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