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"
51 * A bound gcwq is either associated or disassociated with its CPU.
52 * While associated (!DISASSOCIATED), all workers are bound to the
53 * CPU and none has %WORKER_UNBOUND set and concurrency management
56 * While DISASSOCIATED, the cpu may be offline and all workers have
57 * %WORKER_UNBOUND set and concurrency management disabled, and may
58 * be executing on any CPU. The gcwq behaves as an unbound one.
60 * Note that DISASSOCIATED can be flipped only while holding
61 * assoc_mutex of all pools on the gcwq to avoid changing binding
62 * state while create_worker() is in progress.
64 GCWQ_DISASSOCIATED = 1 << 0, /* cpu can't serve workers */
65 GCWQ_FREEZING = 1 << 1, /* freeze in progress */
68 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
69 POOL_MANAGING_WORKERS = 1 << 1, /* managing workers */
72 WORKER_STARTED = 1 << 0, /* started */
73 WORKER_DIE = 1 << 1, /* die die die */
74 WORKER_IDLE = 1 << 2, /* is idle */
75 WORKER_PREP = 1 << 3, /* preparing to run works */
76 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
77 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
79 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
82 NR_WORKER_POOLS = 2, /* # worker pools per gcwq */
84 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
85 BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER,
86 BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1,
88 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
89 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
91 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
92 /* call for help after 10ms
94 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
95 CREATE_COOLDOWN = HZ, /* time to breath after fail */
98 * Rescue workers are used only on emergencies and shared by
101 RESCUER_NICE_LEVEL = -20,
102 HIGHPRI_NICE_LEVEL = -20,
106 * Structure fields follow one of the following exclusion rules.
108 * I: Modifiable by initialization/destruction paths and read-only for
111 * P: Preemption protected. Disabling preemption is enough and should
112 * only be modified and accessed from the local cpu.
114 * L: gcwq->lock protected. Access with gcwq->lock held.
116 * X: During normal operation, modification requires gcwq->lock and
117 * should be done only from local cpu. Either disabling preemption
118 * on local cpu or grabbing gcwq->lock is enough for read access.
119 * If GCWQ_DISASSOCIATED is set, it's identical to L.
121 * F: wq->flush_mutex protected.
123 * W: workqueue_lock protected.
130 * The poor guys doing the actual heavy lifting. All on-duty workers
131 * are either serving the manager role, on idle list or on busy hash.
134 /* on idle list while idle, on busy hash table while busy */
136 struct list_head entry; /* L: while idle */
137 struct hlist_node hentry; /* L: while busy */
140 struct work_struct *current_work; /* L: work being processed */
141 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
142 struct list_head scheduled; /* L: scheduled works */
143 struct task_struct *task; /* I: worker task */
144 struct worker_pool *pool; /* I: the associated pool */
145 /* 64 bytes boundary on 64bit, 32 on 32bit */
146 unsigned long last_active; /* L: last active timestamp */
147 unsigned int flags; /* X: flags */
148 int id; /* I: worker id */
150 /* for rebinding worker to CPU */
151 struct work_struct rebind_work; /* L: for busy worker */
155 struct global_cwq *gcwq; /* I: the owning gcwq */
156 unsigned int flags; /* X: flags */
158 struct list_head worklist; /* L: list of pending works */
159 int nr_workers; /* L: total number of workers */
161 /* nr_idle includes the ones off idle_list for rebinding */
162 int nr_idle; /* L: currently idle ones */
164 struct list_head idle_list; /* X: list of idle workers */
165 struct timer_list idle_timer; /* L: worker idle timeout */
166 struct timer_list mayday_timer; /* L: SOS timer for workers */
168 struct mutex assoc_mutex; /* protect GCWQ_DISASSOCIATED */
169 struct ida worker_ida; /* L: for worker IDs */
173 * Global per-cpu workqueue. There's one and only one for each cpu
174 * and all works are queued and processed here regardless of their
178 spinlock_t lock; /* the gcwq lock */
179 unsigned int cpu; /* I: the associated cpu */
180 unsigned int flags; /* L: GCWQ_* flags */
182 /* workers are chained either in busy_hash or pool idle_list */
183 struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE];
184 /* L: hash of busy workers */
186 struct worker_pool pools[NR_WORKER_POOLS];
187 /* normal and highpri pools */
188 } ____cacheline_aligned_in_smp;
191 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
192 * work_struct->data are used for flags and thus cwqs need to be
193 * aligned at two's power of the number of flag bits.
195 struct cpu_workqueue_struct {
196 struct worker_pool *pool; /* I: the associated pool */
197 struct workqueue_struct *wq; /* I: the owning workqueue */
198 int work_color; /* L: current color */
199 int flush_color; /* L: flushing color */
200 int nr_in_flight[WORK_NR_COLORS];
201 /* L: nr of in_flight works */
202 int nr_active; /* L: nr of active works */
203 int max_active; /* L: max active works */
204 struct list_head delayed_works; /* L: delayed works */
208 * Structure used to wait for workqueue flush.
211 struct list_head list; /* F: list of flushers */
212 int flush_color; /* F: flush color waiting for */
213 struct completion done; /* flush completion */
217 * All cpumasks are assumed to be always set on UP and thus can't be
218 * used to determine whether there's something to be done.
221 typedef cpumask_var_t mayday_mask_t;
222 #define mayday_test_and_set_cpu(cpu, mask) \
223 cpumask_test_and_set_cpu((cpu), (mask))
224 #define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
225 #define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
226 #define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
227 #define free_mayday_mask(mask) free_cpumask_var((mask))
229 typedef unsigned long mayday_mask_t;
230 #define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
231 #define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
232 #define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
233 #define alloc_mayday_mask(maskp, gfp) true
234 #define free_mayday_mask(mask) do { } while (0)
238 * The externally visible workqueue abstraction is an array of
239 * per-CPU workqueues:
241 struct workqueue_struct {
242 unsigned int flags; /* W: WQ_* flags */
244 struct cpu_workqueue_struct __percpu *pcpu;
245 struct cpu_workqueue_struct *single;
247 } cpu_wq; /* I: cwq's */
248 struct list_head list; /* W: list of all workqueues */
250 struct mutex flush_mutex; /* protects wq flushing */
251 int work_color; /* F: current work color */
252 int flush_color; /* F: current flush color */
253 atomic_t nr_cwqs_to_flush; /* flush in progress */
254 struct wq_flusher *first_flusher; /* F: first flusher */
255 struct list_head flusher_queue; /* F: flush waiters */
256 struct list_head flusher_overflow; /* F: flush overflow list */
258 mayday_mask_t mayday_mask; /* cpus requesting rescue */
259 struct worker *rescuer; /* I: rescue worker */
261 int nr_drainers; /* W: drain in progress */
262 int saved_max_active; /* W: saved cwq max_active */
263 #ifdef CONFIG_LOCKDEP
264 struct lockdep_map lockdep_map;
266 char name[]; /* I: workqueue name */
269 struct workqueue_struct *system_wq __read_mostly;
270 EXPORT_SYMBOL_GPL(system_wq);
271 struct workqueue_struct *system_highpri_wq __read_mostly;
272 EXPORT_SYMBOL_GPL(system_highpri_wq);
273 struct workqueue_struct *system_long_wq __read_mostly;
274 EXPORT_SYMBOL_GPL(system_long_wq);
275 struct workqueue_struct *system_unbound_wq __read_mostly;
276 EXPORT_SYMBOL_GPL(system_unbound_wq);
277 struct workqueue_struct *system_freezable_wq __read_mostly;
278 EXPORT_SYMBOL_GPL(system_freezable_wq);
280 #define CREATE_TRACE_POINTS
281 #include <trace/events/workqueue.h>
283 #define for_each_worker_pool(pool, gcwq) \
284 for ((pool) = &(gcwq)->pools[0]; \
285 (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
287 #define for_each_busy_worker(worker, i, pos, gcwq) \
288 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
289 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
291 static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
294 if (cpu < nr_cpu_ids) {
296 cpu = cpumask_next(cpu, mask);
297 if (cpu < nr_cpu_ids)
301 return WORK_CPU_UNBOUND;
303 return WORK_CPU_NONE;
306 static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
307 struct workqueue_struct *wq)
309 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
315 * An extra gcwq is defined for an invalid cpu number
316 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
317 * specific CPU. The following iterators are similar to
318 * for_each_*_cpu() iterators but also considers the unbound gcwq.
320 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
321 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
322 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
323 * WORK_CPU_UNBOUND for unbound workqueues
325 #define for_each_gcwq_cpu(cpu) \
326 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
327 (cpu) < WORK_CPU_NONE; \
328 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
330 #define for_each_online_gcwq_cpu(cpu) \
331 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
332 (cpu) < WORK_CPU_NONE; \
333 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
335 #define for_each_cwq_cpu(cpu, wq) \
336 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
337 (cpu) < WORK_CPU_NONE; \
338 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
340 #ifdef CONFIG_DEBUG_OBJECTS_WORK
342 static struct debug_obj_descr work_debug_descr;
344 static void *work_debug_hint(void *addr)
346 return ((struct work_struct *) addr)->func;
350 * fixup_init is called when:
351 * - an active object is initialized
353 static int work_fixup_init(void *addr, enum debug_obj_state state)
355 struct work_struct *work = addr;
358 case ODEBUG_STATE_ACTIVE:
359 cancel_work_sync(work);
360 debug_object_init(work, &work_debug_descr);
368 * fixup_activate is called when:
369 * - an active object is activated
370 * - an unknown object is activated (might be a statically initialized object)
372 static int work_fixup_activate(void *addr, enum debug_obj_state state)
374 struct work_struct *work = addr;
378 case ODEBUG_STATE_NOTAVAILABLE:
380 * This is not really a fixup. The work struct was
381 * statically initialized. We just make sure that it
382 * is tracked in the object tracker.
384 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
385 debug_object_init(work, &work_debug_descr);
386 debug_object_activate(work, &work_debug_descr);
392 case ODEBUG_STATE_ACTIVE:
401 * fixup_free is called when:
402 * - an active object is freed
404 static int work_fixup_free(void *addr, enum debug_obj_state state)
406 struct work_struct *work = addr;
409 case ODEBUG_STATE_ACTIVE:
410 cancel_work_sync(work);
411 debug_object_free(work, &work_debug_descr);
418 static struct debug_obj_descr work_debug_descr = {
419 .name = "work_struct",
420 .debug_hint = work_debug_hint,
421 .fixup_init = work_fixup_init,
422 .fixup_activate = work_fixup_activate,
423 .fixup_free = work_fixup_free,
426 static inline void debug_work_activate(struct work_struct *work)
428 debug_object_activate(work, &work_debug_descr);
431 static inline void debug_work_deactivate(struct work_struct *work)
433 debug_object_deactivate(work, &work_debug_descr);
436 void __init_work(struct work_struct *work, int onstack)
439 debug_object_init_on_stack(work, &work_debug_descr);
441 debug_object_init(work, &work_debug_descr);
443 EXPORT_SYMBOL_GPL(__init_work);
445 void destroy_work_on_stack(struct work_struct *work)
447 debug_object_free(work, &work_debug_descr);
449 EXPORT_SYMBOL_GPL(destroy_work_on_stack);
452 static inline void debug_work_activate(struct work_struct *work) { }
453 static inline void debug_work_deactivate(struct work_struct *work) { }
456 /* Serializes the accesses to the list of workqueues. */
457 static DEFINE_SPINLOCK(workqueue_lock);
458 static LIST_HEAD(workqueues);
459 static bool workqueue_freezing; /* W: have wqs started freezing? */
462 * The almighty global cpu workqueues. nr_running is the only field
463 * which is expected to be used frequently by other cpus via
464 * try_to_wake_up(). Put it in a separate cacheline.
466 static DEFINE_PER_CPU(struct global_cwq, global_cwq);
467 static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
470 * Global cpu workqueue and nr_running counter for unbound gcwq. The
471 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
472 * workers have WORKER_UNBOUND set.
474 static struct global_cwq unbound_global_cwq;
475 static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
476 [0 ... NR_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */
479 static int worker_thread(void *__worker);
481 static int worker_pool_pri(struct worker_pool *pool)
483 return pool - pool->gcwq->pools;
486 static struct global_cwq *get_gcwq(unsigned int cpu)
488 if (cpu != WORK_CPU_UNBOUND)
489 return &per_cpu(global_cwq, cpu);
491 return &unbound_global_cwq;
494 static atomic_t *get_pool_nr_running(struct worker_pool *pool)
496 int cpu = pool->gcwq->cpu;
497 int idx = worker_pool_pri(pool);
499 if (cpu != WORK_CPU_UNBOUND)
500 return &per_cpu(pool_nr_running, cpu)[idx];
502 return &unbound_pool_nr_running[idx];
505 static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
506 struct workqueue_struct *wq)
508 if (!(wq->flags & WQ_UNBOUND)) {
509 if (likely(cpu < nr_cpu_ids))
510 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
511 } else if (likely(cpu == WORK_CPU_UNBOUND))
512 return wq->cpu_wq.single;
516 static unsigned int work_color_to_flags(int color)
518 return color << WORK_STRUCT_COLOR_SHIFT;
521 static int get_work_color(struct work_struct *work)
523 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
524 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
527 static int work_next_color(int color)
529 return (color + 1) % WORK_NR_COLORS;
533 * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
534 * contain the pointer to the queued cwq. Once execution starts, the flag
535 * is cleared and the high bits contain OFFQ flags and CPU number.
537 * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
538 * and clear_work_data() can be used to set the cwq, cpu or clear
539 * work->data. These functions should only be called while the work is
540 * owned - ie. while the PENDING bit is set.
542 * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
543 * a work. gcwq is available once the work has been queued anywhere after
544 * initialization until it is sync canceled. cwq is available only while
545 * the work item is queued.
547 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
548 * canceled. While being canceled, a work item may have its PENDING set
549 * but stay off timer and worklist for arbitrarily long and nobody should
550 * try to steal the PENDING bit.
552 static inline void set_work_data(struct work_struct *work, unsigned long data,
555 BUG_ON(!work_pending(work));
556 atomic_long_set(&work->data, data | flags | work_static(work));
559 static void set_work_cwq(struct work_struct *work,
560 struct cpu_workqueue_struct *cwq,
561 unsigned long extra_flags)
563 set_work_data(work, (unsigned long)cwq,
564 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
567 static void set_work_cpu_and_clear_pending(struct work_struct *work,
571 * The following wmb is paired with the implied mb in
572 * test_and_set_bit(PENDING) and ensures all updates to @work made
573 * here are visible to and precede any updates by the next PENDING
577 set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
580 static void clear_work_data(struct work_struct *work)
582 smp_wmb(); /* see set_work_cpu_and_clear_pending() */
583 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
586 static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
588 unsigned long data = atomic_long_read(&work->data);
590 if (data & WORK_STRUCT_CWQ)
591 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
596 static struct global_cwq *get_work_gcwq(struct work_struct *work)
598 unsigned long data = atomic_long_read(&work->data);
601 if (data & WORK_STRUCT_CWQ)
602 return ((struct cpu_workqueue_struct *)
603 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
605 cpu = data >> WORK_OFFQ_CPU_SHIFT;
606 if (cpu == WORK_CPU_NONE)
609 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
610 return get_gcwq(cpu);
613 static void mark_work_canceling(struct work_struct *work)
615 struct global_cwq *gcwq = get_work_gcwq(work);
616 unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
618 set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
619 WORK_STRUCT_PENDING);
622 static bool work_is_canceling(struct work_struct *work)
624 unsigned long data = atomic_long_read(&work->data);
626 return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
630 * Policy functions. These define the policies on how the global worker
631 * pools are managed. Unless noted otherwise, these functions assume that
632 * they're being called with gcwq->lock held.
635 static bool __need_more_worker(struct worker_pool *pool)
637 return !atomic_read(get_pool_nr_running(pool));
641 * Need to wake up a worker? Called from anything but currently
644 * Note that, because unbound workers never contribute to nr_running, this
645 * function will always return %true for unbound gcwq as long as the
646 * worklist isn't empty.
648 static bool need_more_worker(struct worker_pool *pool)
650 return !list_empty(&pool->worklist) && __need_more_worker(pool);
653 /* Can I start working? Called from busy but !running workers. */
654 static bool may_start_working(struct worker_pool *pool)
656 return pool->nr_idle;
659 /* Do I need to keep working? Called from currently running workers. */
660 static bool keep_working(struct worker_pool *pool)
662 atomic_t *nr_running = get_pool_nr_running(pool);
664 return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
667 /* Do we need a new worker? Called from manager. */
668 static bool need_to_create_worker(struct worker_pool *pool)
670 return need_more_worker(pool) && !may_start_working(pool);
673 /* Do I need to be the manager? */
674 static bool need_to_manage_workers(struct worker_pool *pool)
676 return need_to_create_worker(pool) ||
677 (pool->flags & POOL_MANAGE_WORKERS);
680 /* Do we have too many workers and should some go away? */
681 static bool too_many_workers(struct worker_pool *pool)
683 bool managing = pool->flags & POOL_MANAGING_WORKERS;
684 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
685 int nr_busy = pool->nr_workers - nr_idle;
688 * nr_idle and idle_list may disagree if idle rebinding is in
689 * progress. Never return %true if idle_list is empty.
691 if (list_empty(&pool->idle_list))
694 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
701 /* Return the first worker. Safe with preemption disabled */
702 static struct worker *first_worker(struct worker_pool *pool)
704 if (unlikely(list_empty(&pool->idle_list)))
707 return list_first_entry(&pool->idle_list, struct worker, entry);
711 * wake_up_worker - wake up an idle worker
712 * @pool: worker pool to wake worker from
714 * Wake up the first idle worker of @pool.
717 * spin_lock_irq(gcwq->lock).
719 static void wake_up_worker(struct worker_pool *pool)
721 struct worker *worker = first_worker(pool);
724 wake_up_process(worker->task);
728 * wq_worker_waking_up - a worker is waking up
729 * @task: task waking up
730 * @cpu: CPU @task is waking up to
732 * This function is called during try_to_wake_up() when a worker is
736 * spin_lock_irq(rq->lock)
738 void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
740 struct worker *worker = kthread_data(task);
742 if (!(worker->flags & WORKER_NOT_RUNNING))
743 atomic_inc(get_pool_nr_running(worker->pool));
747 * wq_worker_sleeping - a worker is going to sleep
748 * @task: task going to sleep
749 * @cpu: CPU in question, must be the current CPU number
751 * This function is called during schedule() when a busy worker is
752 * going to sleep. Worker on the same cpu can be woken up by
753 * returning pointer to its task.
756 * spin_lock_irq(rq->lock)
759 * Worker task on @cpu to wake up, %NULL if none.
761 struct task_struct *wq_worker_sleeping(struct task_struct *task,
764 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
765 struct worker_pool *pool = worker->pool;
766 atomic_t *nr_running = get_pool_nr_running(pool);
768 if (worker->flags & WORKER_NOT_RUNNING)
771 /* this can only happen on the local cpu */
772 BUG_ON(cpu != raw_smp_processor_id());
775 * The counterpart of the following dec_and_test, implied mb,
776 * worklist not empty test sequence is in insert_work().
777 * Please read comment there.
779 * NOT_RUNNING is clear. This means that we're bound to and
780 * running on the local cpu w/ rq lock held and preemption
781 * disabled, which in turn means that none else could be
782 * manipulating idle_list, so dereferencing idle_list without gcwq
785 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
786 to_wakeup = first_worker(pool);
787 return to_wakeup ? to_wakeup->task : NULL;
791 * worker_set_flags - set worker flags and adjust nr_running accordingly
793 * @flags: flags to set
794 * @wakeup: wakeup an idle worker if necessary
796 * Set @flags in @worker->flags and adjust nr_running accordingly. If
797 * nr_running becomes zero and @wakeup is %true, an idle worker is
801 * spin_lock_irq(gcwq->lock)
803 static inline void worker_set_flags(struct worker *worker, unsigned int flags,
806 struct worker_pool *pool = worker->pool;
808 WARN_ON_ONCE(worker->task != current);
811 * If transitioning into NOT_RUNNING, adjust nr_running and
812 * wake up an idle worker as necessary if requested by
815 if ((flags & WORKER_NOT_RUNNING) &&
816 !(worker->flags & WORKER_NOT_RUNNING)) {
817 atomic_t *nr_running = get_pool_nr_running(pool);
820 if (atomic_dec_and_test(nr_running) &&
821 !list_empty(&pool->worklist))
822 wake_up_worker(pool);
824 atomic_dec(nr_running);
827 worker->flags |= flags;
831 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
833 * @flags: flags to clear
835 * Clear @flags in @worker->flags and adjust nr_running accordingly.
838 * spin_lock_irq(gcwq->lock)
840 static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
842 struct worker_pool *pool = worker->pool;
843 unsigned int oflags = worker->flags;
845 WARN_ON_ONCE(worker->task != current);
847 worker->flags &= ~flags;
850 * If transitioning out of NOT_RUNNING, increment nr_running. Note
851 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
852 * of multiple flags, not a single flag.
854 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
855 if (!(worker->flags & WORKER_NOT_RUNNING))
856 atomic_inc(get_pool_nr_running(pool));
860 * busy_worker_head - return the busy hash head for a work
861 * @gcwq: gcwq of interest
862 * @work: work to be hashed
864 * Return hash head of @gcwq for @work.
867 * spin_lock_irq(gcwq->lock).
870 * Pointer to the hash head.
872 static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
873 struct work_struct *work)
875 const int base_shift = ilog2(sizeof(struct work_struct));
876 unsigned long v = (unsigned long)work;
878 /* simple shift and fold hash, do we need something better? */
880 v += v >> BUSY_WORKER_HASH_ORDER;
881 v &= BUSY_WORKER_HASH_MASK;
883 return &gcwq->busy_hash[v];
887 * __find_worker_executing_work - find worker which is executing a work
888 * @gcwq: gcwq of interest
889 * @bwh: hash head as returned by busy_worker_head()
890 * @work: work to find worker for
892 * Find a worker which is executing @work on @gcwq. @bwh should be
893 * the hash head obtained by calling busy_worker_head() with the same
897 * spin_lock_irq(gcwq->lock).
900 * Pointer to worker which is executing @work if found, NULL
903 static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
904 struct hlist_head *bwh,
905 struct work_struct *work)
907 struct worker *worker;
908 struct hlist_node *tmp;
910 hlist_for_each_entry(worker, tmp, bwh, hentry)
911 if (worker->current_work == work)
917 * find_worker_executing_work - find worker which is executing a work
918 * @gcwq: gcwq of interest
919 * @work: work to find worker for
921 * Find a worker which is executing @work on @gcwq. This function is
922 * identical to __find_worker_executing_work() except that this
923 * function calculates @bwh itself.
926 * spin_lock_irq(gcwq->lock).
929 * Pointer to worker which is executing @work if found, NULL
932 static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
933 struct work_struct *work)
935 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
940 * move_linked_works - move linked works to a list
941 * @work: start of series of works to be scheduled
942 * @head: target list to append @work to
943 * @nextp: out paramter for nested worklist walking
945 * Schedule linked works starting from @work to @head. Work series to
946 * be scheduled starts at @work and includes any consecutive work with
947 * WORK_STRUCT_LINKED set in its predecessor.
949 * If @nextp is not NULL, it's updated to point to the next work of
950 * the last scheduled work. This allows move_linked_works() to be
951 * nested inside outer list_for_each_entry_safe().
954 * spin_lock_irq(gcwq->lock).
956 static void move_linked_works(struct work_struct *work, struct list_head *head,
957 struct work_struct **nextp)
959 struct work_struct *n;
962 * Linked worklist will always end before the end of the list,
963 * use NULL for list head.
965 list_for_each_entry_safe_from(work, n, NULL, entry) {
966 list_move_tail(&work->entry, head);
967 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
972 * If we're already inside safe list traversal and have moved
973 * multiple works to the scheduled queue, the next position
974 * needs to be updated.
980 static void cwq_activate_delayed_work(struct work_struct *work)
982 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
984 trace_workqueue_activate_work(work);
985 move_linked_works(work, &cwq->pool->worklist, NULL);
986 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
990 static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
992 struct work_struct *work = list_first_entry(&cwq->delayed_works,
993 struct work_struct, entry);
995 cwq_activate_delayed_work(work);
999 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1000 * @cwq: cwq of interest
1001 * @color: color of work which left the queue
1003 * A work either has completed or is removed from pending queue,
1004 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1007 * spin_lock_irq(gcwq->lock).
1009 static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
1011 /* ignore uncolored works */
1012 if (color == WORK_NO_COLOR)
1015 cwq->nr_in_flight[color]--;
1018 if (!list_empty(&cwq->delayed_works)) {
1019 /* one down, submit a delayed one */
1020 if (cwq->nr_active < cwq->max_active)
1021 cwq_activate_first_delayed(cwq);
1024 /* is flush in progress and are we at the flushing tip? */
1025 if (likely(cwq->flush_color != color))
1028 /* are there still in-flight works? */
1029 if (cwq->nr_in_flight[color])
1032 /* this cwq is done, clear flush_color */
1033 cwq->flush_color = -1;
1036 * If this was the last cwq, wake up the first flusher. It
1037 * will handle the rest.
1039 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1040 complete(&cwq->wq->first_flusher->done);
1044 * try_to_grab_pending - steal work item from worklist and disable irq
1045 * @work: work item to steal
1046 * @is_dwork: @work is a delayed_work
1047 * @flags: place to store irq state
1049 * Try to grab PENDING bit of @work. This function can handle @work in any
1050 * stable state - idle, on timer or on worklist. Return values are
1052 * 1 if @work was pending and we successfully stole PENDING
1053 * 0 if @work was idle and we claimed PENDING
1054 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
1055 * -ENOENT if someone else is canceling @work, this state may persist
1056 * for arbitrarily long
1058 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
1059 * interrupted while holding PENDING and @work off queue, irq must be
1060 * disabled on entry. This, combined with delayed_work->timer being
1061 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1063 * On successful return, >= 0, irq is disabled and the caller is
1064 * responsible for releasing it using local_irq_restore(*@flags).
1066 * This function is safe to call from any context including IRQ handler.
1068 static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1069 unsigned long *flags)
1071 struct global_cwq *gcwq;
1073 local_irq_save(*flags);
1075 /* try to steal the timer if it exists */
1077 struct delayed_work *dwork = to_delayed_work(work);
1080 * dwork->timer is irqsafe. If del_timer() fails, it's
1081 * guaranteed that the timer is not queued anywhere and not
1082 * running on the local CPU.
1084 if (likely(del_timer(&dwork->timer)))
1088 /* try to claim PENDING the normal way */
1089 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1093 * The queueing is in progress, or it is already queued. Try to
1094 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1096 gcwq = get_work_gcwq(work);
1100 spin_lock(&gcwq->lock);
1101 if (!list_empty(&work->entry)) {
1103 * This work is queued, but perhaps we locked the wrong gcwq.
1104 * In that case we must see the new value after rmb(), see
1105 * insert_work()->wmb().
1108 if (gcwq == get_work_gcwq(work)) {
1109 debug_work_deactivate(work);
1112 * A delayed work item cannot be grabbed directly
1113 * because it might have linked NO_COLOR work items
1114 * which, if left on the delayed_list, will confuse
1115 * cwq->nr_active management later on and cause
1116 * stall. Make sure the work item is activated
1119 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1120 cwq_activate_delayed_work(work);
1122 list_del_init(&work->entry);
1123 cwq_dec_nr_in_flight(get_work_cwq(work),
1124 get_work_color(work));
1126 spin_unlock(&gcwq->lock);
1130 spin_unlock(&gcwq->lock);
1132 local_irq_restore(*flags);
1133 if (work_is_canceling(work))
1140 * insert_work - insert a work into gcwq
1141 * @cwq: cwq @work belongs to
1142 * @work: work to insert
1143 * @head: insertion point
1144 * @extra_flags: extra WORK_STRUCT_* flags to set
1146 * Insert @work which belongs to @cwq into @gcwq after @head.
1147 * @extra_flags is or'd to work_struct flags.
1150 * spin_lock_irq(gcwq->lock).
1152 static void insert_work(struct cpu_workqueue_struct *cwq,
1153 struct work_struct *work, struct list_head *head,
1154 unsigned int extra_flags)
1156 struct worker_pool *pool = cwq->pool;
1158 /* we own @work, set data and link */
1159 set_work_cwq(work, cwq, extra_flags);
1162 * Ensure that we get the right work->data if we see the
1163 * result of list_add() below, see try_to_grab_pending().
1167 list_add_tail(&work->entry, head);
1170 * Ensure either worker_sched_deactivated() sees the above
1171 * list_add_tail() or we see zero nr_running to avoid workers
1172 * lying around lazily while there are works to be processed.
1176 if (__need_more_worker(pool))
1177 wake_up_worker(pool);
1181 * Test whether @work is being queued from another work executing on the
1182 * same workqueue. This is rather expensive and should only be used from
1185 static bool is_chained_work(struct workqueue_struct *wq)
1187 unsigned long flags;
1190 for_each_gcwq_cpu(cpu) {
1191 struct global_cwq *gcwq = get_gcwq(cpu);
1192 struct worker *worker;
1193 struct hlist_node *pos;
1196 spin_lock_irqsave(&gcwq->lock, flags);
1197 for_each_busy_worker(worker, i, pos, gcwq) {
1198 if (worker->task != current)
1200 spin_unlock_irqrestore(&gcwq->lock, flags);
1202 * I'm @worker, no locking necessary. See if @work
1203 * is headed to the same workqueue.
1205 return worker->current_cwq->wq == wq;
1207 spin_unlock_irqrestore(&gcwq->lock, flags);
1212 static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
1213 struct work_struct *work)
1215 struct global_cwq *gcwq;
1216 struct cpu_workqueue_struct *cwq;
1217 struct list_head *worklist;
1218 unsigned int work_flags;
1219 unsigned int req_cpu = cpu;
1222 * While a work item is PENDING && off queue, a task trying to
1223 * steal the PENDING will busy-loop waiting for it to either get
1224 * queued or lose PENDING. Grabbing PENDING and queueing should
1225 * happen with IRQ disabled.
1227 WARN_ON_ONCE(!irqs_disabled());
1229 debug_work_activate(work);
1231 /* if dying, only works from the same workqueue are allowed */
1232 if (unlikely(wq->flags & WQ_DRAINING) &&
1233 WARN_ON_ONCE(!is_chained_work(wq)))
1236 /* determine gcwq to use */
1237 if (!(wq->flags & WQ_UNBOUND)) {
1238 struct global_cwq *last_gcwq;
1240 if (cpu == WORK_CPU_UNBOUND)
1241 cpu = raw_smp_processor_id();
1244 * It's multi cpu. If @work was previously on a different
1245 * cpu, it might still be running there, in which case the
1246 * work needs to be queued on that cpu to guarantee
1249 gcwq = get_gcwq(cpu);
1250 last_gcwq = get_work_gcwq(work);
1252 if (last_gcwq && last_gcwq != gcwq) {
1253 struct worker *worker;
1255 spin_lock(&last_gcwq->lock);
1257 worker = find_worker_executing_work(last_gcwq, work);
1259 if (worker && worker->current_cwq->wq == wq)
1262 /* meh... not running there, queue here */
1263 spin_unlock(&last_gcwq->lock);
1264 spin_lock(&gcwq->lock);
1267 spin_lock(&gcwq->lock);
1270 gcwq = get_gcwq(WORK_CPU_UNBOUND);
1271 spin_lock(&gcwq->lock);
1274 /* gcwq determined, get cwq and queue */
1275 cwq = get_cwq(gcwq->cpu, wq);
1276 trace_workqueue_queue_work(req_cpu, cwq, work);
1278 if (WARN_ON(!list_empty(&work->entry))) {
1279 spin_unlock(&gcwq->lock);
1283 cwq->nr_in_flight[cwq->work_color]++;
1284 work_flags = work_color_to_flags(cwq->work_color);
1286 if (likely(cwq->nr_active < cwq->max_active)) {
1287 trace_workqueue_activate_work(work);
1289 worklist = &cwq->pool->worklist;
1291 work_flags |= WORK_STRUCT_DELAYED;
1292 worklist = &cwq->delayed_works;
1295 insert_work(cwq, work, worklist, work_flags);
1297 spin_unlock(&gcwq->lock);
1301 * queue_work_on - queue work on specific cpu
1302 * @cpu: CPU number to execute work on
1303 * @wq: workqueue to use
1304 * @work: work to queue
1306 * Returns %false if @work was already on a queue, %true otherwise.
1308 * We queue the work to a specific CPU, the caller must ensure it
1311 bool queue_work_on(int cpu, struct workqueue_struct *wq,
1312 struct work_struct *work)
1315 unsigned long flags;
1317 local_irq_save(flags);
1319 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1320 __queue_work(cpu, wq, work);
1324 local_irq_restore(flags);
1327 EXPORT_SYMBOL_GPL(queue_work_on);
1330 * queue_work - queue work on a workqueue
1331 * @wq: workqueue to use
1332 * @work: work to queue
1334 * Returns %false if @work was already on a queue, %true otherwise.
1336 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1337 * it can be processed by another CPU.
1339 bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
1341 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
1343 EXPORT_SYMBOL_GPL(queue_work);
1345 void delayed_work_timer_fn(unsigned long __data)
1347 struct delayed_work *dwork = (struct delayed_work *)__data;
1348 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
1350 /* should have been called from irqsafe timer with irq already off */
1351 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
1353 EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
1355 static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1356 struct delayed_work *dwork, unsigned long delay)
1358 struct timer_list *timer = &dwork->timer;
1359 struct work_struct *work = &dwork->work;
1362 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1363 timer->data != (unsigned long)dwork);
1364 BUG_ON(timer_pending(timer));
1365 BUG_ON(!list_empty(&work->entry));
1367 timer_stats_timer_set_start_info(&dwork->timer);
1370 * This stores cwq for the moment, for the timer_fn. Note that the
1371 * work's gcwq is preserved to allow reentrance detection for
1374 if (!(wq->flags & WQ_UNBOUND)) {
1375 struct global_cwq *gcwq = get_work_gcwq(work);
1378 * If we cannot get the last gcwq from @work directly,
1379 * select the last CPU such that it avoids unnecessarily
1380 * triggering non-reentrancy check in __queue_work().
1385 if (lcpu == WORK_CPU_UNBOUND)
1386 lcpu = raw_smp_processor_id();
1388 lcpu = WORK_CPU_UNBOUND;
1391 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1394 timer->expires = jiffies + delay;
1396 if (unlikely(cpu != WORK_CPU_UNBOUND))
1397 add_timer_on(timer, cpu);
1403 * queue_delayed_work_on - queue work on specific CPU after delay
1404 * @cpu: CPU number to execute work on
1405 * @wq: workqueue to use
1406 * @dwork: work to queue
1407 * @delay: number of jiffies to wait before queueing
1409 * Returns %false if @work was already on a queue, %true otherwise. If
1410 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1413 bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1414 struct delayed_work *dwork, unsigned long delay)
1416 struct work_struct *work = &dwork->work;
1418 unsigned long flags;
1421 return queue_work_on(cpu, wq, &dwork->work);
1423 /* read the comment in __queue_work() */
1424 local_irq_save(flags);
1426 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1427 __queue_delayed_work(cpu, wq, dwork, delay);
1431 local_irq_restore(flags);
1434 EXPORT_SYMBOL_GPL(queue_delayed_work_on);
1437 * queue_delayed_work - queue work on a workqueue after delay
1438 * @wq: workqueue to use
1439 * @dwork: delayable work to queue
1440 * @delay: number of jiffies to wait before queueing
1442 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
1444 bool queue_delayed_work(struct workqueue_struct *wq,
1445 struct delayed_work *dwork, unsigned long delay)
1447 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1449 EXPORT_SYMBOL_GPL(queue_delayed_work);
1452 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1453 * @cpu: CPU number to execute work on
1454 * @wq: workqueue to use
1455 * @dwork: work to queue
1456 * @delay: number of jiffies to wait before queueing
1458 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1459 * modify @dwork's timer so that it expires after @delay. If @delay is
1460 * zero, @work is guaranteed to be scheduled immediately regardless of its
1463 * Returns %false if @dwork was idle and queued, %true if @dwork was
1464 * pending and its timer was modified.
1466 * This function is safe to call from any context including IRQ handler.
1467 * See try_to_grab_pending() for details.
1469 bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1470 struct delayed_work *dwork, unsigned long delay)
1472 unsigned long flags;
1476 ret = try_to_grab_pending(&dwork->work, true, &flags);
1477 } while (unlikely(ret == -EAGAIN));
1479 if (likely(ret >= 0)) {
1480 __queue_delayed_work(cpu, wq, dwork, delay);
1481 local_irq_restore(flags);
1484 /* -ENOENT from try_to_grab_pending() becomes %true */
1487 EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1490 * mod_delayed_work - modify delay of or queue a delayed work
1491 * @wq: workqueue to use
1492 * @dwork: work to queue
1493 * @delay: number of jiffies to wait before queueing
1495 * mod_delayed_work_on() on local CPU.
1497 bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1498 unsigned long delay)
1500 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1502 EXPORT_SYMBOL_GPL(mod_delayed_work);
1505 * worker_enter_idle - enter idle state
1506 * @worker: worker which is entering idle state
1508 * @worker is entering idle state. Update stats and idle timer if
1512 * spin_lock_irq(gcwq->lock).
1514 static void worker_enter_idle(struct worker *worker)
1516 struct worker_pool *pool = worker->pool;
1517 struct global_cwq *gcwq = pool->gcwq;
1519 BUG_ON(worker->flags & WORKER_IDLE);
1520 BUG_ON(!list_empty(&worker->entry) &&
1521 (worker->hentry.next || worker->hentry.pprev));
1523 /* can't use worker_set_flags(), also called from start_worker() */
1524 worker->flags |= WORKER_IDLE;
1526 worker->last_active = jiffies;
1528 /* idle_list is LIFO */
1529 list_add(&worker->entry, &pool->idle_list);
1531 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1532 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1535 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1536 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1537 * nr_running, the warning may trigger spuriously. Check iff
1538 * unbind is not in progress.
1540 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
1541 pool->nr_workers == pool->nr_idle &&
1542 atomic_read(get_pool_nr_running(pool)));
1546 * worker_leave_idle - leave idle state
1547 * @worker: worker which is leaving idle state
1549 * @worker is leaving idle state. Update stats.
1552 * spin_lock_irq(gcwq->lock).
1554 static void worker_leave_idle(struct worker *worker)
1556 struct worker_pool *pool = worker->pool;
1558 BUG_ON(!(worker->flags & WORKER_IDLE));
1559 worker_clr_flags(worker, WORKER_IDLE);
1561 list_del_init(&worker->entry);
1565 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1568 * Works which are scheduled while the cpu is online must at least be
1569 * scheduled to a worker which is bound to the cpu so that if they are
1570 * flushed from cpu callbacks while cpu is going down, they are
1571 * guaranteed to execute on the cpu.
1573 * This function is to be used by rogue workers and rescuers to bind
1574 * themselves to the target cpu and may race with cpu going down or
1575 * coming online. kthread_bind() can't be used because it may put the
1576 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1577 * verbatim as it's best effort and blocking and gcwq may be
1578 * [dis]associated in the meantime.
1580 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1581 * binding against %GCWQ_DISASSOCIATED which is set during
1582 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1583 * enters idle state or fetches works without dropping lock, it can
1584 * guarantee the scheduling requirement described in the first paragraph.
1587 * Might sleep. Called without any lock but returns with gcwq->lock
1591 * %true if the associated gcwq is online (@worker is successfully
1592 * bound), %false if offline.
1594 static bool worker_maybe_bind_and_lock(struct worker *worker)
1595 __acquires(&gcwq->lock)
1597 struct global_cwq *gcwq = worker->pool->gcwq;
1598 struct task_struct *task = worker->task;
1602 * The following call may fail, succeed or succeed
1603 * without actually migrating the task to the cpu if
1604 * it races with cpu hotunplug operation. Verify
1605 * against GCWQ_DISASSOCIATED.
1607 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1608 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1610 spin_lock_irq(&gcwq->lock);
1611 if (gcwq->flags & GCWQ_DISASSOCIATED)
1613 if (task_cpu(task) == gcwq->cpu &&
1614 cpumask_equal(¤t->cpus_allowed,
1615 get_cpu_mask(gcwq->cpu)))
1617 spin_unlock_irq(&gcwq->lock);
1620 * We've raced with CPU hot[un]plug. Give it a breather
1621 * and retry migration. cond_resched() is required here;
1622 * otherwise, we might deadlock against cpu_stop trying to
1623 * bring down the CPU on non-preemptive kernel.
1631 * Rebind an idle @worker to its CPU. worker_thread() will test
1632 * list_empty(@worker->entry) before leaving idle and call this function.
1634 static void idle_worker_rebind(struct worker *worker)
1636 struct global_cwq *gcwq = worker->pool->gcwq;
1638 /* CPU may go down again inbetween, clear UNBOUND only on success */
1639 if (worker_maybe_bind_and_lock(worker))
1640 worker_clr_flags(worker, WORKER_UNBOUND);
1642 /* rebind complete, become available again */
1643 list_add(&worker->entry, &worker->pool->idle_list);
1644 spin_unlock_irq(&gcwq->lock);
1648 * Function for @worker->rebind.work used to rebind unbound busy workers to
1649 * the associated cpu which is coming back online. This is scheduled by
1650 * cpu up but can race with other cpu hotplug operations and may be
1651 * executed twice without intervening cpu down.
1653 static void busy_worker_rebind_fn(struct work_struct *work)
1655 struct worker *worker = container_of(work, struct worker, rebind_work);
1656 struct global_cwq *gcwq = worker->pool->gcwq;
1658 if (worker_maybe_bind_and_lock(worker))
1659 worker_clr_flags(worker, WORKER_UNBOUND);
1661 spin_unlock_irq(&gcwq->lock);
1665 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1666 * @gcwq: gcwq of interest
1668 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1669 * is different for idle and busy ones.
1671 * Idle ones will be removed from the idle_list and woken up. They will
1672 * add themselves back after completing rebind. This ensures that the
1673 * idle_list doesn't contain any unbound workers when re-bound busy workers
1674 * try to perform local wake-ups for concurrency management.
1676 * Busy workers can rebind after they finish their current work items.
1677 * Queueing the rebind work item at the head of the scheduled list is
1678 * enough. Note that nr_running will be properly bumped as busy workers
1681 * On return, all non-manager workers are scheduled for rebind - see
1682 * manage_workers() for the manager special case. Any idle worker
1683 * including the manager will not appear on @idle_list until rebind is
1684 * complete, making local wake-ups safe.
1686 static void rebind_workers(struct global_cwq *gcwq)
1688 struct worker_pool *pool;
1689 struct worker *worker, *n;
1690 struct hlist_node *pos;
1693 lockdep_assert_held(&gcwq->lock);
1695 for_each_worker_pool(pool, gcwq)
1696 lockdep_assert_held(&pool->assoc_mutex);
1698 /* dequeue and kick idle ones */
1699 for_each_worker_pool(pool, gcwq) {
1700 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1702 * idle workers should be off @pool->idle_list
1703 * until rebind is complete to avoid receiving
1704 * premature local wake-ups.
1706 list_del_init(&worker->entry);
1709 * worker_thread() will see the above dequeuing
1710 * and call idle_worker_rebind().
1712 wake_up_process(worker->task);
1716 /* rebind busy workers */
1717 for_each_busy_worker(worker, i, pos, gcwq) {
1718 struct work_struct *rebind_work = &worker->rebind_work;
1719 struct workqueue_struct *wq;
1721 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1722 work_data_bits(rebind_work)))
1725 debug_work_activate(rebind_work);
1728 * wq doesn't really matter but let's keep @worker->pool
1729 * and @cwq->pool consistent for sanity.
1731 if (worker_pool_pri(worker->pool))
1732 wq = system_highpri_wq;
1736 insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
1737 worker->scheduled.next,
1738 work_color_to_flags(WORK_NO_COLOR));
1742 static struct worker *alloc_worker(void)
1744 struct worker *worker;
1746 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1748 INIT_LIST_HEAD(&worker->entry);
1749 INIT_LIST_HEAD(&worker->scheduled);
1750 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1751 /* on creation a worker is in !idle && prep state */
1752 worker->flags = WORKER_PREP;
1758 * create_worker - create a new workqueue worker
1759 * @pool: pool the new worker will belong to
1761 * Create a new worker which is bound to @pool. The returned worker
1762 * can be started by calling start_worker() or destroyed using
1766 * Might sleep. Does GFP_KERNEL allocations.
1769 * Pointer to the newly created worker.
1771 static struct worker *create_worker(struct worker_pool *pool)
1773 struct global_cwq *gcwq = pool->gcwq;
1774 const char *pri = worker_pool_pri(pool) ? "H" : "";
1775 struct worker *worker = NULL;
1778 spin_lock_irq(&gcwq->lock);
1779 while (ida_get_new(&pool->worker_ida, &id)) {
1780 spin_unlock_irq(&gcwq->lock);
1781 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1783 spin_lock_irq(&gcwq->lock);
1785 spin_unlock_irq(&gcwq->lock);
1787 worker = alloc_worker();
1791 worker->pool = pool;
1794 if (gcwq->cpu != WORK_CPU_UNBOUND)
1795 worker->task = kthread_create_on_node(worker_thread,
1796 worker, cpu_to_node(gcwq->cpu),
1797 "kworker/%u:%d%s", gcwq->cpu, id, pri);
1799 worker->task = kthread_create(worker_thread, worker,
1800 "kworker/u:%d%s", id, pri);
1801 if (IS_ERR(worker->task))
1804 if (worker_pool_pri(pool))
1805 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1808 * Determine CPU binding of the new worker depending on
1809 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1810 * flag remains stable across this function. See the comments
1811 * above the flag definition for details.
1813 * As an unbound worker may later become a regular one if CPU comes
1814 * online, make sure every worker has %PF_THREAD_BOUND set.
1816 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
1817 kthread_bind(worker->task, gcwq->cpu);
1819 worker->task->flags |= PF_THREAD_BOUND;
1820 worker->flags |= WORKER_UNBOUND;
1826 spin_lock_irq(&gcwq->lock);
1827 ida_remove(&pool->worker_ida, id);
1828 spin_unlock_irq(&gcwq->lock);
1835 * start_worker - start a newly created worker
1836 * @worker: worker to start
1838 * Make the gcwq aware of @worker and start it.
1841 * spin_lock_irq(gcwq->lock).
1843 static void start_worker(struct worker *worker)
1845 worker->flags |= WORKER_STARTED;
1846 worker->pool->nr_workers++;
1847 worker_enter_idle(worker);
1848 wake_up_process(worker->task);
1852 * destroy_worker - destroy a workqueue worker
1853 * @worker: worker to be destroyed
1855 * Destroy @worker and adjust @gcwq stats accordingly.
1858 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1860 static void destroy_worker(struct worker *worker)
1862 struct worker_pool *pool = worker->pool;
1863 struct global_cwq *gcwq = pool->gcwq;
1864 int id = worker->id;
1866 /* sanity check frenzy */
1867 BUG_ON(worker->current_work);
1868 BUG_ON(!list_empty(&worker->scheduled));
1870 if (worker->flags & WORKER_STARTED)
1872 if (worker->flags & WORKER_IDLE)
1875 list_del_init(&worker->entry);
1876 worker->flags |= WORKER_DIE;
1878 spin_unlock_irq(&gcwq->lock);
1880 kthread_stop(worker->task);
1883 spin_lock_irq(&gcwq->lock);
1884 ida_remove(&pool->worker_ida, id);
1887 static void idle_worker_timeout(unsigned long __pool)
1889 struct worker_pool *pool = (void *)__pool;
1890 struct global_cwq *gcwq = pool->gcwq;
1892 spin_lock_irq(&gcwq->lock);
1894 if (too_many_workers(pool)) {
1895 struct worker *worker;
1896 unsigned long expires;
1898 /* idle_list is kept in LIFO order, check the last one */
1899 worker = list_entry(pool->idle_list.prev, struct worker, entry);
1900 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1902 if (time_before(jiffies, expires))
1903 mod_timer(&pool->idle_timer, expires);
1905 /* it's been idle for too long, wake up manager */
1906 pool->flags |= POOL_MANAGE_WORKERS;
1907 wake_up_worker(pool);
1911 spin_unlock_irq(&gcwq->lock);
1914 static bool send_mayday(struct work_struct *work)
1916 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1917 struct workqueue_struct *wq = cwq->wq;
1920 if (!(wq->flags & WQ_RESCUER))
1923 /* mayday mayday mayday */
1924 cpu = cwq->pool->gcwq->cpu;
1925 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1926 if (cpu == WORK_CPU_UNBOUND)
1928 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1929 wake_up_process(wq->rescuer->task);
1933 static void gcwq_mayday_timeout(unsigned long __pool)
1935 struct worker_pool *pool = (void *)__pool;
1936 struct global_cwq *gcwq = pool->gcwq;
1937 struct work_struct *work;
1939 spin_lock_irq(&gcwq->lock);
1941 if (need_to_create_worker(pool)) {
1943 * We've been trying to create a new worker but
1944 * haven't been successful. We might be hitting an
1945 * allocation deadlock. Send distress signals to
1948 list_for_each_entry(work, &pool->worklist, entry)
1952 spin_unlock_irq(&gcwq->lock);
1954 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1958 * maybe_create_worker - create a new worker if necessary
1959 * @pool: pool to create a new worker for
1961 * Create a new worker for @pool if necessary. @pool is guaranteed to
1962 * have at least one idle worker on return from this function. If
1963 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1964 * sent to all rescuers with works scheduled on @pool to resolve
1965 * possible allocation deadlock.
1967 * On return, need_to_create_worker() is guaranteed to be false and
1968 * may_start_working() true.
1971 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1972 * multiple times. Does GFP_KERNEL allocations. Called only from
1976 * false if no action was taken and gcwq->lock stayed locked, true
1979 static bool maybe_create_worker(struct worker_pool *pool)
1980 __releases(&gcwq->lock)
1981 __acquires(&gcwq->lock)
1983 struct global_cwq *gcwq = pool->gcwq;
1985 if (!need_to_create_worker(pool))
1988 spin_unlock_irq(&gcwq->lock);
1990 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1991 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1994 struct worker *worker;
1996 worker = create_worker(pool);
1998 del_timer_sync(&pool->mayday_timer);
1999 spin_lock_irq(&gcwq->lock);
2000 start_worker(worker);
2001 BUG_ON(need_to_create_worker(pool));
2005 if (!need_to_create_worker(pool))
2008 __set_current_state(TASK_INTERRUPTIBLE);
2009 schedule_timeout(CREATE_COOLDOWN);
2011 if (!need_to_create_worker(pool))
2015 del_timer_sync(&pool->mayday_timer);
2016 spin_lock_irq(&gcwq->lock);
2017 if (need_to_create_worker(pool))
2023 * maybe_destroy_worker - destroy workers which have been idle for a while
2024 * @pool: pool to destroy workers for
2026 * Destroy @pool workers which have been idle for longer than
2027 * IDLE_WORKER_TIMEOUT.
2030 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2031 * multiple times. Called only from manager.
2034 * false if no action was taken and gcwq->lock stayed locked, true
2037 static bool maybe_destroy_workers(struct worker_pool *pool)
2041 while (too_many_workers(pool)) {
2042 struct worker *worker;
2043 unsigned long expires;
2045 worker = list_entry(pool->idle_list.prev, struct worker, entry);
2046 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2048 if (time_before(jiffies, expires)) {
2049 mod_timer(&pool->idle_timer, expires);
2053 destroy_worker(worker);
2061 * manage_workers - manage worker pool
2064 * Assume the manager role and manage gcwq worker pool @worker belongs
2065 * to. At any given time, there can be only zero or one manager per
2066 * gcwq. The exclusion is handled automatically by this function.
2068 * The caller can safely start processing works on false return. On
2069 * true return, it's guaranteed that need_to_create_worker() is false
2070 * and may_start_working() is true.
2073 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2074 * multiple times. Does GFP_KERNEL allocations.
2077 * false if no action was taken and gcwq->lock stayed locked, true if
2078 * some action was taken.
2080 static bool manage_workers(struct worker *worker)
2082 struct worker_pool *pool = worker->pool;
2085 if (pool->flags & POOL_MANAGING_WORKERS)
2088 pool->flags |= POOL_MANAGING_WORKERS;
2091 * To simplify both worker management and CPU hotplug, hold off
2092 * management while hotplug is in progress. CPU hotplug path can't
2093 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2094 * lead to idle worker depletion (all become busy thinking someone
2095 * else is managing) which in turn can result in deadlock under
2096 * extreme circumstances. Use @pool->assoc_mutex to synchronize
2097 * manager against CPU hotplug.
2099 * assoc_mutex would always be free unless CPU hotplug is in
2100 * progress. trylock first without dropping @gcwq->lock.
2102 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
2103 spin_unlock_irq(&pool->gcwq->lock);
2104 mutex_lock(&pool->assoc_mutex);
2106 * CPU hotplug could have happened while we were waiting
2107 * for assoc_mutex. Hotplug itself can't handle us
2108 * because manager isn't either on idle or busy list, and
2109 * @gcwq's state and ours could have deviated.
2111 * As hotplug is now excluded via assoc_mutex, we can
2112 * simply try to bind. It will succeed or fail depending
2113 * on @gcwq's current state. Try it and adjust
2114 * %WORKER_UNBOUND accordingly.
2116 if (worker_maybe_bind_and_lock(worker))
2117 worker->flags &= ~WORKER_UNBOUND;
2119 worker->flags |= WORKER_UNBOUND;
2124 pool->flags &= ~POOL_MANAGE_WORKERS;
2127 * Destroy and then create so that may_start_working() is true
2130 ret |= maybe_destroy_workers(pool);
2131 ret |= maybe_create_worker(pool);
2133 pool->flags &= ~POOL_MANAGING_WORKERS;
2134 mutex_unlock(&pool->assoc_mutex);
2139 * process_one_work - process single work
2141 * @work: work to process
2143 * Process @work. This function contains all the logics necessary to
2144 * process a single work including synchronization against and
2145 * interaction with other workers on the same cpu, queueing and
2146 * flushing. As long as context requirement is met, any worker can
2147 * call this function to process a work.
2150 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
2152 static void process_one_work(struct worker *worker, struct work_struct *work)
2153 __releases(&gcwq->lock)
2154 __acquires(&gcwq->lock)
2156 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2157 struct worker_pool *pool = worker->pool;
2158 struct global_cwq *gcwq = pool->gcwq;
2159 struct hlist_head *bwh = busy_worker_head(gcwq, work);
2160 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
2161 work_func_t f = work->func;
2163 struct worker *collision;
2164 #ifdef CONFIG_LOCKDEP
2166 * It is permissible to free the struct work_struct from
2167 * inside the function that is called from it, this we need to
2168 * take into account for lockdep too. To avoid bogus "held
2169 * lock freed" warnings as well as problems when looking into
2170 * work->lockdep_map, make a copy and use that here.
2172 struct lockdep_map lockdep_map;
2174 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
2177 * Ensure we're on the correct CPU. DISASSOCIATED test is
2178 * necessary to avoid spurious warnings from rescuers servicing the
2179 * unbound or a disassociated gcwq.
2181 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
2182 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
2183 raw_smp_processor_id() != gcwq->cpu);
2186 * A single work shouldn't be executed concurrently by
2187 * multiple workers on a single cpu. Check whether anyone is
2188 * already processing the work. If so, defer the work to the
2189 * currently executing one.
2191 collision = __find_worker_executing_work(gcwq, bwh, work);
2192 if (unlikely(collision)) {
2193 move_linked_works(work, &collision->scheduled, NULL);
2197 /* claim and dequeue */
2198 debug_work_deactivate(work);
2199 hlist_add_head(&worker->hentry, bwh);
2200 worker->current_work = work;
2201 worker->current_cwq = cwq;
2202 work_color = get_work_color(work);
2204 list_del_init(&work->entry);
2207 * CPU intensive works don't participate in concurrency
2208 * management. They're the scheduler's responsibility.
2210 if (unlikely(cpu_intensive))
2211 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2214 * Unbound gcwq isn't concurrency managed and work items should be
2215 * executed ASAP. Wake up another worker if necessary.
2217 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2218 wake_up_worker(pool);
2221 * Record the last CPU and clear PENDING which should be the last
2222 * update to @work. Also, do this inside @gcwq->lock so that
2223 * PENDING and queued state changes happen together while IRQ is
2226 set_work_cpu_and_clear_pending(work, gcwq->cpu);
2228 spin_unlock_irq(&gcwq->lock);
2230 lock_map_acquire_read(&cwq->wq->lockdep_map);
2231 lock_map_acquire(&lockdep_map);
2232 trace_workqueue_execute_start(work);
2235 * While we must be careful to not use "work" after this, the trace
2236 * point will only record its address.
2238 trace_workqueue_execute_end(work);
2239 lock_map_release(&lockdep_map);
2240 lock_map_release(&cwq->wq->lockdep_map);
2242 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2243 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2244 " last function: %pf\n",
2245 current->comm, preempt_count(), task_pid_nr(current), f);
2246 debug_show_held_locks(current);
2250 spin_lock_irq(&gcwq->lock);
2252 /* clear cpu intensive status */
2253 if (unlikely(cpu_intensive))
2254 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2256 /* we're done with it, release */
2257 hlist_del_init(&worker->hentry);
2258 worker->current_work = NULL;
2259 worker->current_cwq = NULL;
2260 cwq_dec_nr_in_flight(cwq, work_color);
2264 * process_scheduled_works - process scheduled works
2267 * Process all scheduled works. Please note that the scheduled list
2268 * may change while processing a work, so this function repeatedly
2269 * fetches a work from the top and executes it.
2272 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2275 static void process_scheduled_works(struct worker *worker)
2277 while (!list_empty(&worker->scheduled)) {
2278 struct work_struct *work = list_first_entry(&worker->scheduled,
2279 struct work_struct, entry);
2280 process_one_work(worker, work);
2285 * worker_thread - the worker thread function
2288 * The gcwq worker thread function. There's a single dynamic pool of
2289 * these per each cpu. These workers process all works regardless of
2290 * their specific target workqueue. The only exception is works which
2291 * belong to workqueues with a rescuer which will be explained in
2294 static int worker_thread(void *__worker)
2296 struct worker *worker = __worker;
2297 struct worker_pool *pool = worker->pool;
2298 struct global_cwq *gcwq = pool->gcwq;
2300 /* tell the scheduler that this is a workqueue worker */
2301 worker->task->flags |= PF_WQ_WORKER;
2303 spin_lock_irq(&gcwq->lock);
2305 /* we are off idle list if destruction or rebind is requested */
2306 if (unlikely(list_empty(&worker->entry))) {
2307 spin_unlock_irq(&gcwq->lock);
2309 /* if DIE is set, destruction is requested */
2310 if (worker->flags & WORKER_DIE) {
2311 worker->task->flags &= ~PF_WQ_WORKER;
2315 /* otherwise, rebind */
2316 idle_worker_rebind(worker);
2320 worker_leave_idle(worker);
2322 /* no more worker necessary? */
2323 if (!need_more_worker(pool))
2326 /* do we need to manage? */
2327 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2331 * ->scheduled list can only be filled while a worker is
2332 * preparing to process a work or actually processing it.
2333 * Make sure nobody diddled with it while I was sleeping.
2335 BUG_ON(!list_empty(&worker->scheduled));
2338 * When control reaches this point, we're guaranteed to have
2339 * at least one idle worker or that someone else has already
2340 * assumed the manager role.
2342 worker_clr_flags(worker, WORKER_PREP);
2345 struct work_struct *work =
2346 list_first_entry(&pool->worklist,
2347 struct work_struct, entry);
2349 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2350 /* optimization path, not strictly necessary */
2351 process_one_work(worker, work);
2352 if (unlikely(!list_empty(&worker->scheduled)))
2353 process_scheduled_works(worker);
2355 move_linked_works(work, &worker->scheduled, NULL);
2356 process_scheduled_works(worker);
2358 } while (keep_working(pool));
2360 worker_set_flags(worker, WORKER_PREP, false);
2362 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2366 * gcwq->lock is held and there's no work to process and no
2367 * need to manage, sleep. Workers are woken up only while
2368 * holding gcwq->lock or from local cpu, so setting the
2369 * current state before releasing gcwq->lock is enough to
2370 * prevent losing any event.
2372 worker_enter_idle(worker);
2373 __set_current_state(TASK_INTERRUPTIBLE);
2374 spin_unlock_irq(&gcwq->lock);
2380 * rescuer_thread - the rescuer thread function
2381 * @__wq: the associated workqueue
2383 * Workqueue rescuer thread function. There's one rescuer for each
2384 * workqueue which has WQ_RESCUER set.
2386 * Regular work processing on a gcwq may block trying to create a new
2387 * worker which uses GFP_KERNEL allocation which has slight chance of
2388 * developing into deadlock if some works currently on the same queue
2389 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2390 * the problem rescuer solves.
2392 * When such condition is possible, the gcwq summons rescuers of all
2393 * workqueues which have works queued on the gcwq and let them process
2394 * those works so that forward progress can be guaranteed.
2396 * This should happen rarely.
2398 static int rescuer_thread(void *__wq)
2400 struct workqueue_struct *wq = __wq;
2401 struct worker *rescuer = wq->rescuer;
2402 struct list_head *scheduled = &rescuer->scheduled;
2403 bool is_unbound = wq->flags & WQ_UNBOUND;
2406 set_user_nice(current, RESCUER_NICE_LEVEL);
2408 set_current_state(TASK_INTERRUPTIBLE);
2410 if (kthread_should_stop())
2414 * See whether any cpu is asking for help. Unbounded
2415 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2417 for_each_mayday_cpu(cpu, wq->mayday_mask) {
2418 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2419 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2420 struct worker_pool *pool = cwq->pool;
2421 struct global_cwq *gcwq = pool->gcwq;
2422 struct work_struct *work, *n;
2424 __set_current_state(TASK_RUNNING);
2425 mayday_clear_cpu(cpu, wq->mayday_mask);
2427 /* migrate to the target cpu if possible */
2428 rescuer->pool = pool;
2429 worker_maybe_bind_and_lock(rescuer);
2432 * Slurp in all works issued via this workqueue and
2435 BUG_ON(!list_empty(&rescuer->scheduled));
2436 list_for_each_entry_safe(work, n, &pool->worklist, entry)
2437 if (get_work_cwq(work) == cwq)
2438 move_linked_works(work, scheduled, &n);
2440 process_scheduled_works(rescuer);
2443 * Leave this gcwq. If keep_working() is %true, notify a
2444 * regular worker; otherwise, we end up with 0 concurrency
2445 * and stalling the execution.
2447 if (keep_working(pool))
2448 wake_up_worker(pool);
2450 spin_unlock_irq(&gcwq->lock);
2458 struct work_struct work;
2459 struct completion done;
2462 static void wq_barrier_func(struct work_struct *work)
2464 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2465 complete(&barr->done);
2469 * insert_wq_barrier - insert a barrier work
2470 * @cwq: cwq to insert barrier into
2471 * @barr: wq_barrier to insert
2472 * @target: target work to attach @barr to
2473 * @worker: worker currently executing @target, NULL if @target is not executing
2475 * @barr is linked to @target such that @barr is completed only after
2476 * @target finishes execution. Please note that the ordering
2477 * guarantee is observed only with respect to @target and on the local
2480 * Currently, a queued barrier can't be canceled. This is because
2481 * try_to_grab_pending() can't determine whether the work to be
2482 * grabbed is at the head of the queue and thus can't clear LINKED
2483 * flag of the previous work while there must be a valid next work
2484 * after a work with LINKED flag set.
2486 * Note that when @worker is non-NULL, @target may be modified
2487 * underneath us, so we can't reliably determine cwq from @target.
2490 * spin_lock_irq(gcwq->lock).
2492 static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2493 struct wq_barrier *barr,
2494 struct work_struct *target, struct worker *worker)
2496 struct list_head *head;
2497 unsigned int linked = 0;
2500 * debugobject calls are safe here even with gcwq->lock locked
2501 * as we know for sure that this will not trigger any of the
2502 * checks and call back into the fixup functions where we
2505 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
2506 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2507 init_completion(&barr->done);
2510 * If @target is currently being executed, schedule the
2511 * barrier to the worker; otherwise, put it after @target.
2514 head = worker->scheduled.next;
2516 unsigned long *bits = work_data_bits(target);
2518 head = target->entry.next;
2519 /* there can already be other linked works, inherit and set */
2520 linked = *bits & WORK_STRUCT_LINKED;
2521 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2524 debug_work_activate(&barr->work);
2525 insert_work(cwq, &barr->work, head,
2526 work_color_to_flags(WORK_NO_COLOR) | linked);
2530 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2531 * @wq: workqueue being flushed
2532 * @flush_color: new flush color, < 0 for no-op
2533 * @work_color: new work color, < 0 for no-op
2535 * Prepare cwqs for workqueue flushing.
2537 * If @flush_color is non-negative, flush_color on all cwqs should be
2538 * -1. If no cwq has in-flight commands at the specified color, all
2539 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2540 * has in flight commands, its cwq->flush_color is set to
2541 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2542 * wakeup logic is armed and %true is returned.
2544 * The caller should have initialized @wq->first_flusher prior to
2545 * calling this function with non-negative @flush_color. If
2546 * @flush_color is negative, no flush color update is done and %false
2549 * If @work_color is non-negative, all cwqs should have the same
2550 * work_color which is previous to @work_color and all will be
2551 * advanced to @work_color.
2554 * mutex_lock(wq->flush_mutex).
2557 * %true if @flush_color >= 0 and there's something to flush. %false
2560 static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2561 int flush_color, int work_color)
2566 if (flush_color >= 0) {
2567 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2568 atomic_set(&wq->nr_cwqs_to_flush, 1);
2571 for_each_cwq_cpu(cpu, wq) {
2572 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2573 struct global_cwq *gcwq = cwq->pool->gcwq;
2575 spin_lock_irq(&gcwq->lock);
2577 if (flush_color >= 0) {
2578 BUG_ON(cwq->flush_color != -1);
2580 if (cwq->nr_in_flight[flush_color]) {
2581 cwq->flush_color = flush_color;
2582 atomic_inc(&wq->nr_cwqs_to_flush);
2587 if (work_color >= 0) {
2588 BUG_ON(work_color != work_next_color(cwq->work_color));
2589 cwq->work_color = work_color;
2592 spin_unlock_irq(&gcwq->lock);
2595 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2596 complete(&wq->first_flusher->done);
2602 * flush_workqueue - ensure that any scheduled work has run to completion.
2603 * @wq: workqueue to flush
2605 * Forces execution of the workqueue and blocks until its completion.
2606 * This is typically used in driver shutdown handlers.
2608 * We sleep until all works which were queued on entry have been handled,
2609 * but we are not livelocked by new incoming ones.
2611 void flush_workqueue(struct workqueue_struct *wq)
2613 struct wq_flusher this_flusher = {
2614 .list = LIST_HEAD_INIT(this_flusher.list),
2616 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2620 lock_map_acquire(&wq->lockdep_map);
2621 lock_map_release(&wq->lockdep_map);
2623 mutex_lock(&wq->flush_mutex);
2626 * Start-to-wait phase
2628 next_color = work_next_color(wq->work_color);
2630 if (next_color != wq->flush_color) {
2632 * Color space is not full. The current work_color
2633 * becomes our flush_color and work_color is advanced
2636 BUG_ON(!list_empty(&wq->flusher_overflow));
2637 this_flusher.flush_color = wq->work_color;
2638 wq->work_color = next_color;
2640 if (!wq->first_flusher) {
2641 /* no flush in progress, become the first flusher */
2642 BUG_ON(wq->flush_color != this_flusher.flush_color);
2644 wq->first_flusher = &this_flusher;
2646 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2648 /* nothing to flush, done */
2649 wq->flush_color = next_color;
2650 wq->first_flusher = NULL;
2655 BUG_ON(wq->flush_color == this_flusher.flush_color);
2656 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2657 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2661 * Oops, color space is full, wait on overflow queue.
2662 * The next flush completion will assign us
2663 * flush_color and transfer to flusher_queue.
2665 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2668 mutex_unlock(&wq->flush_mutex);
2670 wait_for_completion(&this_flusher.done);
2673 * Wake-up-and-cascade phase
2675 * First flushers are responsible for cascading flushes and
2676 * handling overflow. Non-first flushers can simply return.
2678 if (wq->first_flusher != &this_flusher)
2681 mutex_lock(&wq->flush_mutex);
2683 /* we might have raced, check again with mutex held */
2684 if (wq->first_flusher != &this_flusher)
2687 wq->first_flusher = NULL;
2689 BUG_ON(!list_empty(&this_flusher.list));
2690 BUG_ON(wq->flush_color != this_flusher.flush_color);
2693 struct wq_flusher *next, *tmp;
2695 /* complete all the flushers sharing the current flush color */
2696 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2697 if (next->flush_color != wq->flush_color)
2699 list_del_init(&next->list);
2700 complete(&next->done);
2703 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2704 wq->flush_color != work_next_color(wq->work_color));
2706 /* this flush_color is finished, advance by one */
2707 wq->flush_color = work_next_color(wq->flush_color);
2709 /* one color has been freed, handle overflow queue */
2710 if (!list_empty(&wq->flusher_overflow)) {
2712 * Assign the same color to all overflowed
2713 * flushers, advance work_color and append to
2714 * flusher_queue. This is the start-to-wait
2715 * phase for these overflowed flushers.
2717 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2718 tmp->flush_color = wq->work_color;
2720 wq->work_color = work_next_color(wq->work_color);
2722 list_splice_tail_init(&wq->flusher_overflow,
2723 &wq->flusher_queue);
2724 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2727 if (list_empty(&wq->flusher_queue)) {
2728 BUG_ON(wq->flush_color != wq->work_color);
2733 * Need to flush more colors. Make the next flusher
2734 * the new first flusher and arm cwqs.
2736 BUG_ON(wq->flush_color == wq->work_color);
2737 BUG_ON(wq->flush_color != next->flush_color);
2739 list_del_init(&next->list);
2740 wq->first_flusher = next;
2742 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2746 * Meh... this color is already done, clear first
2747 * flusher and repeat cascading.
2749 wq->first_flusher = NULL;
2753 mutex_unlock(&wq->flush_mutex);
2755 EXPORT_SYMBOL_GPL(flush_workqueue);
2758 * drain_workqueue - drain a workqueue
2759 * @wq: workqueue to drain
2761 * Wait until the workqueue becomes empty. While draining is in progress,
2762 * only chain queueing is allowed. IOW, only currently pending or running
2763 * work items on @wq can queue further work items on it. @wq is flushed
2764 * repeatedly until it becomes empty. The number of flushing is detemined
2765 * by the depth of chaining and should be relatively short. Whine if it
2768 void drain_workqueue(struct workqueue_struct *wq)
2770 unsigned int flush_cnt = 0;
2774 * __queue_work() needs to test whether there are drainers, is much
2775 * hotter than drain_workqueue() and already looks at @wq->flags.
2776 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2778 spin_lock(&workqueue_lock);
2779 if (!wq->nr_drainers++)
2780 wq->flags |= WQ_DRAINING;
2781 spin_unlock(&workqueue_lock);
2783 flush_workqueue(wq);
2785 for_each_cwq_cpu(cpu, wq) {
2786 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2789 spin_lock_irq(&cwq->pool->gcwq->lock);
2790 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2791 spin_unlock_irq(&cwq->pool->gcwq->lock);
2796 if (++flush_cnt == 10 ||
2797 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2798 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2799 wq->name, flush_cnt);
2803 spin_lock(&workqueue_lock);
2804 if (!--wq->nr_drainers)
2805 wq->flags &= ~WQ_DRAINING;
2806 spin_unlock(&workqueue_lock);
2808 EXPORT_SYMBOL_GPL(drain_workqueue);
2810 static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2812 struct worker *worker = NULL;
2813 struct global_cwq *gcwq;
2814 struct cpu_workqueue_struct *cwq;
2817 gcwq = get_work_gcwq(work);
2821 spin_lock_irq(&gcwq->lock);
2822 if (!list_empty(&work->entry)) {
2824 * See the comment near try_to_grab_pending()->smp_rmb().
2825 * If it was re-queued to a different gcwq under us, we
2826 * are not going to wait.
2829 cwq = get_work_cwq(work);
2830 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2833 worker = find_worker_executing_work(gcwq, work);
2836 cwq = worker->current_cwq;
2839 insert_wq_barrier(cwq, barr, work, worker);
2840 spin_unlock_irq(&gcwq->lock);
2843 * If @max_active is 1 or rescuer is in use, flushing another work
2844 * item on the same workqueue may lead to deadlock. Make sure the
2845 * flusher is not running on the same workqueue by verifying write
2848 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2849 lock_map_acquire(&cwq->wq->lockdep_map);
2851 lock_map_acquire_read(&cwq->wq->lockdep_map);
2852 lock_map_release(&cwq->wq->lockdep_map);
2856 spin_unlock_irq(&gcwq->lock);
2861 * flush_work - wait for a work to finish executing the last queueing instance
2862 * @work: the work to flush
2864 * Wait until @work has finished execution. @work is guaranteed to be idle
2865 * on return if it hasn't been requeued since flush started.
2868 * %true if flush_work() waited for the work to finish execution,
2869 * %false if it was already idle.
2871 bool flush_work(struct work_struct *work)
2873 struct wq_barrier barr;
2875 lock_map_acquire(&work->lockdep_map);
2876 lock_map_release(&work->lockdep_map);
2878 if (start_flush_work(work, &barr)) {
2879 wait_for_completion(&barr.done);
2880 destroy_work_on_stack(&barr.work);
2886 EXPORT_SYMBOL_GPL(flush_work);
2888 static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2890 unsigned long flags;
2894 ret = try_to_grab_pending(work, is_dwork, &flags);
2896 * If someone else is canceling, wait for the same event it
2897 * would be waiting for before retrying.
2899 if (unlikely(ret == -ENOENT))
2901 } while (unlikely(ret < 0));
2903 /* tell other tasks trying to grab @work to back off */
2904 mark_work_canceling(work);
2905 local_irq_restore(flags);
2908 clear_work_data(work);
2913 * cancel_work_sync - cancel a work and wait for it to finish
2914 * @work: the work to cancel
2916 * Cancel @work and wait for its execution to finish. This function
2917 * can be used even if the work re-queues itself or migrates to
2918 * another workqueue. On return from this function, @work is
2919 * guaranteed to be not pending or executing on any CPU.
2921 * cancel_work_sync(&delayed_work->work) must not be used for
2922 * delayed_work's. Use cancel_delayed_work_sync() instead.
2924 * The caller must ensure that the workqueue on which @work was last
2925 * queued can't be destroyed before this function returns.
2928 * %true if @work was pending, %false otherwise.
2930 bool cancel_work_sync(struct work_struct *work)
2932 return __cancel_work_timer(work, false);
2934 EXPORT_SYMBOL_GPL(cancel_work_sync);
2937 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2938 * @dwork: the delayed work to flush
2940 * Delayed timer is cancelled and the pending work is queued for
2941 * immediate execution. Like flush_work(), this function only
2942 * considers the last queueing instance of @dwork.
2945 * %true if flush_work() waited for the work to finish execution,
2946 * %false if it was already idle.
2948 bool flush_delayed_work(struct delayed_work *dwork)
2950 local_irq_disable();
2951 if (del_timer_sync(&dwork->timer))
2952 __queue_work(dwork->cpu,
2953 get_work_cwq(&dwork->work)->wq, &dwork->work);
2955 return flush_work(&dwork->work);
2957 EXPORT_SYMBOL(flush_delayed_work);
2960 * cancel_delayed_work - cancel a delayed work
2961 * @dwork: delayed_work to cancel
2963 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2964 * and canceled; %false if wasn't pending. Note that the work callback
2965 * function may still be running on return, unless it returns %true and the
2966 * work doesn't re-arm itself. Explicitly flush or use
2967 * cancel_delayed_work_sync() to wait on it.
2969 * This function is safe to call from any context including IRQ handler.
2971 bool cancel_delayed_work(struct delayed_work *dwork)
2973 unsigned long flags;
2977 ret = try_to_grab_pending(&dwork->work, true, &flags);
2978 } while (unlikely(ret == -EAGAIN));
2980 if (unlikely(ret < 0))
2983 set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
2984 local_irq_restore(flags);
2987 EXPORT_SYMBOL(cancel_delayed_work);
2990 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2991 * @dwork: the delayed work cancel
2993 * This is cancel_work_sync() for delayed works.
2996 * %true if @dwork was pending, %false otherwise.
2998 bool cancel_delayed_work_sync(struct delayed_work *dwork)
3000 return __cancel_work_timer(&dwork->work, true);
3002 EXPORT_SYMBOL(cancel_delayed_work_sync);
3005 * schedule_work_on - put work task on a specific cpu
3006 * @cpu: cpu to put the work task on
3007 * @work: job to be done
3009 * This puts a job on a specific cpu
3011 bool schedule_work_on(int cpu, struct work_struct *work)
3013 return queue_work_on(cpu, system_wq, work);
3015 EXPORT_SYMBOL(schedule_work_on);
3018 * schedule_work - put work task in global workqueue
3019 * @work: job to be done
3021 * Returns %false if @work was already on the kernel-global workqueue and
3024 * This puts a job in the kernel-global workqueue if it was not already
3025 * queued and leaves it in the same position on the kernel-global
3026 * workqueue otherwise.
3028 bool schedule_work(struct work_struct *work)
3030 return queue_work(system_wq, work);
3032 EXPORT_SYMBOL(schedule_work);
3035 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3037 * @dwork: job to be done
3038 * @delay: number of jiffies to wait
3040 * After waiting for a given time this puts a job in the kernel-global
3041 * workqueue on the specified CPU.
3043 bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3044 unsigned long delay)
3046 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
3048 EXPORT_SYMBOL(schedule_delayed_work_on);
3051 * schedule_delayed_work - put work task in global workqueue after delay
3052 * @dwork: job to be done
3053 * @delay: number of jiffies to wait or 0 for immediate execution
3055 * After waiting for a given time this puts a job in the kernel-global
3058 bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
3060 return queue_delayed_work(system_wq, dwork, delay);
3062 EXPORT_SYMBOL(schedule_delayed_work);
3065 * schedule_on_each_cpu - execute a function synchronously on each online CPU
3066 * @func: the function to call
3068 * schedule_on_each_cpu() executes @func on each online CPU using the
3069 * system workqueue and blocks until all CPUs have completed.
3070 * schedule_on_each_cpu() is very slow.
3073 * 0 on success, -errno on failure.
3075 int schedule_on_each_cpu(work_func_t func)
3078 struct work_struct __percpu *works;
3080 works = alloc_percpu(struct work_struct);
3086 for_each_online_cpu(cpu) {
3087 struct work_struct *work = per_cpu_ptr(works, cpu);
3089 INIT_WORK(work, func);
3090 schedule_work_on(cpu, work);
3093 for_each_online_cpu(cpu)
3094 flush_work(per_cpu_ptr(works, cpu));
3102 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3104 * Forces execution of the kernel-global workqueue and blocks until its
3107 * Think twice before calling this function! It's very easy to get into
3108 * trouble if you don't take great care. Either of the following situations
3109 * will lead to deadlock:
3111 * One of the work items currently on the workqueue needs to acquire
3112 * a lock held by your code or its caller.
3114 * Your code is running in the context of a work routine.
3116 * They will be detected by lockdep when they occur, but the first might not
3117 * occur very often. It depends on what work items are on the workqueue and
3118 * what locks they need, which you have no control over.
3120 * In most situations flushing the entire workqueue is overkill; you merely
3121 * need to know that a particular work item isn't queued and isn't running.
3122 * In such cases you should use cancel_delayed_work_sync() or
3123 * cancel_work_sync() instead.
3125 void flush_scheduled_work(void)
3127 flush_workqueue(system_wq);
3129 EXPORT_SYMBOL(flush_scheduled_work);
3132 * execute_in_process_context - reliably execute the routine with user context
3133 * @fn: the function to execute
3134 * @ew: guaranteed storage for the execute work structure (must
3135 * be available when the work executes)
3137 * Executes the function immediately if process context is available,
3138 * otherwise schedules the function for delayed execution.
3140 * Returns: 0 - function was executed
3141 * 1 - function was scheduled for execution
3143 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
3145 if (!in_interrupt()) {
3150 INIT_WORK(&ew->work, fn);
3151 schedule_work(&ew->work);
3155 EXPORT_SYMBOL_GPL(execute_in_process_context);
3157 int keventd_up(void)
3159 return system_wq != NULL;
3162 static int alloc_cwqs(struct workqueue_struct *wq)
3165 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3166 * Make sure that the alignment isn't lower than that of
3167 * unsigned long long.
3169 const size_t size = sizeof(struct cpu_workqueue_struct);
3170 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3171 __alignof__(unsigned long long));
3173 if (!(wq->flags & WQ_UNBOUND))
3174 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3179 * Allocate enough room to align cwq and put an extra
3180 * pointer at the end pointing back to the originally
3181 * allocated pointer which will be used for free.
3183 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3185 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3186 *(void **)(wq->cpu_wq.single + 1) = ptr;
3190 /* just in case, make sure it's actually aligned */
3191 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3192 return wq->cpu_wq.v ? 0 : -ENOMEM;
3195 static void free_cwqs(struct workqueue_struct *wq)
3197 if (!(wq->flags & WQ_UNBOUND))
3198 free_percpu(wq->cpu_wq.pcpu);
3199 else if (wq->cpu_wq.single) {
3200 /* the pointer to free is stored right after the cwq */
3201 kfree(*(void **)(wq->cpu_wq.single + 1));
3205 static int wq_clamp_max_active(int max_active, unsigned int flags,
3208 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3210 if (max_active < 1 || max_active > lim)
3211 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3212 max_active, name, 1, lim);
3214 return clamp_val(max_active, 1, lim);
3217 struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
3220 struct lock_class_key *key,
3221 const char *lock_name, ...)
3223 va_list args, args1;
3224 struct workqueue_struct *wq;
3228 /* determine namelen, allocate wq and format name */
3229 va_start(args, lock_name);
3230 va_copy(args1, args);
3231 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3233 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3237 vsnprintf(wq->name, namelen, fmt, args1);
3242 * Workqueues which may be used during memory reclaim should
3243 * have a rescuer to guarantee forward progress.
3245 if (flags & WQ_MEM_RECLAIM)
3246 flags |= WQ_RESCUER;
3248 max_active = max_active ?: WQ_DFL_ACTIVE;
3249 max_active = wq_clamp_max_active(max_active, flags, wq->name);
3253 wq->saved_max_active = max_active;
3254 mutex_init(&wq->flush_mutex);
3255 atomic_set(&wq->nr_cwqs_to_flush, 0);
3256 INIT_LIST_HEAD(&wq->flusher_queue);
3257 INIT_LIST_HEAD(&wq->flusher_overflow);
3259 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3260 INIT_LIST_HEAD(&wq->list);
3262 if (alloc_cwqs(wq) < 0)
3265 for_each_cwq_cpu(cpu, wq) {
3266 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3267 struct global_cwq *gcwq = get_gcwq(cpu);
3268 int pool_idx = (bool)(flags & WQ_HIGHPRI);
3270 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
3271 cwq->pool = &gcwq->pools[pool_idx];
3273 cwq->flush_color = -1;
3274 cwq->max_active = max_active;
3275 INIT_LIST_HEAD(&cwq->delayed_works);
3278 if (flags & WQ_RESCUER) {
3279 struct worker *rescuer;
3281 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3284 wq->rescuer = rescuer = alloc_worker();
3288 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3290 if (IS_ERR(rescuer->task))
3293 rescuer->task->flags |= PF_THREAD_BOUND;
3294 wake_up_process(rescuer->task);
3298 * workqueue_lock protects global freeze state and workqueues
3299 * list. Grab it, set max_active accordingly and add the new
3300 * workqueue to workqueues list.
3302 spin_lock(&workqueue_lock);
3304 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3305 for_each_cwq_cpu(cpu, wq)
3306 get_cwq(cpu, wq)->max_active = 0;
3308 list_add(&wq->list, &workqueues);
3310 spin_unlock(&workqueue_lock);
3316 free_mayday_mask(wq->mayday_mask);
3322 EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
3325 * destroy_workqueue - safely terminate a workqueue
3326 * @wq: target workqueue
3328 * Safely destroy a workqueue. All work currently pending will be done first.
3330 void destroy_workqueue(struct workqueue_struct *wq)
3334 /* drain it before proceeding with destruction */
3335 drain_workqueue(wq);
3338 * wq list is used to freeze wq, remove from list after
3339 * flushing is complete in case freeze races us.
3341 spin_lock(&workqueue_lock);
3342 list_del(&wq->list);
3343 spin_unlock(&workqueue_lock);
3346 for_each_cwq_cpu(cpu, wq) {
3347 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3350 for (i = 0; i < WORK_NR_COLORS; i++)
3351 BUG_ON(cwq->nr_in_flight[i]);
3352 BUG_ON(cwq->nr_active);
3353 BUG_ON(!list_empty(&cwq->delayed_works));
3356 if (wq->flags & WQ_RESCUER) {
3357 kthread_stop(wq->rescuer->task);
3358 free_mayday_mask(wq->mayday_mask);
3365 EXPORT_SYMBOL_GPL(destroy_workqueue);
3368 * cwq_set_max_active - adjust max_active of a cwq
3369 * @cwq: target cpu_workqueue_struct
3370 * @max_active: new max_active value.
3372 * Set @cwq->max_active to @max_active and activate delayed works if
3376 * spin_lock_irq(gcwq->lock).
3378 static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
3380 cwq->max_active = max_active;
3382 while (!list_empty(&cwq->delayed_works) &&
3383 cwq->nr_active < cwq->max_active)
3384 cwq_activate_first_delayed(cwq);
3388 * workqueue_set_max_active - adjust max_active of a workqueue
3389 * @wq: target workqueue
3390 * @max_active: new max_active value.
3392 * Set max_active of @wq to @max_active.
3395 * Don't call from IRQ context.
3397 void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3401 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3403 spin_lock(&workqueue_lock);
3405 wq->saved_max_active = max_active;
3407 for_each_cwq_cpu(cpu, wq) {
3408 struct global_cwq *gcwq = get_gcwq(cpu);
3410 spin_lock_irq(&gcwq->lock);
3412 if (!(wq->flags & WQ_FREEZABLE) ||
3413 !(gcwq->flags & GCWQ_FREEZING))
3414 cwq_set_max_active(get_cwq(gcwq->cpu, wq), max_active);
3416 spin_unlock_irq(&gcwq->lock);
3419 spin_unlock(&workqueue_lock);
3421 EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3424 * workqueue_congested - test whether a workqueue is congested
3425 * @cpu: CPU in question
3426 * @wq: target workqueue
3428 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3429 * no synchronization around this function and the test result is
3430 * unreliable and only useful as advisory hints or for debugging.
3433 * %true if congested, %false otherwise.
3435 bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3437 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3439 return !list_empty(&cwq->delayed_works);
3441 EXPORT_SYMBOL_GPL(workqueue_congested);
3444 * work_cpu - return the last known associated cpu for @work
3445 * @work: the work of interest
3448 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
3450 unsigned int work_cpu(struct work_struct *work)
3452 struct global_cwq *gcwq = get_work_gcwq(work);
3454 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3456 EXPORT_SYMBOL_GPL(work_cpu);
3459 * work_busy - test whether a work is currently pending or running
3460 * @work: the work to be tested
3462 * Test whether @work is currently pending or running. There is no
3463 * synchronization around this function and the test result is
3464 * unreliable and only useful as advisory hints or for debugging.
3465 * Especially for reentrant wqs, the pending state might hide the
3469 * OR'd bitmask of WORK_BUSY_* bits.
3471 unsigned int work_busy(struct work_struct *work)
3473 struct global_cwq *gcwq = get_work_gcwq(work);
3474 unsigned long flags;
3475 unsigned int ret = 0;
3480 spin_lock_irqsave(&gcwq->lock, flags);
3482 if (work_pending(work))
3483 ret |= WORK_BUSY_PENDING;
3484 if (find_worker_executing_work(gcwq, work))
3485 ret |= WORK_BUSY_RUNNING;
3487 spin_unlock_irqrestore(&gcwq->lock, flags);
3491 EXPORT_SYMBOL_GPL(work_busy);
3496 * There are two challenges in supporting CPU hotplug. Firstly, there
3497 * are a lot of assumptions on strong associations among work, cwq and
3498 * gcwq which make migrating pending and scheduled works very
3499 * difficult to implement without impacting hot paths. Secondly,
3500 * gcwqs serve mix of short, long and very long running works making
3501 * blocked draining impractical.
3503 * This is solved by allowing a gcwq to be disassociated from the CPU
3504 * running as an unbound one and allowing it to be reattached later if the
3505 * cpu comes back online.
3508 /* claim manager positions of all pools */
3509 static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
3511 struct worker_pool *pool;
3513 for_each_worker_pool(pool, gcwq)
3514 mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
3515 spin_lock_irq(&gcwq->lock);
3518 /* release manager positions */
3519 static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
3521 struct worker_pool *pool;
3523 spin_unlock_irq(&gcwq->lock);
3524 for_each_worker_pool(pool, gcwq)
3525 mutex_unlock(&pool->assoc_mutex);
3528 static void gcwq_unbind_fn(struct work_struct *work)
3530 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
3531 struct worker_pool *pool;
3532 struct worker *worker;
3533 struct hlist_node *pos;
3536 BUG_ON(gcwq->cpu != smp_processor_id());
3538 gcwq_claim_assoc_and_lock(gcwq);
3541 * We've claimed all manager positions. Make all workers unbound
3542 * and set DISASSOCIATED. Before this, all workers except for the
3543 * ones which are still executing works from before the last CPU
3544 * down must be on the cpu. After this, they may become diasporas.
3546 for_each_worker_pool(pool, gcwq)
3547 list_for_each_entry(worker, &pool->idle_list, entry)
3548 worker->flags |= WORKER_UNBOUND;
3550 for_each_busy_worker(worker, i, pos, gcwq)
3551 worker->flags |= WORKER_UNBOUND;
3553 gcwq->flags |= GCWQ_DISASSOCIATED;
3555 gcwq_release_assoc_and_unlock(gcwq);
3558 * Call schedule() so that we cross rq->lock and thus can guarantee
3559 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3560 * as scheduler callbacks may be invoked from other cpus.
3565 * Sched callbacks are disabled now. Zap nr_running. After this,
3566 * nr_running stays zero and need_more_worker() and keep_working()
3567 * are always true as long as the worklist is not empty. @gcwq now
3568 * behaves as unbound (in terms of concurrency management) gcwq
3569 * which is served by workers tied to the CPU.
3571 * On return from this function, the current worker would trigger
3572 * unbound chain execution of pending work items if other workers
3575 for_each_worker_pool(pool, gcwq)
3576 atomic_set(get_pool_nr_running(pool), 0);
3580 * Workqueues should be brought up before normal priority CPU notifiers.
3581 * This will be registered high priority CPU notifier.
3583 static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
3584 unsigned long action,
3587 unsigned int cpu = (unsigned long)hcpu;
3588 struct global_cwq *gcwq = get_gcwq(cpu);
3589 struct worker_pool *pool;
3591 switch (action & ~CPU_TASKS_FROZEN) {
3592 case CPU_UP_PREPARE:
3593 for_each_worker_pool(pool, gcwq) {
3594 struct worker *worker;
3596 if (pool->nr_workers)
3599 worker = create_worker(pool);
3603 spin_lock_irq(&gcwq->lock);
3604 start_worker(worker);
3605 spin_unlock_irq(&gcwq->lock);
3609 case CPU_DOWN_FAILED:
3611 gcwq_claim_assoc_and_lock(gcwq);
3612 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3613 rebind_workers(gcwq);
3614 gcwq_release_assoc_and_unlock(gcwq);
3621 * Workqueues should be brought down after normal priority CPU notifiers.
3622 * This will be registered as low priority CPU notifier.
3624 static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
3625 unsigned long action,
3628 unsigned int cpu = (unsigned long)hcpu;
3629 struct work_struct unbind_work;
3631 switch (action & ~CPU_TASKS_FROZEN) {
3632 case CPU_DOWN_PREPARE:
3633 /* unbinding should happen on the local CPU */
3634 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
3635 queue_work_on(cpu, system_highpri_wq, &unbind_work);
3636 flush_work(&unbind_work);
3644 struct work_for_cpu {
3645 struct work_struct work;
3651 static void work_for_cpu_fn(struct work_struct *work)
3653 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3655 wfc->ret = wfc->fn(wfc->arg);
3659 * work_on_cpu - run a function in user context on a particular cpu
3660 * @cpu: the cpu to run on
3661 * @fn: the function to run
3662 * @arg: the function arg
3664 * This will return the value @fn returns.
3665 * It is up to the caller to ensure that the cpu doesn't go offline.
3666 * The caller must not hold any locks which would prevent @fn from completing.
3668 long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3670 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
3672 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3673 schedule_work_on(cpu, &wfc.work);
3674 flush_work(&wfc.work);
3677 EXPORT_SYMBOL_GPL(work_on_cpu);
3678 #endif /* CONFIG_SMP */
3680 #ifdef CONFIG_FREEZER
3683 * freeze_workqueues_begin - begin freezing workqueues
3685 * Start freezing workqueues. After this function returns, all freezable
3686 * workqueues will queue new works to their frozen_works list instead of
3690 * Grabs and releases workqueue_lock and gcwq->lock's.
3692 void freeze_workqueues_begin(void)
3696 spin_lock(&workqueue_lock);
3698 BUG_ON(workqueue_freezing);
3699 workqueue_freezing = true;
3701 for_each_gcwq_cpu(cpu) {
3702 struct global_cwq *gcwq = get_gcwq(cpu);
3703 struct workqueue_struct *wq;
3705 spin_lock_irq(&gcwq->lock);
3707 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3708 gcwq->flags |= GCWQ_FREEZING;
3710 list_for_each_entry(wq, &workqueues, list) {
3711 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3713 if (cwq && wq->flags & WQ_FREEZABLE)
3714 cwq->max_active = 0;
3717 spin_unlock_irq(&gcwq->lock);
3720 spin_unlock(&workqueue_lock);
3724 * freeze_workqueues_busy - are freezable workqueues still busy?
3726 * Check whether freezing is complete. This function must be called
3727 * between freeze_workqueues_begin() and thaw_workqueues().
3730 * Grabs and releases workqueue_lock.
3733 * %true if some freezable workqueues are still busy. %false if freezing
3736 bool freeze_workqueues_busy(void)
3741 spin_lock(&workqueue_lock);
3743 BUG_ON(!workqueue_freezing);
3745 for_each_gcwq_cpu(cpu) {
3746 struct workqueue_struct *wq;
3748 * nr_active is monotonically decreasing. It's safe
3749 * to peek without lock.
3751 list_for_each_entry(wq, &workqueues, list) {
3752 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3754 if (!cwq || !(wq->flags & WQ_FREEZABLE))
3757 BUG_ON(cwq->nr_active < 0);
3758 if (cwq->nr_active) {
3765 spin_unlock(&workqueue_lock);
3770 * thaw_workqueues - thaw workqueues
3772 * Thaw workqueues. Normal queueing is restored and all collected
3773 * frozen works are transferred to their respective gcwq worklists.
3776 * Grabs and releases workqueue_lock and gcwq->lock's.
3778 void thaw_workqueues(void)
3782 spin_lock(&workqueue_lock);
3784 if (!workqueue_freezing)
3787 for_each_gcwq_cpu(cpu) {
3788 struct global_cwq *gcwq = get_gcwq(cpu);
3789 struct worker_pool *pool;
3790 struct workqueue_struct *wq;
3792 spin_lock_irq(&gcwq->lock);
3794 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3795 gcwq->flags &= ~GCWQ_FREEZING;
3797 list_for_each_entry(wq, &workqueues, list) {
3798 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3800 if (!cwq || !(wq->flags & WQ_FREEZABLE))
3803 /* restore max_active and repopulate worklist */
3804 cwq_set_max_active(cwq, wq->saved_max_active);
3807 for_each_worker_pool(pool, gcwq)
3808 wake_up_worker(pool);
3810 spin_unlock_irq(&gcwq->lock);
3813 workqueue_freezing = false;
3815 spin_unlock(&workqueue_lock);
3817 #endif /* CONFIG_FREEZER */
3819 static int __init init_workqueues(void)
3824 /* make sure we have enough bits for OFFQ CPU number */
3825 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3828 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3829 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
3831 /* initialize gcwqs */
3832 for_each_gcwq_cpu(cpu) {
3833 struct global_cwq *gcwq = get_gcwq(cpu);
3834 struct worker_pool *pool;
3836 spin_lock_init(&gcwq->lock);
3838 gcwq->flags |= GCWQ_DISASSOCIATED;
3840 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3841 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3843 for_each_worker_pool(pool, gcwq) {
3845 INIT_LIST_HEAD(&pool->worklist);
3846 INIT_LIST_HEAD(&pool->idle_list);
3848 init_timer_deferrable(&pool->idle_timer);
3849 pool->idle_timer.function = idle_worker_timeout;
3850 pool->idle_timer.data = (unsigned long)pool;
3852 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3853 (unsigned long)pool);
3855 mutex_init(&pool->assoc_mutex);
3856 ida_init(&pool->worker_ida);
3860 /* create the initial worker */
3861 for_each_online_gcwq_cpu(cpu) {
3862 struct global_cwq *gcwq = get_gcwq(cpu);
3863 struct worker_pool *pool;
3865 if (cpu != WORK_CPU_UNBOUND)
3866 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3868 for_each_worker_pool(pool, gcwq) {
3869 struct worker *worker;
3871 worker = create_worker(pool);
3873 spin_lock_irq(&gcwq->lock);
3874 start_worker(worker);
3875 spin_unlock_irq(&gcwq->lock);
3879 system_wq = alloc_workqueue("events", 0, 0);
3880 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
3881 system_long_wq = alloc_workqueue("events_long", 0, 0);
3882 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3883 WQ_UNBOUND_MAX_ACTIVE);
3884 system_freezable_wq = alloc_workqueue("events_freezable",
3886 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
3887 !system_unbound_wq || !system_freezable_wq);
3890 early_initcall(init_workqueues);