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