cros_ec: fix nul-termination for firmware build info
[linux-stable.git] / kernel / workqueue.c
blobd0c6b50792c876bf814616e30715c52768152c54
1 /*
2 * kernel/workqueue.c - generic async execution with shared worker pool
4 * Copyright (C) 2002 Ingo Molnar
6 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
12 * Made to use alloc_percpu by Christoph Lameter.
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
19 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
24 * Please read Documentation/core-api/workqueue.rst for details.
27 #include <linux/export.h>
28 #include <linux/kernel.h>
29 #include <linux/sched.h>
30 #include <linux/init.h>
31 #include <linux/signal.h>
32 #include <linux/completion.h>
33 #include <linux/workqueue.h>
34 #include <linux/slab.h>
35 #include <linux/cpu.h>
36 #include <linux/notifier.h>
37 #include <linux/kthread.h>
38 #include <linux/hardirq.h>
39 #include <linux/mempolicy.h>
40 #include <linux/freezer.h>
41 #include <linux/kallsyms.h>
42 #include <linux/debug_locks.h>
43 #include <linux/lockdep.h>
44 #include <linux/idr.h>
45 #include <linux/jhash.h>
46 #include <linux/hashtable.h>
47 #include <linux/rculist.h>
48 #include <linux/nodemask.h>
49 #include <linux/moduleparam.h>
50 #include <linux/uaccess.h>
51 #include <linux/nmi.h>
53 #include "workqueue_internal.h"
55 enum {
57 * worker_pool flags
59 * A bound pool is either associated or disassociated with its CPU.
60 * While associated (!DISASSOCIATED), all workers are bound to the
61 * CPU and none has %WORKER_UNBOUND set and concurrency management
62 * is in effect.
64 * While DISASSOCIATED, the cpu may be offline and all workers have
65 * %WORKER_UNBOUND set and concurrency management disabled, and may
66 * be executing on any CPU. The pool behaves as an unbound one.
68 * Note that DISASSOCIATED should be flipped only while holding
69 * attach_mutex to avoid changing binding state while
70 * worker_attach_to_pool() is in progress.
72 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
73 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
75 /* worker flags */
76 WORKER_DIE = 1 << 1, /* die die die */
77 WORKER_IDLE = 1 << 2, /* is idle */
78 WORKER_PREP = 1 << 3, /* preparing to run works */
79 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
80 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
81 WORKER_REBOUND = 1 << 8, /* worker was rebound */
83 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
84 WORKER_UNBOUND | WORKER_REBOUND,
86 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
88 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
89 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
91 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
92 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
94 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
95 /* call for help after 10ms
96 (min two ticks) */
97 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
98 CREATE_COOLDOWN = HZ, /* time to breath after fail */
101 * Rescue workers are used only on emergencies and shared by
102 * all cpus. Give MIN_NICE.
104 RESCUER_NICE_LEVEL = MIN_NICE,
105 HIGHPRI_NICE_LEVEL = MIN_NICE,
107 WQ_NAME_LEN = 24,
111 * Structure fields follow one of the following exclusion rules.
113 * I: Modifiable by initialization/destruction paths and read-only for
114 * everyone else.
116 * P: Preemption protected. Disabling preemption is enough and should
117 * only be modified and accessed from the local cpu.
119 * L: pool->lock protected. Access with pool->lock held.
121 * X: During normal operation, modification requires pool->lock and should
122 * be done only from local cpu. Either disabling preemption on local
123 * cpu or grabbing pool->lock is enough for read access. If
124 * POOL_DISASSOCIATED is set, it's identical to L.
126 * A: pool->attach_mutex protected.
128 * PL: wq_pool_mutex protected.
130 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
132 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
134 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
135 * sched-RCU for reads.
137 * WQ: wq->mutex protected.
139 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
141 * MD: wq_mayday_lock protected.
144 /* struct worker is defined in workqueue_internal.h */
146 struct worker_pool {
147 spinlock_t lock; /* the pool lock */
148 int cpu; /* I: the associated cpu */
149 int node; /* I: the associated node ID */
150 int id; /* I: pool ID */
151 unsigned int flags; /* X: flags */
153 unsigned long watchdog_ts; /* L: watchdog timestamp */
155 struct list_head worklist; /* L: list of pending works */
156 int nr_workers; /* L: total number of workers */
158 /* nr_idle includes the ones off idle_list for rebinding */
159 int nr_idle; /* L: currently idle ones */
161 struct list_head idle_list; /* X: list of idle workers */
162 struct timer_list idle_timer; /* L: worker idle timeout */
163 struct timer_list mayday_timer; /* L: SOS timer for workers */
165 /* a workers is either on busy_hash or idle_list, or the manager */
166 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
167 /* L: hash of busy workers */
169 /* see manage_workers() for details on the two manager mutexes */
170 struct worker *manager; /* L: purely informational */
171 struct mutex attach_mutex; /* attach/detach exclusion */
172 struct list_head workers; /* A: attached workers */
173 struct completion *detach_completion; /* all workers detached */
175 struct ida worker_ida; /* worker IDs for task name */
177 struct workqueue_attrs *attrs; /* I: worker attributes */
178 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
179 int refcnt; /* PL: refcnt for unbound pools */
182 * The current concurrency level. As it's likely to be accessed
183 * from other CPUs during try_to_wake_up(), put it in a separate
184 * cacheline.
186 atomic_t nr_running ____cacheline_aligned_in_smp;
189 * Destruction of pool is sched-RCU protected to allow dereferences
190 * from get_work_pool().
192 struct rcu_head rcu;
193 } ____cacheline_aligned_in_smp;
196 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
197 * of work_struct->data are used for flags and the remaining high bits
198 * point to the pwq; thus, pwqs need to be aligned at two's power of the
199 * number of flag bits.
201 struct pool_workqueue {
202 struct worker_pool *pool; /* I: the associated pool */
203 struct workqueue_struct *wq; /* I: the owning workqueue */
204 int work_color; /* L: current color */
205 int flush_color; /* L: flushing color */
206 int refcnt; /* L: reference count */
207 int nr_in_flight[WORK_NR_COLORS];
208 /* L: nr of in_flight works */
209 int nr_active; /* L: nr of active works */
210 int max_active; /* L: max active works */
211 struct list_head delayed_works; /* L: delayed works */
212 struct list_head pwqs_node; /* WR: node on wq->pwqs */
213 struct list_head mayday_node; /* MD: node on wq->maydays */
216 * Release of unbound pwq is punted to system_wq. See put_pwq()
217 * and pwq_unbound_release_workfn() for details. pool_workqueue
218 * itself is also sched-RCU protected so that the first pwq can be
219 * determined without grabbing wq->mutex.
221 struct work_struct unbound_release_work;
222 struct rcu_head rcu;
223 } __aligned(1 << WORK_STRUCT_FLAG_BITS);
226 * Structure used to wait for workqueue flush.
228 struct wq_flusher {
229 struct list_head list; /* WQ: list of flushers */
230 int flush_color; /* WQ: flush color waiting for */
231 struct completion done; /* flush completion */
234 struct wq_device;
237 * The externally visible workqueue. It relays the issued work items to
238 * the appropriate worker_pool through its pool_workqueues.
240 struct workqueue_struct {
241 struct list_head pwqs; /* WR: all pwqs of this wq */
242 struct list_head list; /* PR: list of all workqueues */
244 struct mutex mutex; /* protects this wq */
245 int work_color; /* WQ: current work color */
246 int flush_color; /* WQ: current flush color */
247 atomic_t nr_pwqs_to_flush; /* flush in progress */
248 struct wq_flusher *first_flusher; /* WQ: first flusher */
249 struct list_head flusher_queue; /* WQ: flush waiters */
250 struct list_head flusher_overflow; /* WQ: flush overflow list */
252 struct list_head maydays; /* MD: pwqs requesting rescue */
253 struct worker *rescuer; /* I: rescue worker */
255 int nr_drainers; /* WQ: drain in progress */
256 int saved_max_active; /* WQ: saved pwq max_active */
258 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
259 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
261 #ifdef CONFIG_SYSFS
262 struct wq_device *wq_dev; /* I: for sysfs interface */
263 #endif
264 #ifdef CONFIG_LOCKDEP
265 struct lockdep_map lockdep_map;
266 #endif
267 char name[WQ_NAME_LEN]; /* I: workqueue name */
270 * Destruction of workqueue_struct is sched-RCU protected to allow
271 * walking the workqueues list without grabbing wq_pool_mutex.
272 * This is used to dump all workqueues from sysrq.
274 struct rcu_head rcu;
276 /* hot fields used during command issue, aligned to cacheline */
277 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
278 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
279 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
282 static struct kmem_cache *pwq_cache;
284 static cpumask_var_t *wq_numa_possible_cpumask;
285 /* possible CPUs of each node */
287 static bool wq_disable_numa;
288 module_param_named(disable_numa, wq_disable_numa, bool, 0444);
290 /* see the comment above the definition of WQ_POWER_EFFICIENT */
291 static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
292 module_param_named(power_efficient, wq_power_efficient, bool, 0444);
294 static bool wq_online; /* can kworkers be created yet? */
296 static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
298 /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
299 static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
301 static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
302 static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
303 static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
305 static LIST_HEAD(workqueues); /* PR: list of all workqueues */
306 static bool workqueue_freezing; /* PL: have wqs started freezing? */
308 /* PL: allowable cpus for unbound wqs and work items */
309 static cpumask_var_t wq_unbound_cpumask;
311 /* CPU where unbound work was last round robin scheduled from this CPU */
312 static DEFINE_PER_CPU(int, wq_rr_cpu_last);
315 * Local execution of unbound work items is no longer guaranteed. The
316 * following always forces round-robin CPU selection on unbound work items
317 * to uncover usages which depend on it.
319 #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
320 static bool wq_debug_force_rr_cpu = true;
321 #else
322 static bool wq_debug_force_rr_cpu = false;
323 #endif
324 module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
326 /* the per-cpu worker pools */
327 static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
329 static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
331 /* PL: hash of all unbound pools keyed by pool->attrs */
332 static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
334 /* I: attributes used when instantiating standard unbound pools on demand */
335 static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
337 /* I: attributes used when instantiating ordered pools on demand */
338 static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
340 struct workqueue_struct *system_wq __read_mostly;
341 EXPORT_SYMBOL(system_wq);
342 struct workqueue_struct *system_highpri_wq __read_mostly;
343 EXPORT_SYMBOL_GPL(system_highpri_wq);
344 struct workqueue_struct *system_long_wq __read_mostly;
345 EXPORT_SYMBOL_GPL(system_long_wq);
346 struct workqueue_struct *system_unbound_wq __read_mostly;
347 EXPORT_SYMBOL_GPL(system_unbound_wq);
348 struct workqueue_struct *system_freezable_wq __read_mostly;
349 EXPORT_SYMBOL_GPL(system_freezable_wq);
350 struct workqueue_struct *system_power_efficient_wq __read_mostly;
351 EXPORT_SYMBOL_GPL(system_power_efficient_wq);
352 struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
353 EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
355 static int worker_thread(void *__worker);
356 static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
358 #define CREATE_TRACE_POINTS
359 #include <trace/events/workqueue.h>
361 #define assert_rcu_or_pool_mutex() \
362 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
363 !lockdep_is_held(&wq_pool_mutex), \
364 "sched RCU or wq_pool_mutex should be held")
366 #define assert_rcu_or_wq_mutex(wq) \
367 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
368 !lockdep_is_held(&wq->mutex), \
369 "sched RCU or wq->mutex should be held")
371 #define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
372 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
373 !lockdep_is_held(&wq->mutex) && \
374 !lockdep_is_held(&wq_pool_mutex), \
375 "sched RCU, wq->mutex or wq_pool_mutex should be held")
377 #define for_each_cpu_worker_pool(pool, cpu) \
378 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
379 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
380 (pool)++)
383 * for_each_pool - iterate through all worker_pools in the system
384 * @pool: iteration cursor
385 * @pi: integer used for iteration
387 * This must be called either with wq_pool_mutex held or sched RCU read
388 * locked. If the pool needs to be used beyond the locking in effect, the
389 * caller is responsible for guaranteeing that the pool stays online.
391 * The if/else clause exists only for the lockdep assertion and can be
392 * ignored.
394 #define for_each_pool(pool, pi) \
395 idr_for_each_entry(&worker_pool_idr, pool, pi) \
396 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
397 else
400 * for_each_pool_worker - iterate through all workers of a worker_pool
401 * @worker: iteration cursor
402 * @pool: worker_pool to iterate workers of
404 * This must be called with @pool->attach_mutex.
406 * The if/else clause exists only for the lockdep assertion and can be
407 * ignored.
409 #define for_each_pool_worker(worker, pool) \
410 list_for_each_entry((worker), &(pool)->workers, node) \
411 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
412 else
415 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
416 * @pwq: iteration cursor
417 * @wq: the target workqueue
419 * This must be called either with wq->mutex held or sched RCU read locked.
420 * If the pwq needs to be used beyond the locking in effect, the caller is
421 * responsible for guaranteeing that the pwq stays online.
423 * The if/else clause exists only for the lockdep assertion and can be
424 * ignored.
426 #define for_each_pwq(pwq, wq) \
427 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
428 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
429 else
431 #ifdef CONFIG_DEBUG_OBJECTS_WORK
433 static struct debug_obj_descr work_debug_descr;
435 static void *work_debug_hint(void *addr)
437 return ((struct work_struct *) addr)->func;
440 static bool work_is_static_object(void *addr)
442 struct work_struct *work = addr;
444 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
448 * fixup_init is called when:
449 * - an active object is initialized
451 static bool work_fixup_init(void *addr, enum debug_obj_state state)
453 struct work_struct *work = addr;
455 switch (state) {
456 case ODEBUG_STATE_ACTIVE:
457 cancel_work_sync(work);
458 debug_object_init(work, &work_debug_descr);
459 return true;
460 default:
461 return false;
466 * fixup_free is called when:
467 * - an active object is freed
469 static bool work_fixup_free(void *addr, enum debug_obj_state state)
471 struct work_struct *work = addr;
473 switch (state) {
474 case ODEBUG_STATE_ACTIVE:
475 cancel_work_sync(work);
476 debug_object_free(work, &work_debug_descr);
477 return true;
478 default:
479 return false;
483 static struct debug_obj_descr work_debug_descr = {
484 .name = "work_struct",
485 .debug_hint = work_debug_hint,
486 .is_static_object = work_is_static_object,
487 .fixup_init = work_fixup_init,
488 .fixup_free = work_fixup_free,
491 static inline void debug_work_activate(struct work_struct *work)
493 debug_object_activate(work, &work_debug_descr);
496 static inline void debug_work_deactivate(struct work_struct *work)
498 debug_object_deactivate(work, &work_debug_descr);
501 void __init_work(struct work_struct *work, int onstack)
503 if (onstack)
504 debug_object_init_on_stack(work, &work_debug_descr);
505 else
506 debug_object_init(work, &work_debug_descr);
508 EXPORT_SYMBOL_GPL(__init_work);
510 void destroy_work_on_stack(struct work_struct *work)
512 debug_object_free(work, &work_debug_descr);
514 EXPORT_SYMBOL_GPL(destroy_work_on_stack);
516 void destroy_delayed_work_on_stack(struct delayed_work *work)
518 destroy_timer_on_stack(&work->timer);
519 debug_object_free(&work->work, &work_debug_descr);
521 EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
523 #else
524 static inline void debug_work_activate(struct work_struct *work) { }
525 static inline void debug_work_deactivate(struct work_struct *work) { }
526 #endif
529 * worker_pool_assign_id - allocate ID and assing it to @pool
530 * @pool: the pool pointer of interest
532 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
533 * successfully, -errno on failure.
535 static int worker_pool_assign_id(struct worker_pool *pool)
537 int ret;
539 lockdep_assert_held(&wq_pool_mutex);
541 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
542 GFP_KERNEL);
543 if (ret >= 0) {
544 pool->id = ret;
545 return 0;
547 return ret;
551 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
552 * @wq: the target workqueue
553 * @node: the node ID
555 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
556 * read locked.
557 * If the pwq needs to be used beyond the locking in effect, the caller is
558 * responsible for guaranteeing that the pwq stays online.
560 * Return: The unbound pool_workqueue for @node.
562 static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
563 int node)
565 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
568 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
569 * delayed item is pending. The plan is to keep CPU -> NODE
570 * mapping valid and stable across CPU on/offlines. Once that
571 * happens, this workaround can be removed.
573 if (unlikely(node == NUMA_NO_NODE))
574 return wq->dfl_pwq;
576 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
579 static unsigned int work_color_to_flags(int color)
581 return color << WORK_STRUCT_COLOR_SHIFT;
584 static int get_work_color(struct work_struct *work)
586 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
587 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
590 static int work_next_color(int color)
592 return (color + 1) % WORK_NR_COLORS;
596 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
597 * contain the pointer to the queued pwq. Once execution starts, the flag
598 * is cleared and the high bits contain OFFQ flags and pool ID.
600 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
601 * and clear_work_data() can be used to set the pwq, pool or clear
602 * work->data. These functions should only be called while the work is
603 * owned - ie. while the PENDING bit is set.
605 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
606 * corresponding to a work. Pool is available once the work has been
607 * queued anywhere after initialization until it is sync canceled. pwq is
608 * available only while the work item is queued.
610 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
611 * canceled. While being canceled, a work item may have its PENDING set
612 * but stay off timer and worklist for arbitrarily long and nobody should
613 * try to steal the PENDING bit.
615 static inline void set_work_data(struct work_struct *work, unsigned long data,
616 unsigned long flags)
618 WARN_ON_ONCE(!work_pending(work));
619 atomic_long_set(&work->data, data | flags | work_static(work));
622 static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
623 unsigned long extra_flags)
625 set_work_data(work, (unsigned long)pwq,
626 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
629 static void set_work_pool_and_keep_pending(struct work_struct *work,
630 int pool_id)
632 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
633 WORK_STRUCT_PENDING);
636 static void set_work_pool_and_clear_pending(struct work_struct *work,
637 int pool_id)
640 * The following wmb is paired with the implied mb in
641 * test_and_set_bit(PENDING) and ensures all updates to @work made
642 * here are visible to and precede any updates by the next PENDING
643 * owner.
645 smp_wmb();
646 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
648 * The following mb guarantees that previous clear of a PENDING bit
649 * will not be reordered with any speculative LOADS or STORES from
650 * work->current_func, which is executed afterwards. This possible
651 * reordering can lead to a missed execution on attempt to qeueue
652 * the same @work. E.g. consider this case:
654 * CPU#0 CPU#1
655 * ---------------------------- --------------------------------
657 * 1 STORE event_indicated
658 * 2 queue_work_on() {
659 * 3 test_and_set_bit(PENDING)
660 * 4 } set_..._and_clear_pending() {
661 * 5 set_work_data() # clear bit
662 * 6 smp_mb()
663 * 7 work->current_func() {
664 * 8 LOAD event_indicated
667 * Without an explicit full barrier speculative LOAD on line 8 can
668 * be executed before CPU#0 does STORE on line 1. If that happens,
669 * CPU#0 observes the PENDING bit is still set and new execution of
670 * a @work is not queued in a hope, that CPU#1 will eventually
671 * finish the queued @work. Meanwhile CPU#1 does not see
672 * event_indicated is set, because speculative LOAD was executed
673 * before actual STORE.
675 smp_mb();
678 static void clear_work_data(struct work_struct *work)
680 smp_wmb(); /* see set_work_pool_and_clear_pending() */
681 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
684 static struct pool_workqueue *get_work_pwq(struct work_struct *work)
686 unsigned long data = atomic_long_read(&work->data);
688 if (data & WORK_STRUCT_PWQ)
689 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
690 else
691 return NULL;
695 * get_work_pool - return the worker_pool a given work was associated with
696 * @work: the work item of interest
698 * Pools are created and destroyed under wq_pool_mutex, and allows read
699 * access under sched-RCU read lock. As such, this function should be
700 * called under wq_pool_mutex or with preemption disabled.
702 * All fields of the returned pool are accessible as long as the above
703 * mentioned locking is in effect. If the returned pool needs to be used
704 * beyond the critical section, the caller is responsible for ensuring the
705 * returned pool is and stays online.
707 * Return: The worker_pool @work was last associated with. %NULL if none.
709 static struct worker_pool *get_work_pool(struct work_struct *work)
711 unsigned long data = atomic_long_read(&work->data);
712 int pool_id;
714 assert_rcu_or_pool_mutex();
716 if (data & WORK_STRUCT_PWQ)
717 return ((struct pool_workqueue *)
718 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
720 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
721 if (pool_id == WORK_OFFQ_POOL_NONE)
722 return NULL;
724 return idr_find(&worker_pool_idr, pool_id);
728 * get_work_pool_id - return the worker pool ID a given work is associated with
729 * @work: the work item of interest
731 * Return: The worker_pool ID @work was last associated with.
732 * %WORK_OFFQ_POOL_NONE if none.
734 static int get_work_pool_id(struct work_struct *work)
736 unsigned long data = atomic_long_read(&work->data);
738 if (data & WORK_STRUCT_PWQ)
739 return ((struct pool_workqueue *)
740 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
742 return data >> WORK_OFFQ_POOL_SHIFT;
745 static void mark_work_canceling(struct work_struct *work)
747 unsigned long pool_id = get_work_pool_id(work);
749 pool_id <<= WORK_OFFQ_POOL_SHIFT;
750 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
753 static bool work_is_canceling(struct work_struct *work)
755 unsigned long data = atomic_long_read(&work->data);
757 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
761 * Policy functions. These define the policies on how the global worker
762 * pools are managed. Unless noted otherwise, these functions assume that
763 * they're being called with pool->lock held.
766 static bool __need_more_worker(struct worker_pool *pool)
768 return !atomic_read(&pool->nr_running);
772 * Need to wake up a worker? Called from anything but currently
773 * running workers.
775 * Note that, because unbound workers never contribute to nr_running, this
776 * function will always return %true for unbound pools as long as the
777 * worklist isn't empty.
779 static bool need_more_worker(struct worker_pool *pool)
781 return !list_empty(&pool->worklist) && __need_more_worker(pool);
784 /* Can I start working? Called from busy but !running workers. */
785 static bool may_start_working(struct worker_pool *pool)
787 return pool->nr_idle;
790 /* Do I need to keep working? Called from currently running workers. */
791 static bool keep_working(struct worker_pool *pool)
793 return !list_empty(&pool->worklist) &&
794 atomic_read(&pool->nr_running) <= 1;
797 /* Do we need a new worker? Called from manager. */
798 static bool need_to_create_worker(struct worker_pool *pool)
800 return need_more_worker(pool) && !may_start_working(pool);
803 /* Do we have too many workers and should some go away? */
804 static bool too_many_workers(struct worker_pool *pool)
806 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
807 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
808 int nr_busy = pool->nr_workers - nr_idle;
810 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
814 * Wake up functions.
817 /* Return the first idle worker. Safe with preemption disabled */
818 static struct worker *first_idle_worker(struct worker_pool *pool)
820 if (unlikely(list_empty(&pool->idle_list)))
821 return NULL;
823 return list_first_entry(&pool->idle_list, struct worker, entry);
827 * wake_up_worker - wake up an idle worker
828 * @pool: worker pool to wake worker from
830 * Wake up the first idle worker of @pool.
832 * CONTEXT:
833 * spin_lock_irq(pool->lock).
835 static void wake_up_worker(struct worker_pool *pool)
837 struct worker *worker = first_idle_worker(pool);
839 if (likely(worker))
840 wake_up_process(worker->task);
844 * wq_worker_waking_up - a worker is waking up
845 * @task: task waking up
846 * @cpu: CPU @task is waking up to
848 * This function is called during try_to_wake_up() when a worker is
849 * being awoken.
851 * CONTEXT:
852 * spin_lock_irq(rq->lock)
854 void wq_worker_waking_up(struct task_struct *task, int cpu)
856 struct worker *worker = kthread_data(task);
858 if (!(worker->flags & WORKER_NOT_RUNNING)) {
859 WARN_ON_ONCE(worker->pool->cpu != cpu);
860 atomic_inc(&worker->pool->nr_running);
865 * wq_worker_sleeping - a worker is going to sleep
866 * @task: task going to sleep
868 * This function is called during schedule() when a busy worker is
869 * going to sleep. Worker on the same cpu can be woken up by
870 * returning pointer to its task.
872 * CONTEXT:
873 * spin_lock_irq(rq->lock)
875 * Return:
876 * Worker task on @cpu to wake up, %NULL if none.
878 struct task_struct *wq_worker_sleeping(struct task_struct *task)
880 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
881 struct worker_pool *pool;
884 * Rescuers, which may not have all the fields set up like normal
885 * workers, also reach here, let's not access anything before
886 * checking NOT_RUNNING.
888 if (worker->flags & WORKER_NOT_RUNNING)
889 return NULL;
891 pool = worker->pool;
893 /* this can only happen on the local cpu */
894 if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
895 return NULL;
898 * The counterpart of the following dec_and_test, implied mb,
899 * worklist not empty test sequence is in insert_work().
900 * Please read comment there.
902 * NOT_RUNNING is clear. This means that we're bound to and
903 * running on the local cpu w/ rq lock held and preemption
904 * disabled, which in turn means that none else could be
905 * manipulating idle_list, so dereferencing idle_list without pool
906 * lock is safe.
908 if (atomic_dec_and_test(&pool->nr_running) &&
909 !list_empty(&pool->worklist))
910 to_wakeup = first_idle_worker(pool);
911 return to_wakeup ? to_wakeup->task : NULL;
915 * worker_set_flags - set worker flags and adjust nr_running accordingly
916 * @worker: self
917 * @flags: flags to set
919 * Set @flags in @worker->flags and adjust nr_running accordingly.
921 * CONTEXT:
922 * spin_lock_irq(pool->lock)
924 static inline void worker_set_flags(struct worker *worker, unsigned int flags)
926 struct worker_pool *pool = worker->pool;
928 WARN_ON_ONCE(worker->task != current);
930 /* If transitioning into NOT_RUNNING, adjust nr_running. */
931 if ((flags & WORKER_NOT_RUNNING) &&
932 !(worker->flags & WORKER_NOT_RUNNING)) {
933 atomic_dec(&pool->nr_running);
936 worker->flags |= flags;
940 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
941 * @worker: self
942 * @flags: flags to clear
944 * Clear @flags in @worker->flags and adjust nr_running accordingly.
946 * CONTEXT:
947 * spin_lock_irq(pool->lock)
949 static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
951 struct worker_pool *pool = worker->pool;
952 unsigned int oflags = worker->flags;
954 WARN_ON_ONCE(worker->task != current);
956 worker->flags &= ~flags;
959 * If transitioning out of NOT_RUNNING, increment nr_running. Note
960 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
961 * of multiple flags, not a single flag.
963 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
964 if (!(worker->flags & WORKER_NOT_RUNNING))
965 atomic_inc(&pool->nr_running);
969 * find_worker_executing_work - find worker which is executing a work
970 * @pool: pool of interest
971 * @work: work to find worker for
973 * Find a worker which is executing @work on @pool by searching
974 * @pool->busy_hash which is keyed by the address of @work. For a worker
975 * to match, its current execution should match the address of @work and
976 * its work function. This is to avoid unwanted dependency between
977 * unrelated work executions through a work item being recycled while still
978 * being executed.
980 * This is a bit tricky. A work item may be freed once its execution
981 * starts and nothing prevents the freed area from being recycled for
982 * another work item. If the same work item address ends up being reused
983 * before the original execution finishes, workqueue will identify the
984 * recycled work item as currently executing and make it wait until the
985 * current execution finishes, introducing an unwanted dependency.
987 * This function checks the work item address and work function to avoid
988 * false positives. Note that this isn't complete as one may construct a
989 * work function which can introduce dependency onto itself through a
990 * recycled work item. Well, if somebody wants to shoot oneself in the
991 * foot that badly, there's only so much we can do, and if such deadlock
992 * actually occurs, it should be easy to locate the culprit work function.
994 * CONTEXT:
995 * spin_lock_irq(pool->lock).
997 * Return:
998 * Pointer to worker which is executing @work if found, %NULL
999 * otherwise.
1001 static struct worker *find_worker_executing_work(struct worker_pool *pool,
1002 struct work_struct *work)
1004 struct worker *worker;
1006 hash_for_each_possible(pool->busy_hash, worker, hentry,
1007 (unsigned long)work)
1008 if (worker->current_work == work &&
1009 worker->current_func == work->func)
1010 return worker;
1012 return NULL;
1016 * move_linked_works - move linked works to a list
1017 * @work: start of series of works to be scheduled
1018 * @head: target list to append @work to
1019 * @nextp: out parameter for nested worklist walking
1021 * Schedule linked works starting from @work to @head. Work series to
1022 * be scheduled starts at @work and includes any consecutive work with
1023 * WORK_STRUCT_LINKED set in its predecessor.
1025 * If @nextp is not NULL, it's updated to point to the next work of
1026 * the last scheduled work. This allows move_linked_works() to be
1027 * nested inside outer list_for_each_entry_safe().
1029 * CONTEXT:
1030 * spin_lock_irq(pool->lock).
1032 static void move_linked_works(struct work_struct *work, struct list_head *head,
1033 struct work_struct **nextp)
1035 struct work_struct *n;
1038 * Linked worklist will always end before the end of the list,
1039 * use NULL for list head.
1041 list_for_each_entry_safe_from(work, n, NULL, entry) {
1042 list_move_tail(&work->entry, head);
1043 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1044 break;
1048 * If we're already inside safe list traversal and have moved
1049 * multiple works to the scheduled queue, the next position
1050 * needs to be updated.
1052 if (nextp)
1053 *nextp = n;
1057 * get_pwq - get an extra reference on the specified pool_workqueue
1058 * @pwq: pool_workqueue to get
1060 * Obtain an extra reference on @pwq. The caller should guarantee that
1061 * @pwq has positive refcnt and be holding the matching pool->lock.
1063 static void get_pwq(struct pool_workqueue *pwq)
1065 lockdep_assert_held(&pwq->pool->lock);
1066 WARN_ON_ONCE(pwq->refcnt <= 0);
1067 pwq->refcnt++;
1071 * put_pwq - put a pool_workqueue reference
1072 * @pwq: pool_workqueue to put
1074 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1075 * destruction. The caller should be holding the matching pool->lock.
1077 static void put_pwq(struct pool_workqueue *pwq)
1079 lockdep_assert_held(&pwq->pool->lock);
1080 if (likely(--pwq->refcnt))
1081 return;
1082 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1083 return;
1085 * @pwq can't be released under pool->lock, bounce to
1086 * pwq_unbound_release_workfn(). This never recurses on the same
1087 * pool->lock as this path is taken only for unbound workqueues and
1088 * the release work item is scheduled on a per-cpu workqueue. To
1089 * avoid lockdep warning, unbound pool->locks are given lockdep
1090 * subclass of 1 in get_unbound_pool().
1092 schedule_work(&pwq->unbound_release_work);
1096 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1097 * @pwq: pool_workqueue to put (can be %NULL)
1099 * put_pwq() with locking. This function also allows %NULL @pwq.
1101 static void put_pwq_unlocked(struct pool_workqueue *pwq)
1103 if (pwq) {
1105 * As both pwqs and pools are sched-RCU protected, the
1106 * following lock operations are safe.
1108 spin_lock_irq(&pwq->pool->lock);
1109 put_pwq(pwq);
1110 spin_unlock_irq(&pwq->pool->lock);
1114 static void pwq_activate_delayed_work(struct work_struct *work)
1116 struct pool_workqueue *pwq = get_work_pwq(work);
1118 trace_workqueue_activate_work(work);
1119 if (list_empty(&pwq->pool->worklist))
1120 pwq->pool->watchdog_ts = jiffies;
1121 move_linked_works(work, &pwq->pool->worklist, NULL);
1122 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1123 pwq->nr_active++;
1126 static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
1128 struct work_struct *work = list_first_entry(&pwq->delayed_works,
1129 struct work_struct, entry);
1131 pwq_activate_delayed_work(work);
1135 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1136 * @pwq: pwq of interest
1137 * @color: color of work which left the queue
1139 * A work either has completed or is removed from pending queue,
1140 * decrement nr_in_flight of its pwq and handle workqueue flushing.
1142 * CONTEXT:
1143 * spin_lock_irq(pool->lock).
1145 static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1147 /* uncolored work items don't participate in flushing or nr_active */
1148 if (color == WORK_NO_COLOR)
1149 goto out_put;
1151 pwq->nr_in_flight[color]--;
1153 pwq->nr_active--;
1154 if (!list_empty(&pwq->delayed_works)) {
1155 /* one down, submit a delayed one */
1156 if (pwq->nr_active < pwq->max_active)
1157 pwq_activate_first_delayed(pwq);
1160 /* is flush in progress and are we at the flushing tip? */
1161 if (likely(pwq->flush_color != color))
1162 goto out_put;
1164 /* are there still in-flight works? */
1165 if (pwq->nr_in_flight[color])
1166 goto out_put;
1168 /* this pwq is done, clear flush_color */
1169 pwq->flush_color = -1;
1172 * If this was the last pwq, wake up the first flusher. It
1173 * will handle the rest.
1175 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1176 complete(&pwq->wq->first_flusher->done);
1177 out_put:
1178 put_pwq(pwq);
1182 * try_to_grab_pending - steal work item from worklist and disable irq
1183 * @work: work item to steal
1184 * @is_dwork: @work is a delayed_work
1185 * @flags: place to store irq state
1187 * Try to grab PENDING bit of @work. This function can handle @work in any
1188 * stable state - idle, on timer or on worklist.
1190 * Return:
1191 * 1 if @work was pending and we successfully stole PENDING
1192 * 0 if @work was idle and we claimed PENDING
1193 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
1194 * -ENOENT if someone else is canceling @work, this state may persist
1195 * for arbitrarily long
1197 * Note:
1198 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
1199 * interrupted while holding PENDING and @work off queue, irq must be
1200 * disabled on entry. This, combined with delayed_work->timer being
1201 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1203 * On successful return, >= 0, irq is disabled and the caller is
1204 * responsible for releasing it using local_irq_restore(*@flags).
1206 * This function is safe to call from any context including IRQ handler.
1208 static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1209 unsigned long *flags)
1211 struct worker_pool *pool;
1212 struct pool_workqueue *pwq;
1214 local_irq_save(*flags);
1216 /* try to steal the timer if it exists */
1217 if (is_dwork) {
1218 struct delayed_work *dwork = to_delayed_work(work);
1221 * dwork->timer is irqsafe. If del_timer() fails, it's
1222 * guaranteed that the timer is not queued anywhere and not
1223 * running on the local CPU.
1225 if (likely(del_timer(&dwork->timer)))
1226 return 1;
1229 /* try to claim PENDING the normal way */
1230 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1231 return 0;
1234 * The queueing is in progress, or it is already queued. Try to
1235 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1237 pool = get_work_pool(work);
1238 if (!pool)
1239 goto fail;
1241 spin_lock(&pool->lock);
1243 * work->data is guaranteed to point to pwq only while the work
1244 * item is queued on pwq->wq, and both updating work->data to point
1245 * to pwq on queueing and to pool on dequeueing are done under
1246 * pwq->pool->lock. This in turn guarantees that, if work->data
1247 * points to pwq which is associated with a locked pool, the work
1248 * item is currently queued on that pool.
1250 pwq = get_work_pwq(work);
1251 if (pwq && pwq->pool == pool) {
1252 debug_work_deactivate(work);
1255 * A delayed work item cannot be grabbed directly because
1256 * it might have linked NO_COLOR work items which, if left
1257 * on the delayed_list, will confuse pwq->nr_active
1258 * management later on and cause stall. Make sure the work
1259 * item is activated before grabbing.
1261 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1262 pwq_activate_delayed_work(work);
1264 list_del_init(&work->entry);
1265 pwq_dec_nr_in_flight(pwq, get_work_color(work));
1267 /* work->data points to pwq iff queued, point to pool */
1268 set_work_pool_and_keep_pending(work, pool->id);
1270 spin_unlock(&pool->lock);
1271 return 1;
1273 spin_unlock(&pool->lock);
1274 fail:
1275 local_irq_restore(*flags);
1276 if (work_is_canceling(work))
1277 return -ENOENT;
1278 cpu_relax();
1279 return -EAGAIN;
1283 * insert_work - insert a work into a pool
1284 * @pwq: pwq @work belongs to
1285 * @work: work to insert
1286 * @head: insertion point
1287 * @extra_flags: extra WORK_STRUCT_* flags to set
1289 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
1290 * work_struct flags.
1292 * CONTEXT:
1293 * spin_lock_irq(pool->lock).
1295 static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1296 struct list_head *head, unsigned int extra_flags)
1298 struct worker_pool *pool = pwq->pool;
1300 /* we own @work, set data and link */
1301 set_work_pwq(work, pwq, extra_flags);
1302 list_add_tail(&work->entry, head);
1303 get_pwq(pwq);
1306 * Ensure either wq_worker_sleeping() sees the above
1307 * list_add_tail() or we see zero nr_running to avoid workers lying
1308 * around lazily while there are works to be processed.
1310 smp_mb();
1312 if (__need_more_worker(pool))
1313 wake_up_worker(pool);
1317 * Test whether @work is being queued from another work executing on the
1318 * same workqueue.
1320 static bool is_chained_work(struct workqueue_struct *wq)
1322 struct worker *worker;
1324 worker = current_wq_worker();
1326 * Return %true iff I'm a worker execuing a work item on @wq. If
1327 * I'm @worker, it's safe to dereference it without locking.
1329 return worker && worker->current_pwq->wq == wq;
1333 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1334 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1335 * avoid perturbing sensitive tasks.
1337 static int wq_select_unbound_cpu(int cpu)
1339 static bool printed_dbg_warning;
1340 int new_cpu;
1342 if (likely(!wq_debug_force_rr_cpu)) {
1343 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1344 return cpu;
1345 } else if (!printed_dbg_warning) {
1346 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1347 printed_dbg_warning = true;
1350 if (cpumask_empty(wq_unbound_cpumask))
1351 return cpu;
1353 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1354 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1355 if (unlikely(new_cpu >= nr_cpu_ids)) {
1356 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1357 if (unlikely(new_cpu >= nr_cpu_ids))
1358 return cpu;
1360 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1362 return new_cpu;
1365 static void __queue_work(int cpu, struct workqueue_struct *wq,
1366 struct work_struct *work)
1368 struct pool_workqueue *pwq;
1369 struct worker_pool *last_pool;
1370 struct list_head *worklist;
1371 unsigned int work_flags;
1372 unsigned int req_cpu = cpu;
1375 * While a work item is PENDING && off queue, a task trying to
1376 * steal the PENDING will busy-loop waiting for it to either get
1377 * queued or lose PENDING. Grabbing PENDING and queueing should
1378 * happen with IRQ disabled.
1380 WARN_ON_ONCE(!irqs_disabled());
1382 debug_work_activate(work);
1384 /* if draining, only works from the same workqueue are allowed */
1385 if (unlikely(wq->flags & __WQ_DRAINING) &&
1386 WARN_ON_ONCE(!is_chained_work(wq)))
1387 return;
1388 retry:
1389 if (req_cpu == WORK_CPU_UNBOUND)
1390 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
1392 /* pwq which will be used unless @work is executing elsewhere */
1393 if (!(wq->flags & WQ_UNBOUND))
1394 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1395 else
1396 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1399 * If @work was previously on a different pool, it might still be
1400 * running there, in which case the work needs to be queued on that
1401 * pool to guarantee non-reentrancy.
1403 last_pool = get_work_pool(work);
1404 if (last_pool && last_pool != pwq->pool) {
1405 struct worker *worker;
1407 spin_lock(&last_pool->lock);
1409 worker = find_worker_executing_work(last_pool, work);
1411 if (worker && worker->current_pwq->wq == wq) {
1412 pwq = worker->current_pwq;
1413 } else {
1414 /* meh... not running there, queue here */
1415 spin_unlock(&last_pool->lock);
1416 spin_lock(&pwq->pool->lock);
1418 } else {
1419 spin_lock(&pwq->pool->lock);
1423 * pwq is determined and locked. For unbound pools, we could have
1424 * raced with pwq release and it could already be dead. If its
1425 * refcnt is zero, repeat pwq selection. Note that pwqs never die
1426 * without another pwq replacing it in the numa_pwq_tbl or while
1427 * work items are executing on it, so the retrying is guaranteed to
1428 * make forward-progress.
1430 if (unlikely(!pwq->refcnt)) {
1431 if (wq->flags & WQ_UNBOUND) {
1432 spin_unlock(&pwq->pool->lock);
1433 cpu_relax();
1434 goto retry;
1436 /* oops */
1437 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1438 wq->name, cpu);
1441 /* pwq determined, queue */
1442 trace_workqueue_queue_work(req_cpu, pwq, work);
1444 if (WARN_ON(!list_empty(&work->entry))) {
1445 spin_unlock(&pwq->pool->lock);
1446 return;
1449 pwq->nr_in_flight[pwq->work_color]++;
1450 work_flags = work_color_to_flags(pwq->work_color);
1452 if (likely(pwq->nr_active < pwq->max_active)) {
1453 trace_workqueue_activate_work(work);
1454 pwq->nr_active++;
1455 worklist = &pwq->pool->worklist;
1456 if (list_empty(worklist))
1457 pwq->pool->watchdog_ts = jiffies;
1458 } else {
1459 work_flags |= WORK_STRUCT_DELAYED;
1460 worklist = &pwq->delayed_works;
1463 insert_work(pwq, work, worklist, work_flags);
1465 spin_unlock(&pwq->pool->lock);
1469 * queue_work_on - queue work on specific cpu
1470 * @cpu: CPU number to execute work on
1471 * @wq: workqueue to use
1472 * @work: work to queue
1474 * We queue the work to a specific CPU, the caller must ensure it
1475 * can't go away.
1477 * Return: %false if @work was already on a queue, %true otherwise.
1479 bool queue_work_on(int cpu, struct workqueue_struct *wq,
1480 struct work_struct *work)
1482 bool ret = false;
1483 unsigned long flags;
1485 local_irq_save(flags);
1487 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1488 __queue_work(cpu, wq, work);
1489 ret = true;
1492 local_irq_restore(flags);
1493 return ret;
1495 EXPORT_SYMBOL(queue_work_on);
1497 void delayed_work_timer_fn(unsigned long __data)
1499 struct delayed_work *dwork = (struct delayed_work *)__data;
1501 /* should have been called from irqsafe timer with irq already off */
1502 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
1504 EXPORT_SYMBOL(delayed_work_timer_fn);
1506 static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1507 struct delayed_work *dwork, unsigned long delay)
1509 struct timer_list *timer = &dwork->timer;
1510 struct work_struct *work = &dwork->work;
1512 WARN_ON_ONCE(!wq);
1513 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1514 timer->data != (unsigned long)dwork);
1515 WARN_ON_ONCE(timer_pending(timer));
1516 WARN_ON_ONCE(!list_empty(&work->entry));
1519 * If @delay is 0, queue @dwork->work immediately. This is for
1520 * both optimization and correctness. The earliest @timer can
1521 * expire is on the closest next tick and delayed_work users depend
1522 * on that there's no such delay when @delay is 0.
1524 if (!delay) {
1525 __queue_work(cpu, wq, &dwork->work);
1526 return;
1529 dwork->wq = wq;
1530 dwork->cpu = cpu;
1531 timer->expires = jiffies + delay;
1533 if (unlikely(cpu != WORK_CPU_UNBOUND))
1534 add_timer_on(timer, cpu);
1535 else
1536 add_timer(timer);
1540 * queue_delayed_work_on - queue work on specific CPU after delay
1541 * @cpu: CPU number to execute work on
1542 * @wq: workqueue to use
1543 * @dwork: work to queue
1544 * @delay: number of jiffies to wait before queueing
1546 * Return: %false if @work was already on a queue, %true otherwise. If
1547 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1548 * execution.
1550 bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1551 struct delayed_work *dwork, unsigned long delay)
1553 struct work_struct *work = &dwork->work;
1554 bool ret = false;
1555 unsigned long flags;
1557 /* read the comment in __queue_work() */
1558 local_irq_save(flags);
1560 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1561 __queue_delayed_work(cpu, wq, dwork, delay);
1562 ret = true;
1565 local_irq_restore(flags);
1566 return ret;
1568 EXPORT_SYMBOL(queue_delayed_work_on);
1571 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1572 * @cpu: CPU number to execute work on
1573 * @wq: workqueue to use
1574 * @dwork: work to queue
1575 * @delay: number of jiffies to wait before queueing
1577 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1578 * modify @dwork's timer so that it expires after @delay. If @delay is
1579 * zero, @work is guaranteed to be scheduled immediately regardless of its
1580 * current state.
1582 * Return: %false if @dwork was idle and queued, %true if @dwork was
1583 * pending and its timer was modified.
1585 * This function is safe to call from any context including IRQ handler.
1586 * See try_to_grab_pending() for details.
1588 bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1589 struct delayed_work *dwork, unsigned long delay)
1591 unsigned long flags;
1592 int ret;
1594 do {
1595 ret = try_to_grab_pending(&dwork->work, true, &flags);
1596 } while (unlikely(ret == -EAGAIN));
1598 if (likely(ret >= 0)) {
1599 __queue_delayed_work(cpu, wq, dwork, delay);
1600 local_irq_restore(flags);
1603 /* -ENOENT from try_to_grab_pending() becomes %true */
1604 return ret;
1606 EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1609 * worker_enter_idle - enter idle state
1610 * @worker: worker which is entering idle state
1612 * @worker is entering idle state. Update stats and idle timer if
1613 * necessary.
1615 * LOCKING:
1616 * spin_lock_irq(pool->lock).
1618 static void worker_enter_idle(struct worker *worker)
1620 struct worker_pool *pool = worker->pool;
1622 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1623 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1624 (worker->hentry.next || worker->hentry.pprev)))
1625 return;
1627 /* can't use worker_set_flags(), also called from create_worker() */
1628 worker->flags |= WORKER_IDLE;
1629 pool->nr_idle++;
1630 worker->last_active = jiffies;
1632 /* idle_list is LIFO */
1633 list_add(&worker->entry, &pool->idle_list);
1635 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1636 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1639 * Sanity check nr_running. Because wq_unbind_fn() releases
1640 * pool->lock between setting %WORKER_UNBOUND and zapping
1641 * nr_running, the warning may trigger spuriously. Check iff
1642 * unbind is not in progress.
1644 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1645 pool->nr_workers == pool->nr_idle &&
1646 atomic_read(&pool->nr_running));
1650 * worker_leave_idle - leave idle state
1651 * @worker: worker which is leaving idle state
1653 * @worker is leaving idle state. Update stats.
1655 * LOCKING:
1656 * spin_lock_irq(pool->lock).
1658 static void worker_leave_idle(struct worker *worker)
1660 struct worker_pool *pool = worker->pool;
1662 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1663 return;
1664 worker_clr_flags(worker, WORKER_IDLE);
1665 pool->nr_idle--;
1666 list_del_init(&worker->entry);
1669 static struct worker *alloc_worker(int node)
1671 struct worker *worker;
1673 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
1674 if (worker) {
1675 INIT_LIST_HEAD(&worker->entry);
1676 INIT_LIST_HEAD(&worker->scheduled);
1677 INIT_LIST_HEAD(&worker->node);
1678 /* on creation a worker is in !idle && prep state */
1679 worker->flags = WORKER_PREP;
1681 return worker;
1685 * worker_attach_to_pool() - attach a worker to a pool
1686 * @worker: worker to be attached
1687 * @pool: the target pool
1689 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1690 * cpu-binding of @worker are kept coordinated with the pool across
1691 * cpu-[un]hotplugs.
1693 static void worker_attach_to_pool(struct worker *worker,
1694 struct worker_pool *pool)
1696 mutex_lock(&pool->attach_mutex);
1699 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1700 * online CPUs. It'll be re-applied when any of the CPUs come up.
1702 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1705 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1706 * stable across this function. See the comments above the
1707 * flag definition for details.
1709 if (pool->flags & POOL_DISASSOCIATED)
1710 worker->flags |= WORKER_UNBOUND;
1712 list_add_tail(&worker->node, &pool->workers);
1714 mutex_unlock(&pool->attach_mutex);
1718 * worker_detach_from_pool() - detach a worker from its pool
1719 * @worker: worker which is attached to its pool
1720 * @pool: the pool @worker is attached to
1722 * Undo the attaching which had been done in worker_attach_to_pool(). The
1723 * caller worker shouldn't access to the pool after detached except it has
1724 * other reference to the pool.
1726 static void worker_detach_from_pool(struct worker *worker,
1727 struct worker_pool *pool)
1729 struct completion *detach_completion = NULL;
1731 mutex_lock(&pool->attach_mutex);
1732 list_del(&worker->node);
1733 if (list_empty(&pool->workers))
1734 detach_completion = pool->detach_completion;
1735 mutex_unlock(&pool->attach_mutex);
1737 /* clear leftover flags without pool->lock after it is detached */
1738 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1740 if (detach_completion)
1741 complete(detach_completion);
1745 * create_worker - create a new workqueue worker
1746 * @pool: pool the new worker will belong to
1748 * Create and start a new worker which is attached to @pool.
1750 * CONTEXT:
1751 * Might sleep. Does GFP_KERNEL allocations.
1753 * Return:
1754 * Pointer to the newly created worker.
1756 static struct worker *create_worker(struct worker_pool *pool)
1758 struct worker *worker = NULL;
1759 int id = -1;
1760 char id_buf[16];
1762 /* ID is needed to determine kthread name */
1763 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
1764 if (id < 0)
1765 goto fail;
1767 worker = alloc_worker(pool->node);
1768 if (!worker)
1769 goto fail;
1771 worker->pool = pool;
1772 worker->id = id;
1774 if (pool->cpu >= 0)
1775 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1776 pool->attrs->nice < 0 ? "H" : "");
1777 else
1778 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1780 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1781 "kworker/%s", id_buf);
1782 if (IS_ERR(worker->task))
1783 goto fail;
1785 set_user_nice(worker->task, pool->attrs->nice);
1786 kthread_bind_mask(worker->task, pool->attrs->cpumask);
1788 /* successful, attach the worker to the pool */
1789 worker_attach_to_pool(worker, pool);
1791 /* start the newly created worker */
1792 spin_lock_irq(&pool->lock);
1793 worker->pool->nr_workers++;
1794 worker_enter_idle(worker);
1795 wake_up_process(worker->task);
1796 spin_unlock_irq(&pool->lock);
1798 return worker;
1800 fail:
1801 if (id >= 0)
1802 ida_simple_remove(&pool->worker_ida, id);
1803 kfree(worker);
1804 return NULL;
1808 * destroy_worker - destroy a workqueue worker
1809 * @worker: worker to be destroyed
1811 * Destroy @worker and adjust @pool stats accordingly. The worker should
1812 * be idle.
1814 * CONTEXT:
1815 * spin_lock_irq(pool->lock).
1817 static void destroy_worker(struct worker *worker)
1819 struct worker_pool *pool = worker->pool;
1821 lockdep_assert_held(&pool->lock);
1823 /* sanity check frenzy */
1824 if (WARN_ON(worker->current_work) ||
1825 WARN_ON(!list_empty(&worker->scheduled)) ||
1826 WARN_ON(!(worker->flags & WORKER_IDLE)))
1827 return;
1829 pool->nr_workers--;
1830 pool->nr_idle--;
1832 list_del_init(&worker->entry);
1833 worker->flags |= WORKER_DIE;
1834 wake_up_process(worker->task);
1837 static void idle_worker_timeout(unsigned long __pool)
1839 struct worker_pool *pool = (void *)__pool;
1841 spin_lock_irq(&pool->lock);
1843 while (too_many_workers(pool)) {
1844 struct worker *worker;
1845 unsigned long expires;
1847 /* idle_list is kept in LIFO order, check the last one */
1848 worker = list_entry(pool->idle_list.prev, struct worker, entry);
1849 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1851 if (time_before(jiffies, expires)) {
1852 mod_timer(&pool->idle_timer, expires);
1853 break;
1856 destroy_worker(worker);
1859 spin_unlock_irq(&pool->lock);
1862 static void send_mayday(struct work_struct *work)
1864 struct pool_workqueue *pwq = get_work_pwq(work);
1865 struct workqueue_struct *wq = pwq->wq;
1867 lockdep_assert_held(&wq_mayday_lock);
1869 if (!wq->rescuer)
1870 return;
1872 /* mayday mayday mayday */
1873 if (list_empty(&pwq->mayday_node)) {
1875 * If @pwq is for an unbound wq, its base ref may be put at
1876 * any time due to an attribute change. Pin @pwq until the
1877 * rescuer is done with it.
1879 get_pwq(pwq);
1880 list_add_tail(&pwq->mayday_node, &wq->maydays);
1881 wake_up_process(wq->rescuer->task);
1885 static void pool_mayday_timeout(unsigned long __pool)
1887 struct worker_pool *pool = (void *)__pool;
1888 struct work_struct *work;
1890 spin_lock_irq(&pool->lock);
1891 spin_lock(&wq_mayday_lock); /* for wq->maydays */
1893 if (need_to_create_worker(pool)) {
1895 * We've been trying to create a new worker but
1896 * haven't been successful. We might be hitting an
1897 * allocation deadlock. Send distress signals to
1898 * rescuers.
1900 list_for_each_entry(work, &pool->worklist, entry)
1901 send_mayday(work);
1904 spin_unlock(&wq_mayday_lock);
1905 spin_unlock_irq(&pool->lock);
1907 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1911 * maybe_create_worker - create a new worker if necessary
1912 * @pool: pool to create a new worker for
1914 * Create a new worker for @pool if necessary. @pool is guaranteed to
1915 * have at least one idle worker on return from this function. If
1916 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1917 * sent to all rescuers with works scheduled on @pool to resolve
1918 * possible allocation deadlock.
1920 * On return, need_to_create_worker() is guaranteed to be %false and
1921 * may_start_working() %true.
1923 * LOCKING:
1924 * spin_lock_irq(pool->lock) which may be released and regrabbed
1925 * multiple times. Does GFP_KERNEL allocations. Called only from
1926 * manager.
1928 static void maybe_create_worker(struct worker_pool *pool)
1929 __releases(&pool->lock)
1930 __acquires(&pool->lock)
1932 restart:
1933 spin_unlock_irq(&pool->lock);
1935 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1936 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1938 while (true) {
1939 if (create_worker(pool) || !need_to_create_worker(pool))
1940 break;
1942 schedule_timeout_interruptible(CREATE_COOLDOWN);
1944 if (!need_to_create_worker(pool))
1945 break;
1948 del_timer_sync(&pool->mayday_timer);
1949 spin_lock_irq(&pool->lock);
1951 * This is necessary even after a new worker was just successfully
1952 * created as @pool->lock was dropped and the new worker might have
1953 * already become busy.
1955 if (need_to_create_worker(pool))
1956 goto restart;
1960 * manage_workers - manage worker pool
1961 * @worker: self
1963 * Assume the manager role and manage the worker pool @worker belongs
1964 * to. At any given time, there can be only zero or one manager per
1965 * pool. The exclusion is handled automatically by this function.
1967 * The caller can safely start processing works on false return. On
1968 * true return, it's guaranteed that need_to_create_worker() is false
1969 * and may_start_working() is true.
1971 * CONTEXT:
1972 * spin_lock_irq(pool->lock) which may be released and regrabbed
1973 * multiple times. Does GFP_KERNEL allocations.
1975 * Return:
1976 * %false if the pool doesn't need management and the caller can safely
1977 * start processing works, %true if management function was performed and
1978 * the conditions that the caller verified before calling the function may
1979 * no longer be true.
1981 static bool manage_workers(struct worker *worker)
1983 struct worker_pool *pool = worker->pool;
1985 if (pool->flags & POOL_MANAGER_ACTIVE)
1986 return false;
1988 pool->flags |= POOL_MANAGER_ACTIVE;
1989 pool->manager = worker;
1991 maybe_create_worker(pool);
1993 pool->manager = NULL;
1994 pool->flags &= ~POOL_MANAGER_ACTIVE;
1995 wake_up(&wq_manager_wait);
1996 return true;
2000 * process_one_work - process single work
2001 * @worker: self
2002 * @work: work to process
2004 * Process @work. This function contains all the logics necessary to
2005 * process a single work including synchronization against and
2006 * interaction with other workers on the same cpu, queueing and
2007 * flushing. As long as context requirement is met, any worker can
2008 * call this function to process a work.
2010 * CONTEXT:
2011 * spin_lock_irq(pool->lock) which is released and regrabbed.
2013 static void process_one_work(struct worker *worker, struct work_struct *work)
2014 __releases(&pool->lock)
2015 __acquires(&pool->lock)
2017 struct pool_workqueue *pwq = get_work_pwq(work);
2018 struct worker_pool *pool = worker->pool;
2019 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
2020 int work_color;
2021 struct worker *collision;
2022 #ifdef CONFIG_LOCKDEP
2024 * It is permissible to free the struct work_struct from
2025 * inside the function that is called from it, this we need to
2026 * take into account for lockdep too. To avoid bogus "held
2027 * lock freed" warnings as well as problems when looking into
2028 * work->lockdep_map, make a copy and use that here.
2030 struct lockdep_map lockdep_map;
2032 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
2033 #endif
2034 /* ensure we're on the correct CPU */
2035 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
2036 raw_smp_processor_id() != pool->cpu);
2039 * A single work shouldn't be executed concurrently by
2040 * multiple workers on a single cpu. Check whether anyone is
2041 * already processing the work. If so, defer the work to the
2042 * currently executing one.
2044 collision = find_worker_executing_work(pool, work);
2045 if (unlikely(collision)) {
2046 move_linked_works(work, &collision->scheduled, NULL);
2047 return;
2050 /* claim and dequeue */
2051 debug_work_deactivate(work);
2052 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2053 worker->current_work = work;
2054 worker->current_func = work->func;
2055 worker->current_pwq = pwq;
2056 work_color = get_work_color(work);
2058 list_del_init(&work->entry);
2061 * CPU intensive works don't participate in concurrency management.
2062 * They're the scheduler's responsibility. This takes @worker out
2063 * of concurrency management and the next code block will chain
2064 * execution of the pending work items.
2066 if (unlikely(cpu_intensive))
2067 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
2070 * Wake up another worker if necessary. The condition is always
2071 * false for normal per-cpu workers since nr_running would always
2072 * be >= 1 at this point. This is used to chain execution of the
2073 * pending work items for WORKER_NOT_RUNNING workers such as the
2074 * UNBOUND and CPU_INTENSIVE ones.
2076 if (need_more_worker(pool))
2077 wake_up_worker(pool);
2080 * Record the last pool and clear PENDING which should be the last
2081 * update to @work. Also, do this inside @pool->lock so that
2082 * PENDING and queued state changes happen together while IRQ is
2083 * disabled.
2085 set_work_pool_and_clear_pending(work, pool->id);
2087 spin_unlock_irq(&pool->lock);
2089 lock_map_acquire(&pwq->wq->lockdep_map);
2090 lock_map_acquire(&lockdep_map);
2092 * Strictly speaking we should mark the invariant state without holding
2093 * any locks, that is, before these two lock_map_acquire()'s.
2095 * However, that would result in:
2097 * A(W1)
2098 * WFC(C)
2099 * A(W1)
2100 * C(C)
2102 * Which would create W1->C->W1 dependencies, even though there is no
2103 * actual deadlock possible. There are two solutions, using a
2104 * read-recursive acquire on the work(queue) 'locks', but this will then
2105 * hit the lockdep limitation on recursive locks, or simply discard
2106 * these locks.
2108 * AFAICT there is no possible deadlock scenario between the
2109 * flush_work() and complete() primitives (except for single-threaded
2110 * workqueues), so hiding them isn't a problem.
2112 lockdep_invariant_state(true);
2113 trace_workqueue_execute_start(work);
2114 worker->current_func(work);
2116 * While we must be careful to not use "work" after this, the trace
2117 * point will only record its address.
2119 trace_workqueue_execute_end(work);
2120 lock_map_release(&lockdep_map);
2121 lock_map_release(&pwq->wq->lockdep_map);
2123 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2124 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2125 " last function: %pf\n",
2126 current->comm, preempt_count(), task_pid_nr(current),
2127 worker->current_func);
2128 debug_show_held_locks(current);
2129 dump_stack();
2133 * The following prevents a kworker from hogging CPU on !PREEMPT
2134 * kernels, where a requeueing work item waiting for something to
2135 * happen could deadlock with stop_machine as such work item could
2136 * indefinitely requeue itself while all other CPUs are trapped in
2137 * stop_machine. At the same time, report a quiescent RCU state so
2138 * the same condition doesn't freeze RCU.
2140 cond_resched_rcu_qs();
2142 spin_lock_irq(&pool->lock);
2144 /* clear cpu intensive status */
2145 if (unlikely(cpu_intensive))
2146 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2148 /* we're done with it, release */
2149 hash_del(&worker->hentry);
2150 worker->current_work = NULL;
2151 worker->current_func = NULL;
2152 worker->current_pwq = NULL;
2153 worker->desc_valid = false;
2154 pwq_dec_nr_in_flight(pwq, work_color);
2158 * process_scheduled_works - process scheduled works
2159 * @worker: self
2161 * Process all scheduled works. Please note that the scheduled list
2162 * may change while processing a work, so this function repeatedly
2163 * fetches a work from the top and executes it.
2165 * CONTEXT:
2166 * spin_lock_irq(pool->lock) which may be released and regrabbed
2167 * multiple times.
2169 static void process_scheduled_works(struct worker *worker)
2171 while (!list_empty(&worker->scheduled)) {
2172 struct work_struct *work = list_first_entry(&worker->scheduled,
2173 struct work_struct, entry);
2174 process_one_work(worker, work);
2179 * worker_thread - the worker thread function
2180 * @__worker: self
2182 * The worker thread function. All workers belong to a worker_pool -
2183 * either a per-cpu one or dynamic unbound one. These workers process all
2184 * work items regardless of their specific target workqueue. The only
2185 * exception is work items which belong to workqueues with a rescuer which
2186 * will be explained in rescuer_thread().
2188 * Return: 0
2190 static int worker_thread(void *__worker)
2192 struct worker *worker = __worker;
2193 struct worker_pool *pool = worker->pool;
2195 /* tell the scheduler that this is a workqueue worker */
2196 worker->task->flags |= PF_WQ_WORKER;
2197 woke_up:
2198 spin_lock_irq(&pool->lock);
2200 /* am I supposed to die? */
2201 if (unlikely(worker->flags & WORKER_DIE)) {
2202 spin_unlock_irq(&pool->lock);
2203 WARN_ON_ONCE(!list_empty(&worker->entry));
2204 worker->task->flags &= ~PF_WQ_WORKER;
2206 set_task_comm(worker->task, "kworker/dying");
2207 ida_simple_remove(&pool->worker_ida, worker->id);
2208 worker_detach_from_pool(worker, pool);
2209 kfree(worker);
2210 return 0;
2213 worker_leave_idle(worker);
2214 recheck:
2215 /* no more worker necessary? */
2216 if (!need_more_worker(pool))
2217 goto sleep;
2219 /* do we need to manage? */
2220 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2221 goto recheck;
2224 * ->scheduled list can only be filled while a worker is
2225 * preparing to process a work or actually processing it.
2226 * Make sure nobody diddled with it while I was sleeping.
2228 WARN_ON_ONCE(!list_empty(&worker->scheduled));
2231 * Finish PREP stage. We're guaranteed to have at least one idle
2232 * worker or that someone else has already assumed the manager
2233 * role. This is where @worker starts participating in concurrency
2234 * management if applicable and concurrency management is restored
2235 * after being rebound. See rebind_workers() for details.
2237 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2239 do {
2240 struct work_struct *work =
2241 list_first_entry(&pool->worklist,
2242 struct work_struct, entry);
2244 pool->watchdog_ts = jiffies;
2246 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2247 /* optimization path, not strictly necessary */
2248 process_one_work(worker, work);
2249 if (unlikely(!list_empty(&worker->scheduled)))
2250 process_scheduled_works(worker);
2251 } else {
2252 move_linked_works(work, &worker->scheduled, NULL);
2253 process_scheduled_works(worker);
2255 } while (keep_working(pool));
2257 worker_set_flags(worker, WORKER_PREP);
2258 sleep:
2260 * pool->lock is held and there's no work to process and no need to
2261 * manage, sleep. Workers are woken up only while holding
2262 * pool->lock or from local cpu, so setting the current state
2263 * before releasing pool->lock is enough to prevent losing any
2264 * event.
2266 worker_enter_idle(worker);
2267 __set_current_state(TASK_IDLE);
2268 spin_unlock_irq(&pool->lock);
2269 schedule();
2270 goto woke_up;
2274 * rescuer_thread - the rescuer thread function
2275 * @__rescuer: self
2277 * Workqueue rescuer thread function. There's one rescuer for each
2278 * workqueue which has WQ_MEM_RECLAIM set.
2280 * Regular work processing on a pool may block trying to create a new
2281 * worker which uses GFP_KERNEL allocation which has slight chance of
2282 * developing into deadlock if some works currently on the same queue
2283 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2284 * the problem rescuer solves.
2286 * When such condition is possible, the pool summons rescuers of all
2287 * workqueues which have works queued on the pool and let them process
2288 * those works so that forward progress can be guaranteed.
2290 * This should happen rarely.
2292 * Return: 0
2294 static int rescuer_thread(void *__rescuer)
2296 struct worker *rescuer = __rescuer;
2297 struct workqueue_struct *wq = rescuer->rescue_wq;
2298 struct list_head *scheduled = &rescuer->scheduled;
2299 bool should_stop;
2301 set_user_nice(current, RESCUER_NICE_LEVEL);
2304 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2305 * doesn't participate in concurrency management.
2307 rescuer->task->flags |= PF_WQ_WORKER;
2308 repeat:
2309 set_current_state(TASK_IDLE);
2312 * By the time the rescuer is requested to stop, the workqueue
2313 * shouldn't have any work pending, but @wq->maydays may still have
2314 * pwq(s) queued. This can happen by non-rescuer workers consuming
2315 * all the work items before the rescuer got to them. Go through
2316 * @wq->maydays processing before acting on should_stop so that the
2317 * list is always empty on exit.
2319 should_stop = kthread_should_stop();
2321 /* see whether any pwq is asking for help */
2322 spin_lock_irq(&wq_mayday_lock);
2324 while (!list_empty(&wq->maydays)) {
2325 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2326 struct pool_workqueue, mayday_node);
2327 struct worker_pool *pool = pwq->pool;
2328 struct work_struct *work, *n;
2329 bool first = true;
2331 __set_current_state(TASK_RUNNING);
2332 list_del_init(&pwq->mayday_node);
2334 spin_unlock_irq(&wq_mayday_lock);
2336 worker_attach_to_pool(rescuer, pool);
2338 spin_lock_irq(&pool->lock);
2339 rescuer->pool = pool;
2342 * Slurp in all works issued via this workqueue and
2343 * process'em.
2345 WARN_ON_ONCE(!list_empty(scheduled));
2346 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2347 if (get_work_pwq(work) == pwq) {
2348 if (first)
2349 pool->watchdog_ts = jiffies;
2350 move_linked_works(work, scheduled, &n);
2352 first = false;
2355 if (!list_empty(scheduled)) {
2356 process_scheduled_works(rescuer);
2359 * The above execution of rescued work items could
2360 * have created more to rescue through
2361 * pwq_activate_first_delayed() or chained
2362 * queueing. Let's put @pwq back on mayday list so
2363 * that such back-to-back work items, which may be
2364 * being used to relieve memory pressure, don't
2365 * incur MAYDAY_INTERVAL delay inbetween.
2367 if (need_to_create_worker(pool)) {
2368 spin_lock(&wq_mayday_lock);
2369 get_pwq(pwq);
2370 list_move_tail(&pwq->mayday_node, &wq->maydays);
2371 spin_unlock(&wq_mayday_lock);
2376 * Put the reference grabbed by send_mayday(). @pool won't
2377 * go away while we're still attached to it.
2379 put_pwq(pwq);
2382 * Leave this pool. If need_more_worker() is %true, notify a
2383 * regular worker; otherwise, we end up with 0 concurrency
2384 * and stalling the execution.
2386 if (need_more_worker(pool))
2387 wake_up_worker(pool);
2389 rescuer->pool = NULL;
2390 spin_unlock_irq(&pool->lock);
2392 worker_detach_from_pool(rescuer, pool);
2394 spin_lock_irq(&wq_mayday_lock);
2397 spin_unlock_irq(&wq_mayday_lock);
2399 if (should_stop) {
2400 __set_current_state(TASK_RUNNING);
2401 rescuer->task->flags &= ~PF_WQ_WORKER;
2402 return 0;
2405 /* rescuers should never participate in concurrency management */
2406 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2407 schedule();
2408 goto repeat;
2412 * check_flush_dependency - check for flush dependency sanity
2413 * @target_wq: workqueue being flushed
2414 * @target_work: work item being flushed (NULL for workqueue flushes)
2416 * %current is trying to flush the whole @target_wq or @target_work on it.
2417 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2418 * reclaiming memory or running on a workqueue which doesn't have
2419 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2420 * a deadlock.
2422 static void check_flush_dependency(struct workqueue_struct *target_wq,
2423 struct work_struct *target_work)
2425 work_func_t target_func = target_work ? target_work->func : NULL;
2426 struct worker *worker;
2428 if (target_wq->flags & WQ_MEM_RECLAIM)
2429 return;
2431 worker = current_wq_worker();
2433 WARN_ONCE(current->flags & PF_MEMALLOC,
2434 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2435 current->pid, current->comm, target_wq->name, target_func);
2436 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2437 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
2438 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2439 worker->current_pwq->wq->name, worker->current_func,
2440 target_wq->name, target_func);
2443 struct wq_barrier {
2444 struct work_struct work;
2445 struct completion done;
2446 struct task_struct *task; /* purely informational */
2449 static void wq_barrier_func(struct work_struct *work)
2451 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2452 complete(&barr->done);
2456 * insert_wq_barrier - insert a barrier work
2457 * @pwq: pwq to insert barrier into
2458 * @barr: wq_barrier to insert
2459 * @target: target work to attach @barr to
2460 * @worker: worker currently executing @target, NULL if @target is not executing
2462 * @barr is linked to @target such that @barr is completed only after
2463 * @target finishes execution. Please note that the ordering
2464 * guarantee is observed only with respect to @target and on the local
2465 * cpu.
2467 * Currently, a queued barrier can't be canceled. This is because
2468 * try_to_grab_pending() can't determine whether the work to be
2469 * grabbed is at the head of the queue and thus can't clear LINKED
2470 * flag of the previous work while there must be a valid next work
2471 * after a work with LINKED flag set.
2473 * Note that when @worker is non-NULL, @target may be modified
2474 * underneath us, so we can't reliably determine pwq from @target.
2476 * CONTEXT:
2477 * spin_lock_irq(pool->lock).
2479 static void insert_wq_barrier(struct pool_workqueue *pwq,
2480 struct wq_barrier *barr,
2481 struct work_struct *target, struct worker *worker)
2483 struct list_head *head;
2484 unsigned int linked = 0;
2487 * debugobject calls are safe here even with pool->lock locked
2488 * as we know for sure that this will not trigger any of the
2489 * checks and call back into the fixup functions where we
2490 * might deadlock.
2492 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
2493 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2496 * Explicitly init the crosslock for wq_barrier::done, make its lock
2497 * key a subkey of the corresponding work. As a result we won't
2498 * build a dependency between wq_barrier::done and unrelated work.
2500 lockdep_init_map_crosslock((struct lockdep_map *)&barr->done.map,
2501 "(complete)wq_barr::done",
2502 target->lockdep_map.key, 1);
2503 __init_completion(&barr->done);
2504 barr->task = current;
2507 * If @target is currently being executed, schedule the
2508 * barrier to the worker; otherwise, put it after @target.
2510 if (worker)
2511 head = worker->scheduled.next;
2512 else {
2513 unsigned long *bits = work_data_bits(target);
2515 head = target->entry.next;
2516 /* there can already be other linked works, inherit and set */
2517 linked = *bits & WORK_STRUCT_LINKED;
2518 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2521 debug_work_activate(&barr->work);
2522 insert_work(pwq, &barr->work, head,
2523 work_color_to_flags(WORK_NO_COLOR) | linked);
2527 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
2528 * @wq: workqueue being flushed
2529 * @flush_color: new flush color, < 0 for no-op
2530 * @work_color: new work color, < 0 for no-op
2532 * Prepare pwqs for workqueue flushing.
2534 * If @flush_color is non-negative, flush_color on all pwqs should be
2535 * -1. If no pwq has in-flight commands at the specified color, all
2536 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2537 * has in flight commands, its pwq->flush_color is set to
2538 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
2539 * wakeup logic is armed and %true is returned.
2541 * The caller should have initialized @wq->first_flusher prior to
2542 * calling this function with non-negative @flush_color. If
2543 * @flush_color is negative, no flush color update is done and %false
2544 * is returned.
2546 * If @work_color is non-negative, all pwqs should have the same
2547 * work_color which is previous to @work_color and all will be
2548 * advanced to @work_color.
2550 * CONTEXT:
2551 * mutex_lock(wq->mutex).
2553 * Return:
2554 * %true if @flush_color >= 0 and there's something to flush. %false
2555 * otherwise.
2557 static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
2558 int flush_color, int work_color)
2560 bool wait = false;
2561 struct pool_workqueue *pwq;
2563 if (flush_color >= 0) {
2564 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2565 atomic_set(&wq->nr_pwqs_to_flush, 1);
2568 for_each_pwq(pwq, wq) {
2569 struct worker_pool *pool = pwq->pool;
2571 spin_lock_irq(&pool->lock);
2573 if (flush_color >= 0) {
2574 WARN_ON_ONCE(pwq->flush_color != -1);
2576 if (pwq->nr_in_flight[flush_color]) {
2577 pwq->flush_color = flush_color;
2578 atomic_inc(&wq->nr_pwqs_to_flush);
2579 wait = true;
2583 if (work_color >= 0) {
2584 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2585 pwq->work_color = work_color;
2588 spin_unlock_irq(&pool->lock);
2591 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
2592 complete(&wq->first_flusher->done);
2594 return wait;
2598 * flush_workqueue - ensure that any scheduled work has run to completion.
2599 * @wq: workqueue to flush
2601 * This function sleeps until all work items which were queued on entry
2602 * have finished execution, but it is not livelocked by new incoming ones.
2604 void flush_workqueue(struct workqueue_struct *wq)
2606 struct wq_flusher this_flusher = {
2607 .list = LIST_HEAD_INIT(this_flusher.list),
2608 .flush_color = -1,
2609 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2611 int next_color;
2613 if (WARN_ON(!wq_online))
2614 return;
2616 lock_map_acquire(&wq->lockdep_map);
2617 lock_map_release(&wq->lockdep_map);
2619 mutex_lock(&wq->mutex);
2622 * Start-to-wait phase
2624 next_color = work_next_color(wq->work_color);
2626 if (next_color != wq->flush_color) {
2628 * Color space is not full. The current work_color
2629 * becomes our flush_color and work_color is advanced
2630 * by one.
2632 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
2633 this_flusher.flush_color = wq->work_color;
2634 wq->work_color = next_color;
2636 if (!wq->first_flusher) {
2637 /* no flush in progress, become the first flusher */
2638 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
2640 wq->first_flusher = &this_flusher;
2642 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
2643 wq->work_color)) {
2644 /* nothing to flush, done */
2645 wq->flush_color = next_color;
2646 wq->first_flusher = NULL;
2647 goto out_unlock;
2649 } else {
2650 /* wait in queue */
2651 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
2652 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2653 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
2655 } else {
2657 * Oops, color space is full, wait on overflow queue.
2658 * The next flush completion will assign us
2659 * flush_color and transfer to flusher_queue.
2661 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2664 check_flush_dependency(wq, NULL);
2666 mutex_unlock(&wq->mutex);
2668 wait_for_completion(&this_flusher.done);
2671 * Wake-up-and-cascade phase
2673 * First flushers are responsible for cascading flushes and
2674 * handling overflow. Non-first flushers can simply return.
2676 if (wq->first_flusher != &this_flusher)
2677 return;
2679 mutex_lock(&wq->mutex);
2681 /* we might have raced, check again with mutex held */
2682 if (wq->first_flusher != &this_flusher)
2683 goto out_unlock;
2685 wq->first_flusher = NULL;
2687 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2688 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
2690 while (true) {
2691 struct wq_flusher *next, *tmp;
2693 /* complete all the flushers sharing the current flush color */
2694 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2695 if (next->flush_color != wq->flush_color)
2696 break;
2697 list_del_init(&next->list);
2698 complete(&next->done);
2701 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2702 wq->flush_color != work_next_color(wq->work_color));
2704 /* this flush_color is finished, advance by one */
2705 wq->flush_color = work_next_color(wq->flush_color);
2707 /* one color has been freed, handle overflow queue */
2708 if (!list_empty(&wq->flusher_overflow)) {
2710 * Assign the same color to all overflowed
2711 * flushers, advance work_color and append to
2712 * flusher_queue. This is the start-to-wait
2713 * phase for these overflowed flushers.
2715 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2716 tmp->flush_color = wq->work_color;
2718 wq->work_color = work_next_color(wq->work_color);
2720 list_splice_tail_init(&wq->flusher_overflow,
2721 &wq->flusher_queue);
2722 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
2725 if (list_empty(&wq->flusher_queue)) {
2726 WARN_ON_ONCE(wq->flush_color != wq->work_color);
2727 break;
2731 * Need to flush more colors. Make the next flusher
2732 * the new first flusher and arm pwqs.
2734 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2735 WARN_ON_ONCE(wq->flush_color != next->flush_color);
2737 list_del_init(&next->list);
2738 wq->first_flusher = next;
2740 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
2741 break;
2744 * Meh... this color is already done, clear first
2745 * flusher and repeat cascading.
2747 wq->first_flusher = NULL;
2750 out_unlock:
2751 mutex_unlock(&wq->mutex);
2753 EXPORT_SYMBOL(flush_workqueue);
2756 * drain_workqueue - drain a workqueue
2757 * @wq: workqueue to drain
2759 * Wait until the workqueue becomes empty. While draining is in progress,
2760 * only chain queueing is allowed. IOW, only currently pending or running
2761 * work items on @wq can queue further work items on it. @wq is flushed
2762 * repeatedly until it becomes empty. The number of flushing is determined
2763 * by the depth of chaining and should be relatively short. Whine if it
2764 * takes too long.
2766 void drain_workqueue(struct workqueue_struct *wq)
2768 unsigned int flush_cnt = 0;
2769 struct pool_workqueue *pwq;
2772 * __queue_work() needs to test whether there are drainers, is much
2773 * hotter than drain_workqueue() and already looks at @wq->flags.
2774 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
2776 mutex_lock(&wq->mutex);
2777 if (!wq->nr_drainers++)
2778 wq->flags |= __WQ_DRAINING;
2779 mutex_unlock(&wq->mutex);
2780 reflush:
2781 flush_workqueue(wq);
2783 mutex_lock(&wq->mutex);
2785 for_each_pwq(pwq, wq) {
2786 bool drained;
2788 spin_lock_irq(&pwq->pool->lock);
2789 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2790 spin_unlock_irq(&pwq->pool->lock);
2792 if (drained)
2793 continue;
2795 if (++flush_cnt == 10 ||
2796 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2797 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
2798 wq->name, flush_cnt);
2800 mutex_unlock(&wq->mutex);
2801 goto reflush;
2804 if (!--wq->nr_drainers)
2805 wq->flags &= ~__WQ_DRAINING;
2806 mutex_unlock(&wq->mutex);
2808 EXPORT_SYMBOL_GPL(drain_workqueue);
2810 static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2812 struct worker *worker = NULL;
2813 struct worker_pool *pool;
2814 struct pool_workqueue *pwq;
2816 might_sleep();
2818 local_irq_disable();
2819 pool = get_work_pool(work);
2820 if (!pool) {
2821 local_irq_enable();
2822 return false;
2825 spin_lock(&pool->lock);
2826 /* see the comment in try_to_grab_pending() with the same code */
2827 pwq = get_work_pwq(work);
2828 if (pwq) {
2829 if (unlikely(pwq->pool != pool))
2830 goto already_gone;
2831 } else {
2832 worker = find_worker_executing_work(pool, work);
2833 if (!worker)
2834 goto already_gone;
2835 pwq = worker->current_pwq;
2838 check_flush_dependency(pwq->wq, work);
2840 insert_wq_barrier(pwq, barr, work, worker);
2841 spin_unlock_irq(&pool->lock);
2844 * Force a lock recursion deadlock when using flush_work() inside a
2845 * single-threaded or rescuer equipped workqueue.
2847 * For single threaded workqueues the deadlock happens when the work
2848 * is after the work issuing the flush_work(). For rescuer equipped
2849 * workqueues the deadlock happens when the rescuer stalls, blocking
2850 * forward progress.
2852 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) {
2853 lock_map_acquire(&pwq->wq->lockdep_map);
2854 lock_map_release(&pwq->wq->lockdep_map);
2857 return true;
2858 already_gone:
2859 spin_unlock_irq(&pool->lock);
2860 return false;
2864 * flush_work - wait for a work to finish executing the last queueing instance
2865 * @work: the work to flush
2867 * Wait until @work has finished execution. @work is guaranteed to be idle
2868 * on return if it hasn't been requeued since flush started.
2870 * Return:
2871 * %true if flush_work() waited for the work to finish execution,
2872 * %false if it was already idle.
2874 bool flush_work(struct work_struct *work)
2876 struct wq_barrier barr;
2878 if (WARN_ON(!wq_online))
2879 return false;
2881 lock_map_acquire(&work->lockdep_map);
2882 lock_map_release(&work->lockdep_map);
2884 if (start_flush_work(work, &barr)) {
2885 wait_for_completion(&barr.done);
2886 destroy_work_on_stack(&barr.work);
2887 return true;
2888 } else {
2889 return false;
2892 EXPORT_SYMBOL_GPL(flush_work);
2894 struct cwt_wait {
2895 wait_queue_entry_t wait;
2896 struct work_struct *work;
2899 static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
2901 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2903 if (cwait->work != key)
2904 return 0;
2905 return autoremove_wake_function(wait, mode, sync, key);
2908 static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2910 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
2911 unsigned long flags;
2912 int ret;
2914 do {
2915 ret = try_to_grab_pending(work, is_dwork, &flags);
2917 * If someone else is already canceling, wait for it to
2918 * finish. flush_work() doesn't work for PREEMPT_NONE
2919 * because we may get scheduled between @work's completion
2920 * and the other canceling task resuming and clearing
2921 * CANCELING - flush_work() will return false immediately
2922 * as @work is no longer busy, try_to_grab_pending() will
2923 * return -ENOENT as @work is still being canceled and the
2924 * other canceling task won't be able to clear CANCELING as
2925 * we're hogging the CPU.
2927 * Let's wait for completion using a waitqueue. As this
2928 * may lead to the thundering herd problem, use a custom
2929 * wake function which matches @work along with exclusive
2930 * wait and wakeup.
2932 if (unlikely(ret == -ENOENT)) {
2933 struct cwt_wait cwait;
2935 init_wait(&cwait.wait);
2936 cwait.wait.func = cwt_wakefn;
2937 cwait.work = work;
2939 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
2940 TASK_UNINTERRUPTIBLE);
2941 if (work_is_canceling(work))
2942 schedule();
2943 finish_wait(&cancel_waitq, &cwait.wait);
2945 } while (unlikely(ret < 0));
2947 /* tell other tasks trying to grab @work to back off */
2948 mark_work_canceling(work);
2949 local_irq_restore(flags);
2952 * This allows canceling during early boot. We know that @work
2953 * isn't executing.
2955 if (wq_online)
2956 flush_work(work);
2958 clear_work_data(work);
2961 * Paired with prepare_to_wait() above so that either
2962 * waitqueue_active() is visible here or !work_is_canceling() is
2963 * visible there.
2965 smp_mb();
2966 if (waitqueue_active(&cancel_waitq))
2967 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
2969 return ret;
2973 * cancel_work_sync - cancel a work and wait for it to finish
2974 * @work: the work to cancel
2976 * Cancel @work and wait for its execution to finish. This function
2977 * can be used even if the work re-queues itself or migrates to
2978 * another workqueue. On return from this function, @work is
2979 * guaranteed to be not pending or executing on any CPU.
2981 * cancel_work_sync(&delayed_work->work) must not be used for
2982 * delayed_work's. Use cancel_delayed_work_sync() instead.
2984 * The caller must ensure that the workqueue on which @work was last
2985 * queued can't be destroyed before this function returns.
2987 * Return:
2988 * %true if @work was pending, %false otherwise.
2990 bool cancel_work_sync(struct work_struct *work)
2992 return __cancel_work_timer(work, false);
2994 EXPORT_SYMBOL_GPL(cancel_work_sync);
2997 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2998 * @dwork: the delayed work to flush
3000 * Delayed timer is cancelled and the pending work is queued for
3001 * immediate execution. Like flush_work(), this function only
3002 * considers the last queueing instance of @dwork.
3004 * Return:
3005 * %true if flush_work() waited for the work to finish execution,
3006 * %false if it was already idle.
3008 bool flush_delayed_work(struct delayed_work *dwork)
3010 local_irq_disable();
3011 if (del_timer_sync(&dwork->timer))
3012 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
3013 local_irq_enable();
3014 return flush_work(&dwork->work);
3016 EXPORT_SYMBOL(flush_delayed_work);
3018 static bool __cancel_work(struct work_struct *work, bool is_dwork)
3020 unsigned long flags;
3021 int ret;
3023 do {
3024 ret = try_to_grab_pending(work, is_dwork, &flags);
3025 } while (unlikely(ret == -EAGAIN));
3027 if (unlikely(ret < 0))
3028 return false;
3030 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3031 local_irq_restore(flags);
3032 return ret;
3036 * See cancel_delayed_work()
3038 bool cancel_work(struct work_struct *work)
3040 return __cancel_work(work, false);
3044 * cancel_delayed_work - cancel a delayed work
3045 * @dwork: delayed_work to cancel
3047 * Kill off a pending delayed_work.
3049 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3050 * pending.
3052 * Note:
3053 * The work callback function may still be running on return, unless
3054 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3055 * use cancel_delayed_work_sync() to wait on it.
3057 * This function is safe to call from any context including IRQ handler.
3059 bool cancel_delayed_work(struct delayed_work *dwork)
3061 return __cancel_work(&dwork->work, true);
3063 EXPORT_SYMBOL(cancel_delayed_work);
3066 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3067 * @dwork: the delayed work cancel
3069 * This is cancel_work_sync() for delayed works.
3071 * Return:
3072 * %true if @dwork was pending, %false otherwise.
3074 bool cancel_delayed_work_sync(struct delayed_work *dwork)
3076 return __cancel_work_timer(&dwork->work, true);
3078 EXPORT_SYMBOL(cancel_delayed_work_sync);
3081 * schedule_on_each_cpu - execute a function synchronously on each online CPU
3082 * @func: the function to call
3084 * schedule_on_each_cpu() executes @func on each online CPU using the
3085 * system workqueue and blocks until all CPUs have completed.
3086 * schedule_on_each_cpu() is very slow.
3088 * Return:
3089 * 0 on success, -errno on failure.
3091 int schedule_on_each_cpu(work_func_t func)
3093 int cpu;
3094 struct work_struct __percpu *works;
3096 works = alloc_percpu(struct work_struct);
3097 if (!works)
3098 return -ENOMEM;
3100 get_online_cpus();
3102 for_each_online_cpu(cpu) {
3103 struct work_struct *work = per_cpu_ptr(works, cpu);
3105 INIT_WORK(work, func);
3106 schedule_work_on(cpu, work);
3109 for_each_online_cpu(cpu)
3110 flush_work(per_cpu_ptr(works, cpu));
3112 put_online_cpus();
3113 free_percpu(works);
3114 return 0;
3118 * execute_in_process_context - reliably execute the routine with user context
3119 * @fn: the function to execute
3120 * @ew: guaranteed storage for the execute work structure (must
3121 * be available when the work executes)
3123 * Executes the function immediately if process context is available,
3124 * otherwise schedules the function for delayed execution.
3126 * Return: 0 - function was executed
3127 * 1 - function was scheduled for execution
3129 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
3131 if (!in_interrupt()) {
3132 fn(&ew->work);
3133 return 0;
3136 INIT_WORK(&ew->work, fn);
3137 schedule_work(&ew->work);
3139 return 1;
3141 EXPORT_SYMBOL_GPL(execute_in_process_context);
3144 * free_workqueue_attrs - free a workqueue_attrs
3145 * @attrs: workqueue_attrs to free
3147 * Undo alloc_workqueue_attrs().
3149 void free_workqueue_attrs(struct workqueue_attrs *attrs)
3151 if (attrs) {
3152 free_cpumask_var(attrs->cpumask);
3153 kfree(attrs);
3158 * alloc_workqueue_attrs - allocate a workqueue_attrs
3159 * @gfp_mask: allocation mask to use
3161 * Allocate a new workqueue_attrs, initialize with default settings and
3162 * return it.
3164 * Return: The allocated new workqueue_attr on success. %NULL on failure.
3166 struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3168 struct workqueue_attrs *attrs;
3170 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3171 if (!attrs)
3172 goto fail;
3173 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3174 goto fail;
3176 cpumask_copy(attrs->cpumask, cpu_possible_mask);
3177 return attrs;
3178 fail:
3179 free_workqueue_attrs(attrs);
3180 return NULL;
3183 static void copy_workqueue_attrs(struct workqueue_attrs *to,
3184 const struct workqueue_attrs *from)
3186 to->nice = from->nice;
3187 cpumask_copy(to->cpumask, from->cpumask);
3189 * Unlike hash and equality test, this function doesn't ignore
3190 * ->no_numa as it is used for both pool and wq attrs. Instead,
3191 * get_unbound_pool() explicitly clears ->no_numa after copying.
3193 to->no_numa = from->no_numa;
3196 /* hash value of the content of @attr */
3197 static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3199 u32 hash = 0;
3201 hash = jhash_1word(attrs->nice, hash);
3202 hash = jhash(cpumask_bits(attrs->cpumask),
3203 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
3204 return hash;
3207 /* content equality test */
3208 static bool wqattrs_equal(const struct workqueue_attrs *a,
3209 const struct workqueue_attrs *b)
3211 if (a->nice != b->nice)
3212 return false;
3213 if (!cpumask_equal(a->cpumask, b->cpumask))
3214 return false;
3215 return true;
3219 * init_worker_pool - initialize a newly zalloc'd worker_pool
3220 * @pool: worker_pool to initialize
3222 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
3224 * Return: 0 on success, -errno on failure. Even on failure, all fields
3225 * inside @pool proper are initialized and put_unbound_pool() can be called
3226 * on @pool safely to release it.
3228 static int init_worker_pool(struct worker_pool *pool)
3230 spin_lock_init(&pool->lock);
3231 pool->id = -1;
3232 pool->cpu = -1;
3233 pool->node = NUMA_NO_NODE;
3234 pool->flags |= POOL_DISASSOCIATED;
3235 pool->watchdog_ts = jiffies;
3236 INIT_LIST_HEAD(&pool->worklist);
3237 INIT_LIST_HEAD(&pool->idle_list);
3238 hash_init(pool->busy_hash);
3240 setup_deferrable_timer(&pool->idle_timer, idle_worker_timeout,
3241 (unsigned long)pool);
3243 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3244 (unsigned long)pool);
3246 mutex_init(&pool->attach_mutex);
3247 INIT_LIST_HEAD(&pool->workers);
3249 ida_init(&pool->worker_ida);
3250 INIT_HLIST_NODE(&pool->hash_node);
3251 pool->refcnt = 1;
3253 /* shouldn't fail above this point */
3254 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3255 if (!pool->attrs)
3256 return -ENOMEM;
3257 return 0;
3260 static void rcu_free_wq(struct rcu_head *rcu)
3262 struct workqueue_struct *wq =
3263 container_of(rcu, struct workqueue_struct, rcu);
3265 if (!(wq->flags & WQ_UNBOUND))
3266 free_percpu(wq->cpu_pwqs);
3267 else
3268 free_workqueue_attrs(wq->unbound_attrs);
3270 kfree(wq->rescuer);
3271 kfree(wq);
3274 static void rcu_free_pool(struct rcu_head *rcu)
3276 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3278 ida_destroy(&pool->worker_ida);
3279 free_workqueue_attrs(pool->attrs);
3280 kfree(pool);
3284 * put_unbound_pool - put a worker_pool
3285 * @pool: worker_pool to put
3287 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
3288 * safe manner. get_unbound_pool() calls this function on its failure path
3289 * and this function should be able to release pools which went through,
3290 * successfully or not, init_worker_pool().
3292 * Should be called with wq_pool_mutex held.
3294 static void put_unbound_pool(struct worker_pool *pool)
3296 DECLARE_COMPLETION_ONSTACK(detach_completion);
3297 struct worker *worker;
3299 lockdep_assert_held(&wq_pool_mutex);
3301 if (--pool->refcnt)
3302 return;
3304 /* sanity checks */
3305 if (WARN_ON(!(pool->cpu < 0)) ||
3306 WARN_ON(!list_empty(&pool->worklist)))
3307 return;
3309 /* release id and unhash */
3310 if (pool->id >= 0)
3311 idr_remove(&worker_pool_idr, pool->id);
3312 hash_del(&pool->hash_node);
3315 * Become the manager and destroy all workers. This prevents
3316 * @pool's workers from blocking on attach_mutex. We're the last
3317 * manager and @pool gets freed with the flag set.
3319 spin_lock_irq(&pool->lock);
3320 wait_event_lock_irq(wq_manager_wait,
3321 !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3322 pool->flags |= POOL_MANAGER_ACTIVE;
3324 while ((worker = first_idle_worker(pool)))
3325 destroy_worker(worker);
3326 WARN_ON(pool->nr_workers || pool->nr_idle);
3327 spin_unlock_irq(&pool->lock);
3329 mutex_lock(&pool->attach_mutex);
3330 if (!list_empty(&pool->workers))
3331 pool->detach_completion = &detach_completion;
3332 mutex_unlock(&pool->attach_mutex);
3334 if (pool->detach_completion)
3335 wait_for_completion(pool->detach_completion);
3337 /* shut down the timers */
3338 del_timer_sync(&pool->idle_timer);
3339 del_timer_sync(&pool->mayday_timer);
3341 /* sched-RCU protected to allow dereferences from get_work_pool() */
3342 call_rcu_sched(&pool->rcu, rcu_free_pool);
3346 * get_unbound_pool - get a worker_pool with the specified attributes
3347 * @attrs: the attributes of the worker_pool to get
3349 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3350 * reference count and return it. If there already is a matching
3351 * worker_pool, it will be used; otherwise, this function attempts to
3352 * create a new one.
3354 * Should be called with wq_pool_mutex held.
3356 * Return: On success, a worker_pool with the same attributes as @attrs.
3357 * On failure, %NULL.
3359 static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3361 u32 hash = wqattrs_hash(attrs);
3362 struct worker_pool *pool;
3363 int node;
3364 int target_node = NUMA_NO_NODE;
3366 lockdep_assert_held(&wq_pool_mutex);
3368 /* do we already have a matching pool? */
3369 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3370 if (wqattrs_equal(pool->attrs, attrs)) {
3371 pool->refcnt++;
3372 return pool;
3376 /* if cpumask is contained inside a NUMA node, we belong to that node */
3377 if (wq_numa_enabled) {
3378 for_each_node(node) {
3379 if (cpumask_subset(attrs->cpumask,
3380 wq_numa_possible_cpumask[node])) {
3381 target_node = node;
3382 break;
3387 /* nope, create a new one */
3388 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
3389 if (!pool || init_worker_pool(pool) < 0)
3390 goto fail;
3392 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
3393 copy_workqueue_attrs(pool->attrs, attrs);
3394 pool->node = target_node;
3397 * no_numa isn't a worker_pool attribute, always clear it. See
3398 * 'struct workqueue_attrs' comments for detail.
3400 pool->attrs->no_numa = false;
3402 if (worker_pool_assign_id(pool) < 0)
3403 goto fail;
3405 /* create and start the initial worker */
3406 if (wq_online && !create_worker(pool))
3407 goto fail;
3409 /* install */
3410 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3412 return pool;
3413 fail:
3414 if (pool)
3415 put_unbound_pool(pool);
3416 return NULL;
3419 static void rcu_free_pwq(struct rcu_head *rcu)
3421 kmem_cache_free(pwq_cache,
3422 container_of(rcu, struct pool_workqueue, rcu));
3426 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3427 * and needs to be destroyed.
3429 static void pwq_unbound_release_workfn(struct work_struct *work)
3431 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3432 unbound_release_work);
3433 struct workqueue_struct *wq = pwq->wq;
3434 struct worker_pool *pool = pwq->pool;
3435 bool is_last;
3437 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3438 return;
3440 mutex_lock(&wq->mutex);
3441 list_del_rcu(&pwq->pwqs_node);
3442 is_last = list_empty(&wq->pwqs);
3443 mutex_unlock(&wq->mutex);
3445 mutex_lock(&wq_pool_mutex);
3446 put_unbound_pool(pool);
3447 mutex_unlock(&wq_pool_mutex);
3449 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3452 * If we're the last pwq going away, @wq is already dead and no one
3453 * is gonna access it anymore. Schedule RCU free.
3455 if (is_last)
3456 call_rcu_sched(&wq->rcu, rcu_free_wq);
3460 * pwq_adjust_max_active - update a pwq's max_active to the current setting
3461 * @pwq: target pool_workqueue
3463 * If @pwq isn't freezing, set @pwq->max_active to the associated
3464 * workqueue's saved_max_active and activate delayed work items
3465 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
3467 static void pwq_adjust_max_active(struct pool_workqueue *pwq)
3469 struct workqueue_struct *wq = pwq->wq;
3470 bool freezable = wq->flags & WQ_FREEZABLE;
3471 unsigned long flags;
3473 /* for @wq->saved_max_active */
3474 lockdep_assert_held(&wq->mutex);
3476 /* fast exit for non-freezable wqs */
3477 if (!freezable && pwq->max_active == wq->saved_max_active)
3478 return;
3480 /* this function can be called during early boot w/ irq disabled */
3481 spin_lock_irqsave(&pwq->pool->lock, flags);
3484 * During [un]freezing, the caller is responsible for ensuring that
3485 * this function is called at least once after @workqueue_freezing
3486 * is updated and visible.
3488 if (!freezable || !workqueue_freezing) {
3489 pwq->max_active = wq->saved_max_active;
3491 while (!list_empty(&pwq->delayed_works) &&
3492 pwq->nr_active < pwq->max_active)
3493 pwq_activate_first_delayed(pwq);
3496 * Need to kick a worker after thawed or an unbound wq's
3497 * max_active is bumped. It's a slow path. Do it always.
3499 wake_up_worker(pwq->pool);
3500 } else {
3501 pwq->max_active = 0;
3504 spin_unlock_irqrestore(&pwq->pool->lock, flags);
3507 /* initialize newly alloced @pwq which is associated with @wq and @pool */
3508 static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3509 struct worker_pool *pool)
3511 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3513 memset(pwq, 0, sizeof(*pwq));
3515 pwq->pool = pool;
3516 pwq->wq = wq;
3517 pwq->flush_color = -1;
3518 pwq->refcnt = 1;
3519 INIT_LIST_HEAD(&pwq->delayed_works);
3520 INIT_LIST_HEAD(&pwq->pwqs_node);
3521 INIT_LIST_HEAD(&pwq->mayday_node);
3522 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3525 /* sync @pwq with the current state of its associated wq and link it */
3526 static void link_pwq(struct pool_workqueue *pwq)
3528 struct workqueue_struct *wq = pwq->wq;
3530 lockdep_assert_held(&wq->mutex);
3532 /* may be called multiple times, ignore if already linked */
3533 if (!list_empty(&pwq->pwqs_node))
3534 return;
3536 /* set the matching work_color */
3537 pwq->work_color = wq->work_color;
3539 /* sync max_active to the current setting */
3540 pwq_adjust_max_active(pwq);
3542 /* link in @pwq */
3543 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3546 /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3547 static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3548 const struct workqueue_attrs *attrs)
3550 struct worker_pool *pool;
3551 struct pool_workqueue *pwq;
3553 lockdep_assert_held(&wq_pool_mutex);
3555 pool = get_unbound_pool(attrs);
3556 if (!pool)
3557 return NULL;
3559 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3560 if (!pwq) {
3561 put_unbound_pool(pool);
3562 return NULL;
3565 init_pwq(pwq, wq, pool);
3566 return pwq;
3570 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
3571 * @attrs: the wq_attrs of the default pwq of the target workqueue
3572 * @node: the target NUMA node
3573 * @cpu_going_down: if >= 0, the CPU to consider as offline
3574 * @cpumask: outarg, the resulting cpumask
3576 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3577 * @cpu_going_down is >= 0, that cpu is considered offline during
3578 * calculation. The result is stored in @cpumask.
3580 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3581 * enabled and @node has online CPUs requested by @attrs, the returned
3582 * cpumask is the intersection of the possible CPUs of @node and
3583 * @attrs->cpumask.
3585 * The caller is responsible for ensuring that the cpumask of @node stays
3586 * stable.
3588 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3589 * %false if equal.
3591 static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3592 int cpu_going_down, cpumask_t *cpumask)
3594 if (!wq_numa_enabled || attrs->no_numa)
3595 goto use_dfl;
3597 /* does @node have any online CPUs @attrs wants? */
3598 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3599 if (cpu_going_down >= 0)
3600 cpumask_clear_cpu(cpu_going_down, cpumask);
3602 if (cpumask_empty(cpumask))
3603 goto use_dfl;
3605 /* yeap, return possible CPUs in @node that @attrs wants */
3606 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3608 if (cpumask_empty(cpumask)) {
3609 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3610 "possible intersect\n");
3611 return false;
3614 return !cpumask_equal(cpumask, attrs->cpumask);
3616 use_dfl:
3617 cpumask_copy(cpumask, attrs->cpumask);
3618 return false;
3621 /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3622 static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3623 int node,
3624 struct pool_workqueue *pwq)
3626 struct pool_workqueue *old_pwq;
3628 lockdep_assert_held(&wq_pool_mutex);
3629 lockdep_assert_held(&wq->mutex);
3631 /* link_pwq() can handle duplicate calls */
3632 link_pwq(pwq);
3634 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3635 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3636 return old_pwq;
3639 /* context to store the prepared attrs & pwqs before applying */
3640 struct apply_wqattrs_ctx {
3641 struct workqueue_struct *wq; /* target workqueue */
3642 struct workqueue_attrs *attrs; /* attrs to apply */
3643 struct list_head list; /* queued for batching commit */
3644 struct pool_workqueue *dfl_pwq;
3645 struct pool_workqueue *pwq_tbl[];
3648 /* free the resources after success or abort */
3649 static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3651 if (ctx) {
3652 int node;
3654 for_each_node(node)
3655 put_pwq_unlocked(ctx->pwq_tbl[node]);
3656 put_pwq_unlocked(ctx->dfl_pwq);
3658 free_workqueue_attrs(ctx->attrs);
3660 kfree(ctx);
3664 /* allocate the attrs and pwqs for later installation */
3665 static struct apply_wqattrs_ctx *
3666 apply_wqattrs_prepare(struct workqueue_struct *wq,
3667 const struct workqueue_attrs *attrs)
3669 struct apply_wqattrs_ctx *ctx;
3670 struct workqueue_attrs *new_attrs, *tmp_attrs;
3671 int node;
3673 lockdep_assert_held(&wq_pool_mutex);
3675 ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
3676 GFP_KERNEL);
3678 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3679 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3680 if (!ctx || !new_attrs || !tmp_attrs)
3681 goto out_free;
3684 * Calculate the attrs of the default pwq.
3685 * If the user configured cpumask doesn't overlap with the
3686 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3688 copy_workqueue_attrs(new_attrs, attrs);
3689 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
3690 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3691 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
3694 * We may create multiple pwqs with differing cpumasks. Make a
3695 * copy of @new_attrs which will be modified and used to obtain
3696 * pools.
3698 copy_workqueue_attrs(tmp_attrs, new_attrs);
3701 * If something goes wrong during CPU up/down, we'll fall back to
3702 * the default pwq covering whole @attrs->cpumask. Always create
3703 * it even if we don't use it immediately.
3705 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3706 if (!ctx->dfl_pwq)
3707 goto out_free;
3709 for_each_node(node) {
3710 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
3711 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3712 if (!ctx->pwq_tbl[node])
3713 goto out_free;
3714 } else {
3715 ctx->dfl_pwq->refcnt++;
3716 ctx->pwq_tbl[node] = ctx->dfl_pwq;
3720 /* save the user configured attrs and sanitize it. */
3721 copy_workqueue_attrs(new_attrs, attrs);
3722 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3723 ctx->attrs = new_attrs;
3725 ctx->wq = wq;
3726 free_workqueue_attrs(tmp_attrs);
3727 return ctx;
3729 out_free:
3730 free_workqueue_attrs(tmp_attrs);
3731 free_workqueue_attrs(new_attrs);
3732 apply_wqattrs_cleanup(ctx);
3733 return NULL;
3736 /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3737 static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3739 int node;
3741 /* all pwqs have been created successfully, let's install'em */
3742 mutex_lock(&ctx->wq->mutex);
3744 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
3746 /* save the previous pwq and install the new one */
3747 for_each_node(node)
3748 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
3749 ctx->pwq_tbl[node]);
3751 /* @dfl_pwq might not have been used, ensure it's linked */
3752 link_pwq(ctx->dfl_pwq);
3753 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
3755 mutex_unlock(&ctx->wq->mutex);
3758 static void apply_wqattrs_lock(void)
3760 /* CPUs should stay stable across pwq creations and installations */
3761 get_online_cpus();
3762 mutex_lock(&wq_pool_mutex);
3765 static void apply_wqattrs_unlock(void)
3767 mutex_unlock(&wq_pool_mutex);
3768 put_online_cpus();
3771 static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3772 const struct workqueue_attrs *attrs)
3774 struct apply_wqattrs_ctx *ctx;
3776 /* only unbound workqueues can change attributes */
3777 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3778 return -EINVAL;
3780 /* creating multiple pwqs breaks ordering guarantee */
3781 if (!list_empty(&wq->pwqs)) {
3782 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3783 return -EINVAL;
3785 wq->flags &= ~__WQ_ORDERED;
3788 ctx = apply_wqattrs_prepare(wq, attrs);
3789 if (!ctx)
3790 return -ENOMEM;
3792 /* the ctx has been prepared successfully, let's commit it */
3793 apply_wqattrs_commit(ctx);
3794 apply_wqattrs_cleanup(ctx);
3796 return 0;
3800 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3801 * @wq: the target workqueue
3802 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3804 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3805 * machines, this function maps a separate pwq to each NUMA node with
3806 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3807 * NUMA node it was issued on. Older pwqs are released as in-flight work
3808 * items finish. Note that a work item which repeatedly requeues itself
3809 * back-to-back will stay on its current pwq.
3811 * Performs GFP_KERNEL allocations.
3813 * Return: 0 on success and -errno on failure.
3815 int apply_workqueue_attrs(struct workqueue_struct *wq,
3816 const struct workqueue_attrs *attrs)
3818 int ret;
3820 apply_wqattrs_lock();
3821 ret = apply_workqueue_attrs_locked(wq, attrs);
3822 apply_wqattrs_unlock();
3824 return ret;
3828 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3829 * @wq: the target workqueue
3830 * @cpu: the CPU coming up or going down
3831 * @online: whether @cpu is coming up or going down
3833 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3834 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3835 * @wq accordingly.
3837 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3838 * falls back to @wq->dfl_pwq which may not be optimal but is always
3839 * correct.
3841 * Note that when the last allowed CPU of a NUMA node goes offline for a
3842 * workqueue with a cpumask spanning multiple nodes, the workers which were
3843 * already executing the work items for the workqueue will lose their CPU
3844 * affinity and may execute on any CPU. This is similar to how per-cpu
3845 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3846 * affinity, it's the user's responsibility to flush the work item from
3847 * CPU_DOWN_PREPARE.
3849 static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3850 bool online)
3852 int node = cpu_to_node(cpu);
3853 int cpu_off = online ? -1 : cpu;
3854 struct pool_workqueue *old_pwq = NULL, *pwq;
3855 struct workqueue_attrs *target_attrs;
3856 cpumask_t *cpumask;
3858 lockdep_assert_held(&wq_pool_mutex);
3860 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3861 wq->unbound_attrs->no_numa)
3862 return;
3865 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3866 * Let's use a preallocated one. The following buf is protected by
3867 * CPU hotplug exclusion.
3869 target_attrs = wq_update_unbound_numa_attrs_buf;
3870 cpumask = target_attrs->cpumask;
3872 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3873 pwq = unbound_pwq_by_node(wq, node);
3876 * Let's determine what needs to be done. If the target cpumask is
3877 * different from the default pwq's, we need to compare it to @pwq's
3878 * and create a new one if they don't match. If the target cpumask
3879 * equals the default pwq's, the default pwq should be used.
3881 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
3882 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
3883 return;
3884 } else {
3885 goto use_dfl_pwq;
3888 /* create a new pwq */
3889 pwq = alloc_unbound_pwq(wq, target_attrs);
3890 if (!pwq) {
3891 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3892 wq->name);
3893 goto use_dfl_pwq;
3896 /* Install the new pwq. */
3897 mutex_lock(&wq->mutex);
3898 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3899 goto out_unlock;
3901 use_dfl_pwq:
3902 mutex_lock(&wq->mutex);
3903 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3904 get_pwq(wq->dfl_pwq);
3905 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3906 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3907 out_unlock:
3908 mutex_unlock(&wq->mutex);
3909 put_pwq_unlocked(old_pwq);
3912 static int alloc_and_link_pwqs(struct workqueue_struct *wq)
3914 bool highpri = wq->flags & WQ_HIGHPRI;
3915 int cpu, ret;
3917 if (!(wq->flags & WQ_UNBOUND)) {
3918 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3919 if (!wq->cpu_pwqs)
3920 return -ENOMEM;
3922 for_each_possible_cpu(cpu) {
3923 struct pool_workqueue *pwq =
3924 per_cpu_ptr(wq->cpu_pwqs, cpu);
3925 struct worker_pool *cpu_pools =
3926 per_cpu(cpu_worker_pools, cpu);
3928 init_pwq(pwq, wq, &cpu_pools[highpri]);
3930 mutex_lock(&wq->mutex);
3931 link_pwq(pwq);
3932 mutex_unlock(&wq->mutex);
3934 return 0;
3935 } else if (wq->flags & __WQ_ORDERED) {
3936 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3937 /* there should only be single pwq for ordering guarantee */
3938 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3939 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3940 "ordering guarantee broken for workqueue %s\n", wq->name);
3941 return ret;
3942 } else {
3943 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
3947 static int wq_clamp_max_active(int max_active, unsigned int flags,
3948 const char *name)
3950 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3952 if (max_active < 1 || max_active > lim)
3953 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3954 max_active, name, 1, lim);
3956 return clamp_val(max_active, 1, lim);
3959 struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
3960 unsigned int flags,
3961 int max_active,
3962 struct lock_class_key *key,
3963 const char *lock_name, ...)
3965 size_t tbl_size = 0;
3966 va_list args;
3967 struct workqueue_struct *wq;
3968 struct pool_workqueue *pwq;
3971 * Unbound && max_active == 1 used to imply ordered, which is no
3972 * longer the case on NUMA machines due to per-node pools. While
3973 * alloc_ordered_workqueue() is the right way to create an ordered
3974 * workqueue, keep the previous behavior to avoid subtle breakages
3975 * on NUMA.
3977 if ((flags & WQ_UNBOUND) && max_active == 1)
3978 flags |= __WQ_ORDERED;
3980 /* see the comment above the definition of WQ_POWER_EFFICIENT */
3981 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3982 flags |= WQ_UNBOUND;
3984 /* allocate wq and format name */
3985 if (flags & WQ_UNBOUND)
3986 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
3988 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
3989 if (!wq)
3990 return NULL;
3992 if (flags & WQ_UNBOUND) {
3993 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3994 if (!wq->unbound_attrs)
3995 goto err_free_wq;
3998 va_start(args, lock_name);
3999 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4000 va_end(args);
4002 max_active = max_active ?: WQ_DFL_ACTIVE;
4003 max_active = wq_clamp_max_active(max_active, flags, wq->name);
4005 /* init wq */
4006 wq->flags = flags;
4007 wq->saved_max_active = max_active;
4008 mutex_init(&wq->mutex);
4009 atomic_set(&wq->nr_pwqs_to_flush, 0);
4010 INIT_LIST_HEAD(&wq->pwqs);
4011 INIT_LIST_HEAD(&wq->flusher_queue);
4012 INIT_LIST_HEAD(&wq->flusher_overflow);
4013 INIT_LIST_HEAD(&wq->maydays);
4015 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
4016 INIT_LIST_HEAD(&wq->list);
4018 if (alloc_and_link_pwqs(wq) < 0)
4019 goto err_free_wq;
4022 * Workqueues which may be used during memory reclaim should
4023 * have a rescuer to guarantee forward progress.
4025 if (flags & WQ_MEM_RECLAIM) {
4026 struct worker *rescuer;
4028 rescuer = alloc_worker(NUMA_NO_NODE);
4029 if (!rescuer)
4030 goto err_destroy;
4032 rescuer->rescue_wq = wq;
4033 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
4034 wq->name);
4035 if (IS_ERR(rescuer->task)) {
4036 kfree(rescuer);
4037 goto err_destroy;
4040 wq->rescuer = rescuer;
4041 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4042 wake_up_process(rescuer->task);
4045 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4046 goto err_destroy;
4049 * wq_pool_mutex protects global freeze state and workqueues list.
4050 * Grab it, adjust max_active and add the new @wq to workqueues
4051 * list.
4053 mutex_lock(&wq_pool_mutex);
4055 mutex_lock(&wq->mutex);
4056 for_each_pwq(pwq, wq)
4057 pwq_adjust_max_active(pwq);
4058 mutex_unlock(&wq->mutex);
4060 list_add_tail_rcu(&wq->list, &workqueues);
4062 mutex_unlock(&wq_pool_mutex);
4064 return wq;
4066 err_free_wq:
4067 free_workqueue_attrs(wq->unbound_attrs);
4068 kfree(wq);
4069 return NULL;
4070 err_destroy:
4071 destroy_workqueue(wq);
4072 return NULL;
4074 EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
4077 * destroy_workqueue - safely terminate a workqueue
4078 * @wq: target workqueue
4080 * Safely destroy a workqueue. All work currently pending will be done first.
4082 void destroy_workqueue(struct workqueue_struct *wq)
4084 struct pool_workqueue *pwq;
4085 int node;
4087 /* drain it before proceeding with destruction */
4088 drain_workqueue(wq);
4090 /* sanity checks */
4091 mutex_lock(&wq->mutex);
4092 for_each_pwq(pwq, wq) {
4093 int i;
4095 for (i = 0; i < WORK_NR_COLORS; i++) {
4096 if (WARN_ON(pwq->nr_in_flight[i])) {
4097 mutex_unlock(&wq->mutex);
4098 show_workqueue_state();
4099 return;
4103 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
4104 WARN_ON(pwq->nr_active) ||
4105 WARN_ON(!list_empty(&pwq->delayed_works))) {
4106 mutex_unlock(&wq->mutex);
4107 show_workqueue_state();
4108 return;
4111 mutex_unlock(&wq->mutex);
4114 * wq list is used to freeze wq, remove from list after
4115 * flushing is complete in case freeze races us.
4117 mutex_lock(&wq_pool_mutex);
4118 list_del_rcu(&wq->list);
4119 mutex_unlock(&wq_pool_mutex);
4121 workqueue_sysfs_unregister(wq);
4123 if (wq->rescuer)
4124 kthread_stop(wq->rescuer->task);
4126 if (!(wq->flags & WQ_UNBOUND)) {
4128 * The base ref is never dropped on per-cpu pwqs. Directly
4129 * schedule RCU free.
4131 call_rcu_sched(&wq->rcu, rcu_free_wq);
4132 } else {
4134 * We're the sole accessor of @wq at this point. Directly
4135 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4136 * @wq will be freed when the last pwq is released.
4138 for_each_node(node) {
4139 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4140 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4141 put_pwq_unlocked(pwq);
4145 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4146 * put. Don't access it afterwards.
4148 pwq = wq->dfl_pwq;
4149 wq->dfl_pwq = NULL;
4150 put_pwq_unlocked(pwq);
4153 EXPORT_SYMBOL_GPL(destroy_workqueue);
4156 * workqueue_set_max_active - adjust max_active of a workqueue
4157 * @wq: target workqueue
4158 * @max_active: new max_active value.
4160 * Set max_active of @wq to @max_active.
4162 * CONTEXT:
4163 * Don't call from IRQ context.
4165 void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4167 struct pool_workqueue *pwq;
4169 /* disallow meddling with max_active for ordered workqueues */
4170 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4171 return;
4173 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4175 mutex_lock(&wq->mutex);
4177 wq->flags &= ~__WQ_ORDERED;
4178 wq->saved_max_active = max_active;
4180 for_each_pwq(pwq, wq)
4181 pwq_adjust_max_active(pwq);
4183 mutex_unlock(&wq->mutex);
4185 EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4188 * current_work - retrieve %current task's work struct
4190 * Determine if %current task is a workqueue worker and what it's working on.
4191 * Useful to find out the context that the %current task is running in.
4193 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4195 struct work_struct *current_work(void)
4197 struct worker *worker = current_wq_worker();
4199 return worker ? worker->current_work : NULL;
4201 EXPORT_SYMBOL(current_work);
4204 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4206 * Determine whether %current is a workqueue rescuer. Can be used from
4207 * work functions to determine whether it's being run off the rescuer task.
4209 * Return: %true if %current is a workqueue rescuer. %false otherwise.
4211 bool current_is_workqueue_rescuer(void)
4213 struct worker *worker = current_wq_worker();
4215 return worker && worker->rescue_wq;
4219 * workqueue_congested - test whether a workqueue is congested
4220 * @cpu: CPU in question
4221 * @wq: target workqueue
4223 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4224 * no synchronization around this function and the test result is
4225 * unreliable and only useful as advisory hints or for debugging.
4227 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4228 * Note that both per-cpu and unbound workqueues may be associated with
4229 * multiple pool_workqueues which have separate congested states. A
4230 * workqueue being congested on one CPU doesn't mean the workqueue is also
4231 * contested on other CPUs / NUMA nodes.
4233 * Return:
4234 * %true if congested, %false otherwise.
4236 bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4238 struct pool_workqueue *pwq;
4239 bool ret;
4241 rcu_read_lock_sched();
4243 if (cpu == WORK_CPU_UNBOUND)
4244 cpu = smp_processor_id();
4246 if (!(wq->flags & WQ_UNBOUND))
4247 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4248 else
4249 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4251 ret = !list_empty(&pwq->delayed_works);
4252 rcu_read_unlock_sched();
4254 return ret;
4256 EXPORT_SYMBOL_GPL(workqueue_congested);
4259 * work_busy - test whether a work is currently pending or running
4260 * @work: the work to be tested
4262 * Test whether @work is currently pending or running. There is no
4263 * synchronization around this function and the test result is
4264 * unreliable and only useful as advisory hints or for debugging.
4266 * Return:
4267 * OR'd bitmask of WORK_BUSY_* bits.
4269 unsigned int work_busy(struct work_struct *work)
4271 struct worker_pool *pool;
4272 unsigned long flags;
4273 unsigned int ret = 0;
4275 if (work_pending(work))
4276 ret |= WORK_BUSY_PENDING;
4278 local_irq_save(flags);
4279 pool = get_work_pool(work);
4280 if (pool) {
4281 spin_lock(&pool->lock);
4282 if (find_worker_executing_work(pool, work))
4283 ret |= WORK_BUSY_RUNNING;
4284 spin_unlock(&pool->lock);
4286 local_irq_restore(flags);
4288 return ret;
4290 EXPORT_SYMBOL_GPL(work_busy);
4293 * set_worker_desc - set description for the current work item
4294 * @fmt: printf-style format string
4295 * @...: arguments for the format string
4297 * This function can be called by a running work function to describe what
4298 * the work item is about. If the worker task gets dumped, this
4299 * information will be printed out together to help debugging. The
4300 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4302 void set_worker_desc(const char *fmt, ...)
4304 struct worker *worker = current_wq_worker();
4305 va_list args;
4307 if (worker) {
4308 va_start(args, fmt);
4309 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4310 va_end(args);
4311 worker->desc_valid = true;
4316 * print_worker_info - print out worker information and description
4317 * @log_lvl: the log level to use when printing
4318 * @task: target task
4320 * If @task is a worker and currently executing a work item, print out the
4321 * name of the workqueue being serviced and worker description set with
4322 * set_worker_desc() by the currently executing work item.
4324 * This function can be safely called on any task as long as the
4325 * task_struct itself is accessible. While safe, this function isn't
4326 * synchronized and may print out mixups or garbages of limited length.
4328 void print_worker_info(const char *log_lvl, struct task_struct *task)
4330 work_func_t *fn = NULL;
4331 char name[WQ_NAME_LEN] = { };
4332 char desc[WORKER_DESC_LEN] = { };
4333 struct pool_workqueue *pwq = NULL;
4334 struct workqueue_struct *wq = NULL;
4335 bool desc_valid = false;
4336 struct worker *worker;
4338 if (!(task->flags & PF_WQ_WORKER))
4339 return;
4342 * This function is called without any synchronization and @task
4343 * could be in any state. Be careful with dereferences.
4345 worker = kthread_probe_data(task);
4348 * Carefully copy the associated workqueue's workfn and name. Keep
4349 * the original last '\0' in case the original contains garbage.
4351 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4352 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4353 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4354 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4356 /* copy worker description */
4357 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4358 if (desc_valid)
4359 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4361 if (fn || name[0] || desc[0]) {
4362 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4363 if (desc[0])
4364 pr_cont(" (%s)", desc);
4365 pr_cont("\n");
4369 static void pr_cont_pool_info(struct worker_pool *pool)
4371 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4372 if (pool->node != NUMA_NO_NODE)
4373 pr_cont(" node=%d", pool->node);
4374 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4377 static void pr_cont_work(bool comma, struct work_struct *work)
4379 if (work->func == wq_barrier_func) {
4380 struct wq_barrier *barr;
4382 barr = container_of(work, struct wq_barrier, work);
4384 pr_cont("%s BAR(%d)", comma ? "," : "",
4385 task_pid_nr(barr->task));
4386 } else {
4387 pr_cont("%s %pf", comma ? "," : "", work->func);
4391 static void show_pwq(struct pool_workqueue *pwq)
4393 struct worker_pool *pool = pwq->pool;
4394 struct work_struct *work;
4395 struct worker *worker;
4396 bool has_in_flight = false, has_pending = false;
4397 int bkt;
4399 pr_info(" pwq %d:", pool->id);
4400 pr_cont_pool_info(pool);
4402 pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
4403 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4405 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4406 if (worker->current_pwq == pwq) {
4407 has_in_flight = true;
4408 break;
4411 if (has_in_flight) {
4412 bool comma = false;
4414 pr_info(" in-flight:");
4415 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4416 if (worker->current_pwq != pwq)
4417 continue;
4419 pr_cont("%s %d%s:%pf", comma ? "," : "",
4420 task_pid_nr(worker->task),
4421 worker == pwq->wq->rescuer ? "(RESCUER)" : "",
4422 worker->current_func);
4423 list_for_each_entry(work, &worker->scheduled, entry)
4424 pr_cont_work(false, work);
4425 comma = true;
4427 pr_cont("\n");
4430 list_for_each_entry(work, &pool->worklist, entry) {
4431 if (get_work_pwq(work) == pwq) {
4432 has_pending = true;
4433 break;
4436 if (has_pending) {
4437 bool comma = false;
4439 pr_info(" pending:");
4440 list_for_each_entry(work, &pool->worklist, entry) {
4441 if (get_work_pwq(work) != pwq)
4442 continue;
4444 pr_cont_work(comma, work);
4445 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4447 pr_cont("\n");
4450 if (!list_empty(&pwq->delayed_works)) {
4451 bool comma = false;
4453 pr_info(" delayed:");
4454 list_for_each_entry(work, &pwq->delayed_works, entry) {
4455 pr_cont_work(comma, work);
4456 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4458 pr_cont("\n");
4463 * show_workqueue_state - dump workqueue state
4465 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4466 * all busy workqueues and pools.
4468 void show_workqueue_state(void)
4470 struct workqueue_struct *wq;
4471 struct worker_pool *pool;
4472 unsigned long flags;
4473 int pi;
4475 rcu_read_lock_sched();
4477 pr_info("Showing busy workqueues and worker pools:\n");
4479 list_for_each_entry_rcu(wq, &workqueues, list) {
4480 struct pool_workqueue *pwq;
4481 bool idle = true;
4483 for_each_pwq(pwq, wq) {
4484 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4485 idle = false;
4486 break;
4489 if (idle)
4490 continue;
4492 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4494 for_each_pwq(pwq, wq) {
4495 spin_lock_irqsave(&pwq->pool->lock, flags);
4496 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4497 show_pwq(pwq);
4498 spin_unlock_irqrestore(&pwq->pool->lock, flags);
4500 * We could be printing a lot from atomic context, e.g.
4501 * sysrq-t -> show_workqueue_state(). Avoid triggering
4502 * hard lockup.
4504 touch_nmi_watchdog();
4508 for_each_pool(pool, pi) {
4509 struct worker *worker;
4510 bool first = true;
4512 spin_lock_irqsave(&pool->lock, flags);
4513 if (pool->nr_workers == pool->nr_idle)
4514 goto next_pool;
4516 pr_info("pool %d:", pool->id);
4517 pr_cont_pool_info(pool);
4518 pr_cont(" hung=%us workers=%d",
4519 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4520 pool->nr_workers);
4521 if (pool->manager)
4522 pr_cont(" manager: %d",
4523 task_pid_nr(pool->manager->task));
4524 list_for_each_entry(worker, &pool->idle_list, entry) {
4525 pr_cont(" %s%d", first ? "idle: " : "",
4526 task_pid_nr(worker->task));
4527 first = false;
4529 pr_cont("\n");
4530 next_pool:
4531 spin_unlock_irqrestore(&pool->lock, flags);
4533 * We could be printing a lot from atomic context, e.g.
4534 * sysrq-t -> show_workqueue_state(). Avoid triggering
4535 * hard lockup.
4537 touch_nmi_watchdog();
4540 rcu_read_unlock_sched();
4544 * CPU hotplug.
4546 * There are two challenges in supporting CPU hotplug. Firstly, there
4547 * are a lot of assumptions on strong associations among work, pwq and
4548 * pool which make migrating pending and scheduled works very
4549 * difficult to implement without impacting hot paths. Secondly,
4550 * worker pools serve mix of short, long and very long running works making
4551 * blocked draining impractical.
4553 * This is solved by allowing the pools to be disassociated from the CPU
4554 * running as an unbound one and allowing it to be reattached later if the
4555 * cpu comes back online.
4558 static void wq_unbind_fn(struct work_struct *work)
4560 int cpu = smp_processor_id();
4561 struct worker_pool *pool;
4562 struct worker *worker;
4564 for_each_cpu_worker_pool(pool, cpu) {
4565 mutex_lock(&pool->attach_mutex);
4566 spin_lock_irq(&pool->lock);
4569 * We've blocked all attach/detach operations. Make all workers
4570 * unbound and set DISASSOCIATED. Before this, all workers
4571 * except for the ones which are still executing works from
4572 * before the last CPU down must be on the cpu. After
4573 * this, they may become diasporas.
4575 for_each_pool_worker(worker, pool)
4576 worker->flags |= WORKER_UNBOUND;
4578 pool->flags |= POOL_DISASSOCIATED;
4580 spin_unlock_irq(&pool->lock);
4581 mutex_unlock(&pool->attach_mutex);
4584 * Call schedule() so that we cross rq->lock and thus can
4585 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4586 * This is necessary as scheduler callbacks may be invoked
4587 * from other cpus.
4589 schedule();
4592 * Sched callbacks are disabled now. Zap nr_running.
4593 * After this, nr_running stays zero and need_more_worker()
4594 * and keep_working() are always true as long as the
4595 * worklist is not empty. This pool now behaves as an
4596 * unbound (in terms of concurrency management) pool which
4597 * are served by workers tied to the pool.
4599 atomic_set(&pool->nr_running, 0);
4602 * With concurrency management just turned off, a busy
4603 * worker blocking could lead to lengthy stalls. Kick off
4604 * unbound chain execution of currently pending work items.
4606 spin_lock_irq(&pool->lock);
4607 wake_up_worker(pool);
4608 spin_unlock_irq(&pool->lock);
4613 * rebind_workers - rebind all workers of a pool to the associated CPU
4614 * @pool: pool of interest
4616 * @pool->cpu is coming online. Rebind all workers to the CPU.
4618 static void rebind_workers(struct worker_pool *pool)
4620 struct worker *worker;
4622 lockdep_assert_held(&pool->attach_mutex);
4625 * Restore CPU affinity of all workers. As all idle workers should
4626 * be on the run-queue of the associated CPU before any local
4627 * wake-ups for concurrency management happen, restore CPU affinity
4628 * of all workers first and then clear UNBOUND. As we're called
4629 * from CPU_ONLINE, the following shouldn't fail.
4631 for_each_pool_worker(worker, pool)
4632 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4633 pool->attrs->cpumask) < 0);
4635 spin_lock_irq(&pool->lock);
4638 * XXX: CPU hotplug notifiers are weird and can call DOWN_FAILED
4639 * w/o preceding DOWN_PREPARE. Work around it. CPU hotplug is
4640 * being reworked and this can go away in time.
4642 if (!(pool->flags & POOL_DISASSOCIATED)) {
4643 spin_unlock_irq(&pool->lock);
4644 return;
4647 pool->flags &= ~POOL_DISASSOCIATED;
4649 for_each_pool_worker(worker, pool) {
4650 unsigned int worker_flags = worker->flags;
4653 * A bound idle worker should actually be on the runqueue
4654 * of the associated CPU for local wake-ups targeting it to
4655 * work. Kick all idle workers so that they migrate to the
4656 * associated CPU. Doing this in the same loop as
4657 * replacing UNBOUND with REBOUND is safe as no worker will
4658 * be bound before @pool->lock is released.
4660 if (worker_flags & WORKER_IDLE)
4661 wake_up_process(worker->task);
4664 * We want to clear UNBOUND but can't directly call
4665 * worker_clr_flags() or adjust nr_running. Atomically
4666 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4667 * @worker will clear REBOUND using worker_clr_flags() when
4668 * it initiates the next execution cycle thus restoring
4669 * concurrency management. Note that when or whether
4670 * @worker clears REBOUND doesn't affect correctness.
4672 * ACCESS_ONCE() is necessary because @worker->flags may be
4673 * tested without holding any lock in
4674 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4675 * fail incorrectly leading to premature concurrency
4676 * management operations.
4678 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4679 worker_flags |= WORKER_REBOUND;
4680 worker_flags &= ~WORKER_UNBOUND;
4681 ACCESS_ONCE(worker->flags) = worker_flags;
4684 spin_unlock_irq(&pool->lock);
4688 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4689 * @pool: unbound pool of interest
4690 * @cpu: the CPU which is coming up
4692 * An unbound pool may end up with a cpumask which doesn't have any online
4693 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4694 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4695 * online CPU before, cpus_allowed of all its workers should be restored.
4697 static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4699 static cpumask_t cpumask;
4700 struct worker *worker;
4702 lockdep_assert_held(&pool->attach_mutex);
4704 /* is @cpu allowed for @pool? */
4705 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4706 return;
4708 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4710 /* as we're called from CPU_ONLINE, the following shouldn't fail */
4711 for_each_pool_worker(worker, pool)
4712 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
4715 int workqueue_prepare_cpu(unsigned int cpu)
4717 struct worker_pool *pool;
4719 for_each_cpu_worker_pool(pool, cpu) {
4720 if (pool->nr_workers)
4721 continue;
4722 if (!create_worker(pool))
4723 return -ENOMEM;
4725 return 0;
4728 int workqueue_online_cpu(unsigned int cpu)
4730 struct worker_pool *pool;
4731 struct workqueue_struct *wq;
4732 int pi;
4734 mutex_lock(&wq_pool_mutex);
4736 for_each_pool(pool, pi) {
4737 mutex_lock(&pool->attach_mutex);
4739 if (pool->cpu == cpu)
4740 rebind_workers(pool);
4741 else if (pool->cpu < 0)
4742 restore_unbound_workers_cpumask(pool, cpu);
4744 mutex_unlock(&pool->attach_mutex);
4747 /* update NUMA affinity of unbound workqueues */
4748 list_for_each_entry(wq, &workqueues, list)
4749 wq_update_unbound_numa(wq, cpu, true);
4751 mutex_unlock(&wq_pool_mutex);
4752 return 0;
4755 int workqueue_offline_cpu(unsigned int cpu)
4757 struct work_struct unbind_work;
4758 struct workqueue_struct *wq;
4760 /* unbinding per-cpu workers should happen on the local CPU */
4761 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
4762 queue_work_on(cpu, system_highpri_wq, &unbind_work);
4764 /* update NUMA affinity of unbound workqueues */
4765 mutex_lock(&wq_pool_mutex);
4766 list_for_each_entry(wq, &workqueues, list)
4767 wq_update_unbound_numa(wq, cpu, false);
4768 mutex_unlock(&wq_pool_mutex);
4770 /* wait for per-cpu unbinding to finish */
4771 flush_work(&unbind_work);
4772 destroy_work_on_stack(&unbind_work);
4773 return 0;
4776 #ifdef CONFIG_SMP
4778 struct work_for_cpu {
4779 struct work_struct work;
4780 long (*fn)(void *);
4781 void *arg;
4782 long ret;
4785 static void work_for_cpu_fn(struct work_struct *work)
4787 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4789 wfc->ret = wfc->fn(wfc->arg);
4793 * work_on_cpu - run a function in thread context on a particular cpu
4794 * @cpu: the cpu to run on
4795 * @fn: the function to run
4796 * @arg: the function arg
4798 * It is up to the caller to ensure that the cpu doesn't go offline.
4799 * The caller must not hold any locks which would prevent @fn from completing.
4801 * Return: The value @fn returns.
4803 long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
4805 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
4807 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4808 schedule_work_on(cpu, &wfc.work);
4809 flush_work(&wfc.work);
4810 destroy_work_on_stack(&wfc.work);
4811 return wfc.ret;
4813 EXPORT_SYMBOL_GPL(work_on_cpu);
4816 * work_on_cpu_safe - run a function in thread context on a particular cpu
4817 * @cpu: the cpu to run on
4818 * @fn: the function to run
4819 * @arg: the function argument
4821 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4822 * any locks which would prevent @fn from completing.
4824 * Return: The value @fn returns.
4826 long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
4828 long ret = -ENODEV;
4830 get_online_cpus();
4831 if (cpu_online(cpu))
4832 ret = work_on_cpu(cpu, fn, arg);
4833 put_online_cpus();
4834 return ret;
4836 EXPORT_SYMBOL_GPL(work_on_cpu_safe);
4837 #endif /* CONFIG_SMP */
4839 #ifdef CONFIG_FREEZER
4842 * freeze_workqueues_begin - begin freezing workqueues
4844 * Start freezing workqueues. After this function returns, all freezable
4845 * workqueues will queue new works to their delayed_works list instead of
4846 * pool->worklist.
4848 * CONTEXT:
4849 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4851 void freeze_workqueues_begin(void)
4853 struct workqueue_struct *wq;
4854 struct pool_workqueue *pwq;
4856 mutex_lock(&wq_pool_mutex);
4858 WARN_ON_ONCE(workqueue_freezing);
4859 workqueue_freezing = true;
4861 list_for_each_entry(wq, &workqueues, list) {
4862 mutex_lock(&wq->mutex);
4863 for_each_pwq(pwq, wq)
4864 pwq_adjust_max_active(pwq);
4865 mutex_unlock(&wq->mutex);
4868 mutex_unlock(&wq_pool_mutex);
4872 * freeze_workqueues_busy - are freezable workqueues still busy?
4874 * Check whether freezing is complete. This function must be called
4875 * between freeze_workqueues_begin() and thaw_workqueues().
4877 * CONTEXT:
4878 * Grabs and releases wq_pool_mutex.
4880 * Return:
4881 * %true if some freezable workqueues are still busy. %false if freezing
4882 * is complete.
4884 bool freeze_workqueues_busy(void)
4886 bool busy = false;
4887 struct workqueue_struct *wq;
4888 struct pool_workqueue *pwq;
4890 mutex_lock(&wq_pool_mutex);
4892 WARN_ON_ONCE(!workqueue_freezing);
4894 list_for_each_entry(wq, &workqueues, list) {
4895 if (!(wq->flags & WQ_FREEZABLE))
4896 continue;
4898 * nr_active is monotonically decreasing. It's safe
4899 * to peek without lock.
4901 rcu_read_lock_sched();
4902 for_each_pwq(pwq, wq) {
4903 WARN_ON_ONCE(pwq->nr_active < 0);
4904 if (pwq->nr_active) {
4905 busy = true;
4906 rcu_read_unlock_sched();
4907 goto out_unlock;
4910 rcu_read_unlock_sched();
4912 out_unlock:
4913 mutex_unlock(&wq_pool_mutex);
4914 return busy;
4918 * thaw_workqueues - thaw workqueues
4920 * Thaw workqueues. Normal queueing is restored and all collected
4921 * frozen works are transferred to their respective pool worklists.
4923 * CONTEXT:
4924 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4926 void thaw_workqueues(void)
4928 struct workqueue_struct *wq;
4929 struct pool_workqueue *pwq;
4931 mutex_lock(&wq_pool_mutex);
4933 if (!workqueue_freezing)
4934 goto out_unlock;
4936 workqueue_freezing = false;
4938 /* restore max_active and repopulate worklist */
4939 list_for_each_entry(wq, &workqueues, list) {
4940 mutex_lock(&wq->mutex);
4941 for_each_pwq(pwq, wq)
4942 pwq_adjust_max_active(pwq);
4943 mutex_unlock(&wq->mutex);
4946 out_unlock:
4947 mutex_unlock(&wq_pool_mutex);
4949 #endif /* CONFIG_FREEZER */
4951 static int workqueue_apply_unbound_cpumask(void)
4953 LIST_HEAD(ctxs);
4954 int ret = 0;
4955 struct workqueue_struct *wq;
4956 struct apply_wqattrs_ctx *ctx, *n;
4958 lockdep_assert_held(&wq_pool_mutex);
4960 list_for_each_entry(wq, &workqueues, list) {
4961 if (!(wq->flags & WQ_UNBOUND))
4962 continue;
4963 /* creating multiple pwqs breaks ordering guarantee */
4964 if (wq->flags & __WQ_ORDERED)
4965 continue;
4967 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4968 if (!ctx) {
4969 ret = -ENOMEM;
4970 break;
4973 list_add_tail(&ctx->list, &ctxs);
4976 list_for_each_entry_safe(ctx, n, &ctxs, list) {
4977 if (!ret)
4978 apply_wqattrs_commit(ctx);
4979 apply_wqattrs_cleanup(ctx);
4982 return ret;
4986 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4987 * @cpumask: the cpumask to set
4989 * The low-level workqueues cpumask is a global cpumask that limits
4990 * the affinity of all unbound workqueues. This function check the @cpumask
4991 * and apply it to all unbound workqueues and updates all pwqs of them.
4993 * Retun: 0 - Success
4994 * -EINVAL - Invalid @cpumask
4995 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
4997 int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4999 int ret = -EINVAL;
5000 cpumask_var_t saved_cpumask;
5002 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5003 return -ENOMEM;
5005 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5006 if (!cpumask_empty(cpumask)) {
5007 apply_wqattrs_lock();
5009 /* save the old wq_unbound_cpumask. */
5010 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5012 /* update wq_unbound_cpumask at first and apply it to wqs. */
5013 cpumask_copy(wq_unbound_cpumask, cpumask);
5014 ret = workqueue_apply_unbound_cpumask();
5016 /* restore the wq_unbound_cpumask when failed. */
5017 if (ret < 0)
5018 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5020 apply_wqattrs_unlock();
5023 free_cpumask_var(saved_cpumask);
5024 return ret;
5027 #ifdef CONFIG_SYSFS
5029 * Workqueues with WQ_SYSFS flag set is visible to userland via
5030 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5031 * following attributes.
5033 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5034 * max_active RW int : maximum number of in-flight work items
5036 * Unbound workqueues have the following extra attributes.
5038 * id RO int : the associated pool ID
5039 * nice RW int : nice value of the workers
5040 * cpumask RW mask : bitmask of allowed CPUs for the workers
5042 struct wq_device {
5043 struct workqueue_struct *wq;
5044 struct device dev;
5047 static struct workqueue_struct *dev_to_wq(struct device *dev)
5049 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5051 return wq_dev->wq;
5054 static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5055 char *buf)
5057 struct workqueue_struct *wq = dev_to_wq(dev);
5059 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5061 static DEVICE_ATTR_RO(per_cpu);
5063 static ssize_t max_active_show(struct device *dev,
5064 struct device_attribute *attr, char *buf)
5066 struct workqueue_struct *wq = dev_to_wq(dev);
5068 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5071 static ssize_t max_active_store(struct device *dev,
5072 struct device_attribute *attr, const char *buf,
5073 size_t count)
5075 struct workqueue_struct *wq = dev_to_wq(dev);
5076 int val;
5078 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5079 return -EINVAL;
5081 workqueue_set_max_active(wq, val);
5082 return count;
5084 static DEVICE_ATTR_RW(max_active);
5086 static struct attribute *wq_sysfs_attrs[] = {
5087 &dev_attr_per_cpu.attr,
5088 &dev_attr_max_active.attr,
5089 NULL,
5091 ATTRIBUTE_GROUPS(wq_sysfs);
5093 static ssize_t wq_pool_ids_show(struct device *dev,
5094 struct device_attribute *attr, char *buf)
5096 struct workqueue_struct *wq = dev_to_wq(dev);
5097 const char *delim = "";
5098 int node, written = 0;
5100 rcu_read_lock_sched();
5101 for_each_node(node) {
5102 written += scnprintf(buf + written, PAGE_SIZE - written,
5103 "%s%d:%d", delim, node,
5104 unbound_pwq_by_node(wq, node)->pool->id);
5105 delim = " ";
5107 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5108 rcu_read_unlock_sched();
5110 return written;
5113 static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5114 char *buf)
5116 struct workqueue_struct *wq = dev_to_wq(dev);
5117 int written;
5119 mutex_lock(&wq->mutex);
5120 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5121 mutex_unlock(&wq->mutex);
5123 return written;
5126 /* prepare workqueue_attrs for sysfs store operations */
5127 static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5129 struct workqueue_attrs *attrs;
5131 lockdep_assert_held(&wq_pool_mutex);
5133 attrs = alloc_workqueue_attrs(GFP_KERNEL);
5134 if (!attrs)
5135 return NULL;
5137 copy_workqueue_attrs(attrs, wq->unbound_attrs);
5138 return attrs;
5141 static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5142 const char *buf, size_t count)
5144 struct workqueue_struct *wq = dev_to_wq(dev);
5145 struct workqueue_attrs *attrs;
5146 int ret = -ENOMEM;
5148 apply_wqattrs_lock();
5150 attrs = wq_sysfs_prep_attrs(wq);
5151 if (!attrs)
5152 goto out_unlock;
5154 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5155 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
5156 ret = apply_workqueue_attrs_locked(wq, attrs);
5157 else
5158 ret = -EINVAL;
5160 out_unlock:
5161 apply_wqattrs_unlock();
5162 free_workqueue_attrs(attrs);
5163 return ret ?: count;
5166 static ssize_t wq_cpumask_show(struct device *dev,
5167 struct device_attribute *attr, char *buf)
5169 struct workqueue_struct *wq = dev_to_wq(dev);
5170 int written;
5172 mutex_lock(&wq->mutex);
5173 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5174 cpumask_pr_args(wq->unbound_attrs->cpumask));
5175 mutex_unlock(&wq->mutex);
5176 return written;
5179 static ssize_t wq_cpumask_store(struct device *dev,
5180 struct device_attribute *attr,
5181 const char *buf, size_t count)
5183 struct workqueue_struct *wq = dev_to_wq(dev);
5184 struct workqueue_attrs *attrs;
5185 int ret = -ENOMEM;
5187 apply_wqattrs_lock();
5189 attrs = wq_sysfs_prep_attrs(wq);
5190 if (!attrs)
5191 goto out_unlock;
5193 ret = cpumask_parse(buf, attrs->cpumask);
5194 if (!ret)
5195 ret = apply_workqueue_attrs_locked(wq, attrs);
5197 out_unlock:
5198 apply_wqattrs_unlock();
5199 free_workqueue_attrs(attrs);
5200 return ret ?: count;
5203 static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5204 char *buf)
5206 struct workqueue_struct *wq = dev_to_wq(dev);
5207 int written;
5209 mutex_lock(&wq->mutex);
5210 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5211 !wq->unbound_attrs->no_numa);
5212 mutex_unlock(&wq->mutex);
5214 return written;
5217 static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5218 const char *buf, size_t count)
5220 struct workqueue_struct *wq = dev_to_wq(dev);
5221 struct workqueue_attrs *attrs;
5222 int v, ret = -ENOMEM;
5224 apply_wqattrs_lock();
5226 attrs = wq_sysfs_prep_attrs(wq);
5227 if (!attrs)
5228 goto out_unlock;
5230 ret = -EINVAL;
5231 if (sscanf(buf, "%d", &v) == 1) {
5232 attrs->no_numa = !v;
5233 ret = apply_workqueue_attrs_locked(wq, attrs);
5236 out_unlock:
5237 apply_wqattrs_unlock();
5238 free_workqueue_attrs(attrs);
5239 return ret ?: count;
5242 static struct device_attribute wq_sysfs_unbound_attrs[] = {
5243 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5244 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5245 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5246 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5247 __ATTR_NULL,
5250 static struct bus_type wq_subsys = {
5251 .name = "workqueue",
5252 .dev_groups = wq_sysfs_groups,
5255 static ssize_t wq_unbound_cpumask_show(struct device *dev,
5256 struct device_attribute *attr, char *buf)
5258 int written;
5260 mutex_lock(&wq_pool_mutex);
5261 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5262 cpumask_pr_args(wq_unbound_cpumask));
5263 mutex_unlock(&wq_pool_mutex);
5265 return written;
5268 static ssize_t wq_unbound_cpumask_store(struct device *dev,
5269 struct device_attribute *attr, const char *buf, size_t count)
5271 cpumask_var_t cpumask;
5272 int ret;
5274 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5275 return -ENOMEM;
5277 ret = cpumask_parse(buf, cpumask);
5278 if (!ret)
5279 ret = workqueue_set_unbound_cpumask(cpumask);
5281 free_cpumask_var(cpumask);
5282 return ret ? ret : count;
5285 static struct device_attribute wq_sysfs_cpumask_attr =
5286 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5287 wq_unbound_cpumask_store);
5289 static int __init wq_sysfs_init(void)
5291 int err;
5293 err = subsys_virtual_register(&wq_subsys, NULL);
5294 if (err)
5295 return err;
5297 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
5299 core_initcall(wq_sysfs_init);
5301 static void wq_device_release(struct device *dev)
5303 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5305 kfree(wq_dev);
5309 * workqueue_sysfs_register - make a workqueue visible in sysfs
5310 * @wq: the workqueue to register
5312 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5313 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5314 * which is the preferred method.
5316 * Workqueue user should use this function directly iff it wants to apply
5317 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5318 * apply_workqueue_attrs() may race against userland updating the
5319 * attributes.
5321 * Return: 0 on success, -errno on failure.
5323 int workqueue_sysfs_register(struct workqueue_struct *wq)
5325 struct wq_device *wq_dev;
5326 int ret;
5329 * Adjusting max_active or creating new pwqs by applying
5330 * attributes breaks ordering guarantee. Disallow exposing ordered
5331 * workqueues.
5333 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
5334 return -EINVAL;
5336 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5337 if (!wq_dev)
5338 return -ENOMEM;
5340 wq_dev->wq = wq;
5341 wq_dev->dev.bus = &wq_subsys;
5342 wq_dev->dev.release = wq_device_release;
5343 dev_set_name(&wq_dev->dev, "%s", wq->name);
5346 * unbound_attrs are created separately. Suppress uevent until
5347 * everything is ready.
5349 dev_set_uevent_suppress(&wq_dev->dev, true);
5351 ret = device_register(&wq_dev->dev);
5352 if (ret) {
5353 kfree(wq_dev);
5354 wq->wq_dev = NULL;
5355 return ret;
5358 if (wq->flags & WQ_UNBOUND) {
5359 struct device_attribute *attr;
5361 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5362 ret = device_create_file(&wq_dev->dev, attr);
5363 if (ret) {
5364 device_unregister(&wq_dev->dev);
5365 wq->wq_dev = NULL;
5366 return ret;
5371 dev_set_uevent_suppress(&wq_dev->dev, false);
5372 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5373 return 0;
5377 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5378 * @wq: the workqueue to unregister
5380 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5382 static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
5384 struct wq_device *wq_dev = wq->wq_dev;
5386 if (!wq->wq_dev)
5387 return;
5389 wq->wq_dev = NULL;
5390 device_unregister(&wq_dev->dev);
5392 #else /* CONFIG_SYSFS */
5393 static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5394 #endif /* CONFIG_SYSFS */
5397 * Workqueue watchdog.
5399 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5400 * flush dependency, a concurrency managed work item which stays RUNNING
5401 * indefinitely. Workqueue stalls can be very difficult to debug as the
5402 * usual warning mechanisms don't trigger and internal workqueue state is
5403 * largely opaque.
5405 * Workqueue watchdog monitors all worker pools periodically and dumps
5406 * state if some pools failed to make forward progress for a while where
5407 * forward progress is defined as the first item on ->worklist changing.
5409 * This mechanism is controlled through the kernel parameter
5410 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5411 * corresponding sysfs parameter file.
5413 #ifdef CONFIG_WQ_WATCHDOG
5415 static void wq_watchdog_timer_fn(unsigned long data);
5417 static unsigned long wq_watchdog_thresh = 30;
5418 static struct timer_list wq_watchdog_timer =
5419 TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
5421 static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5422 static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5424 static void wq_watchdog_reset_touched(void)
5426 int cpu;
5428 wq_watchdog_touched = jiffies;
5429 for_each_possible_cpu(cpu)
5430 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5433 static void wq_watchdog_timer_fn(unsigned long data)
5435 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5436 bool lockup_detected = false;
5437 struct worker_pool *pool;
5438 int pi;
5440 if (!thresh)
5441 return;
5443 rcu_read_lock();
5445 for_each_pool(pool, pi) {
5446 unsigned long pool_ts, touched, ts;
5448 if (list_empty(&pool->worklist))
5449 continue;
5451 /* get the latest of pool and touched timestamps */
5452 pool_ts = READ_ONCE(pool->watchdog_ts);
5453 touched = READ_ONCE(wq_watchdog_touched);
5455 if (time_after(pool_ts, touched))
5456 ts = pool_ts;
5457 else
5458 ts = touched;
5460 if (pool->cpu >= 0) {
5461 unsigned long cpu_touched =
5462 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5463 pool->cpu));
5464 if (time_after(cpu_touched, ts))
5465 ts = cpu_touched;
5468 /* did we stall? */
5469 if (time_after(jiffies, ts + thresh)) {
5470 lockup_detected = true;
5471 pr_emerg("BUG: workqueue lockup - pool");
5472 pr_cont_pool_info(pool);
5473 pr_cont(" stuck for %us!\n",
5474 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5478 rcu_read_unlock();
5480 if (lockup_detected)
5481 show_workqueue_state();
5483 wq_watchdog_reset_touched();
5484 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5487 void wq_watchdog_touch(int cpu)
5489 if (cpu >= 0)
5490 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5491 else
5492 wq_watchdog_touched = jiffies;
5495 static void wq_watchdog_set_thresh(unsigned long thresh)
5497 wq_watchdog_thresh = 0;
5498 del_timer_sync(&wq_watchdog_timer);
5500 if (thresh) {
5501 wq_watchdog_thresh = thresh;
5502 wq_watchdog_reset_touched();
5503 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5507 static int wq_watchdog_param_set_thresh(const char *val,
5508 const struct kernel_param *kp)
5510 unsigned long thresh;
5511 int ret;
5513 ret = kstrtoul(val, 0, &thresh);
5514 if (ret)
5515 return ret;
5517 if (system_wq)
5518 wq_watchdog_set_thresh(thresh);
5519 else
5520 wq_watchdog_thresh = thresh;
5522 return 0;
5525 static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5526 .set = wq_watchdog_param_set_thresh,
5527 .get = param_get_ulong,
5530 module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5531 0644);
5533 static void wq_watchdog_init(void)
5535 wq_watchdog_set_thresh(wq_watchdog_thresh);
5538 #else /* CONFIG_WQ_WATCHDOG */
5540 static inline void wq_watchdog_init(void) { }
5542 #endif /* CONFIG_WQ_WATCHDOG */
5544 static void __init wq_numa_init(void)
5546 cpumask_var_t *tbl;
5547 int node, cpu;
5549 if (num_possible_nodes() <= 1)
5550 return;
5552 if (wq_disable_numa) {
5553 pr_info("workqueue: NUMA affinity support disabled\n");
5554 return;
5557 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
5558 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5561 * We want masks of possible CPUs of each node which isn't readily
5562 * available. Build one from cpu_to_node() which should have been
5563 * fully initialized by now.
5565 tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
5566 BUG_ON(!tbl);
5568 for_each_node(node)
5569 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
5570 node_online(node) ? node : NUMA_NO_NODE));
5572 for_each_possible_cpu(cpu) {
5573 node = cpu_to_node(cpu);
5574 if (WARN_ON(node == NUMA_NO_NODE)) {
5575 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5576 /* happens iff arch is bonkers, let's just proceed */
5577 return;
5579 cpumask_set_cpu(cpu, tbl[node]);
5582 wq_numa_possible_cpumask = tbl;
5583 wq_numa_enabled = true;
5587 * workqueue_init_early - early init for workqueue subsystem
5589 * This is the first half of two-staged workqueue subsystem initialization
5590 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5591 * idr are up. It sets up all the data structures and system workqueues
5592 * and allows early boot code to create workqueues and queue/cancel work
5593 * items. Actual work item execution starts only after kthreads can be
5594 * created and scheduled right before early initcalls.
5596 int __init workqueue_init_early(void)
5598 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
5599 int i, cpu;
5601 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5603 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5604 cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5606 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5608 /* initialize CPU pools */
5609 for_each_possible_cpu(cpu) {
5610 struct worker_pool *pool;
5612 i = 0;
5613 for_each_cpu_worker_pool(pool, cpu) {
5614 BUG_ON(init_worker_pool(pool));
5615 pool->cpu = cpu;
5616 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
5617 pool->attrs->nice = std_nice[i++];
5618 pool->node = cpu_to_node(cpu);
5620 /* alloc pool ID */
5621 mutex_lock(&wq_pool_mutex);
5622 BUG_ON(worker_pool_assign_id(pool));
5623 mutex_unlock(&wq_pool_mutex);
5627 /* create default unbound and ordered wq attrs */
5628 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5629 struct workqueue_attrs *attrs;
5631 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5632 attrs->nice = std_nice[i];
5633 unbound_std_wq_attrs[i] = attrs;
5636 * An ordered wq should have only one pwq as ordering is
5637 * guaranteed by max_active which is enforced by pwqs.
5638 * Turn off NUMA so that dfl_pwq is used for all nodes.
5640 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5641 attrs->nice = std_nice[i];
5642 attrs->no_numa = true;
5643 ordered_wq_attrs[i] = attrs;
5646 system_wq = alloc_workqueue("events", 0, 0);
5647 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
5648 system_long_wq = alloc_workqueue("events_long", 0, 0);
5649 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5650 WQ_UNBOUND_MAX_ACTIVE);
5651 system_freezable_wq = alloc_workqueue("events_freezable",
5652 WQ_FREEZABLE, 0);
5653 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5654 WQ_POWER_EFFICIENT, 0);
5655 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5656 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5658 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
5659 !system_unbound_wq || !system_freezable_wq ||
5660 !system_power_efficient_wq ||
5661 !system_freezable_power_efficient_wq);
5663 return 0;
5667 * workqueue_init - bring workqueue subsystem fully online
5669 * This is the latter half of two-staged workqueue subsystem initialization
5670 * and invoked as soon as kthreads can be created and scheduled.
5671 * Workqueues have been created and work items queued on them, but there
5672 * are no kworkers executing the work items yet. Populate the worker pools
5673 * with the initial workers and enable future kworker creations.
5675 int __init workqueue_init(void)
5677 struct workqueue_struct *wq;
5678 struct worker_pool *pool;
5679 int cpu, bkt;
5682 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5683 * CPU to node mapping may not be available that early on some
5684 * archs such as power and arm64. As per-cpu pools created
5685 * previously could be missing node hint and unbound pools NUMA
5686 * affinity, fix them up.
5688 wq_numa_init();
5690 mutex_lock(&wq_pool_mutex);
5692 for_each_possible_cpu(cpu) {
5693 for_each_cpu_worker_pool(pool, cpu) {
5694 pool->node = cpu_to_node(cpu);
5698 list_for_each_entry(wq, &workqueues, list)
5699 wq_update_unbound_numa(wq, smp_processor_id(), true);
5701 mutex_unlock(&wq_pool_mutex);
5703 /* create the initial workers */
5704 for_each_online_cpu(cpu) {
5705 for_each_cpu_worker_pool(pool, cpu) {
5706 pool->flags &= ~POOL_DISASSOCIATED;
5707 BUG_ON(!create_worker(pool));
5711 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
5712 BUG_ON(!create_worker(pool));
5714 wq_online = true;
5715 wq_watchdog_init();
5717 return 0;