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