]> git.proxmox.com Git - mirror_ubuntu-kernels.git/blame - kernel/workqueue.c
workqueue: Tag bound workers with KTHREAD_IS_PER_CPU
[mirror_ubuntu-kernels.git] / kernel / workqueue.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4 2/*
c54fce6e 3 * kernel/workqueue.c - generic async execution with shared worker pool
1da177e4 4 *
c54fce6e 5 * Copyright (C) 2002 Ingo Molnar
1da177e4 6 *
c54fce6e
TH
7 * Derived from the taskqueue/keventd code by:
8 * David Woodhouse <dwmw2@infradead.org>
9 * Andrew Morton
10 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
11 * Theodore Ts'o <tytso@mit.edu>
1da177e4 12 *
c54fce6e 13 * Made to use alloc_percpu by Christoph Lameter.
1da177e4 14 *
c54fce6e
TH
15 * Copyright (C) 2010 SUSE Linux Products GmbH
16 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
89ada679 17 *
c54fce6e
TH
18 * This is the generic async execution mechanism. Work items as are
19 * executed in process context. The worker pool is shared and
b11895c4
L
20 * automatically managed. There are two worker pools for each CPU (one for
21 * normal work items and the other for high priority ones) and some extra
22 * pools for workqueues which are not bound to any specific CPU - the
23 * number of these backing pools is dynamic.
c54fce6e 24 *
9a261491 25 * Please read Documentation/core-api/workqueue.rst for details.
1da177e4
LT
26 */
27
9984de1a 28#include <linux/export.h>
1da177e4
LT
29#include <linux/kernel.h>
30#include <linux/sched.h>
31#include <linux/init.h>
32#include <linux/signal.h>
33#include <linux/completion.h>
34#include <linux/workqueue.h>
35#include <linux/slab.h>
36#include <linux/cpu.h>
37#include <linux/notifier.h>
38#include <linux/kthread.h>
1fa44eca 39#include <linux/hardirq.h>
46934023 40#include <linux/mempolicy.h>
341a5958 41#include <linux/freezer.h>
d5abe669 42#include <linux/debug_locks.h>
4e6045f1 43#include <linux/lockdep.h>
c34056a3 44#include <linux/idr.h>
29c91e99 45#include <linux/jhash.h>
42f8570f 46#include <linux/hashtable.h>
76af4d93 47#include <linux/rculist.h>
bce90380 48#include <linux/nodemask.h>
4c16bd32 49#include <linux/moduleparam.h>
3d1cb205 50#include <linux/uaccess.h>
c98a9805 51#include <linux/sched/isolation.h>
62635ea8 52#include <linux/nmi.h>
e22bee78 53
ea138446 54#include "workqueue_internal.h"
1da177e4 55
c8e55f36 56enum {
24647570
TH
57 /*
58 * worker_pool flags
bc2ae0f5 59 *
24647570 60 * A bound pool is either associated or disassociated with its CPU.
bc2ae0f5
TH
61 * While associated (!DISASSOCIATED), all workers are bound to the
62 * CPU and none has %WORKER_UNBOUND set and concurrency management
63 * is in effect.
64 *
65 * While DISASSOCIATED, the cpu may be offline and all workers have
66 * %WORKER_UNBOUND set and concurrency management disabled, and may
24647570 67 * be executing on any CPU. The pool behaves as an unbound one.
bc2ae0f5 68 *
bc3a1afc 69 * Note that DISASSOCIATED should be flipped only while holding
1258fae7 70 * wq_pool_attach_mutex to avoid changing binding state while
4736cbf7 71 * worker_attach_to_pool() is in progress.
bc2ae0f5 72 */
692b4825 73 POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */
24647570 74 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
db7bccf4 75
c8e55f36 76 /* worker flags */
c8e55f36
TH
77 WORKER_DIE = 1 << 1, /* die die die */
78 WORKER_IDLE = 1 << 2, /* is idle */
e22bee78 79 WORKER_PREP = 1 << 3, /* preparing to run works */
fb0e7beb 80 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
f3421797 81 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
a9ab775b 82 WORKER_REBOUND = 1 << 8, /* worker was rebound */
e22bee78 83
a9ab775b
TH
84 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
85 WORKER_UNBOUND | WORKER_REBOUND,
db7bccf4 86
e34cdddb 87 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
4ce62e9e 88
29c91e99 89 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
c8e55f36 90 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
db7bccf4 91
e22bee78
TH
92 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
93 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
94
3233cdbd
TH
95 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
96 /* call for help after 10ms
97 (min two ticks) */
e22bee78
TH
98 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
99 CREATE_COOLDOWN = HZ, /* time to breath after fail */
e22bee78
TH
100
101 /*
102 * Rescue workers are used only on emergencies and shared by
8698a745 103 * all cpus. Give MIN_NICE.
e22bee78 104 */
8698a745
DY
105 RESCUER_NICE_LEVEL = MIN_NICE,
106 HIGHPRI_NICE_LEVEL = MIN_NICE,
ecf6881f
TH
107
108 WQ_NAME_LEN = 24,
c8e55f36 109};
1da177e4
LT
110
111/*
4690c4ab
TH
112 * Structure fields follow one of the following exclusion rules.
113 *
e41e704b
TH
114 * I: Modifiable by initialization/destruction paths and read-only for
115 * everyone else.
4690c4ab 116 *
e22bee78
TH
117 * P: Preemption protected. Disabling preemption is enough and should
118 * only be modified and accessed from the local cpu.
119 *
d565ed63 120 * L: pool->lock protected. Access with pool->lock held.
4690c4ab 121 *
d565ed63
TH
122 * X: During normal operation, modification requires pool->lock and should
123 * be done only from local cpu. Either disabling preemption on local
124 * cpu or grabbing pool->lock is enough for read access. If
125 * POOL_DISASSOCIATED is set, it's identical to L.
e22bee78 126 *
1258fae7 127 * A: wq_pool_attach_mutex protected.
822d8405 128 *
68e13a67 129 * PL: wq_pool_mutex protected.
5bcab335 130 *
24acfb71 131 * PR: wq_pool_mutex protected for writes. RCU protected for reads.
76af4d93 132 *
5b95e1af
LJ
133 * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads.
134 *
135 * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or
24acfb71 136 * RCU for reads.
5b95e1af 137 *
3c25a55d
LJ
138 * WQ: wq->mutex protected.
139 *
24acfb71 140 * WR: wq->mutex protected for writes. RCU protected for reads.
2e109a28
TH
141 *
142 * MD: wq_mayday_lock protected.
1da177e4 143 */
1da177e4 144
2eaebdb3 145/* struct worker is defined in workqueue_internal.h */
c34056a3 146
bd7bdd43 147struct worker_pool {
a9b8a985 148 raw_spinlock_t lock; /* the pool lock */
d84ff051 149 int cpu; /* I: the associated cpu */
f3f90ad4 150 int node; /* I: the associated node ID */
9daf9e67 151 int id; /* I: pool ID */
11ebea50 152 unsigned int flags; /* X: flags */
bd7bdd43 153
82607adc
TH
154 unsigned long watchdog_ts; /* L: watchdog timestamp */
155
bd7bdd43 156 struct list_head worklist; /* L: list of pending works */
ea1abd61 157
5826cc8f
LJ
158 int nr_workers; /* L: total number of workers */
159 int nr_idle; /* L: currently idle workers */
bd7bdd43
TH
160
161 struct list_head idle_list; /* X: list of idle workers */
162 struct timer_list idle_timer; /* L: worker idle timeout */
163 struct timer_list mayday_timer; /* L: SOS timer for workers */
164
c5aa87bb 165 /* a workers is either on busy_hash or idle_list, or the manager */
c9e7cf27
TH
166 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
167 /* L: hash of busy workers */
168
2607d7a6 169 struct worker *manager; /* L: purely informational */
92f9c5c4 170 struct list_head workers; /* A: attached workers */
60f5a4bc 171 struct completion *detach_completion; /* all workers detached */
e19e397a 172
7cda9aae 173 struct ida worker_ida; /* worker IDs for task name */
e19e397a 174
7a4e344c 175 struct workqueue_attrs *attrs; /* I: worker attributes */
68e13a67
LJ
176 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
177 int refcnt; /* PL: refcnt for unbound pools */
7a4e344c 178
e19e397a
TH
179 /*
180 * The current concurrency level. As it's likely to be accessed
181 * from other CPUs during try_to_wake_up(), put it in a separate
182 * cacheline.
183 */
184 atomic_t nr_running ____cacheline_aligned_in_smp;
29c91e99
TH
185
186 /*
24acfb71 187 * Destruction of pool is RCU protected to allow dereferences
29c91e99
TH
188 * from get_work_pool().
189 */
190 struct rcu_head rcu;
8b03ae3c
TH
191} ____cacheline_aligned_in_smp;
192
1da177e4 193/*
112202d9
TH
194 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
195 * of work_struct->data are used for flags and the remaining high bits
196 * point to the pwq; thus, pwqs need to be aligned at two's power of the
197 * number of flag bits.
1da177e4 198 */
112202d9 199struct pool_workqueue {
bd7bdd43 200 struct worker_pool *pool; /* I: the associated pool */
4690c4ab 201 struct workqueue_struct *wq; /* I: the owning workqueue */
73f53c4a
TH
202 int work_color; /* L: current color */
203 int flush_color; /* L: flushing color */
8864b4e5 204 int refcnt; /* L: reference count */
73f53c4a
TH
205 int nr_in_flight[WORK_NR_COLORS];
206 /* L: nr of in_flight works */
1e19ffc6 207 int nr_active; /* L: nr of active works */
a0a1a5fd 208 int max_active; /* L: max active works */
1e19ffc6 209 struct list_head delayed_works; /* L: delayed works */
3c25a55d 210 struct list_head pwqs_node; /* WR: node on wq->pwqs */
2e109a28 211 struct list_head mayday_node; /* MD: node on wq->maydays */
8864b4e5
TH
212
213 /*
214 * Release of unbound pwq is punted to system_wq. See put_pwq()
215 * and pwq_unbound_release_workfn() for details. pool_workqueue
24acfb71 216 * itself is also RCU protected so that the first pwq can be
b09f4fd3 217 * determined without grabbing wq->mutex.
8864b4e5
TH
218 */
219 struct work_struct unbound_release_work;
220 struct rcu_head rcu;
e904e6c2 221} __aligned(1 << WORK_STRUCT_FLAG_BITS);
1da177e4 222
73f53c4a
TH
223/*
224 * Structure used to wait for workqueue flush.
225 */
226struct wq_flusher {
3c25a55d
LJ
227 struct list_head list; /* WQ: list of flushers */
228 int flush_color; /* WQ: flush color waiting for */
73f53c4a
TH
229 struct completion done; /* flush completion */
230};
231
226223ab
TH
232struct wq_device;
233
1da177e4 234/*
c5aa87bb
TH
235 * The externally visible workqueue. It relays the issued work items to
236 * the appropriate worker_pool through its pool_workqueues.
1da177e4
LT
237 */
238struct workqueue_struct {
3c25a55d 239 struct list_head pwqs; /* WR: all pwqs of this wq */
e2dca7ad 240 struct list_head list; /* PR: list of all workqueues */
73f53c4a 241
3c25a55d
LJ
242 struct mutex mutex; /* protects this wq */
243 int work_color; /* WQ: current work color */
244 int flush_color; /* WQ: current flush color */
112202d9 245 atomic_t nr_pwqs_to_flush; /* flush in progress */
3c25a55d
LJ
246 struct wq_flusher *first_flusher; /* WQ: first flusher */
247 struct list_head flusher_queue; /* WQ: flush waiters */
248 struct list_head flusher_overflow; /* WQ: flush overflow list */
73f53c4a 249
2e109a28 250 struct list_head maydays; /* MD: pwqs requesting rescue */
30ae2fc0 251 struct worker *rescuer; /* MD: rescue worker */
e22bee78 252
87fc741e 253 int nr_drainers; /* WQ: drain in progress */
a357fc03 254 int saved_max_active; /* WQ: saved pwq max_active */
226223ab 255
5b95e1af
LJ
256 struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */
257 struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */
6029a918 258
226223ab
TH
259#ifdef CONFIG_SYSFS
260 struct wq_device *wq_dev; /* I: for sysfs interface */
261#endif
4e6045f1 262#ifdef CONFIG_LOCKDEP
669de8bd
BVA
263 char *lock_name;
264 struct lock_class_key key;
4690c4ab 265 struct lockdep_map lockdep_map;
4e6045f1 266#endif
ecf6881f 267 char name[WQ_NAME_LEN]; /* I: workqueue name */
2728fd2f 268
e2dca7ad 269 /*
24acfb71
TG
270 * Destruction of workqueue_struct is RCU protected to allow walking
271 * the workqueues list without grabbing wq_pool_mutex.
e2dca7ad
TH
272 * This is used to dump all workqueues from sysrq.
273 */
274 struct rcu_head rcu;
275
2728fd2f
TH
276 /* hot fields used during command issue, aligned to cacheline */
277 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
278 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
5b95e1af 279 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
1da177e4
LT
280};
281
e904e6c2
TH
282static struct kmem_cache *pwq_cache;
283
bce90380
TH
284static cpumask_var_t *wq_numa_possible_cpumask;
285 /* possible CPUs of each node */
286
d55262c4
TH
287static bool wq_disable_numa;
288module_param_named(disable_numa, wq_disable_numa, bool, 0444);
289
cee22a15 290/* see the comment above the definition of WQ_POWER_EFFICIENT */
552f530c 291static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
cee22a15
VK
292module_param_named(power_efficient, wq_power_efficient, bool, 0444);
293
863b710b 294static bool wq_online; /* can kworkers be created yet? */
3347fa09 295
bce90380
TH
296static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
297
4c16bd32
TH
298/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
299static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
300
68e13a67 301static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
1258fae7 302static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
a9b8a985 303static DEFINE_RAW_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
d8bb65ab
SAS
304/* wait for manager to go away */
305static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
5bcab335 306
e2dca7ad 307static LIST_HEAD(workqueues); /* PR: list of all workqueues */
68e13a67 308static bool workqueue_freezing; /* PL: have wqs started freezing? */
7d19c5ce 309
ef557180
MG
310/* PL: allowable cpus for unbound wqs and work items */
311static cpumask_var_t wq_unbound_cpumask;
312
313/* CPU where unbound work was last round robin scheduled from this CPU */
314static DEFINE_PER_CPU(int, wq_rr_cpu_last);
b05a7928 315
f303fccb
TH
316/*
317 * Local execution of unbound work items is no longer guaranteed. The
318 * following always forces round-robin CPU selection on unbound work items
319 * to uncover usages which depend on it.
320 */
321#ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
322static bool wq_debug_force_rr_cpu = true;
323#else
324static bool wq_debug_force_rr_cpu = false;
325#endif
326module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
327
7d19c5ce 328/* the per-cpu worker pools */
25528213 329static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
7d19c5ce 330
68e13a67 331static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
7d19c5ce 332
68e13a67 333/* PL: hash of all unbound pools keyed by pool->attrs */
29c91e99
TH
334static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
335
c5aa87bb 336/* I: attributes used when instantiating standard unbound pools on demand */
29c91e99
TH
337static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
338
8a2b7538
TH
339/* I: attributes used when instantiating ordered pools on demand */
340static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
341
d320c038 342struct workqueue_struct *system_wq __read_mostly;
ad7b1f84 343EXPORT_SYMBOL(system_wq);
044c782c 344struct workqueue_struct *system_highpri_wq __read_mostly;
1aabe902 345EXPORT_SYMBOL_GPL(system_highpri_wq);
044c782c 346struct workqueue_struct *system_long_wq __read_mostly;
d320c038 347EXPORT_SYMBOL_GPL(system_long_wq);
044c782c 348struct workqueue_struct *system_unbound_wq __read_mostly;
f3421797 349EXPORT_SYMBOL_GPL(system_unbound_wq);
044c782c 350struct workqueue_struct *system_freezable_wq __read_mostly;
24d51add 351EXPORT_SYMBOL_GPL(system_freezable_wq);
0668106c
VK
352struct workqueue_struct *system_power_efficient_wq __read_mostly;
353EXPORT_SYMBOL_GPL(system_power_efficient_wq);
354struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
355EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
d320c038 356
7d19c5ce 357static int worker_thread(void *__worker);
6ba94429 358static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
c29eb853 359static void show_pwq(struct pool_workqueue *pwq);
7d19c5ce 360
97bd2347
TH
361#define CREATE_TRACE_POINTS
362#include <trace/events/workqueue.h>
363
68e13a67 364#define assert_rcu_or_pool_mutex() \
24acfb71 365 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
f78f5b90 366 !lockdep_is_held(&wq_pool_mutex), \
24acfb71 367 "RCU or wq_pool_mutex should be held")
5bcab335 368
5b95e1af 369#define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \
24acfb71 370 RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \
f78f5b90
PM
371 !lockdep_is_held(&wq->mutex) && \
372 !lockdep_is_held(&wq_pool_mutex), \
24acfb71 373 "RCU, wq->mutex or wq_pool_mutex should be held")
5b95e1af 374
f02ae73a
TH
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]; \
7a62c2c8 378 (pool)++)
4ce62e9e 379
17116969
TH
380/**
381 * for_each_pool - iterate through all worker_pools in the system
382 * @pool: iteration cursor
611c92a0 383 * @pi: integer used for iteration
fa1b54e6 384 *
24acfb71 385 * This must be called either with wq_pool_mutex held or RCU read
68e13a67
LJ
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.
fa1b54e6
TH
388 *
389 * The if/else clause exists only for the lockdep assertion and can be
390 * ignored.
17116969 391 */
611c92a0
TH
392#define for_each_pool(pool, pi) \
393 idr_for_each_entry(&worker_pool_idr, pool, pi) \
68e13a67 394 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
fa1b54e6 395 else
17116969 396
822d8405
TH
397/**
398 * for_each_pool_worker - iterate through all workers of a worker_pool
399 * @worker: iteration cursor
822d8405
TH
400 * @pool: worker_pool to iterate workers of
401 *
1258fae7 402 * This must be called with wq_pool_attach_mutex.
822d8405
TH
403 *
404 * The if/else clause exists only for the lockdep assertion and can be
405 * ignored.
406 */
da028469
LJ
407#define for_each_pool_worker(worker, pool) \
408 list_for_each_entry((worker), &(pool)->workers, node) \
1258fae7 409 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
822d8405
TH
410 else
411
49e3cf44
TH
412/**
413 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
414 * @pwq: iteration cursor
415 * @wq: the target workqueue
76af4d93 416 *
24acfb71 417 * This must be called either with wq->mutex held or RCU read locked.
794b18bc
TH
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.
76af4d93
TH
420 *
421 * The if/else clause exists only for the lockdep assertion and can be
422 * ignored.
49e3cf44
TH
423 */
424#define for_each_pwq(pwq, wq) \
49e9d1a9 425 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \
5a644662 426 lockdep_is_held(&(wq->mutex)))
f3421797 427
dc186ad7
TG
428#ifdef CONFIG_DEBUG_OBJECTS_WORK
429
f9e62f31 430static const struct debug_obj_descr work_debug_descr;
dc186ad7 431
99777288
SG
432static void *work_debug_hint(void *addr)
433{
434 return ((struct work_struct *) addr)->func;
435}
436
b9fdac7f
DC
437static bool work_is_static_object(void *addr)
438{
439 struct work_struct *work = addr;
440
441 return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
442}
443
dc186ad7
TG
444/*
445 * fixup_init is called when:
446 * - an active object is initialized
447 */
02a982a6 448static bool work_fixup_init(void *addr, enum debug_obj_state state)
dc186ad7
TG
449{
450 struct work_struct *work = addr;
451
452 switch (state) {
453 case ODEBUG_STATE_ACTIVE:
454 cancel_work_sync(work);
455 debug_object_init(work, &work_debug_descr);
02a982a6 456 return true;
dc186ad7 457 default:
02a982a6 458 return false;
dc186ad7
TG
459 }
460}
461
dc186ad7
TG
462/*
463 * fixup_free is called when:
464 * - an active object is freed
465 */
02a982a6 466static bool work_fixup_free(void *addr, enum debug_obj_state state)
dc186ad7
TG
467{
468 struct work_struct *work = addr;
469
470 switch (state) {
471 case ODEBUG_STATE_ACTIVE:
472 cancel_work_sync(work);
473 debug_object_free(work, &work_debug_descr);
02a982a6 474 return true;
dc186ad7 475 default:
02a982a6 476 return false;
dc186ad7
TG
477 }
478}
479
f9e62f31 480static const struct debug_obj_descr work_debug_descr = {
dc186ad7 481 .name = "work_struct",
99777288 482 .debug_hint = work_debug_hint,
b9fdac7f 483 .is_static_object = work_is_static_object,
dc186ad7 484 .fixup_init = work_fixup_init,
dc186ad7
TG
485 .fixup_free = work_fixup_free,
486};
487
488static inline void debug_work_activate(struct work_struct *work)
489{
490 debug_object_activate(work, &work_debug_descr);
491}
492
493static inline void debug_work_deactivate(struct work_struct *work)
494{
495 debug_object_deactivate(work, &work_debug_descr);
496}
497
498void __init_work(struct work_struct *work, int onstack)
499{
500 if (onstack)
501 debug_object_init_on_stack(work, &work_debug_descr);
502 else
503 debug_object_init(work, &work_debug_descr);
504}
505EXPORT_SYMBOL_GPL(__init_work);
506
507void destroy_work_on_stack(struct work_struct *work)
508{
509 debug_object_free(work, &work_debug_descr);
510}
511EXPORT_SYMBOL_GPL(destroy_work_on_stack);
512
ea2e64f2
TG
513void destroy_delayed_work_on_stack(struct delayed_work *work)
514{
515 destroy_timer_on_stack(&work->timer);
516 debug_object_free(&work->work, &work_debug_descr);
517}
518EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
519
dc186ad7
TG
520#else
521static inline void debug_work_activate(struct work_struct *work) { }
522static inline void debug_work_deactivate(struct work_struct *work) { }
523#endif
524
4e8b22bd
LB
525/**
526 * worker_pool_assign_id - allocate ID and assing it to @pool
527 * @pool: the pool pointer of interest
528 *
529 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
530 * successfully, -errno on failure.
531 */
9daf9e67
TH
532static int worker_pool_assign_id(struct worker_pool *pool)
533{
534 int ret;
535
68e13a67 536 lockdep_assert_held(&wq_pool_mutex);
5bcab335 537
4e8b22bd
LB
538 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
539 GFP_KERNEL);
229641a6 540 if (ret >= 0) {
e68035fb 541 pool->id = ret;
229641a6
TH
542 return 0;
543 }
fa1b54e6 544 return ret;
7c3eed5c
TH
545}
546
df2d5ae4
TH
547/**
548 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
549 * @wq: the target workqueue
550 * @node: the node ID
551 *
24acfb71 552 * This must be called with any of wq_pool_mutex, wq->mutex or RCU
5b95e1af 553 * read locked.
df2d5ae4
TH
554 * If the pwq needs to be used beyond the locking in effect, the caller is
555 * responsible for guaranteeing that the pwq stays online.
d185af30
YB
556 *
557 * Return: The unbound pool_workqueue for @node.
df2d5ae4
TH
558 */
559static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
560 int node)
561{
5b95e1af 562 assert_rcu_or_wq_mutex_or_pool_mutex(wq);
d6e022f1
TH
563
564 /*
565 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
566 * delayed item is pending. The plan is to keep CPU -> NODE
567 * mapping valid and stable across CPU on/offlines. Once that
568 * happens, this workaround can be removed.
569 */
570 if (unlikely(node == NUMA_NO_NODE))
571 return wq->dfl_pwq;
572
df2d5ae4
TH
573 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
574}
575
73f53c4a
TH
576static unsigned int work_color_to_flags(int color)
577{
578 return color << WORK_STRUCT_COLOR_SHIFT;
579}
580
581static int get_work_color(struct work_struct *work)
582{
583 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
584 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
585}
586
587static int work_next_color(int color)
588{
589 return (color + 1) % WORK_NR_COLORS;
590}
1da177e4 591
14441960 592/*
112202d9
TH
593 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
594 * contain the pointer to the queued pwq. Once execution starts, the flag
7c3eed5c 595 * is cleared and the high bits contain OFFQ flags and pool ID.
7a22ad75 596 *
112202d9
TH
597 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
598 * and clear_work_data() can be used to set the pwq, pool or clear
bbb68dfa
TH
599 * work->data. These functions should only be called while the work is
600 * owned - ie. while the PENDING bit is set.
7a22ad75 601 *
112202d9 602 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
7c3eed5c 603 * corresponding to a work. Pool is available once the work has been
112202d9 604 * queued anywhere after initialization until it is sync canceled. pwq is
7c3eed5c 605 * available only while the work item is queued.
7a22ad75 606 *
bbb68dfa
TH
607 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
608 * canceled. While being canceled, a work item may have its PENDING set
609 * but stay off timer and worklist for arbitrarily long and nobody should
610 * try to steal the PENDING bit.
14441960 611 */
7a22ad75
TH
612static inline void set_work_data(struct work_struct *work, unsigned long data,
613 unsigned long flags)
365970a1 614{
6183c009 615 WARN_ON_ONCE(!work_pending(work));
7a22ad75
TH
616 atomic_long_set(&work->data, data | flags | work_static(work));
617}
365970a1 618
112202d9 619static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
7a22ad75
TH
620 unsigned long extra_flags)
621{
112202d9
TH
622 set_work_data(work, (unsigned long)pwq,
623 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
365970a1
DH
624}
625
4468a00f
LJ
626static void set_work_pool_and_keep_pending(struct work_struct *work,
627 int pool_id)
628{
629 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
630 WORK_STRUCT_PENDING);
631}
632
7c3eed5c
TH
633static void set_work_pool_and_clear_pending(struct work_struct *work,
634 int pool_id)
7a22ad75 635{
23657bb1
TH
636 /*
637 * The following wmb is paired with the implied mb in
638 * test_and_set_bit(PENDING) and ensures all updates to @work made
639 * here are visible to and precede any updates by the next PENDING
640 * owner.
641 */
642 smp_wmb();
7c3eed5c 643 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
346c09f8
RP
644 /*
645 * The following mb guarantees that previous clear of a PENDING bit
646 * will not be reordered with any speculative LOADS or STORES from
647 * work->current_func, which is executed afterwards. This possible
8bdc6201 648 * reordering can lead to a missed execution on attempt to queue
346c09f8
RP
649 * the same @work. E.g. consider this case:
650 *
651 * CPU#0 CPU#1
652 * ---------------------------- --------------------------------
653 *
654 * 1 STORE event_indicated
655 * 2 queue_work_on() {
656 * 3 test_and_set_bit(PENDING)
657 * 4 } set_..._and_clear_pending() {
658 * 5 set_work_data() # clear bit
659 * 6 smp_mb()
660 * 7 work->current_func() {
661 * 8 LOAD event_indicated
662 * }
663 *
664 * Without an explicit full barrier speculative LOAD on line 8 can
665 * be executed before CPU#0 does STORE on line 1. If that happens,
666 * CPU#0 observes the PENDING bit is still set and new execution of
667 * a @work is not queued in a hope, that CPU#1 will eventually
668 * finish the queued @work. Meanwhile CPU#1 does not see
669 * event_indicated is set, because speculative LOAD was executed
670 * before actual STORE.
671 */
672 smp_mb();
7a22ad75 673}
f756d5e2 674
7a22ad75 675static void clear_work_data(struct work_struct *work)
1da177e4 676{
7c3eed5c
TH
677 smp_wmb(); /* see set_work_pool_and_clear_pending() */
678 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
1da177e4
LT
679}
680
112202d9 681static struct pool_workqueue *get_work_pwq(struct work_struct *work)
b1f4ec17 682{
e120153d 683 unsigned long data = atomic_long_read(&work->data);
7a22ad75 684
112202d9 685 if (data & WORK_STRUCT_PWQ)
e120153d
TH
686 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
687 else
688 return NULL;
4d707b9f
ON
689}
690
7c3eed5c
TH
691/**
692 * get_work_pool - return the worker_pool a given work was associated with
693 * @work: the work item of interest
694 *
68e13a67 695 * Pools are created and destroyed under wq_pool_mutex, and allows read
24acfb71
TG
696 * access under RCU read lock. As such, this function should be
697 * called under wq_pool_mutex or inside of a rcu_read_lock() region.
fa1b54e6
TH
698 *
699 * All fields of the returned pool are accessible as long as the above
700 * mentioned locking is in effect. If the returned pool needs to be used
701 * beyond the critical section, the caller is responsible for ensuring the
702 * returned pool is and stays online.
d185af30
YB
703 *
704 * Return: The worker_pool @work was last associated with. %NULL if none.
7c3eed5c
TH
705 */
706static struct worker_pool *get_work_pool(struct work_struct *work)
365970a1 707{
e120153d 708 unsigned long data = atomic_long_read(&work->data);
7c3eed5c 709 int pool_id;
7a22ad75 710
68e13a67 711 assert_rcu_or_pool_mutex();
fa1b54e6 712
112202d9
TH
713 if (data & WORK_STRUCT_PWQ)
714 return ((struct pool_workqueue *)
7c3eed5c 715 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
7a22ad75 716
7c3eed5c
TH
717 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
718 if (pool_id == WORK_OFFQ_POOL_NONE)
7a22ad75
TH
719 return NULL;
720
fa1b54e6 721 return idr_find(&worker_pool_idr, pool_id);
7c3eed5c
TH
722}
723
724/**
725 * get_work_pool_id - return the worker pool ID a given work is associated with
726 * @work: the work item of interest
727 *
d185af30 728 * Return: The worker_pool ID @work was last associated with.
7c3eed5c
TH
729 * %WORK_OFFQ_POOL_NONE if none.
730 */
731static int get_work_pool_id(struct work_struct *work)
732{
54d5b7d0
LJ
733 unsigned long data = atomic_long_read(&work->data);
734
112202d9
TH
735 if (data & WORK_STRUCT_PWQ)
736 return ((struct pool_workqueue *)
54d5b7d0 737 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
7c3eed5c 738
54d5b7d0 739 return data >> WORK_OFFQ_POOL_SHIFT;
7c3eed5c
TH
740}
741
bbb68dfa
TH
742static void mark_work_canceling(struct work_struct *work)
743{
7c3eed5c 744 unsigned long pool_id = get_work_pool_id(work);
bbb68dfa 745
7c3eed5c
TH
746 pool_id <<= WORK_OFFQ_POOL_SHIFT;
747 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
bbb68dfa
TH
748}
749
750static bool work_is_canceling(struct work_struct *work)
751{
752 unsigned long data = atomic_long_read(&work->data);
753
112202d9 754 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
bbb68dfa
TH
755}
756
e22bee78 757/*
3270476a
TH
758 * Policy functions. These define the policies on how the global worker
759 * pools are managed. Unless noted otherwise, these functions assume that
d565ed63 760 * they're being called with pool->lock held.
e22bee78
TH
761 */
762
63d95a91 763static bool __need_more_worker(struct worker_pool *pool)
a848e3b6 764{
e19e397a 765 return !atomic_read(&pool->nr_running);
a848e3b6
ON
766}
767
4594bf15 768/*
e22bee78
TH
769 * Need to wake up a worker? Called from anything but currently
770 * running workers.
974271c4
TH
771 *
772 * Note that, because unbound workers never contribute to nr_running, this
706026c2 773 * function will always return %true for unbound pools as long as the
974271c4 774 * worklist isn't empty.
4594bf15 775 */
63d95a91 776static bool need_more_worker(struct worker_pool *pool)
365970a1 777{
63d95a91 778 return !list_empty(&pool->worklist) && __need_more_worker(pool);
e22bee78 779}
4594bf15 780
e22bee78 781/* Can I start working? Called from busy but !running workers. */
63d95a91 782static bool may_start_working(struct worker_pool *pool)
e22bee78 783{
63d95a91 784 return pool->nr_idle;
e22bee78
TH
785}
786
787/* Do I need to keep working? Called from currently running workers. */
63d95a91 788static bool keep_working(struct worker_pool *pool)
e22bee78 789{
e19e397a
TH
790 return !list_empty(&pool->worklist) &&
791 atomic_read(&pool->nr_running) <= 1;
e22bee78
TH
792}
793
794/* Do we need a new worker? Called from manager. */
63d95a91 795static bool need_to_create_worker(struct worker_pool *pool)
e22bee78 796{
63d95a91 797 return need_more_worker(pool) && !may_start_working(pool);
e22bee78 798}
365970a1 799
e22bee78 800/* Do we have too many workers and should some go away? */
63d95a91 801static bool too_many_workers(struct worker_pool *pool)
e22bee78 802{
692b4825 803 bool managing = pool->flags & POOL_MANAGER_ACTIVE;
63d95a91
TH
804 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
805 int nr_busy = pool->nr_workers - nr_idle;
e22bee78
TH
806
807 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
365970a1
DH
808}
809
4d707b9f 810/*
e22bee78
TH
811 * Wake up functions.
812 */
813
1037de36
LJ
814/* Return the first idle worker. Safe with preemption disabled */
815static struct worker *first_idle_worker(struct worker_pool *pool)
7e11629d 816{
63d95a91 817 if (unlikely(list_empty(&pool->idle_list)))
7e11629d
TH
818 return NULL;
819
63d95a91 820 return list_first_entry(&pool->idle_list, struct worker, entry);
7e11629d
TH
821}
822
823/**
824 * wake_up_worker - wake up an idle worker
63d95a91 825 * @pool: worker pool to wake worker from
7e11629d 826 *
63d95a91 827 * Wake up the first idle worker of @pool.
7e11629d
TH
828 *
829 * CONTEXT:
a9b8a985 830 * raw_spin_lock_irq(pool->lock).
7e11629d 831 */
63d95a91 832static void wake_up_worker(struct worker_pool *pool)
7e11629d 833{
1037de36 834 struct worker *worker = first_idle_worker(pool);
7e11629d
TH
835
836 if (likely(worker))
837 wake_up_process(worker->task);
838}
839
d302f017 840/**
6d25be57 841 * wq_worker_running - a worker is running again
e22bee78 842 * @task: task waking up
e22bee78 843 *
6d25be57 844 * This function is called when a worker returns from schedule()
e22bee78 845 */
6d25be57 846void wq_worker_running(struct task_struct *task)
e22bee78
TH
847{
848 struct worker *worker = kthread_data(task);
849
6d25be57
TG
850 if (!worker->sleeping)
851 return;
852 if (!(worker->flags & WORKER_NOT_RUNNING))
e19e397a 853 atomic_inc(&worker->pool->nr_running);
6d25be57 854 worker->sleeping = 0;
e22bee78
TH
855}
856
857/**
858 * wq_worker_sleeping - a worker is going to sleep
859 * @task: task going to sleep
e22bee78 860 *
6d25be57 861 * This function is called from schedule() when a busy worker is
62849a96
SAS
862 * going to sleep. Preemption needs to be disabled to protect ->sleeping
863 * assignment.
e22bee78 864 */
6d25be57 865void wq_worker_sleeping(struct task_struct *task)
e22bee78 866{
6d25be57 867 struct worker *next, *worker = kthread_data(task);
111c225a 868 struct worker_pool *pool;
e22bee78 869
111c225a
TH
870 /*
871 * Rescuers, which may not have all the fields set up like normal
872 * workers, also reach here, let's not access anything before
873 * checking NOT_RUNNING.
874 */
2d64672e 875 if (worker->flags & WORKER_NOT_RUNNING)
6d25be57 876 return;
e22bee78 877
111c225a 878 pool = worker->pool;
111c225a 879
62849a96
SAS
880 /* Return if preempted before wq_worker_running() was reached */
881 if (worker->sleeping)
6d25be57
TG
882 return;
883
884 worker->sleeping = 1;
a9b8a985 885 raw_spin_lock_irq(&pool->lock);
e22bee78
TH
886
887 /*
888 * The counterpart of the following dec_and_test, implied mb,
889 * worklist not empty test sequence is in insert_work().
890 * Please read comment there.
891 *
628c78e7
TH
892 * NOT_RUNNING is clear. This means that we're bound to and
893 * running on the local cpu w/ rq lock held and preemption
894 * disabled, which in turn means that none else could be
d565ed63 895 * manipulating idle_list, so dereferencing idle_list without pool
628c78e7 896 * lock is safe.
e22bee78 897 */
e19e397a 898 if (atomic_dec_and_test(&pool->nr_running) &&
6d25be57
TG
899 !list_empty(&pool->worklist)) {
900 next = first_idle_worker(pool);
901 if (next)
902 wake_up_process(next->task);
903 }
a9b8a985 904 raw_spin_unlock_irq(&pool->lock);
e22bee78
TH
905}
906
1b69ac6b
JW
907/**
908 * wq_worker_last_func - retrieve worker's last work function
8194fe94 909 * @task: Task to retrieve last work function of.
1b69ac6b
JW
910 *
911 * Determine the last function a worker executed. This is called from
912 * the scheduler to get a worker's last known identity.
913 *
914 * CONTEXT:
a9b8a985 915 * raw_spin_lock_irq(rq->lock)
1b69ac6b 916 *
4b047002
JW
917 * This function is called during schedule() when a kworker is going
918 * to sleep. It's used by psi to identify aggregation workers during
919 * dequeuing, to allow periodic aggregation to shut-off when that
920 * worker is the last task in the system or cgroup to go to sleep.
921 *
922 * As this function doesn't involve any workqueue-related locking, it
923 * only returns stable values when called from inside the scheduler's
924 * queuing and dequeuing paths, when @task, which must be a kworker,
925 * is guaranteed to not be processing any works.
926 *
1b69ac6b
JW
927 * Return:
928 * The last work function %current executed as a worker, NULL if it
929 * hasn't executed any work yet.
930 */
931work_func_t wq_worker_last_func(struct task_struct *task)
932{
933 struct worker *worker = kthread_data(task);
934
935 return worker->last_func;
936}
937
e22bee78
TH
938/**
939 * worker_set_flags - set worker flags and adjust nr_running accordingly
cb444766 940 * @worker: self
d302f017 941 * @flags: flags to set
d302f017 942 *
228f1d00 943 * Set @flags in @worker->flags and adjust nr_running accordingly.
d302f017 944 *
cb444766 945 * CONTEXT:
a9b8a985 946 * raw_spin_lock_irq(pool->lock)
d302f017 947 */
228f1d00 948static inline void worker_set_flags(struct worker *worker, unsigned int flags)
d302f017 949{
bd7bdd43 950 struct worker_pool *pool = worker->pool;
e22bee78 951
cb444766
TH
952 WARN_ON_ONCE(worker->task != current);
953
228f1d00 954 /* If transitioning into NOT_RUNNING, adjust nr_running. */
e22bee78
TH
955 if ((flags & WORKER_NOT_RUNNING) &&
956 !(worker->flags & WORKER_NOT_RUNNING)) {
228f1d00 957 atomic_dec(&pool->nr_running);
e22bee78
TH
958 }
959
d302f017
TH
960 worker->flags |= flags;
961}
962
963/**
e22bee78 964 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
cb444766 965 * @worker: self
d302f017
TH
966 * @flags: flags to clear
967 *
e22bee78 968 * Clear @flags in @worker->flags and adjust nr_running accordingly.
d302f017 969 *
cb444766 970 * CONTEXT:
a9b8a985 971 * raw_spin_lock_irq(pool->lock)
d302f017
TH
972 */
973static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
974{
63d95a91 975 struct worker_pool *pool = worker->pool;
e22bee78
TH
976 unsigned int oflags = worker->flags;
977
cb444766
TH
978 WARN_ON_ONCE(worker->task != current);
979
d302f017 980 worker->flags &= ~flags;
e22bee78 981
42c025f3
TH
982 /*
983 * If transitioning out of NOT_RUNNING, increment nr_running. Note
984 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
985 * of multiple flags, not a single flag.
986 */
e22bee78
TH
987 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
988 if (!(worker->flags & WORKER_NOT_RUNNING))
e19e397a 989 atomic_inc(&pool->nr_running);
d302f017
TH
990}
991
8cca0eea
TH
992/**
993 * find_worker_executing_work - find worker which is executing a work
c9e7cf27 994 * @pool: pool of interest
8cca0eea
TH
995 * @work: work to find worker for
996 *
c9e7cf27
TH
997 * Find a worker which is executing @work on @pool by searching
998 * @pool->busy_hash which is keyed by the address of @work. For a worker
a2c1c57b
TH
999 * to match, its current execution should match the address of @work and
1000 * its work function. This is to avoid unwanted dependency between
1001 * unrelated work executions through a work item being recycled while still
1002 * being executed.
1003 *
1004 * This is a bit tricky. A work item may be freed once its execution
1005 * starts and nothing prevents the freed area from being recycled for
1006 * another work item. If the same work item address ends up being reused
1007 * before the original execution finishes, workqueue will identify the
1008 * recycled work item as currently executing and make it wait until the
1009 * current execution finishes, introducing an unwanted dependency.
1010 *
c5aa87bb
TH
1011 * This function checks the work item address and work function to avoid
1012 * false positives. Note that this isn't complete as one may construct a
1013 * work function which can introduce dependency onto itself through a
1014 * recycled work item. Well, if somebody wants to shoot oneself in the
1015 * foot that badly, there's only so much we can do, and if such deadlock
1016 * actually occurs, it should be easy to locate the culprit work function.
8cca0eea
TH
1017 *
1018 * CONTEXT:
a9b8a985 1019 * raw_spin_lock_irq(pool->lock).
8cca0eea 1020 *
d185af30
YB
1021 * Return:
1022 * Pointer to worker which is executing @work if found, %NULL
8cca0eea 1023 * otherwise.
4d707b9f 1024 */
c9e7cf27 1025static struct worker *find_worker_executing_work(struct worker_pool *pool,
8cca0eea 1026 struct work_struct *work)
4d707b9f 1027{
42f8570f 1028 struct worker *worker;
42f8570f 1029
b67bfe0d 1030 hash_for_each_possible(pool->busy_hash, worker, hentry,
a2c1c57b
TH
1031 (unsigned long)work)
1032 if (worker->current_work == work &&
1033 worker->current_func == work->func)
42f8570f
SL
1034 return worker;
1035
1036 return NULL;
4d707b9f
ON
1037}
1038
bf4ede01
TH
1039/**
1040 * move_linked_works - move linked works to a list
1041 * @work: start of series of works to be scheduled
1042 * @head: target list to append @work to
402dd89d 1043 * @nextp: out parameter for nested worklist walking
bf4ede01
TH
1044 *
1045 * Schedule linked works starting from @work to @head. Work series to
1046 * be scheduled starts at @work and includes any consecutive work with
1047 * WORK_STRUCT_LINKED set in its predecessor.
1048 *
1049 * If @nextp is not NULL, it's updated to point to the next work of
1050 * the last scheduled work. This allows move_linked_works() to be
1051 * nested inside outer list_for_each_entry_safe().
1052 *
1053 * CONTEXT:
a9b8a985 1054 * raw_spin_lock_irq(pool->lock).
bf4ede01
TH
1055 */
1056static void move_linked_works(struct work_struct *work, struct list_head *head,
1057 struct work_struct **nextp)
1058{
1059 struct work_struct *n;
1060
1061 /*
1062 * Linked worklist will always end before the end of the list,
1063 * use NULL for list head.
1064 */
1065 list_for_each_entry_safe_from(work, n, NULL, entry) {
1066 list_move_tail(&work->entry, head);
1067 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1068 break;
1069 }
1070
1071 /*
1072 * If we're already inside safe list traversal and have moved
1073 * multiple works to the scheduled queue, the next position
1074 * needs to be updated.
1075 */
1076 if (nextp)
1077 *nextp = n;
1078}
1079
8864b4e5
TH
1080/**
1081 * get_pwq - get an extra reference on the specified pool_workqueue
1082 * @pwq: pool_workqueue to get
1083 *
1084 * Obtain an extra reference on @pwq. The caller should guarantee that
1085 * @pwq has positive refcnt and be holding the matching pool->lock.
1086 */
1087static void get_pwq(struct pool_workqueue *pwq)
1088{
1089 lockdep_assert_held(&pwq->pool->lock);
1090 WARN_ON_ONCE(pwq->refcnt <= 0);
1091 pwq->refcnt++;
1092}
1093
1094/**
1095 * put_pwq - put a pool_workqueue reference
1096 * @pwq: pool_workqueue to put
1097 *
1098 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1099 * destruction. The caller should be holding the matching pool->lock.
1100 */
1101static void put_pwq(struct pool_workqueue *pwq)
1102{
1103 lockdep_assert_held(&pwq->pool->lock);
1104 if (likely(--pwq->refcnt))
1105 return;
1106 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1107 return;
1108 /*
1109 * @pwq can't be released under pool->lock, bounce to
1110 * pwq_unbound_release_workfn(). This never recurses on the same
1111 * pool->lock as this path is taken only for unbound workqueues and
1112 * the release work item is scheduled on a per-cpu workqueue. To
1113 * avoid lockdep warning, unbound pool->locks are given lockdep
1114 * subclass of 1 in get_unbound_pool().
1115 */
1116 schedule_work(&pwq->unbound_release_work);
1117}
1118
dce90d47
TH
1119/**
1120 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1121 * @pwq: pool_workqueue to put (can be %NULL)
1122 *
1123 * put_pwq() with locking. This function also allows %NULL @pwq.
1124 */
1125static void put_pwq_unlocked(struct pool_workqueue *pwq)
1126{
1127 if (pwq) {
1128 /*
24acfb71 1129 * As both pwqs and pools are RCU protected, the
dce90d47
TH
1130 * following lock operations are safe.
1131 */
a9b8a985 1132 raw_spin_lock_irq(&pwq->pool->lock);
dce90d47 1133 put_pwq(pwq);
a9b8a985 1134 raw_spin_unlock_irq(&pwq->pool->lock);
dce90d47
TH
1135 }
1136}
1137
112202d9 1138static void pwq_activate_delayed_work(struct work_struct *work)
bf4ede01 1139{
112202d9 1140 struct pool_workqueue *pwq = get_work_pwq(work);
bf4ede01
TH
1141
1142 trace_workqueue_activate_work(work);
82607adc
TH
1143 if (list_empty(&pwq->pool->worklist))
1144 pwq->pool->watchdog_ts = jiffies;
112202d9 1145 move_linked_works(work, &pwq->pool->worklist, NULL);
bf4ede01 1146 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
112202d9 1147 pwq->nr_active++;
bf4ede01
TH
1148}
1149
112202d9 1150static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
3aa62497 1151{
112202d9 1152 struct work_struct *work = list_first_entry(&pwq->delayed_works,
3aa62497
LJ
1153 struct work_struct, entry);
1154
112202d9 1155 pwq_activate_delayed_work(work);
3aa62497
LJ
1156}
1157
bf4ede01 1158/**
112202d9
TH
1159 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1160 * @pwq: pwq of interest
bf4ede01 1161 * @color: color of work which left the queue
bf4ede01
TH
1162 *
1163 * A work either has completed or is removed from pending queue,
112202d9 1164 * decrement nr_in_flight of its pwq and handle workqueue flushing.
bf4ede01
TH
1165 *
1166 * CONTEXT:
a9b8a985 1167 * raw_spin_lock_irq(pool->lock).
bf4ede01 1168 */
112202d9 1169static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
bf4ede01 1170{
8864b4e5 1171 /* uncolored work items don't participate in flushing or nr_active */
bf4ede01 1172 if (color == WORK_NO_COLOR)
8864b4e5 1173 goto out_put;
bf4ede01 1174
112202d9 1175 pwq->nr_in_flight[color]--;
bf4ede01 1176
112202d9
TH
1177 pwq->nr_active--;
1178 if (!list_empty(&pwq->delayed_works)) {
b3f9f405 1179 /* one down, submit a delayed one */
112202d9
TH
1180 if (pwq->nr_active < pwq->max_active)
1181 pwq_activate_first_delayed(pwq);
bf4ede01
TH
1182 }
1183
1184 /* is flush in progress and are we at the flushing tip? */
112202d9 1185 if (likely(pwq->flush_color != color))
8864b4e5 1186 goto out_put;
bf4ede01
TH
1187
1188 /* are there still in-flight works? */
112202d9 1189 if (pwq->nr_in_flight[color])
8864b4e5 1190 goto out_put;
bf4ede01 1191
112202d9
TH
1192 /* this pwq is done, clear flush_color */
1193 pwq->flush_color = -1;
bf4ede01
TH
1194
1195 /*
112202d9 1196 * If this was the last pwq, wake up the first flusher. It
bf4ede01
TH
1197 * will handle the rest.
1198 */
112202d9
TH
1199 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1200 complete(&pwq->wq->first_flusher->done);
8864b4e5
TH
1201out_put:
1202 put_pwq(pwq);
bf4ede01
TH
1203}
1204
36e227d2 1205/**
bbb68dfa 1206 * try_to_grab_pending - steal work item from worklist and disable irq
36e227d2
TH
1207 * @work: work item to steal
1208 * @is_dwork: @work is a delayed_work
bbb68dfa 1209 * @flags: place to store irq state
36e227d2
TH
1210 *
1211 * Try to grab PENDING bit of @work. This function can handle @work in any
d185af30 1212 * stable state - idle, on timer or on worklist.
36e227d2 1213 *
d185af30 1214 * Return:
3eb6b31b
MCC
1215 *
1216 * ======== ================================================================
36e227d2
TH
1217 * 1 if @work was pending and we successfully stole PENDING
1218 * 0 if @work was idle and we claimed PENDING
1219 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
bbb68dfa
TH
1220 * -ENOENT if someone else is canceling @work, this state may persist
1221 * for arbitrarily long
3eb6b31b 1222 * ======== ================================================================
36e227d2 1223 *
d185af30 1224 * Note:
bbb68dfa 1225 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
e0aecdd8
TH
1226 * interrupted while holding PENDING and @work off queue, irq must be
1227 * disabled on entry. This, combined with delayed_work->timer being
1228 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
bbb68dfa
TH
1229 *
1230 * On successful return, >= 0, irq is disabled and the caller is
1231 * responsible for releasing it using local_irq_restore(*@flags).
1232 *
e0aecdd8 1233 * This function is safe to call from any context including IRQ handler.
bf4ede01 1234 */
bbb68dfa
TH
1235static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1236 unsigned long *flags)
bf4ede01 1237{
d565ed63 1238 struct worker_pool *pool;
112202d9 1239 struct pool_workqueue *pwq;
bf4ede01 1240
bbb68dfa
TH
1241 local_irq_save(*flags);
1242
36e227d2
TH
1243 /* try to steal the timer if it exists */
1244 if (is_dwork) {
1245 struct delayed_work *dwork = to_delayed_work(work);
1246
e0aecdd8
TH
1247 /*
1248 * dwork->timer is irqsafe. If del_timer() fails, it's
1249 * guaranteed that the timer is not queued anywhere and not
1250 * running on the local CPU.
1251 */
36e227d2
TH
1252 if (likely(del_timer(&dwork->timer)))
1253 return 1;
1254 }
1255
1256 /* try to claim PENDING the normal way */
bf4ede01
TH
1257 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1258 return 0;
1259
24acfb71 1260 rcu_read_lock();
bf4ede01
TH
1261 /*
1262 * The queueing is in progress, or it is already queued. Try to
1263 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1264 */
d565ed63
TH
1265 pool = get_work_pool(work);
1266 if (!pool)
bbb68dfa 1267 goto fail;
bf4ede01 1268
a9b8a985 1269 raw_spin_lock(&pool->lock);
0b3dae68 1270 /*
112202d9
TH
1271 * work->data is guaranteed to point to pwq only while the work
1272 * item is queued on pwq->wq, and both updating work->data to point
1273 * to pwq on queueing and to pool on dequeueing are done under
1274 * pwq->pool->lock. This in turn guarantees that, if work->data
1275 * points to pwq which is associated with a locked pool, the work
0b3dae68
LJ
1276 * item is currently queued on that pool.
1277 */
112202d9
TH
1278 pwq = get_work_pwq(work);
1279 if (pwq && pwq->pool == pool) {
16062836
TH
1280 debug_work_deactivate(work);
1281
1282 /*
1283 * A delayed work item cannot be grabbed directly because
1284 * it might have linked NO_COLOR work items which, if left
112202d9 1285 * on the delayed_list, will confuse pwq->nr_active
16062836
TH
1286 * management later on and cause stall. Make sure the work
1287 * item is activated before grabbing.
1288 */
1289 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
112202d9 1290 pwq_activate_delayed_work(work);
16062836
TH
1291
1292 list_del_init(&work->entry);
9c34a704 1293 pwq_dec_nr_in_flight(pwq, get_work_color(work));
16062836 1294
112202d9 1295 /* work->data points to pwq iff queued, point to pool */
16062836
TH
1296 set_work_pool_and_keep_pending(work, pool->id);
1297
a9b8a985 1298 raw_spin_unlock(&pool->lock);
24acfb71 1299 rcu_read_unlock();
16062836 1300 return 1;
bf4ede01 1301 }
a9b8a985 1302 raw_spin_unlock(&pool->lock);
bbb68dfa 1303fail:
24acfb71 1304 rcu_read_unlock();
bbb68dfa
TH
1305 local_irq_restore(*flags);
1306 if (work_is_canceling(work))
1307 return -ENOENT;
1308 cpu_relax();
36e227d2 1309 return -EAGAIN;
bf4ede01
TH
1310}
1311
4690c4ab 1312/**
706026c2 1313 * insert_work - insert a work into a pool
112202d9 1314 * @pwq: pwq @work belongs to
4690c4ab
TH
1315 * @work: work to insert
1316 * @head: insertion point
1317 * @extra_flags: extra WORK_STRUCT_* flags to set
1318 *
112202d9 1319 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
706026c2 1320 * work_struct flags.
4690c4ab
TH
1321 *
1322 * CONTEXT:
a9b8a985 1323 * raw_spin_lock_irq(pool->lock).
4690c4ab 1324 */
112202d9
TH
1325static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1326 struct list_head *head, unsigned int extra_flags)
b89deed3 1327{
112202d9 1328 struct worker_pool *pool = pwq->pool;
e22bee78 1329
e89a85d6
WW
1330 /* record the work call stack in order to print it in KASAN reports */
1331 kasan_record_aux_stack(work);
1332
4690c4ab 1333 /* we own @work, set data and link */
112202d9 1334 set_work_pwq(work, pwq, extra_flags);
1a4d9b0a 1335 list_add_tail(&work->entry, head);
8864b4e5 1336 get_pwq(pwq);
e22bee78
TH
1337
1338 /*
c5aa87bb
TH
1339 * Ensure either wq_worker_sleeping() sees the above
1340 * list_add_tail() or we see zero nr_running to avoid workers lying
1341 * around lazily while there are works to be processed.
e22bee78
TH
1342 */
1343 smp_mb();
1344
63d95a91
TH
1345 if (__need_more_worker(pool))
1346 wake_up_worker(pool);
b89deed3
ON
1347}
1348
c8efcc25
TH
1349/*
1350 * Test whether @work is being queued from another work executing on the
8d03ecfe 1351 * same workqueue.
c8efcc25
TH
1352 */
1353static bool is_chained_work(struct workqueue_struct *wq)
1354{
8d03ecfe
TH
1355 struct worker *worker;
1356
1357 worker = current_wq_worker();
1358 /*
bf393fd4 1359 * Return %true iff I'm a worker executing a work item on @wq. If
8d03ecfe
TH
1360 * I'm @worker, it's safe to dereference it without locking.
1361 */
112202d9 1362 return worker && worker->current_pwq->wq == wq;
c8efcc25
TH
1363}
1364
ef557180
MG
1365/*
1366 * When queueing an unbound work item to a wq, prefer local CPU if allowed
1367 * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to
1368 * avoid perturbing sensitive tasks.
1369 */
1370static int wq_select_unbound_cpu(int cpu)
1371{
f303fccb 1372 static bool printed_dbg_warning;
ef557180
MG
1373 int new_cpu;
1374
f303fccb
TH
1375 if (likely(!wq_debug_force_rr_cpu)) {
1376 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1377 return cpu;
1378 } else if (!printed_dbg_warning) {
1379 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1380 printed_dbg_warning = true;
1381 }
1382
ef557180
MG
1383 if (cpumask_empty(wq_unbound_cpumask))
1384 return cpu;
1385
1386 new_cpu = __this_cpu_read(wq_rr_cpu_last);
1387 new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1388 if (unlikely(new_cpu >= nr_cpu_ids)) {
1389 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1390 if (unlikely(new_cpu >= nr_cpu_ids))
1391 return cpu;
1392 }
1393 __this_cpu_write(wq_rr_cpu_last, new_cpu);
1394
1395 return new_cpu;
1396}
1397
d84ff051 1398static void __queue_work(int cpu, struct workqueue_struct *wq,
1da177e4
LT
1399 struct work_struct *work)
1400{
112202d9 1401 struct pool_workqueue *pwq;
c9178087 1402 struct worker_pool *last_pool;
1e19ffc6 1403 struct list_head *worklist;
8a2e8e5d 1404 unsigned int work_flags;
b75cac93 1405 unsigned int req_cpu = cpu;
8930caba
TH
1406
1407 /*
1408 * While a work item is PENDING && off queue, a task trying to
1409 * steal the PENDING will busy-loop waiting for it to either get
1410 * queued or lose PENDING. Grabbing PENDING and queueing should
1411 * happen with IRQ disabled.
1412 */
8e8eb730 1413 lockdep_assert_irqs_disabled();
1da177e4 1414
dc186ad7 1415 debug_work_activate(work);
1e19ffc6 1416
9ef28a73 1417 /* if draining, only works from the same workqueue are allowed */
618b01eb 1418 if (unlikely(wq->flags & __WQ_DRAINING) &&
c8efcc25 1419 WARN_ON_ONCE(!is_chained_work(wq)))
e41e704b 1420 return;
24acfb71 1421 rcu_read_lock();
9e8cd2f5 1422retry:
c9178087 1423 /* pwq which will be used unless @work is executing elsewhere */
aa202f1f
HD
1424 if (wq->flags & WQ_UNBOUND) {
1425 if (req_cpu == WORK_CPU_UNBOUND)
1426 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
df2d5ae4 1427 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
aa202f1f
HD
1428 } else {
1429 if (req_cpu == WORK_CPU_UNBOUND)
1430 cpu = raw_smp_processor_id();
1431 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1432 }
dbf2576e 1433
c9178087
TH
1434 /*
1435 * If @work was previously on a different pool, it might still be
1436 * running there, in which case the work needs to be queued on that
1437 * pool to guarantee non-reentrancy.
1438 */
1439 last_pool = get_work_pool(work);
1440 if (last_pool && last_pool != pwq->pool) {
1441 struct worker *worker;
18aa9eff 1442
a9b8a985 1443 raw_spin_lock(&last_pool->lock);
18aa9eff 1444
c9178087 1445 worker = find_worker_executing_work(last_pool, work);
18aa9eff 1446
c9178087
TH
1447 if (worker && worker->current_pwq->wq == wq) {
1448 pwq = worker->current_pwq;
8930caba 1449 } else {
c9178087 1450 /* meh... not running there, queue here */
a9b8a985
SAS
1451 raw_spin_unlock(&last_pool->lock);
1452 raw_spin_lock(&pwq->pool->lock);
8930caba 1453 }
f3421797 1454 } else {
a9b8a985 1455 raw_spin_lock(&pwq->pool->lock);
502ca9d8
TH
1456 }
1457
9e8cd2f5
TH
1458 /*
1459 * pwq is determined and locked. For unbound pools, we could have
1460 * raced with pwq release and it could already be dead. If its
1461 * refcnt is zero, repeat pwq selection. Note that pwqs never die
df2d5ae4
TH
1462 * without another pwq replacing it in the numa_pwq_tbl or while
1463 * work items are executing on it, so the retrying is guaranteed to
9e8cd2f5
TH
1464 * make forward-progress.
1465 */
1466 if (unlikely(!pwq->refcnt)) {
1467 if (wq->flags & WQ_UNBOUND) {
a9b8a985 1468 raw_spin_unlock(&pwq->pool->lock);
9e8cd2f5
TH
1469 cpu_relax();
1470 goto retry;
1471 }
1472 /* oops */
1473 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1474 wq->name, cpu);
1475 }
1476
112202d9
TH
1477 /* pwq determined, queue */
1478 trace_workqueue_queue_work(req_cpu, pwq, work);
502ca9d8 1479
24acfb71
TG
1480 if (WARN_ON(!list_empty(&work->entry)))
1481 goto out;
1e19ffc6 1482
112202d9
TH
1483 pwq->nr_in_flight[pwq->work_color]++;
1484 work_flags = work_color_to_flags(pwq->work_color);
1e19ffc6 1485
112202d9 1486 if (likely(pwq->nr_active < pwq->max_active)) {
cdadf009 1487 trace_workqueue_activate_work(work);
112202d9
TH
1488 pwq->nr_active++;
1489 worklist = &pwq->pool->worklist;
82607adc
TH
1490 if (list_empty(worklist))
1491 pwq->pool->watchdog_ts = jiffies;
8a2e8e5d
TH
1492 } else {
1493 work_flags |= WORK_STRUCT_DELAYED;
112202d9 1494 worklist = &pwq->delayed_works;
8a2e8e5d 1495 }
1e19ffc6 1496
112202d9 1497 insert_work(pwq, work, worklist, work_flags);
1e19ffc6 1498
24acfb71 1499out:
a9b8a985 1500 raw_spin_unlock(&pwq->pool->lock);
24acfb71 1501 rcu_read_unlock();
1da177e4
LT
1502}
1503
0fcb78c2 1504/**
c1a220e7
ZR
1505 * queue_work_on - queue work on specific cpu
1506 * @cpu: CPU number to execute work on
0fcb78c2
REB
1507 * @wq: workqueue to use
1508 * @work: work to queue
1509 *
c1a220e7
ZR
1510 * We queue the work to a specific CPU, the caller must ensure it
1511 * can't go away.
d185af30
YB
1512 *
1513 * Return: %false if @work was already on a queue, %true otherwise.
1da177e4 1514 */
d4283e93
TH
1515bool queue_work_on(int cpu, struct workqueue_struct *wq,
1516 struct work_struct *work)
1da177e4 1517{
d4283e93 1518 bool ret = false;
8930caba 1519 unsigned long flags;
ef1ca236 1520
8930caba 1521 local_irq_save(flags);
c1a220e7 1522
22df02bb 1523 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
4690c4ab 1524 __queue_work(cpu, wq, work);
d4283e93 1525 ret = true;
c1a220e7 1526 }
ef1ca236 1527
8930caba 1528 local_irq_restore(flags);
1da177e4
LT
1529 return ret;
1530}
ad7b1f84 1531EXPORT_SYMBOL(queue_work_on);
1da177e4 1532
8204e0c1
AD
1533/**
1534 * workqueue_select_cpu_near - Select a CPU based on NUMA node
1535 * @node: NUMA node ID that we want to select a CPU from
1536 *
1537 * This function will attempt to find a "random" cpu available on a given
1538 * node. If there are no CPUs available on the given node it will return
1539 * WORK_CPU_UNBOUND indicating that we should just schedule to any
1540 * available CPU if we need to schedule this work.
1541 */
1542static int workqueue_select_cpu_near(int node)
1543{
1544 int cpu;
1545
1546 /* No point in doing this if NUMA isn't enabled for workqueues */
1547 if (!wq_numa_enabled)
1548 return WORK_CPU_UNBOUND;
1549
1550 /* Delay binding to CPU if node is not valid or online */
1551 if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1552 return WORK_CPU_UNBOUND;
1553
1554 /* Use local node/cpu if we are already there */
1555 cpu = raw_smp_processor_id();
1556 if (node == cpu_to_node(cpu))
1557 return cpu;
1558
1559 /* Use "random" otherwise know as "first" online CPU of node */
1560 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1561
1562 /* If CPU is valid return that, otherwise just defer */
1563 return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1564}
1565
1566/**
1567 * queue_work_node - queue work on a "random" cpu for a given NUMA node
1568 * @node: NUMA node that we are targeting the work for
1569 * @wq: workqueue to use
1570 * @work: work to queue
1571 *
1572 * We queue the work to a "random" CPU within a given NUMA node. The basic
1573 * idea here is to provide a way to somehow associate work with a given
1574 * NUMA node.
1575 *
1576 * This function will only make a best effort attempt at getting this onto
1577 * the right NUMA node. If no node is requested or the requested node is
1578 * offline then we just fall back to standard queue_work behavior.
1579 *
1580 * Currently the "random" CPU ends up being the first available CPU in the
1581 * intersection of cpu_online_mask and the cpumask of the node, unless we
1582 * are running on the node. In that case we just use the current CPU.
1583 *
1584 * Return: %false if @work was already on a queue, %true otherwise.
1585 */
1586bool queue_work_node(int node, struct workqueue_struct *wq,
1587 struct work_struct *work)
1588{
1589 unsigned long flags;
1590 bool ret = false;
1591
1592 /*
1593 * This current implementation is specific to unbound workqueues.
1594 * Specifically we only return the first available CPU for a given
1595 * node instead of cycling through individual CPUs within the node.
1596 *
1597 * If this is used with a per-cpu workqueue then the logic in
1598 * workqueue_select_cpu_near would need to be updated to allow for
1599 * some round robin type logic.
1600 */
1601 WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1602
1603 local_irq_save(flags);
1604
1605 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1606 int cpu = workqueue_select_cpu_near(node);
1607
1608 __queue_work(cpu, wq, work);
1609 ret = true;
1610 }
1611
1612 local_irq_restore(flags);
1613 return ret;
1614}
1615EXPORT_SYMBOL_GPL(queue_work_node);
1616
8c20feb6 1617void delayed_work_timer_fn(struct timer_list *t)
1da177e4 1618{
8c20feb6 1619 struct delayed_work *dwork = from_timer(dwork, t, timer);
1da177e4 1620
e0aecdd8 1621 /* should have been called from irqsafe timer with irq already off */
60c057bc 1622 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
1da177e4 1623}
1438ade5 1624EXPORT_SYMBOL(delayed_work_timer_fn);
1da177e4 1625
7beb2edf
TH
1626static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1627 struct delayed_work *dwork, unsigned long delay)
1da177e4 1628{
7beb2edf
TH
1629 struct timer_list *timer = &dwork->timer;
1630 struct work_struct *work = &dwork->work;
7beb2edf 1631
637fdbae 1632 WARN_ON_ONCE(!wq);
841b86f3 1633 WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
fc4b514f
TH
1634 WARN_ON_ONCE(timer_pending(timer));
1635 WARN_ON_ONCE(!list_empty(&work->entry));
7beb2edf 1636
8852aac2
TH
1637 /*
1638 * If @delay is 0, queue @dwork->work immediately. This is for
1639 * both optimization and correctness. The earliest @timer can
1640 * expire is on the closest next tick and delayed_work users depend
1641 * on that there's no such delay when @delay is 0.
1642 */
1643 if (!delay) {
1644 __queue_work(cpu, wq, &dwork->work);
1645 return;
1646 }
1647
60c057bc 1648 dwork->wq = wq;
1265057f 1649 dwork->cpu = cpu;
7beb2edf
TH
1650 timer->expires = jiffies + delay;
1651
041bd12e
TH
1652 if (unlikely(cpu != WORK_CPU_UNBOUND))
1653 add_timer_on(timer, cpu);
1654 else
1655 add_timer(timer);
1da177e4
LT
1656}
1657
0fcb78c2
REB
1658/**
1659 * queue_delayed_work_on - queue work on specific CPU after delay
1660 * @cpu: CPU number to execute work on
1661 * @wq: workqueue to use
af9997e4 1662 * @dwork: work to queue
0fcb78c2
REB
1663 * @delay: number of jiffies to wait before queueing
1664 *
d185af30 1665 * Return: %false if @work was already on a queue, %true otherwise. If
715f1300
TH
1666 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1667 * execution.
0fcb78c2 1668 */
d4283e93
TH
1669bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1670 struct delayed_work *dwork, unsigned long delay)
7a6bc1cd 1671{
52bad64d 1672 struct work_struct *work = &dwork->work;
d4283e93 1673 bool ret = false;
8930caba 1674 unsigned long flags;
7a6bc1cd 1675
8930caba
TH
1676 /* read the comment in __queue_work() */
1677 local_irq_save(flags);
7a6bc1cd 1678
22df02bb 1679 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
7beb2edf 1680 __queue_delayed_work(cpu, wq, dwork, delay);
d4283e93 1681 ret = true;
7a6bc1cd 1682 }
8a3e77cc 1683
8930caba 1684 local_irq_restore(flags);
7a6bc1cd
VP
1685 return ret;
1686}
ad7b1f84 1687EXPORT_SYMBOL(queue_delayed_work_on);
c7fc77f7 1688
8376fe22
TH
1689/**
1690 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1691 * @cpu: CPU number to execute work on
1692 * @wq: workqueue to use
1693 * @dwork: work to queue
1694 * @delay: number of jiffies to wait before queueing
1695 *
1696 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1697 * modify @dwork's timer so that it expires after @delay. If @delay is
1698 * zero, @work is guaranteed to be scheduled immediately regardless of its
1699 * current state.
1700 *
d185af30 1701 * Return: %false if @dwork was idle and queued, %true if @dwork was
8376fe22
TH
1702 * pending and its timer was modified.
1703 *
e0aecdd8 1704 * This function is safe to call from any context including IRQ handler.
8376fe22
TH
1705 * See try_to_grab_pending() for details.
1706 */
1707bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1708 struct delayed_work *dwork, unsigned long delay)
1709{
1710 unsigned long flags;
1711 int ret;
c7fc77f7 1712
8376fe22
TH
1713 do {
1714 ret = try_to_grab_pending(&dwork->work, true, &flags);
1715 } while (unlikely(ret == -EAGAIN));
63bc0362 1716
8376fe22
TH
1717 if (likely(ret >= 0)) {
1718 __queue_delayed_work(cpu, wq, dwork, delay);
1719 local_irq_restore(flags);
7a6bc1cd 1720 }
8376fe22
TH
1721
1722 /* -ENOENT from try_to_grab_pending() becomes %true */
7a6bc1cd
VP
1723 return ret;
1724}
8376fe22
TH
1725EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1726
05f0fe6b
TH
1727static void rcu_work_rcufn(struct rcu_head *rcu)
1728{
1729 struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1730
1731 /* read the comment in __queue_work() */
1732 local_irq_disable();
1733 __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1734 local_irq_enable();
1735}
1736
1737/**
1738 * queue_rcu_work - queue work after a RCU grace period
1739 * @wq: workqueue to use
1740 * @rwork: work to queue
1741 *
1742 * Return: %false if @rwork was already pending, %true otherwise. Note
1743 * that a full RCU grace period is guaranteed only after a %true return.
bf393fd4 1744 * While @rwork is guaranteed to be executed after a %false return, the
05f0fe6b
TH
1745 * execution may happen before a full RCU grace period has passed.
1746 */
1747bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1748{
1749 struct work_struct *work = &rwork->work;
1750
1751 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1752 rwork->wq = wq;
1753 call_rcu(&rwork->rcu, rcu_work_rcufn);
1754 return true;
1755 }
1756
1757 return false;
1758}
1759EXPORT_SYMBOL(queue_rcu_work);
1760
c8e55f36
TH
1761/**
1762 * worker_enter_idle - enter idle state
1763 * @worker: worker which is entering idle state
1764 *
1765 * @worker is entering idle state. Update stats and idle timer if
1766 * necessary.
1767 *
1768 * LOCKING:
a9b8a985 1769 * raw_spin_lock_irq(pool->lock).
c8e55f36
TH
1770 */
1771static void worker_enter_idle(struct worker *worker)
1da177e4 1772{
bd7bdd43 1773 struct worker_pool *pool = worker->pool;
c8e55f36 1774
6183c009
TH
1775 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1776 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1777 (worker->hentry.next || worker->hentry.pprev)))
1778 return;
c8e55f36 1779
051e1850 1780 /* can't use worker_set_flags(), also called from create_worker() */
cb444766 1781 worker->flags |= WORKER_IDLE;
bd7bdd43 1782 pool->nr_idle++;
e22bee78 1783 worker->last_active = jiffies;
c8e55f36
TH
1784
1785 /* idle_list is LIFO */
bd7bdd43 1786 list_add(&worker->entry, &pool->idle_list);
db7bccf4 1787
628c78e7
TH
1788 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1789 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
cb444766 1790
544ecf31 1791 /*
e8b3f8db 1792 * Sanity check nr_running. Because unbind_workers() releases
d565ed63 1793 * pool->lock between setting %WORKER_UNBOUND and zapping
628c78e7
TH
1794 * nr_running, the warning may trigger spuriously. Check iff
1795 * unbind is not in progress.
544ecf31 1796 */
24647570 1797 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
bd7bdd43 1798 pool->nr_workers == pool->nr_idle &&
e19e397a 1799 atomic_read(&pool->nr_running));
c8e55f36
TH
1800}
1801
1802/**
1803 * worker_leave_idle - leave idle state
1804 * @worker: worker which is leaving idle state
1805 *
1806 * @worker is leaving idle state. Update stats.
1807 *
1808 * LOCKING:
a9b8a985 1809 * raw_spin_lock_irq(pool->lock).
c8e55f36
TH
1810 */
1811static void worker_leave_idle(struct worker *worker)
1812{
bd7bdd43 1813 struct worker_pool *pool = worker->pool;
c8e55f36 1814
6183c009
TH
1815 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1816 return;
d302f017 1817 worker_clr_flags(worker, WORKER_IDLE);
bd7bdd43 1818 pool->nr_idle--;
c8e55f36
TH
1819 list_del_init(&worker->entry);
1820}
1821
f7537df5 1822static struct worker *alloc_worker(int node)
c34056a3
TH
1823{
1824 struct worker *worker;
1825
f7537df5 1826 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
c8e55f36
TH
1827 if (worker) {
1828 INIT_LIST_HEAD(&worker->entry);
affee4b2 1829 INIT_LIST_HEAD(&worker->scheduled);
da028469 1830 INIT_LIST_HEAD(&worker->node);
e22bee78
TH
1831 /* on creation a worker is in !idle && prep state */
1832 worker->flags = WORKER_PREP;
c8e55f36 1833 }
c34056a3
TH
1834 return worker;
1835}
1836
4736cbf7
LJ
1837/**
1838 * worker_attach_to_pool() - attach a worker to a pool
1839 * @worker: worker to be attached
1840 * @pool: the target pool
1841 *
1842 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1843 * cpu-binding of @worker are kept coordinated with the pool across
1844 * cpu-[un]hotplugs.
1845 */
1846static void worker_attach_to_pool(struct worker *worker,
1847 struct worker_pool *pool)
1848{
1258fae7 1849 mutex_lock(&wq_pool_attach_mutex);
4736cbf7
LJ
1850
1851 /*
1852 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1853 * online CPUs. It'll be re-applied when any of the CPUs come up.
1854 */
1855 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1856
1857 /*
1258fae7
TH
1858 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1859 * stable across this function. See the comments above the flag
1860 * definition for details.
4736cbf7
LJ
1861 */
1862 if (pool->flags & POOL_DISASSOCIATED)
1863 worker->flags |= WORKER_UNBOUND;
5c25b5ff
PZ
1864 else
1865 kthread_set_per_cpu(worker->task, pool->cpu);
4736cbf7
LJ
1866
1867 list_add_tail(&worker->node, &pool->workers);
a2d812a2 1868 worker->pool = pool;
4736cbf7 1869
1258fae7 1870 mutex_unlock(&wq_pool_attach_mutex);
4736cbf7
LJ
1871}
1872
60f5a4bc
LJ
1873/**
1874 * worker_detach_from_pool() - detach a worker from its pool
1875 * @worker: worker which is attached to its pool
60f5a4bc 1876 *
4736cbf7
LJ
1877 * Undo the attaching which had been done in worker_attach_to_pool(). The
1878 * caller worker shouldn't access to the pool after detached except it has
1879 * other reference to the pool.
60f5a4bc 1880 */
a2d812a2 1881static void worker_detach_from_pool(struct worker *worker)
60f5a4bc 1882{
a2d812a2 1883 struct worker_pool *pool = worker->pool;
60f5a4bc
LJ
1884 struct completion *detach_completion = NULL;
1885
1258fae7 1886 mutex_lock(&wq_pool_attach_mutex);
a2d812a2 1887
5c25b5ff 1888 kthread_set_per_cpu(worker->task, -1);
da028469 1889 list_del(&worker->node);
a2d812a2
TH
1890 worker->pool = NULL;
1891
da028469 1892 if (list_empty(&pool->workers))
60f5a4bc 1893 detach_completion = pool->detach_completion;
1258fae7 1894 mutex_unlock(&wq_pool_attach_mutex);
60f5a4bc 1895
b62c0751
LJ
1896 /* clear leftover flags without pool->lock after it is detached */
1897 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1898
60f5a4bc
LJ
1899 if (detach_completion)
1900 complete(detach_completion);
1901}
1902
c34056a3
TH
1903/**
1904 * create_worker - create a new workqueue worker
63d95a91 1905 * @pool: pool the new worker will belong to
c34056a3 1906 *
051e1850 1907 * Create and start a new worker which is attached to @pool.
c34056a3
TH
1908 *
1909 * CONTEXT:
1910 * Might sleep. Does GFP_KERNEL allocations.
1911 *
d185af30 1912 * Return:
c34056a3
TH
1913 * Pointer to the newly created worker.
1914 */
bc2ae0f5 1915static struct worker *create_worker(struct worker_pool *pool)
c34056a3 1916{
c34056a3 1917 struct worker *worker = NULL;
f3421797 1918 int id = -1;
e3c916a4 1919 char id_buf[16];
c34056a3 1920
7cda9aae
LJ
1921 /* ID is needed to determine kthread name */
1922 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
822d8405
TH
1923 if (id < 0)
1924 goto fail;
c34056a3 1925
f7537df5 1926 worker = alloc_worker(pool->node);
c34056a3
TH
1927 if (!worker)
1928 goto fail;
1929
c34056a3
TH
1930 worker->id = id;
1931
29c91e99 1932 if (pool->cpu >= 0)
e3c916a4
TH
1933 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1934 pool->attrs->nice < 0 ? "H" : "");
f3421797 1935 else
e3c916a4
TH
1936 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1937
f3f90ad4 1938 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
e3c916a4 1939 "kworker/%s", id_buf);
c34056a3
TH
1940 if (IS_ERR(worker->task))
1941 goto fail;
1942
91151228 1943 set_user_nice(worker->task, pool->attrs->nice);
25834c73 1944 kthread_bind_mask(worker->task, pool->attrs->cpumask);
91151228 1945
da028469 1946 /* successful, attach the worker to the pool */
4736cbf7 1947 worker_attach_to_pool(worker, pool);
822d8405 1948
051e1850 1949 /* start the newly created worker */
a9b8a985 1950 raw_spin_lock_irq(&pool->lock);
051e1850
LJ
1951 worker->pool->nr_workers++;
1952 worker_enter_idle(worker);
1953 wake_up_process(worker->task);
a9b8a985 1954 raw_spin_unlock_irq(&pool->lock);
051e1850 1955
c34056a3 1956 return worker;
822d8405 1957
c34056a3 1958fail:
9625ab17 1959 if (id >= 0)
7cda9aae 1960 ida_simple_remove(&pool->worker_ida, id);
c34056a3
TH
1961 kfree(worker);
1962 return NULL;
1963}
1964
c34056a3
TH
1965/**
1966 * destroy_worker - destroy a workqueue worker
1967 * @worker: worker to be destroyed
1968 *
73eb7fe7
LJ
1969 * Destroy @worker and adjust @pool stats accordingly. The worker should
1970 * be idle.
c8e55f36
TH
1971 *
1972 * CONTEXT:
a9b8a985 1973 * raw_spin_lock_irq(pool->lock).
c34056a3
TH
1974 */
1975static void destroy_worker(struct worker *worker)
1976{
bd7bdd43 1977 struct worker_pool *pool = worker->pool;
c34056a3 1978
cd549687
TH
1979 lockdep_assert_held(&pool->lock);
1980
c34056a3 1981 /* sanity check frenzy */
6183c009 1982 if (WARN_ON(worker->current_work) ||
73eb7fe7
LJ
1983 WARN_ON(!list_empty(&worker->scheduled)) ||
1984 WARN_ON(!(worker->flags & WORKER_IDLE)))
6183c009 1985 return;
c34056a3 1986
73eb7fe7
LJ
1987 pool->nr_workers--;
1988 pool->nr_idle--;
5bdfff96 1989
c8e55f36 1990 list_del_init(&worker->entry);
cb444766 1991 worker->flags |= WORKER_DIE;
60f5a4bc 1992 wake_up_process(worker->task);
c34056a3
TH
1993}
1994
32a6c723 1995static void idle_worker_timeout(struct timer_list *t)
e22bee78 1996{
32a6c723 1997 struct worker_pool *pool = from_timer(pool, t, idle_timer);
e22bee78 1998
a9b8a985 1999 raw_spin_lock_irq(&pool->lock);
e22bee78 2000
3347fc9f 2001 while (too_many_workers(pool)) {
e22bee78
TH
2002 struct worker *worker;
2003 unsigned long expires;
2004
2005 /* idle_list is kept in LIFO order, check the last one */
63d95a91 2006 worker = list_entry(pool->idle_list.prev, struct worker, entry);
e22bee78
TH
2007 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2008
3347fc9f 2009 if (time_before(jiffies, expires)) {
63d95a91 2010 mod_timer(&pool->idle_timer, expires);
3347fc9f 2011 break;
d5abe669 2012 }
3347fc9f
LJ
2013
2014 destroy_worker(worker);
e22bee78
TH
2015 }
2016
a9b8a985 2017 raw_spin_unlock_irq(&pool->lock);
e22bee78 2018}
d5abe669 2019
493a1724 2020static void send_mayday(struct work_struct *work)
e22bee78 2021{
112202d9
TH
2022 struct pool_workqueue *pwq = get_work_pwq(work);
2023 struct workqueue_struct *wq = pwq->wq;
493a1724 2024
2e109a28 2025 lockdep_assert_held(&wq_mayday_lock);
e22bee78 2026
493008a8 2027 if (!wq->rescuer)
493a1724 2028 return;
e22bee78
TH
2029
2030 /* mayday mayday mayday */
493a1724 2031 if (list_empty(&pwq->mayday_node)) {
77668c8b
LJ
2032 /*
2033 * If @pwq is for an unbound wq, its base ref may be put at
2034 * any time due to an attribute change. Pin @pwq until the
2035 * rescuer is done with it.
2036 */
2037 get_pwq(pwq);
493a1724 2038 list_add_tail(&pwq->mayday_node, &wq->maydays);
e22bee78 2039 wake_up_process(wq->rescuer->task);
493a1724 2040 }
e22bee78
TH
2041}
2042
32a6c723 2043static void pool_mayday_timeout(struct timer_list *t)
e22bee78 2044{
32a6c723 2045 struct worker_pool *pool = from_timer(pool, t, mayday_timer);
e22bee78
TH
2046 struct work_struct *work;
2047
a9b8a985
SAS
2048 raw_spin_lock_irq(&pool->lock);
2049 raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */
e22bee78 2050
63d95a91 2051 if (need_to_create_worker(pool)) {
e22bee78
TH
2052 /*
2053 * We've been trying to create a new worker but
2054 * haven't been successful. We might be hitting an
2055 * allocation deadlock. Send distress signals to
2056 * rescuers.
2057 */
63d95a91 2058 list_for_each_entry(work, &pool->worklist, entry)
e22bee78 2059 send_mayday(work);
1da177e4 2060 }
e22bee78 2061
a9b8a985
SAS
2062 raw_spin_unlock(&wq_mayday_lock);
2063 raw_spin_unlock_irq(&pool->lock);
e22bee78 2064
63d95a91 2065 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1da177e4
LT
2066}
2067
e22bee78
TH
2068/**
2069 * maybe_create_worker - create a new worker if necessary
63d95a91 2070 * @pool: pool to create a new worker for
e22bee78 2071 *
63d95a91 2072 * Create a new worker for @pool if necessary. @pool is guaranteed to
e22bee78
TH
2073 * have at least one idle worker on return from this function. If
2074 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
63d95a91 2075 * sent to all rescuers with works scheduled on @pool to resolve
e22bee78
TH
2076 * possible allocation deadlock.
2077 *
c5aa87bb
TH
2078 * On return, need_to_create_worker() is guaranteed to be %false and
2079 * may_start_working() %true.
e22bee78
TH
2080 *
2081 * LOCKING:
a9b8a985 2082 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
e22bee78
TH
2083 * multiple times. Does GFP_KERNEL allocations. Called only from
2084 * manager.
e22bee78 2085 */
29187a9e 2086static void maybe_create_worker(struct worker_pool *pool)
d565ed63
TH
2087__releases(&pool->lock)
2088__acquires(&pool->lock)
1da177e4 2089{
e22bee78 2090restart:
a9b8a985 2091 raw_spin_unlock_irq(&pool->lock);
9f9c2364 2092
e22bee78 2093 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
63d95a91 2094 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
e22bee78
TH
2095
2096 while (true) {
051e1850 2097 if (create_worker(pool) || !need_to_create_worker(pool))
e22bee78 2098 break;
1da177e4 2099
e212f361 2100 schedule_timeout_interruptible(CREATE_COOLDOWN);
9f9c2364 2101
63d95a91 2102 if (!need_to_create_worker(pool))
e22bee78
TH
2103 break;
2104 }
2105
63d95a91 2106 del_timer_sync(&pool->mayday_timer);
a9b8a985 2107 raw_spin_lock_irq(&pool->lock);
051e1850
LJ
2108 /*
2109 * This is necessary even after a new worker was just successfully
2110 * created as @pool->lock was dropped and the new worker might have
2111 * already become busy.
2112 */
63d95a91 2113 if (need_to_create_worker(pool))
e22bee78 2114 goto restart;
e22bee78
TH
2115}
2116
73f53c4a 2117/**
e22bee78
TH
2118 * manage_workers - manage worker pool
2119 * @worker: self
73f53c4a 2120 *
706026c2 2121 * Assume the manager role and manage the worker pool @worker belongs
e22bee78 2122 * to. At any given time, there can be only zero or one manager per
706026c2 2123 * pool. The exclusion is handled automatically by this function.
e22bee78
TH
2124 *
2125 * The caller can safely start processing works on false return. On
2126 * true return, it's guaranteed that need_to_create_worker() is false
2127 * and may_start_working() is true.
73f53c4a
TH
2128 *
2129 * CONTEXT:
a9b8a985 2130 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
e22bee78
TH
2131 * multiple times. Does GFP_KERNEL allocations.
2132 *
d185af30 2133 * Return:
29187a9e
TH
2134 * %false if the pool doesn't need management and the caller can safely
2135 * start processing works, %true if management function was performed and
2136 * the conditions that the caller verified before calling the function may
2137 * no longer be true.
73f53c4a 2138 */
e22bee78 2139static bool manage_workers(struct worker *worker)
73f53c4a 2140{
63d95a91 2141 struct worker_pool *pool = worker->pool;
73f53c4a 2142
692b4825 2143 if (pool->flags & POOL_MANAGER_ACTIVE)
29187a9e 2144 return false;
692b4825
TH
2145
2146 pool->flags |= POOL_MANAGER_ACTIVE;
2607d7a6 2147 pool->manager = worker;
1e19ffc6 2148
29187a9e 2149 maybe_create_worker(pool);
e22bee78 2150
2607d7a6 2151 pool->manager = NULL;
692b4825 2152 pool->flags &= ~POOL_MANAGER_ACTIVE;
d8bb65ab 2153 rcuwait_wake_up(&manager_wait);
29187a9e 2154 return true;
73f53c4a
TH
2155}
2156
a62428c0
TH
2157/**
2158 * process_one_work - process single work
c34056a3 2159 * @worker: self
a62428c0
TH
2160 * @work: work to process
2161 *
2162 * Process @work. This function contains all the logics necessary to
2163 * process a single work including synchronization against and
2164 * interaction with other workers on the same cpu, queueing and
2165 * flushing. As long as context requirement is met, any worker can
2166 * call this function to process a work.
2167 *
2168 * CONTEXT:
a9b8a985 2169 * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
a62428c0 2170 */
c34056a3 2171static void process_one_work(struct worker *worker, struct work_struct *work)
d565ed63
TH
2172__releases(&pool->lock)
2173__acquires(&pool->lock)
a62428c0 2174{
112202d9 2175 struct pool_workqueue *pwq = get_work_pwq(work);
bd7bdd43 2176 struct worker_pool *pool = worker->pool;
112202d9 2177 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
73f53c4a 2178 int work_color;
7e11629d 2179 struct worker *collision;
a62428c0
TH
2180#ifdef CONFIG_LOCKDEP
2181 /*
2182 * It is permissible to free the struct work_struct from
2183 * inside the function that is called from it, this we need to
2184 * take into account for lockdep too. To avoid bogus "held
2185 * lock freed" warnings as well as problems when looking into
2186 * work->lockdep_map, make a copy and use that here.
2187 */
4d82a1de
PZ
2188 struct lockdep_map lockdep_map;
2189
2190 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
a62428c0 2191#endif
807407c0 2192 /* ensure we're on the correct CPU */
85327af6 2193 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
ec22ca5e 2194 raw_smp_processor_id() != pool->cpu);
25511a47 2195
7e11629d
TH
2196 /*
2197 * A single work shouldn't be executed concurrently by
2198 * multiple workers on a single cpu. Check whether anyone is
2199 * already processing the work. If so, defer the work to the
2200 * currently executing one.
2201 */
c9e7cf27 2202 collision = find_worker_executing_work(pool, work);
7e11629d
TH
2203 if (unlikely(collision)) {
2204 move_linked_works(work, &collision->scheduled, NULL);
2205 return;
2206 }
2207
8930caba 2208 /* claim and dequeue */
a62428c0 2209 debug_work_deactivate(work);
c9e7cf27 2210 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
c34056a3 2211 worker->current_work = work;
a2c1c57b 2212 worker->current_func = work->func;
112202d9 2213 worker->current_pwq = pwq;
73f53c4a 2214 work_color = get_work_color(work);
7a22ad75 2215
8bf89593
TH
2216 /*
2217 * Record wq name for cmdline and debug reporting, may get
2218 * overridden through set_worker_desc().
2219 */
2220 strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2221
a62428c0
TH
2222 list_del_init(&work->entry);
2223
fb0e7beb 2224 /*
228f1d00
LJ
2225 * CPU intensive works don't participate in concurrency management.
2226 * They're the scheduler's responsibility. This takes @worker out
2227 * of concurrency management and the next code block will chain
2228 * execution of the pending work items.
fb0e7beb
TH
2229 */
2230 if (unlikely(cpu_intensive))
228f1d00 2231 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
fb0e7beb 2232
974271c4 2233 /*
a489a03e
LJ
2234 * Wake up another worker if necessary. The condition is always
2235 * false for normal per-cpu workers since nr_running would always
2236 * be >= 1 at this point. This is used to chain execution of the
2237 * pending work items for WORKER_NOT_RUNNING workers such as the
228f1d00 2238 * UNBOUND and CPU_INTENSIVE ones.
974271c4 2239 */
a489a03e 2240 if (need_more_worker(pool))
63d95a91 2241 wake_up_worker(pool);
974271c4 2242
8930caba 2243 /*
7c3eed5c 2244 * Record the last pool and clear PENDING which should be the last
d565ed63 2245 * update to @work. Also, do this inside @pool->lock so that
23657bb1
TH
2246 * PENDING and queued state changes happen together while IRQ is
2247 * disabled.
8930caba 2248 */
7c3eed5c 2249 set_work_pool_and_clear_pending(work, pool->id);
a62428c0 2250
a9b8a985 2251 raw_spin_unlock_irq(&pool->lock);
a62428c0 2252
a1d14934 2253 lock_map_acquire(&pwq->wq->lockdep_map);
a62428c0 2254 lock_map_acquire(&lockdep_map);
e6f3faa7 2255 /*
f52be570
PZ
2256 * Strictly speaking we should mark the invariant state without holding
2257 * any locks, that is, before these two lock_map_acquire()'s.
e6f3faa7
PZ
2258 *
2259 * However, that would result in:
2260 *
2261 * A(W1)
2262 * WFC(C)
2263 * A(W1)
2264 * C(C)
2265 *
2266 * Which would create W1->C->W1 dependencies, even though there is no
2267 * actual deadlock possible. There are two solutions, using a
2268 * read-recursive acquire on the work(queue) 'locks', but this will then
f52be570 2269 * hit the lockdep limitation on recursive locks, or simply discard
e6f3faa7
PZ
2270 * these locks.
2271 *
2272 * AFAICT there is no possible deadlock scenario between the
2273 * flush_work() and complete() primitives (except for single-threaded
2274 * workqueues), so hiding them isn't a problem.
2275 */
f52be570 2276 lockdep_invariant_state(true);
e36c886a 2277 trace_workqueue_execute_start(work);
a2c1c57b 2278 worker->current_func(work);
e36c886a
AV
2279 /*
2280 * While we must be careful to not use "work" after this, the trace
2281 * point will only record its address.
2282 */
1c5da0ec 2283 trace_workqueue_execute_end(work, worker->current_func);
a62428c0 2284 lock_map_release(&lockdep_map);
112202d9 2285 lock_map_release(&pwq->wq->lockdep_map);
a62428c0
TH
2286
2287 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
044c782c 2288 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
d75f773c 2289 " last function: %ps\n",
a2c1c57b
TH
2290 current->comm, preempt_count(), task_pid_nr(current),
2291 worker->current_func);
a62428c0
TH
2292 debug_show_held_locks(current);
2293 dump_stack();
2294 }
2295
b22ce278 2296 /*
025f50f3 2297 * The following prevents a kworker from hogging CPU on !PREEMPTION
b22ce278
TH
2298 * kernels, where a requeueing work item waiting for something to
2299 * happen could deadlock with stop_machine as such work item could
2300 * indefinitely requeue itself while all other CPUs are trapped in
789cbbec
JL
2301 * stop_machine. At the same time, report a quiescent RCU state so
2302 * the same condition doesn't freeze RCU.
b22ce278 2303 */
a7e6425e 2304 cond_resched();
b22ce278 2305
a9b8a985 2306 raw_spin_lock_irq(&pool->lock);
a62428c0 2307
fb0e7beb
TH
2308 /* clear cpu intensive status */
2309 if (unlikely(cpu_intensive))
2310 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2311
1b69ac6b
JW
2312 /* tag the worker for identification in schedule() */
2313 worker->last_func = worker->current_func;
2314
a62428c0 2315 /* we're done with it, release */
42f8570f 2316 hash_del(&worker->hentry);
c34056a3 2317 worker->current_work = NULL;
a2c1c57b 2318 worker->current_func = NULL;
112202d9
TH
2319 worker->current_pwq = NULL;
2320 pwq_dec_nr_in_flight(pwq, work_color);
a62428c0
TH
2321}
2322
affee4b2
TH
2323/**
2324 * process_scheduled_works - process scheduled works
2325 * @worker: self
2326 *
2327 * Process all scheduled works. Please note that the scheduled list
2328 * may change while processing a work, so this function repeatedly
2329 * fetches a work from the top and executes it.
2330 *
2331 * CONTEXT:
a9b8a985 2332 * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
affee4b2
TH
2333 * multiple times.
2334 */
2335static void process_scheduled_works(struct worker *worker)
1da177e4 2336{
affee4b2
TH
2337 while (!list_empty(&worker->scheduled)) {
2338 struct work_struct *work = list_first_entry(&worker->scheduled,
1da177e4 2339 struct work_struct, entry);
c34056a3 2340 process_one_work(worker, work);
1da177e4 2341 }
1da177e4
LT
2342}
2343
197f6acc
TH
2344static void set_pf_worker(bool val)
2345{
2346 mutex_lock(&wq_pool_attach_mutex);
2347 if (val)
2348 current->flags |= PF_WQ_WORKER;
2349 else
2350 current->flags &= ~PF_WQ_WORKER;
2351 mutex_unlock(&wq_pool_attach_mutex);
2352}
2353
4690c4ab
TH
2354/**
2355 * worker_thread - the worker thread function
c34056a3 2356 * @__worker: self
4690c4ab 2357 *
c5aa87bb
TH
2358 * The worker thread function. All workers belong to a worker_pool -
2359 * either a per-cpu one or dynamic unbound one. These workers process all
2360 * work items regardless of their specific target workqueue. The only
2361 * exception is work items which belong to workqueues with a rescuer which
2362 * will be explained in rescuer_thread().
d185af30
YB
2363 *
2364 * Return: 0
4690c4ab 2365 */
c34056a3 2366static int worker_thread(void *__worker)
1da177e4 2367{
c34056a3 2368 struct worker *worker = __worker;
bd7bdd43 2369 struct worker_pool *pool = worker->pool;
1da177e4 2370
e22bee78 2371 /* tell the scheduler that this is a workqueue worker */
197f6acc 2372 set_pf_worker(true);
c8e55f36 2373woke_up:
a9b8a985 2374 raw_spin_lock_irq(&pool->lock);
1da177e4 2375
a9ab775b
TH
2376 /* am I supposed to die? */
2377 if (unlikely(worker->flags & WORKER_DIE)) {
a9b8a985 2378 raw_spin_unlock_irq(&pool->lock);
a9ab775b 2379 WARN_ON_ONCE(!list_empty(&worker->entry));
197f6acc 2380 set_pf_worker(false);
60f5a4bc
LJ
2381
2382 set_task_comm(worker->task, "kworker/dying");
7cda9aae 2383 ida_simple_remove(&pool->worker_ida, worker->id);
a2d812a2 2384 worker_detach_from_pool(worker);
60f5a4bc 2385 kfree(worker);
a9ab775b 2386 return 0;
c8e55f36 2387 }
affee4b2 2388
c8e55f36 2389 worker_leave_idle(worker);
db7bccf4 2390recheck:
e22bee78 2391 /* no more worker necessary? */
63d95a91 2392 if (!need_more_worker(pool))
e22bee78
TH
2393 goto sleep;
2394
2395 /* do we need to manage? */
63d95a91 2396 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
e22bee78
TH
2397 goto recheck;
2398
c8e55f36
TH
2399 /*
2400 * ->scheduled list can only be filled while a worker is
2401 * preparing to process a work or actually processing it.
2402 * Make sure nobody diddled with it while I was sleeping.
2403 */
6183c009 2404 WARN_ON_ONCE(!list_empty(&worker->scheduled));
c8e55f36 2405
e22bee78 2406 /*
a9ab775b
TH
2407 * Finish PREP stage. We're guaranteed to have at least one idle
2408 * worker or that someone else has already assumed the manager
2409 * role. This is where @worker starts participating in concurrency
2410 * management if applicable and concurrency management is restored
2411 * after being rebound. See rebind_workers() for details.
e22bee78 2412 */
a9ab775b 2413 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
e22bee78
TH
2414
2415 do {
c8e55f36 2416 struct work_struct *work =
bd7bdd43 2417 list_first_entry(&pool->worklist,
c8e55f36
TH
2418 struct work_struct, entry);
2419
82607adc
TH
2420 pool->watchdog_ts = jiffies;
2421
c8e55f36
TH
2422 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2423 /* optimization path, not strictly necessary */
2424 process_one_work(worker, work);
2425 if (unlikely(!list_empty(&worker->scheduled)))
affee4b2 2426 process_scheduled_works(worker);
c8e55f36
TH
2427 } else {
2428 move_linked_works(work, &worker->scheduled, NULL);
2429 process_scheduled_works(worker);
affee4b2 2430 }
63d95a91 2431 } while (keep_working(pool));
e22bee78 2432
228f1d00 2433 worker_set_flags(worker, WORKER_PREP);
d313dd85 2434sleep:
c8e55f36 2435 /*
d565ed63
TH
2436 * pool->lock is held and there's no work to process and no need to
2437 * manage, sleep. Workers are woken up only while holding
2438 * pool->lock or from local cpu, so setting the current state
2439 * before releasing pool->lock is enough to prevent losing any
2440 * event.
c8e55f36
TH
2441 */
2442 worker_enter_idle(worker);
c5a94a61 2443 __set_current_state(TASK_IDLE);
a9b8a985 2444 raw_spin_unlock_irq(&pool->lock);
c8e55f36
TH
2445 schedule();
2446 goto woke_up;
1da177e4
LT
2447}
2448
e22bee78
TH
2449/**
2450 * rescuer_thread - the rescuer thread function
111c225a 2451 * @__rescuer: self
e22bee78
TH
2452 *
2453 * Workqueue rescuer thread function. There's one rescuer for each
493008a8 2454 * workqueue which has WQ_MEM_RECLAIM set.
e22bee78 2455 *
706026c2 2456 * Regular work processing on a pool may block trying to create a new
e22bee78
TH
2457 * worker which uses GFP_KERNEL allocation which has slight chance of
2458 * developing into deadlock if some works currently on the same queue
2459 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2460 * the problem rescuer solves.
2461 *
706026c2
TH
2462 * When such condition is possible, the pool summons rescuers of all
2463 * workqueues which have works queued on the pool and let them process
e22bee78
TH
2464 * those works so that forward progress can be guaranteed.
2465 *
2466 * This should happen rarely.
d185af30
YB
2467 *
2468 * Return: 0
e22bee78 2469 */
111c225a 2470static int rescuer_thread(void *__rescuer)
e22bee78 2471{
111c225a
TH
2472 struct worker *rescuer = __rescuer;
2473 struct workqueue_struct *wq = rescuer->rescue_wq;
e22bee78 2474 struct list_head *scheduled = &rescuer->scheduled;
4d595b86 2475 bool should_stop;
e22bee78
TH
2476
2477 set_user_nice(current, RESCUER_NICE_LEVEL);
111c225a
TH
2478
2479 /*
2480 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2481 * doesn't participate in concurrency management.
2482 */
197f6acc 2483 set_pf_worker(true);
e22bee78 2484repeat:
c5a94a61 2485 set_current_state(TASK_IDLE);
e22bee78 2486
4d595b86
LJ
2487 /*
2488 * By the time the rescuer is requested to stop, the workqueue
2489 * shouldn't have any work pending, but @wq->maydays may still have
2490 * pwq(s) queued. This can happen by non-rescuer workers consuming
2491 * all the work items before the rescuer got to them. Go through
2492 * @wq->maydays processing before acting on should_stop so that the
2493 * list is always empty on exit.
2494 */
2495 should_stop = kthread_should_stop();
e22bee78 2496
493a1724 2497 /* see whether any pwq is asking for help */
a9b8a985 2498 raw_spin_lock_irq(&wq_mayday_lock);
493a1724
TH
2499
2500 while (!list_empty(&wq->maydays)) {
2501 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2502 struct pool_workqueue, mayday_node);
112202d9 2503 struct worker_pool *pool = pwq->pool;
e22bee78 2504 struct work_struct *work, *n;
82607adc 2505 bool first = true;
e22bee78
TH
2506
2507 __set_current_state(TASK_RUNNING);
493a1724
TH
2508 list_del_init(&pwq->mayday_node);
2509
a9b8a985 2510 raw_spin_unlock_irq(&wq_mayday_lock);
e22bee78 2511
51697d39
LJ
2512 worker_attach_to_pool(rescuer, pool);
2513
a9b8a985 2514 raw_spin_lock_irq(&pool->lock);
e22bee78
TH
2515
2516 /*
2517 * Slurp in all works issued via this workqueue and
2518 * process'em.
2519 */
0479c8c5 2520 WARN_ON_ONCE(!list_empty(scheduled));
82607adc
TH
2521 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2522 if (get_work_pwq(work) == pwq) {
2523 if (first)
2524 pool->watchdog_ts = jiffies;
e22bee78 2525 move_linked_works(work, scheduled, &n);
82607adc
TH
2526 }
2527 first = false;
2528 }
e22bee78 2529
008847f6
N
2530 if (!list_empty(scheduled)) {
2531 process_scheduled_works(rescuer);
2532
2533 /*
2534 * The above execution of rescued work items could
2535 * have created more to rescue through
2536 * pwq_activate_first_delayed() or chained
2537 * queueing. Let's put @pwq back on mayday list so
2538 * that such back-to-back work items, which may be
2539 * being used to relieve memory pressure, don't
2540 * incur MAYDAY_INTERVAL delay inbetween.
2541 */
4f3f4cf3 2542 if (pwq->nr_active && need_to_create_worker(pool)) {
a9b8a985 2543 raw_spin_lock(&wq_mayday_lock);
e66b39af
TH
2544 /*
2545 * Queue iff we aren't racing destruction
2546 * and somebody else hasn't queued it already.
2547 */
2548 if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2549 get_pwq(pwq);
2550 list_add_tail(&pwq->mayday_node, &wq->maydays);
2551 }
a9b8a985 2552 raw_spin_unlock(&wq_mayday_lock);
008847f6
N
2553 }
2554 }
7576958a 2555
77668c8b
LJ
2556 /*
2557 * Put the reference grabbed by send_mayday(). @pool won't
13b1d625 2558 * go away while we're still attached to it.
77668c8b
LJ
2559 */
2560 put_pwq(pwq);
2561
7576958a 2562 /*
d8ca83e6 2563 * Leave this pool. If need_more_worker() is %true, notify a
7576958a
TH
2564 * regular worker; otherwise, we end up with 0 concurrency
2565 * and stalling the execution.
2566 */
d8ca83e6 2567 if (need_more_worker(pool))
63d95a91 2568 wake_up_worker(pool);
7576958a 2569
a9b8a985 2570 raw_spin_unlock_irq(&pool->lock);
13b1d625 2571
a2d812a2 2572 worker_detach_from_pool(rescuer);
13b1d625 2573
a9b8a985 2574 raw_spin_lock_irq(&wq_mayday_lock);
e22bee78
TH
2575 }
2576
a9b8a985 2577 raw_spin_unlock_irq(&wq_mayday_lock);
493a1724 2578
4d595b86
LJ
2579 if (should_stop) {
2580 __set_current_state(TASK_RUNNING);
197f6acc 2581 set_pf_worker(false);
4d595b86
LJ
2582 return 0;
2583 }
2584
111c225a
TH
2585 /* rescuers should never participate in concurrency management */
2586 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
e22bee78
TH
2587 schedule();
2588 goto repeat;
1da177e4
LT
2589}
2590
fca839c0
TH
2591/**
2592 * check_flush_dependency - check for flush dependency sanity
2593 * @target_wq: workqueue being flushed
2594 * @target_work: work item being flushed (NULL for workqueue flushes)
2595 *
2596 * %current is trying to flush the whole @target_wq or @target_work on it.
2597 * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2598 * reclaiming memory or running on a workqueue which doesn't have
2599 * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2600 * a deadlock.
2601 */
2602static void check_flush_dependency(struct workqueue_struct *target_wq,
2603 struct work_struct *target_work)
2604{
2605 work_func_t target_func = target_work ? target_work->func : NULL;
2606 struct worker *worker;
2607
2608 if (target_wq->flags & WQ_MEM_RECLAIM)
2609 return;
2610
2611 worker = current_wq_worker();
2612
2613 WARN_ONCE(current->flags & PF_MEMALLOC,
d75f773c 2614 "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
fca839c0 2615 current->pid, current->comm, target_wq->name, target_func);
23d11a58
TH
2616 WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2617 (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
d75f773c 2618 "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
fca839c0
TH
2619 worker->current_pwq->wq->name, worker->current_func,
2620 target_wq->name, target_func);
2621}
2622
fc2e4d70
ON
2623struct wq_barrier {
2624 struct work_struct work;
2625 struct completion done;
2607d7a6 2626 struct task_struct *task; /* purely informational */
fc2e4d70
ON
2627};
2628
2629static void wq_barrier_func(struct work_struct *work)
2630{
2631 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2632 complete(&barr->done);
2633}
2634
4690c4ab
TH
2635/**
2636 * insert_wq_barrier - insert a barrier work
112202d9 2637 * @pwq: pwq to insert barrier into
4690c4ab 2638 * @barr: wq_barrier to insert
affee4b2
TH
2639 * @target: target work to attach @barr to
2640 * @worker: worker currently executing @target, NULL if @target is not executing
4690c4ab 2641 *
affee4b2
TH
2642 * @barr is linked to @target such that @barr is completed only after
2643 * @target finishes execution. Please note that the ordering
2644 * guarantee is observed only with respect to @target and on the local
2645 * cpu.
2646 *
2647 * Currently, a queued barrier can't be canceled. This is because
2648 * try_to_grab_pending() can't determine whether the work to be
2649 * grabbed is at the head of the queue and thus can't clear LINKED
2650 * flag of the previous work while there must be a valid next work
2651 * after a work with LINKED flag set.
2652 *
2653 * Note that when @worker is non-NULL, @target may be modified
112202d9 2654 * underneath us, so we can't reliably determine pwq from @target.
4690c4ab
TH
2655 *
2656 * CONTEXT:
a9b8a985 2657 * raw_spin_lock_irq(pool->lock).
4690c4ab 2658 */
112202d9 2659static void insert_wq_barrier(struct pool_workqueue *pwq,
affee4b2
TH
2660 struct wq_barrier *barr,
2661 struct work_struct *target, struct worker *worker)
fc2e4d70 2662{
affee4b2
TH
2663 struct list_head *head;
2664 unsigned int linked = 0;
2665
dc186ad7 2666 /*
d565ed63 2667 * debugobject calls are safe here even with pool->lock locked
dc186ad7
TG
2668 * as we know for sure that this will not trigger any of the
2669 * checks and call back into the fixup functions where we
2670 * might deadlock.
2671 */
ca1cab37 2672 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
22df02bb 2673 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
52fa5bc5 2674
fd1a5b04
BP
2675 init_completion_map(&barr->done, &target->lockdep_map);
2676
2607d7a6 2677 barr->task = current;
83c22520 2678
affee4b2
TH
2679 /*
2680 * If @target is currently being executed, schedule the
2681 * barrier to the worker; otherwise, put it after @target.
2682 */
2683 if (worker)
2684 head = worker->scheduled.next;
2685 else {
2686 unsigned long *bits = work_data_bits(target);
2687
2688 head = target->entry.next;
2689 /* there can already be other linked works, inherit and set */
2690 linked = *bits & WORK_STRUCT_LINKED;
2691 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2692 }
2693
dc186ad7 2694 debug_work_activate(&barr->work);
112202d9 2695 insert_work(pwq, &barr->work, head,
affee4b2 2696 work_color_to_flags(WORK_NO_COLOR) | linked);
fc2e4d70
ON
2697}
2698
73f53c4a 2699/**
112202d9 2700 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
73f53c4a
TH
2701 * @wq: workqueue being flushed
2702 * @flush_color: new flush color, < 0 for no-op
2703 * @work_color: new work color, < 0 for no-op
2704 *
112202d9 2705 * Prepare pwqs for workqueue flushing.
73f53c4a 2706 *
112202d9
TH
2707 * If @flush_color is non-negative, flush_color on all pwqs should be
2708 * -1. If no pwq has in-flight commands at the specified color, all
2709 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2710 * has in flight commands, its pwq->flush_color is set to
2711 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
73f53c4a
TH
2712 * wakeup logic is armed and %true is returned.
2713 *
2714 * The caller should have initialized @wq->first_flusher prior to
2715 * calling this function with non-negative @flush_color. If
2716 * @flush_color is negative, no flush color update is done and %false
2717 * is returned.
2718 *
112202d9 2719 * If @work_color is non-negative, all pwqs should have the same
73f53c4a
TH
2720 * work_color which is previous to @work_color and all will be
2721 * advanced to @work_color.
2722 *
2723 * CONTEXT:
3c25a55d 2724 * mutex_lock(wq->mutex).
73f53c4a 2725 *
d185af30 2726 * Return:
73f53c4a
TH
2727 * %true if @flush_color >= 0 and there's something to flush. %false
2728 * otherwise.
2729 */
112202d9 2730static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
73f53c4a 2731 int flush_color, int work_color)
1da177e4 2732{
73f53c4a 2733 bool wait = false;
49e3cf44 2734 struct pool_workqueue *pwq;
1da177e4 2735
73f53c4a 2736 if (flush_color >= 0) {
6183c009 2737 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
112202d9 2738 atomic_set(&wq->nr_pwqs_to_flush, 1);
1da177e4 2739 }
2355b70f 2740
49e3cf44 2741 for_each_pwq(pwq, wq) {
112202d9 2742 struct worker_pool *pool = pwq->pool;
fc2e4d70 2743
a9b8a985 2744 raw_spin_lock_irq(&pool->lock);
83c22520 2745
73f53c4a 2746 if (flush_color >= 0) {
6183c009 2747 WARN_ON_ONCE(pwq->flush_color != -1);
fc2e4d70 2748
112202d9
TH
2749 if (pwq->nr_in_flight[flush_color]) {
2750 pwq->flush_color = flush_color;
2751 atomic_inc(&wq->nr_pwqs_to_flush);
73f53c4a
TH
2752 wait = true;
2753 }
2754 }
1da177e4 2755
73f53c4a 2756 if (work_color >= 0) {
6183c009 2757 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
112202d9 2758 pwq->work_color = work_color;
73f53c4a 2759 }
1da177e4 2760
a9b8a985 2761 raw_spin_unlock_irq(&pool->lock);
1da177e4 2762 }
2355b70f 2763
112202d9 2764 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
73f53c4a 2765 complete(&wq->first_flusher->done);
14441960 2766
73f53c4a 2767 return wait;
1da177e4
LT
2768}
2769
0fcb78c2 2770/**
1da177e4 2771 * flush_workqueue - ensure that any scheduled work has run to completion.
0fcb78c2 2772 * @wq: workqueue to flush
1da177e4 2773 *
c5aa87bb
TH
2774 * This function sleeps until all work items which were queued on entry
2775 * have finished execution, but it is not livelocked by new incoming ones.
1da177e4 2776 */
7ad5b3a5 2777void flush_workqueue(struct workqueue_struct *wq)
1da177e4 2778{
73f53c4a
TH
2779 struct wq_flusher this_flusher = {
2780 .list = LIST_HEAD_INIT(this_flusher.list),
2781 .flush_color = -1,
fd1a5b04 2782 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
73f53c4a
TH
2783 };
2784 int next_color;
1da177e4 2785
3347fa09
TH
2786 if (WARN_ON(!wq_online))
2787 return;
2788
87915adc
JB
2789 lock_map_acquire(&wq->lockdep_map);
2790 lock_map_release(&wq->lockdep_map);
2791
3c25a55d 2792 mutex_lock(&wq->mutex);
73f53c4a
TH
2793
2794 /*
2795 * Start-to-wait phase
2796 */
2797 next_color = work_next_color(wq->work_color);
2798
2799 if (next_color != wq->flush_color) {
2800 /*
2801 * Color space is not full. The current work_color
2802 * becomes our flush_color and work_color is advanced
2803 * by one.
2804 */
6183c009 2805 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
73f53c4a
TH
2806 this_flusher.flush_color = wq->work_color;
2807 wq->work_color = next_color;
2808
2809 if (!wq->first_flusher) {
2810 /* no flush in progress, become the first flusher */
6183c009 2811 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
73f53c4a
TH
2812
2813 wq->first_flusher = &this_flusher;
2814
112202d9 2815 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
73f53c4a
TH
2816 wq->work_color)) {
2817 /* nothing to flush, done */
2818 wq->flush_color = next_color;
2819 wq->first_flusher = NULL;
2820 goto out_unlock;
2821 }
2822 } else {
2823 /* wait in queue */
6183c009 2824 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
73f53c4a 2825 list_add_tail(&this_flusher.list, &wq->flusher_queue);
112202d9 2826 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
73f53c4a
TH
2827 }
2828 } else {
2829 /*
2830 * Oops, color space is full, wait on overflow queue.
2831 * The next flush completion will assign us
2832 * flush_color and transfer to flusher_queue.
2833 */
2834 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2835 }
2836
fca839c0
TH
2837 check_flush_dependency(wq, NULL);
2838
3c25a55d 2839 mutex_unlock(&wq->mutex);
73f53c4a
TH
2840
2841 wait_for_completion(&this_flusher.done);
2842
2843 /*
2844 * Wake-up-and-cascade phase
2845 *
2846 * First flushers are responsible for cascading flushes and
2847 * handling overflow. Non-first flushers can simply return.
2848 */
00d5d15b 2849 if (READ_ONCE(wq->first_flusher) != &this_flusher)
73f53c4a
TH
2850 return;
2851
3c25a55d 2852 mutex_lock(&wq->mutex);
73f53c4a 2853
4ce48b37
TH
2854 /* we might have raced, check again with mutex held */
2855 if (wq->first_flusher != &this_flusher)
2856 goto out_unlock;
2857
00d5d15b 2858 WRITE_ONCE(wq->first_flusher, NULL);
73f53c4a 2859
6183c009
TH
2860 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2861 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
73f53c4a
TH
2862
2863 while (true) {
2864 struct wq_flusher *next, *tmp;
2865
2866 /* complete all the flushers sharing the current flush color */
2867 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2868 if (next->flush_color != wq->flush_color)
2869 break;
2870 list_del_init(&next->list);
2871 complete(&next->done);
2872 }
2873
6183c009
TH
2874 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2875 wq->flush_color != work_next_color(wq->work_color));
73f53c4a
TH
2876
2877 /* this flush_color is finished, advance by one */
2878 wq->flush_color = work_next_color(wq->flush_color);
2879
2880 /* one color has been freed, handle overflow queue */
2881 if (!list_empty(&wq->flusher_overflow)) {
2882 /*
2883 * Assign the same color to all overflowed
2884 * flushers, advance work_color and append to
2885 * flusher_queue. This is the start-to-wait
2886 * phase for these overflowed flushers.
2887 */
2888 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2889 tmp->flush_color = wq->work_color;
2890
2891 wq->work_color = work_next_color(wq->work_color);
2892
2893 list_splice_tail_init(&wq->flusher_overflow,
2894 &wq->flusher_queue);
112202d9 2895 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
73f53c4a
TH
2896 }
2897
2898 if (list_empty(&wq->flusher_queue)) {
6183c009 2899 WARN_ON_ONCE(wq->flush_color != wq->work_color);
73f53c4a
TH
2900 break;
2901 }
2902
2903 /*
2904 * Need to flush more colors. Make the next flusher
112202d9 2905 * the new first flusher and arm pwqs.
73f53c4a 2906 */
6183c009
TH
2907 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2908 WARN_ON_ONCE(wq->flush_color != next->flush_color);
73f53c4a
TH
2909
2910 list_del_init(&next->list);
2911 wq->first_flusher = next;
2912
112202d9 2913 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
73f53c4a
TH
2914 break;
2915
2916 /*
2917 * Meh... this color is already done, clear first
2918 * flusher and repeat cascading.
2919 */
2920 wq->first_flusher = NULL;
2921 }
2922
2923out_unlock:
3c25a55d 2924 mutex_unlock(&wq->mutex);
1da177e4 2925}
1dadafa8 2926EXPORT_SYMBOL(flush_workqueue);
1da177e4 2927
9c5a2ba7
TH
2928/**
2929 * drain_workqueue - drain a workqueue
2930 * @wq: workqueue to drain
2931 *
2932 * Wait until the workqueue becomes empty. While draining is in progress,
2933 * only chain queueing is allowed. IOW, only currently pending or running
2934 * work items on @wq can queue further work items on it. @wq is flushed
b749b1b6 2935 * repeatedly until it becomes empty. The number of flushing is determined
9c5a2ba7
TH
2936 * by the depth of chaining and should be relatively short. Whine if it
2937 * takes too long.
2938 */
2939void drain_workqueue(struct workqueue_struct *wq)
2940{
2941 unsigned int flush_cnt = 0;
49e3cf44 2942 struct pool_workqueue *pwq;
9c5a2ba7
TH
2943
2944 /*
2945 * __queue_work() needs to test whether there are drainers, is much
2946 * hotter than drain_workqueue() and already looks at @wq->flags.
618b01eb 2947 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
9c5a2ba7 2948 */
87fc741e 2949 mutex_lock(&wq->mutex);
9c5a2ba7 2950 if (!wq->nr_drainers++)
618b01eb 2951 wq->flags |= __WQ_DRAINING;
87fc741e 2952 mutex_unlock(&wq->mutex);
9c5a2ba7
TH
2953reflush:
2954 flush_workqueue(wq);
2955
b09f4fd3 2956 mutex_lock(&wq->mutex);
76af4d93 2957
49e3cf44 2958 for_each_pwq(pwq, wq) {
fa2563e4 2959 bool drained;
9c5a2ba7 2960
a9b8a985 2961 raw_spin_lock_irq(&pwq->pool->lock);
112202d9 2962 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
a9b8a985 2963 raw_spin_unlock_irq(&pwq->pool->lock);
fa2563e4
TT
2964
2965 if (drained)
9c5a2ba7
TH
2966 continue;
2967
2968 if (++flush_cnt == 10 ||
2969 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
c5aa87bb 2970 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
044c782c 2971 wq->name, flush_cnt);
76af4d93 2972
b09f4fd3 2973 mutex_unlock(&wq->mutex);
9c5a2ba7
TH
2974 goto reflush;
2975 }
2976
9c5a2ba7 2977 if (!--wq->nr_drainers)
618b01eb 2978 wq->flags &= ~__WQ_DRAINING;
87fc741e 2979 mutex_unlock(&wq->mutex);
9c5a2ba7
TH
2980}
2981EXPORT_SYMBOL_GPL(drain_workqueue);
2982
d6e89786
JB
2983static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2984 bool from_cancel)
db700897 2985{
affee4b2 2986 struct worker *worker = NULL;
c9e7cf27 2987 struct worker_pool *pool;
112202d9 2988 struct pool_workqueue *pwq;
db700897
ON
2989
2990 might_sleep();
fa1b54e6 2991
24acfb71 2992 rcu_read_lock();
c9e7cf27 2993 pool = get_work_pool(work);
fa1b54e6 2994 if (!pool) {
24acfb71 2995 rcu_read_unlock();
baf59022 2996 return false;
fa1b54e6 2997 }
db700897 2998
a9b8a985 2999 raw_spin_lock_irq(&pool->lock);
0b3dae68 3000 /* see the comment in try_to_grab_pending() with the same code */
112202d9
TH
3001 pwq = get_work_pwq(work);
3002 if (pwq) {
3003 if (unlikely(pwq->pool != pool))
4690c4ab 3004 goto already_gone;
606a5020 3005 } else {
c9e7cf27 3006 worker = find_worker_executing_work(pool, work);
affee4b2 3007 if (!worker)
4690c4ab 3008 goto already_gone;
112202d9 3009 pwq = worker->current_pwq;
606a5020 3010 }
db700897 3011
fca839c0
TH
3012 check_flush_dependency(pwq->wq, work);
3013
112202d9 3014 insert_wq_barrier(pwq, barr, work, worker);
a9b8a985 3015 raw_spin_unlock_irq(&pool->lock);
7a22ad75 3016
e159489b 3017 /*
a1d14934
PZ
3018 * Force a lock recursion deadlock when using flush_work() inside a
3019 * single-threaded or rescuer equipped workqueue.
3020 *
3021 * For single threaded workqueues the deadlock happens when the work
3022 * is after the work issuing the flush_work(). For rescuer equipped
3023 * workqueues the deadlock happens when the rescuer stalls, blocking
3024 * forward progress.
e159489b 3025 */
d6e89786
JB
3026 if (!from_cancel &&
3027 (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
112202d9 3028 lock_map_acquire(&pwq->wq->lockdep_map);
a1d14934
PZ
3029 lock_map_release(&pwq->wq->lockdep_map);
3030 }
24acfb71 3031 rcu_read_unlock();
401a8d04 3032 return true;
4690c4ab 3033already_gone:
a9b8a985 3034 raw_spin_unlock_irq(&pool->lock);
24acfb71 3035 rcu_read_unlock();
401a8d04 3036 return false;
db700897 3037}
baf59022 3038
d6e89786
JB
3039static bool __flush_work(struct work_struct *work, bool from_cancel)
3040{
3041 struct wq_barrier barr;
3042
3043 if (WARN_ON(!wq_online))
3044 return false;
3045
4d43d395
TH
3046 if (WARN_ON(!work->func))
3047 return false;
3048
87915adc
JB
3049 if (!from_cancel) {
3050 lock_map_acquire(&work->lockdep_map);
3051 lock_map_release(&work->lockdep_map);
3052 }
3053
d6e89786
JB
3054 if (start_flush_work(work, &barr, from_cancel)) {
3055 wait_for_completion(&barr.done);
3056 destroy_work_on_stack(&barr.work);
3057 return true;
3058 } else {
3059 return false;
3060 }
3061}
3062
baf59022
TH
3063/**
3064 * flush_work - wait for a work to finish executing the last queueing instance
3065 * @work: the work to flush
3066 *
606a5020
TH
3067 * Wait until @work has finished execution. @work is guaranteed to be idle
3068 * on return if it hasn't been requeued since flush started.
baf59022 3069 *
d185af30 3070 * Return:
baf59022
TH
3071 * %true if flush_work() waited for the work to finish execution,
3072 * %false if it was already idle.
3073 */
3074bool flush_work(struct work_struct *work)
3075{
d6e89786 3076 return __flush_work(work, false);
6e84d644 3077}
606a5020 3078EXPORT_SYMBOL_GPL(flush_work);
6e84d644 3079
8603e1b3 3080struct cwt_wait {
ac6424b9 3081 wait_queue_entry_t wait;
8603e1b3
TH
3082 struct work_struct *work;
3083};
3084
ac6424b9 3085static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
8603e1b3
TH
3086{
3087 struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3088
3089 if (cwait->work != key)
3090 return 0;
3091 return autoremove_wake_function(wait, mode, sync, key);
3092}
3093
36e227d2 3094static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
1f1f642e 3095{
8603e1b3 3096 static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
bbb68dfa 3097 unsigned long flags;
1f1f642e
ON
3098 int ret;
3099
3100 do {
bbb68dfa
TH
3101 ret = try_to_grab_pending(work, is_dwork, &flags);
3102 /*
8603e1b3
TH
3103 * If someone else is already canceling, wait for it to
3104 * finish. flush_work() doesn't work for PREEMPT_NONE
3105 * because we may get scheduled between @work's completion
3106 * and the other canceling task resuming and clearing
3107 * CANCELING - flush_work() will return false immediately
3108 * as @work is no longer busy, try_to_grab_pending() will
3109 * return -ENOENT as @work is still being canceled and the
3110 * other canceling task won't be able to clear CANCELING as
3111 * we're hogging the CPU.
3112 *
3113 * Let's wait for completion using a waitqueue. As this
3114 * may lead to the thundering herd problem, use a custom
3115 * wake function which matches @work along with exclusive
3116 * wait and wakeup.
bbb68dfa 3117 */
8603e1b3
TH
3118 if (unlikely(ret == -ENOENT)) {
3119 struct cwt_wait cwait;
3120
3121 init_wait(&cwait.wait);
3122 cwait.wait.func = cwt_wakefn;
3123 cwait.work = work;
3124
3125 prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3126 TASK_UNINTERRUPTIBLE);
3127 if (work_is_canceling(work))
3128 schedule();
3129 finish_wait(&cancel_waitq, &cwait.wait);
3130 }
1f1f642e
ON
3131 } while (unlikely(ret < 0));
3132
bbb68dfa
TH
3133 /* tell other tasks trying to grab @work to back off */
3134 mark_work_canceling(work);
3135 local_irq_restore(flags);
3136
3347fa09
TH
3137 /*
3138 * This allows canceling during early boot. We know that @work
3139 * isn't executing.
3140 */
3141 if (wq_online)
d6e89786 3142 __flush_work(work, true);
3347fa09 3143
7a22ad75 3144 clear_work_data(work);
8603e1b3
TH
3145
3146 /*
3147 * Paired with prepare_to_wait() above so that either
3148 * waitqueue_active() is visible here or !work_is_canceling() is
3149 * visible there.
3150 */
3151 smp_mb();
3152 if (waitqueue_active(&cancel_waitq))
3153 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3154
1f1f642e
ON
3155 return ret;
3156}
3157
6e84d644 3158/**
401a8d04
TH
3159 * cancel_work_sync - cancel a work and wait for it to finish
3160 * @work: the work to cancel
6e84d644 3161 *
401a8d04
TH
3162 * Cancel @work and wait for its execution to finish. This function
3163 * can be used even if the work re-queues itself or migrates to
3164 * another workqueue. On return from this function, @work is
3165 * guaranteed to be not pending or executing on any CPU.
1f1f642e 3166 *
401a8d04
TH
3167 * cancel_work_sync(&delayed_work->work) must not be used for
3168 * delayed_work's. Use cancel_delayed_work_sync() instead.
6e84d644 3169 *
401a8d04 3170 * The caller must ensure that the workqueue on which @work was last
6e84d644 3171 * queued can't be destroyed before this function returns.
401a8d04 3172 *
d185af30 3173 * Return:
401a8d04 3174 * %true if @work was pending, %false otherwise.
6e84d644 3175 */
401a8d04 3176bool cancel_work_sync(struct work_struct *work)
6e84d644 3177{
36e227d2 3178 return __cancel_work_timer(work, false);
b89deed3 3179}
28e53bdd 3180EXPORT_SYMBOL_GPL(cancel_work_sync);
b89deed3 3181
6e84d644 3182/**
401a8d04
TH
3183 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3184 * @dwork: the delayed work to flush
6e84d644 3185 *
401a8d04
TH
3186 * Delayed timer is cancelled and the pending work is queued for
3187 * immediate execution. Like flush_work(), this function only
3188 * considers the last queueing instance of @dwork.
1f1f642e 3189 *
d185af30 3190 * Return:
401a8d04
TH
3191 * %true if flush_work() waited for the work to finish execution,
3192 * %false if it was already idle.
6e84d644 3193 */
401a8d04
TH
3194bool flush_delayed_work(struct delayed_work *dwork)
3195{
8930caba 3196 local_irq_disable();
401a8d04 3197 if (del_timer_sync(&dwork->timer))
60c057bc 3198 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
8930caba 3199 local_irq_enable();
401a8d04
TH
3200 return flush_work(&dwork->work);
3201}
3202EXPORT_SYMBOL(flush_delayed_work);
3203
05f0fe6b
TH
3204/**
3205 * flush_rcu_work - wait for a rwork to finish executing the last queueing
3206 * @rwork: the rcu work to flush
3207 *
3208 * Return:
3209 * %true if flush_rcu_work() waited for the work to finish execution,
3210 * %false if it was already idle.
3211 */
3212bool flush_rcu_work(struct rcu_work *rwork)
3213{
3214 if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3215 rcu_barrier();
3216 flush_work(&rwork->work);
3217 return true;
3218 } else {
3219 return flush_work(&rwork->work);
3220 }
3221}
3222EXPORT_SYMBOL(flush_rcu_work);
3223
f72b8792
JA
3224static bool __cancel_work(struct work_struct *work, bool is_dwork)
3225{
3226 unsigned long flags;
3227 int ret;
3228
3229 do {
3230 ret = try_to_grab_pending(work, is_dwork, &flags);
3231 } while (unlikely(ret == -EAGAIN));
3232
3233 if (unlikely(ret < 0))
3234 return false;
3235
3236 set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3237 local_irq_restore(flags);
3238 return ret;
3239}
3240
09383498 3241/**
57b30ae7
TH
3242 * cancel_delayed_work - cancel a delayed work
3243 * @dwork: delayed_work to cancel
09383498 3244 *
d185af30
YB
3245 * Kill off a pending delayed_work.
3246 *
3247 * Return: %true if @dwork was pending and canceled; %false if it wasn't
3248 * pending.
3249 *
3250 * Note:
3251 * The work callback function may still be running on return, unless
3252 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
3253 * use cancel_delayed_work_sync() to wait on it.
09383498 3254 *
57b30ae7 3255 * This function is safe to call from any context including IRQ handler.
09383498 3256 */
57b30ae7 3257bool cancel_delayed_work(struct delayed_work *dwork)
09383498 3258{
f72b8792 3259 return __cancel_work(&dwork->work, true);
09383498 3260}
57b30ae7 3261EXPORT_SYMBOL(cancel_delayed_work);
09383498 3262
401a8d04
TH
3263/**
3264 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3265 * @dwork: the delayed work cancel
3266 *
3267 * This is cancel_work_sync() for delayed works.
3268 *
d185af30 3269 * Return:
401a8d04
TH
3270 * %true if @dwork was pending, %false otherwise.
3271 */
3272bool cancel_delayed_work_sync(struct delayed_work *dwork)
6e84d644 3273{
36e227d2 3274 return __cancel_work_timer(&dwork->work, true);
6e84d644 3275}
f5a421a4 3276EXPORT_SYMBOL(cancel_delayed_work_sync);
1da177e4 3277
b6136773 3278/**
31ddd871 3279 * schedule_on_each_cpu - execute a function synchronously on each online CPU
b6136773 3280 * @func: the function to call
b6136773 3281 *
31ddd871
TH
3282 * schedule_on_each_cpu() executes @func on each online CPU using the
3283 * system workqueue and blocks until all CPUs have completed.
b6136773 3284 * schedule_on_each_cpu() is very slow.
31ddd871 3285 *
d185af30 3286 * Return:
31ddd871 3287 * 0 on success, -errno on failure.
b6136773 3288 */
65f27f38 3289int schedule_on_each_cpu(work_func_t func)
15316ba8
CL
3290{
3291 int cpu;
38f51568 3292 struct work_struct __percpu *works;
15316ba8 3293
b6136773
AM
3294 works = alloc_percpu(struct work_struct);
3295 if (!works)
15316ba8 3296 return -ENOMEM;
b6136773 3297
93981800
TH
3298 get_online_cpus();
3299
15316ba8 3300 for_each_online_cpu(cpu) {
9bfb1839
IM
3301 struct work_struct *work = per_cpu_ptr(works, cpu);
3302
3303 INIT_WORK(work, func);
b71ab8c2 3304 schedule_work_on(cpu, work);
65a64464 3305 }
93981800
TH
3306
3307 for_each_online_cpu(cpu)
3308 flush_work(per_cpu_ptr(works, cpu));
3309
95402b38 3310 put_online_cpus();
b6136773 3311 free_percpu(works);
15316ba8
CL
3312 return 0;
3313}
3314
1fa44eca
JB
3315/**
3316 * execute_in_process_context - reliably execute the routine with user context
3317 * @fn: the function to execute
1fa44eca
JB
3318 * @ew: guaranteed storage for the execute work structure (must
3319 * be available when the work executes)
3320 *
3321 * Executes the function immediately if process context is available,
3322 * otherwise schedules the function for delayed execution.
3323 *
d185af30 3324 * Return: 0 - function was executed
1fa44eca
JB
3325 * 1 - function was scheduled for execution
3326 */
65f27f38 3327int execute_in_process_context(work_func_t fn, struct execute_work *ew)
1fa44eca
JB
3328{
3329 if (!in_interrupt()) {
65f27f38 3330 fn(&ew->work);
1fa44eca
JB
3331 return 0;
3332 }
3333
65f27f38 3334 INIT_WORK(&ew->work, fn);
1fa44eca
JB
3335 schedule_work(&ew->work);
3336
3337 return 1;
3338}
3339EXPORT_SYMBOL_GPL(execute_in_process_context);
3340
6ba94429
FW
3341/**
3342 * free_workqueue_attrs - free a workqueue_attrs
3343 * @attrs: workqueue_attrs to free
226223ab 3344 *
6ba94429 3345 * Undo alloc_workqueue_attrs().
226223ab 3346 */
513c98d0 3347void free_workqueue_attrs(struct workqueue_attrs *attrs)
226223ab 3348{
6ba94429
FW
3349 if (attrs) {
3350 free_cpumask_var(attrs->cpumask);
3351 kfree(attrs);
3352 }
226223ab
TH
3353}
3354
6ba94429
FW
3355/**
3356 * alloc_workqueue_attrs - allocate a workqueue_attrs
6ba94429
FW
3357 *
3358 * Allocate a new workqueue_attrs, initialize with default settings and
3359 * return it.
3360 *
3361 * Return: The allocated new workqueue_attr on success. %NULL on failure.
3362 */
513c98d0 3363struct workqueue_attrs *alloc_workqueue_attrs(void)
226223ab 3364{
6ba94429 3365 struct workqueue_attrs *attrs;
226223ab 3366
be69d00d 3367 attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
6ba94429
FW
3368 if (!attrs)
3369 goto fail;
be69d00d 3370 if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
6ba94429
FW
3371 goto fail;
3372
3373 cpumask_copy(attrs->cpumask, cpu_possible_mask);
3374 return attrs;
3375fail:
3376 free_workqueue_attrs(attrs);
3377 return NULL;
226223ab
TH
3378}
3379
6ba94429
FW
3380static void copy_workqueue_attrs(struct workqueue_attrs *to,
3381 const struct workqueue_attrs *from)
226223ab 3382{
6ba94429
FW
3383 to->nice = from->nice;
3384 cpumask_copy(to->cpumask, from->cpumask);
3385 /*
3386 * Unlike hash and equality test, this function doesn't ignore
3387 * ->no_numa as it is used for both pool and wq attrs. Instead,
3388 * get_unbound_pool() explicitly clears ->no_numa after copying.
3389 */
3390 to->no_numa = from->no_numa;
226223ab
TH
3391}
3392
6ba94429
FW
3393/* hash value of the content of @attr */
3394static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
226223ab 3395{
6ba94429 3396 u32 hash = 0;
226223ab 3397
6ba94429
FW
3398 hash = jhash_1word(attrs->nice, hash);
3399 hash = jhash(cpumask_bits(attrs->cpumask),
3400 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
3401 return hash;
226223ab 3402}
226223ab 3403
6ba94429
FW
3404/* content equality test */
3405static bool wqattrs_equal(const struct workqueue_attrs *a,
3406 const struct workqueue_attrs *b)
226223ab 3407{
6ba94429
FW
3408 if (a->nice != b->nice)
3409 return false;
3410 if (!cpumask_equal(a->cpumask, b->cpumask))
3411 return false;
3412 return true;
226223ab
TH
3413}
3414
6ba94429
FW
3415/**
3416 * init_worker_pool - initialize a newly zalloc'd worker_pool
3417 * @pool: worker_pool to initialize
3418 *
402dd89d 3419 * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs.
6ba94429
FW
3420 *
3421 * Return: 0 on success, -errno on failure. Even on failure, all fields
3422 * inside @pool proper are initialized and put_unbound_pool() can be called
3423 * on @pool safely to release it.
3424 */
3425static int init_worker_pool(struct worker_pool *pool)
226223ab 3426{
a9b8a985 3427 raw_spin_lock_init(&pool->lock);
6ba94429
FW
3428 pool->id = -1;
3429 pool->cpu = -1;
3430 pool->node = NUMA_NO_NODE;
3431 pool->flags |= POOL_DISASSOCIATED;
82607adc 3432 pool->watchdog_ts = jiffies;
6ba94429
FW
3433 INIT_LIST_HEAD(&pool->worklist);
3434 INIT_LIST_HEAD(&pool->idle_list);
3435 hash_init(pool->busy_hash);
226223ab 3436
32a6c723 3437 timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
226223ab 3438
32a6c723 3439 timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
226223ab 3440
6ba94429 3441 INIT_LIST_HEAD(&pool->workers);
226223ab 3442
6ba94429
FW
3443 ida_init(&pool->worker_ida);
3444 INIT_HLIST_NODE(&pool->hash_node);
3445 pool->refcnt = 1;
226223ab 3446
6ba94429 3447 /* shouldn't fail above this point */
be69d00d 3448 pool->attrs = alloc_workqueue_attrs();
6ba94429
FW
3449 if (!pool->attrs)
3450 return -ENOMEM;
3451 return 0;
226223ab
TH
3452}
3453
669de8bd
BVA
3454#ifdef CONFIG_LOCKDEP
3455static void wq_init_lockdep(struct workqueue_struct *wq)
3456{
3457 char *lock_name;
3458
3459 lockdep_register_key(&wq->key);
3460 lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3461 if (!lock_name)
3462 lock_name = wq->name;
69a106c0
QC
3463
3464 wq->lock_name = lock_name;
669de8bd
BVA
3465 lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3466}
3467
3468static void wq_unregister_lockdep(struct workqueue_struct *wq)
3469{
3470 lockdep_unregister_key(&wq->key);
3471}
3472
3473static void wq_free_lockdep(struct workqueue_struct *wq)
3474{
3475 if (wq->lock_name != wq->name)
3476 kfree(wq->lock_name);
3477}
3478#else
3479static void wq_init_lockdep(struct workqueue_struct *wq)
3480{
3481}
3482
3483static void wq_unregister_lockdep(struct workqueue_struct *wq)
3484{
3485}
3486
3487static void wq_free_lockdep(struct workqueue_struct *wq)
3488{
3489}
3490#endif
3491
6ba94429 3492static void rcu_free_wq(struct rcu_head *rcu)
226223ab 3493{
6ba94429
FW
3494 struct workqueue_struct *wq =
3495 container_of(rcu, struct workqueue_struct, rcu);
226223ab 3496
669de8bd
BVA
3497 wq_free_lockdep(wq);
3498
6ba94429
FW
3499 if (!(wq->flags & WQ_UNBOUND))
3500 free_percpu(wq->cpu_pwqs);
226223ab 3501 else
6ba94429 3502 free_workqueue_attrs(wq->unbound_attrs);
226223ab 3503
6ba94429 3504 kfree(wq);
226223ab
TH
3505}
3506
6ba94429 3507static void rcu_free_pool(struct rcu_head *rcu)
226223ab 3508{
6ba94429 3509 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
226223ab 3510
6ba94429
FW
3511 ida_destroy(&pool->worker_ida);
3512 free_workqueue_attrs(pool->attrs);
3513 kfree(pool);
226223ab
TH
3514}
3515
d8bb65ab
SAS
3516/* This returns with the lock held on success (pool manager is inactive). */
3517static bool wq_manager_inactive(struct worker_pool *pool)
3518{
a9b8a985 3519 raw_spin_lock_irq(&pool->lock);
d8bb65ab
SAS
3520
3521 if (pool->flags & POOL_MANAGER_ACTIVE) {
a9b8a985 3522 raw_spin_unlock_irq(&pool->lock);
d8bb65ab
SAS
3523 return false;
3524 }
3525 return true;
3526}
3527
6ba94429
FW
3528/**
3529 * put_unbound_pool - put a worker_pool
3530 * @pool: worker_pool to put
3531 *
24acfb71 3532 * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU
6ba94429
FW
3533 * safe manner. get_unbound_pool() calls this function on its failure path
3534 * and this function should be able to release pools which went through,
3535 * successfully or not, init_worker_pool().
3536 *
3537 * Should be called with wq_pool_mutex held.
3538 */
3539static void put_unbound_pool(struct worker_pool *pool)
226223ab 3540{
6ba94429
FW
3541 DECLARE_COMPLETION_ONSTACK(detach_completion);
3542 struct worker *worker;
226223ab 3543
6ba94429 3544 lockdep_assert_held(&wq_pool_mutex);
226223ab 3545
6ba94429
FW
3546 if (--pool->refcnt)
3547 return;
226223ab 3548
6ba94429
FW
3549 /* sanity checks */
3550 if (WARN_ON(!(pool->cpu < 0)) ||
3551 WARN_ON(!list_empty(&pool->worklist)))
3552 return;
226223ab 3553
6ba94429
FW
3554 /* release id and unhash */
3555 if (pool->id >= 0)
3556 idr_remove(&worker_pool_idr, pool->id);
3557 hash_del(&pool->hash_node);
d55262c4 3558
6ba94429 3559 /*
692b4825
TH
3560 * Become the manager and destroy all workers. This prevents
3561 * @pool's workers from blocking on attach_mutex. We're the last
3562 * manager and @pool gets freed with the flag set.
d8bb65ab
SAS
3563 * Because of how wq_manager_inactive() works, we will hold the
3564 * spinlock after a successful wait.
6ba94429 3565 */
d8bb65ab
SAS
3566 rcuwait_wait_event(&manager_wait, wq_manager_inactive(pool),
3567 TASK_UNINTERRUPTIBLE);
692b4825
TH
3568 pool->flags |= POOL_MANAGER_ACTIVE;
3569
6ba94429
FW
3570 while ((worker = first_idle_worker(pool)))
3571 destroy_worker(worker);
3572 WARN_ON(pool->nr_workers || pool->nr_idle);
a9b8a985 3573 raw_spin_unlock_irq(&pool->lock);
d55262c4 3574
1258fae7 3575 mutex_lock(&wq_pool_attach_mutex);
6ba94429
FW
3576 if (!list_empty(&pool->workers))
3577 pool->detach_completion = &detach_completion;
1258fae7 3578 mutex_unlock(&wq_pool_attach_mutex);
226223ab 3579
6ba94429
FW
3580 if (pool->detach_completion)
3581 wait_for_completion(pool->detach_completion);
226223ab 3582
6ba94429
FW
3583 /* shut down the timers */
3584 del_timer_sync(&pool->idle_timer);
3585 del_timer_sync(&pool->mayday_timer);
226223ab 3586
24acfb71 3587 /* RCU protected to allow dereferences from get_work_pool() */
25b00775 3588 call_rcu(&pool->rcu, rcu_free_pool);
226223ab
TH
3589}
3590
3591/**
6ba94429
FW
3592 * get_unbound_pool - get a worker_pool with the specified attributes
3593 * @attrs: the attributes of the worker_pool to get
226223ab 3594 *
6ba94429
FW
3595 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3596 * reference count and return it. If there already is a matching
3597 * worker_pool, it will be used; otherwise, this function attempts to
3598 * create a new one.
226223ab 3599 *
6ba94429 3600 * Should be called with wq_pool_mutex held.
226223ab 3601 *
6ba94429
FW
3602 * Return: On success, a worker_pool with the same attributes as @attrs.
3603 * On failure, %NULL.
226223ab 3604 */
6ba94429 3605static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
226223ab 3606{
6ba94429
FW
3607 u32 hash = wqattrs_hash(attrs);
3608 struct worker_pool *pool;
3609 int node;
e2273584 3610 int target_node = NUMA_NO_NODE;
226223ab 3611
6ba94429 3612 lockdep_assert_held(&wq_pool_mutex);
226223ab 3613
6ba94429
FW
3614 /* do we already have a matching pool? */
3615 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3616 if (wqattrs_equal(pool->attrs, attrs)) {
3617 pool->refcnt++;
3618 return pool;
3619 }
3620 }
226223ab 3621
e2273584
XP
3622 /* if cpumask is contained inside a NUMA node, we belong to that node */
3623 if (wq_numa_enabled) {
3624 for_each_node(node) {
3625 if (cpumask_subset(attrs->cpumask,
3626 wq_numa_possible_cpumask[node])) {
3627 target_node = node;
3628 break;
3629 }
3630 }
3631 }
3632
6ba94429 3633 /* nope, create a new one */
e2273584 3634 pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
6ba94429
FW
3635 if (!pool || init_worker_pool(pool) < 0)
3636 goto fail;
3637
3638 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
3639 copy_workqueue_attrs(pool->attrs, attrs);
e2273584 3640 pool->node = target_node;
226223ab
TH
3641
3642 /*
6ba94429
FW
3643 * no_numa isn't a worker_pool attribute, always clear it. See
3644 * 'struct workqueue_attrs' comments for detail.
226223ab 3645 */
6ba94429 3646 pool->attrs->no_numa = false;
226223ab 3647
6ba94429
FW
3648 if (worker_pool_assign_id(pool) < 0)
3649 goto fail;
226223ab 3650
6ba94429 3651 /* create and start the initial worker */
3347fa09 3652 if (wq_online && !create_worker(pool))
6ba94429 3653 goto fail;
226223ab 3654
6ba94429
FW
3655 /* install */
3656 hash_add(unbound_pool_hash, &pool->hash_node, hash);
226223ab 3657
6ba94429
FW
3658 return pool;
3659fail:
3660 if (pool)
3661 put_unbound_pool(pool);
3662 return NULL;
226223ab 3663}
226223ab 3664
6ba94429 3665static void rcu_free_pwq(struct rcu_head *rcu)
7a4e344c 3666{
6ba94429
FW
3667 kmem_cache_free(pwq_cache,
3668 container_of(rcu, struct pool_workqueue, rcu));
7a4e344c
TH
3669}
3670
6ba94429
FW
3671/*
3672 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3673 * and needs to be destroyed.
7a4e344c 3674 */
6ba94429 3675static void pwq_unbound_release_workfn(struct work_struct *work)
7a4e344c 3676{
6ba94429
FW
3677 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3678 unbound_release_work);
3679 struct workqueue_struct *wq = pwq->wq;
3680 struct worker_pool *pool = pwq->pool;
3681 bool is_last;
7a4e344c 3682
6ba94429
FW
3683 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3684 return;
7a4e344c 3685
6ba94429
FW
3686 mutex_lock(&wq->mutex);
3687 list_del_rcu(&pwq->pwqs_node);
3688 is_last = list_empty(&wq->pwqs);
3689 mutex_unlock(&wq->mutex);
3690
3691 mutex_lock(&wq_pool_mutex);
3692 put_unbound_pool(pool);
3693 mutex_unlock(&wq_pool_mutex);
3694
25b00775 3695 call_rcu(&pwq->rcu, rcu_free_pwq);
7a4e344c 3696
2865a8fb 3697 /*
6ba94429
FW
3698 * If we're the last pwq going away, @wq is already dead and no one
3699 * is gonna access it anymore. Schedule RCU free.
2865a8fb 3700 */
669de8bd
BVA
3701 if (is_last) {
3702 wq_unregister_lockdep(wq);
25b00775 3703 call_rcu(&wq->rcu, rcu_free_wq);
669de8bd 3704 }
29c91e99
TH
3705}
3706
7a4e344c 3707/**
6ba94429
FW
3708 * pwq_adjust_max_active - update a pwq's max_active to the current setting
3709 * @pwq: target pool_workqueue
d185af30 3710 *
6ba94429
FW
3711 * If @pwq isn't freezing, set @pwq->max_active to the associated
3712 * workqueue's saved_max_active and activate delayed work items
3713 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
7a4e344c 3714 */
6ba94429 3715static void pwq_adjust_max_active(struct pool_workqueue *pwq)
4e1a1f9a 3716{
6ba94429
FW
3717 struct workqueue_struct *wq = pwq->wq;
3718 bool freezable = wq->flags & WQ_FREEZABLE;
3347fa09 3719 unsigned long flags;
4e1a1f9a 3720
6ba94429
FW
3721 /* for @wq->saved_max_active */
3722 lockdep_assert_held(&wq->mutex);
4e1a1f9a 3723
6ba94429
FW
3724 /* fast exit for non-freezable wqs */
3725 if (!freezable && pwq->max_active == wq->saved_max_active)
3726 return;
7a4e344c 3727
3347fa09 3728 /* this function can be called during early boot w/ irq disabled */
a9b8a985 3729 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
29c91e99 3730
6ba94429
FW
3731 /*
3732 * During [un]freezing, the caller is responsible for ensuring that
3733 * this function is called at least once after @workqueue_freezing
3734 * is updated and visible.
3735 */
3736 if (!freezable || !workqueue_freezing) {
01341fbd
YY
3737 bool kick = false;
3738
6ba94429 3739 pwq->max_active = wq->saved_max_active;
4e1a1f9a 3740
6ba94429 3741 while (!list_empty(&pwq->delayed_works) &&
01341fbd 3742 pwq->nr_active < pwq->max_active) {
6ba94429 3743 pwq_activate_first_delayed(pwq);
01341fbd
YY
3744 kick = true;
3745 }
e2dca7ad 3746
6ba94429
FW
3747 /*
3748 * Need to kick a worker after thawed or an unbound wq's
01341fbd
YY
3749 * max_active is bumped. In realtime scenarios, always kicking a
3750 * worker will cause interference on the isolated cpu cores, so
3751 * let's kick iff work items were activated.
6ba94429 3752 */
01341fbd
YY
3753 if (kick)
3754 wake_up_worker(pwq->pool);
6ba94429
FW
3755 } else {
3756 pwq->max_active = 0;
3757 }
e2dca7ad 3758
a9b8a985 3759 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
e2dca7ad
TH
3760}
3761
6ba94429
FW
3762/* initialize newly alloced @pwq which is associated with @wq and @pool */
3763static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3764 struct worker_pool *pool)
29c91e99 3765{
6ba94429 3766 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
29c91e99 3767
6ba94429
FW
3768 memset(pwq, 0, sizeof(*pwq));
3769
3770 pwq->pool = pool;
3771 pwq->wq = wq;
3772 pwq->flush_color = -1;
3773 pwq->refcnt = 1;
3774 INIT_LIST_HEAD(&pwq->delayed_works);
3775 INIT_LIST_HEAD(&pwq->pwqs_node);
3776 INIT_LIST_HEAD(&pwq->mayday_node);
3777 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
29c91e99
TH
3778}
3779
6ba94429
FW
3780/* sync @pwq with the current state of its associated wq and link it */
3781static void link_pwq(struct pool_workqueue *pwq)
29c91e99 3782{
6ba94429 3783 struct workqueue_struct *wq = pwq->wq;
29c91e99 3784
6ba94429 3785 lockdep_assert_held(&wq->mutex);
a892cacc 3786
6ba94429
FW
3787 /* may be called multiple times, ignore if already linked */
3788 if (!list_empty(&pwq->pwqs_node))
29c91e99 3789 return;
29c91e99 3790
6ba94429
FW
3791 /* set the matching work_color */
3792 pwq->work_color = wq->work_color;
29c91e99 3793
6ba94429
FW
3794 /* sync max_active to the current setting */
3795 pwq_adjust_max_active(pwq);
29c91e99 3796
6ba94429
FW
3797 /* link in @pwq */
3798 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3799}
29c91e99 3800
6ba94429
FW
3801/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3802static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3803 const struct workqueue_attrs *attrs)
3804{
3805 struct worker_pool *pool;
3806 struct pool_workqueue *pwq;
60f5a4bc 3807
6ba94429 3808 lockdep_assert_held(&wq_pool_mutex);
60f5a4bc 3809
6ba94429
FW
3810 pool = get_unbound_pool(attrs);
3811 if (!pool)
3812 return NULL;
60f5a4bc 3813
6ba94429
FW
3814 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3815 if (!pwq) {
3816 put_unbound_pool(pool);
3817 return NULL;
3818 }
29c91e99 3819
6ba94429
FW
3820 init_pwq(pwq, wq, pool);
3821 return pwq;
3822}
29c91e99 3823
29c91e99 3824/**
30186c6f 3825 * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
042f7df1 3826 * @attrs: the wq_attrs of the default pwq of the target workqueue
6ba94429
FW
3827 * @node: the target NUMA node
3828 * @cpu_going_down: if >= 0, the CPU to consider as offline
3829 * @cpumask: outarg, the resulting cpumask
29c91e99 3830 *
6ba94429
FW
3831 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3832 * @cpu_going_down is >= 0, that cpu is considered offline during
3833 * calculation. The result is stored in @cpumask.
a892cacc 3834 *
6ba94429
FW
3835 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3836 * enabled and @node has online CPUs requested by @attrs, the returned
3837 * cpumask is the intersection of the possible CPUs of @node and
3838 * @attrs->cpumask.
d185af30 3839 *
6ba94429
FW
3840 * The caller is responsible for ensuring that the cpumask of @node stays
3841 * stable.
3842 *
3843 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3844 * %false if equal.
29c91e99 3845 */
6ba94429
FW
3846static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3847 int cpu_going_down, cpumask_t *cpumask)
29c91e99 3848{
6ba94429
FW
3849 if (!wq_numa_enabled || attrs->no_numa)
3850 goto use_dfl;
29c91e99 3851
6ba94429
FW
3852 /* does @node have any online CPUs @attrs wants? */
3853 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3854 if (cpu_going_down >= 0)
3855 cpumask_clear_cpu(cpu_going_down, cpumask);
29c91e99 3856
6ba94429
FW
3857 if (cpumask_empty(cpumask))
3858 goto use_dfl;
4c16bd32
TH
3859
3860 /* yeap, return possible CPUs in @node that @attrs wants */
3861 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
1ad0f0a7
MB
3862
3863 if (cpumask_empty(cpumask)) {
3864 pr_warn_once("WARNING: workqueue cpumask: online intersect > "
3865 "possible intersect\n");
3866 return false;
3867 }
3868
4c16bd32
TH
3869 return !cpumask_equal(cpumask, attrs->cpumask);
3870
3871use_dfl:
3872 cpumask_copy(cpumask, attrs->cpumask);
3873 return false;
3874}
3875
1befcf30
TH
3876/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3877static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3878 int node,
3879 struct pool_workqueue *pwq)
3880{
3881 struct pool_workqueue *old_pwq;
3882
5b95e1af 3883 lockdep_assert_held(&wq_pool_mutex);
1befcf30
TH
3884 lockdep_assert_held(&wq->mutex);
3885
3886 /* link_pwq() can handle duplicate calls */
3887 link_pwq(pwq);
3888
3889 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3890 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3891 return old_pwq;
3892}
3893
2d5f0764
LJ
3894/* context to store the prepared attrs & pwqs before applying */
3895struct apply_wqattrs_ctx {
3896 struct workqueue_struct *wq; /* target workqueue */
3897 struct workqueue_attrs *attrs; /* attrs to apply */
042f7df1 3898 struct list_head list; /* queued for batching commit */
2d5f0764
LJ
3899 struct pool_workqueue *dfl_pwq;
3900 struct pool_workqueue *pwq_tbl[];
3901};
3902
3903/* free the resources after success or abort */
3904static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
3905{
3906 if (ctx) {
3907 int node;
3908
3909 for_each_node(node)
3910 put_pwq_unlocked(ctx->pwq_tbl[node]);
3911 put_pwq_unlocked(ctx->dfl_pwq);
3912
3913 free_workqueue_attrs(ctx->attrs);
3914
3915 kfree(ctx);
3916 }
3917}
3918
3919/* allocate the attrs and pwqs for later installation */
3920static struct apply_wqattrs_ctx *
3921apply_wqattrs_prepare(struct workqueue_struct *wq,
3922 const struct workqueue_attrs *attrs)
9e8cd2f5 3923{
2d5f0764 3924 struct apply_wqattrs_ctx *ctx;
4c16bd32 3925 struct workqueue_attrs *new_attrs, *tmp_attrs;
2d5f0764 3926 int node;
9e8cd2f5 3927
2d5f0764 3928 lockdep_assert_held(&wq_pool_mutex);
9e8cd2f5 3929
acafe7e3 3930 ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
8719dcea 3931
be69d00d
TG
3932 new_attrs = alloc_workqueue_attrs();
3933 tmp_attrs = alloc_workqueue_attrs();
2d5f0764
LJ
3934 if (!ctx || !new_attrs || !tmp_attrs)
3935 goto out_free;
13e2e556 3936
042f7df1
LJ
3937 /*
3938 * Calculate the attrs of the default pwq.
3939 * If the user configured cpumask doesn't overlap with the
3940 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3941 */
13e2e556 3942 copy_workqueue_attrs(new_attrs, attrs);
b05a7928 3943 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
042f7df1
LJ
3944 if (unlikely(cpumask_empty(new_attrs->cpumask)))
3945 cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
13e2e556 3946
4c16bd32
TH
3947 /*
3948 * We may create multiple pwqs with differing cpumasks. Make a
3949 * copy of @new_attrs which will be modified and used to obtain
3950 * pools.
3951 */
3952 copy_workqueue_attrs(tmp_attrs, new_attrs);
3953
4c16bd32
TH
3954 /*
3955 * If something goes wrong during CPU up/down, we'll fall back to
3956 * the default pwq covering whole @attrs->cpumask. Always create
3957 * it even if we don't use it immediately.
3958 */
2d5f0764
LJ
3959 ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3960 if (!ctx->dfl_pwq)
3961 goto out_free;
4c16bd32
TH
3962
3963 for_each_node(node) {
042f7df1 3964 if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
2d5f0764
LJ
3965 ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3966 if (!ctx->pwq_tbl[node])
3967 goto out_free;
4c16bd32 3968 } else {
2d5f0764
LJ
3969 ctx->dfl_pwq->refcnt++;
3970 ctx->pwq_tbl[node] = ctx->dfl_pwq;
4c16bd32
TH
3971 }
3972 }
3973
042f7df1
LJ
3974 /* save the user configured attrs and sanitize it. */
3975 copy_workqueue_attrs(new_attrs, attrs);
3976 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
2d5f0764 3977 ctx->attrs = new_attrs;
042f7df1 3978
2d5f0764
LJ
3979 ctx->wq = wq;
3980 free_workqueue_attrs(tmp_attrs);
3981 return ctx;
3982
3983out_free:
3984 free_workqueue_attrs(tmp_attrs);
3985 free_workqueue_attrs(new_attrs);
3986 apply_wqattrs_cleanup(ctx);
3987 return NULL;
3988}
3989
3990/* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
3991static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
3992{
3993 int node;
9e8cd2f5 3994
4c16bd32 3995 /* all pwqs have been created successfully, let's install'em */
2d5f0764 3996 mutex_lock(&ctx->wq->mutex);
a892cacc 3997
2d5f0764 3998 copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
4c16bd32
TH
3999
4000 /* save the previous pwq and install the new one */
f147f29e 4001 for_each_node(node)
2d5f0764
LJ
4002 ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
4003 ctx->pwq_tbl[node]);
4c16bd32
TH
4004
4005 /* @dfl_pwq might not have been used, ensure it's linked */
2d5f0764
LJ
4006 link_pwq(ctx->dfl_pwq);
4007 swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
f147f29e 4008
2d5f0764
LJ
4009 mutex_unlock(&ctx->wq->mutex);
4010}
9e8cd2f5 4011
a0111cf6
LJ
4012static void apply_wqattrs_lock(void)
4013{
4014 /* CPUs should stay stable across pwq creations and installations */
4015 get_online_cpus();
4016 mutex_lock(&wq_pool_mutex);
4017}
4018
4019static void apply_wqattrs_unlock(void)
4020{
4021 mutex_unlock(&wq_pool_mutex);
4022 put_online_cpus();
4023}
4024
4025static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4026 const struct workqueue_attrs *attrs)
2d5f0764
LJ
4027{
4028 struct apply_wqattrs_ctx *ctx;
4c16bd32 4029
2d5f0764
LJ
4030 /* only unbound workqueues can change attributes */
4031 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4032 return -EINVAL;
13e2e556 4033
2d5f0764 4034 /* creating multiple pwqs breaks ordering guarantee */
0a94efb5
TH
4035 if (!list_empty(&wq->pwqs)) {
4036 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4037 return -EINVAL;
4038
4039 wq->flags &= ~__WQ_ORDERED;
4040 }
2d5f0764 4041
2d5f0764 4042 ctx = apply_wqattrs_prepare(wq, attrs);
6201171e 4043 if (!ctx)
4044 return -ENOMEM;
2d5f0764
LJ
4045
4046 /* the ctx has been prepared successfully, let's commit it */
6201171e 4047 apply_wqattrs_commit(ctx);
2d5f0764
LJ
4048 apply_wqattrs_cleanup(ctx);
4049
6201171e 4050 return 0;
9e8cd2f5
TH
4051}
4052
a0111cf6
LJ
4053/**
4054 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
4055 * @wq: the target workqueue
4056 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
4057 *
4058 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
4059 * machines, this function maps a separate pwq to each NUMA node with
4060 * possibles CPUs in @attrs->cpumask so that work items are affine to the
4061 * NUMA node it was issued on. Older pwqs are released as in-flight work
4062 * items finish. Note that a work item which repeatedly requeues itself
4063 * back-to-back will stay on its current pwq.
4064 *
4065 * Performs GFP_KERNEL allocations.
4066 *
509b3204
DJ
4067 * Assumes caller has CPU hotplug read exclusion, i.e. get_online_cpus().
4068 *
a0111cf6
LJ
4069 * Return: 0 on success and -errno on failure.
4070 */
513c98d0 4071int apply_workqueue_attrs(struct workqueue_struct *wq,
a0111cf6
LJ
4072 const struct workqueue_attrs *attrs)
4073{
4074 int ret;
4075
509b3204
DJ
4076 lockdep_assert_cpus_held();
4077
4078 mutex_lock(&wq_pool_mutex);
a0111cf6 4079 ret = apply_workqueue_attrs_locked(wq, attrs);
509b3204 4080 mutex_unlock(&wq_pool_mutex);
a0111cf6
LJ
4081
4082 return ret;
4083}
4084
4c16bd32
TH
4085/**
4086 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
4087 * @wq: the target workqueue
4088 * @cpu: the CPU coming up or going down
4089 * @online: whether @cpu is coming up or going down
4090 *
4091 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4092 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
4093 * @wq accordingly.
4094 *
4095 * If NUMA affinity can't be adjusted due to memory allocation failure, it
4096 * falls back to @wq->dfl_pwq which may not be optimal but is always
4097 * correct.
4098 *
4099 * Note that when the last allowed CPU of a NUMA node goes offline for a
4100 * workqueue with a cpumask spanning multiple nodes, the workers which were
4101 * already executing the work items for the workqueue will lose their CPU
4102 * affinity and may execute on any CPU. This is similar to how per-cpu
4103 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
4104 * affinity, it's the user's responsibility to flush the work item from
4105 * CPU_DOWN_PREPARE.
4106 */
4107static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4108 bool online)
4109{
4110 int node = cpu_to_node(cpu);
4111 int cpu_off = online ? -1 : cpu;
4112 struct pool_workqueue *old_pwq = NULL, *pwq;
4113 struct workqueue_attrs *target_attrs;
4114 cpumask_t *cpumask;
4115
4116 lockdep_assert_held(&wq_pool_mutex);
4117
f7142ed4
LJ
4118 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4119 wq->unbound_attrs->no_numa)
4c16bd32
TH
4120 return;
4121
4122 /*
4123 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4124 * Let's use a preallocated one. The following buf is protected by
4125 * CPU hotplug exclusion.
4126 */
4127 target_attrs = wq_update_unbound_numa_attrs_buf;
4128 cpumask = target_attrs->cpumask;
4129
4c16bd32
TH
4130 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4131 pwq = unbound_pwq_by_node(wq, node);
4132
4133 /*
4134 * Let's determine what needs to be done. If the target cpumask is
042f7df1
LJ
4135 * different from the default pwq's, we need to compare it to @pwq's
4136 * and create a new one if they don't match. If the target cpumask
4137 * equals the default pwq's, the default pwq should be used.
4c16bd32 4138 */
042f7df1 4139 if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
4c16bd32 4140 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
f7142ed4 4141 return;
4c16bd32 4142 } else {
534a3fbb 4143 goto use_dfl_pwq;
4c16bd32
TH
4144 }
4145
4c16bd32
TH
4146 /* create a new pwq */
4147 pwq = alloc_unbound_pwq(wq, target_attrs);
4148 if (!pwq) {
2d916033
FF
4149 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4150 wq->name);
77f300b1 4151 goto use_dfl_pwq;
4c16bd32
TH
4152 }
4153
f7142ed4 4154 /* Install the new pwq. */
4c16bd32
TH
4155 mutex_lock(&wq->mutex);
4156 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4157 goto out_unlock;
4158
4159use_dfl_pwq:
f7142ed4 4160 mutex_lock(&wq->mutex);
a9b8a985 4161 raw_spin_lock_irq(&wq->dfl_pwq->pool->lock);
4c16bd32 4162 get_pwq(wq->dfl_pwq);
a9b8a985 4163 raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4c16bd32
TH
4164 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4165out_unlock:
4166 mutex_unlock(&wq->mutex);
4167 put_pwq_unlocked(old_pwq);
4168}
4169
30cdf249 4170static int alloc_and_link_pwqs(struct workqueue_struct *wq)
0f900049 4171{
49e3cf44 4172 bool highpri = wq->flags & WQ_HIGHPRI;
8a2b7538 4173 int cpu, ret;
30cdf249
TH
4174
4175 if (!(wq->flags & WQ_UNBOUND)) {
420c0ddb
TH
4176 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4177 if (!wq->cpu_pwqs)
30cdf249
TH
4178 return -ENOMEM;
4179
4180 for_each_possible_cpu(cpu) {
7fb98ea7
TH
4181 struct pool_workqueue *pwq =
4182 per_cpu_ptr(wq->cpu_pwqs, cpu);
7a62c2c8 4183 struct worker_pool *cpu_pools =
f02ae73a 4184 per_cpu(cpu_worker_pools, cpu);
f3421797 4185
f147f29e
TH
4186 init_pwq(pwq, wq, &cpu_pools[highpri]);
4187
4188 mutex_lock(&wq->mutex);
1befcf30 4189 link_pwq(pwq);
f147f29e 4190 mutex_unlock(&wq->mutex);
30cdf249 4191 }
9e8cd2f5 4192 return 0;
509b3204
DJ
4193 }
4194
4195 get_online_cpus();
4196 if (wq->flags & __WQ_ORDERED) {
8a2b7538
TH
4197 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4198 /* there should only be single pwq for ordering guarantee */
4199 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4200 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4201 "ordering guarantee broken for workqueue %s\n", wq->name);
30cdf249 4202 } else {
509b3204 4203 ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
30cdf249 4204 }
509b3204
DJ
4205 put_online_cpus();
4206
4207 return ret;
0f900049
TH
4208}
4209
f3421797
TH
4210static int wq_clamp_max_active(int max_active, unsigned int flags,
4211 const char *name)
b71ab8c2 4212{
f3421797
TH
4213 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4214
4215 if (max_active < 1 || max_active > lim)
044c782c
VI
4216 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4217 max_active, name, 1, lim);
b71ab8c2 4218
f3421797 4219 return clamp_val(max_active, 1, lim);
b71ab8c2
TH
4220}
4221
983c7515
TH
4222/*
4223 * Workqueues which may be used during memory reclaim should have a rescuer
4224 * to guarantee forward progress.
4225 */
4226static int init_rescuer(struct workqueue_struct *wq)
4227{
4228 struct worker *rescuer;
b92b36ea 4229 int ret;
983c7515
TH
4230
4231 if (!(wq->flags & WQ_MEM_RECLAIM))
4232 return 0;
4233
4234 rescuer = alloc_worker(NUMA_NO_NODE);
4235 if (!rescuer)
4236 return -ENOMEM;
4237
4238 rescuer->rescue_wq = wq;
4239 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
f187b697 4240 if (IS_ERR(rescuer->task)) {
b92b36ea 4241 ret = PTR_ERR(rescuer->task);
983c7515 4242 kfree(rescuer);
b92b36ea 4243 return ret;
983c7515
TH
4244 }
4245
4246 wq->rescuer = rescuer;
4247 kthread_bind_mask(rescuer->task, cpu_possible_mask);
4248 wake_up_process(rescuer->task);
4249
4250 return 0;
4251}
4252
a2775bbc 4253__printf(1, 4)
669de8bd
BVA
4254struct workqueue_struct *alloc_workqueue(const char *fmt,
4255 unsigned int flags,
4256 int max_active, ...)
1da177e4 4257{
df2d5ae4 4258 size_t tbl_size = 0;
ecf6881f 4259 va_list args;
1da177e4 4260 struct workqueue_struct *wq;
49e3cf44 4261 struct pool_workqueue *pwq;
b196be89 4262
5c0338c6
TH
4263 /*
4264 * Unbound && max_active == 1 used to imply ordered, which is no
4265 * longer the case on NUMA machines due to per-node pools. While
4266 * alloc_ordered_workqueue() is the right way to create an ordered
4267 * workqueue, keep the previous behavior to avoid subtle breakages
4268 * on NUMA.
4269 */
4270 if ((flags & WQ_UNBOUND) && max_active == 1)
4271 flags |= __WQ_ORDERED;
4272
cee22a15
VK
4273 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4274 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4275 flags |= WQ_UNBOUND;
4276
ecf6881f 4277 /* allocate wq and format name */
df2d5ae4 4278 if (flags & WQ_UNBOUND)
ddcb57e2 4279 tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
df2d5ae4
TH
4280
4281 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
b196be89 4282 if (!wq)
d2c1d404 4283 return NULL;
b196be89 4284
6029a918 4285 if (flags & WQ_UNBOUND) {
be69d00d 4286 wq->unbound_attrs = alloc_workqueue_attrs();
6029a918
TH
4287 if (!wq->unbound_attrs)
4288 goto err_free_wq;
4289 }
4290
669de8bd 4291 va_start(args, max_active);
ecf6881f 4292 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
b196be89 4293 va_end(args);
1da177e4 4294
d320c038 4295 max_active = max_active ?: WQ_DFL_ACTIVE;
b196be89 4296 max_active = wq_clamp_max_active(max_active, flags, wq->name);
3af24433 4297
b196be89 4298 /* init wq */
97e37d7b 4299 wq->flags = flags;
a0a1a5fd 4300 wq->saved_max_active = max_active;
3c25a55d 4301 mutex_init(&wq->mutex);
112202d9 4302 atomic_set(&wq->nr_pwqs_to_flush, 0);
30cdf249 4303 INIT_LIST_HEAD(&wq->pwqs);
73f53c4a
TH
4304 INIT_LIST_HEAD(&wq->flusher_queue);
4305 INIT_LIST_HEAD(&wq->flusher_overflow);
493a1724 4306 INIT_LIST_HEAD(&wq->maydays);
502ca9d8 4307
669de8bd 4308 wq_init_lockdep(wq);
cce1a165 4309 INIT_LIST_HEAD(&wq->list);
3af24433 4310
30cdf249 4311 if (alloc_and_link_pwqs(wq) < 0)
82efcab3 4312 goto err_unreg_lockdep;
1537663f 4313
40c17f75 4314 if (wq_online && init_rescuer(wq) < 0)
983c7515 4315 goto err_destroy;
3af24433 4316
226223ab
TH
4317 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4318 goto err_destroy;
4319
a0a1a5fd 4320 /*
68e13a67
LJ
4321 * wq_pool_mutex protects global freeze state and workqueues list.
4322 * Grab it, adjust max_active and add the new @wq to workqueues
4323 * list.
a0a1a5fd 4324 */
68e13a67 4325 mutex_lock(&wq_pool_mutex);
a0a1a5fd 4326
a357fc03 4327 mutex_lock(&wq->mutex);
699ce097
TH
4328 for_each_pwq(pwq, wq)
4329 pwq_adjust_max_active(pwq);
a357fc03 4330 mutex_unlock(&wq->mutex);
a0a1a5fd 4331
e2dca7ad 4332 list_add_tail_rcu(&wq->list, &workqueues);
a0a1a5fd 4333
68e13a67 4334 mutex_unlock(&wq_pool_mutex);
1537663f 4335
3af24433 4336 return wq;
d2c1d404 4337
82efcab3 4338err_unreg_lockdep:
009bb421
BVA
4339 wq_unregister_lockdep(wq);
4340 wq_free_lockdep(wq);
82efcab3 4341err_free_wq:
6029a918 4342 free_workqueue_attrs(wq->unbound_attrs);
d2c1d404
TH
4343 kfree(wq);
4344 return NULL;
4345err_destroy:
4346 destroy_workqueue(wq);
4690c4ab 4347 return NULL;
3af24433 4348}
669de8bd 4349EXPORT_SYMBOL_GPL(alloc_workqueue);
1da177e4 4350
c29eb853
TH
4351static bool pwq_busy(struct pool_workqueue *pwq)
4352{
4353 int i;
4354
4355 for (i = 0; i < WORK_NR_COLORS; i++)
4356 if (pwq->nr_in_flight[i])
4357 return true;
4358
4359 if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4360 return true;
4361 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4362 return true;
4363
4364 return false;
4365}
4366
3af24433
ON
4367/**
4368 * destroy_workqueue - safely terminate a workqueue
4369 * @wq: target workqueue
4370 *
4371 * Safely destroy a workqueue. All work currently pending will be done first.
4372 */
4373void destroy_workqueue(struct workqueue_struct *wq)
4374{
49e3cf44 4375 struct pool_workqueue *pwq;
4c16bd32 4376 int node;
3af24433 4377
def98c84
TH
4378 /*
4379 * Remove it from sysfs first so that sanity check failure doesn't
4380 * lead to sysfs name conflicts.
4381 */
4382 workqueue_sysfs_unregister(wq);
4383
9c5a2ba7
TH
4384 /* drain it before proceeding with destruction */
4385 drain_workqueue(wq);
c8efcc25 4386
def98c84
TH
4387 /* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4388 if (wq->rescuer) {
4389 struct worker *rescuer = wq->rescuer;
4390
4391 /* this prevents new queueing */
a9b8a985 4392 raw_spin_lock_irq(&wq_mayday_lock);
def98c84 4393 wq->rescuer = NULL;
a9b8a985 4394 raw_spin_unlock_irq(&wq_mayday_lock);
def98c84
TH
4395
4396 /* rescuer will empty maydays list before exiting */
4397 kthread_stop(rescuer->task);
8efe1223 4398 kfree(rescuer);
def98c84
TH
4399 }
4400
c29eb853
TH
4401 /*
4402 * Sanity checks - grab all the locks so that we wait for all
4403 * in-flight operations which may do put_pwq().
4404 */
4405 mutex_lock(&wq_pool_mutex);
b09f4fd3 4406 mutex_lock(&wq->mutex);
49e3cf44 4407 for_each_pwq(pwq, wq) {
a9b8a985 4408 raw_spin_lock_irq(&pwq->pool->lock);
c29eb853 4409 if (WARN_ON(pwq_busy(pwq))) {
1d9a6159
KW
4410 pr_warn("%s: %s has the following busy pwq\n",
4411 __func__, wq->name);
c29eb853 4412 show_pwq(pwq);
a9b8a985 4413 raw_spin_unlock_irq(&pwq->pool->lock);
b09f4fd3 4414 mutex_unlock(&wq->mutex);
c29eb853 4415 mutex_unlock(&wq_pool_mutex);
fa07fb6a 4416 show_workqueue_state();
6183c009 4417 return;
76af4d93 4418 }
a9b8a985 4419 raw_spin_unlock_irq(&pwq->pool->lock);
6183c009 4420 }
b09f4fd3 4421 mutex_unlock(&wq->mutex);
6183c009 4422
a0a1a5fd
TH
4423 /*
4424 * wq list is used to freeze wq, remove from list after
4425 * flushing is complete in case freeze races us.
4426 */
e2dca7ad 4427 list_del_rcu(&wq->list);
68e13a67 4428 mutex_unlock(&wq_pool_mutex);
3af24433 4429
8864b4e5 4430 if (!(wq->flags & WQ_UNBOUND)) {
669de8bd 4431 wq_unregister_lockdep(wq);
8864b4e5
TH
4432 /*
4433 * The base ref is never dropped on per-cpu pwqs. Directly
e2dca7ad 4434 * schedule RCU free.
8864b4e5 4435 */
25b00775 4436 call_rcu(&wq->rcu, rcu_free_wq);
8864b4e5
TH
4437 } else {
4438 /*
4439 * We're the sole accessor of @wq at this point. Directly
4c16bd32
TH
4440 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4441 * @wq will be freed when the last pwq is released.
8864b4e5 4442 */
4c16bd32
TH
4443 for_each_node(node) {
4444 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4445 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4446 put_pwq_unlocked(pwq);
4447 }
4448
4449 /*
4450 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4451 * put. Don't access it afterwards.
4452 */
4453 pwq = wq->dfl_pwq;
4454 wq->dfl_pwq = NULL;
dce90d47 4455 put_pwq_unlocked(pwq);
29c91e99 4456 }
3af24433
ON
4457}
4458EXPORT_SYMBOL_GPL(destroy_workqueue);
4459
dcd989cb
TH
4460/**
4461 * workqueue_set_max_active - adjust max_active of a workqueue
4462 * @wq: target workqueue
4463 * @max_active: new max_active value.
4464 *
4465 * Set max_active of @wq to @max_active.
4466 *
4467 * CONTEXT:
4468 * Don't call from IRQ context.
4469 */
4470void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4471{
49e3cf44 4472 struct pool_workqueue *pwq;
dcd989cb 4473
8719dcea 4474 /* disallow meddling with max_active for ordered workqueues */
0a94efb5 4475 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
8719dcea
TH
4476 return;
4477
f3421797 4478 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
dcd989cb 4479
a357fc03 4480 mutex_lock(&wq->mutex);
dcd989cb 4481
0a94efb5 4482 wq->flags &= ~__WQ_ORDERED;
dcd989cb
TH
4483 wq->saved_max_active = max_active;
4484
699ce097
TH
4485 for_each_pwq(pwq, wq)
4486 pwq_adjust_max_active(pwq);
93981800 4487
a357fc03 4488 mutex_unlock(&wq->mutex);
15316ba8 4489}
dcd989cb 4490EXPORT_SYMBOL_GPL(workqueue_set_max_active);
15316ba8 4491
27d4ee03
LW
4492/**
4493 * current_work - retrieve %current task's work struct
4494 *
4495 * Determine if %current task is a workqueue worker and what it's working on.
4496 * Useful to find out the context that the %current task is running in.
4497 *
4498 * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
4499 */
4500struct work_struct *current_work(void)
4501{
4502 struct worker *worker = current_wq_worker();
4503
4504 return worker ? worker->current_work : NULL;
4505}
4506EXPORT_SYMBOL(current_work);
4507
e6267616
TH
4508/**
4509 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4510 *
4511 * Determine whether %current is a workqueue rescuer. Can be used from
4512 * work functions to determine whether it's being run off the rescuer task.
d185af30
YB
4513 *
4514 * Return: %true if %current is a workqueue rescuer. %false otherwise.
e6267616
TH
4515 */
4516bool current_is_workqueue_rescuer(void)
4517{
4518 struct worker *worker = current_wq_worker();
4519
6a092dfd 4520 return worker && worker->rescue_wq;
e6267616
TH
4521}
4522
eef6a7d5 4523/**
dcd989cb
TH
4524 * workqueue_congested - test whether a workqueue is congested
4525 * @cpu: CPU in question
4526 * @wq: target workqueue
eef6a7d5 4527 *
dcd989cb
TH
4528 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4529 * no synchronization around this function and the test result is
4530 * unreliable and only useful as advisory hints or for debugging.
eef6a7d5 4531 *
d3251859
TH
4532 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4533 * Note that both per-cpu and unbound workqueues may be associated with
4534 * multiple pool_workqueues which have separate congested states. A
4535 * workqueue being congested on one CPU doesn't mean the workqueue is also
4536 * contested on other CPUs / NUMA nodes.
4537 *
d185af30 4538 * Return:
dcd989cb 4539 * %true if congested, %false otherwise.
eef6a7d5 4540 */
d84ff051 4541bool workqueue_congested(int cpu, struct workqueue_struct *wq)
1da177e4 4542{
7fb98ea7 4543 struct pool_workqueue *pwq;
76af4d93
TH
4544 bool ret;
4545
24acfb71
TG
4546 rcu_read_lock();
4547 preempt_disable();
7fb98ea7 4548
d3251859
TH
4549 if (cpu == WORK_CPU_UNBOUND)
4550 cpu = smp_processor_id();
4551
7fb98ea7
TH
4552 if (!(wq->flags & WQ_UNBOUND))
4553 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4554 else
df2d5ae4 4555 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
dcd989cb 4556
76af4d93 4557 ret = !list_empty(&pwq->delayed_works);
24acfb71
TG
4558 preempt_enable();
4559 rcu_read_unlock();
76af4d93
TH
4560
4561 return ret;
1da177e4 4562}
dcd989cb 4563EXPORT_SYMBOL_GPL(workqueue_congested);
1da177e4 4564
dcd989cb
TH
4565/**
4566 * work_busy - test whether a work is currently pending or running
4567 * @work: the work to be tested
4568 *
4569 * Test whether @work is currently pending or running. There is no
4570 * synchronization around this function and the test result is
4571 * unreliable and only useful as advisory hints or for debugging.
dcd989cb 4572 *
d185af30 4573 * Return:
dcd989cb
TH
4574 * OR'd bitmask of WORK_BUSY_* bits.
4575 */
4576unsigned int work_busy(struct work_struct *work)
1da177e4 4577{
fa1b54e6 4578 struct worker_pool *pool;
dcd989cb
TH
4579 unsigned long flags;
4580 unsigned int ret = 0;
1da177e4 4581
dcd989cb
TH
4582 if (work_pending(work))
4583 ret |= WORK_BUSY_PENDING;
1da177e4 4584
24acfb71 4585 rcu_read_lock();
fa1b54e6 4586 pool = get_work_pool(work);
038366c5 4587 if (pool) {
a9b8a985 4588 raw_spin_lock_irqsave(&pool->lock, flags);
038366c5
LJ
4589 if (find_worker_executing_work(pool, work))
4590 ret |= WORK_BUSY_RUNNING;
a9b8a985 4591 raw_spin_unlock_irqrestore(&pool->lock, flags);
038366c5 4592 }
24acfb71 4593 rcu_read_unlock();
1da177e4 4594
dcd989cb 4595 return ret;
1da177e4 4596}
dcd989cb 4597EXPORT_SYMBOL_GPL(work_busy);
1da177e4 4598
3d1cb205
TH
4599/**
4600 * set_worker_desc - set description for the current work item
4601 * @fmt: printf-style format string
4602 * @...: arguments for the format string
4603 *
4604 * This function can be called by a running work function to describe what
4605 * the work item is about. If the worker task gets dumped, this
4606 * information will be printed out together to help debugging. The
4607 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4608 */
4609void set_worker_desc(const char *fmt, ...)
4610{
4611 struct worker *worker = current_wq_worker();
4612 va_list args;
4613
4614 if (worker) {
4615 va_start(args, fmt);
4616 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4617 va_end(args);
3d1cb205
TH
4618 }
4619}
5c750d58 4620EXPORT_SYMBOL_GPL(set_worker_desc);
3d1cb205
TH
4621
4622/**
4623 * print_worker_info - print out worker information and description
4624 * @log_lvl: the log level to use when printing
4625 * @task: target task
4626 *
4627 * If @task is a worker and currently executing a work item, print out the
4628 * name of the workqueue being serviced and worker description set with
4629 * set_worker_desc() by the currently executing work item.
4630 *
4631 * This function can be safely called on any task as long as the
4632 * task_struct itself is accessible. While safe, this function isn't
4633 * synchronized and may print out mixups or garbages of limited length.
4634 */
4635void print_worker_info(const char *log_lvl, struct task_struct *task)
4636{
4637 work_func_t *fn = NULL;
4638 char name[WQ_NAME_LEN] = { };
4639 char desc[WORKER_DESC_LEN] = { };
4640 struct pool_workqueue *pwq = NULL;
4641 struct workqueue_struct *wq = NULL;
3d1cb205
TH
4642 struct worker *worker;
4643
4644 if (!(task->flags & PF_WQ_WORKER))
4645 return;
4646
4647 /*
4648 * This function is called without any synchronization and @task
4649 * could be in any state. Be careful with dereferences.
4650 */
e700591a 4651 worker = kthread_probe_data(task);
3d1cb205
TH
4652
4653 /*
8bf89593
TH
4654 * Carefully copy the associated workqueue's workfn, name and desc.
4655 * Keep the original last '\0' in case the original is garbage.
3d1cb205 4656 */
fe557319
CH
4657 copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
4658 copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
4659 copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
4660 copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
4661 copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
3d1cb205
TH
4662
4663 if (fn || name[0] || desc[0]) {
d75f773c 4664 printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
8bf89593 4665 if (strcmp(name, desc))
3d1cb205
TH
4666 pr_cont(" (%s)", desc);
4667 pr_cont("\n");
4668 }
4669}
4670
3494fc30
TH
4671static void pr_cont_pool_info(struct worker_pool *pool)
4672{
4673 pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
4674 if (pool->node != NUMA_NO_NODE)
4675 pr_cont(" node=%d", pool->node);
4676 pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
4677}
4678
4679static void pr_cont_work(bool comma, struct work_struct *work)
4680{
4681 if (work->func == wq_barrier_func) {
4682 struct wq_barrier *barr;
4683
4684 barr = container_of(work, struct wq_barrier, work);
4685
4686 pr_cont("%s BAR(%d)", comma ? "," : "",
4687 task_pid_nr(barr->task));
4688 } else {
d75f773c 4689 pr_cont("%s %ps", comma ? "," : "", work->func);
3494fc30
TH
4690 }
4691}
4692
4693static void show_pwq(struct pool_workqueue *pwq)
4694{
4695 struct worker_pool *pool = pwq->pool;
4696 struct work_struct *work;
4697 struct worker *worker;
4698 bool has_in_flight = false, has_pending = false;
4699 int bkt;
4700
4701 pr_info(" pwq %d:", pool->id);
4702 pr_cont_pool_info(pool);
4703
e66b39af
TH
4704 pr_cont(" active=%d/%d refcnt=%d%s\n",
4705 pwq->nr_active, pwq->max_active, pwq->refcnt,
3494fc30
TH
4706 !list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
4707
4708 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4709 if (worker->current_pwq == pwq) {
4710 has_in_flight = true;
4711 break;
4712 }
4713 }
4714 if (has_in_flight) {
4715 bool comma = false;
4716
4717 pr_info(" in-flight:");
4718 hash_for_each(pool->busy_hash, bkt, worker, hentry) {
4719 if (worker->current_pwq != pwq)
4720 continue;
4721
d75f773c 4722 pr_cont("%s %d%s:%ps", comma ? "," : "",
3494fc30 4723 task_pid_nr(worker->task),
30ae2fc0 4724 worker->rescue_wq ? "(RESCUER)" : "",
3494fc30
TH
4725 worker->current_func);
4726 list_for_each_entry(work, &worker->scheduled, entry)
4727 pr_cont_work(false, work);
4728 comma = true;
4729 }
4730 pr_cont("\n");
4731 }
4732
4733 list_for_each_entry(work, &pool->worklist, entry) {
4734 if (get_work_pwq(work) == pwq) {
4735 has_pending = true;
4736 break;
4737 }
4738 }
4739 if (has_pending) {
4740 bool comma = false;
4741
4742 pr_info(" pending:");
4743 list_for_each_entry(work, &pool->worklist, entry) {
4744 if (get_work_pwq(work) != pwq)
4745 continue;
4746
4747 pr_cont_work(comma, work);
4748 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4749 }
4750 pr_cont("\n");
4751 }
4752
4753 if (!list_empty(&pwq->delayed_works)) {
4754 bool comma = false;
4755
4756 pr_info(" delayed:");
4757 list_for_each_entry(work, &pwq->delayed_works, entry) {
4758 pr_cont_work(comma, work);
4759 comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
4760 }
4761 pr_cont("\n");
4762 }
4763}
4764
4765/**
4766 * show_workqueue_state - dump workqueue state
4767 *
7b776af6
RL
4768 * Called from a sysrq handler or try_to_freeze_tasks() and prints out
4769 * all busy workqueues and pools.
3494fc30
TH
4770 */
4771void show_workqueue_state(void)
4772{
4773 struct workqueue_struct *wq;
4774 struct worker_pool *pool;
4775 unsigned long flags;
4776 int pi;
4777
24acfb71 4778 rcu_read_lock();
3494fc30
TH
4779
4780 pr_info("Showing busy workqueues and worker pools:\n");
4781
4782 list_for_each_entry_rcu(wq, &workqueues, list) {
4783 struct pool_workqueue *pwq;
4784 bool idle = true;
4785
4786 for_each_pwq(pwq, wq) {
4787 if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
4788 idle = false;
4789 break;
4790 }
4791 }
4792 if (idle)
4793 continue;
4794
4795 pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
4796
4797 for_each_pwq(pwq, wq) {
a9b8a985 4798 raw_spin_lock_irqsave(&pwq->pool->lock, flags);
3494fc30
TH
4799 if (pwq->nr_active || !list_empty(&pwq->delayed_works))
4800 show_pwq(pwq);
a9b8a985 4801 raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
62635ea8
SS
4802 /*
4803 * We could be printing a lot from atomic context, e.g.
4804 * sysrq-t -> show_workqueue_state(). Avoid triggering
4805 * hard lockup.
4806 */
4807 touch_nmi_watchdog();
3494fc30
TH
4808 }
4809 }
4810
4811 for_each_pool(pool, pi) {
4812 struct worker *worker;
4813 bool first = true;
4814
a9b8a985 4815 raw_spin_lock_irqsave(&pool->lock, flags);
3494fc30
TH
4816 if (pool->nr_workers == pool->nr_idle)
4817 goto next_pool;
4818
4819 pr_info("pool %d:", pool->id);
4820 pr_cont_pool_info(pool);
82607adc
TH
4821 pr_cont(" hung=%us workers=%d",
4822 jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
4823 pool->nr_workers);
3494fc30
TH
4824 if (pool->manager)
4825 pr_cont(" manager: %d",
4826 task_pid_nr(pool->manager->task));
4827 list_for_each_entry(worker, &pool->idle_list, entry) {
4828 pr_cont(" %s%d", first ? "idle: " : "",
4829 task_pid_nr(worker->task));
4830 first = false;
4831 }
4832 pr_cont("\n");
4833 next_pool:
a9b8a985 4834 raw_spin_unlock_irqrestore(&pool->lock, flags);
62635ea8
SS
4835 /*
4836 * We could be printing a lot from atomic context, e.g.
4837 * sysrq-t -> show_workqueue_state(). Avoid triggering
4838 * hard lockup.
4839 */
4840 touch_nmi_watchdog();
3494fc30
TH
4841 }
4842
24acfb71 4843 rcu_read_unlock();
3494fc30
TH
4844}
4845
6b59808b
TH
4846/* used to show worker information through /proc/PID/{comm,stat,status} */
4847void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
4848{
6b59808b
TH
4849 int off;
4850
4851 /* always show the actual comm */
4852 off = strscpy(buf, task->comm, size);
4853 if (off < 0)
4854 return;
4855
197f6acc 4856 /* stabilize PF_WQ_WORKER and worker pool association */
6b59808b
TH
4857 mutex_lock(&wq_pool_attach_mutex);
4858
197f6acc
TH
4859 if (task->flags & PF_WQ_WORKER) {
4860 struct worker *worker = kthread_data(task);
4861 struct worker_pool *pool = worker->pool;
6b59808b 4862
197f6acc 4863 if (pool) {
a9b8a985 4864 raw_spin_lock_irq(&pool->lock);
197f6acc
TH
4865 /*
4866 * ->desc tracks information (wq name or
4867 * set_worker_desc()) for the latest execution. If
4868 * current, prepend '+', otherwise '-'.
4869 */
4870 if (worker->desc[0] != '\0') {
4871 if (worker->current_work)
4872 scnprintf(buf + off, size - off, "+%s",
4873 worker->desc);
4874 else
4875 scnprintf(buf + off, size - off, "-%s",
4876 worker->desc);
4877 }
a9b8a985 4878 raw_spin_unlock_irq(&pool->lock);
6b59808b 4879 }
6b59808b
TH
4880 }
4881
4882 mutex_unlock(&wq_pool_attach_mutex);
4883}
4884
66448bc2
MM
4885#ifdef CONFIG_SMP
4886
db7bccf4
TH
4887/*
4888 * CPU hotplug.
4889 *
e22bee78 4890 * There are two challenges in supporting CPU hotplug. Firstly, there
112202d9 4891 * are a lot of assumptions on strong associations among work, pwq and
706026c2 4892 * pool which make migrating pending and scheduled works very
e22bee78 4893 * difficult to implement without impacting hot paths. Secondly,
94cf58bb 4894 * worker pools serve mix of short, long and very long running works making
e22bee78
TH
4895 * blocked draining impractical.
4896 *
24647570 4897 * This is solved by allowing the pools to be disassociated from the CPU
628c78e7
TH
4898 * running as an unbound one and allowing it to be reattached later if the
4899 * cpu comes back online.
db7bccf4 4900 */
1da177e4 4901
e8b3f8db 4902static void unbind_workers(int cpu)
3af24433 4903{
4ce62e9e 4904 struct worker_pool *pool;
db7bccf4 4905 struct worker *worker;
3af24433 4906
f02ae73a 4907 for_each_cpu_worker_pool(pool, cpu) {
1258fae7 4908 mutex_lock(&wq_pool_attach_mutex);
a9b8a985 4909 raw_spin_lock_irq(&pool->lock);
3af24433 4910
94cf58bb 4911 /*
92f9c5c4 4912 * We've blocked all attach/detach operations. Make all workers
94cf58bb
TH
4913 * unbound and set DISASSOCIATED. Before this, all workers
4914 * except for the ones which are still executing works from
4915 * before the last CPU down must be on the cpu. After
4916 * this, they may become diasporas.
4917 */
da028469 4918 for_each_pool_worker(worker, pool)
c9e7cf27 4919 worker->flags |= WORKER_UNBOUND;
06ba38a9 4920
24647570 4921 pool->flags |= POOL_DISASSOCIATED;
f2d5a0ee 4922
a9b8a985 4923 raw_spin_unlock_irq(&pool->lock);
06249738 4924
5c25b5ff
PZ
4925 for_each_pool_worker(worker, pool) {
4926 kthread_set_per_cpu(worker->task, -1);
547a77d0 4927 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
5c25b5ff 4928 }
06249738 4929
1258fae7 4930 mutex_unlock(&wq_pool_attach_mutex);
628c78e7 4931
eb283428
LJ
4932 /*
4933 * Call schedule() so that we cross rq->lock and thus can
4934 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4935 * This is necessary as scheduler callbacks may be invoked
4936 * from other cpus.
4937 */
4938 schedule();
06ba38a9 4939
eb283428
LJ
4940 /*
4941 * Sched callbacks are disabled now. Zap nr_running.
4942 * After this, nr_running stays zero and need_more_worker()
4943 * and keep_working() are always true as long as the
4944 * worklist is not empty. This pool now behaves as an
4945 * unbound (in terms of concurrency management) pool which
4946 * are served by workers tied to the pool.
4947 */
e19e397a 4948 atomic_set(&pool->nr_running, 0);
eb283428
LJ
4949
4950 /*
4951 * With concurrency management just turned off, a busy
4952 * worker blocking could lead to lengthy stalls. Kick off
4953 * unbound chain execution of currently pending work items.
4954 */
a9b8a985 4955 raw_spin_lock_irq(&pool->lock);
eb283428 4956 wake_up_worker(pool);
a9b8a985 4957 raw_spin_unlock_irq(&pool->lock);
eb283428 4958 }
3af24433 4959}
3af24433 4960
bd7c089e
TH
4961/**
4962 * rebind_workers - rebind all workers of a pool to the associated CPU
4963 * @pool: pool of interest
4964 *
a9ab775b 4965 * @pool->cpu is coming online. Rebind all workers to the CPU.
bd7c089e
TH
4966 */
4967static void rebind_workers(struct worker_pool *pool)
4968{
a9ab775b 4969 struct worker *worker;
bd7c089e 4970
1258fae7 4971 lockdep_assert_held(&wq_pool_attach_mutex);
bd7c089e 4972
a9ab775b
TH
4973 /*
4974 * Restore CPU affinity of all workers. As all idle workers should
4975 * be on the run-queue of the associated CPU before any local
402dd89d 4976 * wake-ups for concurrency management happen, restore CPU affinity
a9ab775b
TH
4977 * of all workers first and then clear UNBOUND. As we're called
4978 * from CPU_ONLINE, the following shouldn't fail.
4979 */
5c25b5ff
PZ
4980 for_each_pool_worker(worker, pool) {
4981 kthread_set_per_cpu(worker->task, pool->cpu);
a9ab775b
TH
4982 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4983 pool->attrs->cpumask) < 0);
5c25b5ff 4984 }
bd7c089e 4985
a9b8a985 4986 raw_spin_lock_irq(&pool->lock);
f7c17d26 4987
3de5e884 4988 pool->flags &= ~POOL_DISASSOCIATED;
bd7c089e 4989
da028469 4990 for_each_pool_worker(worker, pool) {
a9ab775b 4991 unsigned int worker_flags = worker->flags;
bd7c089e
TH
4992
4993 /*
a9ab775b
TH
4994 * A bound idle worker should actually be on the runqueue
4995 * of the associated CPU for local wake-ups targeting it to
4996 * work. Kick all idle workers so that they migrate to the
4997 * associated CPU. Doing this in the same loop as
4998 * replacing UNBOUND with REBOUND is safe as no worker will
4999 * be bound before @pool->lock is released.
bd7c089e 5000 */
a9ab775b
TH
5001 if (worker_flags & WORKER_IDLE)
5002 wake_up_process(worker->task);
bd7c089e 5003
a9ab775b
TH
5004 /*
5005 * We want to clear UNBOUND but can't directly call
5006 * worker_clr_flags() or adjust nr_running. Atomically
5007 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
5008 * @worker will clear REBOUND using worker_clr_flags() when
5009 * it initiates the next execution cycle thus restoring
5010 * concurrency management. Note that when or whether
5011 * @worker clears REBOUND doesn't affect correctness.
5012 *
c95491ed 5013 * WRITE_ONCE() is necessary because @worker->flags may be
a9ab775b 5014 * tested without holding any lock in
6d25be57 5015 * wq_worker_running(). Without it, NOT_RUNNING test may
a9ab775b
TH
5016 * fail incorrectly leading to premature concurrency
5017 * management operations.
5018 */
5019 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
5020 worker_flags |= WORKER_REBOUND;
5021 worker_flags &= ~WORKER_UNBOUND;
c95491ed 5022 WRITE_ONCE(worker->flags, worker_flags);
bd7c089e 5023 }
a9ab775b 5024
a9b8a985 5025 raw_spin_unlock_irq(&pool->lock);
bd7c089e
TH
5026}
5027
7dbc725e
TH
5028/**
5029 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
5030 * @pool: unbound pool of interest
5031 * @cpu: the CPU which is coming up
5032 *
5033 * An unbound pool may end up with a cpumask which doesn't have any online
5034 * CPUs. When a worker of such pool get scheduled, the scheduler resets
5035 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
5036 * online CPU before, cpus_allowed of all its workers should be restored.
5037 */
5038static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
5039{
5040 static cpumask_t cpumask;
5041 struct worker *worker;
7dbc725e 5042
1258fae7 5043 lockdep_assert_held(&wq_pool_attach_mutex);
7dbc725e
TH
5044
5045 /* is @cpu allowed for @pool? */
5046 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
5047 return;
5048
7dbc725e 5049 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
7dbc725e
TH
5050
5051 /* as we're called from CPU_ONLINE, the following shouldn't fail */
da028469 5052 for_each_pool_worker(worker, pool)
d945b5e9 5053 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
7dbc725e
TH
5054}
5055
7ee681b2
TG
5056int workqueue_prepare_cpu(unsigned int cpu)
5057{
5058 struct worker_pool *pool;
5059
5060 for_each_cpu_worker_pool(pool, cpu) {
5061 if (pool->nr_workers)
5062 continue;
5063 if (!create_worker(pool))
5064 return -ENOMEM;
5065 }
5066 return 0;
5067}
5068
5069int workqueue_online_cpu(unsigned int cpu)
3af24433 5070{
4ce62e9e 5071 struct worker_pool *pool;
4c16bd32 5072 struct workqueue_struct *wq;
7dbc725e 5073 int pi;
3ce63377 5074
7ee681b2 5075 mutex_lock(&wq_pool_mutex);
7dbc725e 5076
7ee681b2 5077 for_each_pool(pool, pi) {
1258fae7 5078 mutex_lock(&wq_pool_attach_mutex);
94cf58bb 5079
7ee681b2
TG
5080 if (pool->cpu == cpu)
5081 rebind_workers(pool);
5082 else if (pool->cpu < 0)
5083 restore_unbound_workers_cpumask(pool, cpu);
94cf58bb 5084
1258fae7 5085 mutex_unlock(&wq_pool_attach_mutex);
7ee681b2 5086 }
6ba94429 5087
7ee681b2
TG
5088 /* update NUMA affinity of unbound workqueues */
5089 list_for_each_entry(wq, &workqueues, list)
5090 wq_update_unbound_numa(wq, cpu, true);
6ba94429 5091
7ee681b2
TG
5092 mutex_unlock(&wq_pool_mutex);
5093 return 0;
6ba94429
FW
5094}
5095
7ee681b2 5096int workqueue_offline_cpu(unsigned int cpu)
6ba94429 5097{
6ba94429
FW
5098 struct workqueue_struct *wq;
5099
7ee681b2 5100 /* unbinding per-cpu workers should happen on the local CPU */
e8b3f8db
LJ
5101 if (WARN_ON(cpu != smp_processor_id()))
5102 return -1;
5103
5104 unbind_workers(cpu);
7ee681b2
TG
5105
5106 /* update NUMA affinity of unbound workqueues */
5107 mutex_lock(&wq_pool_mutex);
5108 list_for_each_entry(wq, &workqueues, list)
5109 wq_update_unbound_numa(wq, cpu, false);
5110 mutex_unlock(&wq_pool_mutex);
5111
7ee681b2 5112 return 0;
6ba94429
FW
5113}
5114
6ba94429
FW
5115struct work_for_cpu {
5116 struct work_struct work;
5117 long (*fn)(void *);
5118 void *arg;
5119 long ret;
5120};
5121
5122static void work_for_cpu_fn(struct work_struct *work)
5123{
5124 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5125
5126 wfc->ret = wfc->fn(wfc->arg);
5127}
5128
5129/**
22aceb31 5130 * work_on_cpu - run a function in thread context on a particular cpu
6ba94429
FW
5131 * @cpu: the cpu to run on
5132 * @fn: the function to run
5133 * @arg: the function arg
5134 *
5135 * It is up to the caller to ensure that the cpu doesn't go offline.
5136 * The caller must not hold any locks which would prevent @fn from completing.
5137 *
5138 * Return: The value @fn returns.
5139 */
5140long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
5141{
5142 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
5143
5144 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5145 schedule_work_on(cpu, &wfc.work);
5146 flush_work(&wfc.work);
5147 destroy_work_on_stack(&wfc.work);
5148 return wfc.ret;
5149}
5150EXPORT_SYMBOL_GPL(work_on_cpu);
0e8d6a93
TG
5151
5152/**
5153 * work_on_cpu_safe - run a function in thread context on a particular cpu
5154 * @cpu: the cpu to run on
5155 * @fn: the function to run
5156 * @arg: the function argument
5157 *
5158 * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
5159 * any locks which would prevent @fn from completing.
5160 *
5161 * Return: The value @fn returns.
5162 */
5163long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
5164{
5165 long ret = -ENODEV;
5166
5167 get_online_cpus();
5168 if (cpu_online(cpu))
5169 ret = work_on_cpu(cpu, fn, arg);
5170 put_online_cpus();
5171 return ret;
5172}
5173EXPORT_SYMBOL_GPL(work_on_cpu_safe);
6ba94429
FW
5174#endif /* CONFIG_SMP */
5175
5176#ifdef CONFIG_FREEZER
5177
5178/**
5179 * freeze_workqueues_begin - begin freezing workqueues
5180 *
5181 * Start freezing workqueues. After this function returns, all freezable
5182 * workqueues will queue new works to their delayed_works list instead of
5183 * pool->worklist.
5184 *
5185 * CONTEXT:
5186 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5187 */
5188void freeze_workqueues_begin(void)
5189{
5190 struct workqueue_struct *wq;
5191 struct pool_workqueue *pwq;
5192
5193 mutex_lock(&wq_pool_mutex);
5194
5195 WARN_ON_ONCE(workqueue_freezing);
5196 workqueue_freezing = true;
5197
5198 list_for_each_entry(wq, &workqueues, list) {
5199 mutex_lock(&wq->mutex);
5200 for_each_pwq(pwq, wq)
5201 pwq_adjust_max_active(pwq);
5202 mutex_unlock(&wq->mutex);
5203 }
5204
5205 mutex_unlock(&wq_pool_mutex);
5206}
5207
5208/**
5209 * freeze_workqueues_busy - are freezable workqueues still busy?
5210 *
5211 * Check whether freezing is complete. This function must be called
5212 * between freeze_workqueues_begin() and thaw_workqueues().
5213 *
5214 * CONTEXT:
5215 * Grabs and releases wq_pool_mutex.
5216 *
5217 * Return:
5218 * %true if some freezable workqueues are still busy. %false if freezing
5219 * is complete.
5220 */
5221bool freeze_workqueues_busy(void)
5222{
5223 bool busy = false;
5224 struct workqueue_struct *wq;
5225 struct pool_workqueue *pwq;
5226
5227 mutex_lock(&wq_pool_mutex);
5228
5229 WARN_ON_ONCE(!workqueue_freezing);
5230
5231 list_for_each_entry(wq, &workqueues, list) {
5232 if (!(wq->flags & WQ_FREEZABLE))
5233 continue;
5234 /*
5235 * nr_active is monotonically decreasing. It's safe
5236 * to peek without lock.
5237 */
24acfb71 5238 rcu_read_lock();
6ba94429
FW
5239 for_each_pwq(pwq, wq) {
5240 WARN_ON_ONCE(pwq->nr_active < 0);
5241 if (pwq->nr_active) {
5242 busy = true;
24acfb71 5243 rcu_read_unlock();
6ba94429
FW
5244 goto out_unlock;
5245 }
5246 }
24acfb71 5247 rcu_read_unlock();
6ba94429
FW
5248 }
5249out_unlock:
5250 mutex_unlock(&wq_pool_mutex);
5251 return busy;
5252}
5253
5254/**
5255 * thaw_workqueues - thaw workqueues
5256 *
5257 * Thaw workqueues. Normal queueing is restored and all collected
5258 * frozen works are transferred to their respective pool worklists.
5259 *
5260 * CONTEXT:
5261 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5262 */
5263void thaw_workqueues(void)
5264{
5265 struct workqueue_struct *wq;
5266 struct pool_workqueue *pwq;
5267
5268 mutex_lock(&wq_pool_mutex);
5269
5270 if (!workqueue_freezing)
5271 goto out_unlock;
5272
5273 workqueue_freezing = false;
5274
5275 /* restore max_active and repopulate worklist */
5276 list_for_each_entry(wq, &workqueues, list) {
5277 mutex_lock(&wq->mutex);
5278 for_each_pwq(pwq, wq)
5279 pwq_adjust_max_active(pwq);
5280 mutex_unlock(&wq->mutex);
5281 }
5282
5283out_unlock:
5284 mutex_unlock(&wq_pool_mutex);
5285}
5286#endif /* CONFIG_FREEZER */
5287
042f7df1
LJ
5288static int workqueue_apply_unbound_cpumask(void)
5289{
5290 LIST_HEAD(ctxs);
5291 int ret = 0;
5292 struct workqueue_struct *wq;
5293 struct apply_wqattrs_ctx *ctx, *n;
5294
5295 lockdep_assert_held(&wq_pool_mutex);
5296
5297 list_for_each_entry(wq, &workqueues, list) {
5298 if (!(wq->flags & WQ_UNBOUND))
5299 continue;
5300 /* creating multiple pwqs breaks ordering guarantee */
5301 if (wq->flags & __WQ_ORDERED)
5302 continue;
5303
5304 ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5305 if (!ctx) {
5306 ret = -ENOMEM;
5307 break;
5308 }
5309
5310 list_add_tail(&ctx->list, &ctxs);
5311 }
5312
5313 list_for_each_entry_safe(ctx, n, &ctxs, list) {
5314 if (!ret)
5315 apply_wqattrs_commit(ctx);
5316 apply_wqattrs_cleanup(ctx);
5317 }
5318
5319 return ret;
5320}
5321
5322/**
5323 * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5324 * @cpumask: the cpumask to set
5325 *
5326 * The low-level workqueues cpumask is a global cpumask that limits
5327 * the affinity of all unbound workqueues. This function check the @cpumask
5328 * and apply it to all unbound workqueues and updates all pwqs of them.
5329 *
5330 * Retun: 0 - Success
5331 * -EINVAL - Invalid @cpumask
5332 * -ENOMEM - Failed to allocate memory for attrs or pwqs.
5333 */
5334int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5335{
5336 int ret = -EINVAL;
5337 cpumask_var_t saved_cpumask;
5338
5339 if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5340 return -ENOMEM;
5341
c98a9805
TS
5342 /*
5343 * Not excluding isolated cpus on purpose.
5344 * If the user wishes to include them, we allow that.
5345 */
042f7df1
LJ
5346 cpumask_and(cpumask, cpumask, cpu_possible_mask);
5347 if (!cpumask_empty(cpumask)) {
a0111cf6 5348 apply_wqattrs_lock();
042f7df1
LJ
5349
5350 /* save the old wq_unbound_cpumask. */
5351 cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5352
5353 /* update wq_unbound_cpumask at first and apply it to wqs. */
5354 cpumask_copy(wq_unbound_cpumask, cpumask);
5355 ret = workqueue_apply_unbound_cpumask();
5356
5357 /* restore the wq_unbound_cpumask when failed. */
5358 if (ret < 0)
5359 cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5360
a0111cf6 5361 apply_wqattrs_unlock();
042f7df1 5362 }
042f7df1
LJ
5363
5364 free_cpumask_var(saved_cpumask);
5365 return ret;
5366}
5367
6ba94429
FW
5368#ifdef CONFIG_SYSFS
5369/*
5370 * Workqueues with WQ_SYSFS flag set is visible to userland via
5371 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
5372 * following attributes.
5373 *
5374 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
5375 * max_active RW int : maximum number of in-flight work items
5376 *
5377 * Unbound workqueues have the following extra attributes.
5378 *
9a19b463 5379 * pool_ids RO int : the associated pool IDs for each node
6ba94429
FW
5380 * nice RW int : nice value of the workers
5381 * cpumask RW mask : bitmask of allowed CPUs for the workers
9a19b463 5382 * numa RW bool : whether enable NUMA affinity
6ba94429
FW
5383 */
5384struct wq_device {
5385 struct workqueue_struct *wq;
5386 struct device dev;
5387};
5388
5389static struct workqueue_struct *dev_to_wq(struct device *dev)
5390{
5391 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
5392
5393 return wq_dev->wq;
5394}
5395
5396static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
5397 char *buf)
5398{
5399 struct workqueue_struct *wq = dev_to_wq(dev);
5400
5401 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
5402}
5403static DEVICE_ATTR_RO(per_cpu);
5404
5405static ssize_t max_active_show(struct device *dev,
5406 struct device_attribute *attr, char *buf)
5407{
5408 struct workqueue_struct *wq = dev_to_wq(dev);
5409
5410 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
5411}
5412
5413static ssize_t max_active_store(struct device *dev,
5414 struct device_attribute *attr, const char *buf,
5415 size_t count)
5416{
5417 struct workqueue_struct *wq = dev_to_wq(dev);
5418 int val;
5419
5420 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
5421 return -EINVAL;
5422
5423 workqueue_set_max_active(wq, val);
5424 return count;
5425}
5426static DEVICE_ATTR_RW(max_active);
5427
5428static struct attribute *wq_sysfs_attrs[] = {
5429 &dev_attr_per_cpu.attr,
5430 &dev_attr_max_active.attr,
5431 NULL,
5432};
5433ATTRIBUTE_GROUPS(wq_sysfs);
5434
5435static ssize_t wq_pool_ids_show(struct device *dev,
5436 struct device_attribute *attr, char *buf)
5437{
5438 struct workqueue_struct *wq = dev_to_wq(dev);
5439 const char *delim = "";
5440 int node, written = 0;
5441
24acfb71
TG
5442 get_online_cpus();
5443 rcu_read_lock();
6ba94429
FW
5444 for_each_node(node) {
5445 written += scnprintf(buf + written, PAGE_SIZE - written,
5446 "%s%d:%d", delim, node,
5447 unbound_pwq_by_node(wq, node)->pool->id);
5448 delim = " ";
5449 }
5450 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
24acfb71
TG
5451 rcu_read_unlock();
5452 put_online_cpus();
6ba94429
FW
5453
5454 return written;
5455}
5456
5457static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
5458 char *buf)
5459{
5460 struct workqueue_struct *wq = dev_to_wq(dev);
5461 int written;
5462
5463 mutex_lock(&wq->mutex);
5464 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
5465 mutex_unlock(&wq->mutex);
5466
5467 return written;
5468}
5469
5470/* prepare workqueue_attrs for sysfs store operations */
5471static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
5472{
5473 struct workqueue_attrs *attrs;
5474
899a94fe
LJ
5475 lockdep_assert_held(&wq_pool_mutex);
5476
be69d00d 5477 attrs = alloc_workqueue_attrs();
6ba94429
FW
5478 if (!attrs)
5479 return NULL;
5480
6ba94429 5481 copy_workqueue_attrs(attrs, wq->unbound_attrs);
6ba94429
FW
5482 return attrs;
5483}
5484
5485static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
5486 const char *buf, size_t count)
5487{
5488 struct workqueue_struct *wq = dev_to_wq(dev);
5489 struct workqueue_attrs *attrs;
d4d3e257
LJ
5490 int ret = -ENOMEM;
5491
5492 apply_wqattrs_lock();
6ba94429
FW
5493
5494 attrs = wq_sysfs_prep_attrs(wq);
5495 if (!attrs)
d4d3e257 5496 goto out_unlock;
6ba94429
FW
5497
5498 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
5499 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
d4d3e257 5500 ret = apply_workqueue_attrs_locked(wq, attrs);
6ba94429
FW
5501 else
5502 ret = -EINVAL;
5503
d4d3e257
LJ
5504out_unlock:
5505 apply_wqattrs_unlock();
6ba94429
FW
5506 free_workqueue_attrs(attrs);
5507 return ret ?: count;
5508}
5509
5510static ssize_t wq_cpumask_show(struct device *dev,
5511 struct device_attribute *attr, char *buf)
5512{
5513 struct workqueue_struct *wq = dev_to_wq(dev);
5514 int written;
5515
5516 mutex_lock(&wq->mutex);
5517 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5518 cpumask_pr_args(wq->unbound_attrs->cpumask));
5519 mutex_unlock(&wq->mutex);
5520 return written;
5521}
5522
5523static ssize_t wq_cpumask_store(struct device *dev,
5524 struct device_attribute *attr,
5525 const char *buf, size_t count)
5526{
5527 struct workqueue_struct *wq = dev_to_wq(dev);
5528 struct workqueue_attrs *attrs;
d4d3e257
LJ
5529 int ret = -ENOMEM;
5530
5531 apply_wqattrs_lock();
6ba94429
FW
5532
5533 attrs = wq_sysfs_prep_attrs(wq);
5534 if (!attrs)
d4d3e257 5535 goto out_unlock;
6ba94429
FW
5536
5537 ret = cpumask_parse(buf, attrs->cpumask);
5538 if (!ret)
d4d3e257 5539 ret = apply_workqueue_attrs_locked(wq, attrs);
6ba94429 5540
d4d3e257
LJ
5541out_unlock:
5542 apply_wqattrs_unlock();
6ba94429
FW
5543 free_workqueue_attrs(attrs);
5544 return ret ?: count;
5545}
5546
5547static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
5548 char *buf)
5549{
5550 struct workqueue_struct *wq = dev_to_wq(dev);
5551 int written;
7dbc725e 5552
6ba94429
FW
5553 mutex_lock(&wq->mutex);
5554 written = scnprintf(buf, PAGE_SIZE, "%d\n",
5555 !wq->unbound_attrs->no_numa);
5556 mutex_unlock(&wq->mutex);
4c16bd32 5557
6ba94429 5558 return written;
65758202
TH
5559}
5560
6ba94429
FW
5561static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
5562 const char *buf, size_t count)
65758202 5563{
6ba94429
FW
5564 struct workqueue_struct *wq = dev_to_wq(dev);
5565 struct workqueue_attrs *attrs;
d4d3e257
LJ
5566 int v, ret = -ENOMEM;
5567
5568 apply_wqattrs_lock();
4c16bd32 5569
6ba94429
FW
5570 attrs = wq_sysfs_prep_attrs(wq);
5571 if (!attrs)
d4d3e257 5572 goto out_unlock;
4c16bd32 5573
6ba94429
FW
5574 ret = -EINVAL;
5575 if (sscanf(buf, "%d", &v) == 1) {
5576 attrs->no_numa = !v;
d4d3e257 5577 ret = apply_workqueue_attrs_locked(wq, attrs);
65758202 5578 }
6ba94429 5579
d4d3e257
LJ
5580out_unlock:
5581 apply_wqattrs_unlock();
6ba94429
FW
5582 free_workqueue_attrs(attrs);
5583 return ret ?: count;
65758202
TH
5584}
5585
6ba94429
FW
5586static struct device_attribute wq_sysfs_unbound_attrs[] = {
5587 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
5588 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
5589 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
5590 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
5591 __ATTR_NULL,
5592};
8ccad40d 5593
6ba94429
FW
5594static struct bus_type wq_subsys = {
5595 .name = "workqueue",
5596 .dev_groups = wq_sysfs_groups,
2d3854a3
RR
5597};
5598
b05a7928
FW
5599static ssize_t wq_unbound_cpumask_show(struct device *dev,
5600 struct device_attribute *attr, char *buf)
5601{
5602 int written;
5603
042f7df1 5604 mutex_lock(&wq_pool_mutex);
b05a7928
FW
5605 written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5606 cpumask_pr_args(wq_unbound_cpumask));
042f7df1 5607 mutex_unlock(&wq_pool_mutex);
b05a7928
FW
5608
5609 return written;
5610}
5611
042f7df1
LJ
5612static ssize_t wq_unbound_cpumask_store(struct device *dev,
5613 struct device_attribute *attr, const char *buf, size_t count)
5614{
5615 cpumask_var_t cpumask;
5616 int ret;
5617
5618 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5619 return -ENOMEM;
5620
5621 ret = cpumask_parse(buf, cpumask);
5622 if (!ret)
5623 ret = workqueue_set_unbound_cpumask(cpumask);
5624
5625 free_cpumask_var(cpumask);
5626 return ret ? ret : count;
5627}
5628
b05a7928 5629static struct device_attribute wq_sysfs_cpumask_attr =
042f7df1
LJ
5630 __ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5631 wq_unbound_cpumask_store);
b05a7928 5632
6ba94429 5633static int __init wq_sysfs_init(void)
2d3854a3 5634{
b05a7928
FW
5635 int err;
5636
5637 err = subsys_virtual_register(&wq_subsys, NULL);
5638 if (err)
5639 return err;
5640
5641 return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
2d3854a3 5642}
6ba94429 5643core_initcall(wq_sysfs_init);
2d3854a3 5644
6ba94429 5645static void wq_device_release(struct device *dev)
2d3854a3 5646{
6ba94429 5647 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
6b44003e 5648
6ba94429 5649 kfree(wq_dev);
2d3854a3 5650}
a0a1a5fd
TH
5651
5652/**
6ba94429
FW
5653 * workqueue_sysfs_register - make a workqueue visible in sysfs
5654 * @wq: the workqueue to register
a0a1a5fd 5655 *
6ba94429
FW
5656 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
5657 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
5658 * which is the preferred method.
a0a1a5fd 5659 *
6ba94429
FW
5660 * Workqueue user should use this function directly iff it wants to apply
5661 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
5662 * apply_workqueue_attrs() may race against userland updating the
5663 * attributes.
5664 *
5665 * Return: 0 on success, -errno on failure.
a0a1a5fd 5666 */
6ba94429 5667int workqueue_sysfs_register(struct workqueue_struct *wq)
a0a1a5fd 5668{
6ba94429
FW
5669 struct wq_device *wq_dev;
5670 int ret;
a0a1a5fd 5671
6ba94429 5672 /*
402dd89d 5673 * Adjusting max_active or creating new pwqs by applying
6ba94429
FW
5674 * attributes breaks ordering guarantee. Disallow exposing ordered
5675 * workqueues.
5676 */
0a94efb5 5677 if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
6ba94429 5678 return -EINVAL;
a0a1a5fd 5679
6ba94429
FW
5680 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
5681 if (!wq_dev)
5682 return -ENOMEM;
5bcab335 5683
6ba94429
FW
5684 wq_dev->wq = wq;
5685 wq_dev->dev.bus = &wq_subsys;
6ba94429 5686 wq_dev->dev.release = wq_device_release;
23217b44 5687 dev_set_name(&wq_dev->dev, "%s", wq->name);
a0a1a5fd 5688
6ba94429
FW
5689 /*
5690 * unbound_attrs are created separately. Suppress uevent until
5691 * everything is ready.
5692 */
5693 dev_set_uevent_suppress(&wq_dev->dev, true);
a0a1a5fd 5694
6ba94429
FW
5695 ret = device_register(&wq_dev->dev);
5696 if (ret) {
537f4146 5697 put_device(&wq_dev->dev);
6ba94429
FW
5698 wq->wq_dev = NULL;
5699 return ret;
5700 }
a0a1a5fd 5701
6ba94429
FW
5702 if (wq->flags & WQ_UNBOUND) {
5703 struct device_attribute *attr;
a0a1a5fd 5704
6ba94429
FW
5705 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
5706 ret = device_create_file(&wq_dev->dev, attr);
5707 if (ret) {
5708 device_unregister(&wq_dev->dev);
5709 wq->wq_dev = NULL;
5710 return ret;
a0a1a5fd
TH
5711 }
5712 }
5713 }
6ba94429
FW
5714
5715 dev_set_uevent_suppress(&wq_dev->dev, false);
5716 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
5717 return 0;
a0a1a5fd
TH
5718}
5719
5720/**
6ba94429
FW
5721 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
5722 * @wq: the workqueue to unregister
a0a1a5fd 5723 *
6ba94429 5724 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
a0a1a5fd 5725 */
6ba94429 5726static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
a0a1a5fd 5727{
6ba94429 5728 struct wq_device *wq_dev = wq->wq_dev;
8b03ae3c 5729
6ba94429
FW
5730 if (!wq->wq_dev)
5731 return;
a0a1a5fd 5732
6ba94429
FW
5733 wq->wq_dev = NULL;
5734 device_unregister(&wq_dev->dev);
a0a1a5fd 5735}
6ba94429
FW
5736#else /* CONFIG_SYSFS */
5737static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
5738#endif /* CONFIG_SYSFS */
a0a1a5fd 5739
82607adc
TH
5740/*
5741 * Workqueue watchdog.
5742 *
5743 * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
5744 * flush dependency, a concurrency managed work item which stays RUNNING
5745 * indefinitely. Workqueue stalls can be very difficult to debug as the
5746 * usual warning mechanisms don't trigger and internal workqueue state is
5747 * largely opaque.
5748 *
5749 * Workqueue watchdog monitors all worker pools periodically and dumps
5750 * state if some pools failed to make forward progress for a while where
5751 * forward progress is defined as the first item on ->worklist changing.
5752 *
5753 * This mechanism is controlled through the kernel parameter
5754 * "workqueue.watchdog_thresh" which can be updated at runtime through the
5755 * corresponding sysfs parameter file.
5756 */
5757#ifdef CONFIG_WQ_WATCHDOG
5758
82607adc 5759static unsigned long wq_watchdog_thresh = 30;
5cd79d6a 5760static struct timer_list wq_watchdog_timer;
82607adc
TH
5761
5762static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
5763static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
5764
5765static void wq_watchdog_reset_touched(void)
5766{
5767 int cpu;
5768
5769 wq_watchdog_touched = jiffies;
5770 for_each_possible_cpu(cpu)
5771 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5772}
5773
5cd79d6a 5774static void wq_watchdog_timer_fn(struct timer_list *unused)
82607adc
TH
5775{
5776 unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
5777 bool lockup_detected = false;
5778 struct worker_pool *pool;
5779 int pi;
5780
5781 if (!thresh)
5782 return;
5783
5784 rcu_read_lock();
5785
5786 for_each_pool(pool, pi) {
5787 unsigned long pool_ts, touched, ts;
5788
5789 if (list_empty(&pool->worklist))
5790 continue;
5791
5792 /* get the latest of pool and touched timestamps */
5793 pool_ts = READ_ONCE(pool->watchdog_ts);
5794 touched = READ_ONCE(wq_watchdog_touched);
5795
5796 if (time_after(pool_ts, touched))
5797 ts = pool_ts;
5798 else
5799 ts = touched;
5800
5801 if (pool->cpu >= 0) {
5802 unsigned long cpu_touched =
5803 READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
5804 pool->cpu));
5805 if (time_after(cpu_touched, ts))
5806 ts = cpu_touched;
5807 }
5808
5809 /* did we stall? */
5810 if (time_after(jiffies, ts + thresh)) {
5811 lockup_detected = true;
5812 pr_emerg("BUG: workqueue lockup - pool");
5813 pr_cont_pool_info(pool);
5814 pr_cont(" stuck for %us!\n",
5815 jiffies_to_msecs(jiffies - pool_ts) / 1000);
5816 }
5817 }
5818
5819 rcu_read_unlock();
5820
5821 if (lockup_detected)
5822 show_workqueue_state();
5823
5824 wq_watchdog_reset_touched();
5825 mod_timer(&wq_watchdog_timer, jiffies + thresh);
5826}
5827
cb9d7fd5 5828notrace void wq_watchdog_touch(int cpu)
82607adc
TH
5829{
5830 if (cpu >= 0)
5831 per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
5832 else
5833 wq_watchdog_touched = jiffies;
5834}
5835
5836static void wq_watchdog_set_thresh(unsigned long thresh)
5837{
5838 wq_watchdog_thresh = 0;
5839 del_timer_sync(&wq_watchdog_timer);
5840
5841 if (thresh) {
5842 wq_watchdog_thresh = thresh;
5843 wq_watchdog_reset_touched();
5844 mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
5845 }
5846}
5847
5848static int wq_watchdog_param_set_thresh(const char *val,
5849 const struct kernel_param *kp)
5850{
5851 unsigned long thresh;
5852 int ret;
5853
5854 ret = kstrtoul(val, 0, &thresh);
5855 if (ret)
5856 return ret;
5857
5858 if (system_wq)
5859 wq_watchdog_set_thresh(thresh);
5860 else
5861 wq_watchdog_thresh = thresh;
5862
5863 return 0;
5864}
5865
5866static const struct kernel_param_ops wq_watchdog_thresh_ops = {
5867 .set = wq_watchdog_param_set_thresh,
5868 .get = param_get_ulong,
5869};
5870
5871module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
5872 0644);
5873
5874static void wq_watchdog_init(void)
5875{
5cd79d6a 5876 timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
82607adc
TH
5877 wq_watchdog_set_thresh(wq_watchdog_thresh);
5878}
5879
5880#else /* CONFIG_WQ_WATCHDOG */
5881
5882static inline void wq_watchdog_init(void) { }
5883
5884#endif /* CONFIG_WQ_WATCHDOG */
5885
bce90380
TH
5886static void __init wq_numa_init(void)
5887{
5888 cpumask_var_t *tbl;
5889 int node, cpu;
5890
bce90380
TH
5891 if (num_possible_nodes() <= 1)
5892 return;
5893
d55262c4
TH
5894 if (wq_disable_numa) {
5895 pr_info("workqueue: NUMA affinity support disabled\n");
5896 return;
5897 }
5898
be69d00d 5899 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
4c16bd32
TH
5900 BUG_ON(!wq_update_unbound_numa_attrs_buf);
5901
bce90380
TH
5902 /*
5903 * We want masks of possible CPUs of each node which isn't readily
5904 * available. Build one from cpu_to_node() which should have been
5905 * fully initialized by now.
5906 */
6396bb22 5907 tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
bce90380
TH
5908 BUG_ON(!tbl);
5909
5910 for_each_node(node)
5a6024f1 5911 BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
1be0c25d 5912 node_online(node) ? node : NUMA_NO_NODE));
bce90380
TH
5913
5914 for_each_possible_cpu(cpu) {
5915 node = cpu_to_node(cpu);
5916 if (WARN_ON(node == NUMA_NO_NODE)) {
5917 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5918 /* happens iff arch is bonkers, let's just proceed */
5919 return;
5920 }
5921 cpumask_set_cpu(cpu, tbl[node]);
5922 }
5923
5924 wq_numa_possible_cpumask = tbl;
5925 wq_numa_enabled = true;
5926}
5927
3347fa09
TH
5928/**
5929 * workqueue_init_early - early init for workqueue subsystem
5930 *
5931 * This is the first half of two-staged workqueue subsystem initialization
5932 * and invoked as soon as the bare basics - memory allocation, cpumasks and
5933 * idr are up. It sets up all the data structures and system workqueues
5934 * and allows early boot code to create workqueues and queue/cancel work
5935 * items. Actual work item execution starts only after kthreads can be
5936 * created and scheduled right before early initcalls.
5937 */
2333e829 5938void __init workqueue_init_early(void)
1da177e4 5939{
7a4e344c 5940 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
1bda3f80 5941 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
7a4e344c 5942 int i, cpu;
c34056a3 5943
10cdb157 5944 BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
e904e6c2 5945
b05a7928 5946 BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
1bda3f80 5947 cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
b05a7928 5948
e904e6c2
TH
5949 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5950
706026c2 5951 /* initialize CPU pools */
29c91e99 5952 for_each_possible_cpu(cpu) {
4ce62e9e 5953 struct worker_pool *pool;
8b03ae3c 5954
7a4e344c 5955 i = 0;
f02ae73a 5956 for_each_cpu_worker_pool(pool, cpu) {
7a4e344c 5957 BUG_ON(init_worker_pool(pool));
ec22ca5e 5958 pool->cpu = cpu;
29c91e99 5959 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
7a4e344c 5960 pool->attrs->nice = std_nice[i++];
f3f90ad4 5961 pool->node = cpu_to_node(cpu);
7a4e344c 5962
9daf9e67 5963 /* alloc pool ID */
68e13a67 5964 mutex_lock(&wq_pool_mutex);
9daf9e67 5965 BUG_ON(worker_pool_assign_id(pool));
68e13a67 5966 mutex_unlock(&wq_pool_mutex);
4ce62e9e 5967 }
8b03ae3c
TH
5968 }
5969
8a2b7538 5970 /* create default unbound and ordered wq attrs */
29c91e99
TH
5971 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5972 struct workqueue_attrs *attrs;
5973
be69d00d 5974 BUG_ON(!(attrs = alloc_workqueue_attrs()));
29c91e99 5975 attrs->nice = std_nice[i];
29c91e99 5976 unbound_std_wq_attrs[i] = attrs;
8a2b7538
TH
5977
5978 /*
5979 * An ordered wq should have only one pwq as ordering is
5980 * guaranteed by max_active which is enforced by pwqs.
5981 * Turn off NUMA so that dfl_pwq is used for all nodes.
5982 */
be69d00d 5983 BUG_ON(!(attrs = alloc_workqueue_attrs()));
8a2b7538
TH
5984 attrs->nice = std_nice[i];
5985 attrs->no_numa = true;
5986 ordered_wq_attrs[i] = attrs;
29c91e99
TH
5987 }
5988
d320c038 5989 system_wq = alloc_workqueue("events", 0, 0);
1aabe902 5990 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
d320c038 5991 system_long_wq = alloc_workqueue("events_long", 0, 0);
f3421797
TH
5992 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5993 WQ_UNBOUND_MAX_ACTIVE);
24d51add
TH
5994 system_freezable_wq = alloc_workqueue("events_freezable",
5995 WQ_FREEZABLE, 0);
0668106c
VK
5996 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5997 WQ_POWER_EFFICIENT, 0);
5998 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5999 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
6000 0);
1aabe902 6001 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
0668106c
VK
6002 !system_unbound_wq || !system_freezable_wq ||
6003 !system_power_efficient_wq ||
6004 !system_freezable_power_efficient_wq);
3347fa09
TH
6005}
6006
6007/**
6008 * workqueue_init - bring workqueue subsystem fully online
6009 *
6010 * This is the latter half of two-staged workqueue subsystem initialization
6011 * and invoked as soon as kthreads can be created and scheduled.
6012 * Workqueues have been created and work items queued on them, but there
6013 * are no kworkers executing the work items yet. Populate the worker pools
6014 * with the initial workers and enable future kworker creations.
6015 */
2333e829 6016void __init workqueue_init(void)
3347fa09 6017{
2186d9f9 6018 struct workqueue_struct *wq;
3347fa09
TH
6019 struct worker_pool *pool;
6020 int cpu, bkt;
6021
2186d9f9
TH
6022 /*
6023 * It'd be simpler to initialize NUMA in workqueue_init_early() but
6024 * CPU to node mapping may not be available that early on some
6025 * archs such as power and arm64. As per-cpu pools created
6026 * previously could be missing node hint and unbound pools NUMA
6027 * affinity, fix them up.
40c17f75
TH
6028 *
6029 * Also, while iterating workqueues, create rescuers if requested.
2186d9f9
TH
6030 */
6031 wq_numa_init();
6032
6033 mutex_lock(&wq_pool_mutex);
6034
6035 for_each_possible_cpu(cpu) {
6036 for_each_cpu_worker_pool(pool, cpu) {
6037 pool->node = cpu_to_node(cpu);
6038 }
6039 }
6040
40c17f75 6041 list_for_each_entry(wq, &workqueues, list) {
2186d9f9 6042 wq_update_unbound_numa(wq, smp_processor_id(), true);
40c17f75
TH
6043 WARN(init_rescuer(wq),
6044 "workqueue: failed to create early rescuer for %s",
6045 wq->name);
6046 }
2186d9f9
TH
6047
6048 mutex_unlock(&wq_pool_mutex);
6049
3347fa09
TH
6050 /* create the initial workers */
6051 for_each_online_cpu(cpu) {
6052 for_each_cpu_worker_pool(pool, cpu) {
6053 pool->flags &= ~POOL_DISASSOCIATED;
6054 BUG_ON(!create_worker(pool));
6055 }
6056 }
6057
6058 hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
6059 BUG_ON(!create_worker(pool));
6060
6061 wq_online = true;
82607adc 6062 wq_watchdog_init();
1da177e4 6063}