debugobjects: Add hint for better object identification
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / kernel / workqueue.c
blobb5fe4c00eb3c9de169557404444dbb4b222615f6
1 /*
2 * kernel/workqueue.c - generic async execution with shared worker pool
4 * Copyright (C) 2002 Ingo Molnar
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>
12 * Made to use alloc_percpu by Christoph Lameter.
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
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.
23 * Please read Documentation/workqueue.txt for details.
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>
45 #include "workqueue_sched.h"
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 */
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 */
65 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
66 WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
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 */
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,
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 */
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 */
90 * Rescue workers are used only on emergencies and shared by
91 * all cpus. Give -20.
93 RESCUER_NICE_LEVEL = -20,
97 * Structure fields follow one of the following exclusion rules.
99 * I: Modifiable by initialization/destruction paths and read-only for
100 * everyone else.
102 * P: Preemption protected. Disabling preemption is enough and should
103 * only be modified and accessed from the local cpu.
105 * L: gcwq->lock protected. Access with gcwq->lock held.
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.
112 * F: wq->flush_mutex protected.
114 * W: workqueue_lock protected.
117 struct global_cwq;
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.
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 */
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 */
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.
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 */
153 int nr_workers; /* L: total number of workers */
154 int nr_idle; /* L: currently idle ones */
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 */
161 struct timer_list idle_timer; /* L: worker idle timeout */
162 struct timer_list mayday_timer; /* L: SOS timer for dworkers */
164 struct ida worker_ida; /* L: for worker IDs */
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;
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.
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 */
190 * Structure used to wait for workqueue flush.
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 */
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.
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
220 * The externally visible workqueue abstraction is an array of
221 * per-CPU workqueues:
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 */
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 */
240 mayday_mask_t mayday_mask; /* cpus requesting rescue */
241 struct worker *rescuer; /* I: rescue worker */
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
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 EXPORT_SYMBOL_GPL(system_wq);
255 EXPORT_SYMBOL_GPL(system_long_wq);
256 EXPORT_SYMBOL_GPL(system_nrt_wq);
257 EXPORT_SYMBOL_GPL(system_unbound_wq);
259 #define CREATE_TRACE_POINTS
260 #include <trace/events/workqueue.h>
262 #define for_each_busy_worker(worker, i, pos, gcwq) \
263 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
264 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
266 static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
267 unsigned int sw)
269 if (cpu < nr_cpu_ids) {
270 if (sw & 1) {
271 cpu = cpumask_next(cpu, mask);
272 if (cpu < nr_cpu_ids)
273 return cpu;
275 if (sw & 2)
276 return WORK_CPU_UNBOUND;
278 return WORK_CPU_NONE;
281 static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
282 struct workqueue_struct *wq)
284 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
288 * CPU iterators
290 * An extra gcwq is defined for an invalid cpu number
291 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
292 * specific CPU. The following iterators are similar to
293 * for_each_*_cpu() iterators but also considers the unbound gcwq.
295 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
296 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
297 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
298 * WORK_CPU_UNBOUND for unbound workqueues
300 #define for_each_gcwq_cpu(cpu) \
301 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
302 (cpu) < WORK_CPU_NONE; \
303 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
305 #define for_each_online_gcwq_cpu(cpu) \
306 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
307 (cpu) < WORK_CPU_NONE; \
308 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
310 #define for_each_cwq_cpu(cpu, wq) \
311 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
312 (cpu) < WORK_CPU_NONE; \
313 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
315 #ifdef CONFIG_DEBUG_OBJECTS_WORK
317 static struct debug_obj_descr work_debug_descr;
319 static void *work_debug_hint(void *addr)
321 return ((struct work_struct *) addr)->func;
325 * fixup_init is called when:
326 * - an active object is initialized
328 static int work_fixup_init(void *addr, enum debug_obj_state state)
330 struct work_struct *work = addr;
332 switch (state) {
333 case ODEBUG_STATE_ACTIVE:
334 cancel_work_sync(work);
335 debug_object_init(work, &work_debug_descr);
336 return 1;
337 default:
338 return 0;
343 * fixup_activate is called when:
344 * - an active object is activated
345 * - an unknown object is activated (might be a statically initialized object)
347 static int work_fixup_activate(void *addr, enum debug_obj_state state)
349 struct work_struct *work = addr;
351 switch (state) {
353 case ODEBUG_STATE_NOTAVAILABLE:
355 * This is not really a fixup. The work struct was
356 * statically initialized. We just make sure that it
357 * is tracked in the object tracker.
359 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
360 debug_object_init(work, &work_debug_descr);
361 debug_object_activate(work, &work_debug_descr);
362 return 0;
364 WARN_ON_ONCE(1);
365 return 0;
367 case ODEBUG_STATE_ACTIVE:
368 WARN_ON(1);
370 default:
371 return 0;
376 * fixup_free is called when:
377 * - an active object is freed
379 static int work_fixup_free(void *addr, enum debug_obj_state state)
381 struct work_struct *work = addr;
383 switch (state) {
384 case ODEBUG_STATE_ACTIVE:
385 cancel_work_sync(work);
386 debug_object_free(work, &work_debug_descr);
387 return 1;
388 default:
389 return 0;
393 static struct debug_obj_descr work_debug_descr = {
394 .name = "work_struct",
395 .debug_hint = work_debug_hint,
396 .fixup_init = work_fixup_init,
397 .fixup_activate = work_fixup_activate,
398 .fixup_free = work_fixup_free,
401 static inline void debug_work_activate(struct work_struct *work)
403 debug_object_activate(work, &work_debug_descr);
406 static inline void debug_work_deactivate(struct work_struct *work)
408 debug_object_deactivate(work, &work_debug_descr);
411 void __init_work(struct work_struct *work, int onstack)
413 if (onstack)
414 debug_object_init_on_stack(work, &work_debug_descr);
415 else
416 debug_object_init(work, &work_debug_descr);
418 EXPORT_SYMBOL_GPL(__init_work);
420 void destroy_work_on_stack(struct work_struct *work)
422 debug_object_free(work, &work_debug_descr);
424 EXPORT_SYMBOL_GPL(destroy_work_on_stack);
426 #else
427 static inline void debug_work_activate(struct work_struct *work) { }
428 static inline void debug_work_deactivate(struct work_struct *work) { }
429 #endif
431 /* Serializes the accesses to the list of workqueues. */
432 static DEFINE_SPINLOCK(workqueue_lock);
433 static LIST_HEAD(workqueues);
434 static bool workqueue_freezing; /* W: have wqs started freezing? */
437 * The almighty global cpu workqueues. nr_running is the only field
438 * which is expected to be used frequently by other cpus via
439 * try_to_wake_up(). Put it in a separate cacheline.
441 static DEFINE_PER_CPU(struct global_cwq, global_cwq);
442 static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
445 * Global cpu workqueue and nr_running counter for unbound gcwq. The
446 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
447 * workers have WORKER_UNBOUND set.
449 static struct global_cwq unbound_global_cwq;
450 static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0); /* always 0 */
452 static int worker_thread(void *__worker);
454 static struct global_cwq *get_gcwq(unsigned int cpu)
456 if (cpu != WORK_CPU_UNBOUND)
457 return &per_cpu(global_cwq, cpu);
458 else
459 return &unbound_global_cwq;
462 static atomic_t *get_gcwq_nr_running(unsigned int cpu)
464 if (cpu != WORK_CPU_UNBOUND)
465 return &per_cpu(gcwq_nr_running, cpu);
466 else
467 return &unbound_gcwq_nr_running;
470 static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
471 struct workqueue_struct *wq)
473 if (!(wq->flags & WQ_UNBOUND)) {
474 if (likely(cpu < nr_cpu_ids)) {
475 #ifdef CONFIG_SMP
476 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
477 #else
478 return wq->cpu_wq.single;
479 #endif
481 } else if (likely(cpu == WORK_CPU_UNBOUND))
482 return wq->cpu_wq.single;
483 return NULL;
486 static unsigned int work_color_to_flags(int color)
488 return color << WORK_STRUCT_COLOR_SHIFT;
491 static int get_work_color(struct work_struct *work)
493 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
494 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
497 static int work_next_color(int color)
499 return (color + 1) % WORK_NR_COLORS;
503 * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
504 * work is on queue. Once execution starts, WORK_STRUCT_CWQ is
505 * cleared and the work data contains the cpu number it was last on.
507 * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
508 * cwq, cpu or clear work->data. These functions should only be
509 * called while the work is owned - ie. while the PENDING bit is set.
511 * get_work_[g]cwq() can be used to obtain the gcwq or cwq
512 * corresponding to a work. gcwq is available once the work has been
513 * queued anywhere after initialization. cwq is available only from
514 * queueing until execution starts.
516 static inline void set_work_data(struct work_struct *work, unsigned long data,
517 unsigned long flags)
519 BUG_ON(!work_pending(work));
520 atomic_long_set(&work->data, data | flags | work_static(work));
523 static void set_work_cwq(struct work_struct *work,
524 struct cpu_workqueue_struct *cwq,
525 unsigned long extra_flags)
527 set_work_data(work, (unsigned long)cwq,
528 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
531 static void set_work_cpu(struct work_struct *work, unsigned int cpu)
533 set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
536 static void clear_work_data(struct work_struct *work)
538 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
541 static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
543 unsigned long data = atomic_long_read(&work->data);
545 if (data & WORK_STRUCT_CWQ)
546 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
547 else
548 return NULL;
551 static struct global_cwq *get_work_gcwq(struct work_struct *work)
553 unsigned long data = atomic_long_read(&work->data);
554 unsigned int cpu;
556 if (data & WORK_STRUCT_CWQ)
557 return ((struct cpu_workqueue_struct *)
558 (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
560 cpu = data >> WORK_STRUCT_FLAG_BITS;
561 if (cpu == WORK_CPU_NONE)
562 return NULL;
564 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
565 return get_gcwq(cpu);
569 * Policy functions. These define the policies on how the global
570 * worker pool is managed. Unless noted otherwise, these functions
571 * assume that they're being called with gcwq->lock held.
574 static bool __need_more_worker(struct global_cwq *gcwq)
576 return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
577 gcwq->flags & GCWQ_HIGHPRI_PENDING;
581 * Need to wake up a worker? Called from anything but currently
582 * running workers.
584 static bool need_more_worker(struct global_cwq *gcwq)
586 return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
589 /* Can I start working? Called from busy but !running workers. */
590 static bool may_start_working(struct global_cwq *gcwq)
592 return gcwq->nr_idle;
595 /* Do I need to keep working? Called from currently running workers. */
596 static bool keep_working(struct global_cwq *gcwq)
598 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
600 return !list_empty(&gcwq->worklist) &&
601 (atomic_read(nr_running) <= 1 ||
602 gcwq->flags & GCWQ_HIGHPRI_PENDING);
605 /* Do we need a new worker? Called from manager. */
606 static bool need_to_create_worker(struct global_cwq *gcwq)
608 return need_more_worker(gcwq) && !may_start_working(gcwq);
611 /* Do I need to be the manager? */
612 static bool need_to_manage_workers(struct global_cwq *gcwq)
614 return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
617 /* Do we have too many workers and should some go away? */
618 static bool too_many_workers(struct global_cwq *gcwq)
620 bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
621 int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
622 int nr_busy = gcwq->nr_workers - nr_idle;
624 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
628 * Wake up functions.
631 /* Return the first worker. Safe with preemption disabled */
632 static struct worker *first_worker(struct global_cwq *gcwq)
634 if (unlikely(list_empty(&gcwq->idle_list)))
635 return NULL;
637 return list_first_entry(&gcwq->idle_list, struct worker, entry);
641 * wake_up_worker - wake up an idle worker
642 * @gcwq: gcwq to wake worker for
644 * Wake up the first idle worker of @gcwq.
646 * CONTEXT:
647 * spin_lock_irq(gcwq->lock).
649 static void wake_up_worker(struct global_cwq *gcwq)
651 struct worker *worker = first_worker(gcwq);
653 if (likely(worker))
654 wake_up_process(worker->task);
658 * wq_worker_waking_up - a worker is waking up
659 * @task: task waking up
660 * @cpu: CPU @task is waking up to
662 * This function is called during try_to_wake_up() when a worker is
663 * being awoken.
665 * CONTEXT:
666 * spin_lock_irq(rq->lock)
668 void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
670 struct worker *worker = kthread_data(task);
672 if (!(worker->flags & WORKER_NOT_RUNNING))
673 atomic_inc(get_gcwq_nr_running(cpu));
677 * wq_worker_sleeping - a worker is going to sleep
678 * @task: task going to sleep
679 * @cpu: CPU in question, must be the current CPU number
681 * This function is called during schedule() when a busy worker is
682 * going to sleep. Worker on the same cpu can be woken up by
683 * returning pointer to its task.
685 * CONTEXT:
686 * spin_lock_irq(rq->lock)
688 * RETURNS:
689 * Worker task on @cpu to wake up, %NULL if none.
691 struct task_struct *wq_worker_sleeping(struct task_struct *task,
692 unsigned int cpu)
694 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
695 struct global_cwq *gcwq = get_gcwq(cpu);
696 atomic_t *nr_running = get_gcwq_nr_running(cpu);
698 if (worker->flags & WORKER_NOT_RUNNING)
699 return NULL;
701 /* this can only happen on the local cpu */
702 BUG_ON(cpu != raw_smp_processor_id());
705 * The counterpart of the following dec_and_test, implied mb,
706 * worklist not empty test sequence is in insert_work().
707 * Please read comment there.
709 * NOT_RUNNING is clear. This means that trustee is not in
710 * charge and we're running on the local cpu w/ rq lock held
711 * and preemption disabled, which in turn means that none else
712 * could be manipulating idle_list, so dereferencing idle_list
713 * without gcwq lock is safe.
715 if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
716 to_wakeup = first_worker(gcwq);
717 return to_wakeup ? to_wakeup->task : NULL;
721 * worker_set_flags - set worker flags and adjust nr_running accordingly
722 * @worker: self
723 * @flags: flags to set
724 * @wakeup: wakeup an idle worker if necessary
726 * Set @flags in @worker->flags and adjust nr_running accordingly. If
727 * nr_running becomes zero and @wakeup is %true, an idle worker is
728 * woken up.
730 * CONTEXT:
731 * spin_lock_irq(gcwq->lock)
733 static inline void worker_set_flags(struct worker *worker, unsigned int flags,
734 bool wakeup)
736 struct global_cwq *gcwq = worker->gcwq;
738 WARN_ON_ONCE(worker->task != current);
741 * If transitioning into NOT_RUNNING, adjust nr_running and
742 * wake up an idle worker as necessary if requested by
743 * @wakeup.
745 if ((flags & WORKER_NOT_RUNNING) &&
746 !(worker->flags & WORKER_NOT_RUNNING)) {
747 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
749 if (wakeup) {
750 if (atomic_dec_and_test(nr_running) &&
751 !list_empty(&gcwq->worklist))
752 wake_up_worker(gcwq);
753 } else
754 atomic_dec(nr_running);
757 worker->flags |= flags;
761 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
762 * @worker: self
763 * @flags: flags to clear
765 * Clear @flags in @worker->flags and adjust nr_running accordingly.
767 * CONTEXT:
768 * spin_lock_irq(gcwq->lock)
770 static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
772 struct global_cwq *gcwq = worker->gcwq;
773 unsigned int oflags = worker->flags;
775 WARN_ON_ONCE(worker->task != current);
777 worker->flags &= ~flags;
780 * If transitioning out of NOT_RUNNING, increment nr_running. Note
781 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
782 * of multiple flags, not a single flag.
784 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
785 if (!(worker->flags & WORKER_NOT_RUNNING))
786 atomic_inc(get_gcwq_nr_running(gcwq->cpu));
790 * busy_worker_head - return the busy hash head for a work
791 * @gcwq: gcwq of interest
792 * @work: work to be hashed
794 * Return hash head of @gcwq for @work.
796 * CONTEXT:
797 * spin_lock_irq(gcwq->lock).
799 * RETURNS:
800 * Pointer to the hash head.
802 static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
803 struct work_struct *work)
805 const int base_shift = ilog2(sizeof(struct work_struct));
806 unsigned long v = (unsigned long)work;
808 /* simple shift and fold hash, do we need something better? */
809 v >>= base_shift;
810 v += v >> BUSY_WORKER_HASH_ORDER;
811 v &= BUSY_WORKER_HASH_MASK;
813 return &gcwq->busy_hash[v];
817 * __find_worker_executing_work - find worker which is executing a work
818 * @gcwq: gcwq of interest
819 * @bwh: hash head as returned by busy_worker_head()
820 * @work: work to find worker for
822 * Find a worker which is executing @work on @gcwq. @bwh should be
823 * the hash head obtained by calling busy_worker_head() with the same
824 * work.
826 * CONTEXT:
827 * spin_lock_irq(gcwq->lock).
829 * RETURNS:
830 * Pointer to worker which is executing @work if found, NULL
831 * otherwise.
833 static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
834 struct hlist_head *bwh,
835 struct work_struct *work)
837 struct worker *worker;
838 struct hlist_node *tmp;
840 hlist_for_each_entry(worker, tmp, bwh, hentry)
841 if (worker->current_work == work)
842 return worker;
843 return NULL;
847 * find_worker_executing_work - find worker which is executing a work
848 * @gcwq: gcwq of interest
849 * @work: work to find worker for
851 * Find a worker which is executing @work on @gcwq. This function is
852 * identical to __find_worker_executing_work() except that this
853 * function calculates @bwh itself.
855 * CONTEXT:
856 * spin_lock_irq(gcwq->lock).
858 * RETURNS:
859 * Pointer to worker which is executing @work if found, NULL
860 * otherwise.
862 static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
863 struct work_struct *work)
865 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
866 work);
870 * gcwq_determine_ins_pos - find insertion position
871 * @gcwq: gcwq of interest
872 * @cwq: cwq a work is being queued for
874 * A work for @cwq is about to be queued on @gcwq, determine insertion
875 * position for the work. If @cwq is for HIGHPRI wq, the work is
876 * queued at the head of the queue but in FIFO order with respect to
877 * other HIGHPRI works; otherwise, at the end of the queue. This
878 * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
879 * there are HIGHPRI works pending.
881 * CONTEXT:
882 * spin_lock_irq(gcwq->lock).
884 * RETURNS:
885 * Pointer to inserstion position.
887 static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
888 struct cpu_workqueue_struct *cwq)
890 struct work_struct *twork;
892 if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
893 return &gcwq->worklist;
895 list_for_each_entry(twork, &gcwq->worklist, entry) {
896 struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
898 if (!(tcwq->wq->flags & WQ_HIGHPRI))
899 break;
902 gcwq->flags |= GCWQ_HIGHPRI_PENDING;
903 return &twork->entry;
907 * insert_work - insert a work into gcwq
908 * @cwq: cwq @work belongs to
909 * @work: work to insert
910 * @head: insertion point
911 * @extra_flags: extra WORK_STRUCT_* flags to set
913 * Insert @work which belongs to @cwq into @gcwq after @head.
914 * @extra_flags is or'd to work_struct flags.
916 * CONTEXT:
917 * spin_lock_irq(gcwq->lock).
919 static void insert_work(struct cpu_workqueue_struct *cwq,
920 struct work_struct *work, struct list_head *head,
921 unsigned int extra_flags)
923 struct global_cwq *gcwq = cwq->gcwq;
925 /* we own @work, set data and link */
926 set_work_cwq(work, cwq, extra_flags);
929 * Ensure that we get the right work->data if we see the
930 * result of list_add() below, see try_to_grab_pending().
932 smp_wmb();
934 list_add_tail(&work->entry, head);
937 * Ensure either worker_sched_deactivated() sees the above
938 * list_add_tail() or we see zero nr_running to avoid workers
939 * lying around lazily while there are works to be processed.
941 smp_mb();
943 if (__need_more_worker(gcwq))
944 wake_up_worker(gcwq);
948 * Test whether @work is being queued from another work executing on the
949 * same workqueue. This is rather expensive and should only be used from
950 * cold paths.
952 static bool is_chained_work(struct workqueue_struct *wq)
954 unsigned long flags;
955 unsigned int cpu;
957 for_each_gcwq_cpu(cpu) {
958 struct global_cwq *gcwq = get_gcwq(cpu);
959 struct worker *worker;
960 struct hlist_node *pos;
961 int i;
963 spin_lock_irqsave(&gcwq->lock, flags);
964 for_each_busy_worker(worker, i, pos, gcwq) {
965 if (worker->task != current)
966 continue;
967 spin_unlock_irqrestore(&gcwq->lock, flags);
969 * I'm @worker, no locking necessary. See if @work
970 * is headed to the same workqueue.
972 return worker->current_cwq->wq == wq;
974 spin_unlock_irqrestore(&gcwq->lock, flags);
976 return false;
979 static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
980 struct work_struct *work)
982 struct global_cwq *gcwq;
983 struct cpu_workqueue_struct *cwq;
984 struct list_head *worklist;
985 unsigned int work_flags;
986 unsigned long flags;
988 debug_work_activate(work);
990 /* if dying, only works from the same workqueue are allowed */
991 if (unlikely(wq->flags & WQ_DYING) &&
992 WARN_ON_ONCE(!is_chained_work(wq)))
993 return;
995 /* determine gcwq to use */
996 if (!(wq->flags & WQ_UNBOUND)) {
997 struct global_cwq *last_gcwq;
999 if (unlikely(cpu == WORK_CPU_UNBOUND))
1000 cpu = raw_smp_processor_id();
1003 * It's multi cpu. If @wq is non-reentrant and @work
1004 * was previously on a different cpu, it might still
1005 * be running there, in which case the work needs to
1006 * be queued on that cpu to guarantee non-reentrance.
1008 gcwq = get_gcwq(cpu);
1009 if (wq->flags & WQ_NON_REENTRANT &&
1010 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1011 struct worker *worker;
1013 spin_lock_irqsave(&last_gcwq->lock, flags);
1015 worker = find_worker_executing_work(last_gcwq, work);
1017 if (worker && worker->current_cwq->wq == wq)
1018 gcwq = last_gcwq;
1019 else {
1020 /* meh... not running there, queue here */
1021 spin_unlock_irqrestore(&last_gcwq->lock, flags);
1022 spin_lock_irqsave(&gcwq->lock, flags);
1024 } else
1025 spin_lock_irqsave(&gcwq->lock, flags);
1026 } else {
1027 gcwq = get_gcwq(WORK_CPU_UNBOUND);
1028 spin_lock_irqsave(&gcwq->lock, flags);
1031 /* gcwq determined, get cwq and queue */
1032 cwq = get_cwq(gcwq->cpu, wq);
1033 trace_workqueue_queue_work(cpu, cwq, work);
1035 BUG_ON(!list_empty(&work->entry));
1037 cwq->nr_in_flight[cwq->work_color]++;
1038 work_flags = work_color_to_flags(cwq->work_color);
1040 if (likely(cwq->nr_active < cwq->max_active)) {
1041 trace_workqueue_activate_work(work);
1042 cwq->nr_active++;
1043 worklist = gcwq_determine_ins_pos(gcwq, cwq);
1044 } else {
1045 work_flags |= WORK_STRUCT_DELAYED;
1046 worklist = &cwq->delayed_works;
1049 insert_work(cwq, work, worklist, work_flags);
1051 spin_unlock_irqrestore(&gcwq->lock, flags);
1055 * queue_work - queue work on a workqueue
1056 * @wq: workqueue to use
1057 * @work: work to queue
1059 * Returns 0 if @work was already on a queue, non-zero otherwise.
1061 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1062 * it can be processed by another CPU.
1064 int queue_work(struct workqueue_struct *wq, struct work_struct *work)
1066 int ret;
1068 ret = queue_work_on(get_cpu(), wq, work);
1069 put_cpu();
1071 return ret;
1073 EXPORT_SYMBOL_GPL(queue_work);
1076 * queue_work_on - queue work on specific cpu
1077 * @cpu: CPU number to execute work on
1078 * @wq: workqueue to use
1079 * @work: work to queue
1081 * Returns 0 if @work was already on a queue, non-zero otherwise.
1083 * We queue the work to a specific CPU, the caller must ensure it
1084 * can't go away.
1087 queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1089 int ret = 0;
1091 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1092 __queue_work(cpu, wq, work);
1093 ret = 1;
1095 return ret;
1097 EXPORT_SYMBOL_GPL(queue_work_on);
1099 static void delayed_work_timer_fn(unsigned long __data)
1101 struct delayed_work *dwork = (struct delayed_work *)__data;
1102 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
1104 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
1108 * queue_delayed_work - queue work on a workqueue after delay
1109 * @wq: workqueue to use
1110 * @dwork: delayable work to queue
1111 * @delay: number of jiffies to wait before queueing
1113 * Returns 0 if @work was already on a queue, non-zero otherwise.
1115 int queue_delayed_work(struct workqueue_struct *wq,
1116 struct delayed_work *dwork, unsigned long delay)
1118 if (delay == 0)
1119 return queue_work(wq, &dwork->work);
1121 return queue_delayed_work_on(-1, wq, dwork, delay);
1123 EXPORT_SYMBOL_GPL(queue_delayed_work);
1126 * queue_delayed_work_on - queue work on specific CPU after delay
1127 * @cpu: CPU number to execute work on
1128 * @wq: workqueue to use
1129 * @dwork: work to queue
1130 * @delay: number of jiffies to wait before queueing
1132 * Returns 0 if @work was already on a queue, non-zero otherwise.
1134 int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1135 struct delayed_work *dwork, unsigned long delay)
1137 int ret = 0;
1138 struct timer_list *timer = &dwork->timer;
1139 struct work_struct *work = &dwork->work;
1141 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1142 unsigned int lcpu;
1144 BUG_ON(timer_pending(timer));
1145 BUG_ON(!list_empty(&work->entry));
1147 timer_stats_timer_set_start_info(&dwork->timer);
1150 * This stores cwq for the moment, for the timer_fn.
1151 * Note that the work's gcwq is preserved to allow
1152 * reentrance detection for delayed works.
1154 if (!(wq->flags & WQ_UNBOUND)) {
1155 struct global_cwq *gcwq = get_work_gcwq(work);
1157 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1158 lcpu = gcwq->cpu;
1159 else
1160 lcpu = raw_smp_processor_id();
1161 } else
1162 lcpu = WORK_CPU_UNBOUND;
1164 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1166 timer->expires = jiffies + delay;
1167 timer->data = (unsigned long)dwork;
1168 timer->function = delayed_work_timer_fn;
1170 if (unlikely(cpu >= 0))
1171 add_timer_on(timer, cpu);
1172 else
1173 add_timer(timer);
1174 ret = 1;
1176 return ret;
1178 EXPORT_SYMBOL_GPL(queue_delayed_work_on);
1181 * worker_enter_idle - enter idle state
1182 * @worker: worker which is entering idle state
1184 * @worker is entering idle state. Update stats and idle timer if
1185 * necessary.
1187 * LOCKING:
1188 * spin_lock_irq(gcwq->lock).
1190 static void worker_enter_idle(struct worker *worker)
1192 struct global_cwq *gcwq = worker->gcwq;
1194 BUG_ON(worker->flags & WORKER_IDLE);
1195 BUG_ON(!list_empty(&worker->entry) &&
1196 (worker->hentry.next || worker->hentry.pprev));
1198 /* can't use worker_set_flags(), also called from start_worker() */
1199 worker->flags |= WORKER_IDLE;
1200 gcwq->nr_idle++;
1201 worker->last_active = jiffies;
1203 /* idle_list is LIFO */
1204 list_add(&worker->entry, &gcwq->idle_list);
1206 if (likely(!(worker->flags & WORKER_ROGUE))) {
1207 if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1208 mod_timer(&gcwq->idle_timer,
1209 jiffies + IDLE_WORKER_TIMEOUT);
1210 } else
1211 wake_up_all(&gcwq->trustee_wait);
1213 /* sanity check nr_running */
1214 WARN_ON_ONCE(gcwq->nr_workers == gcwq->nr_idle &&
1215 atomic_read(get_gcwq_nr_running(gcwq->cpu)));
1219 * worker_leave_idle - leave idle state
1220 * @worker: worker which is leaving idle state
1222 * @worker is leaving idle state. Update stats.
1224 * LOCKING:
1225 * spin_lock_irq(gcwq->lock).
1227 static void worker_leave_idle(struct worker *worker)
1229 struct global_cwq *gcwq = worker->gcwq;
1231 BUG_ON(!(worker->flags & WORKER_IDLE));
1232 worker_clr_flags(worker, WORKER_IDLE);
1233 gcwq->nr_idle--;
1234 list_del_init(&worker->entry);
1238 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1239 * @worker: self
1241 * Works which are scheduled while the cpu is online must at least be
1242 * scheduled to a worker which is bound to the cpu so that if they are
1243 * flushed from cpu callbacks while cpu is going down, they are
1244 * guaranteed to execute on the cpu.
1246 * This function is to be used by rogue workers and rescuers to bind
1247 * themselves to the target cpu and may race with cpu going down or
1248 * coming online. kthread_bind() can't be used because it may put the
1249 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1250 * verbatim as it's best effort and blocking and gcwq may be
1251 * [dis]associated in the meantime.
1253 * This function tries set_cpus_allowed() and locks gcwq and verifies
1254 * the binding against GCWQ_DISASSOCIATED which is set during
1255 * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1256 * idle state or fetches works without dropping lock, it can guarantee
1257 * the scheduling requirement described in the first paragraph.
1259 * CONTEXT:
1260 * Might sleep. Called without any lock but returns with gcwq->lock
1261 * held.
1263 * RETURNS:
1264 * %true if the associated gcwq is online (@worker is successfully
1265 * bound), %false if offline.
1267 static bool worker_maybe_bind_and_lock(struct worker *worker)
1268 __acquires(&gcwq->lock)
1270 struct global_cwq *gcwq = worker->gcwq;
1271 struct task_struct *task = worker->task;
1273 while (true) {
1275 * The following call may fail, succeed or succeed
1276 * without actually migrating the task to the cpu if
1277 * it races with cpu hotunplug operation. Verify
1278 * against GCWQ_DISASSOCIATED.
1280 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1281 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1283 spin_lock_irq(&gcwq->lock);
1284 if (gcwq->flags & GCWQ_DISASSOCIATED)
1285 return false;
1286 if (task_cpu(task) == gcwq->cpu &&
1287 cpumask_equal(&current->cpus_allowed,
1288 get_cpu_mask(gcwq->cpu)))
1289 return true;
1290 spin_unlock_irq(&gcwq->lock);
1292 /* CPU has come up inbetween, retry migration */
1293 cpu_relax();
1298 * Function for worker->rebind_work used to rebind rogue busy workers
1299 * to the associated cpu which is coming back online. This is
1300 * scheduled by cpu up but can race with other cpu hotplug operations
1301 * and may be executed twice without intervening cpu down.
1303 static void worker_rebind_fn(struct work_struct *work)
1305 struct worker *worker = container_of(work, struct worker, rebind_work);
1306 struct global_cwq *gcwq = worker->gcwq;
1308 if (worker_maybe_bind_and_lock(worker))
1309 worker_clr_flags(worker, WORKER_REBIND);
1311 spin_unlock_irq(&gcwq->lock);
1314 static struct worker *alloc_worker(void)
1316 struct worker *worker;
1318 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1319 if (worker) {
1320 INIT_LIST_HEAD(&worker->entry);
1321 INIT_LIST_HEAD(&worker->scheduled);
1322 INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1323 /* on creation a worker is in !idle && prep state */
1324 worker->flags = WORKER_PREP;
1326 return worker;
1330 * create_worker - create a new workqueue worker
1331 * @gcwq: gcwq the new worker will belong to
1332 * @bind: whether to set affinity to @cpu or not
1334 * Create a new worker which is bound to @gcwq. The returned worker
1335 * can be started by calling start_worker() or destroyed using
1336 * destroy_worker().
1338 * CONTEXT:
1339 * Might sleep. Does GFP_KERNEL allocations.
1341 * RETURNS:
1342 * Pointer to the newly created worker.
1344 static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
1346 bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
1347 struct worker *worker = NULL;
1348 int id = -1;
1350 spin_lock_irq(&gcwq->lock);
1351 while (ida_get_new(&gcwq->worker_ida, &id)) {
1352 spin_unlock_irq(&gcwq->lock);
1353 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
1354 goto fail;
1355 spin_lock_irq(&gcwq->lock);
1357 spin_unlock_irq(&gcwq->lock);
1359 worker = alloc_worker();
1360 if (!worker)
1361 goto fail;
1363 worker->gcwq = gcwq;
1364 worker->id = id;
1366 if (!on_unbound_cpu)
1367 worker->task = kthread_create(worker_thread, worker,
1368 "kworker/%u:%d", gcwq->cpu, id);
1369 else
1370 worker->task = kthread_create(worker_thread, worker,
1371 "kworker/u:%d", id);
1372 if (IS_ERR(worker->task))
1373 goto fail;
1376 * A rogue worker will become a regular one if CPU comes
1377 * online later on. Make sure every worker has
1378 * PF_THREAD_BOUND set.
1380 if (bind && !on_unbound_cpu)
1381 kthread_bind(worker->task, gcwq->cpu);
1382 else {
1383 worker->task->flags |= PF_THREAD_BOUND;
1384 if (on_unbound_cpu)
1385 worker->flags |= WORKER_UNBOUND;
1388 return worker;
1389 fail:
1390 if (id >= 0) {
1391 spin_lock_irq(&gcwq->lock);
1392 ida_remove(&gcwq->worker_ida, id);
1393 spin_unlock_irq(&gcwq->lock);
1395 kfree(worker);
1396 return NULL;
1400 * start_worker - start a newly created worker
1401 * @worker: worker to start
1403 * Make the gcwq aware of @worker and start it.
1405 * CONTEXT:
1406 * spin_lock_irq(gcwq->lock).
1408 static void start_worker(struct worker *worker)
1410 worker->flags |= WORKER_STARTED;
1411 worker->gcwq->nr_workers++;
1412 worker_enter_idle(worker);
1413 wake_up_process(worker->task);
1417 * destroy_worker - destroy a workqueue worker
1418 * @worker: worker to be destroyed
1420 * Destroy @worker and adjust @gcwq stats accordingly.
1422 * CONTEXT:
1423 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1425 static void destroy_worker(struct worker *worker)
1427 struct global_cwq *gcwq = worker->gcwq;
1428 int id = worker->id;
1430 /* sanity check frenzy */
1431 BUG_ON(worker->current_work);
1432 BUG_ON(!list_empty(&worker->scheduled));
1434 if (worker->flags & WORKER_STARTED)
1435 gcwq->nr_workers--;
1436 if (worker->flags & WORKER_IDLE)
1437 gcwq->nr_idle--;
1439 list_del_init(&worker->entry);
1440 worker->flags |= WORKER_DIE;
1442 spin_unlock_irq(&gcwq->lock);
1444 kthread_stop(worker->task);
1445 kfree(worker);
1447 spin_lock_irq(&gcwq->lock);
1448 ida_remove(&gcwq->worker_ida, id);
1451 static void idle_worker_timeout(unsigned long __gcwq)
1453 struct global_cwq *gcwq = (void *)__gcwq;
1455 spin_lock_irq(&gcwq->lock);
1457 if (too_many_workers(gcwq)) {
1458 struct worker *worker;
1459 unsigned long expires;
1461 /* idle_list is kept in LIFO order, check the last one */
1462 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1463 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1465 if (time_before(jiffies, expires))
1466 mod_timer(&gcwq->idle_timer, expires);
1467 else {
1468 /* it's been idle for too long, wake up manager */
1469 gcwq->flags |= GCWQ_MANAGE_WORKERS;
1470 wake_up_worker(gcwq);
1474 spin_unlock_irq(&gcwq->lock);
1477 static bool send_mayday(struct work_struct *work)
1479 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1480 struct workqueue_struct *wq = cwq->wq;
1481 unsigned int cpu;
1483 if (!(wq->flags & WQ_RESCUER))
1484 return false;
1486 /* mayday mayday mayday */
1487 cpu = cwq->gcwq->cpu;
1488 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1489 if (cpu == WORK_CPU_UNBOUND)
1490 cpu = 0;
1491 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1492 wake_up_process(wq->rescuer->task);
1493 return true;
1496 static void gcwq_mayday_timeout(unsigned long __gcwq)
1498 struct global_cwq *gcwq = (void *)__gcwq;
1499 struct work_struct *work;
1501 spin_lock_irq(&gcwq->lock);
1503 if (need_to_create_worker(gcwq)) {
1505 * We've been trying to create a new worker but
1506 * haven't been successful. We might be hitting an
1507 * allocation deadlock. Send distress signals to
1508 * rescuers.
1510 list_for_each_entry(work, &gcwq->worklist, entry)
1511 send_mayday(work);
1514 spin_unlock_irq(&gcwq->lock);
1516 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1520 * maybe_create_worker - create a new worker if necessary
1521 * @gcwq: gcwq to create a new worker for
1523 * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to
1524 * have at least one idle worker on return from this function. If
1525 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1526 * sent to all rescuers with works scheduled on @gcwq to resolve
1527 * possible allocation deadlock.
1529 * On return, need_to_create_worker() is guaranteed to be false and
1530 * may_start_working() true.
1532 * LOCKING:
1533 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1534 * multiple times. Does GFP_KERNEL allocations. Called only from
1535 * manager.
1537 * RETURNS:
1538 * false if no action was taken and gcwq->lock stayed locked, true
1539 * otherwise.
1541 static bool maybe_create_worker(struct global_cwq *gcwq)
1542 __releases(&gcwq->lock)
1543 __acquires(&gcwq->lock)
1545 if (!need_to_create_worker(gcwq))
1546 return false;
1547 restart:
1548 spin_unlock_irq(&gcwq->lock);
1550 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1551 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1553 while (true) {
1554 struct worker *worker;
1556 worker = create_worker(gcwq, true);
1557 if (worker) {
1558 del_timer_sync(&gcwq->mayday_timer);
1559 spin_lock_irq(&gcwq->lock);
1560 start_worker(worker);
1561 BUG_ON(need_to_create_worker(gcwq));
1562 return true;
1565 if (!need_to_create_worker(gcwq))
1566 break;
1568 __set_current_state(TASK_INTERRUPTIBLE);
1569 schedule_timeout(CREATE_COOLDOWN);
1571 if (!need_to_create_worker(gcwq))
1572 break;
1575 del_timer_sync(&gcwq->mayday_timer);
1576 spin_lock_irq(&gcwq->lock);
1577 if (need_to_create_worker(gcwq))
1578 goto restart;
1579 return true;
1583 * maybe_destroy_worker - destroy workers which have been idle for a while
1584 * @gcwq: gcwq to destroy workers for
1586 * Destroy @gcwq workers which have been idle for longer than
1587 * IDLE_WORKER_TIMEOUT.
1589 * LOCKING:
1590 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1591 * multiple times. Called only from manager.
1593 * RETURNS:
1594 * false if no action was taken and gcwq->lock stayed locked, true
1595 * otherwise.
1597 static bool maybe_destroy_workers(struct global_cwq *gcwq)
1599 bool ret = false;
1601 while (too_many_workers(gcwq)) {
1602 struct worker *worker;
1603 unsigned long expires;
1605 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1606 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1608 if (time_before(jiffies, expires)) {
1609 mod_timer(&gcwq->idle_timer, expires);
1610 break;
1613 destroy_worker(worker);
1614 ret = true;
1617 return ret;
1621 * manage_workers - manage worker pool
1622 * @worker: self
1624 * Assume the manager role and manage gcwq worker pool @worker belongs
1625 * to. At any given time, there can be only zero or one manager per
1626 * gcwq. The exclusion is handled automatically by this function.
1628 * The caller can safely start processing works on false return. On
1629 * true return, it's guaranteed that need_to_create_worker() is false
1630 * and may_start_working() is true.
1632 * CONTEXT:
1633 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1634 * multiple times. Does GFP_KERNEL allocations.
1636 * RETURNS:
1637 * false if no action was taken and gcwq->lock stayed locked, true if
1638 * some action was taken.
1640 static bool manage_workers(struct worker *worker)
1642 struct global_cwq *gcwq = worker->gcwq;
1643 bool ret = false;
1645 if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1646 return ret;
1648 gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1649 gcwq->flags |= GCWQ_MANAGING_WORKERS;
1652 * Destroy and then create so that may_start_working() is true
1653 * on return.
1655 ret |= maybe_destroy_workers(gcwq);
1656 ret |= maybe_create_worker(gcwq);
1658 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1661 * The trustee might be waiting to take over the manager
1662 * position, tell it we're done.
1664 if (unlikely(gcwq->trustee))
1665 wake_up_all(&gcwq->trustee_wait);
1667 return ret;
1671 * move_linked_works - move linked works to a list
1672 * @work: start of series of works to be scheduled
1673 * @head: target list to append @work to
1674 * @nextp: out paramter for nested worklist walking
1676 * Schedule linked works starting from @work to @head. Work series to
1677 * be scheduled starts at @work and includes any consecutive work with
1678 * WORK_STRUCT_LINKED set in its predecessor.
1680 * If @nextp is not NULL, it's updated to point to the next work of
1681 * the last scheduled work. This allows move_linked_works() to be
1682 * nested inside outer list_for_each_entry_safe().
1684 * CONTEXT:
1685 * spin_lock_irq(gcwq->lock).
1687 static void move_linked_works(struct work_struct *work, struct list_head *head,
1688 struct work_struct **nextp)
1690 struct work_struct *n;
1693 * Linked worklist will always end before the end of the list,
1694 * use NULL for list head.
1696 list_for_each_entry_safe_from(work, n, NULL, entry) {
1697 list_move_tail(&work->entry, head);
1698 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1699 break;
1703 * If we're already inside safe list traversal and have moved
1704 * multiple works to the scheduled queue, the next position
1705 * needs to be updated.
1707 if (nextp)
1708 *nextp = n;
1711 static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
1713 struct work_struct *work = list_first_entry(&cwq->delayed_works,
1714 struct work_struct, entry);
1715 struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
1717 trace_workqueue_activate_work(work);
1718 move_linked_works(work, pos, NULL);
1719 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1720 cwq->nr_active++;
1724 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1725 * @cwq: cwq of interest
1726 * @color: color of work which left the queue
1727 * @delayed: for a delayed work
1729 * A work either has completed or is removed from pending queue,
1730 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1732 * CONTEXT:
1733 * spin_lock_irq(gcwq->lock).
1735 static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1736 bool delayed)
1738 /* ignore uncolored works */
1739 if (color == WORK_NO_COLOR)
1740 return;
1742 cwq->nr_in_flight[color]--;
1744 if (!delayed) {
1745 cwq->nr_active--;
1746 if (!list_empty(&cwq->delayed_works)) {
1747 /* one down, submit a delayed one */
1748 if (cwq->nr_active < cwq->max_active)
1749 cwq_activate_first_delayed(cwq);
1753 /* is flush in progress and are we at the flushing tip? */
1754 if (likely(cwq->flush_color != color))
1755 return;
1757 /* are there still in-flight works? */
1758 if (cwq->nr_in_flight[color])
1759 return;
1761 /* this cwq is done, clear flush_color */
1762 cwq->flush_color = -1;
1765 * If this was the last cwq, wake up the first flusher. It
1766 * will handle the rest.
1768 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1769 complete(&cwq->wq->first_flusher->done);
1773 * process_one_work - process single work
1774 * @worker: self
1775 * @work: work to process
1777 * Process @work. This function contains all the logics necessary to
1778 * process a single work including synchronization against and
1779 * interaction with other workers on the same cpu, queueing and
1780 * flushing. As long as context requirement is met, any worker can
1781 * call this function to process a work.
1783 * CONTEXT:
1784 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1786 static void process_one_work(struct worker *worker, struct work_struct *work)
1787 __releases(&gcwq->lock)
1788 __acquires(&gcwq->lock)
1790 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1791 struct global_cwq *gcwq = cwq->gcwq;
1792 struct hlist_head *bwh = busy_worker_head(gcwq, work);
1793 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
1794 work_func_t f = work->func;
1795 int work_color;
1796 struct worker *collision;
1797 #ifdef CONFIG_LOCKDEP
1799 * It is permissible to free the struct work_struct from
1800 * inside the function that is called from it, this we need to
1801 * take into account for lockdep too. To avoid bogus "held
1802 * lock freed" warnings as well as problems when looking into
1803 * work->lockdep_map, make a copy and use that here.
1805 struct lockdep_map lockdep_map = work->lockdep_map;
1806 #endif
1808 * A single work shouldn't be executed concurrently by
1809 * multiple workers on a single cpu. Check whether anyone is
1810 * already processing the work. If so, defer the work to the
1811 * currently executing one.
1813 collision = __find_worker_executing_work(gcwq, bwh, work);
1814 if (unlikely(collision)) {
1815 move_linked_works(work, &collision->scheduled, NULL);
1816 return;
1819 /* claim and process */
1820 debug_work_deactivate(work);
1821 hlist_add_head(&worker->hentry, bwh);
1822 worker->current_work = work;
1823 worker->current_cwq = cwq;
1824 work_color = get_work_color(work);
1826 /* record the current cpu number in the work data and dequeue */
1827 set_work_cpu(work, gcwq->cpu);
1828 list_del_init(&work->entry);
1831 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1832 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1834 if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1835 struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1836 struct work_struct, entry);
1838 if (!list_empty(&gcwq->worklist) &&
1839 get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1840 wake_up_worker(gcwq);
1841 else
1842 gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1846 * CPU intensive works don't participate in concurrency
1847 * management. They're the scheduler's responsibility.
1849 if (unlikely(cpu_intensive))
1850 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1852 spin_unlock_irq(&gcwq->lock);
1854 work_clear_pending(work);
1855 lock_map_acquire_read(&cwq->wq->lockdep_map);
1856 lock_map_acquire(&lockdep_map);
1857 trace_workqueue_execute_start(work);
1858 f(work);
1860 * While we must be careful to not use "work" after this, the trace
1861 * point will only record its address.
1863 trace_workqueue_execute_end(work);
1864 lock_map_release(&lockdep_map);
1865 lock_map_release(&cwq->wq->lockdep_map);
1867 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1868 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1869 "%s/0x%08x/%d\n",
1870 current->comm, preempt_count(), task_pid_nr(current));
1871 printk(KERN_ERR " last function: ");
1872 print_symbol("%s\n", (unsigned long)f);
1873 debug_show_held_locks(current);
1874 dump_stack();
1877 spin_lock_irq(&gcwq->lock);
1879 /* clear cpu intensive status */
1880 if (unlikely(cpu_intensive))
1881 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1883 /* we're done with it, release */
1884 hlist_del_init(&worker->hentry);
1885 worker->current_work = NULL;
1886 worker->current_cwq = NULL;
1887 cwq_dec_nr_in_flight(cwq, work_color, false);
1891 * process_scheduled_works - process scheduled works
1892 * @worker: self
1894 * Process all scheduled works. Please note that the scheduled list
1895 * may change while processing a work, so this function repeatedly
1896 * fetches a work from the top and executes it.
1898 * CONTEXT:
1899 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1900 * multiple times.
1902 static void process_scheduled_works(struct worker *worker)
1904 while (!list_empty(&worker->scheduled)) {
1905 struct work_struct *work = list_first_entry(&worker->scheduled,
1906 struct work_struct, entry);
1907 process_one_work(worker, work);
1912 * worker_thread - the worker thread function
1913 * @__worker: self
1915 * The gcwq worker thread function. There's a single dynamic pool of
1916 * these per each cpu. These workers process all works regardless of
1917 * their specific target workqueue. The only exception is works which
1918 * belong to workqueues with a rescuer which will be explained in
1919 * rescuer_thread().
1921 static int worker_thread(void *__worker)
1923 struct worker *worker = __worker;
1924 struct global_cwq *gcwq = worker->gcwq;
1926 /* tell the scheduler that this is a workqueue worker */
1927 worker->task->flags |= PF_WQ_WORKER;
1928 woke_up:
1929 spin_lock_irq(&gcwq->lock);
1931 /* DIE can be set only while we're idle, checking here is enough */
1932 if (worker->flags & WORKER_DIE) {
1933 spin_unlock_irq(&gcwq->lock);
1934 worker->task->flags &= ~PF_WQ_WORKER;
1935 return 0;
1938 worker_leave_idle(worker);
1939 recheck:
1940 /* no more worker necessary? */
1941 if (!need_more_worker(gcwq))
1942 goto sleep;
1944 /* do we need to manage? */
1945 if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1946 goto recheck;
1949 * ->scheduled list can only be filled while a worker is
1950 * preparing to process a work or actually processing it.
1951 * Make sure nobody diddled with it while I was sleeping.
1953 BUG_ON(!list_empty(&worker->scheduled));
1956 * When control reaches this point, we're guaranteed to have
1957 * at least one idle worker or that someone else has already
1958 * assumed the manager role.
1960 worker_clr_flags(worker, WORKER_PREP);
1962 do {
1963 struct work_struct *work =
1964 list_first_entry(&gcwq->worklist,
1965 struct work_struct, entry);
1967 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1968 /* optimization path, not strictly necessary */
1969 process_one_work(worker, work);
1970 if (unlikely(!list_empty(&worker->scheduled)))
1971 process_scheduled_works(worker);
1972 } else {
1973 move_linked_works(work, &worker->scheduled, NULL);
1974 process_scheduled_works(worker);
1976 } while (keep_working(gcwq));
1978 worker_set_flags(worker, WORKER_PREP, false);
1979 sleep:
1980 if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
1981 goto recheck;
1984 * gcwq->lock is held and there's no work to process and no
1985 * need to manage, sleep. Workers are woken up only while
1986 * holding gcwq->lock or from local cpu, so setting the
1987 * current state before releasing gcwq->lock is enough to
1988 * prevent losing any event.
1990 worker_enter_idle(worker);
1991 __set_current_state(TASK_INTERRUPTIBLE);
1992 spin_unlock_irq(&gcwq->lock);
1993 schedule();
1994 goto woke_up;
1998 * rescuer_thread - the rescuer thread function
1999 * @__wq: the associated workqueue
2001 * Workqueue rescuer thread function. There's one rescuer for each
2002 * workqueue which has WQ_RESCUER set.
2004 * Regular work processing on a gcwq may block trying to create a new
2005 * worker which uses GFP_KERNEL allocation which has slight chance of
2006 * developing into deadlock if some works currently on the same queue
2007 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2008 * the problem rescuer solves.
2010 * When such condition is possible, the gcwq summons rescuers of all
2011 * workqueues which have works queued on the gcwq and let them process
2012 * those works so that forward progress can be guaranteed.
2014 * This should happen rarely.
2016 static int rescuer_thread(void *__wq)
2018 struct workqueue_struct *wq = __wq;
2019 struct worker *rescuer = wq->rescuer;
2020 struct list_head *scheduled = &rescuer->scheduled;
2021 bool is_unbound = wq->flags & WQ_UNBOUND;
2022 unsigned int cpu;
2024 set_user_nice(current, RESCUER_NICE_LEVEL);
2025 repeat:
2026 set_current_state(TASK_INTERRUPTIBLE);
2028 if (kthread_should_stop())
2029 return 0;
2032 * See whether any cpu is asking for help. Unbounded
2033 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2035 for_each_mayday_cpu(cpu, wq->mayday_mask) {
2036 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2037 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2038 struct global_cwq *gcwq = cwq->gcwq;
2039 struct work_struct *work, *n;
2041 __set_current_state(TASK_RUNNING);
2042 mayday_clear_cpu(cpu, wq->mayday_mask);
2044 /* migrate to the target cpu if possible */
2045 rescuer->gcwq = gcwq;
2046 worker_maybe_bind_and_lock(rescuer);
2049 * Slurp in all works issued via this workqueue and
2050 * process'em.
2052 BUG_ON(!list_empty(&rescuer->scheduled));
2053 list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
2054 if (get_work_cwq(work) == cwq)
2055 move_linked_works(work, scheduled, &n);
2057 process_scheduled_works(rescuer);
2060 * Leave this gcwq. If keep_working() is %true, notify a
2061 * regular worker; otherwise, we end up with 0 concurrency
2062 * and stalling the execution.
2064 if (keep_working(gcwq))
2065 wake_up_worker(gcwq);
2067 spin_unlock_irq(&gcwq->lock);
2070 schedule();
2071 goto repeat;
2074 struct wq_barrier {
2075 struct work_struct work;
2076 struct completion done;
2079 static void wq_barrier_func(struct work_struct *work)
2081 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2082 complete(&barr->done);
2086 * insert_wq_barrier - insert a barrier work
2087 * @cwq: cwq to insert barrier into
2088 * @barr: wq_barrier to insert
2089 * @target: target work to attach @barr to
2090 * @worker: worker currently executing @target, NULL if @target is not executing
2092 * @barr is linked to @target such that @barr is completed only after
2093 * @target finishes execution. Please note that the ordering
2094 * guarantee is observed only with respect to @target and on the local
2095 * cpu.
2097 * Currently, a queued barrier can't be canceled. This is because
2098 * try_to_grab_pending() can't determine whether the work to be
2099 * grabbed is at the head of the queue and thus can't clear LINKED
2100 * flag of the previous work while there must be a valid next work
2101 * after a work with LINKED flag set.
2103 * Note that when @worker is non-NULL, @target may be modified
2104 * underneath us, so we can't reliably determine cwq from @target.
2106 * CONTEXT:
2107 * spin_lock_irq(gcwq->lock).
2109 static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2110 struct wq_barrier *barr,
2111 struct work_struct *target, struct worker *worker)
2113 struct list_head *head;
2114 unsigned int linked = 0;
2117 * debugobject calls are safe here even with gcwq->lock locked
2118 * as we know for sure that this will not trigger any of the
2119 * checks and call back into the fixup functions where we
2120 * might deadlock.
2122 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
2123 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2124 init_completion(&barr->done);
2127 * If @target is currently being executed, schedule the
2128 * barrier to the worker; otherwise, put it after @target.
2130 if (worker)
2131 head = worker->scheduled.next;
2132 else {
2133 unsigned long *bits = work_data_bits(target);
2135 head = target->entry.next;
2136 /* there can already be other linked works, inherit and set */
2137 linked = *bits & WORK_STRUCT_LINKED;
2138 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2141 debug_work_activate(&barr->work);
2142 insert_work(cwq, &barr->work, head,
2143 work_color_to_flags(WORK_NO_COLOR) | linked);
2147 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2148 * @wq: workqueue being flushed
2149 * @flush_color: new flush color, < 0 for no-op
2150 * @work_color: new work color, < 0 for no-op
2152 * Prepare cwqs for workqueue flushing.
2154 * If @flush_color is non-negative, flush_color on all cwqs should be
2155 * -1. If no cwq has in-flight commands at the specified color, all
2156 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2157 * has in flight commands, its cwq->flush_color is set to
2158 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2159 * wakeup logic is armed and %true is returned.
2161 * The caller should have initialized @wq->first_flusher prior to
2162 * calling this function with non-negative @flush_color. If
2163 * @flush_color is negative, no flush color update is done and %false
2164 * is returned.
2166 * If @work_color is non-negative, all cwqs should have the same
2167 * work_color which is previous to @work_color and all will be
2168 * advanced to @work_color.
2170 * CONTEXT:
2171 * mutex_lock(wq->flush_mutex).
2173 * RETURNS:
2174 * %true if @flush_color >= 0 and there's something to flush. %false
2175 * otherwise.
2177 static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2178 int flush_color, int work_color)
2180 bool wait = false;
2181 unsigned int cpu;
2183 if (flush_color >= 0) {
2184 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2185 atomic_set(&wq->nr_cwqs_to_flush, 1);
2188 for_each_cwq_cpu(cpu, wq) {
2189 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2190 struct global_cwq *gcwq = cwq->gcwq;
2192 spin_lock_irq(&gcwq->lock);
2194 if (flush_color >= 0) {
2195 BUG_ON(cwq->flush_color != -1);
2197 if (cwq->nr_in_flight[flush_color]) {
2198 cwq->flush_color = flush_color;
2199 atomic_inc(&wq->nr_cwqs_to_flush);
2200 wait = true;
2204 if (work_color >= 0) {
2205 BUG_ON(work_color != work_next_color(cwq->work_color));
2206 cwq->work_color = work_color;
2209 spin_unlock_irq(&gcwq->lock);
2212 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2213 complete(&wq->first_flusher->done);
2215 return wait;
2219 * flush_workqueue - ensure that any scheduled work has run to completion.
2220 * @wq: workqueue to flush
2222 * Forces execution of the workqueue and blocks until its completion.
2223 * This is typically used in driver shutdown handlers.
2225 * We sleep until all works which were queued on entry have been handled,
2226 * but we are not livelocked by new incoming ones.
2228 void flush_workqueue(struct workqueue_struct *wq)
2230 struct wq_flusher this_flusher = {
2231 .list = LIST_HEAD_INIT(this_flusher.list),
2232 .flush_color = -1,
2233 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2235 int next_color;
2237 lock_map_acquire(&wq->lockdep_map);
2238 lock_map_release(&wq->lockdep_map);
2240 mutex_lock(&wq->flush_mutex);
2243 * Start-to-wait phase
2245 next_color = work_next_color(wq->work_color);
2247 if (next_color != wq->flush_color) {
2249 * Color space is not full. The current work_color
2250 * becomes our flush_color and work_color is advanced
2251 * by one.
2253 BUG_ON(!list_empty(&wq->flusher_overflow));
2254 this_flusher.flush_color = wq->work_color;
2255 wq->work_color = next_color;
2257 if (!wq->first_flusher) {
2258 /* no flush in progress, become the first flusher */
2259 BUG_ON(wq->flush_color != this_flusher.flush_color);
2261 wq->first_flusher = &this_flusher;
2263 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2264 wq->work_color)) {
2265 /* nothing to flush, done */
2266 wq->flush_color = next_color;
2267 wq->first_flusher = NULL;
2268 goto out_unlock;
2270 } else {
2271 /* wait in queue */
2272 BUG_ON(wq->flush_color == this_flusher.flush_color);
2273 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2274 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2276 } else {
2278 * Oops, color space is full, wait on overflow queue.
2279 * The next flush completion will assign us
2280 * flush_color and transfer to flusher_queue.
2282 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2285 mutex_unlock(&wq->flush_mutex);
2287 wait_for_completion(&this_flusher.done);
2290 * Wake-up-and-cascade phase
2292 * First flushers are responsible for cascading flushes and
2293 * handling overflow. Non-first flushers can simply return.
2295 if (wq->first_flusher != &this_flusher)
2296 return;
2298 mutex_lock(&wq->flush_mutex);
2300 /* we might have raced, check again with mutex held */
2301 if (wq->first_flusher != &this_flusher)
2302 goto out_unlock;
2304 wq->first_flusher = NULL;
2306 BUG_ON(!list_empty(&this_flusher.list));
2307 BUG_ON(wq->flush_color != this_flusher.flush_color);
2309 while (true) {
2310 struct wq_flusher *next, *tmp;
2312 /* complete all the flushers sharing the current flush color */
2313 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2314 if (next->flush_color != wq->flush_color)
2315 break;
2316 list_del_init(&next->list);
2317 complete(&next->done);
2320 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2321 wq->flush_color != work_next_color(wq->work_color));
2323 /* this flush_color is finished, advance by one */
2324 wq->flush_color = work_next_color(wq->flush_color);
2326 /* one color has been freed, handle overflow queue */
2327 if (!list_empty(&wq->flusher_overflow)) {
2329 * Assign the same color to all overflowed
2330 * flushers, advance work_color and append to
2331 * flusher_queue. This is the start-to-wait
2332 * phase for these overflowed flushers.
2334 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2335 tmp->flush_color = wq->work_color;
2337 wq->work_color = work_next_color(wq->work_color);
2339 list_splice_tail_init(&wq->flusher_overflow,
2340 &wq->flusher_queue);
2341 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2344 if (list_empty(&wq->flusher_queue)) {
2345 BUG_ON(wq->flush_color != wq->work_color);
2346 break;
2350 * Need to flush more colors. Make the next flusher
2351 * the new first flusher and arm cwqs.
2353 BUG_ON(wq->flush_color == wq->work_color);
2354 BUG_ON(wq->flush_color != next->flush_color);
2356 list_del_init(&next->list);
2357 wq->first_flusher = next;
2359 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2360 break;
2363 * Meh... this color is already done, clear first
2364 * flusher and repeat cascading.
2366 wq->first_flusher = NULL;
2369 out_unlock:
2370 mutex_unlock(&wq->flush_mutex);
2372 EXPORT_SYMBOL_GPL(flush_workqueue);
2374 static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2375 bool wait_executing)
2377 struct worker *worker = NULL;
2378 struct global_cwq *gcwq;
2379 struct cpu_workqueue_struct *cwq;
2381 might_sleep();
2382 gcwq = get_work_gcwq(work);
2383 if (!gcwq)
2384 return false;
2386 spin_lock_irq(&gcwq->lock);
2387 if (!list_empty(&work->entry)) {
2389 * See the comment near try_to_grab_pending()->smp_rmb().
2390 * If it was re-queued to a different gcwq under us, we
2391 * are not going to wait.
2393 smp_rmb();
2394 cwq = get_work_cwq(work);
2395 if (unlikely(!cwq || gcwq != cwq->gcwq))
2396 goto already_gone;
2397 } else if (wait_executing) {
2398 worker = find_worker_executing_work(gcwq, work);
2399 if (!worker)
2400 goto already_gone;
2401 cwq = worker->current_cwq;
2402 } else
2403 goto already_gone;
2405 insert_wq_barrier(cwq, barr, work, worker);
2406 spin_unlock_irq(&gcwq->lock);
2409 * If @max_active is 1 or rescuer is in use, flushing another work
2410 * item on the same workqueue may lead to deadlock. Make sure the
2411 * flusher is not running on the same workqueue by verifying write
2412 * access.
2414 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2415 lock_map_acquire(&cwq->wq->lockdep_map);
2416 else
2417 lock_map_acquire_read(&cwq->wq->lockdep_map);
2418 lock_map_release(&cwq->wq->lockdep_map);
2420 return true;
2421 already_gone:
2422 spin_unlock_irq(&gcwq->lock);
2423 return false;
2427 * flush_work - wait for a work to finish executing the last queueing instance
2428 * @work: the work to flush
2430 * Wait until @work has finished execution. This function considers
2431 * only the last queueing instance of @work. If @work has been
2432 * enqueued across different CPUs on a non-reentrant workqueue or on
2433 * multiple workqueues, @work might still be executing on return on
2434 * some of the CPUs from earlier queueing.
2436 * If @work was queued only on a non-reentrant, ordered or unbound
2437 * workqueue, @work is guaranteed to be idle on return if it hasn't
2438 * been requeued since flush started.
2440 * RETURNS:
2441 * %true if flush_work() waited for the work to finish execution,
2442 * %false if it was already idle.
2444 bool flush_work(struct work_struct *work)
2446 struct wq_barrier barr;
2448 if (start_flush_work(work, &barr, true)) {
2449 wait_for_completion(&barr.done);
2450 destroy_work_on_stack(&barr.work);
2451 return true;
2452 } else
2453 return false;
2455 EXPORT_SYMBOL_GPL(flush_work);
2457 static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2459 struct wq_barrier barr;
2460 struct worker *worker;
2462 spin_lock_irq(&gcwq->lock);
2464 worker = find_worker_executing_work(gcwq, work);
2465 if (unlikely(worker))
2466 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2468 spin_unlock_irq(&gcwq->lock);
2470 if (unlikely(worker)) {
2471 wait_for_completion(&barr.done);
2472 destroy_work_on_stack(&barr.work);
2473 return true;
2474 } else
2475 return false;
2478 static bool wait_on_work(struct work_struct *work)
2480 bool ret = false;
2481 int cpu;
2483 might_sleep();
2485 lock_map_acquire(&work->lockdep_map);
2486 lock_map_release(&work->lockdep_map);
2488 for_each_gcwq_cpu(cpu)
2489 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2490 return ret;
2494 * flush_work_sync - wait until a work has finished execution
2495 * @work: the work to flush
2497 * Wait until @work has finished execution. On return, it's
2498 * guaranteed that all queueing instances of @work which happened
2499 * before this function is called are finished. In other words, if
2500 * @work hasn't been requeued since this function was called, @work is
2501 * guaranteed to be idle on return.
2503 * RETURNS:
2504 * %true if flush_work_sync() waited for the work to finish execution,
2505 * %false if it was already idle.
2507 bool flush_work_sync(struct work_struct *work)
2509 struct wq_barrier barr;
2510 bool pending, waited;
2512 /* we'll wait for executions separately, queue barr only if pending */
2513 pending = start_flush_work(work, &barr, false);
2515 /* wait for executions to finish */
2516 waited = wait_on_work(work);
2518 /* wait for the pending one */
2519 if (pending) {
2520 wait_for_completion(&barr.done);
2521 destroy_work_on_stack(&barr.work);
2524 return pending || waited;
2526 EXPORT_SYMBOL_GPL(flush_work_sync);
2529 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
2530 * so this work can't be re-armed in any way.
2532 static int try_to_grab_pending(struct work_struct *work)
2534 struct global_cwq *gcwq;
2535 int ret = -1;
2537 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
2538 return 0;
2541 * The queueing is in progress, or it is already queued. Try to
2542 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2544 gcwq = get_work_gcwq(work);
2545 if (!gcwq)
2546 return ret;
2548 spin_lock_irq(&gcwq->lock);
2549 if (!list_empty(&work->entry)) {
2551 * This work is queued, but perhaps we locked the wrong gcwq.
2552 * In that case we must see the new value after rmb(), see
2553 * insert_work()->wmb().
2555 smp_rmb();
2556 if (gcwq == get_work_gcwq(work)) {
2557 debug_work_deactivate(work);
2558 list_del_init(&work->entry);
2559 cwq_dec_nr_in_flight(get_work_cwq(work),
2560 get_work_color(work),
2561 *work_data_bits(work) & WORK_STRUCT_DELAYED);
2562 ret = 1;
2565 spin_unlock_irq(&gcwq->lock);
2567 return ret;
2570 static bool __cancel_work_timer(struct work_struct *work,
2571 struct timer_list* timer)
2573 int ret;
2575 do {
2576 ret = (timer && likely(del_timer(timer)));
2577 if (!ret)
2578 ret = try_to_grab_pending(work);
2579 wait_on_work(work);
2580 } while (unlikely(ret < 0));
2582 clear_work_data(work);
2583 return ret;
2587 * cancel_work_sync - cancel a work and wait for it to finish
2588 * @work: the work to cancel
2590 * Cancel @work and wait for its execution to finish. This function
2591 * can be used even if the work re-queues itself or migrates to
2592 * another workqueue. On return from this function, @work is
2593 * guaranteed to be not pending or executing on any CPU.
2595 * cancel_work_sync(&delayed_work->work) must not be used for
2596 * delayed_work's. Use cancel_delayed_work_sync() instead.
2598 * The caller must ensure that the workqueue on which @work was last
2599 * queued can't be destroyed before this function returns.
2601 * RETURNS:
2602 * %true if @work was pending, %false otherwise.
2604 bool cancel_work_sync(struct work_struct *work)
2606 return __cancel_work_timer(work, NULL);
2608 EXPORT_SYMBOL_GPL(cancel_work_sync);
2611 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2612 * @dwork: the delayed work to flush
2614 * Delayed timer is cancelled and the pending work is queued for
2615 * immediate execution. Like flush_work(), this function only
2616 * considers the last queueing instance of @dwork.
2618 * RETURNS:
2619 * %true if flush_work() waited for the work to finish execution,
2620 * %false if it was already idle.
2622 bool flush_delayed_work(struct delayed_work *dwork)
2624 if (del_timer_sync(&dwork->timer))
2625 __queue_work(raw_smp_processor_id(),
2626 get_work_cwq(&dwork->work)->wq, &dwork->work);
2627 return flush_work(&dwork->work);
2629 EXPORT_SYMBOL(flush_delayed_work);
2632 * flush_delayed_work_sync - wait for a dwork to finish
2633 * @dwork: the delayed work to flush
2635 * Delayed timer is cancelled and the pending work is queued for
2636 * execution immediately. Other than timer handling, its behavior
2637 * is identical to flush_work_sync().
2639 * RETURNS:
2640 * %true if flush_work_sync() waited for the work to finish execution,
2641 * %false if it was already idle.
2643 bool flush_delayed_work_sync(struct delayed_work *dwork)
2645 if (del_timer_sync(&dwork->timer))
2646 __queue_work(raw_smp_processor_id(),
2647 get_work_cwq(&dwork->work)->wq, &dwork->work);
2648 return flush_work_sync(&dwork->work);
2650 EXPORT_SYMBOL(flush_delayed_work_sync);
2653 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2654 * @dwork: the delayed work cancel
2656 * This is cancel_work_sync() for delayed works.
2658 * RETURNS:
2659 * %true if @dwork was pending, %false otherwise.
2661 bool cancel_delayed_work_sync(struct delayed_work *dwork)
2663 return __cancel_work_timer(&dwork->work, &dwork->timer);
2665 EXPORT_SYMBOL(cancel_delayed_work_sync);
2668 * schedule_work - put work task in global workqueue
2669 * @work: job to be done
2671 * Returns zero if @work was already on the kernel-global workqueue and
2672 * non-zero otherwise.
2674 * This puts a job in the kernel-global workqueue if it was not already
2675 * queued and leaves it in the same position on the kernel-global
2676 * workqueue otherwise.
2678 int schedule_work(struct work_struct *work)
2680 return queue_work(system_wq, work);
2682 EXPORT_SYMBOL(schedule_work);
2685 * schedule_work_on - put work task on a specific cpu
2686 * @cpu: cpu to put the work task on
2687 * @work: job to be done
2689 * This puts a job on a specific cpu
2691 int schedule_work_on(int cpu, struct work_struct *work)
2693 return queue_work_on(cpu, system_wq, work);
2695 EXPORT_SYMBOL(schedule_work_on);
2698 * schedule_delayed_work - put work task in global workqueue after delay
2699 * @dwork: job to be done
2700 * @delay: number of jiffies to wait or 0 for immediate execution
2702 * After waiting for a given time this puts a job in the kernel-global
2703 * workqueue.
2705 int schedule_delayed_work(struct delayed_work *dwork,
2706 unsigned long delay)
2708 return queue_delayed_work(system_wq, dwork, delay);
2710 EXPORT_SYMBOL(schedule_delayed_work);
2713 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2714 * @cpu: cpu to use
2715 * @dwork: job to be done
2716 * @delay: number of jiffies to wait
2718 * After waiting for a given time this puts a job in the kernel-global
2719 * workqueue on the specified CPU.
2721 int schedule_delayed_work_on(int cpu,
2722 struct delayed_work *dwork, unsigned long delay)
2724 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
2726 EXPORT_SYMBOL(schedule_delayed_work_on);
2729 * schedule_on_each_cpu - execute a function synchronously on each online CPU
2730 * @func: the function to call
2732 * schedule_on_each_cpu() executes @func on each online CPU using the
2733 * system workqueue and blocks until all CPUs have completed.
2734 * schedule_on_each_cpu() is very slow.
2736 * RETURNS:
2737 * 0 on success, -errno on failure.
2739 int schedule_on_each_cpu(work_func_t func)
2741 int cpu;
2742 struct work_struct __percpu *works;
2744 works = alloc_percpu(struct work_struct);
2745 if (!works)
2746 return -ENOMEM;
2748 get_online_cpus();
2750 for_each_online_cpu(cpu) {
2751 struct work_struct *work = per_cpu_ptr(works, cpu);
2753 INIT_WORK(work, func);
2754 schedule_work_on(cpu, work);
2757 for_each_online_cpu(cpu)
2758 flush_work(per_cpu_ptr(works, cpu));
2760 put_online_cpus();
2761 free_percpu(works);
2762 return 0;
2766 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2768 * Forces execution of the kernel-global workqueue and blocks until its
2769 * completion.
2771 * Think twice before calling this function! It's very easy to get into
2772 * trouble if you don't take great care. Either of the following situations
2773 * will lead to deadlock:
2775 * One of the work items currently on the workqueue needs to acquire
2776 * a lock held by your code or its caller.
2778 * Your code is running in the context of a work routine.
2780 * They will be detected by lockdep when they occur, but the first might not
2781 * occur very often. It depends on what work items are on the workqueue and
2782 * what locks they need, which you have no control over.
2784 * In most situations flushing the entire workqueue is overkill; you merely
2785 * need to know that a particular work item isn't queued and isn't running.
2786 * In such cases you should use cancel_delayed_work_sync() or
2787 * cancel_work_sync() instead.
2789 void flush_scheduled_work(void)
2791 flush_workqueue(system_wq);
2793 EXPORT_SYMBOL(flush_scheduled_work);
2796 * execute_in_process_context - reliably execute the routine with user context
2797 * @fn: the function to execute
2798 * @ew: guaranteed storage for the execute work structure (must
2799 * be available when the work executes)
2801 * Executes the function immediately if process context is available,
2802 * otherwise schedules the function for delayed execution.
2804 * Returns: 0 - function was executed
2805 * 1 - function was scheduled for execution
2807 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
2809 if (!in_interrupt()) {
2810 fn(&ew->work);
2811 return 0;
2814 INIT_WORK(&ew->work, fn);
2815 schedule_work(&ew->work);
2817 return 1;
2819 EXPORT_SYMBOL_GPL(execute_in_process_context);
2821 int keventd_up(void)
2823 return system_wq != NULL;
2826 static int alloc_cwqs(struct workqueue_struct *wq)
2829 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
2830 * Make sure that the alignment isn't lower than that of
2831 * unsigned long long.
2833 const size_t size = sizeof(struct cpu_workqueue_struct);
2834 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
2835 __alignof__(unsigned long long));
2836 #ifdef CONFIG_SMP
2837 bool percpu = !(wq->flags & WQ_UNBOUND);
2838 #else
2839 bool percpu = false;
2840 #endif
2842 if (percpu)
2843 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2844 else {
2845 void *ptr;
2848 * Allocate enough room to align cwq and put an extra
2849 * pointer at the end pointing back to the originally
2850 * allocated pointer which will be used for free.
2852 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2853 if (ptr) {
2854 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2855 *(void **)(wq->cpu_wq.single + 1) = ptr;
2859 /* just in case, make sure it's actually aligned
2860 * - this is affected by PERCPU() alignment in vmlinux.lds.S
2862 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2863 return wq->cpu_wq.v ? 0 : -ENOMEM;
2866 static void free_cwqs(struct workqueue_struct *wq)
2868 #ifdef CONFIG_SMP
2869 bool percpu = !(wq->flags & WQ_UNBOUND);
2870 #else
2871 bool percpu = false;
2872 #endif
2874 if (percpu)
2875 free_percpu(wq->cpu_wq.pcpu);
2876 else if (wq->cpu_wq.single) {
2877 /* the pointer to free is stored right after the cwq */
2878 kfree(*(void **)(wq->cpu_wq.single + 1));
2882 static int wq_clamp_max_active(int max_active, unsigned int flags,
2883 const char *name)
2885 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2887 if (max_active < 1 || max_active > lim)
2888 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2889 "is out of range, clamping between %d and %d\n",
2890 max_active, name, 1, lim);
2892 return clamp_val(max_active, 1, lim);
2895 struct workqueue_struct *__alloc_workqueue_key(const char *name,
2896 unsigned int flags,
2897 int max_active,
2898 struct lock_class_key *key,
2899 const char *lock_name)
2901 struct workqueue_struct *wq;
2902 unsigned int cpu;
2905 * Workqueues which may be used during memory reclaim should
2906 * have a rescuer to guarantee forward progress.
2908 if (flags & WQ_MEM_RECLAIM)
2909 flags |= WQ_RESCUER;
2912 * Unbound workqueues aren't concurrency managed and should be
2913 * dispatched to workers immediately.
2915 if (flags & WQ_UNBOUND)
2916 flags |= WQ_HIGHPRI;
2918 max_active = max_active ?: WQ_DFL_ACTIVE;
2919 max_active = wq_clamp_max_active(max_active, flags, name);
2921 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
2922 if (!wq)
2923 goto err;
2925 wq->flags = flags;
2926 wq->saved_max_active = max_active;
2927 mutex_init(&wq->flush_mutex);
2928 atomic_set(&wq->nr_cwqs_to_flush, 0);
2929 INIT_LIST_HEAD(&wq->flusher_queue);
2930 INIT_LIST_HEAD(&wq->flusher_overflow);
2932 wq->name = name;
2933 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
2934 INIT_LIST_HEAD(&wq->list);
2936 if (alloc_cwqs(wq) < 0)
2937 goto err;
2939 for_each_cwq_cpu(cpu, wq) {
2940 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2941 struct global_cwq *gcwq = get_gcwq(cpu);
2943 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
2944 cwq->gcwq = gcwq;
2945 cwq->wq = wq;
2946 cwq->flush_color = -1;
2947 cwq->max_active = max_active;
2948 INIT_LIST_HEAD(&cwq->delayed_works);
2951 if (flags & WQ_RESCUER) {
2952 struct worker *rescuer;
2954 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
2955 goto err;
2957 wq->rescuer = rescuer = alloc_worker();
2958 if (!rescuer)
2959 goto err;
2961 rescuer->task = kthread_create(rescuer_thread, wq, "%s", name);
2962 if (IS_ERR(rescuer->task))
2963 goto err;
2965 rescuer->task->flags |= PF_THREAD_BOUND;
2966 wake_up_process(rescuer->task);
2970 * workqueue_lock protects global freeze state and workqueues
2971 * list. Grab it, set max_active accordingly and add the new
2972 * workqueue to workqueues list.
2974 spin_lock(&workqueue_lock);
2976 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
2977 for_each_cwq_cpu(cpu, wq)
2978 get_cwq(cpu, wq)->max_active = 0;
2980 list_add(&wq->list, &workqueues);
2982 spin_unlock(&workqueue_lock);
2984 return wq;
2985 err:
2986 if (wq) {
2987 free_cwqs(wq);
2988 free_mayday_mask(wq->mayday_mask);
2989 kfree(wq->rescuer);
2990 kfree(wq);
2992 return NULL;
2994 EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
2997 * destroy_workqueue - safely terminate a workqueue
2998 * @wq: target workqueue
3000 * Safely destroy a workqueue. All work currently pending will be done first.
3002 void destroy_workqueue(struct workqueue_struct *wq)
3004 unsigned int flush_cnt = 0;
3005 unsigned int cpu;
3008 * Mark @wq dying and drain all pending works. Once WQ_DYING is
3009 * set, only chain queueing is allowed. IOW, only currently
3010 * pending or running work items on @wq can queue further work
3011 * items on it. @wq is flushed repeatedly until it becomes empty.
3012 * The number of flushing is detemined by the depth of chaining and
3013 * should be relatively short. Whine if it takes too long.
3015 wq->flags |= WQ_DYING;
3016 reflush:
3017 flush_workqueue(wq);
3019 for_each_cwq_cpu(cpu, wq) {
3020 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3022 if (!cwq->nr_active && list_empty(&cwq->delayed_works))
3023 continue;
3025 if (++flush_cnt == 10 ||
3026 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
3027 printk(KERN_WARNING "workqueue %s: flush on "
3028 "destruction isn't complete after %u tries\n",
3029 wq->name, flush_cnt);
3030 goto reflush;
3034 * wq list is used to freeze wq, remove from list after
3035 * flushing is complete in case freeze races us.
3037 spin_lock(&workqueue_lock);
3038 list_del(&wq->list);
3039 spin_unlock(&workqueue_lock);
3041 /* sanity check */
3042 for_each_cwq_cpu(cpu, wq) {
3043 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3044 int i;
3046 for (i = 0; i < WORK_NR_COLORS; i++)
3047 BUG_ON(cwq->nr_in_flight[i]);
3048 BUG_ON(cwq->nr_active);
3049 BUG_ON(!list_empty(&cwq->delayed_works));
3052 if (wq->flags & WQ_RESCUER) {
3053 kthread_stop(wq->rescuer->task);
3054 free_mayday_mask(wq->mayday_mask);
3055 kfree(wq->rescuer);
3058 free_cwqs(wq);
3059 kfree(wq);
3061 EXPORT_SYMBOL_GPL(destroy_workqueue);
3064 * workqueue_set_max_active - adjust max_active of a workqueue
3065 * @wq: target workqueue
3066 * @max_active: new max_active value.
3068 * Set max_active of @wq to @max_active.
3070 * CONTEXT:
3071 * Don't call from IRQ context.
3073 void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3075 unsigned int cpu;
3077 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3079 spin_lock(&workqueue_lock);
3081 wq->saved_max_active = max_active;
3083 for_each_cwq_cpu(cpu, wq) {
3084 struct global_cwq *gcwq = get_gcwq(cpu);
3086 spin_lock_irq(&gcwq->lock);
3088 if (!(wq->flags & WQ_FREEZABLE) ||
3089 !(gcwq->flags & GCWQ_FREEZING))
3090 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3092 spin_unlock_irq(&gcwq->lock);
3095 spin_unlock(&workqueue_lock);
3097 EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3100 * workqueue_congested - test whether a workqueue is congested
3101 * @cpu: CPU in question
3102 * @wq: target workqueue
3104 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3105 * no synchronization around this function and the test result is
3106 * unreliable and only useful as advisory hints or for debugging.
3108 * RETURNS:
3109 * %true if congested, %false otherwise.
3111 bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3113 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3115 return !list_empty(&cwq->delayed_works);
3117 EXPORT_SYMBOL_GPL(workqueue_congested);
3120 * work_cpu - return the last known associated cpu for @work
3121 * @work: the work of interest
3123 * RETURNS:
3124 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
3126 unsigned int work_cpu(struct work_struct *work)
3128 struct global_cwq *gcwq = get_work_gcwq(work);
3130 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3132 EXPORT_SYMBOL_GPL(work_cpu);
3135 * work_busy - test whether a work is currently pending or running
3136 * @work: the work to be tested
3138 * Test whether @work is currently pending or running. There is no
3139 * synchronization around this function and the test result is
3140 * unreliable and only useful as advisory hints or for debugging.
3141 * Especially for reentrant wqs, the pending state might hide the
3142 * running state.
3144 * RETURNS:
3145 * OR'd bitmask of WORK_BUSY_* bits.
3147 unsigned int work_busy(struct work_struct *work)
3149 struct global_cwq *gcwq = get_work_gcwq(work);
3150 unsigned long flags;
3151 unsigned int ret = 0;
3153 if (!gcwq)
3154 return false;
3156 spin_lock_irqsave(&gcwq->lock, flags);
3158 if (work_pending(work))
3159 ret |= WORK_BUSY_PENDING;
3160 if (find_worker_executing_work(gcwq, work))
3161 ret |= WORK_BUSY_RUNNING;
3163 spin_unlock_irqrestore(&gcwq->lock, flags);
3165 return ret;
3167 EXPORT_SYMBOL_GPL(work_busy);
3170 * CPU hotplug.
3172 * There are two challenges in supporting CPU hotplug. Firstly, there
3173 * are a lot of assumptions on strong associations among work, cwq and
3174 * gcwq which make migrating pending and scheduled works very
3175 * difficult to implement without impacting hot paths. Secondly,
3176 * gcwqs serve mix of short, long and very long running works making
3177 * blocked draining impractical.
3179 * This is solved by allowing a gcwq to be detached from CPU, running
3180 * it with unbound (rogue) workers and allowing it to be reattached
3181 * later if the cpu comes back online. A separate thread is created
3182 * to govern a gcwq in such state and is called the trustee of the
3183 * gcwq.
3185 * Trustee states and their descriptions.
3187 * START Command state used on startup. On CPU_DOWN_PREPARE, a
3188 * new trustee is started with this state.
3190 * IN_CHARGE Once started, trustee will enter this state after
3191 * assuming the manager role and making all existing
3192 * workers rogue. DOWN_PREPARE waits for trustee to
3193 * enter this state. After reaching IN_CHARGE, trustee
3194 * tries to execute the pending worklist until it's empty
3195 * and the state is set to BUTCHER, or the state is set
3196 * to RELEASE.
3198 * BUTCHER Command state which is set by the cpu callback after
3199 * the cpu has went down. Once this state is set trustee
3200 * knows that there will be no new works on the worklist
3201 * and once the worklist is empty it can proceed to
3202 * killing idle workers.
3204 * RELEASE Command state which is set by the cpu callback if the
3205 * cpu down has been canceled or it has come online
3206 * again. After recognizing this state, trustee stops
3207 * trying to drain or butcher and clears ROGUE, rebinds
3208 * all remaining workers back to the cpu and releases
3209 * manager role.
3211 * DONE Trustee will enter this state after BUTCHER or RELEASE
3212 * is complete.
3214 * trustee CPU draining
3215 * took over down complete
3216 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3217 * | | ^
3218 * | CPU is back online v return workers |
3219 * ----------------> RELEASE --------------
3223 * trustee_wait_event_timeout - timed event wait for trustee
3224 * @cond: condition to wait for
3225 * @timeout: timeout in jiffies
3227 * wait_event_timeout() for trustee to use. Handles locking and
3228 * checks for RELEASE request.
3230 * CONTEXT:
3231 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3232 * multiple times. To be used by trustee.
3234 * RETURNS:
3235 * Positive indicating left time if @cond is satisfied, 0 if timed
3236 * out, -1 if canceled.
3238 #define trustee_wait_event_timeout(cond, timeout) ({ \
3239 long __ret = (timeout); \
3240 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
3241 __ret) { \
3242 spin_unlock_irq(&gcwq->lock); \
3243 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
3244 (gcwq->trustee_state == TRUSTEE_RELEASE), \
3245 __ret); \
3246 spin_lock_irq(&gcwq->lock); \
3248 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
3252 * trustee_wait_event - event wait for trustee
3253 * @cond: condition to wait for
3255 * wait_event() for trustee to use. Automatically handles locking and
3256 * checks for CANCEL request.
3258 * CONTEXT:
3259 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3260 * multiple times. To be used by trustee.
3262 * RETURNS:
3263 * 0 if @cond is satisfied, -1 if canceled.
3265 #define trustee_wait_event(cond) ({ \
3266 long __ret1; \
3267 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3268 __ret1 < 0 ? -1 : 0; \
3271 static int __cpuinit trustee_thread(void *__gcwq)
3273 struct global_cwq *gcwq = __gcwq;
3274 struct worker *worker;
3275 struct work_struct *work;
3276 struct hlist_node *pos;
3277 long rc;
3278 int i;
3280 BUG_ON(gcwq->cpu != smp_processor_id());
3282 spin_lock_irq(&gcwq->lock);
3284 * Claim the manager position and make all workers rogue.
3285 * Trustee must be bound to the target cpu and can't be
3286 * cancelled.
3288 BUG_ON(gcwq->cpu != smp_processor_id());
3289 rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3290 BUG_ON(rc < 0);
3292 gcwq->flags |= GCWQ_MANAGING_WORKERS;
3294 list_for_each_entry(worker, &gcwq->idle_list, entry)
3295 worker->flags |= WORKER_ROGUE;
3297 for_each_busy_worker(worker, i, pos, gcwq)
3298 worker->flags |= WORKER_ROGUE;
3301 * Call schedule() so that we cross rq->lock and thus can
3302 * guarantee sched callbacks see the rogue flag. This is
3303 * necessary as scheduler callbacks may be invoked from other
3304 * cpus.
3306 spin_unlock_irq(&gcwq->lock);
3307 schedule();
3308 spin_lock_irq(&gcwq->lock);
3311 * Sched callbacks are disabled now. Zap nr_running. After
3312 * this, nr_running stays zero and need_more_worker() and
3313 * keep_working() are always true as long as the worklist is
3314 * not empty.
3316 atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
3318 spin_unlock_irq(&gcwq->lock);
3319 del_timer_sync(&gcwq->idle_timer);
3320 spin_lock_irq(&gcwq->lock);
3323 * We're now in charge. Notify and proceed to drain. We need
3324 * to keep the gcwq running during the whole CPU down
3325 * procedure as other cpu hotunplug callbacks may need to
3326 * flush currently running tasks.
3328 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3329 wake_up_all(&gcwq->trustee_wait);
3332 * The original cpu is in the process of dying and may go away
3333 * anytime now. When that happens, we and all workers would
3334 * be migrated to other cpus. Try draining any left work. We
3335 * want to get it over with ASAP - spam rescuers, wake up as
3336 * many idlers as necessary and create new ones till the
3337 * worklist is empty. Note that if the gcwq is frozen, there
3338 * may be frozen works in freezable cwqs. Don't declare
3339 * completion while frozen.
3341 while (gcwq->nr_workers != gcwq->nr_idle ||
3342 gcwq->flags & GCWQ_FREEZING ||
3343 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
3344 int nr_works = 0;
3346 list_for_each_entry(work, &gcwq->worklist, entry) {
3347 send_mayday(work);
3348 nr_works++;
3351 list_for_each_entry(worker, &gcwq->idle_list, entry) {
3352 if (!nr_works--)
3353 break;
3354 wake_up_process(worker->task);
3357 if (need_to_create_worker(gcwq)) {
3358 spin_unlock_irq(&gcwq->lock);
3359 worker = create_worker(gcwq, false);
3360 spin_lock_irq(&gcwq->lock);
3361 if (worker) {
3362 worker->flags |= WORKER_ROGUE;
3363 start_worker(worker);
3367 /* give a breather */
3368 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3369 break;
3373 * Either all works have been scheduled and cpu is down, or
3374 * cpu down has already been canceled. Wait for and butcher
3375 * all workers till we're canceled.
3377 do {
3378 rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3379 while (!list_empty(&gcwq->idle_list))
3380 destroy_worker(list_first_entry(&gcwq->idle_list,
3381 struct worker, entry));
3382 } while (gcwq->nr_workers && rc >= 0);
3385 * At this point, either draining has completed and no worker
3386 * is left, or cpu down has been canceled or the cpu is being
3387 * brought back up. There shouldn't be any idle one left.
3388 * Tell the remaining busy ones to rebind once it finishes the
3389 * currently scheduled works by scheduling the rebind_work.
3391 WARN_ON(!list_empty(&gcwq->idle_list));
3393 for_each_busy_worker(worker, i, pos, gcwq) {
3394 struct work_struct *rebind_work = &worker->rebind_work;
3397 * Rebind_work may race with future cpu hotplug
3398 * operations. Use a separate flag to mark that
3399 * rebinding is scheduled.
3401 worker->flags |= WORKER_REBIND;
3402 worker->flags &= ~WORKER_ROGUE;
3404 /* queue rebind_work, wq doesn't matter, use the default one */
3405 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3406 work_data_bits(rebind_work)))
3407 continue;
3409 debug_work_activate(rebind_work);
3410 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3411 worker->scheduled.next,
3412 work_color_to_flags(WORK_NO_COLOR));
3415 /* relinquish manager role */
3416 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3418 /* notify completion */
3419 gcwq->trustee = NULL;
3420 gcwq->trustee_state = TRUSTEE_DONE;
3421 wake_up_all(&gcwq->trustee_wait);
3422 spin_unlock_irq(&gcwq->lock);
3423 return 0;
3427 * wait_trustee_state - wait for trustee to enter the specified state
3428 * @gcwq: gcwq the trustee of interest belongs to
3429 * @state: target state to wait for
3431 * Wait for the trustee to reach @state. DONE is already matched.
3433 * CONTEXT:
3434 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3435 * multiple times. To be used by cpu_callback.
3437 static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
3438 __releases(&gcwq->lock)
3439 __acquires(&gcwq->lock)
3441 if (!(gcwq->trustee_state == state ||
3442 gcwq->trustee_state == TRUSTEE_DONE)) {
3443 spin_unlock_irq(&gcwq->lock);
3444 __wait_event(gcwq->trustee_wait,
3445 gcwq->trustee_state == state ||
3446 gcwq->trustee_state == TRUSTEE_DONE);
3447 spin_lock_irq(&gcwq->lock);
3451 static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
3452 unsigned long action,
3453 void *hcpu)
3455 unsigned int cpu = (unsigned long)hcpu;
3456 struct global_cwq *gcwq = get_gcwq(cpu);
3457 struct task_struct *new_trustee = NULL;
3458 struct worker *uninitialized_var(new_worker);
3459 unsigned long flags;
3461 action &= ~CPU_TASKS_FROZEN;
3463 switch (action) {
3464 case CPU_DOWN_PREPARE:
3465 new_trustee = kthread_create(trustee_thread, gcwq,
3466 "workqueue_trustee/%d\n", cpu);
3467 if (IS_ERR(new_trustee))
3468 return notifier_from_errno(PTR_ERR(new_trustee));
3469 kthread_bind(new_trustee, cpu);
3470 /* fall through */
3471 case CPU_UP_PREPARE:
3472 BUG_ON(gcwq->first_idle);
3473 new_worker = create_worker(gcwq, false);
3474 if (!new_worker) {
3475 if (new_trustee)
3476 kthread_stop(new_trustee);
3477 return NOTIFY_BAD;
3481 /* some are called w/ irq disabled, don't disturb irq status */
3482 spin_lock_irqsave(&gcwq->lock, flags);
3484 switch (action) {
3485 case CPU_DOWN_PREPARE:
3486 /* initialize trustee and tell it to acquire the gcwq */
3487 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3488 gcwq->trustee = new_trustee;
3489 gcwq->trustee_state = TRUSTEE_START;
3490 wake_up_process(gcwq->trustee);
3491 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3492 /* fall through */
3493 case CPU_UP_PREPARE:
3494 BUG_ON(gcwq->first_idle);
3495 gcwq->first_idle = new_worker;
3496 break;
3498 case CPU_DYING:
3500 * Before this, the trustee and all workers except for
3501 * the ones which are still executing works from
3502 * before the last CPU down must be on the cpu. After
3503 * this, they'll all be diasporas.
3505 gcwq->flags |= GCWQ_DISASSOCIATED;
3506 break;
3508 case CPU_POST_DEAD:
3509 gcwq->trustee_state = TRUSTEE_BUTCHER;
3510 /* fall through */
3511 case CPU_UP_CANCELED:
3512 destroy_worker(gcwq->first_idle);
3513 gcwq->first_idle = NULL;
3514 break;
3516 case CPU_DOWN_FAILED:
3517 case CPU_ONLINE:
3518 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3519 if (gcwq->trustee_state != TRUSTEE_DONE) {
3520 gcwq->trustee_state = TRUSTEE_RELEASE;
3521 wake_up_process(gcwq->trustee);
3522 wait_trustee_state(gcwq, TRUSTEE_DONE);
3526 * Trustee is done and there might be no worker left.
3527 * Put the first_idle in and request a real manager to
3528 * take a look.
3530 spin_unlock_irq(&gcwq->lock);
3531 kthread_bind(gcwq->first_idle->task, cpu);
3532 spin_lock_irq(&gcwq->lock);
3533 gcwq->flags |= GCWQ_MANAGE_WORKERS;
3534 start_worker(gcwq->first_idle);
3535 gcwq->first_idle = NULL;
3536 break;
3539 spin_unlock_irqrestore(&gcwq->lock, flags);
3541 return notifier_from_errno(0);
3544 #ifdef CONFIG_SMP
3546 struct work_for_cpu {
3547 struct completion completion;
3548 long (*fn)(void *);
3549 void *arg;
3550 long ret;
3553 static int do_work_for_cpu(void *_wfc)
3555 struct work_for_cpu *wfc = _wfc;
3556 wfc->ret = wfc->fn(wfc->arg);
3557 complete(&wfc->completion);
3558 return 0;
3562 * work_on_cpu - run a function in user context on a particular cpu
3563 * @cpu: the cpu to run on
3564 * @fn: the function to run
3565 * @arg: the function arg
3567 * This will return the value @fn returns.
3568 * It is up to the caller to ensure that the cpu doesn't go offline.
3569 * The caller must not hold any locks which would prevent @fn from completing.
3571 long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3573 struct task_struct *sub_thread;
3574 struct work_for_cpu wfc = {
3575 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3576 .fn = fn,
3577 .arg = arg,
3580 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3581 if (IS_ERR(sub_thread))
3582 return PTR_ERR(sub_thread);
3583 kthread_bind(sub_thread, cpu);
3584 wake_up_process(sub_thread);
3585 wait_for_completion(&wfc.completion);
3586 return wfc.ret;
3588 EXPORT_SYMBOL_GPL(work_on_cpu);
3589 #endif /* CONFIG_SMP */
3591 #ifdef CONFIG_FREEZER
3594 * freeze_workqueues_begin - begin freezing workqueues
3596 * Start freezing workqueues. After this function returns, all freezable
3597 * workqueues will queue new works to their frozen_works list instead of
3598 * gcwq->worklist.
3600 * CONTEXT:
3601 * Grabs and releases workqueue_lock and gcwq->lock's.
3603 void freeze_workqueues_begin(void)
3605 unsigned int cpu;
3607 spin_lock(&workqueue_lock);
3609 BUG_ON(workqueue_freezing);
3610 workqueue_freezing = true;
3612 for_each_gcwq_cpu(cpu) {
3613 struct global_cwq *gcwq = get_gcwq(cpu);
3614 struct workqueue_struct *wq;
3616 spin_lock_irq(&gcwq->lock);
3618 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3619 gcwq->flags |= GCWQ_FREEZING;
3621 list_for_each_entry(wq, &workqueues, list) {
3622 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3624 if (cwq && wq->flags & WQ_FREEZABLE)
3625 cwq->max_active = 0;
3628 spin_unlock_irq(&gcwq->lock);
3631 spin_unlock(&workqueue_lock);
3635 * freeze_workqueues_busy - are freezable workqueues still busy?
3637 * Check whether freezing is complete. This function must be called
3638 * between freeze_workqueues_begin() and thaw_workqueues().
3640 * CONTEXT:
3641 * Grabs and releases workqueue_lock.
3643 * RETURNS:
3644 * %true if some freezable workqueues are still busy. %false if freezing
3645 * is complete.
3647 bool freeze_workqueues_busy(void)
3649 unsigned int cpu;
3650 bool busy = false;
3652 spin_lock(&workqueue_lock);
3654 BUG_ON(!workqueue_freezing);
3656 for_each_gcwq_cpu(cpu) {
3657 struct workqueue_struct *wq;
3659 * nr_active is monotonically decreasing. It's safe
3660 * to peek without lock.
3662 list_for_each_entry(wq, &workqueues, list) {
3663 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3665 if (!cwq || !(wq->flags & WQ_FREEZABLE))
3666 continue;
3668 BUG_ON(cwq->nr_active < 0);
3669 if (cwq->nr_active) {
3670 busy = true;
3671 goto out_unlock;
3675 out_unlock:
3676 spin_unlock(&workqueue_lock);
3677 return busy;
3681 * thaw_workqueues - thaw workqueues
3683 * Thaw workqueues. Normal queueing is restored and all collected
3684 * frozen works are transferred to their respective gcwq worklists.
3686 * CONTEXT:
3687 * Grabs and releases workqueue_lock and gcwq->lock's.
3689 void thaw_workqueues(void)
3691 unsigned int cpu;
3693 spin_lock(&workqueue_lock);
3695 if (!workqueue_freezing)
3696 goto out_unlock;
3698 for_each_gcwq_cpu(cpu) {
3699 struct global_cwq *gcwq = get_gcwq(cpu);
3700 struct workqueue_struct *wq;
3702 spin_lock_irq(&gcwq->lock);
3704 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3705 gcwq->flags &= ~GCWQ_FREEZING;
3707 list_for_each_entry(wq, &workqueues, list) {
3708 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3710 if (!cwq || !(wq->flags & WQ_FREEZABLE))
3711 continue;
3713 /* restore max_active and repopulate worklist */
3714 cwq->max_active = wq->saved_max_active;
3716 while (!list_empty(&cwq->delayed_works) &&
3717 cwq->nr_active < cwq->max_active)
3718 cwq_activate_first_delayed(cwq);
3721 wake_up_worker(gcwq);
3723 spin_unlock_irq(&gcwq->lock);
3726 workqueue_freezing = false;
3727 out_unlock:
3728 spin_unlock(&workqueue_lock);
3730 #endif /* CONFIG_FREEZER */
3732 static int __init init_workqueues(void)
3734 unsigned int cpu;
3735 int i;
3737 cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
3739 /* initialize gcwqs */
3740 for_each_gcwq_cpu(cpu) {
3741 struct global_cwq *gcwq = get_gcwq(cpu);
3743 spin_lock_init(&gcwq->lock);
3744 INIT_LIST_HEAD(&gcwq->worklist);
3745 gcwq->cpu = cpu;
3746 gcwq->flags |= GCWQ_DISASSOCIATED;
3748 INIT_LIST_HEAD(&gcwq->idle_list);
3749 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3750 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3752 init_timer_deferrable(&gcwq->idle_timer);
3753 gcwq->idle_timer.function = idle_worker_timeout;
3754 gcwq->idle_timer.data = (unsigned long)gcwq;
3756 setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3757 (unsigned long)gcwq);
3759 ida_init(&gcwq->worker_ida);
3761 gcwq->trustee_state = TRUSTEE_DONE;
3762 init_waitqueue_head(&gcwq->trustee_wait);
3765 /* create the initial worker */
3766 for_each_online_gcwq_cpu(cpu) {
3767 struct global_cwq *gcwq = get_gcwq(cpu);
3768 struct worker *worker;
3770 if (cpu != WORK_CPU_UNBOUND)
3771 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3772 worker = create_worker(gcwq, true);
3773 BUG_ON(!worker);
3774 spin_lock_irq(&gcwq->lock);
3775 start_worker(worker);
3776 spin_unlock_irq(&gcwq->lock);
3779 system_wq = alloc_workqueue("events", 0, 0);
3780 system_long_wq = alloc_workqueue("events_long", 0, 0);
3781 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3782 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3783 WQ_UNBOUND_MAX_ACTIVE);
3784 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
3785 !system_unbound_wq);
3786 return 0;
3788 early_initcall(init_workqueues);