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>
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"
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 */
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
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
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
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.
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.
124 /* on idle list while idle, on busy hash table while busy */
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
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.
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.
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))
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)
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 */
226 struct cpu_workqueue_struct __percpu *pcpu;
227 struct cpu_workqueue_struct *single;
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 #ifdef CONFIG_LOCKDEP
246 struct lockdep_map lockdep_map;
248 char name[]; /* I: workqueue name */
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,
274 if (cpu < nr_cpu_ids) {
276 cpu = cpumask_next(cpu, mask);
277 if (cpu < nr_cpu_ids)
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);
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;
338 case ODEBUG_STATE_ACTIVE:
339 cancel_work_sync(work);
340 debug_object_init(work, &work_debug_descr);
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;
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);
372 case ODEBUG_STATE_ACTIVE:
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;
389 case ODEBUG_STATE_ACTIVE:
390 cancel_work_sync(work);
391 debug_object_free(work, &work_debug_descr);
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)
419 debug_object_init_on_stack(work, &work_debug_descr);
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);
432 static inline void debug_work_activate(struct work_struct *work) { }
433 static inline void debug_work_deactivate(struct work_struct *work) { }
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);
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);
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 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
481 } else if (likely(cpu == WORK_CPU_UNBOUND))
482 return wq->cpu_wq.single;
486 static unsigned int work_color_to_flags(int color)
488 return color << WORK_STRUCT_COLOR_SHIFT;
491 static int get_work_color(struct work_struct *work)
493 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
494 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
497 static int work_next_color(int color)
499 return (color + 1) % WORK_NR_COLORS;
503 * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
504 * work is on queue. Once execution starts, WORK_STRUCT_CWQ is
505 * cleared and the work data contains the cpu number it was last on.
507 * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
508 * cwq, cpu or clear work->data. These functions should only be
509 * called while the work is owned - ie. while the PENDING bit is set.
511 * get_work_[g]cwq() can be used to obtain the gcwq or cwq
512 * corresponding to a work. gcwq is available once the work has been
513 * queued anywhere after initialization. cwq is available only from
514 * queueing until execution starts.
516 static inline void set_work_data(struct work_struct *work, unsigned long data,
519 BUG_ON(!work_pending(work));
520 atomic_long_set(&work->data, data | flags | work_static(work));
523 static void set_work_cwq(struct work_struct *work,
524 struct cpu_workqueue_struct *cwq,
525 unsigned long extra_flags)
527 set_work_data(work, (unsigned long)cwq,
528 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
531 static void set_work_cpu(struct work_struct *work, unsigned int cpu)
533 set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
536 static void clear_work_data(struct work_struct *work)
538 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
541 static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
543 unsigned long data = atomic_long_read(&work->data);
545 if (data & WORK_STRUCT_CWQ)
546 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
551 static struct global_cwq *get_work_gcwq(struct work_struct *work)
553 unsigned long data = atomic_long_read(&work->data);
556 if (data & WORK_STRUCT_CWQ)
557 return ((struct cpu_workqueue_struct *)
558 (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
560 cpu = data >> WORK_STRUCT_FLAG_BITS;
561 if (cpu == WORK_CPU_NONE)
564 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
565 return get_gcwq(cpu);
569 * Policy functions. These define the policies on how the global
570 * worker pool is managed. Unless noted otherwise, these functions
571 * assume that they're being called with gcwq->lock held.
574 static bool __need_more_worker(struct global_cwq *gcwq)
576 return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
577 gcwq->flags & GCWQ_HIGHPRI_PENDING;
581 * Need to wake up a worker? Called from anything but currently
584 static bool need_more_worker(struct global_cwq *gcwq)
586 return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
589 /* Can I start working? Called from busy but !running workers. */
590 static bool may_start_working(struct global_cwq *gcwq)
592 return gcwq->nr_idle;
595 /* Do I need to keep working? Called from currently running workers. */
596 static bool keep_working(struct global_cwq *gcwq)
598 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
600 return !list_empty(&gcwq->worklist) &&
601 (atomic_read(nr_running) <= 1 ||
602 gcwq->flags & GCWQ_HIGHPRI_PENDING);
605 /* Do we need a new worker? Called from manager. */
606 static bool need_to_create_worker(struct global_cwq *gcwq)
608 return need_more_worker(gcwq) && !may_start_working(gcwq);
611 /* Do I need to be the manager? */
612 static bool need_to_manage_workers(struct global_cwq *gcwq)
614 return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
617 /* Do we have too many workers and should some go away? */
618 static bool too_many_workers(struct global_cwq *gcwq)
620 bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
621 int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
622 int nr_busy = gcwq->nr_workers - nr_idle;
624 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
631 /* Return the first worker. Safe with preemption disabled */
632 static struct worker *first_worker(struct global_cwq *gcwq)
634 if (unlikely(list_empty(&gcwq->idle_list)))
637 return list_first_entry(&gcwq->idle_list, struct worker, entry);
641 * wake_up_worker - wake up an idle worker
642 * @gcwq: gcwq to wake worker for
644 * Wake up the first idle worker of @gcwq.
647 * spin_lock_irq(gcwq->lock).
649 static void wake_up_worker(struct global_cwq *gcwq)
651 struct worker *worker = first_worker(gcwq);
654 wake_up_process(worker->task);
658 * wq_worker_waking_up - a worker is waking up
659 * @task: task waking up
660 * @cpu: CPU @task is waking up to
662 * This function is called during try_to_wake_up() when a worker is
666 * spin_lock_irq(rq->lock)
668 void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
670 struct worker *worker = kthread_data(task);
672 if (!(worker->flags & WORKER_NOT_RUNNING))
673 atomic_inc(get_gcwq_nr_running(cpu));
677 * wq_worker_sleeping - a worker is going to sleep
678 * @task: task going to sleep
679 * @cpu: CPU in question, must be the current CPU number
681 * This function is called during schedule() when a busy worker is
682 * going to sleep. Worker on the same cpu can be woken up by
683 * returning pointer to its task.
686 * spin_lock_irq(rq->lock)
689 * Worker task on @cpu to wake up, %NULL if none.
691 struct task_struct *wq_worker_sleeping(struct task_struct *task,
694 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
695 struct global_cwq *gcwq = get_gcwq(cpu);
696 atomic_t *nr_running = get_gcwq_nr_running(cpu);
698 if (worker->flags & WORKER_NOT_RUNNING)
701 /* this can only happen on the local cpu */
702 BUG_ON(cpu != raw_smp_processor_id());
705 * The counterpart of the following dec_and_test, implied mb,
706 * worklist not empty test sequence is in insert_work().
707 * Please read comment there.
709 * NOT_RUNNING is clear. This means that trustee is not in
710 * charge and we're running on the local cpu w/ rq lock held
711 * and preemption disabled, which in turn means that none else
712 * could be manipulating idle_list, so dereferencing idle_list
713 * without gcwq lock is safe.
715 if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
716 to_wakeup = first_worker(gcwq);
717 return to_wakeup ? to_wakeup->task : NULL;
721 * worker_set_flags - set worker flags and adjust nr_running accordingly
723 * @flags: flags to set
724 * @wakeup: wakeup an idle worker if necessary
726 * Set @flags in @worker->flags and adjust nr_running accordingly. If
727 * nr_running becomes zero and @wakeup is %true, an idle worker is
731 * spin_lock_irq(gcwq->lock)
733 static inline void worker_set_flags(struct worker *worker, unsigned int flags,
736 struct global_cwq *gcwq = worker->gcwq;
738 WARN_ON_ONCE(worker->task != current);
741 * If transitioning into NOT_RUNNING, adjust nr_running and
742 * wake up an idle worker as necessary if requested by
745 if ((flags & WORKER_NOT_RUNNING) &&
746 !(worker->flags & WORKER_NOT_RUNNING)) {
747 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
750 if (atomic_dec_and_test(nr_running) &&
751 !list_empty(&gcwq->worklist))
752 wake_up_worker(gcwq);
754 atomic_dec(nr_running);
757 worker->flags |= flags;
761 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
763 * @flags: flags to clear
765 * Clear @flags in @worker->flags and adjust nr_running accordingly.
768 * spin_lock_irq(gcwq->lock)
770 static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
772 struct global_cwq *gcwq = worker->gcwq;
773 unsigned int oflags = worker->flags;
775 WARN_ON_ONCE(worker->task != current);
777 worker->flags &= ~flags;
780 * If transitioning out of NOT_RUNNING, increment nr_running. Note
781 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
782 * of multiple flags, not a single flag.
784 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
785 if (!(worker->flags & WORKER_NOT_RUNNING))
786 atomic_inc(get_gcwq_nr_running(gcwq->cpu));
790 * busy_worker_head - return the busy hash head for a work
791 * @gcwq: gcwq of interest
792 * @work: work to be hashed
794 * Return hash head of @gcwq for @work.
797 * spin_lock_irq(gcwq->lock).
800 * Pointer to the hash head.
802 static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
803 struct work_struct *work)
805 const int base_shift = ilog2(sizeof(struct work_struct));
806 unsigned long v = (unsigned long)work;
808 /* simple shift and fold hash, do we need something better? */
810 v += v >> BUSY_WORKER_HASH_ORDER;
811 v &= BUSY_WORKER_HASH_MASK;
813 return &gcwq->busy_hash[v];
817 * __find_worker_executing_work - find worker which is executing a work
818 * @gcwq: gcwq of interest
819 * @bwh: hash head as returned by busy_worker_head()
820 * @work: work to find worker for
822 * Find a worker which is executing @work on @gcwq. @bwh should be
823 * the hash head obtained by calling busy_worker_head() with the same
827 * spin_lock_irq(gcwq->lock).
830 * Pointer to worker which is executing @work if found, NULL
833 static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
834 struct hlist_head *bwh,
835 struct work_struct *work)
837 struct worker *worker;
838 struct hlist_node *tmp;
840 hlist_for_each_entry(worker, tmp, bwh, hentry)
841 if (worker->current_work == work)
847 * find_worker_executing_work - find worker which is executing a work
848 * @gcwq: gcwq of interest
849 * @work: work to find worker for
851 * Find a worker which is executing @work on @gcwq. This function is
852 * identical to __find_worker_executing_work() except that this
853 * function calculates @bwh itself.
856 * spin_lock_irq(gcwq->lock).
859 * Pointer to worker which is executing @work if found, NULL
862 static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
863 struct work_struct *work)
865 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
870 * gcwq_determine_ins_pos - find insertion position
871 * @gcwq: gcwq of interest
872 * @cwq: cwq a work is being queued for
874 * A work for @cwq is about to be queued on @gcwq, determine insertion
875 * position for the work. If @cwq is for HIGHPRI wq, the work is
876 * queued at the head of the queue but in FIFO order with respect to
877 * other HIGHPRI works; otherwise, at the end of the queue. This
878 * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
879 * there are HIGHPRI works pending.
882 * spin_lock_irq(gcwq->lock).
885 * Pointer to inserstion position.
887 static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
888 struct cpu_workqueue_struct *cwq)
890 struct work_struct *twork;
892 if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
893 return &gcwq->worklist;
895 list_for_each_entry(twork, &gcwq->worklist, entry) {
896 struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
898 if (!(tcwq->wq->flags & WQ_HIGHPRI))
902 gcwq->flags |= GCWQ_HIGHPRI_PENDING;
903 return &twork->entry;
907 * insert_work - insert a work into gcwq
908 * @cwq: cwq @work belongs to
909 * @work: work to insert
910 * @head: insertion point
911 * @extra_flags: extra WORK_STRUCT_* flags to set
913 * Insert @work which belongs to @cwq into @gcwq after @head.
914 * @extra_flags is or'd to work_struct flags.
917 * spin_lock_irq(gcwq->lock).
919 static void insert_work(struct cpu_workqueue_struct *cwq,
920 struct work_struct *work, struct list_head *head,
921 unsigned int extra_flags)
923 struct global_cwq *gcwq = cwq->gcwq;
925 /* we own @work, set data and link */
926 set_work_cwq(work, cwq, extra_flags);
929 * Ensure that we get the right work->data if we see the
930 * result of list_add() below, see try_to_grab_pending().
934 list_add_tail(&work->entry, head);
937 * Ensure either worker_sched_deactivated() sees the above
938 * list_add_tail() or we see zero nr_running to avoid workers
939 * lying around lazily while there are works to be processed.
943 if (__need_more_worker(gcwq))
944 wake_up_worker(gcwq);
948 * Test whether @work is being queued from another work executing on the
949 * same workqueue. This is rather expensive and should only be used from
952 static bool is_chained_work(struct workqueue_struct *wq)
957 for_each_gcwq_cpu(cpu) {
958 struct global_cwq *gcwq = get_gcwq(cpu);
959 struct worker *worker;
960 struct hlist_node *pos;
963 spin_lock_irqsave(&gcwq->lock, flags);
964 for_each_busy_worker(worker, i, pos, gcwq) {
965 if (worker->task != current)
967 spin_unlock_irqrestore(&gcwq->lock, flags);
969 * I'm @worker, no locking necessary. See if @work
970 * is headed to the same workqueue.
972 return worker->current_cwq->wq == wq;
974 spin_unlock_irqrestore(&gcwq->lock, flags);
979 static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
980 struct work_struct *work)
982 struct global_cwq *gcwq;
983 struct cpu_workqueue_struct *cwq;
984 struct list_head *worklist;
985 unsigned int work_flags;
988 debug_work_activate(work);
990 /* if dying, only works from the same workqueue are allowed */
991 if (unlikely(wq->flags & WQ_DRAINING) &&
992 WARN_ON_ONCE(!is_chained_work(wq)))
995 /* determine gcwq to use */
996 if (!(wq->flags & WQ_UNBOUND)) {
997 struct global_cwq *last_gcwq;
999 if (unlikely(cpu == WORK_CPU_UNBOUND))
1000 cpu = raw_smp_processor_id();
1003 * It's multi cpu. If @wq is non-reentrant and @work
1004 * was previously on a different cpu, it might still
1005 * be running there, in which case the work needs to
1006 * be queued on that cpu to guarantee non-reentrance.
1008 gcwq = get_gcwq(cpu);
1009 if (wq->flags & WQ_NON_REENTRANT &&
1010 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1011 struct worker *worker;
1013 spin_lock_irqsave(&last_gcwq->lock, flags);
1015 worker = find_worker_executing_work(last_gcwq, work);
1017 if (worker && worker->current_cwq->wq == wq)
1020 /* meh... not running there, queue here */
1021 spin_unlock_irqrestore(&last_gcwq->lock, flags);
1022 spin_lock_irqsave(&gcwq->lock, flags);
1025 spin_lock_irqsave(&gcwq->lock, flags);
1027 gcwq = get_gcwq(WORK_CPU_UNBOUND);
1028 spin_lock_irqsave(&gcwq->lock, flags);
1031 /* gcwq determined, get cwq and queue */
1032 cwq = get_cwq(gcwq->cpu, wq);
1033 trace_workqueue_queue_work(cpu, cwq, work);
1035 BUG_ON(!list_empty(&work->entry));
1037 cwq->nr_in_flight[cwq->work_color]++;
1038 work_flags = work_color_to_flags(cwq->work_color);
1040 if (likely(cwq->nr_active < cwq->max_active)) {
1041 trace_workqueue_activate_work(work);
1043 worklist = gcwq_determine_ins_pos(gcwq, cwq);
1045 work_flags |= WORK_STRUCT_DELAYED;
1046 worklist = &cwq->delayed_works;
1049 insert_work(cwq, work, worklist, work_flags);
1051 spin_unlock_irqrestore(&gcwq->lock, flags);
1055 * queue_work - queue work on a workqueue
1056 * @wq: workqueue to use
1057 * @work: work to queue
1059 * Returns 0 if @work was already on a queue, non-zero otherwise.
1061 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1062 * it can be processed by another CPU.
1064 int queue_work(struct workqueue_struct *wq, struct work_struct *work)
1068 ret = queue_work_on(get_cpu(), wq, work);
1073 EXPORT_SYMBOL_GPL(queue_work);
1076 * queue_work_on - queue work on specific cpu
1077 * @cpu: CPU number to execute work on
1078 * @wq: workqueue to use
1079 * @work: work to queue
1081 * Returns 0 if @work was already on a queue, non-zero otherwise.
1083 * We queue the work to a specific CPU, the caller must ensure it
1087 queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1091 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1092 __queue_work(cpu, wq, work);
1097 EXPORT_SYMBOL_GPL(queue_work_on);
1099 static void delayed_work_timer_fn(unsigned long __data)
1101 struct delayed_work *dwork = (struct delayed_work *)__data;
1102 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
1104 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
1108 * queue_delayed_work - queue work on a workqueue after delay
1109 * @wq: workqueue to use
1110 * @dwork: delayable work to queue
1111 * @delay: number of jiffies to wait before queueing
1113 * Returns 0 if @work was already on a queue, non-zero otherwise.
1115 int queue_delayed_work(struct workqueue_struct *wq,
1116 struct delayed_work *dwork, unsigned long delay)
1119 return queue_work(wq, &dwork->work);
1121 return queue_delayed_work_on(-1, wq, dwork, delay);
1123 EXPORT_SYMBOL_GPL(queue_delayed_work);
1126 * queue_delayed_work_on - queue work on specific CPU after delay
1127 * @cpu: CPU number to execute work on
1128 * @wq: workqueue to use
1129 * @dwork: work to queue
1130 * @delay: number of jiffies to wait before queueing
1132 * Returns 0 if @work was already on a queue, non-zero otherwise.
1134 int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1135 struct delayed_work *dwork, unsigned long delay)
1138 struct timer_list *timer = &dwork->timer;
1139 struct work_struct *work = &dwork->work;
1141 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1144 BUG_ON(timer_pending(timer));
1145 BUG_ON(!list_empty(&work->entry));
1147 timer_stats_timer_set_start_info(&dwork->timer);
1150 * This stores cwq for the moment, for the timer_fn.
1151 * Note that the work's gcwq is preserved to allow
1152 * reentrance detection for delayed works.
1154 if (!(wq->flags & WQ_UNBOUND)) {
1155 struct global_cwq *gcwq = get_work_gcwq(work);
1157 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1160 lcpu = raw_smp_processor_id();
1162 lcpu = WORK_CPU_UNBOUND;
1164 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1166 timer->expires = jiffies + delay;
1167 timer->data = (unsigned long)dwork;
1168 timer->function = delayed_work_timer_fn;
1170 if (unlikely(cpu >= 0))
1171 add_timer_on(timer, cpu);
1178 EXPORT_SYMBOL_GPL(queue_delayed_work_on);
1181 * worker_enter_idle - enter idle state
1182 * @worker: worker which is entering idle state
1184 * @worker is entering idle state. Update stats and idle timer if
1188 * spin_lock_irq(gcwq->lock).
1190 static void worker_enter_idle(struct worker *worker)
1192 struct global_cwq *gcwq = worker->gcwq;
1194 BUG_ON(worker->flags & WORKER_IDLE);
1195 BUG_ON(!list_empty(&worker->entry) &&
1196 (worker->hentry.next || worker->hentry.pprev));
1198 /* can't use worker_set_flags(), also called from start_worker() */
1199 worker->flags |= WORKER_IDLE;
1201 worker->last_active = jiffies;
1203 /* idle_list is LIFO */
1204 list_add(&worker->entry, &gcwq->idle_list);
1206 if (likely(!(worker->flags & WORKER_ROGUE))) {
1207 if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1208 mod_timer(&gcwq->idle_timer,
1209 jiffies + IDLE_WORKER_TIMEOUT);
1211 wake_up_all(&gcwq->trustee_wait);
1213 /* sanity check nr_running */
1214 WARN_ON_ONCE(gcwq->nr_workers == gcwq->nr_idle &&
1215 atomic_read(get_gcwq_nr_running(gcwq->cpu)));
1219 * worker_leave_idle - leave idle state
1220 * @worker: worker which is leaving idle state
1222 * @worker is leaving idle state. Update stats.
1225 * spin_lock_irq(gcwq->lock).
1227 static void worker_leave_idle(struct worker *worker)
1229 struct global_cwq *gcwq = worker->gcwq;
1231 BUG_ON(!(worker->flags & WORKER_IDLE));
1232 worker_clr_flags(worker, WORKER_IDLE);
1234 list_del_init(&worker->entry);
1238 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1241 * Works which are scheduled while the cpu is online must at least be
1242 * scheduled to a worker which is bound to the cpu so that if they are
1243 * flushed from cpu callbacks while cpu is going down, they are
1244 * guaranteed to execute on the cpu.
1246 * This function is to be used by rogue workers and rescuers to bind
1247 * themselves to the target cpu and may race with cpu going down or
1248 * coming online. kthread_bind() can't be used because it may put the
1249 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1250 * verbatim as it's best effort and blocking and gcwq may be
1251 * [dis]associated in the meantime.
1253 * This function tries set_cpus_allowed() and locks gcwq and verifies
1254 * the binding against GCWQ_DISASSOCIATED which is set during
1255 * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1256 * idle state or fetches works without dropping lock, it can guarantee
1257 * the scheduling requirement described in the first paragraph.
1260 * Might sleep. Called without any lock but returns with gcwq->lock
1264 * %true if the associated gcwq is online (@worker is successfully
1265 * bound), %false if offline.
1267 static bool worker_maybe_bind_and_lock(struct worker *worker)
1268 __acquires(&gcwq->lock)
1270 struct global_cwq *gcwq = worker->gcwq;
1271 struct task_struct *task = worker->task;
1275 * The following call may fail, succeed or succeed
1276 * without actually migrating the task to the cpu if
1277 * it races with cpu hotunplug operation. Verify
1278 * against GCWQ_DISASSOCIATED.
1280 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1281 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1283 spin_lock_irq(&gcwq->lock);
1284 if (gcwq->flags & GCWQ_DISASSOCIATED)
1286 if (task_cpu(task) == gcwq->cpu &&
1287 cpumask_equal(¤t->cpus_allowed,
1288 get_cpu_mask(gcwq->cpu)))
1290 spin_unlock_irq(&gcwq->lock);
1293 * We've raced with CPU hot[un]plug. Give it a breather
1294 * and retry migration. cond_resched() is required here;
1295 * otherwise, we might deadlock against cpu_stop trying to
1296 * bring down the CPU on non-preemptive kernel.
1304 * Function for worker->rebind_work used to rebind rogue busy workers
1305 * to the associated cpu which is coming back online. This is
1306 * scheduled by cpu up but can race with other cpu hotplug operations
1307 * and may be executed twice without intervening cpu down.
1309 static void worker_rebind_fn(struct work_struct *work)
1311 struct worker *worker = container_of(work, struct worker, rebind_work);
1312 struct global_cwq *gcwq = worker->gcwq;
1314 if (worker_maybe_bind_and_lock(worker))
1315 worker_clr_flags(worker, WORKER_REBIND);
1317 spin_unlock_irq(&gcwq->lock);
1320 static struct worker *alloc_worker(void)
1322 struct worker *worker;
1324 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1326 INIT_LIST_HEAD(&worker->entry);
1327 INIT_LIST_HEAD(&worker->scheduled);
1328 INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1329 /* on creation a worker is in !idle && prep state */
1330 worker->flags = WORKER_PREP;
1336 * create_worker - create a new workqueue worker
1337 * @gcwq: gcwq the new worker will belong to
1338 * @bind: whether to set affinity to @cpu or not
1340 * Create a new worker which is bound to @gcwq. The returned worker
1341 * can be started by calling start_worker() or destroyed using
1345 * Might sleep. Does GFP_KERNEL allocations.
1348 * Pointer to the newly created worker.
1350 static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
1352 bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
1353 struct worker *worker = NULL;
1356 spin_lock_irq(&gcwq->lock);
1357 while (ida_get_new(&gcwq->worker_ida, &id)) {
1358 spin_unlock_irq(&gcwq->lock);
1359 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
1361 spin_lock_irq(&gcwq->lock);
1363 spin_unlock_irq(&gcwq->lock);
1365 worker = alloc_worker();
1369 worker->gcwq = gcwq;
1372 if (!on_unbound_cpu)
1373 worker->task = kthread_create_on_node(worker_thread,
1375 cpu_to_node(gcwq->cpu),
1376 "kworker/%u:%d", gcwq->cpu, id);
1378 worker->task = kthread_create(worker_thread, worker,
1379 "kworker/u:%d", id);
1380 if (IS_ERR(worker->task))
1384 * A rogue worker will become a regular one if CPU comes
1385 * online later on. Make sure every worker has
1386 * PF_THREAD_BOUND set.
1388 if (bind && !on_unbound_cpu)
1389 kthread_bind(worker->task, gcwq->cpu);
1391 worker->task->flags |= PF_THREAD_BOUND;
1393 worker->flags |= WORKER_UNBOUND;
1399 spin_lock_irq(&gcwq->lock);
1400 ida_remove(&gcwq->worker_ida, id);
1401 spin_unlock_irq(&gcwq->lock);
1408 * start_worker - start a newly created worker
1409 * @worker: worker to start
1411 * Make the gcwq aware of @worker and start it.
1414 * spin_lock_irq(gcwq->lock).
1416 static void start_worker(struct worker *worker)
1418 worker->flags |= WORKER_STARTED;
1419 worker->gcwq->nr_workers++;
1420 worker_enter_idle(worker);
1421 wake_up_process(worker->task);
1425 * destroy_worker - destroy a workqueue worker
1426 * @worker: worker to be destroyed
1428 * Destroy @worker and adjust @gcwq stats accordingly.
1431 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1433 static void destroy_worker(struct worker *worker)
1435 struct global_cwq *gcwq = worker->gcwq;
1436 int id = worker->id;
1438 /* sanity check frenzy */
1439 BUG_ON(worker->current_work);
1440 BUG_ON(!list_empty(&worker->scheduled));
1442 if (worker->flags & WORKER_STARTED)
1444 if (worker->flags & WORKER_IDLE)
1447 list_del_init(&worker->entry);
1448 worker->flags |= WORKER_DIE;
1450 spin_unlock_irq(&gcwq->lock);
1452 kthread_stop(worker->task);
1455 spin_lock_irq(&gcwq->lock);
1456 ida_remove(&gcwq->worker_ida, id);
1459 static void idle_worker_timeout(unsigned long __gcwq)
1461 struct global_cwq *gcwq = (void *)__gcwq;
1463 spin_lock_irq(&gcwq->lock);
1465 if (too_many_workers(gcwq)) {
1466 struct worker *worker;
1467 unsigned long expires;
1469 /* idle_list is kept in LIFO order, check the last one */
1470 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1471 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1473 if (time_before(jiffies, expires))
1474 mod_timer(&gcwq->idle_timer, expires);
1476 /* it's been idle for too long, wake up manager */
1477 gcwq->flags |= GCWQ_MANAGE_WORKERS;
1478 wake_up_worker(gcwq);
1482 spin_unlock_irq(&gcwq->lock);
1485 static bool send_mayday(struct work_struct *work)
1487 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1488 struct workqueue_struct *wq = cwq->wq;
1491 if (!(wq->flags & WQ_RESCUER))
1494 /* mayday mayday mayday */
1495 cpu = cwq->gcwq->cpu;
1496 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1497 if (cpu == WORK_CPU_UNBOUND)
1499 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1500 wake_up_process(wq->rescuer->task);
1504 static void gcwq_mayday_timeout(unsigned long __gcwq)
1506 struct global_cwq *gcwq = (void *)__gcwq;
1507 struct work_struct *work;
1509 spin_lock_irq(&gcwq->lock);
1511 if (need_to_create_worker(gcwq)) {
1513 * We've been trying to create a new worker but
1514 * haven't been successful. We might be hitting an
1515 * allocation deadlock. Send distress signals to
1518 list_for_each_entry(work, &gcwq->worklist, entry)
1522 spin_unlock_irq(&gcwq->lock);
1524 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1528 * maybe_create_worker - create a new worker if necessary
1529 * @gcwq: gcwq to create a new worker for
1531 * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to
1532 * have at least one idle worker on return from this function. If
1533 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1534 * sent to all rescuers with works scheduled on @gcwq to resolve
1535 * possible allocation deadlock.
1537 * On return, need_to_create_worker() is guaranteed to be false and
1538 * may_start_working() true.
1541 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1542 * multiple times. Does GFP_KERNEL allocations. Called only from
1546 * false if no action was taken and gcwq->lock stayed locked, true
1549 static bool maybe_create_worker(struct global_cwq *gcwq)
1550 __releases(&gcwq->lock)
1551 __acquires(&gcwq->lock)
1553 if (!need_to_create_worker(gcwq))
1556 spin_unlock_irq(&gcwq->lock);
1558 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1559 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1562 struct worker *worker;
1564 worker = create_worker(gcwq, true);
1566 del_timer_sync(&gcwq->mayday_timer);
1567 spin_lock_irq(&gcwq->lock);
1568 start_worker(worker);
1569 BUG_ON(need_to_create_worker(gcwq));
1573 if (!need_to_create_worker(gcwq))
1576 __set_current_state(TASK_INTERRUPTIBLE);
1577 schedule_timeout(CREATE_COOLDOWN);
1579 if (!need_to_create_worker(gcwq))
1583 del_timer_sync(&gcwq->mayday_timer);
1584 spin_lock_irq(&gcwq->lock);
1585 if (need_to_create_worker(gcwq))
1591 * maybe_destroy_worker - destroy workers which have been idle for a while
1592 * @gcwq: gcwq to destroy workers for
1594 * Destroy @gcwq workers which have been idle for longer than
1595 * IDLE_WORKER_TIMEOUT.
1598 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1599 * multiple times. Called only from manager.
1602 * false if no action was taken and gcwq->lock stayed locked, true
1605 static bool maybe_destroy_workers(struct global_cwq *gcwq)
1609 while (too_many_workers(gcwq)) {
1610 struct worker *worker;
1611 unsigned long expires;
1613 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1614 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1616 if (time_before(jiffies, expires)) {
1617 mod_timer(&gcwq->idle_timer, expires);
1621 destroy_worker(worker);
1629 * manage_workers - manage worker pool
1632 * Assume the manager role and manage gcwq worker pool @worker belongs
1633 * to. At any given time, there can be only zero or one manager per
1634 * gcwq. The exclusion is handled automatically by this function.
1636 * The caller can safely start processing works on false return. On
1637 * true return, it's guaranteed that need_to_create_worker() is false
1638 * and may_start_working() is true.
1641 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1642 * multiple times. Does GFP_KERNEL allocations.
1645 * false if no action was taken and gcwq->lock stayed locked, true if
1646 * some action was taken.
1648 static bool manage_workers(struct worker *worker)
1650 struct global_cwq *gcwq = worker->gcwq;
1653 if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1656 gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1657 gcwq->flags |= GCWQ_MANAGING_WORKERS;
1660 * Destroy and then create so that may_start_working() is true
1663 ret |= maybe_destroy_workers(gcwq);
1664 ret |= maybe_create_worker(gcwq);
1666 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1669 * The trustee might be waiting to take over the manager
1670 * position, tell it we're done.
1672 if (unlikely(gcwq->trustee))
1673 wake_up_all(&gcwq->trustee_wait);
1679 * move_linked_works - move linked works to a list
1680 * @work: start of series of works to be scheduled
1681 * @head: target list to append @work to
1682 * @nextp: out paramter for nested worklist walking
1684 * Schedule linked works starting from @work to @head. Work series to
1685 * be scheduled starts at @work and includes any consecutive work with
1686 * WORK_STRUCT_LINKED set in its predecessor.
1688 * If @nextp is not NULL, it's updated to point to the next work of
1689 * the last scheduled work. This allows move_linked_works() to be
1690 * nested inside outer list_for_each_entry_safe().
1693 * spin_lock_irq(gcwq->lock).
1695 static void move_linked_works(struct work_struct *work, struct list_head *head,
1696 struct work_struct **nextp)
1698 struct work_struct *n;
1701 * Linked worklist will always end before the end of the list,
1702 * use NULL for list head.
1704 list_for_each_entry_safe_from(work, n, NULL, entry) {
1705 list_move_tail(&work->entry, head);
1706 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1711 * If we're already inside safe list traversal and have moved
1712 * multiple works to the scheduled queue, the next position
1713 * needs to be updated.
1719 static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
1721 struct work_struct *work = list_first_entry(&cwq->delayed_works,
1722 struct work_struct, entry);
1723 struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
1725 trace_workqueue_activate_work(work);
1726 move_linked_works(work, pos, NULL);
1727 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1732 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1733 * @cwq: cwq of interest
1734 * @color: color of work which left the queue
1735 * @delayed: for a delayed work
1737 * A work either has completed or is removed from pending queue,
1738 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1741 * spin_lock_irq(gcwq->lock).
1743 static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1746 /* ignore uncolored works */
1747 if (color == WORK_NO_COLOR)
1750 cwq->nr_in_flight[color]--;
1754 if (!list_empty(&cwq->delayed_works)) {
1755 /* one down, submit a delayed one */
1756 if (cwq->nr_active < cwq->max_active)
1757 cwq_activate_first_delayed(cwq);
1761 /* is flush in progress and are we at the flushing tip? */
1762 if (likely(cwq->flush_color != color))
1765 /* are there still in-flight works? */
1766 if (cwq->nr_in_flight[color])
1769 /* this cwq is done, clear flush_color */
1770 cwq->flush_color = -1;
1773 * If this was the last cwq, wake up the first flusher. It
1774 * will handle the rest.
1776 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1777 complete(&cwq->wq->first_flusher->done);
1781 * process_one_work - process single work
1783 * @work: work to process
1785 * Process @work. This function contains all the logics necessary to
1786 * process a single work including synchronization against and
1787 * interaction with other workers on the same cpu, queueing and
1788 * flushing. As long as context requirement is met, any worker can
1789 * call this function to process a work.
1792 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1794 static void process_one_work(struct worker *worker, struct work_struct *work)
1795 __releases(&gcwq->lock)
1796 __acquires(&gcwq->lock)
1798 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1799 struct global_cwq *gcwq = cwq->gcwq;
1800 struct hlist_head *bwh = busy_worker_head(gcwq, work);
1801 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
1802 work_func_t f = work->func;
1804 struct worker *collision;
1805 #ifdef CONFIG_LOCKDEP
1807 * It is permissible to free the struct work_struct from
1808 * inside the function that is called from it, this we need to
1809 * take into account for lockdep too. To avoid bogus "held
1810 * lock freed" warnings as well as problems when looking into
1811 * work->lockdep_map, make a copy and use that here.
1813 struct lockdep_map lockdep_map = work->lockdep_map;
1816 * A single work shouldn't be executed concurrently by
1817 * multiple workers on a single cpu. Check whether anyone is
1818 * already processing the work. If so, defer the work to the
1819 * currently executing one.
1821 collision = __find_worker_executing_work(gcwq, bwh, work);
1822 if (unlikely(collision)) {
1823 move_linked_works(work, &collision->scheduled, NULL);
1827 /* claim and process */
1828 debug_work_deactivate(work);
1829 hlist_add_head(&worker->hentry, bwh);
1830 worker->current_work = work;
1831 worker->current_cwq = cwq;
1832 work_color = get_work_color(work);
1834 /* record the current cpu number in the work data and dequeue */
1835 set_work_cpu(work, gcwq->cpu);
1836 list_del_init(&work->entry);
1839 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1840 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1842 if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1843 struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1844 struct work_struct, entry);
1846 if (!list_empty(&gcwq->worklist) &&
1847 get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1848 wake_up_worker(gcwq);
1850 gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1854 * CPU intensive works don't participate in concurrency
1855 * management. They're the scheduler's responsibility.
1857 if (unlikely(cpu_intensive))
1858 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1860 spin_unlock_irq(&gcwq->lock);
1862 work_clear_pending(work);
1863 lock_map_acquire_read(&cwq->wq->lockdep_map);
1864 lock_map_acquire(&lockdep_map);
1865 trace_workqueue_execute_start(work);
1868 * While we must be careful to not use "work" after this, the trace
1869 * point will only record its address.
1871 trace_workqueue_execute_end(work);
1872 lock_map_release(&lockdep_map);
1873 lock_map_release(&cwq->wq->lockdep_map);
1875 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1876 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1878 current->comm, preempt_count(), task_pid_nr(current));
1879 printk(KERN_ERR " last function: ");
1880 print_symbol("%s\n", (unsigned long)f);
1881 debug_show_held_locks(current);
1885 spin_lock_irq(&gcwq->lock);
1887 /* clear cpu intensive status */
1888 if (unlikely(cpu_intensive))
1889 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1891 /* we're done with it, release */
1892 hlist_del_init(&worker->hentry);
1893 worker->current_work = NULL;
1894 worker->current_cwq = NULL;
1895 cwq_dec_nr_in_flight(cwq, work_color, false);
1899 * process_scheduled_works - process scheduled works
1902 * Process all scheduled works. Please note that the scheduled list
1903 * may change while processing a work, so this function repeatedly
1904 * fetches a work from the top and executes it.
1907 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1910 static void process_scheduled_works(struct worker *worker)
1912 while (!list_empty(&worker->scheduled)) {
1913 struct work_struct *work = list_first_entry(&worker->scheduled,
1914 struct work_struct, entry);
1915 process_one_work(worker, work);
1920 * worker_thread - the worker thread function
1923 * The gcwq worker thread function. There's a single dynamic pool of
1924 * these per each cpu. These workers process all works regardless of
1925 * their specific target workqueue. The only exception is works which
1926 * belong to workqueues with a rescuer which will be explained in
1929 static int worker_thread(void *__worker)
1931 struct worker *worker = __worker;
1932 struct global_cwq *gcwq = worker->gcwq;
1934 /* tell the scheduler that this is a workqueue worker */
1935 worker->task->flags |= PF_WQ_WORKER;
1937 spin_lock_irq(&gcwq->lock);
1939 /* DIE can be set only while we're idle, checking here is enough */
1940 if (worker->flags & WORKER_DIE) {
1941 spin_unlock_irq(&gcwq->lock);
1942 worker->task->flags &= ~PF_WQ_WORKER;
1946 worker_leave_idle(worker);
1948 /* no more worker necessary? */
1949 if (!need_more_worker(gcwq))
1952 /* do we need to manage? */
1953 if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1957 * ->scheduled list can only be filled while a worker is
1958 * preparing to process a work or actually processing it.
1959 * Make sure nobody diddled with it while I was sleeping.
1961 BUG_ON(!list_empty(&worker->scheduled));
1964 * When control reaches this point, we're guaranteed to have
1965 * at least one idle worker or that someone else has already
1966 * assumed the manager role.
1968 worker_clr_flags(worker, WORKER_PREP);
1971 struct work_struct *work =
1972 list_first_entry(&gcwq->worklist,
1973 struct work_struct, entry);
1975 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1976 /* optimization path, not strictly necessary */
1977 process_one_work(worker, work);
1978 if (unlikely(!list_empty(&worker->scheduled)))
1979 process_scheduled_works(worker);
1981 move_linked_works(work, &worker->scheduled, NULL);
1982 process_scheduled_works(worker);
1984 } while (keep_working(gcwq));
1986 worker_set_flags(worker, WORKER_PREP, false);
1988 if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
1992 * gcwq->lock is held and there's no work to process and no
1993 * need to manage, sleep. Workers are woken up only while
1994 * holding gcwq->lock or from local cpu, so setting the
1995 * current state before releasing gcwq->lock is enough to
1996 * prevent losing any event.
1998 worker_enter_idle(worker);
1999 __set_current_state(TASK_INTERRUPTIBLE);
2000 spin_unlock_irq(&gcwq->lock);
2006 * rescuer_thread - the rescuer thread function
2007 * @__wq: the associated workqueue
2009 * Workqueue rescuer thread function. There's one rescuer for each
2010 * workqueue which has WQ_RESCUER set.
2012 * Regular work processing on a gcwq may block trying to create a new
2013 * worker which uses GFP_KERNEL allocation which has slight chance of
2014 * developing into deadlock if some works currently on the same queue
2015 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2016 * the problem rescuer solves.
2018 * When such condition is possible, the gcwq summons rescuers of all
2019 * workqueues which have works queued on the gcwq and let them process
2020 * those works so that forward progress can be guaranteed.
2022 * This should happen rarely.
2024 static int rescuer_thread(void *__wq)
2026 struct workqueue_struct *wq = __wq;
2027 struct worker *rescuer = wq->rescuer;
2028 struct list_head *scheduled = &rescuer->scheduled;
2029 bool is_unbound = wq->flags & WQ_UNBOUND;
2032 set_user_nice(current, RESCUER_NICE_LEVEL);
2034 set_current_state(TASK_INTERRUPTIBLE);
2036 if (kthread_should_stop())
2040 * See whether any cpu is asking for help. Unbounded
2041 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2043 for_each_mayday_cpu(cpu, wq->mayday_mask) {
2044 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2045 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2046 struct global_cwq *gcwq = cwq->gcwq;
2047 struct work_struct *work, *n;
2049 __set_current_state(TASK_RUNNING);
2050 mayday_clear_cpu(cpu, wq->mayday_mask);
2052 /* migrate to the target cpu if possible */
2053 rescuer->gcwq = gcwq;
2054 worker_maybe_bind_and_lock(rescuer);
2057 * Slurp in all works issued via this workqueue and
2060 BUG_ON(!list_empty(&rescuer->scheduled));
2061 list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
2062 if (get_work_cwq(work) == cwq)
2063 move_linked_works(work, scheduled, &n);
2065 process_scheduled_works(rescuer);
2068 * Leave this gcwq. If keep_working() is %true, notify a
2069 * regular worker; otherwise, we end up with 0 concurrency
2070 * and stalling the execution.
2072 if (keep_working(gcwq))
2073 wake_up_worker(gcwq);
2075 spin_unlock_irq(&gcwq->lock);
2083 struct work_struct work;
2084 struct completion done;
2087 static void wq_barrier_func(struct work_struct *work)
2089 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2090 complete(&barr->done);
2094 * insert_wq_barrier - insert a barrier work
2095 * @cwq: cwq to insert barrier into
2096 * @barr: wq_barrier to insert
2097 * @target: target work to attach @barr to
2098 * @worker: worker currently executing @target, NULL if @target is not executing
2100 * @barr is linked to @target such that @barr is completed only after
2101 * @target finishes execution. Please note that the ordering
2102 * guarantee is observed only with respect to @target and on the local
2105 * Currently, a queued barrier can't be canceled. This is because
2106 * try_to_grab_pending() can't determine whether the work to be
2107 * grabbed is at the head of the queue and thus can't clear LINKED
2108 * flag of the previous work while there must be a valid next work
2109 * after a work with LINKED flag set.
2111 * Note that when @worker is non-NULL, @target may be modified
2112 * underneath us, so we can't reliably determine cwq from @target.
2115 * spin_lock_irq(gcwq->lock).
2117 static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2118 struct wq_barrier *barr,
2119 struct work_struct *target, struct worker *worker)
2121 struct list_head *head;
2122 unsigned int linked = 0;
2125 * debugobject calls are safe here even with gcwq->lock locked
2126 * as we know for sure that this will not trigger any of the
2127 * checks and call back into the fixup functions where we
2130 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
2131 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2132 init_completion(&barr->done);
2135 * If @target is currently being executed, schedule the
2136 * barrier to the worker; otherwise, put it after @target.
2139 head = worker->scheduled.next;
2141 unsigned long *bits = work_data_bits(target);
2143 head = target->entry.next;
2144 /* there can already be other linked works, inherit and set */
2145 linked = *bits & WORK_STRUCT_LINKED;
2146 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2149 debug_work_activate(&barr->work);
2150 insert_work(cwq, &barr->work, head,
2151 work_color_to_flags(WORK_NO_COLOR) | linked);
2155 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2156 * @wq: workqueue being flushed
2157 * @flush_color: new flush color, < 0 for no-op
2158 * @work_color: new work color, < 0 for no-op
2160 * Prepare cwqs for workqueue flushing.
2162 * If @flush_color is non-negative, flush_color on all cwqs should be
2163 * -1. If no cwq has in-flight commands at the specified color, all
2164 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2165 * has in flight commands, its cwq->flush_color is set to
2166 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2167 * wakeup logic is armed and %true is returned.
2169 * The caller should have initialized @wq->first_flusher prior to
2170 * calling this function with non-negative @flush_color. If
2171 * @flush_color is negative, no flush color update is done and %false
2174 * If @work_color is non-negative, all cwqs should have the same
2175 * work_color which is previous to @work_color and all will be
2176 * advanced to @work_color.
2179 * mutex_lock(wq->flush_mutex).
2182 * %true if @flush_color >= 0 and there's something to flush. %false
2185 static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2186 int flush_color, int work_color)
2191 if (flush_color >= 0) {
2192 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2193 atomic_set(&wq->nr_cwqs_to_flush, 1);
2196 for_each_cwq_cpu(cpu, wq) {
2197 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2198 struct global_cwq *gcwq = cwq->gcwq;
2200 spin_lock_irq(&gcwq->lock);
2202 if (flush_color >= 0) {
2203 BUG_ON(cwq->flush_color != -1);
2205 if (cwq->nr_in_flight[flush_color]) {
2206 cwq->flush_color = flush_color;
2207 atomic_inc(&wq->nr_cwqs_to_flush);
2212 if (work_color >= 0) {
2213 BUG_ON(work_color != work_next_color(cwq->work_color));
2214 cwq->work_color = work_color;
2217 spin_unlock_irq(&gcwq->lock);
2220 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2221 complete(&wq->first_flusher->done);
2227 * flush_workqueue - ensure that any scheduled work has run to completion.
2228 * @wq: workqueue to flush
2230 * Forces execution of the workqueue and blocks until its completion.
2231 * This is typically used in driver shutdown handlers.
2233 * We sleep until all works which were queued on entry have been handled,
2234 * but we are not livelocked by new incoming ones.
2236 void flush_workqueue(struct workqueue_struct *wq)
2238 struct wq_flusher this_flusher = {
2239 .list = LIST_HEAD_INIT(this_flusher.list),
2241 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2245 lock_map_acquire(&wq->lockdep_map);
2246 lock_map_release(&wq->lockdep_map);
2248 mutex_lock(&wq->flush_mutex);
2251 * Start-to-wait phase
2253 next_color = work_next_color(wq->work_color);
2255 if (next_color != wq->flush_color) {
2257 * Color space is not full. The current work_color
2258 * becomes our flush_color and work_color is advanced
2261 BUG_ON(!list_empty(&wq->flusher_overflow));
2262 this_flusher.flush_color = wq->work_color;
2263 wq->work_color = next_color;
2265 if (!wq->first_flusher) {
2266 /* no flush in progress, become the first flusher */
2267 BUG_ON(wq->flush_color != this_flusher.flush_color);
2269 wq->first_flusher = &this_flusher;
2271 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2273 /* nothing to flush, done */
2274 wq->flush_color = next_color;
2275 wq->first_flusher = NULL;
2280 BUG_ON(wq->flush_color == this_flusher.flush_color);
2281 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2282 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2286 * Oops, color space is full, wait on overflow queue.
2287 * The next flush completion will assign us
2288 * flush_color and transfer to flusher_queue.
2290 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2293 mutex_unlock(&wq->flush_mutex);
2295 wait_for_completion(&this_flusher.done);
2298 * Wake-up-and-cascade phase
2300 * First flushers are responsible for cascading flushes and
2301 * handling overflow. Non-first flushers can simply return.
2303 if (wq->first_flusher != &this_flusher)
2306 mutex_lock(&wq->flush_mutex);
2308 /* we might have raced, check again with mutex held */
2309 if (wq->first_flusher != &this_flusher)
2312 wq->first_flusher = NULL;
2314 BUG_ON(!list_empty(&this_flusher.list));
2315 BUG_ON(wq->flush_color != this_flusher.flush_color);
2318 struct wq_flusher *next, *tmp;
2320 /* complete all the flushers sharing the current flush color */
2321 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2322 if (next->flush_color != wq->flush_color)
2324 list_del_init(&next->list);
2325 complete(&next->done);
2328 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2329 wq->flush_color != work_next_color(wq->work_color));
2331 /* this flush_color is finished, advance by one */
2332 wq->flush_color = work_next_color(wq->flush_color);
2334 /* one color has been freed, handle overflow queue */
2335 if (!list_empty(&wq->flusher_overflow)) {
2337 * Assign the same color to all overflowed
2338 * flushers, advance work_color and append to
2339 * flusher_queue. This is the start-to-wait
2340 * phase for these overflowed flushers.
2342 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2343 tmp->flush_color = wq->work_color;
2345 wq->work_color = work_next_color(wq->work_color);
2347 list_splice_tail_init(&wq->flusher_overflow,
2348 &wq->flusher_queue);
2349 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2352 if (list_empty(&wq->flusher_queue)) {
2353 BUG_ON(wq->flush_color != wq->work_color);
2358 * Need to flush more colors. Make the next flusher
2359 * the new first flusher and arm cwqs.
2361 BUG_ON(wq->flush_color == wq->work_color);
2362 BUG_ON(wq->flush_color != next->flush_color);
2364 list_del_init(&next->list);
2365 wq->first_flusher = next;
2367 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2371 * Meh... this color is already done, clear first
2372 * flusher and repeat cascading.
2374 wq->first_flusher = NULL;
2378 mutex_unlock(&wq->flush_mutex);
2380 EXPORT_SYMBOL_GPL(flush_workqueue);
2383 * drain_workqueue - drain a workqueue
2384 * @wq: workqueue to drain
2386 * Wait until the workqueue becomes empty. While draining is in progress,
2387 * only chain queueing is allowed. IOW, only currently pending or running
2388 * work items on @wq can queue further work items on it. @wq is flushed
2389 * repeatedly until it becomes empty. The number of flushing is detemined
2390 * by the depth of chaining and should be relatively short. Whine if it
2393 void drain_workqueue(struct workqueue_struct *wq)
2395 unsigned int flush_cnt = 0;
2399 * __queue_work() needs to test whether there are drainers, is much
2400 * hotter than drain_workqueue() and already looks at @wq->flags.
2401 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2403 spin_lock(&workqueue_lock);
2404 if (!wq->nr_drainers++)
2405 wq->flags |= WQ_DRAINING;
2406 spin_unlock(&workqueue_lock);
2408 flush_workqueue(wq);
2410 for_each_cwq_cpu(cpu, wq) {
2411 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2414 spin_lock_irq(&cwq->gcwq->lock);
2415 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2416 spin_unlock_irq(&cwq->gcwq->lock);
2421 if (++flush_cnt == 10 ||
2422 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2423 pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
2424 wq->name, flush_cnt);
2428 spin_lock(&workqueue_lock);
2429 if (!--wq->nr_drainers)
2430 wq->flags &= ~WQ_DRAINING;
2431 spin_unlock(&workqueue_lock);
2433 EXPORT_SYMBOL_GPL(drain_workqueue);
2435 static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2436 bool wait_executing)
2438 struct worker *worker = NULL;
2439 struct global_cwq *gcwq;
2440 struct cpu_workqueue_struct *cwq;
2443 gcwq = get_work_gcwq(work);
2447 spin_lock_irq(&gcwq->lock);
2448 if (!list_empty(&work->entry)) {
2450 * See the comment near try_to_grab_pending()->smp_rmb().
2451 * If it was re-queued to a different gcwq under us, we
2452 * are not going to wait.
2455 cwq = get_work_cwq(work);
2456 if (unlikely(!cwq || gcwq != cwq->gcwq))
2458 } else if (wait_executing) {
2459 worker = find_worker_executing_work(gcwq, work);
2462 cwq = worker->current_cwq;
2466 insert_wq_barrier(cwq, barr, work, worker);
2467 spin_unlock_irq(&gcwq->lock);
2470 * If @max_active is 1 or rescuer is in use, flushing another work
2471 * item on the same workqueue may lead to deadlock. Make sure the
2472 * flusher is not running on the same workqueue by verifying write
2475 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2476 lock_map_acquire(&cwq->wq->lockdep_map);
2478 lock_map_acquire_read(&cwq->wq->lockdep_map);
2479 lock_map_release(&cwq->wq->lockdep_map);
2483 spin_unlock_irq(&gcwq->lock);
2488 * flush_work - wait for a work to finish executing the last queueing instance
2489 * @work: the work to flush
2491 * Wait until @work has finished execution. This function considers
2492 * only the last queueing instance of @work. If @work has been
2493 * enqueued across different CPUs on a non-reentrant workqueue or on
2494 * multiple workqueues, @work might still be executing on return on
2495 * some of the CPUs from earlier queueing.
2497 * If @work was queued only on a non-reentrant, ordered or unbound
2498 * workqueue, @work is guaranteed to be idle on return if it hasn't
2499 * been requeued since flush started.
2502 * %true if flush_work() waited for the work to finish execution,
2503 * %false if it was already idle.
2505 bool flush_work(struct work_struct *work)
2507 struct wq_barrier barr;
2509 if (start_flush_work(work, &barr, true)) {
2510 wait_for_completion(&barr.done);
2511 destroy_work_on_stack(&barr.work);
2516 EXPORT_SYMBOL_GPL(flush_work);
2518 static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2520 struct wq_barrier barr;
2521 struct worker *worker;
2523 spin_lock_irq(&gcwq->lock);
2525 worker = find_worker_executing_work(gcwq, work);
2526 if (unlikely(worker))
2527 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2529 spin_unlock_irq(&gcwq->lock);
2531 if (unlikely(worker)) {
2532 wait_for_completion(&barr.done);
2533 destroy_work_on_stack(&barr.work);
2539 static bool wait_on_work(struct work_struct *work)
2546 lock_map_acquire(&work->lockdep_map);
2547 lock_map_release(&work->lockdep_map);
2549 for_each_gcwq_cpu(cpu)
2550 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2555 * flush_work_sync - wait until a work has finished execution
2556 * @work: the work to flush
2558 * Wait until @work has finished execution. On return, it's
2559 * guaranteed that all queueing instances of @work which happened
2560 * before this function is called are finished. In other words, if
2561 * @work hasn't been requeued since this function was called, @work is
2562 * guaranteed to be idle on return.
2565 * %true if flush_work_sync() waited for the work to finish execution,
2566 * %false if it was already idle.
2568 bool flush_work_sync(struct work_struct *work)
2570 struct wq_barrier barr;
2571 bool pending, waited;
2573 /* we'll wait for executions separately, queue barr only if pending */
2574 pending = start_flush_work(work, &barr, false);
2576 /* wait for executions to finish */
2577 waited = wait_on_work(work);
2579 /* wait for the pending one */
2581 wait_for_completion(&barr.done);
2582 destroy_work_on_stack(&barr.work);
2585 return pending || waited;
2587 EXPORT_SYMBOL_GPL(flush_work_sync);
2590 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
2591 * so this work can't be re-armed in any way.
2593 static int try_to_grab_pending(struct work_struct *work)
2595 struct global_cwq *gcwq;
2598 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
2602 * The queueing is in progress, or it is already queued. Try to
2603 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2605 gcwq = get_work_gcwq(work);
2609 spin_lock_irq(&gcwq->lock);
2610 if (!list_empty(&work->entry)) {
2612 * This work is queued, but perhaps we locked the wrong gcwq.
2613 * In that case we must see the new value after rmb(), see
2614 * insert_work()->wmb().
2617 if (gcwq == get_work_gcwq(work)) {
2618 debug_work_deactivate(work);
2619 list_del_init(&work->entry);
2620 cwq_dec_nr_in_flight(get_work_cwq(work),
2621 get_work_color(work),
2622 *work_data_bits(work) & WORK_STRUCT_DELAYED);
2626 spin_unlock_irq(&gcwq->lock);
2631 static bool __cancel_work_timer(struct work_struct *work,
2632 struct timer_list* timer)
2637 ret = (timer && likely(del_timer(timer)));
2639 ret = try_to_grab_pending(work);
2641 } while (unlikely(ret < 0));
2643 clear_work_data(work);
2648 * cancel_work_sync - cancel a work and wait for it to finish
2649 * @work: the work to cancel
2651 * Cancel @work and wait for its execution to finish. This function
2652 * can be used even if the work re-queues itself or migrates to
2653 * another workqueue. On return from this function, @work is
2654 * guaranteed to be not pending or executing on any CPU.
2656 * cancel_work_sync(&delayed_work->work) must not be used for
2657 * delayed_work's. Use cancel_delayed_work_sync() instead.
2659 * The caller must ensure that the workqueue on which @work was last
2660 * queued can't be destroyed before this function returns.
2663 * %true if @work was pending, %false otherwise.
2665 bool cancel_work_sync(struct work_struct *work)
2667 return __cancel_work_timer(work, NULL);
2669 EXPORT_SYMBOL_GPL(cancel_work_sync);
2672 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2673 * @dwork: the delayed work to flush
2675 * Delayed timer is cancelled and the pending work is queued for
2676 * immediate execution. Like flush_work(), this function only
2677 * considers the last queueing instance of @dwork.
2680 * %true if flush_work() waited for the work to finish execution,
2681 * %false if it was already idle.
2683 bool flush_delayed_work(struct delayed_work *dwork)
2685 if (del_timer_sync(&dwork->timer))
2686 __queue_work(raw_smp_processor_id(),
2687 get_work_cwq(&dwork->work)->wq, &dwork->work);
2688 return flush_work(&dwork->work);
2690 EXPORT_SYMBOL(flush_delayed_work);
2693 * flush_delayed_work_sync - wait for a dwork to finish
2694 * @dwork: the delayed work to flush
2696 * Delayed timer is cancelled and the pending work is queued for
2697 * execution immediately. Other than timer handling, its behavior
2698 * is identical to flush_work_sync().
2701 * %true if flush_work_sync() waited for the work to finish execution,
2702 * %false if it was already idle.
2704 bool flush_delayed_work_sync(struct delayed_work *dwork)
2706 if (del_timer_sync(&dwork->timer))
2707 __queue_work(raw_smp_processor_id(),
2708 get_work_cwq(&dwork->work)->wq, &dwork->work);
2709 return flush_work_sync(&dwork->work);
2711 EXPORT_SYMBOL(flush_delayed_work_sync);
2714 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2715 * @dwork: the delayed work cancel
2717 * This is cancel_work_sync() for delayed works.
2720 * %true if @dwork was pending, %false otherwise.
2722 bool cancel_delayed_work_sync(struct delayed_work *dwork)
2724 return __cancel_work_timer(&dwork->work, &dwork->timer);
2726 EXPORT_SYMBOL(cancel_delayed_work_sync);
2729 * schedule_work - put work task in global workqueue
2730 * @work: job to be done
2732 * Returns zero if @work was already on the kernel-global workqueue and
2733 * non-zero otherwise.
2735 * This puts a job in the kernel-global workqueue if it was not already
2736 * queued and leaves it in the same position on the kernel-global
2737 * workqueue otherwise.
2739 int schedule_work(struct work_struct *work)
2741 return queue_work(system_wq, work);
2743 EXPORT_SYMBOL(schedule_work);
2746 * schedule_work_on - put work task on a specific cpu
2747 * @cpu: cpu to put the work task on
2748 * @work: job to be done
2750 * This puts a job on a specific cpu
2752 int schedule_work_on(int cpu, struct work_struct *work)
2754 return queue_work_on(cpu, system_wq, work);
2756 EXPORT_SYMBOL(schedule_work_on);
2759 * schedule_delayed_work - put work task in global workqueue after delay
2760 * @dwork: job to be done
2761 * @delay: number of jiffies to wait or 0 for immediate execution
2763 * After waiting for a given time this puts a job in the kernel-global
2766 int schedule_delayed_work(struct delayed_work *dwork,
2767 unsigned long delay)
2769 return queue_delayed_work(system_wq, dwork, delay);
2771 EXPORT_SYMBOL(schedule_delayed_work);
2774 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2776 * @dwork: job to be done
2777 * @delay: number of jiffies to wait
2779 * After waiting for a given time this puts a job in the kernel-global
2780 * workqueue on the specified CPU.
2782 int schedule_delayed_work_on(int cpu,
2783 struct delayed_work *dwork, unsigned long delay)
2785 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
2787 EXPORT_SYMBOL(schedule_delayed_work_on);
2790 * schedule_on_each_cpu - execute a function synchronously on each online CPU
2791 * @func: the function to call
2793 * schedule_on_each_cpu() executes @func on each online CPU using the
2794 * system workqueue and blocks until all CPUs have completed.
2795 * schedule_on_each_cpu() is very slow.
2798 * 0 on success, -errno on failure.
2800 int schedule_on_each_cpu(work_func_t func)
2803 struct work_struct __percpu *works;
2805 works = alloc_percpu(struct work_struct);
2811 for_each_online_cpu(cpu) {
2812 struct work_struct *work = per_cpu_ptr(works, cpu);
2814 INIT_WORK(work, func);
2815 schedule_work_on(cpu, work);
2818 for_each_online_cpu(cpu)
2819 flush_work(per_cpu_ptr(works, cpu));
2827 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2829 * Forces execution of the kernel-global workqueue and blocks until its
2832 * Think twice before calling this function! It's very easy to get into
2833 * trouble if you don't take great care. Either of the following situations
2834 * will lead to deadlock:
2836 * One of the work items currently on the workqueue needs to acquire
2837 * a lock held by your code or its caller.
2839 * Your code is running in the context of a work routine.
2841 * They will be detected by lockdep when they occur, but the first might not
2842 * occur very often. It depends on what work items are on the workqueue and
2843 * what locks they need, which you have no control over.
2845 * In most situations flushing the entire workqueue is overkill; you merely
2846 * need to know that a particular work item isn't queued and isn't running.
2847 * In such cases you should use cancel_delayed_work_sync() or
2848 * cancel_work_sync() instead.
2850 void flush_scheduled_work(void)
2852 flush_workqueue(system_wq);
2854 EXPORT_SYMBOL(flush_scheduled_work);
2857 * execute_in_process_context - reliably execute the routine with user context
2858 * @fn: the function to execute
2859 * @ew: guaranteed storage for the execute work structure (must
2860 * be available when the work executes)
2862 * Executes the function immediately if process context is available,
2863 * otherwise schedules the function for delayed execution.
2865 * Returns: 0 - function was executed
2866 * 1 - function was scheduled for execution
2868 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
2870 if (!in_interrupt()) {
2875 INIT_WORK(&ew->work, fn);
2876 schedule_work(&ew->work);
2880 EXPORT_SYMBOL_GPL(execute_in_process_context);
2882 int keventd_up(void)
2884 return system_wq != NULL;
2887 static int alloc_cwqs(struct workqueue_struct *wq)
2890 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
2891 * Make sure that the alignment isn't lower than that of
2892 * unsigned long long.
2894 const size_t size = sizeof(struct cpu_workqueue_struct);
2895 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
2896 __alignof__(unsigned long long));
2898 if (!(wq->flags & WQ_UNBOUND))
2899 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2904 * Allocate enough room to align cwq and put an extra
2905 * pointer at the end pointing back to the originally
2906 * allocated pointer which will be used for free.
2908 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2910 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2911 *(void **)(wq->cpu_wq.single + 1) = ptr;
2915 /* just in case, make sure it's actually aligned */
2916 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2917 return wq->cpu_wq.v ? 0 : -ENOMEM;
2920 static void free_cwqs(struct workqueue_struct *wq)
2922 if (!(wq->flags & WQ_UNBOUND))
2923 free_percpu(wq->cpu_wq.pcpu);
2924 else if (wq->cpu_wq.single) {
2925 /* the pointer to free is stored right after the cwq */
2926 kfree(*(void **)(wq->cpu_wq.single + 1));
2930 static int wq_clamp_max_active(int max_active, unsigned int flags,
2933 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2935 if (max_active < 1 || max_active > lim)
2936 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2937 "is out of range, clamping between %d and %d\n",
2938 max_active, name, 1, lim);
2940 return clamp_val(max_active, 1, lim);
2943 struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
2946 struct lock_class_key *key,
2947 const char *lock_name, ...)
2949 va_list args, args1;
2950 struct workqueue_struct *wq;
2954 /* determine namelen, allocate wq and format name */
2955 va_start(args, lock_name);
2956 va_copy(args1, args);
2957 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
2959 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
2963 vsnprintf(wq->name, namelen, fmt, args1);
2968 * Workqueues which may be used during memory reclaim should
2969 * have a rescuer to guarantee forward progress.
2971 if (flags & WQ_MEM_RECLAIM)
2972 flags |= WQ_RESCUER;
2975 * Unbound workqueues aren't concurrency managed and should be
2976 * dispatched to workers immediately.
2978 if (flags & WQ_UNBOUND)
2979 flags |= WQ_HIGHPRI;
2981 max_active = max_active ?: WQ_DFL_ACTIVE;
2982 max_active = wq_clamp_max_active(max_active, flags, wq->name);
2986 wq->saved_max_active = max_active;
2987 mutex_init(&wq->flush_mutex);
2988 atomic_set(&wq->nr_cwqs_to_flush, 0);
2989 INIT_LIST_HEAD(&wq->flusher_queue);
2990 INIT_LIST_HEAD(&wq->flusher_overflow);
2992 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
2993 INIT_LIST_HEAD(&wq->list);
2995 if (alloc_cwqs(wq) < 0)
2998 for_each_cwq_cpu(cpu, wq) {
2999 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3000 struct global_cwq *gcwq = get_gcwq(cpu);
3002 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
3005 cwq->flush_color = -1;
3006 cwq->max_active = max_active;
3007 INIT_LIST_HEAD(&cwq->delayed_works);
3010 if (flags & WQ_RESCUER) {
3011 struct worker *rescuer;
3013 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3016 wq->rescuer = rescuer = alloc_worker();
3020 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3022 if (IS_ERR(rescuer->task))
3025 rescuer->task->flags |= PF_THREAD_BOUND;
3026 wake_up_process(rescuer->task);
3030 * workqueue_lock protects global freeze state and workqueues
3031 * list. Grab it, set max_active accordingly and add the new
3032 * workqueue to workqueues list.
3034 spin_lock(&workqueue_lock);
3036 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3037 for_each_cwq_cpu(cpu, wq)
3038 get_cwq(cpu, wq)->max_active = 0;
3040 list_add(&wq->list, &workqueues);
3042 spin_unlock(&workqueue_lock);
3048 free_mayday_mask(wq->mayday_mask);
3054 EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
3057 * destroy_workqueue - safely terminate a workqueue
3058 * @wq: target workqueue
3060 * Safely destroy a workqueue. All work currently pending will be done first.
3062 void destroy_workqueue(struct workqueue_struct *wq)
3066 /* drain it before proceeding with destruction */
3067 drain_workqueue(wq);
3070 * wq list is used to freeze wq, remove from list after
3071 * flushing is complete in case freeze races us.
3073 spin_lock(&workqueue_lock);
3074 list_del(&wq->list);
3075 spin_unlock(&workqueue_lock);
3078 for_each_cwq_cpu(cpu, wq) {
3079 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3082 for (i = 0; i < WORK_NR_COLORS; i++)
3083 BUG_ON(cwq->nr_in_flight[i]);
3084 BUG_ON(cwq->nr_active);
3085 BUG_ON(!list_empty(&cwq->delayed_works));
3088 if (wq->flags & WQ_RESCUER) {
3089 kthread_stop(wq->rescuer->task);
3090 free_mayday_mask(wq->mayday_mask);
3097 EXPORT_SYMBOL_GPL(destroy_workqueue);
3100 * workqueue_set_max_active - adjust max_active of a workqueue
3101 * @wq: target workqueue
3102 * @max_active: new max_active value.
3104 * Set max_active of @wq to @max_active.
3107 * Don't call from IRQ context.
3109 void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3113 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3115 spin_lock(&workqueue_lock);
3117 wq->saved_max_active = max_active;
3119 for_each_cwq_cpu(cpu, wq) {
3120 struct global_cwq *gcwq = get_gcwq(cpu);
3122 spin_lock_irq(&gcwq->lock);
3124 if (!(wq->flags & WQ_FREEZABLE) ||
3125 !(gcwq->flags & GCWQ_FREEZING))
3126 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3128 spin_unlock_irq(&gcwq->lock);
3131 spin_unlock(&workqueue_lock);
3133 EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3136 * workqueue_congested - test whether a workqueue is congested
3137 * @cpu: CPU in question
3138 * @wq: target workqueue
3140 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3141 * no synchronization around this function and the test result is
3142 * unreliable and only useful as advisory hints or for debugging.
3145 * %true if congested, %false otherwise.
3147 bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3149 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3151 return !list_empty(&cwq->delayed_works);
3153 EXPORT_SYMBOL_GPL(workqueue_congested);
3156 * work_cpu - return the last known associated cpu for @work
3157 * @work: the work of interest
3160 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
3162 unsigned int work_cpu(struct work_struct *work)
3164 struct global_cwq *gcwq = get_work_gcwq(work);
3166 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3168 EXPORT_SYMBOL_GPL(work_cpu);
3171 * work_busy - test whether a work is currently pending or running
3172 * @work: the work to be tested
3174 * Test whether @work is currently pending or running. There is no
3175 * synchronization around this function and the test result is
3176 * unreliable and only useful as advisory hints or for debugging.
3177 * Especially for reentrant wqs, the pending state might hide the
3181 * OR'd bitmask of WORK_BUSY_* bits.
3183 unsigned int work_busy(struct work_struct *work)
3185 struct global_cwq *gcwq = get_work_gcwq(work);
3186 unsigned long flags;
3187 unsigned int ret = 0;
3192 spin_lock_irqsave(&gcwq->lock, flags);
3194 if (work_pending(work))
3195 ret |= WORK_BUSY_PENDING;
3196 if (find_worker_executing_work(gcwq, work))
3197 ret |= WORK_BUSY_RUNNING;
3199 spin_unlock_irqrestore(&gcwq->lock, flags);
3203 EXPORT_SYMBOL_GPL(work_busy);
3208 * There are two challenges in supporting CPU hotplug. Firstly, there
3209 * are a lot of assumptions on strong associations among work, cwq and
3210 * gcwq which make migrating pending and scheduled works very
3211 * difficult to implement without impacting hot paths. Secondly,
3212 * gcwqs serve mix of short, long and very long running works making
3213 * blocked draining impractical.
3215 * This is solved by allowing a gcwq to be detached from CPU, running
3216 * it with unbound (rogue) workers and allowing it to be reattached
3217 * later if the cpu comes back online. A separate thread is created
3218 * to govern a gcwq in such state and is called the trustee of the
3221 * Trustee states and their descriptions.
3223 * START Command state used on startup. On CPU_DOWN_PREPARE, a
3224 * new trustee is started with this state.
3226 * IN_CHARGE Once started, trustee will enter this state after
3227 * assuming the manager role and making all existing
3228 * workers rogue. DOWN_PREPARE waits for trustee to
3229 * enter this state. After reaching IN_CHARGE, trustee
3230 * tries to execute the pending worklist until it's empty
3231 * and the state is set to BUTCHER, or the state is set
3234 * BUTCHER Command state which is set by the cpu callback after
3235 * the cpu has went down. Once this state is set trustee
3236 * knows that there will be no new works on the worklist
3237 * and once the worklist is empty it can proceed to
3238 * killing idle workers.
3240 * RELEASE Command state which is set by the cpu callback if the
3241 * cpu down has been canceled or it has come online
3242 * again. After recognizing this state, trustee stops
3243 * trying to drain or butcher and clears ROGUE, rebinds
3244 * all remaining workers back to the cpu and releases
3247 * DONE Trustee will enter this state after BUTCHER or RELEASE
3250 * trustee CPU draining
3251 * took over down complete
3252 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3254 * | CPU is back online v return workers |
3255 * ----------------> RELEASE --------------
3259 * trustee_wait_event_timeout - timed event wait for trustee
3260 * @cond: condition to wait for
3261 * @timeout: timeout in jiffies
3263 * wait_event_timeout() for trustee to use. Handles locking and
3264 * checks for RELEASE request.
3267 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3268 * multiple times. To be used by trustee.
3271 * Positive indicating left time if @cond is satisfied, 0 if timed
3272 * out, -1 if canceled.
3274 #define trustee_wait_event_timeout(cond, timeout) ({ \
3275 long __ret = (timeout); \
3276 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
3278 spin_unlock_irq(&gcwq->lock); \
3279 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
3280 (gcwq->trustee_state == TRUSTEE_RELEASE), \
3282 spin_lock_irq(&gcwq->lock); \
3284 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
3288 * trustee_wait_event - event wait for trustee
3289 * @cond: condition to wait for
3291 * wait_event() for trustee to use. Automatically handles locking and
3292 * checks for CANCEL request.
3295 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3296 * multiple times. To be used by trustee.
3299 * 0 if @cond is satisfied, -1 if canceled.
3301 #define trustee_wait_event(cond) ({ \
3303 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3304 __ret1 < 0 ? -1 : 0; \
3307 static int __cpuinit trustee_thread(void *__gcwq)
3309 struct global_cwq *gcwq = __gcwq;
3310 struct worker *worker;
3311 struct work_struct *work;
3312 struct hlist_node *pos;
3316 BUG_ON(gcwq->cpu != smp_processor_id());
3318 spin_lock_irq(&gcwq->lock);
3320 * Claim the manager position and make all workers rogue.
3321 * Trustee must be bound to the target cpu and can't be
3324 BUG_ON(gcwq->cpu != smp_processor_id());
3325 rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3328 gcwq->flags |= GCWQ_MANAGING_WORKERS;
3330 list_for_each_entry(worker, &gcwq->idle_list, entry)
3331 worker->flags |= WORKER_ROGUE;
3333 for_each_busy_worker(worker, i, pos, gcwq)
3334 worker->flags |= WORKER_ROGUE;
3337 * Call schedule() so that we cross rq->lock and thus can
3338 * guarantee sched callbacks see the rogue flag. This is
3339 * necessary as scheduler callbacks may be invoked from other
3342 spin_unlock_irq(&gcwq->lock);
3344 spin_lock_irq(&gcwq->lock);
3347 * Sched callbacks are disabled now. Zap nr_running. After
3348 * this, nr_running stays zero and need_more_worker() and
3349 * keep_working() are always true as long as the worklist is
3352 atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
3354 spin_unlock_irq(&gcwq->lock);
3355 del_timer_sync(&gcwq->idle_timer);
3356 spin_lock_irq(&gcwq->lock);
3359 * We're now in charge. Notify and proceed to drain. We need
3360 * to keep the gcwq running during the whole CPU down
3361 * procedure as other cpu hotunplug callbacks may need to
3362 * flush currently running tasks.
3364 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3365 wake_up_all(&gcwq->trustee_wait);
3368 * The original cpu is in the process of dying and may go away
3369 * anytime now. When that happens, we and all workers would
3370 * be migrated to other cpus. Try draining any left work. We
3371 * want to get it over with ASAP - spam rescuers, wake up as
3372 * many idlers as necessary and create new ones till the
3373 * worklist is empty. Note that if the gcwq is frozen, there
3374 * may be frozen works in freezable cwqs. Don't declare
3375 * completion while frozen.
3377 while (gcwq->nr_workers != gcwq->nr_idle ||
3378 gcwq->flags & GCWQ_FREEZING ||
3379 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
3382 list_for_each_entry(work, &gcwq->worklist, entry) {
3387 list_for_each_entry(worker, &gcwq->idle_list, entry) {
3390 wake_up_process(worker->task);
3393 if (need_to_create_worker(gcwq)) {
3394 spin_unlock_irq(&gcwq->lock);
3395 worker = create_worker(gcwq, false);
3396 spin_lock_irq(&gcwq->lock);
3398 worker->flags |= WORKER_ROGUE;
3399 start_worker(worker);
3403 /* give a breather */
3404 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3409 * Either all works have been scheduled and cpu is down, or
3410 * cpu down has already been canceled. Wait for and butcher
3411 * all workers till we're canceled.
3414 rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3415 while (!list_empty(&gcwq->idle_list))
3416 destroy_worker(list_first_entry(&gcwq->idle_list,
3417 struct worker, entry));
3418 } while (gcwq->nr_workers && rc >= 0);
3421 * At this point, either draining has completed and no worker
3422 * is left, or cpu down has been canceled or the cpu is being
3423 * brought back up. There shouldn't be any idle one left.
3424 * Tell the remaining busy ones to rebind once it finishes the
3425 * currently scheduled works by scheduling the rebind_work.
3427 WARN_ON(!list_empty(&gcwq->idle_list));
3429 for_each_busy_worker(worker, i, pos, gcwq) {
3430 struct work_struct *rebind_work = &worker->rebind_work;
3433 * Rebind_work may race with future cpu hotplug
3434 * operations. Use a separate flag to mark that
3435 * rebinding is scheduled.
3437 worker->flags |= WORKER_REBIND;
3438 worker->flags &= ~WORKER_ROGUE;
3440 /* queue rebind_work, wq doesn't matter, use the default one */
3441 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3442 work_data_bits(rebind_work)))
3445 debug_work_activate(rebind_work);
3446 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3447 worker->scheduled.next,
3448 work_color_to_flags(WORK_NO_COLOR));
3451 /* relinquish manager role */
3452 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3454 /* notify completion */
3455 gcwq->trustee = NULL;
3456 gcwq->trustee_state = TRUSTEE_DONE;
3457 wake_up_all(&gcwq->trustee_wait);
3458 spin_unlock_irq(&gcwq->lock);
3463 * wait_trustee_state - wait for trustee to enter the specified state
3464 * @gcwq: gcwq the trustee of interest belongs to
3465 * @state: target state to wait for
3467 * Wait for the trustee to reach @state. DONE is already matched.
3470 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3471 * multiple times. To be used by cpu_callback.
3473 static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
3474 __releases(&gcwq->lock)
3475 __acquires(&gcwq->lock)
3477 if (!(gcwq->trustee_state == state ||
3478 gcwq->trustee_state == TRUSTEE_DONE)) {
3479 spin_unlock_irq(&gcwq->lock);
3480 __wait_event(gcwq->trustee_wait,
3481 gcwq->trustee_state == state ||
3482 gcwq->trustee_state == TRUSTEE_DONE);
3483 spin_lock_irq(&gcwq->lock);
3487 static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
3488 unsigned long action,
3491 unsigned int cpu = (unsigned long)hcpu;
3492 struct global_cwq *gcwq = get_gcwq(cpu);
3493 struct task_struct *new_trustee = NULL;
3494 struct worker *uninitialized_var(new_worker);
3495 unsigned long flags;
3497 action &= ~CPU_TASKS_FROZEN;
3500 case CPU_DOWN_PREPARE:
3501 new_trustee = kthread_create(trustee_thread, gcwq,
3502 "workqueue_trustee/%d\n", cpu);
3503 if (IS_ERR(new_trustee))
3504 return notifier_from_errno(PTR_ERR(new_trustee));
3505 kthread_bind(new_trustee, cpu);
3507 case CPU_UP_PREPARE:
3508 BUG_ON(gcwq->first_idle);
3509 new_worker = create_worker(gcwq, false);
3512 kthread_stop(new_trustee);
3517 /* some are called w/ irq disabled, don't disturb irq status */
3518 spin_lock_irqsave(&gcwq->lock, flags);
3521 case CPU_DOWN_PREPARE:
3522 /* initialize trustee and tell it to acquire the gcwq */
3523 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3524 gcwq->trustee = new_trustee;
3525 gcwq->trustee_state = TRUSTEE_START;
3526 wake_up_process(gcwq->trustee);
3527 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3529 case CPU_UP_PREPARE:
3530 BUG_ON(gcwq->first_idle);
3531 gcwq->first_idle = new_worker;
3536 * Before this, the trustee and all workers except for
3537 * the ones which are still executing works from
3538 * before the last CPU down must be on the cpu. After
3539 * this, they'll all be diasporas.
3541 gcwq->flags |= GCWQ_DISASSOCIATED;
3545 gcwq->trustee_state = TRUSTEE_BUTCHER;
3547 case CPU_UP_CANCELED:
3548 destroy_worker(gcwq->first_idle);
3549 gcwq->first_idle = NULL;
3552 case CPU_DOWN_FAILED:
3554 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3555 if (gcwq->trustee_state != TRUSTEE_DONE) {
3556 gcwq->trustee_state = TRUSTEE_RELEASE;
3557 wake_up_process(gcwq->trustee);
3558 wait_trustee_state(gcwq, TRUSTEE_DONE);
3562 * Trustee is done and there might be no worker left.
3563 * Put the first_idle in and request a real manager to
3566 spin_unlock_irq(&gcwq->lock);
3567 kthread_bind(gcwq->first_idle->task, cpu);
3568 spin_lock_irq(&gcwq->lock);
3569 gcwq->flags |= GCWQ_MANAGE_WORKERS;
3570 start_worker(gcwq->first_idle);
3571 gcwq->first_idle = NULL;
3575 spin_unlock_irqrestore(&gcwq->lock, flags);
3577 return notifier_from_errno(0);
3582 struct work_for_cpu {
3583 struct completion completion;
3589 static int do_work_for_cpu(void *_wfc)
3591 struct work_for_cpu *wfc = _wfc;
3592 wfc->ret = wfc->fn(wfc->arg);
3593 complete(&wfc->completion);
3598 * work_on_cpu - run a function in user context on a particular cpu
3599 * @cpu: the cpu to run on
3600 * @fn: the function to run
3601 * @arg: the function arg
3603 * This will return the value @fn returns.
3604 * It is up to the caller to ensure that the cpu doesn't go offline.
3605 * The caller must not hold any locks which would prevent @fn from completing.
3607 long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3609 struct task_struct *sub_thread;
3610 struct work_for_cpu wfc = {
3611 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3616 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3617 if (IS_ERR(sub_thread))
3618 return PTR_ERR(sub_thread);
3619 kthread_bind(sub_thread, cpu);
3620 wake_up_process(sub_thread);
3621 wait_for_completion(&wfc.completion);
3624 EXPORT_SYMBOL_GPL(work_on_cpu);
3625 #endif /* CONFIG_SMP */
3627 #ifdef CONFIG_FREEZER
3630 * freeze_workqueues_begin - begin freezing workqueues
3632 * Start freezing workqueues. After this function returns, all freezable
3633 * workqueues will queue new works to their frozen_works list instead of
3637 * Grabs and releases workqueue_lock and gcwq->lock's.
3639 void freeze_workqueues_begin(void)
3643 spin_lock(&workqueue_lock);
3645 BUG_ON(workqueue_freezing);
3646 workqueue_freezing = true;
3648 for_each_gcwq_cpu(cpu) {
3649 struct global_cwq *gcwq = get_gcwq(cpu);
3650 struct workqueue_struct *wq;
3652 spin_lock_irq(&gcwq->lock);
3654 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3655 gcwq->flags |= GCWQ_FREEZING;
3657 list_for_each_entry(wq, &workqueues, list) {
3658 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3660 if (cwq && wq->flags & WQ_FREEZABLE)
3661 cwq->max_active = 0;
3664 spin_unlock_irq(&gcwq->lock);
3667 spin_unlock(&workqueue_lock);
3671 * freeze_workqueues_busy - are freezable workqueues still busy?
3673 * Check whether freezing is complete. This function must be called
3674 * between freeze_workqueues_begin() and thaw_workqueues().
3677 * Grabs and releases workqueue_lock.
3680 * %true if some freezable workqueues are still busy. %false if freezing
3683 bool freeze_workqueues_busy(void)
3688 spin_lock(&workqueue_lock);
3690 BUG_ON(!workqueue_freezing);
3692 for_each_gcwq_cpu(cpu) {
3693 struct workqueue_struct *wq;
3695 * nr_active is monotonically decreasing. It's safe
3696 * to peek without lock.
3698 list_for_each_entry(wq, &workqueues, list) {
3699 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3701 if (!cwq || !(wq->flags & WQ_FREEZABLE))
3704 BUG_ON(cwq->nr_active < 0);
3705 if (cwq->nr_active) {
3712 spin_unlock(&workqueue_lock);
3717 * thaw_workqueues - thaw workqueues
3719 * Thaw workqueues. Normal queueing is restored and all collected
3720 * frozen works are transferred to their respective gcwq worklists.
3723 * Grabs and releases workqueue_lock and gcwq->lock's.
3725 void thaw_workqueues(void)
3729 spin_lock(&workqueue_lock);
3731 if (!workqueue_freezing)
3734 for_each_gcwq_cpu(cpu) {
3735 struct global_cwq *gcwq = get_gcwq(cpu);
3736 struct workqueue_struct *wq;
3738 spin_lock_irq(&gcwq->lock);
3740 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3741 gcwq->flags &= ~GCWQ_FREEZING;
3743 list_for_each_entry(wq, &workqueues, list) {
3744 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3746 if (!cwq || !(wq->flags & WQ_FREEZABLE))
3749 /* restore max_active and repopulate worklist */
3750 cwq->max_active = wq->saved_max_active;
3752 while (!list_empty(&cwq->delayed_works) &&
3753 cwq->nr_active < cwq->max_active)
3754 cwq_activate_first_delayed(cwq);
3757 wake_up_worker(gcwq);
3759 spin_unlock_irq(&gcwq->lock);
3762 workqueue_freezing = false;
3764 spin_unlock(&workqueue_lock);
3766 #endif /* CONFIG_FREEZER */
3768 static int __init init_workqueues(void)
3773 cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
3775 /* initialize gcwqs */
3776 for_each_gcwq_cpu(cpu) {
3777 struct global_cwq *gcwq = get_gcwq(cpu);
3779 spin_lock_init(&gcwq->lock);
3780 INIT_LIST_HEAD(&gcwq->worklist);
3782 gcwq->flags |= GCWQ_DISASSOCIATED;
3784 INIT_LIST_HEAD(&gcwq->idle_list);
3785 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3786 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3788 init_timer_deferrable(&gcwq->idle_timer);
3789 gcwq->idle_timer.function = idle_worker_timeout;
3790 gcwq->idle_timer.data = (unsigned long)gcwq;
3792 setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3793 (unsigned long)gcwq);
3795 ida_init(&gcwq->worker_ida);
3797 gcwq->trustee_state = TRUSTEE_DONE;
3798 init_waitqueue_head(&gcwq->trustee_wait);
3801 /* create the initial worker */
3802 for_each_online_gcwq_cpu(cpu) {
3803 struct global_cwq *gcwq = get_gcwq(cpu);
3804 struct worker *worker;
3806 if (cpu != WORK_CPU_UNBOUND)
3807 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3808 worker = create_worker(gcwq, true);
3810 spin_lock_irq(&gcwq->lock);
3811 start_worker(worker);
3812 spin_unlock_irq(&gcwq->lock);
3815 system_wq = alloc_workqueue("events", 0, 0);
3816 system_long_wq = alloc_workqueue("events_long", 0, 0);
3817 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3818 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3819 WQ_UNBOUND_MAX_ACTIVE);
3820 system_freezable_wq = alloc_workqueue("events_freezable",
3822 system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
3823 WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
3824 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
3825 !system_unbound_wq || !system_freezable_wq ||
3826 !system_nrt_freezable_wq);
3829 early_initcall(init_workqueues);