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