OSDN Git Service

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