workqueue: drop WQ_RESCUER and test workqueue->rescuer for NULL instead
[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
19 * automatically managed. There is one worker pool for each CPU and
20 * one extra for works which are better served by workers which are
21 * not bound to any specific CPU.
22 *
23 * Please read Documentation/workqueue.txt for details.
1da177e4
LT
24 */
25
9984de1a 26#include <linux/export.h>
1da177e4
LT
27#include <linux/kernel.h>
28#include <linux/sched.h>
29#include <linux/init.h>
30#include <linux/signal.h>
31#include <linux/completion.h>
32#include <linux/workqueue.h>
33#include <linux/slab.h>
34#include <linux/cpu.h>
35#include <linux/notifier.h>
36#include <linux/kthread.h>
1fa44eca 37#include <linux/hardirq.h>
46934023 38#include <linux/mempolicy.h>
341a5958 39#include <linux/freezer.h>
d5abe669
PZ
40#include <linux/kallsyms.h>
41#include <linux/debug_locks.h>
4e6045f1 42#include <linux/lockdep.h>
c34056a3 43#include <linux/idr.h>
29c91e99 44#include <linux/jhash.h>
42f8570f 45#include <linux/hashtable.h>
76af4d93 46#include <linux/rculist.h>
e22bee78 47
ea138446 48#include "workqueue_internal.h"
1da177e4 49
c8e55f36 50enum {
24647570
TH
51 /*
52 * worker_pool flags
bc2ae0f5 53 *
24647570 54 * A bound pool is either associated or disassociated with its CPU.
bc2ae0f5
TH
55 * While associated (!DISASSOCIATED), all workers are bound to the
56 * CPU and none has %WORKER_UNBOUND set and concurrency management
57 * is in effect.
58 *
59 * While DISASSOCIATED, the cpu may be offline and all workers have
60 * %WORKER_UNBOUND set and concurrency management disabled, and may
24647570 61 * be executing on any CPU. The pool behaves as an unbound one.
bc2ae0f5
TH
62 *
63 * Note that DISASSOCIATED can be flipped only while holding
24647570
TH
64 * assoc_mutex to avoid changing binding state while
65 * create_worker() is in progress.
bc2ae0f5 66 */
11ebea50 67 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
24647570 68 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
35b6bb63 69 POOL_FREEZING = 1 << 3, /* freeze in progress */
db7bccf4 70
c8e55f36
TH
71 /* worker flags */
72 WORKER_STARTED = 1 << 0, /* started */
73 WORKER_DIE = 1 << 1, /* die die die */
74 WORKER_IDLE = 1 << 2, /* is idle */
e22bee78 75 WORKER_PREP = 1 << 3, /* preparing to run works */
fb0e7beb 76 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
f3421797 77 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
e22bee78 78
5f7dabfd 79 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
403c821d 80 WORKER_CPU_INTENSIVE,
db7bccf4 81
e34cdddb 82 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
4ce62e9e 83
29c91e99 84 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
c8e55f36 85 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
db7bccf4 86
e22bee78
TH
87 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
88 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
89
3233cdbd
TH
90 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
91 /* call for help after 10ms
92 (min two ticks) */
e22bee78
TH
93 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
94 CREATE_COOLDOWN = HZ, /* time to breath after fail */
e22bee78
TH
95
96 /*
97 * Rescue workers are used only on emergencies and shared by
98 * all cpus. Give -20.
99 */
100 RESCUER_NICE_LEVEL = -20,
3270476a 101 HIGHPRI_NICE_LEVEL = -20,
c8e55f36 102};
1da177e4
LT
103
104/*
4690c4ab
TH
105 * Structure fields follow one of the following exclusion rules.
106 *
e41e704b
TH
107 * I: Modifiable by initialization/destruction paths and read-only for
108 * everyone else.
4690c4ab 109 *
e22bee78
TH
110 * P: Preemption protected. Disabling preemption is enough and should
111 * only be modified and accessed from the local cpu.
112 *
d565ed63 113 * L: pool->lock protected. Access with pool->lock held.
4690c4ab 114 *
d565ed63
TH
115 * X: During normal operation, modification requires pool->lock and should
116 * be done only from local cpu. Either disabling preemption on local
117 * cpu or grabbing pool->lock is enough for read access. If
118 * POOL_DISASSOCIATED is set, it's identical to L.
e22bee78 119 *
73f53c4a
TH
120 * F: wq->flush_mutex protected.
121 *
4690c4ab 122 * W: workqueue_lock protected.
76af4d93
TH
123 *
124 * R: workqueue_lock protected for writes. Sched-RCU protected for reads.
1da177e4 125 */
1da177e4 126
2eaebdb3 127/* struct worker is defined in workqueue_internal.h */
c34056a3 128
bd7bdd43 129struct worker_pool {
d565ed63 130 spinlock_t lock; /* the pool lock */
d84ff051 131 int cpu; /* I: the associated cpu */
9daf9e67 132 int id; /* I: pool ID */
11ebea50 133 unsigned int flags; /* X: flags */
bd7bdd43
TH
134
135 struct list_head worklist; /* L: list of pending works */
136 int nr_workers; /* L: total number of workers */
ea1abd61
LJ
137
138 /* nr_idle includes the ones off idle_list for rebinding */
bd7bdd43
TH
139 int nr_idle; /* L: currently idle ones */
140
141 struct list_head idle_list; /* X: list of idle workers */
142 struct timer_list idle_timer; /* L: worker idle timeout */
143 struct timer_list mayday_timer; /* L: SOS timer for workers */
144
c9e7cf27
TH
145 /* workers are chained either in busy_hash or idle_list */
146 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
147 /* L: hash of busy workers */
148
34a06bd6 149 struct mutex manager_arb; /* manager arbitration */
24647570 150 struct mutex assoc_mutex; /* protect POOL_DISASSOCIATED */
bd7bdd43 151 struct ida worker_ida; /* L: for worker IDs */
e19e397a 152
7a4e344c 153 struct workqueue_attrs *attrs; /* I: worker attributes */
29c91e99
TH
154 struct hlist_node hash_node; /* R: unbound_pool_hash node */
155 int refcnt; /* refcnt for unbound pools */
7a4e344c 156
e19e397a
TH
157 /*
158 * The current concurrency level. As it's likely to be accessed
159 * from other CPUs during try_to_wake_up(), put it in a separate
160 * cacheline.
161 */
162 atomic_t nr_running ____cacheline_aligned_in_smp;
29c91e99
TH
163
164 /*
165 * Destruction of pool is sched-RCU protected to allow dereferences
166 * from get_work_pool().
167 */
168 struct rcu_head rcu;
8b03ae3c
TH
169} ____cacheline_aligned_in_smp;
170
1da177e4 171/*
112202d9
TH
172 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
173 * of work_struct->data are used for flags and the remaining high bits
174 * point to the pwq; thus, pwqs need to be aligned at two's power of the
175 * number of flag bits.
1da177e4 176 */
112202d9 177struct pool_workqueue {
bd7bdd43 178 struct worker_pool *pool; /* I: the associated pool */
4690c4ab 179 struct workqueue_struct *wq; /* I: the owning workqueue */
73f53c4a
TH
180 int work_color; /* L: current color */
181 int flush_color; /* L: flushing color */
182 int nr_in_flight[WORK_NR_COLORS];
183 /* L: nr of in_flight works */
1e19ffc6 184 int nr_active; /* L: nr of active works */
a0a1a5fd 185 int max_active; /* L: max active works */
1e19ffc6 186 struct list_head delayed_works; /* L: delayed works */
76af4d93 187 struct list_head pwqs_node; /* R: node on wq->pwqs */
493a1724 188 struct list_head mayday_node; /* W: node on wq->maydays */
e904e6c2 189} __aligned(1 << WORK_STRUCT_FLAG_BITS);
1da177e4 190
73f53c4a
TH
191/*
192 * Structure used to wait for workqueue flush.
193 */
194struct wq_flusher {
195 struct list_head list; /* F: list of flushers */
196 int flush_color; /* F: flush color waiting for */
197 struct completion done; /* flush completion */
198};
199
1da177e4
LT
200/*
201 * The externally visible workqueue abstraction is an array of
202 * per-CPU workqueues:
203 */
204struct workqueue_struct {
9c5a2ba7 205 unsigned int flags; /* W: WQ_* flags */
420c0ddb 206 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwq's */
76af4d93 207 struct list_head pwqs; /* R: all pwqs of this wq */
4690c4ab 208 struct list_head list; /* W: list of all workqueues */
73f53c4a
TH
209
210 struct mutex flush_mutex; /* protects wq flushing */
211 int work_color; /* F: current work color */
212 int flush_color; /* F: current flush color */
112202d9 213 atomic_t nr_pwqs_to_flush; /* flush in progress */
73f53c4a
TH
214 struct wq_flusher *first_flusher; /* F: first flusher */
215 struct list_head flusher_queue; /* F: flush waiters */
216 struct list_head flusher_overflow; /* F: flush overflow list */
217
493a1724 218 struct list_head maydays; /* W: pwqs requesting rescue */
e22bee78
TH
219 struct worker *rescuer; /* I: rescue worker */
220
9c5a2ba7 221 int nr_drainers; /* W: drain in progress */
112202d9 222 int saved_max_active; /* W: saved pwq max_active */
4e6045f1 223#ifdef CONFIG_LOCKDEP
4690c4ab 224 struct lockdep_map lockdep_map;
4e6045f1 225#endif
b196be89 226 char name[]; /* I: workqueue name */
1da177e4
LT
227};
228
e904e6c2
TH
229static struct kmem_cache *pwq_cache;
230
29c91e99
TH
231/* hash of all unbound pools keyed by pool->attrs */
232static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
233
234static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
235
d320c038 236struct workqueue_struct *system_wq __read_mostly;
d320c038 237EXPORT_SYMBOL_GPL(system_wq);
044c782c 238struct workqueue_struct *system_highpri_wq __read_mostly;
1aabe902 239EXPORT_SYMBOL_GPL(system_highpri_wq);
044c782c 240struct workqueue_struct *system_long_wq __read_mostly;
d320c038 241EXPORT_SYMBOL_GPL(system_long_wq);
044c782c 242struct workqueue_struct *system_unbound_wq __read_mostly;
f3421797 243EXPORT_SYMBOL_GPL(system_unbound_wq);
044c782c 244struct workqueue_struct *system_freezable_wq __read_mostly;
24d51add 245EXPORT_SYMBOL_GPL(system_freezable_wq);
d320c038 246
97bd2347
TH
247#define CREATE_TRACE_POINTS
248#include <trace/events/workqueue.h>
249
76af4d93
TH
250#define assert_rcu_or_wq_lock() \
251 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
252 lockdep_is_held(&workqueue_lock), \
253 "sched RCU or workqueue lock should be held")
254
f02ae73a
TH
255#define for_each_cpu_worker_pool(pool, cpu) \
256 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
257 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
7a62c2c8 258 (pool)++)
4ce62e9e 259
b67bfe0d
SL
260#define for_each_busy_worker(worker, i, pool) \
261 hash_for_each(pool->busy_hash, i, worker, hentry)
db7bccf4 262
17116969
TH
263/**
264 * for_each_pool - iterate through all worker_pools in the system
265 * @pool: iteration cursor
266 * @id: integer used for iteration
fa1b54e6
TH
267 *
268 * This must be called either with workqueue_lock held or sched RCU read
269 * locked. If the pool needs to be used beyond the locking in effect, the
270 * caller is responsible for guaranteeing that the pool stays online.
271 *
272 * The if/else clause exists only for the lockdep assertion and can be
273 * ignored.
17116969
TH
274 */
275#define for_each_pool(pool, id) \
fa1b54e6
TH
276 idr_for_each_entry(&worker_pool_idr, pool, id) \
277 if (({ assert_rcu_or_wq_lock(); false; })) { } \
278 else
17116969 279
49e3cf44
TH
280/**
281 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
282 * @pwq: iteration cursor
283 * @wq: the target workqueue
76af4d93
TH
284 *
285 * This must be called either with workqueue_lock held or sched RCU read
286 * locked. If the pwq needs to be used beyond the locking in effect, the
287 * caller is responsible for guaranteeing that the pwq stays online.
288 *
289 * The if/else clause exists only for the lockdep assertion and can be
290 * ignored.
49e3cf44
TH
291 */
292#define for_each_pwq(pwq, wq) \
76af4d93
TH
293 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
294 if (({ assert_rcu_or_wq_lock(); false; })) { } \
295 else
f3421797 296
dc186ad7
TG
297#ifdef CONFIG_DEBUG_OBJECTS_WORK
298
299static struct debug_obj_descr work_debug_descr;
300
99777288
SG
301static void *work_debug_hint(void *addr)
302{
303 return ((struct work_struct *) addr)->func;
304}
305
dc186ad7
TG
306/*
307 * fixup_init is called when:
308 * - an active object is initialized
309 */
310static int work_fixup_init(void *addr, enum debug_obj_state state)
311{
312 struct work_struct *work = addr;
313
314 switch (state) {
315 case ODEBUG_STATE_ACTIVE:
316 cancel_work_sync(work);
317 debug_object_init(work, &work_debug_descr);
318 return 1;
319 default:
320 return 0;
321 }
322}
323
324/*
325 * fixup_activate is called when:
326 * - an active object is activated
327 * - an unknown object is activated (might be a statically initialized object)
328 */
329static int work_fixup_activate(void *addr, enum debug_obj_state state)
330{
331 struct work_struct *work = addr;
332
333 switch (state) {
334
335 case ODEBUG_STATE_NOTAVAILABLE:
336 /*
337 * This is not really a fixup. The work struct was
338 * statically initialized. We just make sure that it
339 * is tracked in the object tracker.
340 */
22df02bb 341 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
dc186ad7
TG
342 debug_object_init(work, &work_debug_descr);
343 debug_object_activate(work, &work_debug_descr);
344 return 0;
345 }
346 WARN_ON_ONCE(1);
347 return 0;
348
349 case ODEBUG_STATE_ACTIVE:
350 WARN_ON(1);
351
352 default:
353 return 0;
354 }
355}
356
357/*
358 * fixup_free is called when:
359 * - an active object is freed
360 */
361static int work_fixup_free(void *addr, enum debug_obj_state state)
362{
363 struct work_struct *work = addr;
364
365 switch (state) {
366 case ODEBUG_STATE_ACTIVE:
367 cancel_work_sync(work);
368 debug_object_free(work, &work_debug_descr);
369 return 1;
370 default:
371 return 0;
372 }
373}
374
375static struct debug_obj_descr work_debug_descr = {
376 .name = "work_struct",
99777288 377 .debug_hint = work_debug_hint,
dc186ad7
TG
378 .fixup_init = work_fixup_init,
379 .fixup_activate = work_fixup_activate,
380 .fixup_free = work_fixup_free,
381};
382
383static inline void debug_work_activate(struct work_struct *work)
384{
385 debug_object_activate(work, &work_debug_descr);
386}
387
388static inline void debug_work_deactivate(struct work_struct *work)
389{
390 debug_object_deactivate(work, &work_debug_descr);
391}
392
393void __init_work(struct work_struct *work, int onstack)
394{
395 if (onstack)
396 debug_object_init_on_stack(work, &work_debug_descr);
397 else
398 debug_object_init(work, &work_debug_descr);
399}
400EXPORT_SYMBOL_GPL(__init_work);
401
402void destroy_work_on_stack(struct work_struct *work)
403{
404 debug_object_free(work, &work_debug_descr);
405}
406EXPORT_SYMBOL_GPL(destroy_work_on_stack);
407
408#else
409static inline void debug_work_activate(struct work_struct *work) { }
410static inline void debug_work_deactivate(struct work_struct *work) { }
411#endif
412
95402b38
GS
413/* Serializes the accesses to the list of workqueues. */
414static DEFINE_SPINLOCK(workqueue_lock);
1da177e4 415static LIST_HEAD(workqueues);
a0a1a5fd 416static bool workqueue_freezing; /* W: have wqs started freezing? */
c34056a3 417
e22bee78 418/*
e19e397a
TH
419 * The CPU and unbound standard worker pools. The unbound ones have
420 * POOL_DISASSOCIATED set, and their workers have WORKER_UNBOUND set.
f3421797 421 */
e19e397a 422static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
f02ae73a 423 cpu_worker_pools);
f3421797 424
fa1b54e6
TH
425/*
426 * idr of all pools. Modifications are protected by workqueue_lock. Read
427 * accesses are protected by sched-RCU protected.
428 */
9daf9e67
TH
429static DEFINE_IDR(worker_pool_idr);
430
c34056a3 431static int worker_thread(void *__worker);
1da177e4 432
9daf9e67
TH
433/* allocate ID and assign it to @pool */
434static int worker_pool_assign_id(struct worker_pool *pool)
435{
436 int ret;
437
fa1b54e6
TH
438 do {
439 if (!idr_pre_get(&worker_pool_idr, GFP_KERNEL))
440 return -ENOMEM;
9daf9e67 441
fa1b54e6
TH
442 spin_lock_irq(&workqueue_lock);
443 ret = idr_get_new(&worker_pool_idr, pool, &pool->id);
444 spin_unlock_irq(&workqueue_lock);
445 } while (ret == -EAGAIN);
9daf9e67 446
fa1b54e6 447 return ret;
7c3eed5c
TH
448}
449
76af4d93
TH
450/**
451 * first_pwq - return the first pool_workqueue of the specified workqueue
452 * @wq: the target workqueue
453 *
454 * This must be called either with workqueue_lock held or sched RCU read
455 * locked. If the pwq needs to be used beyond the locking in effect, the
456 * caller is responsible for guaranteeing that the pwq stays online.
457 */
7fb98ea7 458static struct pool_workqueue *first_pwq(struct workqueue_struct *wq)
b1f4ec17 459{
76af4d93
TH
460 assert_rcu_or_wq_lock();
461 return list_first_or_null_rcu(&wq->pwqs, struct pool_workqueue,
462 pwqs_node);
b1f4ec17
ON
463}
464
73f53c4a
TH
465static unsigned int work_color_to_flags(int color)
466{
467 return color << WORK_STRUCT_COLOR_SHIFT;
468}
469
470static int get_work_color(struct work_struct *work)
471{
472 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
473 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
474}
475
476static int work_next_color(int color)
477{
478 return (color + 1) % WORK_NR_COLORS;
479}
1da177e4 480
14441960 481/*
112202d9
TH
482 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
483 * contain the pointer to the queued pwq. Once execution starts, the flag
7c3eed5c 484 * is cleared and the high bits contain OFFQ flags and pool ID.
7a22ad75 485 *
112202d9
TH
486 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
487 * and clear_work_data() can be used to set the pwq, pool or clear
bbb68dfa
TH
488 * work->data. These functions should only be called while the work is
489 * owned - ie. while the PENDING bit is set.
7a22ad75 490 *
112202d9 491 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
7c3eed5c 492 * corresponding to a work. Pool is available once the work has been
112202d9 493 * queued anywhere after initialization until it is sync canceled. pwq is
7c3eed5c 494 * available only while the work item is queued.
7a22ad75 495 *
bbb68dfa
TH
496 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
497 * canceled. While being canceled, a work item may have its PENDING set
498 * but stay off timer and worklist for arbitrarily long and nobody should
499 * try to steal the PENDING bit.
14441960 500 */
7a22ad75
TH
501static inline void set_work_data(struct work_struct *work, unsigned long data,
502 unsigned long flags)
365970a1 503{
6183c009 504 WARN_ON_ONCE(!work_pending(work));
7a22ad75
TH
505 atomic_long_set(&work->data, data | flags | work_static(work));
506}
365970a1 507
112202d9 508static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
7a22ad75
TH
509 unsigned long extra_flags)
510{
112202d9
TH
511 set_work_data(work, (unsigned long)pwq,
512 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
365970a1
DH
513}
514
4468a00f
LJ
515static void set_work_pool_and_keep_pending(struct work_struct *work,
516 int pool_id)
517{
518 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
519 WORK_STRUCT_PENDING);
520}
521
7c3eed5c
TH
522static void set_work_pool_and_clear_pending(struct work_struct *work,
523 int pool_id)
7a22ad75 524{
23657bb1
TH
525 /*
526 * The following wmb is paired with the implied mb in
527 * test_and_set_bit(PENDING) and ensures all updates to @work made
528 * here are visible to and precede any updates by the next PENDING
529 * owner.
530 */
531 smp_wmb();
7c3eed5c 532 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
7a22ad75 533}
f756d5e2 534
7a22ad75 535static void clear_work_data(struct work_struct *work)
1da177e4 536{
7c3eed5c
TH
537 smp_wmb(); /* see set_work_pool_and_clear_pending() */
538 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
1da177e4
LT
539}
540
112202d9 541static struct pool_workqueue *get_work_pwq(struct work_struct *work)
b1f4ec17 542{
e120153d 543 unsigned long data = atomic_long_read(&work->data);
7a22ad75 544
112202d9 545 if (data & WORK_STRUCT_PWQ)
e120153d
TH
546 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
547 else
548 return NULL;
4d707b9f
ON
549}
550
7c3eed5c
TH
551/**
552 * get_work_pool - return the worker_pool a given work was associated with
553 * @work: the work item of interest
554 *
555 * Return the worker_pool @work was last associated with. %NULL if none.
fa1b54e6
TH
556 *
557 * Pools are created and destroyed under workqueue_lock, and allows read
558 * access under sched-RCU read lock. As such, this function should be
559 * called under workqueue_lock or with preemption disabled.
560 *
561 * All fields of the returned pool are accessible as long as the above
562 * mentioned locking is in effect. If the returned pool needs to be used
563 * beyond the critical section, the caller is responsible for ensuring the
564 * returned pool is and stays online.
7c3eed5c
TH
565 */
566static struct worker_pool *get_work_pool(struct work_struct *work)
365970a1 567{
e120153d 568 unsigned long data = atomic_long_read(&work->data);
7c3eed5c 569 int pool_id;
7a22ad75 570
fa1b54e6
TH
571 assert_rcu_or_wq_lock();
572
112202d9
TH
573 if (data & WORK_STRUCT_PWQ)
574 return ((struct pool_workqueue *)
7c3eed5c 575 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
7a22ad75 576
7c3eed5c
TH
577 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
578 if (pool_id == WORK_OFFQ_POOL_NONE)
7a22ad75
TH
579 return NULL;
580
fa1b54e6 581 return idr_find(&worker_pool_idr, pool_id);
7c3eed5c
TH
582}
583
584/**
585 * get_work_pool_id - return the worker pool ID a given work is associated with
586 * @work: the work item of interest
587 *
588 * Return the worker_pool ID @work was last associated with.
589 * %WORK_OFFQ_POOL_NONE if none.
590 */
591static int get_work_pool_id(struct work_struct *work)
592{
54d5b7d0
LJ
593 unsigned long data = atomic_long_read(&work->data);
594
112202d9
TH
595 if (data & WORK_STRUCT_PWQ)
596 return ((struct pool_workqueue *)
54d5b7d0 597 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
7c3eed5c 598
54d5b7d0 599 return data >> WORK_OFFQ_POOL_SHIFT;
7c3eed5c
TH
600}
601
bbb68dfa
TH
602static void mark_work_canceling(struct work_struct *work)
603{
7c3eed5c 604 unsigned long pool_id = get_work_pool_id(work);
bbb68dfa 605
7c3eed5c
TH
606 pool_id <<= WORK_OFFQ_POOL_SHIFT;
607 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
bbb68dfa
TH
608}
609
610static bool work_is_canceling(struct work_struct *work)
611{
612 unsigned long data = atomic_long_read(&work->data);
613
112202d9 614 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
bbb68dfa
TH
615}
616
e22bee78 617/*
3270476a
TH
618 * Policy functions. These define the policies on how the global worker
619 * pools are managed. Unless noted otherwise, these functions assume that
d565ed63 620 * they're being called with pool->lock held.
e22bee78
TH
621 */
622
63d95a91 623static bool __need_more_worker(struct worker_pool *pool)
a848e3b6 624{
e19e397a 625 return !atomic_read(&pool->nr_running);
a848e3b6
ON
626}
627
4594bf15 628/*
e22bee78
TH
629 * Need to wake up a worker? Called from anything but currently
630 * running workers.
974271c4
TH
631 *
632 * Note that, because unbound workers never contribute to nr_running, this
706026c2 633 * function will always return %true for unbound pools as long as the
974271c4 634 * worklist isn't empty.
4594bf15 635 */
63d95a91 636static bool need_more_worker(struct worker_pool *pool)
365970a1 637{
63d95a91 638 return !list_empty(&pool->worklist) && __need_more_worker(pool);
e22bee78 639}
4594bf15 640
e22bee78 641/* Can I start working? Called from busy but !running workers. */
63d95a91 642static bool may_start_working(struct worker_pool *pool)
e22bee78 643{
63d95a91 644 return pool->nr_idle;
e22bee78
TH
645}
646
647/* Do I need to keep working? Called from currently running workers. */
63d95a91 648static bool keep_working(struct worker_pool *pool)
e22bee78 649{
e19e397a
TH
650 return !list_empty(&pool->worklist) &&
651 atomic_read(&pool->nr_running) <= 1;
e22bee78
TH
652}
653
654/* Do we need a new worker? Called from manager. */
63d95a91 655static bool need_to_create_worker(struct worker_pool *pool)
e22bee78 656{
63d95a91 657 return need_more_worker(pool) && !may_start_working(pool);
e22bee78 658}
365970a1 659
e22bee78 660/* Do I need to be the manager? */
63d95a91 661static bool need_to_manage_workers(struct worker_pool *pool)
e22bee78 662{
63d95a91 663 return need_to_create_worker(pool) ||
11ebea50 664 (pool->flags & POOL_MANAGE_WORKERS);
e22bee78
TH
665}
666
667/* Do we have too many workers and should some go away? */
63d95a91 668static bool too_many_workers(struct worker_pool *pool)
e22bee78 669{
34a06bd6 670 bool managing = mutex_is_locked(&pool->manager_arb);
63d95a91
TH
671 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
672 int nr_busy = pool->nr_workers - nr_idle;
e22bee78 673
ea1abd61
LJ
674 /*
675 * nr_idle and idle_list may disagree if idle rebinding is in
676 * progress. Never return %true if idle_list is empty.
677 */
678 if (list_empty(&pool->idle_list))
679 return false;
680
e22bee78 681 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
365970a1
DH
682}
683
4d707b9f 684/*
e22bee78
TH
685 * Wake up functions.
686 */
687
7e11629d 688/* Return the first worker. Safe with preemption disabled */
63d95a91 689static struct worker *first_worker(struct worker_pool *pool)
7e11629d 690{
63d95a91 691 if (unlikely(list_empty(&pool->idle_list)))
7e11629d
TH
692 return NULL;
693
63d95a91 694 return list_first_entry(&pool->idle_list, struct worker, entry);
7e11629d
TH
695}
696
697/**
698 * wake_up_worker - wake up an idle worker
63d95a91 699 * @pool: worker pool to wake worker from
7e11629d 700 *
63d95a91 701 * Wake up the first idle worker of @pool.
7e11629d
TH
702 *
703 * CONTEXT:
d565ed63 704 * spin_lock_irq(pool->lock).
7e11629d 705 */
63d95a91 706static void wake_up_worker(struct worker_pool *pool)
7e11629d 707{
63d95a91 708 struct worker *worker = first_worker(pool);
7e11629d
TH
709
710 if (likely(worker))
711 wake_up_process(worker->task);
712}
713
d302f017 714/**
e22bee78
TH
715 * wq_worker_waking_up - a worker is waking up
716 * @task: task waking up
717 * @cpu: CPU @task is waking up to
718 *
719 * This function is called during try_to_wake_up() when a worker is
720 * being awoken.
721 *
722 * CONTEXT:
723 * spin_lock_irq(rq->lock)
724 */
d84ff051 725void wq_worker_waking_up(struct task_struct *task, int cpu)
e22bee78
TH
726{
727 struct worker *worker = kthread_data(task);
728
36576000 729 if (!(worker->flags & WORKER_NOT_RUNNING)) {
ec22ca5e 730 WARN_ON_ONCE(worker->pool->cpu != cpu);
e19e397a 731 atomic_inc(&worker->pool->nr_running);
36576000 732 }
e22bee78
TH
733}
734
735/**
736 * wq_worker_sleeping - a worker is going to sleep
737 * @task: task going to sleep
738 * @cpu: CPU in question, must be the current CPU number
739 *
740 * This function is called during schedule() when a busy worker is
741 * going to sleep. Worker on the same cpu can be woken up by
742 * returning pointer to its task.
743 *
744 * CONTEXT:
745 * spin_lock_irq(rq->lock)
746 *
747 * RETURNS:
748 * Worker task on @cpu to wake up, %NULL if none.
749 */
d84ff051 750struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
e22bee78
TH
751{
752 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
111c225a 753 struct worker_pool *pool;
e22bee78 754
111c225a
TH
755 /*
756 * Rescuers, which may not have all the fields set up like normal
757 * workers, also reach here, let's not access anything before
758 * checking NOT_RUNNING.
759 */
2d64672e 760 if (worker->flags & WORKER_NOT_RUNNING)
e22bee78
TH
761 return NULL;
762
111c225a 763 pool = worker->pool;
111c225a 764
e22bee78 765 /* this can only happen on the local cpu */
6183c009
TH
766 if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
767 return NULL;
e22bee78
TH
768
769 /*
770 * The counterpart of the following dec_and_test, implied mb,
771 * worklist not empty test sequence is in insert_work().
772 * Please read comment there.
773 *
628c78e7
TH
774 * NOT_RUNNING is clear. This means that we're bound to and
775 * running on the local cpu w/ rq lock held and preemption
776 * disabled, which in turn means that none else could be
d565ed63 777 * manipulating idle_list, so dereferencing idle_list without pool
628c78e7 778 * lock is safe.
e22bee78 779 */
e19e397a
TH
780 if (atomic_dec_and_test(&pool->nr_running) &&
781 !list_empty(&pool->worklist))
63d95a91 782 to_wakeup = first_worker(pool);
e22bee78
TH
783 return to_wakeup ? to_wakeup->task : NULL;
784}
785
786/**
787 * worker_set_flags - set worker flags and adjust nr_running accordingly
cb444766 788 * @worker: self
d302f017
TH
789 * @flags: flags to set
790 * @wakeup: wakeup an idle worker if necessary
791 *
e22bee78
TH
792 * Set @flags in @worker->flags and adjust nr_running accordingly. If
793 * nr_running becomes zero and @wakeup is %true, an idle worker is
794 * woken up.
d302f017 795 *
cb444766 796 * CONTEXT:
d565ed63 797 * spin_lock_irq(pool->lock)
d302f017
TH
798 */
799static inline void worker_set_flags(struct worker *worker, unsigned int flags,
800 bool wakeup)
801{
bd7bdd43 802 struct worker_pool *pool = worker->pool;
e22bee78 803
cb444766
TH
804 WARN_ON_ONCE(worker->task != current);
805
e22bee78
TH
806 /*
807 * If transitioning into NOT_RUNNING, adjust nr_running and
808 * wake up an idle worker as necessary if requested by
809 * @wakeup.
810 */
811 if ((flags & WORKER_NOT_RUNNING) &&
812 !(worker->flags & WORKER_NOT_RUNNING)) {
e22bee78 813 if (wakeup) {
e19e397a 814 if (atomic_dec_and_test(&pool->nr_running) &&
bd7bdd43 815 !list_empty(&pool->worklist))
63d95a91 816 wake_up_worker(pool);
e22bee78 817 } else
e19e397a 818 atomic_dec(&pool->nr_running);
e22bee78
TH
819 }
820
d302f017
TH
821 worker->flags |= flags;
822}
823
824/**
e22bee78 825 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
cb444766 826 * @worker: self
d302f017
TH
827 * @flags: flags to clear
828 *
e22bee78 829 * Clear @flags in @worker->flags and adjust nr_running accordingly.
d302f017 830 *
cb444766 831 * CONTEXT:
d565ed63 832 * spin_lock_irq(pool->lock)
d302f017
TH
833 */
834static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
835{
63d95a91 836 struct worker_pool *pool = worker->pool;
e22bee78
TH
837 unsigned int oflags = worker->flags;
838
cb444766
TH
839 WARN_ON_ONCE(worker->task != current);
840
d302f017 841 worker->flags &= ~flags;
e22bee78 842
42c025f3
TH
843 /*
844 * If transitioning out of NOT_RUNNING, increment nr_running. Note
845 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
846 * of multiple flags, not a single flag.
847 */
e22bee78
TH
848 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
849 if (!(worker->flags & WORKER_NOT_RUNNING))
e19e397a 850 atomic_inc(&pool->nr_running);
d302f017
TH
851}
852
8cca0eea
TH
853/**
854 * find_worker_executing_work - find worker which is executing a work
c9e7cf27 855 * @pool: pool of interest
8cca0eea
TH
856 * @work: work to find worker for
857 *
c9e7cf27
TH
858 * Find a worker which is executing @work on @pool by searching
859 * @pool->busy_hash which is keyed by the address of @work. For a worker
a2c1c57b
TH
860 * to match, its current execution should match the address of @work and
861 * its work function. This is to avoid unwanted dependency between
862 * unrelated work executions through a work item being recycled while still
863 * being executed.
864 *
865 * This is a bit tricky. A work item may be freed once its execution
866 * starts and nothing prevents the freed area from being recycled for
867 * another work item. If the same work item address ends up being reused
868 * before the original execution finishes, workqueue will identify the
869 * recycled work item as currently executing and make it wait until the
870 * current execution finishes, introducing an unwanted dependency.
871 *
872 * This function checks the work item address, work function and workqueue
873 * to avoid false positives. Note that this isn't complete as one may
874 * construct a work function which can introduce dependency onto itself
875 * through a recycled work item. Well, if somebody wants to shoot oneself
876 * in the foot that badly, there's only so much we can do, and if such
877 * deadlock actually occurs, it should be easy to locate the culprit work
878 * function.
8cca0eea
TH
879 *
880 * CONTEXT:
d565ed63 881 * spin_lock_irq(pool->lock).
8cca0eea
TH
882 *
883 * RETURNS:
884 * Pointer to worker which is executing @work if found, NULL
885 * otherwise.
4d707b9f 886 */
c9e7cf27 887static struct worker *find_worker_executing_work(struct worker_pool *pool,
8cca0eea 888 struct work_struct *work)
4d707b9f 889{
42f8570f 890 struct worker *worker;
42f8570f 891
b67bfe0d 892 hash_for_each_possible(pool->busy_hash, worker, hentry,
a2c1c57b
TH
893 (unsigned long)work)
894 if (worker->current_work == work &&
895 worker->current_func == work->func)
42f8570f
SL
896 return worker;
897
898 return NULL;
4d707b9f
ON
899}
900
bf4ede01
TH
901/**
902 * move_linked_works - move linked works to a list
903 * @work: start of series of works to be scheduled
904 * @head: target list to append @work to
905 * @nextp: out paramter for nested worklist walking
906 *
907 * Schedule linked works starting from @work to @head. Work series to
908 * be scheduled starts at @work and includes any consecutive work with
909 * WORK_STRUCT_LINKED set in its predecessor.
910 *
911 * If @nextp is not NULL, it's updated to point to the next work of
912 * the last scheduled work. This allows move_linked_works() to be
913 * nested inside outer list_for_each_entry_safe().
914 *
915 * CONTEXT:
d565ed63 916 * spin_lock_irq(pool->lock).
bf4ede01
TH
917 */
918static void move_linked_works(struct work_struct *work, struct list_head *head,
919 struct work_struct **nextp)
920{
921 struct work_struct *n;
922
923 /*
924 * Linked worklist will always end before the end of the list,
925 * use NULL for list head.
926 */
927 list_for_each_entry_safe_from(work, n, NULL, entry) {
928 list_move_tail(&work->entry, head);
929 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
930 break;
931 }
932
933 /*
934 * If we're already inside safe list traversal and have moved
935 * multiple works to the scheduled queue, the next position
936 * needs to be updated.
937 */
938 if (nextp)
939 *nextp = n;
940}
941
112202d9 942static void pwq_activate_delayed_work(struct work_struct *work)
bf4ede01 943{
112202d9 944 struct pool_workqueue *pwq = get_work_pwq(work);
bf4ede01
TH
945
946 trace_workqueue_activate_work(work);
112202d9 947 move_linked_works(work, &pwq->pool->worklist, NULL);
bf4ede01 948 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
112202d9 949 pwq->nr_active++;
bf4ede01
TH
950}
951
112202d9 952static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
3aa62497 953{
112202d9 954 struct work_struct *work = list_first_entry(&pwq->delayed_works,
3aa62497
LJ
955 struct work_struct, entry);
956
112202d9 957 pwq_activate_delayed_work(work);
3aa62497
LJ
958}
959
bf4ede01 960/**
112202d9
TH
961 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
962 * @pwq: pwq of interest
bf4ede01 963 * @color: color of work which left the queue
bf4ede01
TH
964 *
965 * A work either has completed or is removed from pending queue,
112202d9 966 * decrement nr_in_flight of its pwq and handle workqueue flushing.
bf4ede01
TH
967 *
968 * CONTEXT:
d565ed63 969 * spin_lock_irq(pool->lock).
bf4ede01 970 */
112202d9 971static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
bf4ede01
TH
972{
973 /* ignore uncolored works */
974 if (color == WORK_NO_COLOR)
975 return;
976
112202d9 977 pwq->nr_in_flight[color]--;
bf4ede01 978
112202d9
TH
979 pwq->nr_active--;
980 if (!list_empty(&pwq->delayed_works)) {
b3f9f405 981 /* one down, submit a delayed one */
112202d9
TH
982 if (pwq->nr_active < pwq->max_active)
983 pwq_activate_first_delayed(pwq);
bf4ede01
TH
984 }
985
986 /* is flush in progress and are we at the flushing tip? */
112202d9 987 if (likely(pwq->flush_color != color))
bf4ede01
TH
988 return;
989
990 /* are there still in-flight works? */
112202d9 991 if (pwq->nr_in_flight[color])
bf4ede01
TH
992 return;
993
112202d9
TH
994 /* this pwq is done, clear flush_color */
995 pwq->flush_color = -1;
bf4ede01
TH
996
997 /*
112202d9 998 * If this was the last pwq, wake up the first flusher. It
bf4ede01
TH
999 * will handle the rest.
1000 */
112202d9
TH
1001 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1002 complete(&pwq->wq->first_flusher->done);
bf4ede01
TH
1003}
1004
36e227d2 1005/**
bbb68dfa 1006 * try_to_grab_pending - steal work item from worklist and disable irq
36e227d2
TH
1007 * @work: work item to steal
1008 * @is_dwork: @work is a delayed_work
bbb68dfa 1009 * @flags: place to store irq state
36e227d2
TH
1010 *
1011 * Try to grab PENDING bit of @work. This function can handle @work in any
1012 * stable state - idle, on timer or on worklist. Return values are
1013 *
1014 * 1 if @work was pending and we successfully stole PENDING
1015 * 0 if @work was idle and we claimed PENDING
1016 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
bbb68dfa
TH
1017 * -ENOENT if someone else is canceling @work, this state may persist
1018 * for arbitrarily long
36e227d2 1019 *
bbb68dfa 1020 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
e0aecdd8
TH
1021 * interrupted while holding PENDING and @work off queue, irq must be
1022 * disabled on entry. This, combined with delayed_work->timer being
1023 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
bbb68dfa
TH
1024 *
1025 * On successful return, >= 0, irq is disabled and the caller is
1026 * responsible for releasing it using local_irq_restore(*@flags).
1027 *
e0aecdd8 1028 * This function is safe to call from any context including IRQ handler.
bf4ede01 1029 */
bbb68dfa
TH
1030static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1031 unsigned long *flags)
bf4ede01 1032{
d565ed63 1033 struct worker_pool *pool;
112202d9 1034 struct pool_workqueue *pwq;
bf4ede01 1035
bbb68dfa
TH
1036 local_irq_save(*flags);
1037
36e227d2
TH
1038 /* try to steal the timer if it exists */
1039 if (is_dwork) {
1040 struct delayed_work *dwork = to_delayed_work(work);
1041
e0aecdd8
TH
1042 /*
1043 * dwork->timer is irqsafe. If del_timer() fails, it's
1044 * guaranteed that the timer is not queued anywhere and not
1045 * running on the local CPU.
1046 */
36e227d2
TH
1047 if (likely(del_timer(&dwork->timer)))
1048 return 1;
1049 }
1050
1051 /* try to claim PENDING the normal way */
bf4ede01
TH
1052 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1053 return 0;
1054
1055 /*
1056 * The queueing is in progress, or it is already queued. Try to
1057 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1058 */
d565ed63
TH
1059 pool = get_work_pool(work);
1060 if (!pool)
bbb68dfa 1061 goto fail;
bf4ede01 1062
d565ed63 1063 spin_lock(&pool->lock);
0b3dae68 1064 /*
112202d9
TH
1065 * work->data is guaranteed to point to pwq only while the work
1066 * item is queued on pwq->wq, and both updating work->data to point
1067 * to pwq on queueing and to pool on dequeueing are done under
1068 * pwq->pool->lock. This in turn guarantees that, if work->data
1069 * points to pwq which is associated with a locked pool, the work
0b3dae68
LJ
1070 * item is currently queued on that pool.
1071 */
112202d9
TH
1072 pwq = get_work_pwq(work);
1073 if (pwq && pwq->pool == pool) {
16062836
TH
1074 debug_work_deactivate(work);
1075
1076 /*
1077 * A delayed work item cannot be grabbed directly because
1078 * it might have linked NO_COLOR work items which, if left
112202d9 1079 * on the delayed_list, will confuse pwq->nr_active
16062836
TH
1080 * management later on and cause stall. Make sure the work
1081 * item is activated before grabbing.
1082 */
1083 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
112202d9 1084 pwq_activate_delayed_work(work);
16062836
TH
1085
1086 list_del_init(&work->entry);
112202d9 1087 pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
16062836 1088
112202d9 1089 /* work->data points to pwq iff queued, point to pool */
16062836
TH
1090 set_work_pool_and_keep_pending(work, pool->id);
1091
1092 spin_unlock(&pool->lock);
1093 return 1;
bf4ede01 1094 }
d565ed63 1095 spin_unlock(&pool->lock);
bbb68dfa
TH
1096fail:
1097 local_irq_restore(*flags);
1098 if (work_is_canceling(work))
1099 return -ENOENT;
1100 cpu_relax();
36e227d2 1101 return -EAGAIN;
bf4ede01
TH
1102}
1103
4690c4ab 1104/**
706026c2 1105 * insert_work - insert a work into a pool
112202d9 1106 * @pwq: pwq @work belongs to
4690c4ab
TH
1107 * @work: work to insert
1108 * @head: insertion point
1109 * @extra_flags: extra WORK_STRUCT_* flags to set
1110 *
112202d9 1111 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
706026c2 1112 * work_struct flags.
4690c4ab
TH
1113 *
1114 * CONTEXT:
d565ed63 1115 * spin_lock_irq(pool->lock).
4690c4ab 1116 */
112202d9
TH
1117static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1118 struct list_head *head, unsigned int extra_flags)
b89deed3 1119{
112202d9 1120 struct worker_pool *pool = pwq->pool;
e22bee78 1121
4690c4ab 1122 /* we own @work, set data and link */
112202d9 1123 set_work_pwq(work, pwq, extra_flags);
1a4d9b0a 1124 list_add_tail(&work->entry, head);
e22bee78
TH
1125
1126 /*
1127 * Ensure either worker_sched_deactivated() sees the above
1128 * list_add_tail() or we see zero nr_running to avoid workers
1129 * lying around lazily while there are works to be processed.
1130 */
1131 smp_mb();
1132
63d95a91
TH
1133 if (__need_more_worker(pool))
1134 wake_up_worker(pool);
b89deed3
ON
1135}
1136
c8efcc25
TH
1137/*
1138 * Test whether @work is being queued from another work executing on the
8d03ecfe 1139 * same workqueue.
c8efcc25
TH
1140 */
1141static bool is_chained_work(struct workqueue_struct *wq)
1142{
8d03ecfe
TH
1143 struct worker *worker;
1144
1145 worker = current_wq_worker();
1146 /*
1147 * Return %true iff I'm a worker execuing a work item on @wq. If
1148 * I'm @worker, it's safe to dereference it without locking.
1149 */
112202d9 1150 return worker && worker->current_pwq->wq == wq;
c8efcc25
TH
1151}
1152
d84ff051 1153static void __queue_work(int cpu, struct workqueue_struct *wq,
1da177e4
LT
1154 struct work_struct *work)
1155{
112202d9 1156 struct pool_workqueue *pwq;
1e19ffc6 1157 struct list_head *worklist;
8a2e8e5d 1158 unsigned int work_flags;
b75cac93 1159 unsigned int req_cpu = cpu;
8930caba
TH
1160
1161 /*
1162 * While a work item is PENDING && off queue, a task trying to
1163 * steal the PENDING will busy-loop waiting for it to either get
1164 * queued or lose PENDING. Grabbing PENDING and queueing should
1165 * happen with IRQ disabled.
1166 */
1167 WARN_ON_ONCE(!irqs_disabled());
1da177e4 1168
dc186ad7 1169 debug_work_activate(work);
1e19ffc6 1170
c8efcc25 1171 /* if dying, only works from the same workqueue are allowed */
9c5a2ba7 1172 if (unlikely(wq->flags & WQ_DRAINING) &&
c8efcc25 1173 WARN_ON_ONCE(!is_chained_work(wq)))
e41e704b
TH
1174 return;
1175
112202d9 1176 /* determine the pwq to use */
c7fc77f7 1177 if (!(wq->flags & WQ_UNBOUND)) {
c9e7cf27 1178 struct worker_pool *last_pool;
18aa9eff 1179
57469821 1180 if (cpu == WORK_CPU_UNBOUND)
c7fc77f7
TH
1181 cpu = raw_smp_processor_id();
1182
18aa9eff 1183 /*
dbf2576e
TH
1184 * It's multi cpu. If @work was previously on a different
1185 * cpu, it might still be running there, in which case the
1186 * work needs to be queued on that cpu to guarantee
1187 * non-reentrancy.
18aa9eff 1188 */
7fb98ea7 1189 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
c9e7cf27 1190 last_pool = get_work_pool(work);
dbf2576e 1191
112202d9 1192 if (last_pool && last_pool != pwq->pool) {
18aa9eff
TH
1193 struct worker *worker;
1194
d565ed63 1195 spin_lock(&last_pool->lock);
18aa9eff 1196
c9e7cf27 1197 worker = find_worker_executing_work(last_pool, work);
18aa9eff 1198
112202d9 1199 if (worker && worker->current_pwq->wq == wq) {
7fb98ea7 1200 pwq = per_cpu_ptr(wq->cpu_pwqs, last_pool->cpu);
8594fade 1201 } else {
18aa9eff 1202 /* meh... not running there, queue here */
d565ed63 1203 spin_unlock(&last_pool->lock);
112202d9 1204 spin_lock(&pwq->pool->lock);
18aa9eff 1205 }
8930caba 1206 } else {
112202d9 1207 spin_lock(&pwq->pool->lock);
8930caba 1208 }
f3421797 1209 } else {
7fb98ea7 1210 pwq = first_pwq(wq);
112202d9 1211 spin_lock(&pwq->pool->lock);
502ca9d8
TH
1212 }
1213
112202d9
TH
1214 /* pwq determined, queue */
1215 trace_workqueue_queue_work(req_cpu, pwq, work);
502ca9d8 1216
f5b2552b 1217 if (WARN_ON(!list_empty(&work->entry))) {
112202d9 1218 spin_unlock(&pwq->pool->lock);
f5b2552b
DC
1219 return;
1220 }
1e19ffc6 1221
112202d9
TH
1222 pwq->nr_in_flight[pwq->work_color]++;
1223 work_flags = work_color_to_flags(pwq->work_color);
1e19ffc6 1224
112202d9 1225 if (likely(pwq->nr_active < pwq->max_active)) {
cdadf009 1226 trace_workqueue_activate_work(work);
112202d9
TH
1227 pwq->nr_active++;
1228 worklist = &pwq->pool->worklist;
8a2e8e5d
TH
1229 } else {
1230 work_flags |= WORK_STRUCT_DELAYED;
112202d9 1231 worklist = &pwq->delayed_works;
8a2e8e5d 1232 }
1e19ffc6 1233
112202d9 1234 insert_work(pwq, work, worklist, work_flags);
1e19ffc6 1235
112202d9 1236 spin_unlock(&pwq->pool->lock);
1da177e4
LT
1237}
1238
0fcb78c2 1239/**
c1a220e7
ZR
1240 * queue_work_on - queue work on specific cpu
1241 * @cpu: CPU number to execute work on
0fcb78c2
REB
1242 * @wq: workqueue to use
1243 * @work: work to queue
1244 *
d4283e93 1245 * Returns %false if @work was already on a queue, %true otherwise.
1da177e4 1246 *
c1a220e7
ZR
1247 * We queue the work to a specific CPU, the caller must ensure it
1248 * can't go away.
1da177e4 1249 */
d4283e93
TH
1250bool queue_work_on(int cpu, struct workqueue_struct *wq,
1251 struct work_struct *work)
1da177e4 1252{
d4283e93 1253 bool ret = false;
8930caba 1254 unsigned long flags;
ef1ca236 1255
8930caba 1256 local_irq_save(flags);
c1a220e7 1257
22df02bb 1258 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
4690c4ab 1259 __queue_work(cpu, wq, work);
d4283e93 1260 ret = true;
c1a220e7 1261 }
ef1ca236 1262
8930caba 1263 local_irq_restore(flags);
1da177e4
LT
1264 return ret;
1265}
c1a220e7 1266EXPORT_SYMBOL_GPL(queue_work_on);
1da177e4 1267
c1a220e7 1268/**
0a13c00e 1269 * queue_work - queue work on a workqueue
c1a220e7
ZR
1270 * @wq: workqueue to use
1271 * @work: work to queue
1272 *
d4283e93 1273 * Returns %false if @work was already on a queue, %true otherwise.
c1a220e7 1274 *
0a13c00e
TH
1275 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1276 * it can be processed by another CPU.
c1a220e7 1277 */
d4283e93 1278bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
c1a220e7 1279{
57469821 1280 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
c1a220e7 1281}
0a13c00e 1282EXPORT_SYMBOL_GPL(queue_work);
c1a220e7 1283
d8e794df 1284void delayed_work_timer_fn(unsigned long __data)
1da177e4 1285{
52bad64d 1286 struct delayed_work *dwork = (struct delayed_work *)__data;
1da177e4 1287
e0aecdd8 1288 /* should have been called from irqsafe timer with irq already off */
60c057bc 1289 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
1da177e4 1290}
1438ade5 1291EXPORT_SYMBOL(delayed_work_timer_fn);
1da177e4 1292
7beb2edf
TH
1293static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1294 struct delayed_work *dwork, unsigned long delay)
1da177e4 1295{
7beb2edf
TH
1296 struct timer_list *timer = &dwork->timer;
1297 struct work_struct *work = &dwork->work;
7beb2edf
TH
1298
1299 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1300 timer->data != (unsigned long)dwork);
fc4b514f
TH
1301 WARN_ON_ONCE(timer_pending(timer));
1302 WARN_ON_ONCE(!list_empty(&work->entry));
7beb2edf 1303
8852aac2
TH
1304 /*
1305 * If @delay is 0, queue @dwork->work immediately. This is for
1306 * both optimization and correctness. The earliest @timer can
1307 * expire is on the closest next tick and delayed_work users depend
1308 * on that there's no such delay when @delay is 0.
1309 */
1310 if (!delay) {
1311 __queue_work(cpu, wq, &dwork->work);
1312 return;
1313 }
1314
7beb2edf 1315 timer_stats_timer_set_start_info(&dwork->timer);
1da177e4 1316
60c057bc 1317 dwork->wq = wq;
1265057f 1318 dwork->cpu = cpu;
7beb2edf
TH
1319 timer->expires = jiffies + delay;
1320
1321 if (unlikely(cpu != WORK_CPU_UNBOUND))
1322 add_timer_on(timer, cpu);
1323 else
1324 add_timer(timer);
1da177e4
LT
1325}
1326
0fcb78c2
REB
1327/**
1328 * queue_delayed_work_on - queue work on specific CPU after delay
1329 * @cpu: CPU number to execute work on
1330 * @wq: workqueue to use
af9997e4 1331 * @dwork: work to queue
0fcb78c2
REB
1332 * @delay: number of jiffies to wait before queueing
1333 *
715f1300
TH
1334 * Returns %false if @work was already on a queue, %true otherwise. If
1335 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1336 * execution.
0fcb78c2 1337 */
d4283e93
TH
1338bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1339 struct delayed_work *dwork, unsigned long delay)
7a6bc1cd 1340{
52bad64d 1341 struct work_struct *work = &dwork->work;
d4283e93 1342 bool ret = false;
8930caba 1343 unsigned long flags;
7a6bc1cd 1344
8930caba
TH
1345 /* read the comment in __queue_work() */
1346 local_irq_save(flags);
7a6bc1cd 1347
22df02bb 1348 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
7beb2edf 1349 __queue_delayed_work(cpu, wq, dwork, delay);
d4283e93 1350 ret = true;
7a6bc1cd 1351 }
8a3e77cc 1352
8930caba 1353 local_irq_restore(flags);
7a6bc1cd
VP
1354 return ret;
1355}
ae90dd5d 1356EXPORT_SYMBOL_GPL(queue_delayed_work_on);
c7fc77f7 1357
0a13c00e
TH
1358/**
1359 * queue_delayed_work - queue work on a workqueue after delay
1360 * @wq: workqueue to use
1361 * @dwork: delayable work to queue
1362 * @delay: number of jiffies to wait before queueing
1363 *
715f1300 1364 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
0a13c00e 1365 */
d4283e93 1366bool queue_delayed_work(struct workqueue_struct *wq,
0a13c00e
TH
1367 struct delayed_work *dwork, unsigned long delay)
1368{
57469821 1369 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
0a13c00e
TH
1370}
1371EXPORT_SYMBOL_GPL(queue_delayed_work);
c7fc77f7 1372
8376fe22
TH
1373/**
1374 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1375 * @cpu: CPU number to execute work on
1376 * @wq: workqueue to use
1377 * @dwork: work to queue
1378 * @delay: number of jiffies to wait before queueing
1379 *
1380 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1381 * modify @dwork's timer so that it expires after @delay. If @delay is
1382 * zero, @work is guaranteed to be scheduled immediately regardless of its
1383 * current state.
1384 *
1385 * Returns %false if @dwork was idle and queued, %true if @dwork was
1386 * pending and its timer was modified.
1387 *
e0aecdd8 1388 * This function is safe to call from any context including IRQ handler.
8376fe22
TH
1389 * See try_to_grab_pending() for details.
1390 */
1391bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1392 struct delayed_work *dwork, unsigned long delay)
1393{
1394 unsigned long flags;
1395 int ret;
c7fc77f7 1396
8376fe22
TH
1397 do {
1398 ret = try_to_grab_pending(&dwork->work, true, &flags);
1399 } while (unlikely(ret == -EAGAIN));
63bc0362 1400
8376fe22
TH
1401 if (likely(ret >= 0)) {
1402 __queue_delayed_work(cpu, wq, dwork, delay);
1403 local_irq_restore(flags);
7a6bc1cd 1404 }
8376fe22
TH
1405
1406 /* -ENOENT from try_to_grab_pending() becomes %true */
7a6bc1cd
VP
1407 return ret;
1408}
8376fe22
TH
1409EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1410
1411/**
1412 * mod_delayed_work - modify delay of or queue a delayed work
1413 * @wq: workqueue to use
1414 * @dwork: work to queue
1415 * @delay: number of jiffies to wait before queueing
1416 *
1417 * mod_delayed_work_on() on local CPU.
1418 */
1419bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1420 unsigned long delay)
1421{
1422 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1423}
1424EXPORT_SYMBOL_GPL(mod_delayed_work);
1da177e4 1425
c8e55f36
TH
1426/**
1427 * worker_enter_idle - enter idle state
1428 * @worker: worker which is entering idle state
1429 *
1430 * @worker is entering idle state. Update stats and idle timer if
1431 * necessary.
1432 *
1433 * LOCKING:
d565ed63 1434 * spin_lock_irq(pool->lock).
c8e55f36
TH
1435 */
1436static void worker_enter_idle(struct worker *worker)
1da177e4 1437{
bd7bdd43 1438 struct worker_pool *pool = worker->pool;
c8e55f36 1439
6183c009
TH
1440 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1441 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1442 (worker->hentry.next || worker->hentry.pprev)))
1443 return;
c8e55f36 1444
cb444766
TH
1445 /* can't use worker_set_flags(), also called from start_worker() */
1446 worker->flags |= WORKER_IDLE;
bd7bdd43 1447 pool->nr_idle++;
e22bee78 1448 worker->last_active = jiffies;
c8e55f36
TH
1449
1450 /* idle_list is LIFO */
bd7bdd43 1451 list_add(&worker->entry, &pool->idle_list);
db7bccf4 1452
628c78e7
TH
1453 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1454 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
cb444766 1455
544ecf31 1456 /*
706026c2 1457 * Sanity check nr_running. Because wq_unbind_fn() releases
d565ed63 1458 * pool->lock between setting %WORKER_UNBOUND and zapping
628c78e7
TH
1459 * nr_running, the warning may trigger spuriously. Check iff
1460 * unbind is not in progress.
544ecf31 1461 */
24647570 1462 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
bd7bdd43 1463 pool->nr_workers == pool->nr_idle &&
e19e397a 1464 atomic_read(&pool->nr_running));
c8e55f36
TH
1465}
1466
1467/**
1468 * worker_leave_idle - leave idle state
1469 * @worker: worker which is leaving idle state
1470 *
1471 * @worker is leaving idle state. Update stats.
1472 *
1473 * LOCKING:
d565ed63 1474 * spin_lock_irq(pool->lock).
c8e55f36
TH
1475 */
1476static void worker_leave_idle(struct worker *worker)
1477{
bd7bdd43 1478 struct worker_pool *pool = worker->pool;
c8e55f36 1479
6183c009
TH
1480 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1481 return;
d302f017 1482 worker_clr_flags(worker, WORKER_IDLE);
bd7bdd43 1483 pool->nr_idle--;
c8e55f36
TH
1484 list_del_init(&worker->entry);
1485}
1486
e22bee78 1487/**
f36dc67b
LJ
1488 * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1489 * @pool: target worker_pool
1490 *
1491 * Bind %current to the cpu of @pool if it is associated and lock @pool.
e22bee78
TH
1492 *
1493 * Works which are scheduled while the cpu is online must at least be
1494 * scheduled to a worker which is bound to the cpu so that if they are
1495 * flushed from cpu callbacks while cpu is going down, they are
1496 * guaranteed to execute on the cpu.
1497 *
f5faa077 1498 * This function is to be used by unbound workers and rescuers to bind
e22bee78
TH
1499 * themselves to the target cpu and may race with cpu going down or
1500 * coming online. kthread_bind() can't be used because it may put the
1501 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
706026c2 1502 * verbatim as it's best effort and blocking and pool may be
e22bee78
TH
1503 * [dis]associated in the meantime.
1504 *
706026c2 1505 * This function tries set_cpus_allowed() and locks pool and verifies the
24647570 1506 * binding against %POOL_DISASSOCIATED which is set during
f2d5a0ee
TH
1507 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1508 * enters idle state or fetches works without dropping lock, it can
1509 * guarantee the scheduling requirement described in the first paragraph.
e22bee78
TH
1510 *
1511 * CONTEXT:
d565ed63 1512 * Might sleep. Called without any lock but returns with pool->lock
e22bee78
TH
1513 * held.
1514 *
1515 * RETURNS:
706026c2 1516 * %true if the associated pool is online (@worker is successfully
e22bee78
TH
1517 * bound), %false if offline.
1518 */
f36dc67b 1519static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
d565ed63 1520__acquires(&pool->lock)
e22bee78 1521{
e22bee78 1522 while (true) {
4e6045f1 1523 /*
e22bee78
TH
1524 * The following call may fail, succeed or succeed
1525 * without actually migrating the task to the cpu if
1526 * it races with cpu hotunplug operation. Verify
24647570 1527 * against POOL_DISASSOCIATED.
4e6045f1 1528 */
24647570 1529 if (!(pool->flags & POOL_DISASSOCIATED))
7a4e344c 1530 set_cpus_allowed_ptr(current, pool->attrs->cpumask);
e22bee78 1531
d565ed63 1532 spin_lock_irq(&pool->lock);
24647570 1533 if (pool->flags & POOL_DISASSOCIATED)
e22bee78 1534 return false;
f5faa077 1535 if (task_cpu(current) == pool->cpu &&
7a4e344c 1536 cpumask_equal(&current->cpus_allowed, pool->attrs->cpumask))
e22bee78 1537 return true;
d565ed63 1538 spin_unlock_irq(&pool->lock);
e22bee78 1539
5035b20f
TH
1540 /*
1541 * We've raced with CPU hot[un]plug. Give it a breather
1542 * and retry migration. cond_resched() is required here;
1543 * otherwise, we might deadlock against cpu_stop trying to
1544 * bring down the CPU on non-preemptive kernel.
1545 */
e22bee78 1546 cpu_relax();
5035b20f 1547 cond_resched();
e22bee78
TH
1548 }
1549}
1550
25511a47 1551/*
ea1abd61 1552 * Rebind an idle @worker to its CPU. worker_thread() will test
5f7dabfd 1553 * list_empty(@worker->entry) before leaving idle and call this function.
25511a47
TH
1554 */
1555static void idle_worker_rebind(struct worker *worker)
1556{
5f7dabfd 1557 /* CPU may go down again inbetween, clear UNBOUND only on success */
f36dc67b 1558 if (worker_maybe_bind_and_lock(worker->pool))
5f7dabfd 1559 worker_clr_flags(worker, WORKER_UNBOUND);
25511a47 1560
ea1abd61
LJ
1561 /* rebind complete, become available again */
1562 list_add(&worker->entry, &worker->pool->idle_list);
d565ed63 1563 spin_unlock_irq(&worker->pool->lock);
25511a47
TH
1564}
1565
e22bee78 1566/*
25511a47 1567 * Function for @worker->rebind.work used to rebind unbound busy workers to
403c821d
TH
1568 * the associated cpu which is coming back online. This is scheduled by
1569 * cpu up but can race with other cpu hotplug operations and may be
1570 * executed twice without intervening cpu down.
e22bee78 1571 */
25511a47 1572static void busy_worker_rebind_fn(struct work_struct *work)
e22bee78
TH
1573{
1574 struct worker *worker = container_of(work, struct worker, rebind_work);
e22bee78 1575
f36dc67b 1576 if (worker_maybe_bind_and_lock(worker->pool))
eab6d828 1577 worker_clr_flags(worker, WORKER_UNBOUND);
e22bee78 1578
d565ed63 1579 spin_unlock_irq(&worker->pool->lock);
e22bee78
TH
1580}
1581
25511a47 1582/**
94cf58bb
TH
1583 * rebind_workers - rebind all workers of a pool to the associated CPU
1584 * @pool: pool of interest
25511a47 1585 *
94cf58bb 1586 * @pool->cpu is coming online. Rebind all workers to the CPU. Rebinding
25511a47
TH
1587 * is different for idle and busy ones.
1588 *
ea1abd61
LJ
1589 * Idle ones will be removed from the idle_list and woken up. They will
1590 * add themselves back after completing rebind. This ensures that the
1591 * idle_list doesn't contain any unbound workers when re-bound busy workers
1592 * try to perform local wake-ups for concurrency management.
25511a47 1593 *
ea1abd61
LJ
1594 * Busy workers can rebind after they finish their current work items.
1595 * Queueing the rebind work item at the head of the scheduled list is
1596 * enough. Note that nr_running will be properly bumped as busy workers
1597 * rebind.
25511a47 1598 *
ea1abd61
LJ
1599 * On return, all non-manager workers are scheduled for rebind - see
1600 * manage_workers() for the manager special case. Any idle worker
1601 * including the manager will not appear on @idle_list until rebind is
1602 * complete, making local wake-ups safe.
25511a47 1603 */
94cf58bb 1604static void rebind_workers(struct worker_pool *pool)
25511a47 1605{
ea1abd61 1606 struct worker *worker, *n;
25511a47
TH
1607 int i;
1608
94cf58bb
TH
1609 lockdep_assert_held(&pool->assoc_mutex);
1610 lockdep_assert_held(&pool->lock);
25511a47 1611
5f7dabfd 1612 /* dequeue and kick idle ones */
94cf58bb
TH
1613 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1614 /*
1615 * idle workers should be off @pool->idle_list until rebind
1616 * is complete to avoid receiving premature local wake-ups.
1617 */
1618 list_del_init(&worker->entry);
25511a47 1619
94cf58bb
TH
1620 /*
1621 * worker_thread() will see the above dequeuing and call
1622 * idle_worker_rebind().
1623 */
1624 wake_up_process(worker->task);
1625 }
25511a47 1626
94cf58bb 1627 /* rebind busy workers */
b67bfe0d 1628 for_each_busy_worker(worker, i, pool) {
94cf58bb
TH
1629 struct work_struct *rebind_work = &worker->rebind_work;
1630 struct workqueue_struct *wq;
25511a47 1631
94cf58bb
TH
1632 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1633 work_data_bits(rebind_work)))
1634 continue;
25511a47 1635
94cf58bb 1636 debug_work_activate(rebind_work);
90beca5d 1637
94cf58bb
TH
1638 /*
1639 * wq doesn't really matter but let's keep @worker->pool
112202d9 1640 * and @pwq->pool consistent for sanity.
94cf58bb 1641 */
7a4e344c 1642 if (worker->pool->attrs->nice < 0)
94cf58bb
TH
1643 wq = system_highpri_wq;
1644 else
1645 wq = system_wq;
1646
7fb98ea7 1647 insert_work(per_cpu_ptr(wq->cpu_pwqs, pool->cpu), rebind_work,
94cf58bb
TH
1648 worker->scheduled.next,
1649 work_color_to_flags(WORK_NO_COLOR));
ec58815a 1650 }
25511a47
TH
1651}
1652
c34056a3
TH
1653static struct worker *alloc_worker(void)
1654{
1655 struct worker *worker;
1656
1657 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
c8e55f36
TH
1658 if (worker) {
1659 INIT_LIST_HEAD(&worker->entry);
affee4b2 1660 INIT_LIST_HEAD(&worker->scheduled);
25511a47 1661 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
e22bee78
TH
1662 /* on creation a worker is in !idle && prep state */
1663 worker->flags = WORKER_PREP;
c8e55f36 1664 }
c34056a3
TH
1665 return worker;
1666}
1667
1668/**
1669 * create_worker - create a new workqueue worker
63d95a91 1670 * @pool: pool the new worker will belong to
c34056a3 1671 *
63d95a91 1672 * Create a new worker which is bound to @pool. The returned worker
c34056a3
TH
1673 * can be started by calling start_worker() or destroyed using
1674 * destroy_worker().
1675 *
1676 * CONTEXT:
1677 * Might sleep. Does GFP_KERNEL allocations.
1678 *
1679 * RETURNS:
1680 * Pointer to the newly created worker.
1681 */
bc2ae0f5 1682static struct worker *create_worker(struct worker_pool *pool)
c34056a3 1683{
7a4e344c 1684 const char *pri = pool->attrs->nice < 0 ? "H" : "";
c34056a3 1685 struct worker *worker = NULL;
f3421797 1686 int id = -1;
c34056a3 1687
d565ed63 1688 spin_lock_irq(&pool->lock);
bd7bdd43 1689 while (ida_get_new(&pool->worker_ida, &id)) {
d565ed63 1690 spin_unlock_irq(&pool->lock);
bd7bdd43 1691 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
c34056a3 1692 goto fail;
d565ed63 1693 spin_lock_irq(&pool->lock);
c34056a3 1694 }
d565ed63 1695 spin_unlock_irq(&pool->lock);
c34056a3
TH
1696
1697 worker = alloc_worker();
1698 if (!worker)
1699 goto fail;
1700
bd7bdd43 1701 worker->pool = pool;
c34056a3
TH
1702 worker->id = id;
1703
29c91e99 1704 if (pool->cpu >= 0)
94dcf29a 1705 worker->task = kthread_create_on_node(worker_thread,
ec22ca5e 1706 worker, cpu_to_node(pool->cpu),
d84ff051 1707 "kworker/%d:%d%s", pool->cpu, id, pri);
f3421797
TH
1708 else
1709 worker->task = kthread_create(worker_thread, worker,
ac6104cd
TH
1710 "kworker/u%d:%d%s",
1711 pool->id, id, pri);
c34056a3
TH
1712 if (IS_ERR(worker->task))
1713 goto fail;
1714
7a4e344c
TH
1715 set_user_nice(worker->task, pool->attrs->nice);
1716 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
3270476a 1717
db7bccf4 1718 /*
7a4e344c
TH
1719 * %PF_THREAD_BOUND is used to prevent userland from meddling with
1720 * cpumask of workqueue workers. This is an abuse. We need
1721 * %PF_NO_SETAFFINITY.
db7bccf4 1722 */
7a4e344c
TH
1723 worker->task->flags |= PF_THREAD_BOUND;
1724
1725 /*
1726 * The caller is responsible for ensuring %POOL_DISASSOCIATED
1727 * remains stable across this function. See the comments above the
1728 * flag definition for details.
1729 */
1730 if (pool->flags & POOL_DISASSOCIATED)
bc2ae0f5 1731 worker->flags |= WORKER_UNBOUND;
c34056a3
TH
1732
1733 return worker;
1734fail:
1735 if (id >= 0) {
d565ed63 1736 spin_lock_irq(&pool->lock);
bd7bdd43 1737 ida_remove(&pool->worker_ida, id);
d565ed63 1738 spin_unlock_irq(&pool->lock);
c34056a3
TH
1739 }
1740 kfree(worker);
1741 return NULL;
1742}
1743
1744/**
1745 * start_worker - start a newly created worker
1746 * @worker: worker to start
1747 *
706026c2 1748 * Make the pool aware of @worker and start it.
c34056a3
TH
1749 *
1750 * CONTEXT:
d565ed63 1751 * spin_lock_irq(pool->lock).
c34056a3
TH
1752 */
1753static void start_worker(struct worker *worker)
1754{
cb444766 1755 worker->flags |= WORKER_STARTED;
bd7bdd43 1756 worker->pool->nr_workers++;
c8e55f36 1757 worker_enter_idle(worker);
c34056a3
TH
1758 wake_up_process(worker->task);
1759}
1760
1761/**
1762 * destroy_worker - destroy a workqueue worker
1763 * @worker: worker to be destroyed
1764 *
706026c2 1765 * Destroy @worker and adjust @pool stats accordingly.
c8e55f36
TH
1766 *
1767 * CONTEXT:
d565ed63 1768 * spin_lock_irq(pool->lock) which is released and regrabbed.
c34056a3
TH
1769 */
1770static void destroy_worker(struct worker *worker)
1771{
bd7bdd43 1772 struct worker_pool *pool = worker->pool;
c34056a3
TH
1773 int id = worker->id;
1774
1775 /* sanity check frenzy */
6183c009
TH
1776 if (WARN_ON(worker->current_work) ||
1777 WARN_ON(!list_empty(&worker->scheduled)))
1778 return;
c34056a3 1779
c8e55f36 1780 if (worker->flags & WORKER_STARTED)
bd7bdd43 1781 pool->nr_workers--;
c8e55f36 1782 if (worker->flags & WORKER_IDLE)
bd7bdd43 1783 pool->nr_idle--;
c8e55f36
TH
1784
1785 list_del_init(&worker->entry);
cb444766 1786 worker->flags |= WORKER_DIE;
c8e55f36 1787
d565ed63 1788 spin_unlock_irq(&pool->lock);
c8e55f36 1789
c34056a3
TH
1790 kthread_stop(worker->task);
1791 kfree(worker);
1792
d565ed63 1793 spin_lock_irq(&pool->lock);
bd7bdd43 1794 ida_remove(&pool->worker_ida, id);
c34056a3
TH
1795}
1796
63d95a91 1797static void idle_worker_timeout(unsigned long __pool)
e22bee78 1798{
63d95a91 1799 struct worker_pool *pool = (void *)__pool;
e22bee78 1800
d565ed63 1801 spin_lock_irq(&pool->lock);
e22bee78 1802
63d95a91 1803 if (too_many_workers(pool)) {
e22bee78
TH
1804 struct worker *worker;
1805 unsigned long expires;
1806
1807 /* idle_list is kept in LIFO order, check the last one */
63d95a91 1808 worker = list_entry(pool->idle_list.prev, struct worker, entry);
e22bee78
TH
1809 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1810
1811 if (time_before(jiffies, expires))
63d95a91 1812 mod_timer(&pool->idle_timer, expires);
e22bee78
TH
1813 else {
1814 /* it's been idle for too long, wake up manager */
11ebea50 1815 pool->flags |= POOL_MANAGE_WORKERS;
63d95a91 1816 wake_up_worker(pool);
d5abe669 1817 }
e22bee78
TH
1818 }
1819
d565ed63 1820 spin_unlock_irq(&pool->lock);
e22bee78 1821}
d5abe669 1822
493a1724 1823static void send_mayday(struct work_struct *work)
e22bee78 1824{
112202d9
TH
1825 struct pool_workqueue *pwq = get_work_pwq(work);
1826 struct workqueue_struct *wq = pwq->wq;
493a1724
TH
1827
1828 lockdep_assert_held(&workqueue_lock);
e22bee78 1829
493008a8 1830 if (!wq->rescuer)
493a1724 1831 return;
e22bee78
TH
1832
1833 /* mayday mayday mayday */
493a1724
TH
1834 if (list_empty(&pwq->mayday_node)) {
1835 list_add_tail(&pwq->mayday_node, &wq->maydays);
e22bee78 1836 wake_up_process(wq->rescuer->task);
493a1724 1837 }
e22bee78
TH
1838}
1839
706026c2 1840static void pool_mayday_timeout(unsigned long __pool)
e22bee78 1841{
63d95a91 1842 struct worker_pool *pool = (void *)__pool;
e22bee78
TH
1843 struct work_struct *work;
1844
493a1724
TH
1845 spin_lock_irq(&workqueue_lock); /* for wq->maydays */
1846 spin_lock(&pool->lock);
e22bee78 1847
63d95a91 1848 if (need_to_create_worker(pool)) {
e22bee78
TH
1849 /*
1850 * We've been trying to create a new worker but
1851 * haven't been successful. We might be hitting an
1852 * allocation deadlock. Send distress signals to
1853 * rescuers.
1854 */
63d95a91 1855 list_for_each_entry(work, &pool->worklist, entry)
e22bee78 1856 send_mayday(work);
1da177e4 1857 }
e22bee78 1858
493a1724
TH
1859 spin_unlock(&pool->lock);
1860 spin_unlock_irq(&workqueue_lock);
e22bee78 1861
63d95a91 1862 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1da177e4
LT
1863}
1864
e22bee78
TH
1865/**
1866 * maybe_create_worker - create a new worker if necessary
63d95a91 1867 * @pool: pool to create a new worker for
e22bee78 1868 *
63d95a91 1869 * Create a new worker for @pool if necessary. @pool is guaranteed to
e22bee78
TH
1870 * have at least one idle worker on return from this function. If
1871 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
63d95a91 1872 * sent to all rescuers with works scheduled on @pool to resolve
e22bee78
TH
1873 * possible allocation deadlock.
1874 *
1875 * On return, need_to_create_worker() is guaranteed to be false and
1876 * may_start_working() true.
1877 *
1878 * LOCKING:
d565ed63 1879 * spin_lock_irq(pool->lock) which may be released and regrabbed
e22bee78
TH
1880 * multiple times. Does GFP_KERNEL allocations. Called only from
1881 * manager.
1882 *
1883 * RETURNS:
d565ed63 1884 * false if no action was taken and pool->lock stayed locked, true
e22bee78
TH
1885 * otherwise.
1886 */
63d95a91 1887static bool maybe_create_worker(struct worker_pool *pool)
d565ed63
TH
1888__releases(&pool->lock)
1889__acquires(&pool->lock)
1da177e4 1890{
63d95a91 1891 if (!need_to_create_worker(pool))
e22bee78
TH
1892 return false;
1893restart:
d565ed63 1894 spin_unlock_irq(&pool->lock);
9f9c2364 1895
e22bee78 1896 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
63d95a91 1897 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
e22bee78
TH
1898
1899 while (true) {
1900 struct worker *worker;
1901
bc2ae0f5 1902 worker = create_worker(pool);
e22bee78 1903 if (worker) {
63d95a91 1904 del_timer_sync(&pool->mayday_timer);
d565ed63 1905 spin_lock_irq(&pool->lock);
e22bee78 1906 start_worker(worker);
6183c009
TH
1907 if (WARN_ON_ONCE(need_to_create_worker(pool)))
1908 goto restart;
e22bee78
TH
1909 return true;
1910 }
1911
63d95a91 1912 if (!need_to_create_worker(pool))
e22bee78 1913 break;
1da177e4 1914
e22bee78
TH
1915 __set_current_state(TASK_INTERRUPTIBLE);
1916 schedule_timeout(CREATE_COOLDOWN);
9f9c2364 1917
63d95a91 1918 if (!need_to_create_worker(pool))
e22bee78
TH
1919 break;
1920 }
1921
63d95a91 1922 del_timer_sync(&pool->mayday_timer);
d565ed63 1923 spin_lock_irq(&pool->lock);
63d95a91 1924 if (need_to_create_worker(pool))
e22bee78
TH
1925 goto restart;
1926 return true;
1927}
1928
1929/**
1930 * maybe_destroy_worker - destroy workers which have been idle for a while
63d95a91 1931 * @pool: pool to destroy workers for
e22bee78 1932 *
63d95a91 1933 * Destroy @pool workers which have been idle for longer than
e22bee78
TH
1934 * IDLE_WORKER_TIMEOUT.
1935 *
1936 * LOCKING:
d565ed63 1937 * spin_lock_irq(pool->lock) which may be released and regrabbed
e22bee78
TH
1938 * multiple times. Called only from manager.
1939 *
1940 * RETURNS:
d565ed63 1941 * false if no action was taken and pool->lock stayed locked, true
e22bee78
TH
1942 * otherwise.
1943 */
63d95a91 1944static bool maybe_destroy_workers(struct worker_pool *pool)
e22bee78
TH
1945{
1946 bool ret = false;
1da177e4 1947
63d95a91 1948 while (too_many_workers(pool)) {
e22bee78
TH
1949 struct worker *worker;
1950 unsigned long expires;
3af24433 1951
63d95a91 1952 worker = list_entry(pool->idle_list.prev, struct worker, entry);
e22bee78 1953 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
85f4186a 1954
e22bee78 1955 if (time_before(jiffies, expires)) {
63d95a91 1956 mod_timer(&pool->idle_timer, expires);
3af24433 1957 break;
e22bee78 1958 }
1da177e4 1959
e22bee78
TH
1960 destroy_worker(worker);
1961 ret = true;
1da177e4 1962 }
1e19ffc6 1963
e22bee78 1964 return ret;
1e19ffc6
TH
1965}
1966
73f53c4a 1967/**
e22bee78
TH
1968 * manage_workers - manage worker pool
1969 * @worker: self
73f53c4a 1970 *
706026c2 1971 * Assume the manager role and manage the worker pool @worker belongs
e22bee78 1972 * to. At any given time, there can be only zero or one manager per
706026c2 1973 * pool. The exclusion is handled automatically by this function.
e22bee78
TH
1974 *
1975 * The caller can safely start processing works on false return. On
1976 * true return, it's guaranteed that need_to_create_worker() is false
1977 * and may_start_working() is true.
73f53c4a
TH
1978 *
1979 * CONTEXT:
d565ed63 1980 * spin_lock_irq(pool->lock) which may be released and regrabbed
e22bee78
TH
1981 * multiple times. Does GFP_KERNEL allocations.
1982 *
1983 * RETURNS:
d565ed63
TH
1984 * spin_lock_irq(pool->lock) which may be released and regrabbed
1985 * multiple times. Does GFP_KERNEL allocations.
73f53c4a 1986 */
e22bee78 1987static bool manage_workers(struct worker *worker)
73f53c4a 1988{
63d95a91 1989 struct worker_pool *pool = worker->pool;
e22bee78 1990 bool ret = false;
73f53c4a 1991
34a06bd6 1992 if (!mutex_trylock(&pool->manager_arb))
e22bee78 1993 return ret;
1e19ffc6 1994
ee378aa4
LJ
1995 /*
1996 * To simplify both worker management and CPU hotplug, hold off
1997 * management while hotplug is in progress. CPU hotplug path can't
34a06bd6
TH
1998 * grab @pool->manager_arb to achieve this because that can lead to
1999 * idle worker depletion (all become busy thinking someone else is
2000 * managing) which in turn can result in deadlock under extreme
2001 * circumstances. Use @pool->assoc_mutex to synchronize manager
2002 * against CPU hotplug.
ee378aa4 2003 *
b2eb83d1 2004 * assoc_mutex would always be free unless CPU hotplug is in
d565ed63 2005 * progress. trylock first without dropping @pool->lock.
ee378aa4 2006 */
b2eb83d1 2007 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
d565ed63 2008 spin_unlock_irq(&pool->lock);
b2eb83d1 2009 mutex_lock(&pool->assoc_mutex);
ee378aa4
LJ
2010 /*
2011 * CPU hotplug could have happened while we were waiting
b2eb83d1 2012 * for assoc_mutex. Hotplug itself can't handle us
ee378aa4 2013 * because manager isn't either on idle or busy list, and
706026c2 2014 * @pool's state and ours could have deviated.
ee378aa4 2015 *
b2eb83d1 2016 * As hotplug is now excluded via assoc_mutex, we can
ee378aa4 2017 * simply try to bind. It will succeed or fail depending
706026c2 2018 * on @pool's current state. Try it and adjust
ee378aa4
LJ
2019 * %WORKER_UNBOUND accordingly.
2020 */
f36dc67b 2021 if (worker_maybe_bind_and_lock(pool))
ee378aa4
LJ
2022 worker->flags &= ~WORKER_UNBOUND;
2023 else
2024 worker->flags |= WORKER_UNBOUND;
73f53c4a 2025
ee378aa4
LJ
2026 ret = true;
2027 }
73f53c4a 2028
11ebea50 2029 pool->flags &= ~POOL_MANAGE_WORKERS;
73f53c4a
TH
2030
2031 /*
e22bee78
TH
2032 * Destroy and then create so that may_start_working() is true
2033 * on return.
73f53c4a 2034 */
63d95a91
TH
2035 ret |= maybe_destroy_workers(pool);
2036 ret |= maybe_create_worker(pool);
e22bee78 2037
b2eb83d1 2038 mutex_unlock(&pool->assoc_mutex);
34a06bd6 2039 mutex_unlock(&pool->manager_arb);
e22bee78 2040 return ret;
73f53c4a
TH
2041}
2042
a62428c0
TH
2043/**
2044 * process_one_work - process single work
c34056a3 2045 * @worker: self
a62428c0
TH
2046 * @work: work to process
2047 *
2048 * Process @work. This function contains all the logics necessary to
2049 * process a single work including synchronization against and
2050 * interaction with other workers on the same cpu, queueing and
2051 * flushing. As long as context requirement is met, any worker can
2052 * call this function to process a work.
2053 *
2054 * CONTEXT:
d565ed63 2055 * spin_lock_irq(pool->lock) which is released and regrabbed.
a62428c0 2056 */
c34056a3 2057static void process_one_work(struct worker *worker, struct work_struct *work)
d565ed63
TH
2058__releases(&pool->lock)
2059__acquires(&pool->lock)
a62428c0 2060{
112202d9 2061 struct pool_workqueue *pwq = get_work_pwq(work);
bd7bdd43 2062 struct worker_pool *pool = worker->pool;
112202d9 2063 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
73f53c4a 2064 int work_color;
7e11629d 2065 struct worker *collision;
a62428c0
TH
2066#ifdef CONFIG_LOCKDEP
2067 /*
2068 * It is permissible to free the struct work_struct from
2069 * inside the function that is called from it, this we need to
2070 * take into account for lockdep too. To avoid bogus "held
2071 * lock freed" warnings as well as problems when looking into
2072 * work->lockdep_map, make a copy and use that here.
2073 */
4d82a1de
PZ
2074 struct lockdep_map lockdep_map;
2075
2076 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
a62428c0 2077#endif
6fec10a1
TH
2078 /*
2079 * Ensure we're on the correct CPU. DISASSOCIATED test is
2080 * necessary to avoid spurious warnings from rescuers servicing the
24647570 2081 * unbound or a disassociated pool.
6fec10a1 2082 */
5f7dabfd 2083 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
24647570 2084 !(pool->flags & POOL_DISASSOCIATED) &&
ec22ca5e 2085 raw_smp_processor_id() != pool->cpu);
25511a47 2086
7e11629d
TH
2087 /*
2088 * A single work shouldn't be executed concurrently by
2089 * multiple workers on a single cpu. Check whether anyone is
2090 * already processing the work. If so, defer the work to the
2091 * currently executing one.
2092 */
c9e7cf27 2093 collision = find_worker_executing_work(pool, work);
7e11629d
TH
2094 if (unlikely(collision)) {
2095 move_linked_works(work, &collision->scheduled, NULL);
2096 return;
2097 }
2098
8930caba 2099 /* claim and dequeue */
a62428c0 2100 debug_work_deactivate(work);
c9e7cf27 2101 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
c34056a3 2102 worker->current_work = work;
a2c1c57b 2103 worker->current_func = work->func;
112202d9 2104 worker->current_pwq = pwq;
73f53c4a 2105 work_color = get_work_color(work);
7a22ad75 2106
a62428c0
TH
2107 list_del_init(&work->entry);
2108
fb0e7beb
TH
2109 /*
2110 * CPU intensive works don't participate in concurrency
2111 * management. They're the scheduler's responsibility.
2112 */
2113 if (unlikely(cpu_intensive))
2114 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2115
974271c4 2116 /*
d565ed63 2117 * Unbound pool isn't concurrency managed and work items should be
974271c4
TH
2118 * executed ASAP. Wake up another worker if necessary.
2119 */
63d95a91
TH
2120 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2121 wake_up_worker(pool);
974271c4 2122
8930caba 2123 /*
7c3eed5c 2124 * Record the last pool and clear PENDING which should be the last
d565ed63 2125 * update to @work. Also, do this inside @pool->lock so that
23657bb1
TH
2126 * PENDING and queued state changes happen together while IRQ is
2127 * disabled.
8930caba 2128 */
7c3eed5c 2129 set_work_pool_and_clear_pending(work, pool->id);
a62428c0 2130
d565ed63 2131 spin_unlock_irq(&pool->lock);
a62428c0 2132
112202d9 2133 lock_map_acquire_read(&pwq->wq->lockdep_map);
a62428c0 2134 lock_map_acquire(&lockdep_map);
e36c886a 2135 trace_workqueue_execute_start(work);
a2c1c57b 2136 worker->current_func(work);
e36c886a
AV
2137 /*
2138 * While we must be careful to not use "work" after this, the trace
2139 * point will only record its address.
2140 */
2141 trace_workqueue_execute_end(work);
a62428c0 2142 lock_map_release(&lockdep_map);
112202d9 2143 lock_map_release(&pwq->wq->lockdep_map);
a62428c0
TH
2144
2145 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
044c782c
VI
2146 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2147 " last function: %pf\n",
a2c1c57b
TH
2148 current->comm, preempt_count(), task_pid_nr(current),
2149 worker->current_func);
a62428c0
TH
2150 debug_show_held_locks(current);
2151 dump_stack();
2152 }
2153
d565ed63 2154 spin_lock_irq(&pool->lock);
a62428c0 2155
fb0e7beb
TH
2156 /* clear cpu intensive status */
2157 if (unlikely(cpu_intensive))
2158 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2159
a62428c0 2160 /* we're done with it, release */
42f8570f 2161 hash_del(&worker->hentry);
c34056a3 2162 worker->current_work = NULL;
a2c1c57b 2163 worker->current_func = NULL;
112202d9
TH
2164 worker->current_pwq = NULL;
2165 pwq_dec_nr_in_flight(pwq, work_color);
a62428c0
TH
2166}
2167
affee4b2
TH
2168/**
2169 * process_scheduled_works - process scheduled works
2170 * @worker: self
2171 *
2172 * Process all scheduled works. Please note that the scheduled list
2173 * may change while processing a work, so this function repeatedly
2174 * fetches a work from the top and executes it.
2175 *
2176 * CONTEXT:
d565ed63 2177 * spin_lock_irq(pool->lock) which may be released and regrabbed
affee4b2
TH
2178 * multiple times.
2179 */
2180static void process_scheduled_works(struct worker *worker)
1da177e4 2181{
affee4b2
TH
2182 while (!list_empty(&worker->scheduled)) {
2183 struct work_struct *work = list_first_entry(&worker->scheduled,
1da177e4 2184 struct work_struct, entry);
c34056a3 2185 process_one_work(worker, work);
1da177e4 2186 }
1da177e4
LT
2187}
2188
4690c4ab
TH
2189/**
2190 * worker_thread - the worker thread function
c34056a3 2191 * @__worker: self
4690c4ab 2192 *
706026c2
TH
2193 * The worker thread function. There are NR_CPU_WORKER_POOLS dynamic pools
2194 * of these per each cpu. These workers process all works regardless of
e22bee78
TH
2195 * their specific target workqueue. The only exception is works which
2196 * belong to workqueues with a rescuer which will be explained in
2197 * rescuer_thread().
4690c4ab 2198 */
c34056a3 2199static int worker_thread(void *__worker)
1da177e4 2200{
c34056a3 2201 struct worker *worker = __worker;
bd7bdd43 2202 struct worker_pool *pool = worker->pool;
1da177e4 2203
e22bee78
TH
2204 /* tell the scheduler that this is a workqueue worker */
2205 worker->task->flags |= PF_WQ_WORKER;
c8e55f36 2206woke_up:
d565ed63 2207 spin_lock_irq(&pool->lock);
1da177e4 2208
5f7dabfd
LJ
2209 /* we are off idle list if destruction or rebind is requested */
2210 if (unlikely(list_empty(&worker->entry))) {
d565ed63 2211 spin_unlock_irq(&pool->lock);
25511a47 2212
5f7dabfd 2213 /* if DIE is set, destruction is requested */
25511a47
TH
2214 if (worker->flags & WORKER_DIE) {
2215 worker->task->flags &= ~PF_WQ_WORKER;
2216 return 0;
2217 }
2218
5f7dabfd 2219 /* otherwise, rebind */
25511a47
TH
2220 idle_worker_rebind(worker);
2221 goto woke_up;
c8e55f36 2222 }
affee4b2 2223
c8e55f36 2224 worker_leave_idle(worker);
db7bccf4 2225recheck:
e22bee78 2226 /* no more worker necessary? */
63d95a91 2227 if (!need_more_worker(pool))
e22bee78
TH
2228 goto sleep;
2229
2230 /* do we need to manage? */
63d95a91 2231 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
e22bee78
TH
2232 goto recheck;
2233
c8e55f36
TH
2234 /*
2235 * ->scheduled list can only be filled while a worker is
2236 * preparing to process a work or actually processing it.
2237 * Make sure nobody diddled with it while I was sleeping.
2238 */
6183c009 2239 WARN_ON_ONCE(!list_empty(&worker->scheduled));
c8e55f36 2240
e22bee78
TH
2241 /*
2242 * When control reaches this point, we're guaranteed to have
2243 * at least one idle worker or that someone else has already
2244 * assumed the manager role.
2245 */
2246 worker_clr_flags(worker, WORKER_PREP);
2247
2248 do {
c8e55f36 2249 struct work_struct *work =
bd7bdd43 2250 list_first_entry(&pool->worklist,
c8e55f36
TH
2251 struct work_struct, entry);
2252
2253 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2254 /* optimization path, not strictly necessary */
2255 process_one_work(worker, work);
2256 if (unlikely(!list_empty(&worker->scheduled)))
affee4b2 2257 process_scheduled_works(worker);
c8e55f36
TH
2258 } else {
2259 move_linked_works(work, &worker->scheduled, NULL);
2260 process_scheduled_works(worker);
affee4b2 2261 }
63d95a91 2262 } while (keep_working(pool));
e22bee78
TH
2263
2264 worker_set_flags(worker, WORKER_PREP, false);
d313dd85 2265sleep:
63d95a91 2266 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
e22bee78 2267 goto recheck;
d313dd85 2268
c8e55f36 2269 /*
d565ed63
TH
2270 * pool->lock is held and there's no work to process and no need to
2271 * manage, sleep. Workers are woken up only while holding
2272 * pool->lock or from local cpu, so setting the current state
2273 * before releasing pool->lock is enough to prevent losing any
2274 * event.
c8e55f36
TH
2275 */
2276 worker_enter_idle(worker);
2277 __set_current_state(TASK_INTERRUPTIBLE);
d565ed63 2278 spin_unlock_irq(&pool->lock);
c8e55f36
TH
2279 schedule();
2280 goto woke_up;
1da177e4
LT
2281}
2282
e22bee78
TH
2283/**
2284 * rescuer_thread - the rescuer thread function
111c225a 2285 * @__rescuer: self
e22bee78
TH
2286 *
2287 * Workqueue rescuer thread function. There's one rescuer for each
493008a8 2288 * workqueue which has WQ_MEM_RECLAIM set.
e22bee78 2289 *
706026c2 2290 * Regular work processing on a pool may block trying to create a new
e22bee78
TH
2291 * worker which uses GFP_KERNEL allocation which has slight chance of
2292 * developing into deadlock if some works currently on the same queue
2293 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2294 * the problem rescuer solves.
2295 *
706026c2
TH
2296 * When such condition is possible, the pool summons rescuers of all
2297 * workqueues which have works queued on the pool and let them process
e22bee78
TH
2298 * those works so that forward progress can be guaranteed.
2299 *
2300 * This should happen rarely.
2301 */
111c225a 2302static int rescuer_thread(void *__rescuer)
e22bee78 2303{
111c225a
TH
2304 struct worker *rescuer = __rescuer;
2305 struct workqueue_struct *wq = rescuer->rescue_wq;
e22bee78 2306 struct list_head *scheduled = &rescuer->scheduled;
e22bee78
TH
2307
2308 set_user_nice(current, RESCUER_NICE_LEVEL);
111c225a
TH
2309
2310 /*
2311 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2312 * doesn't participate in concurrency management.
2313 */
2314 rescuer->task->flags |= PF_WQ_WORKER;
e22bee78
TH
2315repeat:
2316 set_current_state(TASK_INTERRUPTIBLE);
2317
412d32e6
MG
2318 if (kthread_should_stop()) {
2319 __set_current_state(TASK_RUNNING);
111c225a 2320 rescuer->task->flags &= ~PF_WQ_WORKER;
e22bee78 2321 return 0;
412d32e6 2322 }
e22bee78 2323
493a1724
TH
2324 /* see whether any pwq is asking for help */
2325 spin_lock_irq(&workqueue_lock);
2326
2327 while (!list_empty(&wq->maydays)) {
2328 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2329 struct pool_workqueue, mayday_node);
112202d9 2330 struct worker_pool *pool = pwq->pool;
e22bee78
TH
2331 struct work_struct *work, *n;
2332
2333 __set_current_state(TASK_RUNNING);
493a1724
TH
2334 list_del_init(&pwq->mayday_node);
2335
2336 spin_unlock_irq(&workqueue_lock);
e22bee78
TH
2337
2338 /* migrate to the target cpu if possible */
f36dc67b 2339 worker_maybe_bind_and_lock(pool);
b3104104 2340 rescuer->pool = pool;
e22bee78
TH
2341
2342 /*
2343 * Slurp in all works issued via this workqueue and
2344 * process'em.
2345 */
6183c009 2346 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
bd7bdd43 2347 list_for_each_entry_safe(work, n, &pool->worklist, entry)
112202d9 2348 if (get_work_pwq(work) == pwq)
e22bee78
TH
2349 move_linked_works(work, scheduled, &n);
2350
2351 process_scheduled_works(rescuer);
7576958a
TH
2352
2353 /*
d565ed63 2354 * Leave this pool. If keep_working() is %true, notify a
7576958a
TH
2355 * regular worker; otherwise, we end up with 0 concurrency
2356 * and stalling the execution.
2357 */
63d95a91
TH
2358 if (keep_working(pool))
2359 wake_up_worker(pool);
7576958a 2360
b3104104 2361 rescuer->pool = NULL;
493a1724
TH
2362 spin_unlock(&pool->lock);
2363 spin_lock(&workqueue_lock);
e22bee78
TH
2364 }
2365
493a1724
TH
2366 spin_unlock_irq(&workqueue_lock);
2367
111c225a
TH
2368 /* rescuers should never participate in concurrency management */
2369 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
e22bee78
TH
2370 schedule();
2371 goto repeat;
1da177e4
LT
2372}
2373
fc2e4d70
ON
2374struct wq_barrier {
2375 struct work_struct work;
2376 struct completion done;
2377};
2378
2379static void wq_barrier_func(struct work_struct *work)
2380{
2381 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2382 complete(&barr->done);
2383}
2384
4690c4ab
TH
2385/**
2386 * insert_wq_barrier - insert a barrier work
112202d9 2387 * @pwq: pwq to insert barrier into
4690c4ab 2388 * @barr: wq_barrier to insert
affee4b2
TH
2389 * @target: target work to attach @barr to
2390 * @worker: worker currently executing @target, NULL if @target is not executing
4690c4ab 2391 *
affee4b2
TH
2392 * @barr is linked to @target such that @barr is completed only after
2393 * @target finishes execution. Please note that the ordering
2394 * guarantee is observed only with respect to @target and on the local
2395 * cpu.
2396 *
2397 * Currently, a queued barrier can't be canceled. This is because
2398 * try_to_grab_pending() can't determine whether the work to be
2399 * grabbed is at the head of the queue and thus can't clear LINKED
2400 * flag of the previous work while there must be a valid next work
2401 * after a work with LINKED flag set.
2402 *
2403 * Note that when @worker is non-NULL, @target may be modified
112202d9 2404 * underneath us, so we can't reliably determine pwq from @target.
4690c4ab
TH
2405 *
2406 * CONTEXT:
d565ed63 2407 * spin_lock_irq(pool->lock).
4690c4ab 2408 */
112202d9 2409static void insert_wq_barrier(struct pool_workqueue *pwq,
affee4b2
TH
2410 struct wq_barrier *barr,
2411 struct work_struct *target, struct worker *worker)
fc2e4d70 2412{
affee4b2
TH
2413 struct list_head *head;
2414 unsigned int linked = 0;
2415
dc186ad7 2416 /*
d565ed63 2417 * debugobject calls are safe here even with pool->lock locked
dc186ad7
TG
2418 * as we know for sure that this will not trigger any of the
2419 * checks and call back into the fixup functions where we
2420 * might deadlock.
2421 */
ca1cab37 2422 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
22df02bb 2423 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
fc2e4d70 2424 init_completion(&barr->done);
83c22520 2425
affee4b2
TH
2426 /*
2427 * If @target is currently being executed, schedule the
2428 * barrier to the worker; otherwise, put it after @target.
2429 */
2430 if (worker)
2431 head = worker->scheduled.next;
2432 else {
2433 unsigned long *bits = work_data_bits(target);
2434
2435 head = target->entry.next;
2436 /* there can already be other linked works, inherit and set */
2437 linked = *bits & WORK_STRUCT_LINKED;
2438 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2439 }
2440
dc186ad7 2441 debug_work_activate(&barr->work);
112202d9 2442 insert_work(pwq, &barr->work, head,
affee4b2 2443 work_color_to_flags(WORK_NO_COLOR) | linked);
fc2e4d70
ON
2444}
2445
73f53c4a 2446/**
112202d9 2447 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
73f53c4a
TH
2448 * @wq: workqueue being flushed
2449 * @flush_color: new flush color, < 0 for no-op
2450 * @work_color: new work color, < 0 for no-op
2451 *
112202d9 2452 * Prepare pwqs for workqueue flushing.
73f53c4a 2453 *
112202d9
TH
2454 * If @flush_color is non-negative, flush_color on all pwqs should be
2455 * -1. If no pwq has in-flight commands at the specified color, all
2456 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2457 * has in flight commands, its pwq->flush_color is set to
2458 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
73f53c4a
TH
2459 * wakeup logic is armed and %true is returned.
2460 *
2461 * The caller should have initialized @wq->first_flusher prior to
2462 * calling this function with non-negative @flush_color. If
2463 * @flush_color is negative, no flush color update is done and %false
2464 * is returned.
2465 *
112202d9 2466 * If @work_color is non-negative, all pwqs should have the same
73f53c4a
TH
2467 * work_color which is previous to @work_color and all will be
2468 * advanced to @work_color.
2469 *
2470 * CONTEXT:
2471 * mutex_lock(wq->flush_mutex).
2472 *
2473 * RETURNS:
2474 * %true if @flush_color >= 0 and there's something to flush. %false
2475 * otherwise.
2476 */
112202d9 2477static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
73f53c4a 2478 int flush_color, int work_color)
1da177e4 2479{
73f53c4a 2480 bool wait = false;
49e3cf44 2481 struct pool_workqueue *pwq;
1da177e4 2482
73f53c4a 2483 if (flush_color >= 0) {
6183c009 2484 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
112202d9 2485 atomic_set(&wq->nr_pwqs_to_flush, 1);
1da177e4 2486 }
2355b70f 2487
76af4d93
TH
2488 local_irq_disable();
2489
49e3cf44 2490 for_each_pwq(pwq, wq) {
112202d9 2491 struct worker_pool *pool = pwq->pool;
fc2e4d70 2492
76af4d93 2493 spin_lock(&pool->lock);
83c22520 2494
73f53c4a 2495 if (flush_color >= 0) {
6183c009 2496 WARN_ON_ONCE(pwq->flush_color != -1);
fc2e4d70 2497
112202d9
TH
2498 if (pwq->nr_in_flight[flush_color]) {
2499 pwq->flush_color = flush_color;
2500 atomic_inc(&wq->nr_pwqs_to_flush);
73f53c4a
TH
2501 wait = true;
2502 }
2503 }
1da177e4 2504
73f53c4a 2505 if (work_color >= 0) {
6183c009 2506 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
112202d9 2507 pwq->work_color = work_color;
73f53c4a 2508 }
1da177e4 2509
76af4d93 2510 spin_unlock(&pool->lock);
1da177e4 2511 }
2355b70f 2512
76af4d93
TH
2513 local_irq_enable();
2514
112202d9 2515 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
73f53c4a 2516 complete(&wq->first_flusher->done);
14441960 2517
73f53c4a 2518 return wait;
1da177e4
LT
2519}
2520
0fcb78c2 2521/**
1da177e4 2522 * flush_workqueue - ensure that any scheduled work has run to completion.
0fcb78c2 2523 * @wq: workqueue to flush
1da177e4
LT
2524 *
2525 * Forces execution of the workqueue and blocks until its completion.
2526 * This is typically used in driver shutdown handlers.
2527 *
fc2e4d70
ON
2528 * We sleep until all works which were queued on entry have been handled,
2529 * but we are not livelocked by new incoming ones.
1da177e4 2530 */
7ad5b3a5 2531void flush_workqueue(struct workqueue_struct *wq)
1da177e4 2532{
73f53c4a
TH
2533 struct wq_flusher this_flusher = {
2534 .list = LIST_HEAD_INIT(this_flusher.list),
2535 .flush_color = -1,
2536 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2537 };
2538 int next_color;
1da177e4 2539
3295f0ef
IM
2540 lock_map_acquire(&wq->lockdep_map);
2541 lock_map_release(&wq->lockdep_map);
73f53c4a
TH
2542
2543 mutex_lock(&wq->flush_mutex);
2544
2545 /*
2546 * Start-to-wait phase
2547 */
2548 next_color = work_next_color(wq->work_color);
2549
2550 if (next_color != wq->flush_color) {
2551 /*
2552 * Color space is not full. The current work_color
2553 * becomes our flush_color and work_color is advanced
2554 * by one.
2555 */
6183c009 2556 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
73f53c4a
TH
2557 this_flusher.flush_color = wq->work_color;
2558 wq->work_color = next_color;
2559
2560 if (!wq->first_flusher) {
2561 /* no flush in progress, become the first flusher */
6183c009 2562 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
73f53c4a
TH
2563
2564 wq->first_flusher = &this_flusher;
2565
112202d9 2566 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
73f53c4a
TH
2567 wq->work_color)) {
2568 /* nothing to flush, done */
2569 wq->flush_color = next_color;
2570 wq->first_flusher = NULL;
2571 goto out_unlock;
2572 }
2573 } else {
2574 /* wait in queue */
6183c009 2575 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
73f53c4a 2576 list_add_tail(&this_flusher.list, &wq->flusher_queue);
112202d9 2577 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
73f53c4a
TH
2578 }
2579 } else {
2580 /*
2581 * Oops, color space is full, wait on overflow queue.
2582 * The next flush completion will assign us
2583 * flush_color and transfer to flusher_queue.
2584 */
2585 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2586 }
2587
2588 mutex_unlock(&wq->flush_mutex);
2589
2590 wait_for_completion(&this_flusher.done);
2591
2592 /*
2593 * Wake-up-and-cascade phase
2594 *
2595 * First flushers are responsible for cascading flushes and
2596 * handling overflow. Non-first flushers can simply return.
2597 */
2598 if (wq->first_flusher != &this_flusher)
2599 return;
2600
2601 mutex_lock(&wq->flush_mutex);
2602
4ce48b37
TH
2603 /* we might have raced, check again with mutex held */
2604 if (wq->first_flusher != &this_flusher)
2605 goto out_unlock;
2606
73f53c4a
TH
2607 wq->first_flusher = NULL;
2608
6183c009
TH
2609 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2610 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
73f53c4a
TH
2611
2612 while (true) {
2613 struct wq_flusher *next, *tmp;
2614
2615 /* complete all the flushers sharing the current flush color */
2616 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2617 if (next->flush_color != wq->flush_color)
2618 break;
2619 list_del_init(&next->list);
2620 complete(&next->done);
2621 }
2622
6183c009
TH
2623 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2624 wq->flush_color != work_next_color(wq->work_color));
73f53c4a
TH
2625
2626 /* this flush_color is finished, advance by one */
2627 wq->flush_color = work_next_color(wq->flush_color);
2628
2629 /* one color has been freed, handle overflow queue */
2630 if (!list_empty(&wq->flusher_overflow)) {
2631 /*
2632 * Assign the same color to all overflowed
2633 * flushers, advance work_color and append to
2634 * flusher_queue. This is the start-to-wait
2635 * phase for these overflowed flushers.
2636 */
2637 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2638 tmp->flush_color = wq->work_color;
2639
2640 wq->work_color = work_next_color(wq->work_color);
2641
2642 list_splice_tail_init(&wq->flusher_overflow,
2643 &wq->flusher_queue);
112202d9 2644 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
73f53c4a
TH
2645 }
2646
2647 if (list_empty(&wq->flusher_queue)) {
6183c009 2648 WARN_ON_ONCE(wq->flush_color != wq->work_color);
73f53c4a
TH
2649 break;
2650 }
2651
2652 /*
2653 * Need to flush more colors. Make the next flusher
112202d9 2654 * the new first flusher and arm pwqs.
73f53c4a 2655 */
6183c009
TH
2656 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2657 WARN_ON_ONCE(wq->flush_color != next->flush_color);
73f53c4a
TH
2658
2659 list_del_init(&next->list);
2660 wq->first_flusher = next;
2661
112202d9 2662 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
73f53c4a
TH
2663 break;
2664
2665 /*
2666 * Meh... this color is already done, clear first
2667 * flusher and repeat cascading.
2668 */
2669 wq->first_flusher = NULL;
2670 }
2671
2672out_unlock:
2673 mutex_unlock(&wq->flush_mutex);
1da177e4 2674}
ae90dd5d 2675EXPORT_SYMBOL_GPL(flush_workqueue);
1da177e4 2676
9c5a2ba7
TH
2677/**
2678 * drain_workqueue - drain a workqueue
2679 * @wq: workqueue to drain
2680 *
2681 * Wait until the workqueue becomes empty. While draining is in progress,
2682 * only chain queueing is allowed. IOW, only currently pending or running
2683 * work items on @wq can queue further work items on it. @wq is flushed
2684 * repeatedly until it becomes empty. The number of flushing is detemined
2685 * by the depth of chaining and should be relatively short. Whine if it
2686 * takes too long.
2687 */
2688void drain_workqueue(struct workqueue_struct *wq)
2689{
2690 unsigned int flush_cnt = 0;
49e3cf44 2691 struct pool_workqueue *pwq;
9c5a2ba7
TH
2692
2693 /*
2694 * __queue_work() needs to test whether there are drainers, is much
2695 * hotter than drain_workqueue() and already looks at @wq->flags.
2696 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2697 */
e98d5b16 2698 spin_lock_irq(&workqueue_lock);
9c5a2ba7
TH
2699 if (!wq->nr_drainers++)
2700 wq->flags |= WQ_DRAINING;
e98d5b16 2701 spin_unlock_irq(&workqueue_lock);
9c5a2ba7
TH
2702reflush:
2703 flush_workqueue(wq);
2704
76af4d93
TH
2705 local_irq_disable();
2706
49e3cf44 2707 for_each_pwq(pwq, wq) {
fa2563e4 2708 bool drained;
9c5a2ba7 2709
76af4d93 2710 spin_lock(&pwq->pool->lock);
112202d9 2711 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
76af4d93 2712 spin_unlock(&pwq->pool->lock);
fa2563e4
TT
2713
2714 if (drained)
9c5a2ba7
TH
2715 continue;
2716
2717 if (++flush_cnt == 10 ||
2718 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
044c782c
VI
2719 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2720 wq->name, flush_cnt);
76af4d93
TH
2721
2722 local_irq_enable();
9c5a2ba7
TH
2723 goto reflush;
2724 }
2725
76af4d93 2726 spin_lock(&workqueue_lock);
9c5a2ba7
TH
2727 if (!--wq->nr_drainers)
2728 wq->flags &= ~WQ_DRAINING;
76af4d93
TH
2729 spin_unlock(&workqueue_lock);
2730
2731 local_irq_enable();
9c5a2ba7
TH
2732}
2733EXPORT_SYMBOL_GPL(drain_workqueue);
2734
606a5020 2735static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
db700897 2736{
affee4b2 2737 struct worker *worker = NULL;
c9e7cf27 2738 struct worker_pool *pool;
112202d9 2739 struct pool_workqueue *pwq;
db700897
ON
2740
2741 might_sleep();
fa1b54e6
TH
2742
2743 local_irq_disable();
c9e7cf27 2744 pool = get_work_pool(work);
fa1b54e6
TH
2745 if (!pool) {
2746 local_irq_enable();
baf59022 2747 return false;
fa1b54e6 2748 }
db700897 2749
fa1b54e6 2750 spin_lock(&pool->lock);
0b3dae68 2751 /* see the comment in try_to_grab_pending() with the same code */
112202d9
TH
2752 pwq = get_work_pwq(work);
2753 if (pwq) {
2754 if (unlikely(pwq->pool != pool))
4690c4ab 2755 goto already_gone;
606a5020 2756 } else {
c9e7cf27 2757 worker = find_worker_executing_work(pool, work);
affee4b2 2758 if (!worker)
4690c4ab 2759 goto already_gone;
112202d9 2760 pwq = worker->current_pwq;
606a5020 2761 }
db700897 2762
112202d9 2763 insert_wq_barrier(pwq, barr, work, worker);
d565ed63 2764 spin_unlock_irq(&pool->lock);
7a22ad75 2765
e159489b
TH
2766 /*
2767 * If @max_active is 1 or rescuer is in use, flushing another work
2768 * item on the same workqueue may lead to deadlock. Make sure the
2769 * flusher is not running on the same workqueue by verifying write
2770 * access.
2771 */
493008a8 2772 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
112202d9 2773 lock_map_acquire(&pwq->wq->lockdep_map);
e159489b 2774 else
112202d9
TH
2775 lock_map_acquire_read(&pwq->wq->lockdep_map);
2776 lock_map_release(&pwq->wq->lockdep_map);
e159489b 2777
401a8d04 2778 return true;
4690c4ab 2779already_gone:
d565ed63 2780 spin_unlock_irq(&pool->lock);
401a8d04 2781 return false;
db700897 2782}
baf59022
TH
2783
2784/**
2785 * flush_work - wait for a work to finish executing the last queueing instance
2786 * @work: the work to flush
2787 *
606a5020
TH
2788 * Wait until @work has finished execution. @work is guaranteed to be idle
2789 * on return if it hasn't been requeued since flush started.
baf59022
TH
2790 *
2791 * RETURNS:
2792 * %true if flush_work() waited for the work to finish execution,
2793 * %false if it was already idle.
2794 */
2795bool flush_work(struct work_struct *work)
2796{
2797 struct wq_barrier barr;
2798
0976dfc1
SB
2799 lock_map_acquire(&work->lockdep_map);
2800 lock_map_release(&work->lockdep_map);
2801
606a5020 2802 if (start_flush_work(work, &barr)) {
401a8d04
TH
2803 wait_for_completion(&barr.done);
2804 destroy_work_on_stack(&barr.work);
2805 return true;
606a5020 2806 } else {
401a8d04 2807 return false;
6e84d644 2808 }
6e84d644 2809}
606a5020 2810EXPORT_SYMBOL_GPL(flush_work);
6e84d644 2811
36e227d2 2812static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
1f1f642e 2813{
bbb68dfa 2814 unsigned long flags;
1f1f642e
ON
2815 int ret;
2816
2817 do {
bbb68dfa
TH
2818 ret = try_to_grab_pending(work, is_dwork, &flags);
2819 /*
2820 * If someone else is canceling, wait for the same event it
2821 * would be waiting for before retrying.
2822 */
2823 if (unlikely(ret == -ENOENT))
606a5020 2824 flush_work(work);
1f1f642e
ON
2825 } while (unlikely(ret < 0));
2826
bbb68dfa
TH
2827 /* tell other tasks trying to grab @work to back off */
2828 mark_work_canceling(work);
2829 local_irq_restore(flags);
2830
606a5020 2831 flush_work(work);
7a22ad75 2832 clear_work_data(work);
1f1f642e
ON
2833 return ret;
2834}
2835
6e84d644 2836/**
401a8d04
TH
2837 * cancel_work_sync - cancel a work and wait for it to finish
2838 * @work: the work to cancel
6e84d644 2839 *
401a8d04
TH
2840 * Cancel @work and wait for its execution to finish. This function
2841 * can be used even if the work re-queues itself or migrates to
2842 * another workqueue. On return from this function, @work is
2843 * guaranteed to be not pending or executing on any CPU.
1f1f642e 2844 *
401a8d04
TH
2845 * cancel_work_sync(&delayed_work->work) must not be used for
2846 * delayed_work's. Use cancel_delayed_work_sync() instead.
6e84d644 2847 *
401a8d04 2848 * The caller must ensure that the workqueue on which @work was last
6e84d644 2849 * queued can't be destroyed before this function returns.
401a8d04
TH
2850 *
2851 * RETURNS:
2852 * %true if @work was pending, %false otherwise.
6e84d644 2853 */
401a8d04 2854bool cancel_work_sync(struct work_struct *work)
6e84d644 2855{
36e227d2 2856 return __cancel_work_timer(work, false);
b89deed3 2857}
28e53bdd 2858EXPORT_SYMBOL_GPL(cancel_work_sync);
b89deed3 2859
6e84d644 2860/**
401a8d04
TH
2861 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2862 * @dwork: the delayed work to flush
6e84d644 2863 *
401a8d04
TH
2864 * Delayed timer is cancelled and the pending work is queued for
2865 * immediate execution. Like flush_work(), this function only
2866 * considers the last queueing instance of @dwork.
1f1f642e 2867 *
401a8d04
TH
2868 * RETURNS:
2869 * %true if flush_work() waited for the work to finish execution,
2870 * %false if it was already idle.
6e84d644 2871 */
401a8d04
TH
2872bool flush_delayed_work(struct delayed_work *dwork)
2873{
8930caba 2874 local_irq_disable();
401a8d04 2875 if (del_timer_sync(&dwork->timer))
60c057bc 2876 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
8930caba 2877 local_irq_enable();
401a8d04
TH
2878 return flush_work(&dwork->work);
2879}
2880EXPORT_SYMBOL(flush_delayed_work);
2881
09383498 2882/**
57b30ae7
TH
2883 * cancel_delayed_work - cancel a delayed work
2884 * @dwork: delayed_work to cancel
09383498 2885 *
57b30ae7
TH
2886 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2887 * and canceled; %false if wasn't pending. Note that the work callback
2888 * function may still be running on return, unless it returns %true and the
2889 * work doesn't re-arm itself. Explicitly flush or use
2890 * cancel_delayed_work_sync() to wait on it.
09383498 2891 *
57b30ae7 2892 * This function is safe to call from any context including IRQ handler.
09383498 2893 */
57b30ae7 2894bool cancel_delayed_work(struct delayed_work *dwork)
09383498 2895{
57b30ae7
TH
2896 unsigned long flags;
2897 int ret;
2898
2899 do {
2900 ret = try_to_grab_pending(&dwork->work, true, &flags);
2901 } while (unlikely(ret == -EAGAIN));
2902
2903 if (unlikely(ret < 0))
2904 return false;
2905
7c3eed5c
TH
2906 set_work_pool_and_clear_pending(&dwork->work,
2907 get_work_pool_id(&dwork->work));
57b30ae7 2908 local_irq_restore(flags);
c0158ca6 2909 return ret;
09383498 2910}
57b30ae7 2911EXPORT_SYMBOL(cancel_delayed_work);
09383498 2912
401a8d04
TH
2913/**
2914 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2915 * @dwork: the delayed work cancel
2916 *
2917 * This is cancel_work_sync() for delayed works.
2918 *
2919 * RETURNS:
2920 * %true if @dwork was pending, %false otherwise.
2921 */
2922bool cancel_delayed_work_sync(struct delayed_work *dwork)
6e84d644 2923{
36e227d2 2924 return __cancel_work_timer(&dwork->work, true);
6e84d644 2925}
f5a421a4 2926EXPORT_SYMBOL(cancel_delayed_work_sync);
1da177e4 2927
0fcb78c2 2928/**
c1a220e7
ZR
2929 * schedule_work_on - put work task on a specific cpu
2930 * @cpu: cpu to put the work task on
2931 * @work: job to be done
2932 *
2933 * This puts a job on a specific cpu
2934 */
d4283e93 2935bool schedule_work_on(int cpu, struct work_struct *work)
c1a220e7 2936{
d320c038 2937 return queue_work_on(cpu, system_wq, work);
c1a220e7
ZR
2938}
2939EXPORT_SYMBOL(schedule_work_on);
2940
0fcb78c2 2941/**
0fcb78c2
REB
2942 * schedule_work - put work task in global workqueue
2943 * @work: job to be done
0fcb78c2 2944 *
d4283e93
TH
2945 * Returns %false if @work was already on the kernel-global workqueue and
2946 * %true otherwise.
5b0f437d
BVA
2947 *
2948 * This puts a job in the kernel-global workqueue if it was not already
2949 * queued and leaves it in the same position on the kernel-global
2950 * workqueue otherwise.
0fcb78c2 2951 */
d4283e93 2952bool schedule_work(struct work_struct *work)
1da177e4 2953{
d320c038 2954 return queue_work(system_wq, work);
1da177e4 2955}
ae90dd5d 2956EXPORT_SYMBOL(schedule_work);
1da177e4 2957
0fcb78c2
REB
2958/**
2959 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2960 * @cpu: cpu to use
52bad64d 2961 * @dwork: job to be done
0fcb78c2
REB
2962 * @delay: number of jiffies to wait
2963 *
2964 * After waiting for a given time this puts a job in the kernel-global
2965 * workqueue on the specified CPU.
2966 */
d4283e93
TH
2967bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
2968 unsigned long delay)
1da177e4 2969{
d320c038 2970 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
1da177e4 2971}
ae90dd5d 2972EXPORT_SYMBOL(schedule_delayed_work_on);
1da177e4 2973
0fcb78c2
REB
2974/**
2975 * schedule_delayed_work - put work task in global workqueue after delay
52bad64d
DH
2976 * @dwork: job to be done
2977 * @delay: number of jiffies to wait or 0 for immediate execution
0fcb78c2
REB
2978 *
2979 * After waiting for a given time this puts a job in the kernel-global
2980 * workqueue.
2981 */
d4283e93 2982bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
1da177e4 2983{
d320c038 2984 return queue_delayed_work(system_wq, dwork, delay);
1da177e4 2985}
ae90dd5d 2986EXPORT_SYMBOL(schedule_delayed_work);
1da177e4 2987
b6136773 2988/**
31ddd871 2989 * schedule_on_each_cpu - execute a function synchronously on each online CPU
b6136773 2990 * @func: the function to call
b6136773 2991 *
31ddd871
TH
2992 * schedule_on_each_cpu() executes @func on each online CPU using the
2993 * system workqueue and blocks until all CPUs have completed.
b6136773 2994 * schedule_on_each_cpu() is very slow.
31ddd871
TH
2995 *
2996 * RETURNS:
2997 * 0 on success, -errno on failure.
b6136773 2998 */
65f27f38 2999int schedule_on_each_cpu(work_func_t func)
15316ba8
CL
3000{
3001 int cpu;
38f51568 3002 struct work_struct __percpu *works;
15316ba8 3003
b6136773
AM
3004 works = alloc_percpu(struct work_struct);
3005 if (!works)
15316ba8 3006 return -ENOMEM;
b6136773 3007
93981800
TH
3008 get_online_cpus();
3009
15316ba8 3010 for_each_online_cpu(cpu) {
9bfb1839
IM
3011 struct work_struct *work = per_cpu_ptr(works, cpu);
3012
3013 INIT_WORK(work, func);
b71ab8c2 3014 schedule_work_on(cpu, work);
65a64464 3015 }
93981800
TH
3016
3017 for_each_online_cpu(cpu)
3018 flush_work(per_cpu_ptr(works, cpu));
3019
95402b38 3020 put_online_cpus();
b6136773 3021 free_percpu(works);
15316ba8
CL
3022 return 0;
3023}
3024
eef6a7d5
AS
3025/**
3026 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3027 *
3028 * Forces execution of the kernel-global workqueue and blocks until its
3029 * completion.
3030 *
3031 * Think twice before calling this function! It's very easy to get into
3032 * trouble if you don't take great care. Either of the following situations
3033 * will lead to deadlock:
3034 *
3035 * One of the work items currently on the workqueue needs to acquire
3036 * a lock held by your code or its caller.
3037 *
3038 * Your code is running in the context of a work routine.
3039 *
3040 * They will be detected by lockdep when they occur, but the first might not
3041 * occur very often. It depends on what work items are on the workqueue and
3042 * what locks they need, which you have no control over.
3043 *
3044 * In most situations flushing the entire workqueue is overkill; you merely
3045 * need to know that a particular work item isn't queued and isn't running.
3046 * In such cases you should use cancel_delayed_work_sync() or
3047 * cancel_work_sync() instead.
3048 */
1da177e4
LT
3049void flush_scheduled_work(void)
3050{
d320c038 3051 flush_workqueue(system_wq);
1da177e4 3052}
ae90dd5d 3053EXPORT_SYMBOL(flush_scheduled_work);
1da177e4 3054
1fa44eca
JB
3055/**
3056 * execute_in_process_context - reliably execute the routine with user context
3057 * @fn: the function to execute
1fa44eca
JB
3058 * @ew: guaranteed storage for the execute work structure (must
3059 * be available when the work executes)
3060 *
3061 * Executes the function immediately if process context is available,
3062 * otherwise schedules the function for delayed execution.
3063 *
3064 * Returns: 0 - function was executed
3065 * 1 - function was scheduled for execution
3066 */
65f27f38 3067int execute_in_process_context(work_func_t fn, struct execute_work *ew)
1fa44eca
JB
3068{
3069 if (!in_interrupt()) {
65f27f38 3070 fn(&ew->work);
1fa44eca
JB
3071 return 0;
3072 }
3073
65f27f38 3074 INIT_WORK(&ew->work, fn);
1fa44eca
JB
3075 schedule_work(&ew->work);
3076
3077 return 1;
3078}
3079EXPORT_SYMBOL_GPL(execute_in_process_context);
3080
1da177e4
LT
3081int keventd_up(void)
3082{
d320c038 3083 return system_wq != NULL;
1da177e4
LT
3084}
3085
7a4e344c
TH
3086/**
3087 * free_workqueue_attrs - free a workqueue_attrs
3088 * @attrs: workqueue_attrs to free
3089 *
3090 * Undo alloc_workqueue_attrs().
3091 */
3092void free_workqueue_attrs(struct workqueue_attrs *attrs)
3093{
3094 if (attrs) {
3095 free_cpumask_var(attrs->cpumask);
3096 kfree(attrs);
3097 }
3098}
3099
3100/**
3101 * alloc_workqueue_attrs - allocate a workqueue_attrs
3102 * @gfp_mask: allocation mask to use
3103 *
3104 * Allocate a new workqueue_attrs, initialize with default settings and
3105 * return it. Returns NULL on failure.
3106 */
3107struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3108{
3109 struct workqueue_attrs *attrs;
3110
3111 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3112 if (!attrs)
3113 goto fail;
3114 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3115 goto fail;
3116
3117 cpumask_setall(attrs->cpumask);
3118 return attrs;
3119fail:
3120 free_workqueue_attrs(attrs);
3121 return NULL;
3122}
3123
29c91e99
TH
3124static void copy_workqueue_attrs(struct workqueue_attrs *to,
3125 const struct workqueue_attrs *from)
3126{
3127 to->nice = from->nice;
3128 cpumask_copy(to->cpumask, from->cpumask);
3129}
3130
3131/*
3132 * Hacky implementation of jhash of bitmaps which only considers the
3133 * specified number of bits. We probably want a proper implementation in
3134 * include/linux/jhash.h.
3135 */
3136static u32 jhash_bitmap(const unsigned long *bitmap, int bits, u32 hash)
3137{
3138 int nr_longs = bits / BITS_PER_LONG;
3139 int nr_leftover = bits % BITS_PER_LONG;
3140 unsigned long leftover = 0;
3141
3142 if (nr_longs)
3143 hash = jhash(bitmap, nr_longs * sizeof(long), hash);
3144 if (nr_leftover) {
3145 bitmap_copy(&leftover, bitmap + nr_longs, nr_leftover);
3146 hash = jhash(&leftover, sizeof(long), hash);
3147 }
3148 return hash;
3149}
3150
3151/* hash value of the content of @attr */
3152static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3153{
3154 u32 hash = 0;
3155
3156 hash = jhash_1word(attrs->nice, hash);
3157 hash = jhash_bitmap(cpumask_bits(attrs->cpumask), nr_cpu_ids, hash);
3158 return hash;
3159}
3160
3161/* content equality test */
3162static bool wqattrs_equal(const struct workqueue_attrs *a,
3163 const struct workqueue_attrs *b)
3164{
3165 if (a->nice != b->nice)
3166 return false;
3167 if (!cpumask_equal(a->cpumask, b->cpumask))
3168 return false;
3169 return true;
3170}
3171
7a4e344c
TH
3172/**
3173 * init_worker_pool - initialize a newly zalloc'd worker_pool
3174 * @pool: worker_pool to initialize
3175 *
3176 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
29c91e99
TH
3177 * Returns 0 on success, -errno on failure. Even on failure, all fields
3178 * inside @pool proper are initialized and put_unbound_pool() can be called
3179 * on @pool safely to release it.
7a4e344c
TH
3180 */
3181static int init_worker_pool(struct worker_pool *pool)
4e1a1f9a
TH
3182{
3183 spin_lock_init(&pool->lock);
29c91e99
TH
3184 pool->id = -1;
3185 pool->cpu = -1;
4e1a1f9a
TH
3186 pool->flags |= POOL_DISASSOCIATED;
3187 INIT_LIST_HEAD(&pool->worklist);
3188 INIT_LIST_HEAD(&pool->idle_list);
3189 hash_init(pool->busy_hash);
3190
3191 init_timer_deferrable(&pool->idle_timer);
3192 pool->idle_timer.function = idle_worker_timeout;
3193 pool->idle_timer.data = (unsigned long)pool;
3194
3195 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3196 (unsigned long)pool);
3197
3198 mutex_init(&pool->manager_arb);
3199 mutex_init(&pool->assoc_mutex);
3200 ida_init(&pool->worker_ida);
7a4e344c 3201
29c91e99
TH
3202 INIT_HLIST_NODE(&pool->hash_node);
3203 pool->refcnt = 1;
3204
3205 /* shouldn't fail above this point */
7a4e344c
TH
3206 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3207 if (!pool->attrs)
3208 return -ENOMEM;
3209 return 0;
4e1a1f9a
TH
3210}
3211
29c91e99
TH
3212static void rcu_free_pool(struct rcu_head *rcu)
3213{
3214 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3215
3216 ida_destroy(&pool->worker_ida);
3217 free_workqueue_attrs(pool->attrs);
3218 kfree(pool);
3219}
3220
3221/**
3222 * put_unbound_pool - put a worker_pool
3223 * @pool: worker_pool to put
3224 *
3225 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
3226 * safe manner.
3227 */
3228static void put_unbound_pool(struct worker_pool *pool)
3229{
3230 struct worker *worker;
3231
3232 spin_lock_irq(&workqueue_lock);
3233 if (--pool->refcnt) {
3234 spin_unlock_irq(&workqueue_lock);
3235 return;
3236 }
3237
3238 /* sanity checks */
3239 if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
3240 WARN_ON(!list_empty(&pool->worklist))) {
3241 spin_unlock_irq(&workqueue_lock);
3242 return;
3243 }
3244
3245 /* release id and unhash */
3246 if (pool->id >= 0)
3247 idr_remove(&worker_pool_idr, pool->id);
3248 hash_del(&pool->hash_node);
3249
3250 spin_unlock_irq(&workqueue_lock);
3251
3252 /* lock out manager and destroy all workers */
3253 mutex_lock(&pool->manager_arb);
3254 spin_lock_irq(&pool->lock);
3255
3256 while ((worker = first_worker(pool)))
3257 destroy_worker(worker);
3258 WARN_ON(pool->nr_workers || pool->nr_idle);
3259
3260 spin_unlock_irq(&pool->lock);
3261 mutex_unlock(&pool->manager_arb);
3262
3263 /* shut down the timers */
3264 del_timer_sync(&pool->idle_timer);
3265 del_timer_sync(&pool->mayday_timer);
3266
3267 /* sched-RCU protected to allow dereferences from get_work_pool() */
3268 call_rcu_sched(&pool->rcu, rcu_free_pool);
3269}
3270
3271/**
3272 * get_unbound_pool - get a worker_pool with the specified attributes
3273 * @attrs: the attributes of the worker_pool to get
3274 *
3275 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3276 * reference count and return it. If there already is a matching
3277 * worker_pool, it will be used; otherwise, this function attempts to
3278 * create a new one. On failure, returns NULL.
3279 */
3280static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3281{
3282 static DEFINE_MUTEX(create_mutex);
3283 u32 hash = wqattrs_hash(attrs);
3284 struct worker_pool *pool;
3285 struct worker *worker;
3286
3287 mutex_lock(&create_mutex);
3288
3289 /* do we already have a matching pool? */
3290 spin_lock_irq(&workqueue_lock);
3291 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3292 if (wqattrs_equal(pool->attrs, attrs)) {
3293 pool->refcnt++;
3294 goto out_unlock;
3295 }
3296 }
3297 spin_unlock_irq(&workqueue_lock);
3298
3299 /* nope, create a new one */
3300 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3301 if (!pool || init_worker_pool(pool) < 0)
3302 goto fail;
3303
3304 copy_workqueue_attrs(pool->attrs, attrs);
3305
3306 if (worker_pool_assign_id(pool) < 0)
3307 goto fail;
3308
3309 /* create and start the initial worker */
3310 worker = create_worker(pool);
3311 if (!worker)
3312 goto fail;
3313
3314 spin_lock_irq(&pool->lock);
3315 start_worker(worker);
3316 spin_unlock_irq(&pool->lock);
3317
3318 /* install */
3319 spin_lock_irq(&workqueue_lock);
3320 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3321out_unlock:
3322 spin_unlock_irq(&workqueue_lock);
3323 mutex_unlock(&create_mutex);
3324 return pool;
3325fail:
3326 mutex_unlock(&create_mutex);
3327 if (pool)
3328 put_unbound_pool(pool);
3329 return NULL;
3330}
3331
30cdf249 3332static int alloc_and_link_pwqs(struct workqueue_struct *wq)
0f900049 3333{
49e3cf44 3334 bool highpri = wq->flags & WQ_HIGHPRI;
30cdf249
TH
3335 int cpu;
3336
3337 if (!(wq->flags & WQ_UNBOUND)) {
420c0ddb
TH
3338 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3339 if (!wq->cpu_pwqs)
30cdf249
TH
3340 return -ENOMEM;
3341
3342 for_each_possible_cpu(cpu) {
7fb98ea7
TH
3343 struct pool_workqueue *pwq =
3344 per_cpu_ptr(wq->cpu_pwqs, cpu);
7a62c2c8 3345 struct worker_pool *cpu_pools =
f02ae73a 3346 per_cpu(cpu_worker_pools, cpu);
f3421797 3347
7a62c2c8 3348 pwq->pool = &cpu_pools[highpri];
76af4d93 3349 list_add_tail_rcu(&pwq->pwqs_node, &wq->pwqs);
30cdf249
TH
3350 }
3351 } else {
3352 struct pool_workqueue *pwq;
3353
3354 pwq = kmem_cache_zalloc(pwq_cache, GFP_KERNEL);
3355 if (!pwq)
3356 return -ENOMEM;
3357
29c91e99
TH
3358 pwq->pool = get_unbound_pool(unbound_std_wq_attrs[highpri]);
3359 if (!pwq->pool) {
3360 kmem_cache_free(pwq_cache, pwq);
3361 return -ENOMEM;
3362 }
3363
76af4d93 3364 list_add_tail_rcu(&pwq->pwqs_node, &wq->pwqs);
30cdf249
TH
3365 }
3366
3367 return 0;
0f900049
TH
3368}
3369
112202d9 3370static void free_pwqs(struct workqueue_struct *wq)
0f900049 3371{
e06ffa1e 3372 if (!(wq->flags & WQ_UNBOUND))
420c0ddb
TH
3373 free_percpu(wq->cpu_pwqs);
3374 else if (!list_empty(&wq->pwqs))
3375 kmem_cache_free(pwq_cache, list_first_entry(&wq->pwqs,
3376 struct pool_workqueue, pwqs_node));
0f900049
TH
3377}
3378
f3421797
TH
3379static int wq_clamp_max_active(int max_active, unsigned int flags,
3380 const char *name)
b71ab8c2 3381{
f3421797
TH
3382 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3383
3384 if (max_active < 1 || max_active > lim)
044c782c
VI
3385 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3386 max_active, name, 1, lim);
b71ab8c2 3387
f3421797 3388 return clamp_val(max_active, 1, lim);
b71ab8c2
TH
3389}
3390
b196be89 3391struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
d320c038
TH
3392 unsigned int flags,
3393 int max_active,
3394 struct lock_class_key *key,
b196be89 3395 const char *lock_name, ...)
1da177e4 3396{
b196be89 3397 va_list args, args1;
1da177e4 3398 struct workqueue_struct *wq;
49e3cf44 3399 struct pool_workqueue *pwq;
b196be89
TH
3400 size_t namelen;
3401
3402 /* determine namelen, allocate wq and format name */
3403 va_start(args, lock_name);
3404 va_copy(args1, args);
3405 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3406
3407 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3408 if (!wq)
3409 goto err;
3410
3411 vsnprintf(wq->name, namelen, fmt, args1);
3412 va_end(args);
3413 va_end(args1);
1da177e4 3414
d320c038 3415 max_active = max_active ?: WQ_DFL_ACTIVE;
b196be89 3416 max_active = wq_clamp_max_active(max_active, flags, wq->name);
3af24433 3417
b196be89 3418 /* init wq */
97e37d7b 3419 wq->flags = flags;
a0a1a5fd 3420 wq->saved_max_active = max_active;
73f53c4a 3421 mutex_init(&wq->flush_mutex);
112202d9 3422 atomic_set(&wq->nr_pwqs_to_flush, 0);
30cdf249 3423 INIT_LIST_HEAD(&wq->pwqs);
73f53c4a
TH
3424 INIT_LIST_HEAD(&wq->flusher_queue);
3425 INIT_LIST_HEAD(&wq->flusher_overflow);
493a1724 3426 INIT_LIST_HEAD(&wq->maydays);
502ca9d8 3427
eb13ba87 3428 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
cce1a165 3429 INIT_LIST_HEAD(&wq->list);
3af24433 3430
30cdf249 3431 if (alloc_and_link_pwqs(wq) < 0)
bdbc5dd7
TH
3432 goto err;
3433
76af4d93 3434 local_irq_disable();
49e3cf44 3435 for_each_pwq(pwq, wq) {
112202d9 3436 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
112202d9
TH
3437 pwq->wq = wq;
3438 pwq->flush_color = -1;
3439 pwq->max_active = max_active;
3440 INIT_LIST_HEAD(&pwq->delayed_works);
493a1724 3441 INIT_LIST_HEAD(&pwq->mayday_node);
e22bee78 3442 }
76af4d93 3443 local_irq_enable();
1537663f 3444
493008a8
TH
3445 /*
3446 * Workqueues which may be used during memory reclaim should
3447 * have a rescuer to guarantee forward progress.
3448 */
3449 if (flags & WQ_MEM_RECLAIM) {
e22bee78
TH
3450 struct worker *rescuer;
3451
e22bee78
TH
3452 wq->rescuer = rescuer = alloc_worker();
3453 if (!rescuer)
3454 goto err;
3455
111c225a
TH
3456 rescuer->rescue_wq = wq;
3457 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
b196be89 3458 wq->name);
e22bee78
TH
3459 if (IS_ERR(rescuer->task))
3460 goto err;
3461
e22bee78
TH
3462 rescuer->task->flags |= PF_THREAD_BOUND;
3463 wake_up_process(rescuer->task);
3af24433
ON
3464 }
3465
a0a1a5fd
TH
3466 /*
3467 * workqueue_lock protects global freeze state and workqueues
3468 * list. Grab it, set max_active accordingly and add the new
3469 * workqueue to workqueues list.
3470 */
e98d5b16 3471 spin_lock_irq(&workqueue_lock);
a0a1a5fd 3472
58a69cb4 3473 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
49e3cf44
TH
3474 for_each_pwq(pwq, wq)
3475 pwq->max_active = 0;
a0a1a5fd 3476
1537663f 3477 list_add(&wq->list, &workqueues);
a0a1a5fd 3478
e98d5b16 3479 spin_unlock_irq(&workqueue_lock);
1537663f 3480
3af24433 3481 return wq;
4690c4ab
TH
3482err:
3483 if (wq) {
112202d9 3484 free_pwqs(wq);
e22bee78 3485 kfree(wq->rescuer);
4690c4ab
TH
3486 kfree(wq);
3487 }
3488 return NULL;
3af24433 3489}
d320c038 3490EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
1da177e4 3491
3af24433
ON
3492/**
3493 * destroy_workqueue - safely terminate a workqueue
3494 * @wq: target workqueue
3495 *
3496 * Safely destroy a workqueue. All work currently pending will be done first.
3497 */
3498void destroy_workqueue(struct workqueue_struct *wq)
3499{
49e3cf44 3500 struct pool_workqueue *pwq;
3af24433 3501
9c5a2ba7
TH
3502 /* drain it before proceeding with destruction */
3503 drain_workqueue(wq);
c8efcc25 3504
76af4d93
TH
3505 spin_lock_irq(&workqueue_lock);
3506
6183c009 3507 /* sanity checks */
49e3cf44 3508 for_each_pwq(pwq, wq) {
6183c009
TH
3509 int i;
3510
76af4d93
TH
3511 for (i = 0; i < WORK_NR_COLORS; i++) {
3512 if (WARN_ON(pwq->nr_in_flight[i])) {
3513 spin_unlock_irq(&workqueue_lock);
6183c009 3514 return;
76af4d93
TH
3515 }
3516 }
3517
6183c009 3518 if (WARN_ON(pwq->nr_active) ||
76af4d93
TH
3519 WARN_ON(!list_empty(&pwq->delayed_works))) {
3520 spin_unlock_irq(&workqueue_lock);
6183c009 3521 return;
76af4d93 3522 }
6183c009
TH
3523 }
3524
a0a1a5fd
TH
3525 /*
3526 * wq list is used to freeze wq, remove from list after
3527 * flushing is complete in case freeze races us.
3528 */
b1f4ec17 3529 list_del(&wq->list);
76af4d93 3530
e98d5b16 3531 spin_unlock_irq(&workqueue_lock);
3af24433 3532
493008a8 3533 if (wq->rescuer) {
e22bee78 3534 kthread_stop(wq->rescuer->task);
8d9df9f0 3535 kfree(wq->rescuer);
493008a8 3536 wq->rescuer = NULL;
e22bee78
TH
3537 }
3538
29c91e99
TH
3539 /*
3540 * We're the sole accessor of @wq at this point. Directly access
3541 * the first pwq and put its pool.
3542 */
3543 if (wq->flags & WQ_UNBOUND) {
3544 pwq = list_first_entry(&wq->pwqs, struct pool_workqueue,
3545 pwqs_node);
3546 put_unbound_pool(pwq->pool);
3547 }
112202d9 3548 free_pwqs(wq);
3af24433
ON
3549 kfree(wq);
3550}
3551EXPORT_SYMBOL_GPL(destroy_workqueue);
3552
9f4bd4cd 3553/**
112202d9
TH
3554 * pwq_set_max_active - adjust max_active of a pwq
3555 * @pwq: target pool_workqueue
9f4bd4cd
LJ
3556 * @max_active: new max_active value.
3557 *
112202d9 3558 * Set @pwq->max_active to @max_active and activate delayed works if
9f4bd4cd
LJ
3559 * increased.
3560 *
3561 * CONTEXT:
d565ed63 3562 * spin_lock_irq(pool->lock).
9f4bd4cd 3563 */
112202d9 3564static void pwq_set_max_active(struct pool_workqueue *pwq, int max_active)
9f4bd4cd 3565{
112202d9 3566 pwq->max_active = max_active;
9f4bd4cd 3567
112202d9
TH
3568 while (!list_empty(&pwq->delayed_works) &&
3569 pwq->nr_active < pwq->max_active)
3570 pwq_activate_first_delayed(pwq);
9f4bd4cd
LJ
3571}
3572
dcd989cb
TH
3573/**
3574 * workqueue_set_max_active - adjust max_active of a workqueue
3575 * @wq: target workqueue
3576 * @max_active: new max_active value.
3577 *
3578 * Set max_active of @wq to @max_active.
3579 *
3580 * CONTEXT:
3581 * Don't call from IRQ context.
3582 */
3583void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3584{
49e3cf44 3585 struct pool_workqueue *pwq;
dcd989cb 3586
f3421797 3587 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
dcd989cb 3588
e98d5b16 3589 spin_lock_irq(&workqueue_lock);
dcd989cb
TH
3590
3591 wq->saved_max_active = max_active;
3592
49e3cf44 3593 for_each_pwq(pwq, wq) {
112202d9 3594 struct worker_pool *pool = pwq->pool;
dcd989cb 3595
e98d5b16 3596 spin_lock(&pool->lock);
dcd989cb 3597
58a69cb4 3598 if (!(wq->flags & WQ_FREEZABLE) ||
35b6bb63 3599 !(pool->flags & POOL_FREEZING))
112202d9 3600 pwq_set_max_active(pwq, max_active);
9bfb1839 3601
e98d5b16 3602 spin_unlock(&pool->lock);
65a64464 3603 }
93981800 3604
e98d5b16 3605 spin_unlock_irq(&workqueue_lock);
15316ba8 3606}
dcd989cb 3607EXPORT_SYMBOL_GPL(workqueue_set_max_active);
15316ba8 3608
eef6a7d5 3609/**
dcd989cb
TH
3610 * workqueue_congested - test whether a workqueue is congested
3611 * @cpu: CPU in question
3612 * @wq: target workqueue
eef6a7d5 3613 *
dcd989cb
TH
3614 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3615 * no synchronization around this function and the test result is
3616 * unreliable and only useful as advisory hints or for debugging.
eef6a7d5 3617 *
dcd989cb
TH
3618 * RETURNS:
3619 * %true if congested, %false otherwise.
eef6a7d5 3620 */
d84ff051 3621bool workqueue_congested(int cpu, struct workqueue_struct *wq)
1da177e4 3622{
7fb98ea7 3623 struct pool_workqueue *pwq;
76af4d93
TH
3624 bool ret;
3625
3626 preempt_disable();
7fb98ea7
TH
3627
3628 if (!(wq->flags & WQ_UNBOUND))
3629 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
3630 else
3631 pwq = first_pwq(wq);
dcd989cb 3632
76af4d93
TH
3633 ret = !list_empty(&pwq->delayed_works);
3634 preempt_enable();
3635
3636 return ret;
1da177e4 3637}
dcd989cb 3638EXPORT_SYMBOL_GPL(workqueue_congested);
1da177e4 3639
dcd989cb
TH
3640/**
3641 * work_busy - test whether a work is currently pending or running
3642 * @work: the work to be tested
3643 *
3644 * Test whether @work is currently pending or running. There is no
3645 * synchronization around this function and the test result is
3646 * unreliable and only useful as advisory hints or for debugging.
dcd989cb
TH
3647 *
3648 * RETURNS:
3649 * OR'd bitmask of WORK_BUSY_* bits.
3650 */
3651unsigned int work_busy(struct work_struct *work)
1da177e4 3652{
fa1b54e6 3653 struct worker_pool *pool;
dcd989cb
TH
3654 unsigned long flags;
3655 unsigned int ret = 0;
1da177e4 3656
dcd989cb
TH
3657 if (work_pending(work))
3658 ret |= WORK_BUSY_PENDING;
1da177e4 3659
fa1b54e6
TH
3660 local_irq_save(flags);
3661 pool = get_work_pool(work);
038366c5 3662 if (pool) {
fa1b54e6 3663 spin_lock(&pool->lock);
038366c5
LJ
3664 if (find_worker_executing_work(pool, work))
3665 ret |= WORK_BUSY_RUNNING;
fa1b54e6 3666 spin_unlock(&pool->lock);
038366c5 3667 }
fa1b54e6 3668 local_irq_restore(flags);
1da177e4 3669
dcd989cb 3670 return ret;
1da177e4 3671}
dcd989cb 3672EXPORT_SYMBOL_GPL(work_busy);
1da177e4 3673
db7bccf4
TH
3674/*
3675 * CPU hotplug.
3676 *
e22bee78 3677 * There are two challenges in supporting CPU hotplug. Firstly, there
112202d9 3678 * are a lot of assumptions on strong associations among work, pwq and
706026c2 3679 * pool which make migrating pending and scheduled works very
e22bee78 3680 * difficult to implement without impacting hot paths. Secondly,
94cf58bb 3681 * worker pools serve mix of short, long and very long running works making
e22bee78
TH
3682 * blocked draining impractical.
3683 *
24647570 3684 * This is solved by allowing the pools to be disassociated from the CPU
628c78e7
TH
3685 * running as an unbound one and allowing it to be reattached later if the
3686 * cpu comes back online.
db7bccf4 3687 */
1da177e4 3688
706026c2 3689static void wq_unbind_fn(struct work_struct *work)
3af24433 3690{
38db41d9 3691 int cpu = smp_processor_id();
4ce62e9e 3692 struct worker_pool *pool;
db7bccf4 3693 struct worker *worker;
db7bccf4 3694 int i;
3af24433 3695
f02ae73a 3696 for_each_cpu_worker_pool(pool, cpu) {
6183c009 3697 WARN_ON_ONCE(cpu != smp_processor_id());
db7bccf4 3698
94cf58bb
TH
3699 mutex_lock(&pool->assoc_mutex);
3700 spin_lock_irq(&pool->lock);
3af24433 3701
94cf58bb
TH
3702 /*
3703 * We've claimed all manager positions. Make all workers
3704 * unbound and set DISASSOCIATED. Before this, all workers
3705 * except for the ones which are still executing works from
3706 * before the last CPU down must be on the cpu. After
3707 * this, they may become diasporas.
3708 */
4ce62e9e 3709 list_for_each_entry(worker, &pool->idle_list, entry)
403c821d 3710 worker->flags |= WORKER_UNBOUND;
3af24433 3711
b67bfe0d 3712 for_each_busy_worker(worker, i, pool)
c9e7cf27 3713 worker->flags |= WORKER_UNBOUND;
06ba38a9 3714
24647570 3715 pool->flags |= POOL_DISASSOCIATED;
f2d5a0ee 3716
94cf58bb
TH
3717 spin_unlock_irq(&pool->lock);
3718 mutex_unlock(&pool->assoc_mutex);
3719 }
628c78e7 3720
e22bee78 3721 /*
403c821d 3722 * Call schedule() so that we cross rq->lock and thus can guarantee
628c78e7
TH
3723 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3724 * as scheduler callbacks may be invoked from other cpus.
e22bee78 3725 */
e22bee78 3726 schedule();
06ba38a9 3727
e22bee78 3728 /*
628c78e7
TH
3729 * Sched callbacks are disabled now. Zap nr_running. After this,
3730 * nr_running stays zero and need_more_worker() and keep_working()
38db41d9
TH
3731 * are always true as long as the worklist is not empty. Pools on
3732 * @cpu now behave as unbound (in terms of concurrency management)
3733 * pools which are served by workers tied to the CPU.
628c78e7
TH
3734 *
3735 * On return from this function, the current worker would trigger
3736 * unbound chain execution of pending work items if other workers
3737 * didn't already.
e22bee78 3738 */
f02ae73a 3739 for_each_cpu_worker_pool(pool, cpu)
e19e397a 3740 atomic_set(&pool->nr_running, 0);
3af24433 3741}
3af24433 3742
8db25e78
TH
3743/*
3744 * Workqueues should be brought up before normal priority CPU notifiers.
3745 * This will be registered high priority CPU notifier.
3746 */
9fdf9b73 3747static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
8db25e78
TH
3748 unsigned long action,
3749 void *hcpu)
3af24433 3750{
d84ff051 3751 int cpu = (unsigned long)hcpu;
4ce62e9e 3752 struct worker_pool *pool;
3ce63377 3753
8db25e78 3754 switch (action & ~CPU_TASKS_FROZEN) {
3af24433 3755 case CPU_UP_PREPARE:
f02ae73a 3756 for_each_cpu_worker_pool(pool, cpu) {
3ce63377
TH
3757 struct worker *worker;
3758
3759 if (pool->nr_workers)
3760 continue;
3761
3762 worker = create_worker(pool);
3763 if (!worker)
3764 return NOTIFY_BAD;
3765
d565ed63 3766 spin_lock_irq(&pool->lock);
3ce63377 3767 start_worker(worker);
d565ed63 3768 spin_unlock_irq(&pool->lock);
3af24433 3769 }
8db25e78 3770 break;
3af24433 3771
db7bccf4
TH
3772 case CPU_DOWN_FAILED:
3773 case CPU_ONLINE:
f02ae73a 3774 for_each_cpu_worker_pool(pool, cpu) {
94cf58bb
TH
3775 mutex_lock(&pool->assoc_mutex);
3776 spin_lock_irq(&pool->lock);
3777
24647570 3778 pool->flags &= ~POOL_DISASSOCIATED;
94cf58bb
TH
3779 rebind_workers(pool);
3780
3781 spin_unlock_irq(&pool->lock);
3782 mutex_unlock(&pool->assoc_mutex);
3783 }
db7bccf4 3784 break;
00dfcaf7 3785 }
65758202
TH
3786 return NOTIFY_OK;
3787}
3788
3789/*
3790 * Workqueues should be brought down after normal priority CPU notifiers.
3791 * This will be registered as low priority CPU notifier.
3792 */
9fdf9b73 3793static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
65758202
TH
3794 unsigned long action,
3795 void *hcpu)
3796{
d84ff051 3797 int cpu = (unsigned long)hcpu;
8db25e78
TH
3798 struct work_struct unbind_work;
3799
65758202
TH
3800 switch (action & ~CPU_TASKS_FROZEN) {
3801 case CPU_DOWN_PREPARE:
8db25e78 3802 /* unbinding should happen on the local CPU */
706026c2 3803 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
7635d2fd 3804 queue_work_on(cpu, system_highpri_wq, &unbind_work);
8db25e78
TH
3805 flush_work(&unbind_work);
3806 break;
65758202
TH
3807 }
3808 return NOTIFY_OK;
3809}
3810
2d3854a3 3811#ifdef CONFIG_SMP
8ccad40d 3812
2d3854a3 3813struct work_for_cpu {
ed48ece2 3814 struct work_struct work;
2d3854a3
RR
3815 long (*fn)(void *);
3816 void *arg;
3817 long ret;
3818};
3819
ed48ece2 3820static void work_for_cpu_fn(struct work_struct *work)
2d3854a3 3821{
ed48ece2
TH
3822 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3823
2d3854a3
RR
3824 wfc->ret = wfc->fn(wfc->arg);
3825}
3826
3827/**
3828 * work_on_cpu - run a function in user context on a particular cpu
3829 * @cpu: the cpu to run on
3830 * @fn: the function to run
3831 * @arg: the function arg
3832 *
31ad9081
RR
3833 * This will return the value @fn returns.
3834 * It is up to the caller to ensure that the cpu doesn't go offline.
6b44003e 3835 * The caller must not hold any locks which would prevent @fn from completing.
2d3854a3 3836 */
d84ff051 3837long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
2d3854a3 3838{
ed48ece2 3839 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
6b44003e 3840
ed48ece2
TH
3841 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3842 schedule_work_on(cpu, &wfc.work);
3843 flush_work(&wfc.work);
2d3854a3
RR
3844 return wfc.ret;
3845}
3846EXPORT_SYMBOL_GPL(work_on_cpu);
3847#endif /* CONFIG_SMP */
3848
a0a1a5fd
TH
3849#ifdef CONFIG_FREEZER
3850
3851/**
3852 * freeze_workqueues_begin - begin freezing workqueues
3853 *
58a69cb4
TH
3854 * Start freezing workqueues. After this function returns, all freezable
3855 * workqueues will queue new works to their frozen_works list instead of
706026c2 3856 * pool->worklist.
a0a1a5fd
TH
3857 *
3858 * CONTEXT:
d565ed63 3859 * Grabs and releases workqueue_lock and pool->lock's.
a0a1a5fd
TH
3860 */
3861void freeze_workqueues_begin(void)
3862{
17116969 3863 struct worker_pool *pool;
24b8a847
TH
3864 struct workqueue_struct *wq;
3865 struct pool_workqueue *pwq;
17116969 3866 int id;
a0a1a5fd 3867
e98d5b16 3868 spin_lock_irq(&workqueue_lock);
a0a1a5fd 3869
6183c009 3870 WARN_ON_ONCE(workqueue_freezing);
a0a1a5fd
TH
3871 workqueue_freezing = true;
3872
24b8a847 3873 /* set FREEZING */
17116969 3874 for_each_pool(pool, id) {
17116969 3875 spin_lock(&pool->lock);
17116969
TH
3876 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
3877 pool->flags |= POOL_FREEZING;
24b8a847
TH
3878 spin_unlock(&pool->lock);
3879 }
a0a1a5fd 3880
24b8a847
TH
3881 /* suppress further executions by setting max_active to zero */
3882 list_for_each_entry(wq, &workqueues, list) {
3883 if (!(wq->flags & WQ_FREEZABLE))
3884 continue;
8b03ae3c 3885
24b8a847
TH
3886 for_each_pwq(pwq, wq) {
3887 spin_lock(&pwq->pool->lock);
3888 pwq->max_active = 0;
3889 spin_unlock(&pwq->pool->lock);
a1056305 3890 }
a0a1a5fd
TH
3891 }
3892
e98d5b16 3893 spin_unlock_irq(&workqueue_lock);
a0a1a5fd
TH
3894}
3895
3896/**
58a69cb4 3897 * freeze_workqueues_busy - are freezable workqueues still busy?
a0a1a5fd
TH
3898 *
3899 * Check whether freezing is complete. This function must be called
3900 * between freeze_workqueues_begin() and thaw_workqueues().
3901 *
3902 * CONTEXT:
3903 * Grabs and releases workqueue_lock.
3904 *
3905 * RETURNS:
58a69cb4
TH
3906 * %true if some freezable workqueues are still busy. %false if freezing
3907 * is complete.
a0a1a5fd
TH
3908 */
3909bool freeze_workqueues_busy(void)
3910{
a0a1a5fd 3911 bool busy = false;
24b8a847
TH
3912 struct workqueue_struct *wq;
3913 struct pool_workqueue *pwq;
a0a1a5fd 3914
e98d5b16 3915 spin_lock_irq(&workqueue_lock);
a0a1a5fd 3916
6183c009 3917 WARN_ON_ONCE(!workqueue_freezing);
a0a1a5fd 3918
24b8a847
TH
3919 list_for_each_entry(wq, &workqueues, list) {
3920 if (!(wq->flags & WQ_FREEZABLE))
3921 continue;
a0a1a5fd
TH
3922 /*
3923 * nr_active is monotonically decreasing. It's safe
3924 * to peek without lock.
3925 */
24b8a847 3926 for_each_pwq(pwq, wq) {
6183c009 3927 WARN_ON_ONCE(pwq->nr_active < 0);
112202d9 3928 if (pwq->nr_active) {
a0a1a5fd
TH
3929 busy = true;
3930 goto out_unlock;
3931 }
3932 }
3933 }
3934out_unlock:
e98d5b16 3935 spin_unlock_irq(&workqueue_lock);
a0a1a5fd
TH
3936 return busy;
3937}
3938
3939/**
3940 * thaw_workqueues - thaw workqueues
3941 *
3942 * Thaw workqueues. Normal queueing is restored and all collected
706026c2 3943 * frozen works are transferred to their respective pool worklists.
a0a1a5fd
TH
3944 *
3945 * CONTEXT:
d565ed63 3946 * Grabs and releases workqueue_lock and pool->lock's.
a0a1a5fd
TH
3947 */
3948void thaw_workqueues(void)
3949{
24b8a847
TH
3950 struct workqueue_struct *wq;
3951 struct pool_workqueue *pwq;
3952 struct worker_pool *pool;
3953 int id;
a0a1a5fd 3954
e98d5b16 3955 spin_lock_irq(&workqueue_lock);
a0a1a5fd
TH
3956
3957 if (!workqueue_freezing)
3958 goto out_unlock;
3959
24b8a847
TH
3960 /* clear FREEZING */
3961 for_each_pool(pool, id) {
3962 spin_lock(&pool->lock);
3963 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
3964 pool->flags &= ~POOL_FREEZING;
3965 spin_unlock(&pool->lock);
3966 }
8b03ae3c 3967
24b8a847
TH
3968 /* restore max_active and repopulate worklist */
3969 list_for_each_entry(wq, &workqueues, list) {
3970 if (!(wq->flags & WQ_FREEZABLE))
3971 continue;
a1056305 3972
24b8a847
TH
3973 for_each_pwq(pwq, wq) {
3974 spin_lock(&pwq->pool->lock);
3975 pwq_set_max_active(pwq, wq->saved_max_active);
3976 spin_unlock(&pwq->pool->lock);
d565ed63 3977 }
a0a1a5fd
TH
3978 }
3979
24b8a847
TH
3980 /* kick workers */
3981 for_each_pool(pool, id) {
3982 spin_lock(&pool->lock);
3983 wake_up_worker(pool);
3984 spin_unlock(&pool->lock);
3985 }
3986
a0a1a5fd
TH
3987 workqueue_freezing = false;
3988out_unlock:
e98d5b16 3989 spin_unlock_irq(&workqueue_lock);
a0a1a5fd
TH
3990}
3991#endif /* CONFIG_FREEZER */
3992
6ee0578b 3993static int __init init_workqueues(void)
1da177e4 3994{
7a4e344c
TH
3995 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
3996 int i, cpu;
c34056a3 3997
7c3eed5c
TH
3998 /* make sure we have enough bits for OFFQ pool ID */
3999 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) <
6be19588 4000 WORK_CPU_END * NR_STD_WORKER_POOLS);
b5490077 4001
e904e6c2
TH
4002 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4003
4004 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4005
65758202 4006 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
a5b4e57d 4007 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
8b03ae3c 4008
706026c2 4009 /* initialize CPU pools */
29c91e99 4010 for_each_possible_cpu(cpu) {
4ce62e9e 4011 struct worker_pool *pool;
8b03ae3c 4012
7a4e344c 4013 i = 0;
f02ae73a 4014 for_each_cpu_worker_pool(pool, cpu) {
7a4e344c 4015 BUG_ON(init_worker_pool(pool));
ec22ca5e 4016 pool->cpu = cpu;
29c91e99 4017 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
7a4e344c
TH
4018 pool->attrs->nice = std_nice[i++];
4019
9daf9e67
TH
4020 /* alloc pool ID */
4021 BUG_ON(worker_pool_assign_id(pool));
4ce62e9e 4022 }
8b03ae3c
TH
4023 }
4024
e22bee78 4025 /* create the initial worker */
29c91e99 4026 for_each_online_cpu(cpu) {
4ce62e9e 4027 struct worker_pool *pool;
e22bee78 4028
f02ae73a 4029 for_each_cpu_worker_pool(pool, cpu) {
4ce62e9e
TH
4030 struct worker *worker;
4031
29c91e99 4032 pool->flags &= ~POOL_DISASSOCIATED;
24647570 4033
bc2ae0f5 4034 worker = create_worker(pool);
4ce62e9e 4035 BUG_ON(!worker);
d565ed63 4036 spin_lock_irq(&pool->lock);
4ce62e9e 4037 start_worker(worker);
d565ed63 4038 spin_unlock_irq(&pool->lock);
4ce62e9e 4039 }
e22bee78
TH
4040 }
4041
29c91e99
TH
4042 /* create default unbound wq attrs */
4043 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
4044 struct workqueue_attrs *attrs;
4045
4046 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
4047
4048 attrs->nice = std_nice[i];
4049 cpumask_setall(attrs->cpumask);
4050
4051 unbound_std_wq_attrs[i] = attrs;
4052 }
4053
d320c038 4054 system_wq = alloc_workqueue("events", 0, 0);
1aabe902 4055 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
d320c038 4056 system_long_wq = alloc_workqueue("events_long", 0, 0);
f3421797
TH
4057 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
4058 WQ_UNBOUND_MAX_ACTIVE);
24d51add
TH
4059 system_freezable_wq = alloc_workqueue("events_freezable",
4060 WQ_FREEZABLE, 0);
1aabe902 4061 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
ae930e0f 4062 !system_unbound_wq || !system_freezable_wq);
6ee0578b 4063 return 0;
1da177e4 4064}
6ee0578b 4065early_initcall(init_workqueues);