workqueue: separate pool-attaching code out from create_worker()
[linux-2.6-block.git] / kernel / workqueue.c
CommitLineData
1da177e4 1/*
c54fce6e 2 * kernel/workqueue.c - generic async execution with shared worker pool
1da177e4 3 *
c54fce6e 4 * Copyright (C) 2002 Ingo Molnar
1da177e4 5 *
c54fce6e
TH
6 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
1da177e4 11 *
c54fce6e 12 * Made to use alloc_percpu by Christoph Lameter.
1da177e4 13 *
c54fce6e
TH
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
89ada679 16 *
c54fce6e
TH
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
b11895c4
L
19 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
c54fce6e
TH
23 *
24 * Please read Documentation/workqueue.txt for details.
1da177e4
LT
25 */
26
9984de1a 27#include <linux/export.h>
1da177e4
LT
28#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
1fa44eca 38#include <linux/hardirq.h>
46934023 39#include <linux/mempolicy.h>
341a5958 40#include <linux/freezer.h>
d5abe669
PZ
41#include <linux/kallsyms.h>
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>
e22bee78 51
ea138446 52#include "workqueue_internal.h"
1da177e4 53
c8e55f36 54enum {
24647570
TH
55 /*
56 * worker_pool flags
bc2ae0f5 57 *
24647570 58 * A bound pool is either associated or disassociated with its CPU.
bc2ae0f5
TH
59 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
61 * is in effect.
62 *
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
24647570 65 * be executing on any CPU. The pool behaves as an unbound one.
bc2ae0f5 66 *
bc3a1afc 67 * Note that DISASSOCIATED should be flipped only while holding
92f9c5c4 68 * attach_mutex to avoid changing binding state while
4736cbf7 69 * worker_attach_to_pool() is in progress.
bc2ae0f5 70 */
24647570 71 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
35b6bb63 72 POOL_FREEZING = 1 << 3, /* freeze in progress */
db7bccf4 73
c8e55f36 74 /* worker flags */
c8e55f36
TH
75 WORKER_DIE = 1 << 1, /* die die die */
76 WORKER_IDLE = 1 << 2, /* is idle */
e22bee78 77 WORKER_PREP = 1 << 3, /* preparing to run works */
fb0e7beb 78 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
f3421797 79 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
a9ab775b 80 WORKER_REBOUND = 1 << 8, /* worker was rebound */
e22bee78 81
a9ab775b
TH
82 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
83 WORKER_UNBOUND | WORKER_REBOUND,
db7bccf4 84
e34cdddb 85 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
4ce62e9e 86
29c91e99 87 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
c8e55f36 88 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
db7bccf4 89
e22bee78
TH
90 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
91 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
92
3233cdbd
TH
93 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
94 /* call for help after 10ms
95 (min two ticks) */
e22bee78
TH
96 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
97 CREATE_COOLDOWN = HZ, /* time to breath after fail */
e22bee78
TH
98
99 /*
100 * Rescue workers are used only on emergencies and shared by
101 * all cpus. Give -20.
102 */
103 RESCUER_NICE_LEVEL = -20,
3270476a 104 HIGHPRI_NICE_LEVEL = -20,
ecf6881f
TH
105
106 WQ_NAME_LEN = 24,
c8e55f36 107};
1da177e4
LT
108
109/*
4690c4ab
TH
110 * Structure fields follow one of the following exclusion rules.
111 *
e41e704b
TH
112 * I: Modifiable by initialization/destruction paths and read-only for
113 * everyone else.
4690c4ab 114 *
e22bee78
TH
115 * P: Preemption protected. Disabling preemption is enough and should
116 * only be modified and accessed from the local cpu.
117 *
d565ed63 118 * L: pool->lock protected. Access with pool->lock held.
4690c4ab 119 *
d565ed63
TH
120 * X: During normal operation, modification requires pool->lock and should
121 * be done only from local cpu. Either disabling preemption on local
122 * cpu or grabbing pool->lock is enough for read access. If
123 * POOL_DISASSOCIATED is set, it's identical to L.
e22bee78 124 *
92f9c5c4 125 * A: pool->attach_mutex protected.
822d8405 126 *
68e13a67 127 * PL: wq_pool_mutex protected.
5bcab335 128 *
68e13a67 129 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
76af4d93 130 *
3c25a55d
LJ
131 * WQ: wq->mutex protected.
132 *
b5927605 133 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
2e109a28
TH
134 *
135 * MD: wq_mayday_lock protected.
1da177e4 136 */
1da177e4 137
2eaebdb3 138/* struct worker is defined in workqueue_internal.h */
c34056a3 139
bd7bdd43 140struct worker_pool {
d565ed63 141 spinlock_t lock; /* the pool lock */
d84ff051 142 int cpu; /* I: the associated cpu */
f3f90ad4 143 int node; /* I: the associated node ID */
9daf9e67 144 int id; /* I: pool ID */
11ebea50 145 unsigned int flags; /* X: flags */
bd7bdd43
TH
146
147 struct list_head worklist; /* L: list of pending works */
148 int nr_workers; /* L: total number of workers */
ea1abd61
LJ
149
150 /* nr_idle includes the ones off idle_list for rebinding */
bd7bdd43
TH
151 int nr_idle; /* L: currently idle ones */
152
153 struct list_head idle_list; /* X: list of idle workers */
154 struct timer_list idle_timer; /* L: worker idle timeout */
155 struct timer_list mayday_timer; /* L: SOS timer for workers */
156
c5aa87bb 157 /* a workers is either on busy_hash or idle_list, or the manager */
c9e7cf27
TH
158 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
159 /* L: hash of busy workers */
160
bc3a1afc 161 /* see manage_workers() for details on the two manager mutexes */
34a06bd6 162 struct mutex manager_arb; /* manager arbitration */
92f9c5c4
LJ
163 struct mutex attach_mutex; /* attach/detach exclusion */
164 struct list_head workers; /* A: attached workers */
60f5a4bc 165 struct completion *detach_completion; /* all workers detached */
e19e397a 166
7cda9aae
LJ
167 struct ida worker_ida; /* worker IDs for task name */
168
7a4e344c 169 struct workqueue_attrs *attrs; /* I: worker attributes */
68e13a67
LJ
170 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
171 int refcnt; /* PL: refcnt for unbound pools */
7a4e344c 172
e19e397a
TH
173 /*
174 * The current concurrency level. As it's likely to be accessed
175 * from other CPUs during try_to_wake_up(), put it in a separate
176 * cacheline.
177 */
178 atomic_t nr_running ____cacheline_aligned_in_smp;
29c91e99
TH
179
180 /*
181 * Destruction of pool is sched-RCU protected to allow dereferences
182 * from get_work_pool().
183 */
184 struct rcu_head rcu;
8b03ae3c
TH
185} ____cacheline_aligned_in_smp;
186
1da177e4 187/*
112202d9
TH
188 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
189 * of work_struct->data are used for flags and the remaining high bits
190 * point to the pwq; thus, pwqs need to be aligned at two's power of the
191 * number of flag bits.
1da177e4 192 */
112202d9 193struct pool_workqueue {
bd7bdd43 194 struct worker_pool *pool; /* I: the associated pool */
4690c4ab 195 struct workqueue_struct *wq; /* I: the owning workqueue */
73f53c4a
TH
196 int work_color; /* L: current color */
197 int flush_color; /* L: flushing color */
8864b4e5 198 int refcnt; /* L: reference count */
73f53c4a
TH
199 int nr_in_flight[WORK_NR_COLORS];
200 /* L: nr of in_flight works */
1e19ffc6 201 int nr_active; /* L: nr of active works */
a0a1a5fd 202 int max_active; /* L: max active works */
1e19ffc6 203 struct list_head delayed_works; /* L: delayed works */
3c25a55d 204 struct list_head pwqs_node; /* WR: node on wq->pwqs */
2e109a28 205 struct list_head mayday_node; /* MD: node on wq->maydays */
8864b4e5
TH
206
207 /*
208 * Release of unbound pwq is punted to system_wq. See put_pwq()
209 * and pwq_unbound_release_workfn() for details. pool_workqueue
210 * itself is also sched-RCU protected so that the first pwq can be
b09f4fd3 211 * determined without grabbing wq->mutex.
8864b4e5
TH
212 */
213 struct work_struct unbound_release_work;
214 struct rcu_head rcu;
e904e6c2 215} __aligned(1 << WORK_STRUCT_FLAG_BITS);
1da177e4 216
73f53c4a
TH
217/*
218 * Structure used to wait for workqueue flush.
219 */
220struct wq_flusher {
3c25a55d
LJ
221 struct list_head list; /* WQ: list of flushers */
222 int flush_color; /* WQ: flush color waiting for */
73f53c4a
TH
223 struct completion done; /* flush completion */
224};
225
226223ab
TH
226struct wq_device;
227
1da177e4 228/*
c5aa87bb
TH
229 * The externally visible workqueue. It relays the issued work items to
230 * the appropriate worker_pool through its pool_workqueues.
1da177e4
LT
231 */
232struct workqueue_struct {
3c25a55d 233 struct list_head pwqs; /* WR: all pwqs of this wq */
68e13a67 234 struct list_head list; /* PL: list of all workqueues */
73f53c4a 235
3c25a55d
LJ
236 struct mutex mutex; /* protects this wq */
237 int work_color; /* WQ: current work color */
238 int flush_color; /* WQ: current flush color */
112202d9 239 atomic_t nr_pwqs_to_flush; /* flush in progress */
3c25a55d
LJ
240 struct wq_flusher *first_flusher; /* WQ: first flusher */
241 struct list_head flusher_queue; /* WQ: flush waiters */
242 struct list_head flusher_overflow; /* WQ: flush overflow list */
73f53c4a 243
2e109a28 244 struct list_head maydays; /* MD: pwqs requesting rescue */
e22bee78
TH
245 struct worker *rescuer; /* I: rescue worker */
246
87fc741e 247 int nr_drainers; /* WQ: drain in progress */
a357fc03 248 int saved_max_active; /* WQ: saved pwq max_active */
226223ab 249
6029a918 250 struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */
4c16bd32 251 struct pool_workqueue *dfl_pwq; /* WQ: only for unbound wqs */
6029a918 252
226223ab
TH
253#ifdef CONFIG_SYSFS
254 struct wq_device *wq_dev; /* I: for sysfs interface */
255#endif
4e6045f1 256#ifdef CONFIG_LOCKDEP
4690c4ab 257 struct lockdep_map lockdep_map;
4e6045f1 258#endif
ecf6881f 259 char name[WQ_NAME_LEN]; /* I: workqueue name */
2728fd2f
TH
260
261 /* hot fields used during command issue, aligned to cacheline */
262 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
263 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
df2d5ae4 264 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */
1da177e4
LT
265};
266
e904e6c2
TH
267static struct kmem_cache *pwq_cache;
268
bce90380
TH
269static int wq_numa_tbl_len; /* highest possible NUMA node id + 1 */
270static cpumask_var_t *wq_numa_possible_cpumask;
271 /* possible CPUs of each node */
272
d55262c4
TH
273static bool wq_disable_numa;
274module_param_named(disable_numa, wq_disable_numa, bool, 0444);
275
cee22a15
VK
276/* see the comment above the definition of WQ_POWER_EFFICIENT */
277#ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
278static bool wq_power_efficient = true;
279#else
280static bool wq_power_efficient;
281#endif
282
283module_param_named(power_efficient, wq_power_efficient, bool, 0444);
284
bce90380
TH
285static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
286
4c16bd32
TH
287/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
288static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
289
68e13a67 290static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
2e109a28 291static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
5bcab335 292
68e13a67
LJ
293static LIST_HEAD(workqueues); /* PL: list of all workqueues */
294static bool workqueue_freezing; /* PL: have wqs started freezing? */
7d19c5ce
TH
295
296/* the per-cpu worker pools */
297static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
298 cpu_worker_pools);
299
68e13a67 300static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
7d19c5ce 301
68e13a67 302/* PL: hash of all unbound pools keyed by pool->attrs */
29c91e99
TH
303static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
304
c5aa87bb 305/* I: attributes used when instantiating standard unbound pools on demand */
29c91e99
TH
306static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
307
8a2b7538
TH
308/* I: attributes used when instantiating ordered pools on demand */
309static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
310
d320c038 311struct workqueue_struct *system_wq __read_mostly;
ad7b1f84 312EXPORT_SYMBOL(system_wq);
044c782c 313struct workqueue_struct *system_highpri_wq __read_mostly;
1aabe902 314EXPORT_SYMBOL_GPL(system_highpri_wq);
044c782c 315struct workqueue_struct *system_long_wq __read_mostly;
d320c038 316EXPORT_SYMBOL_GPL(system_long_wq);
044c782c 317struct workqueue_struct *system_unbound_wq __read_mostly;
f3421797 318EXPORT_SYMBOL_GPL(system_unbound_wq);
044c782c 319struct workqueue_struct *system_freezable_wq __read_mostly;
24d51add 320EXPORT_SYMBOL_GPL(system_freezable_wq);
0668106c
VK
321struct workqueue_struct *system_power_efficient_wq __read_mostly;
322EXPORT_SYMBOL_GPL(system_power_efficient_wq);
323struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
324EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
d320c038 325
7d19c5ce
TH
326static int worker_thread(void *__worker);
327static void copy_workqueue_attrs(struct workqueue_attrs *to,
328 const struct workqueue_attrs *from);
329
97bd2347
TH
330#define CREATE_TRACE_POINTS
331#include <trace/events/workqueue.h>
332
68e13a67 333#define assert_rcu_or_pool_mutex() \
5bcab335 334 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
68e13a67
LJ
335 lockdep_is_held(&wq_pool_mutex), \
336 "sched RCU or wq_pool_mutex should be held")
5bcab335 337
b09f4fd3 338#define assert_rcu_or_wq_mutex(wq) \
76af4d93 339 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
b5927605 340 lockdep_is_held(&wq->mutex), \
b09f4fd3 341 "sched RCU or wq->mutex should be held")
76af4d93 342
f02ae73a
TH
343#define for_each_cpu_worker_pool(pool, cpu) \
344 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
345 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
7a62c2c8 346 (pool)++)
4ce62e9e 347
17116969
TH
348/**
349 * for_each_pool - iterate through all worker_pools in the system
350 * @pool: iteration cursor
611c92a0 351 * @pi: integer used for iteration
fa1b54e6 352 *
68e13a67
LJ
353 * This must be called either with wq_pool_mutex held or sched RCU read
354 * locked. If the pool needs to be used beyond the locking in effect, the
355 * caller is responsible for guaranteeing that the pool stays online.
fa1b54e6
TH
356 *
357 * The if/else clause exists only for the lockdep assertion and can be
358 * ignored.
17116969 359 */
611c92a0
TH
360#define for_each_pool(pool, pi) \
361 idr_for_each_entry(&worker_pool_idr, pool, pi) \
68e13a67 362 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
fa1b54e6 363 else
17116969 364
822d8405
TH
365/**
366 * for_each_pool_worker - iterate through all workers of a worker_pool
367 * @worker: iteration cursor
822d8405
TH
368 * @pool: worker_pool to iterate workers of
369 *
92f9c5c4 370 * This must be called with @pool->attach_mutex.
822d8405
TH
371 *
372 * The if/else clause exists only for the lockdep assertion and can be
373 * ignored.
374 */
da028469
LJ
375#define for_each_pool_worker(worker, pool) \
376 list_for_each_entry((worker), &(pool)->workers, node) \
92f9c5c4 377 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
822d8405
TH
378 else
379
49e3cf44
TH
380/**
381 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
382 * @pwq: iteration cursor
383 * @wq: the target workqueue
76af4d93 384 *
b09f4fd3 385 * This must be called either with wq->mutex held or sched RCU read locked.
794b18bc
TH
386 * If the pwq needs to be used beyond the locking in effect, the caller is
387 * responsible for guaranteeing that the pwq stays online.
76af4d93
TH
388 *
389 * The if/else clause exists only for the lockdep assertion and can be
390 * ignored.
49e3cf44
TH
391 */
392#define for_each_pwq(pwq, wq) \
76af4d93 393 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
b09f4fd3 394 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
76af4d93 395 else
f3421797 396
dc186ad7
TG
397#ifdef CONFIG_DEBUG_OBJECTS_WORK
398
399static struct debug_obj_descr work_debug_descr;
400
99777288
SG
401static void *work_debug_hint(void *addr)
402{
403 return ((struct work_struct *) addr)->func;
404}
405
dc186ad7
TG
406/*
407 * fixup_init is called when:
408 * - an active object is initialized
409 */
410static int work_fixup_init(void *addr, enum debug_obj_state state)
411{
412 struct work_struct *work = addr;
413
414 switch (state) {
415 case ODEBUG_STATE_ACTIVE:
416 cancel_work_sync(work);
417 debug_object_init(work, &work_debug_descr);
418 return 1;
419 default:
420 return 0;
421 }
422}
423
424/*
425 * fixup_activate is called when:
426 * - an active object is activated
427 * - an unknown object is activated (might be a statically initialized object)
428 */
429static int work_fixup_activate(void *addr, enum debug_obj_state state)
430{
431 struct work_struct *work = addr;
432
433 switch (state) {
434
435 case ODEBUG_STATE_NOTAVAILABLE:
436 /*
437 * This is not really a fixup. The work struct was
438 * statically initialized. We just make sure that it
439 * is tracked in the object tracker.
440 */
22df02bb 441 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
dc186ad7
TG
442 debug_object_init(work, &work_debug_descr);
443 debug_object_activate(work, &work_debug_descr);
444 return 0;
445 }
446 WARN_ON_ONCE(1);
447 return 0;
448
449 case ODEBUG_STATE_ACTIVE:
450 WARN_ON(1);
451
452 default:
453 return 0;
454 }
455}
456
457/*
458 * fixup_free is called when:
459 * - an active object is freed
460 */
461static int work_fixup_free(void *addr, enum debug_obj_state state)
462{
463 struct work_struct *work = addr;
464
465 switch (state) {
466 case ODEBUG_STATE_ACTIVE:
467 cancel_work_sync(work);
468 debug_object_free(work, &work_debug_descr);
469 return 1;
470 default:
471 return 0;
472 }
473}
474
475static struct debug_obj_descr work_debug_descr = {
476 .name = "work_struct",
99777288 477 .debug_hint = work_debug_hint,
dc186ad7
TG
478 .fixup_init = work_fixup_init,
479 .fixup_activate = work_fixup_activate,
480 .fixup_free = work_fixup_free,
481};
482
483static inline void debug_work_activate(struct work_struct *work)
484{
485 debug_object_activate(work, &work_debug_descr);
486}
487
488static inline void debug_work_deactivate(struct work_struct *work)
489{
490 debug_object_deactivate(work, &work_debug_descr);
491}
492
493void __init_work(struct work_struct *work, int onstack)
494{
495 if (onstack)
496 debug_object_init_on_stack(work, &work_debug_descr);
497 else
498 debug_object_init(work, &work_debug_descr);
499}
500EXPORT_SYMBOL_GPL(__init_work);
501
502void destroy_work_on_stack(struct work_struct *work)
503{
504 debug_object_free(work, &work_debug_descr);
505}
506EXPORT_SYMBOL_GPL(destroy_work_on_stack);
507
ea2e64f2
TG
508void destroy_delayed_work_on_stack(struct delayed_work *work)
509{
510 destroy_timer_on_stack(&work->timer);
511 debug_object_free(&work->work, &work_debug_descr);
512}
513EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
514
dc186ad7
TG
515#else
516static inline void debug_work_activate(struct work_struct *work) { }
517static inline void debug_work_deactivate(struct work_struct *work) { }
518#endif
519
4e8b22bd
LB
520/**
521 * worker_pool_assign_id - allocate ID and assing it to @pool
522 * @pool: the pool pointer of interest
523 *
524 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
525 * successfully, -errno on failure.
526 */
9daf9e67
TH
527static int worker_pool_assign_id(struct worker_pool *pool)
528{
529 int ret;
530
68e13a67 531 lockdep_assert_held(&wq_pool_mutex);
5bcab335 532
4e8b22bd
LB
533 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
534 GFP_KERNEL);
229641a6 535 if (ret >= 0) {
e68035fb 536 pool->id = ret;
229641a6
TH
537 return 0;
538 }
fa1b54e6 539 return ret;
7c3eed5c
TH
540}
541
df2d5ae4
TH
542/**
543 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
544 * @wq: the target workqueue
545 * @node: the node ID
546 *
547 * This must be called either with pwq_lock held or sched RCU read locked.
548 * If the pwq needs to be used beyond the locking in effect, the caller is
549 * responsible for guaranteeing that the pwq stays online.
d185af30
YB
550 *
551 * Return: The unbound pool_workqueue for @node.
df2d5ae4
TH
552 */
553static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
554 int node)
555{
556 assert_rcu_or_wq_mutex(wq);
557 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
558}
559
73f53c4a
TH
560static unsigned int work_color_to_flags(int color)
561{
562 return color << WORK_STRUCT_COLOR_SHIFT;
563}
564
565static int get_work_color(struct work_struct *work)
566{
567 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
568 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
569}
570
571static int work_next_color(int color)
572{
573 return (color + 1) % WORK_NR_COLORS;
574}
1da177e4 575
14441960 576/*
112202d9
TH
577 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
578 * contain the pointer to the queued pwq. Once execution starts, the flag
7c3eed5c 579 * is cleared and the high bits contain OFFQ flags and pool ID.
7a22ad75 580 *
112202d9
TH
581 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
582 * and clear_work_data() can be used to set the pwq, pool or clear
bbb68dfa
TH
583 * work->data. These functions should only be called while the work is
584 * owned - ie. while the PENDING bit is set.
7a22ad75 585 *
112202d9 586 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
7c3eed5c 587 * corresponding to a work. Pool is available once the work has been
112202d9 588 * queued anywhere after initialization until it is sync canceled. pwq is
7c3eed5c 589 * available only while the work item is queued.
7a22ad75 590 *
bbb68dfa
TH
591 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
592 * canceled. While being canceled, a work item may have its PENDING set
593 * but stay off timer and worklist for arbitrarily long and nobody should
594 * try to steal the PENDING bit.
14441960 595 */
7a22ad75
TH
596static inline void set_work_data(struct work_struct *work, unsigned long data,
597 unsigned long flags)
365970a1 598{
6183c009 599 WARN_ON_ONCE(!work_pending(work));
7a22ad75
TH
600 atomic_long_set(&work->data, data | flags | work_static(work));
601}
365970a1 602
112202d9 603static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
7a22ad75
TH
604 unsigned long extra_flags)
605{
112202d9
TH
606 set_work_data(work, (unsigned long)pwq,
607 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
365970a1
DH
608}
609
4468a00f
LJ
610static void set_work_pool_and_keep_pending(struct work_struct *work,
611 int pool_id)
612{
613 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
614 WORK_STRUCT_PENDING);
615}
616
7c3eed5c
TH
617static void set_work_pool_and_clear_pending(struct work_struct *work,
618 int pool_id)
7a22ad75 619{
23657bb1
TH
620 /*
621 * The following wmb is paired with the implied mb in
622 * test_and_set_bit(PENDING) and ensures all updates to @work made
623 * here are visible to and precede any updates by the next PENDING
624 * owner.
625 */
626 smp_wmb();
7c3eed5c 627 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
7a22ad75 628}
f756d5e2 629
7a22ad75 630static void clear_work_data(struct work_struct *work)
1da177e4 631{
7c3eed5c
TH
632 smp_wmb(); /* see set_work_pool_and_clear_pending() */
633 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
1da177e4
LT
634}
635
112202d9 636static struct pool_workqueue *get_work_pwq(struct work_struct *work)
b1f4ec17 637{
e120153d 638 unsigned long data = atomic_long_read(&work->data);
7a22ad75 639
112202d9 640 if (data & WORK_STRUCT_PWQ)
e120153d
TH
641 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
642 else
643 return NULL;
4d707b9f
ON
644}
645
7c3eed5c
TH
646/**
647 * get_work_pool - return the worker_pool a given work was associated with
648 * @work: the work item of interest
649 *
68e13a67
LJ
650 * Pools are created and destroyed under wq_pool_mutex, and allows read
651 * access under sched-RCU read lock. As such, this function should be
652 * called under wq_pool_mutex or with preemption disabled.
fa1b54e6
TH
653 *
654 * All fields of the returned pool are accessible as long as the above
655 * mentioned locking is in effect. If the returned pool needs to be used
656 * beyond the critical section, the caller is responsible for ensuring the
657 * returned pool is and stays online.
d185af30
YB
658 *
659 * Return: The worker_pool @work was last associated with. %NULL if none.
7c3eed5c
TH
660 */
661static struct worker_pool *get_work_pool(struct work_struct *work)
365970a1 662{
e120153d 663 unsigned long data = atomic_long_read(&work->data);
7c3eed5c 664 int pool_id;
7a22ad75 665
68e13a67 666 assert_rcu_or_pool_mutex();
fa1b54e6 667
112202d9
TH
668 if (data & WORK_STRUCT_PWQ)
669 return ((struct pool_workqueue *)
7c3eed5c 670 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
7a22ad75 671
7c3eed5c
TH
672 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
673 if (pool_id == WORK_OFFQ_POOL_NONE)
7a22ad75
TH
674 return NULL;
675
fa1b54e6 676 return idr_find(&worker_pool_idr, pool_id);
7c3eed5c
TH
677}
678
679/**
680 * get_work_pool_id - return the worker pool ID a given work is associated with
681 * @work: the work item of interest
682 *
d185af30 683 * Return: The worker_pool ID @work was last associated with.
7c3eed5c
TH
684 * %WORK_OFFQ_POOL_NONE if none.
685 */
686static int get_work_pool_id(struct work_struct *work)
687{
54d5b7d0
LJ
688 unsigned long data = atomic_long_read(&work->data);
689
112202d9
TH
690 if (data & WORK_STRUCT_PWQ)
691 return ((struct pool_workqueue *)
54d5b7d0 692 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
7c3eed5c 693
54d5b7d0 694 return data >> WORK_OFFQ_POOL_SHIFT;
7c3eed5c
TH
695}
696
bbb68dfa
TH
697static void mark_work_canceling(struct work_struct *work)
698{
7c3eed5c 699 unsigned long pool_id = get_work_pool_id(work);
bbb68dfa 700
7c3eed5c
TH
701 pool_id <<= WORK_OFFQ_POOL_SHIFT;
702 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
bbb68dfa
TH
703}
704
705static bool work_is_canceling(struct work_struct *work)
706{
707 unsigned long data = atomic_long_read(&work->data);
708
112202d9 709 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
bbb68dfa
TH
710}
711
e22bee78 712/*
3270476a
TH
713 * Policy functions. These define the policies on how the global worker
714 * pools are managed. Unless noted otherwise, these functions assume that
d565ed63 715 * they're being called with pool->lock held.
e22bee78
TH
716 */
717
63d95a91 718static bool __need_more_worker(struct worker_pool *pool)
a848e3b6 719{
e19e397a 720 return !atomic_read(&pool->nr_running);
a848e3b6
ON
721}
722
4594bf15 723/*
e22bee78
TH
724 * Need to wake up a worker? Called from anything but currently
725 * running workers.
974271c4
TH
726 *
727 * Note that, because unbound workers never contribute to nr_running, this
706026c2 728 * function will always return %true for unbound pools as long as the
974271c4 729 * worklist isn't empty.
4594bf15 730 */
63d95a91 731static bool need_more_worker(struct worker_pool *pool)
365970a1 732{
63d95a91 733 return !list_empty(&pool->worklist) && __need_more_worker(pool);
e22bee78 734}
4594bf15 735
e22bee78 736/* Can I start working? Called from busy but !running workers. */
63d95a91 737static bool may_start_working(struct worker_pool *pool)
e22bee78 738{
63d95a91 739 return pool->nr_idle;
e22bee78
TH
740}
741
742/* Do I need to keep working? Called from currently running workers. */
63d95a91 743static bool keep_working(struct worker_pool *pool)
e22bee78 744{
e19e397a
TH
745 return !list_empty(&pool->worklist) &&
746 atomic_read(&pool->nr_running) <= 1;
e22bee78
TH
747}
748
749/* Do we need a new worker? Called from manager. */
63d95a91 750static bool need_to_create_worker(struct worker_pool *pool)
e22bee78 751{
63d95a91 752 return need_more_worker(pool) && !may_start_working(pool);
e22bee78 753}
365970a1 754
e22bee78 755/* Do we have too many workers and should some go away? */
63d95a91 756static bool too_many_workers(struct worker_pool *pool)
e22bee78 757{
34a06bd6 758 bool managing = mutex_is_locked(&pool->manager_arb);
63d95a91
TH
759 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
760 int nr_busy = pool->nr_workers - nr_idle;
e22bee78 761
ea1abd61
LJ
762 /*
763 * nr_idle and idle_list may disagree if idle rebinding is in
764 * progress. Never return %true if idle_list is empty.
765 */
766 if (list_empty(&pool->idle_list))
767 return false;
768
e22bee78 769 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
365970a1
DH
770}
771
4d707b9f 772/*
e22bee78
TH
773 * Wake up functions.
774 */
775
7e11629d 776/* Return the first worker. Safe with preemption disabled */
63d95a91 777static struct worker *first_worker(struct worker_pool *pool)
7e11629d 778{
63d95a91 779 if (unlikely(list_empty(&pool->idle_list)))
7e11629d
TH
780 return NULL;
781
63d95a91 782 return list_first_entry(&pool->idle_list, struct worker, entry);
7e11629d
TH
783}
784
785/**
786 * wake_up_worker - wake up an idle worker
63d95a91 787 * @pool: worker pool to wake worker from
7e11629d 788 *
63d95a91 789 * Wake up the first idle worker of @pool.
7e11629d
TH
790 *
791 * CONTEXT:
d565ed63 792 * spin_lock_irq(pool->lock).
7e11629d 793 */
63d95a91 794static void wake_up_worker(struct worker_pool *pool)
7e11629d 795{
63d95a91 796 struct worker *worker = first_worker(pool);
7e11629d
TH
797
798 if (likely(worker))
799 wake_up_process(worker->task);
800}
801
d302f017 802/**
e22bee78
TH
803 * wq_worker_waking_up - a worker is waking up
804 * @task: task waking up
805 * @cpu: CPU @task is waking up to
806 *
807 * This function is called during try_to_wake_up() when a worker is
808 * being awoken.
809 *
810 * CONTEXT:
811 * spin_lock_irq(rq->lock)
812 */
d84ff051 813void wq_worker_waking_up(struct task_struct *task, int cpu)
e22bee78
TH
814{
815 struct worker *worker = kthread_data(task);
816
36576000 817 if (!(worker->flags & WORKER_NOT_RUNNING)) {
ec22ca5e 818 WARN_ON_ONCE(worker->pool->cpu != cpu);
e19e397a 819 atomic_inc(&worker->pool->nr_running);
36576000 820 }
e22bee78
TH
821}
822
823/**
824 * wq_worker_sleeping - a worker is going to sleep
825 * @task: task going to sleep
826 * @cpu: CPU in question, must be the current CPU number
827 *
828 * This function is called during schedule() when a busy worker is
829 * going to sleep. Worker on the same cpu can be woken up by
830 * returning pointer to its task.
831 *
832 * CONTEXT:
833 * spin_lock_irq(rq->lock)
834 *
d185af30 835 * Return:
e22bee78
TH
836 * Worker task on @cpu to wake up, %NULL if none.
837 */
d84ff051 838struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
e22bee78
TH
839{
840 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
111c225a 841 struct worker_pool *pool;
e22bee78 842
111c225a
TH
843 /*
844 * Rescuers, which may not have all the fields set up like normal
845 * workers, also reach here, let's not access anything before
846 * checking NOT_RUNNING.
847 */
2d64672e 848 if (worker->flags & WORKER_NOT_RUNNING)
e22bee78
TH
849 return NULL;
850
111c225a 851 pool = worker->pool;
111c225a 852
e22bee78 853 /* this can only happen on the local cpu */
6183c009
TH
854 if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
855 return NULL;
e22bee78
TH
856
857 /*
858 * The counterpart of the following dec_and_test, implied mb,
859 * worklist not empty test sequence is in insert_work().
860 * Please read comment there.
861 *
628c78e7
TH
862 * NOT_RUNNING is clear. This means that we're bound to and
863 * running on the local cpu w/ rq lock held and preemption
864 * disabled, which in turn means that none else could be
d565ed63 865 * manipulating idle_list, so dereferencing idle_list without pool
628c78e7 866 * lock is safe.
e22bee78 867 */
e19e397a
TH
868 if (atomic_dec_and_test(&pool->nr_running) &&
869 !list_empty(&pool->worklist))
63d95a91 870 to_wakeup = first_worker(pool);
e22bee78
TH
871 return to_wakeup ? to_wakeup->task : NULL;
872}
873
874/**
875 * worker_set_flags - set worker flags and adjust nr_running accordingly
cb444766 876 * @worker: self
d302f017
TH
877 * @flags: flags to set
878 * @wakeup: wakeup an idle worker if necessary
879 *
e22bee78
TH
880 * Set @flags in @worker->flags and adjust nr_running accordingly. If
881 * nr_running becomes zero and @wakeup is %true, an idle worker is
882 * woken up.
d302f017 883 *
cb444766 884 * CONTEXT:
d565ed63 885 * spin_lock_irq(pool->lock)
d302f017
TH
886 */
887static inline void worker_set_flags(struct worker *worker, unsigned int flags,
888 bool wakeup)
889{
bd7bdd43 890 struct worker_pool *pool = worker->pool;
e22bee78 891
cb444766
TH
892 WARN_ON_ONCE(worker->task != current);
893
e22bee78
TH
894 /*
895 * If transitioning into NOT_RUNNING, adjust nr_running and
896 * wake up an idle worker as necessary if requested by
897 * @wakeup.
898 */
899 if ((flags & WORKER_NOT_RUNNING) &&
900 !(worker->flags & WORKER_NOT_RUNNING)) {
e22bee78 901 if (wakeup) {
e19e397a 902 if (atomic_dec_and_test(&pool->nr_running) &&
bd7bdd43 903 !list_empty(&pool->worklist))
63d95a91 904 wake_up_worker(pool);
e22bee78 905 } else
e19e397a 906 atomic_dec(&pool->nr_running);
e22bee78
TH
907 }
908
d302f017
TH
909 worker->flags |= flags;
910}
911
912/**
e22bee78 913 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
cb444766 914 * @worker: self
d302f017
TH
915 * @flags: flags to clear
916 *
e22bee78 917 * Clear @flags in @worker->flags and adjust nr_running accordingly.
d302f017 918 *
cb444766 919 * CONTEXT:
d565ed63 920 * spin_lock_irq(pool->lock)
d302f017
TH
921 */
922static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
923{
63d95a91 924 struct worker_pool *pool = worker->pool;
e22bee78
TH
925 unsigned int oflags = worker->flags;
926
cb444766
TH
927 WARN_ON_ONCE(worker->task != current);
928
d302f017 929 worker->flags &= ~flags;
e22bee78 930
42c025f3
TH
931 /*
932 * If transitioning out of NOT_RUNNING, increment nr_running. Note
933 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
934 * of multiple flags, not a single flag.
935 */
e22bee78
TH
936 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
937 if (!(worker->flags & WORKER_NOT_RUNNING))
e19e397a 938 atomic_inc(&pool->nr_running);
d302f017
TH
939}
940
8cca0eea
TH
941/**
942 * find_worker_executing_work - find worker which is executing a work
c9e7cf27 943 * @pool: pool of interest
8cca0eea
TH
944 * @work: work to find worker for
945 *
c9e7cf27
TH
946 * Find a worker which is executing @work on @pool by searching
947 * @pool->busy_hash which is keyed by the address of @work. For a worker
a2c1c57b
TH
948 * to match, its current execution should match the address of @work and
949 * its work function. This is to avoid unwanted dependency between
950 * unrelated work executions through a work item being recycled while still
951 * being executed.
952 *
953 * This is a bit tricky. A work item may be freed once its execution
954 * starts and nothing prevents the freed area from being recycled for
955 * another work item. If the same work item address ends up being reused
956 * before the original execution finishes, workqueue will identify the
957 * recycled work item as currently executing and make it wait until the
958 * current execution finishes, introducing an unwanted dependency.
959 *
c5aa87bb
TH
960 * This function checks the work item address and work function to avoid
961 * false positives. Note that this isn't complete as one may construct a
962 * work function which can introduce dependency onto itself through a
963 * recycled work item. Well, if somebody wants to shoot oneself in the
964 * foot that badly, there's only so much we can do, and if such deadlock
965 * actually occurs, it should be easy to locate the culprit work function.
8cca0eea
TH
966 *
967 * CONTEXT:
d565ed63 968 * spin_lock_irq(pool->lock).
8cca0eea 969 *
d185af30
YB
970 * Return:
971 * Pointer to worker which is executing @work if found, %NULL
8cca0eea 972 * otherwise.
4d707b9f 973 */
c9e7cf27 974static struct worker *find_worker_executing_work(struct worker_pool *pool,
8cca0eea 975 struct work_struct *work)
4d707b9f 976{
42f8570f 977 struct worker *worker;
42f8570f 978
b67bfe0d 979 hash_for_each_possible(pool->busy_hash, worker, hentry,
a2c1c57b
TH
980 (unsigned long)work)
981 if (worker->current_work == work &&
982 worker->current_func == work->func)
42f8570f
SL
983 return worker;
984
985 return NULL;
4d707b9f
ON
986}
987
bf4ede01
TH
988/**
989 * move_linked_works - move linked works to a list
990 * @work: start of series of works to be scheduled
991 * @head: target list to append @work to
992 * @nextp: out paramter for nested worklist walking
993 *
994 * Schedule linked works starting from @work to @head. Work series to
995 * be scheduled starts at @work and includes any consecutive work with
996 * WORK_STRUCT_LINKED set in its predecessor.
997 *
998 * If @nextp is not NULL, it's updated to point to the next work of
999 * the last scheduled work. This allows move_linked_works() to be
1000 * nested inside outer list_for_each_entry_safe().
1001 *
1002 * CONTEXT:
d565ed63 1003 * spin_lock_irq(pool->lock).
bf4ede01
TH
1004 */
1005static void move_linked_works(struct work_struct *work, struct list_head *head,
1006 struct work_struct **nextp)
1007{
1008 struct work_struct *n;
1009
1010 /*
1011 * Linked worklist will always end before the end of the list,
1012 * use NULL for list head.
1013 */
1014 list_for_each_entry_safe_from(work, n, NULL, entry) {
1015 list_move_tail(&work->entry, head);
1016 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1017 break;
1018 }
1019
1020 /*
1021 * If we're already inside safe list traversal and have moved
1022 * multiple works to the scheduled queue, the next position
1023 * needs to be updated.
1024 */
1025 if (nextp)
1026 *nextp = n;
1027}
1028
8864b4e5
TH
1029/**
1030 * get_pwq - get an extra reference on the specified pool_workqueue
1031 * @pwq: pool_workqueue to get
1032 *
1033 * Obtain an extra reference on @pwq. The caller should guarantee that
1034 * @pwq has positive refcnt and be holding the matching pool->lock.
1035 */
1036static void get_pwq(struct pool_workqueue *pwq)
1037{
1038 lockdep_assert_held(&pwq->pool->lock);
1039 WARN_ON_ONCE(pwq->refcnt <= 0);
1040 pwq->refcnt++;
1041}
1042
1043/**
1044 * put_pwq - put a pool_workqueue reference
1045 * @pwq: pool_workqueue to put
1046 *
1047 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1048 * destruction. The caller should be holding the matching pool->lock.
1049 */
1050static void put_pwq(struct pool_workqueue *pwq)
1051{
1052 lockdep_assert_held(&pwq->pool->lock);
1053 if (likely(--pwq->refcnt))
1054 return;
1055 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1056 return;
1057 /*
1058 * @pwq can't be released under pool->lock, bounce to
1059 * pwq_unbound_release_workfn(). This never recurses on the same
1060 * pool->lock as this path is taken only for unbound workqueues and
1061 * the release work item is scheduled on a per-cpu workqueue. To
1062 * avoid lockdep warning, unbound pool->locks are given lockdep
1063 * subclass of 1 in get_unbound_pool().
1064 */
1065 schedule_work(&pwq->unbound_release_work);
1066}
1067
dce90d47
TH
1068/**
1069 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1070 * @pwq: pool_workqueue to put (can be %NULL)
1071 *
1072 * put_pwq() with locking. This function also allows %NULL @pwq.
1073 */
1074static void put_pwq_unlocked(struct pool_workqueue *pwq)
1075{
1076 if (pwq) {
1077 /*
1078 * As both pwqs and pools are sched-RCU protected, the
1079 * following lock operations are safe.
1080 */
1081 spin_lock_irq(&pwq->pool->lock);
1082 put_pwq(pwq);
1083 spin_unlock_irq(&pwq->pool->lock);
1084 }
1085}
1086
112202d9 1087static void pwq_activate_delayed_work(struct work_struct *work)
bf4ede01 1088{
112202d9 1089 struct pool_workqueue *pwq = get_work_pwq(work);
bf4ede01
TH
1090
1091 trace_workqueue_activate_work(work);
112202d9 1092 move_linked_works(work, &pwq->pool->worklist, NULL);
bf4ede01 1093 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
112202d9 1094 pwq->nr_active++;
bf4ede01
TH
1095}
1096
112202d9 1097static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
3aa62497 1098{
112202d9 1099 struct work_struct *work = list_first_entry(&pwq->delayed_works,
3aa62497
LJ
1100 struct work_struct, entry);
1101
112202d9 1102 pwq_activate_delayed_work(work);
3aa62497
LJ
1103}
1104
bf4ede01 1105/**
112202d9
TH
1106 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1107 * @pwq: pwq of interest
bf4ede01 1108 * @color: color of work which left the queue
bf4ede01
TH
1109 *
1110 * A work either has completed or is removed from pending queue,
112202d9 1111 * decrement nr_in_flight of its pwq and handle workqueue flushing.
bf4ede01
TH
1112 *
1113 * CONTEXT:
d565ed63 1114 * spin_lock_irq(pool->lock).
bf4ede01 1115 */
112202d9 1116static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
bf4ede01 1117{
8864b4e5 1118 /* uncolored work items don't participate in flushing or nr_active */
bf4ede01 1119 if (color == WORK_NO_COLOR)
8864b4e5 1120 goto out_put;
bf4ede01 1121
112202d9 1122 pwq->nr_in_flight[color]--;
bf4ede01 1123
112202d9
TH
1124 pwq->nr_active--;
1125 if (!list_empty(&pwq->delayed_works)) {
b3f9f405 1126 /* one down, submit a delayed one */
112202d9
TH
1127 if (pwq->nr_active < pwq->max_active)
1128 pwq_activate_first_delayed(pwq);
bf4ede01
TH
1129 }
1130
1131 /* is flush in progress and are we at the flushing tip? */
112202d9 1132 if (likely(pwq->flush_color != color))
8864b4e5 1133 goto out_put;
bf4ede01
TH
1134
1135 /* are there still in-flight works? */
112202d9 1136 if (pwq->nr_in_flight[color])
8864b4e5 1137 goto out_put;
bf4ede01 1138
112202d9
TH
1139 /* this pwq is done, clear flush_color */
1140 pwq->flush_color = -1;
bf4ede01
TH
1141
1142 /*
112202d9 1143 * If this was the last pwq, wake up the first flusher. It
bf4ede01
TH
1144 * will handle the rest.
1145 */
112202d9
TH
1146 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1147 complete(&pwq->wq->first_flusher->done);
8864b4e5
TH
1148out_put:
1149 put_pwq(pwq);
bf4ede01
TH
1150}
1151
36e227d2 1152/**
bbb68dfa 1153 * try_to_grab_pending - steal work item from worklist and disable irq
36e227d2
TH
1154 * @work: work item to steal
1155 * @is_dwork: @work is a delayed_work
bbb68dfa 1156 * @flags: place to store irq state
36e227d2
TH
1157 *
1158 * Try to grab PENDING bit of @work. This function can handle @work in any
d185af30 1159 * stable state - idle, on timer or on worklist.
36e227d2 1160 *
d185af30 1161 * Return:
36e227d2
TH
1162 * 1 if @work was pending and we successfully stole PENDING
1163 * 0 if @work was idle and we claimed PENDING
1164 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
bbb68dfa
TH
1165 * -ENOENT if someone else is canceling @work, this state may persist
1166 * for arbitrarily long
36e227d2 1167 *
d185af30 1168 * Note:
bbb68dfa 1169 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
e0aecdd8
TH
1170 * interrupted while holding PENDING and @work off queue, irq must be
1171 * disabled on entry. This, combined with delayed_work->timer being
1172 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
bbb68dfa
TH
1173 *
1174 * On successful return, >= 0, irq is disabled and the caller is
1175 * responsible for releasing it using local_irq_restore(*@flags).
1176 *
e0aecdd8 1177 * This function is safe to call from any context including IRQ handler.
bf4ede01 1178 */
bbb68dfa
TH
1179static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1180 unsigned long *flags)
bf4ede01 1181{
d565ed63 1182 struct worker_pool *pool;
112202d9 1183 struct pool_workqueue *pwq;
bf4ede01 1184
bbb68dfa
TH
1185 local_irq_save(*flags);
1186
36e227d2
TH
1187 /* try to steal the timer if it exists */
1188 if (is_dwork) {
1189 struct delayed_work *dwork = to_delayed_work(work);
1190
e0aecdd8
TH
1191 /*
1192 * dwork->timer is irqsafe. If del_timer() fails, it's
1193 * guaranteed that the timer is not queued anywhere and not
1194 * running on the local CPU.
1195 */
36e227d2
TH
1196 if (likely(del_timer(&dwork->timer)))
1197 return 1;
1198 }
1199
1200 /* try to claim PENDING the normal way */
bf4ede01
TH
1201 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1202 return 0;
1203
1204 /*
1205 * The queueing is in progress, or it is already queued. Try to
1206 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1207 */
d565ed63
TH
1208 pool = get_work_pool(work);
1209 if (!pool)
bbb68dfa 1210 goto fail;
bf4ede01 1211
d565ed63 1212 spin_lock(&pool->lock);
0b3dae68 1213 /*
112202d9
TH
1214 * work->data is guaranteed to point to pwq only while the work
1215 * item is queued on pwq->wq, and both updating work->data to point
1216 * to pwq on queueing and to pool on dequeueing are done under
1217 * pwq->pool->lock. This in turn guarantees that, if work->data
1218 * points to pwq which is associated with a locked pool, the work
0b3dae68
LJ
1219 * item is currently queued on that pool.
1220 */
112202d9
TH
1221 pwq = get_work_pwq(work);
1222 if (pwq && pwq->pool == pool) {
16062836
TH
1223 debug_work_deactivate(work);
1224
1225 /*
1226 * A delayed work item cannot be grabbed directly because
1227 * it might have linked NO_COLOR work items which, if left
112202d9 1228 * on the delayed_list, will confuse pwq->nr_active
16062836
TH
1229 * management later on and cause stall. Make sure the work
1230 * item is activated before grabbing.
1231 */
1232 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
112202d9 1233 pwq_activate_delayed_work(work);
16062836
TH
1234
1235 list_del_init(&work->entry);
112202d9 1236 pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
16062836 1237
112202d9 1238 /* work->data points to pwq iff queued, point to pool */
16062836
TH
1239 set_work_pool_and_keep_pending(work, pool->id);
1240
1241 spin_unlock(&pool->lock);
1242 return 1;
bf4ede01 1243 }
d565ed63 1244 spin_unlock(&pool->lock);
bbb68dfa
TH
1245fail:
1246 local_irq_restore(*flags);
1247 if (work_is_canceling(work))
1248 return -ENOENT;
1249 cpu_relax();
36e227d2 1250 return -EAGAIN;
bf4ede01
TH
1251}
1252
4690c4ab 1253/**
706026c2 1254 * insert_work - insert a work into a pool
112202d9 1255 * @pwq: pwq @work belongs to
4690c4ab
TH
1256 * @work: work to insert
1257 * @head: insertion point
1258 * @extra_flags: extra WORK_STRUCT_* flags to set
1259 *
112202d9 1260 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
706026c2 1261 * work_struct flags.
4690c4ab
TH
1262 *
1263 * CONTEXT:
d565ed63 1264 * spin_lock_irq(pool->lock).
4690c4ab 1265 */
112202d9
TH
1266static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1267 struct list_head *head, unsigned int extra_flags)
b89deed3 1268{
112202d9 1269 struct worker_pool *pool = pwq->pool;
e22bee78 1270
4690c4ab 1271 /* we own @work, set data and link */
112202d9 1272 set_work_pwq(work, pwq, extra_flags);
1a4d9b0a 1273 list_add_tail(&work->entry, head);
8864b4e5 1274 get_pwq(pwq);
e22bee78
TH
1275
1276 /*
c5aa87bb
TH
1277 * Ensure either wq_worker_sleeping() sees the above
1278 * list_add_tail() or we see zero nr_running to avoid workers lying
1279 * around lazily while there are works to be processed.
e22bee78
TH
1280 */
1281 smp_mb();
1282
63d95a91
TH
1283 if (__need_more_worker(pool))
1284 wake_up_worker(pool);
b89deed3
ON
1285}
1286
c8efcc25
TH
1287/*
1288 * Test whether @work is being queued from another work executing on the
8d03ecfe 1289 * same workqueue.
c8efcc25
TH
1290 */
1291static bool is_chained_work(struct workqueue_struct *wq)
1292{
8d03ecfe
TH
1293 struct worker *worker;
1294
1295 worker = current_wq_worker();
1296 /*
1297 * Return %true iff I'm a worker execuing a work item on @wq. If
1298 * I'm @worker, it's safe to dereference it without locking.
1299 */
112202d9 1300 return worker && worker->current_pwq->wq == wq;
c8efcc25
TH
1301}
1302
d84ff051 1303static void __queue_work(int cpu, struct workqueue_struct *wq,
1da177e4
LT
1304 struct work_struct *work)
1305{
112202d9 1306 struct pool_workqueue *pwq;
c9178087 1307 struct worker_pool *last_pool;
1e19ffc6 1308 struct list_head *worklist;
8a2e8e5d 1309 unsigned int work_flags;
b75cac93 1310 unsigned int req_cpu = cpu;
8930caba
TH
1311
1312 /*
1313 * While a work item is PENDING && off queue, a task trying to
1314 * steal the PENDING will busy-loop waiting for it to either get
1315 * queued or lose PENDING. Grabbing PENDING and queueing should
1316 * happen with IRQ disabled.
1317 */
1318 WARN_ON_ONCE(!irqs_disabled());
1da177e4 1319
dc186ad7 1320 debug_work_activate(work);
1e19ffc6 1321
9ef28a73 1322 /* if draining, only works from the same workqueue are allowed */
618b01eb 1323 if (unlikely(wq->flags & __WQ_DRAINING) &&
c8efcc25 1324 WARN_ON_ONCE(!is_chained_work(wq)))
e41e704b 1325 return;
9e8cd2f5 1326retry:
df2d5ae4
TH
1327 if (req_cpu == WORK_CPU_UNBOUND)
1328 cpu = raw_smp_processor_id();
1329
c9178087 1330 /* pwq which will be used unless @work is executing elsewhere */
df2d5ae4 1331 if (!(wq->flags & WQ_UNBOUND))
7fb98ea7 1332 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
df2d5ae4
TH
1333 else
1334 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
dbf2576e 1335
c9178087
TH
1336 /*
1337 * If @work was previously on a different pool, it might still be
1338 * running there, in which case the work needs to be queued on that
1339 * pool to guarantee non-reentrancy.
1340 */
1341 last_pool = get_work_pool(work);
1342 if (last_pool && last_pool != pwq->pool) {
1343 struct worker *worker;
18aa9eff 1344
c9178087 1345 spin_lock(&last_pool->lock);
18aa9eff 1346
c9178087 1347 worker = find_worker_executing_work(last_pool, work);
18aa9eff 1348
c9178087
TH
1349 if (worker && worker->current_pwq->wq == wq) {
1350 pwq = worker->current_pwq;
8930caba 1351 } else {
c9178087
TH
1352 /* meh... not running there, queue here */
1353 spin_unlock(&last_pool->lock);
112202d9 1354 spin_lock(&pwq->pool->lock);
8930caba 1355 }
f3421797 1356 } else {
112202d9 1357 spin_lock(&pwq->pool->lock);
502ca9d8
TH
1358 }
1359
9e8cd2f5
TH
1360 /*
1361 * pwq is determined and locked. For unbound pools, we could have
1362 * raced with pwq release and it could already be dead. If its
1363 * refcnt is zero, repeat pwq selection. Note that pwqs never die
df2d5ae4
TH
1364 * without another pwq replacing it in the numa_pwq_tbl or while
1365 * work items are executing on it, so the retrying is guaranteed to
9e8cd2f5
TH
1366 * make forward-progress.
1367 */
1368 if (unlikely(!pwq->refcnt)) {
1369 if (wq->flags & WQ_UNBOUND) {
1370 spin_unlock(&pwq->pool->lock);
1371 cpu_relax();
1372 goto retry;
1373 }
1374 /* oops */
1375 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1376 wq->name, cpu);
1377 }
1378
112202d9
TH
1379 /* pwq determined, queue */
1380 trace_workqueue_queue_work(req_cpu, pwq, work);
502ca9d8 1381
f5b2552b 1382 if (WARN_ON(!list_empty(&work->entry))) {
112202d9 1383 spin_unlock(&pwq->pool->lock);
f5b2552b
DC
1384 return;
1385 }
1e19ffc6 1386
112202d9
TH
1387 pwq->nr_in_flight[pwq->work_color]++;
1388 work_flags = work_color_to_flags(pwq->work_color);
1e19ffc6 1389
112202d9 1390 if (likely(pwq->nr_active < pwq->max_active)) {
cdadf009 1391 trace_workqueue_activate_work(work);
112202d9
TH
1392 pwq->nr_active++;
1393 worklist = &pwq->pool->worklist;
8a2e8e5d
TH
1394 } else {
1395 work_flags |= WORK_STRUCT_DELAYED;
112202d9 1396 worklist = &pwq->delayed_works;
8a2e8e5d 1397 }
1e19ffc6 1398
112202d9 1399 insert_work(pwq, work, worklist, work_flags);
1e19ffc6 1400
112202d9 1401 spin_unlock(&pwq->pool->lock);
1da177e4
LT
1402}
1403
0fcb78c2 1404/**
c1a220e7
ZR
1405 * queue_work_on - queue work on specific cpu
1406 * @cpu: CPU number to execute work on
0fcb78c2
REB
1407 * @wq: workqueue to use
1408 * @work: work to queue
1409 *
c1a220e7
ZR
1410 * We queue the work to a specific CPU, the caller must ensure it
1411 * can't go away.
d185af30
YB
1412 *
1413 * Return: %false if @work was already on a queue, %true otherwise.
1da177e4 1414 */
d4283e93
TH
1415bool queue_work_on(int cpu, struct workqueue_struct *wq,
1416 struct work_struct *work)
1da177e4 1417{
d4283e93 1418 bool ret = false;
8930caba 1419 unsigned long flags;
ef1ca236 1420
8930caba 1421 local_irq_save(flags);
c1a220e7 1422
22df02bb 1423 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
4690c4ab 1424 __queue_work(cpu, wq, work);
d4283e93 1425 ret = true;
c1a220e7 1426 }
ef1ca236 1427
8930caba 1428 local_irq_restore(flags);
1da177e4
LT
1429 return ret;
1430}
ad7b1f84 1431EXPORT_SYMBOL(queue_work_on);
1da177e4 1432
d8e794df 1433void delayed_work_timer_fn(unsigned long __data)
1da177e4 1434{
52bad64d 1435 struct delayed_work *dwork = (struct delayed_work *)__data;
1da177e4 1436
e0aecdd8 1437 /* should have been called from irqsafe timer with irq already off */
60c057bc 1438 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
1da177e4 1439}
1438ade5 1440EXPORT_SYMBOL(delayed_work_timer_fn);
1da177e4 1441
7beb2edf
TH
1442static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1443 struct delayed_work *dwork, unsigned long delay)
1da177e4 1444{
7beb2edf
TH
1445 struct timer_list *timer = &dwork->timer;
1446 struct work_struct *work = &dwork->work;
7beb2edf
TH
1447
1448 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1449 timer->data != (unsigned long)dwork);
fc4b514f
TH
1450 WARN_ON_ONCE(timer_pending(timer));
1451 WARN_ON_ONCE(!list_empty(&work->entry));
7beb2edf 1452
8852aac2
TH
1453 /*
1454 * If @delay is 0, queue @dwork->work immediately. This is for
1455 * both optimization and correctness. The earliest @timer can
1456 * expire is on the closest next tick and delayed_work users depend
1457 * on that there's no such delay when @delay is 0.
1458 */
1459 if (!delay) {
1460 __queue_work(cpu, wq, &dwork->work);
1461 return;
1462 }
1463
7beb2edf 1464 timer_stats_timer_set_start_info(&dwork->timer);
1da177e4 1465
60c057bc 1466 dwork->wq = wq;
1265057f 1467 dwork->cpu = cpu;
7beb2edf
TH
1468 timer->expires = jiffies + delay;
1469
1470 if (unlikely(cpu != WORK_CPU_UNBOUND))
1471 add_timer_on(timer, cpu);
1472 else
1473 add_timer(timer);
1da177e4
LT
1474}
1475
0fcb78c2
REB
1476/**
1477 * queue_delayed_work_on - queue work on specific CPU after delay
1478 * @cpu: CPU number to execute work on
1479 * @wq: workqueue to use
af9997e4 1480 * @dwork: work to queue
0fcb78c2
REB
1481 * @delay: number of jiffies to wait before queueing
1482 *
d185af30 1483 * Return: %false if @work was already on a queue, %true otherwise. If
715f1300
TH
1484 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1485 * execution.
0fcb78c2 1486 */
d4283e93
TH
1487bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1488 struct delayed_work *dwork, unsigned long delay)
7a6bc1cd 1489{
52bad64d 1490 struct work_struct *work = &dwork->work;
d4283e93 1491 bool ret = false;
8930caba 1492 unsigned long flags;
7a6bc1cd 1493
8930caba
TH
1494 /* read the comment in __queue_work() */
1495 local_irq_save(flags);
7a6bc1cd 1496
22df02bb 1497 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
7beb2edf 1498 __queue_delayed_work(cpu, wq, dwork, delay);
d4283e93 1499 ret = true;
7a6bc1cd 1500 }
8a3e77cc 1501
8930caba 1502 local_irq_restore(flags);
7a6bc1cd
VP
1503 return ret;
1504}
ad7b1f84 1505EXPORT_SYMBOL(queue_delayed_work_on);
c7fc77f7 1506
8376fe22
TH
1507/**
1508 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1509 * @cpu: CPU number to execute work on
1510 * @wq: workqueue to use
1511 * @dwork: work to queue
1512 * @delay: number of jiffies to wait before queueing
1513 *
1514 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1515 * modify @dwork's timer so that it expires after @delay. If @delay is
1516 * zero, @work is guaranteed to be scheduled immediately regardless of its
1517 * current state.
1518 *
d185af30 1519 * Return: %false if @dwork was idle and queued, %true if @dwork was
8376fe22
TH
1520 * pending and its timer was modified.
1521 *
e0aecdd8 1522 * This function is safe to call from any context including IRQ handler.
8376fe22
TH
1523 * See try_to_grab_pending() for details.
1524 */
1525bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1526 struct delayed_work *dwork, unsigned long delay)
1527{
1528 unsigned long flags;
1529 int ret;
c7fc77f7 1530
8376fe22
TH
1531 do {
1532 ret = try_to_grab_pending(&dwork->work, true, &flags);
1533 } while (unlikely(ret == -EAGAIN));
63bc0362 1534
8376fe22
TH
1535 if (likely(ret >= 0)) {
1536 __queue_delayed_work(cpu, wq, dwork, delay);
1537 local_irq_restore(flags);
7a6bc1cd 1538 }
8376fe22
TH
1539
1540 /* -ENOENT from try_to_grab_pending() becomes %true */
7a6bc1cd
VP
1541 return ret;
1542}
8376fe22
TH
1543EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1544
c8e55f36
TH
1545/**
1546 * worker_enter_idle - enter idle state
1547 * @worker: worker which is entering idle state
1548 *
1549 * @worker is entering idle state. Update stats and idle timer if
1550 * necessary.
1551 *
1552 * LOCKING:
d565ed63 1553 * spin_lock_irq(pool->lock).
c8e55f36
TH
1554 */
1555static void worker_enter_idle(struct worker *worker)
1da177e4 1556{
bd7bdd43 1557 struct worker_pool *pool = worker->pool;
c8e55f36 1558
6183c009
TH
1559 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1560 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1561 (worker->hentry.next || worker->hentry.pprev)))
1562 return;
c8e55f36 1563
cb444766
TH
1564 /* can't use worker_set_flags(), also called from start_worker() */
1565 worker->flags |= WORKER_IDLE;
bd7bdd43 1566 pool->nr_idle++;
e22bee78 1567 worker->last_active = jiffies;
c8e55f36
TH
1568
1569 /* idle_list is LIFO */
bd7bdd43 1570 list_add(&worker->entry, &pool->idle_list);
db7bccf4 1571
628c78e7
TH
1572 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1573 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
cb444766 1574
544ecf31 1575 /*
706026c2 1576 * Sanity check nr_running. Because wq_unbind_fn() releases
d565ed63 1577 * pool->lock between setting %WORKER_UNBOUND and zapping
628c78e7
TH
1578 * nr_running, the warning may trigger spuriously. Check iff
1579 * unbind is not in progress.
544ecf31 1580 */
24647570 1581 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
bd7bdd43 1582 pool->nr_workers == pool->nr_idle &&
e19e397a 1583 atomic_read(&pool->nr_running));
c8e55f36
TH
1584}
1585
1586/**
1587 * worker_leave_idle - leave idle state
1588 * @worker: worker which is leaving idle state
1589 *
1590 * @worker is leaving idle state. Update stats.
1591 *
1592 * LOCKING:
d565ed63 1593 * spin_lock_irq(pool->lock).
c8e55f36
TH
1594 */
1595static void worker_leave_idle(struct worker *worker)
1596{
bd7bdd43 1597 struct worker_pool *pool = worker->pool;
c8e55f36 1598
6183c009
TH
1599 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1600 return;
d302f017 1601 worker_clr_flags(worker, WORKER_IDLE);
bd7bdd43 1602 pool->nr_idle--;
c8e55f36
TH
1603 list_del_init(&worker->entry);
1604}
1605
e22bee78 1606/**
f36dc67b
LJ
1607 * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1608 * @pool: target worker_pool
1609 *
1610 * Bind %current to the cpu of @pool if it is associated and lock @pool.
e22bee78
TH
1611 *
1612 * Works which are scheduled while the cpu is online must at least be
1613 * scheduled to a worker which is bound to the cpu so that if they are
1614 * flushed from cpu callbacks while cpu is going down, they are
1615 * guaranteed to execute on the cpu.
1616 *
f5faa077 1617 * This function is to be used by unbound workers and rescuers to bind
e22bee78
TH
1618 * themselves to the target cpu and may race with cpu going down or
1619 * coming online. kthread_bind() can't be used because it may put the
1620 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
706026c2 1621 * verbatim as it's best effort and blocking and pool may be
e22bee78
TH
1622 * [dis]associated in the meantime.
1623 *
706026c2 1624 * This function tries set_cpus_allowed() and locks pool and verifies the
24647570 1625 * binding against %POOL_DISASSOCIATED which is set during
f2d5a0ee
TH
1626 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1627 * enters idle state or fetches works without dropping lock, it can
1628 * guarantee the scheduling requirement described in the first paragraph.
e22bee78
TH
1629 *
1630 * CONTEXT:
d565ed63 1631 * Might sleep. Called without any lock but returns with pool->lock
e22bee78
TH
1632 * held.
1633 *
d185af30 1634 * Return:
706026c2 1635 * %true if the associated pool is online (@worker is successfully
e22bee78
TH
1636 * bound), %false if offline.
1637 */
f36dc67b 1638static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
d565ed63 1639__acquires(&pool->lock)
e22bee78 1640{
e22bee78 1641 while (true) {
4e6045f1 1642 /*
e22bee78
TH
1643 * The following call may fail, succeed or succeed
1644 * without actually migrating the task to the cpu if
1645 * it races with cpu hotunplug operation. Verify
24647570 1646 * against POOL_DISASSOCIATED.
4e6045f1 1647 */
24647570 1648 if (!(pool->flags & POOL_DISASSOCIATED))
7a4e344c 1649 set_cpus_allowed_ptr(current, pool->attrs->cpumask);
e22bee78 1650
d565ed63 1651 spin_lock_irq(&pool->lock);
24647570 1652 if (pool->flags & POOL_DISASSOCIATED)
e22bee78 1653 return false;
f5faa077 1654 if (task_cpu(current) == pool->cpu &&
7a4e344c 1655 cpumask_equal(&current->cpus_allowed, pool->attrs->cpumask))
e22bee78 1656 return true;
d565ed63 1657 spin_unlock_irq(&pool->lock);
e22bee78 1658
5035b20f
TH
1659 /*
1660 * We've raced with CPU hot[un]plug. Give it a breather
1661 * and retry migration. cond_resched() is required here;
1662 * otherwise, we might deadlock against cpu_stop trying to
1663 * bring down the CPU on non-preemptive kernel.
1664 */
e22bee78 1665 cpu_relax();
5035b20f 1666 cond_resched();
e22bee78
TH
1667 }
1668}
1669
c34056a3
TH
1670static struct worker *alloc_worker(void)
1671{
1672 struct worker *worker;
1673
1674 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
c8e55f36
TH
1675 if (worker) {
1676 INIT_LIST_HEAD(&worker->entry);
affee4b2 1677 INIT_LIST_HEAD(&worker->scheduled);
da028469 1678 INIT_LIST_HEAD(&worker->node);
e22bee78
TH
1679 /* on creation a worker is in !idle && prep state */
1680 worker->flags = WORKER_PREP;
c8e55f36 1681 }
c34056a3
TH
1682 return worker;
1683}
1684
4736cbf7
LJ
1685/**
1686 * worker_attach_to_pool() - attach a worker to a pool
1687 * @worker: worker to be attached
1688 * @pool: the target pool
1689 *
1690 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1691 * cpu-binding of @worker are kept coordinated with the pool across
1692 * cpu-[un]hotplugs.
1693 */
1694static void worker_attach_to_pool(struct worker *worker,
1695 struct worker_pool *pool)
1696{
1697 mutex_lock(&pool->attach_mutex);
1698
1699 /*
1700 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1701 * online CPUs. It'll be re-applied when any of the CPUs come up.
1702 */
1703 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1704
1705 /*
1706 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1707 * stable across this function. See the comments above the
1708 * flag definition for details.
1709 */
1710 if (pool->flags & POOL_DISASSOCIATED)
1711 worker->flags |= WORKER_UNBOUND;
1712
1713 list_add_tail(&worker->node, &pool->workers);
1714
1715 mutex_unlock(&pool->attach_mutex);
1716}
1717
60f5a4bc
LJ
1718/**
1719 * worker_detach_from_pool() - detach a worker from its pool
1720 * @worker: worker which is attached to its pool
1721 * @pool: the pool @worker is attached to
1722 *
4736cbf7
LJ
1723 * Undo the attaching which had been done in worker_attach_to_pool(). The
1724 * caller worker shouldn't access to the pool after detached except it has
1725 * other reference to the pool.
60f5a4bc
LJ
1726 */
1727static void worker_detach_from_pool(struct worker *worker,
1728 struct worker_pool *pool)
1729{
1730 struct completion *detach_completion = NULL;
1731
92f9c5c4 1732 mutex_lock(&pool->attach_mutex);
da028469
LJ
1733 list_del(&worker->node);
1734 if (list_empty(&pool->workers))
60f5a4bc 1735 detach_completion = pool->detach_completion;
92f9c5c4 1736 mutex_unlock(&pool->attach_mutex);
60f5a4bc
LJ
1737
1738 if (detach_completion)
1739 complete(detach_completion);
1740}
1741
c34056a3
TH
1742/**
1743 * create_worker - create a new workqueue worker
63d95a91 1744 * @pool: pool the new worker will belong to
c34056a3 1745 *
73eb7fe7
LJ
1746 * Create a new worker which is attached to @pool. The new worker must be
1747 * started by start_worker().
c34056a3
TH
1748 *
1749 * CONTEXT:
1750 * Might sleep. Does GFP_KERNEL allocations.
1751 *
d185af30 1752 * Return:
c34056a3
TH
1753 * Pointer to the newly created worker.
1754 */
bc2ae0f5 1755static struct worker *create_worker(struct worker_pool *pool)
c34056a3 1756{
c34056a3 1757 struct worker *worker = NULL;
f3421797 1758 int id = -1;
e3c916a4 1759 char id_buf[16];
c34056a3 1760
7cda9aae
LJ
1761 /* ID is needed to determine kthread name */
1762 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
822d8405
TH
1763 if (id < 0)
1764 goto fail;
c34056a3
TH
1765
1766 worker = alloc_worker();
1767 if (!worker)
1768 goto fail;
1769
bd7bdd43 1770 worker->pool = pool;
c34056a3
TH
1771 worker->id = id;
1772
29c91e99 1773 if (pool->cpu >= 0)
e3c916a4
TH
1774 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1775 pool->attrs->nice < 0 ? "H" : "");
f3421797 1776 else
e3c916a4
TH
1777 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1778
f3f90ad4 1779 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
e3c916a4 1780 "kworker/%s", id_buf);
c34056a3
TH
1781 if (IS_ERR(worker->task))
1782 goto fail;
1783
91151228
ON
1784 set_user_nice(worker->task, pool->attrs->nice);
1785
1786 /* prevent userland from meddling with cpumask of workqueue workers */
1787 worker->task->flags |= PF_NO_SETAFFINITY;
1788
da028469 1789 /* successful, attach the worker to the pool */
4736cbf7 1790 worker_attach_to_pool(worker, pool);
4d757c5c 1791
c34056a3 1792 return worker;
822d8405 1793
c34056a3 1794fail:
9625ab17 1795 if (id >= 0)
7cda9aae 1796 ida_simple_remove(&pool->worker_ida, id);
c34056a3
TH
1797 kfree(worker);
1798 return NULL;
1799}
1800
1801/**
1802 * start_worker - start a newly created worker
1803 * @worker: worker to start
1804 *
706026c2 1805 * Make the pool aware of @worker and start it.
c34056a3
TH
1806 *
1807 * CONTEXT:
d565ed63 1808 * spin_lock_irq(pool->lock).
c34056a3
TH
1809 */
1810static void start_worker(struct worker *worker)
1811{
bd7bdd43 1812 worker->pool->nr_workers++;
c8e55f36 1813 worker_enter_idle(worker);
c34056a3
TH
1814 wake_up_process(worker->task);
1815}
1816
ebf44d16
TH
1817/**
1818 * create_and_start_worker - create and start a worker for a pool
1819 * @pool: the target pool
1820 *
cd549687 1821 * Grab the managership of @pool and create and start a new worker for it.
d185af30
YB
1822 *
1823 * Return: 0 on success. A negative error code otherwise.
ebf44d16
TH
1824 */
1825static int create_and_start_worker(struct worker_pool *pool)
1826{
1827 struct worker *worker;
1828
1829 worker = create_worker(pool);
1830 if (worker) {
1831 spin_lock_irq(&pool->lock);
1832 start_worker(worker);
1833 spin_unlock_irq(&pool->lock);
1834 }
1835
1836 return worker ? 0 : -ENOMEM;
1837}
1838
c34056a3
TH
1839/**
1840 * destroy_worker - destroy a workqueue worker
1841 * @worker: worker to be destroyed
1842 *
73eb7fe7
LJ
1843 * Destroy @worker and adjust @pool stats accordingly. The worker should
1844 * be idle.
c8e55f36
TH
1845 *
1846 * CONTEXT:
60f5a4bc 1847 * spin_lock_irq(pool->lock).
c34056a3
TH
1848 */
1849static void destroy_worker(struct worker *worker)
1850{
bd7bdd43 1851 struct worker_pool *pool = worker->pool;
c34056a3 1852
cd549687
TH
1853 lockdep_assert_held(&pool->lock);
1854
c34056a3 1855 /* sanity check frenzy */
6183c009 1856 if (WARN_ON(worker->current_work) ||
73eb7fe7
LJ
1857 WARN_ON(!list_empty(&worker->scheduled)) ||
1858 WARN_ON(!(worker->flags & WORKER_IDLE)))
6183c009 1859 return;
c34056a3 1860
73eb7fe7
LJ
1861 pool->nr_workers--;
1862 pool->nr_idle--;
c8e55f36
TH
1863
1864 list_del_init(&worker->entry);
cb444766 1865 worker->flags |= WORKER_DIE;
60f5a4bc 1866 wake_up_process(worker->task);
c34056a3
TH
1867}
1868
63d95a91 1869static void idle_worker_timeout(unsigned long __pool)
e22bee78 1870{
63d95a91 1871 struct worker_pool *pool = (void *)__pool;
e22bee78 1872
d565ed63 1873 spin_lock_irq(&pool->lock);
e22bee78 1874
3347fc9f 1875 while (too_many_workers(pool)) {
e22bee78
TH
1876 struct worker *worker;
1877 unsigned long expires;
1878
1879 /* idle_list is kept in LIFO order, check the last one */
63d95a91 1880 worker = list_entry(pool->idle_list.prev, struct worker, entry);
e22bee78
TH
1881 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1882
3347fc9f 1883 if (time_before(jiffies, expires)) {
63d95a91 1884 mod_timer(&pool->idle_timer, expires);
3347fc9f 1885 break;
d5abe669 1886 }
3347fc9f
LJ
1887
1888 destroy_worker(worker);
e22bee78
TH
1889 }
1890
d565ed63 1891 spin_unlock_irq(&pool->lock);
e22bee78 1892}
d5abe669 1893
493a1724 1894static void send_mayday(struct work_struct *work)
e22bee78 1895{
112202d9
TH
1896 struct pool_workqueue *pwq = get_work_pwq(work);
1897 struct workqueue_struct *wq = pwq->wq;
493a1724 1898
2e109a28 1899 lockdep_assert_held(&wq_mayday_lock);
e22bee78 1900
493008a8 1901 if (!wq->rescuer)
493a1724 1902 return;
e22bee78
TH
1903
1904 /* mayday mayday mayday */
493a1724 1905 if (list_empty(&pwq->mayday_node)) {
77668c8b
LJ
1906 /*
1907 * If @pwq is for an unbound wq, its base ref may be put at
1908 * any time due to an attribute change. Pin @pwq until the
1909 * rescuer is done with it.
1910 */
1911 get_pwq(pwq);
493a1724 1912 list_add_tail(&pwq->mayday_node, &wq->maydays);
e22bee78 1913 wake_up_process(wq->rescuer->task);
493a1724 1914 }
e22bee78
TH
1915}
1916
706026c2 1917static void pool_mayday_timeout(unsigned long __pool)
e22bee78 1918{
63d95a91 1919 struct worker_pool *pool = (void *)__pool;
e22bee78
TH
1920 struct work_struct *work;
1921
2e109a28 1922 spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */
493a1724 1923 spin_lock(&pool->lock);
e22bee78 1924
63d95a91 1925 if (need_to_create_worker(pool)) {
e22bee78
TH
1926 /*
1927 * We've been trying to create a new worker but
1928 * haven't been successful. We might be hitting an
1929 * allocation deadlock. Send distress signals to
1930 * rescuers.
1931 */
63d95a91 1932 list_for_each_entry(work, &pool->worklist, entry)
e22bee78 1933 send_mayday(work);
1da177e4 1934 }
e22bee78 1935
493a1724 1936 spin_unlock(&pool->lock);
2e109a28 1937 spin_unlock_irq(&wq_mayday_lock);
e22bee78 1938
63d95a91 1939 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1da177e4
LT
1940}
1941
e22bee78
TH
1942/**
1943 * maybe_create_worker - create a new worker if necessary
63d95a91 1944 * @pool: pool to create a new worker for
e22bee78 1945 *
63d95a91 1946 * Create a new worker for @pool if necessary. @pool is guaranteed to
e22bee78
TH
1947 * have at least one idle worker on return from this function. If
1948 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
63d95a91 1949 * sent to all rescuers with works scheduled on @pool to resolve
e22bee78
TH
1950 * possible allocation deadlock.
1951 *
c5aa87bb
TH
1952 * On return, need_to_create_worker() is guaranteed to be %false and
1953 * may_start_working() %true.
e22bee78
TH
1954 *
1955 * LOCKING:
d565ed63 1956 * spin_lock_irq(pool->lock) which may be released and regrabbed
e22bee78
TH
1957 * multiple times. Does GFP_KERNEL allocations. Called only from
1958 * manager.
1959 *
d185af30 1960 * Return:
c5aa87bb 1961 * %false if no action was taken and pool->lock stayed locked, %true
e22bee78
TH
1962 * otherwise.
1963 */
63d95a91 1964static bool maybe_create_worker(struct worker_pool *pool)
d565ed63
TH
1965__releases(&pool->lock)
1966__acquires(&pool->lock)
1da177e4 1967{
63d95a91 1968 if (!need_to_create_worker(pool))
e22bee78
TH
1969 return false;
1970restart:
d565ed63 1971 spin_unlock_irq(&pool->lock);
9f9c2364 1972
e22bee78 1973 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
63d95a91 1974 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
e22bee78
TH
1975
1976 while (true) {
1977 struct worker *worker;
1978
bc2ae0f5 1979 worker = create_worker(pool);
e22bee78 1980 if (worker) {
63d95a91 1981 del_timer_sync(&pool->mayday_timer);
d565ed63 1982 spin_lock_irq(&pool->lock);
e22bee78 1983 start_worker(worker);
6183c009
TH
1984 if (WARN_ON_ONCE(need_to_create_worker(pool)))
1985 goto restart;
e22bee78
TH
1986 return true;
1987 }
1988
63d95a91 1989 if (!need_to_create_worker(pool))
e22bee78 1990 break;
1da177e4 1991
e22bee78
TH
1992 __set_current_state(TASK_INTERRUPTIBLE);
1993 schedule_timeout(CREATE_COOLDOWN);
9f9c2364 1994
63d95a91 1995 if (!need_to_create_worker(pool))
e22bee78
TH
1996 break;
1997 }
1998
63d95a91 1999 del_timer_sync(&pool->mayday_timer);
d565ed63 2000 spin_lock_irq(&pool->lock);
63d95a91 2001 if (need_to_create_worker(pool))
e22bee78
TH
2002 goto restart;
2003 return true;
2004}
2005
73f53c4a 2006/**
e22bee78
TH
2007 * manage_workers - manage worker pool
2008 * @worker: self
73f53c4a 2009 *
706026c2 2010 * Assume the manager role and manage the worker pool @worker belongs
e22bee78 2011 * to. At any given time, there can be only zero or one manager per
706026c2 2012 * pool. The exclusion is handled automatically by this function.
e22bee78
TH
2013 *
2014 * The caller can safely start processing works on false return. On
2015 * true return, it's guaranteed that need_to_create_worker() is false
2016 * and may_start_working() is true.
73f53c4a
TH
2017 *
2018 * CONTEXT:
d565ed63 2019 * spin_lock_irq(pool->lock) which may be released and regrabbed
e22bee78
TH
2020 * multiple times. Does GFP_KERNEL allocations.
2021 *
d185af30 2022 * Return:
2d498db9
L
2023 * %false if the pool don't need management and the caller can safely start
2024 * processing works, %true indicates that the function released pool->lock
2025 * and reacquired it to perform some management function and that the
2026 * conditions that the caller verified while holding the lock before
2027 * calling the function might no longer be true.
73f53c4a 2028 */
e22bee78 2029static bool manage_workers(struct worker *worker)
73f53c4a 2030{
63d95a91 2031 struct worker_pool *pool = worker->pool;
e22bee78 2032 bool ret = false;
73f53c4a 2033
bc3a1afc 2034 /*
bc3a1afc
TH
2035 * Anyone who successfully grabs manager_arb wins the arbitration
2036 * and becomes the manager. mutex_trylock() on pool->manager_arb
2037 * failure while holding pool->lock reliably indicates that someone
2038 * else is managing the pool and the worker which failed trylock
2039 * can proceed to executing work items. This means that anyone
2040 * grabbing manager_arb is responsible for actually performing
2041 * manager duties. If manager_arb is grabbed and released without
2042 * actual management, the pool may stall indefinitely.
bc3a1afc 2043 */
34a06bd6 2044 if (!mutex_trylock(&pool->manager_arb))
e22bee78 2045 return ret;
1e19ffc6 2046
63d95a91 2047 ret |= maybe_create_worker(pool);
e22bee78 2048
34a06bd6 2049 mutex_unlock(&pool->manager_arb);
e22bee78 2050 return ret;
73f53c4a
TH
2051}
2052
a62428c0
TH
2053/**
2054 * process_one_work - process single work
c34056a3 2055 * @worker: self
a62428c0
TH
2056 * @work: work to process
2057 *
2058 * Process @work. This function contains all the logics necessary to
2059 * process a single work including synchronization against and
2060 * interaction with other workers on the same cpu, queueing and
2061 * flushing. As long as context requirement is met, any worker can
2062 * call this function to process a work.
2063 *
2064 * CONTEXT:
d565ed63 2065 * spin_lock_irq(pool->lock) which is released and regrabbed.
a62428c0 2066 */
c34056a3 2067static void process_one_work(struct worker *worker, struct work_struct *work)
d565ed63
TH
2068__releases(&pool->lock)
2069__acquires(&pool->lock)
a62428c0 2070{
112202d9 2071 struct pool_workqueue *pwq = get_work_pwq(work);
bd7bdd43 2072 struct worker_pool *pool = worker->pool;
112202d9 2073 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
73f53c4a 2074 int work_color;
7e11629d 2075 struct worker *collision;
a62428c0
TH
2076#ifdef CONFIG_LOCKDEP
2077 /*
2078 * It is permissible to free the struct work_struct from
2079 * inside the function that is called from it, this we need to
2080 * take into account for lockdep too. To avoid bogus "held
2081 * lock freed" warnings as well as problems when looking into
2082 * work->lockdep_map, make a copy and use that here.
2083 */
4d82a1de
PZ
2084 struct lockdep_map lockdep_map;
2085
2086 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
a62428c0 2087#endif
6fec10a1
TH
2088 /*
2089 * Ensure we're on the correct CPU. DISASSOCIATED test is
2090 * necessary to avoid spurious warnings from rescuers servicing the
24647570 2091 * unbound or a disassociated pool.
6fec10a1 2092 */
5f7dabfd 2093 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
24647570 2094 !(pool->flags & POOL_DISASSOCIATED) &&
ec22ca5e 2095 raw_smp_processor_id() != pool->cpu);
25511a47 2096
7e11629d
TH
2097 /*
2098 * A single work shouldn't be executed concurrently by
2099 * multiple workers on a single cpu. Check whether anyone is
2100 * already processing the work. If so, defer the work to the
2101 * currently executing one.
2102 */
c9e7cf27 2103 collision = find_worker_executing_work(pool, work);
7e11629d
TH
2104 if (unlikely(collision)) {
2105 move_linked_works(work, &collision->scheduled, NULL);
2106 return;
2107 }
2108
8930caba 2109 /* claim and dequeue */
a62428c0 2110 debug_work_deactivate(work);
c9e7cf27 2111 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
c34056a3 2112 worker->current_work = work;
a2c1c57b 2113 worker->current_func = work->func;
112202d9 2114 worker->current_pwq = pwq;
73f53c4a 2115 work_color = get_work_color(work);
7a22ad75 2116
a62428c0
TH
2117 list_del_init(&work->entry);
2118
fb0e7beb
TH
2119 /*
2120 * CPU intensive works don't participate in concurrency
2121 * management. They're the scheduler's responsibility.
2122 */
2123 if (unlikely(cpu_intensive))
2124 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2125
974271c4 2126 /*
d565ed63 2127 * Unbound pool isn't concurrency managed and work items should be
974271c4
TH
2128 * executed ASAP. Wake up another worker if necessary.
2129 */
63d95a91
TH
2130 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2131 wake_up_worker(pool);
974271c4 2132
8930caba 2133 /*
7c3eed5c 2134 * Record the last pool and clear PENDING which should be the last
d565ed63 2135 * update to @work. Also, do this inside @pool->lock so that
23657bb1
TH
2136 * PENDING and queued state changes happen together while IRQ is
2137 * disabled.
8930caba 2138 */
7c3eed5c 2139 set_work_pool_and_clear_pending(work, pool->id);
a62428c0 2140
d565ed63 2141 spin_unlock_irq(&pool->lock);
a62428c0 2142
112202d9 2143 lock_map_acquire_read(&pwq->wq->lockdep_map);
a62428c0 2144 lock_map_acquire(&lockdep_map);
e36c886a 2145 trace_workqueue_execute_start(work);
a2c1c57b 2146 worker->current_func(work);
e36c886a
AV
2147 /*
2148 * While we must be careful to not use "work" after this, the trace
2149 * point will only record its address.
2150 */
2151 trace_workqueue_execute_end(work);
a62428c0 2152 lock_map_release(&lockdep_map);
112202d9 2153 lock_map_release(&pwq->wq->lockdep_map);
a62428c0
TH
2154
2155 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
044c782c
VI
2156 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2157 " last function: %pf\n",
a2c1c57b
TH
2158 current->comm, preempt_count(), task_pid_nr(current),
2159 worker->current_func);
a62428c0
TH
2160 debug_show_held_locks(current);
2161 dump_stack();
2162 }
2163
b22ce278
TH
2164 /*
2165 * The following prevents a kworker from hogging CPU on !PREEMPT
2166 * kernels, where a requeueing work item waiting for something to
2167 * happen could deadlock with stop_machine as such work item could
2168 * indefinitely requeue itself while all other CPUs are trapped in
2169 * stop_machine.
2170 */
2171 cond_resched();
2172
d565ed63 2173 spin_lock_irq(&pool->lock);
a62428c0 2174
fb0e7beb
TH
2175 /* clear cpu intensive status */
2176 if (unlikely(cpu_intensive))
2177 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2178
a62428c0 2179 /* we're done with it, release */
42f8570f 2180 hash_del(&worker->hentry);
c34056a3 2181 worker->current_work = NULL;
a2c1c57b 2182 worker->current_func = NULL;
112202d9 2183 worker->current_pwq = NULL;
3d1cb205 2184 worker->desc_valid = false;
112202d9 2185 pwq_dec_nr_in_flight(pwq, work_color);
a62428c0
TH
2186}
2187
affee4b2
TH
2188/**
2189 * process_scheduled_works - process scheduled works
2190 * @worker: self
2191 *
2192 * Process all scheduled works. Please note that the scheduled list
2193 * may change while processing a work, so this function repeatedly
2194 * fetches a work from the top and executes it.
2195 *
2196 * CONTEXT:
d565ed63 2197 * spin_lock_irq(pool->lock) which may be released and regrabbed
affee4b2
TH
2198 * multiple times.
2199 */
2200static void process_scheduled_works(struct worker *worker)
1da177e4 2201{
affee4b2
TH
2202 while (!list_empty(&worker->scheduled)) {
2203 struct work_struct *work = list_first_entry(&worker->scheduled,
1da177e4 2204 struct work_struct, entry);
c34056a3 2205 process_one_work(worker, work);
1da177e4 2206 }
1da177e4
LT
2207}
2208
4690c4ab
TH
2209/**
2210 * worker_thread - the worker thread function
c34056a3 2211 * @__worker: self
4690c4ab 2212 *
c5aa87bb
TH
2213 * The worker thread function. All workers belong to a worker_pool -
2214 * either a per-cpu one or dynamic unbound one. These workers process all
2215 * work items regardless of their specific target workqueue. The only
2216 * exception is work items which belong to workqueues with a rescuer which
2217 * will be explained in rescuer_thread().
d185af30
YB
2218 *
2219 * Return: 0
4690c4ab 2220 */
c34056a3 2221static int worker_thread(void *__worker)
1da177e4 2222{
c34056a3 2223 struct worker *worker = __worker;
bd7bdd43 2224 struct worker_pool *pool = worker->pool;
1da177e4 2225
e22bee78
TH
2226 /* tell the scheduler that this is a workqueue worker */
2227 worker->task->flags |= PF_WQ_WORKER;
c8e55f36 2228woke_up:
d565ed63 2229 spin_lock_irq(&pool->lock);
1da177e4 2230
a9ab775b
TH
2231 /* am I supposed to die? */
2232 if (unlikely(worker->flags & WORKER_DIE)) {
d565ed63 2233 spin_unlock_irq(&pool->lock);
a9ab775b
TH
2234 WARN_ON_ONCE(!list_empty(&worker->entry));
2235 worker->task->flags &= ~PF_WQ_WORKER;
60f5a4bc
LJ
2236
2237 set_task_comm(worker->task, "kworker/dying");
7cda9aae 2238 ida_simple_remove(&pool->worker_ida, worker->id);
60f5a4bc
LJ
2239 worker_detach_from_pool(worker, pool);
2240 kfree(worker);
a9ab775b 2241 return 0;
c8e55f36 2242 }
affee4b2 2243
c8e55f36 2244 worker_leave_idle(worker);
db7bccf4 2245recheck:
e22bee78 2246 /* no more worker necessary? */
63d95a91 2247 if (!need_more_worker(pool))
e22bee78
TH
2248 goto sleep;
2249
2250 /* do we need to manage? */
63d95a91 2251 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
e22bee78
TH
2252 goto recheck;
2253
c8e55f36
TH
2254 /*
2255 * ->scheduled list can only be filled while a worker is
2256 * preparing to process a work or actually processing it.
2257 * Make sure nobody diddled with it while I was sleeping.
2258 */
6183c009 2259 WARN_ON_ONCE(!list_empty(&worker->scheduled));
c8e55f36 2260
e22bee78 2261 /*
a9ab775b
TH
2262 * Finish PREP stage. We're guaranteed to have at least one idle
2263 * worker or that someone else has already assumed the manager
2264 * role. This is where @worker starts participating in concurrency
2265 * management if applicable and concurrency management is restored
2266 * after being rebound. See rebind_workers() for details.
e22bee78 2267 */
a9ab775b 2268 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
e22bee78
TH
2269
2270 do {
c8e55f36 2271 struct work_struct *work =
bd7bdd43 2272 list_first_entry(&pool->worklist,
c8e55f36
TH
2273 struct work_struct, entry);
2274
2275 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2276 /* optimization path, not strictly necessary */
2277 process_one_work(worker, work);
2278 if (unlikely(!list_empty(&worker->scheduled)))
affee4b2 2279 process_scheduled_works(worker);
c8e55f36
TH
2280 } else {
2281 move_linked_works(work, &worker->scheduled, NULL);
2282 process_scheduled_works(worker);
affee4b2 2283 }
63d95a91 2284 } while (keep_working(pool));
e22bee78
TH
2285
2286 worker_set_flags(worker, WORKER_PREP, false);
d313dd85 2287sleep:
c8e55f36 2288 /*
d565ed63
TH
2289 * pool->lock is held and there's no work to process and no need to
2290 * manage, sleep. Workers are woken up only while holding
2291 * pool->lock or from local cpu, so setting the current state
2292 * before releasing pool->lock is enough to prevent losing any
2293 * event.
c8e55f36
TH
2294 */
2295 worker_enter_idle(worker);
2296 __set_current_state(TASK_INTERRUPTIBLE);
d565ed63 2297 spin_unlock_irq(&pool->lock);
c8e55f36
TH
2298 schedule();
2299 goto woke_up;
1da177e4
LT
2300}
2301
e22bee78
TH
2302/**
2303 * rescuer_thread - the rescuer thread function
111c225a 2304 * @__rescuer: self
e22bee78
TH
2305 *
2306 * Workqueue rescuer thread function. There's one rescuer for each
493008a8 2307 * workqueue which has WQ_MEM_RECLAIM set.
e22bee78 2308 *
706026c2 2309 * Regular work processing on a pool may block trying to create a new
e22bee78
TH
2310 * worker which uses GFP_KERNEL allocation which has slight chance of
2311 * developing into deadlock if some works currently on the same queue
2312 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2313 * the problem rescuer solves.
2314 *
706026c2
TH
2315 * When such condition is possible, the pool summons rescuers of all
2316 * workqueues which have works queued on the pool and let them process
e22bee78
TH
2317 * those works so that forward progress can be guaranteed.
2318 *
2319 * This should happen rarely.
d185af30
YB
2320 *
2321 * Return: 0
e22bee78 2322 */
111c225a 2323static int rescuer_thread(void *__rescuer)
e22bee78 2324{
111c225a
TH
2325 struct worker *rescuer = __rescuer;
2326 struct workqueue_struct *wq = rescuer->rescue_wq;
e22bee78 2327 struct list_head *scheduled = &rescuer->scheduled;
4d595b86 2328 bool should_stop;
e22bee78
TH
2329
2330 set_user_nice(current, RESCUER_NICE_LEVEL);
111c225a
TH
2331
2332 /*
2333 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2334 * doesn't participate in concurrency management.
2335 */
2336 rescuer->task->flags |= PF_WQ_WORKER;
e22bee78
TH
2337repeat:
2338 set_current_state(TASK_INTERRUPTIBLE);
2339
4d595b86
LJ
2340 /*
2341 * By the time the rescuer is requested to stop, the workqueue
2342 * shouldn't have any work pending, but @wq->maydays may still have
2343 * pwq(s) queued. This can happen by non-rescuer workers consuming
2344 * all the work items before the rescuer got to them. Go through
2345 * @wq->maydays processing before acting on should_stop so that the
2346 * list is always empty on exit.
2347 */
2348 should_stop = kthread_should_stop();
e22bee78 2349
493a1724 2350 /* see whether any pwq is asking for help */
2e109a28 2351 spin_lock_irq(&wq_mayday_lock);
493a1724
TH
2352
2353 while (!list_empty(&wq->maydays)) {
2354 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2355 struct pool_workqueue, mayday_node);
112202d9 2356 struct worker_pool *pool = pwq->pool;
e22bee78
TH
2357 struct work_struct *work, *n;
2358
2359 __set_current_state(TASK_RUNNING);
493a1724
TH
2360 list_del_init(&pwq->mayday_node);
2361
2e109a28 2362 spin_unlock_irq(&wq_mayday_lock);
e22bee78
TH
2363
2364 /* migrate to the target cpu if possible */
f36dc67b 2365 worker_maybe_bind_and_lock(pool);
b3104104 2366 rescuer->pool = pool;
e22bee78
TH
2367
2368 /*
2369 * Slurp in all works issued via this workqueue and
2370 * process'em.
2371 */
6183c009 2372 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
bd7bdd43 2373 list_for_each_entry_safe(work, n, &pool->worklist, entry)
112202d9 2374 if (get_work_pwq(work) == pwq)
e22bee78
TH
2375 move_linked_works(work, scheduled, &n);
2376
2377 process_scheduled_works(rescuer);
7576958a 2378
77668c8b
LJ
2379 /*
2380 * Put the reference grabbed by send_mayday(). @pool won't
2381 * go away while we're holding its lock.
2382 */
2383 put_pwq(pwq);
2384
7576958a 2385 /*
d565ed63 2386 * Leave this pool. If keep_working() is %true, notify a
7576958a
TH
2387 * regular worker; otherwise, we end up with 0 concurrency
2388 * and stalling the execution.
2389 */
63d95a91
TH
2390 if (keep_working(pool))
2391 wake_up_worker(pool);
7576958a 2392
b3104104 2393 rescuer->pool = NULL;
493a1724 2394 spin_unlock(&pool->lock);
2e109a28 2395 spin_lock(&wq_mayday_lock);
e22bee78
TH
2396 }
2397
2e109a28 2398 spin_unlock_irq(&wq_mayday_lock);
493a1724 2399
4d595b86
LJ
2400 if (should_stop) {
2401 __set_current_state(TASK_RUNNING);
2402 rescuer->task->flags &= ~PF_WQ_WORKER;
2403 return 0;
2404 }
2405
111c225a
TH
2406 /* rescuers should never participate in concurrency management */
2407 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
e22bee78
TH
2408 schedule();
2409 goto repeat;
1da177e4
LT
2410}
2411
fc2e4d70
ON
2412struct wq_barrier {
2413 struct work_struct work;
2414 struct completion done;
2415};
2416
2417static void wq_barrier_func(struct work_struct *work)
2418{
2419 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2420 complete(&barr->done);
2421}
2422
4690c4ab
TH
2423/**
2424 * insert_wq_barrier - insert a barrier work
112202d9 2425 * @pwq: pwq to insert barrier into
4690c4ab 2426 * @barr: wq_barrier to insert
affee4b2
TH
2427 * @target: target work to attach @barr to
2428 * @worker: worker currently executing @target, NULL if @target is not executing
4690c4ab 2429 *
affee4b2
TH
2430 * @barr is linked to @target such that @barr is completed only after
2431 * @target finishes execution. Please note that the ordering
2432 * guarantee is observed only with respect to @target and on the local
2433 * cpu.
2434 *
2435 * Currently, a queued barrier can't be canceled. This is because
2436 * try_to_grab_pending() can't determine whether the work to be
2437 * grabbed is at the head of the queue and thus can't clear LINKED
2438 * flag of the previous work while there must be a valid next work
2439 * after a work with LINKED flag set.
2440 *
2441 * Note that when @worker is non-NULL, @target may be modified
112202d9 2442 * underneath us, so we can't reliably determine pwq from @target.
4690c4ab
TH
2443 *
2444 * CONTEXT:
d565ed63 2445 * spin_lock_irq(pool->lock).
4690c4ab 2446 */
112202d9 2447static void insert_wq_barrier(struct pool_workqueue *pwq,
affee4b2
TH
2448 struct wq_barrier *barr,
2449 struct work_struct *target, struct worker *worker)
fc2e4d70 2450{
affee4b2
TH
2451 struct list_head *head;
2452 unsigned int linked = 0;
2453
dc186ad7 2454 /*
d565ed63 2455 * debugobject calls are safe here even with pool->lock locked
dc186ad7
TG
2456 * as we know for sure that this will not trigger any of the
2457 * checks and call back into the fixup functions where we
2458 * might deadlock.
2459 */
ca1cab37 2460 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
22df02bb 2461 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
fc2e4d70 2462 init_completion(&barr->done);
83c22520 2463
affee4b2
TH
2464 /*
2465 * If @target is currently being executed, schedule the
2466 * barrier to the worker; otherwise, put it after @target.
2467 */
2468 if (worker)
2469 head = worker->scheduled.next;
2470 else {
2471 unsigned long *bits = work_data_bits(target);
2472
2473 head = target->entry.next;
2474 /* there can already be other linked works, inherit and set */
2475 linked = *bits & WORK_STRUCT_LINKED;
2476 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2477 }
2478
dc186ad7 2479 debug_work_activate(&barr->work);
112202d9 2480 insert_work(pwq, &barr->work, head,
affee4b2 2481 work_color_to_flags(WORK_NO_COLOR) | linked);
fc2e4d70
ON
2482}
2483
73f53c4a 2484/**
112202d9 2485 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
73f53c4a
TH
2486 * @wq: workqueue being flushed
2487 * @flush_color: new flush color, < 0 for no-op
2488 * @work_color: new work color, < 0 for no-op
2489 *
112202d9 2490 * Prepare pwqs for workqueue flushing.
73f53c4a 2491 *
112202d9
TH
2492 * If @flush_color is non-negative, flush_color on all pwqs should be
2493 * -1. If no pwq has in-flight commands at the specified color, all
2494 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2495 * has in flight commands, its pwq->flush_color is set to
2496 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
73f53c4a
TH
2497 * wakeup logic is armed and %true is returned.
2498 *
2499 * The caller should have initialized @wq->first_flusher prior to
2500 * calling this function with non-negative @flush_color. If
2501 * @flush_color is negative, no flush color update is done and %false
2502 * is returned.
2503 *
112202d9 2504 * If @work_color is non-negative, all pwqs should have the same
73f53c4a
TH
2505 * work_color which is previous to @work_color and all will be
2506 * advanced to @work_color.
2507 *
2508 * CONTEXT:
3c25a55d 2509 * mutex_lock(wq->mutex).
73f53c4a 2510 *
d185af30 2511 * Return:
73f53c4a
TH
2512 * %true if @flush_color >= 0 and there's something to flush. %false
2513 * otherwise.
2514 */
112202d9 2515static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
73f53c4a 2516 int flush_color, int work_color)
1da177e4 2517{
73f53c4a 2518 bool wait = false;
49e3cf44 2519 struct pool_workqueue *pwq;
1da177e4 2520
73f53c4a 2521 if (flush_color >= 0) {
6183c009 2522 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
112202d9 2523 atomic_set(&wq->nr_pwqs_to_flush, 1);
1da177e4 2524 }
2355b70f 2525
49e3cf44 2526 for_each_pwq(pwq, wq) {
112202d9 2527 struct worker_pool *pool = pwq->pool;
fc2e4d70 2528
b09f4fd3 2529 spin_lock_irq(&pool->lock);
83c22520 2530
73f53c4a 2531 if (flush_color >= 0) {
6183c009 2532 WARN_ON_ONCE(pwq->flush_color != -1);
fc2e4d70 2533
112202d9
TH
2534 if (pwq->nr_in_flight[flush_color]) {
2535 pwq->flush_color = flush_color;
2536 atomic_inc(&wq->nr_pwqs_to_flush);
73f53c4a
TH
2537 wait = true;
2538 }
2539 }
1da177e4 2540
73f53c4a 2541 if (work_color >= 0) {
6183c009 2542 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
112202d9 2543 pwq->work_color = work_color;
73f53c4a 2544 }
1da177e4 2545
b09f4fd3 2546 spin_unlock_irq(&pool->lock);
1da177e4 2547 }
2355b70f 2548
112202d9 2549 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
73f53c4a 2550 complete(&wq->first_flusher->done);
14441960 2551
73f53c4a 2552 return wait;
1da177e4
LT
2553}
2554
0fcb78c2 2555/**
1da177e4 2556 * flush_workqueue - ensure that any scheduled work has run to completion.
0fcb78c2 2557 * @wq: workqueue to flush
1da177e4 2558 *
c5aa87bb
TH
2559 * This function sleeps until all work items which were queued on entry
2560 * have finished execution, but it is not livelocked by new incoming ones.
1da177e4 2561 */
7ad5b3a5 2562void flush_workqueue(struct workqueue_struct *wq)
1da177e4 2563{
73f53c4a
TH
2564 struct wq_flusher this_flusher = {
2565 .list = LIST_HEAD_INIT(this_flusher.list),
2566 .flush_color = -1,
2567 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2568 };
2569 int next_color;
1da177e4 2570
3295f0ef
IM
2571 lock_map_acquire(&wq->lockdep_map);
2572 lock_map_release(&wq->lockdep_map);
73f53c4a 2573
3c25a55d 2574 mutex_lock(&wq->mutex);
73f53c4a
TH
2575
2576 /*
2577 * Start-to-wait phase
2578 */
2579 next_color = work_next_color(wq->work_color);
2580
2581 if (next_color != wq->flush_color) {
2582 /*
2583 * Color space is not full. The current work_color
2584 * becomes our flush_color and work_color is advanced
2585 * by one.
2586 */
6183c009 2587 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
73f53c4a
TH
2588 this_flusher.flush_color = wq->work_color;
2589 wq->work_color = next_color;
2590
2591 if (!wq->first_flusher) {
2592 /* no flush in progress, become the first flusher */
6183c009 2593 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
73f53c4a
TH
2594
2595 wq->first_flusher = &this_flusher;
2596
112202d9 2597 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
73f53c4a
TH
2598 wq->work_color)) {
2599 /* nothing to flush, done */
2600 wq->flush_color = next_color;
2601 wq->first_flusher = NULL;
2602 goto out_unlock;
2603 }
2604 } else {
2605 /* wait in queue */
6183c009 2606 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
73f53c4a 2607 list_add_tail(&this_flusher.list, &wq->flusher_queue);
112202d9 2608 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
73f53c4a
TH
2609 }
2610 } else {
2611 /*
2612 * Oops, color space is full, wait on overflow queue.
2613 * The next flush completion will assign us
2614 * flush_color and transfer to flusher_queue.
2615 */
2616 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2617 }
2618
3c25a55d 2619 mutex_unlock(&wq->mutex);
73f53c4a
TH
2620
2621 wait_for_completion(&this_flusher.done);
2622
2623 /*
2624 * Wake-up-and-cascade phase
2625 *
2626 * First flushers are responsible for cascading flushes and
2627 * handling overflow. Non-first flushers can simply return.
2628 */
2629 if (wq->first_flusher != &this_flusher)
2630 return;
2631
3c25a55d 2632 mutex_lock(&wq->mutex);
73f53c4a 2633
4ce48b37
TH
2634 /* we might have raced, check again with mutex held */
2635 if (wq->first_flusher != &this_flusher)
2636 goto out_unlock;
2637
73f53c4a
TH
2638 wq->first_flusher = NULL;
2639
6183c009
TH
2640 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2641 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
73f53c4a
TH
2642
2643 while (true) {
2644 struct wq_flusher *next, *tmp;
2645
2646 /* complete all the flushers sharing the current flush color */
2647 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2648 if (next->flush_color != wq->flush_color)
2649 break;
2650 list_del_init(&next->list);
2651 complete(&next->done);
2652 }
2653
6183c009
TH
2654 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2655 wq->flush_color != work_next_color(wq->work_color));
73f53c4a
TH
2656
2657 /* this flush_color is finished, advance by one */
2658 wq->flush_color = work_next_color(wq->flush_color);
2659
2660 /* one color has been freed, handle overflow queue */
2661 if (!list_empty(&wq->flusher_overflow)) {
2662 /*
2663 * Assign the same color to all overflowed
2664 * flushers, advance work_color and append to
2665 * flusher_queue. This is the start-to-wait
2666 * phase for these overflowed flushers.
2667 */
2668 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2669 tmp->flush_color = wq->work_color;
2670
2671 wq->work_color = work_next_color(wq->work_color);
2672
2673 list_splice_tail_init(&wq->flusher_overflow,
2674 &wq->flusher_queue);
112202d9 2675 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
73f53c4a
TH
2676 }
2677
2678 if (list_empty(&wq->flusher_queue)) {
6183c009 2679 WARN_ON_ONCE(wq->flush_color != wq->work_color);
73f53c4a
TH
2680 break;
2681 }
2682
2683 /*
2684 * Need to flush more colors. Make the next flusher
112202d9 2685 * the new first flusher and arm pwqs.
73f53c4a 2686 */
6183c009
TH
2687 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2688 WARN_ON_ONCE(wq->flush_color != next->flush_color);
73f53c4a
TH
2689
2690 list_del_init(&next->list);
2691 wq->first_flusher = next;
2692
112202d9 2693 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
73f53c4a
TH
2694 break;
2695
2696 /*
2697 * Meh... this color is already done, clear first
2698 * flusher and repeat cascading.
2699 */
2700 wq->first_flusher = NULL;
2701 }
2702
2703out_unlock:
3c25a55d 2704 mutex_unlock(&wq->mutex);
1da177e4 2705}
ae90dd5d 2706EXPORT_SYMBOL_GPL(flush_workqueue);
1da177e4 2707
9c5a2ba7
TH
2708/**
2709 * drain_workqueue - drain a workqueue
2710 * @wq: workqueue to drain
2711 *
2712 * Wait until the workqueue becomes empty. While draining is in progress,
2713 * only chain queueing is allowed. IOW, only currently pending or running
2714 * work items on @wq can queue further work items on it. @wq is flushed
2715 * repeatedly until it becomes empty. The number of flushing is detemined
2716 * by the depth of chaining and should be relatively short. Whine if it
2717 * takes too long.
2718 */
2719void drain_workqueue(struct workqueue_struct *wq)
2720{
2721 unsigned int flush_cnt = 0;
49e3cf44 2722 struct pool_workqueue *pwq;
9c5a2ba7
TH
2723
2724 /*
2725 * __queue_work() needs to test whether there are drainers, is much
2726 * hotter than drain_workqueue() and already looks at @wq->flags.
618b01eb 2727 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
9c5a2ba7 2728 */
87fc741e 2729 mutex_lock(&wq->mutex);
9c5a2ba7 2730 if (!wq->nr_drainers++)
618b01eb 2731 wq->flags |= __WQ_DRAINING;
87fc741e 2732 mutex_unlock(&wq->mutex);
9c5a2ba7
TH
2733reflush:
2734 flush_workqueue(wq);
2735
b09f4fd3 2736 mutex_lock(&wq->mutex);
76af4d93 2737
49e3cf44 2738 for_each_pwq(pwq, wq) {
fa2563e4 2739 bool drained;
9c5a2ba7 2740
b09f4fd3 2741 spin_lock_irq(&pwq->pool->lock);
112202d9 2742 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
b09f4fd3 2743 spin_unlock_irq(&pwq->pool->lock);
fa2563e4
TT
2744
2745 if (drained)
9c5a2ba7
TH
2746 continue;
2747
2748 if (++flush_cnt == 10 ||
2749 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
c5aa87bb 2750 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
044c782c 2751 wq->name, flush_cnt);
76af4d93 2752
b09f4fd3 2753 mutex_unlock(&wq->mutex);
9c5a2ba7
TH
2754 goto reflush;
2755 }
2756
9c5a2ba7 2757 if (!--wq->nr_drainers)
618b01eb 2758 wq->flags &= ~__WQ_DRAINING;
87fc741e 2759 mutex_unlock(&wq->mutex);
9c5a2ba7
TH
2760}
2761EXPORT_SYMBOL_GPL(drain_workqueue);
2762
606a5020 2763static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
db700897 2764{
affee4b2 2765 struct worker *worker = NULL;
c9e7cf27 2766 struct worker_pool *pool;
112202d9 2767 struct pool_workqueue *pwq;
db700897
ON
2768
2769 might_sleep();
fa1b54e6
TH
2770
2771 local_irq_disable();
c9e7cf27 2772 pool = get_work_pool(work);
fa1b54e6
TH
2773 if (!pool) {
2774 local_irq_enable();
baf59022 2775 return false;
fa1b54e6 2776 }
db700897 2777
fa1b54e6 2778 spin_lock(&pool->lock);
0b3dae68 2779 /* see the comment in try_to_grab_pending() with the same code */
112202d9
TH
2780 pwq = get_work_pwq(work);
2781 if (pwq) {
2782 if (unlikely(pwq->pool != pool))
4690c4ab 2783 goto already_gone;
606a5020 2784 } else {
c9e7cf27 2785 worker = find_worker_executing_work(pool, work);
affee4b2 2786 if (!worker)
4690c4ab 2787 goto already_gone;
112202d9 2788 pwq = worker->current_pwq;
606a5020 2789 }
db700897 2790
112202d9 2791 insert_wq_barrier(pwq, barr, work, worker);
d565ed63 2792 spin_unlock_irq(&pool->lock);
7a22ad75 2793
e159489b
TH
2794 /*
2795 * If @max_active is 1 or rescuer is in use, flushing another work
2796 * item on the same workqueue may lead to deadlock. Make sure the
2797 * flusher is not running on the same workqueue by verifying write
2798 * access.
2799 */
493008a8 2800 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
112202d9 2801 lock_map_acquire(&pwq->wq->lockdep_map);
e159489b 2802 else
112202d9
TH
2803 lock_map_acquire_read(&pwq->wq->lockdep_map);
2804 lock_map_release(&pwq->wq->lockdep_map);
e159489b 2805
401a8d04 2806 return true;
4690c4ab 2807already_gone:
d565ed63 2808 spin_unlock_irq(&pool->lock);
401a8d04 2809 return false;
db700897 2810}
baf59022
TH
2811
2812/**
2813 * flush_work - wait for a work to finish executing the last queueing instance
2814 * @work: the work to flush
2815 *
606a5020
TH
2816 * Wait until @work has finished execution. @work is guaranteed to be idle
2817 * on return if it hasn't been requeued since flush started.
baf59022 2818 *
d185af30 2819 * Return:
baf59022
TH
2820 * %true if flush_work() waited for the work to finish execution,
2821 * %false if it was already idle.
2822 */
2823bool flush_work(struct work_struct *work)
2824{
12997d1a
BH
2825 struct wq_barrier barr;
2826
0976dfc1
SB
2827 lock_map_acquire(&work->lockdep_map);
2828 lock_map_release(&work->lockdep_map);
2829
12997d1a
BH
2830 if (start_flush_work(work, &barr)) {
2831 wait_for_completion(&barr.done);
2832 destroy_work_on_stack(&barr.work);
2833 return true;
2834 } else {
2835 return false;
2836 }
6e84d644 2837}
606a5020 2838EXPORT_SYMBOL_GPL(flush_work);
6e84d644 2839
36e227d2 2840static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
1f1f642e 2841{
bbb68dfa 2842 unsigned long flags;
1f1f642e
ON
2843 int ret;
2844
2845 do {
bbb68dfa
TH
2846 ret = try_to_grab_pending(work, is_dwork, &flags);
2847 /*
2848 * If someone else is canceling, wait for the same event it
2849 * would be waiting for before retrying.
2850 */
2851 if (unlikely(ret == -ENOENT))
606a5020 2852 flush_work(work);
1f1f642e
ON
2853 } while (unlikely(ret < 0));
2854
bbb68dfa
TH
2855 /* tell other tasks trying to grab @work to back off */
2856 mark_work_canceling(work);
2857 local_irq_restore(flags);
2858
606a5020 2859 flush_work(work);
7a22ad75 2860 clear_work_data(work);
1f1f642e
ON
2861 return ret;
2862}
2863
6e84d644 2864/**
401a8d04
TH
2865 * cancel_work_sync - cancel a work and wait for it to finish
2866 * @work: the work to cancel
6e84d644 2867 *
401a8d04
TH
2868 * Cancel @work and wait for its execution to finish. This function
2869 * can be used even if the work re-queues itself or migrates to
2870 * another workqueue. On return from this function, @work is
2871 * guaranteed to be not pending or executing on any CPU.
1f1f642e 2872 *
401a8d04
TH
2873 * cancel_work_sync(&delayed_work->work) must not be used for
2874 * delayed_work's. Use cancel_delayed_work_sync() instead.
6e84d644 2875 *
401a8d04 2876 * The caller must ensure that the workqueue on which @work was last
6e84d644 2877 * queued can't be destroyed before this function returns.
401a8d04 2878 *
d185af30 2879 * Return:
401a8d04 2880 * %true if @work was pending, %false otherwise.
6e84d644 2881 */
401a8d04 2882bool cancel_work_sync(struct work_struct *work)
6e84d644 2883{
36e227d2 2884 return __cancel_work_timer(work, false);
b89deed3 2885}
28e53bdd 2886EXPORT_SYMBOL_GPL(cancel_work_sync);
b89deed3 2887
6e84d644 2888/**
401a8d04
TH
2889 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2890 * @dwork: the delayed work to flush
6e84d644 2891 *
401a8d04
TH
2892 * Delayed timer is cancelled and the pending work is queued for
2893 * immediate execution. Like flush_work(), this function only
2894 * considers the last queueing instance of @dwork.
1f1f642e 2895 *
d185af30 2896 * Return:
401a8d04
TH
2897 * %true if flush_work() waited for the work to finish execution,
2898 * %false if it was already idle.
6e84d644 2899 */
401a8d04
TH
2900bool flush_delayed_work(struct delayed_work *dwork)
2901{
8930caba 2902 local_irq_disable();
401a8d04 2903 if (del_timer_sync(&dwork->timer))
60c057bc 2904 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
8930caba 2905 local_irq_enable();
401a8d04
TH
2906 return flush_work(&dwork->work);
2907}
2908EXPORT_SYMBOL(flush_delayed_work);
2909
09383498 2910/**
57b30ae7
TH
2911 * cancel_delayed_work - cancel a delayed work
2912 * @dwork: delayed_work to cancel
09383498 2913 *
d185af30
YB
2914 * Kill off a pending delayed_work.
2915 *
2916 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2917 * pending.
2918 *
2919 * Note:
2920 * The work callback function may still be running on return, unless
2921 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2922 * use cancel_delayed_work_sync() to wait on it.
09383498 2923 *
57b30ae7 2924 * This function is safe to call from any context including IRQ handler.
09383498 2925 */
57b30ae7 2926bool cancel_delayed_work(struct delayed_work *dwork)
09383498 2927{
57b30ae7
TH
2928 unsigned long flags;
2929 int ret;
2930
2931 do {
2932 ret = try_to_grab_pending(&dwork->work, true, &flags);
2933 } while (unlikely(ret == -EAGAIN));
2934
2935 if (unlikely(ret < 0))
2936 return false;
2937
7c3eed5c
TH
2938 set_work_pool_and_clear_pending(&dwork->work,
2939 get_work_pool_id(&dwork->work));
57b30ae7 2940 local_irq_restore(flags);
c0158ca6 2941 return ret;
09383498 2942}
57b30ae7 2943EXPORT_SYMBOL(cancel_delayed_work);
09383498 2944
401a8d04
TH
2945/**
2946 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2947 * @dwork: the delayed work cancel
2948 *
2949 * This is cancel_work_sync() for delayed works.
2950 *
d185af30 2951 * Return:
401a8d04
TH
2952 * %true if @dwork was pending, %false otherwise.
2953 */
2954bool cancel_delayed_work_sync(struct delayed_work *dwork)
6e84d644 2955{
36e227d2 2956 return __cancel_work_timer(&dwork->work, true);
6e84d644 2957}
f5a421a4 2958EXPORT_SYMBOL(cancel_delayed_work_sync);
1da177e4 2959
b6136773 2960/**
31ddd871 2961 * schedule_on_each_cpu - execute a function synchronously on each online CPU
b6136773 2962 * @func: the function to call
b6136773 2963 *
31ddd871
TH
2964 * schedule_on_each_cpu() executes @func on each online CPU using the
2965 * system workqueue and blocks until all CPUs have completed.
b6136773 2966 * schedule_on_each_cpu() is very slow.
31ddd871 2967 *
d185af30 2968 * Return:
31ddd871 2969 * 0 on success, -errno on failure.
b6136773 2970 */
65f27f38 2971int schedule_on_each_cpu(work_func_t func)
15316ba8
CL
2972{
2973 int cpu;
38f51568 2974 struct work_struct __percpu *works;
15316ba8 2975
b6136773
AM
2976 works = alloc_percpu(struct work_struct);
2977 if (!works)
15316ba8 2978 return -ENOMEM;
b6136773 2979
93981800
TH
2980 get_online_cpus();
2981
15316ba8 2982 for_each_online_cpu(cpu) {
9bfb1839
IM
2983 struct work_struct *work = per_cpu_ptr(works, cpu);
2984
2985 INIT_WORK(work, func);
b71ab8c2 2986 schedule_work_on(cpu, work);
65a64464 2987 }
93981800
TH
2988
2989 for_each_online_cpu(cpu)
2990 flush_work(per_cpu_ptr(works, cpu));
2991
95402b38 2992 put_online_cpus();
b6136773 2993 free_percpu(works);
15316ba8
CL
2994 return 0;
2995}
2996
eef6a7d5
AS
2997/**
2998 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2999 *
3000 * Forces execution of the kernel-global workqueue and blocks until its
3001 * completion.
3002 *
3003 * Think twice before calling this function! It's very easy to get into
3004 * trouble if you don't take great care. Either of the following situations
3005 * will lead to deadlock:
3006 *
3007 * One of the work items currently on the workqueue needs to acquire
3008 * a lock held by your code or its caller.
3009 *
3010 * Your code is running in the context of a work routine.
3011 *
3012 * They will be detected by lockdep when they occur, but the first might not
3013 * occur very often. It depends on what work items are on the workqueue and
3014 * what locks they need, which you have no control over.
3015 *
3016 * In most situations flushing the entire workqueue is overkill; you merely
3017 * need to know that a particular work item isn't queued and isn't running.
3018 * In such cases you should use cancel_delayed_work_sync() or
3019 * cancel_work_sync() instead.
3020 */
1da177e4
LT
3021void flush_scheduled_work(void)
3022{
d320c038 3023 flush_workqueue(system_wq);
1da177e4 3024}
ae90dd5d 3025EXPORT_SYMBOL(flush_scheduled_work);
1da177e4 3026
1fa44eca
JB
3027/**
3028 * execute_in_process_context - reliably execute the routine with user context
3029 * @fn: the function to execute
1fa44eca
JB
3030 * @ew: guaranteed storage for the execute work structure (must
3031 * be available when the work executes)
3032 *
3033 * Executes the function immediately if process context is available,
3034 * otherwise schedules the function for delayed execution.
3035 *
d185af30 3036 * Return: 0 - function was executed
1fa44eca
JB
3037 * 1 - function was scheduled for execution
3038 */
65f27f38 3039int execute_in_process_context(work_func_t fn, struct execute_work *ew)
1fa44eca
JB
3040{
3041 if (!in_interrupt()) {
65f27f38 3042 fn(&ew->work);
1fa44eca
JB
3043 return 0;
3044 }
3045
65f27f38 3046 INIT_WORK(&ew->work, fn);
1fa44eca
JB
3047 schedule_work(&ew->work);
3048
3049 return 1;
3050}
3051EXPORT_SYMBOL_GPL(execute_in_process_context);
3052
226223ab
TH
3053#ifdef CONFIG_SYSFS
3054/*
3055 * Workqueues with WQ_SYSFS flag set is visible to userland via
3056 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
3057 * following attributes.
3058 *
3059 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
3060 * max_active RW int : maximum number of in-flight work items
3061 *
3062 * Unbound workqueues have the following extra attributes.
3063 *
3064 * id RO int : the associated pool ID
3065 * nice RW int : nice value of the workers
3066 * cpumask RW mask : bitmask of allowed CPUs for the workers
3067 */
3068struct wq_device {
3069 struct workqueue_struct *wq;
3070 struct device dev;
3071};
3072
3073static struct workqueue_struct *dev_to_wq(struct device *dev)
3074{
3075 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3076
3077 return wq_dev->wq;
3078}
3079
1a6661da
GKH
3080static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
3081 char *buf)
226223ab
TH
3082{
3083 struct workqueue_struct *wq = dev_to_wq(dev);
3084
3085 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
3086}
1a6661da 3087static DEVICE_ATTR_RO(per_cpu);
226223ab 3088
1a6661da
GKH
3089static ssize_t max_active_show(struct device *dev,
3090 struct device_attribute *attr, char *buf)
226223ab
TH
3091{
3092 struct workqueue_struct *wq = dev_to_wq(dev);
3093
3094 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
3095}
3096
1a6661da
GKH
3097static ssize_t max_active_store(struct device *dev,
3098 struct device_attribute *attr, const char *buf,
3099 size_t count)
226223ab
TH
3100{
3101 struct workqueue_struct *wq = dev_to_wq(dev);
3102 int val;
3103
3104 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
3105 return -EINVAL;
3106
3107 workqueue_set_max_active(wq, val);
3108 return count;
3109}
1a6661da 3110static DEVICE_ATTR_RW(max_active);
226223ab 3111
1a6661da
GKH
3112static struct attribute *wq_sysfs_attrs[] = {
3113 &dev_attr_per_cpu.attr,
3114 &dev_attr_max_active.attr,
3115 NULL,
226223ab 3116};
1a6661da 3117ATTRIBUTE_GROUPS(wq_sysfs);
226223ab 3118
d55262c4
TH
3119static ssize_t wq_pool_ids_show(struct device *dev,
3120 struct device_attribute *attr, char *buf)
226223ab
TH
3121{
3122 struct workqueue_struct *wq = dev_to_wq(dev);
d55262c4
TH
3123 const char *delim = "";
3124 int node, written = 0;
226223ab
TH
3125
3126 rcu_read_lock_sched();
d55262c4
TH
3127 for_each_node(node) {
3128 written += scnprintf(buf + written, PAGE_SIZE - written,
3129 "%s%d:%d", delim, node,
3130 unbound_pwq_by_node(wq, node)->pool->id);
3131 delim = " ";
3132 }
3133 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
226223ab
TH
3134 rcu_read_unlock_sched();
3135
3136 return written;
3137}
3138
3139static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3140 char *buf)
3141{
3142 struct workqueue_struct *wq = dev_to_wq(dev);
3143 int written;
3144
6029a918
TH
3145 mutex_lock(&wq->mutex);
3146 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
3147 mutex_unlock(&wq->mutex);
226223ab
TH
3148
3149 return written;
3150}
3151
3152/* prepare workqueue_attrs for sysfs store operations */
3153static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3154{
3155 struct workqueue_attrs *attrs;
3156
3157 attrs = alloc_workqueue_attrs(GFP_KERNEL);
3158 if (!attrs)
3159 return NULL;
3160
6029a918
TH
3161 mutex_lock(&wq->mutex);
3162 copy_workqueue_attrs(attrs, wq->unbound_attrs);
3163 mutex_unlock(&wq->mutex);
226223ab
TH
3164 return attrs;
3165}
3166
3167static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3168 const char *buf, size_t count)
3169{
3170 struct workqueue_struct *wq = dev_to_wq(dev);
3171 struct workqueue_attrs *attrs;
3172 int ret;
3173
3174 attrs = wq_sysfs_prep_attrs(wq);
3175 if (!attrs)
3176 return -ENOMEM;
3177
3178 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
14481842 3179 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
226223ab
TH
3180 ret = apply_workqueue_attrs(wq, attrs);
3181 else
3182 ret = -EINVAL;
3183
3184 free_workqueue_attrs(attrs);
3185 return ret ?: count;
3186}
3187
3188static ssize_t wq_cpumask_show(struct device *dev,
3189 struct device_attribute *attr, char *buf)
3190{
3191 struct workqueue_struct *wq = dev_to_wq(dev);
3192 int written;
3193
6029a918
TH
3194 mutex_lock(&wq->mutex);
3195 written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
3196 mutex_unlock(&wq->mutex);
226223ab
TH
3197
3198 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3199 return written;
3200}
3201
3202static ssize_t wq_cpumask_store(struct device *dev,
3203 struct device_attribute *attr,
3204 const char *buf, size_t count)
3205{
3206 struct workqueue_struct *wq = dev_to_wq(dev);
3207 struct workqueue_attrs *attrs;
3208 int ret;
3209
3210 attrs = wq_sysfs_prep_attrs(wq);
3211 if (!attrs)
3212 return -ENOMEM;
3213
3214 ret = cpumask_parse(buf, attrs->cpumask);
3215 if (!ret)
3216 ret = apply_workqueue_attrs(wq, attrs);
3217
3218 free_workqueue_attrs(attrs);
3219 return ret ?: count;
3220}
3221
d55262c4
TH
3222static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
3223 char *buf)
3224{
3225 struct workqueue_struct *wq = dev_to_wq(dev);
3226 int written;
3227
3228 mutex_lock(&wq->mutex);
3229 written = scnprintf(buf, PAGE_SIZE, "%d\n",
3230 !wq->unbound_attrs->no_numa);
3231 mutex_unlock(&wq->mutex);
3232
3233 return written;
3234}
3235
3236static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
3237 const char *buf, size_t count)
3238{
3239 struct workqueue_struct *wq = dev_to_wq(dev);
3240 struct workqueue_attrs *attrs;
3241 int v, ret;
3242
3243 attrs = wq_sysfs_prep_attrs(wq);
3244 if (!attrs)
3245 return -ENOMEM;
3246
3247 ret = -EINVAL;
3248 if (sscanf(buf, "%d", &v) == 1) {
3249 attrs->no_numa = !v;
3250 ret = apply_workqueue_attrs(wq, attrs);
3251 }
3252
3253 free_workqueue_attrs(attrs);
3254 return ret ?: count;
3255}
3256
226223ab 3257static struct device_attribute wq_sysfs_unbound_attrs[] = {
d55262c4 3258 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
226223ab
TH
3259 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3260 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
d55262c4 3261 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
226223ab
TH
3262 __ATTR_NULL,
3263};
3264
3265static struct bus_type wq_subsys = {
3266 .name = "workqueue",
1a6661da 3267 .dev_groups = wq_sysfs_groups,
226223ab
TH
3268};
3269
3270static int __init wq_sysfs_init(void)
3271{
3272 return subsys_virtual_register(&wq_subsys, NULL);
3273}
3274core_initcall(wq_sysfs_init);
3275
3276static void wq_device_release(struct device *dev)
3277{
3278 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3279
3280 kfree(wq_dev);
3281}
3282
3283/**
3284 * workqueue_sysfs_register - make a workqueue visible in sysfs
3285 * @wq: the workqueue to register
3286 *
3287 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3288 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3289 * which is the preferred method.
3290 *
3291 * Workqueue user should use this function directly iff it wants to apply
3292 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3293 * apply_workqueue_attrs() may race against userland updating the
3294 * attributes.
3295 *
d185af30 3296 * Return: 0 on success, -errno on failure.
226223ab
TH
3297 */
3298int workqueue_sysfs_register(struct workqueue_struct *wq)
3299{
3300 struct wq_device *wq_dev;
3301 int ret;
3302
3303 /*
3304 * Adjusting max_active or creating new pwqs by applyting
3305 * attributes breaks ordering guarantee. Disallow exposing ordered
3306 * workqueues.
3307 */
3308 if (WARN_ON(wq->flags & __WQ_ORDERED))
3309 return -EINVAL;
3310
3311 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3312 if (!wq_dev)
3313 return -ENOMEM;
3314
3315 wq_dev->wq = wq;
3316 wq_dev->dev.bus = &wq_subsys;
3317 wq_dev->dev.init_name = wq->name;
3318 wq_dev->dev.release = wq_device_release;
3319
3320 /*
3321 * unbound_attrs are created separately. Suppress uevent until
3322 * everything is ready.
3323 */
3324 dev_set_uevent_suppress(&wq_dev->dev, true);
3325
3326 ret = device_register(&wq_dev->dev);
3327 if (ret) {
3328 kfree(wq_dev);
3329 wq->wq_dev = NULL;
3330 return ret;
3331 }
3332
3333 if (wq->flags & WQ_UNBOUND) {
3334 struct device_attribute *attr;
3335
3336 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3337 ret = device_create_file(&wq_dev->dev, attr);
3338 if (ret) {
3339 device_unregister(&wq_dev->dev);
3340 wq->wq_dev = NULL;
3341 return ret;
3342 }
3343 }
3344 }
3345
3346 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3347 return 0;
3348}
3349
3350/**
3351 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3352 * @wq: the workqueue to unregister
3353 *
3354 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3355 */
3356static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3357{
3358 struct wq_device *wq_dev = wq->wq_dev;
3359
3360 if (!wq->wq_dev)
3361 return;
3362
3363 wq->wq_dev = NULL;
3364 device_unregister(&wq_dev->dev);
3365}
3366#else /* CONFIG_SYSFS */
3367static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
3368#endif /* CONFIG_SYSFS */
3369
7a4e344c
TH
3370/**
3371 * free_workqueue_attrs - free a workqueue_attrs
3372 * @attrs: workqueue_attrs to free
3373 *
3374 * Undo alloc_workqueue_attrs().
3375 */
3376void free_workqueue_attrs(struct workqueue_attrs *attrs)
3377{
3378 if (attrs) {
3379 free_cpumask_var(attrs->cpumask);
3380 kfree(attrs);
3381 }
3382}
3383
3384/**
3385 * alloc_workqueue_attrs - allocate a workqueue_attrs
3386 * @gfp_mask: allocation mask to use
3387 *
3388 * Allocate a new workqueue_attrs, initialize with default settings and
d185af30
YB
3389 * return it.
3390 *
3391 * Return: The allocated new workqueue_attr on success. %NULL on failure.
7a4e344c
TH
3392 */
3393struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3394{
3395 struct workqueue_attrs *attrs;
3396
3397 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3398 if (!attrs)
3399 goto fail;
3400 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3401 goto fail;
3402
13e2e556 3403 cpumask_copy(attrs->cpumask, cpu_possible_mask);
7a4e344c
TH
3404 return attrs;
3405fail:
3406 free_workqueue_attrs(attrs);
3407 return NULL;
3408}
3409
29c91e99
TH
3410static void copy_workqueue_attrs(struct workqueue_attrs *to,
3411 const struct workqueue_attrs *from)
3412{
3413 to->nice = from->nice;
3414 cpumask_copy(to->cpumask, from->cpumask);
2865a8fb
SL
3415 /*
3416 * Unlike hash and equality test, this function doesn't ignore
3417 * ->no_numa as it is used for both pool and wq attrs. Instead,
3418 * get_unbound_pool() explicitly clears ->no_numa after copying.
3419 */
3420 to->no_numa = from->no_numa;
29c91e99
TH
3421}
3422
29c91e99
TH
3423/* hash value of the content of @attr */
3424static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3425{
3426 u32 hash = 0;
3427
3428 hash = jhash_1word(attrs->nice, hash);
13e2e556
TH
3429 hash = jhash(cpumask_bits(attrs->cpumask),
3430 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
29c91e99
TH
3431 return hash;
3432}
3433
3434/* content equality test */
3435static bool wqattrs_equal(const struct workqueue_attrs *a,
3436 const struct workqueue_attrs *b)
3437{
3438 if (a->nice != b->nice)
3439 return false;
3440 if (!cpumask_equal(a->cpumask, b->cpumask))
3441 return false;
3442 return true;
3443}
3444
7a4e344c
TH
3445/**
3446 * init_worker_pool - initialize a newly zalloc'd worker_pool
3447 * @pool: worker_pool to initialize
3448 *
3449 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
d185af30
YB
3450 *
3451 * Return: 0 on success, -errno on failure. Even on failure, all fields
29c91e99
TH
3452 * inside @pool proper are initialized and put_unbound_pool() can be called
3453 * on @pool safely to release it.
7a4e344c
TH
3454 */
3455static int init_worker_pool(struct worker_pool *pool)
4e1a1f9a
TH
3456{
3457 spin_lock_init(&pool->lock);
29c91e99
TH
3458 pool->id = -1;
3459 pool->cpu = -1;
f3f90ad4 3460 pool->node = NUMA_NO_NODE;
4e1a1f9a
TH
3461 pool->flags |= POOL_DISASSOCIATED;
3462 INIT_LIST_HEAD(&pool->worklist);
3463 INIT_LIST_HEAD(&pool->idle_list);
3464 hash_init(pool->busy_hash);
3465
3466 init_timer_deferrable(&pool->idle_timer);
3467 pool->idle_timer.function = idle_worker_timeout;
3468 pool->idle_timer.data = (unsigned long)pool;
3469
3470 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3471 (unsigned long)pool);
3472
3473 mutex_init(&pool->manager_arb);
92f9c5c4 3474 mutex_init(&pool->attach_mutex);
da028469 3475 INIT_LIST_HEAD(&pool->workers);
7a4e344c 3476
7cda9aae 3477 ida_init(&pool->worker_ida);
29c91e99
TH
3478 INIT_HLIST_NODE(&pool->hash_node);
3479 pool->refcnt = 1;
3480
3481 /* shouldn't fail above this point */
7a4e344c
TH
3482 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3483 if (!pool->attrs)
3484 return -ENOMEM;
3485 return 0;
4e1a1f9a
TH
3486}
3487
29c91e99
TH
3488static void rcu_free_pool(struct rcu_head *rcu)
3489{
3490 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3491
7cda9aae 3492 ida_destroy(&pool->worker_ida);
29c91e99
TH
3493 free_workqueue_attrs(pool->attrs);
3494 kfree(pool);
3495}
3496
3497/**
3498 * put_unbound_pool - put a worker_pool
3499 * @pool: worker_pool to put
3500 *
3501 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
c5aa87bb
TH
3502 * safe manner. get_unbound_pool() calls this function on its failure path
3503 * and this function should be able to release pools which went through,
3504 * successfully or not, init_worker_pool().
a892cacc
TH
3505 *
3506 * Should be called with wq_pool_mutex held.
29c91e99
TH
3507 */
3508static void put_unbound_pool(struct worker_pool *pool)
3509{
60f5a4bc 3510 DECLARE_COMPLETION_ONSTACK(detach_completion);
29c91e99
TH
3511 struct worker *worker;
3512
a892cacc
TH
3513 lockdep_assert_held(&wq_pool_mutex);
3514
3515 if (--pool->refcnt)
29c91e99 3516 return;
29c91e99
TH
3517
3518 /* sanity checks */
3519 if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
a892cacc 3520 WARN_ON(!list_empty(&pool->worklist)))
29c91e99 3521 return;
29c91e99
TH
3522
3523 /* release id and unhash */
3524 if (pool->id >= 0)
3525 idr_remove(&worker_pool_idr, pool->id);
3526 hash_del(&pool->hash_node);
3527
c5aa87bb
TH
3528 /*
3529 * Become the manager and destroy all workers. Grabbing
3530 * manager_arb prevents @pool's workers from blocking on
92f9c5c4 3531 * attach_mutex.
c5aa87bb 3532 */
29c91e99 3533 mutex_lock(&pool->manager_arb);
29c91e99 3534
60f5a4bc 3535 spin_lock_irq(&pool->lock);
29c91e99
TH
3536 while ((worker = first_worker(pool)))
3537 destroy_worker(worker);
3538 WARN_ON(pool->nr_workers || pool->nr_idle);
29c91e99 3539 spin_unlock_irq(&pool->lock);
60f5a4bc 3540
92f9c5c4 3541 mutex_lock(&pool->attach_mutex);
da028469 3542 if (!list_empty(&pool->workers))
60f5a4bc 3543 pool->detach_completion = &detach_completion;
92f9c5c4 3544 mutex_unlock(&pool->attach_mutex);
60f5a4bc
LJ
3545
3546 if (pool->detach_completion)
3547 wait_for_completion(pool->detach_completion);
3548
29c91e99
TH
3549 mutex_unlock(&pool->manager_arb);
3550
3551 /* shut down the timers */
3552 del_timer_sync(&pool->idle_timer);
3553 del_timer_sync(&pool->mayday_timer);
3554
3555 /* sched-RCU protected to allow dereferences from get_work_pool() */
3556 call_rcu_sched(&pool->rcu, rcu_free_pool);
3557}
3558
3559/**
3560 * get_unbound_pool - get a worker_pool with the specified attributes
3561 * @attrs: the attributes of the worker_pool to get
3562 *
3563 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3564 * reference count and return it. If there already is a matching
3565 * worker_pool, it will be used; otherwise, this function attempts to
d185af30 3566 * create a new one.
a892cacc
TH
3567 *
3568 * Should be called with wq_pool_mutex held.
d185af30
YB
3569 *
3570 * Return: On success, a worker_pool with the same attributes as @attrs.
3571 * On failure, %NULL.
29c91e99
TH
3572 */
3573static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3574{
29c91e99
TH
3575 u32 hash = wqattrs_hash(attrs);
3576 struct worker_pool *pool;
f3f90ad4 3577 int node;
29c91e99 3578
a892cacc 3579 lockdep_assert_held(&wq_pool_mutex);
29c91e99
TH
3580
3581 /* do we already have a matching pool? */
29c91e99
TH
3582 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3583 if (wqattrs_equal(pool->attrs, attrs)) {
3584 pool->refcnt++;
3585 goto out_unlock;
3586 }
3587 }
29c91e99
TH
3588
3589 /* nope, create a new one */
3590 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3591 if (!pool || init_worker_pool(pool) < 0)
3592 goto fail;
3593
12ee4fc6
LJ
3594 if (workqueue_freezing)
3595 pool->flags |= POOL_FREEZING;
3596
8864b4e5 3597 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
29c91e99
TH
3598 copy_workqueue_attrs(pool->attrs, attrs);
3599
2865a8fb
SL
3600 /*
3601 * no_numa isn't a worker_pool attribute, always clear it. See
3602 * 'struct workqueue_attrs' comments for detail.
3603 */
3604 pool->attrs->no_numa = false;
3605
f3f90ad4
TH
3606 /* if cpumask is contained inside a NUMA node, we belong to that node */
3607 if (wq_numa_enabled) {
3608 for_each_node(node) {
3609 if (cpumask_subset(pool->attrs->cpumask,
3610 wq_numa_possible_cpumask[node])) {
3611 pool->node = node;
3612 break;
3613 }
3614 }
3615 }
3616
29c91e99
TH
3617 if (worker_pool_assign_id(pool) < 0)
3618 goto fail;
3619
3620 /* create and start the initial worker */
ebf44d16 3621 if (create_and_start_worker(pool) < 0)
29c91e99
TH
3622 goto fail;
3623
29c91e99 3624 /* install */
29c91e99
TH
3625 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3626out_unlock:
29c91e99
TH
3627 return pool;
3628fail:
29c91e99
TH
3629 if (pool)
3630 put_unbound_pool(pool);
3631 return NULL;
3632}
3633
8864b4e5
TH
3634static void rcu_free_pwq(struct rcu_head *rcu)
3635{
3636 kmem_cache_free(pwq_cache,
3637 container_of(rcu, struct pool_workqueue, rcu));
3638}
3639
3640/*
3641 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3642 * and needs to be destroyed.
3643 */
3644static void pwq_unbound_release_workfn(struct work_struct *work)
3645{
3646 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3647 unbound_release_work);
3648 struct workqueue_struct *wq = pwq->wq;
3649 struct worker_pool *pool = pwq->pool;
bc0caf09 3650 bool is_last;
8864b4e5
TH
3651
3652 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3653 return;
3654
75ccf595 3655 /*
3c25a55d 3656 * Unlink @pwq. Synchronization against wq->mutex isn't strictly
75ccf595
TH
3657 * necessary on release but do it anyway. It's easier to verify
3658 * and consistent with the linking path.
3659 */
3c25a55d 3660 mutex_lock(&wq->mutex);
8864b4e5 3661 list_del_rcu(&pwq->pwqs_node);
bc0caf09 3662 is_last = list_empty(&wq->pwqs);
3c25a55d 3663 mutex_unlock(&wq->mutex);
8864b4e5 3664
a892cacc 3665 mutex_lock(&wq_pool_mutex);
8864b4e5 3666 put_unbound_pool(pool);
a892cacc
TH
3667 mutex_unlock(&wq_pool_mutex);
3668
8864b4e5
TH
3669 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3670
3671 /*
3672 * If we're the last pwq going away, @wq is already dead and no one
3673 * is gonna access it anymore. Free it.
3674 */
6029a918
TH
3675 if (is_last) {
3676 free_workqueue_attrs(wq->unbound_attrs);
8864b4e5 3677 kfree(wq);
6029a918 3678 }
8864b4e5
TH
3679}
3680
0fbd95aa 3681/**
699ce097 3682 * pwq_adjust_max_active - update a pwq's max_active to the current setting
0fbd95aa 3683 * @pwq: target pool_workqueue
0fbd95aa 3684 *
699ce097
TH
3685 * If @pwq isn't freezing, set @pwq->max_active to the associated
3686 * workqueue's saved_max_active and activate delayed work items
3687 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
0fbd95aa 3688 */
699ce097 3689static void pwq_adjust_max_active(struct pool_workqueue *pwq)
0fbd95aa 3690{
699ce097
TH
3691 struct workqueue_struct *wq = pwq->wq;
3692 bool freezable = wq->flags & WQ_FREEZABLE;
3693
3694 /* for @wq->saved_max_active */
a357fc03 3695 lockdep_assert_held(&wq->mutex);
699ce097
TH
3696
3697 /* fast exit for non-freezable wqs */
3698 if (!freezable && pwq->max_active == wq->saved_max_active)
3699 return;
3700
a357fc03 3701 spin_lock_irq(&pwq->pool->lock);
699ce097
TH
3702
3703 if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) {
3704 pwq->max_active = wq->saved_max_active;
0fbd95aa 3705
699ce097
TH
3706 while (!list_empty(&pwq->delayed_works) &&
3707 pwq->nr_active < pwq->max_active)
3708 pwq_activate_first_delayed(pwq);
951a078a
LJ
3709
3710 /*
3711 * Need to kick a worker after thawed or an unbound wq's
3712 * max_active is bumped. It's a slow path. Do it always.
3713 */
3714 wake_up_worker(pwq->pool);
699ce097
TH
3715 } else {
3716 pwq->max_active = 0;
3717 }
3718
a357fc03 3719 spin_unlock_irq(&pwq->pool->lock);
0fbd95aa
TH
3720}
3721
e50aba9a 3722/* initialize newly alloced @pwq which is associated with @wq and @pool */
f147f29e
TH
3723static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3724 struct worker_pool *pool)
d2c1d404
TH
3725{
3726 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3727
e50aba9a
TH
3728 memset(pwq, 0, sizeof(*pwq));
3729
d2c1d404
TH
3730 pwq->pool = pool;
3731 pwq->wq = wq;
3732 pwq->flush_color = -1;
8864b4e5 3733 pwq->refcnt = 1;
d2c1d404 3734 INIT_LIST_HEAD(&pwq->delayed_works);
1befcf30 3735 INIT_LIST_HEAD(&pwq->pwqs_node);
d2c1d404 3736 INIT_LIST_HEAD(&pwq->mayday_node);
8864b4e5 3737 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
f147f29e 3738}
d2c1d404 3739
f147f29e 3740/* sync @pwq with the current state of its associated wq and link it */
1befcf30 3741static void link_pwq(struct pool_workqueue *pwq)
f147f29e
TH
3742{
3743 struct workqueue_struct *wq = pwq->wq;
3744
3745 lockdep_assert_held(&wq->mutex);
75ccf595 3746
1befcf30
TH
3747 /* may be called multiple times, ignore if already linked */
3748 if (!list_empty(&pwq->pwqs_node))
3749 return;
3750
983ca25e
TH
3751 /*
3752 * Set the matching work_color. This is synchronized with
3c25a55d 3753 * wq->mutex to avoid confusing flush_workqueue().
983ca25e 3754 */
75ccf595 3755 pwq->work_color = wq->work_color;
983ca25e
TH
3756
3757 /* sync max_active to the current setting */
3758 pwq_adjust_max_active(pwq);
3759
3760 /* link in @pwq */
9e8cd2f5 3761 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
f147f29e 3762}
a357fc03 3763
f147f29e
TH
3764/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3765static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3766 const struct workqueue_attrs *attrs)
3767{
3768 struct worker_pool *pool;
3769 struct pool_workqueue *pwq;
3770
3771 lockdep_assert_held(&wq_pool_mutex);
3772
3773 pool = get_unbound_pool(attrs);
3774 if (!pool)
3775 return NULL;
3776
e50aba9a 3777 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
f147f29e
TH
3778 if (!pwq) {
3779 put_unbound_pool(pool);
3780 return NULL;
df2d5ae4 3781 }
6029a918 3782
f147f29e
TH
3783 init_pwq(pwq, wq, pool);
3784 return pwq;
d2c1d404
TH
3785}
3786
4c16bd32
TH
3787/* undo alloc_unbound_pwq(), used only in the error path */
3788static void free_unbound_pwq(struct pool_workqueue *pwq)
3789{
3790 lockdep_assert_held(&wq_pool_mutex);
3791
3792 if (pwq) {
3793 put_unbound_pool(pwq->pool);
cece95df 3794 kmem_cache_free(pwq_cache, pwq);
4c16bd32
TH
3795 }
3796}
3797
3798/**
3799 * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
3800 * @attrs: the wq_attrs of interest
3801 * @node: the target NUMA node
3802 * @cpu_going_down: if >= 0, the CPU to consider as offline
3803 * @cpumask: outarg, the resulting cpumask
3804 *
3805 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3806 * @cpu_going_down is >= 0, that cpu is considered offline during
d185af30 3807 * calculation. The result is stored in @cpumask.
4c16bd32
TH
3808 *
3809 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3810 * enabled and @node has online CPUs requested by @attrs, the returned
3811 * cpumask is the intersection of the possible CPUs of @node and
3812 * @attrs->cpumask.
3813 *
3814 * The caller is responsible for ensuring that the cpumask of @node stays
3815 * stable.
d185af30
YB
3816 *
3817 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3818 * %false if equal.
4c16bd32
TH
3819 */
3820static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3821 int cpu_going_down, cpumask_t *cpumask)
3822{
d55262c4 3823 if (!wq_numa_enabled || attrs->no_numa)
4c16bd32
TH
3824 goto use_dfl;
3825
3826 /* does @node have any online CPUs @attrs wants? */
3827 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3828 if (cpu_going_down >= 0)
3829 cpumask_clear_cpu(cpu_going_down, cpumask);
3830
3831 if (cpumask_empty(cpumask))
3832 goto use_dfl;
3833
3834 /* yeap, return possible CPUs in @node that @attrs wants */
3835 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3836 return !cpumask_equal(cpumask, attrs->cpumask);
3837
3838use_dfl:
3839 cpumask_copy(cpumask, attrs->cpumask);
3840 return false;
3841}
3842
1befcf30
TH
3843/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3844static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3845 int node,
3846 struct pool_workqueue *pwq)
3847{
3848 struct pool_workqueue *old_pwq;
3849
3850 lockdep_assert_held(&wq->mutex);
3851
3852 /* link_pwq() can handle duplicate calls */
3853 link_pwq(pwq);
3854
3855 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3856 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3857 return old_pwq;
3858}
3859
9e8cd2f5
TH
3860/**
3861 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3862 * @wq: the target workqueue
3863 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3864 *
4c16bd32
TH
3865 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3866 * machines, this function maps a separate pwq to each NUMA node with
3867 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3868 * NUMA node it was issued on. Older pwqs are released as in-flight work
3869 * items finish. Note that a work item which repeatedly requeues itself
3870 * back-to-back will stay on its current pwq.
9e8cd2f5 3871 *
d185af30
YB
3872 * Performs GFP_KERNEL allocations.
3873 *
3874 * Return: 0 on success and -errno on failure.
9e8cd2f5
TH
3875 */
3876int apply_workqueue_attrs(struct workqueue_struct *wq,
3877 const struct workqueue_attrs *attrs)
3878{
4c16bd32
TH
3879 struct workqueue_attrs *new_attrs, *tmp_attrs;
3880 struct pool_workqueue **pwq_tbl, *dfl_pwq;
f147f29e 3881 int node, ret;
9e8cd2f5 3882
8719dcea 3883 /* only unbound workqueues can change attributes */
9e8cd2f5
TH
3884 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3885 return -EINVAL;
3886
8719dcea
TH
3887 /* creating multiple pwqs breaks ordering guarantee */
3888 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3889 return -EINVAL;
3890
4c16bd32 3891 pwq_tbl = kzalloc(wq_numa_tbl_len * sizeof(pwq_tbl[0]), GFP_KERNEL);
13e2e556 3892 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4c16bd32
TH
3893 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3894 if (!pwq_tbl || !new_attrs || !tmp_attrs)
13e2e556
TH
3895 goto enomem;
3896
4c16bd32 3897 /* make a copy of @attrs and sanitize it */
13e2e556
TH
3898 copy_workqueue_attrs(new_attrs, attrs);
3899 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3900
4c16bd32
TH
3901 /*
3902 * We may create multiple pwqs with differing cpumasks. Make a
3903 * copy of @new_attrs which will be modified and used to obtain
3904 * pools.
3905 */
3906 copy_workqueue_attrs(tmp_attrs, new_attrs);
3907
3908 /*
3909 * CPUs should stay stable across pwq creations and installations.
3910 * Pin CPUs, determine the target cpumask for each node and create
3911 * pwqs accordingly.
3912 */
3913 get_online_cpus();
3914
a892cacc 3915 mutex_lock(&wq_pool_mutex);
4c16bd32
TH
3916
3917 /*
3918 * If something goes wrong during CPU up/down, we'll fall back to
3919 * the default pwq covering whole @attrs->cpumask. Always create
3920 * it even if we don't use it immediately.
3921 */
3922 dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3923 if (!dfl_pwq)
3924 goto enomem_pwq;
3925
3926 for_each_node(node) {
3927 if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
3928 pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3929 if (!pwq_tbl[node])
3930 goto enomem_pwq;
3931 } else {
3932 dfl_pwq->refcnt++;
3933 pwq_tbl[node] = dfl_pwq;
3934 }
3935 }
3936
f147f29e 3937 mutex_unlock(&wq_pool_mutex);
9e8cd2f5 3938
4c16bd32 3939 /* all pwqs have been created successfully, let's install'em */
f147f29e 3940 mutex_lock(&wq->mutex);
a892cacc 3941
f147f29e 3942 copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
4c16bd32
TH
3943
3944 /* save the previous pwq and install the new one */
f147f29e 3945 for_each_node(node)
4c16bd32
TH
3946 pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
3947
3948 /* @dfl_pwq might not have been used, ensure it's linked */
3949 link_pwq(dfl_pwq);
3950 swap(wq->dfl_pwq, dfl_pwq);
f147f29e
TH
3951
3952 mutex_unlock(&wq->mutex);
9e8cd2f5 3953
4c16bd32
TH
3954 /* put the old pwqs */
3955 for_each_node(node)
3956 put_pwq_unlocked(pwq_tbl[node]);
3957 put_pwq_unlocked(dfl_pwq);
3958
3959 put_online_cpus();
4862125b
TH
3960 ret = 0;
3961 /* fall through */
3962out_free:
4c16bd32 3963 free_workqueue_attrs(tmp_attrs);
4862125b 3964 free_workqueue_attrs(new_attrs);
4c16bd32 3965 kfree(pwq_tbl);
4862125b 3966 return ret;
13e2e556 3967
4c16bd32
TH
3968enomem_pwq:
3969 free_unbound_pwq(dfl_pwq);
3970 for_each_node(node)
3971 if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
3972 free_unbound_pwq(pwq_tbl[node]);
3973 mutex_unlock(&wq_pool_mutex);
3974 put_online_cpus();
13e2e556 3975enomem:
4862125b
TH
3976 ret = -ENOMEM;
3977 goto out_free;
9e8cd2f5
TH
3978}
3979
4c16bd32
TH
3980/**
3981 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3982 * @wq: the target workqueue
3983 * @cpu: the CPU coming up or going down
3984 * @online: whether @cpu is coming up or going down
3985 *
3986 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3987 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3988 * @wq accordingly.
3989 *
3990 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3991 * falls back to @wq->dfl_pwq which may not be optimal but is always
3992 * correct.
3993 *
3994 * Note that when the last allowed CPU of a NUMA node goes offline for a
3995 * workqueue with a cpumask spanning multiple nodes, the workers which were
3996 * already executing the work items for the workqueue will lose their CPU
3997 * affinity and may execute on any CPU. This is similar to how per-cpu
3998 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3999 * affinity, it's the user's responsibility to flush the work item from
4000 * CPU_DOWN_PREPARE.
4001 */
4002static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
4003 bool online)
4004{
4005 int node = cpu_to_node(cpu);
4006 int cpu_off = online ? -1 : cpu;
4007 struct pool_workqueue *old_pwq = NULL, *pwq;
4008 struct workqueue_attrs *target_attrs;
4009 cpumask_t *cpumask;
4010
4011 lockdep_assert_held(&wq_pool_mutex);
4012
4013 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
4014 return;
4015
4016 /*
4017 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
4018 * Let's use a preallocated one. The following buf is protected by
4019 * CPU hotplug exclusion.
4020 */
4021 target_attrs = wq_update_unbound_numa_attrs_buf;
4022 cpumask = target_attrs->cpumask;
4023
4024 mutex_lock(&wq->mutex);
d55262c4
TH
4025 if (wq->unbound_attrs->no_numa)
4026 goto out_unlock;
4c16bd32
TH
4027
4028 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
4029 pwq = unbound_pwq_by_node(wq, node);
4030
4031 /*
4032 * Let's determine what needs to be done. If the target cpumask is
4033 * different from wq's, we need to compare it to @pwq's and create
4034 * a new one if they don't match. If the target cpumask equals
534a3fbb 4035 * wq's, the default pwq should be used.
4c16bd32
TH
4036 */
4037 if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
4038 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
4039 goto out_unlock;
4040 } else {
534a3fbb 4041 goto use_dfl_pwq;
4c16bd32
TH
4042 }
4043
4044 mutex_unlock(&wq->mutex);
4045
4046 /* create a new pwq */
4047 pwq = alloc_unbound_pwq(wq, target_attrs);
4048 if (!pwq) {
2d916033
FF
4049 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
4050 wq->name);
77f300b1
DY
4051 mutex_lock(&wq->mutex);
4052 goto use_dfl_pwq;
4c16bd32
TH
4053 }
4054
4055 /*
4056 * Install the new pwq. As this function is called only from CPU
4057 * hotplug callbacks and applying a new attrs is wrapped with
4058 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
4059 * inbetween.
4060 */
4061 mutex_lock(&wq->mutex);
4062 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
4063 goto out_unlock;
4064
4065use_dfl_pwq:
4066 spin_lock_irq(&wq->dfl_pwq->pool->lock);
4067 get_pwq(wq->dfl_pwq);
4068 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4069 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
4070out_unlock:
4071 mutex_unlock(&wq->mutex);
4072 put_pwq_unlocked(old_pwq);
4073}
4074
30cdf249 4075static int alloc_and_link_pwqs(struct workqueue_struct *wq)
0f900049 4076{
49e3cf44 4077 bool highpri = wq->flags & WQ_HIGHPRI;
8a2b7538 4078 int cpu, ret;
30cdf249
TH
4079
4080 if (!(wq->flags & WQ_UNBOUND)) {
420c0ddb
TH
4081 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4082 if (!wq->cpu_pwqs)
30cdf249
TH
4083 return -ENOMEM;
4084
4085 for_each_possible_cpu(cpu) {
7fb98ea7
TH
4086 struct pool_workqueue *pwq =
4087 per_cpu_ptr(wq->cpu_pwqs, cpu);
7a62c2c8 4088 struct worker_pool *cpu_pools =
f02ae73a 4089 per_cpu(cpu_worker_pools, cpu);
f3421797 4090
f147f29e
TH
4091 init_pwq(pwq, wq, &cpu_pools[highpri]);
4092
4093 mutex_lock(&wq->mutex);
1befcf30 4094 link_pwq(pwq);
f147f29e 4095 mutex_unlock(&wq->mutex);
30cdf249 4096 }
9e8cd2f5 4097 return 0;
8a2b7538
TH
4098 } else if (wq->flags & __WQ_ORDERED) {
4099 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
4100 /* there should only be single pwq for ordering guarantee */
4101 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
4102 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
4103 "ordering guarantee broken for workqueue %s\n", wq->name);
4104 return ret;
30cdf249 4105 } else {
9e8cd2f5 4106 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
30cdf249 4107 }
0f900049
TH
4108}
4109
f3421797
TH
4110static int wq_clamp_max_active(int max_active, unsigned int flags,
4111 const char *name)
b71ab8c2 4112{
f3421797
TH
4113 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4114
4115 if (max_active < 1 || max_active > lim)
044c782c
VI
4116 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4117 max_active, name, 1, lim);
b71ab8c2 4118
f3421797 4119 return clamp_val(max_active, 1, lim);
b71ab8c2
TH
4120}
4121
b196be89 4122struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
d320c038
TH
4123 unsigned int flags,
4124 int max_active,
4125 struct lock_class_key *key,
b196be89 4126 const char *lock_name, ...)
1da177e4 4127{
df2d5ae4 4128 size_t tbl_size = 0;
ecf6881f 4129 va_list args;
1da177e4 4130 struct workqueue_struct *wq;
49e3cf44 4131 struct pool_workqueue *pwq;
b196be89 4132
cee22a15
VK
4133 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4134 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4135 flags |= WQ_UNBOUND;
4136
ecf6881f 4137 /* allocate wq and format name */
df2d5ae4
TH
4138 if (flags & WQ_UNBOUND)
4139 tbl_size = wq_numa_tbl_len * sizeof(wq->numa_pwq_tbl[0]);
4140
4141 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
b196be89 4142 if (!wq)
d2c1d404 4143 return NULL;
b196be89 4144
6029a918
TH
4145 if (flags & WQ_UNBOUND) {
4146 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4147 if (!wq->unbound_attrs)
4148 goto err_free_wq;
4149 }
4150
ecf6881f
TH
4151 va_start(args, lock_name);
4152 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
b196be89 4153 va_end(args);
1da177e4 4154
d320c038 4155 max_active = max_active ?: WQ_DFL_ACTIVE;
b196be89 4156 max_active = wq_clamp_max_active(max_active, flags, wq->name);
3af24433 4157
b196be89 4158 /* init wq */
97e37d7b 4159 wq->flags = flags;
a0a1a5fd 4160 wq->saved_max_active = max_active;
3c25a55d 4161 mutex_init(&wq->mutex);
112202d9 4162 atomic_set(&wq->nr_pwqs_to_flush, 0);
30cdf249 4163 INIT_LIST_HEAD(&wq->pwqs);
73f53c4a
TH
4164 INIT_LIST_HEAD(&wq->flusher_queue);
4165 INIT_LIST_HEAD(&wq->flusher_overflow);
493a1724 4166 INIT_LIST_HEAD(&wq->maydays);
502ca9d8 4167
eb13ba87 4168 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
cce1a165 4169 INIT_LIST_HEAD(&wq->list);
3af24433 4170
30cdf249 4171 if (alloc_and_link_pwqs(wq) < 0)
d2c1d404 4172 goto err_free_wq;
1537663f 4173
493008a8
TH
4174 /*
4175 * Workqueues which may be used during memory reclaim should
4176 * have a rescuer to guarantee forward progress.
4177 */
4178 if (flags & WQ_MEM_RECLAIM) {
e22bee78
TH
4179 struct worker *rescuer;
4180
d2c1d404 4181 rescuer = alloc_worker();
e22bee78 4182 if (!rescuer)
d2c1d404 4183 goto err_destroy;
e22bee78 4184
111c225a
TH
4185 rescuer->rescue_wq = wq;
4186 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
b196be89 4187 wq->name);
d2c1d404
TH
4188 if (IS_ERR(rescuer->task)) {
4189 kfree(rescuer);
4190 goto err_destroy;
4191 }
e22bee78 4192
d2c1d404 4193 wq->rescuer = rescuer;
14a40ffc 4194 rescuer->task->flags |= PF_NO_SETAFFINITY;
e22bee78 4195 wake_up_process(rescuer->task);
3af24433
ON
4196 }
4197
226223ab
TH
4198 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4199 goto err_destroy;
4200
a0a1a5fd 4201 /*
68e13a67
LJ
4202 * wq_pool_mutex protects global freeze state and workqueues list.
4203 * Grab it, adjust max_active and add the new @wq to workqueues
4204 * list.
a0a1a5fd 4205 */
68e13a67 4206 mutex_lock(&wq_pool_mutex);
a0a1a5fd 4207
a357fc03 4208 mutex_lock(&wq->mutex);
699ce097
TH
4209 for_each_pwq(pwq, wq)
4210 pwq_adjust_max_active(pwq);
a357fc03 4211 mutex_unlock(&wq->mutex);
a0a1a5fd 4212
1537663f 4213 list_add(&wq->list, &workqueues);
a0a1a5fd 4214
68e13a67 4215 mutex_unlock(&wq_pool_mutex);
1537663f 4216
3af24433 4217 return wq;
d2c1d404
TH
4218
4219err_free_wq:
6029a918 4220 free_workqueue_attrs(wq->unbound_attrs);
d2c1d404
TH
4221 kfree(wq);
4222 return NULL;
4223err_destroy:
4224 destroy_workqueue(wq);
4690c4ab 4225 return NULL;
3af24433 4226}
d320c038 4227EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
1da177e4 4228
3af24433
ON
4229/**
4230 * destroy_workqueue - safely terminate a workqueue
4231 * @wq: target workqueue
4232 *
4233 * Safely destroy a workqueue. All work currently pending will be done first.
4234 */
4235void destroy_workqueue(struct workqueue_struct *wq)
4236{
49e3cf44 4237 struct pool_workqueue *pwq;
4c16bd32 4238 int node;
3af24433 4239
9c5a2ba7
TH
4240 /* drain it before proceeding with destruction */
4241 drain_workqueue(wq);
c8efcc25 4242
6183c009 4243 /* sanity checks */
b09f4fd3 4244 mutex_lock(&wq->mutex);
49e3cf44 4245 for_each_pwq(pwq, wq) {
6183c009
TH
4246 int i;
4247
76af4d93
TH
4248 for (i = 0; i < WORK_NR_COLORS; i++) {
4249 if (WARN_ON(pwq->nr_in_flight[i])) {
b09f4fd3 4250 mutex_unlock(&wq->mutex);
6183c009 4251 return;
76af4d93
TH
4252 }
4253 }
4254
5c529597 4255 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
8864b4e5 4256 WARN_ON(pwq->nr_active) ||
76af4d93 4257 WARN_ON(!list_empty(&pwq->delayed_works))) {
b09f4fd3 4258 mutex_unlock(&wq->mutex);
6183c009 4259 return;
76af4d93 4260 }
6183c009 4261 }
b09f4fd3 4262 mutex_unlock(&wq->mutex);
6183c009 4263
a0a1a5fd
TH
4264 /*
4265 * wq list is used to freeze wq, remove from list after
4266 * flushing is complete in case freeze races us.
4267 */
68e13a67 4268 mutex_lock(&wq_pool_mutex);
d2c1d404 4269 list_del_init(&wq->list);
68e13a67 4270 mutex_unlock(&wq_pool_mutex);
3af24433 4271
226223ab
TH
4272 workqueue_sysfs_unregister(wq);
4273
493008a8 4274 if (wq->rescuer) {
e22bee78 4275 kthread_stop(wq->rescuer->task);
8d9df9f0 4276 kfree(wq->rescuer);
493008a8 4277 wq->rescuer = NULL;
e22bee78
TH
4278 }
4279
8864b4e5
TH
4280 if (!(wq->flags & WQ_UNBOUND)) {
4281 /*
4282 * The base ref is never dropped on per-cpu pwqs. Directly
4283 * free the pwqs and wq.
4284 */
4285 free_percpu(wq->cpu_pwqs);
4286 kfree(wq);
4287 } else {
4288 /*
4289 * We're the sole accessor of @wq at this point. Directly
4c16bd32
TH
4290 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4291 * @wq will be freed when the last pwq is released.
8864b4e5 4292 */
4c16bd32
TH
4293 for_each_node(node) {
4294 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4295 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4296 put_pwq_unlocked(pwq);
4297 }
4298
4299 /*
4300 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4301 * put. Don't access it afterwards.
4302 */
4303 pwq = wq->dfl_pwq;
4304 wq->dfl_pwq = NULL;
dce90d47 4305 put_pwq_unlocked(pwq);
29c91e99 4306 }
3af24433
ON
4307}
4308EXPORT_SYMBOL_GPL(destroy_workqueue);
4309
dcd989cb
TH
4310/**
4311 * workqueue_set_max_active - adjust max_active of a workqueue
4312 * @wq: target workqueue
4313 * @max_active: new max_active value.
4314 *
4315 * Set max_active of @wq to @max_active.
4316 *
4317 * CONTEXT:
4318 * Don't call from IRQ context.
4319 */
4320void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4321{
49e3cf44 4322 struct pool_workqueue *pwq;
dcd989cb 4323
8719dcea
TH
4324 /* disallow meddling with max_active for ordered workqueues */
4325 if (WARN_ON(wq->flags & __WQ_ORDERED))
4326 return;
4327
f3421797 4328 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
dcd989cb 4329
a357fc03 4330 mutex_lock(&wq->mutex);
dcd989cb
TH
4331
4332 wq->saved_max_active = max_active;
4333
699ce097
TH
4334 for_each_pwq(pwq, wq)
4335 pwq_adjust_max_active(pwq);
93981800 4336
a357fc03 4337 mutex_unlock(&wq->mutex);
15316ba8 4338}
dcd989cb 4339EXPORT_SYMBOL_GPL(workqueue_set_max_active);
15316ba8 4340
e6267616
TH
4341/**
4342 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4343 *
4344 * Determine whether %current is a workqueue rescuer. Can be used from
4345 * work functions to determine whether it's being run off the rescuer task.
d185af30
YB
4346 *
4347 * Return: %true if %current is a workqueue rescuer. %false otherwise.
e6267616
TH
4348 */
4349bool current_is_workqueue_rescuer(void)
4350{
4351 struct worker *worker = current_wq_worker();
4352
6a092dfd 4353 return worker && worker->rescue_wq;
e6267616
TH
4354}
4355
eef6a7d5 4356/**
dcd989cb
TH
4357 * workqueue_congested - test whether a workqueue is congested
4358 * @cpu: CPU in question
4359 * @wq: target workqueue
eef6a7d5 4360 *
dcd989cb
TH
4361 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4362 * no synchronization around this function and the test result is
4363 * unreliable and only useful as advisory hints or for debugging.
eef6a7d5 4364 *
d3251859
TH
4365 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4366 * Note that both per-cpu and unbound workqueues may be associated with
4367 * multiple pool_workqueues which have separate congested states. A
4368 * workqueue being congested on one CPU doesn't mean the workqueue is also
4369 * contested on other CPUs / NUMA nodes.
4370 *
d185af30 4371 * Return:
dcd989cb 4372 * %true if congested, %false otherwise.
eef6a7d5 4373 */
d84ff051 4374bool workqueue_congested(int cpu, struct workqueue_struct *wq)
1da177e4 4375{
7fb98ea7 4376 struct pool_workqueue *pwq;
76af4d93
TH
4377 bool ret;
4378
88109453 4379 rcu_read_lock_sched();
7fb98ea7 4380
d3251859
TH
4381 if (cpu == WORK_CPU_UNBOUND)
4382 cpu = smp_processor_id();
4383
7fb98ea7
TH
4384 if (!(wq->flags & WQ_UNBOUND))
4385 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4386 else
df2d5ae4 4387 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
dcd989cb 4388
76af4d93 4389 ret = !list_empty(&pwq->delayed_works);
88109453 4390 rcu_read_unlock_sched();
76af4d93
TH
4391
4392 return ret;
1da177e4 4393}
dcd989cb 4394EXPORT_SYMBOL_GPL(workqueue_congested);
1da177e4 4395
dcd989cb
TH
4396/**
4397 * work_busy - test whether a work is currently pending or running
4398 * @work: the work to be tested
4399 *
4400 * Test whether @work is currently pending or running. There is no
4401 * synchronization around this function and the test result is
4402 * unreliable and only useful as advisory hints or for debugging.
dcd989cb 4403 *
d185af30 4404 * Return:
dcd989cb
TH
4405 * OR'd bitmask of WORK_BUSY_* bits.
4406 */
4407unsigned int work_busy(struct work_struct *work)
1da177e4 4408{
fa1b54e6 4409 struct worker_pool *pool;
dcd989cb
TH
4410 unsigned long flags;
4411 unsigned int ret = 0;
1da177e4 4412
dcd989cb
TH
4413 if (work_pending(work))
4414 ret |= WORK_BUSY_PENDING;
1da177e4 4415
fa1b54e6
TH
4416 local_irq_save(flags);
4417 pool = get_work_pool(work);
038366c5 4418 if (pool) {
fa1b54e6 4419 spin_lock(&pool->lock);
038366c5
LJ
4420 if (find_worker_executing_work(pool, work))
4421 ret |= WORK_BUSY_RUNNING;
fa1b54e6 4422 spin_unlock(&pool->lock);
038366c5 4423 }
fa1b54e6 4424 local_irq_restore(flags);
1da177e4 4425
dcd989cb 4426 return ret;
1da177e4 4427}
dcd989cb 4428EXPORT_SYMBOL_GPL(work_busy);
1da177e4 4429
3d1cb205
TH
4430/**
4431 * set_worker_desc - set description for the current work item
4432 * @fmt: printf-style format string
4433 * @...: arguments for the format string
4434 *
4435 * This function can be called by a running work function to describe what
4436 * the work item is about. If the worker task gets dumped, this
4437 * information will be printed out together to help debugging. The
4438 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4439 */
4440void set_worker_desc(const char *fmt, ...)
4441{
4442 struct worker *worker = current_wq_worker();
4443 va_list args;
4444
4445 if (worker) {
4446 va_start(args, fmt);
4447 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4448 va_end(args);
4449 worker->desc_valid = true;
4450 }
4451}
4452
4453/**
4454 * print_worker_info - print out worker information and description
4455 * @log_lvl: the log level to use when printing
4456 * @task: target task
4457 *
4458 * If @task is a worker and currently executing a work item, print out the
4459 * name of the workqueue being serviced and worker description set with
4460 * set_worker_desc() by the currently executing work item.
4461 *
4462 * This function can be safely called on any task as long as the
4463 * task_struct itself is accessible. While safe, this function isn't
4464 * synchronized and may print out mixups or garbages of limited length.
4465 */
4466void print_worker_info(const char *log_lvl, struct task_struct *task)
4467{
4468 work_func_t *fn = NULL;
4469 char name[WQ_NAME_LEN] = { };
4470 char desc[WORKER_DESC_LEN] = { };
4471 struct pool_workqueue *pwq = NULL;
4472 struct workqueue_struct *wq = NULL;
4473 bool desc_valid = false;
4474 struct worker *worker;
4475
4476 if (!(task->flags & PF_WQ_WORKER))
4477 return;
4478
4479 /*
4480 * This function is called without any synchronization and @task
4481 * could be in any state. Be careful with dereferences.
4482 */
4483 worker = probe_kthread_data(task);
4484
4485 /*
4486 * Carefully copy the associated workqueue's workfn and name. Keep
4487 * the original last '\0' in case the original contains garbage.
4488 */
4489 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4490 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4491 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4492 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4493
4494 /* copy worker description */
4495 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4496 if (desc_valid)
4497 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4498
4499 if (fn || name[0] || desc[0]) {
2d916033 4500 pr_info("%sWorkqueue: %s %pf", log_lvl, name, fn);
3d1cb205
TH
4501 if (desc[0])
4502 pr_cont(" (%s)", desc);
4503 pr_cont("\n");
4504 }
4505}
4506
db7bccf4
TH
4507/*
4508 * CPU hotplug.
4509 *
e22bee78 4510 * There are two challenges in supporting CPU hotplug. Firstly, there
112202d9 4511 * are a lot of assumptions on strong associations among work, pwq and
706026c2 4512 * pool which make migrating pending and scheduled works very
e22bee78 4513 * difficult to implement without impacting hot paths. Secondly,
94cf58bb 4514 * worker pools serve mix of short, long and very long running works making
e22bee78
TH
4515 * blocked draining impractical.
4516 *
24647570 4517 * This is solved by allowing the pools to be disassociated from the CPU
628c78e7
TH
4518 * running as an unbound one and allowing it to be reattached later if the
4519 * cpu comes back online.
db7bccf4 4520 */
1da177e4 4521
706026c2 4522static void wq_unbind_fn(struct work_struct *work)
3af24433 4523{
38db41d9 4524 int cpu = smp_processor_id();
4ce62e9e 4525 struct worker_pool *pool;
db7bccf4 4526 struct worker *worker;
3af24433 4527
f02ae73a 4528 for_each_cpu_worker_pool(pool, cpu) {
6183c009 4529 WARN_ON_ONCE(cpu != smp_processor_id());
db7bccf4 4530
92f9c5c4 4531 mutex_lock(&pool->attach_mutex);
94cf58bb 4532 spin_lock_irq(&pool->lock);
3af24433 4533
94cf58bb 4534 /*
92f9c5c4 4535 * We've blocked all attach/detach operations. Make all workers
94cf58bb
TH
4536 * unbound and set DISASSOCIATED. Before this, all workers
4537 * except for the ones which are still executing works from
4538 * before the last CPU down must be on the cpu. After
4539 * this, they may become diasporas.
4540 */
da028469 4541 for_each_pool_worker(worker, pool)
c9e7cf27 4542 worker->flags |= WORKER_UNBOUND;
06ba38a9 4543
24647570 4544 pool->flags |= POOL_DISASSOCIATED;
f2d5a0ee 4545
94cf58bb 4546 spin_unlock_irq(&pool->lock);
92f9c5c4 4547 mutex_unlock(&pool->attach_mutex);
628c78e7 4548
eb283428
LJ
4549 /*
4550 * Call schedule() so that we cross rq->lock and thus can
4551 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4552 * This is necessary as scheduler callbacks may be invoked
4553 * from other cpus.
4554 */
4555 schedule();
06ba38a9 4556
eb283428
LJ
4557 /*
4558 * Sched callbacks are disabled now. Zap nr_running.
4559 * After this, nr_running stays zero and need_more_worker()
4560 * and keep_working() are always true as long as the
4561 * worklist is not empty. This pool now behaves as an
4562 * unbound (in terms of concurrency management) pool which
4563 * are served by workers tied to the pool.
4564 */
e19e397a 4565 atomic_set(&pool->nr_running, 0);
eb283428
LJ
4566
4567 /*
4568 * With concurrency management just turned off, a busy
4569 * worker blocking could lead to lengthy stalls. Kick off
4570 * unbound chain execution of currently pending work items.
4571 */
4572 spin_lock_irq(&pool->lock);
4573 wake_up_worker(pool);
4574 spin_unlock_irq(&pool->lock);
4575 }
3af24433 4576}
3af24433 4577
bd7c089e
TH
4578/**
4579 * rebind_workers - rebind all workers of a pool to the associated CPU
4580 * @pool: pool of interest
4581 *
a9ab775b 4582 * @pool->cpu is coming online. Rebind all workers to the CPU.
bd7c089e
TH
4583 */
4584static void rebind_workers(struct worker_pool *pool)
4585{
a9ab775b 4586 struct worker *worker;
bd7c089e 4587
92f9c5c4 4588 lockdep_assert_held(&pool->attach_mutex);
bd7c089e 4589
a9ab775b
TH
4590 /*
4591 * Restore CPU affinity of all workers. As all idle workers should
4592 * be on the run-queue of the associated CPU before any local
4593 * wake-ups for concurrency management happen, restore CPU affinty
4594 * of all workers first and then clear UNBOUND. As we're called
4595 * from CPU_ONLINE, the following shouldn't fail.
4596 */
da028469 4597 for_each_pool_worker(worker, pool)
a9ab775b
TH
4598 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4599 pool->attrs->cpumask) < 0);
bd7c089e 4600
a9ab775b 4601 spin_lock_irq(&pool->lock);
bd7c089e 4602
da028469 4603 for_each_pool_worker(worker, pool) {
a9ab775b 4604 unsigned int worker_flags = worker->flags;
bd7c089e
TH
4605
4606 /*
a9ab775b
TH
4607 * A bound idle worker should actually be on the runqueue
4608 * of the associated CPU for local wake-ups targeting it to
4609 * work. Kick all idle workers so that they migrate to the
4610 * associated CPU. Doing this in the same loop as
4611 * replacing UNBOUND with REBOUND is safe as no worker will
4612 * be bound before @pool->lock is released.
bd7c089e 4613 */
a9ab775b
TH
4614 if (worker_flags & WORKER_IDLE)
4615 wake_up_process(worker->task);
bd7c089e 4616
a9ab775b
TH
4617 /*
4618 * We want to clear UNBOUND but can't directly call
4619 * worker_clr_flags() or adjust nr_running. Atomically
4620 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4621 * @worker will clear REBOUND using worker_clr_flags() when
4622 * it initiates the next execution cycle thus restoring
4623 * concurrency management. Note that when or whether
4624 * @worker clears REBOUND doesn't affect correctness.
4625 *
4626 * ACCESS_ONCE() is necessary because @worker->flags may be
4627 * tested without holding any lock in
4628 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4629 * fail incorrectly leading to premature concurrency
4630 * management operations.
4631 */
4632 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4633 worker_flags |= WORKER_REBOUND;
4634 worker_flags &= ~WORKER_UNBOUND;
4635 ACCESS_ONCE(worker->flags) = worker_flags;
bd7c089e 4636 }
a9ab775b
TH
4637
4638 spin_unlock_irq(&pool->lock);
bd7c089e
TH
4639}
4640
7dbc725e
TH
4641/**
4642 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4643 * @pool: unbound pool of interest
4644 * @cpu: the CPU which is coming up
4645 *
4646 * An unbound pool may end up with a cpumask which doesn't have any online
4647 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4648 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4649 * online CPU before, cpus_allowed of all its workers should be restored.
4650 */
4651static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4652{
4653 static cpumask_t cpumask;
4654 struct worker *worker;
7dbc725e 4655
92f9c5c4 4656 lockdep_assert_held(&pool->attach_mutex);
7dbc725e
TH
4657
4658 /* is @cpu allowed for @pool? */
4659 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4660 return;
4661
4662 /* is @cpu the only online CPU? */
4663 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4664 if (cpumask_weight(&cpumask) != 1)
4665 return;
4666
4667 /* as we're called from CPU_ONLINE, the following shouldn't fail */
da028469 4668 for_each_pool_worker(worker, pool)
7dbc725e
TH
4669 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4670 pool->attrs->cpumask) < 0);
4671}
4672
8db25e78
TH
4673/*
4674 * Workqueues should be brought up before normal priority CPU notifiers.
4675 * This will be registered high priority CPU notifier.
4676 */
0db0628d 4677static int workqueue_cpu_up_callback(struct notifier_block *nfb,
8db25e78
TH
4678 unsigned long action,
4679 void *hcpu)
3af24433 4680{
d84ff051 4681 int cpu = (unsigned long)hcpu;
4ce62e9e 4682 struct worker_pool *pool;
4c16bd32 4683 struct workqueue_struct *wq;
7dbc725e 4684 int pi;
3ce63377 4685
8db25e78 4686 switch (action & ~CPU_TASKS_FROZEN) {
3af24433 4687 case CPU_UP_PREPARE:
f02ae73a 4688 for_each_cpu_worker_pool(pool, cpu) {
3ce63377
TH
4689 if (pool->nr_workers)
4690 continue;
ebf44d16 4691 if (create_and_start_worker(pool) < 0)
3ce63377 4692 return NOTIFY_BAD;
3af24433 4693 }
8db25e78 4694 break;
3af24433 4695
db7bccf4
TH
4696 case CPU_DOWN_FAILED:
4697 case CPU_ONLINE:
68e13a67 4698 mutex_lock(&wq_pool_mutex);
7dbc725e
TH
4699
4700 for_each_pool(pool, pi) {
92f9c5c4 4701 mutex_lock(&pool->attach_mutex);
94cf58bb 4702
7dbc725e
TH
4703 if (pool->cpu == cpu) {
4704 spin_lock_irq(&pool->lock);
4705 pool->flags &= ~POOL_DISASSOCIATED;
4706 spin_unlock_irq(&pool->lock);
a9ab775b 4707
7dbc725e
TH
4708 rebind_workers(pool);
4709 } else if (pool->cpu < 0) {
4710 restore_unbound_workers_cpumask(pool, cpu);
4711 }
94cf58bb 4712
92f9c5c4 4713 mutex_unlock(&pool->attach_mutex);
94cf58bb 4714 }
7dbc725e 4715
4c16bd32
TH
4716 /* update NUMA affinity of unbound workqueues */
4717 list_for_each_entry(wq, &workqueues, list)
4718 wq_update_unbound_numa(wq, cpu, true);
4719
68e13a67 4720 mutex_unlock(&wq_pool_mutex);
db7bccf4 4721 break;
00dfcaf7 4722 }
65758202
TH
4723 return NOTIFY_OK;
4724}
4725
4726/*
4727 * Workqueues should be brought down after normal priority CPU notifiers.
4728 * This will be registered as low priority CPU notifier.
4729 */
0db0628d 4730static int workqueue_cpu_down_callback(struct notifier_block *nfb,
65758202
TH
4731 unsigned long action,
4732 void *hcpu)
4733{
d84ff051 4734 int cpu = (unsigned long)hcpu;
8db25e78 4735 struct work_struct unbind_work;
4c16bd32 4736 struct workqueue_struct *wq;
8db25e78 4737
65758202
TH
4738 switch (action & ~CPU_TASKS_FROZEN) {
4739 case CPU_DOWN_PREPARE:
4c16bd32 4740 /* unbinding per-cpu workers should happen on the local CPU */
706026c2 4741 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
7635d2fd 4742 queue_work_on(cpu, system_highpri_wq, &unbind_work);
4c16bd32
TH
4743
4744 /* update NUMA affinity of unbound workqueues */
4745 mutex_lock(&wq_pool_mutex);
4746 list_for_each_entry(wq, &workqueues, list)
4747 wq_update_unbound_numa(wq, cpu, false);
4748 mutex_unlock(&wq_pool_mutex);
4749
4750 /* wait for per-cpu unbinding to finish */
8db25e78 4751 flush_work(&unbind_work);
440a1136 4752 destroy_work_on_stack(&unbind_work);
8db25e78 4753 break;
65758202
TH
4754 }
4755 return NOTIFY_OK;
4756}
4757
2d3854a3 4758#ifdef CONFIG_SMP
8ccad40d 4759
2d3854a3 4760struct work_for_cpu {
ed48ece2 4761 struct work_struct work;
2d3854a3
RR
4762 long (*fn)(void *);
4763 void *arg;
4764 long ret;
4765};
4766
ed48ece2 4767static void work_for_cpu_fn(struct work_struct *work)
2d3854a3 4768{
ed48ece2
TH
4769 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4770
2d3854a3
RR
4771 wfc->ret = wfc->fn(wfc->arg);
4772}
4773
4774/**
4775 * work_on_cpu - run a function in user context on a particular cpu
4776 * @cpu: the cpu to run on
4777 * @fn: the function to run
4778 * @arg: the function arg
4779 *
31ad9081 4780 * It is up to the caller to ensure that the cpu doesn't go offline.
6b44003e 4781 * The caller must not hold any locks which would prevent @fn from completing.
d185af30
YB
4782 *
4783 * Return: The value @fn returns.
2d3854a3 4784 */
d84ff051 4785long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
2d3854a3 4786{
ed48ece2 4787 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
6b44003e 4788
ed48ece2
TH
4789 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4790 schedule_work_on(cpu, &wfc.work);
12997d1a 4791 flush_work(&wfc.work);
440a1136 4792 destroy_work_on_stack(&wfc.work);
2d3854a3
RR
4793 return wfc.ret;
4794}
4795EXPORT_SYMBOL_GPL(work_on_cpu);
4796#endif /* CONFIG_SMP */
4797
a0a1a5fd
TH
4798#ifdef CONFIG_FREEZER
4799
4800/**
4801 * freeze_workqueues_begin - begin freezing workqueues
4802 *
58a69cb4 4803 * Start freezing workqueues. After this function returns, all freezable
c5aa87bb 4804 * workqueues will queue new works to their delayed_works list instead of
706026c2 4805 * pool->worklist.
a0a1a5fd
TH
4806 *
4807 * CONTEXT:
a357fc03 4808 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
a0a1a5fd
TH
4809 */
4810void freeze_workqueues_begin(void)
4811{
17116969 4812 struct worker_pool *pool;
24b8a847
TH
4813 struct workqueue_struct *wq;
4814 struct pool_workqueue *pwq;
611c92a0 4815 int pi;
a0a1a5fd 4816
68e13a67 4817 mutex_lock(&wq_pool_mutex);
a0a1a5fd 4818
6183c009 4819 WARN_ON_ONCE(workqueue_freezing);
a0a1a5fd
TH
4820 workqueue_freezing = true;
4821
24b8a847 4822 /* set FREEZING */
611c92a0 4823 for_each_pool(pool, pi) {
5bcab335 4824 spin_lock_irq(&pool->lock);
17116969
TH
4825 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
4826 pool->flags |= POOL_FREEZING;
5bcab335 4827 spin_unlock_irq(&pool->lock);
24b8a847 4828 }
a0a1a5fd 4829
24b8a847 4830 list_for_each_entry(wq, &workqueues, list) {
a357fc03 4831 mutex_lock(&wq->mutex);
699ce097
TH
4832 for_each_pwq(pwq, wq)
4833 pwq_adjust_max_active(pwq);
a357fc03 4834 mutex_unlock(&wq->mutex);
a0a1a5fd 4835 }
5bcab335 4836
68e13a67 4837 mutex_unlock(&wq_pool_mutex);
a0a1a5fd
TH
4838}
4839
4840/**
58a69cb4 4841 * freeze_workqueues_busy - are freezable workqueues still busy?
a0a1a5fd
TH
4842 *
4843 * Check whether freezing is complete. This function must be called
4844 * between freeze_workqueues_begin() and thaw_workqueues().
4845 *
4846 * CONTEXT:
68e13a67 4847 * Grabs and releases wq_pool_mutex.
a0a1a5fd 4848 *
d185af30 4849 * Return:
58a69cb4
TH
4850 * %true if some freezable workqueues are still busy. %false if freezing
4851 * is complete.
a0a1a5fd
TH
4852 */
4853bool freeze_workqueues_busy(void)
4854{
a0a1a5fd 4855 bool busy = false;
24b8a847
TH
4856 struct workqueue_struct *wq;
4857 struct pool_workqueue *pwq;
a0a1a5fd 4858
68e13a67 4859 mutex_lock(&wq_pool_mutex);
a0a1a5fd 4860
6183c009 4861 WARN_ON_ONCE(!workqueue_freezing);
a0a1a5fd 4862
24b8a847
TH
4863 list_for_each_entry(wq, &workqueues, list) {
4864 if (!(wq->flags & WQ_FREEZABLE))
4865 continue;
a0a1a5fd
TH
4866 /*
4867 * nr_active is monotonically decreasing. It's safe
4868 * to peek without lock.
4869 */
88109453 4870 rcu_read_lock_sched();
24b8a847 4871 for_each_pwq(pwq, wq) {
6183c009 4872 WARN_ON_ONCE(pwq->nr_active < 0);
112202d9 4873 if (pwq->nr_active) {
a0a1a5fd 4874 busy = true;
88109453 4875 rcu_read_unlock_sched();
a0a1a5fd
TH
4876 goto out_unlock;
4877 }
4878 }
88109453 4879 rcu_read_unlock_sched();
a0a1a5fd
TH
4880 }
4881out_unlock:
68e13a67 4882 mutex_unlock(&wq_pool_mutex);
a0a1a5fd
TH
4883 return busy;
4884}
4885
4886/**
4887 * thaw_workqueues - thaw workqueues
4888 *
4889 * Thaw workqueues. Normal queueing is restored and all collected
706026c2 4890 * frozen works are transferred to their respective pool worklists.
a0a1a5fd
TH
4891 *
4892 * CONTEXT:
a357fc03 4893 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
a0a1a5fd
TH
4894 */
4895void thaw_workqueues(void)
4896{
24b8a847
TH
4897 struct workqueue_struct *wq;
4898 struct pool_workqueue *pwq;
4899 struct worker_pool *pool;
611c92a0 4900 int pi;
a0a1a5fd 4901
68e13a67 4902 mutex_lock(&wq_pool_mutex);
a0a1a5fd
TH
4903
4904 if (!workqueue_freezing)
4905 goto out_unlock;
4906
24b8a847 4907 /* clear FREEZING */
611c92a0 4908 for_each_pool(pool, pi) {
5bcab335 4909 spin_lock_irq(&pool->lock);
24b8a847
TH
4910 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
4911 pool->flags &= ~POOL_FREEZING;
5bcab335 4912 spin_unlock_irq(&pool->lock);
24b8a847 4913 }
8b03ae3c 4914
24b8a847
TH
4915 /* restore max_active and repopulate worklist */
4916 list_for_each_entry(wq, &workqueues, list) {
a357fc03 4917 mutex_lock(&wq->mutex);
699ce097
TH
4918 for_each_pwq(pwq, wq)
4919 pwq_adjust_max_active(pwq);
a357fc03 4920 mutex_unlock(&wq->mutex);
a0a1a5fd
TH
4921 }
4922
4923 workqueue_freezing = false;
4924out_unlock:
68e13a67 4925 mutex_unlock(&wq_pool_mutex);
a0a1a5fd
TH
4926}
4927#endif /* CONFIG_FREEZER */
4928
bce90380
TH
4929static void __init wq_numa_init(void)
4930{
4931 cpumask_var_t *tbl;
4932 int node, cpu;
4933
4934 /* determine NUMA pwq table len - highest node id + 1 */
4935 for_each_node(node)
4936 wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1);
4937
4938 if (num_possible_nodes() <= 1)
4939 return;
4940
d55262c4
TH
4941 if (wq_disable_numa) {
4942 pr_info("workqueue: NUMA affinity support disabled\n");
4943 return;
4944 }
4945
4c16bd32
TH
4946 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
4947 BUG_ON(!wq_update_unbound_numa_attrs_buf);
4948
bce90380
TH
4949 /*
4950 * We want masks of possible CPUs of each node which isn't readily
4951 * available. Build one from cpu_to_node() which should have been
4952 * fully initialized by now.
4953 */
4954 tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL);
4955 BUG_ON(!tbl);
4956
4957 for_each_node(node)
1be0c25d
TH
4958 BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
4959 node_online(node) ? node : NUMA_NO_NODE));
bce90380
TH
4960
4961 for_each_possible_cpu(cpu) {
4962 node = cpu_to_node(cpu);
4963 if (WARN_ON(node == NUMA_NO_NODE)) {
4964 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
4965 /* happens iff arch is bonkers, let's just proceed */
4966 return;
4967 }
4968 cpumask_set_cpu(cpu, tbl[node]);
4969 }
4970
4971 wq_numa_possible_cpumask = tbl;
4972 wq_numa_enabled = true;
4973}
4974
6ee0578b 4975static int __init init_workqueues(void)
1da177e4 4976{
7a4e344c
TH
4977 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
4978 int i, cpu;
c34056a3 4979
e904e6c2
TH
4980 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4981
4982 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4983
65758202 4984 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
a5b4e57d 4985 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
8b03ae3c 4986
bce90380
TH
4987 wq_numa_init();
4988
706026c2 4989 /* initialize CPU pools */
29c91e99 4990 for_each_possible_cpu(cpu) {
4ce62e9e 4991 struct worker_pool *pool;
8b03ae3c 4992
7a4e344c 4993 i = 0;
f02ae73a 4994 for_each_cpu_worker_pool(pool, cpu) {
7a4e344c 4995 BUG_ON(init_worker_pool(pool));
ec22ca5e 4996 pool->cpu = cpu;
29c91e99 4997 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
7a4e344c 4998 pool->attrs->nice = std_nice[i++];
f3f90ad4 4999 pool->node = cpu_to_node(cpu);
7a4e344c 5000
9daf9e67 5001 /* alloc pool ID */
68e13a67 5002 mutex_lock(&wq_pool_mutex);
9daf9e67 5003 BUG_ON(worker_pool_assign_id(pool));
68e13a67 5004 mutex_unlock(&wq_pool_mutex);
4ce62e9e 5005 }
8b03ae3c
TH
5006 }
5007
e22bee78 5008 /* create the initial worker */
29c91e99 5009 for_each_online_cpu(cpu) {
4ce62e9e 5010 struct worker_pool *pool;
e22bee78 5011
f02ae73a 5012 for_each_cpu_worker_pool(pool, cpu) {
29c91e99 5013 pool->flags &= ~POOL_DISASSOCIATED;
ebf44d16 5014 BUG_ON(create_and_start_worker(pool) < 0);
4ce62e9e 5015 }
e22bee78
TH
5016 }
5017
8a2b7538 5018 /* create default unbound and ordered wq attrs */
29c91e99
TH
5019 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
5020 struct workqueue_attrs *attrs;
5021
5022 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
29c91e99 5023 attrs->nice = std_nice[i];
29c91e99 5024 unbound_std_wq_attrs[i] = attrs;
8a2b7538
TH
5025
5026 /*
5027 * An ordered wq should have only one pwq as ordering is
5028 * guaranteed by max_active which is enforced by pwqs.
5029 * Turn off NUMA so that dfl_pwq is used for all nodes.
5030 */
5031 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
5032 attrs->nice = std_nice[i];
5033 attrs->no_numa = true;
5034 ordered_wq_attrs[i] = attrs;
29c91e99
TH
5035 }
5036
d320c038 5037 system_wq = alloc_workqueue("events", 0, 0);
1aabe902 5038 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
d320c038 5039 system_long_wq = alloc_workqueue("events_long", 0, 0);
f3421797
TH
5040 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5041 WQ_UNBOUND_MAX_ACTIVE);
24d51add
TH
5042 system_freezable_wq = alloc_workqueue("events_freezable",
5043 WQ_FREEZABLE, 0);
0668106c
VK
5044 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
5045 WQ_POWER_EFFICIENT, 0);
5046 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
5047 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
5048 0);
1aabe902 5049 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
0668106c
VK
5050 !system_unbound_wq || !system_freezable_wq ||
5051 !system_power_efficient_wq ||
5052 !system_freezable_power_efficient_wq);
6ee0578b 5053 return 0;
1da177e4 5054}
6ee0578b 5055early_initcall(init_workqueues);