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