usb: Prevent dead ports when xhci is not enabled
[linux/fpc-iii.git] / kernel / workqueue.c
blob7bf068a76357608322b78c789f7be25784d9912a
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/export.h>
27 #include <linux/kernel.h>
28 #include <linux/sched.h>
29 #include <linux/init.h>
30 #include <linux/signal.h>
31 #include <linux/completion.h>
32 #include <linux/workqueue.h>
33 #include <linux/slab.h>
34 #include <linux/cpu.h>
35 #include <linux/notifier.h>
36 #include <linux/kthread.h>
37 #include <linux/hardirq.h>
38 #include <linux/mempolicy.h>
39 #include <linux/freezer.h>
40 #include <linux/kallsyms.h>
41 #include <linux/debug_locks.h>
42 #include <linux/lockdep.h>
43 #include <linux/idr.h>
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; /* W: WQ_* flags */
225 union {
226 struct cpu_workqueue_struct __percpu *pcpu;
227 struct cpu_workqueue_struct *single;
228 unsigned long v;
229 } cpu_wq; /* I: cwq's */
230 struct list_head list; /* W: list of all workqueues */
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 nr_drainers; /* W: drain in progress */
244 int saved_max_active; /* W: saved cwq max_active */
245 const char *name; /* I: workqueue name */
246 #ifdef CONFIG_LOCKDEP
247 struct lockdep_map lockdep_map;
248 #endif
251 struct workqueue_struct *system_wq __read_mostly;
252 struct workqueue_struct *system_long_wq __read_mostly;
253 struct workqueue_struct *system_nrt_wq __read_mostly;
254 struct workqueue_struct *system_unbound_wq __read_mostly;
255 struct workqueue_struct *system_freezable_wq __read_mostly;
256 struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
257 EXPORT_SYMBOL_GPL(system_wq);
258 EXPORT_SYMBOL_GPL(system_long_wq);
259 EXPORT_SYMBOL_GPL(system_nrt_wq);
260 EXPORT_SYMBOL_GPL(system_unbound_wq);
261 EXPORT_SYMBOL_GPL(system_freezable_wq);
262 EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
264 #define CREATE_TRACE_POINTS
265 #include <trace/events/workqueue.h>
267 #define for_each_busy_worker(worker, i, pos, gcwq) \
268 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
269 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
271 static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
272 unsigned int sw)
274 if (cpu < nr_cpu_ids) {
275 if (sw & 1) {
276 cpu = cpumask_next(cpu, mask);
277 if (cpu < nr_cpu_ids)
278 return cpu;
280 if (sw & 2)
281 return WORK_CPU_UNBOUND;
283 return WORK_CPU_NONE;
286 static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
287 struct workqueue_struct *wq)
289 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
293 * CPU iterators
295 * An extra gcwq is defined for an invalid cpu number
296 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
297 * specific CPU. The following iterators are similar to
298 * for_each_*_cpu() iterators but also considers the unbound gcwq.
300 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
301 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
302 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
303 * WORK_CPU_UNBOUND for unbound workqueues
305 #define for_each_gcwq_cpu(cpu) \
306 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
307 (cpu) < WORK_CPU_NONE; \
308 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
310 #define for_each_online_gcwq_cpu(cpu) \
311 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
312 (cpu) < WORK_CPU_NONE; \
313 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
315 #define for_each_cwq_cpu(cpu, wq) \
316 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
317 (cpu) < WORK_CPU_NONE; \
318 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
320 #ifdef CONFIG_DEBUG_OBJECTS_WORK
322 static struct debug_obj_descr work_debug_descr;
324 static void *work_debug_hint(void *addr)
326 return ((struct work_struct *) addr)->func;
330 * fixup_init is called when:
331 * - an active object is initialized
333 static int work_fixup_init(void *addr, enum debug_obj_state state)
335 struct work_struct *work = addr;
337 switch (state) {
338 case ODEBUG_STATE_ACTIVE:
339 cancel_work_sync(work);
340 debug_object_init(work, &work_debug_descr);
341 return 1;
342 default:
343 return 0;
348 * fixup_activate is called when:
349 * - an active object is activated
350 * - an unknown object is activated (might be a statically initialized object)
352 static int work_fixup_activate(void *addr, enum debug_obj_state state)
354 struct work_struct *work = addr;
356 switch (state) {
358 case ODEBUG_STATE_NOTAVAILABLE:
360 * This is not really a fixup. The work struct was
361 * statically initialized. We just make sure that it
362 * is tracked in the object tracker.
364 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
365 debug_object_init(work, &work_debug_descr);
366 debug_object_activate(work, &work_debug_descr);
367 return 0;
369 WARN_ON_ONCE(1);
370 return 0;
372 case ODEBUG_STATE_ACTIVE:
373 WARN_ON(1);
375 default:
376 return 0;
381 * fixup_free is called when:
382 * - an active object is freed
384 static int work_fixup_free(void *addr, enum debug_obj_state state)
386 struct work_struct *work = addr;
388 switch (state) {
389 case ODEBUG_STATE_ACTIVE:
390 cancel_work_sync(work);
391 debug_object_free(work, &work_debug_descr);
392 return 1;
393 default:
394 return 0;
398 static struct debug_obj_descr work_debug_descr = {
399 .name = "work_struct",
400 .debug_hint = work_debug_hint,
401 .fixup_init = work_fixup_init,
402 .fixup_activate = work_fixup_activate,
403 .fixup_free = work_fixup_free,
406 static inline void debug_work_activate(struct work_struct *work)
408 debug_object_activate(work, &work_debug_descr);
411 static inline void debug_work_deactivate(struct work_struct *work)
413 debug_object_deactivate(work, &work_debug_descr);
416 void __init_work(struct work_struct *work, int onstack)
418 if (onstack)
419 debug_object_init_on_stack(work, &work_debug_descr);
420 else
421 debug_object_init(work, &work_debug_descr);
423 EXPORT_SYMBOL_GPL(__init_work);
425 void destroy_work_on_stack(struct work_struct *work)
427 debug_object_free(work, &work_debug_descr);
429 EXPORT_SYMBOL_GPL(destroy_work_on_stack);
431 #else
432 static inline void debug_work_activate(struct work_struct *work) { }
433 static inline void debug_work_deactivate(struct work_struct *work) { }
434 #endif
436 /* Serializes the accesses to the list of workqueues. */
437 static DEFINE_SPINLOCK(workqueue_lock);
438 static LIST_HEAD(workqueues);
439 static bool workqueue_freezing; /* W: have wqs started freezing? */
442 * The almighty global cpu workqueues. nr_running is the only field
443 * which is expected to be used frequently by other cpus via
444 * try_to_wake_up(). Put it in a separate cacheline.
446 static DEFINE_PER_CPU(struct global_cwq, global_cwq);
447 static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
450 * Global cpu workqueue and nr_running counter for unbound gcwq. The
451 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
452 * workers have WORKER_UNBOUND set.
454 static struct global_cwq unbound_global_cwq;
455 static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0); /* always 0 */
457 static int worker_thread(void *__worker);
459 static struct global_cwq *get_gcwq(unsigned int cpu)
461 if (cpu != WORK_CPU_UNBOUND)
462 return &per_cpu(global_cwq, cpu);
463 else
464 return &unbound_global_cwq;
467 static atomic_t *get_gcwq_nr_running(unsigned int cpu)
469 if (cpu != WORK_CPU_UNBOUND)
470 return &per_cpu(gcwq_nr_running, cpu);
471 else
472 return &unbound_gcwq_nr_running;
475 static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
476 struct workqueue_struct *wq)
478 if (!(wq->flags & WQ_UNBOUND)) {
479 if (likely(cpu < nr_cpu_ids)) {
480 #ifdef CONFIG_SMP
481 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
482 #else
483 return wq->cpu_wq.single;
484 #endif
486 } else if (likely(cpu == WORK_CPU_UNBOUND))
487 return wq->cpu_wq.single;
488 return NULL;
491 static unsigned int work_color_to_flags(int color)
493 return color << WORK_STRUCT_COLOR_SHIFT;
496 static int get_work_color(struct work_struct *work)
498 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
499 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
502 static int work_next_color(int color)
504 return (color + 1) % WORK_NR_COLORS;
508 * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
509 * work is on queue. Once execution starts, WORK_STRUCT_CWQ is
510 * cleared and the work data contains the cpu number it was last on.
512 * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
513 * cwq, cpu or clear work->data. These functions should only be
514 * called while the work is owned - ie. while the PENDING bit is set.
516 * get_work_[g]cwq() can be used to obtain the gcwq or cwq
517 * corresponding to a work. gcwq is available once the work has been
518 * queued anywhere after initialization. cwq is available only from
519 * queueing until execution starts.
521 static inline void set_work_data(struct work_struct *work, unsigned long data,
522 unsigned long flags)
524 BUG_ON(!work_pending(work));
525 atomic_long_set(&work->data, data | flags | work_static(work));
528 static void set_work_cwq(struct work_struct *work,
529 struct cpu_workqueue_struct *cwq,
530 unsigned long extra_flags)
532 set_work_data(work, (unsigned long)cwq,
533 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
536 static void set_work_cpu(struct work_struct *work, unsigned int cpu)
538 set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
541 static void clear_work_data(struct work_struct *work)
543 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
546 static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
548 unsigned long data = atomic_long_read(&work->data);
550 if (data & WORK_STRUCT_CWQ)
551 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
552 else
553 return NULL;
556 static struct global_cwq *get_work_gcwq(struct work_struct *work)
558 unsigned long data = atomic_long_read(&work->data);
559 unsigned int cpu;
561 if (data & WORK_STRUCT_CWQ)
562 return ((struct cpu_workqueue_struct *)
563 (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
565 cpu = data >> WORK_STRUCT_FLAG_BITS;
566 if (cpu == WORK_CPU_NONE)
567 return NULL;
569 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
570 return get_gcwq(cpu);
574 * Policy functions. These define the policies on how the global
575 * worker pool is managed. Unless noted otherwise, these functions
576 * assume that they're being called with gcwq->lock held.
579 static bool __need_more_worker(struct global_cwq *gcwq)
581 return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
582 gcwq->flags & GCWQ_HIGHPRI_PENDING;
586 * Need to wake up a worker? Called from anything but currently
587 * running workers.
589 static bool need_more_worker(struct global_cwq *gcwq)
591 return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
594 /* Can I start working? Called from busy but !running workers. */
595 static bool may_start_working(struct global_cwq *gcwq)
597 return gcwq->nr_idle;
600 /* Do I need to keep working? Called from currently running workers. */
601 static bool keep_working(struct global_cwq *gcwq)
603 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
605 return !list_empty(&gcwq->worklist) &&
606 (atomic_read(nr_running) <= 1 ||
607 gcwq->flags & GCWQ_HIGHPRI_PENDING);
610 /* Do we need a new worker? Called from manager. */
611 static bool need_to_create_worker(struct global_cwq *gcwq)
613 return need_more_worker(gcwq) && !may_start_working(gcwq);
616 /* Do I need to be the manager? */
617 static bool need_to_manage_workers(struct global_cwq *gcwq)
619 return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
622 /* Do we have too many workers and should some go away? */
623 static bool too_many_workers(struct global_cwq *gcwq)
625 bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
626 int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
627 int nr_busy = gcwq->nr_workers - nr_idle;
629 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
633 * Wake up functions.
636 /* Return the first worker. Safe with preemption disabled */
637 static struct worker *first_worker(struct global_cwq *gcwq)
639 if (unlikely(list_empty(&gcwq->idle_list)))
640 return NULL;
642 return list_first_entry(&gcwq->idle_list, struct worker, entry);
646 * wake_up_worker - wake up an idle worker
647 * @gcwq: gcwq to wake worker for
649 * Wake up the first idle worker of @gcwq.
651 * CONTEXT:
652 * spin_lock_irq(gcwq->lock).
654 static void wake_up_worker(struct global_cwq *gcwq)
656 struct worker *worker = first_worker(gcwq);
658 if (likely(worker))
659 wake_up_process(worker->task);
663 * wq_worker_waking_up - a worker is waking up
664 * @task: task waking up
665 * @cpu: CPU @task is waking up to
667 * This function is called during try_to_wake_up() when a worker is
668 * being awoken.
670 * CONTEXT:
671 * spin_lock_irq(rq->lock)
673 void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
675 struct worker *worker = kthread_data(task);
677 if (!(worker->flags & WORKER_NOT_RUNNING))
678 atomic_inc(get_gcwq_nr_running(cpu));
682 * wq_worker_sleeping - a worker is going to sleep
683 * @task: task going to sleep
684 * @cpu: CPU in question, must be the current CPU number
686 * This function is called during schedule() when a busy worker is
687 * going to sleep. Worker on the same cpu can be woken up by
688 * returning pointer to its task.
690 * CONTEXT:
691 * spin_lock_irq(rq->lock)
693 * RETURNS:
694 * Worker task on @cpu to wake up, %NULL if none.
696 struct task_struct *wq_worker_sleeping(struct task_struct *task,
697 unsigned int cpu)
699 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
700 struct global_cwq *gcwq = get_gcwq(cpu);
701 atomic_t *nr_running = get_gcwq_nr_running(cpu);
703 if (worker->flags & WORKER_NOT_RUNNING)
704 return NULL;
706 /* this can only happen on the local cpu */
707 BUG_ON(cpu != raw_smp_processor_id());
710 * The counterpart of the following dec_and_test, implied mb,
711 * worklist not empty test sequence is in insert_work().
712 * Please read comment there.
714 * NOT_RUNNING is clear. This means that trustee is not in
715 * charge and we're running on the local cpu w/ rq lock held
716 * and preemption disabled, which in turn means that none else
717 * could be manipulating idle_list, so dereferencing idle_list
718 * without gcwq lock is safe.
720 if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
721 to_wakeup = first_worker(gcwq);
722 return to_wakeup ? to_wakeup->task : NULL;
726 * worker_set_flags - set worker flags and adjust nr_running accordingly
727 * @worker: self
728 * @flags: flags to set
729 * @wakeup: wakeup an idle worker if necessary
731 * Set @flags in @worker->flags and adjust nr_running accordingly. If
732 * nr_running becomes zero and @wakeup is %true, an idle worker is
733 * woken up.
735 * CONTEXT:
736 * spin_lock_irq(gcwq->lock)
738 static inline void worker_set_flags(struct worker *worker, unsigned int flags,
739 bool wakeup)
741 struct global_cwq *gcwq = worker->gcwq;
743 WARN_ON_ONCE(worker->task != current);
746 * If transitioning into NOT_RUNNING, adjust nr_running and
747 * wake up an idle worker as necessary if requested by
748 * @wakeup.
750 if ((flags & WORKER_NOT_RUNNING) &&
751 !(worker->flags & WORKER_NOT_RUNNING)) {
752 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
754 if (wakeup) {
755 if (atomic_dec_and_test(nr_running) &&
756 !list_empty(&gcwq->worklist))
757 wake_up_worker(gcwq);
758 } else
759 atomic_dec(nr_running);
762 worker->flags |= flags;
766 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
767 * @worker: self
768 * @flags: flags to clear
770 * Clear @flags in @worker->flags and adjust nr_running accordingly.
772 * CONTEXT:
773 * spin_lock_irq(gcwq->lock)
775 static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
777 struct global_cwq *gcwq = worker->gcwq;
778 unsigned int oflags = worker->flags;
780 WARN_ON_ONCE(worker->task != current);
782 worker->flags &= ~flags;
785 * If transitioning out of NOT_RUNNING, increment nr_running. Note
786 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
787 * of multiple flags, not a single flag.
789 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
790 if (!(worker->flags & WORKER_NOT_RUNNING))
791 atomic_inc(get_gcwq_nr_running(gcwq->cpu));
795 * busy_worker_head - return the busy hash head for a work
796 * @gcwq: gcwq of interest
797 * @work: work to be hashed
799 * Return hash head of @gcwq for @work.
801 * CONTEXT:
802 * spin_lock_irq(gcwq->lock).
804 * RETURNS:
805 * Pointer to the hash head.
807 static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
808 struct work_struct *work)
810 const int base_shift = ilog2(sizeof(struct work_struct));
811 unsigned long v = (unsigned long)work;
813 /* simple shift and fold hash, do we need something better? */
814 v >>= base_shift;
815 v += v >> BUSY_WORKER_HASH_ORDER;
816 v &= BUSY_WORKER_HASH_MASK;
818 return &gcwq->busy_hash[v];
822 * __find_worker_executing_work - find worker which is executing a work
823 * @gcwq: gcwq of interest
824 * @bwh: hash head as returned by busy_worker_head()
825 * @work: work to find worker for
827 * Find a worker which is executing @work on @gcwq. @bwh should be
828 * the hash head obtained by calling busy_worker_head() with the same
829 * work.
831 * CONTEXT:
832 * spin_lock_irq(gcwq->lock).
834 * RETURNS:
835 * Pointer to worker which is executing @work if found, NULL
836 * otherwise.
838 static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
839 struct hlist_head *bwh,
840 struct work_struct *work)
842 struct worker *worker;
843 struct hlist_node *tmp;
845 hlist_for_each_entry(worker, tmp, bwh, hentry)
846 if (worker->current_work == work)
847 return worker;
848 return NULL;
852 * find_worker_executing_work - find worker which is executing a work
853 * @gcwq: gcwq of interest
854 * @work: work to find worker for
856 * Find a worker which is executing @work on @gcwq. This function is
857 * identical to __find_worker_executing_work() except that this
858 * function calculates @bwh itself.
860 * CONTEXT:
861 * spin_lock_irq(gcwq->lock).
863 * RETURNS:
864 * Pointer to worker which is executing @work if found, NULL
865 * otherwise.
867 static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
868 struct work_struct *work)
870 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
871 work);
875 * gcwq_determine_ins_pos - find insertion position
876 * @gcwq: gcwq of interest
877 * @cwq: cwq a work is being queued for
879 * A work for @cwq is about to be queued on @gcwq, determine insertion
880 * position for the work. If @cwq is for HIGHPRI wq, the work is
881 * queued at the head of the queue but in FIFO order with respect to
882 * other HIGHPRI works; otherwise, at the end of the queue. This
883 * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
884 * there are HIGHPRI works pending.
886 * CONTEXT:
887 * spin_lock_irq(gcwq->lock).
889 * RETURNS:
890 * Pointer to inserstion position.
892 static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
893 struct cpu_workqueue_struct *cwq)
895 struct work_struct *twork;
897 if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
898 return &gcwq->worklist;
900 list_for_each_entry(twork, &gcwq->worklist, entry) {
901 struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
903 if (!(tcwq->wq->flags & WQ_HIGHPRI))
904 break;
907 gcwq->flags |= GCWQ_HIGHPRI_PENDING;
908 return &twork->entry;
912 * insert_work - insert a work into gcwq
913 * @cwq: cwq @work belongs to
914 * @work: work to insert
915 * @head: insertion point
916 * @extra_flags: extra WORK_STRUCT_* flags to set
918 * Insert @work which belongs to @cwq into @gcwq after @head.
919 * @extra_flags is or'd to work_struct flags.
921 * CONTEXT:
922 * spin_lock_irq(gcwq->lock).
924 static void insert_work(struct cpu_workqueue_struct *cwq,
925 struct work_struct *work, struct list_head *head,
926 unsigned int extra_flags)
928 struct global_cwq *gcwq = cwq->gcwq;
930 /* we own @work, set data and link */
931 set_work_cwq(work, cwq, extra_flags);
934 * Ensure that we get the right work->data if we see the
935 * result of list_add() below, see try_to_grab_pending().
937 smp_wmb();
939 list_add_tail(&work->entry, head);
942 * Ensure either worker_sched_deactivated() sees the above
943 * list_add_tail() or we see zero nr_running to avoid workers
944 * lying around lazily while there are works to be processed.
946 smp_mb();
948 if (__need_more_worker(gcwq))
949 wake_up_worker(gcwq);
953 * Test whether @work is being queued from another work executing on the
954 * same workqueue. This is rather expensive and should only be used from
955 * cold paths.
957 static bool is_chained_work(struct workqueue_struct *wq)
959 unsigned long flags;
960 unsigned int cpu;
962 for_each_gcwq_cpu(cpu) {
963 struct global_cwq *gcwq = get_gcwq(cpu);
964 struct worker *worker;
965 struct hlist_node *pos;
966 int i;
968 spin_lock_irqsave(&gcwq->lock, flags);
969 for_each_busy_worker(worker, i, pos, gcwq) {
970 if (worker->task != current)
971 continue;
972 spin_unlock_irqrestore(&gcwq->lock, flags);
974 * I'm @worker, no locking necessary. See if @work
975 * is headed to the same workqueue.
977 return worker->current_cwq->wq == wq;
979 spin_unlock_irqrestore(&gcwq->lock, flags);
981 return false;
984 static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
985 struct work_struct *work)
987 struct global_cwq *gcwq;
988 struct cpu_workqueue_struct *cwq;
989 struct list_head *worklist;
990 unsigned int work_flags;
991 unsigned long flags;
993 debug_work_activate(work);
995 /* if dying, only works from the same workqueue are allowed */
996 if (unlikely(wq->flags & WQ_DRAINING) &&
997 WARN_ON_ONCE(!is_chained_work(wq)))
998 return;
1000 /* determine gcwq to use */
1001 if (!(wq->flags & WQ_UNBOUND)) {
1002 struct global_cwq *last_gcwq;
1004 if (unlikely(cpu == WORK_CPU_UNBOUND))
1005 cpu = raw_smp_processor_id();
1008 * It's multi cpu. If @wq is non-reentrant and @work
1009 * was previously on a different cpu, it might still
1010 * be running there, in which case the work needs to
1011 * be queued on that cpu to guarantee non-reentrance.
1013 gcwq = get_gcwq(cpu);
1014 if (wq->flags & WQ_NON_REENTRANT &&
1015 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1016 struct worker *worker;
1018 spin_lock_irqsave(&last_gcwq->lock, flags);
1020 worker = find_worker_executing_work(last_gcwq, work);
1022 if (worker && worker->current_cwq->wq == wq)
1023 gcwq = last_gcwq;
1024 else {
1025 /* meh... not running there, queue here */
1026 spin_unlock_irqrestore(&last_gcwq->lock, flags);
1027 spin_lock_irqsave(&gcwq->lock, flags);
1029 } else
1030 spin_lock_irqsave(&gcwq->lock, flags);
1031 } else {
1032 gcwq = get_gcwq(WORK_CPU_UNBOUND);
1033 spin_lock_irqsave(&gcwq->lock, flags);
1036 /* gcwq determined, get cwq and queue */
1037 cwq = get_cwq(gcwq->cpu, wq);
1038 trace_workqueue_queue_work(cpu, cwq, work);
1040 BUG_ON(!list_empty(&work->entry));
1042 cwq->nr_in_flight[cwq->work_color]++;
1043 work_flags = work_color_to_flags(cwq->work_color);
1045 if (likely(cwq->nr_active < cwq->max_active)) {
1046 trace_workqueue_activate_work(work);
1047 cwq->nr_active++;
1048 worklist = gcwq_determine_ins_pos(gcwq, cwq);
1049 } else {
1050 work_flags |= WORK_STRUCT_DELAYED;
1051 worklist = &cwq->delayed_works;
1054 insert_work(cwq, work, worklist, work_flags);
1056 spin_unlock_irqrestore(&gcwq->lock, flags);
1060 * queue_work - queue work on a workqueue
1061 * @wq: workqueue to use
1062 * @work: work to queue
1064 * Returns 0 if @work was already on a queue, non-zero otherwise.
1066 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1067 * it can be processed by another CPU.
1069 int queue_work(struct workqueue_struct *wq, struct work_struct *work)
1071 int ret;
1073 ret = queue_work_on(get_cpu(), wq, work);
1074 put_cpu();
1076 return ret;
1078 EXPORT_SYMBOL_GPL(queue_work);
1081 * queue_work_on - queue work on specific cpu
1082 * @cpu: CPU number to execute work on
1083 * @wq: workqueue to use
1084 * @work: work to queue
1086 * Returns 0 if @work was already on a queue, non-zero otherwise.
1088 * We queue the work to a specific CPU, the caller must ensure it
1089 * can't go away.
1092 queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1094 int ret = 0;
1096 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1097 __queue_work(cpu, wq, work);
1098 ret = 1;
1100 return ret;
1102 EXPORT_SYMBOL_GPL(queue_work_on);
1104 static void delayed_work_timer_fn(unsigned long __data)
1106 struct delayed_work *dwork = (struct delayed_work *)__data;
1107 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
1109 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
1113 * queue_delayed_work - queue work on a workqueue after delay
1114 * @wq: workqueue to use
1115 * @dwork: delayable work to queue
1116 * @delay: number of jiffies to wait before queueing
1118 * Returns 0 if @work was already on a queue, non-zero otherwise.
1120 int queue_delayed_work(struct workqueue_struct *wq,
1121 struct delayed_work *dwork, unsigned long delay)
1123 if (delay == 0)
1124 return queue_work(wq, &dwork->work);
1126 return queue_delayed_work_on(-1, wq, dwork, delay);
1128 EXPORT_SYMBOL_GPL(queue_delayed_work);
1131 * queue_delayed_work_on - queue work on specific CPU after delay
1132 * @cpu: CPU number to execute work on
1133 * @wq: workqueue to use
1134 * @dwork: work to queue
1135 * @delay: number of jiffies to wait before queueing
1137 * Returns 0 if @work was already on a queue, non-zero otherwise.
1139 int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1140 struct delayed_work *dwork, unsigned long delay)
1142 int ret = 0;
1143 struct timer_list *timer = &dwork->timer;
1144 struct work_struct *work = &dwork->work;
1146 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1147 unsigned int lcpu;
1149 WARN_ON_ONCE(timer_pending(timer));
1150 WARN_ON_ONCE(!list_empty(&work->entry));
1152 timer_stats_timer_set_start_info(&dwork->timer);
1155 * This stores cwq for the moment, for the timer_fn.
1156 * Note that the work's gcwq is preserved to allow
1157 * reentrance detection for delayed works.
1159 if (!(wq->flags & WQ_UNBOUND)) {
1160 struct global_cwq *gcwq = get_work_gcwq(work);
1162 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1163 lcpu = gcwq->cpu;
1164 else
1165 lcpu = raw_smp_processor_id();
1166 } else
1167 lcpu = WORK_CPU_UNBOUND;
1169 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1171 timer->expires = jiffies + delay;
1172 timer->data = (unsigned long)dwork;
1173 timer->function = delayed_work_timer_fn;
1175 if (unlikely(cpu >= 0))
1176 add_timer_on(timer, cpu);
1177 else
1178 add_timer(timer);
1179 ret = 1;
1181 return ret;
1183 EXPORT_SYMBOL_GPL(queue_delayed_work_on);
1186 * worker_enter_idle - enter idle state
1187 * @worker: worker which is entering idle state
1189 * @worker is entering idle state. Update stats and idle timer if
1190 * necessary.
1192 * LOCKING:
1193 * spin_lock_irq(gcwq->lock).
1195 static void worker_enter_idle(struct worker *worker)
1197 struct global_cwq *gcwq = worker->gcwq;
1199 BUG_ON(worker->flags & WORKER_IDLE);
1200 BUG_ON(!list_empty(&worker->entry) &&
1201 (worker->hentry.next || worker->hentry.pprev));
1203 /* can't use worker_set_flags(), also called from start_worker() */
1204 worker->flags |= WORKER_IDLE;
1205 gcwq->nr_idle++;
1206 worker->last_active = jiffies;
1208 /* idle_list is LIFO */
1209 list_add(&worker->entry, &gcwq->idle_list);
1211 if (likely(!(worker->flags & WORKER_ROGUE))) {
1212 if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1213 mod_timer(&gcwq->idle_timer,
1214 jiffies + IDLE_WORKER_TIMEOUT);
1215 } else
1216 wake_up_all(&gcwq->trustee_wait);
1219 * Sanity check nr_running. Because trustee releases gcwq->lock
1220 * between setting %WORKER_ROGUE and zapping nr_running, the
1221 * warning may trigger spuriously. Check iff trustee is idle.
1223 WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
1224 gcwq->nr_workers == gcwq->nr_idle &&
1225 atomic_read(get_gcwq_nr_running(gcwq->cpu)));
1229 * worker_leave_idle - leave idle state
1230 * @worker: worker which is leaving idle state
1232 * @worker is leaving idle state. Update stats.
1234 * LOCKING:
1235 * spin_lock_irq(gcwq->lock).
1237 static void worker_leave_idle(struct worker *worker)
1239 struct global_cwq *gcwq = worker->gcwq;
1241 BUG_ON(!(worker->flags & WORKER_IDLE));
1242 worker_clr_flags(worker, WORKER_IDLE);
1243 gcwq->nr_idle--;
1244 list_del_init(&worker->entry);
1248 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1249 * @worker: self
1251 * Works which are scheduled while the cpu is online must at least be
1252 * scheduled to a worker which is bound to the cpu so that if they are
1253 * flushed from cpu callbacks while cpu is going down, they are
1254 * guaranteed to execute on the cpu.
1256 * This function is to be used by rogue workers and rescuers to bind
1257 * themselves to the target cpu and may race with cpu going down or
1258 * coming online. kthread_bind() can't be used because it may put the
1259 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1260 * verbatim as it's best effort and blocking and gcwq may be
1261 * [dis]associated in the meantime.
1263 * This function tries set_cpus_allowed() and locks gcwq and verifies
1264 * the binding against GCWQ_DISASSOCIATED which is set during
1265 * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1266 * idle state or fetches works without dropping lock, it can guarantee
1267 * the scheduling requirement described in the first paragraph.
1269 * CONTEXT:
1270 * Might sleep. Called without any lock but returns with gcwq->lock
1271 * held.
1273 * RETURNS:
1274 * %true if the associated gcwq is online (@worker is successfully
1275 * bound), %false if offline.
1277 static bool worker_maybe_bind_and_lock(struct worker *worker)
1278 __acquires(&gcwq->lock)
1280 struct global_cwq *gcwq = worker->gcwq;
1281 struct task_struct *task = worker->task;
1283 while (true) {
1285 * The following call may fail, succeed or succeed
1286 * without actually migrating the task to the cpu if
1287 * it races with cpu hotunplug operation. Verify
1288 * against GCWQ_DISASSOCIATED.
1290 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1291 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1293 spin_lock_irq(&gcwq->lock);
1294 if (gcwq->flags & GCWQ_DISASSOCIATED)
1295 return false;
1296 if (task_cpu(task) == gcwq->cpu &&
1297 cpumask_equal(&current->cpus_allowed,
1298 get_cpu_mask(gcwq->cpu)))
1299 return true;
1300 spin_unlock_irq(&gcwq->lock);
1303 * We've raced with CPU hot[un]plug. Give it a breather
1304 * and retry migration. cond_resched() is required here;
1305 * otherwise, we might deadlock against cpu_stop trying to
1306 * bring down the CPU on non-preemptive kernel.
1308 cpu_relax();
1309 cond_resched();
1314 * Function for worker->rebind_work used to rebind rogue busy workers
1315 * to the associated cpu which is coming back online. This is
1316 * scheduled by cpu up but can race with other cpu hotplug operations
1317 * and may be executed twice without intervening cpu down.
1319 static void worker_rebind_fn(struct work_struct *work)
1321 struct worker *worker = container_of(work, struct worker, rebind_work);
1322 struct global_cwq *gcwq = worker->gcwq;
1324 if (worker_maybe_bind_and_lock(worker))
1325 worker_clr_flags(worker, WORKER_REBIND);
1327 spin_unlock_irq(&gcwq->lock);
1330 static struct worker *alloc_worker(void)
1332 struct worker *worker;
1334 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1335 if (worker) {
1336 INIT_LIST_HEAD(&worker->entry);
1337 INIT_LIST_HEAD(&worker->scheduled);
1338 INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1339 /* on creation a worker is in !idle && prep state */
1340 worker->flags = WORKER_PREP;
1342 return worker;
1346 * create_worker - create a new workqueue worker
1347 * @gcwq: gcwq the new worker will belong to
1348 * @bind: whether to set affinity to @cpu or not
1350 * Create a new worker which is bound to @gcwq. The returned worker
1351 * can be started by calling start_worker() or destroyed using
1352 * destroy_worker().
1354 * CONTEXT:
1355 * Might sleep. Does GFP_KERNEL allocations.
1357 * RETURNS:
1358 * Pointer to the newly created worker.
1360 static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
1362 bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
1363 struct worker *worker = NULL;
1364 int id = -1;
1366 spin_lock_irq(&gcwq->lock);
1367 while (ida_get_new(&gcwq->worker_ida, &id)) {
1368 spin_unlock_irq(&gcwq->lock);
1369 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
1370 goto fail;
1371 spin_lock_irq(&gcwq->lock);
1373 spin_unlock_irq(&gcwq->lock);
1375 worker = alloc_worker();
1376 if (!worker)
1377 goto fail;
1379 worker->gcwq = gcwq;
1380 worker->id = id;
1382 if (!on_unbound_cpu)
1383 worker->task = kthread_create_on_node(worker_thread,
1384 worker,
1385 cpu_to_node(gcwq->cpu),
1386 "kworker/%u:%d", gcwq->cpu, id);
1387 else
1388 worker->task = kthread_create(worker_thread, worker,
1389 "kworker/u:%d", id);
1390 if (IS_ERR(worker->task))
1391 goto fail;
1394 * A rogue worker will become a regular one if CPU comes
1395 * online later on. Make sure every worker has
1396 * PF_THREAD_BOUND set.
1398 if (bind && !on_unbound_cpu)
1399 kthread_bind(worker->task, gcwq->cpu);
1400 else {
1401 worker->task->flags |= PF_THREAD_BOUND;
1402 if (on_unbound_cpu)
1403 worker->flags |= WORKER_UNBOUND;
1406 return worker;
1407 fail:
1408 if (id >= 0) {
1409 spin_lock_irq(&gcwq->lock);
1410 ida_remove(&gcwq->worker_ida, id);
1411 spin_unlock_irq(&gcwq->lock);
1413 kfree(worker);
1414 return NULL;
1418 * start_worker - start a newly created worker
1419 * @worker: worker to start
1421 * Make the gcwq aware of @worker and start it.
1423 * CONTEXT:
1424 * spin_lock_irq(gcwq->lock).
1426 static void start_worker(struct worker *worker)
1428 worker->flags |= WORKER_STARTED;
1429 worker->gcwq->nr_workers++;
1430 worker_enter_idle(worker);
1431 wake_up_process(worker->task);
1435 * destroy_worker - destroy a workqueue worker
1436 * @worker: worker to be destroyed
1438 * Destroy @worker and adjust @gcwq stats accordingly.
1440 * CONTEXT:
1441 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1443 static void destroy_worker(struct worker *worker)
1445 struct global_cwq *gcwq = worker->gcwq;
1446 int id = worker->id;
1448 /* sanity check frenzy */
1449 BUG_ON(worker->current_work);
1450 BUG_ON(!list_empty(&worker->scheduled));
1452 if (worker->flags & WORKER_STARTED)
1453 gcwq->nr_workers--;
1454 if (worker->flags & WORKER_IDLE)
1455 gcwq->nr_idle--;
1457 list_del_init(&worker->entry);
1458 worker->flags |= WORKER_DIE;
1460 spin_unlock_irq(&gcwq->lock);
1462 kthread_stop(worker->task);
1463 kfree(worker);
1465 spin_lock_irq(&gcwq->lock);
1466 ida_remove(&gcwq->worker_ida, id);
1469 static void idle_worker_timeout(unsigned long __gcwq)
1471 struct global_cwq *gcwq = (void *)__gcwq;
1473 spin_lock_irq(&gcwq->lock);
1475 if (too_many_workers(gcwq)) {
1476 struct worker *worker;
1477 unsigned long expires;
1479 /* idle_list is kept in LIFO order, check the last one */
1480 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1481 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1483 if (time_before(jiffies, expires))
1484 mod_timer(&gcwq->idle_timer, expires);
1485 else {
1486 /* it's been idle for too long, wake up manager */
1487 gcwq->flags |= GCWQ_MANAGE_WORKERS;
1488 wake_up_worker(gcwq);
1492 spin_unlock_irq(&gcwq->lock);
1495 static bool send_mayday(struct work_struct *work)
1497 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1498 struct workqueue_struct *wq = cwq->wq;
1499 unsigned int cpu;
1501 if (!(wq->flags & WQ_RESCUER))
1502 return false;
1504 /* mayday mayday mayday */
1505 cpu = cwq->gcwq->cpu;
1506 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1507 if (cpu == WORK_CPU_UNBOUND)
1508 cpu = 0;
1509 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1510 wake_up_process(wq->rescuer->task);
1511 return true;
1514 static void gcwq_mayday_timeout(unsigned long __gcwq)
1516 struct global_cwq *gcwq = (void *)__gcwq;
1517 struct work_struct *work;
1519 spin_lock_irq(&gcwq->lock);
1521 if (need_to_create_worker(gcwq)) {
1523 * We've been trying to create a new worker but
1524 * haven't been successful. We might be hitting an
1525 * allocation deadlock. Send distress signals to
1526 * rescuers.
1528 list_for_each_entry(work, &gcwq->worklist, entry)
1529 send_mayday(work);
1532 spin_unlock_irq(&gcwq->lock);
1534 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1538 * maybe_create_worker - create a new worker if necessary
1539 * @gcwq: gcwq to create a new worker for
1541 * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to
1542 * have at least one idle worker on return from this function. If
1543 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1544 * sent to all rescuers with works scheduled on @gcwq to resolve
1545 * possible allocation deadlock.
1547 * On return, need_to_create_worker() is guaranteed to be false and
1548 * may_start_working() true.
1550 * LOCKING:
1551 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1552 * multiple times. Does GFP_KERNEL allocations. Called only from
1553 * manager.
1555 * RETURNS:
1556 * false if no action was taken and gcwq->lock stayed locked, true
1557 * otherwise.
1559 static bool maybe_create_worker(struct global_cwq *gcwq)
1560 __releases(&gcwq->lock)
1561 __acquires(&gcwq->lock)
1563 if (!need_to_create_worker(gcwq))
1564 return false;
1565 restart:
1566 spin_unlock_irq(&gcwq->lock);
1568 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1569 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1571 while (true) {
1572 struct worker *worker;
1574 worker = create_worker(gcwq, true);
1575 if (worker) {
1576 del_timer_sync(&gcwq->mayday_timer);
1577 spin_lock_irq(&gcwq->lock);
1578 start_worker(worker);
1579 BUG_ON(need_to_create_worker(gcwq));
1580 return true;
1583 if (!need_to_create_worker(gcwq))
1584 break;
1586 __set_current_state(TASK_INTERRUPTIBLE);
1587 schedule_timeout(CREATE_COOLDOWN);
1589 if (!need_to_create_worker(gcwq))
1590 break;
1593 del_timer_sync(&gcwq->mayday_timer);
1594 spin_lock_irq(&gcwq->lock);
1595 if (need_to_create_worker(gcwq))
1596 goto restart;
1597 return true;
1601 * maybe_destroy_worker - destroy workers which have been idle for a while
1602 * @gcwq: gcwq to destroy workers for
1604 * Destroy @gcwq workers which have been idle for longer than
1605 * IDLE_WORKER_TIMEOUT.
1607 * LOCKING:
1608 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1609 * multiple times. Called only from manager.
1611 * RETURNS:
1612 * false if no action was taken and gcwq->lock stayed locked, true
1613 * otherwise.
1615 static bool maybe_destroy_workers(struct global_cwq *gcwq)
1617 bool ret = false;
1619 while (too_many_workers(gcwq)) {
1620 struct worker *worker;
1621 unsigned long expires;
1623 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1624 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1626 if (time_before(jiffies, expires)) {
1627 mod_timer(&gcwq->idle_timer, expires);
1628 break;
1631 destroy_worker(worker);
1632 ret = true;
1635 return ret;
1639 * manage_workers - manage worker pool
1640 * @worker: self
1642 * Assume the manager role and manage gcwq worker pool @worker belongs
1643 * to. At any given time, there can be only zero or one manager per
1644 * gcwq. The exclusion is handled automatically by this function.
1646 * The caller can safely start processing works on false return. On
1647 * true return, it's guaranteed that need_to_create_worker() is false
1648 * and may_start_working() is true.
1650 * CONTEXT:
1651 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1652 * multiple times. Does GFP_KERNEL allocations.
1654 * RETURNS:
1655 * false if no action was taken and gcwq->lock stayed locked, true if
1656 * some action was taken.
1658 static bool manage_workers(struct worker *worker)
1660 struct global_cwq *gcwq = worker->gcwq;
1661 bool ret = false;
1663 if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1664 return ret;
1666 gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1667 gcwq->flags |= GCWQ_MANAGING_WORKERS;
1670 * Destroy and then create so that may_start_working() is true
1671 * on return.
1673 ret |= maybe_destroy_workers(gcwq);
1674 ret |= maybe_create_worker(gcwq);
1676 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1679 * The trustee might be waiting to take over the manager
1680 * position, tell it we're done.
1682 if (unlikely(gcwq->trustee))
1683 wake_up_all(&gcwq->trustee_wait);
1685 return ret;
1689 * move_linked_works - move linked works to a list
1690 * @work: start of series of works to be scheduled
1691 * @head: target list to append @work to
1692 * @nextp: out paramter for nested worklist walking
1694 * Schedule linked works starting from @work to @head. Work series to
1695 * be scheduled starts at @work and includes any consecutive work with
1696 * WORK_STRUCT_LINKED set in its predecessor.
1698 * If @nextp is not NULL, it's updated to point to the next work of
1699 * the last scheduled work. This allows move_linked_works() to be
1700 * nested inside outer list_for_each_entry_safe().
1702 * CONTEXT:
1703 * spin_lock_irq(gcwq->lock).
1705 static void move_linked_works(struct work_struct *work, struct list_head *head,
1706 struct work_struct **nextp)
1708 struct work_struct *n;
1711 * Linked worklist will always end before the end of the list,
1712 * use NULL for list head.
1714 list_for_each_entry_safe_from(work, n, NULL, entry) {
1715 list_move_tail(&work->entry, head);
1716 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1717 break;
1721 * If we're already inside safe list traversal and have moved
1722 * multiple works to the scheduled queue, the next position
1723 * needs to be updated.
1725 if (nextp)
1726 *nextp = n;
1729 static void cwq_activate_delayed_work(struct work_struct *work)
1731 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1732 struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
1734 trace_workqueue_activate_work(work);
1735 move_linked_works(work, pos, NULL);
1736 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1737 cwq->nr_active++;
1740 static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
1742 struct work_struct *work = list_first_entry(&cwq->delayed_works,
1743 struct work_struct, entry);
1745 cwq_activate_delayed_work(work);
1749 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1750 * @cwq: cwq of interest
1751 * @color: color of work which left the queue
1752 * @delayed: for a delayed work
1754 * A work either has completed or is removed from pending queue,
1755 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1757 * CONTEXT:
1758 * spin_lock_irq(gcwq->lock).
1760 static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1761 bool delayed)
1763 /* ignore uncolored works */
1764 if (color == WORK_NO_COLOR)
1765 return;
1767 cwq->nr_in_flight[color]--;
1769 if (!delayed) {
1770 cwq->nr_active--;
1771 if (!list_empty(&cwq->delayed_works)) {
1772 /* one down, submit a delayed one */
1773 if (cwq->nr_active < cwq->max_active)
1774 cwq_activate_first_delayed(cwq);
1778 /* is flush in progress and are we at the flushing tip? */
1779 if (likely(cwq->flush_color != color))
1780 return;
1782 /* are there still in-flight works? */
1783 if (cwq->nr_in_flight[color])
1784 return;
1786 /* this cwq is done, clear flush_color */
1787 cwq->flush_color = -1;
1790 * If this was the last cwq, wake up the first flusher. It
1791 * will handle the rest.
1793 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1794 complete(&cwq->wq->first_flusher->done);
1798 * process_one_work - process single work
1799 * @worker: self
1800 * @work: work to process
1802 * Process @work. This function contains all the logics necessary to
1803 * process a single work including synchronization against and
1804 * interaction with other workers on the same cpu, queueing and
1805 * flushing. As long as context requirement is met, any worker can
1806 * call this function to process a work.
1808 * CONTEXT:
1809 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1811 static void process_one_work(struct worker *worker, struct work_struct *work)
1812 __releases(&gcwq->lock)
1813 __acquires(&gcwq->lock)
1815 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1816 struct global_cwq *gcwq = cwq->gcwq;
1817 struct hlist_head *bwh = busy_worker_head(gcwq, work);
1818 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
1819 work_func_t f = work->func;
1820 int work_color;
1821 struct worker *collision;
1822 #ifdef CONFIG_LOCKDEP
1824 * It is permissible to free the struct work_struct from
1825 * inside the function that is called from it, this we need to
1826 * take into account for lockdep too. To avoid bogus "held
1827 * lock freed" warnings as well as problems when looking into
1828 * work->lockdep_map, make a copy and use that here.
1830 struct lockdep_map lockdep_map = work->lockdep_map;
1831 #endif
1833 * A single work shouldn't be executed concurrently by
1834 * multiple workers on a single cpu. Check whether anyone is
1835 * already processing the work. If so, defer the work to the
1836 * currently executing one.
1838 collision = __find_worker_executing_work(gcwq, bwh, work);
1839 if (unlikely(collision)) {
1840 move_linked_works(work, &collision->scheduled, NULL);
1841 return;
1844 /* claim and process */
1845 debug_work_deactivate(work);
1846 hlist_add_head(&worker->hentry, bwh);
1847 worker->current_work = work;
1848 worker->current_cwq = cwq;
1849 work_color = get_work_color(work);
1851 /* record the current cpu number in the work data and dequeue */
1852 set_work_cpu(work, gcwq->cpu);
1853 list_del_init(&work->entry);
1856 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1857 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1859 if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1860 struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1861 struct work_struct, entry);
1863 if (!list_empty(&gcwq->worklist) &&
1864 get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1865 wake_up_worker(gcwq);
1866 else
1867 gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1871 * CPU intensive works don't participate in concurrency
1872 * management. They're the scheduler's responsibility.
1874 if (unlikely(cpu_intensive))
1875 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1877 spin_unlock_irq(&gcwq->lock);
1879 smp_wmb(); /* paired with test_and_set_bit(PENDING) */
1880 work_clear_pending(work);
1882 lock_map_acquire_read(&cwq->wq->lockdep_map);
1883 lock_map_acquire(&lockdep_map);
1884 trace_workqueue_execute_start(work);
1885 f(work);
1887 * While we must be careful to not use "work" after this, the trace
1888 * point will only record its address.
1890 trace_workqueue_execute_end(work);
1891 lock_map_release(&lockdep_map);
1892 lock_map_release(&cwq->wq->lockdep_map);
1894 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1895 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1896 "%s/0x%08x/%d\n",
1897 current->comm, preempt_count(), task_pid_nr(current));
1898 printk(KERN_ERR " last function: ");
1899 print_symbol("%s\n", (unsigned long)f);
1900 debug_show_held_locks(current);
1901 dump_stack();
1904 spin_lock_irq(&gcwq->lock);
1906 /* clear cpu intensive status */
1907 if (unlikely(cpu_intensive))
1908 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1910 /* we're done with it, release */
1911 hlist_del_init(&worker->hentry);
1912 worker->current_work = NULL;
1913 worker->current_cwq = NULL;
1914 cwq_dec_nr_in_flight(cwq, work_color, false);
1918 * process_scheduled_works - process scheduled works
1919 * @worker: self
1921 * Process all scheduled works. Please note that the scheduled list
1922 * may change while processing a work, so this function repeatedly
1923 * fetches a work from the top and executes it.
1925 * CONTEXT:
1926 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1927 * multiple times.
1929 static void process_scheduled_works(struct worker *worker)
1931 while (!list_empty(&worker->scheduled)) {
1932 struct work_struct *work = list_first_entry(&worker->scheduled,
1933 struct work_struct, entry);
1934 process_one_work(worker, work);
1939 * worker_thread - the worker thread function
1940 * @__worker: self
1942 * The gcwq worker thread function. There's a single dynamic pool of
1943 * these per each cpu. These workers process all works regardless of
1944 * their specific target workqueue. The only exception is works which
1945 * belong to workqueues with a rescuer which will be explained in
1946 * rescuer_thread().
1948 static int worker_thread(void *__worker)
1950 struct worker *worker = __worker;
1951 struct global_cwq *gcwq = worker->gcwq;
1953 /* tell the scheduler that this is a workqueue worker */
1954 worker->task->flags |= PF_WQ_WORKER;
1955 woke_up:
1956 spin_lock_irq(&gcwq->lock);
1958 /* DIE can be set only while we're idle, checking here is enough */
1959 if (worker->flags & WORKER_DIE) {
1960 spin_unlock_irq(&gcwq->lock);
1961 worker->task->flags &= ~PF_WQ_WORKER;
1962 return 0;
1965 worker_leave_idle(worker);
1966 recheck:
1967 /* no more worker necessary? */
1968 if (!need_more_worker(gcwq))
1969 goto sleep;
1971 /* do we need to manage? */
1972 if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1973 goto recheck;
1976 * ->scheduled list can only be filled while a worker is
1977 * preparing to process a work or actually processing it.
1978 * Make sure nobody diddled with it while I was sleeping.
1980 BUG_ON(!list_empty(&worker->scheduled));
1983 * When control reaches this point, we're guaranteed to have
1984 * at least one idle worker or that someone else has already
1985 * assumed the manager role.
1987 worker_clr_flags(worker, WORKER_PREP);
1989 do {
1990 struct work_struct *work =
1991 list_first_entry(&gcwq->worklist,
1992 struct work_struct, entry);
1994 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1995 /* optimization path, not strictly necessary */
1996 process_one_work(worker, work);
1997 if (unlikely(!list_empty(&worker->scheduled)))
1998 process_scheduled_works(worker);
1999 } else {
2000 move_linked_works(work, &worker->scheduled, NULL);
2001 process_scheduled_works(worker);
2003 } while (keep_working(gcwq));
2005 worker_set_flags(worker, WORKER_PREP, false);
2006 sleep:
2007 if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
2008 goto recheck;
2011 * gcwq->lock is held and there's no work to process and no
2012 * need to manage, sleep. Workers are woken up only while
2013 * holding gcwq->lock or from local cpu, so setting the
2014 * current state before releasing gcwq->lock is enough to
2015 * prevent losing any event.
2017 worker_enter_idle(worker);
2018 __set_current_state(TASK_INTERRUPTIBLE);
2019 spin_unlock_irq(&gcwq->lock);
2020 schedule();
2021 goto woke_up;
2025 * rescuer_thread - the rescuer thread function
2026 * @__wq: the associated workqueue
2028 * Workqueue rescuer thread function. There's one rescuer for each
2029 * workqueue which has WQ_RESCUER set.
2031 * Regular work processing on a gcwq may block trying to create a new
2032 * worker which uses GFP_KERNEL allocation which has slight chance of
2033 * developing into deadlock if some works currently on the same queue
2034 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2035 * the problem rescuer solves.
2037 * When such condition is possible, the gcwq summons rescuers of all
2038 * workqueues which have works queued on the gcwq and let them process
2039 * those works so that forward progress can be guaranteed.
2041 * This should happen rarely.
2043 static int rescuer_thread(void *__wq)
2045 struct workqueue_struct *wq = __wq;
2046 struct worker *rescuer = wq->rescuer;
2047 struct list_head *scheduled = &rescuer->scheduled;
2048 bool is_unbound = wq->flags & WQ_UNBOUND;
2049 unsigned int cpu;
2051 set_user_nice(current, RESCUER_NICE_LEVEL);
2052 repeat:
2053 set_current_state(TASK_INTERRUPTIBLE);
2055 if (kthread_should_stop()) {
2056 __set_current_state(TASK_RUNNING);
2057 return 0;
2061 * See whether any cpu is asking for help. Unbounded
2062 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2064 for_each_mayday_cpu(cpu, wq->mayday_mask) {
2065 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2066 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2067 struct global_cwq *gcwq = cwq->gcwq;
2068 struct work_struct *work, *n;
2070 __set_current_state(TASK_RUNNING);
2071 mayday_clear_cpu(cpu, wq->mayday_mask);
2073 /* migrate to the target cpu if possible */
2074 rescuer->gcwq = gcwq;
2075 worker_maybe_bind_and_lock(rescuer);
2078 * Slurp in all works issued via this workqueue and
2079 * process'em.
2081 BUG_ON(!list_empty(&rescuer->scheduled));
2082 list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
2083 if (get_work_cwq(work) == cwq)
2084 move_linked_works(work, scheduled, &n);
2086 process_scheduled_works(rescuer);
2089 * Leave this gcwq. If keep_working() is %true, notify a
2090 * regular worker; otherwise, we end up with 0 concurrency
2091 * and stalling the execution.
2093 if (keep_working(gcwq))
2094 wake_up_worker(gcwq);
2096 spin_unlock_irq(&gcwq->lock);
2099 schedule();
2100 goto repeat;
2103 struct wq_barrier {
2104 struct work_struct work;
2105 struct completion done;
2108 static void wq_barrier_func(struct work_struct *work)
2110 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2111 complete(&barr->done);
2115 * insert_wq_barrier - insert a barrier work
2116 * @cwq: cwq to insert barrier into
2117 * @barr: wq_barrier to insert
2118 * @target: target work to attach @barr to
2119 * @worker: worker currently executing @target, NULL if @target is not executing
2121 * @barr is linked to @target such that @barr is completed only after
2122 * @target finishes execution. Please note that the ordering
2123 * guarantee is observed only with respect to @target and on the local
2124 * cpu.
2126 * Currently, a queued barrier can't be canceled. This is because
2127 * try_to_grab_pending() can't determine whether the work to be
2128 * grabbed is at the head of the queue and thus can't clear LINKED
2129 * flag of the previous work while there must be a valid next work
2130 * after a work with LINKED flag set.
2132 * Note that when @worker is non-NULL, @target may be modified
2133 * underneath us, so we can't reliably determine cwq from @target.
2135 * CONTEXT:
2136 * spin_lock_irq(gcwq->lock).
2138 static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2139 struct wq_barrier *barr,
2140 struct work_struct *target, struct worker *worker)
2142 struct list_head *head;
2143 unsigned int linked = 0;
2146 * debugobject calls are safe here even with gcwq->lock locked
2147 * as we know for sure that this will not trigger any of the
2148 * checks and call back into the fixup functions where we
2149 * might deadlock.
2151 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
2152 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2153 init_completion(&barr->done);
2156 * If @target is currently being executed, schedule the
2157 * barrier to the worker; otherwise, put it after @target.
2159 if (worker)
2160 head = worker->scheduled.next;
2161 else {
2162 unsigned long *bits = work_data_bits(target);
2164 head = target->entry.next;
2165 /* there can already be other linked works, inherit and set */
2166 linked = *bits & WORK_STRUCT_LINKED;
2167 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2170 debug_work_activate(&barr->work);
2171 insert_work(cwq, &barr->work, head,
2172 work_color_to_flags(WORK_NO_COLOR) | linked);
2176 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2177 * @wq: workqueue being flushed
2178 * @flush_color: new flush color, < 0 for no-op
2179 * @work_color: new work color, < 0 for no-op
2181 * Prepare cwqs for workqueue flushing.
2183 * If @flush_color is non-negative, flush_color on all cwqs should be
2184 * -1. If no cwq has in-flight commands at the specified color, all
2185 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2186 * has in flight commands, its cwq->flush_color is set to
2187 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2188 * wakeup logic is armed and %true is returned.
2190 * The caller should have initialized @wq->first_flusher prior to
2191 * calling this function with non-negative @flush_color. If
2192 * @flush_color is negative, no flush color update is done and %false
2193 * is returned.
2195 * If @work_color is non-negative, all cwqs should have the same
2196 * work_color which is previous to @work_color and all will be
2197 * advanced to @work_color.
2199 * CONTEXT:
2200 * mutex_lock(wq->flush_mutex).
2202 * RETURNS:
2203 * %true if @flush_color >= 0 and there's something to flush. %false
2204 * otherwise.
2206 static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2207 int flush_color, int work_color)
2209 bool wait = false;
2210 unsigned int cpu;
2212 if (flush_color >= 0) {
2213 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2214 atomic_set(&wq->nr_cwqs_to_flush, 1);
2217 for_each_cwq_cpu(cpu, wq) {
2218 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2219 struct global_cwq *gcwq = cwq->gcwq;
2221 spin_lock_irq(&gcwq->lock);
2223 if (flush_color >= 0) {
2224 BUG_ON(cwq->flush_color != -1);
2226 if (cwq->nr_in_flight[flush_color]) {
2227 cwq->flush_color = flush_color;
2228 atomic_inc(&wq->nr_cwqs_to_flush);
2229 wait = true;
2233 if (work_color >= 0) {
2234 BUG_ON(work_color != work_next_color(cwq->work_color));
2235 cwq->work_color = work_color;
2238 spin_unlock_irq(&gcwq->lock);
2241 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2242 complete(&wq->first_flusher->done);
2244 return wait;
2248 * flush_workqueue - ensure that any scheduled work has run to completion.
2249 * @wq: workqueue to flush
2251 * Forces execution of the workqueue and blocks until its completion.
2252 * This is typically used in driver shutdown handlers.
2254 * We sleep until all works which were queued on entry have been handled,
2255 * but we are not livelocked by new incoming ones.
2257 void flush_workqueue(struct workqueue_struct *wq)
2259 struct wq_flusher this_flusher = {
2260 .list = LIST_HEAD_INIT(this_flusher.list),
2261 .flush_color = -1,
2262 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2264 int next_color;
2266 lock_map_acquire(&wq->lockdep_map);
2267 lock_map_release(&wq->lockdep_map);
2269 mutex_lock(&wq->flush_mutex);
2272 * Start-to-wait phase
2274 next_color = work_next_color(wq->work_color);
2276 if (next_color != wq->flush_color) {
2278 * Color space is not full. The current work_color
2279 * becomes our flush_color and work_color is advanced
2280 * by one.
2282 BUG_ON(!list_empty(&wq->flusher_overflow));
2283 this_flusher.flush_color = wq->work_color;
2284 wq->work_color = next_color;
2286 if (!wq->first_flusher) {
2287 /* no flush in progress, become the first flusher */
2288 BUG_ON(wq->flush_color != this_flusher.flush_color);
2290 wq->first_flusher = &this_flusher;
2292 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2293 wq->work_color)) {
2294 /* nothing to flush, done */
2295 wq->flush_color = next_color;
2296 wq->first_flusher = NULL;
2297 goto out_unlock;
2299 } else {
2300 /* wait in queue */
2301 BUG_ON(wq->flush_color == this_flusher.flush_color);
2302 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2303 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2305 } else {
2307 * Oops, color space is full, wait on overflow queue.
2308 * The next flush completion will assign us
2309 * flush_color and transfer to flusher_queue.
2311 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2314 mutex_unlock(&wq->flush_mutex);
2316 wait_for_completion(&this_flusher.done);
2319 * Wake-up-and-cascade phase
2321 * First flushers are responsible for cascading flushes and
2322 * handling overflow. Non-first flushers can simply return.
2324 if (wq->first_flusher != &this_flusher)
2325 return;
2327 mutex_lock(&wq->flush_mutex);
2329 /* we might have raced, check again with mutex held */
2330 if (wq->first_flusher != &this_flusher)
2331 goto out_unlock;
2333 wq->first_flusher = NULL;
2335 BUG_ON(!list_empty(&this_flusher.list));
2336 BUG_ON(wq->flush_color != this_flusher.flush_color);
2338 while (true) {
2339 struct wq_flusher *next, *tmp;
2341 /* complete all the flushers sharing the current flush color */
2342 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2343 if (next->flush_color != wq->flush_color)
2344 break;
2345 list_del_init(&next->list);
2346 complete(&next->done);
2349 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2350 wq->flush_color != work_next_color(wq->work_color));
2352 /* this flush_color is finished, advance by one */
2353 wq->flush_color = work_next_color(wq->flush_color);
2355 /* one color has been freed, handle overflow queue */
2356 if (!list_empty(&wq->flusher_overflow)) {
2358 * Assign the same color to all overflowed
2359 * flushers, advance work_color and append to
2360 * flusher_queue. This is the start-to-wait
2361 * phase for these overflowed flushers.
2363 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2364 tmp->flush_color = wq->work_color;
2366 wq->work_color = work_next_color(wq->work_color);
2368 list_splice_tail_init(&wq->flusher_overflow,
2369 &wq->flusher_queue);
2370 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2373 if (list_empty(&wq->flusher_queue)) {
2374 BUG_ON(wq->flush_color != wq->work_color);
2375 break;
2379 * Need to flush more colors. Make the next flusher
2380 * the new first flusher and arm cwqs.
2382 BUG_ON(wq->flush_color == wq->work_color);
2383 BUG_ON(wq->flush_color != next->flush_color);
2385 list_del_init(&next->list);
2386 wq->first_flusher = next;
2388 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2389 break;
2392 * Meh... this color is already done, clear first
2393 * flusher and repeat cascading.
2395 wq->first_flusher = NULL;
2398 out_unlock:
2399 mutex_unlock(&wq->flush_mutex);
2401 EXPORT_SYMBOL_GPL(flush_workqueue);
2404 * drain_workqueue - drain a workqueue
2405 * @wq: workqueue to drain
2407 * Wait until the workqueue becomes empty. While draining is in progress,
2408 * only chain queueing is allowed. IOW, only currently pending or running
2409 * work items on @wq can queue further work items on it. @wq is flushed
2410 * repeatedly until it becomes empty. The number of flushing is detemined
2411 * by the depth of chaining and should be relatively short. Whine if it
2412 * takes too long.
2414 void drain_workqueue(struct workqueue_struct *wq)
2416 unsigned int flush_cnt = 0;
2417 unsigned int cpu;
2420 * __queue_work() needs to test whether there are drainers, is much
2421 * hotter than drain_workqueue() and already looks at @wq->flags.
2422 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2424 spin_lock(&workqueue_lock);
2425 if (!wq->nr_drainers++)
2426 wq->flags |= WQ_DRAINING;
2427 spin_unlock(&workqueue_lock);
2428 reflush:
2429 flush_workqueue(wq);
2431 for_each_cwq_cpu(cpu, wq) {
2432 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2433 bool drained;
2435 spin_lock_irq(&cwq->gcwq->lock);
2436 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2437 spin_unlock_irq(&cwq->gcwq->lock);
2439 if (drained)
2440 continue;
2442 if (++flush_cnt == 10 ||
2443 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2444 pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
2445 wq->name, flush_cnt);
2446 goto reflush;
2449 spin_lock(&workqueue_lock);
2450 if (!--wq->nr_drainers)
2451 wq->flags &= ~WQ_DRAINING;
2452 spin_unlock(&workqueue_lock);
2454 EXPORT_SYMBOL_GPL(drain_workqueue);
2456 static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2457 bool wait_executing)
2459 struct worker *worker = NULL;
2460 struct global_cwq *gcwq;
2461 struct cpu_workqueue_struct *cwq;
2463 might_sleep();
2464 gcwq = get_work_gcwq(work);
2465 if (!gcwq)
2466 return false;
2468 spin_lock_irq(&gcwq->lock);
2469 if (!list_empty(&work->entry)) {
2471 * See the comment near try_to_grab_pending()->smp_rmb().
2472 * If it was re-queued to a different gcwq under us, we
2473 * are not going to wait.
2475 smp_rmb();
2476 cwq = get_work_cwq(work);
2477 if (unlikely(!cwq || gcwq != cwq->gcwq))
2478 goto already_gone;
2479 } else if (wait_executing) {
2480 worker = find_worker_executing_work(gcwq, work);
2481 if (!worker)
2482 goto already_gone;
2483 cwq = worker->current_cwq;
2484 } else
2485 goto already_gone;
2487 insert_wq_barrier(cwq, barr, work, worker);
2488 spin_unlock_irq(&gcwq->lock);
2491 * If @max_active is 1 or rescuer is in use, flushing another work
2492 * item on the same workqueue may lead to deadlock. Make sure the
2493 * flusher is not running on the same workqueue by verifying write
2494 * access.
2496 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2497 lock_map_acquire(&cwq->wq->lockdep_map);
2498 else
2499 lock_map_acquire_read(&cwq->wq->lockdep_map);
2500 lock_map_release(&cwq->wq->lockdep_map);
2502 return true;
2503 already_gone:
2504 spin_unlock_irq(&gcwq->lock);
2505 return false;
2509 * flush_work - wait for a work to finish executing the last queueing instance
2510 * @work: the work to flush
2512 * Wait until @work has finished execution. This function considers
2513 * only the last queueing instance of @work. If @work has been
2514 * enqueued across different CPUs on a non-reentrant workqueue or on
2515 * multiple workqueues, @work might still be executing on return on
2516 * some of the CPUs from earlier queueing.
2518 * If @work was queued only on a non-reentrant, ordered or unbound
2519 * workqueue, @work is guaranteed to be idle on return if it hasn't
2520 * been requeued since flush started.
2522 * RETURNS:
2523 * %true if flush_work() waited for the work to finish execution,
2524 * %false if it was already idle.
2526 bool flush_work(struct work_struct *work)
2528 struct wq_barrier barr;
2530 if (start_flush_work(work, &barr, true)) {
2531 wait_for_completion(&barr.done);
2532 destroy_work_on_stack(&barr.work);
2533 return true;
2534 } else
2535 return false;
2537 EXPORT_SYMBOL_GPL(flush_work);
2539 static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2541 struct wq_barrier barr;
2542 struct worker *worker;
2544 spin_lock_irq(&gcwq->lock);
2546 worker = find_worker_executing_work(gcwq, work);
2547 if (unlikely(worker))
2548 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2550 spin_unlock_irq(&gcwq->lock);
2552 if (unlikely(worker)) {
2553 wait_for_completion(&barr.done);
2554 destroy_work_on_stack(&barr.work);
2555 return true;
2556 } else
2557 return false;
2560 static bool wait_on_work(struct work_struct *work)
2562 bool ret = false;
2563 int cpu;
2565 might_sleep();
2567 lock_map_acquire(&work->lockdep_map);
2568 lock_map_release(&work->lockdep_map);
2570 for_each_gcwq_cpu(cpu)
2571 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2572 return ret;
2576 * flush_work_sync - wait until a work has finished execution
2577 * @work: the work to flush
2579 * Wait until @work has finished execution. On return, it's
2580 * guaranteed that all queueing instances of @work which happened
2581 * before this function is called are finished. In other words, if
2582 * @work hasn't been requeued since this function was called, @work is
2583 * guaranteed to be idle on return.
2585 * RETURNS:
2586 * %true if flush_work_sync() waited for the work to finish execution,
2587 * %false if it was already idle.
2589 bool flush_work_sync(struct work_struct *work)
2591 struct wq_barrier barr;
2592 bool pending, waited;
2594 /* we'll wait for executions separately, queue barr only if pending */
2595 pending = start_flush_work(work, &barr, false);
2597 /* wait for executions to finish */
2598 waited = wait_on_work(work);
2600 /* wait for the pending one */
2601 if (pending) {
2602 wait_for_completion(&barr.done);
2603 destroy_work_on_stack(&barr.work);
2606 return pending || waited;
2608 EXPORT_SYMBOL_GPL(flush_work_sync);
2611 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
2612 * so this work can't be re-armed in any way.
2614 static int try_to_grab_pending(struct work_struct *work)
2616 struct global_cwq *gcwq;
2617 int ret = -1;
2619 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
2620 return 0;
2623 * The queueing is in progress, or it is already queued. Try to
2624 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2626 gcwq = get_work_gcwq(work);
2627 if (!gcwq)
2628 return ret;
2630 spin_lock_irq(&gcwq->lock);
2631 if (!list_empty(&work->entry)) {
2633 * This work is queued, but perhaps we locked the wrong gcwq.
2634 * In that case we must see the new value after rmb(), see
2635 * insert_work()->wmb().
2637 smp_rmb();
2638 if (gcwq == get_work_gcwq(work)) {
2639 debug_work_deactivate(work);
2642 * A delayed work item cannot be grabbed directly
2643 * because it might have linked NO_COLOR work items
2644 * which, if left on the delayed_list, will confuse
2645 * cwq->nr_active management later on and cause
2646 * stall. Make sure the work item is activated
2647 * before grabbing.
2649 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
2650 cwq_activate_delayed_work(work);
2652 list_del_init(&work->entry);
2653 cwq_dec_nr_in_flight(get_work_cwq(work),
2654 get_work_color(work),
2655 *work_data_bits(work) & WORK_STRUCT_DELAYED);
2656 ret = 1;
2659 spin_unlock_irq(&gcwq->lock);
2661 return ret;
2664 static bool __cancel_work_timer(struct work_struct *work,
2665 struct timer_list* timer)
2667 int ret;
2669 do {
2670 ret = (timer && likely(del_timer(timer)));
2671 if (!ret)
2672 ret = try_to_grab_pending(work);
2673 wait_on_work(work);
2674 } while (unlikely(ret < 0));
2676 clear_work_data(work);
2677 return ret;
2681 * cancel_work_sync - cancel a work and wait for it to finish
2682 * @work: the work to cancel
2684 * Cancel @work and wait for its execution to finish. This function
2685 * can be used even if the work re-queues itself or migrates to
2686 * another workqueue. On return from this function, @work is
2687 * guaranteed to be not pending or executing on any CPU.
2689 * cancel_work_sync(&delayed_work->work) must not be used for
2690 * delayed_work's. Use cancel_delayed_work_sync() instead.
2692 * The caller must ensure that the workqueue on which @work was last
2693 * queued can't be destroyed before this function returns.
2695 * RETURNS:
2696 * %true if @work was pending, %false otherwise.
2698 bool cancel_work_sync(struct work_struct *work)
2700 return __cancel_work_timer(work, NULL);
2702 EXPORT_SYMBOL_GPL(cancel_work_sync);
2705 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2706 * @dwork: the delayed work to flush
2708 * Delayed timer is cancelled and the pending work is queued for
2709 * immediate execution. Like flush_work(), this function only
2710 * considers the last queueing instance of @dwork.
2712 * RETURNS:
2713 * %true if flush_work() waited for the work to finish execution,
2714 * %false if it was already idle.
2716 bool flush_delayed_work(struct delayed_work *dwork)
2718 if (del_timer_sync(&dwork->timer))
2719 __queue_work(raw_smp_processor_id(),
2720 get_work_cwq(&dwork->work)->wq, &dwork->work);
2721 return flush_work(&dwork->work);
2723 EXPORT_SYMBOL(flush_delayed_work);
2726 * flush_delayed_work_sync - wait for a dwork to finish
2727 * @dwork: the delayed work to flush
2729 * Delayed timer is cancelled and the pending work is queued for
2730 * execution immediately. Other than timer handling, its behavior
2731 * is identical to flush_work_sync().
2733 * RETURNS:
2734 * %true if flush_work_sync() waited for the work to finish execution,
2735 * %false if it was already idle.
2737 bool flush_delayed_work_sync(struct delayed_work *dwork)
2739 if (del_timer_sync(&dwork->timer))
2740 __queue_work(raw_smp_processor_id(),
2741 get_work_cwq(&dwork->work)->wq, &dwork->work);
2742 return flush_work_sync(&dwork->work);
2744 EXPORT_SYMBOL(flush_delayed_work_sync);
2747 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2748 * @dwork: the delayed work cancel
2750 * This is cancel_work_sync() for delayed works.
2752 * RETURNS:
2753 * %true if @dwork was pending, %false otherwise.
2755 bool cancel_delayed_work_sync(struct delayed_work *dwork)
2757 return __cancel_work_timer(&dwork->work, &dwork->timer);
2759 EXPORT_SYMBOL(cancel_delayed_work_sync);
2762 * schedule_work - put work task in global workqueue
2763 * @work: job to be done
2765 * Returns zero if @work was already on the kernel-global workqueue and
2766 * non-zero otherwise.
2768 * This puts a job in the kernel-global workqueue if it was not already
2769 * queued and leaves it in the same position on the kernel-global
2770 * workqueue otherwise.
2772 int schedule_work(struct work_struct *work)
2774 return queue_work(system_wq, work);
2776 EXPORT_SYMBOL(schedule_work);
2779 * schedule_work_on - put work task on a specific cpu
2780 * @cpu: cpu to put the work task on
2781 * @work: job to be done
2783 * This puts a job on a specific cpu
2785 int schedule_work_on(int cpu, struct work_struct *work)
2787 return queue_work_on(cpu, system_wq, work);
2789 EXPORT_SYMBOL(schedule_work_on);
2792 * schedule_delayed_work - put work task in global workqueue after delay
2793 * @dwork: job to be done
2794 * @delay: number of jiffies to wait or 0 for immediate execution
2796 * After waiting for a given time this puts a job in the kernel-global
2797 * workqueue.
2799 int schedule_delayed_work(struct delayed_work *dwork,
2800 unsigned long delay)
2802 return queue_delayed_work(system_wq, dwork, delay);
2804 EXPORT_SYMBOL(schedule_delayed_work);
2807 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2808 * @cpu: cpu to use
2809 * @dwork: job to be done
2810 * @delay: number of jiffies to wait
2812 * After waiting for a given time this puts a job in the kernel-global
2813 * workqueue on the specified CPU.
2815 int schedule_delayed_work_on(int cpu,
2816 struct delayed_work *dwork, unsigned long delay)
2818 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
2820 EXPORT_SYMBOL(schedule_delayed_work_on);
2823 * schedule_on_each_cpu - execute a function synchronously on each online CPU
2824 * @func: the function to call
2826 * schedule_on_each_cpu() executes @func on each online CPU using the
2827 * system workqueue and blocks until all CPUs have completed.
2828 * schedule_on_each_cpu() is very slow.
2830 * RETURNS:
2831 * 0 on success, -errno on failure.
2833 int schedule_on_each_cpu(work_func_t func)
2835 int cpu;
2836 struct work_struct __percpu *works;
2838 works = alloc_percpu(struct work_struct);
2839 if (!works)
2840 return -ENOMEM;
2842 get_online_cpus();
2844 for_each_online_cpu(cpu) {
2845 struct work_struct *work = per_cpu_ptr(works, cpu);
2847 INIT_WORK(work, func);
2848 schedule_work_on(cpu, work);
2851 for_each_online_cpu(cpu)
2852 flush_work(per_cpu_ptr(works, cpu));
2854 put_online_cpus();
2855 free_percpu(works);
2856 return 0;
2860 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2862 * Forces execution of the kernel-global workqueue and blocks until its
2863 * completion.
2865 * Think twice before calling this function! It's very easy to get into
2866 * trouble if you don't take great care. Either of the following situations
2867 * will lead to deadlock:
2869 * One of the work items currently on the workqueue needs to acquire
2870 * a lock held by your code or its caller.
2872 * Your code is running in the context of a work routine.
2874 * They will be detected by lockdep when they occur, but the first might not
2875 * occur very often. It depends on what work items are on the workqueue and
2876 * what locks they need, which you have no control over.
2878 * In most situations flushing the entire workqueue is overkill; you merely
2879 * need to know that a particular work item isn't queued and isn't running.
2880 * In such cases you should use cancel_delayed_work_sync() or
2881 * cancel_work_sync() instead.
2883 void flush_scheduled_work(void)
2885 flush_workqueue(system_wq);
2887 EXPORT_SYMBOL(flush_scheduled_work);
2890 * execute_in_process_context - reliably execute the routine with user context
2891 * @fn: the function to execute
2892 * @ew: guaranteed storage for the execute work structure (must
2893 * be available when the work executes)
2895 * Executes the function immediately if process context is available,
2896 * otherwise schedules the function for delayed execution.
2898 * Returns: 0 - function was executed
2899 * 1 - function was scheduled for execution
2901 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
2903 if (!in_interrupt()) {
2904 fn(&ew->work);
2905 return 0;
2908 INIT_WORK(&ew->work, fn);
2909 schedule_work(&ew->work);
2911 return 1;
2913 EXPORT_SYMBOL_GPL(execute_in_process_context);
2915 int keventd_up(void)
2917 return system_wq != NULL;
2920 static int alloc_cwqs(struct workqueue_struct *wq)
2923 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
2924 * Make sure that the alignment isn't lower than that of
2925 * unsigned long long.
2927 const size_t size = sizeof(struct cpu_workqueue_struct);
2928 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
2929 __alignof__(unsigned long long));
2930 #ifdef CONFIG_SMP
2931 bool percpu = !(wq->flags & WQ_UNBOUND);
2932 #else
2933 bool percpu = false;
2934 #endif
2936 if (percpu)
2937 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2938 else {
2939 void *ptr;
2942 * Allocate enough room to align cwq and put an extra
2943 * pointer at the end pointing back to the originally
2944 * allocated pointer which will be used for free.
2946 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2947 if (ptr) {
2948 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2949 *(void **)(wq->cpu_wq.single + 1) = ptr;
2953 /* just in case, make sure it's actually aligned */
2954 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2955 return wq->cpu_wq.v ? 0 : -ENOMEM;
2958 static void free_cwqs(struct workqueue_struct *wq)
2960 #ifdef CONFIG_SMP
2961 bool percpu = !(wq->flags & WQ_UNBOUND);
2962 #else
2963 bool percpu = false;
2964 #endif
2966 if (percpu)
2967 free_percpu(wq->cpu_wq.pcpu);
2968 else if (wq->cpu_wq.single) {
2969 /* the pointer to free is stored right after the cwq */
2970 kfree(*(void **)(wq->cpu_wq.single + 1));
2974 static int wq_clamp_max_active(int max_active, unsigned int flags,
2975 const char *name)
2977 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2979 if (max_active < 1 || max_active > lim)
2980 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2981 "is out of range, clamping between %d and %d\n",
2982 max_active, name, 1, lim);
2984 return clamp_val(max_active, 1, lim);
2987 struct workqueue_struct *__alloc_workqueue_key(const char *name,
2988 unsigned int flags,
2989 int max_active,
2990 struct lock_class_key *key,
2991 const char *lock_name)
2993 struct workqueue_struct *wq;
2994 unsigned int cpu;
2997 * Workqueues which may be used during memory reclaim should
2998 * have a rescuer to guarantee forward progress.
3000 if (flags & WQ_MEM_RECLAIM)
3001 flags |= WQ_RESCUER;
3004 * Unbound workqueues aren't concurrency managed and should be
3005 * dispatched to workers immediately.
3007 if (flags & WQ_UNBOUND)
3008 flags |= WQ_HIGHPRI;
3010 max_active = max_active ?: WQ_DFL_ACTIVE;
3011 max_active = wq_clamp_max_active(max_active, flags, name);
3013 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
3014 if (!wq)
3015 goto err;
3017 wq->flags = flags;
3018 wq->saved_max_active = max_active;
3019 mutex_init(&wq->flush_mutex);
3020 atomic_set(&wq->nr_cwqs_to_flush, 0);
3021 INIT_LIST_HEAD(&wq->flusher_queue);
3022 INIT_LIST_HEAD(&wq->flusher_overflow);
3024 wq->name = name;
3025 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3026 INIT_LIST_HEAD(&wq->list);
3028 if (alloc_cwqs(wq) < 0)
3029 goto err;
3031 for_each_cwq_cpu(cpu, wq) {
3032 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3033 struct global_cwq *gcwq = get_gcwq(cpu);
3035 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
3036 cwq->gcwq = gcwq;
3037 cwq->wq = wq;
3038 cwq->flush_color = -1;
3039 cwq->max_active = max_active;
3040 INIT_LIST_HEAD(&cwq->delayed_works);
3043 if (flags & WQ_RESCUER) {
3044 struct worker *rescuer;
3046 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3047 goto err;
3049 wq->rescuer = rescuer = alloc_worker();
3050 if (!rescuer)
3051 goto err;
3053 rescuer->task = kthread_create(rescuer_thread, wq, "%s", name);
3054 if (IS_ERR(rescuer->task))
3055 goto err;
3057 rescuer->task->flags |= PF_THREAD_BOUND;
3058 wake_up_process(rescuer->task);
3062 * workqueue_lock protects global freeze state and workqueues
3063 * list. Grab it, set max_active accordingly and add the new
3064 * workqueue to workqueues list.
3066 spin_lock(&workqueue_lock);
3068 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3069 for_each_cwq_cpu(cpu, wq)
3070 get_cwq(cpu, wq)->max_active = 0;
3072 list_add(&wq->list, &workqueues);
3074 spin_unlock(&workqueue_lock);
3076 return wq;
3077 err:
3078 if (wq) {
3079 free_cwqs(wq);
3080 free_mayday_mask(wq->mayday_mask);
3081 kfree(wq->rescuer);
3082 kfree(wq);
3084 return NULL;
3086 EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
3089 * destroy_workqueue - safely terminate a workqueue
3090 * @wq: target workqueue
3092 * Safely destroy a workqueue. All work currently pending will be done first.
3094 void destroy_workqueue(struct workqueue_struct *wq)
3096 unsigned int cpu;
3098 /* drain it before proceeding with destruction */
3099 drain_workqueue(wq);
3102 * wq list is used to freeze wq, remove from list after
3103 * flushing is complete in case freeze races us.
3105 spin_lock(&workqueue_lock);
3106 list_del(&wq->list);
3107 spin_unlock(&workqueue_lock);
3109 /* sanity check */
3110 for_each_cwq_cpu(cpu, wq) {
3111 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3112 int i;
3114 for (i = 0; i < WORK_NR_COLORS; i++)
3115 BUG_ON(cwq->nr_in_flight[i]);
3116 BUG_ON(cwq->nr_active);
3117 BUG_ON(!list_empty(&cwq->delayed_works));
3120 if (wq->flags & WQ_RESCUER) {
3121 kthread_stop(wq->rescuer->task);
3122 free_mayday_mask(wq->mayday_mask);
3123 kfree(wq->rescuer);
3126 free_cwqs(wq);
3127 kfree(wq);
3129 EXPORT_SYMBOL_GPL(destroy_workqueue);
3132 * workqueue_set_max_active - adjust max_active of a workqueue
3133 * @wq: target workqueue
3134 * @max_active: new max_active value.
3136 * Set max_active of @wq to @max_active.
3138 * CONTEXT:
3139 * Don't call from IRQ context.
3141 void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3143 unsigned int cpu;
3145 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3147 spin_lock(&workqueue_lock);
3149 wq->saved_max_active = max_active;
3151 for_each_cwq_cpu(cpu, wq) {
3152 struct global_cwq *gcwq = get_gcwq(cpu);
3154 spin_lock_irq(&gcwq->lock);
3156 if (!(wq->flags & WQ_FREEZABLE) ||
3157 !(gcwq->flags & GCWQ_FREEZING))
3158 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3160 spin_unlock_irq(&gcwq->lock);
3163 spin_unlock(&workqueue_lock);
3165 EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3168 * workqueue_congested - test whether a workqueue is congested
3169 * @cpu: CPU in question
3170 * @wq: target workqueue
3172 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3173 * no synchronization around this function and the test result is
3174 * unreliable and only useful as advisory hints or for debugging.
3176 * RETURNS:
3177 * %true if congested, %false otherwise.
3179 bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3181 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3183 return !list_empty(&cwq->delayed_works);
3185 EXPORT_SYMBOL_GPL(workqueue_congested);
3188 * work_cpu - return the last known associated cpu for @work
3189 * @work: the work of interest
3191 * RETURNS:
3192 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
3194 unsigned int work_cpu(struct work_struct *work)
3196 struct global_cwq *gcwq = get_work_gcwq(work);
3198 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3200 EXPORT_SYMBOL_GPL(work_cpu);
3203 * work_busy - test whether a work is currently pending or running
3204 * @work: the work to be tested
3206 * Test whether @work is currently pending or running. There is no
3207 * synchronization around this function and the test result is
3208 * unreliable and only useful as advisory hints or for debugging.
3209 * Especially for reentrant wqs, the pending state might hide the
3210 * running state.
3212 * RETURNS:
3213 * OR'd bitmask of WORK_BUSY_* bits.
3215 unsigned int work_busy(struct work_struct *work)
3217 struct global_cwq *gcwq = get_work_gcwq(work);
3218 unsigned long flags;
3219 unsigned int ret = 0;
3221 if (!gcwq)
3222 return false;
3224 spin_lock_irqsave(&gcwq->lock, flags);
3226 if (work_pending(work))
3227 ret |= WORK_BUSY_PENDING;
3228 if (find_worker_executing_work(gcwq, work))
3229 ret |= WORK_BUSY_RUNNING;
3231 spin_unlock_irqrestore(&gcwq->lock, flags);
3233 return ret;
3235 EXPORT_SYMBOL_GPL(work_busy);
3238 * CPU hotplug.
3240 * There are two challenges in supporting CPU hotplug. Firstly, there
3241 * are a lot of assumptions on strong associations among work, cwq and
3242 * gcwq which make migrating pending and scheduled works very
3243 * difficult to implement without impacting hot paths. Secondly,
3244 * gcwqs serve mix of short, long and very long running works making
3245 * blocked draining impractical.
3247 * This is solved by allowing a gcwq to be detached from CPU, running
3248 * it with unbound (rogue) workers and allowing it to be reattached
3249 * later if the cpu comes back online. A separate thread is created
3250 * to govern a gcwq in such state and is called the trustee of the
3251 * gcwq.
3253 * Trustee states and their descriptions.
3255 * START Command state used on startup. On CPU_DOWN_PREPARE, a
3256 * new trustee is started with this state.
3258 * IN_CHARGE Once started, trustee will enter this state after
3259 * assuming the manager role and making all existing
3260 * workers rogue. DOWN_PREPARE waits for trustee to
3261 * enter this state. After reaching IN_CHARGE, trustee
3262 * tries to execute the pending worklist until it's empty
3263 * and the state is set to BUTCHER, or the state is set
3264 * to RELEASE.
3266 * BUTCHER Command state which is set by the cpu callback after
3267 * the cpu has went down. Once this state is set trustee
3268 * knows that there will be no new works on the worklist
3269 * and once the worklist is empty it can proceed to
3270 * killing idle workers.
3272 * RELEASE Command state which is set by the cpu callback if the
3273 * cpu down has been canceled or it has come online
3274 * again. After recognizing this state, trustee stops
3275 * trying to drain or butcher and clears ROGUE, rebinds
3276 * all remaining workers back to the cpu and releases
3277 * manager role.
3279 * DONE Trustee will enter this state after BUTCHER or RELEASE
3280 * is complete.
3282 * trustee CPU draining
3283 * took over down complete
3284 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3285 * | | ^
3286 * | CPU is back online v return workers |
3287 * ----------------> RELEASE --------------
3291 * trustee_wait_event_timeout - timed event wait for trustee
3292 * @cond: condition to wait for
3293 * @timeout: timeout in jiffies
3295 * wait_event_timeout() for trustee to use. Handles locking and
3296 * checks for RELEASE request.
3298 * CONTEXT:
3299 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3300 * multiple times. To be used by trustee.
3302 * RETURNS:
3303 * Positive indicating left time if @cond is satisfied, 0 if timed
3304 * out, -1 if canceled.
3306 #define trustee_wait_event_timeout(cond, timeout) ({ \
3307 long __ret = (timeout); \
3308 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
3309 __ret) { \
3310 spin_unlock_irq(&gcwq->lock); \
3311 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
3312 (gcwq->trustee_state == TRUSTEE_RELEASE), \
3313 __ret); \
3314 spin_lock_irq(&gcwq->lock); \
3316 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
3320 * trustee_wait_event - event wait for trustee
3321 * @cond: condition to wait for
3323 * wait_event() for trustee to use. Automatically handles locking and
3324 * checks for CANCEL request.
3326 * CONTEXT:
3327 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3328 * multiple times. To be used by trustee.
3330 * RETURNS:
3331 * 0 if @cond is satisfied, -1 if canceled.
3333 #define trustee_wait_event(cond) ({ \
3334 long __ret1; \
3335 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3336 __ret1 < 0 ? -1 : 0; \
3339 static int __cpuinit trustee_thread(void *__gcwq)
3341 struct global_cwq *gcwq = __gcwq;
3342 struct worker *worker;
3343 struct work_struct *work;
3344 struct hlist_node *pos;
3345 long rc;
3346 int i;
3348 BUG_ON(gcwq->cpu != smp_processor_id());
3350 spin_lock_irq(&gcwq->lock);
3352 * Claim the manager position and make all workers rogue.
3353 * Trustee must be bound to the target cpu and can't be
3354 * cancelled.
3356 BUG_ON(gcwq->cpu != smp_processor_id());
3357 rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3358 BUG_ON(rc < 0);
3360 gcwq->flags |= GCWQ_MANAGING_WORKERS;
3362 list_for_each_entry(worker, &gcwq->idle_list, entry)
3363 worker->flags |= WORKER_ROGUE;
3365 for_each_busy_worker(worker, i, pos, gcwq)
3366 worker->flags |= WORKER_ROGUE;
3369 * Call schedule() so that we cross rq->lock and thus can
3370 * guarantee sched callbacks see the rogue flag. This is
3371 * necessary as scheduler callbacks may be invoked from other
3372 * cpus.
3374 spin_unlock_irq(&gcwq->lock);
3375 schedule();
3376 spin_lock_irq(&gcwq->lock);
3379 * Sched callbacks are disabled now. Zap nr_running. After
3380 * this, nr_running stays zero and need_more_worker() and
3381 * keep_working() are always true as long as the worklist is
3382 * not empty.
3384 atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
3386 spin_unlock_irq(&gcwq->lock);
3387 del_timer_sync(&gcwq->idle_timer);
3388 spin_lock_irq(&gcwq->lock);
3391 * We're now in charge. Notify and proceed to drain. We need
3392 * to keep the gcwq running during the whole CPU down
3393 * procedure as other cpu hotunplug callbacks may need to
3394 * flush currently running tasks.
3396 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3397 wake_up_all(&gcwq->trustee_wait);
3400 * The original cpu is in the process of dying and may go away
3401 * anytime now. When that happens, we and all workers would
3402 * be migrated to other cpus. Try draining any left work. We
3403 * want to get it over with ASAP - spam rescuers, wake up as
3404 * many idlers as necessary and create new ones till the
3405 * worklist is empty. Note that if the gcwq is frozen, there
3406 * may be frozen works in freezable cwqs. Don't declare
3407 * completion while frozen.
3409 while (gcwq->nr_workers != gcwq->nr_idle ||
3410 gcwq->flags & GCWQ_FREEZING ||
3411 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
3412 int nr_works = 0;
3414 list_for_each_entry(work, &gcwq->worklist, entry) {
3415 send_mayday(work);
3416 nr_works++;
3419 list_for_each_entry(worker, &gcwq->idle_list, entry) {
3420 if (!nr_works--)
3421 break;
3422 wake_up_process(worker->task);
3425 if (need_to_create_worker(gcwq)) {
3426 spin_unlock_irq(&gcwq->lock);
3427 worker = create_worker(gcwq, false);
3428 spin_lock_irq(&gcwq->lock);
3429 if (worker) {
3430 worker->flags |= WORKER_ROGUE;
3431 start_worker(worker);
3435 /* give a breather */
3436 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3437 break;
3441 * Either all works have been scheduled and cpu is down, or
3442 * cpu down has already been canceled. Wait for and butcher
3443 * all workers till we're canceled.
3445 do {
3446 rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3447 while (!list_empty(&gcwq->idle_list))
3448 destroy_worker(list_first_entry(&gcwq->idle_list,
3449 struct worker, entry));
3450 } while (gcwq->nr_workers && rc >= 0);
3453 * At this point, either draining has completed and no worker
3454 * is left, or cpu down has been canceled or the cpu is being
3455 * brought back up. There shouldn't be any idle one left.
3456 * Tell the remaining busy ones to rebind once it finishes the
3457 * currently scheduled works by scheduling the rebind_work.
3459 WARN_ON(!list_empty(&gcwq->idle_list));
3461 for_each_busy_worker(worker, i, pos, gcwq) {
3462 struct work_struct *rebind_work = &worker->rebind_work;
3463 unsigned long worker_flags = worker->flags;
3466 * Rebind_work may race with future cpu hotplug
3467 * operations. Use a separate flag to mark that
3468 * rebinding is scheduled. The morphing should
3469 * be atomic.
3471 worker_flags |= WORKER_REBIND;
3472 worker_flags &= ~WORKER_ROGUE;
3473 ACCESS_ONCE(worker->flags) = worker_flags;
3475 /* queue rebind_work, wq doesn't matter, use the default one */
3476 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3477 work_data_bits(rebind_work)))
3478 continue;
3480 debug_work_activate(rebind_work);
3481 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3482 worker->scheduled.next,
3483 work_color_to_flags(WORK_NO_COLOR));
3486 /* relinquish manager role */
3487 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3489 /* notify completion */
3490 gcwq->trustee = NULL;
3491 gcwq->trustee_state = TRUSTEE_DONE;
3492 wake_up_all(&gcwq->trustee_wait);
3493 spin_unlock_irq(&gcwq->lock);
3494 return 0;
3498 * wait_trustee_state - wait for trustee to enter the specified state
3499 * @gcwq: gcwq the trustee of interest belongs to
3500 * @state: target state to wait for
3502 * Wait for the trustee to reach @state. DONE is already matched.
3504 * CONTEXT:
3505 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3506 * multiple times. To be used by cpu_callback.
3508 static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
3509 __releases(&gcwq->lock)
3510 __acquires(&gcwq->lock)
3512 if (!(gcwq->trustee_state == state ||
3513 gcwq->trustee_state == TRUSTEE_DONE)) {
3514 spin_unlock_irq(&gcwq->lock);
3515 __wait_event(gcwq->trustee_wait,
3516 gcwq->trustee_state == state ||
3517 gcwq->trustee_state == TRUSTEE_DONE);
3518 spin_lock_irq(&gcwq->lock);
3522 static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
3523 unsigned long action,
3524 void *hcpu)
3526 unsigned int cpu = (unsigned long)hcpu;
3527 struct global_cwq *gcwq = get_gcwq(cpu);
3528 struct task_struct *new_trustee = NULL;
3529 struct worker *uninitialized_var(new_worker);
3530 unsigned long flags;
3532 action &= ~CPU_TASKS_FROZEN;
3534 switch (action) {
3535 case CPU_DOWN_PREPARE:
3536 new_trustee = kthread_create(trustee_thread, gcwq,
3537 "workqueue_trustee/%d\n", cpu);
3538 if (IS_ERR(new_trustee))
3539 return notifier_from_errno(PTR_ERR(new_trustee));
3540 kthread_bind(new_trustee, cpu);
3541 /* fall through */
3542 case CPU_UP_PREPARE:
3543 BUG_ON(gcwq->first_idle);
3544 new_worker = create_worker(gcwq, false);
3545 if (!new_worker) {
3546 if (new_trustee)
3547 kthread_stop(new_trustee);
3548 return NOTIFY_BAD;
3552 /* some are called w/ irq disabled, don't disturb irq status */
3553 spin_lock_irqsave(&gcwq->lock, flags);
3555 switch (action) {
3556 case CPU_DOWN_PREPARE:
3557 /* initialize trustee and tell it to acquire the gcwq */
3558 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3559 gcwq->trustee = new_trustee;
3560 gcwq->trustee_state = TRUSTEE_START;
3561 wake_up_process(gcwq->trustee);
3562 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3563 /* fall through */
3564 case CPU_UP_PREPARE:
3565 BUG_ON(gcwq->first_idle);
3566 gcwq->first_idle = new_worker;
3567 break;
3569 case CPU_DYING:
3571 * Before this, the trustee and all workers except for
3572 * the ones which are still executing works from
3573 * before the last CPU down must be on the cpu. After
3574 * this, they'll all be diasporas.
3576 gcwq->flags |= GCWQ_DISASSOCIATED;
3577 break;
3579 case CPU_POST_DEAD:
3580 gcwq->trustee_state = TRUSTEE_BUTCHER;
3581 /* fall through */
3582 case CPU_UP_CANCELED:
3583 destroy_worker(gcwq->first_idle);
3584 gcwq->first_idle = NULL;
3585 break;
3587 case CPU_DOWN_FAILED:
3588 case CPU_ONLINE:
3589 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3590 if (gcwq->trustee_state != TRUSTEE_DONE) {
3591 gcwq->trustee_state = TRUSTEE_RELEASE;
3592 wake_up_process(gcwq->trustee);
3593 wait_trustee_state(gcwq, TRUSTEE_DONE);
3597 * Trustee is done and there might be no worker left.
3598 * Put the first_idle in and request a real manager to
3599 * take a look.
3601 spin_unlock_irq(&gcwq->lock);
3602 kthread_bind(gcwq->first_idle->task, cpu);
3603 spin_lock_irq(&gcwq->lock);
3604 gcwq->flags |= GCWQ_MANAGE_WORKERS;
3605 start_worker(gcwq->first_idle);
3606 gcwq->first_idle = NULL;
3607 break;
3610 spin_unlock_irqrestore(&gcwq->lock, flags);
3612 return notifier_from_errno(0);
3616 * Workqueues should be brought up before normal priority CPU notifiers.
3617 * This will be registered high priority CPU notifier.
3619 static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
3620 unsigned long action,
3621 void *hcpu)
3623 switch (action & ~CPU_TASKS_FROZEN) {
3624 case CPU_UP_PREPARE:
3625 case CPU_UP_CANCELED:
3626 case CPU_DOWN_FAILED:
3627 case CPU_ONLINE:
3628 return workqueue_cpu_callback(nfb, action, hcpu);
3630 return NOTIFY_OK;
3634 * Workqueues should be brought down after normal priority CPU notifiers.
3635 * This will be registered as low priority CPU notifier.
3637 static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
3638 unsigned long action,
3639 void *hcpu)
3641 switch (action & ~CPU_TASKS_FROZEN) {
3642 case CPU_DOWN_PREPARE:
3643 case CPU_DYING:
3644 case CPU_POST_DEAD:
3645 return workqueue_cpu_callback(nfb, action, hcpu);
3647 return NOTIFY_OK;
3650 #ifdef CONFIG_SMP
3652 struct work_for_cpu {
3653 struct work_struct work;
3654 long (*fn)(void *);
3655 void *arg;
3656 long ret;
3659 static void work_for_cpu_fn(struct work_struct *work)
3661 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3663 wfc->ret = wfc->fn(wfc->arg);
3667 * work_on_cpu - run a function in user context on a particular cpu
3668 * @cpu: the cpu to run on
3669 * @fn: the function to run
3670 * @arg: the function arg
3672 * This will return the value @fn returns.
3673 * It is up to the caller to ensure that the cpu doesn't go offline.
3674 * The caller must not hold any locks which would prevent @fn from completing.
3676 long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3678 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
3680 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3681 schedule_work_on(cpu, &wfc.work);
3682 flush_work(&wfc.work);
3683 return wfc.ret;
3685 EXPORT_SYMBOL_GPL(work_on_cpu);
3686 #endif /* CONFIG_SMP */
3688 #ifdef CONFIG_FREEZER
3691 * freeze_workqueues_begin - begin freezing workqueues
3693 * Start freezing workqueues. After this function returns, all freezable
3694 * workqueues will queue new works to their frozen_works list instead of
3695 * gcwq->worklist.
3697 * CONTEXT:
3698 * Grabs and releases workqueue_lock and gcwq->lock's.
3700 void freeze_workqueues_begin(void)
3702 unsigned int cpu;
3704 spin_lock(&workqueue_lock);
3706 BUG_ON(workqueue_freezing);
3707 workqueue_freezing = true;
3709 for_each_gcwq_cpu(cpu) {
3710 struct global_cwq *gcwq = get_gcwq(cpu);
3711 struct workqueue_struct *wq;
3713 spin_lock_irq(&gcwq->lock);
3715 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3716 gcwq->flags |= GCWQ_FREEZING;
3718 list_for_each_entry(wq, &workqueues, list) {
3719 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3721 if (cwq && wq->flags & WQ_FREEZABLE)
3722 cwq->max_active = 0;
3725 spin_unlock_irq(&gcwq->lock);
3728 spin_unlock(&workqueue_lock);
3732 * freeze_workqueues_busy - are freezable workqueues still busy?
3734 * Check whether freezing is complete. This function must be called
3735 * between freeze_workqueues_begin() and thaw_workqueues().
3737 * CONTEXT:
3738 * Grabs and releases workqueue_lock.
3740 * RETURNS:
3741 * %true if some freezable workqueues are still busy. %false if freezing
3742 * is complete.
3744 bool freeze_workqueues_busy(void)
3746 unsigned int cpu;
3747 bool busy = false;
3749 spin_lock(&workqueue_lock);
3751 BUG_ON(!workqueue_freezing);
3753 for_each_gcwq_cpu(cpu) {
3754 struct workqueue_struct *wq;
3756 * nr_active is monotonically decreasing. It's safe
3757 * to peek without lock.
3759 list_for_each_entry(wq, &workqueues, list) {
3760 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3762 if (!cwq || !(wq->flags & WQ_FREEZABLE))
3763 continue;
3765 BUG_ON(cwq->nr_active < 0);
3766 if (cwq->nr_active) {
3767 busy = true;
3768 goto out_unlock;
3772 out_unlock:
3773 spin_unlock(&workqueue_lock);
3774 return busy;
3778 * thaw_workqueues - thaw workqueues
3780 * Thaw workqueues. Normal queueing is restored and all collected
3781 * frozen works are transferred to their respective gcwq worklists.
3783 * CONTEXT:
3784 * Grabs and releases workqueue_lock and gcwq->lock's.
3786 void thaw_workqueues(void)
3788 unsigned int cpu;
3790 spin_lock(&workqueue_lock);
3792 if (!workqueue_freezing)
3793 goto out_unlock;
3795 for_each_gcwq_cpu(cpu) {
3796 struct global_cwq *gcwq = get_gcwq(cpu);
3797 struct workqueue_struct *wq;
3799 spin_lock_irq(&gcwq->lock);
3801 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3802 gcwq->flags &= ~GCWQ_FREEZING;
3804 list_for_each_entry(wq, &workqueues, list) {
3805 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3807 if (!cwq || !(wq->flags & WQ_FREEZABLE))
3808 continue;
3810 /* restore max_active and repopulate worklist */
3811 cwq->max_active = wq->saved_max_active;
3813 while (!list_empty(&cwq->delayed_works) &&
3814 cwq->nr_active < cwq->max_active)
3815 cwq_activate_first_delayed(cwq);
3818 wake_up_worker(gcwq);
3820 spin_unlock_irq(&gcwq->lock);
3823 workqueue_freezing = false;
3824 out_unlock:
3825 spin_unlock(&workqueue_lock);
3827 #endif /* CONFIG_FREEZER */
3829 static int __init init_workqueues(void)
3831 unsigned int cpu;
3832 int i;
3834 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3835 cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
3837 /* initialize gcwqs */
3838 for_each_gcwq_cpu(cpu) {
3839 struct global_cwq *gcwq = get_gcwq(cpu);
3841 spin_lock_init(&gcwq->lock);
3842 INIT_LIST_HEAD(&gcwq->worklist);
3843 gcwq->cpu = cpu;
3844 gcwq->flags |= GCWQ_DISASSOCIATED;
3846 INIT_LIST_HEAD(&gcwq->idle_list);
3847 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3848 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3850 init_timer_deferrable(&gcwq->idle_timer);
3851 gcwq->idle_timer.function = idle_worker_timeout;
3852 gcwq->idle_timer.data = (unsigned long)gcwq;
3854 setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3855 (unsigned long)gcwq);
3857 ida_init(&gcwq->worker_ida);
3859 gcwq->trustee_state = TRUSTEE_DONE;
3860 init_waitqueue_head(&gcwq->trustee_wait);
3863 /* create the initial worker */
3864 for_each_online_gcwq_cpu(cpu) {
3865 struct global_cwq *gcwq = get_gcwq(cpu);
3866 struct worker *worker;
3868 if (cpu != WORK_CPU_UNBOUND)
3869 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3870 worker = create_worker(gcwq, true);
3871 BUG_ON(!worker);
3872 spin_lock_irq(&gcwq->lock);
3873 start_worker(worker);
3874 spin_unlock_irq(&gcwq->lock);
3877 system_wq = alloc_workqueue("events", 0, 0);
3878 system_long_wq = alloc_workqueue("events_long", 0, 0);
3879 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3880 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3881 WQ_UNBOUND_MAX_ACTIVE);
3882 system_freezable_wq = alloc_workqueue("events_freezable",
3883 WQ_FREEZABLE, 0);
3884 system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
3885 WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
3886 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
3887 !system_unbound_wq || !system_freezable_wq ||
3888 !system_nrt_freezable_wq);
3889 return 0;
3891 early_initcall(init_workqueues);