1 // SPDX-License-Identifier: GPL-2.0-only
3 * kernel/workqueue.c - generic async execution with shared worker pool
5 * Copyright (C) 2002 Ingo Molnar
7 * Derived from the taskqueue/keventd code by:
8 * David Woodhouse <dwmw2@infradead.org>
10 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
11 * Theodore Ts'o <tytso@mit.edu>
13 * Made to use alloc_percpu by Christoph Lameter.
15 * Copyright (C) 2010 SUSE Linux Products GmbH
16 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
18 * This is the generic async execution mechanism. Work items as are
19 * executed in process context. The worker pool is shared and
20 * automatically managed. There are two worker pools for each CPU (one for
21 * normal work items and the other for high priority ones) and some extra
22 * pools for workqueues which are not bound to any specific CPU - the
23 * number of these backing pools is dynamic.
25 * Please read Documentation/core-api/workqueue.rst for details.
28 #include <linux/export.h>
29 #include <linux/kernel.h>
30 #include <linux/sched.h>
31 #include <linux/init.h>
32 #include <linux/signal.h>
33 #include <linux/completion.h>
34 #include <linux/workqueue.h>
35 #include <linux/slab.h>
36 #include <linux/cpu.h>
37 #include <linux/notifier.h>
38 #include <linux/kthread.h>
39 #include <linux/hardirq.h>
40 #include <linux/mempolicy.h>
41 #include <linux/freezer.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>
51 #include <linux/sched/isolation.h>
52 #include <linux/nmi.h>
53 #include <linux/kvm_para.h>
55 #include "workqueue_internal.h"
61 * A bound pool is either associated or disassociated with its CPU.
62 * While associated (!DISASSOCIATED), all workers are bound to the
63 * CPU and none has %WORKER_UNBOUND set and concurrency management
66 * While DISASSOCIATED, the cpu may be offline and all workers have
67 * %WORKER_UNBOUND set and concurrency management disabled, and may
68 * be executing on any CPU. The pool behaves as an unbound one.
70 * Note that DISASSOCIATED should be flipped only while holding
71 * wq_pool_attach_mutex to avoid changing binding state while
72 * worker_attach_to_pool() is in progress.
74 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
75 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
78 WORKER_DIE = 1 << 1, /* die die die */
79 WORKER_IDLE = 1 << 2, /* is idle */
80 WORKER_PREP = 1 << 3, /* preparing to run works */
81 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
82 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
83 WORKER_REBOUND = 1 << 8, /* worker was rebound */
85 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
86 WORKER_UNBOUND | WORKER_REBOUND,
88 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
90 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
91 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
93 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
94 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
96 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
97 /* call for help after 10ms
99 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
100 CREATE_COOLDOWN = HZ, /* time to breath after fail */
103 * Rescue workers are used only on emergencies and shared by
104 * all cpus. Give MIN_NICE.
106 RESCUER_NICE_LEVEL = MIN_NICE,
107 HIGHPRI_NICE_LEVEL = MIN_NICE,
113 * Structure fields follow one of the following exclusion rules.
115 * I: Modifiable by initialization/destruction paths and read-only for
118 * P: Preemption protected. Disabling preemption is enough and should
119 * only be modified and accessed from the local cpu.
121 * L: pool->lock protected. Access with pool->lock held.
123 * X: During normal operation, modification requires pool->lock and should
124 * be done only from local cpu. Either disabling preemption on local
125 * cpu or grabbing pool->lock is enough for read access. If
126 * POOL_DISASSOCIATED is set, it's identical to L.
128 * A: wq_pool_attach_mutex protected.
130 * PL: wq_pool_mutex protected.
132 * PR: wq_pool_mutex protected for writes. RCU protected for reads.
134 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
136 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
139 * WQ: wq->mutex protected.
141 * WR: wq->mutex protected for writes. RCU protected for reads.
143 * MD: wq_mayday_lock protected.
146 /* struct worker is defined in workqueue_internal.h */
149 spinlock_t lock; /* the pool lock */
150 int cpu; /* I: the associated cpu */
151 int node; /* I: the associated node ID */
152 int id; /* I: pool ID */
153 unsigned int flags; /* X: flags */
155 unsigned long watchdog_ts; /* L: watchdog timestamp */
157 struct list_head worklist; /* L: list of pending works */
159 int nr_workers; /* L: total number of workers */
160 int nr_idle; /* L: currently idle workers */
162 struct list_head idle_list; /* X: list of idle workers */
163 struct timer_list idle_timer; /* L: worker idle timeout */
164 struct timer_list mayday_timer; /* L: SOS timer for workers */
166 /* a workers is either on busy_hash or idle_list, or the manager */
167 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
168 /* L: hash of busy workers */
170 struct worker *manager; /* L: purely informational */
171 struct list_head workers; /* A: attached workers */
172 struct completion *detach_completion; /* all workers detached */
174 struct ida worker_ida; /* worker IDs for task name */
176 struct workqueue_attrs *attrs; /* I: worker attributes */
177 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
178 int refcnt; /* PL: refcnt for unbound pools */
181 * The current concurrency level. As it's likely to be accessed
182 * from other CPUs during try_to_wake_up(), put it in a separate
185 atomic_t nr_running ____cacheline_aligned_in_smp;
188 * Destruction of pool is RCU protected to allow dereferences
189 * from get_work_pool().
192 } ____cacheline_aligned_in_smp;
195 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
196 * of work_struct->data are used for flags and the remaining high bits
197 * point to the pwq; thus, pwqs need to be aligned at two's power of the
198 * number of flag bits.
200 struct pool_workqueue {
201 struct worker_pool *pool; /* I: the associated pool */
202 struct workqueue_struct *wq; /* I: the owning workqueue */
203 int work_color; /* L: current color */
204 int flush_color; /* L: flushing color */
205 int refcnt; /* L: reference count */
206 int nr_in_flight[WORK_NR_COLORS];
207 /* L: nr of in_flight works */
208 int nr_active; /* L: nr of active works */
209 int max_active; /* L: max active works */
210 struct list_head delayed_works; /* L: delayed works */
211 struct list_head pwqs_node; /* WR: node on wq->pwqs */
212 struct list_head mayday_node; /* MD: node on wq->maydays */
215 * Release of unbound pwq is punted to system_wq. See put_pwq()
216 * and pwq_unbound_release_workfn() for details. pool_workqueue
217 * itself is also RCU protected so that the first pwq can be
218 * determined without grabbing wq->mutex.
220 struct work_struct unbound_release_work;
222 } __aligned(1 << WORK_STRUCT_FLAG_BITS);
225 * Structure used to wait for workqueue flush.
228 struct list_head list; /* WQ: list of flushers */
229 int flush_color; /* WQ: flush color waiting for */
230 struct completion done; /* flush completion */
236 * The externally visible workqueue. It relays the issued work items to
237 * the appropriate worker_pool through its pool_workqueues.
239 struct workqueue_struct {
240 struct list_head pwqs; /* WR: all pwqs of this wq */
241 struct list_head list; /* PR: list of all workqueues */
243 struct mutex mutex; /* protects this wq */
244 int work_color; /* WQ: current work color */
245 int flush_color; /* WQ: current flush color */
246 atomic_t nr_pwqs_to_flush; /* flush in progress */
247 struct wq_flusher *first_flusher; /* WQ: first flusher */
248 struct list_head flusher_queue; /* WQ: flush waiters */
249 struct list_head flusher_overflow; /* WQ: flush overflow list */
251 struct list_head maydays; /* MD: pwqs requesting rescue */
252 struct worker *rescuer; /* I: rescue worker */
254 int nr_drainers; /* WQ: drain in progress */
255 int saved_max_active; /* WQ: saved pwq max_active */
257 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
258 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
261 struct wq_device *wq_dev; /* I: for sysfs interface */
263 #ifdef CONFIG_LOCKDEP
265 struct lock_class_key key;
266 struct lockdep_map lockdep_map;
268 char name[WQ_NAME_LEN]; /* I: workqueue name */
271 * Destruction of workqueue_struct is RCU protected to allow walking
272 * the workqueues list without grabbing wq_pool_mutex.
273 * This is used to dump all workqueues from sysrq.
277 /* hot fields used during command issue, aligned to cacheline */
278 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
279 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
280 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
283 static struct kmem_cache *pwq_cache;
285 static cpumask_var_t *wq_numa_possible_cpumask;
286 /* possible CPUs of each node */
288 static bool wq_disable_numa;
289 module_param_named(disable_numa, wq_disable_numa, bool, 0444);
291 /* see the comment above the definition of WQ_POWER_EFFICIENT */
292 static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
293 module_param_named(power_efficient, wq_power_efficient, bool, 0444);
295 static bool wq_online; /* can kworkers be created yet? */
297 static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
299 /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
300 static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
302 static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
303 static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
304 static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
305 static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
307 static LIST_HEAD(workqueues); /* PR: list of all workqueues */
308 static bool workqueue_freezing; /* PL: have wqs started freezing? */
310 /* PL: allowable cpus for unbound wqs and work items */
311 static cpumask_var_t wq_unbound_cpumask;
313 /* CPU where unbound work was last round robin scheduled from this CPU */
314 static DEFINE_PER_CPU(int, wq_rr_cpu_last);
317 * Local execution of unbound work items is no longer guaranteed. The
318 * following always forces round-robin CPU selection on unbound work items
319 * to uncover usages which depend on it.
321 #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
322 static bool wq_debug_force_rr_cpu = true;
324 static bool wq_debug_force_rr_cpu = false;
326 module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
328 /* the per-cpu worker pools */
329 static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
331 static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
333 /* PL: hash of all unbound pools keyed by pool->attrs */
334 static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
336 /* I: attributes used when instantiating standard unbound pools on demand */
337 static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
339 /* I: attributes used when instantiating ordered pools on demand */
340 static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
342 struct workqueue_struct *system_wq __read_mostly;
343 EXPORT_SYMBOL(system_wq);
344 struct workqueue_struct *system_highpri_wq __read_mostly;
345 EXPORT_SYMBOL_GPL(system_highpri_wq);
346 struct workqueue_struct *system_long_wq __read_mostly;
347 EXPORT_SYMBOL_GPL(system_long_wq);
348 struct workqueue_struct *system_unbound_wq __read_mostly;
349 EXPORT_SYMBOL_GPL(system_unbound_wq);
350 struct workqueue_struct *system_freezable_wq __read_mostly;
351 EXPORT_SYMBOL_GPL(system_freezable_wq);
352 struct workqueue_struct *system_power_efficient_wq __read_mostly;
353 EXPORT_SYMBOL_GPL(system_power_efficient_wq);
354 struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
355 EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
357 static int worker_thread(void *__worker);
358 static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
360 #define CREATE_TRACE_POINTS
361 #include <trace/events/workqueue.h>
363 #define assert_rcu_or_pool_mutex() \
364 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
365 !lockdep_is_held(&wq_pool_mutex), \
366 "RCU or wq_pool_mutex should be held")
368 #define assert_rcu_or_wq_mutex(wq) \
369 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
370 !lockdep_is_held(&wq->mutex), \
371 "RCU or wq->mutex should be held")
373 #define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
374 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
375 !lockdep_is_held(&wq->mutex) && \
376 !lockdep_is_held(&wq_pool_mutex), \
377 "RCU, wq->mutex or wq_pool_mutex should be held")
379 #define for_each_cpu_worker_pool(pool, cpu) \
380 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
381 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
385 * for_each_pool - iterate through all worker_pools in the system
386 * @pool: iteration cursor
387 * @pi: integer used for iteration
389 * This must be called either with wq_pool_mutex held or RCU read
390 * locked. If the pool needs to be used beyond the locking in effect, the
391 * caller is responsible for guaranteeing that the pool stays online.
393 * The if/else clause exists only for the lockdep assertion and can be
396 #define for_each_pool(pool, pi) \
397 idr_for_each_entry(&worker_pool_idr, pool, pi) \
398 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
402 * for_each_pool_worker - iterate through all workers of a worker_pool
403 * @worker: iteration cursor
404 * @pool: worker_pool to iterate workers of
406 * This must be called with wq_pool_attach_mutex.
408 * The if/else clause exists only for the lockdep assertion and can be
411 #define for_each_pool_worker(worker, pool) \
412 list_for_each_entry((worker), &(pool)->workers, node) \
413 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
417 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
418 * @pwq: iteration cursor
419 * @wq: the target workqueue
421 * This must be called either with wq->mutex held or RCU read locked.
422 * If the pwq needs to be used beyond the locking in effect, the caller is
423 * responsible for guaranteeing that the pwq stays online.
425 * The if/else clause exists only for the lockdep assertion and can be
428 #define for_each_pwq(pwq, wq) \
429 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \
430 lockdep_is_held(&wq->mutex)) \
431 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
434 #ifdef CONFIG_DEBUG_OBJECTS_WORK
436 static struct debug_obj_descr work_debug_descr;
438 static void *work_debug_hint(void *addr)
440 return ((struct work_struct *) addr)->func;
443 static bool work_is_static_object(void *addr)
445 struct work_struct *work = addr;
447 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
451 * fixup_init is called when:
452 * - an active object is initialized
454 static bool work_fixup_init(void *addr, enum debug_obj_state state)
456 struct work_struct *work = addr;
459 case ODEBUG_STATE_ACTIVE:
460 cancel_work_sync(work);
461 debug_object_init(work, &work_debug_descr);
469 * fixup_free is called when:
470 * - an active object is freed
472 static bool work_fixup_free(void *addr, enum debug_obj_state state)
474 struct work_struct *work = addr;
477 case ODEBUG_STATE_ACTIVE:
478 cancel_work_sync(work);
479 debug_object_free(work, &work_debug_descr);
486 static struct debug_obj_descr work_debug_descr = {
487 .name = "work_struct",
488 .debug_hint = work_debug_hint,
489 .is_static_object = work_is_static_object,
490 .fixup_init = work_fixup_init,
491 .fixup_free = work_fixup_free,
494 static inline void debug_work_activate(struct work_struct *work)
496 debug_object_activate(work, &work_debug_descr);
499 static inline void debug_work_deactivate(struct work_struct *work)
501 debug_object_deactivate(work, &work_debug_descr);
504 void __init_work(struct work_struct *work, int onstack)
507 debug_object_init_on_stack(work, &work_debug_descr);
509 debug_object_init(work, &work_debug_descr);
511 EXPORT_SYMBOL_GPL(__init_work);
513 void destroy_work_on_stack(struct work_struct *work)
515 debug_object_free(work, &work_debug_descr);
517 EXPORT_SYMBOL_GPL(destroy_work_on_stack);
519 void destroy_delayed_work_on_stack(struct delayed_work *work)
521 destroy_timer_on_stack(&work->timer);
522 debug_object_free(&work->work, &work_debug_descr);
524 EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
527 static inline void debug_work_activate(struct work_struct *work) { }
528 static inline void debug_work_deactivate(struct work_struct *work) { }
532 * worker_pool_assign_id - allocate ID and assing it to @pool
533 * @pool: the pool pointer of interest
535 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
536 * successfully, -errno on failure.
538 static int worker_pool_assign_id(struct worker_pool *pool)
542 lockdep_assert_held(&wq_pool_mutex);
544 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
554 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
555 * @wq: the target workqueue
558 * This must be called with any of wq_pool_mutex, wq->mutex or RCU
560 * If the pwq needs to be used beyond the locking in effect, the caller is
561 * responsible for guaranteeing that the pwq stays online.
563 * Return: The unbound pool_workqueue for @node.
565 static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
568 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
571 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
572 * delayed item is pending. The plan is to keep CPU -> NODE
573 * mapping valid and stable across CPU on/offlines. Once that
574 * happens, this workaround can be removed.
576 if (unlikely(node == NUMA_NO_NODE))
579 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
582 static unsigned int work_color_to_flags(int color)
584 return color << WORK_STRUCT_COLOR_SHIFT;
587 static int get_work_color(struct work_struct *work)
589 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
590 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
593 static int work_next_color(int color)
595 return (color + 1) % WORK_NR_COLORS;
599 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
600 * contain the pointer to the queued pwq. Once execution starts, the flag
601 * is cleared and the high bits contain OFFQ flags and pool ID.
603 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
604 * and clear_work_data() can be used to set the pwq, pool or clear
605 * work->data. These functions should only be called while the work is
606 * owned - ie. while the PENDING bit is set.
608 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
609 * corresponding to a work. Pool is available once the work has been
610 * queued anywhere after initialization until it is sync canceled. pwq is
611 * available only while the work item is queued.
613 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
614 * canceled. While being canceled, a work item may have its PENDING set
615 * but stay off timer and worklist for arbitrarily long and nobody should
616 * try to steal the PENDING bit.
618 static inline void set_work_data(struct work_struct *work, unsigned long data,
621 WARN_ON_ONCE(!work_pending(work));
622 atomic_long_set(&work->data, data | flags | work_static(work));
625 static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
626 unsigned long extra_flags)
628 set_work_data(work, (unsigned long)pwq,
629 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
632 static void set_work_pool_and_keep_pending(struct work_struct *work,
635 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
636 WORK_STRUCT_PENDING);
639 static void set_work_pool_and_clear_pending(struct work_struct *work,
643 * The following wmb is paired with the implied mb in
644 * test_and_set_bit(PENDING) and ensures all updates to @work made
645 * here are visible to and precede any updates by the next PENDING
649 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
651 * The following mb guarantees that previous clear of a PENDING bit
652 * will not be reordered with any speculative LOADS or STORES from
653 * work->current_func, which is executed afterwards. This possible
654 * reordering can lead to a missed execution on attempt to queue
655 * the same @work. E.g. consider this case:
658 * ---------------------------- --------------------------------
660 * 1 STORE event_indicated
661 * 2 queue_work_on() {
662 * 3 test_and_set_bit(PENDING)
663 * 4 } set_..._and_clear_pending() {
664 * 5 set_work_data() # clear bit
666 * 7 work->current_func() {
667 * 8 LOAD event_indicated
670 * Without an explicit full barrier speculative LOAD on line 8 can
671 * be executed before CPU#0 does STORE on line 1. If that happens,
672 * CPU#0 observes the PENDING bit is still set and new execution of
673 * a @work is not queued in a hope, that CPU#1 will eventually
674 * finish the queued @work. Meanwhile CPU#1 does not see
675 * event_indicated is set, because speculative LOAD was executed
676 * before actual STORE.
681 static void clear_work_data(struct work_struct *work)
683 smp_wmb(); /* see set_work_pool_and_clear_pending() */
684 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
687 static inline struct pool_workqueue *work_struct_pwq(unsigned long data)
689 return (struct pool_workqueue *)(data & WORK_STRUCT_WQ_DATA_MASK);
692 static struct pool_workqueue *get_work_pwq(struct work_struct *work)
694 unsigned long data = atomic_long_read(&work->data);
696 if (data & WORK_STRUCT_PWQ)
697 return work_struct_pwq(data);
703 * get_work_pool - return the worker_pool a given work was associated with
704 * @work: the work item of interest
706 * Pools are created and destroyed under wq_pool_mutex, and allows read
707 * access under RCU read lock. As such, this function should be
708 * called under wq_pool_mutex or inside of a rcu_read_lock() region.
710 * All fields of the returned pool are accessible as long as the above
711 * mentioned locking is in effect. If the returned pool needs to be used
712 * beyond the critical section, the caller is responsible for ensuring the
713 * returned pool is and stays online.
715 * Return: The worker_pool @work was last associated with. %NULL if none.
717 static struct worker_pool *get_work_pool(struct work_struct *work)
719 unsigned long data = atomic_long_read(&work->data);
722 assert_rcu_or_pool_mutex();
724 if (data & WORK_STRUCT_PWQ)
725 return work_struct_pwq(data)->pool;
727 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
728 if (pool_id == WORK_OFFQ_POOL_NONE)
731 return idr_find(&worker_pool_idr, pool_id);
735 * get_work_pool_id - return the worker pool ID a given work is associated with
736 * @work: the work item of interest
738 * Return: The worker_pool ID @work was last associated with.
739 * %WORK_OFFQ_POOL_NONE if none.
741 static int get_work_pool_id(struct work_struct *work)
743 unsigned long data = atomic_long_read(&work->data);
745 if (data & WORK_STRUCT_PWQ)
746 return work_struct_pwq(data)->pool->id;
748 return data >> WORK_OFFQ_POOL_SHIFT;
751 static void mark_work_canceling(struct work_struct *work)
753 unsigned long pool_id = get_work_pool_id(work);
755 pool_id <<= WORK_OFFQ_POOL_SHIFT;
756 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
759 static bool work_is_canceling(struct work_struct *work)
761 unsigned long data = atomic_long_read(&work->data);
763 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
767 * Policy functions. These define the policies on how the global worker
768 * pools are managed. Unless noted otherwise, these functions assume that
769 * they're being called with pool->lock held.
772 static bool __need_more_worker(struct worker_pool *pool)
774 return !atomic_read(&pool->nr_running);
778 * Need to wake up a worker? Called from anything but currently
781 * Note that, because unbound workers never contribute to nr_running, this
782 * function will always return %true for unbound pools as long as the
783 * worklist isn't empty.
785 static bool need_more_worker(struct worker_pool *pool)
787 return !list_empty(&pool->worklist) && __need_more_worker(pool);
790 /* Can I start working? Called from busy but !running workers. */
791 static bool may_start_working(struct worker_pool *pool)
793 return pool->nr_idle;
796 /* Do I need to keep working? Called from currently running workers. */
797 static bool keep_working(struct worker_pool *pool)
799 return !list_empty(&pool->worklist) &&
800 atomic_read(&pool->nr_running) <= 1;
803 /* Do we need a new worker? Called from manager. */
804 static bool need_to_create_worker(struct worker_pool *pool)
806 return need_more_worker(pool) && !may_start_working(pool);
809 /* Do we have too many workers and should some go away? */
810 static bool too_many_workers(struct worker_pool *pool)
812 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
813 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
814 int nr_busy = pool->nr_workers - nr_idle;
816 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
823 /* Return the first idle worker. Safe with preemption disabled */
824 static struct worker *first_idle_worker(struct worker_pool *pool)
826 if (unlikely(list_empty(&pool->idle_list)))
829 return list_first_entry(&pool->idle_list, struct worker, entry);
833 * wake_up_worker - wake up an idle worker
834 * @pool: worker pool to wake worker from
836 * Wake up the first idle worker of @pool.
839 * spin_lock_irq(pool->lock).
841 static void wake_up_worker(struct worker_pool *pool)
843 struct worker *worker = first_idle_worker(pool);
846 wake_up_process(worker->task);
850 * wq_worker_running - a worker is running again
851 * @task: task waking up
853 * This function is called when a worker returns from schedule()
855 void wq_worker_running(struct task_struct *task)
857 struct worker *worker = kthread_data(task);
859 if (!worker->sleeping)
863 * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check
864 * and the nr_running increment below, we may ruin the nr_running reset
865 * and leave with an unexpected pool->nr_running == 1 on the newly unbound
866 * pool. Protect against such race.
869 if (!(worker->flags & WORKER_NOT_RUNNING))
870 atomic_inc(&worker->pool->nr_running);
872 worker->sleeping = 0;
876 * wq_worker_sleeping - a worker is going to sleep
877 * @task: task going to sleep
879 * This function is called from schedule() when a busy worker is
880 * going to sleep. Preemption needs to be disabled to protect ->sleeping
883 void wq_worker_sleeping(struct task_struct *task)
885 struct worker *next, *worker = kthread_data(task);
886 struct worker_pool *pool;
889 * Rescuers, which may not have all the fields set up like normal
890 * workers, also reach here, let's not access anything before
891 * checking NOT_RUNNING.
893 if (worker->flags & WORKER_NOT_RUNNING)
898 /* Return if preempted before wq_worker_running() was reached */
899 if (worker->sleeping)
902 worker->sleeping = 1;
903 spin_lock_irq(&pool->lock);
906 * The counterpart of the following dec_and_test, implied mb,
907 * worklist not empty test sequence is in insert_work().
908 * Please read comment there.
910 * NOT_RUNNING is clear. This means that we're bound to and
911 * running on the local cpu w/ rq lock held and preemption
912 * disabled, which in turn means that none else could be
913 * manipulating idle_list, so dereferencing idle_list without pool
916 if (atomic_dec_and_test(&pool->nr_running) &&
917 !list_empty(&pool->worklist)) {
918 next = first_idle_worker(pool);
920 wake_up_process(next->task);
922 spin_unlock_irq(&pool->lock);
926 * wq_worker_last_func - retrieve worker's last work function
927 * @task: Task to retrieve last work function of.
929 * Determine the last function a worker executed. This is called from
930 * the scheduler to get a worker's last known identity.
933 * spin_lock_irq(rq->lock)
935 * This function is called during schedule() when a kworker is going
936 * to sleep. It's used by psi to identify aggregation workers during
937 * dequeuing, to allow periodic aggregation to shut-off when that
938 * worker is the last task in the system or cgroup to go to sleep.
940 * As this function doesn't involve any workqueue-related locking, it
941 * only returns stable values when called from inside the scheduler's
942 * queuing and dequeuing paths, when @task, which must be a kworker,
943 * is guaranteed to not be processing any works.
946 * The last work function %current executed as a worker, NULL if it
947 * hasn't executed any work yet.
949 work_func_t wq_worker_last_func(struct task_struct *task)
951 struct worker *worker = kthread_data(task);
953 return worker->last_func;
957 * worker_set_flags - set worker flags and adjust nr_running accordingly
959 * @flags: flags to set
961 * Set @flags in @worker->flags and adjust nr_running accordingly.
964 * spin_lock_irq(pool->lock)
966 static inline void worker_set_flags(struct worker *worker, unsigned int flags)
968 struct worker_pool *pool = worker->pool;
970 WARN_ON_ONCE(worker->task != current);
972 /* If transitioning into NOT_RUNNING, adjust nr_running. */
973 if ((flags & WORKER_NOT_RUNNING) &&
974 !(worker->flags & WORKER_NOT_RUNNING)) {
975 atomic_dec(&pool->nr_running);
978 worker->flags |= flags;
982 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
984 * @flags: flags to clear
986 * Clear @flags in @worker->flags and adjust nr_running accordingly.
989 * spin_lock_irq(pool->lock)
991 static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
993 struct worker_pool *pool = worker->pool;
994 unsigned int oflags = worker->flags;
996 WARN_ON_ONCE(worker->task != current);
998 worker->flags &= ~flags;
1001 * If transitioning out of NOT_RUNNING, increment nr_running. Note
1002 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
1003 * of multiple flags, not a single flag.
1005 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
1006 if (!(worker->flags & WORKER_NOT_RUNNING))
1007 atomic_inc(&pool->nr_running);
1011 * find_worker_executing_work - find worker which is executing a work
1012 * @pool: pool of interest
1013 * @work: work to find worker for
1015 * Find a worker which is executing @work on @pool by searching
1016 * @pool->busy_hash which is keyed by the address of @work. For a worker
1017 * to match, its current execution should match the address of @work and
1018 * its work function. This is to avoid unwanted dependency between
1019 * unrelated work executions through a work item being recycled while still
1022 * This is a bit tricky. A work item may be freed once its execution
1023 * starts and nothing prevents the freed area from being recycled for
1024 * another work item. If the same work item address ends up being reused
1025 * before the original execution finishes, workqueue will identify the
1026 * recycled work item as currently executing and make it wait until the
1027 * current execution finishes, introducing an unwanted dependency.
1029 * This function checks the work item address and work function to avoid
1030 * false positives. Note that this isn't complete as one may construct a
1031 * work function which can introduce dependency onto itself through a
1032 * recycled work item. Well, if somebody wants to shoot oneself in the
1033 * foot that badly, there's only so much we can do, and if such deadlock
1034 * actually occurs, it should be easy to locate the culprit work function.
1037 * spin_lock_irq(pool->lock).
1040 * Pointer to worker which is executing @work if found, %NULL
1043 static struct worker *find_worker_executing_work(struct worker_pool *pool,
1044 struct work_struct *work)
1046 struct worker *worker;
1048 hash_for_each_possible(pool->busy_hash, worker, hentry,
1049 (unsigned long)work)
1050 if (worker->current_work == work &&
1051 worker->current_func == work->func)
1058 * move_linked_works - move linked works to a list
1059 * @work: start of series of works to be scheduled
1060 * @head: target list to append @work to
1061 * @nextp: out parameter for nested worklist walking
1063 * Schedule linked works starting from @work to @head. Work series to
1064 * be scheduled starts at @work and includes any consecutive work with
1065 * WORK_STRUCT_LINKED set in its predecessor.
1067 * If @nextp is not NULL, it's updated to point to the next work of
1068 * the last scheduled work. This allows move_linked_works() to be
1069 * nested inside outer list_for_each_entry_safe().
1072 * spin_lock_irq(pool->lock).
1074 static void move_linked_works(struct work_struct *work, struct list_head *head,
1075 struct work_struct **nextp)
1077 struct work_struct *n;
1080 * Linked worklist will always end before the end of the list,
1081 * use NULL for list head.
1083 list_for_each_entry_safe_from(work, n, NULL, entry) {
1084 list_move_tail(&work->entry, head);
1085 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1090 * If we're already inside safe list traversal and have moved
1091 * multiple works to the scheduled queue, the next position
1092 * needs to be updated.
1099 * get_pwq - get an extra reference on the specified pool_workqueue
1100 * @pwq: pool_workqueue to get
1102 * Obtain an extra reference on @pwq. The caller should guarantee that
1103 * @pwq has positive refcnt and be holding the matching pool->lock.
1105 static void get_pwq(struct pool_workqueue *pwq)
1107 lockdep_assert_held(&pwq->pool->lock);
1108 WARN_ON_ONCE(pwq->refcnt <= 0);
1113 * put_pwq - put a pool_workqueue reference
1114 * @pwq: pool_workqueue to put
1116 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1117 * destruction. The caller should be holding the matching pool->lock.
1119 static void put_pwq(struct pool_workqueue *pwq)
1121 lockdep_assert_held(&pwq->pool->lock);
1122 if (likely(--pwq->refcnt))
1124 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1127 * @pwq can't be released under pool->lock, bounce to
1128 * pwq_unbound_release_workfn(). This never recurses on the same
1129 * pool->lock as this path is taken only for unbound workqueues and
1130 * the release work item is scheduled on a per-cpu workqueue. To
1131 * avoid lockdep warning, unbound pool->locks are given lockdep
1132 * subclass of 1 in get_unbound_pool().
1134 schedule_work(&pwq->unbound_release_work);
1138 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1139 * @pwq: pool_workqueue to put (can be %NULL)
1141 * put_pwq() with locking. This function also allows %NULL @pwq.
1143 static void put_pwq_unlocked(struct pool_workqueue *pwq)
1147 * As both pwqs and pools are RCU protected, the
1148 * following lock operations are safe.
1150 spin_lock_irq(&pwq->pool->lock);
1152 spin_unlock_irq(&pwq->pool->lock);
1156 static void pwq_activate_delayed_work(struct work_struct *work)
1158 struct pool_workqueue *pwq = get_work_pwq(work);
1160 trace_workqueue_activate_work(work);
1161 if (list_empty(&pwq->pool->worklist))
1162 pwq->pool->watchdog_ts = jiffies;
1163 move_linked_works(work, &pwq->pool->worklist, NULL);
1164 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1168 static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
1170 struct work_struct *work = list_first_entry(&pwq->delayed_works,
1171 struct work_struct, entry);
1173 pwq_activate_delayed_work(work);
1177 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1178 * @pwq: pwq of interest
1179 * @color: color of work which left the queue
1181 * A work either has completed or is removed from pending queue,
1182 * decrement nr_in_flight of its pwq and handle workqueue flushing.
1185 * spin_lock_irq(pool->lock).
1187 static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1189 /* uncolored work items don't participate in flushing or nr_active */
1190 if (color == WORK_NO_COLOR)
1193 pwq->nr_in_flight[color]--;
1196 if (!list_empty(&pwq->delayed_works)) {
1197 /* one down, submit a delayed one */
1198 if (pwq->nr_active < pwq->max_active)
1199 pwq_activate_first_delayed(pwq);
1202 /* is flush in progress and are we at the flushing tip? */
1203 if (likely(pwq->flush_color != color))
1206 /* are there still in-flight works? */
1207 if (pwq->nr_in_flight[color])
1210 /* this pwq is done, clear flush_color */
1211 pwq->flush_color = -1;
1214 * If this was the last pwq, wake up the first flusher. It
1215 * will handle the rest.
1217 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1218 complete(&pwq->wq->first_flusher->done);
1224 * try_to_grab_pending - steal work item from worklist and disable irq
1225 * @work: work item to steal
1226 * @is_dwork: @work is a delayed_work
1227 * @flags: place to store irq state
1229 * Try to grab PENDING bit of @work. This function can handle @work in any
1230 * stable state - idle, on timer or on worklist.
1233 * 1 if @work was pending and we successfully stole PENDING
1234 * 0 if @work was idle and we claimed PENDING
1235 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
1236 * -ENOENT if someone else is canceling @work, this state may persist
1237 * for arbitrarily long
1240 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
1241 * interrupted while holding PENDING and @work off queue, irq must be
1242 * disabled on entry. This, combined with delayed_work->timer being
1243 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1245 * On successful return, >= 0, irq is disabled and the caller is
1246 * responsible for releasing it using local_irq_restore(*@flags).
1248 * This function is safe to call from any context including IRQ handler.
1250 static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1251 unsigned long *flags)
1253 struct worker_pool *pool;
1254 struct pool_workqueue *pwq;
1256 local_irq_save(*flags);
1258 /* try to steal the timer if it exists */
1260 struct delayed_work *dwork = to_delayed_work(work);
1263 * dwork->timer is irqsafe. If del_timer() fails, it's
1264 * guaranteed that the timer is not queued anywhere and not
1265 * running on the local CPU.
1267 if (likely(del_timer(&dwork->timer)))
1271 /* try to claim PENDING the normal way */
1272 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1277 * The queueing is in progress, or it is already queued. Try to
1278 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1280 pool = get_work_pool(work);
1284 spin_lock(&pool->lock);
1286 * work->data is guaranteed to point to pwq only while the work
1287 * item is queued on pwq->wq, and both updating work->data to point
1288 * to pwq on queueing and to pool on dequeueing are done under
1289 * pwq->pool->lock. This in turn guarantees that, if work->data
1290 * points to pwq which is associated with a locked pool, the work
1291 * item is currently queued on that pool.
1293 pwq = get_work_pwq(work);
1294 if (pwq && pwq->pool == pool) {
1295 debug_work_deactivate(work);
1298 * A delayed work item cannot be grabbed directly because
1299 * it might have linked NO_COLOR work items which, if left
1300 * on the delayed_list, will confuse pwq->nr_active
1301 * management later on and cause stall. Make sure the work
1302 * item is activated before grabbing.
1304 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1305 pwq_activate_delayed_work(work);
1307 list_del_init(&work->entry);
1308 pwq_dec_nr_in_flight(pwq, get_work_color(work));
1310 /* work->data points to pwq iff queued, point to pool */
1311 set_work_pool_and_keep_pending(work, pool->id);
1313 spin_unlock(&pool->lock);
1317 spin_unlock(&pool->lock);
1320 local_irq_restore(*flags);
1321 if (work_is_canceling(work))
1328 * insert_work - insert a work into a pool
1329 * @pwq: pwq @work belongs to
1330 * @work: work to insert
1331 * @head: insertion point
1332 * @extra_flags: extra WORK_STRUCT_* flags to set
1334 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
1335 * work_struct flags.
1338 * spin_lock_irq(pool->lock).
1340 static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1341 struct list_head *head, unsigned int extra_flags)
1343 struct worker_pool *pool = pwq->pool;
1345 /* we own @work, set data and link */
1346 set_work_pwq(work, pwq, extra_flags);
1347 list_add_tail(&work->entry, head);
1351 * Ensure either wq_worker_sleeping() sees the above
1352 * list_add_tail() or we see zero nr_running to avoid workers lying
1353 * around lazily while there are works to be processed.
1357 if (__need_more_worker(pool))
1358 wake_up_worker(pool);
1362 * Test whether @work is being queued from another work executing on the
1365 static bool is_chained_work(struct workqueue_struct *wq)
1367 struct worker *worker;
1369 worker = current_wq_worker();
1371 * Return %true iff I'm a worker executing a work item on @wq. If
1372 * I'm @worker, it's safe to dereference it without locking.
1374 return worker && worker->current_pwq->wq == wq;
1378 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1379 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1380 * avoid perturbing sensitive tasks.
1382 static int wq_select_unbound_cpu(int cpu)
1384 static bool printed_dbg_warning;
1387 if (likely(!wq_debug_force_rr_cpu)) {
1388 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1390 } else if (!printed_dbg_warning) {
1391 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1392 printed_dbg_warning = true;
1395 if (cpumask_empty(wq_unbound_cpumask))
1398 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1399 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1400 if (unlikely(new_cpu >= nr_cpu_ids)) {
1401 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1402 if (unlikely(new_cpu >= nr_cpu_ids))
1405 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1410 static void __queue_work(int cpu, struct workqueue_struct *wq,
1411 struct work_struct *work)
1413 struct pool_workqueue *pwq;
1414 struct worker_pool *last_pool;
1415 struct list_head *worklist;
1416 unsigned int work_flags;
1417 unsigned int req_cpu = cpu;
1420 * While a work item is PENDING && off queue, a task trying to
1421 * steal the PENDING will busy-loop waiting for it to either get
1422 * queued or lose PENDING. Grabbing PENDING and queueing should
1423 * happen with IRQ disabled.
1425 lockdep_assert_irqs_disabled();
1428 /* if draining, only works from the same workqueue are allowed */
1429 if (unlikely(wq->flags & __WQ_DRAINING) &&
1430 WARN_ON_ONCE(!is_chained_work(wq)))
1434 /* pwq which will be used unless @work is executing elsewhere */
1435 if (wq->flags & WQ_UNBOUND) {
1436 if (req_cpu == WORK_CPU_UNBOUND)
1437 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
1438 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1440 if (req_cpu == WORK_CPU_UNBOUND)
1441 cpu = raw_smp_processor_id();
1442 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1446 * If @work was previously on a different pool, it might still be
1447 * running there, in which case the work needs to be queued on that
1448 * pool to guarantee non-reentrancy.
1450 last_pool = get_work_pool(work);
1451 if (last_pool && last_pool != pwq->pool) {
1452 struct worker *worker;
1454 spin_lock(&last_pool->lock);
1456 worker = find_worker_executing_work(last_pool, work);
1458 if (worker && worker->current_pwq->wq == wq) {
1459 pwq = worker->current_pwq;
1461 /* meh... not running there, queue here */
1462 spin_unlock(&last_pool->lock);
1463 spin_lock(&pwq->pool->lock);
1466 spin_lock(&pwq->pool->lock);
1470 * pwq is determined and locked. For unbound pools, we could have
1471 * raced with pwq release and it could already be dead. If its
1472 * refcnt is zero, repeat pwq selection. Note that pwqs never die
1473 * without another pwq replacing it in the numa_pwq_tbl or while
1474 * work items are executing on it, so the retrying is guaranteed to
1475 * make forward-progress.
1477 if (unlikely(!pwq->refcnt)) {
1478 if (wq->flags & WQ_UNBOUND) {
1479 spin_unlock(&pwq->pool->lock);
1484 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1488 /* pwq determined, queue */
1489 trace_workqueue_queue_work(req_cpu, pwq, work);
1491 if (WARN_ON(!list_empty(&work->entry)))
1494 pwq->nr_in_flight[pwq->work_color]++;
1495 work_flags = work_color_to_flags(pwq->work_color);
1497 if (likely(pwq->nr_active < pwq->max_active)) {
1498 trace_workqueue_activate_work(work);
1500 worklist = &pwq->pool->worklist;
1501 if (list_empty(worklist))
1502 pwq->pool->watchdog_ts = jiffies;
1504 work_flags |= WORK_STRUCT_DELAYED;
1505 worklist = &pwq->delayed_works;
1508 debug_work_activate(work);
1509 insert_work(pwq, work, worklist, work_flags);
1512 spin_unlock(&pwq->pool->lock);
1517 * queue_work_on - queue work on specific cpu
1518 * @cpu: CPU number to execute work on
1519 * @wq: workqueue to use
1520 * @work: work to queue
1522 * We queue the work to a specific CPU, the caller must ensure it
1525 * Return: %false if @work was already on a queue, %true otherwise.
1527 bool queue_work_on(int cpu, struct workqueue_struct *wq,
1528 struct work_struct *work)
1531 unsigned long flags;
1533 local_irq_save(flags);
1535 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1536 __queue_work(cpu, wq, work);
1540 local_irq_restore(flags);
1543 EXPORT_SYMBOL(queue_work_on);
1546 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1547 * @node: NUMA node ID that we want to select a CPU from
1549 * This function will attempt to find a "random" cpu available on a given
1550 * node. If there are no CPUs available on the given node it will return
1551 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1552 * available CPU if we need to schedule this work.
1554 static int workqueue_select_cpu_near(int node)
1558 /* No point in doing this if NUMA isn't enabled for workqueues */
1559 if (!wq_numa_enabled)
1560 return WORK_CPU_UNBOUND;
1562 /* Delay binding to CPU if node is not valid or online */
1563 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1564 return WORK_CPU_UNBOUND;
1566 /* Use local node/cpu if we are already there */
1567 cpu = raw_smp_processor_id();
1568 if (node == cpu_to_node(cpu))
1571 /* Use "random" otherwise know as "first" online CPU of node */
1572 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1574 /* If CPU is valid return that, otherwise just defer */
1575 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1579 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1580 * @node: NUMA node that we are targeting the work for
1581 * @wq: workqueue to use
1582 * @work: work to queue
1584 * We queue the work to a "random" CPU within a given NUMA node. The basic
1585 * idea here is to provide a way to somehow associate work with a given
1588 * This function will only make a best effort attempt at getting this onto
1589 * the right NUMA node. If no node is requested or the requested node is
1590 * offline then we just fall back to standard queue_work behavior.
1592 * Currently the "random" CPU ends up being the first available CPU in the
1593 * intersection of cpu_online_mask and the cpumask of the node, unless we
1594 * are running on the node. In that case we just use the current CPU.
1596 * Return: %false if @work was already on a queue, %true otherwise.
1598 bool queue_work_node(int node, struct workqueue_struct *wq,
1599 struct work_struct *work)
1601 unsigned long flags;
1605 * This current implementation is specific to unbound workqueues.
1606 * Specifically we only return the first available CPU for a given
1607 * node instead of cycling through individual CPUs within the node.
1609 * If this is used with a per-cpu workqueue then the logic in
1610 * workqueue_select_cpu_near would need to be updated to allow for
1611 * some round robin type logic.
1613 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1615 local_irq_save(flags);
1617 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1618 int cpu = workqueue_select_cpu_near(node);
1620 __queue_work(cpu, wq, work);
1624 local_irq_restore(flags);
1627 EXPORT_SYMBOL_GPL(queue_work_node);
1629 void delayed_work_timer_fn(struct timer_list *t)
1631 struct delayed_work *dwork = from_timer(dwork, t, timer);
1633 /* should have been called from irqsafe timer with irq already off */
1634 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
1636 EXPORT_SYMBOL(delayed_work_timer_fn);
1638 static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1639 struct delayed_work *dwork, unsigned long delay)
1641 struct timer_list *timer = &dwork->timer;
1642 struct work_struct *work = &dwork->work;
1645 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
1646 WARN_ON_ONCE(timer_pending(timer));
1647 WARN_ON_ONCE(!list_empty(&work->entry));
1650 * If @delay is 0, queue @dwork->work immediately. This is for
1651 * both optimization and correctness. The earliest @timer can
1652 * expire is on the closest next tick and delayed_work users depend
1653 * on that there's no such delay when @delay is 0.
1656 __queue_work(cpu, wq, &dwork->work);
1662 timer->expires = jiffies + delay;
1664 if (unlikely(cpu != WORK_CPU_UNBOUND))
1665 add_timer_on(timer, cpu);
1671 * queue_delayed_work_on - queue work on specific CPU after delay
1672 * @cpu: CPU number to execute work on
1673 * @wq: workqueue to use
1674 * @dwork: work to queue
1675 * @delay: number of jiffies to wait before queueing
1677 * Return: %false if @work was already on a queue, %true otherwise. If
1678 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1681 bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1682 struct delayed_work *dwork, unsigned long delay)
1684 struct work_struct *work = &dwork->work;
1686 unsigned long flags;
1688 /* read the comment in __queue_work() */
1689 local_irq_save(flags);
1691 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1692 __queue_delayed_work(cpu, wq, dwork, delay);
1696 local_irq_restore(flags);
1699 EXPORT_SYMBOL(queue_delayed_work_on);
1702 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1703 * @cpu: CPU number to execute work on
1704 * @wq: workqueue to use
1705 * @dwork: work to queue
1706 * @delay: number of jiffies to wait before queueing
1708 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1709 * modify @dwork's timer so that it expires after @delay. If @delay is
1710 * zero, @work is guaranteed to be scheduled immediately regardless of its
1713 * Return: %false if @dwork was idle and queued, %true if @dwork was
1714 * pending and its timer was modified.
1716 * This function is safe to call from any context including IRQ handler.
1717 * See try_to_grab_pending() for details.
1719 bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1720 struct delayed_work *dwork, unsigned long delay)
1722 unsigned long flags;
1726 ret = try_to_grab_pending(&dwork->work, true, &flags);
1727 } while (unlikely(ret == -EAGAIN));
1729 if (likely(ret >= 0)) {
1730 __queue_delayed_work(cpu, wq, dwork, delay);
1731 local_irq_restore(flags);
1734 /* -ENOENT from try_to_grab_pending() becomes %true */
1737 EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1739 static void rcu_work_rcufn(struct rcu_head *rcu)
1741 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1743 /* read the comment in __queue_work() */
1744 local_irq_disable();
1745 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1750 * queue_rcu_work - queue work after a RCU grace period
1751 * @wq: workqueue to use
1752 * @rwork: work to queue
1754 * Return: %false if @rwork was already pending, %true otherwise. Note
1755 * that a full RCU grace period is guaranteed only after a %true return.
1756 * While @rwork is guaranteed to be executed after a %false return, the
1757 * execution may happen before a full RCU grace period has passed.
1759 bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1761 struct work_struct *work = &rwork->work;
1763 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1765 call_rcu(&rwork->rcu, rcu_work_rcufn);
1771 EXPORT_SYMBOL(queue_rcu_work);
1774 * worker_enter_idle - enter idle state
1775 * @worker: worker which is entering idle state
1777 * @worker is entering idle state. Update stats and idle timer if
1781 * spin_lock_irq(pool->lock).
1783 static void worker_enter_idle(struct worker *worker)
1785 struct worker_pool *pool = worker->pool;
1787 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1788 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1789 (worker->hentry.next || worker->hentry.pprev)))
1792 /* can't use worker_set_flags(), also called from create_worker() */
1793 worker->flags |= WORKER_IDLE;
1795 worker->last_active = jiffies;
1797 /* idle_list is LIFO */
1798 list_add(&worker->entry, &pool->idle_list);
1800 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1801 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1804 * Sanity check nr_running. Because unbind_workers() releases
1805 * pool->lock between setting %WORKER_UNBOUND and zapping
1806 * nr_running, the warning may trigger spuriously. Check iff
1807 * unbind is not in progress.
1809 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1810 pool->nr_workers == pool->nr_idle &&
1811 atomic_read(&pool->nr_running));
1815 * worker_leave_idle - leave idle state
1816 * @worker: worker which is leaving idle state
1818 * @worker is leaving idle state. Update stats.
1821 * spin_lock_irq(pool->lock).
1823 static void worker_leave_idle(struct worker *worker)
1825 struct worker_pool *pool = worker->pool;
1827 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1829 worker_clr_flags(worker, WORKER_IDLE);
1831 list_del_init(&worker->entry);
1834 static struct worker *alloc_worker(int node)
1836 struct worker *worker;
1838 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
1840 INIT_LIST_HEAD(&worker->entry);
1841 INIT_LIST_HEAD(&worker->scheduled);
1842 INIT_LIST_HEAD(&worker->node);
1843 /* on creation a worker is in !idle && prep state */
1844 worker->flags = WORKER_PREP;
1850 * worker_attach_to_pool() - attach a worker to a pool
1851 * @worker: worker to be attached
1852 * @pool: the target pool
1854 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1855 * cpu-binding of @worker are kept coordinated with the pool across
1858 static void worker_attach_to_pool(struct worker *worker,
1859 struct worker_pool *pool)
1861 mutex_lock(&wq_pool_attach_mutex);
1864 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1865 * stable across this function. See the comments above the flag
1866 * definition for details.
1868 if (pool->flags & POOL_DISASSOCIATED)
1869 worker->flags |= WORKER_UNBOUND;
1871 if (worker->rescue_wq)
1872 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1874 list_add_tail(&worker->node, &pool->workers);
1875 worker->pool = pool;
1877 mutex_unlock(&wq_pool_attach_mutex);
1881 * worker_detach_from_pool() - detach a worker from its pool
1882 * @worker: worker which is attached to its pool
1884 * Undo the attaching which had been done in worker_attach_to_pool(). The
1885 * caller worker shouldn't access to the pool after detached except it has
1886 * other reference to the pool.
1888 static void worker_detach_from_pool(struct worker *worker)
1890 struct worker_pool *pool = worker->pool;
1891 struct completion *detach_completion = NULL;
1893 mutex_lock(&wq_pool_attach_mutex);
1895 list_del(&worker->node);
1896 worker->pool = NULL;
1898 if (list_empty(&pool->workers))
1899 detach_completion = pool->detach_completion;
1900 mutex_unlock(&wq_pool_attach_mutex);
1902 /* clear leftover flags without pool->lock after it is detached */
1903 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1905 if (detach_completion)
1906 complete(detach_completion);
1910 * create_worker - create a new workqueue worker
1911 * @pool: pool the new worker will belong to
1913 * Create and start a new worker which is attached to @pool.
1916 * Might sleep. Does GFP_KERNEL allocations.
1919 * Pointer to the newly created worker.
1921 static struct worker *create_worker(struct worker_pool *pool)
1923 struct worker *worker = NULL;
1927 /* ID is needed to determine kthread name */
1928 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
1932 worker = alloc_worker(pool->node);
1939 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1940 pool->attrs->nice < 0 ? "H" : "");
1942 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1944 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1945 "kworker/%s", id_buf);
1946 if (IS_ERR(worker->task))
1949 set_user_nice(worker->task, pool->attrs->nice);
1950 kthread_bind_mask(worker->task, pool->attrs->cpumask);
1952 /* successful, attach the worker to the pool */
1953 worker_attach_to_pool(worker, pool);
1955 /* start the newly created worker */
1956 spin_lock_irq(&pool->lock);
1957 worker->pool->nr_workers++;
1958 worker_enter_idle(worker);
1959 wake_up_process(worker->task);
1960 spin_unlock_irq(&pool->lock);
1966 ida_simple_remove(&pool->worker_ida, id);
1972 * destroy_worker - destroy a workqueue worker
1973 * @worker: worker to be destroyed
1975 * Destroy @worker and adjust @pool stats accordingly. The worker should
1979 * spin_lock_irq(pool->lock).
1981 static void destroy_worker(struct worker *worker)
1983 struct worker_pool *pool = worker->pool;
1985 lockdep_assert_held(&pool->lock);
1987 /* sanity check frenzy */
1988 if (WARN_ON(worker->current_work) ||
1989 WARN_ON(!list_empty(&worker->scheduled)) ||
1990 WARN_ON(!(worker->flags & WORKER_IDLE)))
1996 list_del_init(&worker->entry);
1997 worker->flags |= WORKER_DIE;
1998 wake_up_process(worker->task);
2001 static void idle_worker_timeout(struct timer_list *t)
2003 struct worker_pool *pool = from_timer(pool, t, idle_timer);
2005 spin_lock_irq(&pool->lock);
2007 while (too_many_workers(pool)) {
2008 struct worker *worker;
2009 unsigned long expires;
2011 /* idle_list is kept in LIFO order, check the last one */
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);
2023 spin_unlock_irq(&pool->lock);
2026 static void send_mayday(struct work_struct *work)
2028 struct pool_workqueue *pwq = get_work_pwq(work);
2029 struct workqueue_struct *wq = pwq->wq;
2031 lockdep_assert_held(&wq_mayday_lock);
2036 /* mayday mayday mayday */
2037 if (list_empty(&pwq->mayday_node)) {
2039 * If @pwq is for an unbound wq, its base ref may be put at
2040 * any time due to an attribute change. Pin @pwq until the
2041 * rescuer is done with it.
2044 list_add_tail(&pwq->mayday_node, &wq->maydays);
2045 wake_up_process(wq->rescuer->task);
2049 static void pool_mayday_timeout(struct timer_list *t)
2051 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
2052 struct work_struct *work;
2054 spin_lock_irq(&pool->lock);
2055 spin_lock(&wq_mayday_lock); /* for wq->maydays */
2057 if (need_to_create_worker(pool)) {
2059 * We've been trying to create a new worker but
2060 * haven't been successful. We might be hitting an
2061 * allocation deadlock. Send distress signals to
2064 list_for_each_entry(work, &pool->worklist, entry)
2068 spin_unlock(&wq_mayday_lock);
2069 spin_unlock_irq(&pool->lock);
2071 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
2075 * maybe_create_worker - create a new worker if necessary
2076 * @pool: pool to create a new worker for
2078 * Create a new worker for @pool if necessary. @pool is guaranteed to
2079 * have at least one idle worker on return from this function. If
2080 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
2081 * sent to all rescuers with works scheduled on @pool to resolve
2082 * possible allocation deadlock.
2084 * On return, need_to_create_worker() is guaranteed to be %false and
2085 * may_start_working() %true.
2088 * spin_lock_irq(pool->lock) which may be released and regrabbed
2089 * multiple times. Does GFP_KERNEL allocations. Called only from
2092 static void maybe_create_worker(struct worker_pool *pool)
2093 __releases(&pool->lock)
2094 __acquires(&pool->lock)
2097 spin_unlock_irq(&pool->lock);
2099 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
2100 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2103 if (create_worker(pool) || !need_to_create_worker(pool))
2106 schedule_timeout_interruptible(CREATE_COOLDOWN);
2108 if (!need_to_create_worker(pool))
2112 del_timer_sync(&pool->mayday_timer);
2113 spin_lock_irq(&pool->lock);
2115 * This is necessary even after a new worker was just successfully
2116 * created as @pool->lock was dropped and the new worker might have
2117 * already become busy.
2119 if (need_to_create_worker(pool))
2124 * manage_workers - manage worker pool
2127 * Assume the manager role and manage the worker pool @worker belongs
2128 * to. At any given time, there can be only zero or one manager per
2129 * pool. The exclusion is handled automatically by this function.
2131 * The caller can safely start processing works on false return. On
2132 * true return, it's guaranteed that need_to_create_worker() is false
2133 * and may_start_working() is true.
2136 * spin_lock_irq(pool->lock) which may be released and regrabbed
2137 * multiple times. Does GFP_KERNEL allocations.
2140 * %false if the pool doesn't need management and the caller can safely
2141 * start processing works, %true if management function was performed and
2142 * the conditions that the caller verified before calling the function may
2143 * no longer be true.
2145 static bool manage_workers(struct worker *worker)
2147 struct worker_pool *pool = worker->pool;
2149 if (pool->flags & POOL_MANAGER_ACTIVE)
2152 pool->flags |= POOL_MANAGER_ACTIVE;
2153 pool->manager = worker;
2155 maybe_create_worker(pool);
2157 pool->manager = NULL;
2158 pool->flags &= ~POOL_MANAGER_ACTIVE;
2159 wake_up(&wq_manager_wait);
2164 * process_one_work - process single work
2166 * @work: work to process
2168 * Process @work. This function contains all the logics necessary to
2169 * process a single work including synchronization against and
2170 * interaction with other workers on the same cpu, queueing and
2171 * flushing. As long as context requirement is met, any worker can
2172 * call this function to process a work.
2175 * spin_lock_irq(pool->lock) which is released and regrabbed.
2177 static void process_one_work(struct worker *worker, struct work_struct *work)
2178 __releases(&pool->lock)
2179 __acquires(&pool->lock)
2181 struct pool_workqueue *pwq = get_work_pwq(work);
2182 struct worker_pool *pool = worker->pool;
2183 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
2185 struct worker *collision;
2186 #ifdef CONFIG_LOCKDEP
2188 * It is permissible to free the struct work_struct from
2189 * inside the function that is called from it, this we need to
2190 * take into account for lockdep too. To avoid bogus "held
2191 * lock freed" warnings as well as problems when looking into
2192 * work->lockdep_map, make a copy and use that here.
2194 struct lockdep_map lockdep_map;
2196 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
2198 /* ensure we're on the correct CPU */
2199 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
2200 raw_smp_processor_id() != pool->cpu);
2203 * A single work shouldn't be executed concurrently by
2204 * multiple workers on a single cpu. Check whether anyone is
2205 * already processing the work. If so, defer the work to the
2206 * currently executing one.
2208 collision = find_worker_executing_work(pool, work);
2209 if (unlikely(collision)) {
2210 move_linked_works(work, &collision->scheduled, NULL);
2214 /* claim and dequeue */
2215 debug_work_deactivate(work);
2216 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2217 worker->current_work = work;
2218 worker->current_func = work->func;
2219 worker->current_pwq = pwq;
2220 work_color = get_work_color(work);
2223 * Record wq name for cmdline and debug reporting, may get
2224 * overridden through set_worker_desc().
2226 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2228 list_del_init(&work->entry);
2231 * CPU intensive works don't participate in concurrency management.
2232 * They're the scheduler's responsibility. This takes @worker out
2233 * of concurrency management and the next code block will chain
2234 * execution of the pending work items.
2236 if (unlikely(cpu_intensive))
2237 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
2240 * Wake up another worker if necessary. The condition is always
2241 * false for normal per-cpu workers since nr_running would always
2242 * be >= 1 at this point. This is used to chain execution of the
2243 * pending work items for WORKER_NOT_RUNNING workers such as the
2244 * UNBOUND and CPU_INTENSIVE ones.
2246 if (need_more_worker(pool))
2247 wake_up_worker(pool);
2250 * Record the last pool and clear PENDING which should be the last
2251 * update to @work. Also, do this inside @pool->lock so that
2252 * PENDING and queued state changes happen together while IRQ is
2255 set_work_pool_and_clear_pending(work, pool->id);
2257 spin_unlock_irq(&pool->lock);
2259 lock_map_acquire(&pwq->wq->lockdep_map);
2260 lock_map_acquire(&lockdep_map);
2262 * Strictly speaking we should mark the invariant state without holding
2263 * any locks, that is, before these two lock_map_acquire()'s.
2265 * However, that would result in:
2272 * Which would create W1->C->W1 dependencies, even though there is no
2273 * actual deadlock possible. There are two solutions, using a
2274 * read-recursive acquire on the work(queue) 'locks', but this will then
2275 * hit the lockdep limitation on recursive locks, or simply discard
2278 * AFAICT there is no possible deadlock scenario between the
2279 * flush_work() and complete() primitives (except for single-threaded
2280 * workqueues), so hiding them isn't a problem.
2282 lockdep_invariant_state(true);
2283 trace_workqueue_execute_start(work);
2284 worker->current_func(work);
2286 * While we must be careful to not use "work" after this, the trace
2287 * point will only record its address.
2289 trace_workqueue_execute_end(work);
2290 lock_map_release(&lockdep_map);
2291 lock_map_release(&pwq->wq->lockdep_map);
2293 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2294 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2295 " last function: %ps\n",
2296 current->comm, preempt_count(), task_pid_nr(current),
2297 worker->current_func);
2298 debug_show_held_locks(current);
2303 * The following prevents a kworker from hogging CPU on !PREEMPT
2304 * kernels, where a requeueing work item waiting for something to
2305 * happen could deadlock with stop_machine as such work item could
2306 * indefinitely requeue itself while all other CPUs are trapped in
2307 * stop_machine. At the same time, report a quiescent RCU state so
2308 * the same condition doesn't freeze RCU.
2312 spin_lock_irq(&pool->lock);
2314 /* clear cpu intensive status */
2315 if (unlikely(cpu_intensive))
2316 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2318 /* tag the worker for identification in schedule() */
2319 worker->last_func = worker->current_func;
2321 /* we're done with it, release */
2322 hash_del(&worker->hentry);
2323 worker->current_work = NULL;
2324 worker->current_func = NULL;
2325 worker->current_pwq = NULL;
2326 pwq_dec_nr_in_flight(pwq, work_color);
2330 * process_scheduled_works - process scheduled works
2333 * Process all scheduled works. Please note that the scheduled list
2334 * may change while processing a work, so this function repeatedly
2335 * fetches a work from the top and executes it.
2338 * spin_lock_irq(pool->lock) which may be released and regrabbed
2341 static void process_scheduled_works(struct worker *worker)
2343 while (!list_empty(&worker->scheduled)) {
2344 struct work_struct *work = list_first_entry(&worker->scheduled,
2345 struct work_struct, entry);
2346 process_one_work(worker, work);
2350 static void set_pf_worker(bool val)
2352 mutex_lock(&wq_pool_attach_mutex);
2354 current->flags |= PF_WQ_WORKER;
2356 current->flags &= ~PF_WQ_WORKER;
2357 mutex_unlock(&wq_pool_attach_mutex);
2361 * worker_thread - the worker thread function
2364 * The worker thread function. All workers belong to a worker_pool -
2365 * either a per-cpu one or dynamic unbound one. These workers process all
2366 * work items regardless of their specific target workqueue. The only
2367 * exception is work items which belong to workqueues with a rescuer which
2368 * will be explained in rescuer_thread().
2372 static int worker_thread(void *__worker)
2374 struct worker *worker = __worker;
2375 struct worker_pool *pool = worker->pool;
2377 /* tell the scheduler that this is a workqueue worker */
2378 set_pf_worker(true);
2380 spin_lock_irq(&pool->lock);
2382 /* am I supposed to die? */
2383 if (unlikely(worker->flags & WORKER_DIE)) {
2384 spin_unlock_irq(&pool->lock);
2385 WARN_ON_ONCE(!list_empty(&worker->entry));
2386 set_pf_worker(false);
2388 set_task_comm(worker->task, "kworker/dying");
2389 ida_simple_remove(&pool->worker_ida, worker->id);
2390 worker_detach_from_pool(worker);
2395 worker_leave_idle(worker);
2397 /* no more worker necessary? */
2398 if (!need_more_worker(pool))
2401 /* do we need to manage? */
2402 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2406 * ->scheduled list can only be filled while a worker is
2407 * preparing to process a work or actually processing it.
2408 * Make sure nobody diddled with it while I was sleeping.
2410 WARN_ON_ONCE(!list_empty(&worker->scheduled));
2413 * Finish PREP stage. We're guaranteed to have at least one idle
2414 * worker or that someone else has already assumed the manager
2415 * role. This is where @worker starts participating in concurrency
2416 * management if applicable and concurrency management is restored
2417 * after being rebound. See rebind_workers() for details.
2419 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2422 struct work_struct *work =
2423 list_first_entry(&pool->worklist,
2424 struct work_struct, entry);
2426 pool->watchdog_ts = jiffies;
2428 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2429 /* optimization path, not strictly necessary */
2430 process_one_work(worker, work);
2431 if (unlikely(!list_empty(&worker->scheduled)))
2432 process_scheduled_works(worker);
2434 move_linked_works(work, &worker->scheduled, NULL);
2435 process_scheduled_works(worker);
2437 } while (keep_working(pool));
2439 worker_set_flags(worker, WORKER_PREP);
2442 * pool->lock is held and there's no work to process and no need to
2443 * manage, sleep. Workers are woken up only while holding
2444 * pool->lock or from local cpu, so setting the current state
2445 * before releasing pool->lock is enough to prevent losing any
2448 worker_enter_idle(worker);
2449 __set_current_state(TASK_IDLE);
2450 spin_unlock_irq(&pool->lock);
2456 * rescuer_thread - the rescuer thread function
2459 * Workqueue rescuer thread function. There's one rescuer for each
2460 * workqueue which has WQ_MEM_RECLAIM set.
2462 * Regular work processing on a pool may block trying to create a new
2463 * worker which uses GFP_KERNEL allocation which has slight chance of
2464 * developing into deadlock if some works currently on the same queue
2465 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2466 * the problem rescuer solves.
2468 * When such condition is possible, the pool summons rescuers of all
2469 * workqueues which have works queued on the pool and let them process
2470 * those works so that forward progress can be guaranteed.
2472 * This should happen rarely.
2476 static int rescuer_thread(void *__rescuer)
2478 struct worker *rescuer = __rescuer;
2479 struct workqueue_struct *wq = rescuer->rescue_wq;
2480 struct list_head *scheduled = &rescuer->scheduled;
2483 set_user_nice(current, RESCUER_NICE_LEVEL);
2486 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2487 * doesn't participate in concurrency management.
2489 set_pf_worker(true);
2491 set_current_state(TASK_IDLE);
2494 * By the time the rescuer is requested to stop, the workqueue
2495 * shouldn't have any work pending, but @wq->maydays may still have
2496 * pwq(s) queued. This can happen by non-rescuer workers consuming
2497 * all the work items before the rescuer got to them. Go through
2498 * @wq->maydays processing before acting on should_stop so that the
2499 * list is always empty on exit.
2501 should_stop = kthread_should_stop();
2503 /* see whether any pwq is asking for help */
2504 spin_lock_irq(&wq_mayday_lock);
2506 while (!list_empty(&wq->maydays)) {
2507 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2508 struct pool_workqueue, mayday_node);
2509 struct worker_pool *pool = pwq->pool;
2510 struct work_struct *work, *n;
2513 __set_current_state(TASK_RUNNING);
2514 list_del_init(&pwq->mayday_node);
2516 spin_unlock_irq(&wq_mayday_lock);
2518 worker_attach_to_pool(rescuer, pool);
2520 spin_lock_irq(&pool->lock);
2523 * Slurp in all works issued via this workqueue and
2526 WARN_ON_ONCE(!list_empty(scheduled));
2527 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2528 if (get_work_pwq(work) == pwq) {
2530 pool->watchdog_ts = jiffies;
2531 move_linked_works(work, scheduled, &n);
2536 if (!list_empty(scheduled)) {
2537 process_scheduled_works(rescuer);
2540 * The above execution of rescued work items could
2541 * have created more to rescue through
2542 * pwq_activate_first_delayed() or chained
2543 * queueing. Let's put @pwq back on mayday list so
2544 * that such back-to-back work items, which may be
2545 * being used to relieve memory pressure, don't
2546 * incur MAYDAY_INTERVAL delay inbetween.
2548 if (need_to_create_worker(pool)) {
2549 spin_lock(&wq_mayday_lock);
2551 * Queue iff we aren't racing destruction
2552 * and somebody else hasn't queued it already.
2554 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2556 list_add_tail(&pwq->mayday_node, &wq->maydays);
2558 spin_unlock(&wq_mayday_lock);
2563 * Put the reference grabbed by send_mayday(). @pool won't
2564 * go away while we're still attached to it.
2569 * Leave this pool. If need_more_worker() is %true, notify a
2570 * regular worker; otherwise, we end up with 0 concurrency
2571 * and stalling the execution.
2573 if (need_more_worker(pool))
2574 wake_up_worker(pool);
2576 spin_unlock_irq(&pool->lock);
2578 worker_detach_from_pool(rescuer);
2580 spin_lock_irq(&wq_mayday_lock);
2583 spin_unlock_irq(&wq_mayday_lock);
2586 __set_current_state(TASK_RUNNING);
2587 set_pf_worker(false);
2591 /* rescuers should never participate in concurrency management */
2592 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2598 * check_flush_dependency - check for flush dependency sanity
2599 * @target_wq: workqueue being flushed
2600 * @target_work: work item being flushed (NULL for workqueue flushes)
2602 * %current is trying to flush the whole @target_wq or @target_work on it.
2603 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2604 * reclaiming memory or running on a workqueue which doesn't have
2605 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2608 static void check_flush_dependency(struct workqueue_struct *target_wq,
2609 struct work_struct *target_work)
2611 work_func_t target_func = target_work ? target_work->func : NULL;
2612 struct worker *worker;
2614 if (target_wq->flags & WQ_MEM_RECLAIM)
2617 worker = current_wq_worker();
2619 WARN_ONCE(current->flags & PF_MEMALLOC,
2620 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
2621 current->pid, current->comm, target_wq->name, target_func);
2622 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2623 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
2624 "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
2625 worker->current_pwq->wq->name, worker->current_func,
2626 target_wq->name, target_func);
2630 struct work_struct work;
2631 struct completion done;
2632 struct task_struct *task; /* purely informational */
2635 static void wq_barrier_func(struct work_struct *work)
2637 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2638 complete(&barr->done);
2642 * insert_wq_barrier - insert a barrier work
2643 * @pwq: pwq to insert barrier into
2644 * @barr: wq_barrier to insert
2645 * @target: target work to attach @barr to
2646 * @worker: worker currently executing @target, NULL if @target is not executing
2648 * @barr is linked to @target such that @barr is completed only after
2649 * @target finishes execution. Please note that the ordering
2650 * guarantee is observed only with respect to @target and on the local
2653 * Currently, a queued barrier can't be canceled. This is because
2654 * try_to_grab_pending() can't determine whether the work to be
2655 * grabbed is at the head of the queue and thus can't clear LINKED
2656 * flag of the previous work while there must be a valid next work
2657 * after a work with LINKED flag set.
2659 * Note that when @worker is non-NULL, @target may be modified
2660 * underneath us, so we can't reliably determine pwq from @target.
2663 * spin_lock_irq(pool->lock).
2665 static void insert_wq_barrier(struct pool_workqueue *pwq,
2666 struct wq_barrier *barr,
2667 struct work_struct *target, struct worker *worker)
2669 struct list_head *head;
2670 unsigned int linked = 0;
2673 * debugobject calls are safe here even with pool->lock locked
2674 * as we know for sure that this will not trigger any of the
2675 * checks and call back into the fixup functions where we
2678 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
2679 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2681 init_completion_map(&barr->done, &target->lockdep_map);
2683 barr->task = current;
2686 * If @target is currently being executed, schedule the
2687 * barrier to the worker; otherwise, put it after @target.
2690 head = worker->scheduled.next;
2692 unsigned long *bits = work_data_bits(target);
2694 head = target->entry.next;
2695 /* there can already be other linked works, inherit and set */
2696 linked = *bits & WORK_STRUCT_LINKED;
2697 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2700 debug_work_activate(&barr->work);
2701 insert_work(pwq, &barr->work, head,
2702 work_color_to_flags(WORK_NO_COLOR) | linked);
2706 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
2707 * @wq: workqueue being flushed
2708 * @flush_color: new flush color, < 0 for no-op
2709 * @work_color: new work color, < 0 for no-op
2711 * Prepare pwqs for workqueue flushing.
2713 * If @flush_color is non-negative, flush_color on all pwqs should be
2714 * -1. If no pwq has in-flight commands at the specified color, all
2715 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2716 * has in flight commands, its pwq->flush_color is set to
2717 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
2718 * wakeup logic is armed and %true is returned.
2720 * The caller should have initialized @wq->first_flusher prior to
2721 * calling this function with non-negative @flush_color. If
2722 * @flush_color is negative, no flush color update is done and %false
2725 * If @work_color is non-negative, all pwqs should have the same
2726 * work_color which is previous to @work_color and all will be
2727 * advanced to @work_color.
2730 * mutex_lock(wq->mutex).
2733 * %true if @flush_color >= 0 and there's something to flush. %false
2736 static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
2737 int flush_color, int work_color)
2740 struct pool_workqueue *pwq;
2742 if (flush_color >= 0) {
2743 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2744 atomic_set(&wq->nr_pwqs_to_flush, 1);
2747 for_each_pwq(pwq, wq) {
2748 struct worker_pool *pool = pwq->pool;
2750 spin_lock_irq(&pool->lock);
2752 if (flush_color >= 0) {
2753 WARN_ON_ONCE(pwq->flush_color != -1);
2755 if (pwq->nr_in_flight[flush_color]) {
2756 pwq->flush_color = flush_color;
2757 atomic_inc(&wq->nr_pwqs_to_flush);
2762 if (work_color >= 0) {
2763 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2764 pwq->work_color = work_color;
2767 spin_unlock_irq(&pool->lock);
2770 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
2771 complete(&wq->first_flusher->done);
2777 * flush_workqueue - ensure that any scheduled work has run to completion.
2778 * @wq: workqueue to flush
2780 * This function sleeps until all work items which were queued on entry
2781 * have finished execution, but it is not livelocked by new incoming ones.
2783 void flush_workqueue(struct workqueue_struct *wq)
2785 struct wq_flusher this_flusher = {
2786 .list = LIST_HEAD_INIT(this_flusher.list),
2788 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
2792 if (WARN_ON(!wq_online))
2795 lock_map_acquire(&wq->lockdep_map);
2796 lock_map_release(&wq->lockdep_map);
2798 mutex_lock(&wq->mutex);
2801 * Start-to-wait phase
2803 next_color = work_next_color(wq->work_color);
2805 if (next_color != wq->flush_color) {
2807 * Color space is not full. The current work_color
2808 * becomes our flush_color and work_color is advanced
2811 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
2812 this_flusher.flush_color = wq->work_color;
2813 wq->work_color = next_color;
2815 if (!wq->first_flusher) {
2816 /* no flush in progress, become the first flusher */
2817 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
2819 wq->first_flusher = &this_flusher;
2821 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
2823 /* nothing to flush, done */
2824 wq->flush_color = next_color;
2825 wq->first_flusher = NULL;
2830 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
2831 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2832 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
2836 * Oops, color space is full, wait on overflow queue.
2837 * The next flush completion will assign us
2838 * flush_color and transfer to flusher_queue.
2840 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2843 check_flush_dependency(wq, NULL);
2845 mutex_unlock(&wq->mutex);
2847 wait_for_completion(&this_flusher.done);
2850 * Wake-up-and-cascade phase
2852 * First flushers are responsible for cascading flushes and
2853 * handling overflow. Non-first flushers can simply return.
2855 if (wq->first_flusher != &this_flusher)
2858 mutex_lock(&wq->mutex);
2860 /* we might have raced, check again with mutex held */
2861 if (wq->first_flusher != &this_flusher)
2864 wq->first_flusher = NULL;
2866 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2867 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
2870 struct wq_flusher *next, *tmp;
2872 /* complete all the flushers sharing the current flush color */
2873 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2874 if (next->flush_color != wq->flush_color)
2876 list_del_init(&next->list);
2877 complete(&next->done);
2880 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2881 wq->flush_color != work_next_color(wq->work_color));
2883 /* this flush_color is finished, advance by one */
2884 wq->flush_color = work_next_color(wq->flush_color);
2886 /* one color has been freed, handle overflow queue */
2887 if (!list_empty(&wq->flusher_overflow)) {
2889 * Assign the same color to all overflowed
2890 * flushers, advance work_color and append to
2891 * flusher_queue. This is the start-to-wait
2892 * phase for these overflowed flushers.
2894 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2895 tmp->flush_color = wq->work_color;
2897 wq->work_color = work_next_color(wq->work_color);
2899 list_splice_tail_init(&wq->flusher_overflow,
2900 &wq->flusher_queue);
2901 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
2904 if (list_empty(&wq->flusher_queue)) {
2905 WARN_ON_ONCE(wq->flush_color != wq->work_color);
2910 * Need to flush more colors. Make the next flusher
2911 * the new first flusher and arm pwqs.
2913 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2914 WARN_ON_ONCE(wq->flush_color != next->flush_color);
2916 list_del_init(&next->list);
2917 wq->first_flusher = next;
2919 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
2923 * Meh... this color is already done, clear first
2924 * flusher and repeat cascading.
2926 wq->first_flusher = NULL;
2930 mutex_unlock(&wq->mutex);
2932 EXPORT_SYMBOL(flush_workqueue);
2935 * drain_workqueue - drain a workqueue
2936 * @wq: workqueue to drain
2938 * Wait until the workqueue becomes empty. While draining is in progress,
2939 * only chain queueing is allowed. IOW, only currently pending or running
2940 * work items on @wq can queue further work items on it. @wq is flushed
2941 * repeatedly until it becomes empty. The number of flushing is determined
2942 * by the depth of chaining and should be relatively short. Whine if it
2945 void drain_workqueue(struct workqueue_struct *wq)
2947 unsigned int flush_cnt = 0;
2948 struct pool_workqueue *pwq;
2951 * __queue_work() needs to test whether there are drainers, is much
2952 * hotter than drain_workqueue() and already looks at @wq->flags.
2953 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
2955 mutex_lock(&wq->mutex);
2956 if (!wq->nr_drainers++)
2957 wq->flags |= __WQ_DRAINING;
2958 mutex_unlock(&wq->mutex);
2960 flush_workqueue(wq);
2962 mutex_lock(&wq->mutex);
2964 for_each_pwq(pwq, wq) {
2967 spin_lock_irq(&pwq->pool->lock);
2968 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2969 spin_unlock_irq(&pwq->pool->lock);
2974 if (++flush_cnt == 10 ||
2975 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2976 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
2977 wq->name, flush_cnt);
2979 mutex_unlock(&wq->mutex);
2983 if (!--wq->nr_drainers)
2984 wq->flags &= ~__WQ_DRAINING;
2985 mutex_unlock(&wq->mutex);
2987 EXPORT_SYMBOL_GPL(drain_workqueue);
2989 static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2992 struct worker *worker = NULL;
2993 struct worker_pool *pool;
2994 struct pool_workqueue *pwq;
2999 pool = get_work_pool(work);
3005 spin_lock_irq(&pool->lock);
3006 /* see the comment in try_to_grab_pending() with the same code */
3007 pwq = get_work_pwq(work);
3009 if (unlikely(pwq->pool != pool))
3012 worker = find_worker_executing_work(pool, work);
3015 pwq = worker->current_pwq;
3018 check_flush_dependency(pwq->wq, work);
3020 insert_wq_barrier(pwq, barr, work, worker);
3021 spin_unlock_irq(&pool->lock);
3024 * Force a lock recursion deadlock when using flush_work() inside a
3025 * single-threaded or rescuer equipped workqueue.
3027 * For single threaded workqueues the deadlock happens when the work
3028 * is after the work issuing the flush_work(). For rescuer equipped
3029 * workqueues the deadlock happens when the rescuer stalls, blocking
3033 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
3034 lock_map_acquire(&pwq->wq->lockdep_map);
3035 lock_map_release(&pwq->wq->lockdep_map);
3040 spin_unlock_irq(&pool->lock);
3045 static bool __flush_work(struct work_struct *work, bool from_cancel)
3047 struct wq_barrier barr;
3049 if (WARN_ON(!wq_online))
3052 if (WARN_ON(!work->func))
3055 lock_map_acquire(&work->lockdep_map);
3056 lock_map_release(&work->lockdep_map);
3058 if (start_flush_work(work, &barr, from_cancel)) {
3059 wait_for_completion(&barr.done);
3060 destroy_work_on_stack(&barr.work);
3068 * flush_work - wait for a work to finish executing the last queueing instance
3069 * @work: the work to flush
3071 * Wait until @work has finished execution. @work is guaranteed to be idle
3072 * on return if it hasn't been requeued since flush started.
3075 * %true if flush_work() waited for the work to finish execution,
3076 * %false if it was already idle.
3078 bool flush_work(struct work_struct *work)
3080 return __flush_work(work, false);
3082 EXPORT_SYMBOL_GPL(flush_work);
3085 wait_queue_entry_t wait;
3086 struct work_struct *work;
3089 static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
3091 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3093 if (cwait->work != key)
3095 return autoremove_wake_function(wait, mode, sync, key);
3098 static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
3100 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
3101 unsigned long flags;
3105 ret = try_to_grab_pending(work, is_dwork, &flags);
3107 * If someone else is already canceling, wait for it to
3108 * finish. flush_work() doesn't work for PREEMPT_NONE
3109 * because we may get scheduled between @work's completion
3110 * and the other canceling task resuming and clearing
3111 * CANCELING - flush_work() will return false immediately
3112 * as @work is no longer busy, try_to_grab_pending() will
3113 * return -ENOENT as @work is still being canceled and the
3114 * other canceling task won't be able to clear CANCELING as
3115 * we're hogging the CPU.
3117 * Let's wait for completion using a waitqueue. As this
3118 * may lead to the thundering herd problem, use a custom
3119 * wake function which matches @work along with exclusive
3122 if (unlikely(ret == -ENOENT)) {
3123 struct cwt_wait cwait;
3125 init_wait(&cwait.wait);
3126 cwait.wait.func = cwt_wakefn;
3129 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3130 TASK_UNINTERRUPTIBLE);
3131 if (work_is_canceling(work))
3133 finish_wait(&cancel_waitq, &cwait.wait);
3135 } while (unlikely(ret < 0));
3137 /* tell other tasks trying to grab @work to back off */
3138 mark_work_canceling(work);
3139 local_irq_restore(flags);
3142 * This allows canceling during early boot. We know that @work
3146 __flush_work(work, true);
3148 clear_work_data(work);
3151 * Paired with prepare_to_wait() above so that either
3152 * waitqueue_active() is visible here or !work_is_canceling() is
3156 if (waitqueue_active(&cancel_waitq))
3157 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3163 * cancel_work_sync - cancel a work and wait for it to finish
3164 * @work: the work to cancel
3166 * Cancel @work and wait for its execution to finish. This function
3167 * can be used even if the work re-queues itself or migrates to
3168 * another workqueue. On return from this function, @work is
3169 * guaranteed to be not pending or executing on any CPU.
3171 * cancel_work_sync(&delayed_work->work) must not be used for
3172 * delayed_work's. Use cancel_delayed_work_sync() instead.
3174 * The caller must ensure that the workqueue on which @work was last
3175 * queued can't be destroyed before this function returns.
3178 * %true if @work was pending, %false otherwise.
3180 bool cancel_work_sync(struct work_struct *work)
3182 return __cancel_work_timer(work, false);
3184 EXPORT_SYMBOL_GPL(cancel_work_sync);
3187 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3188 * @dwork: the delayed work to flush
3190 * Delayed timer is cancelled and the pending work is queued for
3191 * immediate execution. Like flush_work(), this function only
3192 * considers the last queueing instance of @dwork.
3195 * %true if flush_work() waited for the work to finish execution,
3196 * %false if it was already idle.
3198 bool flush_delayed_work(struct delayed_work *dwork)
3200 local_irq_disable();
3201 if (del_timer_sync(&dwork->timer))
3202 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
3204 return flush_work(&dwork->work);
3206 EXPORT_SYMBOL(flush_delayed_work);
3209 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3210 * @rwork: the rcu work to flush
3213 * %true if flush_rcu_work() waited for the work to finish execution,
3214 * %false if it was already idle.
3216 bool flush_rcu_work(struct rcu_work *rwork)
3218 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3220 flush_work(&rwork->work);
3223 return flush_work(&rwork->work);
3226 EXPORT_SYMBOL(flush_rcu_work);
3228 static bool __cancel_work(struct work_struct *work, bool is_dwork)
3230 unsigned long flags;
3234 ret = try_to_grab_pending(work, is_dwork, &flags);
3235 } while (unlikely(ret == -EAGAIN));
3237 if (unlikely(ret < 0))
3240 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3241 local_irq_restore(flags);
3246 * cancel_delayed_work - cancel a delayed work
3247 * @dwork: delayed_work to cancel
3249 * Kill off a pending delayed_work.
3251 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3255 * The work callback function may still be running on return, unless
3256 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3257 * use cancel_delayed_work_sync() to wait on it.
3259 * This function is safe to call from any context including IRQ handler.
3261 bool cancel_delayed_work(struct delayed_work *dwork)
3263 return __cancel_work(&dwork->work, true);
3265 EXPORT_SYMBOL(cancel_delayed_work);
3268 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3269 * @dwork: the delayed work cancel
3271 * This is cancel_work_sync() for delayed works.
3274 * %true if @dwork was pending, %false otherwise.
3276 bool cancel_delayed_work_sync(struct delayed_work *dwork)
3278 return __cancel_work_timer(&dwork->work, true);
3280 EXPORT_SYMBOL(cancel_delayed_work_sync);
3283 * schedule_on_each_cpu - execute a function synchronously on each online CPU
3284 * @func: the function to call
3286 * schedule_on_each_cpu() executes @func on each online CPU using the
3287 * system workqueue and blocks until all CPUs have completed.
3288 * schedule_on_each_cpu() is very slow.
3291 * 0 on success, -errno on failure.
3293 int schedule_on_each_cpu(work_func_t func)
3296 struct work_struct __percpu *works;
3298 works = alloc_percpu(struct work_struct);
3304 for_each_online_cpu(cpu) {
3305 struct work_struct *work = per_cpu_ptr(works, cpu);
3307 INIT_WORK(work, func);
3308 schedule_work_on(cpu, work);
3311 for_each_online_cpu(cpu)
3312 flush_work(per_cpu_ptr(works, cpu));
3320 * execute_in_process_context - reliably execute the routine with user context
3321 * @fn: the function to execute
3322 * @ew: guaranteed storage for the execute work structure (must
3323 * be available when the work executes)
3325 * Executes the function immediately if process context is available,
3326 * otherwise schedules the function for delayed execution.
3328 * Return: 0 - function was executed
3329 * 1 - function was scheduled for execution
3331 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
3333 if (!in_interrupt()) {
3338 INIT_WORK(&ew->work, fn);
3339 schedule_work(&ew->work);
3343 EXPORT_SYMBOL_GPL(execute_in_process_context);
3346 * free_workqueue_attrs - free a workqueue_attrs
3347 * @attrs: workqueue_attrs to free
3349 * Undo alloc_workqueue_attrs().
3351 void free_workqueue_attrs(struct workqueue_attrs *attrs)
3354 free_cpumask_var(attrs->cpumask);
3360 * alloc_workqueue_attrs - allocate a workqueue_attrs
3362 * Allocate a new workqueue_attrs, initialize with default settings and
3365 * Return: The allocated new workqueue_attr on success. %NULL on failure.
3367 struct workqueue_attrs *alloc_workqueue_attrs(void)
3369 struct workqueue_attrs *attrs;
3371 attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
3374 if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
3377 cpumask_copy(attrs->cpumask, cpu_possible_mask);
3380 free_workqueue_attrs(attrs);
3384 static void copy_workqueue_attrs(struct workqueue_attrs *to,
3385 const struct workqueue_attrs *from)
3387 to->nice = from->nice;
3388 cpumask_copy(to->cpumask, from->cpumask);
3390 * Unlike hash and equality test, this function doesn't ignore
3391 * ->no_numa as it is used for both pool and wq attrs. Instead,
3392 * get_unbound_pool() explicitly clears ->no_numa after copying.
3394 to->no_numa = from->no_numa;
3397 /* hash value of the content of @attr */
3398 static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3402 hash = jhash_1word(attrs->nice, hash);
3403 hash = jhash(cpumask_bits(attrs->cpumask),
3404 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
3408 /* content equality test */
3409 static bool wqattrs_equal(const struct workqueue_attrs *a,
3410 const struct workqueue_attrs *b)
3412 if (a->nice != b->nice)
3414 if (!cpumask_equal(a->cpumask, b->cpumask))
3420 * init_worker_pool - initialize a newly zalloc'd worker_pool
3421 * @pool: worker_pool to initialize
3423 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
3425 * Return: 0 on success, -errno on failure. Even on failure, all fields
3426 * inside @pool proper are initialized and put_unbound_pool() can be called
3427 * on @pool safely to release it.
3429 static int init_worker_pool(struct worker_pool *pool)
3431 spin_lock_init(&pool->lock);
3434 pool->node = NUMA_NO_NODE;
3435 pool->flags |= POOL_DISASSOCIATED;
3436 pool->watchdog_ts = jiffies;
3437 INIT_LIST_HEAD(&pool->worklist);
3438 INIT_LIST_HEAD(&pool->idle_list);
3439 hash_init(pool->busy_hash);
3441 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
3443 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
3445 INIT_LIST_HEAD(&pool->workers);
3447 ida_init(&pool->worker_ida);
3448 INIT_HLIST_NODE(&pool->hash_node);
3451 /* shouldn't fail above this point */
3452 pool->attrs = alloc_workqueue_attrs();
3458 #ifdef CONFIG_LOCKDEP
3459 static void wq_init_lockdep(struct workqueue_struct *wq)
3463 lockdep_register_key(&wq->key);
3464 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3466 lock_name = wq->name;
3468 wq->lock_name = lock_name;
3469 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3472 static void wq_unregister_lockdep(struct workqueue_struct *wq)
3474 lockdep_unregister_key(&wq->key);
3477 static void wq_free_lockdep(struct workqueue_struct *wq)
3479 if (wq->lock_name != wq->name)
3480 kfree(wq->lock_name);
3483 static void wq_init_lockdep(struct workqueue_struct *wq)
3487 static void wq_unregister_lockdep(struct workqueue_struct *wq)
3491 static void wq_free_lockdep(struct workqueue_struct *wq)
3496 static void rcu_free_wq(struct rcu_head *rcu)
3498 struct workqueue_struct *wq =
3499 container_of(rcu, struct workqueue_struct, rcu);
3501 wq_free_lockdep(wq);
3503 if (!(wq->flags & WQ_UNBOUND))
3504 free_percpu(wq->cpu_pwqs);
3506 free_workqueue_attrs(wq->unbound_attrs);
3512 static void rcu_free_pool(struct rcu_head *rcu)
3514 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3516 ida_destroy(&pool->worker_ida);
3517 free_workqueue_attrs(pool->attrs);
3522 * put_unbound_pool - put a worker_pool
3523 * @pool: worker_pool to put
3525 * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU
3526 * safe manner. get_unbound_pool() calls this function on its failure path
3527 * and this function should be able to release pools which went through,
3528 * successfully or not, init_worker_pool().
3530 * Should be called with wq_pool_mutex held.
3532 static void put_unbound_pool(struct worker_pool *pool)
3534 DECLARE_COMPLETION_ONSTACK(detach_completion);
3535 struct worker *worker;
3537 lockdep_assert_held(&wq_pool_mutex);
3543 if (WARN_ON(!(pool->cpu < 0)) ||
3544 WARN_ON(!list_empty(&pool->worklist)))
3547 /* release id and unhash */
3549 idr_remove(&worker_pool_idr, pool->id);
3550 hash_del(&pool->hash_node);
3553 * Become the manager and destroy all workers. This prevents
3554 * @pool's workers from blocking on attach_mutex. We're the last
3555 * manager and @pool gets freed with the flag set.
3557 spin_lock_irq(&pool->lock);
3558 wait_event_lock_irq(wq_manager_wait,
3559 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3560 pool->flags |= POOL_MANAGER_ACTIVE;
3562 while ((worker = first_idle_worker(pool)))
3563 destroy_worker(worker);
3564 WARN_ON(pool->nr_workers || pool->nr_idle);
3565 spin_unlock_irq(&pool->lock);
3567 mutex_lock(&wq_pool_attach_mutex);
3568 if (!list_empty(&pool->workers))
3569 pool->detach_completion = &detach_completion;
3570 mutex_unlock(&wq_pool_attach_mutex);
3572 if (pool->detach_completion)
3573 wait_for_completion(pool->detach_completion);
3575 /* shut down the timers */
3576 del_timer_sync(&pool->idle_timer);
3577 del_timer_sync(&pool->mayday_timer);
3579 /* RCU protected to allow dereferences from get_work_pool() */
3580 call_rcu(&pool->rcu, rcu_free_pool);
3584 * get_unbound_pool - get a worker_pool with the specified attributes
3585 * @attrs: the attributes of the worker_pool to get
3587 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3588 * reference count and return it. If there already is a matching
3589 * worker_pool, it will be used; otherwise, this function attempts to
3592 * Should be called with wq_pool_mutex held.
3594 * Return: On success, a worker_pool with the same attributes as @attrs.
3595 * On failure, %NULL.
3597 static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3599 u32 hash = wqattrs_hash(attrs);
3600 struct worker_pool *pool;
3602 int target_node = NUMA_NO_NODE;
3604 lockdep_assert_held(&wq_pool_mutex);
3606 /* do we already have a matching pool? */
3607 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3608 if (wqattrs_equal(pool->attrs, attrs)) {
3614 /* if cpumask is contained inside a NUMA node, we belong to that node */
3615 if (wq_numa_enabled) {
3616 for_each_node(node) {
3617 if (cpumask_subset(attrs->cpumask,
3618 wq_numa_possible_cpumask[node])) {
3625 /* nope, create a new one */
3626 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
3627 if (!pool || init_worker_pool(pool) < 0)
3630 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
3631 copy_workqueue_attrs(pool->attrs, attrs);
3632 pool->node = target_node;
3635 * no_numa isn't a worker_pool attribute, always clear it. See
3636 * 'struct workqueue_attrs' comments for detail.
3638 pool->attrs->no_numa = false;
3640 if (worker_pool_assign_id(pool) < 0)
3643 /* create and start the initial worker */
3644 if (wq_online && !create_worker(pool))
3648 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3653 put_unbound_pool(pool);
3657 static void rcu_free_pwq(struct rcu_head *rcu)
3659 kmem_cache_free(pwq_cache,
3660 container_of(rcu, struct pool_workqueue, rcu));
3664 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3665 * and needs to be destroyed.
3667 static void pwq_unbound_release_workfn(struct work_struct *work)
3669 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3670 unbound_release_work);
3671 struct workqueue_struct *wq = pwq->wq;
3672 struct worker_pool *pool = pwq->pool;
3673 bool is_last = false;
3676 * when @pwq is not linked, it doesn't hold any reference to the
3677 * @wq, and @wq is invalid to access.
3679 if (!list_empty(&pwq->pwqs_node)) {
3680 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3683 mutex_lock(&wq->mutex);
3684 list_del_rcu(&pwq->pwqs_node);
3685 is_last = list_empty(&wq->pwqs);
3686 mutex_unlock(&wq->mutex);
3689 mutex_lock(&wq_pool_mutex);
3690 put_unbound_pool(pool);
3691 mutex_unlock(&wq_pool_mutex);
3693 call_rcu(&pwq->rcu, rcu_free_pwq);
3696 * If we're the last pwq going away, @wq is already dead and no one
3697 * is gonna access it anymore. Schedule RCU free.
3700 wq_unregister_lockdep(wq);
3701 call_rcu(&wq->rcu, rcu_free_wq);
3706 * pwq_adjust_max_active - update a pwq's max_active to the current setting
3707 * @pwq: target pool_workqueue
3709 * If @pwq isn't freezing, set @pwq->max_active to the associated
3710 * workqueue's saved_max_active and activate delayed work items
3711 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
3713 static void pwq_adjust_max_active(struct pool_workqueue *pwq)
3715 struct workqueue_struct *wq = pwq->wq;
3716 bool freezable = wq->flags & WQ_FREEZABLE;
3717 unsigned long flags;
3719 /* for @wq->saved_max_active */
3720 lockdep_assert_held(&wq->mutex);
3722 /* fast exit for non-freezable wqs */
3723 if (!freezable && pwq->max_active == wq->saved_max_active)
3726 /* this function can be called during early boot w/ irq disabled */
3727 spin_lock_irqsave(&pwq->pool->lock, flags);
3730 * During [un]freezing, the caller is responsible for ensuring that
3731 * this function is called at least once after @workqueue_freezing
3732 * is updated and visible.
3734 if (!freezable || !workqueue_freezing) {
3737 pwq->max_active = wq->saved_max_active;
3739 while (!list_empty(&pwq->delayed_works) &&
3740 pwq->nr_active < pwq->max_active) {
3741 pwq_activate_first_delayed(pwq);
3746 * Need to kick a worker after thawed or an unbound wq's
3747 * max_active is bumped. In realtime scenarios, always kicking a
3748 * worker will cause interference on the isolated cpu cores, so
3749 * let's kick iff work items were activated.
3752 wake_up_worker(pwq->pool);
3754 pwq->max_active = 0;
3757 spin_unlock_irqrestore(&pwq->pool->lock, flags);
3760 /* initialize newly alloced @pwq which is associated with @wq and @pool */
3761 static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3762 struct worker_pool *pool)
3764 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3766 memset(pwq, 0, sizeof(*pwq));
3770 pwq->flush_color = -1;
3772 INIT_LIST_HEAD(&pwq->delayed_works);
3773 INIT_LIST_HEAD(&pwq->pwqs_node);
3774 INIT_LIST_HEAD(&pwq->mayday_node);
3775 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3778 /* sync @pwq with the current state of its associated wq and link it */
3779 static void link_pwq(struct pool_workqueue *pwq)
3781 struct workqueue_struct *wq = pwq->wq;
3783 lockdep_assert_held(&wq->mutex);
3785 /* may be called multiple times, ignore if already linked */
3786 if (!list_empty(&pwq->pwqs_node))
3789 /* set the matching work_color */
3790 pwq->work_color = wq->work_color;
3792 /* sync max_active to the current setting */
3793 pwq_adjust_max_active(pwq);
3796 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3799 /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3800 static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3801 const struct workqueue_attrs *attrs)
3803 struct worker_pool *pool;
3804 struct pool_workqueue *pwq;
3806 lockdep_assert_held(&wq_pool_mutex);
3808 pool = get_unbound_pool(attrs);
3812 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3814 put_unbound_pool(pool);
3818 init_pwq(pwq, wq, pool);
3823 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
3824 * @attrs: the wq_attrs of the default pwq of the target workqueue
3825 * @node: the target NUMA node
3826 * @cpu_going_down: if >= 0, the CPU to consider as offline
3827 * @cpumask: outarg, the resulting cpumask
3829 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3830 * @cpu_going_down is >= 0, that cpu is considered offline during
3831 * calculation. The result is stored in @cpumask.
3833 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3834 * enabled and @node has online CPUs requested by @attrs, the returned
3835 * cpumask is the intersection of the possible CPUs of @node and
3838 * The caller is responsible for ensuring that the cpumask of @node stays
3841 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3844 static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3845 int cpu_going_down, cpumask_t *cpumask)
3847 if (!wq_numa_enabled || attrs->no_numa)
3850 /* does @node have any online CPUs @attrs wants? */
3851 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3852 if (cpu_going_down >= 0)
3853 cpumask_clear_cpu(cpu_going_down, cpumask);
3855 if (cpumask_empty(cpumask))
3858 /* yeap, return possible CPUs in @node that @attrs wants */
3859 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3861 if (cpumask_empty(cpumask)) {
3862 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3863 "possible intersect\n");
3867 return !cpumask_equal(cpumask, attrs->cpumask);
3870 cpumask_copy(cpumask, attrs->cpumask);
3874 /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3875 static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3877 struct pool_workqueue *pwq)
3879 struct pool_workqueue *old_pwq;
3881 lockdep_assert_held(&wq_pool_mutex);
3882 lockdep_assert_held(&wq->mutex);
3884 /* link_pwq() can handle duplicate calls */
3887 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3888 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3892 /* context to store the prepared attrs & pwqs before applying */
3893 struct apply_wqattrs_ctx {
3894 struct workqueue_struct *wq; /* target workqueue */
3895 struct workqueue_attrs *attrs; /* attrs to apply */
3896 struct list_head list; /* queued for batching commit */
3897 struct pool_workqueue *dfl_pwq;
3898 struct pool_workqueue *pwq_tbl[];
3901 /* free the resources after success or abort */
3902 static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3908 put_pwq_unlocked(ctx->pwq_tbl[node]);
3909 put_pwq_unlocked(ctx->dfl_pwq);
3911 free_workqueue_attrs(ctx->attrs);
3917 /* allocate the attrs and pwqs for later installation */
3918 static struct apply_wqattrs_ctx *
3919 apply_wqattrs_prepare(struct workqueue_struct *wq,
3920 const struct workqueue_attrs *attrs)
3922 struct apply_wqattrs_ctx *ctx;
3923 struct workqueue_attrs *new_attrs, *tmp_attrs;
3926 lockdep_assert_held(&wq_pool_mutex);
3928 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
3930 new_attrs = alloc_workqueue_attrs();
3931 tmp_attrs = alloc_workqueue_attrs();
3932 if (!ctx || !new_attrs || !tmp_attrs)
3936 * Calculate the attrs of the default pwq.
3937 * If the user configured cpumask doesn't overlap with the
3938 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3940 copy_workqueue_attrs(new_attrs, attrs);
3941 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
3942 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3943 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
3946 * We may create multiple pwqs with differing cpumasks. Make a
3947 * copy of @new_attrs which will be modified and used to obtain
3950 copy_workqueue_attrs(tmp_attrs, new_attrs);
3953 * If something goes wrong during CPU up/down, we'll fall back to
3954 * the default pwq covering whole @attrs->cpumask. Always create
3955 * it even if we don't use it immediately.
3957 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3961 for_each_node(node) {
3962 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
3963 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3964 if (!ctx->pwq_tbl[node])
3967 ctx->dfl_pwq->refcnt++;
3968 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3972 /* save the user configured attrs and sanitize it. */
3973 copy_workqueue_attrs(new_attrs, attrs);
3974 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3975 ctx->attrs = new_attrs;
3978 free_workqueue_attrs(tmp_attrs);
3982 free_workqueue_attrs(tmp_attrs);
3983 free_workqueue_attrs(new_attrs);
3984 apply_wqattrs_cleanup(ctx);
3988 /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3989 static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3993 /* all pwqs have been created successfully, let's install'em */
3994 mutex_lock(&ctx->wq->mutex);
3996 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3998 /* save the previous pwq and install the new one */
4000 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
4001 ctx->pwq_tbl[node]);
4003 /* @dfl_pwq might not have been used, ensure it's linked */
4004 link_pwq(ctx->dfl_pwq);
4005 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
4007 mutex_unlock(&ctx->wq->mutex);
4010 static void apply_wqattrs_lock(void)
4012 /* CPUs should stay stable across pwq creations and installations */
4014 mutex_lock(&wq_pool_mutex);
4017 static void apply_wqattrs_unlock(void)
4019 mutex_unlock(&wq_pool_mutex);
4023 static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4024 const struct workqueue_attrs *attrs)
4026 struct apply_wqattrs_ctx *ctx;
4028 /* only unbound workqueues can change attributes */
4029 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4032 /* creating multiple pwqs breaks ordering guarantee */
4033 if (!list_empty(&wq->pwqs)) {
4034 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4037 wq->flags &= ~__WQ_ORDERED;
4040 ctx = apply_wqattrs_prepare(wq, attrs);
4044 /* the ctx has been prepared successfully, let's commit it */
4045 apply_wqattrs_commit(ctx);
4046 apply_wqattrs_cleanup(ctx);
4052 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4053 * @wq: the target workqueue
4054 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4056 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4057 * machines, this function maps a separate pwq to each NUMA node with
4058 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4059 * NUMA node it was issued on. Older pwqs are released as in-flight work
4060 * items finish. Note that a work item which repeatedly requeues itself
4061 * back-to-back will stay on its current pwq.
4063 * Performs GFP_KERNEL allocations.
4065 * Assumes caller has CPU hotplug read exclusion, i.e. get_online_cpus().
4067 * Return: 0 on success and -errno on failure.
4069 int apply_workqueue_attrs(struct workqueue_struct *wq,
4070 const struct workqueue_attrs *attrs)
4074 lockdep_assert_cpus_held();
4076 mutex_lock(&wq_pool_mutex);
4077 ret = apply_workqueue_attrs_locked(wq, attrs);
4078 mutex_unlock(&wq_pool_mutex);
4084 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4085 * @wq: the target workqueue
4086 * @cpu: the CPU coming up or going down
4087 * @online: whether @cpu is coming up or going down
4089 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4090 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4093 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4094 * falls back to @wq->dfl_pwq which may not be optimal but is always
4097 * Note that when the last allowed CPU of a NUMA node goes offline for a
4098 * workqueue with a cpumask spanning multiple nodes, the workers which were
4099 * already executing the work items for the workqueue will lose their CPU
4100 * affinity and may execute on any CPU. This is similar to how per-cpu
4101 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4102 * affinity, it's the user's responsibility to flush the work item from
4105 static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4108 int node = cpu_to_node(cpu);
4109 int cpu_off = online ? -1 : cpu;
4110 struct pool_workqueue *old_pwq = NULL, *pwq;
4111 struct workqueue_attrs *target_attrs;
4114 lockdep_assert_held(&wq_pool_mutex);
4116 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4117 wq->unbound_attrs->no_numa)
4121 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4122 * Let's use a preallocated one. The following buf is protected by
4123 * CPU hotplug exclusion.
4125 target_attrs = wq_update_unbound_numa_attrs_buf;
4126 cpumask = target_attrs->cpumask;
4128 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4129 pwq = unbound_pwq_by_node(wq, node);
4132 * Let's determine what needs to be done. If the target cpumask is
4133 * different from the default pwq's, we need to compare it to @pwq's
4134 * and create a new one if they don't match. If the target cpumask
4135 * equals the default pwq's, the default pwq should be used.
4137 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
4138 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
4144 /* create a new pwq */
4145 pwq = alloc_unbound_pwq(wq, target_attrs);
4147 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4152 /* Install the new pwq. */
4153 mutex_lock(&wq->mutex);
4154 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4158 mutex_lock(&wq->mutex);
4159 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4160 get_pwq(wq->dfl_pwq);
4161 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4162 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4164 mutex_unlock(&wq->mutex);
4165 put_pwq_unlocked(old_pwq);
4168 static int alloc_and_link_pwqs(struct workqueue_struct *wq)
4170 bool highpri = wq->flags & WQ_HIGHPRI;
4173 if (!(wq->flags & WQ_UNBOUND)) {
4174 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4178 for_each_possible_cpu(cpu) {
4179 struct pool_workqueue *pwq =
4180 per_cpu_ptr(wq->cpu_pwqs, cpu);
4181 struct worker_pool *cpu_pools =
4182 per_cpu(cpu_worker_pools, cpu);
4184 init_pwq(pwq, wq, &cpu_pools[highpri]);
4186 mutex_lock(&wq->mutex);
4188 mutex_unlock(&wq->mutex);
4194 if (wq->flags & __WQ_ORDERED) {
4195 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4196 /* there should only be single pwq for ordering guarantee */
4197 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4198 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4199 "ordering guarantee broken for workqueue %s\n", wq->name);
4201 ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
4208 static int wq_clamp_max_active(int max_active, unsigned int flags,
4211 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4213 if (max_active < 1 || max_active > lim)
4214 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4215 max_active, name, 1, lim);
4217 return clamp_val(max_active, 1, lim);
4221 * Workqueues which may be used during memory reclaim should have a rescuer
4222 * to guarantee forward progress.
4224 static int init_rescuer(struct workqueue_struct *wq)
4226 struct worker *rescuer;
4229 if (!(wq->flags & WQ_MEM_RECLAIM))
4232 rescuer = alloc_worker(NUMA_NO_NODE);
4236 rescuer->rescue_wq = wq;
4237 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4238 ret = PTR_ERR_OR_ZERO(rescuer->task);
4244 wq->rescuer = rescuer;
4245 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4246 wake_up_process(rescuer->task);
4252 struct workqueue_struct *alloc_workqueue(const char *fmt,
4254 int max_active, ...)
4256 size_t tbl_size = 0;
4258 struct workqueue_struct *wq;
4259 struct pool_workqueue *pwq;
4262 * Unbound && max_active == 1 used to imply ordered, which is no
4263 * longer the case on NUMA machines due to per-node pools. While
4264 * alloc_ordered_workqueue() is the right way to create an ordered
4265 * workqueue, keep the previous behavior to avoid subtle breakages
4268 if ((flags & WQ_UNBOUND) && max_active == 1)
4269 flags |= __WQ_ORDERED;
4271 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4272 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4273 flags |= WQ_UNBOUND;
4275 /* allocate wq and format name */
4276 if (flags & WQ_UNBOUND)
4277 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
4279 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
4283 if (flags & WQ_UNBOUND) {
4284 wq->unbound_attrs = alloc_workqueue_attrs();
4285 if (!wq->unbound_attrs)
4289 va_start(args, max_active);
4290 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4293 max_active = max_active ?: WQ_DFL_ACTIVE;
4294 max_active = wq_clamp_max_active(max_active, flags, wq->name);
4298 wq->saved_max_active = max_active;
4299 mutex_init(&wq->mutex);
4300 atomic_set(&wq->nr_pwqs_to_flush, 0);
4301 INIT_LIST_HEAD(&wq->pwqs);
4302 INIT_LIST_HEAD(&wq->flusher_queue);
4303 INIT_LIST_HEAD(&wq->flusher_overflow);
4304 INIT_LIST_HEAD(&wq->maydays);
4306 wq_init_lockdep(wq);
4307 INIT_LIST_HEAD(&wq->list);
4309 if (alloc_and_link_pwqs(wq) < 0)
4310 goto err_unreg_lockdep;
4312 if (wq_online && init_rescuer(wq) < 0)
4315 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4319 * wq_pool_mutex protects global freeze state and workqueues list.
4320 * Grab it, adjust max_active and add the new @wq to workqueues
4323 mutex_lock(&wq_pool_mutex);
4325 mutex_lock(&wq->mutex);
4326 for_each_pwq(pwq, wq)
4327 pwq_adjust_max_active(pwq);
4328 mutex_unlock(&wq->mutex);
4330 list_add_tail_rcu(&wq->list, &workqueues);
4332 mutex_unlock(&wq_pool_mutex);
4337 wq_unregister_lockdep(wq);
4338 wq_free_lockdep(wq);
4340 free_workqueue_attrs(wq->unbound_attrs);
4344 destroy_workqueue(wq);
4347 EXPORT_SYMBOL_GPL(alloc_workqueue);
4350 * destroy_workqueue - safely terminate a workqueue
4351 * @wq: target workqueue
4353 * Safely destroy a workqueue. All work currently pending will be done first.
4355 void destroy_workqueue(struct workqueue_struct *wq)
4357 struct pool_workqueue *pwq;
4361 * Remove it from sysfs first so that sanity check failure doesn't
4362 * lead to sysfs name conflicts.
4364 workqueue_sysfs_unregister(wq);
4366 /* drain it before proceeding with destruction */
4367 drain_workqueue(wq);
4369 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4371 struct worker *rescuer = wq->rescuer;
4373 /* this prevents new queueing */
4374 spin_lock_irq(&wq_mayday_lock);
4376 spin_unlock_irq(&wq_mayday_lock);
4378 /* rescuer will empty maydays list before exiting */
4379 kthread_stop(rescuer->task);
4384 mutex_lock(&wq->mutex);
4385 for_each_pwq(pwq, wq) {
4388 for (i = 0; i < WORK_NR_COLORS; i++) {
4389 if (WARN_ON(pwq->nr_in_flight[i])) {
4390 mutex_unlock(&wq->mutex);
4391 show_workqueue_state();
4396 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
4397 WARN_ON(pwq->nr_active) ||
4398 WARN_ON(!list_empty(&pwq->delayed_works))) {
4399 mutex_unlock(&wq->mutex);
4400 show_workqueue_state();
4404 mutex_unlock(&wq->mutex);
4407 * wq list is used to freeze wq, remove from list after
4408 * flushing is complete in case freeze races us.
4410 mutex_lock(&wq_pool_mutex);
4411 list_del_rcu(&wq->list);
4412 mutex_unlock(&wq_pool_mutex);
4414 if (!(wq->flags & WQ_UNBOUND)) {
4415 wq_unregister_lockdep(wq);
4417 * The base ref is never dropped on per-cpu pwqs. Directly
4418 * schedule RCU free.
4420 call_rcu(&wq->rcu, rcu_free_wq);
4423 * We're the sole accessor of @wq at this point. Directly
4424 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4425 * @wq will be freed when the last pwq is released.
4427 for_each_node(node) {
4428 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4429 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4430 put_pwq_unlocked(pwq);
4434 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4435 * put. Don't access it afterwards.
4439 put_pwq_unlocked(pwq);
4442 EXPORT_SYMBOL_GPL(destroy_workqueue);
4445 * workqueue_set_max_active - adjust max_active of a workqueue
4446 * @wq: target workqueue
4447 * @max_active: new max_active value.
4449 * Set max_active of @wq to @max_active.
4452 * Don't call from IRQ context.
4454 void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4456 struct pool_workqueue *pwq;
4458 /* disallow meddling with max_active for ordered workqueues */
4459 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4462 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4464 mutex_lock(&wq->mutex);
4466 wq->flags &= ~__WQ_ORDERED;
4467 wq->saved_max_active = max_active;
4469 for_each_pwq(pwq, wq)
4470 pwq_adjust_max_active(pwq);
4472 mutex_unlock(&wq->mutex);
4474 EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4477 * current_work - retrieve %current task's work struct
4479 * Determine if %current task is a workqueue worker and what it's working on.
4480 * Useful to find out the context that the %current task is running in.
4482 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4484 struct work_struct *current_work(void)
4486 struct worker *worker = current_wq_worker();
4488 return worker ? worker->current_work : NULL;
4490 EXPORT_SYMBOL(current_work);
4493 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4495 * Determine whether %current is a workqueue rescuer. Can be used from
4496 * work functions to determine whether it's being run off the rescuer task.
4498 * Return: %true if %current is a workqueue rescuer. %false otherwise.
4500 bool current_is_workqueue_rescuer(void)
4502 struct worker *worker = current_wq_worker();
4504 return worker && worker->rescue_wq;
4508 * workqueue_congested - test whether a workqueue is congested
4509 * @cpu: CPU in question
4510 * @wq: target workqueue
4512 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4513 * no synchronization around this function and the test result is
4514 * unreliable and only useful as advisory hints or for debugging.
4516 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4517 * Note that both per-cpu and unbound workqueues may be associated with
4518 * multiple pool_workqueues which have separate congested states. A
4519 * workqueue being congested on one CPU doesn't mean the workqueue is also
4520 * contested on other CPUs / NUMA nodes.
4523 * %true if congested, %false otherwise.
4525 bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4527 struct pool_workqueue *pwq;
4533 if (cpu == WORK_CPU_UNBOUND)
4534 cpu = smp_processor_id();
4536 if (!(wq->flags & WQ_UNBOUND))
4537 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4539 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4541 ret = !list_empty(&pwq->delayed_works);
4547 EXPORT_SYMBOL_GPL(workqueue_congested);
4550 * work_busy - test whether a work is currently pending or running
4551 * @work: the work to be tested
4553 * Test whether @work is currently pending or running. There is no
4554 * synchronization around this function and the test result is
4555 * unreliable and only useful as advisory hints or for debugging.
4558 * OR'd bitmask of WORK_BUSY_* bits.
4560 unsigned int work_busy(struct work_struct *work)
4562 struct worker_pool *pool;
4563 unsigned long flags;
4564 unsigned int ret = 0;
4566 if (work_pending(work))
4567 ret |= WORK_BUSY_PENDING;
4570 pool = get_work_pool(work);
4572 spin_lock_irqsave(&pool->lock, flags);
4573 if (find_worker_executing_work(pool, work))
4574 ret |= WORK_BUSY_RUNNING;
4575 spin_unlock_irqrestore(&pool->lock, flags);
4581 EXPORT_SYMBOL_GPL(work_busy);
4584 * set_worker_desc - set description for the current work item
4585 * @fmt: printf-style format string
4586 * @...: arguments for the format string
4588 * This function can be called by a running work function to describe what
4589 * the work item is about. If the worker task gets dumped, this
4590 * information will be printed out together to help debugging. The
4591 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4593 void set_worker_desc(const char *fmt, ...)
4595 struct worker *worker = current_wq_worker();
4599 va_start(args, fmt);
4600 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4604 EXPORT_SYMBOL_GPL(set_worker_desc);
4607 * print_worker_info - print out worker information and description
4608 * @log_lvl: the log level to use when printing
4609 * @task: target task
4611 * If @task is a worker and currently executing a work item, print out the
4612 * name of the workqueue being serviced and worker description set with
4613 * set_worker_desc() by the currently executing work item.
4615 * This function can be safely called on any task as long as the
4616 * task_struct itself is accessible. While safe, this function isn't
4617 * synchronized and may print out mixups or garbages of limited length.
4619 void print_worker_info(const char *log_lvl, struct task_struct *task)
4621 work_func_t *fn = NULL;
4622 char name[WQ_NAME_LEN] = { };
4623 char desc[WORKER_DESC_LEN] = { };
4624 struct pool_workqueue *pwq = NULL;
4625 struct workqueue_struct *wq = NULL;
4626 struct worker *worker;
4628 if (!(task->flags & PF_WQ_WORKER))
4632 * This function is called without any synchronization and @task
4633 * could be in any state. Be careful with dereferences.
4635 worker = kthread_probe_data(task);
4638 * Carefully copy the associated workqueue's workfn, name and desc.
4639 * Keep the original last '\0' in case the original is garbage.
4641 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4642 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4643 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4644 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4645 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4647 if (fn || name[0] || desc[0]) {
4648 printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
4649 if (strcmp(name, desc))
4650 pr_cont(" (%s)", desc);
4655 static void pr_cont_pool_info(struct worker_pool *pool)
4657 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4658 if (pool->node != NUMA_NO_NODE)
4659 pr_cont(" node=%d", pool->node);
4660 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4663 static void pr_cont_work(bool comma, struct work_struct *work)
4665 if (work->func == wq_barrier_func) {
4666 struct wq_barrier *barr;
4668 barr = container_of(work, struct wq_barrier, work);
4670 pr_cont("%s BAR(%d)", comma ? "," : "",
4671 task_pid_nr(barr->task));
4673 pr_cont("%s %ps", comma ? "," : "", work->func);
4677 static void show_pwq(struct pool_workqueue *pwq)
4679 struct worker_pool *pool = pwq->pool;
4680 struct work_struct *work;
4681 struct worker *worker;
4682 bool has_in_flight = false, has_pending = false;
4685 pr_info(" pwq %d:", pool->id);
4686 pr_cont_pool_info(pool);
4688 pr_cont(" active=%d/%d refcnt=%d%s\n",
4689 pwq->nr_active, pwq->max_active, pwq->refcnt,
4690 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4692 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4693 if (worker->current_pwq == pwq) {
4694 has_in_flight = true;
4698 if (has_in_flight) {
4701 pr_info(" in-flight:");
4702 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4703 if (worker->current_pwq != pwq)
4706 pr_cont("%s %d%s:%ps", comma ? "," : "",
4707 task_pid_nr(worker->task),
4708 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4709 worker->current_func);
4710 list_for_each_entry(work, &worker->scheduled, entry)
4711 pr_cont_work(false, work);
4717 list_for_each_entry(work, &pool->worklist, entry) {
4718 if (get_work_pwq(work) == pwq) {
4726 pr_info(" pending:");
4727 list_for_each_entry(work, &pool->worklist, entry) {
4728 if (get_work_pwq(work) != pwq)
4731 pr_cont_work(comma, work);
4732 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4737 if (!list_empty(&pwq->delayed_works)) {
4740 pr_info(" delayed:");
4741 list_for_each_entry(work, &pwq->delayed_works, entry) {
4742 pr_cont_work(comma, work);
4743 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4750 * show_workqueue_state - dump workqueue state
4752 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4753 * all busy workqueues and pools.
4755 void show_workqueue_state(void)
4757 struct workqueue_struct *wq;
4758 struct worker_pool *pool;
4759 unsigned long flags;
4764 pr_info("Showing busy workqueues and worker pools:\n");
4766 list_for_each_entry_rcu(wq, &workqueues, list) {
4767 struct pool_workqueue *pwq;
4770 for_each_pwq(pwq, wq) {
4771 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4779 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4781 for_each_pwq(pwq, wq) {
4782 spin_lock_irqsave(&pwq->pool->lock, flags);
4783 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4785 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4787 * We could be printing a lot from atomic context, e.g.
4788 * sysrq-t -> show_workqueue_state(). Avoid triggering
4791 touch_nmi_watchdog();
4795 for_each_pool(pool, pi) {
4796 struct worker *worker;
4799 spin_lock_irqsave(&pool->lock, flags);
4800 if (pool->nr_workers == pool->nr_idle)
4803 pr_info("pool %d:", pool->id);
4804 pr_cont_pool_info(pool);
4805 pr_cont(" hung=%us workers=%d",
4806 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4809 pr_cont(" manager: %d",
4810 task_pid_nr(pool->manager->task));
4811 list_for_each_entry(worker, &pool->idle_list, entry) {
4812 pr_cont(" %s%d", first ? "idle: " : "",
4813 task_pid_nr(worker->task));
4818 spin_unlock_irqrestore(&pool->lock, flags);
4820 * We could be printing a lot from atomic context, e.g.
4821 * sysrq-t -> show_workqueue_state(). Avoid triggering
4824 touch_nmi_watchdog();
4830 /* used to show worker information through /proc/PID/{comm,stat,status} */
4831 void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4835 /* always show the actual comm */
4836 off = strscpy(buf, task->comm, size);
4840 /* stabilize PF_WQ_WORKER and worker pool association */
4841 mutex_lock(&wq_pool_attach_mutex);
4843 if (task->flags & PF_WQ_WORKER) {
4844 struct worker *worker = kthread_data(task);
4845 struct worker_pool *pool = worker->pool;
4848 spin_lock_irq(&pool->lock);
4850 * ->desc tracks information (wq name or
4851 * set_worker_desc()) for the latest execution. If
4852 * current, prepend '+', otherwise '-'.
4854 if (worker->desc[0] != '\0') {
4855 if (worker->current_work)
4856 scnprintf(buf + off, size - off, "+%s",
4859 scnprintf(buf + off, size - off, "-%s",
4862 spin_unlock_irq(&pool->lock);
4866 mutex_unlock(&wq_pool_attach_mutex);
4874 * There are two challenges in supporting CPU hotplug. Firstly, there
4875 * are a lot of assumptions on strong associations among work, pwq and
4876 * pool which make migrating pending and scheduled works very
4877 * difficult to implement without impacting hot paths. Secondly,
4878 * worker pools serve mix of short, long and very long running works making
4879 * blocked draining impractical.
4881 * This is solved by allowing the pools to be disassociated from the CPU
4882 * running as an unbound one and allowing it to be reattached later if the
4883 * cpu comes back online.
4886 static void unbind_workers(int cpu)
4888 struct worker_pool *pool;
4889 struct worker *worker;
4891 for_each_cpu_worker_pool(pool, cpu) {
4892 mutex_lock(&wq_pool_attach_mutex);
4893 spin_lock_irq(&pool->lock);
4896 * We've blocked all attach/detach operations. Make all workers
4897 * unbound and set DISASSOCIATED. Before this, all workers
4898 * except for the ones which are still executing works from
4899 * before the last CPU down must be on the cpu. After
4900 * this, they may become diasporas.
4902 for_each_pool_worker(worker, pool)
4903 worker->flags |= WORKER_UNBOUND;
4905 pool->flags |= POOL_DISASSOCIATED;
4907 spin_unlock_irq(&pool->lock);
4908 mutex_unlock(&wq_pool_attach_mutex);
4911 * Call schedule() so that we cross rq->lock and thus can
4912 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4913 * This is necessary as scheduler callbacks may be invoked
4919 * Sched callbacks are disabled now. Zap nr_running.
4920 * After this, nr_running stays zero and need_more_worker()
4921 * and keep_working() are always true as long as the
4922 * worklist is not empty. This pool now behaves as an
4923 * unbound (in terms of concurrency management) pool which
4924 * are served by workers tied to the pool.
4926 atomic_set(&pool->nr_running, 0);
4929 * With concurrency management just turned off, a busy
4930 * worker blocking could lead to lengthy stalls. Kick off
4931 * unbound chain execution of currently pending work items.
4933 spin_lock_irq(&pool->lock);
4934 wake_up_worker(pool);
4935 spin_unlock_irq(&pool->lock);
4940 * rebind_workers - rebind all workers of a pool to the associated CPU
4941 * @pool: pool of interest
4943 * @pool->cpu is coming online. Rebind all workers to the CPU.
4945 static void rebind_workers(struct worker_pool *pool)
4947 struct worker *worker;
4949 lockdep_assert_held(&wq_pool_attach_mutex);
4952 * Restore CPU affinity of all workers. As all idle workers should
4953 * be on the run-queue of the associated CPU before any local
4954 * wake-ups for concurrency management happen, restore CPU affinity
4955 * of all workers first and then clear UNBOUND. As we're called
4956 * from CPU_ONLINE, the following shouldn't fail.
4958 for_each_pool_worker(worker, pool)
4959 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4960 pool->attrs->cpumask) < 0);
4962 spin_lock_irq(&pool->lock);
4964 pool->flags &= ~POOL_DISASSOCIATED;
4966 for_each_pool_worker(worker, pool) {
4967 unsigned int worker_flags = worker->flags;
4970 * A bound idle worker should actually be on the runqueue
4971 * of the associated CPU for local wake-ups targeting it to
4972 * work. Kick all idle workers so that they migrate to the
4973 * associated CPU. Doing this in the same loop as
4974 * replacing UNBOUND with REBOUND is safe as no worker will
4975 * be bound before @pool->lock is released.
4977 if (worker_flags & WORKER_IDLE)
4978 wake_up_process(worker->task);
4981 * We want to clear UNBOUND but can't directly call
4982 * worker_clr_flags() or adjust nr_running. Atomically
4983 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4984 * @worker will clear REBOUND using worker_clr_flags() when
4985 * it initiates the next execution cycle thus restoring
4986 * concurrency management. Note that when or whether
4987 * @worker clears REBOUND doesn't affect correctness.
4989 * WRITE_ONCE() is necessary because @worker->flags may be
4990 * tested without holding any lock in
4991 * wq_worker_running(). Without it, NOT_RUNNING test may
4992 * fail incorrectly leading to premature concurrency
4993 * management operations.
4995 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4996 worker_flags |= WORKER_REBOUND;
4997 worker_flags &= ~WORKER_UNBOUND;
4998 WRITE_ONCE(worker->flags, worker_flags);
5001 spin_unlock_irq(&pool->lock);
5005 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
5006 * @pool: unbound pool of interest
5007 * @cpu: the CPU which is coming up
5009 * An unbound pool may end up with a cpumask which doesn't have any online
5010 * CPUs. When a worker of such pool get scheduled, the scheduler resets
5011 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
5012 * online CPU before, cpus_allowed of all its workers should be restored.
5014 static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
5016 static cpumask_t cpumask;
5017 struct worker *worker;
5019 lockdep_assert_held(&wq_pool_attach_mutex);
5021 /* is @cpu allowed for @pool? */
5022 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
5025 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
5027 /* as we're called from CPU_ONLINE, the following shouldn't fail */
5028 for_each_pool_worker(worker, pool)
5029 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
5032 int workqueue_prepare_cpu(unsigned int cpu)
5034 struct worker_pool *pool;
5036 for_each_cpu_worker_pool(pool, cpu) {
5037 if (pool->nr_workers)
5039 if (!create_worker(pool))
5045 int workqueue_online_cpu(unsigned int cpu)
5047 struct worker_pool *pool;
5048 struct workqueue_struct *wq;
5051 mutex_lock(&wq_pool_mutex);
5053 for_each_pool(pool, pi) {
5054 mutex_lock(&wq_pool_attach_mutex);
5056 if (pool->cpu == cpu)
5057 rebind_workers(pool);
5058 else if (pool->cpu < 0)
5059 restore_unbound_workers_cpumask(pool, cpu);
5061 mutex_unlock(&wq_pool_attach_mutex);
5064 /* update NUMA affinity of unbound workqueues */
5065 list_for_each_entry(wq, &workqueues, list)
5066 wq_update_unbound_numa(wq, cpu, true);
5068 mutex_unlock(&wq_pool_mutex);
5072 int workqueue_offline_cpu(unsigned int cpu)
5074 struct workqueue_struct *wq;
5076 /* unbinding per-cpu workers should happen on the local CPU */
5077 if (WARN_ON(cpu != smp_processor_id()))
5080 unbind_workers(cpu);
5082 /* update NUMA affinity of unbound workqueues */
5083 mutex_lock(&wq_pool_mutex);
5084 list_for_each_entry(wq, &workqueues, list)
5085 wq_update_unbound_numa(wq, cpu, false);
5086 mutex_unlock(&wq_pool_mutex);
5091 struct work_for_cpu {
5092 struct work_struct work;
5098 static void work_for_cpu_fn(struct work_struct *work)
5100 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5102 wfc->ret = wfc->fn(wfc->arg);
5106 * work_on_cpu - run a function in thread context on a particular cpu
5107 * @cpu: the cpu to run on
5108 * @fn: the function to run
5109 * @arg: the function arg
5111 * It is up to the caller to ensure that the cpu doesn't go offline.
5112 * The caller must not hold any locks which would prevent @fn from completing.
5114 * Return: The value @fn returns.
5116 long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
5118 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
5120 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5121 schedule_work_on(cpu, &wfc.work);
5122 flush_work(&wfc.work);
5123 destroy_work_on_stack(&wfc.work);
5126 EXPORT_SYMBOL_GPL(work_on_cpu);
5129 * work_on_cpu_safe - run a function in thread context on a particular cpu
5130 * @cpu: the cpu to run on
5131 * @fn: the function to run
5132 * @arg: the function argument
5134 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5135 * any locks which would prevent @fn from completing.
5137 * Return: The value @fn returns.
5139 long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5144 if (cpu_online(cpu))
5145 ret = work_on_cpu(cpu, fn, arg);
5149 EXPORT_SYMBOL_GPL(work_on_cpu_safe);
5150 #endif /* CONFIG_SMP */
5152 #ifdef CONFIG_FREEZER
5155 * freeze_workqueues_begin - begin freezing workqueues
5157 * Start freezing workqueues. After this function returns, all freezable
5158 * workqueues will queue new works to their delayed_works list instead of
5162 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5164 void freeze_workqueues_begin(void)
5166 struct workqueue_struct *wq;
5167 struct pool_workqueue *pwq;
5169 mutex_lock(&wq_pool_mutex);
5171 WARN_ON_ONCE(workqueue_freezing);
5172 workqueue_freezing = true;
5174 list_for_each_entry(wq, &workqueues, list) {
5175 mutex_lock(&wq->mutex);
5176 for_each_pwq(pwq, wq)
5177 pwq_adjust_max_active(pwq);
5178 mutex_unlock(&wq->mutex);
5181 mutex_unlock(&wq_pool_mutex);
5185 * freeze_workqueues_busy - are freezable workqueues still busy?
5187 * Check whether freezing is complete. This function must be called
5188 * between freeze_workqueues_begin() and thaw_workqueues().
5191 * Grabs and releases wq_pool_mutex.
5194 * %true if some freezable workqueues are still busy. %false if freezing
5197 bool freeze_workqueues_busy(void)
5200 struct workqueue_struct *wq;
5201 struct pool_workqueue *pwq;
5203 mutex_lock(&wq_pool_mutex);
5205 WARN_ON_ONCE(!workqueue_freezing);
5207 list_for_each_entry(wq, &workqueues, list) {
5208 if (!(wq->flags & WQ_FREEZABLE))
5211 * nr_active is monotonically decreasing. It's safe
5212 * to peek without lock.
5215 for_each_pwq(pwq, wq) {
5216 WARN_ON_ONCE(pwq->nr_active < 0);
5217 if (pwq->nr_active) {
5226 mutex_unlock(&wq_pool_mutex);
5231 * thaw_workqueues - thaw workqueues
5233 * Thaw workqueues. Normal queueing is restored and all collected
5234 * frozen works are transferred to their respective pool worklists.
5237 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5239 void thaw_workqueues(void)
5241 struct workqueue_struct *wq;
5242 struct pool_workqueue *pwq;
5244 mutex_lock(&wq_pool_mutex);
5246 if (!workqueue_freezing)
5249 workqueue_freezing = false;
5251 /* restore max_active and repopulate worklist */
5252 list_for_each_entry(wq, &workqueues, list) {
5253 mutex_lock(&wq->mutex);
5254 for_each_pwq(pwq, wq)
5255 pwq_adjust_max_active(pwq);
5256 mutex_unlock(&wq->mutex);
5260 mutex_unlock(&wq_pool_mutex);
5262 #endif /* CONFIG_FREEZER */
5264 static int workqueue_apply_unbound_cpumask(void)
5268 struct workqueue_struct *wq;
5269 struct apply_wqattrs_ctx *ctx, *n;
5271 lockdep_assert_held(&wq_pool_mutex);
5273 list_for_each_entry(wq, &workqueues, list) {
5274 if (!(wq->flags & WQ_UNBOUND))
5277 /* creating multiple pwqs breaks ordering guarantee */
5278 if (!list_empty(&wq->pwqs)) {
5279 if (wq->flags & __WQ_ORDERED_EXPLICIT)
5281 wq->flags &= ~__WQ_ORDERED;
5284 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5290 list_add_tail(&ctx->list, &ctxs);
5293 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5295 apply_wqattrs_commit(ctx);
5296 apply_wqattrs_cleanup(ctx);
5303 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5304 * @cpumask: the cpumask to set
5306 * The low-level workqueues cpumask is a global cpumask that limits
5307 * the affinity of all unbound workqueues. This function check the @cpumask
5308 * and apply it to all unbound workqueues and updates all pwqs of them.
5310 * Retun: 0 - Success
5311 * -EINVAL - Invalid @cpumask
5312 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5314 int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5317 cpumask_var_t saved_cpumask;
5320 * Not excluding isolated cpus on purpose.
5321 * If the user wishes to include them, we allow that.
5323 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5324 if (!cpumask_empty(cpumask)) {
5325 apply_wqattrs_lock();
5326 if (cpumask_equal(cpumask, wq_unbound_cpumask)) {
5331 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL)) {
5336 /* save the old wq_unbound_cpumask. */
5337 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5339 /* update wq_unbound_cpumask at first and apply it to wqs. */
5340 cpumask_copy(wq_unbound_cpumask, cpumask);
5341 ret = workqueue_apply_unbound_cpumask();
5343 /* restore the wq_unbound_cpumask when failed. */
5345 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5347 free_cpumask_var(saved_cpumask);
5349 apply_wqattrs_unlock();
5357 * Workqueues with WQ_SYSFS flag set is visible to userland via
5358 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5359 * following attributes.
5361 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5362 * max_active RW int : maximum number of in-flight work items
5364 * Unbound workqueues have the following extra attributes.
5366 * pool_ids RO int : the associated pool IDs for each node
5367 * nice RW int : nice value of the workers
5368 * cpumask RW mask : bitmask of allowed CPUs for the workers
5369 * numa RW bool : whether enable NUMA affinity
5372 struct workqueue_struct *wq;
5376 static struct workqueue_struct *dev_to_wq(struct device *dev)
5378 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5383 static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5386 struct workqueue_struct *wq = dev_to_wq(dev);
5388 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5390 static DEVICE_ATTR_RO(per_cpu);
5392 static ssize_t max_active_show(struct device *dev,
5393 struct device_attribute *attr, char *buf)
5395 struct workqueue_struct *wq = dev_to_wq(dev);
5397 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5400 static ssize_t max_active_store(struct device *dev,
5401 struct device_attribute *attr, const char *buf,
5404 struct workqueue_struct *wq = dev_to_wq(dev);
5407 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5410 workqueue_set_max_active(wq, val);
5413 static DEVICE_ATTR_RW(max_active);
5415 static struct attribute *wq_sysfs_attrs[] = {
5416 &dev_attr_per_cpu.attr,
5417 &dev_attr_max_active.attr,
5420 ATTRIBUTE_GROUPS(wq_sysfs);
5422 static ssize_t wq_pool_ids_show(struct device *dev,
5423 struct device_attribute *attr, char *buf)
5425 struct workqueue_struct *wq = dev_to_wq(dev);
5426 const char *delim = "";
5427 int node, written = 0;
5431 for_each_node(node) {
5432 written += scnprintf(buf + written, PAGE_SIZE - written,
5433 "%s%d:%d", delim, node,
5434 unbound_pwq_by_node(wq, node)->pool->id);
5437 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5444 static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5447 struct workqueue_struct *wq = dev_to_wq(dev);
5450 mutex_lock(&wq->mutex);
5451 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5452 mutex_unlock(&wq->mutex);
5457 /* prepare workqueue_attrs for sysfs store operations */
5458 static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5460 struct workqueue_attrs *attrs;
5462 lockdep_assert_held(&wq_pool_mutex);
5464 attrs = alloc_workqueue_attrs();
5468 copy_workqueue_attrs(attrs, wq->unbound_attrs);
5472 static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5473 const char *buf, size_t count)
5475 struct workqueue_struct *wq = dev_to_wq(dev);
5476 struct workqueue_attrs *attrs;
5479 apply_wqattrs_lock();
5481 attrs = wq_sysfs_prep_attrs(wq);
5485 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5486 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
5487 ret = apply_workqueue_attrs_locked(wq, attrs);
5492 apply_wqattrs_unlock();
5493 free_workqueue_attrs(attrs);
5494 return ret ?: count;
5497 static ssize_t wq_cpumask_show(struct device *dev,
5498 struct device_attribute *attr, char *buf)
5500 struct workqueue_struct *wq = dev_to_wq(dev);
5503 mutex_lock(&wq->mutex);
5504 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5505 cpumask_pr_args(wq->unbound_attrs->cpumask));
5506 mutex_unlock(&wq->mutex);
5510 static ssize_t wq_cpumask_store(struct device *dev,
5511 struct device_attribute *attr,
5512 const char *buf, size_t count)
5514 struct workqueue_struct *wq = dev_to_wq(dev);
5515 struct workqueue_attrs *attrs;
5518 apply_wqattrs_lock();
5520 attrs = wq_sysfs_prep_attrs(wq);
5524 ret = cpumask_parse(buf, attrs->cpumask);
5526 ret = apply_workqueue_attrs_locked(wq, attrs);
5529 apply_wqattrs_unlock();
5530 free_workqueue_attrs(attrs);
5531 return ret ?: count;
5534 static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5537 struct workqueue_struct *wq = dev_to_wq(dev);
5540 mutex_lock(&wq->mutex);
5541 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5542 !wq->unbound_attrs->no_numa);
5543 mutex_unlock(&wq->mutex);
5548 static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5549 const char *buf, size_t count)
5551 struct workqueue_struct *wq = dev_to_wq(dev);
5552 struct workqueue_attrs *attrs;
5553 int v, ret = -ENOMEM;
5555 apply_wqattrs_lock();
5557 attrs = wq_sysfs_prep_attrs(wq);
5562 if (sscanf(buf, "%d", &v) == 1) {
5563 attrs->no_numa = !v;
5564 ret = apply_workqueue_attrs_locked(wq, attrs);
5568 apply_wqattrs_unlock();
5569 free_workqueue_attrs(attrs);
5570 return ret ?: count;
5573 static struct device_attribute wq_sysfs_unbound_attrs[] = {
5574 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5575 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5576 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5577 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5581 static struct bus_type wq_subsys = {
5582 .name = "workqueue",
5583 .dev_groups = wq_sysfs_groups,
5586 static ssize_t wq_unbound_cpumask_show(struct device *dev,
5587 struct device_attribute *attr, char *buf)
5591 mutex_lock(&wq_pool_mutex);
5592 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5593 cpumask_pr_args(wq_unbound_cpumask));
5594 mutex_unlock(&wq_pool_mutex);
5599 static ssize_t wq_unbound_cpumask_store(struct device *dev,
5600 struct device_attribute *attr, const char *buf, size_t count)
5602 cpumask_var_t cpumask;
5605 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5608 ret = cpumask_parse(buf, cpumask);
5610 ret = workqueue_set_unbound_cpumask(cpumask);
5612 free_cpumask_var(cpumask);
5613 return ret ? ret : count;
5616 static struct device_attribute wq_sysfs_cpumask_attr =
5617 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5618 wq_unbound_cpumask_store);
5620 static int __init wq_sysfs_init(void)
5624 err = subsys_virtual_register(&wq_subsys, NULL);
5628 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
5630 core_initcall(wq_sysfs_init);
5632 static void wq_device_release(struct device *dev)
5634 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5640 * workqueue_sysfs_register - make a workqueue visible in sysfs
5641 * @wq: the workqueue to register
5643 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5644 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5645 * which is the preferred method.
5647 * Workqueue user should use this function directly iff it wants to apply
5648 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5649 * apply_workqueue_attrs() may race against userland updating the
5652 * Return: 0 on success, -errno on failure.
5654 int workqueue_sysfs_register(struct workqueue_struct *wq)
5656 struct wq_device *wq_dev;
5660 * Adjusting max_active or creating new pwqs by applying
5661 * attributes breaks ordering guarantee. Disallow exposing ordered
5664 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
5667 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5672 wq_dev->dev.bus = &wq_subsys;
5673 wq_dev->dev.release = wq_device_release;
5674 dev_set_name(&wq_dev->dev, "%s", wq->name);
5677 * unbound_attrs are created separately. Suppress uevent until
5678 * everything is ready.
5680 dev_set_uevent_suppress(&wq_dev->dev, true);
5682 ret = device_register(&wq_dev->dev);
5684 put_device(&wq_dev->dev);
5689 if (wq->flags & WQ_UNBOUND) {
5690 struct device_attribute *attr;
5692 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5693 ret = device_create_file(&wq_dev->dev, attr);
5695 device_unregister(&wq_dev->dev);
5702 dev_set_uevent_suppress(&wq_dev->dev, false);
5703 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5708 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5709 * @wq: the workqueue to unregister
5711 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5713 static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5715 struct wq_device *wq_dev = wq->wq_dev;
5721 device_unregister(&wq_dev->dev);
5723 #else /* CONFIG_SYSFS */
5724 static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5725 #endif /* CONFIG_SYSFS */
5728 * Workqueue watchdog.
5730 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5731 * flush dependency, a concurrency managed work item which stays RUNNING
5732 * indefinitely. Workqueue stalls can be very difficult to debug as the
5733 * usual warning mechanisms don't trigger and internal workqueue state is
5736 * Workqueue watchdog monitors all worker pools periodically and dumps
5737 * state if some pools failed to make forward progress for a while where
5738 * forward progress is defined as the first item on ->worklist changing.
5740 * This mechanism is controlled through the kernel parameter
5741 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5742 * corresponding sysfs parameter file.
5744 #ifdef CONFIG_WQ_WATCHDOG
5746 static unsigned long wq_watchdog_thresh = 30;
5747 static struct timer_list wq_watchdog_timer;
5749 static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5750 static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5752 static void wq_watchdog_reset_touched(void)
5756 wq_watchdog_touched = jiffies;
5757 for_each_possible_cpu(cpu)
5758 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5761 static void wq_watchdog_timer_fn(struct timer_list *unused)
5763 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5764 bool lockup_detected = false;
5765 unsigned long now = jiffies;
5766 struct worker_pool *pool;
5774 for_each_pool(pool, pi) {
5775 unsigned long pool_ts, touched, ts;
5777 if (list_empty(&pool->worklist))
5781 * If a virtual machine is stopped by the host it can look to
5782 * the watchdog like a stall.
5784 kvm_check_and_clear_guest_paused();
5786 /* get the latest of pool and touched timestamps */
5787 pool_ts = READ_ONCE(pool->watchdog_ts);
5788 touched = READ_ONCE(wq_watchdog_touched);
5790 if (time_after(pool_ts, touched))
5795 if (pool->cpu >= 0) {
5796 unsigned long cpu_touched =
5797 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5799 if (time_after(cpu_touched, ts))
5804 if (time_after(now, ts + thresh)) {
5805 lockup_detected = true;
5806 pr_emerg("BUG: workqueue lockup - pool");
5807 pr_cont_pool_info(pool);
5808 pr_cont(" stuck for %us!\n",
5809 jiffies_to_msecs(now - pool_ts) / 1000);
5815 if (lockup_detected)
5816 show_workqueue_state();
5818 wq_watchdog_reset_touched();
5819 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5822 notrace void wq_watchdog_touch(int cpu)
5825 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5827 wq_watchdog_touched = jiffies;
5830 static void wq_watchdog_set_thresh(unsigned long thresh)
5832 wq_watchdog_thresh = 0;
5833 del_timer_sync(&wq_watchdog_timer);
5836 wq_watchdog_thresh = thresh;
5837 wq_watchdog_reset_touched();
5838 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5842 static int wq_watchdog_param_set_thresh(const char *val,
5843 const struct kernel_param *kp)
5845 unsigned long thresh;
5848 ret = kstrtoul(val, 0, &thresh);
5853 wq_watchdog_set_thresh(thresh);
5855 wq_watchdog_thresh = thresh;
5860 static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5861 .set = wq_watchdog_param_set_thresh,
5862 .get = param_get_ulong,
5865 module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5868 static void wq_watchdog_init(void)
5870 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
5871 wq_watchdog_set_thresh(wq_watchdog_thresh);
5874 #else /* CONFIG_WQ_WATCHDOG */
5876 static inline void wq_watchdog_init(void) { }
5878 #endif /* CONFIG_WQ_WATCHDOG */
5880 static void __init wq_numa_init(void)
5885 if (num_possible_nodes() <= 1)
5888 if (wq_disable_numa) {
5889 pr_info("workqueue: NUMA affinity support disabled\n");
5893 for_each_possible_cpu(cpu) {
5894 if (WARN_ON(cpu_to_node(cpu) == NUMA_NO_NODE)) {
5895 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5900 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
5901 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5904 * We want masks of possible CPUs of each node which isn't readily
5905 * available. Build one from cpu_to_node() which should have been
5906 * fully initialized by now.
5908 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
5912 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
5913 node_online(node) ? node : NUMA_NO_NODE));
5915 for_each_possible_cpu(cpu) {
5916 node = cpu_to_node(cpu);
5917 cpumask_set_cpu(cpu, tbl[node]);
5920 wq_numa_possible_cpumask = tbl;
5921 wq_numa_enabled = true;
5925 * workqueue_init_early - early init for workqueue subsystem
5927 * This is the first half of two-staged workqueue subsystem initialization
5928 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5929 * idr are up. It sets up all the data structures and system workqueues
5930 * and allows early boot code to create workqueues and queue/cancel work
5931 * items. Actual work item execution starts only after kthreads can be
5932 * created and scheduled right before early initcalls.
5934 int __init workqueue_init_early(void)
5936 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5937 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
5940 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5942 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5943 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
5945 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5947 /* initialize CPU pools */
5948 for_each_possible_cpu(cpu) {
5949 struct worker_pool *pool;
5952 for_each_cpu_worker_pool(pool, cpu) {
5953 BUG_ON(init_worker_pool(pool));
5955 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
5956 pool->attrs->nice = std_nice[i++];
5957 pool->node = cpu_to_node(cpu);
5960 mutex_lock(&wq_pool_mutex);
5961 BUG_ON(worker_pool_assign_id(pool));
5962 mutex_unlock(&wq_pool_mutex);
5966 /* create default unbound and ordered wq attrs */
5967 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5968 struct workqueue_attrs *attrs;
5970 BUG_ON(!(attrs = alloc_workqueue_attrs()));
5971 attrs->nice = std_nice[i];
5972 unbound_std_wq_attrs[i] = attrs;
5975 * An ordered wq should have only one pwq as ordering is
5976 * guaranteed by max_active which is enforced by pwqs.
5977 * Turn off NUMA so that dfl_pwq is used for all nodes.
5979 BUG_ON(!(attrs = alloc_workqueue_attrs()));
5980 attrs->nice = std_nice[i];
5981 attrs->no_numa = true;
5982 ordered_wq_attrs[i] = attrs;
5985 system_wq = alloc_workqueue("events", 0, 0);
5986 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
5987 system_long_wq = alloc_workqueue("events_long", 0, 0);
5988 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5989 WQ_UNBOUND_MAX_ACTIVE);
5990 system_freezable_wq = alloc_workqueue("events_freezable",
5992 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5993 WQ_POWER_EFFICIENT, 0);
5994 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5995 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5997 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
5998 !system_unbound_wq || !system_freezable_wq ||
5999 !system_power_efficient_wq ||
6000 !system_freezable_power_efficient_wq);
6006 * workqueue_init - bring workqueue subsystem fully online
6008 * This is the latter half of two-staged workqueue subsystem initialization
6009 * and invoked as soon as kthreads can be created and scheduled.
6010 * Workqueues have been created and work items queued on them, but there
6011 * are no kworkers executing the work items yet. Populate the worker pools
6012 * with the initial workers and enable future kworker creations.
6014 int __init workqueue_init(void)
6016 struct workqueue_struct *wq;
6017 struct worker_pool *pool;
6021 * It'd be simpler to initialize NUMA in workqueue_init_early() but
6022 * CPU to node mapping may not be available that early on some
6023 * archs such as power and arm64. As per-cpu pools created
6024 * previously could be missing node hint and unbound pools NUMA
6025 * affinity, fix them up.
6027 * Also, while iterating workqueues, create rescuers if requested.
6031 mutex_lock(&wq_pool_mutex);
6033 for_each_possible_cpu(cpu) {
6034 for_each_cpu_worker_pool(pool, cpu) {
6035 pool->node = cpu_to_node(cpu);
6039 list_for_each_entry(wq, &workqueues, list) {
6040 wq_update_unbound_numa(wq, smp_processor_id(), true);
6041 WARN(init_rescuer(wq),
6042 "workqueue: failed to create early rescuer for %s",
6046 mutex_unlock(&wq_pool_mutex);
6048 /* create the initial workers */
6049 for_each_online_cpu(cpu) {
6050 for_each_cpu_worker_pool(pool, cpu) {
6051 pool->flags &= ~POOL_DISASSOCIATED;
6052 BUG_ON(!create_worker(pool));
6056 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
6057 BUG_ON(!create_worker(pool));