2 * kernel/workqueue.c - generic async execution with shared worker pool
4 * Copyright (C) 2002 Ingo Molnar
6 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
12 * Made to use alloc_percpu by Christoph Lameter.
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
19 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
24 * Please read Documentation/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/debug_locks.h>
42 #include <linux/lockdep.h>
43 #include <linux/idr.h>
44 #include <linux/jhash.h>
45 #include <linux/hashtable.h>
46 #include <linux/rculist.h>
47 #include <linux/nodemask.h>
48 #include <linux/moduleparam.h>
49 #include <linux/uaccess.h>
50 #include <linux/sched/isolation.h>
51 #include <linux/nmi.h>
53 #include "workqueue_internal.h"
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
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 * wq_pool_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 */
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
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
,
111 * Structure fields follow one of the following exclusion rules.
113 * I: Modifiable by initialization/destruction paths and read-only for
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: wq_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 */
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 */
157 int nr_workers
; /* L: total number of workers */
158 int nr_idle
; /* L: currently idle workers */
160 struct list_head idle_list
; /* X: list of idle workers */
161 struct timer_list idle_timer
; /* L: worker idle timeout */
162 struct timer_list mayday_timer
; /* L: SOS timer for workers */
164 /* a workers is either on busy_hash or idle_list, or the manager */
165 DECLARE_HASHTABLE(busy_hash
, BUSY_WORKER_HASH_ORDER
);
166 /* L: hash of busy workers */
168 struct worker
*manager
; /* L: purely informational */
169 struct list_head workers
; /* A: attached workers */
170 struct completion
*detach_completion
; /* all workers detached */
172 struct ida worker_ida
; /* worker IDs for task name */
174 struct workqueue_attrs
*attrs
; /* I: worker attributes */
175 struct hlist_node hash_node
; /* PL: unbound_pool_hash node */
176 int refcnt
; /* PL: refcnt for unbound pools */
179 * The current concurrency level. As it's likely to be accessed
180 * from other CPUs during try_to_wake_up(), put it in a separate
183 atomic_t nr_running ____cacheline_aligned_in_smp
;
186 * Destruction of pool is sched-RCU protected to allow dereferences
187 * from get_work_pool().
190 } ____cacheline_aligned_in_smp
;
193 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
194 * of work_struct->data are used for flags and the remaining high bits
195 * point to the pwq; thus, pwqs need to be aligned at two's power of the
196 * number of flag bits.
198 struct pool_workqueue
{
199 struct worker_pool
*pool
; /* I: the associated pool */
200 struct workqueue_struct
*wq
; /* I: the owning workqueue */
201 int work_color
; /* L: current color */
202 int flush_color
; /* L: flushing color */
203 int refcnt
; /* L: reference count */
204 int nr_in_flight
[WORK_NR_COLORS
];
205 /* L: nr of in_flight works */
206 int nr_active
; /* L: nr of active works */
207 int max_active
; /* L: max active works */
208 struct list_head delayed_works
; /* L: delayed works */
209 struct list_head pwqs_node
; /* WR: node on wq->pwqs */
210 struct list_head mayday_node
; /* MD: node on wq->maydays */
213 * Release of unbound pwq is punted to system_wq. See put_pwq()
214 * and pwq_unbound_release_workfn() for details. pool_workqueue
215 * itself is also sched-RCU protected so that the first pwq can be
216 * determined without grabbing wq->mutex.
218 struct work_struct unbound_release_work
;
220 } __aligned(1 << WORK_STRUCT_FLAG_BITS
);
223 * Structure used to wait for workqueue flush.
226 struct list_head list
; /* WQ: list of flushers */
227 int flush_color
; /* WQ: flush color waiting for */
228 struct completion done
; /* flush completion */
234 * The externally visible workqueue. It relays the issued work items to
235 * the appropriate worker_pool through its pool_workqueues.
237 struct workqueue_struct
{
238 struct list_head pwqs
; /* WR: all pwqs of this wq */
239 struct list_head list
; /* PR: list of all workqueues */
241 struct mutex mutex
; /* protects this wq */
242 int work_color
; /* WQ: current work color */
243 int flush_color
; /* WQ: current flush color */
244 atomic_t nr_pwqs_to_flush
; /* flush in progress */
245 struct wq_flusher
*first_flusher
; /* WQ: first flusher */
246 struct list_head flusher_queue
; /* WQ: flush waiters */
247 struct list_head flusher_overflow
; /* WQ: flush overflow list */
249 struct list_head maydays
; /* MD: pwqs requesting rescue */
250 struct worker
*rescuer
; /* I: rescue worker */
252 int nr_drainers
; /* WQ: drain in progress */
253 int saved_max_active
; /* WQ: saved pwq max_active */
255 struct workqueue_attrs
*unbound_attrs
; /* PW: only for unbound wqs */
256 struct pool_workqueue
*dfl_pwq
; /* PW: only for unbound wqs */
259 struct wq_device
*wq_dev
; /* I: for sysfs interface */
261 #ifdef CONFIG_LOCKDEP
262 struct lockdep_map lockdep_map
;
264 char name
[WQ_NAME_LEN
]; /* I: workqueue name */
267 * Destruction of workqueue_struct is sched-RCU protected to allow
268 * walking the workqueues list without grabbing wq_pool_mutex.
269 * This is used to dump all workqueues from sysrq.
273 /* hot fields used during command issue, aligned to cacheline */
274 unsigned int flags ____cacheline_aligned
; /* WQ: WQ_* flags */
275 struct pool_workqueue __percpu
*cpu_pwqs
; /* I: per-cpu pwqs */
276 struct pool_workqueue __rcu
*numa_pwq_tbl
[]; /* PWR: unbound pwqs indexed by node */
279 static struct kmem_cache
*pwq_cache
;
281 static cpumask_var_t
*wq_numa_possible_cpumask
;
282 /* possible CPUs of each node */
284 static bool wq_disable_numa
;
285 module_param_named(disable_numa
, wq_disable_numa
, bool, 0444);
287 /* see the comment above the definition of WQ_POWER_EFFICIENT */
288 static bool wq_power_efficient
= IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT
);
289 module_param_named(power_efficient
, wq_power_efficient
, bool, 0444);
291 static bool wq_online
; /* can kworkers be created yet? */
293 static bool wq_numa_enabled
; /* unbound NUMA affinity enabled */
295 /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
296 static struct workqueue_attrs
*wq_update_unbound_numa_attrs_buf
;
298 static DEFINE_MUTEX(wq_pool_mutex
); /* protects pools and workqueues list */
299 static DEFINE_MUTEX(wq_pool_attach_mutex
); /* protects worker attach/detach */
300 static DEFINE_SPINLOCK(wq_mayday_lock
); /* protects wq->maydays list */
301 static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait
); /* wait for manager to go away */
303 static LIST_HEAD(workqueues
); /* PR: list of all workqueues */
304 static bool workqueue_freezing
; /* PL: have wqs started freezing? */
306 /* PL: allowable cpus for unbound wqs and work items */
307 static cpumask_var_t wq_unbound_cpumask
;
309 /* CPU where unbound work was last round robin scheduled from this CPU */
310 static DEFINE_PER_CPU(int, wq_rr_cpu_last
);
313 * Local execution of unbound work items is no longer guaranteed. The
314 * following always forces round-robin CPU selection on unbound work items
315 * to uncover usages which depend on it.
317 #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
318 static bool wq_debug_force_rr_cpu
= true;
320 static bool wq_debug_force_rr_cpu
= false;
322 module_param_named(debug_force_rr_cpu
, wq_debug_force_rr_cpu
, bool, 0644);
324 /* the per-cpu worker pools */
325 static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool
[NR_STD_WORKER_POOLS
], cpu_worker_pools
);
327 static DEFINE_IDR(worker_pool_idr
); /* PR: idr of all pools */
329 /* PL: hash of all unbound pools keyed by pool->attrs */
330 static DEFINE_HASHTABLE(unbound_pool_hash
, UNBOUND_POOL_HASH_ORDER
);
332 /* I: attributes used when instantiating standard unbound pools on demand */
333 static struct workqueue_attrs
*unbound_std_wq_attrs
[NR_STD_WORKER_POOLS
];
335 /* I: attributes used when instantiating ordered pools on demand */
336 static struct workqueue_attrs
*ordered_wq_attrs
[NR_STD_WORKER_POOLS
];
338 struct workqueue_struct
*system_wq __read_mostly
;
339 EXPORT_SYMBOL(system_wq
);
340 struct workqueue_struct
*system_highpri_wq __read_mostly
;
341 EXPORT_SYMBOL_GPL(system_highpri_wq
);
342 struct workqueue_struct
*system_long_wq __read_mostly
;
343 EXPORT_SYMBOL_GPL(system_long_wq
);
344 struct workqueue_struct
*system_unbound_wq __read_mostly
;
345 EXPORT_SYMBOL_GPL(system_unbound_wq
);
346 struct workqueue_struct
*system_freezable_wq __read_mostly
;
347 EXPORT_SYMBOL_GPL(system_freezable_wq
);
348 struct workqueue_struct
*system_power_efficient_wq __read_mostly
;
349 EXPORT_SYMBOL_GPL(system_power_efficient_wq
);
350 struct workqueue_struct
*system_freezable_power_efficient_wq __read_mostly
;
351 EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq
);
353 static int worker_thread(void *__worker
);
354 static void workqueue_sysfs_unregister(struct workqueue_struct
*wq
);
356 #define CREATE_TRACE_POINTS
357 #include <trace/events/workqueue.h>
359 #define assert_rcu_or_pool_mutex() \
360 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
361 !lockdep_is_held(&wq_pool_mutex), \
362 "sched RCU or wq_pool_mutex should be held")
364 #define assert_rcu_or_wq_mutex(wq) \
365 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
366 !lockdep_is_held(&wq->mutex), \
367 "sched RCU or wq->mutex should be held")
369 #define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
370 RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() && \
371 !lockdep_is_held(&wq->mutex) && \
372 !lockdep_is_held(&wq_pool_mutex), \
373 "sched RCU, wq->mutex or wq_pool_mutex should be held")
375 #define for_each_cpu_worker_pool(pool, cpu) \
376 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
377 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
381 * for_each_pool - iterate through all worker_pools in the system
382 * @pool: iteration cursor
383 * @pi: integer used for iteration
385 * This must be called either with wq_pool_mutex held or sched RCU read
386 * locked. If the pool needs to be used beyond the locking in effect, the
387 * caller is responsible for guaranteeing that the pool stays online.
389 * The if/else clause exists only for the lockdep assertion and can be
392 #define for_each_pool(pool, pi) \
393 idr_for_each_entry(&worker_pool_idr, pool, pi) \
394 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
398 * for_each_pool_worker - iterate through all workers of a worker_pool
399 * @worker: iteration cursor
400 * @pool: worker_pool to iterate workers of
402 * This must be called with wq_pool_attach_mutex.
404 * The if/else clause exists only for the lockdep assertion and can be
407 #define for_each_pool_worker(worker, pool) \
408 list_for_each_entry((worker), &(pool)->workers, node) \
409 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
413 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
414 * @pwq: iteration cursor
415 * @wq: the target workqueue
417 * This must be called either with wq->mutex held or sched RCU read locked.
418 * If the pwq needs to be used beyond the locking in effect, the caller is
419 * responsible for guaranteeing that the pwq stays online.
421 * The if/else clause exists only for the lockdep assertion and can be
424 #define for_each_pwq(pwq, wq) \
425 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
426 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
429 #ifdef CONFIG_DEBUG_OBJECTS_WORK
431 static struct debug_obj_descr work_debug_descr
;
433 static void *work_debug_hint(void *addr
)
435 return ((struct work_struct
*) addr
)->func
;
438 static bool work_is_static_object(void *addr
)
440 struct work_struct
*work
= addr
;
442 return test_bit(WORK_STRUCT_STATIC_BIT
, work_data_bits(work
));
446 * fixup_init is called when:
447 * - an active object is initialized
449 static bool work_fixup_init(void *addr
, enum debug_obj_state state
)
451 struct work_struct
*work
= addr
;
454 case ODEBUG_STATE_ACTIVE
:
455 cancel_work_sync(work
);
456 debug_object_init(work
, &work_debug_descr
);
464 * fixup_free is called when:
465 * - an active object is freed
467 static bool work_fixup_free(void *addr
, enum debug_obj_state state
)
469 struct work_struct
*work
= addr
;
472 case ODEBUG_STATE_ACTIVE
:
473 cancel_work_sync(work
);
474 debug_object_free(work
, &work_debug_descr
);
481 static struct debug_obj_descr work_debug_descr
= {
482 .name
= "work_struct",
483 .debug_hint
= work_debug_hint
,
484 .is_static_object
= work_is_static_object
,
485 .fixup_init
= work_fixup_init
,
486 .fixup_free
= work_fixup_free
,
489 static inline void debug_work_activate(struct work_struct
*work
)
491 debug_object_activate(work
, &work_debug_descr
);
494 static inline void debug_work_deactivate(struct work_struct
*work
)
496 debug_object_deactivate(work
, &work_debug_descr
);
499 void __init_work(struct work_struct
*work
, int onstack
)
502 debug_object_init_on_stack(work
, &work_debug_descr
);
504 debug_object_init(work
, &work_debug_descr
);
506 EXPORT_SYMBOL_GPL(__init_work
);
508 void destroy_work_on_stack(struct work_struct
*work
)
510 debug_object_free(work
, &work_debug_descr
);
512 EXPORT_SYMBOL_GPL(destroy_work_on_stack
);
514 void destroy_delayed_work_on_stack(struct delayed_work
*work
)
516 destroy_timer_on_stack(&work
->timer
);
517 debug_object_free(&work
->work
, &work_debug_descr
);
519 EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack
);
522 static inline void debug_work_activate(struct work_struct
*work
) { }
523 static inline void debug_work_deactivate(struct work_struct
*work
) { }
527 * worker_pool_assign_id - allocate ID and assing it to @pool
528 * @pool: the pool pointer of interest
530 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
531 * successfully, -errno on failure.
533 static int worker_pool_assign_id(struct worker_pool
*pool
)
537 lockdep_assert_held(&wq_pool_mutex
);
539 ret
= idr_alloc(&worker_pool_idr
, pool
, 0, WORK_OFFQ_POOL_NONE
,
549 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
550 * @wq: the target workqueue
553 * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
555 * If the pwq needs to be used beyond the locking in effect, the caller is
556 * responsible for guaranteeing that the pwq stays online.
558 * Return: The unbound pool_workqueue for @node.
560 static struct pool_workqueue
*unbound_pwq_by_node(struct workqueue_struct
*wq
,
563 assert_rcu_or_wq_mutex_or_pool_mutex(wq
);
566 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
567 * delayed item is pending. The plan is to keep CPU -> NODE
568 * mapping valid and stable across CPU on/offlines. Once that
569 * happens, this workaround can be removed.
571 if (unlikely(node
== NUMA_NO_NODE
))
574 return rcu_dereference_raw(wq
->numa_pwq_tbl
[node
]);
577 static unsigned int work_color_to_flags(int color
)
579 return color
<< WORK_STRUCT_COLOR_SHIFT
;
582 static int get_work_color(struct work_struct
*work
)
584 return (*work_data_bits(work
) >> WORK_STRUCT_COLOR_SHIFT
) &
585 ((1 << WORK_STRUCT_COLOR_BITS
) - 1);
588 static int work_next_color(int color
)
590 return (color
+ 1) % WORK_NR_COLORS
;
594 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
595 * contain the pointer to the queued pwq. Once execution starts, the flag
596 * is cleared and the high bits contain OFFQ flags and pool ID.
598 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
599 * and clear_work_data() can be used to set the pwq, pool or clear
600 * work->data. These functions should only be called while the work is
601 * owned - ie. while the PENDING bit is set.
603 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
604 * corresponding to a work. Pool is available once the work has been
605 * queued anywhere after initialization until it is sync canceled. pwq is
606 * available only while the work item is queued.
608 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
609 * canceled. While being canceled, a work item may have its PENDING set
610 * but stay off timer and worklist for arbitrarily long and nobody should
611 * try to steal the PENDING bit.
613 static inline void set_work_data(struct work_struct
*work
, unsigned long data
,
616 WARN_ON_ONCE(!work_pending(work
));
617 atomic_long_set(&work
->data
, data
| flags
| work_static(work
));
620 static void set_work_pwq(struct work_struct
*work
, struct pool_workqueue
*pwq
,
621 unsigned long extra_flags
)
623 set_work_data(work
, (unsigned long)pwq
,
624 WORK_STRUCT_PENDING
| WORK_STRUCT_PWQ
| extra_flags
);
627 static void set_work_pool_and_keep_pending(struct work_struct
*work
,
630 set_work_data(work
, (unsigned long)pool_id
<< WORK_OFFQ_POOL_SHIFT
,
631 WORK_STRUCT_PENDING
);
634 static void set_work_pool_and_clear_pending(struct work_struct
*work
,
638 * The following wmb is paired with the implied mb in
639 * test_and_set_bit(PENDING) and ensures all updates to @work made
640 * here are visible to and precede any updates by the next PENDING
644 set_work_data(work
, (unsigned long)pool_id
<< WORK_OFFQ_POOL_SHIFT
, 0);
646 * The following mb guarantees that previous clear of a PENDING bit
647 * will not be reordered with any speculative LOADS or STORES from
648 * work->current_func, which is executed afterwards. This possible
649 * reordering can lead to a missed execution on attempt to qeueue
650 * the same @work. E.g. consider this case:
653 * ---------------------------- --------------------------------
655 * 1 STORE event_indicated
656 * 2 queue_work_on() {
657 * 3 test_and_set_bit(PENDING)
658 * 4 } set_..._and_clear_pending() {
659 * 5 set_work_data() # clear bit
661 * 7 work->current_func() {
662 * 8 LOAD event_indicated
665 * Without an explicit full barrier speculative LOAD on line 8 can
666 * be executed before CPU#0 does STORE on line 1. If that happens,
667 * CPU#0 observes the PENDING bit is still set and new execution of
668 * a @work is not queued in a hope, that CPU#1 will eventually
669 * finish the queued @work. Meanwhile CPU#1 does not see
670 * event_indicated is set, because speculative LOAD was executed
671 * before actual STORE.
676 static void clear_work_data(struct work_struct
*work
)
678 smp_wmb(); /* see set_work_pool_and_clear_pending() */
679 set_work_data(work
, WORK_STRUCT_NO_POOL
, 0);
682 static struct pool_workqueue
*get_work_pwq(struct work_struct
*work
)
684 unsigned long data
= atomic_long_read(&work
->data
);
686 if (data
& WORK_STRUCT_PWQ
)
687 return (void *)(data
& WORK_STRUCT_WQ_DATA_MASK
);
693 * get_work_pool - return the worker_pool a given work was associated with
694 * @work: the work item of interest
696 * Pools are created and destroyed under wq_pool_mutex, and allows read
697 * access under sched-RCU read lock. As such, this function should be
698 * called under wq_pool_mutex or with preemption disabled.
700 * All fields of the returned pool are accessible as long as the above
701 * mentioned locking is in effect. If the returned pool needs to be used
702 * beyond the critical section, the caller is responsible for ensuring the
703 * returned pool is and stays online.
705 * Return: The worker_pool @work was last associated with. %NULL if none.
707 static struct worker_pool
*get_work_pool(struct work_struct
*work
)
709 unsigned long data
= atomic_long_read(&work
->data
);
712 assert_rcu_or_pool_mutex();
714 if (data
& WORK_STRUCT_PWQ
)
715 return ((struct pool_workqueue
*)
716 (data
& WORK_STRUCT_WQ_DATA_MASK
))->pool
;
718 pool_id
= data
>> WORK_OFFQ_POOL_SHIFT
;
719 if (pool_id
== WORK_OFFQ_POOL_NONE
)
722 return idr_find(&worker_pool_idr
, pool_id
);
726 * get_work_pool_id - return the worker pool ID a given work is associated with
727 * @work: the work item of interest
729 * Return: The worker_pool ID @work was last associated with.
730 * %WORK_OFFQ_POOL_NONE if none.
732 static int get_work_pool_id(struct work_struct
*work
)
734 unsigned long data
= atomic_long_read(&work
->data
);
736 if (data
& WORK_STRUCT_PWQ
)
737 return ((struct pool_workqueue
*)
738 (data
& WORK_STRUCT_WQ_DATA_MASK
))->pool
->id
;
740 return data
>> WORK_OFFQ_POOL_SHIFT
;
743 static void mark_work_canceling(struct work_struct
*work
)
745 unsigned long pool_id
= get_work_pool_id(work
);
747 pool_id
<<= WORK_OFFQ_POOL_SHIFT
;
748 set_work_data(work
, pool_id
| WORK_OFFQ_CANCELING
, WORK_STRUCT_PENDING
);
751 static bool work_is_canceling(struct work_struct
*work
)
753 unsigned long data
= atomic_long_read(&work
->data
);
755 return !(data
& WORK_STRUCT_PWQ
) && (data
& WORK_OFFQ_CANCELING
);
759 * Policy functions. These define the policies on how the global worker
760 * pools are managed. Unless noted otherwise, these functions assume that
761 * they're being called with pool->lock held.
764 static bool __need_more_worker(struct worker_pool
*pool
)
766 return !atomic_read(&pool
->nr_running
);
770 * Need to wake up a worker? Called from anything but currently
773 * Note that, because unbound workers never contribute to nr_running, this
774 * function will always return %true for unbound pools as long as the
775 * worklist isn't empty.
777 static bool need_more_worker(struct worker_pool
*pool
)
779 return !list_empty(&pool
->worklist
) && __need_more_worker(pool
);
782 /* Can I start working? Called from busy but !running workers. */
783 static bool may_start_working(struct worker_pool
*pool
)
785 return pool
->nr_idle
;
788 /* Do I need to keep working? Called from currently running workers. */
789 static bool keep_working(struct worker_pool
*pool
)
791 return !list_empty(&pool
->worklist
) &&
792 atomic_read(&pool
->nr_running
) <= 1;
795 /* Do we need a new worker? Called from manager. */
796 static bool need_to_create_worker(struct worker_pool
*pool
)
798 return need_more_worker(pool
) && !may_start_working(pool
);
801 /* Do we have too many workers and should some go away? */
802 static bool too_many_workers(struct worker_pool
*pool
)
804 bool managing
= pool
->flags
& POOL_MANAGER_ACTIVE
;
805 int nr_idle
= pool
->nr_idle
+ managing
; /* manager is considered idle */
806 int nr_busy
= pool
->nr_workers
- nr_idle
;
808 return nr_idle
> 2 && (nr_idle
- 2) * MAX_IDLE_WORKERS_RATIO
>= nr_busy
;
815 /* Return the first idle worker. Safe with preemption disabled */
816 static struct worker
*first_idle_worker(struct worker_pool
*pool
)
818 if (unlikely(list_empty(&pool
->idle_list
)))
821 return list_first_entry(&pool
->idle_list
, struct worker
, entry
);
825 * wake_up_worker - wake up an idle worker
826 * @pool: worker pool to wake worker from
828 * Wake up the first idle worker of @pool.
831 * spin_lock_irq(pool->lock).
833 static void wake_up_worker(struct worker_pool
*pool
)
835 struct worker
*worker
= first_idle_worker(pool
);
838 wake_up_process(worker
->task
);
842 * wq_worker_waking_up - a worker is waking up
843 * @task: task waking up
844 * @cpu: CPU @task is waking up to
846 * This function is called during try_to_wake_up() when a worker is
850 * spin_lock_irq(rq->lock)
852 void wq_worker_waking_up(struct task_struct
*task
, int cpu
)
854 struct worker
*worker
= kthread_data(task
);
856 if (!(worker
->flags
& WORKER_NOT_RUNNING
)) {
857 WARN_ON_ONCE(worker
->pool
->cpu
!= cpu
);
858 atomic_inc(&worker
->pool
->nr_running
);
863 * wq_worker_sleeping - a worker is going to sleep
864 * @task: task going to sleep
866 * This function is called during schedule() when a busy worker is
867 * going to sleep. Worker on the same cpu can be woken up by
868 * returning pointer to its task.
871 * spin_lock_irq(rq->lock)
874 * Worker task on @cpu to wake up, %NULL if none.
876 struct task_struct
*wq_worker_sleeping(struct task_struct
*task
)
878 struct worker
*worker
= kthread_data(task
), *to_wakeup
= NULL
;
879 struct worker_pool
*pool
;
882 * Rescuers, which may not have all the fields set up like normal
883 * workers, also reach here, let's not access anything before
884 * checking NOT_RUNNING.
886 if (worker
->flags
& WORKER_NOT_RUNNING
)
891 /* this can only happen on the local cpu */
892 if (WARN_ON_ONCE(pool
->cpu
!= raw_smp_processor_id()))
896 * The counterpart of the following dec_and_test, implied mb,
897 * worklist not empty test sequence is in insert_work().
898 * Please read comment there.
900 * NOT_RUNNING is clear. This means that we're bound to and
901 * running on the local cpu w/ rq lock held and preemption
902 * disabled, which in turn means that none else could be
903 * manipulating idle_list, so dereferencing idle_list without pool
906 if (atomic_dec_and_test(&pool
->nr_running
) &&
907 !list_empty(&pool
->worklist
))
908 to_wakeup
= first_idle_worker(pool
);
909 return to_wakeup
? to_wakeup
->task
: NULL
;
913 * worker_set_flags - set worker flags and adjust nr_running accordingly
915 * @flags: flags to set
917 * Set @flags in @worker->flags and adjust nr_running accordingly.
920 * spin_lock_irq(pool->lock)
922 static inline void worker_set_flags(struct worker
*worker
, unsigned int flags
)
924 struct worker_pool
*pool
= worker
->pool
;
926 WARN_ON_ONCE(worker
->task
!= current
);
928 /* If transitioning into NOT_RUNNING, adjust nr_running. */
929 if ((flags
& WORKER_NOT_RUNNING
) &&
930 !(worker
->flags
& WORKER_NOT_RUNNING
)) {
931 atomic_dec(&pool
->nr_running
);
934 worker
->flags
|= flags
;
938 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
940 * @flags: flags to clear
942 * Clear @flags in @worker->flags and adjust nr_running accordingly.
945 * spin_lock_irq(pool->lock)
947 static inline void worker_clr_flags(struct worker
*worker
, unsigned int flags
)
949 struct worker_pool
*pool
= worker
->pool
;
950 unsigned int oflags
= worker
->flags
;
952 WARN_ON_ONCE(worker
->task
!= current
);
954 worker
->flags
&= ~flags
;
957 * If transitioning out of NOT_RUNNING, increment nr_running. Note
958 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
959 * of multiple flags, not a single flag.
961 if ((flags
& WORKER_NOT_RUNNING
) && (oflags
& WORKER_NOT_RUNNING
))
962 if (!(worker
->flags
& WORKER_NOT_RUNNING
))
963 atomic_inc(&pool
->nr_running
);
967 * find_worker_executing_work - find worker which is executing a work
968 * @pool: pool of interest
969 * @work: work to find worker for
971 * Find a worker which is executing @work on @pool by searching
972 * @pool->busy_hash which is keyed by the address of @work. For a worker
973 * to match, its current execution should match the address of @work and
974 * its work function. This is to avoid unwanted dependency between
975 * unrelated work executions through a work item being recycled while still
978 * This is a bit tricky. A work item may be freed once its execution
979 * starts and nothing prevents the freed area from being recycled for
980 * another work item. If the same work item address ends up being reused
981 * before the original execution finishes, workqueue will identify the
982 * recycled work item as currently executing and make it wait until the
983 * current execution finishes, introducing an unwanted dependency.
985 * This function checks the work item address and work function to avoid
986 * false positives. Note that this isn't complete as one may construct a
987 * work function which can introduce dependency onto itself through a
988 * recycled work item. Well, if somebody wants to shoot oneself in the
989 * foot that badly, there's only so much we can do, and if such deadlock
990 * actually occurs, it should be easy to locate the culprit work function.
993 * spin_lock_irq(pool->lock).
996 * Pointer to worker which is executing @work if found, %NULL
999 static struct worker
*find_worker_executing_work(struct worker_pool
*pool
,
1000 struct work_struct
*work
)
1002 struct worker
*worker
;
1004 hash_for_each_possible(pool
->busy_hash
, worker
, hentry
,
1005 (unsigned long)work
)
1006 if (worker
->current_work
== work
&&
1007 worker
->current_func
== work
->func
)
1014 * move_linked_works - move linked works to a list
1015 * @work: start of series of works to be scheduled
1016 * @head: target list to append @work to
1017 * @nextp: out parameter for nested worklist walking
1019 * Schedule linked works starting from @work to @head. Work series to
1020 * be scheduled starts at @work and includes any consecutive work with
1021 * WORK_STRUCT_LINKED set in its predecessor.
1023 * If @nextp is not NULL, it's updated to point to the next work of
1024 * the last scheduled work. This allows move_linked_works() to be
1025 * nested inside outer list_for_each_entry_safe().
1028 * spin_lock_irq(pool->lock).
1030 static void move_linked_works(struct work_struct
*work
, struct list_head
*head
,
1031 struct work_struct
**nextp
)
1033 struct work_struct
*n
;
1036 * Linked worklist will always end before the end of the list,
1037 * use NULL for list head.
1039 list_for_each_entry_safe_from(work
, n
, NULL
, entry
) {
1040 list_move_tail(&work
->entry
, head
);
1041 if (!(*work_data_bits(work
) & WORK_STRUCT_LINKED
))
1046 * If we're already inside safe list traversal and have moved
1047 * multiple works to the scheduled queue, the next position
1048 * needs to be updated.
1055 * get_pwq - get an extra reference on the specified pool_workqueue
1056 * @pwq: pool_workqueue to get
1058 * Obtain an extra reference on @pwq. The caller should guarantee that
1059 * @pwq has positive refcnt and be holding the matching pool->lock.
1061 static void get_pwq(struct pool_workqueue
*pwq
)
1063 lockdep_assert_held(&pwq
->pool
->lock
);
1064 WARN_ON_ONCE(pwq
->refcnt
<= 0);
1069 * put_pwq - put a pool_workqueue reference
1070 * @pwq: pool_workqueue to put
1072 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1073 * destruction. The caller should be holding the matching pool->lock.
1075 static void put_pwq(struct pool_workqueue
*pwq
)
1077 lockdep_assert_held(&pwq
->pool
->lock
);
1078 if (likely(--pwq
->refcnt
))
1080 if (WARN_ON_ONCE(!(pwq
->wq
->flags
& WQ_UNBOUND
)))
1083 * @pwq can't be released under pool->lock, bounce to
1084 * pwq_unbound_release_workfn(). This never recurses on the same
1085 * pool->lock as this path is taken only for unbound workqueues and
1086 * the release work item is scheduled on a per-cpu workqueue. To
1087 * avoid lockdep warning, unbound pool->locks are given lockdep
1088 * subclass of 1 in get_unbound_pool().
1090 schedule_work(&pwq
->unbound_release_work
);
1094 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1095 * @pwq: pool_workqueue to put (can be %NULL)
1097 * put_pwq() with locking. This function also allows %NULL @pwq.
1099 static void put_pwq_unlocked(struct pool_workqueue
*pwq
)
1103 * As both pwqs and pools are sched-RCU protected, the
1104 * following lock operations are safe.
1106 spin_lock_irq(&pwq
->pool
->lock
);
1108 spin_unlock_irq(&pwq
->pool
->lock
);
1112 static void pwq_activate_delayed_work(struct work_struct
*work
)
1114 struct pool_workqueue
*pwq
= get_work_pwq(work
);
1116 trace_workqueue_activate_work(work
);
1117 if (list_empty(&pwq
->pool
->worklist
))
1118 pwq
->pool
->watchdog_ts
= jiffies
;
1119 move_linked_works(work
, &pwq
->pool
->worklist
, NULL
);
1120 __clear_bit(WORK_STRUCT_DELAYED_BIT
, work_data_bits(work
));
1124 static void pwq_activate_first_delayed(struct pool_workqueue
*pwq
)
1126 struct work_struct
*work
= list_first_entry(&pwq
->delayed_works
,
1127 struct work_struct
, entry
);
1129 pwq_activate_delayed_work(work
);
1133 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1134 * @pwq: pwq of interest
1135 * @color: color of work which left the queue
1137 * A work either has completed or is removed from pending queue,
1138 * decrement nr_in_flight of its pwq and handle workqueue flushing.
1141 * spin_lock_irq(pool->lock).
1143 static void pwq_dec_nr_in_flight(struct pool_workqueue
*pwq
, int color
)
1145 /* uncolored work items don't participate in flushing or nr_active */
1146 if (color
== WORK_NO_COLOR
)
1149 pwq
->nr_in_flight
[color
]--;
1152 if (!list_empty(&pwq
->delayed_works
)) {
1153 /* one down, submit a delayed one */
1154 if (pwq
->nr_active
< pwq
->max_active
)
1155 pwq_activate_first_delayed(pwq
);
1158 /* is flush in progress and are we at the flushing tip? */
1159 if (likely(pwq
->flush_color
!= color
))
1162 /* are there still in-flight works? */
1163 if (pwq
->nr_in_flight
[color
])
1166 /* this pwq is done, clear flush_color */
1167 pwq
->flush_color
= -1;
1170 * If this was the last pwq, wake up the first flusher. It
1171 * will handle the rest.
1173 if (atomic_dec_and_test(&pwq
->wq
->nr_pwqs_to_flush
))
1174 complete(&pwq
->wq
->first_flusher
->done
);
1180 * try_to_grab_pending - steal work item from worklist and disable irq
1181 * @work: work item to steal
1182 * @is_dwork: @work is a delayed_work
1183 * @flags: place to store irq state
1185 * Try to grab PENDING bit of @work. This function can handle @work in any
1186 * stable state - idle, on timer or on worklist.
1189 * 1 if @work was pending and we successfully stole PENDING
1190 * 0 if @work was idle and we claimed PENDING
1191 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
1192 * -ENOENT if someone else is canceling @work, this state may persist
1193 * for arbitrarily long
1196 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
1197 * interrupted while holding PENDING and @work off queue, irq must be
1198 * disabled on entry. This, combined with delayed_work->timer being
1199 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1201 * On successful return, >= 0, irq is disabled and the caller is
1202 * responsible for releasing it using local_irq_restore(*@flags).
1204 * This function is safe to call from any context including IRQ handler.
1206 static int try_to_grab_pending(struct work_struct
*work
, bool is_dwork
,
1207 unsigned long *flags
)
1209 struct worker_pool
*pool
;
1210 struct pool_workqueue
*pwq
;
1212 local_irq_save(*flags
);
1214 /* try to steal the timer if it exists */
1216 struct delayed_work
*dwork
= to_delayed_work(work
);
1219 * dwork->timer is irqsafe. If del_timer() fails, it's
1220 * guaranteed that the timer is not queued anywhere and not
1221 * running on the local CPU.
1223 if (likely(del_timer(&dwork
->timer
)))
1227 /* try to claim PENDING the normal way */
1228 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT
, work_data_bits(work
)))
1232 * The queueing is in progress, or it is already queued. Try to
1233 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1235 pool
= get_work_pool(work
);
1239 spin_lock(&pool
->lock
);
1241 * work->data is guaranteed to point to pwq only while the work
1242 * item is queued on pwq->wq, and both updating work->data to point
1243 * to pwq on queueing and to pool on dequeueing are done under
1244 * pwq->pool->lock. This in turn guarantees that, if work->data
1245 * points to pwq which is associated with a locked pool, the work
1246 * item is currently queued on that pool.
1248 pwq
= get_work_pwq(work
);
1249 if (pwq
&& pwq
->pool
== pool
) {
1250 debug_work_deactivate(work
);
1253 * A delayed work item cannot be grabbed directly because
1254 * it might have linked NO_COLOR work items which, if left
1255 * on the delayed_list, will confuse pwq->nr_active
1256 * management later on and cause stall. Make sure the work
1257 * item is activated before grabbing.
1259 if (*work_data_bits(work
) & WORK_STRUCT_DELAYED
)
1260 pwq_activate_delayed_work(work
);
1262 list_del_init(&work
->entry
);
1263 pwq_dec_nr_in_flight(pwq
, get_work_color(work
));
1265 /* work->data points to pwq iff queued, point to pool */
1266 set_work_pool_and_keep_pending(work
, pool
->id
);
1268 spin_unlock(&pool
->lock
);
1271 spin_unlock(&pool
->lock
);
1273 local_irq_restore(*flags
);
1274 if (work_is_canceling(work
))
1281 * insert_work - insert a work into a pool
1282 * @pwq: pwq @work belongs to
1283 * @work: work to insert
1284 * @head: insertion point
1285 * @extra_flags: extra WORK_STRUCT_* flags to set
1287 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
1288 * work_struct flags.
1291 * spin_lock_irq(pool->lock).
1293 static void insert_work(struct pool_workqueue
*pwq
, struct work_struct
*work
,
1294 struct list_head
*head
, unsigned int extra_flags
)
1296 struct worker_pool
*pool
= pwq
->pool
;
1298 /* we own @work, set data and link */
1299 set_work_pwq(work
, pwq
, extra_flags
);
1300 list_add_tail(&work
->entry
, head
);
1304 * Ensure either wq_worker_sleeping() sees the above
1305 * list_add_tail() or we see zero nr_running to avoid workers lying
1306 * around lazily while there are works to be processed.
1310 if (__need_more_worker(pool
))
1311 wake_up_worker(pool
);
1315 * Test whether @work is being queued from another work executing on the
1318 static bool is_chained_work(struct workqueue_struct
*wq
)
1320 struct worker
*worker
;
1322 worker
= current_wq_worker();
1324 * Return %true iff I'm a worker execuing a work item on @wq. If
1325 * I'm @worker, it's safe to dereference it without locking.
1327 return worker
&& worker
->current_pwq
->wq
== wq
;
1331 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1332 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1333 * avoid perturbing sensitive tasks.
1335 static int wq_select_unbound_cpu(int cpu
)
1337 static bool printed_dbg_warning
;
1340 if (likely(!wq_debug_force_rr_cpu
)) {
1341 if (cpumask_test_cpu(cpu
, wq_unbound_cpumask
))
1343 } else if (!printed_dbg_warning
) {
1344 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1345 printed_dbg_warning
= true;
1348 if (cpumask_empty(wq_unbound_cpumask
))
1351 new_cpu
= __this_cpu_read(wq_rr_cpu_last
);
1352 new_cpu
= cpumask_next_and(new_cpu
, wq_unbound_cpumask
, cpu_online_mask
);
1353 if (unlikely(new_cpu
>= nr_cpu_ids
)) {
1354 new_cpu
= cpumask_first_and(wq_unbound_cpumask
, cpu_online_mask
);
1355 if (unlikely(new_cpu
>= nr_cpu_ids
))
1358 __this_cpu_write(wq_rr_cpu_last
, new_cpu
);
1363 static void __queue_work(int cpu
, struct workqueue_struct
*wq
,
1364 struct work_struct
*work
)
1366 struct pool_workqueue
*pwq
;
1367 struct worker_pool
*last_pool
;
1368 struct list_head
*worklist
;
1369 unsigned int work_flags
;
1370 unsigned int req_cpu
= cpu
;
1373 * While a work item is PENDING && off queue, a task trying to
1374 * steal the PENDING will busy-loop waiting for it to either get
1375 * queued or lose PENDING. Grabbing PENDING and queueing should
1376 * happen with IRQ disabled.
1378 lockdep_assert_irqs_disabled();
1380 debug_work_activate(work
);
1382 /* if draining, only works from the same workqueue are allowed */
1383 if (unlikely(wq
->flags
& __WQ_DRAINING
) &&
1384 WARN_ON_ONCE(!is_chained_work(wq
)))
1387 if (req_cpu
== WORK_CPU_UNBOUND
)
1388 cpu
= wq_select_unbound_cpu(raw_smp_processor_id());
1390 /* pwq which will be used unless @work is executing elsewhere */
1391 if (!(wq
->flags
& WQ_UNBOUND
))
1392 pwq
= per_cpu_ptr(wq
->cpu_pwqs
, cpu
);
1394 pwq
= unbound_pwq_by_node(wq
, cpu_to_node(cpu
));
1397 * If @work was previously on a different pool, it might still be
1398 * running there, in which case the work needs to be queued on that
1399 * pool to guarantee non-reentrancy.
1401 last_pool
= get_work_pool(work
);
1402 if (last_pool
&& last_pool
!= pwq
->pool
) {
1403 struct worker
*worker
;
1405 spin_lock(&last_pool
->lock
);
1407 worker
= find_worker_executing_work(last_pool
, work
);
1409 if (worker
&& worker
->current_pwq
->wq
== wq
) {
1410 pwq
= worker
->current_pwq
;
1412 /* meh... not running there, queue here */
1413 spin_unlock(&last_pool
->lock
);
1414 spin_lock(&pwq
->pool
->lock
);
1417 spin_lock(&pwq
->pool
->lock
);
1421 * pwq is determined and locked. For unbound pools, we could have
1422 * raced with pwq release and it could already be dead. If its
1423 * refcnt is zero, repeat pwq selection. Note that pwqs never die
1424 * without another pwq replacing it in the numa_pwq_tbl or while
1425 * work items are executing on it, so the retrying is guaranteed to
1426 * make forward-progress.
1428 if (unlikely(!pwq
->refcnt
)) {
1429 if (wq
->flags
& WQ_UNBOUND
) {
1430 spin_unlock(&pwq
->pool
->lock
);
1435 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1439 /* pwq determined, queue */
1440 trace_workqueue_queue_work(req_cpu
, pwq
, work
);
1442 if (WARN_ON(!list_empty(&work
->entry
))) {
1443 spin_unlock(&pwq
->pool
->lock
);
1447 pwq
->nr_in_flight
[pwq
->work_color
]++;
1448 work_flags
= work_color_to_flags(pwq
->work_color
);
1450 if (likely(pwq
->nr_active
< pwq
->max_active
)) {
1451 trace_workqueue_activate_work(work
);
1453 worklist
= &pwq
->pool
->worklist
;
1454 if (list_empty(worklist
))
1455 pwq
->pool
->watchdog_ts
= jiffies
;
1457 work_flags
|= WORK_STRUCT_DELAYED
;
1458 worklist
= &pwq
->delayed_works
;
1461 insert_work(pwq
, work
, worklist
, work_flags
);
1463 spin_unlock(&pwq
->pool
->lock
);
1467 * queue_work_on - queue work on specific cpu
1468 * @cpu: CPU number to execute work on
1469 * @wq: workqueue to use
1470 * @work: work to queue
1472 * We queue the work to a specific CPU, the caller must ensure it
1475 * Return: %false if @work was already on a queue, %true otherwise.
1477 bool queue_work_on(int cpu
, struct workqueue_struct
*wq
,
1478 struct work_struct
*work
)
1481 unsigned long flags
;
1483 local_irq_save(flags
);
1485 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT
, work_data_bits(work
))) {
1486 __queue_work(cpu
, wq
, work
);
1490 local_irq_restore(flags
);
1493 EXPORT_SYMBOL(queue_work_on
);
1495 void delayed_work_timer_fn(struct timer_list
*t
)
1497 struct delayed_work
*dwork
= from_timer(dwork
, t
, timer
);
1499 /* should have been called from irqsafe timer with irq already off */
1500 __queue_work(dwork
->cpu
, dwork
->wq
, &dwork
->work
);
1502 EXPORT_SYMBOL(delayed_work_timer_fn
);
1504 static void __queue_delayed_work(int cpu
, struct workqueue_struct
*wq
,
1505 struct delayed_work
*dwork
, unsigned long delay
)
1507 struct timer_list
*timer
= &dwork
->timer
;
1508 struct work_struct
*work
= &dwork
->work
;
1511 WARN_ON_ONCE(timer
->function
!= delayed_work_timer_fn
);
1512 WARN_ON_ONCE(timer_pending(timer
));
1513 WARN_ON_ONCE(!list_empty(&work
->entry
));
1516 * If @delay is 0, queue @dwork->work immediately. This is for
1517 * both optimization and correctness. The earliest @timer can
1518 * expire is on the closest next tick and delayed_work users depend
1519 * on that there's no such delay when @delay is 0.
1522 __queue_work(cpu
, wq
, &dwork
->work
);
1528 timer
->expires
= jiffies
+ delay
;
1530 if (unlikely(cpu
!= WORK_CPU_UNBOUND
))
1531 add_timer_on(timer
, cpu
);
1537 * queue_delayed_work_on - queue work on specific CPU after delay
1538 * @cpu: CPU number to execute work on
1539 * @wq: workqueue to use
1540 * @dwork: work to queue
1541 * @delay: number of jiffies to wait before queueing
1543 * Return: %false if @work was already on a queue, %true otherwise. If
1544 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1547 bool queue_delayed_work_on(int cpu
, struct workqueue_struct
*wq
,
1548 struct delayed_work
*dwork
, unsigned long delay
)
1550 struct work_struct
*work
= &dwork
->work
;
1552 unsigned long flags
;
1554 /* read the comment in __queue_work() */
1555 local_irq_save(flags
);
1557 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT
, work_data_bits(work
))) {
1558 __queue_delayed_work(cpu
, wq
, dwork
, delay
);
1562 local_irq_restore(flags
);
1565 EXPORT_SYMBOL(queue_delayed_work_on
);
1568 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1569 * @cpu: CPU number to execute work on
1570 * @wq: workqueue to use
1571 * @dwork: work to queue
1572 * @delay: number of jiffies to wait before queueing
1574 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1575 * modify @dwork's timer so that it expires after @delay. If @delay is
1576 * zero, @work is guaranteed to be scheduled immediately regardless of its
1579 * Return: %false if @dwork was idle and queued, %true if @dwork was
1580 * pending and its timer was modified.
1582 * This function is safe to call from any context including IRQ handler.
1583 * See try_to_grab_pending() for details.
1585 bool mod_delayed_work_on(int cpu
, struct workqueue_struct
*wq
,
1586 struct delayed_work
*dwork
, unsigned long delay
)
1588 unsigned long flags
;
1592 ret
= try_to_grab_pending(&dwork
->work
, true, &flags
);
1593 } while (unlikely(ret
== -EAGAIN
));
1595 if (likely(ret
>= 0)) {
1596 __queue_delayed_work(cpu
, wq
, dwork
, delay
);
1597 local_irq_restore(flags
);
1600 /* -ENOENT from try_to_grab_pending() becomes %true */
1603 EXPORT_SYMBOL_GPL(mod_delayed_work_on
);
1605 static void rcu_work_rcufn(struct rcu_head
*rcu
)
1607 struct rcu_work
*rwork
= container_of(rcu
, struct rcu_work
, rcu
);
1609 /* read the comment in __queue_work() */
1610 local_irq_disable();
1611 __queue_work(WORK_CPU_UNBOUND
, rwork
->wq
, &rwork
->work
);
1616 * queue_rcu_work - queue work after a RCU grace period
1617 * @wq: workqueue to use
1618 * @rwork: work to queue
1620 * Return: %false if @rwork was already pending, %true otherwise. Note
1621 * that a full RCU grace period is guaranteed only after a %true return.
1622 * While @rwork is guarnateed to be executed after a %false return, the
1623 * execution may happen before a full RCU grace period has passed.
1625 bool queue_rcu_work(struct workqueue_struct
*wq
, struct rcu_work
*rwork
)
1627 struct work_struct
*work
= &rwork
->work
;
1629 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT
, work_data_bits(work
))) {
1631 call_rcu(&rwork
->rcu
, rcu_work_rcufn
);
1637 EXPORT_SYMBOL(queue_rcu_work
);
1640 * worker_enter_idle - enter idle state
1641 * @worker: worker which is entering idle state
1643 * @worker is entering idle state. Update stats and idle timer if
1647 * spin_lock_irq(pool->lock).
1649 static void worker_enter_idle(struct worker
*worker
)
1651 struct worker_pool
*pool
= worker
->pool
;
1653 if (WARN_ON_ONCE(worker
->flags
& WORKER_IDLE
) ||
1654 WARN_ON_ONCE(!list_empty(&worker
->entry
) &&
1655 (worker
->hentry
.next
|| worker
->hentry
.pprev
)))
1658 /* can't use worker_set_flags(), also called from create_worker() */
1659 worker
->flags
|= WORKER_IDLE
;
1661 worker
->last_active
= jiffies
;
1663 /* idle_list is LIFO */
1664 list_add(&worker
->entry
, &pool
->idle_list
);
1666 if (too_many_workers(pool
) && !timer_pending(&pool
->idle_timer
))
1667 mod_timer(&pool
->idle_timer
, jiffies
+ IDLE_WORKER_TIMEOUT
);
1670 * Sanity check nr_running. Because unbind_workers() releases
1671 * pool->lock between setting %WORKER_UNBOUND and zapping
1672 * nr_running, the warning may trigger spuriously. Check iff
1673 * unbind is not in progress.
1675 WARN_ON_ONCE(!(pool
->flags
& POOL_DISASSOCIATED
) &&
1676 pool
->nr_workers
== pool
->nr_idle
&&
1677 atomic_read(&pool
->nr_running
));
1681 * worker_leave_idle - leave idle state
1682 * @worker: worker which is leaving idle state
1684 * @worker is leaving idle state. Update stats.
1687 * spin_lock_irq(pool->lock).
1689 static void worker_leave_idle(struct worker
*worker
)
1691 struct worker_pool
*pool
= worker
->pool
;
1693 if (WARN_ON_ONCE(!(worker
->flags
& WORKER_IDLE
)))
1695 worker_clr_flags(worker
, WORKER_IDLE
);
1697 list_del_init(&worker
->entry
);
1700 static struct worker
*alloc_worker(int node
)
1702 struct worker
*worker
;
1704 worker
= kzalloc_node(sizeof(*worker
), GFP_KERNEL
, node
);
1706 INIT_LIST_HEAD(&worker
->entry
);
1707 INIT_LIST_HEAD(&worker
->scheduled
);
1708 INIT_LIST_HEAD(&worker
->node
);
1709 /* on creation a worker is in !idle && prep state */
1710 worker
->flags
= WORKER_PREP
;
1716 * worker_attach_to_pool() - attach a worker to a pool
1717 * @worker: worker to be attached
1718 * @pool: the target pool
1720 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1721 * cpu-binding of @worker are kept coordinated with the pool across
1724 static void worker_attach_to_pool(struct worker
*worker
,
1725 struct worker_pool
*pool
)
1727 mutex_lock(&wq_pool_attach_mutex
);
1730 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1731 * online CPUs. It'll be re-applied when any of the CPUs come up.
1733 set_cpus_allowed_ptr(worker
->task
, pool
->attrs
->cpumask
);
1736 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1737 * stable across this function. See the comments above the flag
1738 * definition for details.
1740 if (pool
->flags
& POOL_DISASSOCIATED
)
1741 worker
->flags
|= WORKER_UNBOUND
;
1743 list_add_tail(&worker
->node
, &pool
->workers
);
1744 worker
->pool
= pool
;
1746 mutex_unlock(&wq_pool_attach_mutex
);
1750 * worker_detach_from_pool() - detach a worker from its pool
1751 * @worker: worker which is attached to its pool
1753 * Undo the attaching which had been done in worker_attach_to_pool(). The
1754 * caller worker shouldn't access to the pool after detached except it has
1755 * other reference to the pool.
1757 static void worker_detach_from_pool(struct worker
*worker
)
1759 struct worker_pool
*pool
= worker
->pool
;
1760 struct completion
*detach_completion
= NULL
;
1762 mutex_lock(&wq_pool_attach_mutex
);
1764 list_del(&worker
->node
);
1765 worker
->pool
= NULL
;
1767 if (list_empty(&pool
->workers
))
1768 detach_completion
= pool
->detach_completion
;
1769 mutex_unlock(&wq_pool_attach_mutex
);
1771 /* clear leftover flags without pool->lock after it is detached */
1772 worker
->flags
&= ~(WORKER_UNBOUND
| WORKER_REBOUND
);
1774 if (detach_completion
)
1775 complete(detach_completion
);
1779 * create_worker - create a new workqueue worker
1780 * @pool: pool the new worker will belong to
1782 * Create and start a new worker which is attached to @pool.
1785 * Might sleep. Does GFP_KERNEL allocations.
1788 * Pointer to the newly created worker.
1790 static struct worker
*create_worker(struct worker_pool
*pool
)
1792 struct worker
*worker
= NULL
;
1796 /* ID is needed to determine kthread name */
1797 id
= ida_simple_get(&pool
->worker_ida
, 0, 0, GFP_KERNEL
);
1801 worker
= alloc_worker(pool
->node
);
1808 snprintf(id_buf
, sizeof(id_buf
), "%d:%d%s", pool
->cpu
, id
,
1809 pool
->attrs
->nice
< 0 ? "H" : "");
1811 snprintf(id_buf
, sizeof(id_buf
), "u%d:%d", pool
->id
, id
);
1813 worker
->task
= kthread_create_on_node(worker_thread
, worker
, pool
->node
,
1814 "kworker/%s", id_buf
);
1815 if (IS_ERR(worker
->task
))
1818 set_user_nice(worker
->task
, pool
->attrs
->nice
);
1819 kthread_bind_mask(worker
->task
, pool
->attrs
->cpumask
);
1821 /* successful, attach the worker to the pool */
1822 worker_attach_to_pool(worker
, pool
);
1824 /* start the newly created worker */
1825 spin_lock_irq(&pool
->lock
);
1826 worker
->pool
->nr_workers
++;
1827 worker_enter_idle(worker
);
1828 wake_up_process(worker
->task
);
1829 spin_unlock_irq(&pool
->lock
);
1835 ida_simple_remove(&pool
->worker_ida
, id
);
1841 * destroy_worker - destroy a workqueue worker
1842 * @worker: worker to be destroyed
1844 * Destroy @worker and adjust @pool stats accordingly. The worker should
1848 * spin_lock_irq(pool->lock).
1850 static void destroy_worker(struct worker
*worker
)
1852 struct worker_pool
*pool
= worker
->pool
;
1854 lockdep_assert_held(&pool
->lock
);
1856 /* sanity check frenzy */
1857 if (WARN_ON(worker
->current_work
) ||
1858 WARN_ON(!list_empty(&worker
->scheduled
)) ||
1859 WARN_ON(!(worker
->flags
& WORKER_IDLE
)))
1865 list_del_init(&worker
->entry
);
1866 worker
->flags
|= WORKER_DIE
;
1867 wake_up_process(worker
->task
);
1870 static void idle_worker_timeout(struct timer_list
*t
)
1872 struct worker_pool
*pool
= from_timer(pool
, t
, idle_timer
);
1874 spin_lock_irq(&pool
->lock
);
1876 while (too_many_workers(pool
)) {
1877 struct worker
*worker
;
1878 unsigned long expires
;
1880 /* idle_list is kept in LIFO order, check the last one */
1881 worker
= list_entry(pool
->idle_list
.prev
, struct worker
, entry
);
1882 expires
= worker
->last_active
+ IDLE_WORKER_TIMEOUT
;
1884 if (time_before(jiffies
, expires
)) {
1885 mod_timer(&pool
->idle_timer
, expires
);
1889 destroy_worker(worker
);
1892 spin_unlock_irq(&pool
->lock
);
1895 static void send_mayday(struct work_struct
*work
)
1897 struct pool_workqueue
*pwq
= get_work_pwq(work
);
1898 struct workqueue_struct
*wq
= pwq
->wq
;
1900 lockdep_assert_held(&wq_mayday_lock
);
1905 /* mayday mayday mayday */
1906 if (list_empty(&pwq
->mayday_node
)) {
1908 * If @pwq is for an unbound wq, its base ref may be put at
1909 * any time due to an attribute change. Pin @pwq until the
1910 * rescuer is done with it.
1913 list_add_tail(&pwq
->mayday_node
, &wq
->maydays
);
1914 wake_up_process(wq
->rescuer
->task
);
1918 static void pool_mayday_timeout(struct timer_list
*t
)
1920 struct worker_pool
*pool
= from_timer(pool
, t
, mayday_timer
);
1921 struct work_struct
*work
;
1923 spin_lock_irq(&pool
->lock
);
1924 spin_lock(&wq_mayday_lock
); /* for wq->maydays */
1926 if (need_to_create_worker(pool
)) {
1928 * We've been trying to create a new worker but
1929 * haven't been successful. We might be hitting an
1930 * allocation deadlock. Send distress signals to
1933 list_for_each_entry(work
, &pool
->worklist
, entry
)
1937 spin_unlock(&wq_mayday_lock
);
1938 spin_unlock_irq(&pool
->lock
);
1940 mod_timer(&pool
->mayday_timer
, jiffies
+ MAYDAY_INTERVAL
);
1944 * maybe_create_worker - create a new worker if necessary
1945 * @pool: pool to create a new worker for
1947 * Create a new worker for @pool if necessary. @pool is guaranteed to
1948 * have at least one idle worker on return from this function. If
1949 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1950 * sent to all rescuers with works scheduled on @pool to resolve
1951 * possible allocation deadlock.
1953 * On return, need_to_create_worker() is guaranteed to be %false and
1954 * may_start_working() %true.
1957 * spin_lock_irq(pool->lock) which may be released and regrabbed
1958 * multiple times. Does GFP_KERNEL allocations. Called only from
1961 static void maybe_create_worker(struct worker_pool
*pool
)
1962 __releases(&pool
->lock
)
1963 __acquires(&pool
->lock
)
1966 spin_unlock_irq(&pool
->lock
);
1968 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1969 mod_timer(&pool
->mayday_timer
, jiffies
+ MAYDAY_INITIAL_TIMEOUT
);
1972 if (create_worker(pool
) || !need_to_create_worker(pool
))
1975 schedule_timeout_interruptible(CREATE_COOLDOWN
);
1977 if (!need_to_create_worker(pool
))
1981 del_timer_sync(&pool
->mayday_timer
);
1982 spin_lock_irq(&pool
->lock
);
1984 * This is necessary even after a new worker was just successfully
1985 * created as @pool->lock was dropped and the new worker might have
1986 * already become busy.
1988 if (need_to_create_worker(pool
))
1993 * manage_workers - manage worker pool
1996 * Assume the manager role and manage the worker pool @worker belongs
1997 * to. At any given time, there can be only zero or one manager per
1998 * pool. The exclusion is handled automatically by this function.
2000 * The caller can safely start processing works on false return. On
2001 * true return, it's guaranteed that need_to_create_worker() is false
2002 * and may_start_working() is true.
2005 * spin_lock_irq(pool->lock) which may be released and regrabbed
2006 * multiple times. Does GFP_KERNEL allocations.
2009 * %false if the pool doesn't need management and the caller can safely
2010 * start processing works, %true if management function was performed and
2011 * the conditions that the caller verified before calling the function may
2012 * no longer be true.
2014 static bool manage_workers(struct worker
*worker
)
2016 struct worker_pool
*pool
= worker
->pool
;
2018 if (pool
->flags
& POOL_MANAGER_ACTIVE
)
2021 pool
->flags
|= POOL_MANAGER_ACTIVE
;
2022 pool
->manager
= worker
;
2024 maybe_create_worker(pool
);
2026 pool
->manager
= NULL
;
2027 pool
->flags
&= ~POOL_MANAGER_ACTIVE
;
2028 wake_up(&wq_manager_wait
);
2033 * process_one_work - process single work
2035 * @work: work to process
2037 * Process @work. This function contains all the logics necessary to
2038 * process a single work including synchronization against and
2039 * interaction with other workers on the same cpu, queueing and
2040 * flushing. As long as context requirement is met, any worker can
2041 * call this function to process a work.
2044 * spin_lock_irq(pool->lock) which is released and regrabbed.
2046 static void process_one_work(struct worker
*worker
, struct work_struct
*work
)
2047 __releases(&pool
->lock
)
2048 __acquires(&pool
->lock
)
2050 struct pool_workqueue
*pwq
= get_work_pwq(work
);
2051 struct worker_pool
*pool
= worker
->pool
;
2052 bool cpu_intensive
= pwq
->wq
->flags
& WQ_CPU_INTENSIVE
;
2054 struct worker
*collision
;
2055 #ifdef CONFIG_LOCKDEP
2057 * It is permissible to free the struct work_struct from
2058 * inside the function that is called from it, this we need to
2059 * take into account for lockdep too. To avoid bogus "held
2060 * lock freed" warnings as well as problems when looking into
2061 * work->lockdep_map, make a copy and use that here.
2063 struct lockdep_map lockdep_map
;
2065 lockdep_copy_map(&lockdep_map
, &work
->lockdep_map
);
2067 /* ensure we're on the correct CPU */
2068 WARN_ON_ONCE(!(pool
->flags
& POOL_DISASSOCIATED
) &&
2069 raw_smp_processor_id() != pool
->cpu
);
2072 * A single work shouldn't be executed concurrently by
2073 * multiple workers on a single cpu. Check whether anyone is
2074 * already processing the work. If so, defer the work to the
2075 * currently executing one.
2077 collision
= find_worker_executing_work(pool
, work
);
2078 if (unlikely(collision
)) {
2079 move_linked_works(work
, &collision
->scheduled
, NULL
);
2083 /* claim and dequeue */
2084 debug_work_deactivate(work
);
2085 hash_add(pool
->busy_hash
, &worker
->hentry
, (unsigned long)work
);
2086 worker
->current_work
= work
;
2087 worker
->current_func
= work
->func
;
2088 worker
->current_pwq
= pwq
;
2089 work_color
= get_work_color(work
);
2092 * Record wq name for cmdline and debug reporting, may get
2093 * overridden through set_worker_desc().
2095 strscpy(worker
->desc
, pwq
->wq
->name
, WORKER_DESC_LEN
);
2097 list_del_init(&work
->entry
);
2100 * CPU intensive works don't participate in concurrency management.
2101 * They're the scheduler's responsibility. This takes @worker out
2102 * of concurrency management and the next code block will chain
2103 * execution of the pending work items.
2105 if (unlikely(cpu_intensive
))
2106 worker_set_flags(worker
, WORKER_CPU_INTENSIVE
);
2109 * Wake up another worker if necessary. The condition is always
2110 * false for normal per-cpu workers since nr_running would always
2111 * be >= 1 at this point. This is used to chain execution of the
2112 * pending work items for WORKER_NOT_RUNNING workers such as the
2113 * UNBOUND and CPU_INTENSIVE ones.
2115 if (need_more_worker(pool
))
2116 wake_up_worker(pool
);
2119 * Record the last pool and clear PENDING which should be the last
2120 * update to @work. Also, do this inside @pool->lock so that
2121 * PENDING and queued state changes happen together while IRQ is
2124 set_work_pool_and_clear_pending(work
, pool
->id
);
2126 spin_unlock_irq(&pool
->lock
);
2128 lock_map_acquire(&pwq
->wq
->lockdep_map
);
2129 lock_map_acquire(&lockdep_map
);
2131 * Strictly speaking we should mark the invariant state without holding
2132 * any locks, that is, before these two lock_map_acquire()'s.
2134 * However, that would result in:
2141 * Which would create W1->C->W1 dependencies, even though there is no
2142 * actual deadlock possible. There are two solutions, using a
2143 * read-recursive acquire on the work(queue) 'locks', but this will then
2144 * hit the lockdep limitation on recursive locks, or simply discard
2147 * AFAICT there is no possible deadlock scenario between the
2148 * flush_work() and complete() primitives (except for single-threaded
2149 * workqueues), so hiding them isn't a problem.
2151 lockdep_invariant_state(true);
2152 trace_workqueue_execute_start(work
);
2153 worker
->current_func(work
);
2155 * While we must be careful to not use "work" after this, the trace
2156 * point will only record its address.
2158 trace_workqueue_execute_end(work
);
2159 lock_map_release(&lockdep_map
);
2160 lock_map_release(&pwq
->wq
->lockdep_map
);
2162 if (unlikely(in_atomic() || lockdep_depth(current
) > 0)) {
2163 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2164 " last function: %pf\n",
2165 current
->comm
, preempt_count(), task_pid_nr(current
),
2166 worker
->current_func
);
2167 debug_show_held_locks(current
);
2172 * The following prevents a kworker from hogging CPU on !PREEMPT
2173 * kernels, where a requeueing work item waiting for something to
2174 * happen could deadlock with stop_machine as such work item could
2175 * indefinitely requeue itself while all other CPUs are trapped in
2176 * stop_machine. At the same time, report a quiescent RCU state so
2177 * the same condition doesn't freeze RCU.
2181 spin_lock_irq(&pool
->lock
);
2183 /* clear cpu intensive status */
2184 if (unlikely(cpu_intensive
))
2185 worker_clr_flags(worker
, WORKER_CPU_INTENSIVE
);
2187 /* we're done with it, release */
2188 hash_del(&worker
->hentry
);
2189 worker
->current_work
= NULL
;
2190 worker
->current_func
= NULL
;
2191 worker
->current_pwq
= NULL
;
2192 pwq_dec_nr_in_flight(pwq
, work_color
);
2196 * process_scheduled_works - process scheduled works
2199 * Process all scheduled works. Please note that the scheduled list
2200 * may change while processing a work, so this function repeatedly
2201 * fetches a work from the top and executes it.
2204 * spin_lock_irq(pool->lock) which may be released and regrabbed
2207 static void process_scheduled_works(struct worker
*worker
)
2209 while (!list_empty(&worker
->scheduled
)) {
2210 struct work_struct
*work
= list_first_entry(&worker
->scheduled
,
2211 struct work_struct
, entry
);
2212 process_one_work(worker
, work
);
2216 static void set_pf_worker(bool val
)
2218 mutex_lock(&wq_pool_attach_mutex
);
2220 current
->flags
|= PF_WQ_WORKER
;
2222 current
->flags
&= ~PF_WQ_WORKER
;
2223 mutex_unlock(&wq_pool_attach_mutex
);
2227 * worker_thread - the worker thread function
2230 * The worker thread function. All workers belong to a worker_pool -
2231 * either a per-cpu one or dynamic unbound one. These workers process all
2232 * work items regardless of their specific target workqueue. The only
2233 * exception is work items which belong to workqueues with a rescuer which
2234 * will be explained in rescuer_thread().
2238 static int worker_thread(void *__worker
)
2240 struct worker
*worker
= __worker
;
2241 struct worker_pool
*pool
= worker
->pool
;
2243 /* tell the scheduler that this is a workqueue worker */
2244 set_pf_worker(true);
2246 spin_lock_irq(&pool
->lock
);
2248 /* am I supposed to die? */
2249 if (unlikely(worker
->flags
& WORKER_DIE
)) {
2250 spin_unlock_irq(&pool
->lock
);
2251 WARN_ON_ONCE(!list_empty(&worker
->entry
));
2252 set_pf_worker(false);
2254 set_task_comm(worker
->task
, "kworker/dying");
2255 ida_simple_remove(&pool
->worker_ida
, worker
->id
);
2256 worker_detach_from_pool(worker
);
2261 worker_leave_idle(worker
);
2263 /* no more worker necessary? */
2264 if (!need_more_worker(pool
))
2267 /* do we need to manage? */
2268 if (unlikely(!may_start_working(pool
)) && manage_workers(worker
))
2272 * ->scheduled list can only be filled while a worker is
2273 * preparing to process a work or actually processing it.
2274 * Make sure nobody diddled with it while I was sleeping.
2276 WARN_ON_ONCE(!list_empty(&worker
->scheduled
));
2279 * Finish PREP stage. We're guaranteed to have at least one idle
2280 * worker or that someone else has already assumed the manager
2281 * role. This is where @worker starts participating in concurrency
2282 * management if applicable and concurrency management is restored
2283 * after being rebound. See rebind_workers() for details.
2285 worker_clr_flags(worker
, WORKER_PREP
| WORKER_REBOUND
);
2288 struct work_struct
*work
=
2289 list_first_entry(&pool
->worklist
,
2290 struct work_struct
, entry
);
2292 pool
->watchdog_ts
= jiffies
;
2294 if (likely(!(*work_data_bits(work
) & WORK_STRUCT_LINKED
))) {
2295 /* optimization path, not strictly necessary */
2296 process_one_work(worker
, work
);
2297 if (unlikely(!list_empty(&worker
->scheduled
)))
2298 process_scheduled_works(worker
);
2300 move_linked_works(work
, &worker
->scheduled
, NULL
);
2301 process_scheduled_works(worker
);
2303 } while (keep_working(pool
));
2305 worker_set_flags(worker
, WORKER_PREP
);
2308 * pool->lock is held and there's no work to process and no need to
2309 * manage, sleep. Workers are woken up only while holding
2310 * pool->lock or from local cpu, so setting the current state
2311 * before releasing pool->lock is enough to prevent losing any
2314 worker_enter_idle(worker
);
2315 __set_current_state(TASK_IDLE
);
2316 spin_unlock_irq(&pool
->lock
);
2322 * rescuer_thread - the rescuer thread function
2325 * Workqueue rescuer thread function. There's one rescuer for each
2326 * workqueue which has WQ_MEM_RECLAIM set.
2328 * Regular work processing on a pool may block trying to create a new
2329 * worker which uses GFP_KERNEL allocation which has slight chance of
2330 * developing into deadlock if some works currently on the same queue
2331 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2332 * the problem rescuer solves.
2334 * When such condition is possible, the pool summons rescuers of all
2335 * workqueues which have works queued on the pool and let them process
2336 * those works so that forward progress can be guaranteed.
2338 * This should happen rarely.
2342 static int rescuer_thread(void *__rescuer
)
2344 struct worker
*rescuer
= __rescuer
;
2345 struct workqueue_struct
*wq
= rescuer
->rescue_wq
;
2346 struct list_head
*scheduled
= &rescuer
->scheduled
;
2349 set_user_nice(current
, RESCUER_NICE_LEVEL
);
2352 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2353 * doesn't participate in concurrency management.
2355 set_pf_worker(true);
2357 set_current_state(TASK_IDLE
);
2360 * By the time the rescuer is requested to stop, the workqueue
2361 * shouldn't have any work pending, but @wq->maydays may still have
2362 * pwq(s) queued. This can happen by non-rescuer workers consuming
2363 * all the work items before the rescuer got to them. Go through
2364 * @wq->maydays processing before acting on should_stop so that the
2365 * list is always empty on exit.
2367 should_stop
= kthread_should_stop();
2369 /* see whether any pwq is asking for help */
2370 spin_lock_irq(&wq_mayday_lock
);
2372 while (!list_empty(&wq
->maydays
)) {
2373 struct pool_workqueue
*pwq
= list_first_entry(&wq
->maydays
,
2374 struct pool_workqueue
, mayday_node
);
2375 struct worker_pool
*pool
= pwq
->pool
;
2376 struct work_struct
*work
, *n
;
2379 __set_current_state(TASK_RUNNING
);
2380 list_del_init(&pwq
->mayday_node
);
2382 spin_unlock_irq(&wq_mayday_lock
);
2384 worker_attach_to_pool(rescuer
, pool
);
2386 spin_lock_irq(&pool
->lock
);
2389 * Slurp in all works issued via this workqueue and
2392 WARN_ON_ONCE(!list_empty(scheduled
));
2393 list_for_each_entry_safe(work
, n
, &pool
->worklist
, entry
) {
2394 if (get_work_pwq(work
) == pwq
) {
2396 pool
->watchdog_ts
= jiffies
;
2397 move_linked_works(work
, scheduled
, &n
);
2402 if (!list_empty(scheduled
)) {
2403 process_scheduled_works(rescuer
);
2406 * The above execution of rescued work items could
2407 * have created more to rescue through
2408 * pwq_activate_first_delayed() or chained
2409 * queueing. Let's put @pwq back on mayday list so
2410 * that such back-to-back work items, which may be
2411 * being used to relieve memory pressure, don't
2412 * incur MAYDAY_INTERVAL delay inbetween.
2414 if (need_to_create_worker(pool
)) {
2415 spin_lock(&wq_mayday_lock
);
2417 * Queue iff we aren't racing destruction
2418 * and somebody else hasn't queued it already.
2420 if (wq
->rescuer
&& list_empty(&pwq
->mayday_node
)) {
2422 list_add_tail(&pwq
->mayday_node
, &wq
->maydays
);
2424 spin_unlock(&wq_mayday_lock
);
2429 * Put the reference grabbed by send_mayday(). @pool won't
2430 * go away while we're still attached to it.
2435 * Leave this pool. If need_more_worker() is %true, notify a
2436 * regular worker; otherwise, we end up with 0 concurrency
2437 * and stalling the execution.
2439 if (need_more_worker(pool
))
2440 wake_up_worker(pool
);
2442 spin_unlock_irq(&pool
->lock
);
2444 worker_detach_from_pool(rescuer
);
2446 spin_lock_irq(&wq_mayday_lock
);
2449 spin_unlock_irq(&wq_mayday_lock
);
2452 __set_current_state(TASK_RUNNING
);
2453 set_pf_worker(false);
2457 /* rescuers should never participate in concurrency management */
2458 WARN_ON_ONCE(!(rescuer
->flags
& WORKER_NOT_RUNNING
));
2464 * check_flush_dependency - check for flush dependency sanity
2465 * @target_wq: workqueue being flushed
2466 * @target_work: work item being flushed (NULL for workqueue flushes)
2468 * %current is trying to flush the whole @target_wq or @target_work on it.
2469 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2470 * reclaiming memory or running on a workqueue which doesn't have
2471 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2474 static void check_flush_dependency(struct workqueue_struct
*target_wq
,
2475 struct work_struct
*target_work
)
2477 work_func_t target_func
= target_work
? target_work
->func
: NULL
;
2478 struct worker
*worker
;
2480 if (target_wq
->flags
& WQ_MEM_RECLAIM
)
2483 worker
= current_wq_worker();
2485 WARN_ONCE(current
->flags
& PF_MEMALLOC
,
2486 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2487 current
->pid
, current
->comm
, target_wq
->name
, target_func
);
2488 WARN_ONCE(worker
&& ((worker
->current_pwq
->wq
->flags
&
2489 (WQ_MEM_RECLAIM
| __WQ_LEGACY
)) == WQ_MEM_RECLAIM
),
2490 "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2491 worker
->current_pwq
->wq
->name
, worker
->current_func
,
2492 target_wq
->name
, target_func
);
2496 struct work_struct work
;
2497 struct completion done
;
2498 struct task_struct
*task
; /* purely informational */
2501 static void wq_barrier_func(struct work_struct
*work
)
2503 struct wq_barrier
*barr
= container_of(work
, struct wq_barrier
, work
);
2504 complete(&barr
->done
);
2508 * insert_wq_barrier - insert a barrier work
2509 * @pwq: pwq to insert barrier into
2510 * @barr: wq_barrier to insert
2511 * @target: target work to attach @barr to
2512 * @worker: worker currently executing @target, NULL if @target is not executing
2514 * @barr is linked to @target such that @barr is completed only after
2515 * @target finishes execution. Please note that the ordering
2516 * guarantee is observed only with respect to @target and on the local
2519 * Currently, a queued barrier can't be canceled. This is because
2520 * try_to_grab_pending() can't determine whether the work to be
2521 * grabbed is at the head of the queue and thus can't clear LINKED
2522 * flag of the previous work while there must be a valid next work
2523 * after a work with LINKED flag set.
2525 * Note that when @worker is non-NULL, @target may be modified
2526 * underneath us, so we can't reliably determine pwq from @target.
2529 * spin_lock_irq(pool->lock).
2531 static void insert_wq_barrier(struct pool_workqueue
*pwq
,
2532 struct wq_barrier
*barr
,
2533 struct work_struct
*target
, struct worker
*worker
)
2535 struct list_head
*head
;
2536 unsigned int linked
= 0;
2539 * debugobject calls are safe here even with pool->lock locked
2540 * as we know for sure that this will not trigger any of the
2541 * checks and call back into the fixup functions where we
2544 INIT_WORK_ONSTACK(&barr
->work
, wq_barrier_func
);
2545 __set_bit(WORK_STRUCT_PENDING_BIT
, work_data_bits(&barr
->work
));
2547 init_completion_map(&barr
->done
, &target
->lockdep_map
);
2549 barr
->task
= current
;
2552 * If @target is currently being executed, schedule the
2553 * barrier to the worker; otherwise, put it after @target.
2556 head
= worker
->scheduled
.next
;
2558 unsigned long *bits
= work_data_bits(target
);
2560 head
= target
->entry
.next
;
2561 /* there can already be other linked works, inherit and set */
2562 linked
= *bits
& WORK_STRUCT_LINKED
;
2563 __set_bit(WORK_STRUCT_LINKED_BIT
, bits
);
2566 debug_work_activate(&barr
->work
);
2567 insert_work(pwq
, &barr
->work
, head
,
2568 work_color_to_flags(WORK_NO_COLOR
) | linked
);
2572 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
2573 * @wq: workqueue being flushed
2574 * @flush_color: new flush color, < 0 for no-op
2575 * @work_color: new work color, < 0 for no-op
2577 * Prepare pwqs for workqueue flushing.
2579 * If @flush_color is non-negative, flush_color on all pwqs should be
2580 * -1. If no pwq has in-flight commands at the specified color, all
2581 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2582 * has in flight commands, its pwq->flush_color is set to
2583 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
2584 * wakeup logic is armed and %true is returned.
2586 * The caller should have initialized @wq->first_flusher prior to
2587 * calling this function with non-negative @flush_color. If
2588 * @flush_color is negative, no flush color update is done and %false
2591 * If @work_color is non-negative, all pwqs should have the same
2592 * work_color which is previous to @work_color and all will be
2593 * advanced to @work_color.
2596 * mutex_lock(wq->mutex).
2599 * %true if @flush_color >= 0 and there's something to flush. %false
2602 static bool flush_workqueue_prep_pwqs(struct workqueue_struct
*wq
,
2603 int flush_color
, int work_color
)
2606 struct pool_workqueue
*pwq
;
2608 if (flush_color
>= 0) {
2609 WARN_ON_ONCE(atomic_read(&wq
->nr_pwqs_to_flush
));
2610 atomic_set(&wq
->nr_pwqs_to_flush
, 1);
2613 for_each_pwq(pwq
, wq
) {
2614 struct worker_pool
*pool
= pwq
->pool
;
2616 spin_lock_irq(&pool
->lock
);
2618 if (flush_color
>= 0) {
2619 WARN_ON_ONCE(pwq
->flush_color
!= -1);
2621 if (pwq
->nr_in_flight
[flush_color
]) {
2622 pwq
->flush_color
= flush_color
;
2623 atomic_inc(&wq
->nr_pwqs_to_flush
);
2628 if (work_color
>= 0) {
2629 WARN_ON_ONCE(work_color
!= work_next_color(pwq
->work_color
));
2630 pwq
->work_color
= work_color
;
2633 spin_unlock_irq(&pool
->lock
);
2636 if (flush_color
>= 0 && atomic_dec_and_test(&wq
->nr_pwqs_to_flush
))
2637 complete(&wq
->first_flusher
->done
);
2643 * flush_workqueue - ensure that any scheduled work has run to completion.
2644 * @wq: workqueue to flush
2646 * This function sleeps until all work items which were queued on entry
2647 * have finished execution, but it is not livelocked by new incoming ones.
2649 void flush_workqueue(struct workqueue_struct
*wq
)
2651 struct wq_flusher this_flusher
= {
2652 .list
= LIST_HEAD_INIT(this_flusher
.list
),
2654 .done
= COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher
.done
, wq
->lockdep_map
),
2658 if (WARN_ON(!wq_online
))
2661 lock_map_acquire(&wq
->lockdep_map
);
2662 lock_map_release(&wq
->lockdep_map
);
2664 mutex_lock(&wq
->mutex
);
2667 * Start-to-wait phase
2669 next_color
= work_next_color(wq
->work_color
);
2671 if (next_color
!= wq
->flush_color
) {
2673 * Color space is not full. The current work_color
2674 * becomes our flush_color and work_color is advanced
2677 WARN_ON_ONCE(!list_empty(&wq
->flusher_overflow
));
2678 this_flusher
.flush_color
= wq
->work_color
;
2679 wq
->work_color
= next_color
;
2681 if (!wq
->first_flusher
) {
2682 /* no flush in progress, become the first flusher */
2683 WARN_ON_ONCE(wq
->flush_color
!= this_flusher
.flush_color
);
2685 wq
->first_flusher
= &this_flusher
;
2687 if (!flush_workqueue_prep_pwqs(wq
, wq
->flush_color
,
2689 /* nothing to flush, done */
2690 wq
->flush_color
= next_color
;
2691 wq
->first_flusher
= NULL
;
2696 WARN_ON_ONCE(wq
->flush_color
== this_flusher
.flush_color
);
2697 list_add_tail(&this_flusher
.list
, &wq
->flusher_queue
);
2698 flush_workqueue_prep_pwqs(wq
, -1, wq
->work_color
);
2702 * Oops, color space is full, wait on overflow queue.
2703 * The next flush completion will assign us
2704 * flush_color and transfer to flusher_queue.
2706 list_add_tail(&this_flusher
.list
, &wq
->flusher_overflow
);
2709 check_flush_dependency(wq
, NULL
);
2711 mutex_unlock(&wq
->mutex
);
2713 wait_for_completion(&this_flusher
.done
);
2716 * Wake-up-and-cascade phase
2718 * First flushers are responsible for cascading flushes and
2719 * handling overflow. Non-first flushers can simply return.
2721 if (wq
->first_flusher
!= &this_flusher
)
2724 mutex_lock(&wq
->mutex
);
2726 /* we might have raced, check again with mutex held */
2727 if (wq
->first_flusher
!= &this_flusher
)
2730 wq
->first_flusher
= NULL
;
2732 WARN_ON_ONCE(!list_empty(&this_flusher
.list
));
2733 WARN_ON_ONCE(wq
->flush_color
!= this_flusher
.flush_color
);
2736 struct wq_flusher
*next
, *tmp
;
2738 /* complete all the flushers sharing the current flush color */
2739 list_for_each_entry_safe(next
, tmp
, &wq
->flusher_queue
, list
) {
2740 if (next
->flush_color
!= wq
->flush_color
)
2742 list_del_init(&next
->list
);
2743 complete(&next
->done
);
2746 WARN_ON_ONCE(!list_empty(&wq
->flusher_overflow
) &&
2747 wq
->flush_color
!= work_next_color(wq
->work_color
));
2749 /* this flush_color is finished, advance by one */
2750 wq
->flush_color
= work_next_color(wq
->flush_color
);
2752 /* one color has been freed, handle overflow queue */
2753 if (!list_empty(&wq
->flusher_overflow
)) {
2755 * Assign the same color to all overflowed
2756 * flushers, advance work_color and append to
2757 * flusher_queue. This is the start-to-wait
2758 * phase for these overflowed flushers.
2760 list_for_each_entry(tmp
, &wq
->flusher_overflow
, list
)
2761 tmp
->flush_color
= wq
->work_color
;
2763 wq
->work_color
= work_next_color(wq
->work_color
);
2765 list_splice_tail_init(&wq
->flusher_overflow
,
2766 &wq
->flusher_queue
);
2767 flush_workqueue_prep_pwqs(wq
, -1, wq
->work_color
);
2770 if (list_empty(&wq
->flusher_queue
)) {
2771 WARN_ON_ONCE(wq
->flush_color
!= wq
->work_color
);
2776 * Need to flush more colors. Make the next flusher
2777 * the new first flusher and arm pwqs.
2779 WARN_ON_ONCE(wq
->flush_color
== wq
->work_color
);
2780 WARN_ON_ONCE(wq
->flush_color
!= next
->flush_color
);
2782 list_del_init(&next
->list
);
2783 wq
->first_flusher
= next
;
2785 if (flush_workqueue_prep_pwqs(wq
, wq
->flush_color
, -1))
2789 * Meh... this color is already done, clear first
2790 * flusher and repeat cascading.
2792 wq
->first_flusher
= NULL
;
2796 mutex_unlock(&wq
->mutex
);
2798 EXPORT_SYMBOL(flush_workqueue
);
2801 * drain_workqueue - drain a workqueue
2802 * @wq: workqueue to drain
2804 * Wait until the workqueue becomes empty. While draining is in progress,
2805 * only chain queueing is allowed. IOW, only currently pending or running
2806 * work items on @wq can queue further work items on it. @wq is flushed
2807 * repeatedly until it becomes empty. The number of flushing is determined
2808 * by the depth of chaining and should be relatively short. Whine if it
2811 void drain_workqueue(struct workqueue_struct
*wq
)
2813 unsigned int flush_cnt
= 0;
2814 struct pool_workqueue
*pwq
;
2817 * __queue_work() needs to test whether there are drainers, is much
2818 * hotter than drain_workqueue() and already looks at @wq->flags.
2819 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
2821 mutex_lock(&wq
->mutex
);
2822 if (!wq
->nr_drainers
++)
2823 wq
->flags
|= __WQ_DRAINING
;
2824 mutex_unlock(&wq
->mutex
);
2826 flush_workqueue(wq
);
2828 mutex_lock(&wq
->mutex
);
2830 for_each_pwq(pwq
, wq
) {
2833 spin_lock_irq(&pwq
->pool
->lock
);
2834 drained
= !pwq
->nr_active
&& list_empty(&pwq
->delayed_works
);
2835 spin_unlock_irq(&pwq
->pool
->lock
);
2840 if (++flush_cnt
== 10 ||
2841 (flush_cnt
% 100 == 0 && flush_cnt
<= 1000))
2842 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
2843 wq
->name
, flush_cnt
);
2845 mutex_unlock(&wq
->mutex
);
2849 if (!--wq
->nr_drainers
)
2850 wq
->flags
&= ~__WQ_DRAINING
;
2851 mutex_unlock(&wq
->mutex
);
2853 EXPORT_SYMBOL_GPL(drain_workqueue
);
2855 static bool start_flush_work(struct work_struct
*work
, struct wq_barrier
*barr
,
2858 struct worker
*worker
= NULL
;
2859 struct worker_pool
*pool
;
2860 struct pool_workqueue
*pwq
;
2864 local_irq_disable();
2865 pool
= get_work_pool(work
);
2871 spin_lock(&pool
->lock
);
2872 /* see the comment in try_to_grab_pending() with the same code */
2873 pwq
= get_work_pwq(work
);
2875 if (unlikely(pwq
->pool
!= pool
))
2878 worker
= find_worker_executing_work(pool
, work
);
2881 pwq
= worker
->current_pwq
;
2884 check_flush_dependency(pwq
->wq
, work
);
2886 insert_wq_barrier(pwq
, barr
, work
, worker
);
2887 spin_unlock_irq(&pool
->lock
);
2890 * Force a lock recursion deadlock when using flush_work() inside a
2891 * single-threaded or rescuer equipped workqueue.
2893 * For single threaded workqueues the deadlock happens when the work
2894 * is after the work issuing the flush_work(). For rescuer equipped
2895 * workqueues the deadlock happens when the rescuer stalls, blocking
2899 (pwq
->wq
->saved_max_active
== 1 || pwq
->wq
->rescuer
)) {
2900 lock_map_acquire(&pwq
->wq
->lockdep_map
);
2901 lock_map_release(&pwq
->wq
->lockdep_map
);
2906 spin_unlock_irq(&pool
->lock
);
2910 static bool __flush_work(struct work_struct
*work
, bool from_cancel
)
2912 struct wq_barrier barr
;
2914 if (WARN_ON(!wq_online
))
2917 if (WARN_ON(!work
->func
))
2921 lock_map_acquire(&work
->lockdep_map
);
2922 lock_map_release(&work
->lockdep_map
);
2925 if (start_flush_work(work
, &barr
, from_cancel
)) {
2926 wait_for_completion(&barr
.done
);
2927 destroy_work_on_stack(&barr
.work
);
2935 * flush_work - wait for a work to finish executing the last queueing instance
2936 * @work: the work to flush
2938 * Wait until @work has finished execution. @work is guaranteed to be idle
2939 * on return if it hasn't been requeued since flush started.
2942 * %true if flush_work() waited for the work to finish execution,
2943 * %false if it was already idle.
2945 bool flush_work(struct work_struct
*work
)
2947 return __flush_work(work
, false);
2949 EXPORT_SYMBOL_GPL(flush_work
);
2952 wait_queue_entry_t wait
;
2953 struct work_struct
*work
;
2956 static int cwt_wakefn(wait_queue_entry_t
*wait
, unsigned mode
, int sync
, void *key
)
2958 struct cwt_wait
*cwait
= container_of(wait
, struct cwt_wait
, wait
);
2960 if (cwait
->work
!= key
)
2962 return autoremove_wake_function(wait
, mode
, sync
, key
);
2965 static bool __cancel_work_timer(struct work_struct
*work
, bool is_dwork
)
2967 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq
);
2968 unsigned long flags
;
2972 ret
= try_to_grab_pending(work
, is_dwork
, &flags
);
2974 * If someone else is already canceling, wait for it to
2975 * finish. flush_work() doesn't work for PREEMPT_NONE
2976 * because we may get scheduled between @work's completion
2977 * and the other canceling task resuming and clearing
2978 * CANCELING - flush_work() will return false immediately
2979 * as @work is no longer busy, try_to_grab_pending() will
2980 * return -ENOENT as @work is still being canceled and the
2981 * other canceling task won't be able to clear CANCELING as
2982 * we're hogging the CPU.
2984 * Let's wait for completion using a waitqueue. As this
2985 * may lead to the thundering herd problem, use a custom
2986 * wake function which matches @work along with exclusive
2989 if (unlikely(ret
== -ENOENT
)) {
2990 struct cwt_wait cwait
;
2992 init_wait(&cwait
.wait
);
2993 cwait
.wait
.func
= cwt_wakefn
;
2996 prepare_to_wait_exclusive(&cancel_waitq
, &cwait
.wait
,
2997 TASK_UNINTERRUPTIBLE
);
2998 if (work_is_canceling(work
))
3000 finish_wait(&cancel_waitq
, &cwait
.wait
);
3002 } while (unlikely(ret
< 0));
3004 /* tell other tasks trying to grab @work to back off */
3005 mark_work_canceling(work
);
3006 local_irq_restore(flags
);
3009 * This allows canceling during early boot. We know that @work
3013 __flush_work(work
, true);
3015 clear_work_data(work
);
3018 * Paired with prepare_to_wait() above so that either
3019 * waitqueue_active() is visible here or !work_is_canceling() is
3023 if (waitqueue_active(&cancel_waitq
))
3024 __wake_up(&cancel_waitq
, TASK_NORMAL
, 1, work
);
3030 * cancel_work_sync - cancel a work and wait for it to finish
3031 * @work: the work to cancel
3033 * Cancel @work and wait for its execution to finish. This function
3034 * can be used even if the work re-queues itself or migrates to
3035 * another workqueue. On return from this function, @work is
3036 * guaranteed to be not pending or executing on any CPU.
3038 * cancel_work_sync(&delayed_work->work) must not be used for
3039 * delayed_work's. Use cancel_delayed_work_sync() instead.
3041 * The caller must ensure that the workqueue on which @work was last
3042 * queued can't be destroyed before this function returns.
3045 * %true if @work was pending, %false otherwise.
3047 bool cancel_work_sync(struct work_struct
*work
)
3049 return __cancel_work_timer(work
, false);
3051 EXPORT_SYMBOL_GPL(cancel_work_sync
);
3054 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3055 * @dwork: the delayed work to flush
3057 * Delayed timer is cancelled and the pending work is queued for
3058 * immediate execution. Like flush_work(), this function only
3059 * considers the last queueing instance of @dwork.
3062 * %true if flush_work() waited for the work to finish execution,
3063 * %false if it was already idle.
3065 bool flush_delayed_work(struct delayed_work
*dwork
)
3067 local_irq_disable();
3068 if (del_timer_sync(&dwork
->timer
))
3069 __queue_work(dwork
->cpu
, dwork
->wq
, &dwork
->work
);
3071 return flush_work(&dwork
->work
);
3073 EXPORT_SYMBOL(flush_delayed_work
);
3076 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3077 * @rwork: the rcu work to flush
3080 * %true if flush_rcu_work() waited for the work to finish execution,
3081 * %false if it was already idle.
3083 bool flush_rcu_work(struct rcu_work
*rwork
)
3085 if (test_bit(WORK_STRUCT_PENDING_BIT
, work_data_bits(&rwork
->work
))) {
3087 flush_work(&rwork
->work
);
3090 return flush_work(&rwork
->work
);
3093 EXPORT_SYMBOL(flush_rcu_work
);
3095 static bool __cancel_work(struct work_struct
*work
, bool is_dwork
)
3097 unsigned long flags
;
3101 ret
= try_to_grab_pending(work
, is_dwork
, &flags
);
3102 } while (unlikely(ret
== -EAGAIN
));
3104 if (unlikely(ret
< 0))
3107 set_work_pool_and_clear_pending(work
, get_work_pool_id(work
));
3108 local_irq_restore(flags
);
3113 * cancel_delayed_work - cancel a delayed work
3114 * @dwork: delayed_work to cancel
3116 * Kill off a pending delayed_work.
3118 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3122 * The work callback function may still be running on return, unless
3123 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3124 * use cancel_delayed_work_sync() to wait on it.
3126 * This function is safe to call from any context including IRQ handler.
3128 bool cancel_delayed_work(struct delayed_work
*dwork
)
3130 return __cancel_work(&dwork
->work
, true);
3132 EXPORT_SYMBOL(cancel_delayed_work
);
3135 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3136 * @dwork: the delayed work cancel
3138 * This is cancel_work_sync() for delayed works.
3141 * %true if @dwork was pending, %false otherwise.
3143 bool cancel_delayed_work_sync(struct delayed_work
*dwork
)
3145 return __cancel_work_timer(&dwork
->work
, true);
3147 EXPORT_SYMBOL(cancel_delayed_work_sync
);
3150 * schedule_on_each_cpu - execute a function synchronously on each online CPU
3151 * @func: the function to call
3153 * schedule_on_each_cpu() executes @func on each online CPU using the
3154 * system workqueue and blocks until all CPUs have completed.
3155 * schedule_on_each_cpu() is very slow.
3158 * 0 on success, -errno on failure.
3160 int schedule_on_each_cpu(work_func_t func
)
3163 struct work_struct __percpu
*works
;
3165 works
= alloc_percpu(struct work_struct
);
3171 for_each_online_cpu(cpu
) {
3172 struct work_struct
*work
= per_cpu_ptr(works
, cpu
);
3174 INIT_WORK(work
, func
);
3175 schedule_work_on(cpu
, work
);
3178 for_each_online_cpu(cpu
)
3179 flush_work(per_cpu_ptr(works
, cpu
));
3187 * execute_in_process_context - reliably execute the routine with user context
3188 * @fn: the function to execute
3189 * @ew: guaranteed storage for the execute work structure (must
3190 * be available when the work executes)
3192 * Executes the function immediately if process context is available,
3193 * otherwise schedules the function for delayed execution.
3195 * Return: 0 - function was executed
3196 * 1 - function was scheduled for execution
3198 int execute_in_process_context(work_func_t fn
, struct execute_work
*ew
)
3200 if (!in_interrupt()) {
3205 INIT_WORK(&ew
->work
, fn
);
3206 schedule_work(&ew
->work
);
3210 EXPORT_SYMBOL_GPL(execute_in_process_context
);
3213 * free_workqueue_attrs - free a workqueue_attrs
3214 * @attrs: workqueue_attrs to free
3216 * Undo alloc_workqueue_attrs().
3218 void free_workqueue_attrs(struct workqueue_attrs
*attrs
)
3221 free_cpumask_var(attrs
->cpumask
);
3227 * alloc_workqueue_attrs - allocate a workqueue_attrs
3228 * @gfp_mask: allocation mask to use
3230 * Allocate a new workqueue_attrs, initialize with default settings and
3233 * Return: The allocated new workqueue_attr on success. %NULL on failure.
3235 struct workqueue_attrs
*alloc_workqueue_attrs(gfp_t gfp_mask
)
3237 struct workqueue_attrs
*attrs
;
3239 attrs
= kzalloc(sizeof(*attrs
), gfp_mask
);
3242 if (!alloc_cpumask_var(&attrs
->cpumask
, gfp_mask
))
3245 cpumask_copy(attrs
->cpumask
, cpu_possible_mask
);
3248 free_workqueue_attrs(attrs
);
3252 static void copy_workqueue_attrs(struct workqueue_attrs
*to
,
3253 const struct workqueue_attrs
*from
)
3255 to
->nice
= from
->nice
;
3256 cpumask_copy(to
->cpumask
, from
->cpumask
);
3258 * Unlike hash and equality test, this function doesn't ignore
3259 * ->no_numa as it is used for both pool and wq attrs. Instead,
3260 * get_unbound_pool() explicitly clears ->no_numa after copying.
3262 to
->no_numa
= from
->no_numa
;
3265 /* hash value of the content of @attr */
3266 static u32
wqattrs_hash(const struct workqueue_attrs
*attrs
)
3270 hash
= jhash_1word(attrs
->nice
, hash
);
3271 hash
= jhash(cpumask_bits(attrs
->cpumask
),
3272 BITS_TO_LONGS(nr_cpumask_bits
) * sizeof(long), hash
);
3276 /* content equality test */
3277 static bool wqattrs_equal(const struct workqueue_attrs
*a
,
3278 const struct workqueue_attrs
*b
)
3280 if (a
->nice
!= b
->nice
)
3282 if (!cpumask_equal(a
->cpumask
, b
->cpumask
))
3288 * init_worker_pool - initialize a newly zalloc'd worker_pool
3289 * @pool: worker_pool to initialize
3291 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
3293 * Return: 0 on success, -errno on failure. Even on failure, all fields
3294 * inside @pool proper are initialized and put_unbound_pool() can be called
3295 * on @pool safely to release it.
3297 static int init_worker_pool(struct worker_pool
*pool
)
3299 spin_lock_init(&pool
->lock
);
3302 pool
->node
= NUMA_NO_NODE
;
3303 pool
->flags
|= POOL_DISASSOCIATED
;
3304 pool
->watchdog_ts
= jiffies
;
3305 INIT_LIST_HEAD(&pool
->worklist
);
3306 INIT_LIST_HEAD(&pool
->idle_list
);
3307 hash_init(pool
->busy_hash
);
3309 timer_setup(&pool
->idle_timer
, idle_worker_timeout
, TIMER_DEFERRABLE
);
3311 timer_setup(&pool
->mayday_timer
, pool_mayday_timeout
, 0);
3313 INIT_LIST_HEAD(&pool
->workers
);
3315 ida_init(&pool
->worker_ida
);
3316 INIT_HLIST_NODE(&pool
->hash_node
);
3319 /* shouldn't fail above this point */
3320 pool
->attrs
= alloc_workqueue_attrs(GFP_KERNEL
);
3326 static void rcu_free_wq(struct rcu_head
*rcu
)
3328 struct workqueue_struct
*wq
=
3329 container_of(rcu
, struct workqueue_struct
, rcu
);
3331 if (!(wq
->flags
& WQ_UNBOUND
))
3332 free_percpu(wq
->cpu_pwqs
);
3334 free_workqueue_attrs(wq
->unbound_attrs
);
3340 static void rcu_free_pool(struct rcu_head
*rcu
)
3342 struct worker_pool
*pool
= container_of(rcu
, struct worker_pool
, rcu
);
3344 ida_destroy(&pool
->worker_ida
);
3345 free_workqueue_attrs(pool
->attrs
);
3350 * put_unbound_pool - put a worker_pool
3351 * @pool: worker_pool to put
3353 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
3354 * safe manner. get_unbound_pool() calls this function on its failure path
3355 * and this function should be able to release pools which went through,
3356 * successfully or not, init_worker_pool().
3358 * Should be called with wq_pool_mutex held.
3360 static void put_unbound_pool(struct worker_pool
*pool
)
3362 DECLARE_COMPLETION_ONSTACK(detach_completion
);
3363 struct worker
*worker
;
3365 lockdep_assert_held(&wq_pool_mutex
);
3371 if (WARN_ON(!(pool
->cpu
< 0)) ||
3372 WARN_ON(!list_empty(&pool
->worklist
)))
3375 /* release id and unhash */
3377 idr_remove(&worker_pool_idr
, pool
->id
);
3378 hash_del(&pool
->hash_node
);
3381 * Become the manager and destroy all workers. This prevents
3382 * @pool's workers from blocking on attach_mutex. We're the last
3383 * manager and @pool gets freed with the flag set.
3385 spin_lock_irq(&pool
->lock
);
3386 wait_event_lock_irq(wq_manager_wait
,
3387 !(pool
->flags
& POOL_MANAGER_ACTIVE
), pool
->lock
);
3388 pool
->flags
|= POOL_MANAGER_ACTIVE
;
3390 while ((worker
= first_idle_worker(pool
)))
3391 destroy_worker(worker
);
3392 WARN_ON(pool
->nr_workers
|| pool
->nr_idle
);
3393 spin_unlock_irq(&pool
->lock
);
3395 mutex_lock(&wq_pool_attach_mutex
);
3396 if (!list_empty(&pool
->workers
))
3397 pool
->detach_completion
= &detach_completion
;
3398 mutex_unlock(&wq_pool_attach_mutex
);
3400 if (pool
->detach_completion
)
3401 wait_for_completion(pool
->detach_completion
);
3403 /* shut down the timers */
3404 del_timer_sync(&pool
->idle_timer
);
3405 del_timer_sync(&pool
->mayday_timer
);
3407 /* sched-RCU protected to allow dereferences from get_work_pool() */
3408 call_rcu_sched(&pool
->rcu
, rcu_free_pool
);
3412 * get_unbound_pool - get a worker_pool with the specified attributes
3413 * @attrs: the attributes of the worker_pool to get
3415 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3416 * reference count and return it. If there already is a matching
3417 * worker_pool, it will be used; otherwise, this function attempts to
3420 * Should be called with wq_pool_mutex held.
3422 * Return: On success, a worker_pool with the same attributes as @attrs.
3423 * On failure, %NULL.
3425 static struct worker_pool
*get_unbound_pool(const struct workqueue_attrs
*attrs
)
3427 u32 hash
= wqattrs_hash(attrs
);
3428 struct worker_pool
*pool
;
3430 int target_node
= NUMA_NO_NODE
;
3432 lockdep_assert_held(&wq_pool_mutex
);
3434 /* do we already have a matching pool? */
3435 hash_for_each_possible(unbound_pool_hash
, pool
, hash_node
, hash
) {
3436 if (wqattrs_equal(pool
->attrs
, attrs
)) {
3442 /* if cpumask is contained inside a NUMA node, we belong to that node */
3443 if (wq_numa_enabled
) {
3444 for_each_node(node
) {
3445 if (cpumask_subset(attrs
->cpumask
,
3446 wq_numa_possible_cpumask
[node
])) {
3453 /* nope, create a new one */
3454 pool
= kzalloc_node(sizeof(*pool
), GFP_KERNEL
, target_node
);
3455 if (!pool
|| init_worker_pool(pool
) < 0)
3458 lockdep_set_subclass(&pool
->lock
, 1); /* see put_pwq() */
3459 copy_workqueue_attrs(pool
->attrs
, attrs
);
3460 pool
->node
= target_node
;
3463 * no_numa isn't a worker_pool attribute, always clear it. See
3464 * 'struct workqueue_attrs' comments for detail.
3466 pool
->attrs
->no_numa
= false;
3468 if (worker_pool_assign_id(pool
) < 0)
3471 /* create and start the initial worker */
3472 if (wq_online
&& !create_worker(pool
))
3476 hash_add(unbound_pool_hash
, &pool
->hash_node
, hash
);
3481 put_unbound_pool(pool
);
3485 static void rcu_free_pwq(struct rcu_head
*rcu
)
3487 kmem_cache_free(pwq_cache
,
3488 container_of(rcu
, struct pool_workqueue
, rcu
));
3492 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3493 * and needs to be destroyed.
3495 static void pwq_unbound_release_workfn(struct work_struct
*work
)
3497 struct pool_workqueue
*pwq
= container_of(work
, struct pool_workqueue
,
3498 unbound_release_work
);
3499 struct workqueue_struct
*wq
= pwq
->wq
;
3500 struct worker_pool
*pool
= pwq
->pool
;
3503 if (WARN_ON_ONCE(!(wq
->flags
& WQ_UNBOUND
)))
3506 mutex_lock(&wq
->mutex
);
3507 list_del_rcu(&pwq
->pwqs_node
);
3508 is_last
= list_empty(&wq
->pwqs
);
3509 mutex_unlock(&wq
->mutex
);
3511 mutex_lock(&wq_pool_mutex
);
3512 put_unbound_pool(pool
);
3513 mutex_unlock(&wq_pool_mutex
);
3515 call_rcu_sched(&pwq
->rcu
, rcu_free_pwq
);
3518 * If we're the last pwq going away, @wq is already dead and no one
3519 * is gonna access it anymore. Schedule RCU free.
3522 call_rcu_sched(&wq
->rcu
, rcu_free_wq
);
3526 * pwq_adjust_max_active - update a pwq's max_active to the current setting
3527 * @pwq: target pool_workqueue
3529 * If @pwq isn't freezing, set @pwq->max_active to the associated
3530 * workqueue's saved_max_active and activate delayed work items
3531 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
3533 static void pwq_adjust_max_active(struct pool_workqueue
*pwq
)
3535 struct workqueue_struct
*wq
= pwq
->wq
;
3536 bool freezable
= wq
->flags
& WQ_FREEZABLE
;
3537 unsigned long flags
;
3539 /* for @wq->saved_max_active */
3540 lockdep_assert_held(&wq
->mutex
);
3542 /* fast exit for non-freezable wqs */
3543 if (!freezable
&& pwq
->max_active
== wq
->saved_max_active
)
3546 /* this function can be called during early boot w/ irq disabled */
3547 spin_lock_irqsave(&pwq
->pool
->lock
, flags
);
3550 * During [un]freezing, the caller is responsible for ensuring that
3551 * this function is called at least once after @workqueue_freezing
3552 * is updated and visible.
3554 if (!freezable
|| !workqueue_freezing
) {
3555 pwq
->max_active
= wq
->saved_max_active
;
3557 while (!list_empty(&pwq
->delayed_works
) &&
3558 pwq
->nr_active
< pwq
->max_active
)
3559 pwq_activate_first_delayed(pwq
);
3562 * Need to kick a worker after thawed or an unbound wq's
3563 * max_active is bumped. It's a slow path. Do it always.
3565 wake_up_worker(pwq
->pool
);
3567 pwq
->max_active
= 0;
3570 spin_unlock_irqrestore(&pwq
->pool
->lock
, flags
);
3573 /* initialize newly alloced @pwq which is associated with @wq and @pool */
3574 static void init_pwq(struct pool_workqueue
*pwq
, struct workqueue_struct
*wq
,
3575 struct worker_pool
*pool
)
3577 BUG_ON((unsigned long)pwq
& WORK_STRUCT_FLAG_MASK
);
3579 memset(pwq
, 0, sizeof(*pwq
));
3583 pwq
->flush_color
= -1;
3585 INIT_LIST_HEAD(&pwq
->delayed_works
);
3586 INIT_LIST_HEAD(&pwq
->pwqs_node
);
3587 INIT_LIST_HEAD(&pwq
->mayday_node
);
3588 INIT_WORK(&pwq
->unbound_release_work
, pwq_unbound_release_workfn
);
3591 /* sync @pwq with the current state of its associated wq and link it */
3592 static void link_pwq(struct pool_workqueue
*pwq
)
3594 struct workqueue_struct
*wq
= pwq
->wq
;
3596 lockdep_assert_held(&wq
->mutex
);
3598 /* may be called multiple times, ignore if already linked */
3599 if (!list_empty(&pwq
->pwqs_node
))
3602 /* set the matching work_color */
3603 pwq
->work_color
= wq
->work_color
;
3605 /* sync max_active to the current setting */
3606 pwq_adjust_max_active(pwq
);
3609 list_add_rcu(&pwq
->pwqs_node
, &wq
->pwqs
);
3612 /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3613 static struct pool_workqueue
*alloc_unbound_pwq(struct workqueue_struct
*wq
,
3614 const struct workqueue_attrs
*attrs
)
3616 struct worker_pool
*pool
;
3617 struct pool_workqueue
*pwq
;
3619 lockdep_assert_held(&wq_pool_mutex
);
3621 pool
= get_unbound_pool(attrs
);
3625 pwq
= kmem_cache_alloc_node(pwq_cache
, GFP_KERNEL
, pool
->node
);
3627 put_unbound_pool(pool
);
3631 init_pwq(pwq
, wq
, pool
);
3636 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
3637 * @attrs: the wq_attrs of the default pwq of the target workqueue
3638 * @node: the target NUMA node
3639 * @cpu_going_down: if >= 0, the CPU to consider as offline
3640 * @cpumask: outarg, the resulting cpumask
3642 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3643 * @cpu_going_down is >= 0, that cpu is considered offline during
3644 * calculation. The result is stored in @cpumask.
3646 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3647 * enabled and @node has online CPUs requested by @attrs, the returned
3648 * cpumask is the intersection of the possible CPUs of @node and
3651 * The caller is responsible for ensuring that the cpumask of @node stays
3654 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3657 static bool wq_calc_node_cpumask(const struct workqueue_attrs
*attrs
, int node
,
3658 int cpu_going_down
, cpumask_t
*cpumask
)
3660 if (!wq_numa_enabled
|| attrs
->no_numa
)
3663 /* does @node have any online CPUs @attrs wants? */
3664 cpumask_and(cpumask
, cpumask_of_node(node
), attrs
->cpumask
);
3665 if (cpu_going_down
>= 0)
3666 cpumask_clear_cpu(cpu_going_down
, cpumask
);
3668 if (cpumask_empty(cpumask
))
3671 /* yeap, return possible CPUs in @node that @attrs wants */
3672 cpumask_and(cpumask
, attrs
->cpumask
, wq_numa_possible_cpumask
[node
]);
3674 if (cpumask_empty(cpumask
)) {
3675 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3676 "possible intersect\n");
3680 return !cpumask_equal(cpumask
, attrs
->cpumask
);
3683 cpumask_copy(cpumask
, attrs
->cpumask
);
3687 /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3688 static struct pool_workqueue
*numa_pwq_tbl_install(struct workqueue_struct
*wq
,
3690 struct pool_workqueue
*pwq
)
3692 struct pool_workqueue
*old_pwq
;
3694 lockdep_assert_held(&wq_pool_mutex
);
3695 lockdep_assert_held(&wq
->mutex
);
3697 /* link_pwq() can handle duplicate calls */
3700 old_pwq
= rcu_access_pointer(wq
->numa_pwq_tbl
[node
]);
3701 rcu_assign_pointer(wq
->numa_pwq_tbl
[node
], pwq
);
3705 /* context to store the prepared attrs & pwqs before applying */
3706 struct apply_wqattrs_ctx
{
3707 struct workqueue_struct
*wq
; /* target workqueue */
3708 struct workqueue_attrs
*attrs
; /* attrs to apply */
3709 struct list_head list
; /* queued for batching commit */
3710 struct pool_workqueue
*dfl_pwq
;
3711 struct pool_workqueue
*pwq_tbl
[];
3714 /* free the resources after success or abort */
3715 static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx
*ctx
)
3721 put_pwq_unlocked(ctx
->pwq_tbl
[node
]);
3722 put_pwq_unlocked(ctx
->dfl_pwq
);
3724 free_workqueue_attrs(ctx
->attrs
);
3730 /* allocate the attrs and pwqs for later installation */
3731 static struct apply_wqattrs_ctx
*
3732 apply_wqattrs_prepare(struct workqueue_struct
*wq
,
3733 const struct workqueue_attrs
*attrs
)
3735 struct apply_wqattrs_ctx
*ctx
;
3736 struct workqueue_attrs
*new_attrs
, *tmp_attrs
;
3739 lockdep_assert_held(&wq_pool_mutex
);
3741 ctx
= kzalloc(struct_size(ctx
, pwq_tbl
, nr_node_ids
), GFP_KERNEL
);
3743 new_attrs
= alloc_workqueue_attrs(GFP_KERNEL
);
3744 tmp_attrs
= alloc_workqueue_attrs(GFP_KERNEL
);
3745 if (!ctx
|| !new_attrs
|| !tmp_attrs
)
3749 * Calculate the attrs of the default pwq.
3750 * If the user configured cpumask doesn't overlap with the
3751 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3753 copy_workqueue_attrs(new_attrs
, attrs
);
3754 cpumask_and(new_attrs
->cpumask
, new_attrs
->cpumask
, wq_unbound_cpumask
);
3755 if (unlikely(cpumask_empty(new_attrs
->cpumask
)))
3756 cpumask_copy(new_attrs
->cpumask
, wq_unbound_cpumask
);
3759 * We may create multiple pwqs with differing cpumasks. Make a
3760 * copy of @new_attrs which will be modified and used to obtain
3763 copy_workqueue_attrs(tmp_attrs
, new_attrs
);
3766 * If something goes wrong during CPU up/down, we'll fall back to
3767 * the default pwq covering whole @attrs->cpumask. Always create
3768 * it even if we don't use it immediately.
3770 ctx
->dfl_pwq
= alloc_unbound_pwq(wq
, new_attrs
);
3774 for_each_node(node
) {
3775 if (wq_calc_node_cpumask(new_attrs
, node
, -1, tmp_attrs
->cpumask
)) {
3776 ctx
->pwq_tbl
[node
] = alloc_unbound_pwq(wq
, tmp_attrs
);
3777 if (!ctx
->pwq_tbl
[node
])
3780 ctx
->dfl_pwq
->refcnt
++;
3781 ctx
->pwq_tbl
[node
] = ctx
->dfl_pwq
;
3785 /* save the user configured attrs and sanitize it. */
3786 copy_workqueue_attrs(new_attrs
, attrs
);
3787 cpumask_and(new_attrs
->cpumask
, new_attrs
->cpumask
, cpu_possible_mask
);
3788 ctx
->attrs
= new_attrs
;
3791 free_workqueue_attrs(tmp_attrs
);
3795 free_workqueue_attrs(tmp_attrs
);
3796 free_workqueue_attrs(new_attrs
);
3797 apply_wqattrs_cleanup(ctx
);
3801 /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3802 static void apply_wqattrs_commit(struct apply_wqattrs_ctx
*ctx
)
3806 /* all pwqs have been created successfully, let's install'em */
3807 mutex_lock(&ctx
->wq
->mutex
);
3809 copy_workqueue_attrs(ctx
->wq
->unbound_attrs
, ctx
->attrs
);
3811 /* save the previous pwq and install the new one */
3813 ctx
->pwq_tbl
[node
] = numa_pwq_tbl_install(ctx
->wq
, node
,
3814 ctx
->pwq_tbl
[node
]);
3816 /* @dfl_pwq might not have been used, ensure it's linked */
3817 link_pwq(ctx
->dfl_pwq
);
3818 swap(ctx
->wq
->dfl_pwq
, ctx
->dfl_pwq
);
3820 mutex_unlock(&ctx
->wq
->mutex
);
3823 static void apply_wqattrs_lock(void)
3825 /* CPUs should stay stable across pwq creations and installations */
3827 mutex_lock(&wq_pool_mutex
);
3830 static void apply_wqattrs_unlock(void)
3832 mutex_unlock(&wq_pool_mutex
);
3836 static int apply_workqueue_attrs_locked(struct workqueue_struct
*wq
,
3837 const struct workqueue_attrs
*attrs
)
3839 struct apply_wqattrs_ctx
*ctx
;
3841 /* only unbound workqueues can change attributes */
3842 if (WARN_ON(!(wq
->flags
& WQ_UNBOUND
)))
3845 /* creating multiple pwqs breaks ordering guarantee */
3846 if (!list_empty(&wq
->pwqs
)) {
3847 if (WARN_ON(wq
->flags
& __WQ_ORDERED_EXPLICIT
))
3850 wq
->flags
&= ~__WQ_ORDERED
;
3853 ctx
= apply_wqattrs_prepare(wq
, attrs
);
3857 /* the ctx has been prepared successfully, let's commit it */
3858 apply_wqattrs_commit(ctx
);
3859 apply_wqattrs_cleanup(ctx
);
3865 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3866 * @wq: the target workqueue
3867 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3869 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3870 * machines, this function maps a separate pwq to each NUMA node with
3871 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3872 * NUMA node it was issued on. Older pwqs are released as in-flight work
3873 * items finish. Note that a work item which repeatedly requeues itself
3874 * back-to-back will stay on its current pwq.
3876 * Performs GFP_KERNEL allocations.
3878 * Return: 0 on success and -errno on failure.
3880 int apply_workqueue_attrs(struct workqueue_struct
*wq
,
3881 const struct workqueue_attrs
*attrs
)
3885 apply_wqattrs_lock();
3886 ret
= apply_workqueue_attrs_locked(wq
, attrs
);
3887 apply_wqattrs_unlock();
3891 EXPORT_SYMBOL_GPL(apply_workqueue_attrs
);
3894 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3895 * @wq: the target workqueue
3896 * @cpu: the CPU coming up or going down
3897 * @online: whether @cpu is coming up or going down
3899 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3900 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3903 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3904 * falls back to @wq->dfl_pwq which may not be optimal but is always
3907 * Note that when the last allowed CPU of a NUMA node goes offline for a
3908 * workqueue with a cpumask spanning multiple nodes, the workers which were
3909 * already executing the work items for the workqueue will lose their CPU
3910 * affinity and may execute on any CPU. This is similar to how per-cpu
3911 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3912 * affinity, it's the user's responsibility to flush the work item from
3915 static void wq_update_unbound_numa(struct workqueue_struct
*wq
, int cpu
,
3918 int node
= cpu_to_node(cpu
);
3919 int cpu_off
= online
? -1 : cpu
;
3920 struct pool_workqueue
*old_pwq
= NULL
, *pwq
;
3921 struct workqueue_attrs
*target_attrs
;
3924 lockdep_assert_held(&wq_pool_mutex
);
3926 if (!wq_numa_enabled
|| !(wq
->flags
& WQ_UNBOUND
) ||
3927 wq
->unbound_attrs
->no_numa
)
3931 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3932 * Let's use a preallocated one. The following buf is protected by
3933 * CPU hotplug exclusion.
3935 target_attrs
= wq_update_unbound_numa_attrs_buf
;
3936 cpumask
= target_attrs
->cpumask
;
3938 copy_workqueue_attrs(target_attrs
, wq
->unbound_attrs
);
3939 pwq
= unbound_pwq_by_node(wq
, node
);
3942 * Let's determine what needs to be done. If the target cpumask is
3943 * different from the default pwq's, we need to compare it to @pwq's
3944 * and create a new one if they don't match. If the target cpumask
3945 * equals the default pwq's, the default pwq should be used.
3947 if (wq_calc_node_cpumask(wq
->dfl_pwq
->pool
->attrs
, node
, cpu_off
, cpumask
)) {
3948 if (cpumask_equal(cpumask
, pwq
->pool
->attrs
->cpumask
))
3954 /* create a new pwq */
3955 pwq
= alloc_unbound_pwq(wq
, target_attrs
);
3957 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3962 /* Install the new pwq. */
3963 mutex_lock(&wq
->mutex
);
3964 old_pwq
= numa_pwq_tbl_install(wq
, node
, pwq
);
3968 mutex_lock(&wq
->mutex
);
3969 spin_lock_irq(&wq
->dfl_pwq
->pool
->lock
);
3970 get_pwq(wq
->dfl_pwq
);
3971 spin_unlock_irq(&wq
->dfl_pwq
->pool
->lock
);
3972 old_pwq
= numa_pwq_tbl_install(wq
, node
, wq
->dfl_pwq
);
3974 mutex_unlock(&wq
->mutex
);
3975 put_pwq_unlocked(old_pwq
);
3978 static int alloc_and_link_pwqs(struct workqueue_struct
*wq
)
3980 bool highpri
= wq
->flags
& WQ_HIGHPRI
;
3983 if (!(wq
->flags
& WQ_UNBOUND
)) {
3984 wq
->cpu_pwqs
= alloc_percpu(struct pool_workqueue
);
3988 for_each_possible_cpu(cpu
) {
3989 struct pool_workqueue
*pwq
=
3990 per_cpu_ptr(wq
->cpu_pwqs
, cpu
);
3991 struct worker_pool
*cpu_pools
=
3992 per_cpu(cpu_worker_pools
, cpu
);
3994 init_pwq(pwq
, wq
, &cpu_pools
[highpri
]);
3996 mutex_lock(&wq
->mutex
);
3998 mutex_unlock(&wq
->mutex
);
4001 } else if (wq
->flags
& __WQ_ORDERED
) {
4002 ret
= apply_workqueue_attrs(wq
, ordered_wq_attrs
[highpri
]);
4003 /* there should only be single pwq for ordering guarantee */
4004 WARN(!ret
&& (wq
->pwqs
.next
!= &wq
->dfl_pwq
->pwqs_node
||
4005 wq
->pwqs
.prev
!= &wq
->dfl_pwq
->pwqs_node
),
4006 "ordering guarantee broken for workqueue %s\n", wq
->name
);
4009 return apply_workqueue_attrs(wq
, unbound_std_wq_attrs
[highpri
]);
4013 static int wq_clamp_max_active(int max_active
, unsigned int flags
,
4016 int lim
= flags
& WQ_UNBOUND
? WQ_UNBOUND_MAX_ACTIVE
: WQ_MAX_ACTIVE
;
4018 if (max_active
< 1 || max_active
> lim
)
4019 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4020 max_active
, name
, 1, lim
);
4022 return clamp_val(max_active
, 1, lim
);
4026 * Workqueues which may be used during memory reclaim should have a rescuer
4027 * to guarantee forward progress.
4029 static int init_rescuer(struct workqueue_struct
*wq
)
4031 struct worker
*rescuer
;
4034 if (!(wq
->flags
& WQ_MEM_RECLAIM
))
4037 rescuer
= alloc_worker(NUMA_NO_NODE
);
4041 rescuer
->rescue_wq
= wq
;
4042 rescuer
->task
= kthread_create(rescuer_thread
, rescuer
, "%s", wq
->name
);
4043 ret
= PTR_ERR_OR_ZERO(rescuer
->task
);
4049 wq
->rescuer
= rescuer
;
4050 kthread_bind_mask(rescuer
->task
, cpu_possible_mask
);
4051 wake_up_process(rescuer
->task
);
4056 struct workqueue_struct
*__alloc_workqueue_key(const char *fmt
,
4059 struct lock_class_key
*key
,
4060 const char *lock_name
, ...)
4062 size_t tbl_size
= 0;
4064 struct workqueue_struct
*wq
;
4065 struct pool_workqueue
*pwq
;
4068 * Unbound && max_active == 1 used to imply ordered, which is no
4069 * longer the case on NUMA machines due to per-node pools. While
4070 * alloc_ordered_workqueue() is the right way to create an ordered
4071 * workqueue, keep the previous behavior to avoid subtle breakages
4074 if ((flags
& WQ_UNBOUND
) && max_active
== 1)
4075 flags
|= __WQ_ORDERED
;
4077 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4078 if ((flags
& WQ_POWER_EFFICIENT
) && wq_power_efficient
)
4079 flags
|= WQ_UNBOUND
;
4081 /* allocate wq and format name */
4082 if (flags
& WQ_UNBOUND
)
4083 tbl_size
= nr_node_ids
* sizeof(wq
->numa_pwq_tbl
[0]);
4085 wq
= kzalloc(sizeof(*wq
) + tbl_size
, GFP_KERNEL
);
4089 if (flags
& WQ_UNBOUND
) {
4090 wq
->unbound_attrs
= alloc_workqueue_attrs(GFP_KERNEL
);
4091 if (!wq
->unbound_attrs
)
4095 va_start(args
, lock_name
);
4096 vsnprintf(wq
->name
, sizeof(wq
->name
), fmt
, args
);
4099 max_active
= max_active
?: WQ_DFL_ACTIVE
;
4100 max_active
= wq_clamp_max_active(max_active
, flags
, wq
->name
);
4104 wq
->saved_max_active
= max_active
;
4105 mutex_init(&wq
->mutex
);
4106 atomic_set(&wq
->nr_pwqs_to_flush
, 0);
4107 INIT_LIST_HEAD(&wq
->pwqs
);
4108 INIT_LIST_HEAD(&wq
->flusher_queue
);
4109 INIT_LIST_HEAD(&wq
->flusher_overflow
);
4110 INIT_LIST_HEAD(&wq
->maydays
);
4112 lockdep_init_map(&wq
->lockdep_map
, lock_name
, key
, 0);
4113 INIT_LIST_HEAD(&wq
->list
);
4115 if (alloc_and_link_pwqs(wq
) < 0)
4118 if (wq_online
&& init_rescuer(wq
) < 0)
4121 if ((wq
->flags
& WQ_SYSFS
) && workqueue_sysfs_register(wq
))
4125 * wq_pool_mutex protects global freeze state and workqueues list.
4126 * Grab it, adjust max_active and add the new @wq to workqueues
4129 mutex_lock(&wq_pool_mutex
);
4131 mutex_lock(&wq
->mutex
);
4132 for_each_pwq(pwq
, wq
)
4133 pwq_adjust_max_active(pwq
);
4134 mutex_unlock(&wq
->mutex
);
4136 list_add_tail_rcu(&wq
->list
, &workqueues
);
4138 mutex_unlock(&wq_pool_mutex
);
4143 free_workqueue_attrs(wq
->unbound_attrs
);
4147 destroy_workqueue(wq
);
4150 EXPORT_SYMBOL_GPL(__alloc_workqueue_key
);
4153 * destroy_workqueue - safely terminate a workqueue
4154 * @wq: target workqueue
4156 * Safely destroy a workqueue. All work currently pending will be done first.
4158 void destroy_workqueue(struct workqueue_struct
*wq
)
4160 struct pool_workqueue
*pwq
;
4164 * Remove it from sysfs first so that sanity check failure doesn't
4165 * lead to sysfs name conflicts.
4167 workqueue_sysfs_unregister(wq
);
4169 /* drain it before proceeding with destruction */
4170 drain_workqueue(wq
);
4172 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4174 struct worker
*rescuer
= wq
->rescuer
;
4176 /* this prevents new queueing */
4177 spin_lock_irq(&wq_mayday_lock
);
4179 spin_unlock_irq(&wq_mayday_lock
);
4181 /* rescuer will empty maydays list before exiting */
4182 kthread_stop(rescuer
->task
);
4187 mutex_lock(&wq
->mutex
);
4188 for_each_pwq(pwq
, wq
) {
4191 for (i
= 0; i
< WORK_NR_COLORS
; i
++) {
4192 if (WARN_ON(pwq
->nr_in_flight
[i
])) {
4193 mutex_unlock(&wq
->mutex
);
4194 show_workqueue_state();
4199 if (WARN_ON((pwq
!= wq
->dfl_pwq
) && (pwq
->refcnt
> 1)) ||
4200 WARN_ON(pwq
->nr_active
) ||
4201 WARN_ON(!list_empty(&pwq
->delayed_works
))) {
4202 mutex_unlock(&wq
->mutex
);
4203 show_workqueue_state();
4207 mutex_unlock(&wq
->mutex
);
4210 * wq list is used to freeze wq, remove from list after
4211 * flushing is complete in case freeze races us.
4213 mutex_lock(&wq_pool_mutex
);
4214 list_del_rcu(&wq
->list
);
4215 mutex_unlock(&wq_pool_mutex
);
4217 if (!(wq
->flags
& WQ_UNBOUND
)) {
4219 * The base ref is never dropped on per-cpu pwqs. Directly
4220 * schedule RCU free.
4222 call_rcu_sched(&wq
->rcu
, rcu_free_wq
);
4225 * We're the sole accessor of @wq at this point. Directly
4226 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4227 * @wq will be freed when the last pwq is released.
4229 for_each_node(node
) {
4230 pwq
= rcu_access_pointer(wq
->numa_pwq_tbl
[node
]);
4231 RCU_INIT_POINTER(wq
->numa_pwq_tbl
[node
], NULL
);
4232 put_pwq_unlocked(pwq
);
4236 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4237 * put. Don't access it afterwards.
4241 put_pwq_unlocked(pwq
);
4244 EXPORT_SYMBOL_GPL(destroy_workqueue
);
4247 * workqueue_set_max_active - adjust max_active of a workqueue
4248 * @wq: target workqueue
4249 * @max_active: new max_active value.
4251 * Set max_active of @wq to @max_active.
4254 * Don't call from IRQ context.
4256 void workqueue_set_max_active(struct workqueue_struct
*wq
, int max_active
)
4258 struct pool_workqueue
*pwq
;
4260 /* disallow meddling with max_active for ordered workqueues */
4261 if (WARN_ON(wq
->flags
& __WQ_ORDERED_EXPLICIT
))
4264 max_active
= wq_clamp_max_active(max_active
, wq
->flags
, wq
->name
);
4266 mutex_lock(&wq
->mutex
);
4268 wq
->flags
&= ~__WQ_ORDERED
;
4269 wq
->saved_max_active
= max_active
;
4271 for_each_pwq(pwq
, wq
)
4272 pwq_adjust_max_active(pwq
);
4274 mutex_unlock(&wq
->mutex
);
4276 EXPORT_SYMBOL_GPL(workqueue_set_max_active
);
4279 * current_work - retrieve %current task's work struct
4281 * Determine if %current task is a workqueue worker and what it's working on.
4282 * Useful to find out the context that the %current task is running in.
4284 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4286 struct work_struct
*current_work(void)
4288 struct worker
*worker
= current_wq_worker();
4290 return worker
? worker
->current_work
: NULL
;
4292 EXPORT_SYMBOL(current_work
);
4295 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4297 * Determine whether %current is a workqueue rescuer. Can be used from
4298 * work functions to determine whether it's being run off the rescuer task.
4300 * Return: %true if %current is a workqueue rescuer. %false otherwise.
4302 bool current_is_workqueue_rescuer(void)
4304 struct worker
*worker
= current_wq_worker();
4306 return worker
&& worker
->rescue_wq
;
4310 * workqueue_congested - test whether a workqueue is congested
4311 * @cpu: CPU in question
4312 * @wq: target workqueue
4314 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4315 * no synchronization around this function and the test result is
4316 * unreliable and only useful as advisory hints or for debugging.
4318 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4319 * Note that both per-cpu and unbound workqueues may be associated with
4320 * multiple pool_workqueues which have separate congested states. A
4321 * workqueue being congested on one CPU doesn't mean the workqueue is also
4322 * contested on other CPUs / NUMA nodes.
4325 * %true if congested, %false otherwise.
4327 bool workqueue_congested(int cpu
, struct workqueue_struct
*wq
)
4329 struct pool_workqueue
*pwq
;
4332 rcu_read_lock_sched();
4334 if (cpu
== WORK_CPU_UNBOUND
)
4335 cpu
= smp_processor_id();
4337 if (!(wq
->flags
& WQ_UNBOUND
))
4338 pwq
= per_cpu_ptr(wq
->cpu_pwqs
, cpu
);
4340 pwq
= unbound_pwq_by_node(wq
, cpu_to_node(cpu
));
4342 ret
= !list_empty(&pwq
->delayed_works
);
4343 rcu_read_unlock_sched();
4347 EXPORT_SYMBOL_GPL(workqueue_congested
);
4350 * work_busy - test whether a work is currently pending or running
4351 * @work: the work to be tested
4353 * Test whether @work is currently pending or running. There is no
4354 * synchronization around this function and the test result is
4355 * unreliable and only useful as advisory hints or for debugging.
4358 * OR'd bitmask of WORK_BUSY_* bits.
4360 unsigned int work_busy(struct work_struct
*work
)
4362 struct worker_pool
*pool
;
4363 unsigned long flags
;
4364 unsigned int ret
= 0;
4366 if (work_pending(work
))
4367 ret
|= WORK_BUSY_PENDING
;
4369 local_irq_save(flags
);
4370 pool
= get_work_pool(work
);
4372 spin_lock(&pool
->lock
);
4373 if (find_worker_executing_work(pool
, work
))
4374 ret
|= WORK_BUSY_RUNNING
;
4375 spin_unlock(&pool
->lock
);
4377 local_irq_restore(flags
);
4381 EXPORT_SYMBOL_GPL(work_busy
);
4384 * set_worker_desc - set description for the current work item
4385 * @fmt: printf-style format string
4386 * @...: arguments for the format string
4388 * This function can be called by a running work function to describe what
4389 * the work item is about. If the worker task gets dumped, this
4390 * information will be printed out together to help debugging. The
4391 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4393 void set_worker_desc(const char *fmt
, ...)
4395 struct worker
*worker
= current_wq_worker();
4399 va_start(args
, fmt
);
4400 vsnprintf(worker
->desc
, sizeof(worker
->desc
), fmt
, args
);
4404 EXPORT_SYMBOL_GPL(set_worker_desc
);
4407 * print_worker_info - print out worker information and description
4408 * @log_lvl: the log level to use when printing
4409 * @task: target task
4411 * If @task is a worker and currently executing a work item, print out the
4412 * name of the workqueue being serviced and worker description set with
4413 * set_worker_desc() by the currently executing work item.
4415 * This function can be safely called on any task as long as the
4416 * task_struct itself is accessible. While safe, this function isn't
4417 * synchronized and may print out mixups or garbages of limited length.
4419 void print_worker_info(const char *log_lvl
, struct task_struct
*task
)
4421 work_func_t
*fn
= NULL
;
4422 char name
[WQ_NAME_LEN
] = { };
4423 char desc
[WORKER_DESC_LEN
] = { };
4424 struct pool_workqueue
*pwq
= NULL
;
4425 struct workqueue_struct
*wq
= NULL
;
4426 struct worker
*worker
;
4428 if (!(task
->flags
& PF_WQ_WORKER
))
4432 * This function is called without any synchronization and @task
4433 * could be in any state. Be careful with dereferences.
4435 worker
= kthread_probe_data(task
);
4438 * Carefully copy the associated workqueue's workfn, name and desc.
4439 * Keep the original last '\0' in case the original is garbage.
4441 probe_kernel_read(&fn
, &worker
->current_func
, sizeof(fn
));
4442 probe_kernel_read(&pwq
, &worker
->current_pwq
, sizeof(pwq
));
4443 probe_kernel_read(&wq
, &pwq
->wq
, sizeof(wq
));
4444 probe_kernel_read(name
, wq
->name
, sizeof(name
) - 1);
4445 probe_kernel_read(desc
, worker
->desc
, sizeof(desc
) - 1);
4447 if (fn
|| name
[0] || desc
[0]) {
4448 printk("%sWorkqueue: %s %pf", log_lvl
, name
, fn
);
4449 if (strcmp(name
, desc
))
4450 pr_cont(" (%s)", desc
);
4455 static void pr_cont_pool_info(struct worker_pool
*pool
)
4457 pr_cont(" cpus=%*pbl", nr_cpumask_bits
, pool
->attrs
->cpumask
);
4458 if (pool
->node
!= NUMA_NO_NODE
)
4459 pr_cont(" node=%d", pool
->node
);
4460 pr_cont(" flags=0x%x nice=%d", pool
->flags
, pool
->attrs
->nice
);
4463 static void pr_cont_work(bool comma
, struct work_struct
*work
)
4465 if (work
->func
== wq_barrier_func
) {
4466 struct wq_barrier
*barr
;
4468 barr
= container_of(work
, struct wq_barrier
, work
);
4470 pr_cont("%s BAR(%d)", comma
? "," : "",
4471 task_pid_nr(barr
->task
));
4473 pr_cont("%s %pf", comma
? "," : "", work
->func
);
4477 static void show_pwq(struct pool_workqueue
*pwq
)
4479 struct worker_pool
*pool
= pwq
->pool
;
4480 struct work_struct
*work
;
4481 struct worker
*worker
;
4482 bool has_in_flight
= false, has_pending
= false;
4485 pr_info(" pwq %d:", pool
->id
);
4486 pr_cont_pool_info(pool
);
4488 pr_cont(" active=%d/%d refcnt=%d%s\n",
4489 pwq
->nr_active
, pwq
->max_active
, pwq
->refcnt
,
4490 !list_empty(&pwq
->mayday_node
) ? " MAYDAY" : "");
4492 hash_for_each(pool
->busy_hash
, bkt
, worker
, hentry
) {
4493 if (worker
->current_pwq
== pwq
) {
4494 has_in_flight
= true;
4498 if (has_in_flight
) {
4501 pr_info(" in-flight:");
4502 hash_for_each(pool
->busy_hash
, bkt
, worker
, hentry
) {
4503 if (worker
->current_pwq
!= pwq
)
4506 pr_cont("%s %d%s:%pf", comma
? "," : "",
4507 task_pid_nr(worker
->task
),
4508 worker
== pwq
->wq
->rescuer
? "(RESCUER)" : "",
4509 worker
->current_func
);
4510 list_for_each_entry(work
, &worker
->scheduled
, entry
)
4511 pr_cont_work(false, work
);
4517 list_for_each_entry(work
, &pool
->worklist
, entry
) {
4518 if (get_work_pwq(work
) == pwq
) {
4526 pr_info(" pending:");
4527 list_for_each_entry(work
, &pool
->worklist
, entry
) {
4528 if (get_work_pwq(work
) != pwq
)
4531 pr_cont_work(comma
, work
);
4532 comma
= !(*work_data_bits(work
) & WORK_STRUCT_LINKED
);
4537 if (!list_empty(&pwq
->delayed_works
)) {
4540 pr_info(" delayed:");
4541 list_for_each_entry(work
, &pwq
->delayed_works
, entry
) {
4542 pr_cont_work(comma
, work
);
4543 comma
= !(*work_data_bits(work
) & WORK_STRUCT_LINKED
);
4550 * show_workqueue_state - dump workqueue state
4552 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4553 * all busy workqueues and pools.
4555 void show_workqueue_state(void)
4557 struct workqueue_struct
*wq
;
4558 struct worker_pool
*pool
;
4559 unsigned long flags
;
4562 rcu_read_lock_sched();
4564 pr_info("Showing busy workqueues and worker pools:\n");
4566 list_for_each_entry_rcu(wq
, &workqueues
, list
) {
4567 struct pool_workqueue
*pwq
;
4570 for_each_pwq(pwq
, wq
) {
4571 if (pwq
->nr_active
|| !list_empty(&pwq
->delayed_works
)) {
4579 pr_info("workqueue %s: flags=0x%x\n", wq
->name
, wq
->flags
);
4581 for_each_pwq(pwq
, wq
) {
4582 spin_lock_irqsave(&pwq
->pool
->lock
, flags
);
4583 if (pwq
->nr_active
|| !list_empty(&pwq
->delayed_works
))
4585 spin_unlock_irqrestore(&pwq
->pool
->lock
, flags
);
4587 * We could be printing a lot from atomic context, e.g.
4588 * sysrq-t -> show_workqueue_state(). Avoid triggering
4591 touch_nmi_watchdog();
4595 for_each_pool(pool
, pi
) {
4596 struct worker
*worker
;
4599 spin_lock_irqsave(&pool
->lock
, flags
);
4600 if (pool
->nr_workers
== pool
->nr_idle
)
4603 pr_info("pool %d:", pool
->id
);
4604 pr_cont_pool_info(pool
);
4605 pr_cont(" hung=%us workers=%d",
4606 jiffies_to_msecs(jiffies
- pool
->watchdog_ts
) / 1000,
4609 pr_cont(" manager: %d",
4610 task_pid_nr(pool
->manager
->task
));
4611 list_for_each_entry(worker
, &pool
->idle_list
, entry
) {
4612 pr_cont(" %s%d", first
? "idle: " : "",
4613 task_pid_nr(worker
->task
));
4618 spin_unlock_irqrestore(&pool
->lock
, flags
);
4620 * We could be printing a lot from atomic context, e.g.
4621 * sysrq-t -> show_workqueue_state(). Avoid triggering
4624 touch_nmi_watchdog();
4627 rcu_read_unlock_sched();
4630 /* used to show worker information through /proc/PID/{comm,stat,status} */
4631 void wq_worker_comm(char *buf
, size_t size
, struct task_struct
*task
)
4635 /* always show the actual comm */
4636 off
= strscpy(buf
, task
->comm
, size
);
4640 /* stabilize PF_WQ_WORKER and worker pool association */
4641 mutex_lock(&wq_pool_attach_mutex
);
4643 if (task
->flags
& PF_WQ_WORKER
) {
4644 struct worker
*worker
= kthread_data(task
);
4645 struct worker_pool
*pool
= worker
->pool
;
4648 spin_lock_irq(&pool
->lock
);
4650 * ->desc tracks information (wq name or
4651 * set_worker_desc()) for the latest execution. If
4652 * current, prepend '+', otherwise '-'.
4654 if (worker
->desc
[0] != '\0') {
4655 if (worker
->current_work
)
4656 scnprintf(buf
+ off
, size
- off
, "+%s",
4659 scnprintf(buf
+ off
, size
- off
, "-%s",
4662 spin_unlock_irq(&pool
->lock
);
4666 mutex_unlock(&wq_pool_attach_mutex
);
4674 * There are two challenges in supporting CPU hotplug. Firstly, there
4675 * are a lot of assumptions on strong associations among work, pwq and
4676 * pool which make migrating pending and scheduled works very
4677 * difficult to implement without impacting hot paths. Secondly,
4678 * worker pools serve mix of short, long and very long running works making
4679 * blocked draining impractical.
4681 * This is solved by allowing the pools to be disassociated from the CPU
4682 * running as an unbound one and allowing it to be reattached later if the
4683 * cpu comes back online.
4686 static void unbind_workers(int cpu
)
4688 struct worker_pool
*pool
;
4689 struct worker
*worker
;
4691 for_each_cpu_worker_pool(pool
, cpu
) {
4692 mutex_lock(&wq_pool_attach_mutex
);
4693 spin_lock_irq(&pool
->lock
);
4696 * We've blocked all attach/detach operations. Make all workers
4697 * unbound and set DISASSOCIATED. Before this, all workers
4698 * except for the ones which are still executing works from
4699 * before the last CPU down must be on the cpu. After
4700 * this, they may become diasporas.
4702 for_each_pool_worker(worker
, pool
)
4703 worker
->flags
|= WORKER_UNBOUND
;
4705 pool
->flags
|= POOL_DISASSOCIATED
;
4707 spin_unlock_irq(&pool
->lock
);
4708 mutex_unlock(&wq_pool_attach_mutex
);
4711 * Call schedule() so that we cross rq->lock and thus can
4712 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4713 * This is necessary as scheduler callbacks may be invoked
4719 * Sched callbacks are disabled now. Zap nr_running.
4720 * After this, nr_running stays zero and need_more_worker()
4721 * and keep_working() are always true as long as the
4722 * worklist is not empty. This pool now behaves as an
4723 * unbound (in terms of concurrency management) pool which
4724 * are served by workers tied to the pool.
4726 atomic_set(&pool
->nr_running
, 0);
4729 * With concurrency management just turned off, a busy
4730 * worker blocking could lead to lengthy stalls. Kick off
4731 * unbound chain execution of currently pending work items.
4733 spin_lock_irq(&pool
->lock
);
4734 wake_up_worker(pool
);
4735 spin_unlock_irq(&pool
->lock
);
4740 * rebind_workers - rebind all workers of a pool to the associated CPU
4741 * @pool: pool of interest
4743 * @pool->cpu is coming online. Rebind all workers to the CPU.
4745 static void rebind_workers(struct worker_pool
*pool
)
4747 struct worker
*worker
;
4749 lockdep_assert_held(&wq_pool_attach_mutex
);
4752 * Restore CPU affinity of all workers. As all idle workers should
4753 * be on the run-queue of the associated CPU before any local
4754 * wake-ups for concurrency management happen, restore CPU affinity
4755 * of all workers first and then clear UNBOUND. As we're called
4756 * from CPU_ONLINE, the following shouldn't fail.
4758 for_each_pool_worker(worker
, pool
)
4759 WARN_ON_ONCE(set_cpus_allowed_ptr(worker
->task
,
4760 pool
->attrs
->cpumask
) < 0);
4762 spin_lock_irq(&pool
->lock
);
4764 pool
->flags
&= ~POOL_DISASSOCIATED
;
4766 for_each_pool_worker(worker
, pool
) {
4767 unsigned int worker_flags
= worker
->flags
;
4770 * A bound idle worker should actually be on the runqueue
4771 * of the associated CPU for local wake-ups targeting it to
4772 * work. Kick all idle workers so that they migrate to the
4773 * associated CPU. Doing this in the same loop as
4774 * replacing UNBOUND with REBOUND is safe as no worker will
4775 * be bound before @pool->lock is released.
4777 if (worker_flags
& WORKER_IDLE
)
4778 wake_up_process(worker
->task
);
4781 * We want to clear UNBOUND but can't directly call
4782 * worker_clr_flags() or adjust nr_running. Atomically
4783 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4784 * @worker will clear REBOUND using worker_clr_flags() when
4785 * it initiates the next execution cycle thus restoring
4786 * concurrency management. Note that when or whether
4787 * @worker clears REBOUND doesn't affect correctness.
4789 * WRITE_ONCE() is necessary because @worker->flags may be
4790 * tested without holding any lock in
4791 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4792 * fail incorrectly leading to premature concurrency
4793 * management operations.
4795 WARN_ON_ONCE(!(worker_flags
& WORKER_UNBOUND
));
4796 worker_flags
|= WORKER_REBOUND
;
4797 worker_flags
&= ~WORKER_UNBOUND
;
4798 WRITE_ONCE(worker
->flags
, worker_flags
);
4801 spin_unlock_irq(&pool
->lock
);
4805 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4806 * @pool: unbound pool of interest
4807 * @cpu: the CPU which is coming up
4809 * An unbound pool may end up with a cpumask which doesn't have any online
4810 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4811 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4812 * online CPU before, cpus_allowed of all its workers should be restored.
4814 static void restore_unbound_workers_cpumask(struct worker_pool
*pool
, int cpu
)
4816 static cpumask_t cpumask
;
4817 struct worker
*worker
;
4819 lockdep_assert_held(&wq_pool_attach_mutex
);
4821 /* is @cpu allowed for @pool? */
4822 if (!cpumask_test_cpu(cpu
, pool
->attrs
->cpumask
))
4825 cpumask_and(&cpumask
, pool
->attrs
->cpumask
, cpu_online_mask
);
4827 /* as we're called from CPU_ONLINE, the following shouldn't fail */
4828 for_each_pool_worker(worker
, pool
)
4829 WARN_ON_ONCE(set_cpus_allowed_ptr(worker
->task
, &cpumask
) < 0);
4832 int workqueue_prepare_cpu(unsigned int cpu
)
4834 struct worker_pool
*pool
;
4836 for_each_cpu_worker_pool(pool
, cpu
) {
4837 if (pool
->nr_workers
)
4839 if (!create_worker(pool
))
4845 int workqueue_online_cpu(unsigned int cpu
)
4847 struct worker_pool
*pool
;
4848 struct workqueue_struct
*wq
;
4851 mutex_lock(&wq_pool_mutex
);
4853 for_each_pool(pool
, pi
) {
4854 mutex_lock(&wq_pool_attach_mutex
);
4856 if (pool
->cpu
== cpu
)
4857 rebind_workers(pool
);
4858 else if (pool
->cpu
< 0)
4859 restore_unbound_workers_cpumask(pool
, cpu
);
4861 mutex_unlock(&wq_pool_attach_mutex
);
4864 /* update NUMA affinity of unbound workqueues */
4865 list_for_each_entry(wq
, &workqueues
, list
)
4866 wq_update_unbound_numa(wq
, cpu
, true);
4868 mutex_unlock(&wq_pool_mutex
);
4872 int workqueue_offline_cpu(unsigned int cpu
)
4874 struct workqueue_struct
*wq
;
4876 /* unbinding per-cpu workers should happen on the local CPU */
4877 if (WARN_ON(cpu
!= smp_processor_id()))
4880 unbind_workers(cpu
);
4882 /* update NUMA affinity of unbound workqueues */
4883 mutex_lock(&wq_pool_mutex
);
4884 list_for_each_entry(wq
, &workqueues
, list
)
4885 wq_update_unbound_numa(wq
, cpu
, false);
4886 mutex_unlock(&wq_pool_mutex
);
4891 struct work_for_cpu
{
4892 struct work_struct work
;
4898 static void work_for_cpu_fn(struct work_struct
*work
)
4900 struct work_for_cpu
*wfc
= container_of(work
, struct work_for_cpu
, work
);
4902 wfc
->ret
= wfc
->fn(wfc
->arg
);
4906 * work_on_cpu - run a function in thread context on a particular cpu
4907 * @cpu: the cpu to run on
4908 * @fn: the function to run
4909 * @arg: the function arg
4911 * It is up to the caller to ensure that the cpu doesn't go offline.
4912 * The caller must not hold any locks which would prevent @fn from completing.
4914 * Return: The value @fn returns.
4916 long work_on_cpu(int cpu
, long (*fn
)(void *), void *arg
)
4918 struct work_for_cpu wfc
= { .fn
= fn
, .arg
= arg
};
4920 INIT_WORK_ONSTACK(&wfc
.work
, work_for_cpu_fn
);
4921 schedule_work_on(cpu
, &wfc
.work
);
4922 flush_work(&wfc
.work
);
4923 destroy_work_on_stack(&wfc
.work
);
4926 EXPORT_SYMBOL_GPL(work_on_cpu
);
4929 * work_on_cpu_safe - run a function in thread context on a particular cpu
4930 * @cpu: the cpu to run on
4931 * @fn: the function to run
4932 * @arg: the function argument
4934 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
4935 * any locks which would prevent @fn from completing.
4937 * Return: The value @fn returns.
4939 long work_on_cpu_safe(int cpu
, long (*fn
)(void *), void *arg
)
4944 if (cpu_online(cpu
))
4945 ret
= work_on_cpu(cpu
, fn
, arg
);
4949 EXPORT_SYMBOL_GPL(work_on_cpu_safe
);
4950 #endif /* CONFIG_SMP */
4952 #ifdef CONFIG_FREEZER
4955 * freeze_workqueues_begin - begin freezing workqueues
4957 * Start freezing workqueues. After this function returns, all freezable
4958 * workqueues will queue new works to their delayed_works list instead of
4962 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4964 void freeze_workqueues_begin(void)
4966 struct workqueue_struct
*wq
;
4967 struct pool_workqueue
*pwq
;
4969 mutex_lock(&wq_pool_mutex
);
4971 WARN_ON_ONCE(workqueue_freezing
);
4972 workqueue_freezing
= true;
4974 list_for_each_entry(wq
, &workqueues
, list
) {
4975 mutex_lock(&wq
->mutex
);
4976 for_each_pwq(pwq
, wq
)
4977 pwq_adjust_max_active(pwq
);
4978 mutex_unlock(&wq
->mutex
);
4981 mutex_unlock(&wq_pool_mutex
);
4985 * freeze_workqueues_busy - are freezable workqueues still busy?
4987 * Check whether freezing is complete. This function must be called
4988 * between freeze_workqueues_begin() and thaw_workqueues().
4991 * Grabs and releases wq_pool_mutex.
4994 * %true if some freezable workqueues are still busy. %false if freezing
4997 bool freeze_workqueues_busy(void)
5000 struct workqueue_struct
*wq
;
5001 struct pool_workqueue
*pwq
;
5003 mutex_lock(&wq_pool_mutex
);
5005 WARN_ON_ONCE(!workqueue_freezing
);
5007 list_for_each_entry(wq
, &workqueues
, list
) {
5008 if (!(wq
->flags
& WQ_FREEZABLE
))
5011 * nr_active is monotonically decreasing. It's safe
5012 * to peek without lock.
5014 rcu_read_lock_sched();
5015 for_each_pwq(pwq
, wq
) {
5016 WARN_ON_ONCE(pwq
->nr_active
< 0);
5017 if (pwq
->nr_active
) {
5019 rcu_read_unlock_sched();
5023 rcu_read_unlock_sched();
5026 mutex_unlock(&wq_pool_mutex
);
5031 * thaw_workqueues - thaw workqueues
5033 * Thaw workqueues. Normal queueing is restored and all collected
5034 * frozen works are transferred to their respective pool worklists.
5037 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5039 void thaw_workqueues(void)
5041 struct workqueue_struct
*wq
;
5042 struct pool_workqueue
*pwq
;
5044 mutex_lock(&wq_pool_mutex
);
5046 if (!workqueue_freezing
)
5049 workqueue_freezing
= false;
5051 /* restore max_active and repopulate worklist */
5052 list_for_each_entry(wq
, &workqueues
, list
) {
5053 mutex_lock(&wq
->mutex
);
5054 for_each_pwq(pwq
, wq
)
5055 pwq_adjust_max_active(pwq
);
5056 mutex_unlock(&wq
->mutex
);
5060 mutex_unlock(&wq_pool_mutex
);
5062 #endif /* CONFIG_FREEZER */
5064 static int workqueue_apply_unbound_cpumask(void)
5068 struct workqueue_struct
*wq
;
5069 struct apply_wqattrs_ctx
*ctx
, *n
;
5071 lockdep_assert_held(&wq_pool_mutex
);
5073 list_for_each_entry(wq
, &workqueues
, list
) {
5074 if (!(wq
->flags
& WQ_UNBOUND
))
5076 /* creating multiple pwqs breaks ordering guarantee */
5077 if (wq
->flags
& __WQ_ORDERED
)
5080 ctx
= apply_wqattrs_prepare(wq
, wq
->unbound_attrs
);
5086 list_add_tail(&ctx
->list
, &ctxs
);
5089 list_for_each_entry_safe(ctx
, n
, &ctxs
, list
) {
5091 apply_wqattrs_commit(ctx
);
5092 apply_wqattrs_cleanup(ctx
);
5099 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5100 * @cpumask: the cpumask to set
5102 * The low-level workqueues cpumask is a global cpumask that limits
5103 * the affinity of all unbound workqueues. This function check the @cpumask
5104 * and apply it to all unbound workqueues and updates all pwqs of them.
5106 * Retun: 0 - Success
5107 * -EINVAL - Invalid @cpumask
5108 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5110 int workqueue_set_unbound_cpumask(cpumask_var_t cpumask
)
5113 cpumask_var_t saved_cpumask
;
5115 if (!zalloc_cpumask_var(&saved_cpumask
, GFP_KERNEL
))
5119 * Not excluding isolated cpus on purpose.
5120 * If the user wishes to include them, we allow that.
5122 cpumask_and(cpumask
, cpumask
, cpu_possible_mask
);
5123 if (!cpumask_empty(cpumask
)) {
5124 apply_wqattrs_lock();
5126 /* save the old wq_unbound_cpumask. */
5127 cpumask_copy(saved_cpumask
, wq_unbound_cpumask
);
5129 /* update wq_unbound_cpumask at first and apply it to wqs. */
5130 cpumask_copy(wq_unbound_cpumask
, cpumask
);
5131 ret
= workqueue_apply_unbound_cpumask();
5133 /* restore the wq_unbound_cpumask when failed. */
5135 cpumask_copy(wq_unbound_cpumask
, saved_cpumask
);
5137 apply_wqattrs_unlock();
5140 free_cpumask_var(saved_cpumask
);
5146 * Workqueues with WQ_SYSFS flag set is visible to userland via
5147 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5148 * following attributes.
5150 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5151 * max_active RW int : maximum number of in-flight work items
5153 * Unbound workqueues have the following extra attributes.
5155 * pool_ids RO int : the associated pool IDs for each node
5156 * nice RW int : nice value of the workers
5157 * cpumask RW mask : bitmask of allowed CPUs for the workers
5158 * numa RW bool : whether enable NUMA affinity
5161 struct workqueue_struct
*wq
;
5165 static struct workqueue_struct
*dev_to_wq(struct device
*dev
)
5167 struct wq_device
*wq_dev
= container_of(dev
, struct wq_device
, dev
);
5172 static ssize_t
per_cpu_show(struct device
*dev
, struct device_attribute
*attr
,
5175 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5177 return scnprintf(buf
, PAGE_SIZE
, "%d\n", (bool)!(wq
->flags
& WQ_UNBOUND
));
5179 static DEVICE_ATTR_RO(per_cpu
);
5181 static ssize_t
max_active_show(struct device
*dev
,
5182 struct device_attribute
*attr
, char *buf
)
5184 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5186 return scnprintf(buf
, PAGE_SIZE
, "%d\n", wq
->saved_max_active
);
5189 static ssize_t
max_active_store(struct device
*dev
,
5190 struct device_attribute
*attr
, const char *buf
,
5193 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5196 if (sscanf(buf
, "%d", &val
) != 1 || val
<= 0)
5199 workqueue_set_max_active(wq
, val
);
5202 static DEVICE_ATTR_RW(max_active
);
5204 static struct attribute
*wq_sysfs_attrs
[] = {
5205 &dev_attr_per_cpu
.attr
,
5206 &dev_attr_max_active
.attr
,
5209 ATTRIBUTE_GROUPS(wq_sysfs
);
5211 static ssize_t
wq_pool_ids_show(struct device
*dev
,
5212 struct device_attribute
*attr
, char *buf
)
5214 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5215 const char *delim
= "";
5216 int node
, written
= 0;
5218 rcu_read_lock_sched();
5219 for_each_node(node
) {
5220 written
+= scnprintf(buf
+ written
, PAGE_SIZE
- written
,
5221 "%s%d:%d", delim
, node
,
5222 unbound_pwq_by_node(wq
, node
)->pool
->id
);
5225 written
+= scnprintf(buf
+ written
, PAGE_SIZE
- written
, "\n");
5226 rcu_read_unlock_sched();
5231 static ssize_t
wq_nice_show(struct device
*dev
, struct device_attribute
*attr
,
5234 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5237 mutex_lock(&wq
->mutex
);
5238 written
= scnprintf(buf
, PAGE_SIZE
, "%d\n", wq
->unbound_attrs
->nice
);
5239 mutex_unlock(&wq
->mutex
);
5244 /* prepare workqueue_attrs for sysfs store operations */
5245 static struct workqueue_attrs
*wq_sysfs_prep_attrs(struct workqueue_struct
*wq
)
5247 struct workqueue_attrs
*attrs
;
5249 lockdep_assert_held(&wq_pool_mutex
);
5251 attrs
= alloc_workqueue_attrs(GFP_KERNEL
);
5255 copy_workqueue_attrs(attrs
, wq
->unbound_attrs
);
5259 static ssize_t
wq_nice_store(struct device
*dev
, struct device_attribute
*attr
,
5260 const char *buf
, size_t count
)
5262 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5263 struct workqueue_attrs
*attrs
;
5266 apply_wqattrs_lock();
5268 attrs
= wq_sysfs_prep_attrs(wq
);
5272 if (sscanf(buf
, "%d", &attrs
->nice
) == 1 &&
5273 attrs
->nice
>= MIN_NICE
&& attrs
->nice
<= MAX_NICE
)
5274 ret
= apply_workqueue_attrs_locked(wq
, attrs
);
5279 apply_wqattrs_unlock();
5280 free_workqueue_attrs(attrs
);
5281 return ret
?: count
;
5284 static ssize_t
wq_cpumask_show(struct device
*dev
,
5285 struct device_attribute
*attr
, char *buf
)
5287 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5290 mutex_lock(&wq
->mutex
);
5291 written
= scnprintf(buf
, PAGE_SIZE
, "%*pb\n",
5292 cpumask_pr_args(wq
->unbound_attrs
->cpumask
));
5293 mutex_unlock(&wq
->mutex
);
5297 static ssize_t
wq_cpumask_store(struct device
*dev
,
5298 struct device_attribute
*attr
,
5299 const char *buf
, size_t count
)
5301 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5302 struct workqueue_attrs
*attrs
;
5305 apply_wqattrs_lock();
5307 attrs
= wq_sysfs_prep_attrs(wq
);
5311 ret
= cpumask_parse(buf
, attrs
->cpumask
);
5313 ret
= apply_workqueue_attrs_locked(wq
, attrs
);
5316 apply_wqattrs_unlock();
5317 free_workqueue_attrs(attrs
);
5318 return ret
?: count
;
5321 static ssize_t
wq_numa_show(struct device
*dev
, struct device_attribute
*attr
,
5324 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5327 mutex_lock(&wq
->mutex
);
5328 written
= scnprintf(buf
, PAGE_SIZE
, "%d\n",
5329 !wq
->unbound_attrs
->no_numa
);
5330 mutex_unlock(&wq
->mutex
);
5335 static ssize_t
wq_numa_store(struct device
*dev
, struct device_attribute
*attr
,
5336 const char *buf
, size_t count
)
5338 struct workqueue_struct
*wq
= dev_to_wq(dev
);
5339 struct workqueue_attrs
*attrs
;
5340 int v
, ret
= -ENOMEM
;
5342 apply_wqattrs_lock();
5344 attrs
= wq_sysfs_prep_attrs(wq
);
5349 if (sscanf(buf
, "%d", &v
) == 1) {
5350 attrs
->no_numa
= !v
;
5351 ret
= apply_workqueue_attrs_locked(wq
, attrs
);
5355 apply_wqattrs_unlock();
5356 free_workqueue_attrs(attrs
);
5357 return ret
?: count
;
5360 static struct device_attribute wq_sysfs_unbound_attrs
[] = {
5361 __ATTR(pool_ids
, 0444, wq_pool_ids_show
, NULL
),
5362 __ATTR(nice
, 0644, wq_nice_show
, wq_nice_store
),
5363 __ATTR(cpumask
, 0644, wq_cpumask_show
, wq_cpumask_store
),
5364 __ATTR(numa
, 0644, wq_numa_show
, wq_numa_store
),
5368 static struct bus_type wq_subsys
= {
5369 .name
= "workqueue",
5370 .dev_groups
= wq_sysfs_groups
,
5373 static ssize_t
wq_unbound_cpumask_show(struct device
*dev
,
5374 struct device_attribute
*attr
, char *buf
)
5378 mutex_lock(&wq_pool_mutex
);
5379 written
= scnprintf(buf
, PAGE_SIZE
, "%*pb\n",
5380 cpumask_pr_args(wq_unbound_cpumask
));
5381 mutex_unlock(&wq_pool_mutex
);
5386 static ssize_t
wq_unbound_cpumask_store(struct device
*dev
,
5387 struct device_attribute
*attr
, const char *buf
, size_t count
)
5389 cpumask_var_t cpumask
;
5392 if (!zalloc_cpumask_var(&cpumask
, GFP_KERNEL
))
5395 ret
= cpumask_parse(buf
, cpumask
);
5397 ret
= workqueue_set_unbound_cpumask(cpumask
);
5399 free_cpumask_var(cpumask
);
5400 return ret
? ret
: count
;
5403 static struct device_attribute wq_sysfs_cpumask_attr
=
5404 __ATTR(cpumask
, 0644, wq_unbound_cpumask_show
,
5405 wq_unbound_cpumask_store
);
5407 static int __init
wq_sysfs_init(void)
5411 err
= subsys_virtual_register(&wq_subsys
, NULL
);
5415 return device_create_file(wq_subsys
.dev_root
, &wq_sysfs_cpumask_attr
);
5417 core_initcall(wq_sysfs_init
);
5419 static void wq_device_release(struct device
*dev
)
5421 struct wq_device
*wq_dev
= container_of(dev
, struct wq_device
, dev
);
5427 * workqueue_sysfs_register - make a workqueue visible in sysfs
5428 * @wq: the workqueue to register
5430 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5431 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5432 * which is the preferred method.
5434 * Workqueue user should use this function directly iff it wants to apply
5435 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5436 * apply_workqueue_attrs() may race against userland updating the
5439 * Return: 0 on success, -errno on failure.
5441 int workqueue_sysfs_register(struct workqueue_struct
*wq
)
5443 struct wq_device
*wq_dev
;
5447 * Adjusting max_active or creating new pwqs by applying
5448 * attributes breaks ordering guarantee. Disallow exposing ordered
5451 if (WARN_ON(wq
->flags
& __WQ_ORDERED_EXPLICIT
))
5454 wq
->wq_dev
= wq_dev
= kzalloc(sizeof(*wq_dev
), GFP_KERNEL
);
5459 wq_dev
->dev
.bus
= &wq_subsys
;
5460 wq_dev
->dev
.release
= wq_device_release
;
5461 dev_set_name(&wq_dev
->dev
, "%s", wq
->name
);
5464 * unbound_attrs are created separately. Suppress uevent until
5465 * everything is ready.
5467 dev_set_uevent_suppress(&wq_dev
->dev
, true);
5469 ret
= device_register(&wq_dev
->dev
);
5471 put_device(&wq_dev
->dev
);
5476 if (wq
->flags
& WQ_UNBOUND
) {
5477 struct device_attribute
*attr
;
5479 for (attr
= wq_sysfs_unbound_attrs
; attr
->attr
.name
; attr
++) {
5480 ret
= device_create_file(&wq_dev
->dev
, attr
);
5482 device_unregister(&wq_dev
->dev
);
5489 dev_set_uevent_suppress(&wq_dev
->dev
, false);
5490 kobject_uevent(&wq_dev
->dev
.kobj
, KOBJ_ADD
);
5495 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5496 * @wq: the workqueue to unregister
5498 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
5500 static void workqueue_sysfs_unregister(struct workqueue_struct
*wq
)
5502 struct wq_device
*wq_dev
= wq
->wq_dev
;
5508 device_unregister(&wq_dev
->dev
);
5510 #else /* CONFIG_SYSFS */
5511 static void workqueue_sysfs_unregister(struct workqueue_struct
*wq
) { }
5512 #endif /* CONFIG_SYSFS */
5515 * Workqueue watchdog.
5517 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5518 * flush dependency, a concurrency managed work item which stays RUNNING
5519 * indefinitely. Workqueue stalls can be very difficult to debug as the
5520 * usual warning mechanisms don't trigger and internal workqueue state is
5523 * Workqueue watchdog monitors all worker pools periodically and dumps
5524 * state if some pools failed to make forward progress for a while where
5525 * forward progress is defined as the first item on ->worklist changing.
5527 * This mechanism is controlled through the kernel parameter
5528 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5529 * corresponding sysfs parameter file.
5531 #ifdef CONFIG_WQ_WATCHDOG
5533 static unsigned long wq_watchdog_thresh
= 30;
5534 static struct timer_list wq_watchdog_timer
;
5536 static unsigned long wq_watchdog_touched
= INITIAL_JIFFIES
;
5537 static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu
) = INITIAL_JIFFIES
;
5539 static void wq_watchdog_reset_touched(void)
5543 wq_watchdog_touched
= jiffies
;
5544 for_each_possible_cpu(cpu
)
5545 per_cpu(wq_watchdog_touched_cpu
, cpu
) = jiffies
;
5548 static void wq_watchdog_timer_fn(struct timer_list
*unused
)
5550 unsigned long thresh
= READ_ONCE(wq_watchdog_thresh
) * HZ
;
5551 bool lockup_detected
= false;
5552 struct worker_pool
*pool
;
5560 for_each_pool(pool
, pi
) {
5561 unsigned long pool_ts
, touched
, ts
;
5563 if (list_empty(&pool
->worklist
))
5566 /* get the latest of pool and touched timestamps */
5567 pool_ts
= READ_ONCE(pool
->watchdog_ts
);
5568 touched
= READ_ONCE(wq_watchdog_touched
);
5570 if (time_after(pool_ts
, touched
))
5575 if (pool
->cpu
>= 0) {
5576 unsigned long cpu_touched
=
5577 READ_ONCE(per_cpu(wq_watchdog_touched_cpu
,
5579 if (time_after(cpu_touched
, ts
))
5584 if (time_after(jiffies
, ts
+ thresh
)) {
5585 lockup_detected
= true;
5586 pr_emerg("BUG: workqueue lockup - pool");
5587 pr_cont_pool_info(pool
);
5588 pr_cont(" stuck for %us!\n",
5589 jiffies_to_msecs(jiffies
- pool_ts
) / 1000);
5595 if (lockup_detected
)
5596 show_workqueue_state();
5598 wq_watchdog_reset_touched();
5599 mod_timer(&wq_watchdog_timer
, jiffies
+ thresh
);
5602 notrace
void wq_watchdog_touch(int cpu
)
5605 per_cpu(wq_watchdog_touched_cpu
, cpu
) = jiffies
;
5607 wq_watchdog_touched
= jiffies
;
5610 static void wq_watchdog_set_thresh(unsigned long thresh
)
5612 wq_watchdog_thresh
= 0;
5613 del_timer_sync(&wq_watchdog_timer
);
5616 wq_watchdog_thresh
= thresh
;
5617 wq_watchdog_reset_touched();
5618 mod_timer(&wq_watchdog_timer
, jiffies
+ thresh
* HZ
);
5622 static int wq_watchdog_param_set_thresh(const char *val
,
5623 const struct kernel_param
*kp
)
5625 unsigned long thresh
;
5628 ret
= kstrtoul(val
, 0, &thresh
);
5633 wq_watchdog_set_thresh(thresh
);
5635 wq_watchdog_thresh
= thresh
;
5640 static const struct kernel_param_ops wq_watchdog_thresh_ops
= {
5641 .set
= wq_watchdog_param_set_thresh
,
5642 .get
= param_get_ulong
,
5645 module_param_cb(watchdog_thresh
, &wq_watchdog_thresh_ops
, &wq_watchdog_thresh
,
5648 static void wq_watchdog_init(void)
5650 timer_setup(&wq_watchdog_timer
, wq_watchdog_timer_fn
, TIMER_DEFERRABLE
);
5651 wq_watchdog_set_thresh(wq_watchdog_thresh
);
5654 #else /* CONFIG_WQ_WATCHDOG */
5656 static inline void wq_watchdog_init(void) { }
5658 #endif /* CONFIG_WQ_WATCHDOG */
5660 static void __init
wq_numa_init(void)
5665 if (num_possible_nodes() <= 1)
5668 if (wq_disable_numa
) {
5669 pr_info("workqueue: NUMA affinity support disabled\n");
5673 wq_update_unbound_numa_attrs_buf
= alloc_workqueue_attrs(GFP_KERNEL
);
5674 BUG_ON(!wq_update_unbound_numa_attrs_buf
);
5677 * We want masks of possible CPUs of each node which isn't readily
5678 * available. Build one from cpu_to_node() which should have been
5679 * fully initialized by now.
5681 tbl
= kcalloc(nr_node_ids
, sizeof(tbl
[0]), GFP_KERNEL
);
5685 BUG_ON(!zalloc_cpumask_var_node(&tbl
[node
], GFP_KERNEL
,
5686 node_online(node
) ? node
: NUMA_NO_NODE
));
5688 for_each_possible_cpu(cpu
) {
5689 node
= cpu_to_node(cpu
);
5690 if (WARN_ON(node
== NUMA_NO_NODE
)) {
5691 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu
);
5692 /* happens iff arch is bonkers, let's just proceed */
5695 cpumask_set_cpu(cpu
, tbl
[node
]);
5698 wq_numa_possible_cpumask
= tbl
;
5699 wq_numa_enabled
= true;
5703 * workqueue_init_early - early init for workqueue subsystem
5705 * This is the first half of two-staged workqueue subsystem initialization
5706 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5707 * idr are up. It sets up all the data structures and system workqueues
5708 * and allows early boot code to create workqueues and queue/cancel work
5709 * items. Actual work item execution starts only after kthreads can be
5710 * created and scheduled right before early initcalls.
5712 int __init
workqueue_init_early(void)
5714 int std_nice
[NR_STD_WORKER_POOLS
] = { 0, HIGHPRI_NICE_LEVEL
};
5715 int hk_flags
= HK_FLAG_DOMAIN
| HK_FLAG_WQ
;
5718 WARN_ON(__alignof__(struct pool_workqueue
) < __alignof__(long long));
5720 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask
, GFP_KERNEL
));
5721 cpumask_copy(wq_unbound_cpumask
, housekeeping_cpumask(hk_flags
));
5723 pwq_cache
= KMEM_CACHE(pool_workqueue
, SLAB_PANIC
);
5725 /* initialize CPU pools */
5726 for_each_possible_cpu(cpu
) {
5727 struct worker_pool
*pool
;
5730 for_each_cpu_worker_pool(pool
, cpu
) {
5731 BUG_ON(init_worker_pool(pool
));
5733 cpumask_copy(pool
->attrs
->cpumask
, cpumask_of(cpu
));
5734 pool
->attrs
->nice
= std_nice
[i
++];
5735 pool
->node
= cpu_to_node(cpu
);
5738 mutex_lock(&wq_pool_mutex
);
5739 BUG_ON(worker_pool_assign_id(pool
));
5740 mutex_unlock(&wq_pool_mutex
);
5744 /* create default unbound and ordered wq attrs */
5745 for (i
= 0; i
< NR_STD_WORKER_POOLS
; i
++) {
5746 struct workqueue_attrs
*attrs
;
5748 BUG_ON(!(attrs
= alloc_workqueue_attrs(GFP_KERNEL
)));
5749 attrs
->nice
= std_nice
[i
];
5750 unbound_std_wq_attrs
[i
] = attrs
;
5753 * An ordered wq should have only one pwq as ordering is
5754 * guaranteed by max_active which is enforced by pwqs.
5755 * Turn off NUMA so that dfl_pwq is used for all nodes.
5757 BUG_ON(!(attrs
= alloc_workqueue_attrs(GFP_KERNEL
)));
5758 attrs
->nice
= std_nice
[i
];
5759 attrs
->no_numa
= true;
5760 ordered_wq_attrs
[i
] = attrs
;
5763 system_wq
= alloc_workqueue("events", 0, 0);
5764 system_highpri_wq
= alloc_workqueue("events_highpri", WQ_HIGHPRI
, 0);
5765 system_long_wq
= alloc_workqueue("events_long", 0, 0);
5766 system_unbound_wq
= alloc_workqueue("events_unbound", WQ_UNBOUND
,
5767 WQ_UNBOUND_MAX_ACTIVE
);
5768 system_freezable_wq
= alloc_workqueue("events_freezable",
5770 system_power_efficient_wq
= alloc_workqueue("events_power_efficient",
5771 WQ_POWER_EFFICIENT
, 0);
5772 system_freezable_power_efficient_wq
= alloc_workqueue("events_freezable_power_efficient",
5773 WQ_FREEZABLE
| WQ_POWER_EFFICIENT
,
5775 BUG_ON(!system_wq
|| !system_highpri_wq
|| !system_long_wq
||
5776 !system_unbound_wq
|| !system_freezable_wq
||
5777 !system_power_efficient_wq
||
5778 !system_freezable_power_efficient_wq
);
5784 * workqueue_init - bring workqueue subsystem fully online
5786 * This is the latter half of two-staged workqueue subsystem initialization
5787 * and invoked as soon as kthreads can be created and scheduled.
5788 * Workqueues have been created and work items queued on them, but there
5789 * are no kworkers executing the work items yet. Populate the worker pools
5790 * with the initial workers and enable future kworker creations.
5792 int __init
workqueue_init(void)
5794 struct workqueue_struct
*wq
;
5795 struct worker_pool
*pool
;
5799 * It'd be simpler to initialize NUMA in workqueue_init_early() but
5800 * CPU to node mapping may not be available that early on some
5801 * archs such as power and arm64. As per-cpu pools created
5802 * previously could be missing node hint and unbound pools NUMA
5803 * affinity, fix them up.
5805 * Also, while iterating workqueues, create rescuers if requested.
5809 mutex_lock(&wq_pool_mutex
);
5811 for_each_possible_cpu(cpu
) {
5812 for_each_cpu_worker_pool(pool
, cpu
) {
5813 pool
->node
= cpu_to_node(cpu
);
5817 list_for_each_entry(wq
, &workqueues
, list
) {
5818 wq_update_unbound_numa(wq
, smp_processor_id(), true);
5819 WARN(init_rescuer(wq
),
5820 "workqueue: failed to create early rescuer for %s",
5824 mutex_unlock(&wq_pool_mutex
);
5826 /* create the initial workers */
5827 for_each_online_cpu(cpu
) {
5828 for_each_cpu_worker_pool(pool
, cpu
) {
5829 pool
->flags
&= ~POOL_DISASSOCIATED
;
5830 BUG_ON(!create_worker(pool
));
5834 hash_for_each(unbound_pool_hash
, bkt
, pool
, hash_node
)
5835 BUG_ON(!create_worker(pool
));