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 are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
24 * Please read Documentation/workqueue.txt for details.
27 #include <linux/export.h>
28 #include <linux/kernel.h>
29 #include <linux/sched.h>
30 #include <linux/init.h>
31 #include <linux/signal.h>
32 #include <linux/completion.h>
33 #include <linux/workqueue.h>
34 #include <linux/slab.h>
35 #include <linux/cpu.h>
36 #include <linux/notifier.h>
37 #include <linux/kthread.h>
38 #include <linux/hardirq.h>
39 #include <linux/mempolicy.h>
40 #include <linux/freezer.h>
41 #include <linux/kallsyms.h>
42 #include <linux/debug_locks.h>
43 #include <linux/lockdep.h>
44 #include <linux/idr.h>
45 #include <linux/jhash.h>
46 #include <linux/hashtable.h>
47 #include <linux/rculist.h>
48 #include <linux/nodemask.h>
49 #include <linux/moduleparam.h>
50 #include <linux/uaccess.h>
52 #include "workqueue_internal.h"
58 * A bound pool is either associated or disassociated with its CPU.
59 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
65 * be executing on any CPU. The pool behaves as an unbound one.
67 * Note that DISASSOCIATED should be flipped only while holding
68 * manager_mutex to avoid changing binding state while
69 * create_worker() is in progress.
71 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
72 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
73 POOL_FREEZING = 1 << 3, /* freeze in progress */
76 WORKER_STARTED = 1 << 0, /* started */
77 WORKER_DIE = 1 << 1, /* die die die */
78 WORKER_IDLE = 1 << 2, /* is idle */
79 WORKER_PREP = 1 << 3, /* preparing to run works */
80 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
81 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
82 WORKER_REBOUND = 1 << 8, /* worker was rebound */
84 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
85 WORKER_UNBOUND | WORKER_REBOUND,
87 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
89 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
90 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
92 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
93 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
95 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
96 /* call for help after 10ms
98 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
99 CREATE_COOLDOWN = HZ, /* time to breath after fail */
102 * Rescue workers are used only on emergencies and shared by
103 * all cpus. Give -20.
105 RESCUER_NICE_LEVEL = -20,
106 HIGHPRI_NICE_LEVEL = -20,
112 * Structure fields follow one of the following exclusion rules.
114 * I: Modifiable by initialization/destruction paths and read-only for
117 * P: Preemption protected. Disabling preemption is enough and should
118 * only be modified and accessed from the local cpu.
120 * L: pool->lock protected. Access with pool->lock held.
122 * X: During normal operation, modification requires pool->lock and should
123 * be done only from local cpu. Either disabling preemption on local
124 * cpu or grabbing pool->lock is enough for read access. If
125 * POOL_DISASSOCIATED is set, it's identical to L.
127 * MG: pool->manager_mutex and pool->lock protected. Writes require both
128 * locks. Reads can happen under either lock.
130 * PL: wq_pool_mutex protected.
132 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
134 * WQ: wq->mutex protected.
136 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
138 * MD: wq_mayday_lock protected.
141 /* struct worker is defined in workqueue_internal.h */
144 spinlock_t lock; /* the pool lock */
145 int cpu; /* I: the associated cpu */
146 int node; /* I: the associated node ID */
147 int id; /* I: pool ID */
148 unsigned int flags; /* X: flags */
150 struct list_head worklist; /* L: list of pending works */
151 int nr_workers; /* L: total number of workers */
153 /* nr_idle includes the ones off idle_list for rebinding */
154 int nr_idle; /* L: currently idle ones */
156 struct list_head idle_list; /* X: list of idle workers */
157 struct timer_list idle_timer; /* L: worker idle timeout */
158 struct timer_list mayday_timer; /* L: SOS timer for workers */
160 /* a workers is either on busy_hash or idle_list, or the manager */
161 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
162 /* L: hash of busy workers */
164 /* see manage_workers() for details on the two manager mutexes */
165 struct mutex manager_arb; /* manager arbitration */
166 struct mutex manager_mutex; /* manager exclusion */
167 struct idr worker_idr; /* MG: worker IDs and iteration */
169 struct workqueue_attrs *attrs; /* I: worker attributes */
170 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
171 int refcnt; /* PL: refcnt for unbound pools */
174 * The current concurrency level. As it's likely to be accessed
175 * from other CPUs during try_to_wake_up(), put it in a separate
178 atomic_t nr_running ____cacheline_aligned_in_smp;
181 * Destruction of pool is sched-RCU protected to allow dereferences
182 * from get_work_pool().
185 } ____cacheline_aligned_in_smp;
188 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
189 * of work_struct->data are used for flags and the remaining high bits
190 * point to the pwq; thus, pwqs need to be aligned at two's power of the
191 * number of flag bits.
193 struct pool_workqueue {
194 struct worker_pool *pool; /* I: the associated pool */
195 struct workqueue_struct *wq; /* I: the owning workqueue */
196 int work_color; /* L: current color */
197 int flush_color; /* L: flushing color */
198 int refcnt; /* L: reference count */
199 int nr_in_flight[WORK_NR_COLORS];
200 /* L: nr of in_flight works */
201 int nr_active; /* L: nr of active works */
202 int max_active; /* L: max active works */
203 struct list_head delayed_works; /* L: delayed works */
204 struct list_head pwqs_node; /* WR: node on wq->pwqs */
205 struct list_head mayday_node; /* MD: node on wq->maydays */
208 * Release of unbound pwq is punted to system_wq. See put_pwq()
209 * and pwq_unbound_release_workfn() for details. pool_workqueue
210 * itself is also sched-RCU protected so that the first pwq can be
211 * determined without grabbing wq->mutex.
213 struct work_struct unbound_release_work;
215 } __aligned(1 << WORK_STRUCT_FLAG_BITS);
218 * Structure used to wait for workqueue flush.
221 struct list_head list; /* WQ: list of flushers */
222 int flush_color; /* WQ: flush color waiting for */
223 struct completion done; /* flush completion */
229 * The externally visible workqueue. It relays the issued work items to
230 * the appropriate worker_pool through its pool_workqueues.
232 struct workqueue_struct {
233 struct list_head pwqs; /* WR: all pwqs of this wq */
234 struct list_head list; /* PL: list of all workqueues */
236 struct mutex mutex; /* protects this wq */
237 int work_color; /* WQ: current work color */
238 int flush_color; /* WQ: current flush color */
239 atomic_t nr_pwqs_to_flush; /* flush in progress */
240 struct wq_flusher *first_flusher; /* WQ: first flusher */
241 struct list_head flusher_queue; /* WQ: flush waiters */
242 struct list_head flusher_overflow; /* WQ: flush overflow list */
244 struct list_head maydays; /* MD: pwqs requesting rescue */
245 struct worker *rescuer; /* I: rescue worker */
247 int nr_drainers; /* WQ: drain in progress */
248 int saved_max_active; /* WQ: saved pwq max_active */
250 struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */
251 struct pool_workqueue *dfl_pwq; /* WQ: only for unbound wqs */
254 struct wq_device *wq_dev; /* I: for sysfs interface */
256 #ifdef CONFIG_LOCKDEP
257 struct lockdep_map lockdep_map;
259 char name[WQ_NAME_LEN]; /* I: workqueue name */
261 /* hot fields used during command issue, aligned to cacheline */
262 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
263 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
264 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */
267 static struct kmem_cache *pwq_cache;
269 static int wq_numa_tbl_len; /* highest possible NUMA node id + 1 */
270 static cpumask_var_t *wq_numa_possible_cpumask;
271 /* possible CPUs of each node */
273 static bool wq_disable_numa;
274 module_param_named(disable_numa, wq_disable_numa, bool, 0444);
276 /* see the comment above the definition of WQ_POWER_EFFICIENT */
277 #ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
278 static bool wq_power_efficient = true;
280 static bool wq_power_efficient;
283 module_param_named(power_efficient, wq_power_efficient, bool, 0444);
285 static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
287 /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
288 static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
290 static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
291 static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
293 static LIST_HEAD(workqueues); /* PL: list of all workqueues */
294 static bool workqueue_freezing; /* PL: have wqs started freezing? */
296 /* the per-cpu worker pools */
297 static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
300 static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
302 /* PL: hash of all unbound pools keyed by pool->attrs */
303 static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
305 /* I: attributes used when instantiating standard unbound pools on demand */
306 static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
308 struct workqueue_struct *system_wq __read_mostly;
309 EXPORT_SYMBOL(system_wq);
310 struct workqueue_struct *system_highpri_wq __read_mostly;
311 EXPORT_SYMBOL_GPL(system_highpri_wq);
312 struct workqueue_struct *system_long_wq __read_mostly;
313 EXPORT_SYMBOL_GPL(system_long_wq);
314 struct workqueue_struct *system_unbound_wq __read_mostly;
315 EXPORT_SYMBOL_GPL(system_unbound_wq);
316 struct workqueue_struct *system_freezable_wq __read_mostly;
317 EXPORT_SYMBOL_GPL(system_freezable_wq);
318 struct workqueue_struct *system_power_efficient_wq __read_mostly;
319 EXPORT_SYMBOL_GPL(system_power_efficient_wq);
320 struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
321 EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
323 static int worker_thread(void *__worker);
324 static void copy_workqueue_attrs(struct workqueue_attrs *to,
325 const struct workqueue_attrs *from);
327 #define CREATE_TRACE_POINTS
328 #include <trace/events/workqueue.h>
330 #define assert_rcu_or_pool_mutex() \
331 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
332 lockdep_is_held(&wq_pool_mutex), \
333 "sched RCU or wq_pool_mutex should be held")
335 #define assert_rcu_or_wq_mutex(wq) \
336 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
337 lockdep_is_held(&wq->mutex), \
338 "sched RCU or wq->mutex should be held")
340 #ifdef CONFIG_LOCKDEP
341 #define assert_manager_or_pool_lock(pool) \
342 WARN_ONCE(debug_locks && \
343 !lockdep_is_held(&(pool)->manager_mutex) && \
344 !lockdep_is_held(&(pool)->lock), \
345 "pool->manager_mutex or ->lock should be held")
347 #define assert_manager_or_pool_lock(pool) do { } while (0)
350 #define for_each_cpu_worker_pool(pool, cpu) \
351 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
352 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
356 * for_each_pool - iterate through all worker_pools in the system
357 * @pool: iteration cursor
358 * @pi: integer used for iteration
360 * This must be called either with wq_pool_mutex held or sched RCU read
361 * locked. If the pool needs to be used beyond the locking in effect, the
362 * caller is responsible for guaranteeing that the pool stays online.
364 * The if/else clause exists only for the lockdep assertion and can be
367 #define for_each_pool(pool, pi) \
368 idr_for_each_entry(&worker_pool_idr, pool, pi) \
369 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
373 * for_each_pool_worker - iterate through all workers of a worker_pool
374 * @worker: iteration cursor
375 * @wi: integer used for iteration
376 * @pool: worker_pool to iterate workers of
378 * This must be called with either @pool->manager_mutex or ->lock held.
380 * The if/else clause exists only for the lockdep assertion and can be
383 #define for_each_pool_worker(worker, wi, pool) \
384 idr_for_each_entry(&(pool)->worker_idr, (worker), (wi)) \
385 if (({ assert_manager_or_pool_lock((pool)); false; })) { } \
389 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
390 * @pwq: iteration cursor
391 * @wq: the target workqueue
393 * This must be called either with wq->mutex held or sched RCU read locked.
394 * If the pwq needs to be used beyond the locking in effect, the caller is
395 * responsible for guaranteeing that the pwq stays online.
397 * The if/else clause exists only for the lockdep assertion and can be
400 #define for_each_pwq(pwq, wq) \
401 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
402 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
405 #ifdef CONFIG_DEBUG_OBJECTS_WORK
407 static struct debug_obj_descr work_debug_descr;
409 static void *work_debug_hint(void *addr)
411 return ((struct work_struct *) addr)->func;
415 * fixup_init is called when:
416 * - an active object is initialized
418 static int work_fixup_init(void *addr, enum debug_obj_state state)
420 struct work_struct *work = addr;
423 case ODEBUG_STATE_ACTIVE:
424 cancel_work_sync(work);
425 debug_object_init(work, &work_debug_descr);
433 * fixup_activate is called when:
434 * - an active object is activated
435 * - an unknown object is activated (might be a statically initialized object)
437 static int work_fixup_activate(void *addr, enum debug_obj_state state)
439 struct work_struct *work = addr;
443 case ODEBUG_STATE_NOTAVAILABLE:
445 * This is not really a fixup. The work struct was
446 * statically initialized. We just make sure that it
447 * is tracked in the object tracker.
449 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
450 debug_object_init(work, &work_debug_descr);
451 debug_object_activate(work, &work_debug_descr);
457 case ODEBUG_STATE_ACTIVE:
466 * fixup_free is called when:
467 * - an active object is freed
469 static int work_fixup_free(void *addr, enum debug_obj_state state)
471 struct work_struct *work = addr;
474 case ODEBUG_STATE_ACTIVE:
475 cancel_work_sync(work);
476 debug_object_free(work, &work_debug_descr);
483 static struct debug_obj_descr work_debug_descr = {
484 .name = "work_struct",
485 .debug_hint = work_debug_hint,
486 .fixup_init = work_fixup_init,
487 .fixup_activate = work_fixup_activate,
488 .fixup_free = work_fixup_free,
491 static inline void debug_work_activate(struct work_struct *work)
493 debug_object_activate(work, &work_debug_descr);
496 static inline void debug_work_deactivate(struct work_struct *work)
498 debug_object_deactivate(work, &work_debug_descr);
501 void __init_work(struct work_struct *work, int onstack)
504 debug_object_init_on_stack(work, &work_debug_descr);
506 debug_object_init(work, &work_debug_descr);
508 EXPORT_SYMBOL_GPL(__init_work);
510 void destroy_work_on_stack(struct work_struct *work)
512 debug_object_free(work, &work_debug_descr);
514 EXPORT_SYMBOL_GPL(destroy_work_on_stack);
517 static inline void debug_work_activate(struct work_struct *work) { }
518 static inline void debug_work_deactivate(struct work_struct *work) { }
521 /* allocate ID and assign it to @pool */
522 static int worker_pool_assign_id(struct worker_pool *pool)
526 lockdep_assert_held(&wq_pool_mutex);
528 ret = idr_alloc(&worker_pool_idr, pool, 0, 0, GFP_KERNEL);
537 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
538 * @wq: the target workqueue
541 * This must be called either with pwq_lock held or sched RCU read locked.
542 * If the pwq needs to be used beyond the locking in effect, the caller is
543 * responsible for guaranteeing that the pwq stays online.
545 * Return: The unbound pool_workqueue for @node.
547 static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
550 assert_rcu_or_wq_mutex(wq);
551 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
554 static unsigned int work_color_to_flags(int color)
556 return color << WORK_STRUCT_COLOR_SHIFT;
559 static int get_work_color(struct work_struct *work)
561 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
562 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
565 static int work_next_color(int color)
567 return (color + 1) % WORK_NR_COLORS;
571 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
572 * contain the pointer to the queued pwq. Once execution starts, the flag
573 * is cleared and the high bits contain OFFQ flags and pool ID.
575 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
576 * and clear_work_data() can be used to set the pwq, pool or clear
577 * work->data. These functions should only be called while the work is
578 * owned - ie. while the PENDING bit is set.
580 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
581 * corresponding to a work. Pool is available once the work has been
582 * queued anywhere after initialization until it is sync canceled. pwq is
583 * available only while the work item is queued.
585 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
586 * canceled. While being canceled, a work item may have its PENDING set
587 * but stay off timer and worklist for arbitrarily long and nobody should
588 * try to steal the PENDING bit.
590 static inline void set_work_data(struct work_struct *work, unsigned long data,
593 WARN_ON_ONCE(!work_pending(work));
594 atomic_long_set(&work->data, data | flags | work_static(work));
597 static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
598 unsigned long extra_flags)
600 set_work_data(work, (unsigned long)pwq,
601 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
604 static void set_work_pool_and_keep_pending(struct work_struct *work,
607 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
608 WORK_STRUCT_PENDING);
611 static void set_work_pool_and_clear_pending(struct work_struct *work,
615 * The following wmb is paired with the implied mb in
616 * test_and_set_bit(PENDING) and ensures all updates to @work made
617 * here are visible to and precede any updates by the next PENDING
621 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
624 static void clear_work_data(struct work_struct *work)
626 smp_wmb(); /* see set_work_pool_and_clear_pending() */
627 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
630 static struct pool_workqueue *get_work_pwq(struct work_struct *work)
632 unsigned long data = atomic_long_read(&work->data);
634 if (data & WORK_STRUCT_PWQ)
635 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
641 * get_work_pool - return the worker_pool a given work was associated with
642 * @work: the work item of interest
644 * Pools are created and destroyed under wq_pool_mutex, and allows read
645 * access under sched-RCU read lock. As such, this function should be
646 * called under wq_pool_mutex or with preemption disabled.
648 * All fields of the returned pool are accessible as long as the above
649 * mentioned locking is in effect. If the returned pool needs to be used
650 * beyond the critical section, the caller is responsible for ensuring the
651 * returned pool is and stays online.
653 * Return: The worker_pool @work was last associated with. %NULL if none.
655 static struct worker_pool *get_work_pool(struct work_struct *work)
657 unsigned long data = atomic_long_read(&work->data);
660 assert_rcu_or_pool_mutex();
662 if (data & WORK_STRUCT_PWQ)
663 return ((struct pool_workqueue *)
664 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
666 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
667 if (pool_id == WORK_OFFQ_POOL_NONE)
670 return idr_find(&worker_pool_idr, pool_id);
674 * get_work_pool_id - return the worker pool ID a given work is associated with
675 * @work: the work item of interest
677 * Return: The worker_pool ID @work was last associated with.
678 * %WORK_OFFQ_POOL_NONE if none.
680 static int get_work_pool_id(struct work_struct *work)
682 unsigned long data = atomic_long_read(&work->data);
684 if (data & WORK_STRUCT_PWQ)
685 return ((struct pool_workqueue *)
686 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
688 return data >> WORK_OFFQ_POOL_SHIFT;
691 static void mark_work_canceling(struct work_struct *work)
693 unsigned long pool_id = get_work_pool_id(work);
695 pool_id <<= WORK_OFFQ_POOL_SHIFT;
696 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
699 static bool work_is_canceling(struct work_struct *work)
701 unsigned long data = atomic_long_read(&work->data);
703 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
707 * Policy functions. These define the policies on how the global worker
708 * pools are managed. Unless noted otherwise, these functions assume that
709 * they're being called with pool->lock held.
712 static bool __need_more_worker(struct worker_pool *pool)
714 return !atomic_read(&pool->nr_running);
718 * Need to wake up a worker? Called from anything but currently
721 * Note that, because unbound workers never contribute to nr_running, this
722 * function will always return %true for unbound pools as long as the
723 * worklist isn't empty.
725 static bool need_more_worker(struct worker_pool *pool)
727 return !list_empty(&pool->worklist) && __need_more_worker(pool);
730 /* Can I start working? Called from busy but !running workers. */
731 static bool may_start_working(struct worker_pool *pool)
733 return pool->nr_idle;
736 /* Do I need to keep working? Called from currently running workers. */
737 static bool keep_working(struct worker_pool *pool)
739 return !list_empty(&pool->worklist) &&
740 atomic_read(&pool->nr_running) <= 1;
743 /* Do we need a new worker? Called from manager. */
744 static bool need_to_create_worker(struct worker_pool *pool)
746 return need_more_worker(pool) && !may_start_working(pool);
749 /* Do I need to be the manager? */
750 static bool need_to_manage_workers(struct worker_pool *pool)
752 return need_to_create_worker(pool) ||
753 (pool->flags & POOL_MANAGE_WORKERS);
756 /* Do we have too many workers and should some go away? */
757 static bool too_many_workers(struct worker_pool *pool)
759 bool managing = mutex_is_locked(&pool->manager_arb);
760 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
761 int nr_busy = pool->nr_workers - nr_idle;
764 * nr_idle and idle_list may disagree if idle rebinding is in
765 * progress. Never return %true if idle_list is empty.
767 if (list_empty(&pool->idle_list))
770 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
777 /* Return the first worker. Safe with preemption disabled */
778 static struct worker *first_worker(struct worker_pool *pool)
780 if (unlikely(list_empty(&pool->idle_list)))
783 return list_first_entry(&pool->idle_list, struct worker, entry);
787 * wake_up_worker - wake up an idle worker
788 * @pool: worker pool to wake worker from
790 * Wake up the first idle worker of @pool.
793 * spin_lock_irq(pool->lock).
795 static void wake_up_worker(struct worker_pool *pool)
797 struct worker *worker = first_worker(pool);
800 wake_up_process(worker->task);
804 * wq_worker_waking_up - a worker is waking up
805 * @task: task waking up
806 * @cpu: CPU @task is waking up to
808 * This function is called during try_to_wake_up() when a worker is
812 * spin_lock_irq(rq->lock)
814 void wq_worker_waking_up(struct task_struct *task, int cpu)
816 struct worker *worker = kthread_data(task);
818 if (!(worker->flags & WORKER_NOT_RUNNING)) {
819 WARN_ON_ONCE(worker->pool->cpu != cpu);
820 atomic_inc(&worker->pool->nr_running);
825 * wq_worker_sleeping - a worker is going to sleep
826 * @task: task going to sleep
827 * @cpu: CPU in question, must be the current CPU number
829 * This function is called during schedule() when a busy worker is
830 * going to sleep. Worker on the same cpu can be woken up by
831 * returning pointer to its task.
834 * spin_lock_irq(rq->lock)
837 * Worker task on @cpu to wake up, %NULL if none.
839 struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
841 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
842 struct worker_pool *pool;
845 * Rescuers, which may not have all the fields set up like normal
846 * workers, also reach here, let's not access anything before
847 * checking NOT_RUNNING.
849 if (worker->flags & WORKER_NOT_RUNNING)
854 /* this can only happen on the local cpu */
855 if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
859 * The counterpart of the following dec_and_test, implied mb,
860 * worklist not empty test sequence is in insert_work().
861 * Please read comment there.
863 * NOT_RUNNING is clear. This means that we're bound to and
864 * running on the local cpu w/ rq lock held and preemption
865 * disabled, which in turn means that none else could be
866 * manipulating idle_list, so dereferencing idle_list without pool
869 if (atomic_dec_and_test(&pool->nr_running) &&
870 !list_empty(&pool->worklist))
871 to_wakeup = first_worker(pool);
872 return to_wakeup ? to_wakeup->task : NULL;
876 * worker_set_flags - set worker flags and adjust nr_running accordingly
878 * @flags: flags to set
879 * @wakeup: wakeup an idle worker if necessary
881 * Set @flags in @worker->flags and adjust nr_running accordingly. If
882 * nr_running becomes zero and @wakeup is %true, an idle worker is
886 * spin_lock_irq(pool->lock)
888 static inline void worker_set_flags(struct worker *worker, unsigned int flags,
891 struct worker_pool *pool = worker->pool;
893 WARN_ON_ONCE(worker->task != current);
896 * If transitioning into NOT_RUNNING, adjust nr_running and
897 * wake up an idle worker as necessary if requested by
900 if ((flags & WORKER_NOT_RUNNING) &&
901 !(worker->flags & WORKER_NOT_RUNNING)) {
903 if (atomic_dec_and_test(&pool->nr_running) &&
904 !list_empty(&pool->worklist))
905 wake_up_worker(pool);
907 atomic_dec(&pool->nr_running);
910 worker->flags |= flags;
914 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
916 * @flags: flags to clear
918 * Clear @flags in @worker->flags and adjust nr_running accordingly.
921 * spin_lock_irq(pool->lock)
923 static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
925 struct worker_pool *pool = worker->pool;
926 unsigned int oflags = worker->flags;
928 WARN_ON_ONCE(worker->task != current);
930 worker->flags &= ~flags;
933 * If transitioning out of NOT_RUNNING, increment nr_running. Note
934 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
935 * of multiple flags, not a single flag.
937 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
938 if (!(worker->flags & WORKER_NOT_RUNNING))
939 atomic_inc(&pool->nr_running);
943 * find_worker_executing_work - find worker which is executing a work
944 * @pool: pool of interest
945 * @work: work to find worker for
947 * Find a worker which is executing @work on @pool by searching
948 * @pool->busy_hash which is keyed by the address of @work. For a worker
949 * to match, its current execution should match the address of @work and
950 * its work function. This is to avoid unwanted dependency between
951 * unrelated work executions through a work item being recycled while still
954 * This is a bit tricky. A work item may be freed once its execution
955 * starts and nothing prevents the freed area from being recycled for
956 * another work item. If the same work item address ends up being reused
957 * before the original execution finishes, workqueue will identify the
958 * recycled work item as currently executing and make it wait until the
959 * current execution finishes, introducing an unwanted dependency.
961 * This function checks the work item address and work function to avoid
962 * false positives. Note that this isn't complete as one may construct a
963 * work function which can introduce dependency onto itself through a
964 * recycled work item. Well, if somebody wants to shoot oneself in the
965 * foot that badly, there's only so much we can do, and if such deadlock
966 * actually occurs, it should be easy to locate the culprit work function.
969 * spin_lock_irq(pool->lock).
972 * Pointer to worker which is executing @work if found, %NULL
975 static struct worker *find_worker_executing_work(struct worker_pool *pool,
976 struct work_struct *work)
978 struct worker *worker;
980 hash_for_each_possible(pool->busy_hash, worker, hentry,
982 if (worker->current_work == work &&
983 worker->current_func == work->func)
990 * move_linked_works - move linked works to a list
991 * @work: start of series of works to be scheduled
992 * @head: target list to append @work to
993 * @nextp: out paramter for nested worklist walking
995 * Schedule linked works starting from @work to @head. Work series to
996 * be scheduled starts at @work and includes any consecutive work with
997 * WORK_STRUCT_LINKED set in its predecessor.
999 * If @nextp is not NULL, it's updated to point to the next work of
1000 * the last scheduled work. This allows move_linked_works() to be
1001 * nested inside outer list_for_each_entry_safe().
1004 * spin_lock_irq(pool->lock).
1006 static void move_linked_works(struct work_struct *work, struct list_head *head,
1007 struct work_struct **nextp)
1009 struct work_struct *n;
1012 * Linked worklist will always end before the end of the list,
1013 * use NULL for list head.
1015 list_for_each_entry_safe_from(work, n, NULL, entry) {
1016 list_move_tail(&work->entry, head);
1017 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1022 * If we're already inside safe list traversal and have moved
1023 * multiple works to the scheduled queue, the next position
1024 * needs to be updated.
1031 * get_pwq - get an extra reference on the specified pool_workqueue
1032 * @pwq: pool_workqueue to get
1034 * Obtain an extra reference on @pwq. The caller should guarantee that
1035 * @pwq has positive refcnt and be holding the matching pool->lock.
1037 static void get_pwq(struct pool_workqueue *pwq)
1039 lockdep_assert_held(&pwq->pool->lock);
1040 WARN_ON_ONCE(pwq->refcnt <= 0);
1045 * put_pwq - put a pool_workqueue reference
1046 * @pwq: pool_workqueue to put
1048 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1049 * destruction. The caller should be holding the matching pool->lock.
1051 static void put_pwq(struct pool_workqueue *pwq)
1053 lockdep_assert_held(&pwq->pool->lock);
1054 if (likely(--pwq->refcnt))
1056 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1059 * @pwq can't be released under pool->lock, bounce to
1060 * pwq_unbound_release_workfn(). This never recurses on the same
1061 * pool->lock as this path is taken only for unbound workqueues and
1062 * the release work item is scheduled on a per-cpu workqueue. To
1063 * avoid lockdep warning, unbound pool->locks are given lockdep
1064 * subclass of 1 in get_unbound_pool().
1066 schedule_work(&pwq->unbound_release_work);
1070 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1071 * @pwq: pool_workqueue to put (can be %NULL)
1073 * put_pwq() with locking. This function also allows %NULL @pwq.
1075 static void put_pwq_unlocked(struct pool_workqueue *pwq)
1079 * As both pwqs and pools are sched-RCU protected, the
1080 * following lock operations are safe.
1082 spin_lock_irq(&pwq->pool->lock);
1084 spin_unlock_irq(&pwq->pool->lock);
1088 static void pwq_activate_delayed_work(struct work_struct *work)
1090 struct pool_workqueue *pwq = get_work_pwq(work);
1092 trace_workqueue_activate_work(work);
1093 move_linked_works(work, &pwq->pool->worklist, NULL);
1094 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1098 static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
1100 struct work_struct *work = list_first_entry(&pwq->delayed_works,
1101 struct work_struct, entry);
1103 pwq_activate_delayed_work(work);
1107 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1108 * @pwq: pwq of interest
1109 * @color: color of work which left the queue
1111 * A work either has completed or is removed from pending queue,
1112 * decrement nr_in_flight of its pwq and handle workqueue flushing.
1115 * spin_lock_irq(pool->lock).
1117 static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1119 /* uncolored work items don't participate in flushing or nr_active */
1120 if (color == WORK_NO_COLOR)
1123 pwq->nr_in_flight[color]--;
1126 if (!list_empty(&pwq->delayed_works)) {
1127 /* one down, submit a delayed one */
1128 if (pwq->nr_active < pwq->max_active)
1129 pwq_activate_first_delayed(pwq);
1132 /* is flush in progress and are we at the flushing tip? */
1133 if (likely(pwq->flush_color != color))
1136 /* are there still in-flight works? */
1137 if (pwq->nr_in_flight[color])
1140 /* this pwq is done, clear flush_color */
1141 pwq->flush_color = -1;
1144 * If this was the last pwq, wake up the first flusher. It
1145 * will handle the rest.
1147 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1148 complete(&pwq->wq->first_flusher->done);
1154 * try_to_grab_pending - steal work item from worklist and disable irq
1155 * @work: work item to steal
1156 * @is_dwork: @work is a delayed_work
1157 * @flags: place to store irq state
1159 * Try to grab PENDING bit of @work. This function can handle @work in any
1160 * stable state - idle, on timer or on worklist.
1163 * 1 if @work was pending and we successfully stole PENDING
1164 * 0 if @work was idle and we claimed PENDING
1165 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
1166 * -ENOENT if someone else is canceling @work, this state may persist
1167 * for arbitrarily long
1170 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
1171 * interrupted while holding PENDING and @work off queue, irq must be
1172 * disabled on entry. This, combined with delayed_work->timer being
1173 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1175 * On successful return, >= 0, irq is disabled and the caller is
1176 * responsible for releasing it using local_irq_restore(*@flags).
1178 * This function is safe to call from any context including IRQ handler.
1180 static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1181 unsigned long *flags)
1183 struct worker_pool *pool;
1184 struct pool_workqueue *pwq;
1186 local_irq_save(*flags);
1188 /* try to steal the timer if it exists */
1190 struct delayed_work *dwork = to_delayed_work(work);
1193 * dwork->timer is irqsafe. If del_timer() fails, it's
1194 * guaranteed that the timer is not queued anywhere and not
1195 * running on the local CPU.
1197 if (likely(del_timer(&dwork->timer)))
1201 /* try to claim PENDING the normal way */
1202 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1206 * The queueing is in progress, or it is already queued. Try to
1207 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1209 pool = get_work_pool(work);
1213 spin_lock(&pool->lock);
1215 * work->data is guaranteed to point to pwq only while the work
1216 * item is queued on pwq->wq, and both updating work->data to point
1217 * to pwq on queueing and to pool on dequeueing are done under
1218 * pwq->pool->lock. This in turn guarantees that, if work->data
1219 * points to pwq which is associated with a locked pool, the work
1220 * item is currently queued on that pool.
1222 pwq = get_work_pwq(work);
1223 if (pwq && pwq->pool == pool) {
1224 debug_work_deactivate(work);
1227 * A delayed work item cannot be grabbed directly because
1228 * it might have linked NO_COLOR work items which, if left
1229 * on the delayed_list, will confuse pwq->nr_active
1230 * management later on and cause stall. Make sure the work
1231 * item is activated before grabbing.
1233 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1234 pwq_activate_delayed_work(work);
1236 list_del_init(&work->entry);
1237 pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
1239 /* work->data points to pwq iff queued, point to pool */
1240 set_work_pool_and_keep_pending(work, pool->id);
1242 spin_unlock(&pool->lock);
1245 spin_unlock(&pool->lock);
1247 local_irq_restore(*flags);
1248 if (work_is_canceling(work))
1255 * insert_work - insert a work into a pool
1256 * @pwq: pwq @work belongs to
1257 * @work: work to insert
1258 * @head: insertion point
1259 * @extra_flags: extra WORK_STRUCT_* flags to set
1261 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
1262 * work_struct flags.
1265 * spin_lock_irq(pool->lock).
1267 static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1268 struct list_head *head, unsigned int extra_flags)
1270 struct worker_pool *pool = pwq->pool;
1272 /* we own @work, set data and link */
1273 set_work_pwq(work, pwq, extra_flags);
1274 list_add_tail(&work->entry, head);
1278 * Ensure either wq_worker_sleeping() sees the above
1279 * list_add_tail() or we see zero nr_running to avoid workers lying
1280 * around lazily while there are works to be processed.
1284 if (__need_more_worker(pool))
1285 wake_up_worker(pool);
1289 * Test whether @work is being queued from another work executing on the
1292 static bool is_chained_work(struct workqueue_struct *wq)
1294 struct worker *worker;
1296 worker = current_wq_worker();
1298 * Return %true iff I'm a worker execuing a work item on @wq. If
1299 * I'm @worker, it's safe to dereference it without locking.
1301 return worker && worker->current_pwq->wq == wq;
1304 static void __queue_work(int cpu, struct workqueue_struct *wq,
1305 struct work_struct *work)
1307 struct pool_workqueue *pwq;
1308 struct worker_pool *last_pool;
1309 struct list_head *worklist;
1310 unsigned int work_flags;
1311 unsigned int req_cpu = cpu;
1314 * While a work item is PENDING && off queue, a task trying to
1315 * steal the PENDING will busy-loop waiting for it to either get
1316 * queued or lose PENDING. Grabbing PENDING and queueing should
1317 * happen with IRQ disabled.
1319 WARN_ON_ONCE(!irqs_disabled());
1321 debug_work_activate(work);
1323 /* if dying, only works from the same workqueue are allowed */
1324 if (unlikely(wq->flags & __WQ_DRAINING) &&
1325 WARN_ON_ONCE(!is_chained_work(wq)))
1328 if (req_cpu == WORK_CPU_UNBOUND)
1329 cpu = raw_smp_processor_id();
1331 /* pwq which will be used unless @work is executing elsewhere */
1332 if (!(wq->flags & WQ_UNBOUND))
1333 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1335 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1338 * If @work was previously on a different pool, it might still be
1339 * running there, in which case the work needs to be queued on that
1340 * pool to guarantee non-reentrancy.
1342 last_pool = get_work_pool(work);
1343 if (last_pool && last_pool != pwq->pool) {
1344 struct worker *worker;
1346 spin_lock(&last_pool->lock);
1348 worker = find_worker_executing_work(last_pool, work);
1350 if (worker && worker->current_pwq->wq == wq) {
1351 pwq = worker->current_pwq;
1353 /* meh... not running there, queue here */
1354 spin_unlock(&last_pool->lock);
1355 spin_lock(&pwq->pool->lock);
1358 spin_lock(&pwq->pool->lock);
1362 * pwq is determined and locked. For unbound pools, we could have
1363 * raced with pwq release and it could already be dead. If its
1364 * refcnt is zero, repeat pwq selection. Note that pwqs never die
1365 * without another pwq replacing it in the numa_pwq_tbl or while
1366 * work items are executing on it, so the retrying is guaranteed to
1367 * make forward-progress.
1369 if (unlikely(!pwq->refcnt)) {
1370 if (wq->flags & WQ_UNBOUND) {
1371 spin_unlock(&pwq->pool->lock);
1376 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1380 /* pwq determined, queue */
1381 trace_workqueue_queue_work(req_cpu, pwq, work);
1383 if (WARN_ON(!list_empty(&work->entry))) {
1384 spin_unlock(&pwq->pool->lock);
1388 pwq->nr_in_flight[pwq->work_color]++;
1389 work_flags = work_color_to_flags(pwq->work_color);
1391 if (likely(pwq->nr_active < pwq->max_active)) {
1392 trace_workqueue_activate_work(work);
1394 worklist = &pwq->pool->worklist;
1396 work_flags |= WORK_STRUCT_DELAYED;
1397 worklist = &pwq->delayed_works;
1400 insert_work(pwq, work, worklist, work_flags);
1402 spin_unlock(&pwq->pool->lock);
1406 * queue_work_on - queue work on specific cpu
1407 * @cpu: CPU number to execute work on
1408 * @wq: workqueue to use
1409 * @work: work to queue
1411 * We queue the work to a specific CPU, the caller must ensure it
1414 * Return: %false if @work was already on a queue, %true otherwise.
1416 bool queue_work_on(int cpu, struct workqueue_struct *wq,
1417 struct work_struct *work)
1420 unsigned long flags;
1422 local_irq_save(flags);
1424 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1425 __queue_work(cpu, wq, work);
1429 local_irq_restore(flags);
1432 EXPORT_SYMBOL(queue_work_on);
1434 void delayed_work_timer_fn(unsigned long __data)
1436 struct delayed_work *dwork = (struct delayed_work *)__data;
1438 /* should have been called from irqsafe timer with irq already off */
1439 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
1441 EXPORT_SYMBOL(delayed_work_timer_fn);
1443 static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1444 struct delayed_work *dwork, unsigned long delay)
1446 struct timer_list *timer = &dwork->timer;
1447 struct work_struct *work = &dwork->work;
1449 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1450 timer->data != (unsigned long)dwork);
1451 WARN_ON_ONCE(timer_pending(timer));
1452 WARN_ON_ONCE(!list_empty(&work->entry));
1455 * If @delay is 0, queue @dwork->work immediately. This is for
1456 * both optimization and correctness. The earliest @timer can
1457 * expire is on the closest next tick and delayed_work users depend
1458 * on that there's no such delay when @delay is 0.
1461 __queue_work(cpu, wq, &dwork->work);
1465 timer_stats_timer_set_start_info(&dwork->timer);
1469 timer->expires = jiffies + delay;
1471 if (unlikely(cpu != WORK_CPU_UNBOUND))
1472 add_timer_on(timer, cpu);
1478 * queue_delayed_work_on - queue work on specific CPU after delay
1479 * @cpu: CPU number to execute work on
1480 * @wq: workqueue to use
1481 * @dwork: work to queue
1482 * @delay: number of jiffies to wait before queueing
1484 * Return: %false if @work was already on a queue, %true otherwise. If
1485 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1488 bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1489 struct delayed_work *dwork, unsigned long delay)
1491 struct work_struct *work = &dwork->work;
1493 unsigned long flags;
1495 /* read the comment in __queue_work() */
1496 local_irq_save(flags);
1498 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1499 __queue_delayed_work(cpu, wq, dwork, delay);
1503 local_irq_restore(flags);
1506 EXPORT_SYMBOL(queue_delayed_work_on);
1509 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1510 * @cpu: CPU number to execute work on
1511 * @wq: workqueue to use
1512 * @dwork: work to queue
1513 * @delay: number of jiffies to wait before queueing
1515 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1516 * modify @dwork's timer so that it expires after @delay. If @delay is
1517 * zero, @work is guaranteed to be scheduled immediately regardless of its
1520 * Return: %false if @dwork was idle and queued, %true if @dwork was
1521 * pending and its timer was modified.
1523 * This function is safe to call from any context including IRQ handler.
1524 * See try_to_grab_pending() for details.
1526 bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1527 struct delayed_work *dwork, unsigned long delay)
1529 unsigned long flags;
1533 ret = try_to_grab_pending(&dwork->work, true, &flags);
1534 } while (unlikely(ret == -EAGAIN));
1536 if (likely(ret >= 0)) {
1537 __queue_delayed_work(cpu, wq, dwork, delay);
1538 local_irq_restore(flags);
1541 /* -ENOENT from try_to_grab_pending() becomes %true */
1544 EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1547 * worker_enter_idle - enter idle state
1548 * @worker: worker which is entering idle state
1550 * @worker is entering idle state. Update stats and idle timer if
1554 * spin_lock_irq(pool->lock).
1556 static void worker_enter_idle(struct worker *worker)
1558 struct worker_pool *pool = worker->pool;
1560 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1561 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1562 (worker->hentry.next || worker->hentry.pprev)))
1565 /* can't use worker_set_flags(), also called from start_worker() */
1566 worker->flags |= WORKER_IDLE;
1568 worker->last_active = jiffies;
1570 /* idle_list is LIFO */
1571 list_add(&worker->entry, &pool->idle_list);
1573 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1574 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1577 * Sanity check nr_running. Because wq_unbind_fn() releases
1578 * pool->lock between setting %WORKER_UNBOUND and zapping
1579 * nr_running, the warning may trigger spuriously. Check iff
1580 * unbind is not in progress.
1582 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1583 pool->nr_workers == pool->nr_idle &&
1584 atomic_read(&pool->nr_running));
1588 * worker_leave_idle - leave idle state
1589 * @worker: worker which is leaving idle state
1591 * @worker is leaving idle state. Update stats.
1594 * spin_lock_irq(pool->lock).
1596 static void worker_leave_idle(struct worker *worker)
1598 struct worker_pool *pool = worker->pool;
1600 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1602 worker_clr_flags(worker, WORKER_IDLE);
1604 list_del_init(&worker->entry);
1608 * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1609 * @pool: target worker_pool
1611 * Bind %current to the cpu of @pool if it is associated and lock @pool.
1613 * Works which are scheduled while the cpu is online must at least be
1614 * scheduled to a worker which is bound to the cpu so that if they are
1615 * flushed from cpu callbacks while cpu is going down, they are
1616 * guaranteed to execute on the cpu.
1618 * This function is to be used by unbound workers and rescuers to bind
1619 * themselves to the target cpu and may race with cpu going down or
1620 * coming online. kthread_bind() can't be used because it may put the
1621 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1622 * verbatim as it's best effort and blocking and pool may be
1623 * [dis]associated in the meantime.
1625 * This function tries set_cpus_allowed() and locks pool and verifies the
1626 * binding against %POOL_DISASSOCIATED which is set during
1627 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1628 * enters idle state or fetches works without dropping lock, it can
1629 * guarantee the scheduling requirement described in the first paragraph.
1632 * Might sleep. Called without any lock but returns with pool->lock
1636 * %true if the associated pool is online (@worker is successfully
1637 * bound), %false if offline.
1639 static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
1640 __acquires(&pool->lock)
1644 * The following call may fail, succeed or succeed
1645 * without actually migrating the task to the cpu if
1646 * it races with cpu hotunplug operation. Verify
1647 * against POOL_DISASSOCIATED.
1649 if (!(pool->flags & POOL_DISASSOCIATED))
1650 set_cpus_allowed_ptr(current, pool->attrs->cpumask);
1652 spin_lock_irq(&pool->lock);
1653 if (pool->flags & POOL_DISASSOCIATED)
1655 if (task_cpu(current) == pool->cpu &&
1656 cpumask_equal(¤t->cpus_allowed, pool->attrs->cpumask))
1658 spin_unlock_irq(&pool->lock);
1661 * We've raced with CPU hot[un]plug. Give it a breather
1662 * and retry migration. cond_resched() is required here;
1663 * otherwise, we might deadlock against cpu_stop trying to
1664 * bring down the CPU on non-preemptive kernel.
1671 static struct worker *alloc_worker(void)
1673 struct worker *worker;
1675 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1677 INIT_LIST_HEAD(&worker->entry);
1678 INIT_LIST_HEAD(&worker->scheduled);
1679 /* on creation a worker is in !idle && prep state */
1680 worker->flags = WORKER_PREP;
1686 * create_worker - create a new workqueue worker
1687 * @pool: pool the new worker will belong to
1689 * Create a new worker which is bound to @pool. The returned worker
1690 * can be started by calling start_worker() or destroyed using
1694 * Might sleep. Does GFP_KERNEL allocations.
1697 * Pointer to the newly created worker.
1699 static struct worker *create_worker(struct worker_pool *pool)
1701 struct worker *worker = NULL;
1705 lockdep_assert_held(&pool->manager_mutex);
1708 * ID is needed to determine kthread name. Allocate ID first
1709 * without installing the pointer.
1711 idr_preload(GFP_KERNEL);
1712 spin_lock_irq(&pool->lock);
1714 id = idr_alloc(&pool->worker_idr, NULL, 0, 0, GFP_NOWAIT);
1716 spin_unlock_irq(&pool->lock);
1721 worker = alloc_worker();
1725 worker->pool = pool;
1729 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1730 pool->attrs->nice < 0 ? "H" : "");
1732 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1734 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1735 "kworker/%s", id_buf);
1736 if (IS_ERR(worker->task))
1739 set_user_nice(worker->task, pool->attrs->nice);
1741 /* prevent userland from meddling with cpumask of workqueue workers */
1742 worker->task->flags |= PF_NO_SETAFFINITY;
1745 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1746 * online CPUs. It'll be re-applied when any of the CPUs come up.
1748 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1751 * The caller is responsible for ensuring %POOL_DISASSOCIATED
1752 * remains stable across this function. See the comments above the
1753 * flag definition for details.
1755 if (pool->flags & POOL_DISASSOCIATED)
1756 worker->flags |= WORKER_UNBOUND;
1758 /* successful, commit the pointer to idr */
1759 spin_lock_irq(&pool->lock);
1760 idr_replace(&pool->worker_idr, worker, worker->id);
1761 spin_unlock_irq(&pool->lock);
1767 spin_lock_irq(&pool->lock);
1768 idr_remove(&pool->worker_idr, id);
1769 spin_unlock_irq(&pool->lock);
1776 * start_worker - start a newly created worker
1777 * @worker: worker to start
1779 * Make the pool aware of @worker and start it.
1782 * spin_lock_irq(pool->lock).
1784 static void start_worker(struct worker *worker)
1786 worker->flags |= WORKER_STARTED;
1787 worker->pool->nr_workers++;
1788 worker_enter_idle(worker);
1789 wake_up_process(worker->task);
1793 * create_and_start_worker - create and start a worker for a pool
1794 * @pool: the target pool
1796 * Grab the managership of @pool and create and start a new worker for it.
1798 * Return: 0 on success. A negative error code otherwise.
1800 static int create_and_start_worker(struct worker_pool *pool)
1802 struct worker *worker;
1804 mutex_lock(&pool->manager_mutex);
1806 worker = create_worker(pool);
1808 spin_lock_irq(&pool->lock);
1809 start_worker(worker);
1810 spin_unlock_irq(&pool->lock);
1813 mutex_unlock(&pool->manager_mutex);
1815 return worker ? 0 : -ENOMEM;
1819 * destroy_worker - destroy a workqueue worker
1820 * @worker: worker to be destroyed
1822 * Destroy @worker and adjust @pool stats accordingly.
1825 * spin_lock_irq(pool->lock) which is released and regrabbed.
1827 static void destroy_worker(struct worker *worker)
1829 struct worker_pool *pool = worker->pool;
1831 lockdep_assert_held(&pool->manager_mutex);
1832 lockdep_assert_held(&pool->lock);
1834 /* sanity check frenzy */
1835 if (WARN_ON(worker->current_work) ||
1836 WARN_ON(!list_empty(&worker->scheduled)))
1839 if (worker->flags & WORKER_STARTED)
1841 if (worker->flags & WORKER_IDLE)
1844 list_del_init(&worker->entry);
1845 worker->flags |= WORKER_DIE;
1847 idr_remove(&pool->worker_idr, worker->id);
1849 spin_unlock_irq(&pool->lock);
1851 kthread_stop(worker->task);
1854 spin_lock_irq(&pool->lock);
1857 static void idle_worker_timeout(unsigned long __pool)
1859 struct worker_pool *pool = (void *)__pool;
1861 spin_lock_irq(&pool->lock);
1863 if (too_many_workers(pool)) {
1864 struct worker *worker;
1865 unsigned long expires;
1867 /* idle_list is kept in LIFO order, check the last one */
1868 worker = list_entry(pool->idle_list.prev, struct worker, entry);
1869 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1871 if (time_before(jiffies, expires))
1872 mod_timer(&pool->idle_timer, expires);
1874 /* it's been idle for too long, wake up manager */
1875 pool->flags |= POOL_MANAGE_WORKERS;
1876 wake_up_worker(pool);
1880 spin_unlock_irq(&pool->lock);
1883 static void send_mayday(struct work_struct *work)
1885 struct pool_workqueue *pwq = get_work_pwq(work);
1886 struct workqueue_struct *wq = pwq->wq;
1888 lockdep_assert_held(&wq_mayday_lock);
1893 /* mayday mayday mayday */
1894 if (list_empty(&pwq->mayday_node)) {
1895 list_add_tail(&pwq->mayday_node, &wq->maydays);
1896 wake_up_process(wq->rescuer->task);
1900 static void pool_mayday_timeout(unsigned long __pool)
1902 struct worker_pool *pool = (void *)__pool;
1903 struct work_struct *work;
1905 spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */
1906 spin_lock(&pool->lock);
1908 if (need_to_create_worker(pool)) {
1910 * We've been trying to create a new worker but
1911 * haven't been successful. We might be hitting an
1912 * allocation deadlock. Send distress signals to
1915 list_for_each_entry(work, &pool->worklist, entry)
1919 spin_unlock(&pool->lock);
1920 spin_unlock_irq(&wq_mayday_lock);
1922 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1926 * maybe_create_worker - create a new worker if necessary
1927 * @pool: pool to create a new worker for
1929 * Create a new worker for @pool if necessary. @pool is guaranteed to
1930 * have at least one idle worker on return from this function. If
1931 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1932 * sent to all rescuers with works scheduled on @pool to resolve
1933 * possible allocation deadlock.
1935 * On return, need_to_create_worker() is guaranteed to be %false and
1936 * may_start_working() %true.
1939 * spin_lock_irq(pool->lock) which may be released and regrabbed
1940 * multiple times. Does GFP_KERNEL allocations. Called only from
1944 * %false if no action was taken and pool->lock stayed locked, %true
1947 static bool maybe_create_worker(struct worker_pool *pool)
1948 __releases(&pool->lock)
1949 __acquires(&pool->lock)
1951 if (!need_to_create_worker(pool))
1954 spin_unlock_irq(&pool->lock);
1956 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1957 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1960 struct worker *worker;
1962 worker = create_worker(pool);
1964 del_timer_sync(&pool->mayday_timer);
1965 spin_lock_irq(&pool->lock);
1966 start_worker(worker);
1967 if (WARN_ON_ONCE(need_to_create_worker(pool)))
1972 if (!need_to_create_worker(pool))
1975 __set_current_state(TASK_INTERRUPTIBLE);
1976 schedule_timeout(CREATE_COOLDOWN);
1978 if (!need_to_create_worker(pool))
1982 del_timer_sync(&pool->mayday_timer);
1983 spin_lock_irq(&pool->lock);
1984 if (need_to_create_worker(pool))
1990 * maybe_destroy_worker - destroy workers which have been idle for a while
1991 * @pool: pool to destroy workers for
1993 * Destroy @pool workers which have been idle for longer than
1994 * IDLE_WORKER_TIMEOUT.
1997 * spin_lock_irq(pool->lock) which may be released and regrabbed
1998 * multiple times. Called only from manager.
2001 * %false if no action was taken and pool->lock stayed locked, %true
2004 static bool maybe_destroy_workers(struct worker_pool *pool)
2008 while (too_many_workers(pool)) {
2009 struct worker *worker;
2010 unsigned long expires;
2012 worker = list_entry(pool->idle_list.prev, struct worker, entry);
2013 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2015 if (time_before(jiffies, expires)) {
2016 mod_timer(&pool->idle_timer, expires);
2020 destroy_worker(worker);
2028 * manage_workers - manage worker pool
2031 * Assume the manager role and manage the worker pool @worker belongs
2032 * to. At any given time, there can be only zero or one manager per
2033 * pool. The exclusion is handled automatically by this function.
2035 * The caller can safely start processing works on false return. On
2036 * true return, it's guaranteed that need_to_create_worker() is false
2037 * and may_start_working() is true.
2040 * spin_lock_irq(pool->lock) which may be released and regrabbed
2041 * multiple times. Does GFP_KERNEL allocations.
2044 * %false if the pool don't need management and the caller can safely start
2045 * processing works, %true indicates that the function released pool->lock
2046 * and reacquired it to perform some management function and that the
2047 * conditions that the caller verified while holding the lock before
2048 * calling the function might no longer be true.
2050 static bool manage_workers(struct worker *worker)
2052 struct worker_pool *pool = worker->pool;
2056 * Managership is governed by two mutexes - manager_arb and
2057 * manager_mutex. manager_arb handles arbitration of manager role.
2058 * Anyone who successfully grabs manager_arb wins the arbitration
2059 * and becomes the manager. mutex_trylock() on pool->manager_arb
2060 * failure while holding pool->lock reliably indicates that someone
2061 * else is managing the pool and the worker which failed trylock
2062 * can proceed to executing work items. This means that anyone
2063 * grabbing manager_arb is responsible for actually performing
2064 * manager duties. If manager_arb is grabbed and released without
2065 * actual management, the pool may stall indefinitely.
2067 * manager_mutex is used for exclusion of actual management
2068 * operations. The holder of manager_mutex can be sure that none
2069 * of management operations, including creation and destruction of
2070 * workers, won't take place until the mutex is released. Because
2071 * manager_mutex doesn't interfere with manager role arbitration,
2072 * it is guaranteed that the pool's management, while may be
2073 * delayed, won't be disturbed by someone else grabbing
2076 if (!mutex_trylock(&pool->manager_arb))
2080 * With manager arbitration won, manager_mutex would be free in
2081 * most cases. trylock first without dropping @pool->lock.
2083 if (unlikely(!mutex_trylock(&pool->manager_mutex))) {
2084 spin_unlock_irq(&pool->lock);
2085 mutex_lock(&pool->manager_mutex);
2086 spin_lock_irq(&pool->lock);
2090 pool->flags &= ~POOL_MANAGE_WORKERS;
2093 * Destroy and then create so that may_start_working() is true
2096 ret |= maybe_destroy_workers(pool);
2097 ret |= maybe_create_worker(pool);
2099 mutex_unlock(&pool->manager_mutex);
2100 mutex_unlock(&pool->manager_arb);
2105 * process_one_work - process single work
2107 * @work: work to process
2109 * Process @work. This function contains all the logics necessary to
2110 * process a single work including synchronization against and
2111 * interaction with other workers on the same cpu, queueing and
2112 * flushing. As long as context requirement is met, any worker can
2113 * call this function to process a work.
2116 * spin_lock_irq(pool->lock) which is released and regrabbed.
2118 static void process_one_work(struct worker *worker, struct work_struct *work)
2119 __releases(&pool->lock)
2120 __acquires(&pool->lock)
2122 struct pool_workqueue *pwq = get_work_pwq(work);
2123 struct worker_pool *pool = worker->pool;
2124 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
2126 struct worker *collision;
2127 #ifdef CONFIG_LOCKDEP
2129 * It is permissible to free the struct work_struct from
2130 * inside the function that is called from it, this we need to
2131 * take into account for lockdep too. To avoid bogus "held
2132 * lock freed" warnings as well as problems when looking into
2133 * work->lockdep_map, make a copy and use that here.
2135 struct lockdep_map lockdep_map;
2137 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
2140 * Ensure we're on the correct CPU. DISASSOCIATED test is
2141 * necessary to avoid spurious warnings from rescuers servicing the
2142 * unbound or a disassociated pool.
2144 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
2145 !(pool->flags & POOL_DISASSOCIATED) &&
2146 raw_smp_processor_id() != pool->cpu);
2149 * A single work shouldn't be executed concurrently by
2150 * multiple workers on a single cpu. Check whether anyone is
2151 * already processing the work. If so, defer the work to the
2152 * currently executing one.
2154 collision = find_worker_executing_work(pool, work);
2155 if (unlikely(collision)) {
2156 move_linked_works(work, &collision->scheduled, NULL);
2160 /* claim and dequeue */
2161 debug_work_deactivate(work);
2162 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2163 worker->current_work = work;
2164 worker->current_func = work->func;
2165 worker->current_pwq = pwq;
2166 work_color = get_work_color(work);
2168 list_del_init(&work->entry);
2171 * CPU intensive works don't participate in concurrency
2172 * management. They're the scheduler's responsibility.
2174 if (unlikely(cpu_intensive))
2175 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2178 * Unbound pool isn't concurrency managed and work items should be
2179 * executed ASAP. Wake up another worker if necessary.
2181 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2182 wake_up_worker(pool);
2185 * Record the last pool and clear PENDING which should be the last
2186 * update to @work. Also, do this inside @pool->lock so that
2187 * PENDING and queued state changes happen together while IRQ is
2190 set_work_pool_and_clear_pending(work, pool->id);
2192 spin_unlock_irq(&pool->lock);
2194 lock_map_acquire_read(&pwq->wq->lockdep_map);
2195 lock_map_acquire(&lockdep_map);
2196 trace_workqueue_execute_start(work);
2197 worker->current_func(work);
2199 * While we must be careful to not use "work" after this, the trace
2200 * point will only record its address.
2202 trace_workqueue_execute_end(work);
2203 lock_map_release(&lockdep_map);
2204 lock_map_release(&pwq->wq->lockdep_map);
2206 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2207 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2208 " last function: %pf\n",
2209 current->comm, preempt_count(), task_pid_nr(current),
2210 worker->current_func);
2211 debug_show_held_locks(current);
2216 * The following prevents a kworker from hogging CPU on !PREEMPT
2217 * kernels, where a requeueing work item waiting for something to
2218 * happen could deadlock with stop_machine as such work item could
2219 * indefinitely requeue itself while all other CPUs are trapped in
2224 spin_lock_irq(&pool->lock);
2226 /* clear cpu intensive status */
2227 if (unlikely(cpu_intensive))
2228 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2230 /* we're done with it, release */
2231 hash_del(&worker->hentry);
2232 worker->current_work = NULL;
2233 worker->current_func = NULL;
2234 worker->current_pwq = NULL;
2235 worker->desc_valid = false;
2236 pwq_dec_nr_in_flight(pwq, work_color);
2240 * process_scheduled_works - process scheduled works
2243 * Process all scheduled works. Please note that the scheduled list
2244 * may change while processing a work, so this function repeatedly
2245 * fetches a work from the top and executes it.
2248 * spin_lock_irq(pool->lock) which may be released and regrabbed
2251 static void process_scheduled_works(struct worker *worker)
2253 while (!list_empty(&worker->scheduled)) {
2254 struct work_struct *work = list_first_entry(&worker->scheduled,
2255 struct work_struct, entry);
2256 process_one_work(worker, work);
2261 * worker_thread - the worker thread function
2264 * The worker thread function. All workers belong to a worker_pool -
2265 * either a per-cpu one or dynamic unbound one. These workers process all
2266 * work items regardless of their specific target workqueue. The only
2267 * exception is work items which belong to workqueues with a rescuer which
2268 * will be explained in rescuer_thread().
2272 static int worker_thread(void *__worker)
2274 struct worker *worker = __worker;
2275 struct worker_pool *pool = worker->pool;
2277 /* tell the scheduler that this is a workqueue worker */
2278 worker->task->flags |= PF_WQ_WORKER;
2280 spin_lock_irq(&pool->lock);
2282 /* am I supposed to die? */
2283 if (unlikely(worker->flags & WORKER_DIE)) {
2284 spin_unlock_irq(&pool->lock);
2285 WARN_ON_ONCE(!list_empty(&worker->entry));
2286 worker->task->flags &= ~PF_WQ_WORKER;
2290 worker_leave_idle(worker);
2292 /* no more worker necessary? */
2293 if (!need_more_worker(pool))
2296 /* do we need to manage? */
2297 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2301 * ->scheduled list can only be filled while a worker is
2302 * preparing to process a work or actually processing it.
2303 * Make sure nobody diddled with it while I was sleeping.
2305 WARN_ON_ONCE(!list_empty(&worker->scheduled));
2308 * Finish PREP stage. We're guaranteed to have at least one idle
2309 * worker or that someone else has already assumed the manager
2310 * role. This is where @worker starts participating in concurrency
2311 * management if applicable and concurrency management is restored
2312 * after being rebound. See rebind_workers() for details.
2314 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2317 struct work_struct *work =
2318 list_first_entry(&pool->worklist,
2319 struct work_struct, entry);
2321 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2322 /* optimization path, not strictly necessary */
2323 process_one_work(worker, work);
2324 if (unlikely(!list_empty(&worker->scheduled)))
2325 process_scheduled_works(worker);
2327 move_linked_works(work, &worker->scheduled, NULL);
2328 process_scheduled_works(worker);
2330 } while (keep_working(pool));
2332 worker_set_flags(worker, WORKER_PREP, false);
2334 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2338 * pool->lock is held and there's no work to process and no need to
2339 * manage, sleep. Workers are woken up only while holding
2340 * pool->lock or from local cpu, so setting the current state
2341 * before releasing pool->lock is enough to prevent losing any
2344 worker_enter_idle(worker);
2345 __set_current_state(TASK_INTERRUPTIBLE);
2346 spin_unlock_irq(&pool->lock);
2352 * rescuer_thread - the rescuer thread function
2355 * Workqueue rescuer thread function. There's one rescuer for each
2356 * workqueue which has WQ_MEM_RECLAIM set.
2358 * Regular work processing on a pool may block trying to create a new
2359 * worker which uses GFP_KERNEL allocation which has slight chance of
2360 * developing into deadlock if some works currently on the same queue
2361 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2362 * the problem rescuer solves.
2364 * When such condition is possible, the pool summons rescuers of all
2365 * workqueues which have works queued on the pool and let them process
2366 * those works so that forward progress can be guaranteed.
2368 * This should happen rarely.
2372 static int rescuer_thread(void *__rescuer)
2374 struct worker *rescuer = __rescuer;
2375 struct workqueue_struct *wq = rescuer->rescue_wq;
2376 struct list_head *scheduled = &rescuer->scheduled;
2378 set_user_nice(current, RESCUER_NICE_LEVEL);
2381 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2382 * doesn't participate in concurrency management.
2384 rescuer->task->flags |= PF_WQ_WORKER;
2386 set_current_state(TASK_INTERRUPTIBLE);
2388 if (kthread_should_stop()) {
2389 __set_current_state(TASK_RUNNING);
2390 rescuer->task->flags &= ~PF_WQ_WORKER;
2394 /* see whether any pwq is asking for help */
2395 spin_lock_irq(&wq_mayday_lock);
2397 while (!list_empty(&wq->maydays)) {
2398 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2399 struct pool_workqueue, mayday_node);
2400 struct worker_pool *pool = pwq->pool;
2401 struct work_struct *work, *n;
2403 __set_current_state(TASK_RUNNING);
2404 list_del_init(&pwq->mayday_node);
2406 spin_unlock_irq(&wq_mayday_lock);
2408 /* migrate to the target cpu if possible */
2409 worker_maybe_bind_and_lock(pool);
2410 rescuer->pool = pool;
2413 * Slurp in all works issued via this workqueue and
2416 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
2417 list_for_each_entry_safe(work, n, &pool->worklist, entry)
2418 if (get_work_pwq(work) == pwq)
2419 move_linked_works(work, scheduled, &n);
2421 process_scheduled_works(rescuer);
2424 * Leave this pool. If keep_working() is %true, notify a
2425 * regular worker; otherwise, we end up with 0 concurrency
2426 * and stalling the execution.
2428 if (keep_working(pool))
2429 wake_up_worker(pool);
2431 rescuer->pool = NULL;
2432 spin_unlock(&pool->lock);
2433 spin_lock(&wq_mayday_lock);
2436 spin_unlock_irq(&wq_mayday_lock);
2438 /* rescuers should never participate in concurrency management */
2439 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2445 struct work_struct work;
2446 struct completion done;
2449 static void wq_barrier_func(struct work_struct *work)
2451 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2452 complete(&barr->done);
2456 * insert_wq_barrier - insert a barrier work
2457 * @pwq: pwq to insert barrier into
2458 * @barr: wq_barrier to insert
2459 * @target: target work to attach @barr to
2460 * @worker: worker currently executing @target, NULL if @target is not executing
2462 * @barr is linked to @target such that @barr is completed only after
2463 * @target finishes execution. Please note that the ordering
2464 * guarantee is observed only with respect to @target and on the local
2467 * Currently, a queued barrier can't be canceled. This is because
2468 * try_to_grab_pending() can't determine whether the work to be
2469 * grabbed is at the head of the queue and thus can't clear LINKED
2470 * flag of the previous work while there must be a valid next work
2471 * after a work with LINKED flag set.
2473 * Note that when @worker is non-NULL, @target may be modified
2474 * underneath us, so we can't reliably determine pwq from @target.
2477 * spin_lock_irq(pool->lock).
2479 static void insert_wq_barrier(struct pool_workqueue *pwq,
2480 struct wq_barrier *barr,
2481 struct work_struct *target, struct worker *worker)
2483 struct list_head *head;
2484 unsigned int linked = 0;
2487 * debugobject calls are safe here even with pool->lock locked
2488 * as we know for sure that this will not trigger any of the
2489 * checks and call back into the fixup functions where we
2492 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
2493 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2494 init_completion(&barr->done);
2497 * If @target is currently being executed, schedule the
2498 * barrier to the worker; otherwise, put it after @target.
2501 head = worker->scheduled.next;
2503 unsigned long *bits = work_data_bits(target);
2505 head = target->entry.next;
2506 /* there can already be other linked works, inherit and set */
2507 linked = *bits & WORK_STRUCT_LINKED;
2508 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2511 debug_work_activate(&barr->work);
2512 insert_work(pwq, &barr->work, head,
2513 work_color_to_flags(WORK_NO_COLOR) | linked);
2517 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
2518 * @wq: workqueue being flushed
2519 * @flush_color: new flush color, < 0 for no-op
2520 * @work_color: new work color, < 0 for no-op
2522 * Prepare pwqs for workqueue flushing.
2524 * If @flush_color is non-negative, flush_color on all pwqs should be
2525 * -1. If no pwq has in-flight commands at the specified color, all
2526 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2527 * has in flight commands, its pwq->flush_color is set to
2528 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
2529 * wakeup logic is armed and %true is returned.
2531 * The caller should have initialized @wq->first_flusher prior to
2532 * calling this function with non-negative @flush_color. If
2533 * @flush_color is negative, no flush color update is done and %false
2536 * If @work_color is non-negative, all pwqs should have the same
2537 * work_color which is previous to @work_color and all will be
2538 * advanced to @work_color.
2541 * mutex_lock(wq->mutex).
2544 * %true if @flush_color >= 0 and there's something to flush. %false
2547 static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
2548 int flush_color, int work_color)
2551 struct pool_workqueue *pwq;
2553 if (flush_color >= 0) {
2554 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2555 atomic_set(&wq->nr_pwqs_to_flush, 1);
2558 for_each_pwq(pwq, wq) {
2559 struct worker_pool *pool = pwq->pool;
2561 spin_lock_irq(&pool->lock);
2563 if (flush_color >= 0) {
2564 WARN_ON_ONCE(pwq->flush_color != -1);
2566 if (pwq->nr_in_flight[flush_color]) {
2567 pwq->flush_color = flush_color;
2568 atomic_inc(&wq->nr_pwqs_to_flush);
2573 if (work_color >= 0) {
2574 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2575 pwq->work_color = work_color;
2578 spin_unlock_irq(&pool->lock);
2581 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
2582 complete(&wq->first_flusher->done);
2588 * flush_workqueue - ensure that any scheduled work has run to completion.
2589 * @wq: workqueue to flush
2591 * This function sleeps until all work items which were queued on entry
2592 * have finished execution, but it is not livelocked by new incoming ones.
2594 void flush_workqueue(struct workqueue_struct *wq)
2596 struct wq_flusher this_flusher = {
2597 .list = LIST_HEAD_INIT(this_flusher.list),
2599 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2603 lock_map_acquire(&wq->lockdep_map);
2604 lock_map_release(&wq->lockdep_map);
2606 mutex_lock(&wq->mutex);
2609 * Start-to-wait phase
2611 next_color = work_next_color(wq->work_color);
2613 if (next_color != wq->flush_color) {
2615 * Color space is not full. The current work_color
2616 * becomes our flush_color and work_color is advanced
2619 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
2620 this_flusher.flush_color = wq->work_color;
2621 wq->work_color = next_color;
2623 if (!wq->first_flusher) {
2624 /* no flush in progress, become the first flusher */
2625 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
2627 wq->first_flusher = &this_flusher;
2629 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
2631 /* nothing to flush, done */
2632 wq->flush_color = next_color;
2633 wq->first_flusher = NULL;
2638 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
2639 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2640 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
2644 * Oops, color space is full, wait on overflow queue.
2645 * The next flush completion will assign us
2646 * flush_color and transfer to flusher_queue.
2648 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2651 mutex_unlock(&wq->mutex);
2653 wait_for_completion(&this_flusher.done);
2656 * Wake-up-and-cascade phase
2658 * First flushers are responsible for cascading flushes and
2659 * handling overflow. Non-first flushers can simply return.
2661 if (wq->first_flusher != &this_flusher)
2664 mutex_lock(&wq->mutex);
2666 /* we might have raced, check again with mutex held */
2667 if (wq->first_flusher != &this_flusher)
2670 wq->first_flusher = NULL;
2672 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2673 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
2676 struct wq_flusher *next, *tmp;
2678 /* complete all the flushers sharing the current flush color */
2679 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2680 if (next->flush_color != wq->flush_color)
2682 list_del_init(&next->list);
2683 complete(&next->done);
2686 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2687 wq->flush_color != work_next_color(wq->work_color));
2689 /* this flush_color is finished, advance by one */
2690 wq->flush_color = work_next_color(wq->flush_color);
2692 /* one color has been freed, handle overflow queue */
2693 if (!list_empty(&wq->flusher_overflow)) {
2695 * Assign the same color to all overflowed
2696 * flushers, advance work_color and append to
2697 * flusher_queue. This is the start-to-wait
2698 * phase for these overflowed flushers.
2700 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2701 tmp->flush_color = wq->work_color;
2703 wq->work_color = work_next_color(wq->work_color);
2705 list_splice_tail_init(&wq->flusher_overflow,
2706 &wq->flusher_queue);
2707 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
2710 if (list_empty(&wq->flusher_queue)) {
2711 WARN_ON_ONCE(wq->flush_color != wq->work_color);
2716 * Need to flush more colors. Make the next flusher
2717 * the new first flusher and arm pwqs.
2719 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2720 WARN_ON_ONCE(wq->flush_color != next->flush_color);
2722 list_del_init(&next->list);
2723 wq->first_flusher = next;
2725 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
2729 * Meh... this color is already done, clear first
2730 * flusher and repeat cascading.
2732 wq->first_flusher = NULL;
2736 mutex_unlock(&wq->mutex);
2738 EXPORT_SYMBOL_GPL(flush_workqueue);
2741 * drain_workqueue - drain a workqueue
2742 * @wq: workqueue to drain
2744 * Wait until the workqueue becomes empty. While draining is in progress,
2745 * only chain queueing is allowed. IOW, only currently pending or running
2746 * work items on @wq can queue further work items on it. @wq is flushed
2747 * repeatedly until it becomes empty. The number of flushing is detemined
2748 * by the depth of chaining and should be relatively short. Whine if it
2751 void drain_workqueue(struct workqueue_struct *wq)
2753 unsigned int flush_cnt = 0;
2754 struct pool_workqueue *pwq;
2757 * __queue_work() needs to test whether there are drainers, is much
2758 * hotter than drain_workqueue() and already looks at @wq->flags.
2759 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
2761 mutex_lock(&wq->mutex);
2762 if (!wq->nr_drainers++)
2763 wq->flags |= __WQ_DRAINING;
2764 mutex_unlock(&wq->mutex);
2766 flush_workqueue(wq);
2768 mutex_lock(&wq->mutex);
2770 for_each_pwq(pwq, wq) {
2773 spin_lock_irq(&pwq->pool->lock);
2774 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2775 spin_unlock_irq(&pwq->pool->lock);
2780 if (++flush_cnt == 10 ||
2781 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2782 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
2783 wq->name, flush_cnt);
2785 mutex_unlock(&wq->mutex);
2789 if (!--wq->nr_drainers)
2790 wq->flags &= ~__WQ_DRAINING;
2791 mutex_unlock(&wq->mutex);
2793 EXPORT_SYMBOL_GPL(drain_workqueue);
2795 static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2797 struct worker *worker = NULL;
2798 struct worker_pool *pool;
2799 struct pool_workqueue *pwq;
2803 local_irq_disable();
2804 pool = get_work_pool(work);
2810 spin_lock(&pool->lock);
2811 /* see the comment in try_to_grab_pending() with the same code */
2812 pwq = get_work_pwq(work);
2814 if (unlikely(pwq->pool != pool))
2817 worker = find_worker_executing_work(pool, work);
2820 pwq = worker->current_pwq;
2823 insert_wq_barrier(pwq, barr, work, worker);
2824 spin_unlock_irq(&pool->lock);
2827 * If @max_active is 1 or rescuer is in use, flushing another work
2828 * item on the same workqueue may lead to deadlock. Make sure the
2829 * flusher is not running on the same workqueue by verifying write
2832 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
2833 lock_map_acquire(&pwq->wq->lockdep_map);
2835 lock_map_acquire_read(&pwq->wq->lockdep_map);
2836 lock_map_release(&pwq->wq->lockdep_map);
2840 spin_unlock_irq(&pool->lock);
2844 static bool __flush_work(struct work_struct *work)
2846 struct wq_barrier barr;
2848 if (start_flush_work(work, &barr)) {
2849 wait_for_completion(&barr.done);
2850 destroy_work_on_stack(&barr.work);
2858 * flush_work - wait for a work to finish executing the last queueing instance
2859 * @work: the work to flush
2861 * Wait until @work has finished execution. @work is guaranteed to be idle
2862 * on return if it hasn't been requeued since flush started.
2865 * %true if flush_work() waited for the work to finish execution,
2866 * %false if it was already idle.
2868 bool flush_work(struct work_struct *work)
2870 lock_map_acquire(&work->lockdep_map);
2871 lock_map_release(&work->lockdep_map);
2873 return __flush_work(work);
2875 EXPORT_SYMBOL_GPL(flush_work);
2877 static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2879 unsigned long flags;
2883 ret = try_to_grab_pending(work, is_dwork, &flags);
2885 * If someone else is canceling, wait for the same event it
2886 * would be waiting for before retrying.
2888 if (unlikely(ret == -ENOENT))
2890 } while (unlikely(ret < 0));
2892 /* tell other tasks trying to grab @work to back off */
2893 mark_work_canceling(work);
2894 local_irq_restore(flags);
2897 clear_work_data(work);
2902 * cancel_work_sync - cancel a work and wait for it to finish
2903 * @work: the work to cancel
2905 * Cancel @work and wait for its execution to finish. This function
2906 * can be used even if the work re-queues itself or migrates to
2907 * another workqueue. On return from this function, @work is
2908 * guaranteed to be not pending or executing on any CPU.
2910 * cancel_work_sync(&delayed_work->work) must not be used for
2911 * delayed_work's. Use cancel_delayed_work_sync() instead.
2913 * The caller must ensure that the workqueue on which @work was last
2914 * queued can't be destroyed before this function returns.
2917 * %true if @work was pending, %false otherwise.
2919 bool cancel_work_sync(struct work_struct *work)
2921 return __cancel_work_timer(work, false);
2923 EXPORT_SYMBOL_GPL(cancel_work_sync);
2926 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2927 * @dwork: the delayed work to flush
2929 * Delayed timer is cancelled and the pending work is queued for
2930 * immediate execution. Like flush_work(), this function only
2931 * considers the last queueing instance of @dwork.
2934 * %true if flush_work() waited for the work to finish execution,
2935 * %false if it was already idle.
2937 bool flush_delayed_work(struct delayed_work *dwork)
2939 local_irq_disable();
2940 if (del_timer_sync(&dwork->timer))
2941 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
2943 return flush_work(&dwork->work);
2945 EXPORT_SYMBOL(flush_delayed_work);
2948 * cancel_delayed_work - cancel a delayed work
2949 * @dwork: delayed_work to cancel
2951 * Kill off a pending delayed_work.
2953 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2957 * The work callback function may still be running on return, unless
2958 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2959 * use cancel_delayed_work_sync() to wait on it.
2961 * This function is safe to call from any context including IRQ handler.
2963 bool cancel_delayed_work(struct delayed_work *dwork)
2965 unsigned long flags;
2969 ret = try_to_grab_pending(&dwork->work, true, &flags);
2970 } while (unlikely(ret == -EAGAIN));
2972 if (unlikely(ret < 0))
2975 set_work_pool_and_clear_pending(&dwork->work,
2976 get_work_pool_id(&dwork->work));
2977 local_irq_restore(flags);
2980 EXPORT_SYMBOL(cancel_delayed_work);
2983 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2984 * @dwork: the delayed work cancel
2986 * This is cancel_work_sync() for delayed works.
2989 * %true if @dwork was pending, %false otherwise.
2991 bool cancel_delayed_work_sync(struct delayed_work *dwork)
2993 return __cancel_work_timer(&dwork->work, true);
2995 EXPORT_SYMBOL(cancel_delayed_work_sync);
2998 * schedule_on_each_cpu - execute a function synchronously on each online CPU
2999 * @func: the function to call
3001 * schedule_on_each_cpu() executes @func on each online CPU using the
3002 * system workqueue and blocks until all CPUs have completed.
3003 * schedule_on_each_cpu() is very slow.
3006 * 0 on success, -errno on failure.
3008 int schedule_on_each_cpu(work_func_t func)
3011 struct work_struct __percpu *works;
3013 works = alloc_percpu(struct work_struct);
3019 for_each_online_cpu(cpu) {
3020 struct work_struct *work = per_cpu_ptr(works, cpu);
3022 INIT_WORK(work, func);
3023 schedule_work_on(cpu, work);
3026 for_each_online_cpu(cpu)
3027 flush_work(per_cpu_ptr(works, cpu));
3035 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3037 * Forces execution of the kernel-global workqueue and blocks until its
3040 * Think twice before calling this function! It's very easy to get into
3041 * trouble if you don't take great care. Either of the following situations
3042 * will lead to deadlock:
3044 * One of the work items currently on the workqueue needs to acquire
3045 * a lock held by your code or its caller.
3047 * Your code is running in the context of a work routine.
3049 * They will be detected by lockdep when they occur, but the first might not
3050 * occur very often. It depends on what work items are on the workqueue and
3051 * what locks they need, which you have no control over.
3053 * In most situations flushing the entire workqueue is overkill; you merely
3054 * need to know that a particular work item isn't queued and isn't running.
3055 * In such cases you should use cancel_delayed_work_sync() or
3056 * cancel_work_sync() instead.
3058 void flush_scheduled_work(void)
3060 flush_workqueue(system_wq);
3062 EXPORT_SYMBOL(flush_scheduled_work);
3065 * execute_in_process_context - reliably execute the routine with user context
3066 * @fn: the function to execute
3067 * @ew: guaranteed storage for the execute work structure (must
3068 * be available when the work executes)
3070 * Executes the function immediately if process context is available,
3071 * otherwise schedules the function for delayed execution.
3073 * Return: 0 - function was executed
3074 * 1 - function was scheduled for execution
3076 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
3078 if (!in_interrupt()) {
3083 INIT_WORK(&ew->work, fn);
3084 schedule_work(&ew->work);
3088 EXPORT_SYMBOL_GPL(execute_in_process_context);
3092 * Workqueues with WQ_SYSFS flag set is visible to userland via
3093 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
3094 * following attributes.
3096 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
3097 * max_active RW int : maximum number of in-flight work items
3099 * Unbound workqueues have the following extra attributes.
3101 * id RO int : the associated pool ID
3102 * nice RW int : nice value of the workers
3103 * cpumask RW mask : bitmask of allowed CPUs for the workers
3106 struct workqueue_struct *wq;
3110 static struct workqueue_struct *dev_to_wq(struct device *dev)
3112 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3117 static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
3120 struct workqueue_struct *wq = dev_to_wq(dev);
3122 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
3124 static DEVICE_ATTR_RO(per_cpu);
3126 static ssize_t max_active_show(struct device *dev,
3127 struct device_attribute *attr, char *buf)
3129 struct workqueue_struct *wq = dev_to_wq(dev);
3131 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
3134 static ssize_t max_active_store(struct device *dev,
3135 struct device_attribute *attr, const char *buf,
3138 struct workqueue_struct *wq = dev_to_wq(dev);
3141 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
3144 workqueue_set_max_active(wq, val);
3147 static DEVICE_ATTR_RW(max_active);
3149 static struct attribute *wq_sysfs_attrs[] = {
3150 &dev_attr_per_cpu.attr,
3151 &dev_attr_max_active.attr,
3154 ATTRIBUTE_GROUPS(wq_sysfs);
3156 static ssize_t wq_pool_ids_show(struct device *dev,
3157 struct device_attribute *attr, char *buf)
3159 struct workqueue_struct *wq = dev_to_wq(dev);
3160 const char *delim = "";
3161 int node, written = 0;
3163 rcu_read_lock_sched();
3164 for_each_node(node) {
3165 written += scnprintf(buf + written, PAGE_SIZE - written,
3166 "%s%d:%d", delim, node,
3167 unbound_pwq_by_node(wq, node)->pool->id);
3170 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3171 rcu_read_unlock_sched();
3176 static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3179 struct workqueue_struct *wq = dev_to_wq(dev);
3182 mutex_lock(&wq->mutex);
3183 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
3184 mutex_unlock(&wq->mutex);
3189 /* prepare workqueue_attrs for sysfs store operations */
3190 static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3192 struct workqueue_attrs *attrs;
3194 attrs = alloc_workqueue_attrs(GFP_KERNEL);
3198 mutex_lock(&wq->mutex);
3199 copy_workqueue_attrs(attrs, wq->unbound_attrs);
3200 mutex_unlock(&wq->mutex);
3204 static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3205 const char *buf, size_t count)
3207 struct workqueue_struct *wq = dev_to_wq(dev);
3208 struct workqueue_attrs *attrs;
3211 attrs = wq_sysfs_prep_attrs(wq);
3215 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
3216 attrs->nice >= -20 && attrs->nice <= 19)
3217 ret = apply_workqueue_attrs(wq, attrs);
3221 free_workqueue_attrs(attrs);
3222 return ret ?: count;
3225 static ssize_t wq_cpumask_show(struct device *dev,
3226 struct device_attribute *attr, char *buf)
3228 struct workqueue_struct *wq = dev_to_wq(dev);
3231 mutex_lock(&wq->mutex);
3232 written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
3233 mutex_unlock(&wq->mutex);
3235 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3239 static ssize_t wq_cpumask_store(struct device *dev,
3240 struct device_attribute *attr,
3241 const char *buf, size_t count)
3243 struct workqueue_struct *wq = dev_to_wq(dev);
3244 struct workqueue_attrs *attrs;
3247 attrs = wq_sysfs_prep_attrs(wq);
3251 ret = cpumask_parse(buf, attrs->cpumask);
3253 ret = apply_workqueue_attrs(wq, attrs);
3255 free_workqueue_attrs(attrs);
3256 return ret ?: count;
3259 static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
3262 struct workqueue_struct *wq = dev_to_wq(dev);
3265 mutex_lock(&wq->mutex);
3266 written = scnprintf(buf, PAGE_SIZE, "%d\n",
3267 !wq->unbound_attrs->no_numa);
3268 mutex_unlock(&wq->mutex);
3273 static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
3274 const char *buf, size_t count)
3276 struct workqueue_struct *wq = dev_to_wq(dev);
3277 struct workqueue_attrs *attrs;
3280 attrs = wq_sysfs_prep_attrs(wq);
3285 if (sscanf(buf, "%d", &v) == 1) {
3286 attrs->no_numa = !v;
3287 ret = apply_workqueue_attrs(wq, attrs);
3290 free_workqueue_attrs(attrs);
3291 return ret ?: count;
3294 static struct device_attribute wq_sysfs_unbound_attrs[] = {
3295 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
3296 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3297 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
3298 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
3302 static struct bus_type wq_subsys = {
3303 .name = "workqueue",
3304 .dev_groups = wq_sysfs_groups,
3307 static int __init wq_sysfs_init(void)
3309 return subsys_virtual_register(&wq_subsys, NULL);
3311 core_initcall(wq_sysfs_init);
3313 static void wq_device_release(struct device *dev)
3315 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3321 * workqueue_sysfs_register - make a workqueue visible in sysfs
3322 * @wq: the workqueue to register
3324 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3325 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3326 * which is the preferred method.
3328 * Workqueue user should use this function directly iff it wants to apply
3329 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3330 * apply_workqueue_attrs() may race against userland updating the
3333 * Return: 0 on success, -errno on failure.
3335 int workqueue_sysfs_register(struct workqueue_struct *wq)
3337 struct wq_device *wq_dev;
3341 * Adjusting max_active or creating new pwqs by applyting
3342 * attributes breaks ordering guarantee. Disallow exposing ordered
3345 if (WARN_ON(wq->flags & __WQ_ORDERED))
3348 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3353 wq_dev->dev.bus = &wq_subsys;
3354 wq_dev->dev.init_name = wq->name;
3355 wq_dev->dev.release = wq_device_release;
3358 * unbound_attrs are created separately. Suppress uevent until
3359 * everything is ready.
3361 dev_set_uevent_suppress(&wq_dev->dev, true);
3363 ret = device_register(&wq_dev->dev);
3370 if (wq->flags & WQ_UNBOUND) {
3371 struct device_attribute *attr;
3373 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3374 ret = device_create_file(&wq_dev->dev, attr);
3376 device_unregister(&wq_dev->dev);
3383 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3388 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3389 * @wq: the workqueue to unregister
3391 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3393 static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3395 struct wq_device *wq_dev = wq->wq_dev;
3401 device_unregister(&wq_dev->dev);
3403 #else /* CONFIG_SYSFS */
3404 static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
3405 #endif /* CONFIG_SYSFS */
3408 * free_workqueue_attrs - free a workqueue_attrs
3409 * @attrs: workqueue_attrs to free
3411 * Undo alloc_workqueue_attrs().
3413 void free_workqueue_attrs(struct workqueue_attrs *attrs)
3416 free_cpumask_var(attrs->cpumask);
3422 * alloc_workqueue_attrs - allocate a workqueue_attrs
3423 * @gfp_mask: allocation mask to use
3425 * Allocate a new workqueue_attrs, initialize with default settings and
3428 * Return: The allocated new workqueue_attr on success. %NULL on failure.
3430 struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3432 struct workqueue_attrs *attrs;
3434 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3437 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3440 cpumask_copy(attrs->cpumask, cpu_possible_mask);
3443 free_workqueue_attrs(attrs);
3447 static void copy_workqueue_attrs(struct workqueue_attrs *to,
3448 const struct workqueue_attrs *from)
3450 to->nice = from->nice;
3451 cpumask_copy(to->cpumask, from->cpumask);
3453 * Unlike hash and equality test, this function doesn't ignore
3454 * ->no_numa as it is used for both pool and wq attrs. Instead,
3455 * get_unbound_pool() explicitly clears ->no_numa after copying.
3457 to->no_numa = from->no_numa;
3460 /* hash value of the content of @attr */
3461 static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3465 hash = jhash_1word(attrs->nice, hash);
3466 hash = jhash(cpumask_bits(attrs->cpumask),
3467 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
3471 /* content equality test */
3472 static bool wqattrs_equal(const struct workqueue_attrs *a,
3473 const struct workqueue_attrs *b)
3475 if (a->nice != b->nice)
3477 if (!cpumask_equal(a->cpumask, b->cpumask))
3483 * init_worker_pool - initialize a newly zalloc'd worker_pool
3484 * @pool: worker_pool to initialize
3486 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
3488 * Return: 0 on success, -errno on failure. Even on failure, all fields
3489 * inside @pool proper are initialized and put_unbound_pool() can be called
3490 * on @pool safely to release it.
3492 static int init_worker_pool(struct worker_pool *pool)
3494 spin_lock_init(&pool->lock);
3497 pool->node = NUMA_NO_NODE;
3498 pool->flags |= POOL_DISASSOCIATED;
3499 INIT_LIST_HEAD(&pool->worklist);
3500 INIT_LIST_HEAD(&pool->idle_list);
3501 hash_init(pool->busy_hash);
3503 init_timer_deferrable(&pool->idle_timer);
3504 pool->idle_timer.function = idle_worker_timeout;
3505 pool->idle_timer.data = (unsigned long)pool;
3507 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3508 (unsigned long)pool);
3510 mutex_init(&pool->manager_arb);
3511 mutex_init(&pool->manager_mutex);
3512 idr_init(&pool->worker_idr);
3514 INIT_HLIST_NODE(&pool->hash_node);
3517 /* shouldn't fail above this point */
3518 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3524 static void rcu_free_pool(struct rcu_head *rcu)
3526 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3528 idr_destroy(&pool->worker_idr);
3529 free_workqueue_attrs(pool->attrs);
3534 * put_unbound_pool - put a worker_pool
3535 * @pool: worker_pool to put
3537 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
3538 * safe manner. get_unbound_pool() calls this function on its failure path
3539 * and this function should be able to release pools which went through,
3540 * successfully or not, init_worker_pool().
3542 * Should be called with wq_pool_mutex held.
3544 static void put_unbound_pool(struct worker_pool *pool)
3546 struct worker *worker;
3548 lockdep_assert_held(&wq_pool_mutex);
3554 if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
3555 WARN_ON(!list_empty(&pool->worklist)))
3558 /* release id and unhash */
3560 idr_remove(&worker_pool_idr, pool->id);
3561 hash_del(&pool->hash_node);
3564 * Become the manager and destroy all workers. Grabbing
3565 * manager_arb prevents @pool's workers from blocking on
3568 mutex_lock(&pool->manager_arb);
3569 mutex_lock(&pool->manager_mutex);
3570 spin_lock_irq(&pool->lock);
3572 while ((worker = first_worker(pool)))
3573 destroy_worker(worker);
3574 WARN_ON(pool->nr_workers || pool->nr_idle);
3576 spin_unlock_irq(&pool->lock);
3577 mutex_unlock(&pool->manager_mutex);
3578 mutex_unlock(&pool->manager_arb);
3580 /* shut down the timers */
3581 del_timer_sync(&pool->idle_timer);
3582 del_timer_sync(&pool->mayday_timer);
3584 /* sched-RCU protected to allow dereferences from get_work_pool() */
3585 call_rcu_sched(&pool->rcu, rcu_free_pool);
3589 * get_unbound_pool - get a worker_pool with the specified attributes
3590 * @attrs: the attributes of the worker_pool to get
3592 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3593 * reference count and return it. If there already is a matching
3594 * worker_pool, it will be used; otherwise, this function attempts to
3597 * Should be called with wq_pool_mutex held.
3599 * Return: On success, a worker_pool with the same attributes as @attrs.
3600 * On failure, %NULL.
3602 static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3604 u32 hash = wqattrs_hash(attrs);
3605 struct worker_pool *pool;
3608 lockdep_assert_held(&wq_pool_mutex);
3610 /* do we already have a matching pool? */
3611 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3612 if (wqattrs_equal(pool->attrs, attrs)) {
3618 /* nope, create a new one */
3619 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3620 if (!pool || init_worker_pool(pool) < 0)
3623 if (workqueue_freezing)
3624 pool->flags |= POOL_FREEZING;
3626 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
3627 copy_workqueue_attrs(pool->attrs, attrs);
3630 * no_numa isn't a worker_pool attribute, always clear it. See
3631 * 'struct workqueue_attrs' comments for detail.
3633 pool->attrs->no_numa = false;
3635 /* if cpumask is contained inside a NUMA node, we belong to that node */
3636 if (wq_numa_enabled) {
3637 for_each_node(node) {
3638 if (cpumask_subset(pool->attrs->cpumask,
3639 wq_numa_possible_cpumask[node])) {
3646 if (worker_pool_assign_id(pool) < 0)
3649 /* create and start the initial worker */
3650 if (create_and_start_worker(pool) < 0)
3654 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3659 put_unbound_pool(pool);
3663 static void rcu_free_pwq(struct rcu_head *rcu)
3665 kmem_cache_free(pwq_cache,
3666 container_of(rcu, struct pool_workqueue, rcu));
3670 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3671 * and needs to be destroyed.
3673 static void pwq_unbound_release_workfn(struct work_struct *work)
3675 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3676 unbound_release_work);
3677 struct workqueue_struct *wq = pwq->wq;
3678 struct worker_pool *pool = pwq->pool;
3681 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3685 * Unlink @pwq. Synchronization against wq->mutex isn't strictly
3686 * necessary on release but do it anyway. It's easier to verify
3687 * and consistent with the linking path.
3689 mutex_lock(&wq->mutex);
3690 list_del_rcu(&pwq->pwqs_node);
3691 is_last = list_empty(&wq->pwqs);
3692 mutex_unlock(&wq->mutex);
3694 mutex_lock(&wq_pool_mutex);
3695 put_unbound_pool(pool);
3696 mutex_unlock(&wq_pool_mutex);
3698 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3701 * If we're the last pwq going away, @wq is already dead and no one
3702 * is gonna access it anymore. Free it.
3705 free_workqueue_attrs(wq->unbound_attrs);
3711 * pwq_adjust_max_active - update a pwq's max_active to the current setting
3712 * @pwq: target pool_workqueue
3714 * If @pwq isn't freezing, set @pwq->max_active to the associated
3715 * workqueue's saved_max_active and activate delayed work items
3716 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
3718 static void pwq_adjust_max_active(struct pool_workqueue *pwq)
3720 struct workqueue_struct *wq = pwq->wq;
3721 bool freezable = wq->flags & WQ_FREEZABLE;
3723 /* for @wq->saved_max_active */
3724 lockdep_assert_held(&wq->mutex);
3726 /* fast exit for non-freezable wqs */
3727 if (!freezable && pwq->max_active == wq->saved_max_active)
3730 spin_lock_irq(&pwq->pool->lock);
3732 if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) {
3733 pwq->max_active = wq->saved_max_active;
3735 while (!list_empty(&pwq->delayed_works) &&
3736 pwq->nr_active < pwq->max_active)
3737 pwq_activate_first_delayed(pwq);
3740 * Need to kick a worker after thawed or an unbound wq's
3741 * max_active is bumped. It's a slow path. Do it always.
3743 wake_up_worker(pwq->pool);
3745 pwq->max_active = 0;
3748 spin_unlock_irq(&pwq->pool->lock);
3751 /* initialize newly alloced @pwq which is associated with @wq and @pool */
3752 static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3753 struct worker_pool *pool)
3755 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3757 memset(pwq, 0, sizeof(*pwq));
3761 pwq->flush_color = -1;
3763 INIT_LIST_HEAD(&pwq->delayed_works);
3764 INIT_LIST_HEAD(&pwq->pwqs_node);
3765 INIT_LIST_HEAD(&pwq->mayday_node);
3766 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3769 /* sync @pwq with the current state of its associated wq and link it */
3770 static void link_pwq(struct pool_workqueue *pwq)
3772 struct workqueue_struct *wq = pwq->wq;
3774 lockdep_assert_held(&wq->mutex);
3776 /* may be called multiple times, ignore if already linked */
3777 if (!list_empty(&pwq->pwqs_node))
3781 * Set the matching work_color. This is synchronized with
3782 * wq->mutex to avoid confusing flush_workqueue().
3784 pwq->work_color = wq->work_color;
3786 /* sync max_active to the current setting */
3787 pwq_adjust_max_active(pwq);
3790 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3793 /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3794 static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3795 const struct workqueue_attrs *attrs)
3797 struct worker_pool *pool;
3798 struct pool_workqueue *pwq;
3800 lockdep_assert_held(&wq_pool_mutex);
3802 pool = get_unbound_pool(attrs);
3806 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3808 put_unbound_pool(pool);
3812 init_pwq(pwq, wq, pool);
3816 /* undo alloc_unbound_pwq(), used only in the error path */
3817 static void free_unbound_pwq(struct pool_workqueue *pwq)
3819 lockdep_assert_held(&wq_pool_mutex);
3822 put_unbound_pool(pwq->pool);
3823 kmem_cache_free(pwq_cache, pwq);
3828 * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
3829 * @attrs: the wq_attrs of interest
3830 * @node: the target NUMA node
3831 * @cpu_going_down: if >= 0, the CPU to consider as offline
3832 * @cpumask: outarg, the resulting cpumask
3834 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3835 * @cpu_going_down is >= 0, that cpu is considered offline during
3836 * calculation. The result is stored in @cpumask.
3838 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3839 * enabled and @node has online CPUs requested by @attrs, the returned
3840 * cpumask is the intersection of the possible CPUs of @node and
3843 * The caller is responsible for ensuring that the cpumask of @node stays
3846 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3849 static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3850 int cpu_going_down, cpumask_t *cpumask)
3852 if (!wq_numa_enabled || attrs->no_numa)
3855 /* does @node have any online CPUs @attrs wants? */
3856 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3857 if (cpu_going_down >= 0)
3858 cpumask_clear_cpu(cpu_going_down, cpumask);
3860 if (cpumask_empty(cpumask))
3863 /* yeap, return possible CPUs in @node that @attrs wants */
3864 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3865 return !cpumask_equal(cpumask, attrs->cpumask);
3868 cpumask_copy(cpumask, attrs->cpumask);
3872 /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3873 static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3875 struct pool_workqueue *pwq)
3877 struct pool_workqueue *old_pwq;
3879 lockdep_assert_held(&wq->mutex);
3881 /* link_pwq() can handle duplicate calls */
3884 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3885 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3890 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3891 * @wq: the target workqueue
3892 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3894 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3895 * machines, this function maps a separate pwq to each NUMA node with
3896 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3897 * NUMA node it was issued on. Older pwqs are released as in-flight work
3898 * items finish. Note that a work item which repeatedly requeues itself
3899 * back-to-back will stay on its current pwq.
3901 * Performs GFP_KERNEL allocations.
3903 * Return: 0 on success and -errno on failure.
3905 int apply_workqueue_attrs(struct workqueue_struct *wq,
3906 const struct workqueue_attrs *attrs)
3908 struct workqueue_attrs *new_attrs, *tmp_attrs;
3909 struct pool_workqueue **pwq_tbl, *dfl_pwq;
3912 /* only unbound workqueues can change attributes */
3913 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3916 /* creating multiple pwqs breaks ordering guarantee */
3917 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3920 pwq_tbl = kzalloc(wq_numa_tbl_len * sizeof(pwq_tbl[0]), GFP_KERNEL);
3921 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3922 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3923 if (!pwq_tbl || !new_attrs || !tmp_attrs)
3926 /* make a copy of @attrs and sanitize it */
3927 copy_workqueue_attrs(new_attrs, attrs);
3928 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3931 * We may create multiple pwqs with differing cpumasks. Make a
3932 * copy of @new_attrs which will be modified and used to obtain
3935 copy_workqueue_attrs(tmp_attrs, new_attrs);
3938 * CPUs should stay stable across pwq creations and installations.
3939 * Pin CPUs, determine the target cpumask for each node and create
3944 mutex_lock(&wq_pool_mutex);
3947 * If something goes wrong during CPU up/down, we'll fall back to
3948 * the default pwq covering whole @attrs->cpumask. Always create
3949 * it even if we don't use it immediately.
3951 dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3955 for_each_node(node) {
3956 if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
3957 pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3962 pwq_tbl[node] = dfl_pwq;
3966 mutex_unlock(&wq_pool_mutex);
3968 /* all pwqs have been created successfully, let's install'em */
3969 mutex_lock(&wq->mutex);
3971 copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
3973 /* save the previous pwq and install the new one */
3975 pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
3977 /* @dfl_pwq might not have been used, ensure it's linked */
3979 swap(wq->dfl_pwq, dfl_pwq);
3981 mutex_unlock(&wq->mutex);
3983 /* put the old pwqs */
3985 put_pwq_unlocked(pwq_tbl[node]);
3986 put_pwq_unlocked(dfl_pwq);
3992 free_workqueue_attrs(tmp_attrs);
3993 free_workqueue_attrs(new_attrs);
3998 free_unbound_pwq(dfl_pwq);
4000 if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
4001 free_unbound_pwq(pwq_tbl[node]);
4002 mutex_unlock(&wq_pool_mutex);
4010 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4011 * @wq: the target workqueue
4012 * @cpu: the CPU coming up or going down
4013 * @online: whether @cpu is coming up or going down
4015 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4016 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4019 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4020 * falls back to @wq->dfl_pwq which may not be optimal but is always
4023 * Note that when the last allowed CPU of a NUMA node goes offline for a
4024 * workqueue with a cpumask spanning multiple nodes, the workers which were
4025 * already executing the work items for the workqueue will lose their CPU
4026 * affinity and may execute on any CPU. This is similar to how per-cpu
4027 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4028 * affinity, it's the user's responsibility to flush the work item from
4031 static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4034 int node = cpu_to_node(cpu);
4035 int cpu_off = online ? -1 : cpu;
4036 struct pool_workqueue *old_pwq = NULL, *pwq;
4037 struct workqueue_attrs *target_attrs;
4040 lockdep_assert_held(&wq_pool_mutex);
4042 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
4046 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4047 * Let's use a preallocated one. The following buf is protected by
4048 * CPU hotplug exclusion.
4050 target_attrs = wq_update_unbound_numa_attrs_buf;
4051 cpumask = target_attrs->cpumask;
4053 mutex_lock(&wq->mutex);
4054 if (wq->unbound_attrs->no_numa)
4057 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4058 pwq = unbound_pwq_by_node(wq, node);
4061 * Let's determine what needs to be done. If the target cpumask is
4062 * different from wq's, we need to compare it to @pwq's and create
4063 * a new one if they don't match. If the target cpumask equals
4064 * wq's, the default pwq should be used. If @pwq is already the
4065 * default one, nothing to do; otherwise, install the default one.
4067 if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
4068 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
4071 if (pwq == wq->dfl_pwq)
4077 mutex_unlock(&wq->mutex);
4079 /* create a new pwq */
4080 pwq = alloc_unbound_pwq(wq, target_attrs);
4082 pr_warning("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4088 * Install the new pwq. As this function is called only from CPU
4089 * hotplug callbacks and applying a new attrs is wrapped with
4090 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
4093 mutex_lock(&wq->mutex);
4094 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4098 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4099 get_pwq(wq->dfl_pwq);
4100 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4101 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4103 mutex_unlock(&wq->mutex);
4104 put_pwq_unlocked(old_pwq);
4107 static int alloc_and_link_pwqs(struct workqueue_struct *wq)
4109 bool highpri = wq->flags & WQ_HIGHPRI;
4112 if (!(wq->flags & WQ_UNBOUND)) {
4113 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4117 for_each_possible_cpu(cpu) {
4118 struct pool_workqueue *pwq =
4119 per_cpu_ptr(wq->cpu_pwqs, cpu);
4120 struct worker_pool *cpu_pools =
4121 per_cpu(cpu_worker_pools, cpu);
4123 init_pwq(pwq, wq, &cpu_pools[highpri]);
4125 mutex_lock(&wq->mutex);
4127 mutex_unlock(&wq->mutex);
4131 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
4135 static int wq_clamp_max_active(int max_active, unsigned int flags,
4138 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4140 if (max_active < 1 || max_active > lim)
4141 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4142 max_active, name, 1, lim);
4144 return clamp_val(max_active, 1, lim);
4147 struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
4150 struct lock_class_key *key,
4151 const char *lock_name, ...)
4153 size_t tbl_size = 0;
4155 struct workqueue_struct *wq;
4156 struct pool_workqueue *pwq;
4158 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4159 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4160 flags |= WQ_UNBOUND;
4162 /* allocate wq and format name */
4163 if (flags & WQ_UNBOUND)
4164 tbl_size = wq_numa_tbl_len * sizeof(wq->numa_pwq_tbl[0]);
4166 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
4170 if (flags & WQ_UNBOUND) {
4171 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4172 if (!wq->unbound_attrs)
4176 va_start(args, lock_name);
4177 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4180 max_active = max_active ?: WQ_DFL_ACTIVE;
4181 max_active = wq_clamp_max_active(max_active, flags, wq->name);
4185 wq->saved_max_active = max_active;
4186 mutex_init(&wq->mutex);
4187 atomic_set(&wq->nr_pwqs_to_flush, 0);
4188 INIT_LIST_HEAD(&wq->pwqs);
4189 INIT_LIST_HEAD(&wq->flusher_queue);
4190 INIT_LIST_HEAD(&wq->flusher_overflow);
4191 INIT_LIST_HEAD(&wq->maydays);
4193 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
4194 INIT_LIST_HEAD(&wq->list);
4196 if (alloc_and_link_pwqs(wq) < 0)
4200 * Workqueues which may be used during memory reclaim should
4201 * have a rescuer to guarantee forward progress.
4203 if (flags & WQ_MEM_RECLAIM) {
4204 struct worker *rescuer;
4206 rescuer = alloc_worker();
4210 rescuer->rescue_wq = wq;
4211 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
4213 if (IS_ERR(rescuer->task)) {
4218 wq->rescuer = rescuer;
4219 rescuer->task->flags |= PF_NO_SETAFFINITY;
4220 wake_up_process(rescuer->task);
4223 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4227 * wq_pool_mutex protects global freeze state and workqueues list.
4228 * Grab it, adjust max_active and add the new @wq to workqueues
4231 mutex_lock(&wq_pool_mutex);
4233 mutex_lock(&wq->mutex);
4234 for_each_pwq(pwq, wq)
4235 pwq_adjust_max_active(pwq);
4236 mutex_unlock(&wq->mutex);
4238 list_add(&wq->list, &workqueues);
4240 mutex_unlock(&wq_pool_mutex);
4245 free_workqueue_attrs(wq->unbound_attrs);
4249 destroy_workqueue(wq);
4252 EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
4255 * destroy_workqueue - safely terminate a workqueue
4256 * @wq: target workqueue
4258 * Safely destroy a workqueue. All work currently pending will be done first.
4260 void destroy_workqueue(struct workqueue_struct *wq)
4262 struct pool_workqueue *pwq;
4265 /* drain it before proceeding with destruction */
4266 drain_workqueue(wq);
4269 mutex_lock(&wq->mutex);
4270 for_each_pwq(pwq, wq) {
4273 for (i = 0; i < WORK_NR_COLORS; i++) {
4274 if (WARN_ON(pwq->nr_in_flight[i])) {
4275 mutex_unlock(&wq->mutex);
4280 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
4281 WARN_ON(pwq->nr_active) ||
4282 WARN_ON(!list_empty(&pwq->delayed_works))) {
4283 mutex_unlock(&wq->mutex);
4287 mutex_unlock(&wq->mutex);
4290 * wq list is used to freeze wq, remove from list after
4291 * flushing is complete in case freeze races us.
4293 mutex_lock(&wq_pool_mutex);
4294 list_del_init(&wq->list);
4295 mutex_unlock(&wq_pool_mutex);
4297 workqueue_sysfs_unregister(wq);
4300 kthread_stop(wq->rescuer->task);
4305 if (!(wq->flags & WQ_UNBOUND)) {
4307 * The base ref is never dropped on per-cpu pwqs. Directly
4308 * free the pwqs and wq.
4310 free_percpu(wq->cpu_pwqs);
4314 * We're the sole accessor of @wq at this point. Directly
4315 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4316 * @wq will be freed when the last pwq is released.
4318 for_each_node(node) {
4319 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4320 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4321 put_pwq_unlocked(pwq);
4325 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4326 * put. Don't access it afterwards.
4330 put_pwq_unlocked(pwq);
4333 EXPORT_SYMBOL_GPL(destroy_workqueue);
4336 * workqueue_set_max_active - adjust max_active of a workqueue
4337 * @wq: target workqueue
4338 * @max_active: new max_active value.
4340 * Set max_active of @wq to @max_active.
4343 * Don't call from IRQ context.
4345 void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4347 struct pool_workqueue *pwq;
4349 /* disallow meddling with max_active for ordered workqueues */
4350 if (WARN_ON(wq->flags & __WQ_ORDERED))
4353 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4355 mutex_lock(&wq->mutex);
4357 wq->saved_max_active = max_active;
4359 for_each_pwq(pwq, wq)
4360 pwq_adjust_max_active(pwq);
4362 mutex_unlock(&wq->mutex);
4364 EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4367 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4369 * Determine whether %current is a workqueue rescuer. Can be used from
4370 * work functions to determine whether it's being run off the rescuer task.
4372 * Return: %true if %current is a workqueue rescuer. %false otherwise.
4374 bool current_is_workqueue_rescuer(void)
4376 struct worker *worker = current_wq_worker();
4378 return worker && worker->rescue_wq;
4382 * workqueue_congested - test whether a workqueue is congested
4383 * @cpu: CPU in question
4384 * @wq: target workqueue
4386 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4387 * no synchronization around this function and the test result is
4388 * unreliable and only useful as advisory hints or for debugging.
4390 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4391 * Note that both per-cpu and unbound workqueues may be associated with
4392 * multiple pool_workqueues which have separate congested states. A
4393 * workqueue being congested on one CPU doesn't mean the workqueue is also
4394 * contested on other CPUs / NUMA nodes.
4397 * %true if congested, %false otherwise.
4399 bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4401 struct pool_workqueue *pwq;
4404 rcu_read_lock_sched();
4406 if (cpu == WORK_CPU_UNBOUND)
4407 cpu = smp_processor_id();
4409 if (!(wq->flags & WQ_UNBOUND))
4410 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4412 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4414 ret = !list_empty(&pwq->delayed_works);
4415 rcu_read_unlock_sched();
4419 EXPORT_SYMBOL_GPL(workqueue_congested);
4422 * work_busy - test whether a work is currently pending or running
4423 * @work: the work to be tested
4425 * Test whether @work is currently pending or running. There is no
4426 * synchronization around this function and the test result is
4427 * unreliable and only useful as advisory hints or for debugging.
4430 * OR'd bitmask of WORK_BUSY_* bits.
4432 unsigned int work_busy(struct work_struct *work)
4434 struct worker_pool *pool;
4435 unsigned long flags;
4436 unsigned int ret = 0;
4438 if (work_pending(work))
4439 ret |= WORK_BUSY_PENDING;
4441 local_irq_save(flags);
4442 pool = get_work_pool(work);
4444 spin_lock(&pool->lock);
4445 if (find_worker_executing_work(pool, work))
4446 ret |= WORK_BUSY_RUNNING;
4447 spin_unlock(&pool->lock);
4449 local_irq_restore(flags);
4453 EXPORT_SYMBOL_GPL(work_busy);
4456 * set_worker_desc - set description for the current work item
4457 * @fmt: printf-style format string
4458 * @...: arguments for the format string
4460 * This function can be called by a running work function to describe what
4461 * the work item is about. If the worker task gets dumped, this
4462 * information will be printed out together to help debugging. The
4463 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4465 void set_worker_desc(const char *fmt, ...)
4467 struct worker *worker = current_wq_worker();
4471 va_start(args, fmt);
4472 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4474 worker->desc_valid = true;
4479 * print_worker_info - print out worker information and description
4480 * @log_lvl: the log level to use when printing
4481 * @task: target task
4483 * If @task is a worker and currently executing a work item, print out the
4484 * name of the workqueue being serviced and worker description set with
4485 * set_worker_desc() by the currently executing work item.
4487 * This function can be safely called on any task as long as the
4488 * task_struct itself is accessible. While safe, this function isn't
4489 * synchronized and may print out mixups or garbages of limited length.
4491 void print_worker_info(const char *log_lvl, struct task_struct *task)
4493 work_func_t *fn = NULL;
4494 char name[WQ_NAME_LEN] = { };
4495 char desc[WORKER_DESC_LEN] = { };
4496 struct pool_workqueue *pwq = NULL;
4497 struct workqueue_struct *wq = NULL;
4498 bool desc_valid = false;
4499 struct worker *worker;
4501 if (!(task->flags & PF_WQ_WORKER))
4505 * This function is called without any synchronization and @task
4506 * could be in any state. Be careful with dereferences.
4508 worker = probe_kthread_data(task);
4511 * Carefully copy the associated workqueue's workfn and name. Keep
4512 * the original last '\0' in case the original contains garbage.
4514 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4515 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4516 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4517 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4519 /* copy worker description */
4520 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4522 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4524 if (fn || name[0] || desc[0]) {
4525 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4527 pr_cont(" (%s)", desc);
4535 * There are two challenges in supporting CPU hotplug. Firstly, there
4536 * are a lot of assumptions on strong associations among work, pwq and
4537 * pool which make migrating pending and scheduled works very
4538 * difficult to implement without impacting hot paths. Secondly,
4539 * worker pools serve mix of short, long and very long running works making
4540 * blocked draining impractical.
4542 * This is solved by allowing the pools to be disassociated from the CPU
4543 * running as an unbound one and allowing it to be reattached later if the
4544 * cpu comes back online.
4547 static void wq_unbind_fn(struct work_struct *work)
4549 int cpu = smp_processor_id();
4550 struct worker_pool *pool;
4551 struct worker *worker;
4554 for_each_cpu_worker_pool(pool, cpu) {
4555 WARN_ON_ONCE(cpu != smp_processor_id());
4557 mutex_lock(&pool->manager_mutex);
4558 spin_lock_irq(&pool->lock);
4561 * We've blocked all manager operations. Make all workers
4562 * unbound and set DISASSOCIATED. Before this, all workers
4563 * except for the ones which are still executing works from
4564 * before the last CPU down must be on the cpu. After
4565 * this, they may become diasporas.
4567 for_each_pool_worker(worker, wi, pool)
4568 worker->flags |= WORKER_UNBOUND;
4570 pool->flags |= POOL_DISASSOCIATED;
4572 spin_unlock_irq(&pool->lock);
4573 mutex_unlock(&pool->manager_mutex);
4576 * Call schedule() so that we cross rq->lock and thus can
4577 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4578 * This is necessary as scheduler callbacks may be invoked
4584 * Sched callbacks are disabled now. Zap nr_running.
4585 * After this, nr_running stays zero and need_more_worker()
4586 * and keep_working() are always true as long as the
4587 * worklist is not empty. This pool now behaves as an
4588 * unbound (in terms of concurrency management) pool which
4589 * are served by workers tied to the pool.
4591 atomic_set(&pool->nr_running, 0);
4594 * With concurrency management just turned off, a busy
4595 * worker blocking could lead to lengthy stalls. Kick off
4596 * unbound chain execution of currently pending work items.
4598 spin_lock_irq(&pool->lock);
4599 wake_up_worker(pool);
4600 spin_unlock_irq(&pool->lock);
4605 * rebind_workers - rebind all workers of a pool to the associated CPU
4606 * @pool: pool of interest
4608 * @pool->cpu is coming online. Rebind all workers to the CPU.
4610 static void rebind_workers(struct worker_pool *pool)
4612 struct worker *worker;
4615 lockdep_assert_held(&pool->manager_mutex);
4618 * Restore CPU affinity of all workers. As all idle workers should
4619 * be on the run-queue of the associated CPU before any local
4620 * wake-ups for concurrency management happen, restore CPU affinty
4621 * of all workers first and then clear UNBOUND. As we're called
4622 * from CPU_ONLINE, the following shouldn't fail.
4624 for_each_pool_worker(worker, wi, pool)
4625 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4626 pool->attrs->cpumask) < 0);
4628 spin_lock_irq(&pool->lock);
4630 for_each_pool_worker(worker, wi, pool) {
4631 unsigned int worker_flags = worker->flags;
4634 * A bound idle worker should actually be on the runqueue
4635 * of the associated CPU for local wake-ups targeting it to
4636 * work. Kick all idle workers so that they migrate to the
4637 * associated CPU. Doing this in the same loop as
4638 * replacing UNBOUND with REBOUND is safe as no worker will
4639 * be bound before @pool->lock is released.
4641 if (worker_flags & WORKER_IDLE)
4642 wake_up_process(worker->task);
4645 * We want to clear UNBOUND but can't directly call
4646 * worker_clr_flags() or adjust nr_running. Atomically
4647 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4648 * @worker will clear REBOUND using worker_clr_flags() when
4649 * it initiates the next execution cycle thus restoring
4650 * concurrency management. Note that when or whether
4651 * @worker clears REBOUND doesn't affect correctness.
4653 * ACCESS_ONCE() is necessary because @worker->flags may be
4654 * tested without holding any lock in
4655 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4656 * fail incorrectly leading to premature concurrency
4657 * management operations.
4659 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4660 worker_flags |= WORKER_REBOUND;
4661 worker_flags &= ~WORKER_UNBOUND;
4662 ACCESS_ONCE(worker->flags) = worker_flags;
4665 spin_unlock_irq(&pool->lock);
4669 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4670 * @pool: unbound pool of interest
4671 * @cpu: the CPU which is coming up
4673 * An unbound pool may end up with a cpumask which doesn't have any online
4674 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4675 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4676 * online CPU before, cpus_allowed of all its workers should be restored.
4678 static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4680 static cpumask_t cpumask;
4681 struct worker *worker;
4684 lockdep_assert_held(&pool->manager_mutex);
4686 /* is @cpu allowed for @pool? */
4687 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4690 /* is @cpu the only online CPU? */
4691 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4692 if (cpumask_weight(&cpumask) != 1)
4695 /* as we're called from CPU_ONLINE, the following shouldn't fail */
4696 for_each_pool_worker(worker, wi, pool)
4697 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4698 pool->attrs->cpumask) < 0);
4702 * Workqueues should be brought up before normal priority CPU notifiers.
4703 * This will be registered high priority CPU notifier.
4705 static int workqueue_cpu_up_callback(struct notifier_block *nfb,
4706 unsigned long action,
4709 int cpu = (unsigned long)hcpu;
4710 struct worker_pool *pool;
4711 struct workqueue_struct *wq;
4714 switch (action & ~CPU_TASKS_FROZEN) {
4715 case CPU_UP_PREPARE:
4716 for_each_cpu_worker_pool(pool, cpu) {
4717 if (pool->nr_workers)
4719 if (create_and_start_worker(pool) < 0)
4724 case CPU_DOWN_FAILED:
4726 mutex_lock(&wq_pool_mutex);
4728 for_each_pool(pool, pi) {
4729 mutex_lock(&pool->manager_mutex);
4731 if (pool->cpu == cpu) {
4732 spin_lock_irq(&pool->lock);
4733 pool->flags &= ~POOL_DISASSOCIATED;
4734 spin_unlock_irq(&pool->lock);
4736 rebind_workers(pool);
4737 } else if (pool->cpu < 0) {
4738 restore_unbound_workers_cpumask(pool, cpu);
4741 mutex_unlock(&pool->manager_mutex);
4744 /* update NUMA affinity of unbound workqueues */
4745 list_for_each_entry(wq, &workqueues, list)
4746 wq_update_unbound_numa(wq, cpu, true);
4748 mutex_unlock(&wq_pool_mutex);
4755 * Workqueues should be brought down after normal priority CPU notifiers.
4756 * This will be registered as low priority CPU notifier.
4758 static int workqueue_cpu_down_callback(struct notifier_block *nfb,
4759 unsigned long action,
4762 int cpu = (unsigned long)hcpu;
4763 struct work_struct unbind_work;
4764 struct workqueue_struct *wq;
4766 switch (action & ~CPU_TASKS_FROZEN) {
4767 case CPU_DOWN_PREPARE:
4768 /* unbinding per-cpu workers should happen on the local CPU */
4769 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
4770 queue_work_on(cpu, system_highpri_wq, &unbind_work);
4772 /* update NUMA affinity of unbound workqueues */
4773 mutex_lock(&wq_pool_mutex);
4774 list_for_each_entry(wq, &workqueues, list)
4775 wq_update_unbound_numa(wq, cpu, false);
4776 mutex_unlock(&wq_pool_mutex);
4778 /* wait for per-cpu unbinding to finish */
4779 flush_work(&unbind_work);
4787 struct work_for_cpu {
4788 struct work_struct work;
4794 static void work_for_cpu_fn(struct work_struct *work)
4796 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4798 wfc->ret = wfc->fn(wfc->arg);
4802 * work_on_cpu - run a function in user context on a particular cpu
4803 * @cpu: the cpu to run on
4804 * @fn: the function to run
4805 * @arg: the function arg
4807 * It is up to the caller to ensure that the cpu doesn't go offline.
4808 * The caller must not hold any locks which would prevent @fn from completing.
4810 * Return: The value @fn returns.
4812 long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
4814 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
4816 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4817 schedule_work_on(cpu, &wfc.work);
4820 * The work item is on-stack and can't lead to deadlock through
4821 * flushing. Use __flush_work() to avoid spurious lockdep warnings
4822 * when work_on_cpu()s are nested.
4824 __flush_work(&wfc.work);
4828 EXPORT_SYMBOL_GPL(work_on_cpu);
4829 #endif /* CONFIG_SMP */
4831 #ifdef CONFIG_FREEZER
4834 * freeze_workqueues_begin - begin freezing workqueues
4836 * Start freezing workqueues. After this function returns, all freezable
4837 * workqueues will queue new works to their delayed_works list instead of
4841 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4843 void freeze_workqueues_begin(void)
4845 struct worker_pool *pool;
4846 struct workqueue_struct *wq;
4847 struct pool_workqueue *pwq;
4850 mutex_lock(&wq_pool_mutex);
4852 WARN_ON_ONCE(workqueue_freezing);
4853 workqueue_freezing = true;
4856 for_each_pool(pool, pi) {
4857 spin_lock_irq(&pool->lock);
4858 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
4859 pool->flags |= POOL_FREEZING;
4860 spin_unlock_irq(&pool->lock);
4863 list_for_each_entry(wq, &workqueues, list) {
4864 mutex_lock(&wq->mutex);
4865 for_each_pwq(pwq, wq)
4866 pwq_adjust_max_active(pwq);
4867 mutex_unlock(&wq->mutex);
4870 mutex_unlock(&wq_pool_mutex);
4874 * freeze_workqueues_busy - are freezable workqueues still busy?
4876 * Check whether freezing is complete. This function must be called
4877 * between freeze_workqueues_begin() and thaw_workqueues().
4880 * Grabs and releases wq_pool_mutex.
4883 * %true if some freezable workqueues are still busy. %false if freezing
4886 bool freeze_workqueues_busy(void)
4889 struct workqueue_struct *wq;
4890 struct pool_workqueue *pwq;
4892 mutex_lock(&wq_pool_mutex);
4894 WARN_ON_ONCE(!workqueue_freezing);
4896 list_for_each_entry(wq, &workqueues, list) {
4897 if (!(wq->flags & WQ_FREEZABLE))
4900 * nr_active is monotonically decreasing. It's safe
4901 * to peek without lock.
4903 rcu_read_lock_sched();
4904 for_each_pwq(pwq, wq) {
4905 WARN_ON_ONCE(pwq->nr_active < 0);
4906 if (pwq->nr_active) {
4908 rcu_read_unlock_sched();
4912 rcu_read_unlock_sched();
4915 mutex_unlock(&wq_pool_mutex);
4920 * thaw_workqueues - thaw workqueues
4922 * Thaw workqueues. Normal queueing is restored and all collected
4923 * frozen works are transferred to their respective pool worklists.
4926 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4928 void thaw_workqueues(void)
4930 struct workqueue_struct *wq;
4931 struct pool_workqueue *pwq;
4932 struct worker_pool *pool;
4935 mutex_lock(&wq_pool_mutex);
4937 if (!workqueue_freezing)
4940 /* clear FREEZING */
4941 for_each_pool(pool, pi) {
4942 spin_lock_irq(&pool->lock);
4943 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
4944 pool->flags &= ~POOL_FREEZING;
4945 spin_unlock_irq(&pool->lock);
4948 /* restore max_active and repopulate worklist */
4949 list_for_each_entry(wq, &workqueues, list) {
4950 mutex_lock(&wq->mutex);
4951 for_each_pwq(pwq, wq)
4952 pwq_adjust_max_active(pwq);
4953 mutex_unlock(&wq->mutex);
4956 workqueue_freezing = false;
4958 mutex_unlock(&wq_pool_mutex);
4960 #endif /* CONFIG_FREEZER */
4962 static void __init wq_numa_init(void)
4967 /* determine NUMA pwq table len - highest node id + 1 */
4969 wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1);
4971 if (num_possible_nodes() <= 1)
4974 if (wq_disable_numa) {
4975 pr_info("workqueue: NUMA affinity support disabled\n");
4979 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
4980 BUG_ON(!wq_update_unbound_numa_attrs_buf);
4983 * We want masks of possible CPUs of each node which isn't readily
4984 * available. Build one from cpu_to_node() which should have been
4985 * fully initialized by now.
4987 tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL);
4991 BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
4992 node_online(node) ? node : NUMA_NO_NODE));
4994 for_each_possible_cpu(cpu) {
4995 node = cpu_to_node(cpu);
4996 if (WARN_ON(node == NUMA_NO_NODE)) {
4997 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
4998 /* happens iff arch is bonkers, let's just proceed */
5001 cpumask_set_cpu(cpu, tbl[node]);
5004 wq_numa_possible_cpumask = tbl;
5005 wq_numa_enabled = true;
5008 static int __init init_workqueues(void)
5010 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5013 /* make sure we have enough bits for OFFQ pool ID */
5014 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) <
5015 WORK_CPU_END * NR_STD_WORKER_POOLS);
5017 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5019 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5021 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
5022 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
5026 /* initialize CPU pools */
5027 for_each_possible_cpu(cpu) {
5028 struct worker_pool *pool;
5031 for_each_cpu_worker_pool(pool, cpu) {
5032 BUG_ON(init_worker_pool(pool));
5034 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
5035 pool->attrs->nice = std_nice[i++];
5036 pool->node = cpu_to_node(cpu);
5039 mutex_lock(&wq_pool_mutex);
5040 BUG_ON(worker_pool_assign_id(pool));
5041 mutex_unlock(&wq_pool_mutex);
5045 /* create the initial worker */
5046 for_each_online_cpu(cpu) {
5047 struct worker_pool *pool;
5049 for_each_cpu_worker_pool(pool, cpu) {
5050 pool->flags &= ~POOL_DISASSOCIATED;
5051 BUG_ON(create_and_start_worker(pool) < 0);
5055 /* create default unbound wq attrs */
5056 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5057 struct workqueue_attrs *attrs;
5059 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5060 attrs->nice = std_nice[i];
5061 unbound_std_wq_attrs[i] = attrs;
5064 system_wq = alloc_workqueue("events", 0, 0);
5065 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
5066 system_long_wq = alloc_workqueue("events_long", 0, 0);
5067 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5068 WQ_UNBOUND_MAX_ACTIVE);
5069 system_freezable_wq = alloc_workqueue("events_freezable",
5071 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5072 WQ_POWER_EFFICIENT, 0);
5073 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5074 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5076 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
5077 !system_unbound_wq || !system_freezable_wq ||
5078 !system_power_efficient_wq ||
5079 !system_freezable_power_efficient_wq);
5082 early_initcall(init_workqueues);