workqueue, freezer: unify spelling of 'freeze' + 'able' to 'freezable'
[linux-2.6.git] / kernel / workqueue.c
1 /*
2  * kernel/workqueue.c - generic async execution with shared worker pool
3  *
4  * Copyright (C) 2002           Ingo Molnar
5  *
6  *   Derived from the taskqueue/keventd code by:
7  *     David Woodhouse <dwmw2@infradead.org>
8  *     Andrew Morton
9  *     Kai Petzke <wpp@marie.physik.tu-berlin.de>
10  *     Theodore Ts'o <tytso@mit.edu>
11  *
12  * Made to use alloc_percpu by Christoph Lameter.
13  *
14  * Copyright (C) 2010           SUSE Linux Products GmbH
15  * Copyright (C) 2010           Tejun Heo <tj@kernel.org>
16  *
17  * This is the generic async execution mechanism.  Work items as are
18  * executed in process context.  The worker pool is shared and
19  * automatically managed.  There is one worker pool for each CPU and
20  * one extra for works which are better served by workers which are
21  * not bound to any specific CPU.
22  *
23  * Please read Documentation/workqueue.txt for details.
24  */
25
26 #include <linux/module.h>
27 #include <linux/kernel.h>
28 #include <linux/sched.h>
29 #include <linux/init.h>
30 #include <linux/signal.h>
31 #include <linux/completion.h>
32 #include <linux/workqueue.h>
33 #include <linux/slab.h>
34 #include <linux/cpu.h>
35 #include <linux/notifier.h>
36 #include <linux/kthread.h>
37 #include <linux/hardirq.h>
38 #include <linux/mempolicy.h>
39 #include <linux/freezer.h>
40 #include <linux/kallsyms.h>
41 #include <linux/debug_locks.h>
42 #include <linux/lockdep.h>
43 #include <linux/idr.h>
44
45 #include "workqueue_sched.h"
46
47 enum {
48         /* global_cwq flags */
49         GCWQ_MANAGE_WORKERS     = 1 << 0,       /* need to manage workers */
50         GCWQ_MANAGING_WORKERS   = 1 << 1,       /* managing workers */
51         GCWQ_DISASSOCIATED      = 1 << 2,       /* cpu can't serve workers */
52         GCWQ_FREEZING           = 1 << 3,       /* freeze in progress */
53         GCWQ_HIGHPRI_PENDING    = 1 << 4,       /* highpri works on queue */
54
55         /* worker flags */
56         WORKER_STARTED          = 1 << 0,       /* started */
57         WORKER_DIE              = 1 << 1,       /* die die die */
58         WORKER_IDLE             = 1 << 2,       /* is idle */
59         WORKER_PREP             = 1 << 3,       /* preparing to run works */
60         WORKER_ROGUE            = 1 << 4,       /* not bound to any cpu */
61         WORKER_REBIND           = 1 << 5,       /* mom is home, come back */
62         WORKER_CPU_INTENSIVE    = 1 << 6,       /* cpu intensive */
63         WORKER_UNBOUND          = 1 << 7,       /* worker is unbound */
64
65         WORKER_NOT_RUNNING      = WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
66                                   WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
67
68         /* gcwq->trustee_state */
69         TRUSTEE_START           = 0,            /* start */
70         TRUSTEE_IN_CHARGE       = 1,            /* trustee in charge of gcwq */
71         TRUSTEE_BUTCHER         = 2,            /* butcher workers */
72         TRUSTEE_RELEASE         = 3,            /* release workers */
73         TRUSTEE_DONE            = 4,            /* trustee is done */
74
75         BUSY_WORKER_HASH_ORDER  = 6,            /* 64 pointers */
76         BUSY_WORKER_HASH_SIZE   = 1 << BUSY_WORKER_HASH_ORDER,
77         BUSY_WORKER_HASH_MASK   = BUSY_WORKER_HASH_SIZE - 1,
78
79         MAX_IDLE_WORKERS_RATIO  = 4,            /* 1/4 of busy can be idle */
80         IDLE_WORKER_TIMEOUT     = 300 * HZ,     /* keep idle ones for 5 mins */
81
82         MAYDAY_INITIAL_TIMEOUT  = HZ / 100,     /* call for help after 10ms */
83         MAYDAY_INTERVAL         = HZ / 10,      /* and then every 100ms */
84         CREATE_COOLDOWN         = HZ,           /* time to breath after fail */
85         TRUSTEE_COOLDOWN        = HZ / 10,      /* for trustee draining */
86
87         /*
88          * Rescue workers are used only on emergencies and shared by
89          * all cpus.  Give -20.
90          */
91         RESCUER_NICE_LEVEL      = -20,
92 };
93
94 /*
95  * Structure fields follow one of the following exclusion rules.
96  *
97  * I: Modifiable by initialization/destruction paths and read-only for
98  *    everyone else.
99  *
100  * P: Preemption protected.  Disabling preemption is enough and should
101  *    only be modified and accessed from the local cpu.
102  *
103  * L: gcwq->lock protected.  Access with gcwq->lock held.
104  *
105  * X: During normal operation, modification requires gcwq->lock and
106  *    should be done only from local cpu.  Either disabling preemption
107  *    on local cpu or grabbing gcwq->lock is enough for read access.
108  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
109  *
110  * F: wq->flush_mutex protected.
111  *
112  * W: workqueue_lock protected.
113  */
114
115 struct global_cwq;
116
117 /*
118  * The poor guys doing the actual heavy lifting.  All on-duty workers
119  * are either serving the manager role, on idle list or on busy hash.
120  */
121 struct worker {
122         /* on idle list while idle, on busy hash table while busy */
123         union {
124                 struct list_head        entry;  /* L: while idle */
125                 struct hlist_node       hentry; /* L: while busy */
126         };
127
128         struct work_struct      *current_work;  /* L: work being processed */
129         struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
130         struct list_head        scheduled;      /* L: scheduled works */
131         struct task_struct      *task;          /* I: worker task */
132         struct global_cwq       *gcwq;          /* I: the associated gcwq */
133         /* 64 bytes boundary on 64bit, 32 on 32bit */
134         unsigned long           last_active;    /* L: last active timestamp */
135         unsigned int            flags;          /* X: flags */
136         int                     id;             /* I: worker id */
137         struct work_struct      rebind_work;    /* L: rebind worker to cpu */
138 };
139
140 /*
141  * Global per-cpu workqueue.  There's one and only one for each cpu
142  * and all works are queued and processed here regardless of their
143  * target workqueues.
144  */
145 struct global_cwq {
146         spinlock_t              lock;           /* the gcwq lock */
147         struct list_head        worklist;       /* L: list of pending works */
148         unsigned int            cpu;            /* I: the associated cpu */
149         unsigned int            flags;          /* L: GCWQ_* flags */
150
151         int                     nr_workers;     /* L: total number of workers */
152         int                     nr_idle;        /* L: currently idle ones */
153
154         /* workers are chained either in the idle_list or busy_hash */
155         struct list_head        idle_list;      /* X: list of idle workers */
156         struct hlist_head       busy_hash[BUSY_WORKER_HASH_SIZE];
157                                                 /* L: hash of busy workers */
158
159         struct timer_list       idle_timer;     /* L: worker idle timeout */
160         struct timer_list       mayday_timer;   /* L: SOS timer for dworkers */
161
162         struct ida              worker_ida;     /* L: for worker IDs */
163
164         struct task_struct      *trustee;       /* L: for gcwq shutdown */
165         unsigned int            trustee_state;  /* L: trustee state */
166         wait_queue_head_t       trustee_wait;   /* trustee wait */
167         struct worker           *first_idle;    /* L: first idle worker */
168 } ____cacheline_aligned_in_smp;
169
170 /*
171  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
172  * work_struct->data are used for flags and thus cwqs need to be
173  * aligned at two's power of the number of flag bits.
174  */
175 struct cpu_workqueue_struct {
176         struct global_cwq       *gcwq;          /* I: the associated gcwq */
177         struct workqueue_struct *wq;            /* I: the owning workqueue */
178         int                     work_color;     /* L: current color */
179         int                     flush_color;    /* L: flushing color */
180         int                     nr_in_flight[WORK_NR_COLORS];
181                                                 /* L: nr of in_flight works */
182         int                     nr_active;      /* L: nr of active works */
183         int                     max_active;     /* L: max active works */
184         struct list_head        delayed_works;  /* L: delayed works */
185 };
186
187 /*
188  * Structure used to wait for workqueue flush.
189  */
190 struct wq_flusher {
191         struct list_head        list;           /* F: list of flushers */
192         int                     flush_color;    /* F: flush color waiting for */
193         struct completion       done;           /* flush completion */
194 };
195
196 /*
197  * All cpumasks are assumed to be always set on UP and thus can't be
198  * used to determine whether there's something to be done.
199  */
200 #ifdef CONFIG_SMP
201 typedef cpumask_var_t mayday_mask_t;
202 #define mayday_test_and_set_cpu(cpu, mask)      \
203         cpumask_test_and_set_cpu((cpu), (mask))
204 #define mayday_clear_cpu(cpu, mask)             cpumask_clear_cpu((cpu), (mask))
205 #define for_each_mayday_cpu(cpu, mask)          for_each_cpu((cpu), (mask))
206 #define alloc_mayday_mask(maskp, gfp)           zalloc_cpumask_var((maskp), (gfp))
207 #define free_mayday_mask(mask)                  free_cpumask_var((mask))
208 #else
209 typedef unsigned long mayday_mask_t;
210 #define mayday_test_and_set_cpu(cpu, mask)      test_and_set_bit(0, &(mask))
211 #define mayday_clear_cpu(cpu, mask)             clear_bit(0, &(mask))
212 #define for_each_mayday_cpu(cpu, mask)          if ((cpu) = 0, (mask))
213 #define alloc_mayday_mask(maskp, gfp)           true
214 #define free_mayday_mask(mask)                  do { } while (0)
215 #endif
216
217 /*
218  * The externally visible workqueue abstraction is an array of
219  * per-CPU workqueues:
220  */
221 struct workqueue_struct {
222         unsigned int            flags;          /* I: WQ_* flags */
223         union {
224                 struct cpu_workqueue_struct __percpu    *pcpu;
225                 struct cpu_workqueue_struct             *single;
226                 unsigned long                           v;
227         } cpu_wq;                               /* I: cwq's */
228         struct list_head        list;           /* W: list of all workqueues */
229
230         struct mutex            flush_mutex;    /* protects wq flushing */
231         int                     work_color;     /* F: current work color */
232         int                     flush_color;    /* F: current flush color */
233         atomic_t                nr_cwqs_to_flush; /* flush in progress */
234         struct wq_flusher       *first_flusher; /* F: first flusher */
235         struct list_head        flusher_queue;  /* F: flush waiters */
236         struct list_head        flusher_overflow; /* F: flush overflow list */
237
238         mayday_mask_t           mayday_mask;    /* cpus requesting rescue */
239         struct worker           *rescuer;       /* I: rescue worker */
240
241         int                     saved_max_active; /* W: saved cwq max_active */
242         const char              *name;          /* I: workqueue name */
243 #ifdef CONFIG_LOCKDEP
244         struct lockdep_map      lockdep_map;
245 #endif
246 };
247
248 struct workqueue_struct *system_wq __read_mostly;
249 struct workqueue_struct *system_long_wq __read_mostly;
250 struct workqueue_struct *system_nrt_wq __read_mostly;
251 struct workqueue_struct *system_unbound_wq __read_mostly;
252 EXPORT_SYMBOL_GPL(system_wq);
253 EXPORT_SYMBOL_GPL(system_long_wq);
254 EXPORT_SYMBOL_GPL(system_nrt_wq);
255 EXPORT_SYMBOL_GPL(system_unbound_wq);
256
257 #define CREATE_TRACE_POINTS
258 #include <trace/events/workqueue.h>
259
260 #define for_each_busy_worker(worker, i, pos, gcwq)                      \
261         for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)                     \
262                 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
263
264 static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
265                                   unsigned int sw)
266 {
267         if (cpu < nr_cpu_ids) {
268                 if (sw & 1) {
269                         cpu = cpumask_next(cpu, mask);
270                         if (cpu < nr_cpu_ids)
271                                 return cpu;
272                 }
273                 if (sw & 2)
274                         return WORK_CPU_UNBOUND;
275         }
276         return WORK_CPU_NONE;
277 }
278
279 static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
280                                 struct workqueue_struct *wq)
281 {
282         return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
283 }
284
285 /*
286  * CPU iterators
287  *
288  * An extra gcwq is defined for an invalid cpu number
289  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
290  * specific CPU.  The following iterators are similar to
291  * for_each_*_cpu() iterators but also considers the unbound gcwq.
292  *
293  * for_each_gcwq_cpu()          : possible CPUs + WORK_CPU_UNBOUND
294  * for_each_online_gcwq_cpu()   : online CPUs + WORK_CPU_UNBOUND
295  * for_each_cwq_cpu()           : possible CPUs for bound workqueues,
296  *                                WORK_CPU_UNBOUND for unbound workqueues
297  */
298 #define for_each_gcwq_cpu(cpu)                                          \
299         for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);         \
300              (cpu) < WORK_CPU_NONE;                                     \
301              (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
302
303 #define for_each_online_gcwq_cpu(cpu)                                   \
304         for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);           \
305              (cpu) < WORK_CPU_NONE;                                     \
306              (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
307
308 #define for_each_cwq_cpu(cpu, wq)                                       \
309         for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));        \
310              (cpu) < WORK_CPU_NONE;                                     \
311              (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
312
313 #ifdef CONFIG_DEBUG_OBJECTS_WORK
314
315 static struct debug_obj_descr work_debug_descr;
316
317 /*
318  * fixup_init is called when:
319  * - an active object is initialized
320  */
321 static int work_fixup_init(void *addr, enum debug_obj_state state)
322 {
323         struct work_struct *work = addr;
324
325         switch (state) {
326         case ODEBUG_STATE_ACTIVE:
327                 cancel_work_sync(work);
328                 debug_object_init(work, &work_debug_descr);
329                 return 1;
330         default:
331                 return 0;
332         }
333 }
334
335 /*
336  * fixup_activate is called when:
337  * - an active object is activated
338  * - an unknown object is activated (might be a statically initialized object)
339  */
340 static int work_fixup_activate(void *addr, enum debug_obj_state state)
341 {
342         struct work_struct *work = addr;
343
344         switch (state) {
345
346         case ODEBUG_STATE_NOTAVAILABLE:
347                 /*
348                  * This is not really a fixup. The work struct was
349                  * statically initialized. We just make sure that it
350                  * is tracked in the object tracker.
351                  */
352                 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
353                         debug_object_init(work, &work_debug_descr);
354                         debug_object_activate(work, &work_debug_descr);
355                         return 0;
356                 }
357                 WARN_ON_ONCE(1);
358                 return 0;
359
360         case ODEBUG_STATE_ACTIVE:
361                 WARN_ON(1);
362
363         default:
364                 return 0;
365         }
366 }
367
368 /*
369  * fixup_free is called when:
370  * - an active object is freed
371  */
372 static int work_fixup_free(void *addr, enum debug_obj_state state)
373 {
374         struct work_struct *work = addr;
375
376         switch (state) {
377         case ODEBUG_STATE_ACTIVE:
378                 cancel_work_sync(work);
379                 debug_object_free(work, &work_debug_descr);
380                 return 1;
381         default:
382                 return 0;
383         }
384 }
385
386 static struct debug_obj_descr work_debug_descr = {
387         .name           = "work_struct",
388         .fixup_init     = work_fixup_init,
389         .fixup_activate = work_fixup_activate,
390         .fixup_free     = work_fixup_free,
391 };
392
393 static inline void debug_work_activate(struct work_struct *work)
394 {
395         debug_object_activate(work, &work_debug_descr);
396 }
397
398 static inline void debug_work_deactivate(struct work_struct *work)
399 {
400         debug_object_deactivate(work, &work_debug_descr);
401 }
402
403 void __init_work(struct work_struct *work, int onstack)
404 {
405         if (onstack)
406                 debug_object_init_on_stack(work, &work_debug_descr);
407         else
408                 debug_object_init(work, &work_debug_descr);
409 }
410 EXPORT_SYMBOL_GPL(__init_work);
411
412 void destroy_work_on_stack(struct work_struct *work)
413 {
414         debug_object_free(work, &work_debug_descr);
415 }
416 EXPORT_SYMBOL_GPL(destroy_work_on_stack);
417
418 #else
419 static inline void debug_work_activate(struct work_struct *work) { }
420 static inline void debug_work_deactivate(struct work_struct *work) { }
421 #endif
422
423 /* Serializes the accesses to the list of workqueues. */
424 static DEFINE_SPINLOCK(workqueue_lock);
425 static LIST_HEAD(workqueues);
426 static bool workqueue_freezing;         /* W: have wqs started freezing? */
427
428 /*
429  * The almighty global cpu workqueues.  nr_running is the only field
430  * which is expected to be used frequently by other cpus via
431  * try_to_wake_up().  Put it in a separate cacheline.
432  */
433 static DEFINE_PER_CPU(struct global_cwq, global_cwq);
434 static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
435
436 /*
437  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
438  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
439  * workers have WORKER_UNBOUND set.
440  */
441 static struct global_cwq unbound_global_cwq;
442 static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0);       /* always 0 */
443
444 static int worker_thread(void *__worker);
445
446 static struct global_cwq *get_gcwq(unsigned int cpu)
447 {
448         if (cpu != WORK_CPU_UNBOUND)
449                 return &per_cpu(global_cwq, cpu);
450         else
451                 return &unbound_global_cwq;
452 }
453
454 static atomic_t *get_gcwq_nr_running(unsigned int cpu)
455 {
456         if (cpu != WORK_CPU_UNBOUND)
457                 return &per_cpu(gcwq_nr_running, cpu);
458         else
459                 return &unbound_gcwq_nr_running;
460 }
461
462 static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
463                                             struct workqueue_struct *wq)
464 {
465         if (!(wq->flags & WQ_UNBOUND)) {
466                 if (likely(cpu < nr_cpu_ids)) {
467 #ifdef CONFIG_SMP
468                         return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
469 #else
470                         return wq->cpu_wq.single;
471 #endif
472                 }
473         } else if (likely(cpu == WORK_CPU_UNBOUND))
474                 return wq->cpu_wq.single;
475         return NULL;
476 }
477
478 static unsigned int work_color_to_flags(int color)
479 {
480         return color << WORK_STRUCT_COLOR_SHIFT;
481 }
482
483 static int get_work_color(struct work_struct *work)
484 {
485         return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
486                 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
487 }
488
489 static int work_next_color(int color)
490 {
491         return (color + 1) % WORK_NR_COLORS;
492 }
493
494 /*
495  * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
496  * work is on queue.  Once execution starts, WORK_STRUCT_CWQ is
497  * cleared and the work data contains the cpu number it was last on.
498  *
499  * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
500  * cwq, cpu or clear work->data.  These functions should only be
501  * called while the work is owned - ie. while the PENDING bit is set.
502  *
503  * get_work_[g]cwq() can be used to obtain the gcwq or cwq
504  * corresponding to a work.  gcwq is available once the work has been
505  * queued anywhere after initialization.  cwq is available only from
506  * queueing until execution starts.
507  */
508 static inline void set_work_data(struct work_struct *work, unsigned long data,
509                                  unsigned long flags)
510 {
511         BUG_ON(!work_pending(work));
512         atomic_long_set(&work->data, data | flags | work_static(work));
513 }
514
515 static void set_work_cwq(struct work_struct *work,
516                          struct cpu_workqueue_struct *cwq,
517                          unsigned long extra_flags)
518 {
519         set_work_data(work, (unsigned long)cwq,
520                       WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
521 }
522
523 static void set_work_cpu(struct work_struct *work, unsigned int cpu)
524 {
525         set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
526 }
527
528 static void clear_work_data(struct work_struct *work)
529 {
530         set_work_data(work, WORK_STRUCT_NO_CPU, 0);
531 }
532
533 static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
534 {
535         unsigned long data = atomic_long_read(&work->data);
536
537         if (data & WORK_STRUCT_CWQ)
538                 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
539         else
540                 return NULL;
541 }
542
543 static struct global_cwq *get_work_gcwq(struct work_struct *work)
544 {
545         unsigned long data = atomic_long_read(&work->data);
546         unsigned int cpu;
547
548         if (data & WORK_STRUCT_CWQ)
549                 return ((struct cpu_workqueue_struct *)
550                         (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
551
552         cpu = data >> WORK_STRUCT_FLAG_BITS;
553         if (cpu == WORK_CPU_NONE)
554                 return NULL;
555
556         BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
557         return get_gcwq(cpu);
558 }
559
560 /*
561  * Policy functions.  These define the policies on how the global
562  * worker pool is managed.  Unless noted otherwise, these functions
563  * assume that they're being called with gcwq->lock held.
564  */
565
566 static bool __need_more_worker(struct global_cwq *gcwq)
567 {
568         return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
569                 gcwq->flags & GCWQ_HIGHPRI_PENDING;
570 }
571
572 /*
573  * Need to wake up a worker?  Called from anything but currently
574  * running workers.
575  */
576 static bool need_more_worker(struct global_cwq *gcwq)
577 {
578         return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
579 }
580
581 /* Can I start working?  Called from busy but !running workers. */
582 static bool may_start_working(struct global_cwq *gcwq)
583 {
584         return gcwq->nr_idle;
585 }
586
587 /* Do I need to keep working?  Called from currently running workers. */
588 static bool keep_working(struct global_cwq *gcwq)
589 {
590         atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
591
592         return !list_empty(&gcwq->worklist) &&
593                 (atomic_read(nr_running) <= 1 ||
594                  gcwq->flags & GCWQ_HIGHPRI_PENDING);
595 }
596
597 /* Do we need a new worker?  Called from manager. */
598 static bool need_to_create_worker(struct global_cwq *gcwq)
599 {
600         return need_more_worker(gcwq) && !may_start_working(gcwq);
601 }
602
603 /* Do I need to be the manager? */
604 static bool need_to_manage_workers(struct global_cwq *gcwq)
605 {
606         return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
607 }
608
609 /* Do we have too many workers and should some go away? */
610 static bool too_many_workers(struct global_cwq *gcwq)
611 {
612         bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
613         int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
614         int nr_busy = gcwq->nr_workers - nr_idle;
615
616         return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
617 }
618
619 /*
620  * Wake up functions.
621  */
622
623 /* Return the first worker.  Safe with preemption disabled */
624 static struct worker *first_worker(struct global_cwq *gcwq)
625 {
626         if (unlikely(list_empty(&gcwq->idle_list)))
627                 return NULL;
628
629         return list_first_entry(&gcwq->idle_list, struct worker, entry);
630 }
631
632 /**
633  * wake_up_worker - wake up an idle worker
634  * @gcwq: gcwq to wake worker for
635  *
636  * Wake up the first idle worker of @gcwq.
637  *
638  * CONTEXT:
639  * spin_lock_irq(gcwq->lock).
640  */
641 static void wake_up_worker(struct global_cwq *gcwq)
642 {
643         struct worker *worker = first_worker(gcwq);
644
645         if (likely(worker))
646                 wake_up_process(worker->task);
647 }
648
649 /**
650  * wq_worker_waking_up - a worker is waking up
651  * @task: task waking up
652  * @cpu: CPU @task is waking up to
653  *
654  * This function is called during try_to_wake_up() when a worker is
655  * being awoken.
656  *
657  * CONTEXT:
658  * spin_lock_irq(rq->lock)
659  */
660 void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
661 {
662         struct worker *worker = kthread_data(task);
663
664         if (!(worker->flags & WORKER_NOT_RUNNING))
665                 atomic_inc(get_gcwq_nr_running(cpu));
666 }
667
668 /**
669  * wq_worker_sleeping - a worker is going to sleep
670  * @task: task going to sleep
671  * @cpu: CPU in question, must be the current CPU number
672  *
673  * This function is called during schedule() when a busy worker is
674  * going to sleep.  Worker on the same cpu can be woken up by
675  * returning pointer to its task.
676  *
677  * CONTEXT:
678  * spin_lock_irq(rq->lock)
679  *
680  * RETURNS:
681  * Worker task on @cpu to wake up, %NULL if none.
682  */
683 struct task_struct *wq_worker_sleeping(struct task_struct *task,
684                                        unsigned int cpu)
685 {
686         struct worker *worker = kthread_data(task), *to_wakeup = NULL;
687         struct global_cwq *gcwq = get_gcwq(cpu);
688         atomic_t *nr_running = get_gcwq_nr_running(cpu);
689
690         if (worker->flags & WORKER_NOT_RUNNING)
691                 return NULL;
692
693         /* this can only happen on the local cpu */
694         BUG_ON(cpu != raw_smp_processor_id());
695
696         /*
697          * The counterpart of the following dec_and_test, implied mb,
698          * worklist not empty test sequence is in insert_work().
699          * Please read comment there.
700          *
701          * NOT_RUNNING is clear.  This means that trustee is not in
702          * charge and we're running on the local cpu w/ rq lock held
703          * and preemption disabled, which in turn means that none else
704          * could be manipulating idle_list, so dereferencing idle_list
705          * without gcwq lock is safe.
706          */
707         if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
708                 to_wakeup = first_worker(gcwq);
709         return to_wakeup ? to_wakeup->task : NULL;
710 }
711
712 /**
713  * worker_set_flags - set worker flags and adjust nr_running accordingly
714  * @worker: self
715  * @flags: flags to set
716  * @wakeup: wakeup an idle worker if necessary
717  *
718  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
719  * nr_running becomes zero and @wakeup is %true, an idle worker is
720  * woken up.
721  *
722  * CONTEXT:
723  * spin_lock_irq(gcwq->lock)
724  */
725 static inline void worker_set_flags(struct worker *worker, unsigned int flags,
726                                     bool wakeup)
727 {
728         struct global_cwq *gcwq = worker->gcwq;
729
730         WARN_ON_ONCE(worker->task != current);
731
732         /*
733          * If transitioning into NOT_RUNNING, adjust nr_running and
734          * wake up an idle worker as necessary if requested by
735          * @wakeup.
736          */
737         if ((flags & WORKER_NOT_RUNNING) &&
738             !(worker->flags & WORKER_NOT_RUNNING)) {
739                 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
740
741                 if (wakeup) {
742                         if (atomic_dec_and_test(nr_running) &&
743                             !list_empty(&gcwq->worklist))
744                                 wake_up_worker(gcwq);
745                 } else
746                         atomic_dec(nr_running);
747         }
748
749         worker->flags |= flags;
750 }
751
752 /**
753  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
754  * @worker: self
755  * @flags: flags to clear
756  *
757  * Clear @flags in @worker->flags and adjust nr_running accordingly.
758  *
759  * CONTEXT:
760  * spin_lock_irq(gcwq->lock)
761  */
762 static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
763 {
764         struct global_cwq *gcwq = worker->gcwq;
765         unsigned int oflags = worker->flags;
766
767         WARN_ON_ONCE(worker->task != current);
768
769         worker->flags &= ~flags;
770
771         /*
772          * If transitioning out of NOT_RUNNING, increment nr_running.  Note
773          * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
774          * of multiple flags, not a single flag.
775          */
776         if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
777                 if (!(worker->flags & WORKER_NOT_RUNNING))
778                         atomic_inc(get_gcwq_nr_running(gcwq->cpu));
779 }
780
781 /**
782  * busy_worker_head - return the busy hash head for a work
783  * @gcwq: gcwq of interest
784  * @work: work to be hashed
785  *
786  * Return hash head of @gcwq for @work.
787  *
788  * CONTEXT:
789  * spin_lock_irq(gcwq->lock).
790  *
791  * RETURNS:
792  * Pointer to the hash head.
793  */
794 static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
795                                            struct work_struct *work)
796 {
797         const int base_shift = ilog2(sizeof(struct work_struct));
798         unsigned long v = (unsigned long)work;
799
800         /* simple shift and fold hash, do we need something better? */
801         v >>= base_shift;
802         v += v >> BUSY_WORKER_HASH_ORDER;
803         v &= BUSY_WORKER_HASH_MASK;
804
805         return &gcwq->busy_hash[v];
806 }
807
808 /**
809  * __find_worker_executing_work - find worker which is executing a work
810  * @gcwq: gcwq of interest
811  * @bwh: hash head as returned by busy_worker_head()
812  * @work: work to find worker for
813  *
814  * Find a worker which is executing @work on @gcwq.  @bwh should be
815  * the hash head obtained by calling busy_worker_head() with the same
816  * work.
817  *
818  * CONTEXT:
819  * spin_lock_irq(gcwq->lock).
820  *
821  * RETURNS:
822  * Pointer to worker which is executing @work if found, NULL
823  * otherwise.
824  */
825 static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
826                                                    struct hlist_head *bwh,
827                                                    struct work_struct *work)
828 {
829         struct worker *worker;
830         struct hlist_node *tmp;
831
832         hlist_for_each_entry(worker, tmp, bwh, hentry)
833                 if (worker->current_work == work)
834                         return worker;
835         return NULL;
836 }
837
838 /**
839  * find_worker_executing_work - find worker which is executing a work
840  * @gcwq: gcwq of interest
841  * @work: work to find worker for
842  *
843  * Find a worker which is executing @work on @gcwq.  This function is
844  * identical to __find_worker_executing_work() except that this
845  * function calculates @bwh itself.
846  *
847  * CONTEXT:
848  * spin_lock_irq(gcwq->lock).
849  *
850  * RETURNS:
851  * Pointer to worker which is executing @work if found, NULL
852  * otherwise.
853  */
854 static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
855                                                  struct work_struct *work)
856 {
857         return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
858                                             work);
859 }
860
861 /**
862  * gcwq_determine_ins_pos - find insertion position
863  * @gcwq: gcwq of interest
864  * @cwq: cwq a work is being queued for
865  *
866  * A work for @cwq is about to be queued on @gcwq, determine insertion
867  * position for the work.  If @cwq is for HIGHPRI wq, the work is
868  * queued at the head of the queue but in FIFO order with respect to
869  * other HIGHPRI works; otherwise, at the end of the queue.  This
870  * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
871  * there are HIGHPRI works pending.
872  *
873  * CONTEXT:
874  * spin_lock_irq(gcwq->lock).
875  *
876  * RETURNS:
877  * Pointer to inserstion position.
878  */
879 static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
880                                                struct cpu_workqueue_struct *cwq)
881 {
882         struct work_struct *twork;
883
884         if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
885                 return &gcwq->worklist;
886
887         list_for_each_entry(twork, &gcwq->worklist, entry) {
888                 struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
889
890                 if (!(tcwq->wq->flags & WQ_HIGHPRI))
891                         break;
892         }
893
894         gcwq->flags |= GCWQ_HIGHPRI_PENDING;
895         return &twork->entry;
896 }
897
898 /**
899  * insert_work - insert a work into gcwq
900  * @cwq: cwq @work belongs to
901  * @work: work to insert
902  * @head: insertion point
903  * @extra_flags: extra WORK_STRUCT_* flags to set
904  *
905  * Insert @work which belongs to @cwq into @gcwq after @head.
906  * @extra_flags is or'd to work_struct flags.
907  *
908  * CONTEXT:
909  * spin_lock_irq(gcwq->lock).
910  */
911 static void insert_work(struct cpu_workqueue_struct *cwq,
912                         struct work_struct *work, struct list_head *head,
913                         unsigned int extra_flags)
914 {
915         struct global_cwq *gcwq = cwq->gcwq;
916
917         /* we own @work, set data and link */
918         set_work_cwq(work, cwq, extra_flags);
919
920         /*
921          * Ensure that we get the right work->data if we see the
922          * result of list_add() below, see try_to_grab_pending().
923          */
924         smp_wmb();
925
926         list_add_tail(&work->entry, head);
927
928         /*
929          * Ensure either worker_sched_deactivated() sees the above
930          * list_add_tail() or we see zero nr_running to avoid workers
931          * lying around lazily while there are works to be processed.
932          */
933         smp_mb();
934
935         if (__need_more_worker(gcwq))
936                 wake_up_worker(gcwq);
937 }
938
939 /*
940  * Test whether @work is being queued from another work executing on the
941  * same workqueue.  This is rather expensive and should only be used from
942  * cold paths.
943  */
944 static bool is_chained_work(struct workqueue_struct *wq)
945 {
946         unsigned long flags;
947         unsigned int cpu;
948
949         for_each_gcwq_cpu(cpu) {
950                 struct global_cwq *gcwq = get_gcwq(cpu);
951                 struct worker *worker;
952                 struct hlist_node *pos;
953                 int i;
954
955                 spin_lock_irqsave(&gcwq->lock, flags);
956                 for_each_busy_worker(worker, i, pos, gcwq) {
957                         if (worker->task != current)
958                                 continue;
959                         spin_unlock_irqrestore(&gcwq->lock, flags);
960                         /*
961                          * I'm @worker, no locking necessary.  See if @work
962                          * is headed to the same workqueue.
963                          */
964                         return worker->current_cwq->wq == wq;
965                 }
966                 spin_unlock_irqrestore(&gcwq->lock, flags);
967         }
968         return false;
969 }
970
971 static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
972                          struct work_struct *work)
973 {
974         struct global_cwq *gcwq;
975         struct cpu_workqueue_struct *cwq;
976         struct list_head *worklist;
977         unsigned int work_flags;
978         unsigned long flags;
979
980         debug_work_activate(work);
981
982         /* if dying, only works from the same workqueue are allowed */
983         if (unlikely(wq->flags & WQ_DYING) &&
984             WARN_ON_ONCE(!is_chained_work(wq)))
985                 return;
986
987         /* determine gcwq to use */
988         if (!(wq->flags & WQ_UNBOUND)) {
989                 struct global_cwq *last_gcwq;
990
991                 if (unlikely(cpu == WORK_CPU_UNBOUND))
992                         cpu = raw_smp_processor_id();
993
994                 /*
995                  * It's multi cpu.  If @wq is non-reentrant and @work
996                  * was previously on a different cpu, it might still
997                  * be running there, in which case the work needs to
998                  * be queued on that cpu to guarantee non-reentrance.
999                  */
1000                 gcwq = get_gcwq(cpu);
1001                 if (wq->flags & WQ_NON_REENTRANT &&
1002                     (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1003                         struct worker *worker;
1004
1005                         spin_lock_irqsave(&last_gcwq->lock, flags);
1006
1007                         worker = find_worker_executing_work(last_gcwq, work);
1008
1009                         if (worker && worker->current_cwq->wq == wq)
1010                                 gcwq = last_gcwq;
1011                         else {
1012                                 /* meh... not running there, queue here */
1013                                 spin_unlock_irqrestore(&last_gcwq->lock, flags);
1014                                 spin_lock_irqsave(&gcwq->lock, flags);
1015                         }
1016                 } else
1017                         spin_lock_irqsave(&gcwq->lock, flags);
1018         } else {
1019                 gcwq = get_gcwq(WORK_CPU_UNBOUND);
1020                 spin_lock_irqsave(&gcwq->lock, flags);
1021         }
1022
1023         /* gcwq determined, get cwq and queue */
1024         cwq = get_cwq(gcwq->cpu, wq);
1025         trace_workqueue_queue_work(cpu, cwq, work);
1026
1027         BUG_ON(!list_empty(&work->entry));
1028
1029         cwq->nr_in_flight[cwq->work_color]++;
1030         work_flags = work_color_to_flags(cwq->work_color);
1031
1032         if (likely(cwq->nr_active < cwq->max_active)) {
1033                 trace_workqueue_activate_work(work);
1034                 cwq->nr_active++;
1035                 worklist = gcwq_determine_ins_pos(gcwq, cwq);
1036         } else {
1037                 work_flags |= WORK_STRUCT_DELAYED;
1038                 worklist = &cwq->delayed_works;
1039         }
1040
1041         insert_work(cwq, work, worklist, work_flags);
1042
1043         spin_unlock_irqrestore(&gcwq->lock, flags);
1044 }
1045
1046 /**
1047  * queue_work - queue work on a workqueue
1048  * @wq: workqueue to use
1049  * @work: work to queue
1050  *
1051  * Returns 0 if @work was already on a queue, non-zero otherwise.
1052  *
1053  * We queue the work to the CPU on which it was submitted, but if the CPU dies
1054  * it can be processed by another CPU.
1055  */
1056 int queue_work(struct workqueue_struct *wq, struct work_struct *work)
1057 {
1058         int ret;
1059
1060         ret = queue_work_on(get_cpu(), wq, work);
1061         put_cpu();
1062
1063         return ret;
1064 }
1065 EXPORT_SYMBOL_GPL(queue_work);
1066
1067 /**
1068  * queue_work_on - queue work on specific cpu
1069  * @cpu: CPU number to execute work on
1070  * @wq: workqueue to use
1071  * @work: work to queue
1072  *
1073  * Returns 0 if @work was already on a queue, non-zero otherwise.
1074  *
1075  * We queue the work to a specific CPU, the caller must ensure it
1076  * can't go away.
1077  */
1078 int
1079 queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1080 {
1081         int ret = 0;
1082
1083         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1084                 __queue_work(cpu, wq, work);
1085                 ret = 1;
1086         }
1087         return ret;
1088 }
1089 EXPORT_SYMBOL_GPL(queue_work_on);
1090
1091 static void delayed_work_timer_fn(unsigned long __data)
1092 {
1093         struct delayed_work *dwork = (struct delayed_work *)__data;
1094         struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
1095
1096         __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
1097 }
1098
1099 /**
1100  * queue_delayed_work - queue work on a workqueue after delay
1101  * @wq: workqueue to use
1102  * @dwork: delayable work to queue
1103  * @delay: number of jiffies to wait before queueing
1104  *
1105  * Returns 0 if @work was already on a queue, non-zero otherwise.
1106  */
1107 int queue_delayed_work(struct workqueue_struct *wq,
1108                         struct delayed_work *dwork, unsigned long delay)
1109 {
1110         if (delay == 0)
1111                 return queue_work(wq, &dwork->work);
1112
1113         return queue_delayed_work_on(-1, wq, dwork, delay);
1114 }
1115 EXPORT_SYMBOL_GPL(queue_delayed_work);
1116
1117 /**
1118  * queue_delayed_work_on - queue work on specific CPU after delay
1119  * @cpu: CPU number to execute work on
1120  * @wq: workqueue to use
1121  * @dwork: work to queue
1122  * @delay: number of jiffies to wait before queueing
1123  *
1124  * Returns 0 if @work was already on a queue, non-zero otherwise.
1125  */
1126 int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1127                         struct delayed_work *dwork, unsigned long delay)
1128 {
1129         int ret = 0;
1130         struct timer_list *timer = &dwork->timer;
1131         struct work_struct *work = &dwork->work;
1132
1133         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1134                 unsigned int lcpu;
1135
1136                 BUG_ON(timer_pending(timer));
1137                 BUG_ON(!list_empty(&work->entry));
1138
1139                 timer_stats_timer_set_start_info(&dwork->timer);
1140
1141                 /*
1142                  * This stores cwq for the moment, for the timer_fn.
1143                  * Note that the work's gcwq is preserved to allow
1144                  * reentrance detection for delayed works.
1145                  */
1146                 if (!(wq->flags & WQ_UNBOUND)) {
1147                         struct global_cwq *gcwq = get_work_gcwq(work);
1148
1149                         if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1150                                 lcpu = gcwq->cpu;
1151                         else
1152                                 lcpu = raw_smp_processor_id();
1153                 } else
1154                         lcpu = WORK_CPU_UNBOUND;
1155
1156                 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1157
1158                 timer->expires = jiffies + delay;
1159                 timer->data = (unsigned long)dwork;
1160                 timer->function = delayed_work_timer_fn;
1161
1162                 if (unlikely(cpu >= 0))
1163                         add_timer_on(timer, cpu);
1164                 else
1165                         add_timer(timer);
1166                 ret = 1;
1167         }
1168         return ret;
1169 }
1170 EXPORT_SYMBOL_GPL(queue_delayed_work_on);
1171
1172 /**
1173  * worker_enter_idle - enter idle state
1174  * @worker: worker which is entering idle state
1175  *
1176  * @worker is entering idle state.  Update stats and idle timer if
1177  * necessary.
1178  *
1179  * LOCKING:
1180  * spin_lock_irq(gcwq->lock).
1181  */
1182 static void worker_enter_idle(struct worker *worker)
1183 {
1184         struct global_cwq *gcwq = worker->gcwq;
1185
1186         BUG_ON(worker->flags & WORKER_IDLE);
1187         BUG_ON(!list_empty(&worker->entry) &&
1188                (worker->hentry.next || worker->hentry.pprev));
1189
1190         /* can't use worker_set_flags(), also called from start_worker() */
1191         worker->flags |= WORKER_IDLE;
1192         gcwq->nr_idle++;
1193         worker->last_active = jiffies;
1194
1195         /* idle_list is LIFO */
1196         list_add(&worker->entry, &gcwq->idle_list);
1197
1198         if (likely(!(worker->flags & WORKER_ROGUE))) {
1199                 if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1200                         mod_timer(&gcwq->idle_timer,
1201                                   jiffies + IDLE_WORKER_TIMEOUT);
1202         } else
1203                 wake_up_all(&gcwq->trustee_wait);
1204
1205         /* sanity check nr_running */
1206         WARN_ON_ONCE(gcwq->nr_workers == gcwq->nr_idle &&
1207                      atomic_read(get_gcwq_nr_running(gcwq->cpu)));
1208 }
1209
1210 /**
1211  * worker_leave_idle - leave idle state
1212  * @worker: worker which is leaving idle state
1213  *
1214  * @worker is leaving idle state.  Update stats.
1215  *
1216  * LOCKING:
1217  * spin_lock_irq(gcwq->lock).
1218  */
1219 static void worker_leave_idle(struct worker *worker)
1220 {
1221         struct global_cwq *gcwq = worker->gcwq;
1222
1223         BUG_ON(!(worker->flags & WORKER_IDLE));
1224         worker_clr_flags(worker, WORKER_IDLE);
1225         gcwq->nr_idle--;
1226         list_del_init(&worker->entry);
1227 }
1228
1229 /**
1230  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1231  * @worker: self
1232  *
1233  * Works which are scheduled while the cpu is online must at least be
1234  * scheduled to a worker which is bound to the cpu so that if they are
1235  * flushed from cpu callbacks while cpu is going down, they are
1236  * guaranteed to execute on the cpu.
1237  *
1238  * This function is to be used by rogue workers and rescuers to bind
1239  * themselves to the target cpu and may race with cpu going down or
1240  * coming online.  kthread_bind() can't be used because it may put the
1241  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1242  * verbatim as it's best effort and blocking and gcwq may be
1243  * [dis]associated in the meantime.
1244  *
1245  * This function tries set_cpus_allowed() and locks gcwq and verifies
1246  * the binding against GCWQ_DISASSOCIATED which is set during
1247  * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1248  * idle state or fetches works without dropping lock, it can guarantee
1249  * the scheduling requirement described in the first paragraph.
1250  *
1251  * CONTEXT:
1252  * Might sleep.  Called without any lock but returns with gcwq->lock
1253  * held.
1254  *
1255  * RETURNS:
1256  * %true if the associated gcwq is online (@worker is successfully
1257  * bound), %false if offline.
1258  */
1259 static bool worker_maybe_bind_and_lock(struct worker *worker)
1260 __acquires(&gcwq->lock)
1261 {
1262         struct global_cwq *gcwq = worker->gcwq;
1263         struct task_struct *task = worker->task;
1264
1265         while (true) {
1266                 /*
1267                  * The following call may fail, succeed or succeed
1268                  * without actually migrating the task to the cpu if
1269                  * it races with cpu hotunplug operation.  Verify
1270                  * against GCWQ_DISASSOCIATED.
1271                  */
1272                 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1273                         set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1274
1275                 spin_lock_irq(&gcwq->lock);
1276                 if (gcwq->flags & GCWQ_DISASSOCIATED)
1277                         return false;
1278                 if (task_cpu(task) == gcwq->cpu &&
1279                     cpumask_equal(&current->cpus_allowed,
1280                                   get_cpu_mask(gcwq->cpu)))
1281                         return true;
1282                 spin_unlock_irq(&gcwq->lock);
1283
1284                 /* CPU has come up inbetween, retry migration */
1285                 cpu_relax();
1286         }
1287 }
1288
1289 /*
1290  * Function for worker->rebind_work used to rebind rogue busy workers
1291  * to the associated cpu which is coming back online.  This is
1292  * scheduled by cpu up but can race with other cpu hotplug operations
1293  * and may be executed twice without intervening cpu down.
1294  */
1295 static void worker_rebind_fn(struct work_struct *work)
1296 {
1297         struct worker *worker = container_of(work, struct worker, rebind_work);
1298         struct global_cwq *gcwq = worker->gcwq;
1299
1300         if (worker_maybe_bind_and_lock(worker))
1301                 worker_clr_flags(worker, WORKER_REBIND);
1302
1303         spin_unlock_irq(&gcwq->lock);
1304 }
1305
1306 static struct worker *alloc_worker(void)
1307 {
1308         struct worker *worker;
1309
1310         worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1311         if (worker) {
1312                 INIT_LIST_HEAD(&worker->entry);
1313                 INIT_LIST_HEAD(&worker->scheduled);
1314                 INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1315                 /* on creation a worker is in !idle && prep state */
1316                 worker->flags = WORKER_PREP;
1317         }
1318         return worker;
1319 }
1320
1321 /**
1322  * create_worker - create a new workqueue worker
1323  * @gcwq: gcwq the new worker will belong to
1324  * @bind: whether to set affinity to @cpu or not
1325  *
1326  * Create a new worker which is bound to @gcwq.  The returned worker
1327  * can be started by calling start_worker() or destroyed using
1328  * destroy_worker().
1329  *
1330  * CONTEXT:
1331  * Might sleep.  Does GFP_KERNEL allocations.
1332  *
1333  * RETURNS:
1334  * Pointer to the newly created worker.
1335  */
1336 static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
1337 {
1338         bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
1339         struct worker *worker = NULL;
1340         int id = -1;
1341
1342         spin_lock_irq(&gcwq->lock);
1343         while (ida_get_new(&gcwq->worker_ida, &id)) {
1344                 spin_unlock_irq(&gcwq->lock);
1345                 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
1346                         goto fail;
1347                 spin_lock_irq(&gcwq->lock);
1348         }
1349         spin_unlock_irq(&gcwq->lock);
1350
1351         worker = alloc_worker();
1352         if (!worker)
1353                 goto fail;
1354
1355         worker->gcwq = gcwq;
1356         worker->id = id;
1357
1358         if (!on_unbound_cpu)
1359                 worker->task = kthread_create(worker_thread, worker,
1360                                               "kworker/%u:%d", gcwq->cpu, id);
1361         else
1362                 worker->task = kthread_create(worker_thread, worker,
1363                                               "kworker/u:%d", id);
1364         if (IS_ERR(worker->task))
1365                 goto fail;
1366
1367         /*
1368          * A rogue worker will become a regular one if CPU comes
1369          * online later on.  Make sure every worker has
1370          * PF_THREAD_BOUND set.
1371          */
1372         if (bind && !on_unbound_cpu)
1373                 kthread_bind(worker->task, gcwq->cpu);
1374         else {
1375                 worker->task->flags |= PF_THREAD_BOUND;
1376                 if (on_unbound_cpu)
1377                         worker->flags |= WORKER_UNBOUND;
1378         }
1379
1380         return worker;
1381 fail:
1382         if (id >= 0) {
1383                 spin_lock_irq(&gcwq->lock);
1384                 ida_remove(&gcwq->worker_ida, id);
1385                 spin_unlock_irq(&gcwq->lock);
1386         }
1387         kfree(worker);
1388         return NULL;
1389 }
1390
1391 /**
1392  * start_worker - start a newly created worker
1393  * @worker: worker to start
1394  *
1395  * Make the gcwq aware of @worker and start it.
1396  *
1397  * CONTEXT:
1398  * spin_lock_irq(gcwq->lock).
1399  */
1400 static void start_worker(struct worker *worker)
1401 {
1402         worker->flags |= WORKER_STARTED;
1403         worker->gcwq->nr_workers++;
1404         worker_enter_idle(worker);
1405         wake_up_process(worker->task);
1406 }
1407
1408 /**
1409  * destroy_worker - destroy a workqueue worker
1410  * @worker: worker to be destroyed
1411  *
1412  * Destroy @worker and adjust @gcwq stats accordingly.
1413  *
1414  * CONTEXT:
1415  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1416  */
1417 static void destroy_worker(struct worker *worker)
1418 {
1419         struct global_cwq *gcwq = worker->gcwq;
1420         int id = worker->id;
1421
1422         /* sanity check frenzy */
1423         BUG_ON(worker->current_work);
1424         BUG_ON(!list_empty(&worker->scheduled));
1425
1426         if (worker->flags & WORKER_STARTED)
1427                 gcwq->nr_workers--;
1428         if (worker->flags & WORKER_IDLE)
1429                 gcwq->nr_idle--;
1430
1431         list_del_init(&worker->entry);
1432         worker->flags |= WORKER_DIE;
1433
1434         spin_unlock_irq(&gcwq->lock);
1435
1436         kthread_stop(worker->task);
1437         kfree(worker);
1438
1439         spin_lock_irq(&gcwq->lock);
1440         ida_remove(&gcwq->worker_ida, id);
1441 }
1442
1443 static void idle_worker_timeout(unsigned long __gcwq)
1444 {
1445         struct global_cwq *gcwq = (void *)__gcwq;
1446
1447         spin_lock_irq(&gcwq->lock);
1448
1449         if (too_many_workers(gcwq)) {
1450                 struct worker *worker;
1451                 unsigned long expires;
1452
1453                 /* idle_list is kept in LIFO order, check the last one */
1454                 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1455                 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1456
1457                 if (time_before(jiffies, expires))
1458                         mod_timer(&gcwq->idle_timer, expires);
1459                 else {
1460                         /* it's been idle for too long, wake up manager */
1461                         gcwq->flags |= GCWQ_MANAGE_WORKERS;
1462                         wake_up_worker(gcwq);
1463                 }
1464         }
1465
1466         spin_unlock_irq(&gcwq->lock);
1467 }
1468
1469 static bool send_mayday(struct work_struct *work)
1470 {
1471         struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1472         struct workqueue_struct *wq = cwq->wq;
1473         unsigned int cpu;
1474
1475         if (!(wq->flags & WQ_RESCUER))
1476                 return false;
1477
1478         /* mayday mayday mayday */
1479         cpu = cwq->gcwq->cpu;
1480         /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1481         if (cpu == WORK_CPU_UNBOUND)
1482                 cpu = 0;
1483         if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1484                 wake_up_process(wq->rescuer->task);
1485         return true;
1486 }
1487
1488 static void gcwq_mayday_timeout(unsigned long __gcwq)
1489 {
1490         struct global_cwq *gcwq = (void *)__gcwq;
1491         struct work_struct *work;
1492
1493         spin_lock_irq(&gcwq->lock);
1494
1495         if (need_to_create_worker(gcwq)) {
1496                 /*
1497                  * We've been trying to create a new worker but
1498                  * haven't been successful.  We might be hitting an
1499                  * allocation deadlock.  Send distress signals to
1500                  * rescuers.
1501                  */
1502                 list_for_each_entry(work, &gcwq->worklist, entry)
1503                         send_mayday(work);
1504         }
1505
1506         spin_unlock_irq(&gcwq->lock);
1507
1508         mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1509 }
1510
1511 /**
1512  * maybe_create_worker - create a new worker if necessary
1513  * @gcwq: gcwq to create a new worker for
1514  *
1515  * Create a new worker for @gcwq if necessary.  @gcwq is guaranteed to
1516  * have at least one idle worker on return from this function.  If
1517  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1518  * sent to all rescuers with works scheduled on @gcwq to resolve
1519  * possible allocation deadlock.
1520  *
1521  * On return, need_to_create_worker() is guaranteed to be false and
1522  * may_start_working() true.
1523  *
1524  * LOCKING:
1525  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1526  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1527  * manager.
1528  *
1529  * RETURNS:
1530  * false if no action was taken and gcwq->lock stayed locked, true
1531  * otherwise.
1532  */
1533 static bool maybe_create_worker(struct global_cwq *gcwq)
1534 __releases(&gcwq->lock)
1535 __acquires(&gcwq->lock)
1536 {
1537         if (!need_to_create_worker(gcwq))
1538                 return false;
1539 restart:
1540         spin_unlock_irq(&gcwq->lock);
1541
1542         /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1543         mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1544
1545         while (true) {
1546                 struct worker *worker;
1547
1548                 worker = create_worker(gcwq, true);
1549                 if (worker) {
1550                         del_timer_sync(&gcwq->mayday_timer);
1551                         spin_lock_irq(&gcwq->lock);
1552                         start_worker(worker);
1553                         BUG_ON(need_to_create_worker(gcwq));
1554                         return true;
1555                 }
1556
1557                 if (!need_to_create_worker(gcwq))
1558                         break;
1559
1560                 __set_current_state(TASK_INTERRUPTIBLE);
1561                 schedule_timeout(CREATE_COOLDOWN);
1562
1563                 if (!need_to_create_worker(gcwq))
1564                         break;
1565         }
1566
1567         del_timer_sync(&gcwq->mayday_timer);
1568         spin_lock_irq(&gcwq->lock);
1569         if (need_to_create_worker(gcwq))
1570                 goto restart;
1571         return true;
1572 }
1573
1574 /**
1575  * maybe_destroy_worker - destroy workers which have been idle for a while
1576  * @gcwq: gcwq to destroy workers for
1577  *
1578  * Destroy @gcwq workers which have been idle for longer than
1579  * IDLE_WORKER_TIMEOUT.
1580  *
1581  * LOCKING:
1582  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1583  * multiple times.  Called only from manager.
1584  *
1585  * RETURNS:
1586  * false if no action was taken and gcwq->lock stayed locked, true
1587  * otherwise.
1588  */
1589 static bool maybe_destroy_workers(struct global_cwq *gcwq)
1590 {
1591         bool ret = false;
1592
1593         while (too_many_workers(gcwq)) {
1594                 struct worker *worker;
1595                 unsigned long expires;
1596
1597                 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1598                 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1599
1600                 if (time_before(jiffies, expires)) {
1601                         mod_timer(&gcwq->idle_timer, expires);
1602                         break;
1603                 }
1604
1605                 destroy_worker(worker);
1606                 ret = true;
1607         }
1608
1609         return ret;
1610 }
1611
1612 /**
1613  * manage_workers - manage worker pool
1614  * @worker: self
1615  *
1616  * Assume the manager role and manage gcwq worker pool @worker belongs
1617  * to.  At any given time, there can be only zero or one manager per
1618  * gcwq.  The exclusion is handled automatically by this function.
1619  *
1620  * The caller can safely start processing works on false return.  On
1621  * true return, it's guaranteed that need_to_create_worker() is false
1622  * and may_start_working() is true.
1623  *
1624  * CONTEXT:
1625  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1626  * multiple times.  Does GFP_KERNEL allocations.
1627  *
1628  * RETURNS:
1629  * false if no action was taken and gcwq->lock stayed locked, true if
1630  * some action was taken.
1631  */
1632 static bool manage_workers(struct worker *worker)
1633 {
1634         struct global_cwq *gcwq = worker->gcwq;
1635         bool ret = false;
1636
1637         if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1638                 return ret;
1639
1640         gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1641         gcwq->flags |= GCWQ_MANAGING_WORKERS;
1642
1643         /*
1644          * Destroy and then create so that may_start_working() is true
1645          * on return.
1646          */
1647         ret |= maybe_destroy_workers(gcwq);
1648         ret |= maybe_create_worker(gcwq);
1649
1650         gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1651
1652         /*
1653          * The trustee might be waiting to take over the manager
1654          * position, tell it we're done.
1655          */
1656         if (unlikely(gcwq->trustee))
1657                 wake_up_all(&gcwq->trustee_wait);
1658
1659         return ret;
1660 }
1661
1662 /**
1663  * move_linked_works - move linked works to a list
1664  * @work: start of series of works to be scheduled
1665  * @head: target list to append @work to
1666  * @nextp: out paramter for nested worklist walking
1667  *
1668  * Schedule linked works starting from @work to @head.  Work series to
1669  * be scheduled starts at @work and includes any consecutive work with
1670  * WORK_STRUCT_LINKED set in its predecessor.
1671  *
1672  * If @nextp is not NULL, it's updated to point to the next work of
1673  * the last scheduled work.  This allows move_linked_works() to be
1674  * nested inside outer list_for_each_entry_safe().
1675  *
1676  * CONTEXT:
1677  * spin_lock_irq(gcwq->lock).
1678  */
1679 static void move_linked_works(struct work_struct *work, struct list_head *head,
1680                               struct work_struct **nextp)
1681 {
1682         struct work_struct *n;
1683
1684         /*
1685          * Linked worklist will always end before the end of the list,
1686          * use NULL for list head.
1687          */
1688         list_for_each_entry_safe_from(work, n, NULL, entry) {
1689                 list_move_tail(&work->entry, head);
1690                 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1691                         break;
1692         }
1693
1694         /*
1695          * If we're already inside safe list traversal and have moved
1696          * multiple works to the scheduled queue, the next position
1697          * needs to be updated.
1698          */
1699         if (nextp)
1700                 *nextp = n;
1701 }
1702
1703 static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
1704 {
1705         struct work_struct *work = list_first_entry(&cwq->delayed_works,
1706                                                     struct work_struct, entry);
1707         struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
1708
1709         trace_workqueue_activate_work(work);
1710         move_linked_works(work, pos, NULL);
1711         __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1712         cwq->nr_active++;
1713 }
1714
1715 /**
1716  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1717  * @cwq: cwq of interest
1718  * @color: color of work which left the queue
1719  * @delayed: for a delayed work
1720  *
1721  * A work either has completed or is removed from pending queue,
1722  * decrement nr_in_flight of its cwq and handle workqueue flushing.
1723  *
1724  * CONTEXT:
1725  * spin_lock_irq(gcwq->lock).
1726  */
1727 static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1728                                  bool delayed)
1729 {
1730         /* ignore uncolored works */
1731         if (color == WORK_NO_COLOR)
1732                 return;
1733
1734         cwq->nr_in_flight[color]--;
1735
1736         if (!delayed) {
1737                 cwq->nr_active--;
1738                 if (!list_empty(&cwq->delayed_works)) {
1739                         /* one down, submit a delayed one */
1740                         if (cwq->nr_active < cwq->max_active)
1741                                 cwq_activate_first_delayed(cwq);
1742                 }
1743         }
1744
1745         /* is flush in progress and are we at the flushing tip? */
1746         if (likely(cwq->flush_color != color))
1747                 return;
1748
1749         /* are there still in-flight works? */
1750         if (cwq->nr_in_flight[color])
1751                 return;
1752
1753         /* this cwq is done, clear flush_color */
1754         cwq->flush_color = -1;
1755
1756         /*
1757          * If this was the last cwq, wake up the first flusher.  It
1758          * will handle the rest.
1759          */
1760         if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1761                 complete(&cwq->wq->first_flusher->done);
1762 }
1763
1764 /**
1765  * process_one_work - process single work
1766  * @worker: self
1767  * @work: work to process
1768  *
1769  * Process @work.  This function contains all the logics necessary to
1770  * process a single work including synchronization against and
1771  * interaction with other workers on the same cpu, queueing and
1772  * flushing.  As long as context requirement is met, any worker can
1773  * call this function to process a work.
1774  *
1775  * CONTEXT:
1776  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1777  */
1778 static void process_one_work(struct worker *worker, struct work_struct *work)
1779 __releases(&gcwq->lock)
1780 __acquires(&gcwq->lock)
1781 {
1782         struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1783         struct global_cwq *gcwq = cwq->gcwq;
1784         struct hlist_head *bwh = busy_worker_head(gcwq, work);
1785         bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
1786         work_func_t f = work->func;
1787         int work_color;
1788         struct worker *collision;
1789 #ifdef CONFIG_LOCKDEP
1790         /*
1791          * It is permissible to free the struct work_struct from
1792          * inside the function that is called from it, this we need to
1793          * take into account for lockdep too.  To avoid bogus "held
1794          * lock freed" warnings as well as problems when looking into
1795          * work->lockdep_map, make a copy and use that here.
1796          */
1797         struct lockdep_map lockdep_map = work->lockdep_map;
1798 #endif
1799         /*
1800          * A single work shouldn't be executed concurrently by
1801          * multiple workers on a single cpu.  Check whether anyone is
1802          * already processing the work.  If so, defer the work to the
1803          * currently executing one.
1804          */
1805         collision = __find_worker_executing_work(gcwq, bwh, work);
1806         if (unlikely(collision)) {
1807                 move_linked_works(work, &collision->scheduled, NULL);
1808                 return;
1809         }
1810
1811         /* claim and process */
1812         debug_work_deactivate(work);
1813         hlist_add_head(&worker->hentry, bwh);
1814         worker->current_work = work;
1815         worker->current_cwq = cwq;
1816         work_color = get_work_color(work);
1817
1818         /* record the current cpu number in the work data and dequeue */
1819         set_work_cpu(work, gcwq->cpu);
1820         list_del_init(&work->entry);
1821
1822         /*
1823          * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1824          * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1825          */
1826         if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1827                 struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1828                                                 struct work_struct, entry);
1829
1830                 if (!list_empty(&gcwq->worklist) &&
1831                     get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1832                         wake_up_worker(gcwq);
1833                 else
1834                         gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1835         }
1836
1837         /*
1838          * CPU intensive works don't participate in concurrency
1839          * management.  They're the scheduler's responsibility.
1840          */
1841         if (unlikely(cpu_intensive))
1842                 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1843
1844         spin_unlock_irq(&gcwq->lock);
1845
1846         work_clear_pending(work);
1847         lock_map_acquire_read(&cwq->wq->lockdep_map);
1848         lock_map_acquire(&lockdep_map);
1849         trace_workqueue_execute_start(work);
1850         f(work);
1851         /*
1852          * While we must be careful to not use "work" after this, the trace
1853          * point will only record its address.
1854          */
1855         trace_workqueue_execute_end(work);
1856         lock_map_release(&lockdep_map);
1857         lock_map_release(&cwq->wq->lockdep_map);
1858
1859         if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1860                 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1861                        "%s/0x%08x/%d\n",
1862                        current->comm, preempt_count(), task_pid_nr(current));
1863                 printk(KERN_ERR "    last function: ");
1864                 print_symbol("%s\n", (unsigned long)f);
1865                 debug_show_held_locks(current);
1866                 dump_stack();
1867         }
1868
1869         spin_lock_irq(&gcwq->lock);
1870
1871         /* clear cpu intensive status */
1872         if (unlikely(cpu_intensive))
1873                 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1874
1875         /* we're done with it, release */
1876         hlist_del_init(&worker->hentry);
1877         worker->current_work = NULL;
1878         worker->current_cwq = NULL;
1879         cwq_dec_nr_in_flight(cwq, work_color, false);
1880 }
1881
1882 /**
1883  * process_scheduled_works - process scheduled works
1884  * @worker: self
1885  *
1886  * Process all scheduled works.  Please note that the scheduled list
1887  * may change while processing a work, so this function repeatedly
1888  * fetches a work from the top and executes it.
1889  *
1890  * CONTEXT:
1891  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1892  * multiple times.
1893  */
1894 static void process_scheduled_works(struct worker *worker)
1895 {
1896         while (!list_empty(&worker->scheduled)) {
1897                 struct work_struct *work = list_first_entry(&worker->scheduled,
1898                                                 struct work_struct, entry);
1899                 process_one_work(worker, work);
1900         }
1901 }
1902
1903 /**
1904  * worker_thread - the worker thread function
1905  * @__worker: self
1906  *
1907  * The gcwq worker thread function.  There's a single dynamic pool of
1908  * these per each cpu.  These workers process all works regardless of
1909  * their specific target workqueue.  The only exception is works which
1910  * belong to workqueues with a rescuer which will be explained in
1911  * rescuer_thread().
1912  */
1913 static int worker_thread(void *__worker)
1914 {
1915         struct worker *worker = __worker;
1916         struct global_cwq *gcwq = worker->gcwq;
1917
1918         /* tell the scheduler that this is a workqueue worker */
1919         worker->task->flags |= PF_WQ_WORKER;
1920 woke_up:
1921         spin_lock_irq(&gcwq->lock);
1922
1923         /* DIE can be set only while we're idle, checking here is enough */
1924         if (worker->flags & WORKER_DIE) {
1925                 spin_unlock_irq(&gcwq->lock);
1926                 worker->task->flags &= ~PF_WQ_WORKER;
1927                 return 0;
1928         }
1929
1930         worker_leave_idle(worker);
1931 recheck:
1932         /* no more worker necessary? */
1933         if (!need_more_worker(gcwq))
1934                 goto sleep;
1935
1936         /* do we need to manage? */
1937         if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1938                 goto recheck;
1939
1940         /*
1941          * ->scheduled list can only be filled while a worker is
1942          * preparing to process a work or actually processing it.
1943          * Make sure nobody diddled with it while I was sleeping.
1944          */
1945         BUG_ON(!list_empty(&worker->scheduled));
1946
1947         /*
1948          * When control reaches this point, we're guaranteed to have
1949          * at least one idle worker or that someone else has already
1950          * assumed the manager role.
1951          */
1952         worker_clr_flags(worker, WORKER_PREP);
1953
1954         do {
1955                 struct work_struct *work =
1956                         list_first_entry(&gcwq->worklist,
1957                                          struct work_struct, entry);
1958
1959                 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1960                         /* optimization path, not strictly necessary */
1961                         process_one_work(worker, work);
1962                         if (unlikely(!list_empty(&worker->scheduled)))
1963                                 process_scheduled_works(worker);
1964                 } else {
1965                         move_linked_works(work, &worker->scheduled, NULL);
1966                         process_scheduled_works(worker);
1967                 }
1968         } while (keep_working(gcwq));
1969
1970         worker_set_flags(worker, WORKER_PREP, false);
1971 sleep:
1972         if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
1973                 goto recheck;
1974
1975         /*
1976          * gcwq->lock is held and there's no work to process and no
1977          * need to manage, sleep.  Workers are woken up only while
1978          * holding gcwq->lock or from local cpu, so setting the
1979          * current state before releasing gcwq->lock is enough to
1980          * prevent losing any event.
1981          */
1982         worker_enter_idle(worker);
1983         __set_current_state(TASK_INTERRUPTIBLE);
1984         spin_unlock_irq(&gcwq->lock);
1985         schedule();
1986         goto woke_up;
1987 }
1988
1989 /**
1990  * rescuer_thread - the rescuer thread function
1991  * @__wq: the associated workqueue
1992  *
1993  * Workqueue rescuer thread function.  There's one rescuer for each
1994  * workqueue which has WQ_RESCUER set.
1995  *
1996  * Regular work processing on a gcwq may block trying to create a new
1997  * worker which uses GFP_KERNEL allocation which has slight chance of
1998  * developing into deadlock if some works currently on the same queue
1999  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2000  * the problem rescuer solves.
2001  *
2002  * When such condition is possible, the gcwq summons rescuers of all
2003  * workqueues which have works queued on the gcwq and let them process
2004  * those works so that forward progress can be guaranteed.
2005  *
2006  * This should happen rarely.
2007  */
2008 static int rescuer_thread(void *__wq)
2009 {
2010         struct workqueue_struct *wq = __wq;
2011         struct worker *rescuer = wq->rescuer;
2012         struct list_head *scheduled = &rescuer->scheduled;
2013         bool is_unbound = wq->flags & WQ_UNBOUND;
2014         unsigned int cpu;
2015
2016         set_user_nice(current, RESCUER_NICE_LEVEL);
2017 repeat:
2018         set_current_state(TASK_INTERRUPTIBLE);
2019
2020         if (kthread_should_stop())
2021                 return 0;
2022
2023         /*
2024          * See whether any cpu is asking for help.  Unbounded
2025          * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2026          */
2027         for_each_mayday_cpu(cpu, wq->mayday_mask) {
2028                 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2029                 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2030                 struct global_cwq *gcwq = cwq->gcwq;
2031                 struct work_struct *work, *n;
2032
2033                 __set_current_state(TASK_RUNNING);
2034                 mayday_clear_cpu(cpu, wq->mayday_mask);
2035
2036                 /* migrate to the target cpu if possible */
2037                 rescuer->gcwq = gcwq;
2038                 worker_maybe_bind_and_lock(rescuer);
2039
2040                 /*
2041                  * Slurp in all works issued via this workqueue and
2042                  * process'em.
2043                  */
2044                 BUG_ON(!list_empty(&rescuer->scheduled));
2045                 list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
2046                         if (get_work_cwq(work) == cwq)
2047                                 move_linked_works(work, scheduled, &n);
2048
2049                 process_scheduled_works(rescuer);
2050
2051                 /*
2052                  * Leave this gcwq.  If keep_working() is %true, notify a
2053                  * regular worker; otherwise, we end up with 0 concurrency
2054                  * and stalling the execution.
2055                  */
2056                 if (keep_working(gcwq))
2057                         wake_up_worker(gcwq);
2058
2059                 spin_unlock_irq(&gcwq->lock);
2060         }
2061
2062         schedule();
2063         goto repeat;
2064 }
2065
2066 struct wq_barrier {
2067         struct work_struct      work;
2068         struct completion       done;
2069 };
2070
2071 static void wq_barrier_func(struct work_struct *work)
2072 {
2073         struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2074         complete(&barr->done);
2075 }
2076
2077 /**
2078  * insert_wq_barrier - insert a barrier work
2079  * @cwq: cwq to insert barrier into
2080  * @barr: wq_barrier to insert
2081  * @target: target work to attach @barr to
2082  * @worker: worker currently executing @target, NULL if @target is not executing
2083  *
2084  * @barr is linked to @target such that @barr is completed only after
2085  * @target finishes execution.  Please note that the ordering
2086  * guarantee is observed only with respect to @target and on the local
2087  * cpu.
2088  *
2089  * Currently, a queued barrier can't be canceled.  This is because
2090  * try_to_grab_pending() can't determine whether the work to be
2091  * grabbed is at the head of the queue and thus can't clear LINKED
2092  * flag of the previous work while there must be a valid next work
2093  * after a work with LINKED flag set.
2094  *
2095  * Note that when @worker is non-NULL, @target may be modified
2096  * underneath us, so we can't reliably determine cwq from @target.
2097  *
2098  * CONTEXT:
2099  * spin_lock_irq(gcwq->lock).
2100  */
2101 static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2102                               struct wq_barrier *barr,
2103                               struct work_struct *target, struct worker *worker)
2104 {
2105         struct list_head *head;
2106         unsigned int linked = 0;
2107
2108         /*
2109          * debugobject calls are safe here even with gcwq->lock locked
2110          * as we know for sure that this will not trigger any of the
2111          * checks and call back into the fixup functions where we
2112          * might deadlock.
2113          */
2114         INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
2115         __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2116         init_completion(&barr->done);
2117
2118         /*
2119          * If @target is currently being executed, schedule the
2120          * barrier to the worker; otherwise, put it after @target.
2121          */
2122         if (worker)
2123                 head = worker->scheduled.next;
2124         else {
2125                 unsigned long *bits = work_data_bits(target);
2126
2127                 head = target->entry.next;
2128                 /* there can already be other linked works, inherit and set */
2129                 linked = *bits & WORK_STRUCT_LINKED;
2130                 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2131         }
2132
2133         debug_work_activate(&barr->work);
2134         insert_work(cwq, &barr->work, head,
2135                     work_color_to_flags(WORK_NO_COLOR) | linked);
2136 }
2137
2138 /**
2139  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2140  * @wq: workqueue being flushed
2141  * @flush_color: new flush color, < 0 for no-op
2142  * @work_color: new work color, < 0 for no-op
2143  *
2144  * Prepare cwqs for workqueue flushing.
2145  *
2146  * If @flush_color is non-negative, flush_color on all cwqs should be
2147  * -1.  If no cwq has in-flight commands at the specified color, all
2148  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
2149  * has in flight commands, its cwq->flush_color is set to
2150  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2151  * wakeup logic is armed and %true is returned.
2152  *
2153  * The caller should have initialized @wq->first_flusher prior to
2154  * calling this function with non-negative @flush_color.  If
2155  * @flush_color is negative, no flush color update is done and %false
2156  * is returned.
2157  *
2158  * If @work_color is non-negative, all cwqs should have the same
2159  * work_color which is previous to @work_color and all will be
2160  * advanced to @work_color.
2161  *
2162  * CONTEXT:
2163  * mutex_lock(wq->flush_mutex).
2164  *
2165  * RETURNS:
2166  * %true if @flush_color >= 0 and there's something to flush.  %false
2167  * otherwise.
2168  */
2169 static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2170                                       int flush_color, int work_color)
2171 {
2172         bool wait = false;
2173         unsigned int cpu;
2174
2175         if (flush_color >= 0) {
2176                 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2177                 atomic_set(&wq->nr_cwqs_to_flush, 1);
2178         }
2179
2180         for_each_cwq_cpu(cpu, wq) {
2181                 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2182                 struct global_cwq *gcwq = cwq->gcwq;
2183
2184                 spin_lock_irq(&gcwq->lock);
2185
2186                 if (flush_color >= 0) {
2187                         BUG_ON(cwq->flush_color != -1);
2188
2189                         if (cwq->nr_in_flight[flush_color]) {
2190                                 cwq->flush_color = flush_color;
2191                                 atomic_inc(&wq->nr_cwqs_to_flush);
2192                                 wait = true;
2193                         }
2194                 }
2195
2196                 if (work_color >= 0) {
2197                         BUG_ON(work_color != work_next_color(cwq->work_color));
2198                         cwq->work_color = work_color;
2199                 }
2200
2201                 spin_unlock_irq(&gcwq->lock);
2202         }
2203
2204         if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2205                 complete(&wq->first_flusher->done);
2206
2207         return wait;
2208 }
2209
2210 /**
2211  * flush_workqueue - ensure that any scheduled work has run to completion.
2212  * @wq: workqueue to flush
2213  *
2214  * Forces execution of the workqueue and blocks until its completion.
2215  * This is typically used in driver shutdown handlers.
2216  *
2217  * We sleep until all works which were queued on entry have been handled,
2218  * but we are not livelocked by new incoming ones.
2219  */
2220 void flush_workqueue(struct workqueue_struct *wq)
2221 {
2222         struct wq_flusher this_flusher = {
2223                 .list = LIST_HEAD_INIT(this_flusher.list),
2224                 .flush_color = -1,
2225                 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2226         };
2227         int next_color;
2228
2229         lock_map_acquire(&wq->lockdep_map);
2230         lock_map_release(&wq->lockdep_map);
2231
2232         mutex_lock(&wq->flush_mutex);
2233
2234         /*
2235          * Start-to-wait phase
2236          */
2237         next_color = work_next_color(wq->work_color);
2238
2239         if (next_color != wq->flush_color) {
2240                 /*
2241                  * Color space is not full.  The current work_color
2242                  * becomes our flush_color and work_color is advanced
2243                  * by one.
2244                  */
2245                 BUG_ON(!list_empty(&wq->flusher_overflow));
2246                 this_flusher.flush_color = wq->work_color;
2247                 wq->work_color = next_color;
2248
2249                 if (!wq->first_flusher) {
2250                         /* no flush in progress, become the first flusher */
2251                         BUG_ON(wq->flush_color != this_flusher.flush_color);
2252
2253                         wq->first_flusher = &this_flusher;
2254
2255                         if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2256                                                        wq->work_color)) {
2257                                 /* nothing to flush, done */
2258                                 wq->flush_color = next_color;
2259                                 wq->first_flusher = NULL;
2260                                 goto out_unlock;
2261                         }
2262                 } else {
2263                         /* wait in queue */
2264                         BUG_ON(wq->flush_color == this_flusher.flush_color);
2265                         list_add_tail(&this_flusher.list, &wq->flusher_queue);
2266                         flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2267                 }
2268         } else {
2269                 /*
2270                  * Oops, color space is full, wait on overflow queue.
2271                  * The next flush completion will assign us
2272                  * flush_color and transfer to flusher_queue.
2273                  */
2274                 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2275         }
2276
2277         mutex_unlock(&wq->flush_mutex);
2278
2279         wait_for_completion(&this_flusher.done);
2280
2281         /*
2282          * Wake-up-and-cascade phase
2283          *
2284          * First flushers are responsible for cascading flushes and
2285          * handling overflow.  Non-first flushers can simply return.
2286          */
2287         if (wq->first_flusher != &this_flusher)
2288                 return;
2289
2290         mutex_lock(&wq->flush_mutex);
2291
2292         /* we might have raced, check again with mutex held */
2293         if (wq->first_flusher != &this_flusher)
2294                 goto out_unlock;
2295
2296         wq->first_flusher = NULL;
2297
2298         BUG_ON(!list_empty(&this_flusher.list));
2299         BUG_ON(wq->flush_color != this_flusher.flush_color);
2300
2301         while (true) {
2302                 struct wq_flusher *next, *tmp;
2303
2304                 /* complete all the flushers sharing the current flush color */
2305                 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2306                         if (next->flush_color != wq->flush_color)
2307                                 break;
2308                         list_del_init(&next->list);
2309                         complete(&next->done);
2310                 }
2311
2312                 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2313                        wq->flush_color != work_next_color(wq->work_color));
2314
2315                 /* this flush_color is finished, advance by one */
2316                 wq->flush_color = work_next_color(wq->flush_color);
2317
2318                 /* one color has been freed, handle overflow queue */
2319                 if (!list_empty(&wq->flusher_overflow)) {
2320                         /*
2321                          * Assign the same color to all overflowed
2322                          * flushers, advance work_color and append to
2323                          * flusher_queue.  This is the start-to-wait
2324                          * phase for these overflowed flushers.
2325                          */
2326                         list_for_each_entry(tmp, &wq->flusher_overflow, list)
2327                                 tmp->flush_color = wq->work_color;
2328
2329                         wq->work_color = work_next_color(wq->work_color);
2330
2331                         list_splice_tail_init(&wq->flusher_overflow,
2332                                               &wq->flusher_queue);
2333                         flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2334                 }
2335
2336                 if (list_empty(&wq->flusher_queue)) {
2337                         BUG_ON(wq->flush_color != wq->work_color);
2338                         break;
2339                 }
2340
2341                 /*
2342                  * Need to flush more colors.  Make the next flusher
2343                  * the new first flusher and arm cwqs.
2344                  */
2345                 BUG_ON(wq->flush_color == wq->work_color);
2346                 BUG_ON(wq->flush_color != next->flush_color);
2347
2348                 list_del_init(&next->list);
2349                 wq->first_flusher = next;
2350
2351                 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2352                         break;
2353
2354                 /*
2355                  * Meh... this color is already done, clear first
2356                  * flusher and repeat cascading.
2357                  */
2358                 wq->first_flusher = NULL;
2359         }
2360
2361 out_unlock:
2362         mutex_unlock(&wq->flush_mutex);
2363 }
2364 EXPORT_SYMBOL_GPL(flush_workqueue);
2365
2366 static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2367                              bool wait_executing)
2368 {
2369         struct worker *worker = NULL;
2370         struct global_cwq *gcwq;
2371         struct cpu_workqueue_struct *cwq;
2372
2373         might_sleep();
2374         gcwq = get_work_gcwq(work);
2375         if (!gcwq)
2376                 return false;
2377
2378         spin_lock_irq(&gcwq->lock);
2379         if (!list_empty(&work->entry)) {
2380                 /*
2381                  * See the comment near try_to_grab_pending()->smp_rmb().
2382                  * If it was re-queued to a different gcwq under us, we
2383                  * are not going to wait.
2384                  */
2385                 smp_rmb();
2386                 cwq = get_work_cwq(work);
2387                 if (unlikely(!cwq || gcwq != cwq->gcwq))
2388                         goto already_gone;
2389         } else if (wait_executing) {
2390                 worker = find_worker_executing_work(gcwq, work);
2391                 if (!worker)
2392                         goto already_gone;
2393                 cwq = worker->current_cwq;
2394         } else
2395                 goto already_gone;
2396
2397         insert_wq_barrier(cwq, barr, work, worker);
2398         spin_unlock_irq(&gcwq->lock);
2399
2400         /*
2401          * If @max_active is 1 or rescuer is in use, flushing another work
2402          * item on the same workqueue may lead to deadlock.  Make sure the
2403          * flusher is not running on the same workqueue by verifying write
2404          * access.
2405          */
2406         if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2407                 lock_map_acquire(&cwq->wq->lockdep_map);
2408         else
2409                 lock_map_acquire_read(&cwq->wq->lockdep_map);
2410         lock_map_release(&cwq->wq->lockdep_map);
2411
2412         return true;
2413 already_gone:
2414         spin_unlock_irq(&gcwq->lock);
2415         return false;
2416 }
2417
2418 /**
2419  * flush_work - wait for a work to finish executing the last queueing instance
2420  * @work: the work to flush
2421  *
2422  * Wait until @work has finished execution.  This function considers
2423  * only the last queueing instance of @work.  If @work has been
2424  * enqueued across different CPUs on a non-reentrant workqueue or on
2425  * multiple workqueues, @work might still be executing on return on
2426  * some of the CPUs from earlier queueing.
2427  *
2428  * If @work was queued only on a non-reentrant, ordered or unbound
2429  * workqueue, @work is guaranteed to be idle on return if it hasn't
2430  * been requeued since flush started.
2431  *
2432  * RETURNS:
2433  * %true if flush_work() waited for the work to finish execution,
2434  * %false if it was already idle.
2435  */
2436 bool flush_work(struct work_struct *work)
2437 {
2438         struct wq_barrier barr;
2439
2440         if (start_flush_work(work, &barr, true)) {
2441                 wait_for_completion(&barr.done);
2442                 destroy_work_on_stack(&barr.work);
2443                 return true;
2444         } else
2445                 return false;
2446 }
2447 EXPORT_SYMBOL_GPL(flush_work);
2448
2449 static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2450 {
2451         struct wq_barrier barr;
2452         struct worker *worker;
2453
2454         spin_lock_irq(&gcwq->lock);
2455
2456         worker = find_worker_executing_work(gcwq, work);
2457         if (unlikely(worker))
2458                 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2459
2460         spin_unlock_irq(&gcwq->lock);
2461
2462         if (unlikely(worker)) {
2463                 wait_for_completion(&barr.done);
2464                 destroy_work_on_stack(&barr.work);
2465                 return true;
2466         } else
2467                 return false;
2468 }
2469
2470 static bool wait_on_work(struct work_struct *work)
2471 {
2472         bool ret = false;
2473         int cpu;
2474
2475         might_sleep();
2476
2477         lock_map_acquire(&work->lockdep_map);
2478         lock_map_release(&work->lockdep_map);
2479
2480         for_each_gcwq_cpu(cpu)
2481                 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2482         return ret;
2483 }
2484
2485 /**
2486  * flush_work_sync - wait until a work has finished execution
2487  * @work: the work to flush
2488  *
2489  * Wait until @work has finished execution.  On return, it's
2490  * guaranteed that all queueing instances of @work which happened
2491  * before this function is called are finished.  In other words, if
2492  * @work hasn't been requeued since this function was called, @work is
2493  * guaranteed to be idle on return.
2494  *
2495  * RETURNS:
2496  * %true if flush_work_sync() waited for the work to finish execution,
2497  * %false if it was already idle.
2498  */
2499 bool flush_work_sync(struct work_struct *work)
2500 {
2501         struct wq_barrier barr;
2502         bool pending, waited;
2503
2504         /* we'll wait for executions separately, queue barr only if pending */
2505         pending = start_flush_work(work, &barr, false);
2506
2507         /* wait for executions to finish */
2508         waited = wait_on_work(work);
2509
2510         /* wait for the pending one */
2511         if (pending) {
2512                 wait_for_completion(&barr.done);
2513                 destroy_work_on_stack(&barr.work);
2514         }
2515
2516         return pending || waited;
2517 }
2518 EXPORT_SYMBOL_GPL(flush_work_sync);
2519
2520 /*
2521  * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
2522  * so this work can't be re-armed in any way.
2523  */
2524 static int try_to_grab_pending(struct work_struct *work)
2525 {
2526         struct global_cwq *gcwq;
2527         int ret = -1;
2528
2529         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
2530                 return 0;
2531
2532         /*
2533          * The queueing is in progress, or it is already queued. Try to
2534          * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2535          */
2536         gcwq = get_work_gcwq(work);
2537         if (!gcwq)
2538                 return ret;
2539
2540         spin_lock_irq(&gcwq->lock);
2541         if (!list_empty(&work->entry)) {
2542                 /*
2543                  * This work is queued, but perhaps we locked the wrong gcwq.
2544                  * In that case we must see the new value after rmb(), see
2545                  * insert_work()->wmb().
2546                  */
2547                 smp_rmb();
2548                 if (gcwq == get_work_gcwq(work)) {
2549                         debug_work_deactivate(work);
2550                         list_del_init(&work->entry);
2551                         cwq_dec_nr_in_flight(get_work_cwq(work),
2552                                 get_work_color(work),
2553                                 *work_data_bits(work) & WORK_STRUCT_DELAYED);
2554                         ret = 1;
2555                 }
2556         }
2557         spin_unlock_irq(&gcwq->lock);
2558
2559         return ret;
2560 }
2561
2562 static bool __cancel_work_timer(struct work_struct *work,
2563                                 struct timer_list* timer)
2564 {
2565         int ret;
2566
2567         do {
2568                 ret = (timer && likely(del_timer(timer)));
2569                 if (!ret)
2570                         ret = try_to_grab_pending(work);
2571                 wait_on_work(work);
2572         } while (unlikely(ret < 0));
2573
2574         clear_work_data(work);
2575         return ret;
2576 }
2577
2578 /**
2579  * cancel_work_sync - cancel a work and wait for it to finish
2580  * @work: the work to cancel
2581  *
2582  * Cancel @work and wait for its execution to finish.  This function
2583  * can be used even if the work re-queues itself or migrates to
2584  * another workqueue.  On return from this function, @work is
2585  * guaranteed to be not pending or executing on any CPU.
2586  *
2587  * cancel_work_sync(&delayed_work->work) must not be used for
2588  * delayed_work's.  Use cancel_delayed_work_sync() instead.
2589  *
2590  * The caller must ensure that the workqueue on which @work was last
2591  * queued can't be destroyed before this function returns.
2592  *
2593  * RETURNS:
2594  * %true if @work was pending, %false otherwise.
2595  */
2596 bool cancel_work_sync(struct work_struct *work)
2597 {
2598         return __cancel_work_timer(work, NULL);
2599 }
2600 EXPORT_SYMBOL_GPL(cancel_work_sync);
2601
2602 /**
2603  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2604  * @dwork: the delayed work to flush
2605  *
2606  * Delayed timer is cancelled and the pending work is queued for
2607  * immediate execution.  Like flush_work(), this function only
2608  * considers the last queueing instance of @dwork.
2609  *
2610  * RETURNS:
2611  * %true if flush_work() waited for the work to finish execution,
2612  * %false if it was already idle.
2613  */
2614 bool flush_delayed_work(struct delayed_work *dwork)
2615 {
2616         if (del_timer_sync(&dwork->timer))
2617                 __queue_work(raw_smp_processor_id(),
2618                              get_work_cwq(&dwork->work)->wq, &dwork->work);
2619         return flush_work(&dwork->work);
2620 }
2621 EXPORT_SYMBOL(flush_delayed_work);
2622
2623 /**
2624  * flush_delayed_work_sync - wait for a dwork to finish
2625  * @dwork: the delayed work to flush
2626  *
2627  * Delayed timer is cancelled and the pending work is queued for
2628  * execution immediately.  Other than timer handling, its behavior
2629  * is identical to flush_work_sync().
2630  *
2631  * RETURNS:
2632  * %true if flush_work_sync() waited for the work to finish execution,
2633  * %false if it was already idle.
2634  */
2635 bool flush_delayed_work_sync(struct delayed_work *dwork)
2636 {
2637         if (del_timer_sync(&dwork->timer))
2638                 __queue_work(raw_smp_processor_id(),
2639                              get_work_cwq(&dwork->work)->wq, &dwork->work);
2640         return flush_work_sync(&dwork->work);
2641 }
2642 EXPORT_SYMBOL(flush_delayed_work_sync);
2643
2644 /**
2645  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2646  * @dwork: the delayed work cancel
2647  *
2648  * This is cancel_work_sync() for delayed works.
2649  *
2650  * RETURNS:
2651  * %true if @dwork was pending, %false otherwise.
2652  */
2653 bool cancel_delayed_work_sync(struct delayed_work *dwork)
2654 {
2655         return __cancel_work_timer(&dwork->work, &dwork->timer);
2656 }
2657 EXPORT_SYMBOL(cancel_delayed_work_sync);
2658
2659 /**
2660  * schedule_work - put work task in global workqueue
2661  * @work: job to be done
2662  *
2663  * Returns zero if @work was already on the kernel-global workqueue and
2664  * non-zero otherwise.
2665  *
2666  * This puts a job in the kernel-global workqueue if it was not already
2667  * queued and leaves it in the same position on the kernel-global
2668  * workqueue otherwise.
2669  */
2670 int schedule_work(struct work_struct *work)
2671 {
2672         return queue_work(system_wq, work);
2673 }
2674 EXPORT_SYMBOL(schedule_work);
2675
2676 /*
2677  * schedule_work_on - put work task on a specific cpu
2678  * @cpu: cpu to put the work task on
2679  * @work: job to be done
2680  *
2681  * This puts a job on a specific cpu
2682  */
2683 int schedule_work_on(int cpu, struct work_struct *work)
2684 {
2685         return queue_work_on(cpu, system_wq, work);
2686 }
2687 EXPORT_SYMBOL(schedule_work_on);
2688
2689 /**
2690  * schedule_delayed_work - put work task in global workqueue after delay
2691  * @dwork: job to be done
2692  * @delay: number of jiffies to wait or 0 for immediate execution
2693  *
2694  * After waiting for a given time this puts a job in the kernel-global
2695  * workqueue.
2696  */
2697 int schedule_delayed_work(struct delayed_work *dwork,
2698                                         unsigned long delay)
2699 {
2700         return queue_delayed_work(system_wq, dwork, delay);
2701 }
2702 EXPORT_SYMBOL(schedule_delayed_work);
2703
2704 /**
2705  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2706  * @cpu: cpu to use
2707  * @dwork: job to be done
2708  * @delay: number of jiffies to wait
2709  *
2710  * After waiting for a given time this puts a job in the kernel-global
2711  * workqueue on the specified CPU.
2712  */
2713 int schedule_delayed_work_on(int cpu,
2714                         struct delayed_work *dwork, unsigned long delay)
2715 {
2716         return queue_delayed_work_on(cpu, system_wq, dwork, delay);
2717 }
2718 EXPORT_SYMBOL(schedule_delayed_work_on);
2719
2720 /**
2721  * schedule_on_each_cpu - execute a function synchronously on each online CPU
2722  * @func: the function to call
2723  *
2724  * schedule_on_each_cpu() executes @func on each online CPU using the
2725  * system workqueue and blocks until all CPUs have completed.
2726  * schedule_on_each_cpu() is very slow.
2727  *
2728  * RETURNS:
2729  * 0 on success, -errno on failure.
2730  */
2731 int schedule_on_each_cpu(work_func_t func)
2732 {
2733         int cpu;
2734         struct work_struct __percpu *works;
2735
2736         works = alloc_percpu(struct work_struct);
2737         if (!works)
2738                 return -ENOMEM;
2739
2740         get_online_cpus();
2741
2742         for_each_online_cpu(cpu) {
2743                 struct work_struct *work = per_cpu_ptr(works, cpu);
2744
2745                 INIT_WORK(work, func);
2746                 schedule_work_on(cpu, work);
2747         }
2748
2749         for_each_online_cpu(cpu)
2750                 flush_work(per_cpu_ptr(works, cpu));
2751
2752         put_online_cpus();
2753         free_percpu(works);
2754         return 0;
2755 }
2756
2757 /**
2758  * flush_scheduled_work - ensure that any scheduled work has run to completion.
2759  *
2760  * Forces execution of the kernel-global workqueue and blocks until its
2761  * completion.
2762  *
2763  * Think twice before calling this function!  It's very easy to get into
2764  * trouble if you don't take great care.  Either of the following situations
2765  * will lead to deadlock:
2766  *
2767  *      One of the work items currently on the workqueue needs to acquire
2768  *      a lock held by your code or its caller.
2769  *
2770  *      Your code is running in the context of a work routine.
2771  *
2772  * They will be detected by lockdep when they occur, but the first might not
2773  * occur very often.  It depends on what work items are on the workqueue and
2774  * what locks they need, which you have no control over.
2775  *
2776  * In most situations flushing the entire workqueue is overkill; you merely
2777  * need to know that a particular work item isn't queued and isn't running.
2778  * In such cases you should use cancel_delayed_work_sync() or
2779  * cancel_work_sync() instead.
2780  */
2781 void flush_scheduled_work(void)
2782 {
2783         flush_workqueue(system_wq);
2784 }
2785 EXPORT_SYMBOL(flush_scheduled_work);
2786
2787 /**
2788  * execute_in_process_context - reliably execute the routine with user context
2789  * @fn:         the function to execute
2790  * @ew:         guaranteed storage for the execute work structure (must
2791  *              be available when the work executes)
2792  *
2793  * Executes the function immediately if process context is available,
2794  * otherwise schedules the function for delayed execution.
2795  *
2796  * Returns:     0 - function was executed
2797  *              1 - function was scheduled for execution
2798  */
2799 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
2800 {
2801         if (!in_interrupt()) {
2802                 fn(&ew->work);
2803                 return 0;
2804         }
2805
2806         INIT_WORK(&ew->work, fn);
2807         schedule_work(&ew->work);
2808
2809         return 1;
2810 }
2811 EXPORT_SYMBOL_GPL(execute_in_process_context);
2812
2813 int keventd_up(void)
2814 {
2815         return system_wq != NULL;
2816 }
2817
2818 static int alloc_cwqs(struct workqueue_struct *wq)
2819 {
2820         /*
2821          * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
2822          * Make sure that the alignment isn't lower than that of
2823          * unsigned long long.
2824          */
2825         const size_t size = sizeof(struct cpu_workqueue_struct);
2826         const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
2827                                    __alignof__(unsigned long long));
2828 #ifdef CONFIG_SMP
2829         bool percpu = !(wq->flags & WQ_UNBOUND);
2830 #else
2831         bool percpu = false;
2832 #endif
2833
2834         if (percpu)
2835                 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2836         else {
2837                 void *ptr;
2838
2839                 /*
2840                  * Allocate enough room to align cwq and put an extra
2841                  * pointer at the end pointing back to the originally
2842                  * allocated pointer which will be used for free.
2843                  */
2844                 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2845                 if (ptr) {
2846                         wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2847                         *(void **)(wq->cpu_wq.single + 1) = ptr;
2848                 }
2849         }
2850
2851         /* just in case, make sure it's actually aligned
2852          * - this is affected by PERCPU() alignment in vmlinux.lds.S
2853          */
2854         BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2855         return wq->cpu_wq.v ? 0 : -ENOMEM;
2856 }
2857
2858 static void free_cwqs(struct workqueue_struct *wq)
2859 {
2860 #ifdef CONFIG_SMP
2861         bool percpu = !(wq->flags & WQ_UNBOUND);
2862 #else
2863         bool percpu = false;
2864 #endif
2865
2866         if (percpu)
2867                 free_percpu(wq->cpu_wq.pcpu);
2868         else if (wq->cpu_wq.single) {
2869                 /* the pointer to free is stored right after the cwq */
2870                 kfree(*(void **)(wq->cpu_wq.single + 1));
2871         }
2872 }
2873
2874 static int wq_clamp_max_active(int max_active, unsigned int flags,
2875                                const char *name)
2876 {
2877         int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2878
2879         if (max_active < 1 || max_active > lim)
2880                 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2881                        "is out of range, clamping between %d and %d\n",
2882                        max_active, name, 1, lim);
2883
2884         return clamp_val(max_active, 1, lim);
2885 }
2886
2887 struct workqueue_struct *__alloc_workqueue_key(const char *name,
2888                                                unsigned int flags,
2889                                                int max_active,
2890                                                struct lock_class_key *key,
2891                                                const char *lock_name)
2892 {
2893         struct workqueue_struct *wq;
2894         unsigned int cpu;
2895
2896         /*
2897          * Workqueues which may be used during memory reclaim should
2898          * have a rescuer to guarantee forward progress.
2899          */
2900         if (flags & WQ_MEM_RECLAIM)
2901                 flags |= WQ_RESCUER;
2902
2903         /*
2904          * Unbound workqueues aren't concurrency managed and should be
2905          * dispatched to workers immediately.
2906          */
2907         if (flags & WQ_UNBOUND)
2908                 flags |= WQ_HIGHPRI;
2909
2910         max_active = max_active ?: WQ_DFL_ACTIVE;
2911         max_active = wq_clamp_max_active(max_active, flags, name);
2912
2913         wq = kzalloc(sizeof(*wq), GFP_KERNEL);
2914         if (!wq)
2915                 goto err;
2916
2917         wq->flags = flags;
2918         wq->saved_max_active = max_active;
2919         mutex_init(&wq->flush_mutex);
2920         atomic_set(&wq->nr_cwqs_to_flush, 0);
2921         INIT_LIST_HEAD(&wq->flusher_queue);
2922         INIT_LIST_HEAD(&wq->flusher_overflow);
2923
2924         wq->name = name;
2925         lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
2926         INIT_LIST_HEAD(&wq->list);
2927
2928         if (alloc_cwqs(wq) < 0)
2929                 goto err;
2930
2931         for_each_cwq_cpu(cpu, wq) {
2932                 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2933                 struct global_cwq *gcwq = get_gcwq(cpu);
2934
2935                 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
2936                 cwq->gcwq = gcwq;
2937                 cwq->wq = wq;
2938                 cwq->flush_color = -1;
2939                 cwq->max_active = max_active;
2940                 INIT_LIST_HEAD(&cwq->delayed_works);
2941         }
2942
2943         if (flags & WQ_RESCUER) {
2944                 struct worker *rescuer;
2945
2946                 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
2947                         goto err;
2948
2949                 wq->rescuer = rescuer = alloc_worker();
2950                 if (!rescuer)
2951                         goto err;
2952
2953                 rescuer->task = kthread_create(rescuer_thread, wq, "%s", name);
2954                 if (IS_ERR(rescuer->task))
2955                         goto err;
2956
2957                 rescuer->task->flags |= PF_THREAD_BOUND;
2958                 wake_up_process(rescuer->task);
2959         }
2960
2961         /*
2962          * workqueue_lock protects global freeze state and workqueues
2963          * list.  Grab it, set max_active accordingly and add the new
2964          * workqueue to workqueues list.
2965          */
2966         spin_lock(&workqueue_lock);
2967
2968         if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
2969                 for_each_cwq_cpu(cpu, wq)
2970                         get_cwq(cpu, wq)->max_active = 0;
2971
2972         list_add(&wq->list, &workqueues);
2973
2974         spin_unlock(&workqueue_lock);
2975
2976         return wq;
2977 err:
2978         if (wq) {
2979                 free_cwqs(wq);
2980                 free_mayday_mask(wq->mayday_mask);
2981                 kfree(wq->rescuer);
2982                 kfree(wq);
2983         }
2984         return NULL;
2985 }
2986 EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
2987
2988 /**
2989  * destroy_workqueue - safely terminate a workqueue
2990  * @wq: target workqueue
2991  *
2992  * Safely destroy a workqueue. All work currently pending will be done first.
2993  */
2994 void destroy_workqueue(struct workqueue_struct *wq)
2995 {
2996         unsigned int flush_cnt = 0;
2997         unsigned int cpu;
2998
2999         /*
3000          * Mark @wq dying and drain all pending works.  Once WQ_DYING is
3001          * set, only chain queueing is allowed.  IOW, only currently
3002          * pending or running work items on @wq can queue further work
3003          * items on it.  @wq is flushed repeatedly until it becomes empty.
3004          * The number of flushing is detemined by the depth of chaining and
3005          * should be relatively short.  Whine if it takes too long.
3006          */
3007         wq->flags |= WQ_DYING;
3008 reflush:
3009         flush_workqueue(wq);
3010
3011         for_each_cwq_cpu(cpu, wq) {
3012                 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3013
3014                 if (!cwq->nr_active && list_empty(&cwq->delayed_works))
3015                         continue;
3016
3017                 if (++flush_cnt == 10 ||
3018                     (flush_cnt % 100 == 0 && flush_cnt <= 1000))
3019                         printk(KERN_WARNING "workqueue %s: flush on "
3020                                "destruction isn't complete after %u tries\n",
3021                                wq->name, flush_cnt);
3022                 goto reflush;
3023         }
3024
3025         /*
3026          * wq list is used to freeze wq, remove from list after
3027          * flushing is complete in case freeze races us.
3028          */
3029         spin_lock(&workqueue_lock);
3030         list_del(&wq->list);
3031         spin_unlock(&workqueue_lock);
3032
3033         /* sanity check */
3034         for_each_cwq_cpu(cpu, wq) {
3035                 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3036                 int i;
3037
3038                 for (i = 0; i < WORK_NR_COLORS; i++)
3039                         BUG_ON(cwq->nr_in_flight[i]);
3040                 BUG_ON(cwq->nr_active);
3041                 BUG_ON(!list_empty(&cwq->delayed_works));
3042         }
3043
3044         if (wq->flags & WQ_RESCUER) {
3045                 kthread_stop(wq->rescuer->task);
3046                 free_mayday_mask(wq->mayday_mask);
3047                 kfree(wq->rescuer);
3048         }
3049
3050         free_cwqs(wq);
3051         kfree(wq);
3052 }
3053 EXPORT_SYMBOL_GPL(destroy_workqueue);
3054
3055 /**
3056  * workqueue_set_max_active - adjust max_active of a workqueue
3057  * @wq: target workqueue
3058  * @max_active: new max_active value.
3059  *
3060  * Set max_active of @wq to @max_active.
3061  *
3062  * CONTEXT:
3063  * Don't call from IRQ context.
3064  */
3065 void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3066 {
3067         unsigned int cpu;
3068
3069         max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3070
3071         spin_lock(&workqueue_lock);
3072
3073         wq->saved_max_active = max_active;
3074
3075         for_each_cwq_cpu(cpu, wq) {
3076                 struct global_cwq *gcwq = get_gcwq(cpu);
3077
3078                 spin_lock_irq(&gcwq->lock);
3079
3080                 if (!(wq->flags & WQ_FREEZABLE) ||
3081                     !(gcwq->flags & GCWQ_FREEZING))
3082                         get_cwq(gcwq->cpu, wq)->max_active = max_active;
3083
3084                 spin_unlock_irq(&gcwq->lock);
3085         }
3086
3087         spin_unlock(&workqueue_lock);
3088 }
3089 EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3090
3091 /**
3092  * workqueue_congested - test whether a workqueue is congested
3093  * @cpu: CPU in question
3094  * @wq: target workqueue
3095  *
3096  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3097  * no synchronization around this function and the test result is
3098  * unreliable and only useful as advisory hints or for debugging.
3099  *
3100  * RETURNS:
3101  * %true if congested, %false otherwise.
3102  */
3103 bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3104 {
3105         struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3106
3107         return !list_empty(&cwq->delayed_works);
3108 }
3109 EXPORT_SYMBOL_GPL(workqueue_congested);
3110
3111 /**
3112  * work_cpu - return the last known associated cpu for @work
3113  * @work: the work of interest
3114  *
3115  * RETURNS:
3116  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3117  */
3118 unsigned int work_cpu(struct work_struct *work)
3119 {
3120         struct global_cwq *gcwq = get_work_gcwq(work);
3121
3122         return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3123 }
3124 EXPORT_SYMBOL_GPL(work_cpu);
3125
3126 /**
3127  * work_busy - test whether a work is currently pending or running
3128  * @work: the work to be tested
3129  *
3130  * Test whether @work is currently pending or running.  There is no
3131  * synchronization around this function and the test result is
3132  * unreliable and only useful as advisory hints or for debugging.
3133  * Especially for reentrant wqs, the pending state might hide the
3134  * running state.
3135  *
3136  * RETURNS:
3137  * OR'd bitmask of WORK_BUSY_* bits.
3138  */
3139 unsigned int work_busy(struct work_struct *work)
3140 {
3141         struct global_cwq *gcwq = get_work_gcwq(work);
3142         unsigned long flags;
3143         unsigned int ret = 0;
3144
3145         if (!gcwq)
3146                 return false;
3147
3148         spin_lock_irqsave(&gcwq->lock, flags);
3149
3150         if (work_pending(work))
3151                 ret |= WORK_BUSY_PENDING;
3152         if (find_worker_executing_work(gcwq, work))
3153                 ret |= WORK_BUSY_RUNNING;
3154
3155         spin_unlock_irqrestore(&gcwq->lock, flags);
3156
3157         return ret;
3158 }
3159 EXPORT_SYMBOL_GPL(work_busy);
3160
3161 /*
3162  * CPU hotplug.
3163  *
3164  * There are two challenges in supporting CPU hotplug.  Firstly, there
3165  * are a lot of assumptions on strong associations among work, cwq and
3166  * gcwq which make migrating pending and scheduled works very
3167  * difficult to implement without impacting hot paths.  Secondly,
3168  * gcwqs serve mix of short, long and very long running works making
3169  * blocked draining impractical.
3170  *
3171  * This is solved by allowing a gcwq to be detached from CPU, running
3172  * it with unbound (rogue) workers and allowing it to be reattached
3173  * later if the cpu comes back online.  A separate thread is created
3174  * to govern a gcwq in such state and is called the trustee of the
3175  * gcwq.
3176  *
3177  * Trustee states and their descriptions.
3178  *
3179  * START        Command state used on startup.  On CPU_DOWN_PREPARE, a
3180  *              new trustee is started with this state.
3181  *
3182  * IN_CHARGE    Once started, trustee will enter this state after
3183  *              assuming the manager role and making all existing
3184  *              workers rogue.  DOWN_PREPARE waits for trustee to
3185  *              enter this state.  After reaching IN_CHARGE, trustee
3186  *              tries to execute the pending worklist until it's empty
3187  *              and the state is set to BUTCHER, or the state is set
3188  *              to RELEASE.
3189  *
3190  * BUTCHER      Command state which is set by the cpu callback after
3191  *              the cpu has went down.  Once this state is set trustee
3192  *              knows that there will be no new works on the worklist
3193  *              and once the worklist is empty it can proceed to
3194  *              killing idle workers.
3195  *
3196  * RELEASE      Command state which is set by the cpu callback if the
3197  *              cpu down has been canceled or it has come online
3198  *              again.  After recognizing this state, trustee stops
3199  *              trying to drain or butcher and clears ROGUE, rebinds
3200  *              all remaining workers back to the cpu and releases
3201  *              manager role.
3202  *
3203  * DONE         Trustee will enter this state after BUTCHER or RELEASE
3204  *              is complete.
3205  *
3206  *          trustee                 CPU                draining
3207  *         took over                down               complete
3208  * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3209  *                        |                     |                  ^
3210  *                        | CPU is back online  v   return workers |
3211  *                         ----------------> RELEASE --------------
3212  */
3213
3214 /**
3215  * trustee_wait_event_timeout - timed event wait for trustee
3216  * @cond: condition to wait for
3217  * @timeout: timeout in jiffies
3218  *
3219  * wait_event_timeout() for trustee to use.  Handles locking and
3220  * checks for RELEASE request.
3221  *
3222  * CONTEXT:
3223  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3224  * multiple times.  To be used by trustee.
3225  *
3226  * RETURNS:
3227  * Positive indicating left time if @cond is satisfied, 0 if timed
3228  * out, -1 if canceled.
3229  */
3230 #define trustee_wait_event_timeout(cond, timeout) ({                    \
3231         long __ret = (timeout);                                         \
3232         while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
3233                __ret) {                                                 \
3234                 spin_unlock_irq(&gcwq->lock);                           \
3235                 __wait_event_timeout(gcwq->trustee_wait, (cond) ||      \
3236                         (gcwq->trustee_state == TRUSTEE_RELEASE),       \
3237                         __ret);                                         \
3238                 spin_lock_irq(&gcwq->lock);                             \
3239         }                                                               \
3240         gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret);          \
3241 })
3242
3243 /**
3244  * trustee_wait_event - event wait for trustee
3245  * @cond: condition to wait for
3246  *
3247  * wait_event() for trustee to use.  Automatically handles locking and
3248  * checks for CANCEL request.
3249  *
3250  * CONTEXT:
3251  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3252  * multiple times.  To be used by trustee.
3253  *
3254  * RETURNS:
3255  * 0 if @cond is satisfied, -1 if canceled.
3256  */
3257 #define trustee_wait_event(cond) ({                                     \
3258         long __ret1;                                                    \
3259         __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3260         __ret1 < 0 ? -1 : 0;                                            \
3261 })
3262
3263 static int __cpuinit trustee_thread(void *__gcwq)
3264 {
3265         struct global_cwq *gcwq = __gcwq;
3266         struct worker *worker;
3267         struct work_struct *work;
3268         struct hlist_node *pos;
3269         long rc;
3270         int i;
3271
3272         BUG_ON(gcwq->cpu != smp_processor_id());
3273
3274         spin_lock_irq(&gcwq->lock);
3275         /*
3276          * Claim the manager position and make all workers rogue.
3277          * Trustee must be bound to the target cpu and can't be
3278          * cancelled.
3279          */
3280         BUG_ON(gcwq->cpu != smp_processor_id());
3281         rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3282         BUG_ON(rc < 0);
3283
3284         gcwq->flags |= GCWQ_MANAGING_WORKERS;
3285
3286         list_for_each_entry(worker, &gcwq->idle_list, entry)
3287                 worker->flags |= WORKER_ROGUE;
3288
3289         for_each_busy_worker(worker, i, pos, gcwq)
3290                 worker->flags |= WORKER_ROGUE;
3291
3292         /*
3293          * Call schedule() so that we cross rq->lock and thus can
3294          * guarantee sched callbacks see the rogue flag.  This is
3295          * necessary as scheduler callbacks may be invoked from other
3296          * cpus.
3297          */
3298         spin_unlock_irq(&gcwq->lock);
3299         schedule();
3300         spin_lock_irq(&gcwq->lock);
3301
3302         /*
3303          * Sched callbacks are disabled now.  Zap nr_running.  After
3304          * this, nr_running stays zero and need_more_worker() and
3305          * keep_working() are always true as long as the worklist is
3306          * not empty.
3307          */
3308         atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
3309
3310         spin_unlock_irq(&gcwq->lock);
3311         del_timer_sync(&gcwq->idle_timer);
3312         spin_lock_irq(&gcwq->lock);
3313
3314         /*
3315          * We're now in charge.  Notify and proceed to drain.  We need
3316          * to keep the gcwq running during the whole CPU down
3317          * procedure as other cpu hotunplug callbacks may need to
3318          * flush currently running tasks.
3319          */
3320         gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3321         wake_up_all(&gcwq->trustee_wait);
3322
3323         /*
3324          * The original cpu is in the process of dying and may go away
3325          * anytime now.  When that happens, we and all workers would
3326          * be migrated to other cpus.  Try draining any left work.  We
3327          * want to get it over with ASAP - spam rescuers, wake up as
3328          * many idlers as necessary and create new ones till the
3329          * worklist is empty.  Note that if the gcwq is frozen, there
3330          * may be frozen works in freezable cwqs.  Don't declare
3331          * completion while frozen.
3332          */
3333         while (gcwq->nr_workers != gcwq->nr_idle ||
3334                gcwq->flags & GCWQ_FREEZING ||
3335                gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
3336                 int nr_works = 0;
3337
3338                 list_for_each_entry(work, &gcwq->worklist, entry) {
3339                         send_mayday(work);
3340                         nr_works++;
3341                 }
3342
3343                 list_for_each_entry(worker, &gcwq->idle_list, entry) {
3344                         if (!nr_works--)
3345                                 break;
3346                         wake_up_process(worker->task);
3347                 }
3348
3349                 if (need_to_create_worker(gcwq)) {
3350                         spin_unlock_irq(&gcwq->lock);
3351                         worker = create_worker(gcwq, false);
3352                         spin_lock_irq(&gcwq->lock);
3353                         if (worker) {
3354                                 worker->flags |= WORKER_ROGUE;
3355                                 start_worker(worker);
3356                         }
3357                 }
3358
3359                 /* give a breather */
3360                 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3361                         break;
3362         }
3363
3364         /*
3365          * Either all works have been scheduled and cpu is down, or
3366          * cpu down has already been canceled.  Wait for and butcher
3367          * all workers till we're canceled.
3368          */
3369         do {
3370                 rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3371                 while (!list_empty(&gcwq->idle_list))
3372                         destroy_worker(list_first_entry(&gcwq->idle_list,
3373                                                         struct worker, entry));
3374         } while (gcwq->nr_workers && rc >= 0);
3375
3376         /*
3377          * At this point, either draining has completed and no worker
3378          * is left, or cpu down has been canceled or the cpu is being
3379          * brought back up.  There shouldn't be any idle one left.
3380          * Tell the remaining busy ones to rebind once it finishes the
3381          * currently scheduled works by scheduling the rebind_work.
3382          */
3383         WARN_ON(!list_empty(&gcwq->idle_list));
3384
3385         for_each_busy_worker(worker, i, pos, gcwq) {
3386                 struct work_struct *rebind_work = &worker->rebind_work;
3387
3388                 /*
3389                  * Rebind_work may race with future cpu hotplug
3390                  * operations.  Use a separate flag to mark that
3391                  * rebinding is scheduled.
3392                  */
3393                 worker->flags |= WORKER_REBIND;
3394                 worker->flags &= ~WORKER_ROGUE;
3395
3396                 /* queue rebind_work, wq doesn't matter, use the default one */
3397                 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3398                                      work_data_bits(rebind_work)))
3399                         continue;
3400
3401                 debug_work_activate(rebind_work);
3402                 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3403                             worker->scheduled.next,
3404                             work_color_to_flags(WORK_NO_COLOR));
3405         }
3406
3407         /* relinquish manager role */
3408         gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3409
3410         /* notify completion */
3411         gcwq->trustee = NULL;
3412         gcwq->trustee_state = TRUSTEE_DONE;
3413         wake_up_all(&gcwq->trustee_wait);
3414         spin_unlock_irq(&gcwq->lock);
3415         return 0;
3416 }
3417
3418 /**
3419  * wait_trustee_state - wait for trustee to enter the specified state
3420  * @gcwq: gcwq the trustee of interest belongs to
3421  * @state: target state to wait for
3422  *
3423  * Wait for the trustee to reach @state.  DONE is already matched.
3424  *
3425  * CONTEXT:
3426  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3427  * multiple times.  To be used by cpu_callback.
3428  */
3429 static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
3430 __releases(&gcwq->lock)
3431 __acquires(&gcwq->lock)
3432 {
3433         if (!(gcwq->trustee_state == state ||
3434               gcwq->trustee_state == TRUSTEE_DONE)) {
3435                 spin_unlock_irq(&gcwq->lock);
3436                 __wait_event(gcwq->trustee_wait,
3437                              gcwq->trustee_state == state ||
3438                              gcwq->trustee_state == TRUSTEE_DONE);
3439                 spin_lock_irq(&gcwq->lock);
3440         }
3441 }
3442
3443 static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
3444                                                 unsigned long action,
3445                                                 void *hcpu)
3446 {
3447         unsigned int cpu = (unsigned long)hcpu;
3448         struct global_cwq *gcwq = get_gcwq(cpu);
3449         struct task_struct *new_trustee = NULL;
3450         struct worker *uninitialized_var(new_worker);
3451         unsigned long flags;
3452
3453         action &= ~CPU_TASKS_FROZEN;
3454
3455         switch (action) {
3456         case CPU_DOWN_PREPARE:
3457                 new_trustee = kthread_create(trustee_thread, gcwq,
3458                                              "workqueue_trustee/%d\n", cpu);
3459                 if (IS_ERR(new_trustee))
3460                         return notifier_from_errno(PTR_ERR(new_trustee));
3461                 kthread_bind(new_trustee, cpu);
3462                 /* fall through */
3463         case CPU_UP_PREPARE:
3464                 BUG_ON(gcwq->first_idle);
3465                 new_worker = create_worker(gcwq, false);
3466                 if (!new_worker) {
3467                         if (new_trustee)
3468                                 kthread_stop(new_trustee);
3469                         return NOTIFY_BAD;
3470                 }
3471         }
3472
3473         /* some are called w/ irq disabled, don't disturb irq status */
3474         spin_lock_irqsave(&gcwq->lock, flags);
3475
3476         switch (action) {
3477         case CPU_DOWN_PREPARE:
3478                 /* initialize trustee and tell it to acquire the gcwq */
3479                 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3480                 gcwq->trustee = new_trustee;
3481                 gcwq->trustee_state = TRUSTEE_START;
3482                 wake_up_process(gcwq->trustee);
3483                 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3484                 /* fall through */
3485         case CPU_UP_PREPARE:
3486                 BUG_ON(gcwq->first_idle);
3487                 gcwq->first_idle = new_worker;
3488                 break;
3489
3490         case CPU_DYING:
3491                 /*
3492                  * Before this, the trustee and all workers except for
3493                  * the ones which are still executing works from
3494                  * before the last CPU down must be on the cpu.  After
3495                  * this, they'll all be diasporas.
3496                  */
3497                 gcwq->flags |= GCWQ_DISASSOCIATED;
3498                 break;
3499
3500         case CPU_POST_DEAD:
3501                 gcwq->trustee_state = TRUSTEE_BUTCHER;
3502                 /* fall through */
3503         case CPU_UP_CANCELED:
3504                 destroy_worker(gcwq->first_idle);
3505                 gcwq->first_idle = NULL;
3506                 break;
3507
3508         case CPU_DOWN_FAILED:
3509         case CPU_ONLINE:
3510                 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3511                 if (gcwq->trustee_state != TRUSTEE_DONE) {
3512                         gcwq->trustee_state = TRUSTEE_RELEASE;
3513                         wake_up_process(gcwq->trustee);
3514                         wait_trustee_state(gcwq, TRUSTEE_DONE);
3515                 }
3516
3517                 /*
3518                  * Trustee is done and there might be no worker left.
3519                  * Put the first_idle in and request a real manager to
3520                  * take a look.
3521                  */
3522                 spin_unlock_irq(&gcwq->lock);
3523                 kthread_bind(gcwq->first_idle->task, cpu);
3524                 spin_lock_irq(&gcwq->lock);
3525                 gcwq->flags |= GCWQ_MANAGE_WORKERS;
3526                 start_worker(gcwq->first_idle);
3527                 gcwq->first_idle = NULL;
3528                 break;
3529         }
3530
3531         spin_unlock_irqrestore(&gcwq->lock, flags);
3532
3533         return notifier_from_errno(0);
3534 }
3535
3536 #ifdef CONFIG_SMP
3537
3538 struct work_for_cpu {
3539         struct completion completion;
3540         long (*fn)(void *);
3541         void *arg;
3542         long ret;
3543 };
3544
3545 static int do_work_for_cpu(void *_wfc)
3546 {
3547         struct work_for_cpu *wfc = _wfc;
3548         wfc->ret = wfc->fn(wfc->arg);
3549         complete(&wfc->completion);
3550         return 0;
3551 }
3552
3553 /**
3554  * work_on_cpu - run a function in user context on a particular cpu
3555  * @cpu: the cpu to run on
3556  * @fn: the function to run
3557  * @arg: the function arg
3558  *
3559  * This will return the value @fn returns.
3560  * It is up to the caller to ensure that the cpu doesn't go offline.
3561  * The caller must not hold any locks which would prevent @fn from completing.
3562  */
3563 long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3564 {
3565         struct task_struct *sub_thread;
3566         struct work_for_cpu wfc = {
3567                 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3568                 .fn = fn,
3569                 .arg = arg,
3570         };
3571
3572         sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3573         if (IS_ERR(sub_thread))
3574                 return PTR_ERR(sub_thread);
3575         kthread_bind(sub_thread, cpu);
3576         wake_up_process(sub_thread);
3577         wait_for_completion(&wfc.completion);
3578         return wfc.ret;
3579 }
3580 EXPORT_SYMBOL_GPL(work_on_cpu);
3581 #endif /* CONFIG_SMP */
3582
3583 #ifdef CONFIG_FREEZER
3584
3585 /**
3586  * freeze_workqueues_begin - begin freezing workqueues
3587  *
3588  * Start freezing workqueues.  After this function returns, all freezable
3589  * workqueues will queue new works to their frozen_works list instead of
3590  * gcwq->worklist.
3591  *
3592  * CONTEXT:
3593  * Grabs and releases workqueue_lock and gcwq->lock's.
3594  */
3595 void freeze_workqueues_begin(void)
3596 {
3597         unsigned int cpu;
3598
3599         spin_lock(&workqueue_lock);
3600
3601         BUG_ON(workqueue_freezing);
3602         workqueue_freezing = true;
3603
3604         for_each_gcwq_cpu(cpu) {
3605                 struct global_cwq *gcwq = get_gcwq(cpu);
3606                 struct workqueue_struct *wq;
3607
3608                 spin_lock_irq(&gcwq->lock);
3609
3610                 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3611                 gcwq->flags |= GCWQ_FREEZING;
3612
3613                 list_for_each_entry(wq, &workqueues, list) {
3614                         struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3615
3616                         if (cwq && wq->flags & WQ_FREEZABLE)
3617                                 cwq->max_active = 0;
3618                 }
3619
3620                 spin_unlock_irq(&gcwq->lock);
3621         }
3622
3623         spin_unlock(&workqueue_lock);
3624 }
3625
3626 /**
3627  * freeze_workqueues_busy - are freezable workqueues still busy?
3628  *
3629  * Check whether freezing is complete.  This function must be called
3630  * between freeze_workqueues_begin() and thaw_workqueues().
3631  *
3632  * CONTEXT:
3633  * Grabs and releases workqueue_lock.
3634  *
3635  * RETURNS:
3636  * %true if some freezable workqueues are still busy.  %false if freezing
3637  * is complete.
3638  */
3639 bool freeze_workqueues_busy(void)
3640 {
3641         unsigned int cpu;
3642         bool busy = false;
3643
3644         spin_lock(&workqueue_lock);
3645
3646         BUG_ON(!workqueue_freezing);
3647
3648         for_each_gcwq_cpu(cpu) {
3649                 struct workqueue_struct *wq;
3650                 /*
3651                  * nr_active is monotonically decreasing.  It's safe
3652                  * to peek without lock.
3653                  */
3654                 list_for_each_entry(wq, &workqueues, list) {
3655                         struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3656
3657                         if (!cwq || !(wq->flags & WQ_FREEZABLE))
3658                                 continue;
3659
3660                         BUG_ON(cwq->nr_active < 0);
3661                         if (cwq->nr_active) {
3662                                 busy = true;
3663                                 goto out_unlock;
3664                         }
3665                 }
3666         }
3667 out_unlock:
3668         spin_unlock(&workqueue_lock);
3669         return busy;
3670 }
3671
3672 /**
3673  * thaw_workqueues - thaw workqueues
3674  *
3675  * Thaw workqueues.  Normal queueing is restored and all collected
3676  * frozen works are transferred to their respective gcwq worklists.
3677  *
3678  * CONTEXT:
3679  * Grabs and releases workqueue_lock and gcwq->lock's.
3680  */
3681 void thaw_workqueues(void)
3682 {
3683         unsigned int cpu;
3684
3685         spin_lock(&workqueue_lock);
3686
3687         if (!workqueue_freezing)
3688                 goto out_unlock;
3689
3690         for_each_gcwq_cpu(cpu) {
3691                 struct global_cwq *gcwq = get_gcwq(cpu);
3692                 struct workqueue_struct *wq;
3693
3694                 spin_lock_irq(&gcwq->lock);
3695
3696                 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3697                 gcwq->flags &= ~GCWQ_FREEZING;
3698
3699                 list_for_each_entry(wq, &workqueues, list) {
3700                         struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3701
3702                         if (!cwq || !(wq->flags & WQ_FREEZABLE))
3703                                 continue;
3704
3705                         /* restore max_active and repopulate worklist */
3706                         cwq->max_active = wq->saved_max_active;
3707
3708                         while (!list_empty(&cwq->delayed_works) &&
3709                                cwq->nr_active < cwq->max_active)
3710                                 cwq_activate_first_delayed(cwq);
3711                 }
3712
3713                 wake_up_worker(gcwq);
3714
3715                 spin_unlock_irq(&gcwq->lock);
3716         }
3717
3718         workqueue_freezing = false;
3719 out_unlock:
3720         spin_unlock(&workqueue_lock);
3721 }
3722 #endif /* CONFIG_FREEZER */
3723
3724 static int __init init_workqueues(void)
3725 {
3726         unsigned int cpu;
3727         int i;
3728
3729         cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
3730
3731         /* initialize gcwqs */
3732         for_each_gcwq_cpu(cpu) {
3733                 struct global_cwq *gcwq = get_gcwq(cpu);
3734
3735                 spin_lock_init(&gcwq->lock);
3736                 INIT_LIST_HEAD(&gcwq->worklist);
3737                 gcwq->cpu = cpu;
3738                 gcwq->flags |= GCWQ_DISASSOCIATED;
3739
3740                 INIT_LIST_HEAD(&gcwq->idle_list);
3741                 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3742                         INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3743
3744                 init_timer_deferrable(&gcwq->idle_timer);
3745                 gcwq->idle_timer.function = idle_worker_timeout;
3746                 gcwq->idle_timer.data = (unsigned long)gcwq;
3747
3748                 setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3749                             (unsigned long)gcwq);
3750
3751                 ida_init(&gcwq->worker_ida);
3752
3753                 gcwq->trustee_state = TRUSTEE_DONE;
3754                 init_waitqueue_head(&gcwq->trustee_wait);
3755         }
3756
3757         /* create the initial worker */
3758         for_each_online_gcwq_cpu(cpu) {
3759                 struct global_cwq *gcwq = get_gcwq(cpu);
3760                 struct worker *worker;
3761
3762                 if (cpu != WORK_CPU_UNBOUND)
3763                         gcwq->flags &= ~GCWQ_DISASSOCIATED;
3764                 worker = create_worker(gcwq, true);
3765                 BUG_ON(!worker);
3766                 spin_lock_irq(&gcwq->lock);
3767                 start_worker(worker);
3768                 spin_unlock_irq(&gcwq->lock);
3769         }
3770
3771         system_wq = alloc_workqueue("events", 0, 0);
3772         system_long_wq = alloc_workqueue("events_long", 0, 0);
3773         system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3774         system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3775                                             WQ_UNBOUND_MAX_ACTIVE);
3776         BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
3777                !system_unbound_wq);
3778         return 0;
3779 }
3780 early_initcall(init_workqueues);