xref: /linux-6.15/kernel/workqueue.c (revision d565ed63)
11da177e4SLinus Torvalds /*
2c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
31da177e4SLinus Torvalds  *
4c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
51da177e4SLinus Torvalds  *
61da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
71da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
8e1f8e874SFrancois Cami  *     Andrew Morton
91da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
101da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1189ada679SChristoph Lameter  *
12cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
13c54fce6eSTejun Heo  *
14c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
15c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
16c54fce6eSTejun Heo  *
17c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
18c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
19c54fce6eSTejun Heo  * automatically managed.  There is one worker pool for each CPU and
20c54fce6eSTejun Heo  * one extra for works which are better served by workers which are
21c54fce6eSTejun Heo  * not bound to any specific CPU.
22c54fce6eSTejun Heo  *
23c54fce6eSTejun Heo  * Please read Documentation/workqueue.txt for details.
241da177e4SLinus Torvalds  */
251da177e4SLinus Torvalds 
269984de1aSPaul Gortmaker #include <linux/export.h>
271da177e4SLinus Torvalds #include <linux/kernel.h>
281da177e4SLinus Torvalds #include <linux/sched.h>
291da177e4SLinus Torvalds #include <linux/init.h>
301da177e4SLinus Torvalds #include <linux/signal.h>
311da177e4SLinus Torvalds #include <linux/completion.h>
321da177e4SLinus Torvalds #include <linux/workqueue.h>
331da177e4SLinus Torvalds #include <linux/slab.h>
341da177e4SLinus Torvalds #include <linux/cpu.h>
351da177e4SLinus Torvalds #include <linux/notifier.h>
361da177e4SLinus Torvalds #include <linux/kthread.h>
371fa44ecaSJames Bottomley #include <linux/hardirq.h>
3846934023SChristoph Lameter #include <linux/mempolicy.h>
39341a5958SRafael J. Wysocki #include <linux/freezer.h>
40d5abe669SPeter Zijlstra #include <linux/kallsyms.h>
41d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
424e6045f1SJohannes Berg #include <linux/lockdep.h>
43c34056a3STejun Heo #include <linux/idr.h>
4442f8570fSSasha Levin #include <linux/hashtable.h>
45e22bee78STejun Heo 
46ea138446STejun Heo #include "workqueue_internal.h"
471da177e4SLinus Torvalds 
48c8e55f36STejun Heo enum {
49bc2ae0f5STejun Heo 	/*
5024647570STejun Heo 	 * worker_pool flags
51bc2ae0f5STejun Heo 	 *
5224647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
53bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
54bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
55bc2ae0f5STejun Heo 	 * is in effect.
56bc2ae0f5STejun Heo 	 *
57bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
58bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
5924647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
60bc2ae0f5STejun Heo 	 *
61bc2ae0f5STejun Heo 	 * Note that DISASSOCIATED can be flipped only while holding
6224647570STejun Heo 	 * assoc_mutex to avoid changing binding state while
6324647570STejun Heo 	 * create_worker() is in progress.
64bc2ae0f5STejun Heo 	 */
6511ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
66552a37e9SLai Jiangshan 	POOL_MANAGING_WORKERS   = 1 << 1,       /* managing workers */
6724647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
6835b6bb63STejun Heo 	POOL_FREEZING		= 1 << 3,	/* freeze in progress */
69db7bccf4STejun Heo 
70c8e55f36STejun Heo 	/* worker flags */
71c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
72c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
73c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
74e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
75fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
76f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
77e22bee78STejun Heo 
785f7dabfdSLai Jiangshan 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_UNBOUND |
79403c821dSTejun Heo 				  WORKER_CPU_INTENSIVE,
80db7bccf4STejun Heo 
81e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
824ce62e9eSTejun Heo 
83c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
84db7bccf4STejun Heo 
85e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
86e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
87e22bee78STejun Heo 
883233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
893233cdbdSTejun Heo 						/* call for help after 10ms
903233cdbdSTejun Heo 						   (min two ticks) */
91e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
92e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
931da177e4SLinus Torvalds 
941da177e4SLinus Torvalds 	/*
95e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
96e22bee78STejun Heo 	 * all cpus.  Give -20.
97e22bee78STejun Heo 	 */
98e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
993270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
100c8e55f36STejun Heo };
101c8e55f36STejun Heo 
1021da177e4SLinus Torvalds /*
1034690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1044690c4abSTejun Heo  *
105e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
106e41e704bSTejun Heo  *    everyone else.
1074690c4abSTejun Heo  *
108e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
109e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
110e22bee78STejun Heo  *
111*d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1124690c4abSTejun Heo  *
113*d565ed63STejun Heo  * X: During normal operation, modification requires pool->lock and should
114*d565ed63STejun Heo  *    be done only from local cpu.  Either disabling preemption on local
115*d565ed63STejun Heo  *    cpu or grabbing pool->lock is enough for read access.  If
116*d565ed63STejun Heo  *    POOL_DISASSOCIATED is set, it's identical to L.
117e22bee78STejun Heo  *
11873f53c4aSTejun Heo  * F: wq->flush_mutex protected.
11973f53c4aSTejun Heo  *
1204690c4abSTejun Heo  * W: workqueue_lock protected.
1214690c4abSTejun Heo  */
1224690c4abSTejun Heo 
1232eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
124c34056a3STejun Heo 
125bd7bdd43STejun Heo struct worker_pool {
126bd7bdd43STejun Heo 	struct global_cwq	*gcwq;		/* I: the owning gcwq */
127*d565ed63STejun Heo 	spinlock_t		lock;		/* the pool lock */
128ec22ca5eSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
1299daf9e67STejun Heo 	int			id;		/* I: pool ID */
13011ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
131bd7bdd43STejun Heo 
132bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
133bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
134ea1abd61SLai Jiangshan 
135ea1abd61SLai Jiangshan 	/* nr_idle includes the ones off idle_list for rebinding */
136bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
137bd7bdd43STejun Heo 
138bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
139bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
140bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
141bd7bdd43STejun Heo 
142c9e7cf27STejun Heo 	/* workers are chained either in busy_hash or idle_list */
143c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
144c9e7cf27STejun Heo 						/* L: hash of busy workers */
145c9e7cf27STejun Heo 
14624647570STejun Heo 	struct mutex		assoc_mutex;	/* protect POOL_DISASSOCIATED */
147bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
148bd7bdd43STejun Heo };
149bd7bdd43STejun Heo 
1504690c4abSTejun Heo /*
151e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
152e22bee78STejun Heo  * and all works are queued and processed here regardless of their
153e22bee78STejun Heo  * target workqueues.
1548b03ae3cSTejun Heo  */
1558b03ae3cSTejun Heo struct global_cwq {
156e34cdddbSTejun Heo 	struct worker_pool	pools[NR_STD_WORKER_POOLS];
157330dad5bSJoonsoo Kim 						/* normal and highpri pools */
1588b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1598b03ae3cSTejun Heo 
1608b03ae3cSTejun Heo /*
161502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1620f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1630f900049STejun Heo  * aligned at two's power of the number of flag bits.
1641da177e4SLinus Torvalds  */
1651da177e4SLinus Torvalds struct cpu_workqueue_struct {
166bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1674690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
16873f53c4aSTejun Heo 	int			work_color;	/* L: current color */
16973f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
17073f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
17173f53c4aSTejun Heo 						/* L: nr of in_flight works */
1721e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
173a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
1741e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
1750f900049STejun Heo };
1761da177e4SLinus Torvalds 
1771da177e4SLinus Torvalds /*
17873f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
17973f53c4aSTejun Heo  */
18073f53c4aSTejun Heo struct wq_flusher {
18173f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
18273f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
18373f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
18473f53c4aSTejun Heo };
1851da177e4SLinus Torvalds 
18673f53c4aSTejun Heo /*
187f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
188f2e005aaSTejun Heo  * used to determine whether there's something to be done.
189f2e005aaSTejun Heo  */
190f2e005aaSTejun Heo #ifdef CONFIG_SMP
191f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
192f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
193f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
194f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
195f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
1969c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
197f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
198f2e005aaSTejun Heo #else
199f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
200f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
201f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
202f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
203f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
204f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
205f2e005aaSTejun Heo #endif
2061da177e4SLinus Torvalds 
2071da177e4SLinus Torvalds /*
2081da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2091da177e4SLinus Torvalds  * per-CPU workqueues:
2101da177e4SLinus Torvalds  */
2111da177e4SLinus Torvalds struct workqueue_struct {
2129c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
213bdbc5dd7STejun Heo 	union {
214bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
215bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
216bdbc5dd7STejun Heo 		unsigned long				v;
217bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2184690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
21973f53c4aSTejun Heo 
22073f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
22173f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
22273f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
22373f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
22473f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
22573f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
22673f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
22773f53c4aSTejun Heo 
228f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
229e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
230e22bee78STejun Heo 
2319c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
232dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2334e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2344e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2354e6045f1SJohannes Berg #endif
236b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2371da177e4SLinus Torvalds };
2381da177e4SLinus Torvalds 
239d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
240d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
241044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
2421aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
243044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
244d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
245044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
246f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
247044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
24824d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
249d320c038STejun Heo 
25097bd2347STejun Heo #define CREATE_TRACE_POINTS
25197bd2347STejun Heo #include <trace/events/workqueue.h>
25297bd2347STejun Heo 
2534ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
2543270476aSTejun Heo 	for ((pool) = &(gcwq)->pools[0];				\
255e34cdddbSTejun Heo 	     (pool) < &(gcwq)->pools[NR_STD_WORKER_POOLS]; (pool)++)
2564ce62e9eSTejun Heo 
257c9e7cf27STejun Heo #define for_each_busy_worker(worker, i, pos, pool)			\
258c9e7cf27STejun Heo 	hash_for_each(pool->busy_hash, i, pos, worker, hentry)
259db7bccf4STejun Heo 
260f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
261f3421797STejun Heo 				  unsigned int sw)
262f3421797STejun Heo {
263f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
264f3421797STejun Heo 		if (sw & 1) {
265f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
266f3421797STejun Heo 			if (cpu < nr_cpu_ids)
267f3421797STejun Heo 				return cpu;
268f3421797STejun Heo 		}
269f3421797STejun Heo 		if (sw & 2)
270f3421797STejun Heo 			return WORK_CPU_UNBOUND;
271f3421797STejun Heo 	}
272f3421797STejun Heo 	return WORK_CPU_NONE;
273f3421797STejun Heo }
274f3421797STejun Heo 
275f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
276f3421797STejun Heo 				struct workqueue_struct *wq)
277f3421797STejun Heo {
278f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
279f3421797STejun Heo }
280f3421797STejun Heo 
28109884951STejun Heo /*
28209884951STejun Heo  * CPU iterators
28309884951STejun Heo  *
28409884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
28509884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
28609884951STejun Heo  * specific CPU.  The following iterators are similar to
28709884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
28809884951STejun Heo  *
28909884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
29009884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
29109884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
29209884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
29309884951STejun Heo  */
294f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
295f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
296f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
297f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
298f3421797STejun Heo 
299f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
300f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
301f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
302f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
303f3421797STejun Heo 
304f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
305f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
306f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
307f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
308f3421797STejun Heo 
309dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
310dc186ad7SThomas Gleixner 
311dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
312dc186ad7SThomas Gleixner 
31399777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
31499777288SStanislaw Gruszka {
31599777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
31699777288SStanislaw Gruszka }
31799777288SStanislaw Gruszka 
318dc186ad7SThomas Gleixner /*
319dc186ad7SThomas Gleixner  * fixup_init is called when:
320dc186ad7SThomas Gleixner  * - an active object is initialized
321dc186ad7SThomas Gleixner  */
322dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
323dc186ad7SThomas Gleixner {
324dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
325dc186ad7SThomas Gleixner 
326dc186ad7SThomas Gleixner 	switch (state) {
327dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
328dc186ad7SThomas Gleixner 		cancel_work_sync(work);
329dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
330dc186ad7SThomas Gleixner 		return 1;
331dc186ad7SThomas Gleixner 	default:
332dc186ad7SThomas Gleixner 		return 0;
333dc186ad7SThomas Gleixner 	}
334dc186ad7SThomas Gleixner }
335dc186ad7SThomas Gleixner 
336dc186ad7SThomas Gleixner /*
337dc186ad7SThomas Gleixner  * fixup_activate is called when:
338dc186ad7SThomas Gleixner  * - an active object is activated
339dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
340dc186ad7SThomas Gleixner  */
341dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
342dc186ad7SThomas Gleixner {
343dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
344dc186ad7SThomas Gleixner 
345dc186ad7SThomas Gleixner 	switch (state) {
346dc186ad7SThomas Gleixner 
347dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
348dc186ad7SThomas Gleixner 		/*
349dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
350dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
351dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
352dc186ad7SThomas Gleixner 		 */
35322df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
354dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
355dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
356dc186ad7SThomas Gleixner 			return 0;
357dc186ad7SThomas Gleixner 		}
358dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
359dc186ad7SThomas Gleixner 		return 0;
360dc186ad7SThomas Gleixner 
361dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
362dc186ad7SThomas Gleixner 		WARN_ON(1);
363dc186ad7SThomas Gleixner 
364dc186ad7SThomas Gleixner 	default:
365dc186ad7SThomas Gleixner 		return 0;
366dc186ad7SThomas Gleixner 	}
367dc186ad7SThomas Gleixner }
368dc186ad7SThomas Gleixner 
369dc186ad7SThomas Gleixner /*
370dc186ad7SThomas Gleixner  * fixup_free is called when:
371dc186ad7SThomas Gleixner  * - an active object is freed
372dc186ad7SThomas Gleixner  */
373dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
374dc186ad7SThomas Gleixner {
375dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
376dc186ad7SThomas Gleixner 
377dc186ad7SThomas Gleixner 	switch (state) {
378dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
379dc186ad7SThomas Gleixner 		cancel_work_sync(work);
380dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
381dc186ad7SThomas Gleixner 		return 1;
382dc186ad7SThomas Gleixner 	default:
383dc186ad7SThomas Gleixner 		return 0;
384dc186ad7SThomas Gleixner 	}
385dc186ad7SThomas Gleixner }
386dc186ad7SThomas Gleixner 
387dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
388dc186ad7SThomas Gleixner 	.name		= "work_struct",
38999777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
390dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
391dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
392dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
393dc186ad7SThomas Gleixner };
394dc186ad7SThomas Gleixner 
395dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
396dc186ad7SThomas Gleixner {
397dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
398dc186ad7SThomas Gleixner }
399dc186ad7SThomas Gleixner 
400dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
401dc186ad7SThomas Gleixner {
402dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
403dc186ad7SThomas Gleixner }
404dc186ad7SThomas Gleixner 
405dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
406dc186ad7SThomas Gleixner {
407dc186ad7SThomas Gleixner 	if (onstack)
408dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
409dc186ad7SThomas Gleixner 	else
410dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
411dc186ad7SThomas Gleixner }
412dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
413dc186ad7SThomas Gleixner 
414dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
415dc186ad7SThomas Gleixner {
416dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
417dc186ad7SThomas Gleixner }
418dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
419dc186ad7SThomas Gleixner 
420dc186ad7SThomas Gleixner #else
421dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
422dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
423dc186ad7SThomas Gleixner #endif
424dc186ad7SThomas Gleixner 
42595402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
42695402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4271da177e4SLinus Torvalds static LIST_HEAD(workqueues);
428a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4291da177e4SLinus Torvalds 
43014441960SOleg Nesterov /*
431e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
432e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
433e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
43414441960SOleg Nesterov  */
4358b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
436e34cdddbSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_STD_WORKER_POOLS]);
437f756d5e2SNathan Lynch 
438f3421797STejun Heo /*
43924647570STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The pools
44024647570STejun Heo  * for online CPUs have POOL_DISASSOCIATED set, and all their workers have
44124647570STejun Heo  * WORKER_UNBOUND set.
442f3421797STejun Heo  */
443f3421797STejun Heo static struct global_cwq unbound_global_cwq;
444e34cdddbSTejun Heo static atomic_t unbound_pool_nr_running[NR_STD_WORKER_POOLS] = {
445e34cdddbSTejun Heo 	[0 ... NR_STD_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4464ce62e9eSTejun Heo };
447f3421797STejun Heo 
4489daf9e67STejun Heo /* idr of all pools */
4499daf9e67STejun Heo static DEFINE_MUTEX(worker_pool_idr_mutex);
4509daf9e67STejun Heo static DEFINE_IDR(worker_pool_idr);
4519daf9e67STejun Heo 
452c34056a3STejun Heo static int worker_thread(void *__worker);
4531da177e4SLinus Torvalds 
454e34cdddbSTejun Heo static int std_worker_pool_pri(struct worker_pool *pool)
4553270476aSTejun Heo {
4563270476aSTejun Heo 	return pool - pool->gcwq->pools;
4573270476aSTejun Heo }
4583270476aSTejun Heo 
4598b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4601da177e4SLinus Torvalds {
461f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4628b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
463f3421797STejun Heo 	else
464f3421797STejun Heo 		return &unbound_global_cwq;
4651da177e4SLinus Torvalds }
4661da177e4SLinus Torvalds 
4679daf9e67STejun Heo /* allocate ID and assign it to @pool */
4689daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
4699daf9e67STejun Heo {
4709daf9e67STejun Heo 	int ret;
4719daf9e67STejun Heo 
4729daf9e67STejun Heo 	mutex_lock(&worker_pool_idr_mutex);
4739daf9e67STejun Heo 	idr_pre_get(&worker_pool_idr, GFP_KERNEL);
4749daf9e67STejun Heo 	ret = idr_get_new(&worker_pool_idr, pool, &pool->id);
4759daf9e67STejun Heo 	mutex_unlock(&worker_pool_idr_mutex);
4769daf9e67STejun Heo 
4779daf9e67STejun Heo 	return ret;
4789daf9e67STejun Heo }
4799daf9e67STejun Heo 
4807c3eed5cSTejun Heo /*
4817c3eed5cSTejun Heo  * Lookup worker_pool by id.  The idr currently is built during boot and
4827c3eed5cSTejun Heo  * never modified.  Don't worry about locking for now.
4837c3eed5cSTejun Heo  */
4847c3eed5cSTejun Heo static struct worker_pool *worker_pool_by_id(int pool_id)
4857c3eed5cSTejun Heo {
4867c3eed5cSTejun Heo 	return idr_find(&worker_pool_idr, pool_id);
4877c3eed5cSTejun Heo }
4887c3eed5cSTejun Heo 
489*d565ed63STejun Heo static struct worker_pool *get_std_worker_pool(int cpu, bool highpri)
490*d565ed63STejun Heo {
491*d565ed63STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
492*d565ed63STejun Heo 
493*d565ed63STejun Heo 	return &gcwq->pools[highpri];
494*d565ed63STejun Heo }
495*d565ed63STejun Heo 
49663d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
497b1f4ec17SOleg Nesterov {
498ec22ca5eSTejun Heo 	int cpu = pool->cpu;
499e34cdddbSTejun Heo 	int idx = std_worker_pool_pri(pool);
50063d95a91STejun Heo 
501f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
5024ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
503f3421797STejun Heo 	else
5044ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
505b1f4ec17SOleg Nesterov }
506b1f4ec17SOleg Nesterov 
5074690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
5084690c4abSTejun Heo 					    struct workqueue_struct *wq)
509a848e3b6SOleg Nesterov {
510f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
511e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
512bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
513f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
514f3421797STejun Heo 		return wq->cpu_wq.single;
515f3421797STejun Heo 	return NULL;
516f3421797STejun Heo }
517a848e3b6SOleg Nesterov 
51873f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
51973f53c4aSTejun Heo {
52073f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
52173f53c4aSTejun Heo }
52273f53c4aSTejun Heo 
52373f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
52473f53c4aSTejun Heo {
52573f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
52673f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
52773f53c4aSTejun Heo }
52873f53c4aSTejun Heo 
52973f53c4aSTejun Heo static int work_next_color(int color)
53073f53c4aSTejun Heo {
53173f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5321da177e4SLinus Torvalds }
5331da177e4SLinus Torvalds 
5344594bf15SDavid Howells /*
535b5490077STejun Heo  * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
536b5490077STejun Heo  * contain the pointer to the queued cwq.  Once execution starts, the flag
5377c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
5387a22ad75STejun Heo  *
5397c3eed5cSTejun Heo  * set_work_cwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
5407c3eed5cSTejun Heo  * and clear_work_data() can be used to set the cwq, pool or clear
541bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
542bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5437a22ad75STejun Heo  *
5447c3eed5cSTejun Heo  * get_work_pool() and get_work_cwq() can be used to obtain the pool or cwq
5457c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
5467c3eed5cSTejun Heo  * queued anywhere after initialization until it is sync canceled.  cwq is
5477c3eed5cSTejun Heo  * available only while the work item is queued.
548bbb68dfaSTejun Heo  *
549bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
550bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
551bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
552bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5534594bf15SDavid Howells  */
5547a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5557a22ad75STejun Heo 				 unsigned long flags)
5567a22ad75STejun Heo {
5577a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5587a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5597a22ad75STejun Heo }
5607a22ad75STejun Heo 
5617a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5624690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5634690c4abSTejun Heo 			 unsigned long extra_flags)
564365970a1SDavid Howells {
5657a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
566e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
567365970a1SDavid Howells }
568365970a1SDavid Howells 
5697c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
5707c3eed5cSTejun Heo 					    int pool_id)
5714d707b9fSOleg Nesterov {
57223657bb1STejun Heo 	/*
57323657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
57423657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
57523657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
57623657bb1STejun Heo 	 * owner.
57723657bb1STejun Heo 	 */
57823657bb1STejun Heo 	smp_wmb();
5797c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
5804d707b9fSOleg Nesterov }
5814d707b9fSOleg Nesterov 
5827a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
583365970a1SDavid Howells {
5847c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
5857c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
5867a22ad75STejun Heo }
5877a22ad75STejun Heo 
5887a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5897a22ad75STejun Heo {
590e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5917a22ad75STejun Heo 
592e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
593e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
594e120153dSTejun Heo 	else
595e120153dSTejun Heo 		return NULL;
5967a22ad75STejun Heo }
5977a22ad75STejun Heo 
5987c3eed5cSTejun Heo /**
5997c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
6007c3eed5cSTejun Heo  * @work: the work item of interest
6017c3eed5cSTejun Heo  *
6027c3eed5cSTejun Heo  * Return the worker_pool @work was last associated with.  %NULL if none.
6037c3eed5cSTejun Heo  */
6047c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
6057a22ad75STejun Heo {
606e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
6077c3eed5cSTejun Heo 	struct worker_pool *pool;
6087c3eed5cSTejun Heo 	int pool_id;
6097a22ad75STejun Heo 
610e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
611e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
6127c3eed5cSTejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool;
6137a22ad75STejun Heo 
6147c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
6157c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
6167a22ad75STejun Heo 		return NULL;
6177a22ad75STejun Heo 
6187c3eed5cSTejun Heo 	pool = worker_pool_by_id(pool_id);
6197c3eed5cSTejun Heo 	WARN_ON_ONCE(!pool);
6207c3eed5cSTejun Heo 	return pool;
6217c3eed5cSTejun Heo }
6227c3eed5cSTejun Heo 
6237c3eed5cSTejun Heo /**
6247c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
6257c3eed5cSTejun Heo  * @work: the work item of interest
6267c3eed5cSTejun Heo  *
6277c3eed5cSTejun Heo  * Return the worker_pool ID @work was last associated with.
6287c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
6297c3eed5cSTejun Heo  */
6307c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
6317c3eed5cSTejun Heo {
6327c3eed5cSTejun Heo 	struct worker_pool *pool = get_work_pool(work);
6337c3eed5cSTejun Heo 
6347c3eed5cSTejun Heo 	return pool ? pool->id : WORK_OFFQ_POOL_NONE;
6357c3eed5cSTejun Heo }
6367c3eed5cSTejun Heo 
637bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
638bbb68dfaSTejun Heo {
6397c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
640bbb68dfaSTejun Heo 
6417c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
6427c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
643bbb68dfaSTejun Heo }
644bbb68dfaSTejun Heo 
645bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
646bbb68dfaSTejun Heo {
647bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
648bbb68dfaSTejun Heo 
649bbb68dfaSTejun Heo 	return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
650bbb68dfaSTejun Heo }
651bbb68dfaSTejun Heo 
652e22bee78STejun Heo /*
6533270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
6543270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
655*d565ed63STejun Heo  * they're being called with pool->lock held.
656e22bee78STejun Heo  */
657e22bee78STejun Heo 
65863d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
659649027d7STejun Heo {
6603270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
661649027d7STejun Heo }
662649027d7STejun Heo 
663e22bee78STejun Heo /*
664e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
665e22bee78STejun Heo  * running workers.
666974271c4STejun Heo  *
667974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
668974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
669974271c4STejun Heo  * worklist isn't empty.
670e22bee78STejun Heo  */
67163d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
672e22bee78STejun Heo {
67363d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
674e22bee78STejun Heo }
675e22bee78STejun Heo 
676e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
67763d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
678e22bee78STejun Heo {
67963d95a91STejun Heo 	return pool->nr_idle;
680e22bee78STejun Heo }
681e22bee78STejun Heo 
682e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
68363d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
684e22bee78STejun Heo {
68563d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
686e22bee78STejun Heo 
6873270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
688e22bee78STejun Heo }
689e22bee78STejun Heo 
690e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
69163d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
692e22bee78STejun Heo {
69363d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
694e22bee78STejun Heo }
695e22bee78STejun Heo 
696e22bee78STejun Heo /* Do I need to be the manager? */
69763d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
698e22bee78STejun Heo {
69963d95a91STejun Heo 	return need_to_create_worker(pool) ||
70011ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
701e22bee78STejun Heo }
702e22bee78STejun Heo 
703e22bee78STejun Heo /* Do we have too many workers and should some go away? */
70463d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
705e22bee78STejun Heo {
706552a37e9SLai Jiangshan 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
70763d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
70863d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
709e22bee78STejun Heo 
710ea1abd61SLai Jiangshan 	/*
711ea1abd61SLai Jiangshan 	 * nr_idle and idle_list may disagree if idle rebinding is in
712ea1abd61SLai Jiangshan 	 * progress.  Never return %true if idle_list is empty.
713ea1abd61SLai Jiangshan 	 */
714ea1abd61SLai Jiangshan 	if (list_empty(&pool->idle_list))
715ea1abd61SLai Jiangshan 		return false;
716ea1abd61SLai Jiangshan 
717e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
718e22bee78STejun Heo }
719e22bee78STejun Heo 
720e22bee78STejun Heo /*
721e22bee78STejun Heo  * Wake up functions.
722e22bee78STejun Heo  */
723e22bee78STejun Heo 
7247e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
72563d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
7267e11629dSTejun Heo {
72763d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
7287e11629dSTejun Heo 		return NULL;
7297e11629dSTejun Heo 
73063d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
7317e11629dSTejun Heo }
7327e11629dSTejun Heo 
7337e11629dSTejun Heo /**
7347e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
73563d95a91STejun Heo  * @pool: worker pool to wake worker from
7367e11629dSTejun Heo  *
73763d95a91STejun Heo  * Wake up the first idle worker of @pool.
7387e11629dSTejun Heo  *
7397e11629dSTejun Heo  * CONTEXT:
740*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
7417e11629dSTejun Heo  */
74263d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
7437e11629dSTejun Heo {
74463d95a91STejun Heo 	struct worker *worker = first_worker(pool);
7457e11629dSTejun Heo 
7467e11629dSTejun Heo 	if (likely(worker))
7477e11629dSTejun Heo 		wake_up_process(worker->task);
7487e11629dSTejun Heo }
7497e11629dSTejun Heo 
7504690c4abSTejun Heo /**
751e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
752e22bee78STejun Heo  * @task: task waking up
753e22bee78STejun Heo  * @cpu: CPU @task is waking up to
754e22bee78STejun Heo  *
755e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
756e22bee78STejun Heo  * being awoken.
757e22bee78STejun Heo  *
758e22bee78STejun Heo  * CONTEXT:
759e22bee78STejun Heo  * spin_lock_irq(rq->lock)
760e22bee78STejun Heo  */
761e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
762e22bee78STejun Heo {
763e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
764e22bee78STejun Heo 
76536576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
766ec22ca5eSTejun Heo 		WARN_ON_ONCE(worker->pool->cpu != cpu);
76763d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
768e22bee78STejun Heo 	}
76936576000SJoonsoo Kim }
770e22bee78STejun Heo 
771e22bee78STejun Heo /**
772e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
773e22bee78STejun Heo  * @task: task going to sleep
774e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
775e22bee78STejun Heo  *
776e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
777e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
778e22bee78STejun Heo  * returning pointer to its task.
779e22bee78STejun Heo  *
780e22bee78STejun Heo  * CONTEXT:
781e22bee78STejun Heo  * spin_lock_irq(rq->lock)
782e22bee78STejun Heo  *
783e22bee78STejun Heo  * RETURNS:
784e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
785e22bee78STejun Heo  */
786e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
787e22bee78STejun Heo 				       unsigned int cpu)
788e22bee78STejun Heo {
789e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
790111c225aSTejun Heo 	struct worker_pool *pool;
791111c225aSTejun Heo 	atomic_t *nr_running;
792e22bee78STejun Heo 
793111c225aSTejun Heo 	/*
794111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
795111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
796111c225aSTejun Heo 	 * checking NOT_RUNNING.
797111c225aSTejun Heo 	 */
7982d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
799e22bee78STejun Heo 		return NULL;
800e22bee78STejun Heo 
801111c225aSTejun Heo 	pool = worker->pool;
802111c225aSTejun Heo 	nr_running = get_pool_nr_running(pool);
803111c225aSTejun Heo 
804e22bee78STejun Heo 	/* this can only happen on the local cpu */
805e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
806e22bee78STejun Heo 
807e22bee78STejun Heo 	/*
808e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
809e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
810e22bee78STejun Heo 	 * Please read comment there.
811e22bee78STejun Heo 	 *
812628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
813628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
814628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
815*d565ed63STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without pool
816628c78e7STejun Heo 	 * lock is safe.
817e22bee78STejun Heo 	 */
818bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
81963d95a91STejun Heo 		to_wakeup = first_worker(pool);
820e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
821e22bee78STejun Heo }
822e22bee78STejun Heo 
823e22bee78STejun Heo /**
824e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
825cb444766STejun Heo  * @worker: self
826d302f017STejun Heo  * @flags: flags to set
827d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
828d302f017STejun Heo  *
829e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
830e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
831e22bee78STejun Heo  * woken up.
832d302f017STejun Heo  *
833cb444766STejun Heo  * CONTEXT:
834*d565ed63STejun Heo  * spin_lock_irq(pool->lock)
835d302f017STejun Heo  */
836d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
837d302f017STejun Heo 				    bool wakeup)
838d302f017STejun Heo {
839bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
840e22bee78STejun Heo 
841cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
842cb444766STejun Heo 
843e22bee78STejun Heo 	/*
844e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
845e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
846e22bee78STejun Heo 	 * @wakeup.
847e22bee78STejun Heo 	 */
848e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
849e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
85063d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
851e22bee78STejun Heo 
852e22bee78STejun Heo 		if (wakeup) {
853e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
854bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
85563d95a91STejun Heo 				wake_up_worker(pool);
856e22bee78STejun Heo 		} else
857e22bee78STejun Heo 			atomic_dec(nr_running);
858e22bee78STejun Heo 	}
859e22bee78STejun Heo 
860d302f017STejun Heo 	worker->flags |= flags;
861d302f017STejun Heo }
862d302f017STejun Heo 
863d302f017STejun Heo /**
864e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
865cb444766STejun Heo  * @worker: self
866d302f017STejun Heo  * @flags: flags to clear
867d302f017STejun Heo  *
868e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
869d302f017STejun Heo  *
870cb444766STejun Heo  * CONTEXT:
871*d565ed63STejun Heo  * spin_lock_irq(pool->lock)
872d302f017STejun Heo  */
873d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
874d302f017STejun Heo {
87563d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
876e22bee78STejun Heo 	unsigned int oflags = worker->flags;
877e22bee78STejun Heo 
878cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
879cb444766STejun Heo 
880d302f017STejun Heo 	worker->flags &= ~flags;
881e22bee78STejun Heo 
88242c025f3STejun Heo 	/*
88342c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
88442c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
88542c025f3STejun Heo 	 * of multiple flags, not a single flag.
88642c025f3STejun Heo 	 */
887e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
888e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
88963d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
890d302f017STejun Heo }
891d302f017STejun Heo 
892d302f017STejun Heo /**
8938cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
894c9e7cf27STejun Heo  * @pool: pool of interest
8958cca0eeaSTejun Heo  * @work: work to find worker for
8968cca0eeaSTejun Heo  *
897c9e7cf27STejun Heo  * Find a worker which is executing @work on @pool by searching
898c9e7cf27STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
899a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
900a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
901a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
902a2c1c57bSTejun Heo  * being executed.
903a2c1c57bSTejun Heo  *
904a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
905a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
906a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
907a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
908a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
909a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
910a2c1c57bSTejun Heo  *
911a2c1c57bSTejun Heo  * This function checks the work item address, work function and workqueue
912a2c1c57bSTejun Heo  * to avoid false positives.  Note that this isn't complete as one may
913a2c1c57bSTejun Heo  * construct a work function which can introduce dependency onto itself
914a2c1c57bSTejun Heo  * through a recycled work item.  Well, if somebody wants to shoot oneself
915a2c1c57bSTejun Heo  * in the foot that badly, there's only so much we can do, and if such
916a2c1c57bSTejun Heo  * deadlock actually occurs, it should be easy to locate the culprit work
917a2c1c57bSTejun Heo  * function.
9188cca0eeaSTejun Heo  *
9198cca0eeaSTejun Heo  * CONTEXT:
920*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
9218cca0eeaSTejun Heo  *
9228cca0eeaSTejun Heo  * RETURNS:
9238cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
9248cca0eeaSTejun Heo  * otherwise.
9258cca0eeaSTejun Heo  */
926c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
9278cca0eeaSTejun Heo 						 struct work_struct *work)
9288cca0eeaSTejun Heo {
92942f8570fSSasha Levin 	struct worker *worker;
93042f8570fSSasha Levin 	struct hlist_node *tmp;
93142f8570fSSasha Levin 
932c9e7cf27STejun Heo 	hash_for_each_possible(pool->busy_hash, worker, tmp, hentry,
933a2c1c57bSTejun Heo 			       (unsigned long)work)
934a2c1c57bSTejun Heo 		if (worker->current_work == work &&
935a2c1c57bSTejun Heo 		    worker->current_func == work->func)
93642f8570fSSasha Levin 			return worker;
93742f8570fSSasha Levin 
93842f8570fSSasha Levin 	return NULL;
9398cca0eeaSTejun Heo }
9408cca0eeaSTejun Heo 
9418cca0eeaSTejun Heo /**
942bf4ede01STejun Heo  * move_linked_works - move linked works to a list
943bf4ede01STejun Heo  * @work: start of series of works to be scheduled
944bf4ede01STejun Heo  * @head: target list to append @work to
945bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
946bf4ede01STejun Heo  *
947bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
948bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
949bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
950bf4ede01STejun Heo  *
951bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
952bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
953bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
954bf4ede01STejun Heo  *
955bf4ede01STejun Heo  * CONTEXT:
956*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
957bf4ede01STejun Heo  */
958bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
959bf4ede01STejun Heo 			      struct work_struct **nextp)
960bf4ede01STejun Heo {
961bf4ede01STejun Heo 	struct work_struct *n;
962bf4ede01STejun Heo 
963bf4ede01STejun Heo 	/*
964bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
965bf4ede01STejun Heo 	 * use NULL for list head.
966bf4ede01STejun Heo 	 */
967bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
968bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
969bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
970bf4ede01STejun Heo 			break;
971bf4ede01STejun Heo 	}
972bf4ede01STejun Heo 
973bf4ede01STejun Heo 	/*
974bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
975bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
976bf4ede01STejun Heo 	 * needs to be updated.
977bf4ede01STejun Heo 	 */
978bf4ede01STejun Heo 	if (nextp)
979bf4ede01STejun Heo 		*nextp = n;
980bf4ede01STejun Heo }
981bf4ede01STejun Heo 
9823aa62497SLai Jiangshan static void cwq_activate_delayed_work(struct work_struct *work)
983bf4ede01STejun Heo {
9843aa62497SLai Jiangshan 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
985bf4ede01STejun Heo 
986bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
987bf4ede01STejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
988bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
989bf4ede01STejun Heo 	cwq->nr_active++;
990bf4ede01STejun Heo }
991bf4ede01STejun Heo 
9923aa62497SLai Jiangshan static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
9933aa62497SLai Jiangshan {
9943aa62497SLai Jiangshan 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
9953aa62497SLai Jiangshan 						    struct work_struct, entry);
9963aa62497SLai Jiangshan 
9973aa62497SLai Jiangshan 	cwq_activate_delayed_work(work);
9983aa62497SLai Jiangshan }
9993aa62497SLai Jiangshan 
1000bf4ede01STejun Heo /**
1001bf4ede01STejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1002bf4ede01STejun Heo  * @cwq: cwq of interest
1003bf4ede01STejun Heo  * @color: color of work which left the queue
1004bf4ede01STejun Heo  *
1005bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1006bf4ede01STejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
1007bf4ede01STejun Heo  *
1008bf4ede01STejun Heo  * CONTEXT:
1009*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1010bf4ede01STejun Heo  */
1011b3f9f405SLai Jiangshan static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
1012bf4ede01STejun Heo {
1013bf4ede01STejun Heo 	/* ignore uncolored works */
1014bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
1015bf4ede01STejun Heo 		return;
1016bf4ede01STejun Heo 
1017bf4ede01STejun Heo 	cwq->nr_in_flight[color]--;
1018bf4ede01STejun Heo 
1019bf4ede01STejun Heo 	cwq->nr_active--;
1020bf4ede01STejun Heo 	if (!list_empty(&cwq->delayed_works)) {
1021bf4ede01STejun Heo 		/* one down, submit a delayed one */
1022bf4ede01STejun Heo 		if (cwq->nr_active < cwq->max_active)
1023bf4ede01STejun Heo 			cwq_activate_first_delayed(cwq);
1024bf4ede01STejun Heo 	}
1025bf4ede01STejun Heo 
1026bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1027bf4ede01STejun Heo 	if (likely(cwq->flush_color != color))
1028bf4ede01STejun Heo 		return;
1029bf4ede01STejun Heo 
1030bf4ede01STejun Heo 	/* are there still in-flight works? */
1031bf4ede01STejun Heo 	if (cwq->nr_in_flight[color])
1032bf4ede01STejun Heo 		return;
1033bf4ede01STejun Heo 
1034bf4ede01STejun Heo 	/* this cwq is done, clear flush_color */
1035bf4ede01STejun Heo 	cwq->flush_color = -1;
1036bf4ede01STejun Heo 
1037bf4ede01STejun Heo 	/*
1038bf4ede01STejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
1039bf4ede01STejun Heo 	 * will handle the rest.
1040bf4ede01STejun Heo 	 */
1041bf4ede01STejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1042bf4ede01STejun Heo 		complete(&cwq->wq->first_flusher->done);
1043bf4ede01STejun Heo }
1044bf4ede01STejun Heo 
104536e227d2STejun Heo /**
1046bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
104736e227d2STejun Heo  * @work: work item to steal
104836e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1049bbb68dfaSTejun Heo  * @flags: place to store irq state
105036e227d2STejun Heo  *
105136e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
105236e227d2STejun Heo  * stable state - idle, on timer or on worklist.  Return values are
105336e227d2STejun Heo  *
105436e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
105536e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
105636e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1057bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1058bbb68dfaSTejun Heo  *		for arbitrarily long
105936e227d2STejun Heo  *
1060bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1061e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1062e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1063e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1064bbb68dfaSTejun Heo  *
1065bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1066bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1067bbb68dfaSTejun Heo  *
1068e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1069bf4ede01STejun Heo  */
1070bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1071bbb68dfaSTejun Heo 			       unsigned long *flags)
1072bf4ede01STejun Heo {
1073*d565ed63STejun Heo 	struct worker_pool *pool;
1074bf4ede01STejun Heo 
1075bbb68dfaSTejun Heo 	local_irq_save(*flags);
1076bbb68dfaSTejun Heo 
107736e227d2STejun Heo 	/* try to steal the timer if it exists */
107836e227d2STejun Heo 	if (is_dwork) {
107936e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
108036e227d2STejun Heo 
1081e0aecdd8STejun Heo 		/*
1082e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1083e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1084e0aecdd8STejun Heo 		 * running on the local CPU.
1085e0aecdd8STejun Heo 		 */
108636e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
108736e227d2STejun Heo 			return 1;
108836e227d2STejun Heo 	}
108936e227d2STejun Heo 
109036e227d2STejun Heo 	/* try to claim PENDING the normal way */
1091bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1092bf4ede01STejun Heo 		return 0;
1093bf4ede01STejun Heo 
1094bf4ede01STejun Heo 	/*
1095bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1096bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1097bf4ede01STejun Heo 	 */
1098*d565ed63STejun Heo 	pool = get_work_pool(work);
1099*d565ed63STejun Heo 	if (!pool)
1100bbb68dfaSTejun Heo 		goto fail;
1101bf4ede01STejun Heo 
1102*d565ed63STejun Heo 	spin_lock(&pool->lock);
1103bf4ede01STejun Heo 	if (!list_empty(&work->entry)) {
1104bf4ede01STejun Heo 		/*
1105*d565ed63STejun Heo 		 * This work is queued, but perhaps we locked the wrong
1106*d565ed63STejun Heo 		 * pool.  In that case we must see the new value after
1107*d565ed63STejun Heo 		 * rmb(), see insert_work()->wmb().
1108bf4ede01STejun Heo 		 */
1109bf4ede01STejun Heo 		smp_rmb();
1110*d565ed63STejun Heo 		if (pool == get_work_pool(work)) {
1111bf4ede01STejun Heo 			debug_work_deactivate(work);
11123aa62497SLai Jiangshan 
11133aa62497SLai Jiangshan 			/*
11143aa62497SLai Jiangshan 			 * A delayed work item cannot be grabbed directly
11153aa62497SLai Jiangshan 			 * because it might have linked NO_COLOR work items
11163aa62497SLai Jiangshan 			 * which, if left on the delayed_list, will confuse
11173aa62497SLai Jiangshan 			 * cwq->nr_active management later on and cause
11183aa62497SLai Jiangshan 			 * stall.  Make sure the work item is activated
11193aa62497SLai Jiangshan 			 * before grabbing.
11203aa62497SLai Jiangshan 			 */
11213aa62497SLai Jiangshan 			if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
11223aa62497SLai Jiangshan 				cwq_activate_delayed_work(work);
11233aa62497SLai Jiangshan 
1124bf4ede01STejun Heo 			list_del_init(&work->entry);
1125bf4ede01STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
1126b3f9f405SLai Jiangshan 				get_work_color(work));
112736e227d2STejun Heo 
1128*d565ed63STejun Heo 			spin_unlock(&pool->lock);
112936e227d2STejun Heo 			return 1;
1130bf4ede01STejun Heo 		}
1131bf4ede01STejun Heo 	}
1132*d565ed63STejun Heo 	spin_unlock(&pool->lock);
1133bbb68dfaSTejun Heo fail:
1134bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1135bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1136bbb68dfaSTejun Heo 		return -ENOENT;
1137bbb68dfaSTejun Heo 	cpu_relax();
113836e227d2STejun Heo 	return -EAGAIN;
1139bf4ede01STejun Heo }
1140bf4ede01STejun Heo 
1141bf4ede01STejun Heo /**
11427e11629dSTejun Heo  * insert_work - insert a work into gcwq
11434690c4abSTejun Heo  * @cwq: cwq @work belongs to
11444690c4abSTejun Heo  * @work: work to insert
11454690c4abSTejun Heo  * @head: insertion point
11464690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
11474690c4abSTejun Heo  *
11487e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
11497e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
11504690c4abSTejun Heo  *
11514690c4abSTejun Heo  * CONTEXT:
1152*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1153365970a1SDavid Howells  */
1154b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
11554690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
11564690c4abSTejun Heo 			unsigned int extra_flags)
1157b89deed3SOleg Nesterov {
115863d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
1159e1d8aa9fSFrederic Weisbecker 
11604690c4abSTejun Heo 	/* we own @work, set data and link */
11617a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
11624690c4abSTejun Heo 
11636e84d644SOleg Nesterov 	/*
11646e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
11656e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
11666e84d644SOleg Nesterov 	 */
11676e84d644SOleg Nesterov 	smp_wmb();
11684690c4abSTejun Heo 
11691a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
1170e22bee78STejun Heo 
1171e22bee78STejun Heo 	/*
1172e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
1173e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
1174e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
1175e22bee78STejun Heo 	 */
1176e22bee78STejun Heo 	smp_mb();
1177e22bee78STejun Heo 
117863d95a91STejun Heo 	if (__need_more_worker(pool))
117963d95a91STejun Heo 		wake_up_worker(pool);
1180b89deed3SOleg Nesterov }
1181b89deed3SOleg Nesterov 
1182c8efcc25STejun Heo /*
1183c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
1184c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
1185c8efcc25STejun Heo  * cold paths.
1186c8efcc25STejun Heo  */
1187c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1188c8efcc25STejun Heo {
1189c8efcc25STejun Heo 	unsigned long flags;
1190c8efcc25STejun Heo 	unsigned int cpu;
1191c8efcc25STejun Heo 
1192c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
1193c9e7cf27STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
1194c9e7cf27STejun Heo 		struct worker_pool *pool = cwq->pool;
1195c8efcc25STejun Heo 		struct worker *worker;
1196c8efcc25STejun Heo 		struct hlist_node *pos;
1197c8efcc25STejun Heo 		int i;
1198c8efcc25STejun Heo 
1199*d565ed63STejun Heo 		spin_lock_irqsave(&pool->lock, flags);
1200c9e7cf27STejun Heo 		for_each_busy_worker(worker, i, pos, pool) {
1201c8efcc25STejun Heo 			if (worker->task != current)
1202c8efcc25STejun Heo 				continue;
1203*d565ed63STejun Heo 			spin_unlock_irqrestore(&pool->lock, flags);
1204c8efcc25STejun Heo 			/*
1205c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
1206c8efcc25STejun Heo 			 * is headed to the same workqueue.
1207c8efcc25STejun Heo 			 */
1208c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
1209c8efcc25STejun Heo 		}
1210*d565ed63STejun Heo 		spin_unlock_irqrestore(&pool->lock, flags);
1211c8efcc25STejun Heo 	}
1212c8efcc25STejun Heo 	return false;
1213c8efcc25STejun Heo }
1214c8efcc25STejun Heo 
12154690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
12161da177e4SLinus Torvalds 			 struct work_struct *work)
12171da177e4SLinus Torvalds {
1218*d565ed63STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
1219*d565ed63STejun Heo 	struct worker_pool *pool;
1220502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
12211e19ffc6STejun Heo 	struct list_head *worklist;
12228a2e8e5dSTejun Heo 	unsigned int work_flags;
1223b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
12248930cabaSTejun Heo 
12258930cabaSTejun Heo 	/*
12268930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
12278930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
12288930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
12298930cabaSTejun Heo 	 * happen with IRQ disabled.
12308930cabaSTejun Heo 	 */
12318930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
12321da177e4SLinus Torvalds 
1233dc186ad7SThomas Gleixner 	debug_work_activate(work);
12341e19ffc6STejun Heo 
1235c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
12369c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1237c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1238e41e704bSTejun Heo 		return;
1239e41e704bSTejun Heo 
1240*d565ed63STejun Heo 	/* determine pool to use */
1241c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1242c9e7cf27STejun Heo 		struct worker_pool *last_pool;
1243c7fc77f7STejun Heo 
124457469821STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
1245f3421797STejun Heo 			cpu = raw_smp_processor_id();
1246f3421797STejun Heo 
124718aa9effSTejun Heo 		/*
1248dbf2576eSTejun Heo 		 * It's multi cpu.  If @work was previously on a different
1249dbf2576eSTejun Heo 		 * cpu, it might still be running there, in which case the
1250dbf2576eSTejun Heo 		 * work needs to be queued on that cpu to guarantee
1251dbf2576eSTejun Heo 		 * non-reentrancy.
125218aa9effSTejun Heo 		 */
1253*d565ed63STejun Heo 		pool = get_std_worker_pool(cpu, highpri);
1254c9e7cf27STejun Heo 		last_pool = get_work_pool(work);
1255dbf2576eSTejun Heo 
1256*d565ed63STejun Heo 		if (last_pool && last_pool != pool) {
125718aa9effSTejun Heo 			struct worker *worker;
125818aa9effSTejun Heo 
1259*d565ed63STejun Heo 			spin_lock(&last_pool->lock);
126018aa9effSTejun Heo 
1261c9e7cf27STejun Heo 			worker = find_worker_executing_work(last_pool, work);
126218aa9effSTejun Heo 
126318aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
1264*d565ed63STejun Heo 				pool = last_pool;
126518aa9effSTejun Heo 			else {
126618aa9effSTejun Heo 				/* meh... not running there, queue here */
1267*d565ed63STejun Heo 				spin_unlock(&last_pool->lock);
1268*d565ed63STejun Heo 				spin_lock(&pool->lock);
126918aa9effSTejun Heo 			}
12708930cabaSTejun Heo 		} else {
1271*d565ed63STejun Heo 			spin_lock(&pool->lock);
12728930cabaSTejun Heo 		}
1273f3421797STejun Heo 	} else {
1274*d565ed63STejun Heo 		pool = get_std_worker_pool(WORK_CPU_UNBOUND, highpri);
1275*d565ed63STejun Heo 		spin_lock(&pool->lock);
1276502ca9d8STejun Heo 	}
1277502ca9d8STejun Heo 
1278*d565ed63STejun Heo 	/* pool determined, get cwq and queue */
1279*d565ed63STejun Heo 	cwq = get_cwq(pool->cpu, wq);
1280b75cac93SJoonsoo Kim 	trace_workqueue_queue_work(req_cpu, cwq, work);
1281502ca9d8STejun Heo 
1282f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1283*d565ed63STejun Heo 		spin_unlock(&pool->lock);
1284f5b2552bSDan Carpenter 		return;
1285f5b2552bSDan Carpenter 	}
12861e19ffc6STejun Heo 
128773f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
12888a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
12891e19ffc6STejun Heo 
12901e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1291cdadf009STejun Heo 		trace_workqueue_activate_work(work);
12921e19ffc6STejun Heo 		cwq->nr_active++;
12933270476aSTejun Heo 		worklist = &cwq->pool->worklist;
12948a2e8e5dSTejun Heo 	} else {
12958a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
12961e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
12978a2e8e5dSTejun Heo 	}
12981e19ffc6STejun Heo 
12998a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
13001e19ffc6STejun Heo 
1301*d565ed63STejun Heo 	spin_unlock(&pool->lock);
13021da177e4SLinus Torvalds }
13031da177e4SLinus Torvalds 
13040fcb78c2SRolf Eike Beer /**
1305c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1306c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1307c1a220e7SZhang Rui  * @wq: workqueue to use
1308c1a220e7SZhang Rui  * @work: work to queue
1309c1a220e7SZhang Rui  *
1310d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
1311c1a220e7SZhang Rui  *
1312c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1313c1a220e7SZhang Rui  * can't go away.
1314c1a220e7SZhang Rui  */
1315d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1316d4283e93STejun Heo 		   struct work_struct *work)
1317c1a220e7SZhang Rui {
1318d4283e93STejun Heo 	bool ret = false;
13198930cabaSTejun Heo 	unsigned long flags;
13208930cabaSTejun Heo 
13218930cabaSTejun Heo 	local_irq_save(flags);
1322c1a220e7SZhang Rui 
132322df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
13244690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1325d4283e93STejun Heo 		ret = true;
1326c1a220e7SZhang Rui 	}
13278930cabaSTejun Heo 
13288930cabaSTejun Heo 	local_irq_restore(flags);
1329c1a220e7SZhang Rui 	return ret;
1330c1a220e7SZhang Rui }
1331c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1332c1a220e7SZhang Rui 
13330a13c00eSTejun Heo /**
13340a13c00eSTejun Heo  * queue_work - queue work on a workqueue
13350a13c00eSTejun Heo  * @wq: workqueue to use
13360a13c00eSTejun Heo  * @work: work to queue
13370a13c00eSTejun Heo  *
1338d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
13390a13c00eSTejun Heo  *
13400a13c00eSTejun Heo  * We queue the work to the CPU on which it was submitted, but if the CPU dies
13410a13c00eSTejun Heo  * it can be processed by another CPU.
13420a13c00eSTejun Heo  */
1343d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
13440a13c00eSTejun Heo {
134557469821STejun Heo 	return queue_work_on(WORK_CPU_UNBOUND, wq, work);
13460a13c00eSTejun Heo }
13470a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work);
13480a13c00eSTejun Heo 
1349d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
13501da177e4SLinus Torvalds {
135152bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
13527a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
13531da177e4SLinus Torvalds 
1354e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
13551265057fSTejun Heo 	__queue_work(dwork->cpu, cwq->wq, &dwork->work);
13561da177e4SLinus Torvalds }
1357d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
13581da177e4SLinus Torvalds 
13597beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
136052bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
13611da177e4SLinus Torvalds {
13627beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
13637beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
13647beb2edfSTejun Heo 	unsigned int lcpu;
13651da177e4SLinus Torvalds 
13667beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
13677beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
1368fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1369fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
13707beb2edfSTejun Heo 
13718852aac2STejun Heo 	/*
13728852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
13738852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
13748852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
13758852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
13768852aac2STejun Heo 	 */
13778852aac2STejun Heo 	if (!delay) {
13788852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
13798852aac2STejun Heo 		return;
13808852aac2STejun Heo 	}
13818852aac2STejun Heo 
13827beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
13837beb2edfSTejun Heo 
13847beb2edfSTejun Heo 	/*
13857beb2edfSTejun Heo 	 * This stores cwq for the moment, for the timer_fn.  Note that the
1386ec22ca5eSTejun Heo 	 * work's pool is preserved to allow reentrance detection for
13877beb2edfSTejun Heo 	 * delayed works.
13887beb2edfSTejun Heo 	 */
13897beb2edfSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1390ec22ca5eSTejun Heo 		struct worker_pool *pool = get_work_pool(work);
13917beb2edfSTejun Heo 
1392e42986deSJoonsoo Kim 		/*
1393ec22ca5eSTejun Heo 		 * If we cannot get the last pool from @work directly,
1394e42986deSJoonsoo Kim 		 * select the last CPU such that it avoids unnecessarily
1395e42986deSJoonsoo Kim 		 * triggering non-reentrancy check in __queue_work().
1396e42986deSJoonsoo Kim 		 */
1397e42986deSJoonsoo Kim 		lcpu = cpu;
1398ec22ca5eSTejun Heo 		if (pool)
1399ec22ca5eSTejun Heo 			lcpu = pool->cpu;
1400e42986deSJoonsoo Kim 		if (lcpu == WORK_CPU_UNBOUND)
14017beb2edfSTejun Heo 			lcpu = raw_smp_processor_id();
14027beb2edfSTejun Heo 	} else {
14037beb2edfSTejun Heo 		lcpu = WORK_CPU_UNBOUND;
14041da177e4SLinus Torvalds 	}
14057beb2edfSTejun Heo 
14067beb2edfSTejun Heo 	set_work_cwq(work, get_cwq(lcpu, wq), 0);
14077beb2edfSTejun Heo 
14081265057fSTejun Heo 	dwork->cpu = cpu;
14097beb2edfSTejun Heo 	timer->expires = jiffies + delay;
14107beb2edfSTejun Heo 
14117beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
14127beb2edfSTejun Heo 		add_timer_on(timer, cpu);
14137beb2edfSTejun Heo 	else
14147beb2edfSTejun Heo 		add_timer(timer);
14157beb2edfSTejun Heo }
14161da177e4SLinus Torvalds 
14170fcb78c2SRolf Eike Beer /**
14180fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
14190fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
14200fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1421af9997e4SRandy Dunlap  * @dwork: work to queue
14220fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
14230fcb78c2SRolf Eike Beer  *
1424715f1300STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.  If
1425715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1426715f1300STejun Heo  * execution.
14270fcb78c2SRolf Eike Beer  */
1428d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
142952bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
14307a6bc1cdSVenkatesh Pallipadi {
143152bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1432d4283e93STejun Heo 	bool ret = false;
14338930cabaSTejun Heo 	unsigned long flags;
14348930cabaSTejun Heo 
14358930cabaSTejun Heo 	/* read the comment in __queue_work() */
14368930cabaSTejun Heo 	local_irq_save(flags);
14377a6bc1cdSVenkatesh Pallipadi 
143822df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14397beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1440d4283e93STejun Heo 		ret = true;
14417a6bc1cdSVenkatesh Pallipadi 	}
14428930cabaSTejun Heo 
14438930cabaSTejun Heo 	local_irq_restore(flags);
14447a6bc1cdSVenkatesh Pallipadi 	return ret;
14457a6bc1cdSVenkatesh Pallipadi }
1446ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
14471da177e4SLinus Torvalds 
1448c8e55f36STejun Heo /**
14490a13c00eSTejun Heo  * queue_delayed_work - queue work on a workqueue after delay
14500a13c00eSTejun Heo  * @wq: workqueue to use
14510a13c00eSTejun Heo  * @dwork: delayable work to queue
14520a13c00eSTejun Heo  * @delay: number of jiffies to wait before queueing
14530a13c00eSTejun Heo  *
1454715f1300STejun Heo  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
14550a13c00eSTejun Heo  */
1456d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq,
14570a13c00eSTejun Heo 			struct delayed_work *dwork, unsigned long delay)
14580a13c00eSTejun Heo {
145957469821STejun Heo 	return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14600a13c00eSTejun Heo }
14610a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work);
14620a13c00eSTejun Heo 
14630a13c00eSTejun Heo /**
14648376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
14658376fe22STejun Heo  * @cpu: CPU number to execute work on
14668376fe22STejun Heo  * @wq: workqueue to use
14678376fe22STejun Heo  * @dwork: work to queue
14688376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14698376fe22STejun Heo  *
14708376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
14718376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
14728376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
14738376fe22STejun Heo  * current state.
14748376fe22STejun Heo  *
14758376fe22STejun Heo  * Returns %false if @dwork was idle and queued, %true if @dwork was
14768376fe22STejun Heo  * pending and its timer was modified.
14778376fe22STejun Heo  *
1478e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
14798376fe22STejun Heo  * See try_to_grab_pending() for details.
14808376fe22STejun Heo  */
14818376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
14828376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
14838376fe22STejun Heo {
14848376fe22STejun Heo 	unsigned long flags;
14858376fe22STejun Heo 	int ret;
14868376fe22STejun Heo 
14878376fe22STejun Heo 	do {
14888376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
14898376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
14908376fe22STejun Heo 
14918376fe22STejun Heo 	if (likely(ret >= 0)) {
14928376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
14938376fe22STejun Heo 		local_irq_restore(flags);
14948376fe22STejun Heo 	}
14958376fe22STejun Heo 
14968376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
14978376fe22STejun Heo 	return ret;
14988376fe22STejun Heo }
14998376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
15008376fe22STejun Heo 
15018376fe22STejun Heo /**
15028376fe22STejun Heo  * mod_delayed_work - modify delay of or queue a delayed work
15038376fe22STejun Heo  * @wq: workqueue to use
15048376fe22STejun Heo  * @dwork: work to queue
15058376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
15068376fe22STejun Heo  *
15078376fe22STejun Heo  * mod_delayed_work_on() on local CPU.
15088376fe22STejun Heo  */
15098376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
15108376fe22STejun Heo 		      unsigned long delay)
15118376fe22STejun Heo {
15128376fe22STejun Heo 	return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
15138376fe22STejun Heo }
15148376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work);
15158376fe22STejun Heo 
15168376fe22STejun Heo /**
1517c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1518c8e55f36STejun Heo  * @worker: worker which is entering idle state
1519c8e55f36STejun Heo  *
1520c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1521c8e55f36STejun Heo  * necessary.
1522c8e55f36STejun Heo  *
1523c8e55f36STejun Heo  * LOCKING:
1524*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1525c8e55f36STejun Heo  */
1526c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
15271da177e4SLinus Torvalds {
1528bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1529c8e55f36STejun Heo 
1530c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1531c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1532c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1533c8e55f36STejun Heo 
1534cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1535cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1536bd7bdd43STejun Heo 	pool->nr_idle++;
1537e22bee78STejun Heo 	worker->last_active = jiffies;
1538c8e55f36STejun Heo 
1539c8e55f36STejun Heo 	/* idle_list is LIFO */
1540bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1541db7bccf4STejun Heo 
154263d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1543628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1544cb444766STejun Heo 
1545544ecf31STejun Heo 	/*
1546628c78e7STejun Heo 	 * Sanity check nr_running.  Because gcwq_unbind_fn() releases
1547*d565ed63STejun Heo 	 * pool->lock between setting %WORKER_UNBOUND and zapping
1548628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1549628c78e7STejun Heo 	 * unbind is not in progress.
1550544ecf31STejun Heo 	 */
155124647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1552bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
155363d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1554c8e55f36STejun Heo }
1555c8e55f36STejun Heo 
1556c8e55f36STejun Heo /**
1557c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1558c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1559c8e55f36STejun Heo  *
1560c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1561c8e55f36STejun Heo  *
1562c8e55f36STejun Heo  * LOCKING:
1563*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1564c8e55f36STejun Heo  */
1565c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1566c8e55f36STejun Heo {
1567bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1568c8e55f36STejun Heo 
1569c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1570d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1571bd7bdd43STejun Heo 	pool->nr_idle--;
1572c8e55f36STejun Heo 	list_del_init(&worker->entry);
1573c8e55f36STejun Heo }
1574c8e55f36STejun Heo 
1575e22bee78STejun Heo /**
1576e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1577e22bee78STejun Heo  * @worker: self
1578e22bee78STejun Heo  *
1579e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1580e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1581e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1582e22bee78STejun Heo  * guaranteed to execute on the cpu.
1583e22bee78STejun Heo  *
1584e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1585e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1586e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1587e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1588e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1589e22bee78STejun Heo  * [dis]associated in the meantime.
1590e22bee78STejun Heo  *
1591f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
159224647570STejun Heo  * binding against %POOL_DISASSOCIATED which is set during
1593f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1594f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1595f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1596e22bee78STejun Heo  *
1597e22bee78STejun Heo  * CONTEXT:
1598*d565ed63STejun Heo  * Might sleep.  Called without any lock but returns with pool->lock
1599e22bee78STejun Heo  * held.
1600e22bee78STejun Heo  *
1601e22bee78STejun Heo  * RETURNS:
1602e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1603e22bee78STejun Heo  * bound), %false if offline.
1604e22bee78STejun Heo  */
1605e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1606*d565ed63STejun Heo __acquires(&pool->lock)
1607e22bee78STejun Heo {
160824647570STejun Heo 	struct worker_pool *pool = worker->pool;
1609e22bee78STejun Heo 	struct task_struct *task = worker->task;
1610e22bee78STejun Heo 
1611e22bee78STejun Heo 	while (true) {
1612e22bee78STejun Heo 		/*
1613e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1614e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1615e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
161624647570STejun Heo 		 * against POOL_DISASSOCIATED.
1617e22bee78STejun Heo 		 */
161824647570STejun Heo 		if (!(pool->flags & POOL_DISASSOCIATED))
1619ec22ca5eSTejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(pool->cpu));
1620e22bee78STejun Heo 
1621*d565ed63STejun Heo 		spin_lock_irq(&pool->lock);
162224647570STejun Heo 		if (pool->flags & POOL_DISASSOCIATED)
1623e22bee78STejun Heo 			return false;
1624ec22ca5eSTejun Heo 		if (task_cpu(task) == pool->cpu &&
1625e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1626ec22ca5eSTejun Heo 				  get_cpu_mask(pool->cpu)))
1627e22bee78STejun Heo 			return true;
1628*d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
1629e22bee78STejun Heo 
16305035b20fSTejun Heo 		/*
16315035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
16325035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
16335035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
16345035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
16355035b20fSTejun Heo 		 */
1636e22bee78STejun Heo 		cpu_relax();
16375035b20fSTejun Heo 		cond_resched();
1638e22bee78STejun Heo 	}
1639e22bee78STejun Heo }
1640e22bee78STejun Heo 
1641e22bee78STejun Heo /*
1642ea1abd61SLai Jiangshan  * Rebind an idle @worker to its CPU.  worker_thread() will test
16435f7dabfdSLai Jiangshan  * list_empty(@worker->entry) before leaving idle and call this function.
164425511a47STejun Heo  */
164525511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
164625511a47STejun Heo {
16475f7dabfdSLai Jiangshan 	/* CPU may go down again inbetween, clear UNBOUND only on success */
16485f7dabfdSLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
16495f7dabfdSLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
165025511a47STejun Heo 
1651ea1abd61SLai Jiangshan 	/* rebind complete, become available again */
1652ea1abd61SLai Jiangshan 	list_add(&worker->entry, &worker->pool->idle_list);
1653*d565ed63STejun Heo 	spin_unlock_irq(&worker->pool->lock);
165425511a47STejun Heo }
165525511a47STejun Heo 
165625511a47STejun Heo /*
165725511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1658403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1659403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1660403c821dSTejun Heo  * executed twice without intervening cpu down.
1661e22bee78STejun Heo  */
166225511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1663e22bee78STejun Heo {
1664e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1665e22bee78STejun Heo 
1666eab6d828SLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
1667eab6d828SLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
1668e22bee78STejun Heo 
1669*d565ed63STejun Heo 	spin_unlock_irq(&worker->pool->lock);
1670e22bee78STejun Heo }
1671e22bee78STejun Heo 
167225511a47STejun Heo /**
167325511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
167425511a47STejun Heo  * @gcwq: gcwq of interest
167525511a47STejun Heo  *
167625511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
167725511a47STejun Heo  * is different for idle and busy ones.
167825511a47STejun Heo  *
1679ea1abd61SLai Jiangshan  * Idle ones will be removed from the idle_list and woken up.  They will
1680ea1abd61SLai Jiangshan  * add themselves back after completing rebind.  This ensures that the
1681ea1abd61SLai Jiangshan  * idle_list doesn't contain any unbound workers when re-bound busy workers
1682ea1abd61SLai Jiangshan  * try to perform local wake-ups for concurrency management.
168325511a47STejun Heo  *
1684ea1abd61SLai Jiangshan  * Busy workers can rebind after they finish their current work items.
1685ea1abd61SLai Jiangshan  * Queueing the rebind work item at the head of the scheduled list is
1686ea1abd61SLai Jiangshan  * enough.  Note that nr_running will be properly bumped as busy workers
1687ea1abd61SLai Jiangshan  * rebind.
168825511a47STejun Heo  *
1689ea1abd61SLai Jiangshan  * On return, all non-manager workers are scheduled for rebind - see
1690ea1abd61SLai Jiangshan  * manage_workers() for the manager special case.  Any idle worker
1691ea1abd61SLai Jiangshan  * including the manager will not appear on @idle_list until rebind is
1692ea1abd61SLai Jiangshan  * complete, making local wake-ups safe.
169325511a47STejun Heo  */
169425511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
169525511a47STejun Heo {
169625511a47STejun Heo 	struct worker_pool *pool;
1697ea1abd61SLai Jiangshan 	struct worker *worker, *n;
169825511a47STejun Heo 	struct hlist_node *pos;
169925511a47STejun Heo 	int i;
170025511a47STejun Heo 
1701*d565ed63STejun Heo 	for_each_worker_pool(pool, gcwq) {
1702b2eb83d1SLai Jiangshan 		lockdep_assert_held(&pool->assoc_mutex);
1703*d565ed63STejun Heo 		lockdep_assert_held(&pool->lock);
1704*d565ed63STejun Heo 	}
170525511a47STejun Heo 
17065f7dabfdSLai Jiangshan 	/* dequeue and kick idle ones */
170725511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
1708ea1abd61SLai Jiangshan 		list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1709ea1abd61SLai Jiangshan 			/*
1710ea1abd61SLai Jiangshan 			 * idle workers should be off @pool->idle_list
1711ea1abd61SLai Jiangshan 			 * until rebind is complete to avoid receiving
1712ea1abd61SLai Jiangshan 			 * premature local wake-ups.
1713ea1abd61SLai Jiangshan 			 */
1714ea1abd61SLai Jiangshan 			list_del_init(&worker->entry);
171525511a47STejun Heo 
171625511a47STejun Heo 			/*
17175f7dabfdSLai Jiangshan 			 * worker_thread() will see the above dequeuing
17185f7dabfdSLai Jiangshan 			 * and call idle_worker_rebind().
171925511a47STejun Heo 			 */
172025511a47STejun Heo 			wake_up_process(worker->task);
172125511a47STejun Heo 		}
172225511a47STejun Heo 
1723ea1abd61SLai Jiangshan 		/* rebind busy workers */
1724c9e7cf27STejun Heo 		for_each_busy_worker(worker, i, pos, pool) {
172525511a47STejun Heo 			struct work_struct *rebind_work = &worker->rebind_work;
1726e2b6a6d5SJoonsoo Kim 			struct workqueue_struct *wq;
172725511a47STejun Heo 
172825511a47STejun Heo 			if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
172925511a47STejun Heo 					     work_data_bits(rebind_work)))
173025511a47STejun Heo 				continue;
173125511a47STejun Heo 
173225511a47STejun Heo 			debug_work_activate(rebind_work);
173390beca5dSTejun Heo 
173490beca5dSTejun Heo 			/*
1735c9e7cf27STejun Heo 			 * wq doesn't really matter but let's keep
1736c9e7cf27STejun Heo 			 * @worker->pool and @cwq->pool consistent for
1737c9e7cf27STejun Heo 			 * sanity.
173890beca5dSTejun Heo 			 */
1739e34cdddbSTejun Heo 			if (std_worker_pool_pri(worker->pool))
1740e2b6a6d5SJoonsoo Kim 				wq = system_highpri_wq;
1741e2b6a6d5SJoonsoo Kim 			else
1742e2b6a6d5SJoonsoo Kim 				wq = system_wq;
1743ec58815aSTejun Heo 
1744ec22ca5eSTejun Heo 			insert_work(get_cwq(pool->cpu, wq), rebind_work,
174525511a47STejun Heo 				    worker->scheduled.next,
174625511a47STejun Heo 				    work_color_to_flags(WORK_NO_COLOR));
1747ec58815aSTejun Heo 		}
174825511a47STejun Heo 	}
1749c9e7cf27STejun Heo }
175025511a47STejun Heo 
1751c34056a3STejun Heo static struct worker *alloc_worker(void)
1752c34056a3STejun Heo {
1753c34056a3STejun Heo 	struct worker *worker;
1754c34056a3STejun Heo 
1755c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1756c8e55f36STejun Heo 	if (worker) {
1757c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1758affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
175925511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1760e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1761e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1762c8e55f36STejun Heo 	}
1763c34056a3STejun Heo 	return worker;
1764c34056a3STejun Heo }
1765c34056a3STejun Heo 
1766c34056a3STejun Heo /**
1767c34056a3STejun Heo  * create_worker - create a new workqueue worker
176863d95a91STejun Heo  * @pool: pool the new worker will belong to
1769c34056a3STejun Heo  *
177063d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1771c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1772c34056a3STejun Heo  * destroy_worker().
1773c34056a3STejun Heo  *
1774c34056a3STejun Heo  * CONTEXT:
1775c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1776c34056a3STejun Heo  *
1777c34056a3STejun Heo  * RETURNS:
1778c34056a3STejun Heo  * Pointer to the newly created worker.
1779c34056a3STejun Heo  */
1780bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1781c34056a3STejun Heo {
1782e34cdddbSTejun Heo 	const char *pri = std_worker_pool_pri(pool) ? "H" : "";
1783c34056a3STejun Heo 	struct worker *worker = NULL;
1784f3421797STejun Heo 	int id = -1;
1785c34056a3STejun Heo 
1786*d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1787bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
1788*d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
1789bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1790c34056a3STejun Heo 			goto fail;
1791*d565ed63STejun Heo 		spin_lock_irq(&pool->lock);
1792c34056a3STejun Heo 	}
1793*d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
1794c34056a3STejun Heo 
1795c34056a3STejun Heo 	worker = alloc_worker();
1796c34056a3STejun Heo 	if (!worker)
1797c34056a3STejun Heo 		goto fail;
1798c34056a3STejun Heo 
1799bd7bdd43STejun Heo 	worker->pool = pool;
1800c34056a3STejun Heo 	worker->id = id;
1801c34056a3STejun Heo 
1802ec22ca5eSTejun Heo 	if (pool->cpu != WORK_CPU_UNBOUND)
180394dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
1804ec22ca5eSTejun Heo 					worker, cpu_to_node(pool->cpu),
1805ec22ca5eSTejun Heo 					"kworker/%u:%d%s", pool->cpu, id, pri);
1806f3421797STejun Heo 	else
1807f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
18083270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1809c34056a3STejun Heo 	if (IS_ERR(worker->task))
1810c34056a3STejun Heo 		goto fail;
1811c34056a3STejun Heo 
1812e34cdddbSTejun Heo 	if (std_worker_pool_pri(pool))
18133270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
18143270476aSTejun Heo 
1815db7bccf4STejun Heo 	/*
1816bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
181724647570STejun Heo 	 * %POOL_DISASSOCIATED.  The caller is responsible for ensuring the
1818bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1819bc2ae0f5STejun Heo 	 * above the flag definition for details.
1820bc2ae0f5STejun Heo 	 *
1821bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1822bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1823db7bccf4STejun Heo 	 */
182424647570STejun Heo 	if (!(pool->flags & POOL_DISASSOCIATED)) {
1825ec22ca5eSTejun Heo 		kthread_bind(worker->task, pool->cpu);
1826bc2ae0f5STejun Heo 	} else {
1827db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1828f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1829f3421797STejun Heo 	}
1830c34056a3STejun Heo 
1831c34056a3STejun Heo 	return worker;
1832c34056a3STejun Heo fail:
1833c34056a3STejun Heo 	if (id >= 0) {
1834*d565ed63STejun Heo 		spin_lock_irq(&pool->lock);
1835bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
1836*d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
1837c34056a3STejun Heo 	}
1838c34056a3STejun Heo 	kfree(worker);
1839c34056a3STejun Heo 	return NULL;
1840c34056a3STejun Heo }
1841c34056a3STejun Heo 
1842c34056a3STejun Heo /**
1843c34056a3STejun Heo  * start_worker - start a newly created worker
1844c34056a3STejun Heo  * @worker: worker to start
1845c34056a3STejun Heo  *
1846c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1847c34056a3STejun Heo  *
1848c34056a3STejun Heo  * CONTEXT:
1849*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1850c34056a3STejun Heo  */
1851c34056a3STejun Heo static void start_worker(struct worker *worker)
1852c34056a3STejun Heo {
1853cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1854bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1855c8e55f36STejun Heo 	worker_enter_idle(worker);
1856c34056a3STejun Heo 	wake_up_process(worker->task);
1857c34056a3STejun Heo }
1858c34056a3STejun Heo 
1859c34056a3STejun Heo /**
1860c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1861c34056a3STejun Heo  * @worker: worker to be destroyed
1862c34056a3STejun Heo  *
1863c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1864c8e55f36STejun Heo  *
1865c8e55f36STejun Heo  * CONTEXT:
1866*d565ed63STejun Heo  * spin_lock_irq(pool->lock) which is released and regrabbed.
1867c34056a3STejun Heo  */
1868c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1869c34056a3STejun Heo {
1870bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1871c34056a3STejun Heo 	int id = worker->id;
1872c34056a3STejun Heo 
1873c34056a3STejun Heo 	/* sanity check frenzy */
1874c34056a3STejun Heo 	BUG_ON(worker->current_work);
1875affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1876c34056a3STejun Heo 
1877c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1878bd7bdd43STejun Heo 		pool->nr_workers--;
1879c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1880bd7bdd43STejun Heo 		pool->nr_idle--;
1881c8e55f36STejun Heo 
1882c8e55f36STejun Heo 	list_del_init(&worker->entry);
1883cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1884c8e55f36STejun Heo 
1885*d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
1886c8e55f36STejun Heo 
1887c34056a3STejun Heo 	kthread_stop(worker->task);
1888c34056a3STejun Heo 	kfree(worker);
1889c34056a3STejun Heo 
1890*d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1891bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1892c34056a3STejun Heo }
1893c34056a3STejun Heo 
189463d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1895e22bee78STejun Heo {
189663d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1897e22bee78STejun Heo 
1898*d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1899e22bee78STejun Heo 
190063d95a91STejun Heo 	if (too_many_workers(pool)) {
1901e22bee78STejun Heo 		struct worker *worker;
1902e22bee78STejun Heo 		unsigned long expires;
1903e22bee78STejun Heo 
1904e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
190563d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1906e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1907e22bee78STejun Heo 
1908e22bee78STejun Heo 		if (time_before(jiffies, expires))
190963d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1910e22bee78STejun Heo 		else {
1911e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
191211ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
191363d95a91STejun Heo 			wake_up_worker(pool);
1914e22bee78STejun Heo 		}
1915e22bee78STejun Heo 	}
1916e22bee78STejun Heo 
1917*d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
1918e22bee78STejun Heo }
1919e22bee78STejun Heo 
1920e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1921e22bee78STejun Heo {
1922e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1923e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1924f3421797STejun Heo 	unsigned int cpu;
1925e22bee78STejun Heo 
1926e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1927e22bee78STejun Heo 		return false;
1928e22bee78STejun Heo 
1929e22bee78STejun Heo 	/* mayday mayday mayday */
1930ec22ca5eSTejun Heo 	cpu = cwq->pool->cpu;
1931f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1932f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1933f3421797STejun Heo 		cpu = 0;
1934f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1935e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1936e22bee78STejun Heo 	return true;
1937e22bee78STejun Heo }
1938e22bee78STejun Heo 
193963d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1940e22bee78STejun Heo {
194163d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1942e22bee78STejun Heo 	struct work_struct *work;
1943e22bee78STejun Heo 
1944*d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1945e22bee78STejun Heo 
194663d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1947e22bee78STejun Heo 		/*
1948e22bee78STejun Heo 		 * We've been trying to create a new worker but
1949e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1950e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1951e22bee78STejun Heo 		 * rescuers.
1952e22bee78STejun Heo 		 */
195363d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1954e22bee78STejun Heo 			send_mayday(work);
1955e22bee78STejun Heo 	}
1956e22bee78STejun Heo 
1957*d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
1958e22bee78STejun Heo 
195963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1960e22bee78STejun Heo }
1961e22bee78STejun Heo 
1962e22bee78STejun Heo /**
1963e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
196463d95a91STejun Heo  * @pool: pool to create a new worker for
1965e22bee78STejun Heo  *
196663d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1967e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1968e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
196963d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1970e22bee78STejun Heo  * possible allocation deadlock.
1971e22bee78STejun Heo  *
1972e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1973e22bee78STejun Heo  * may_start_working() true.
1974e22bee78STejun Heo  *
1975e22bee78STejun Heo  * LOCKING:
1976*d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
1977e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1978e22bee78STejun Heo  * manager.
1979e22bee78STejun Heo  *
1980e22bee78STejun Heo  * RETURNS:
1981*d565ed63STejun Heo  * false if no action was taken and pool->lock stayed locked, true
1982e22bee78STejun Heo  * otherwise.
1983e22bee78STejun Heo  */
198463d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
1985*d565ed63STejun Heo __releases(&pool->lock)
1986*d565ed63STejun Heo __acquires(&pool->lock)
1987e22bee78STejun Heo {
198863d95a91STejun Heo 	if (!need_to_create_worker(pool))
1989e22bee78STejun Heo 		return false;
1990e22bee78STejun Heo restart:
1991*d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
19929f9c2364STejun Heo 
1993e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
199463d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1995e22bee78STejun Heo 
1996e22bee78STejun Heo 	while (true) {
1997e22bee78STejun Heo 		struct worker *worker;
1998e22bee78STejun Heo 
1999bc2ae0f5STejun Heo 		worker = create_worker(pool);
2000e22bee78STejun Heo 		if (worker) {
200163d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
2002*d565ed63STejun Heo 			spin_lock_irq(&pool->lock);
2003e22bee78STejun Heo 			start_worker(worker);
200463d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
2005e22bee78STejun Heo 			return true;
2006e22bee78STejun Heo 		}
2007e22bee78STejun Heo 
200863d95a91STejun Heo 		if (!need_to_create_worker(pool))
2009e22bee78STejun Heo 			break;
2010e22bee78STejun Heo 
2011e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
2012e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
20139f9c2364STejun Heo 
201463d95a91STejun Heo 		if (!need_to_create_worker(pool))
2015e22bee78STejun Heo 			break;
2016e22bee78STejun Heo 	}
2017e22bee78STejun Heo 
201863d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2019*d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
202063d95a91STejun Heo 	if (need_to_create_worker(pool))
2021e22bee78STejun Heo 		goto restart;
2022e22bee78STejun Heo 	return true;
2023e22bee78STejun Heo }
2024e22bee78STejun Heo 
2025e22bee78STejun Heo /**
2026e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
202763d95a91STejun Heo  * @pool: pool to destroy workers for
2028e22bee78STejun Heo  *
202963d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
2030e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
2031e22bee78STejun Heo  *
2032e22bee78STejun Heo  * LOCKING:
2033*d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2034e22bee78STejun Heo  * multiple times.  Called only from manager.
2035e22bee78STejun Heo  *
2036e22bee78STejun Heo  * RETURNS:
2037*d565ed63STejun Heo  * false if no action was taken and pool->lock stayed locked, true
2038e22bee78STejun Heo  * otherwise.
2039e22bee78STejun Heo  */
204063d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
2041e22bee78STejun Heo {
2042e22bee78STejun Heo 	bool ret = false;
2043e22bee78STejun Heo 
204463d95a91STejun Heo 	while (too_many_workers(pool)) {
2045e22bee78STejun Heo 		struct worker *worker;
2046e22bee78STejun Heo 		unsigned long expires;
2047e22bee78STejun Heo 
204863d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2049e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2050e22bee78STejun Heo 
2051e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
205263d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2053e22bee78STejun Heo 			break;
2054e22bee78STejun Heo 		}
2055e22bee78STejun Heo 
2056e22bee78STejun Heo 		destroy_worker(worker);
2057e22bee78STejun Heo 		ret = true;
2058e22bee78STejun Heo 	}
2059e22bee78STejun Heo 
2060e22bee78STejun Heo 	return ret;
2061e22bee78STejun Heo }
2062e22bee78STejun Heo 
2063e22bee78STejun Heo /**
2064e22bee78STejun Heo  * manage_workers - manage worker pool
2065e22bee78STejun Heo  * @worker: self
2066e22bee78STejun Heo  *
2067e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
2068e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2069e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
2070e22bee78STejun Heo  *
2071e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2072e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2073e22bee78STejun Heo  * and may_start_working() is true.
2074e22bee78STejun Heo  *
2075e22bee78STejun Heo  * CONTEXT:
2076*d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2077e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2078e22bee78STejun Heo  *
2079e22bee78STejun Heo  * RETURNS:
2080*d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2081*d565ed63STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2082e22bee78STejun Heo  */
2083e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2084e22bee78STejun Heo {
208563d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2086e22bee78STejun Heo 	bool ret = false;
2087e22bee78STejun Heo 
2088ee378aa4SLai Jiangshan 	if (pool->flags & POOL_MANAGING_WORKERS)
2089e22bee78STejun Heo 		return ret;
2090e22bee78STejun Heo 
2091552a37e9SLai Jiangshan 	pool->flags |= POOL_MANAGING_WORKERS;
2092ee378aa4SLai Jiangshan 
2093ee378aa4SLai Jiangshan 	/*
2094ee378aa4SLai Jiangshan 	 * To simplify both worker management and CPU hotplug, hold off
2095ee378aa4SLai Jiangshan 	 * management while hotplug is in progress.  CPU hotplug path can't
2096ee378aa4SLai Jiangshan 	 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2097ee378aa4SLai Jiangshan 	 * lead to idle worker depletion (all become busy thinking someone
2098ee378aa4SLai Jiangshan 	 * else is managing) which in turn can result in deadlock under
2099b2eb83d1SLai Jiangshan 	 * extreme circumstances.  Use @pool->assoc_mutex to synchronize
2100ee378aa4SLai Jiangshan 	 * manager against CPU hotplug.
2101ee378aa4SLai Jiangshan 	 *
2102b2eb83d1SLai Jiangshan 	 * assoc_mutex would always be free unless CPU hotplug is in
2103*d565ed63STejun Heo 	 * progress.  trylock first without dropping @pool->lock.
2104ee378aa4SLai Jiangshan 	 */
2105b2eb83d1SLai Jiangshan 	if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
2106*d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
2107b2eb83d1SLai Jiangshan 		mutex_lock(&pool->assoc_mutex);
2108ee378aa4SLai Jiangshan 		/*
2109ee378aa4SLai Jiangshan 		 * CPU hotplug could have happened while we were waiting
2110b2eb83d1SLai Jiangshan 		 * for assoc_mutex.  Hotplug itself can't handle us
2111ee378aa4SLai Jiangshan 		 * because manager isn't either on idle or busy list, and
2112ee378aa4SLai Jiangshan 		 * @gcwq's state and ours could have deviated.
2113ee378aa4SLai Jiangshan 		 *
2114b2eb83d1SLai Jiangshan 		 * As hotplug is now excluded via assoc_mutex, we can
2115ee378aa4SLai Jiangshan 		 * simply try to bind.  It will succeed or fail depending
2116ee378aa4SLai Jiangshan 		 * on @gcwq's current state.  Try it and adjust
2117ee378aa4SLai Jiangshan 		 * %WORKER_UNBOUND accordingly.
2118ee378aa4SLai Jiangshan 		 */
2119ee378aa4SLai Jiangshan 		if (worker_maybe_bind_and_lock(worker))
2120ee378aa4SLai Jiangshan 			worker->flags &= ~WORKER_UNBOUND;
2121ee378aa4SLai Jiangshan 		else
2122ee378aa4SLai Jiangshan 			worker->flags |= WORKER_UNBOUND;
2123ee378aa4SLai Jiangshan 
2124ee378aa4SLai Jiangshan 		ret = true;
2125ee378aa4SLai Jiangshan 	}
2126ee378aa4SLai Jiangshan 
212711ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2128e22bee78STejun Heo 
2129e22bee78STejun Heo 	/*
2130e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2131e22bee78STejun Heo 	 * on return.
2132e22bee78STejun Heo 	 */
213363d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
213463d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2135e22bee78STejun Heo 
2136552a37e9SLai Jiangshan 	pool->flags &= ~POOL_MANAGING_WORKERS;
2137b2eb83d1SLai Jiangshan 	mutex_unlock(&pool->assoc_mutex);
2138e22bee78STejun Heo 	return ret;
2139e22bee78STejun Heo }
2140e22bee78STejun Heo 
2141a62428c0STejun Heo /**
2142a62428c0STejun Heo  * process_one_work - process single work
2143c34056a3STejun Heo  * @worker: self
2144a62428c0STejun Heo  * @work: work to process
2145a62428c0STejun Heo  *
2146a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2147a62428c0STejun Heo  * process a single work including synchronization against and
2148a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2149a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2150a62428c0STejun Heo  * call this function to process a work.
2151a62428c0STejun Heo  *
2152a62428c0STejun Heo  * CONTEXT:
2153*d565ed63STejun Heo  * spin_lock_irq(pool->lock) which is released and regrabbed.
2154a62428c0STejun Heo  */
2155c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
2156*d565ed63STejun Heo __releases(&pool->lock)
2157*d565ed63STejun Heo __acquires(&pool->lock)
21581da177e4SLinus Torvalds {
21597e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2160bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2161fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
216273f53c4aSTejun Heo 	int work_color;
21637e11629dSTejun Heo 	struct worker *collision;
21644e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21654e6045f1SJohannes Berg 	/*
2166a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2167a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2168a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2169a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2170a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21714e6045f1SJohannes Berg 	 */
21724d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21734d82a1deSPeter Zijlstra 
21744d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21754e6045f1SJohannes Berg #endif
21766fec10a1STejun Heo 	/*
21776fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21786fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
217924647570STejun Heo 	 * unbound or a disassociated pool.
21806fec10a1STejun Heo 	 */
21815f7dabfdSLai Jiangshan 	WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
218224647570STejun Heo 		     !(pool->flags & POOL_DISASSOCIATED) &&
2183ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
218425511a47STejun Heo 
21857e11629dSTejun Heo 	/*
21867e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21877e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21887e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21897e11629dSTejun Heo 	 * currently executing one.
21907e11629dSTejun Heo 	 */
2191c9e7cf27STejun Heo 	collision = find_worker_executing_work(pool, work);
21927e11629dSTejun Heo 	if (unlikely(collision)) {
21937e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21947e11629dSTejun Heo 		return;
21957e11629dSTejun Heo 	}
21961da177e4SLinus Torvalds 
21978930cabaSTejun Heo 	/* claim and dequeue */
21981da177e4SLinus Torvalds 	debug_work_deactivate(work);
2199c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2200c34056a3STejun Heo 	worker->current_work = work;
2201a2c1c57bSTejun Heo 	worker->current_func = work->func;
22028cca0eeaSTejun Heo 	worker->current_cwq = cwq;
220373f53c4aSTejun Heo 	work_color = get_work_color(work);
22047a22ad75STejun Heo 
2205a62428c0STejun Heo 	list_del_init(&work->entry);
2206a62428c0STejun Heo 
2207649027d7STejun Heo 	/*
2208fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2209fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2210fb0e7bebSTejun Heo 	 */
2211fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2212fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2213fb0e7bebSTejun Heo 
2214974271c4STejun Heo 	/*
2215*d565ed63STejun Heo 	 * Unbound pool isn't concurrency managed and work items should be
2216974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2217974271c4STejun Heo 	 */
221863d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
221963d95a91STejun Heo 		wake_up_worker(pool);
2220974271c4STejun Heo 
22218930cabaSTejun Heo 	/*
22227c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
2223*d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
222423657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
222523657bb1STejun Heo 	 * disabled.
22268930cabaSTejun Heo 	 */
22277c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
22281da177e4SLinus Torvalds 
2229*d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2230365970a1SDavid Howells 
2231e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
22323295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2233e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2234a2c1c57bSTejun Heo 	worker->current_func(work);
2235e36c886aSArjan van de Ven 	/*
2236e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2237e36c886aSArjan van de Ven 	 * point will only record its address.
2238e36c886aSArjan van de Ven 	 */
2239e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22403295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
22413295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
22421da177e4SLinus Torvalds 
2243d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2244044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2245044c782cSValentin Ilie 		       "     last function: %pf\n",
2246a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2247a2c1c57bSTejun Heo 		       worker->current_func);
2248d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2249d5abe669SPeter Zijlstra 		dump_stack();
2250d5abe669SPeter Zijlstra 	}
2251d5abe669SPeter Zijlstra 
2252*d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2253a62428c0STejun Heo 
2254fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2255fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2256fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2257fb0e7bebSTejun Heo 
2258a62428c0STejun Heo 	/* we're done with it, release */
225942f8570fSSasha Levin 	hash_del(&worker->hentry);
2260c34056a3STejun Heo 	worker->current_work = NULL;
2261a2c1c57bSTejun Heo 	worker->current_func = NULL;
22628cca0eeaSTejun Heo 	worker->current_cwq = NULL;
2263b3f9f405SLai Jiangshan 	cwq_dec_nr_in_flight(cwq, work_color);
22641da177e4SLinus Torvalds }
22651da177e4SLinus Torvalds 
2266affee4b2STejun Heo /**
2267affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2268affee4b2STejun Heo  * @worker: self
2269affee4b2STejun Heo  *
2270affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2271affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2272affee4b2STejun Heo  * fetches a work from the top and executes it.
2273affee4b2STejun Heo  *
2274affee4b2STejun Heo  * CONTEXT:
2275*d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2276affee4b2STejun Heo  * multiple times.
2277affee4b2STejun Heo  */
2278affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22791da177e4SLinus Torvalds {
2280affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2281affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2282a62428c0STejun Heo 						struct work_struct, entry);
2283c34056a3STejun Heo 		process_one_work(worker, work);
2284a62428c0STejun Heo 	}
22851da177e4SLinus Torvalds }
22861da177e4SLinus Torvalds 
22874690c4abSTejun Heo /**
22884690c4abSTejun Heo  * worker_thread - the worker thread function
2289c34056a3STejun Heo  * @__worker: self
22904690c4abSTejun Heo  *
2291e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2292e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2293e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2294e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2295e22bee78STejun Heo  * rescuer_thread().
22964690c4abSTejun Heo  */
2297c34056a3STejun Heo static int worker_thread(void *__worker)
22981da177e4SLinus Torvalds {
2299c34056a3STejun Heo 	struct worker *worker = __worker;
2300bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
23011da177e4SLinus Torvalds 
2302e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2303e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2304c8e55f36STejun Heo woke_up:
2305*d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2306affee4b2STejun Heo 
23075f7dabfdSLai Jiangshan 	/* we are off idle list if destruction or rebind is requested */
23085f7dabfdSLai Jiangshan 	if (unlikely(list_empty(&worker->entry))) {
2309*d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
231025511a47STejun Heo 
23115f7dabfdSLai Jiangshan 		/* if DIE is set, destruction is requested */
231225511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2313e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2314c8e55f36STejun Heo 			return 0;
2315c8e55f36STejun Heo 		}
2316c8e55f36STejun Heo 
23175f7dabfdSLai Jiangshan 		/* otherwise, rebind */
231825511a47STejun Heo 		idle_worker_rebind(worker);
231925511a47STejun Heo 		goto woke_up;
232025511a47STejun Heo 	}
232125511a47STejun Heo 
2322c8e55f36STejun Heo 	worker_leave_idle(worker);
2323db7bccf4STejun Heo recheck:
2324e22bee78STejun Heo 	/* no more worker necessary? */
232563d95a91STejun Heo 	if (!need_more_worker(pool))
2326e22bee78STejun Heo 		goto sleep;
2327e22bee78STejun Heo 
2328e22bee78STejun Heo 	/* do we need to manage? */
232963d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2330e22bee78STejun Heo 		goto recheck;
2331e22bee78STejun Heo 
2332c8e55f36STejun Heo 	/*
2333c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2334c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2335c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2336c8e55f36STejun Heo 	 */
2337c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2338c8e55f36STejun Heo 
2339e22bee78STejun Heo 	/*
2340e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2341e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2342e22bee78STejun Heo 	 * assumed the manager role.
2343e22bee78STejun Heo 	 */
2344e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2345e22bee78STejun Heo 
2346e22bee78STejun Heo 	do {
2347affee4b2STejun Heo 		struct work_struct *work =
2348bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2349affee4b2STejun Heo 					 struct work_struct, entry);
2350affee4b2STejun Heo 
2351c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2352affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2353affee4b2STejun Heo 			process_one_work(worker, work);
2354affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2355affee4b2STejun Heo 				process_scheduled_works(worker);
2356affee4b2STejun Heo 		} else {
2357c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2358affee4b2STejun Heo 			process_scheduled_works(worker);
2359affee4b2STejun Heo 		}
236063d95a91STejun Heo 	} while (keep_working(pool));
2361affee4b2STejun Heo 
2362e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2363d313dd85STejun Heo sleep:
236463d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2365e22bee78STejun Heo 		goto recheck;
2366d313dd85STejun Heo 
2367c8e55f36STejun Heo 	/*
2368*d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
2369*d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
2370*d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
2371*d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
2372*d565ed63STejun Heo 	 * event.
2373c8e55f36STejun Heo 	 */
2374c8e55f36STejun Heo 	worker_enter_idle(worker);
2375c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
2376*d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
23771da177e4SLinus Torvalds 	schedule();
2378c8e55f36STejun Heo 	goto woke_up;
23791da177e4SLinus Torvalds }
23801da177e4SLinus Torvalds 
2381e22bee78STejun Heo /**
2382e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2383111c225aSTejun Heo  * @__rescuer: self
2384e22bee78STejun Heo  *
2385e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2386e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2387e22bee78STejun Heo  *
2388e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2389e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2390e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2391e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2392e22bee78STejun Heo  * the problem rescuer solves.
2393e22bee78STejun Heo  *
2394e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2395e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2396e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2397e22bee78STejun Heo  *
2398e22bee78STejun Heo  * This should happen rarely.
2399e22bee78STejun Heo  */
2400111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2401e22bee78STejun Heo {
2402111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2403111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2404e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2405f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2406e22bee78STejun Heo 	unsigned int cpu;
2407e22bee78STejun Heo 
2408e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2409111c225aSTejun Heo 
2410111c225aSTejun Heo 	/*
2411111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2412111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2413111c225aSTejun Heo 	 */
2414111c225aSTejun Heo 	rescuer->task->flags |= PF_WQ_WORKER;
2415e22bee78STejun Heo repeat:
2416e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
24171da177e4SLinus Torvalds 
2418412d32e6SMike Galbraith 	if (kthread_should_stop()) {
2419412d32e6SMike Galbraith 		__set_current_state(TASK_RUNNING);
2420111c225aSTejun Heo 		rescuer->task->flags &= ~PF_WQ_WORKER;
2421e22bee78STejun Heo 		return 0;
2422412d32e6SMike Galbraith 	}
24231da177e4SLinus Torvalds 
2424f3421797STejun Heo 	/*
2425f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2426f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2427f3421797STejun Heo 	 */
2428f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2429f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2430f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2431bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2432e22bee78STejun Heo 		struct work_struct *work, *n;
2433e22bee78STejun Heo 
2434e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2435f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2436e22bee78STejun Heo 
2437e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2438bd7bdd43STejun Heo 		rescuer->pool = pool;
2439e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2440e22bee78STejun Heo 
2441e22bee78STejun Heo 		/*
2442e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2443e22bee78STejun Heo 		 * process'em.
2444e22bee78STejun Heo 		 */
2445e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2446bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2447e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2448e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2449e22bee78STejun Heo 
2450e22bee78STejun Heo 		process_scheduled_works(rescuer);
24517576958aSTejun Heo 
24527576958aSTejun Heo 		/*
2453*d565ed63STejun Heo 		 * Leave this pool.  If keep_working() is %true, notify a
24547576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24557576958aSTejun Heo 		 * and stalling the execution.
24567576958aSTejun Heo 		 */
245763d95a91STejun Heo 		if (keep_working(pool))
245863d95a91STejun Heo 			wake_up_worker(pool);
24597576958aSTejun Heo 
2460*d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
24611da177e4SLinus Torvalds 	}
24621da177e4SLinus Torvalds 
2463111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2464111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2465e22bee78STejun Heo 	schedule();
2466e22bee78STejun Heo 	goto repeat;
24671da177e4SLinus Torvalds }
24681da177e4SLinus Torvalds 
2469fc2e4d70SOleg Nesterov struct wq_barrier {
2470fc2e4d70SOleg Nesterov 	struct work_struct	work;
2471fc2e4d70SOleg Nesterov 	struct completion	done;
2472fc2e4d70SOleg Nesterov };
2473fc2e4d70SOleg Nesterov 
2474fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2475fc2e4d70SOleg Nesterov {
2476fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2477fc2e4d70SOleg Nesterov 	complete(&barr->done);
2478fc2e4d70SOleg Nesterov }
2479fc2e4d70SOleg Nesterov 
24804690c4abSTejun Heo /**
24814690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
24824690c4abSTejun Heo  * @cwq: cwq to insert barrier into
24834690c4abSTejun Heo  * @barr: wq_barrier to insert
2484affee4b2STejun Heo  * @target: target work to attach @barr to
2485affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24864690c4abSTejun Heo  *
2487affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2488affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2489affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2490affee4b2STejun Heo  * cpu.
2491affee4b2STejun Heo  *
2492affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2493affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2494affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2495affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2496affee4b2STejun Heo  * after a work with LINKED flag set.
2497affee4b2STejun Heo  *
2498affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2499affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
25004690c4abSTejun Heo  *
25014690c4abSTejun Heo  * CONTEXT:
2502*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
25034690c4abSTejun Heo  */
250483c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2505affee4b2STejun Heo 			      struct wq_barrier *barr,
2506affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2507fc2e4d70SOleg Nesterov {
2508affee4b2STejun Heo 	struct list_head *head;
2509affee4b2STejun Heo 	unsigned int linked = 0;
2510affee4b2STejun Heo 
2511dc186ad7SThomas Gleixner 	/*
2512*d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
2513dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2514dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2515dc186ad7SThomas Gleixner 	 * might deadlock.
2516dc186ad7SThomas Gleixner 	 */
2517ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
251822df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2519fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
252083c22520SOleg Nesterov 
2521affee4b2STejun Heo 	/*
2522affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2523affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2524affee4b2STejun Heo 	 */
2525affee4b2STejun Heo 	if (worker)
2526affee4b2STejun Heo 		head = worker->scheduled.next;
2527affee4b2STejun Heo 	else {
2528affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2529affee4b2STejun Heo 
2530affee4b2STejun Heo 		head = target->entry.next;
2531affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2532affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2533affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2534affee4b2STejun Heo 	}
2535affee4b2STejun Heo 
2536dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2537affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2538affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2539fc2e4d70SOleg Nesterov }
2540fc2e4d70SOleg Nesterov 
254173f53c4aSTejun Heo /**
254273f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
254373f53c4aSTejun Heo  * @wq: workqueue being flushed
254473f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
254573f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
254673f53c4aSTejun Heo  *
254773f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
254873f53c4aSTejun Heo  *
254973f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
255073f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
255173f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
255273f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
255373f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
255473f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
255573f53c4aSTejun Heo  *
255673f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
255773f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
255873f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
255973f53c4aSTejun Heo  * is returned.
256073f53c4aSTejun Heo  *
256173f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
256273f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
256373f53c4aSTejun Heo  * advanced to @work_color.
256473f53c4aSTejun Heo  *
256573f53c4aSTejun Heo  * CONTEXT:
256673f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
256773f53c4aSTejun Heo  *
256873f53c4aSTejun Heo  * RETURNS:
256973f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
257073f53c4aSTejun Heo  * otherwise.
257173f53c4aSTejun Heo  */
257273f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
257373f53c4aSTejun Heo 				      int flush_color, int work_color)
25741da177e4SLinus Torvalds {
257573f53c4aSTejun Heo 	bool wait = false;
257673f53c4aSTejun Heo 	unsigned int cpu;
25771da177e4SLinus Torvalds 
257873f53c4aSTejun Heo 	if (flush_color >= 0) {
257973f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
258073f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2581dc186ad7SThomas Gleixner 	}
258214441960SOleg Nesterov 
2583f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
258473f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2585*d565ed63STejun Heo 		struct worker_pool *pool = cwq->pool;
25861da177e4SLinus Torvalds 
2587*d565ed63STejun Heo 		spin_lock_irq(&pool->lock);
258873f53c4aSTejun Heo 
258973f53c4aSTejun Heo 		if (flush_color >= 0) {
259073f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
259173f53c4aSTejun Heo 
259273f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
259373f53c4aSTejun Heo 				cwq->flush_color = flush_color;
259473f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
259573f53c4aSTejun Heo 				wait = true;
25961da177e4SLinus Torvalds 			}
259773f53c4aSTejun Heo 		}
259873f53c4aSTejun Heo 
259973f53c4aSTejun Heo 		if (work_color >= 0) {
260073f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
260173f53c4aSTejun Heo 			cwq->work_color = work_color;
260273f53c4aSTejun Heo 		}
260373f53c4aSTejun Heo 
2604*d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
26051da177e4SLinus Torvalds 	}
26061da177e4SLinus Torvalds 
260773f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
260873f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
260973f53c4aSTejun Heo 
261073f53c4aSTejun Heo 	return wait;
261183c22520SOleg Nesterov }
26121da177e4SLinus Torvalds 
26130fcb78c2SRolf Eike Beer /**
26141da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
26150fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
26161da177e4SLinus Torvalds  *
26171da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
26181da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
26191da177e4SLinus Torvalds  *
2620fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2621fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
26221da177e4SLinus Torvalds  */
26237ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
26241da177e4SLinus Torvalds {
262573f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
262673f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
262773f53c4aSTejun Heo 		.flush_color = -1,
262873f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
262973f53c4aSTejun Heo 	};
263073f53c4aSTejun Heo 	int next_color;
2631b1f4ec17SOleg Nesterov 
26323295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
26333295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
263473f53c4aSTejun Heo 
263573f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
263673f53c4aSTejun Heo 
263773f53c4aSTejun Heo 	/*
263873f53c4aSTejun Heo 	 * Start-to-wait phase
263973f53c4aSTejun Heo 	 */
264073f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
264173f53c4aSTejun Heo 
264273f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
264373f53c4aSTejun Heo 		/*
264473f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
264573f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
264673f53c4aSTejun Heo 		 * by one.
264773f53c4aSTejun Heo 		 */
264873f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
264973f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
265073f53c4aSTejun Heo 		wq->work_color = next_color;
265173f53c4aSTejun Heo 
265273f53c4aSTejun Heo 		if (!wq->first_flusher) {
265373f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
265473f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
265573f53c4aSTejun Heo 
265673f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
265773f53c4aSTejun Heo 
265873f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
265973f53c4aSTejun Heo 						       wq->work_color)) {
266073f53c4aSTejun Heo 				/* nothing to flush, done */
266173f53c4aSTejun Heo 				wq->flush_color = next_color;
266273f53c4aSTejun Heo 				wq->first_flusher = NULL;
266373f53c4aSTejun Heo 				goto out_unlock;
266473f53c4aSTejun Heo 			}
266573f53c4aSTejun Heo 		} else {
266673f53c4aSTejun Heo 			/* wait in queue */
266773f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
266873f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
266973f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
267073f53c4aSTejun Heo 		}
267173f53c4aSTejun Heo 	} else {
267273f53c4aSTejun Heo 		/*
267373f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
267473f53c4aSTejun Heo 		 * The next flush completion will assign us
267573f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
267673f53c4aSTejun Heo 		 */
267773f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
267873f53c4aSTejun Heo 	}
267973f53c4aSTejun Heo 
268073f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
268173f53c4aSTejun Heo 
268273f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
268373f53c4aSTejun Heo 
268473f53c4aSTejun Heo 	/*
268573f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
268673f53c4aSTejun Heo 	 *
268773f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
268873f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
268973f53c4aSTejun Heo 	 */
269073f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
269173f53c4aSTejun Heo 		return;
269273f53c4aSTejun Heo 
269373f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
269473f53c4aSTejun Heo 
26954ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26964ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26974ce48b37STejun Heo 		goto out_unlock;
26984ce48b37STejun Heo 
269973f53c4aSTejun Heo 	wq->first_flusher = NULL;
270073f53c4aSTejun Heo 
270173f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
270273f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
270373f53c4aSTejun Heo 
270473f53c4aSTejun Heo 	while (true) {
270573f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
270673f53c4aSTejun Heo 
270773f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
270873f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
270973f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
271073f53c4aSTejun Heo 				break;
271173f53c4aSTejun Heo 			list_del_init(&next->list);
271273f53c4aSTejun Heo 			complete(&next->done);
271373f53c4aSTejun Heo 		}
271473f53c4aSTejun Heo 
271573f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
271673f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
271773f53c4aSTejun Heo 
271873f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
271973f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
272073f53c4aSTejun Heo 
272173f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
272273f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
272373f53c4aSTejun Heo 			/*
272473f53c4aSTejun Heo 			 * Assign the same color to all overflowed
272573f53c4aSTejun Heo 			 * flushers, advance work_color and append to
272673f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
272773f53c4aSTejun Heo 			 * phase for these overflowed flushers.
272873f53c4aSTejun Heo 			 */
272973f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
273073f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
273173f53c4aSTejun Heo 
273273f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
273373f53c4aSTejun Heo 
273473f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
273573f53c4aSTejun Heo 					      &wq->flusher_queue);
273673f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
273773f53c4aSTejun Heo 		}
273873f53c4aSTejun Heo 
273973f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
274073f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
274173f53c4aSTejun Heo 			break;
274273f53c4aSTejun Heo 		}
274373f53c4aSTejun Heo 
274473f53c4aSTejun Heo 		/*
274573f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
274673f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
274773f53c4aSTejun Heo 		 */
274873f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
274973f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
275073f53c4aSTejun Heo 
275173f53c4aSTejun Heo 		list_del_init(&next->list);
275273f53c4aSTejun Heo 		wq->first_flusher = next;
275373f53c4aSTejun Heo 
275473f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
275573f53c4aSTejun Heo 			break;
275673f53c4aSTejun Heo 
275773f53c4aSTejun Heo 		/*
275873f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
275973f53c4aSTejun Heo 		 * flusher and repeat cascading.
276073f53c4aSTejun Heo 		 */
276173f53c4aSTejun Heo 		wq->first_flusher = NULL;
276273f53c4aSTejun Heo 	}
276373f53c4aSTejun Heo 
276473f53c4aSTejun Heo out_unlock:
276573f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
27661da177e4SLinus Torvalds }
2767ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27681da177e4SLinus Torvalds 
27699c5a2ba7STejun Heo /**
27709c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27719c5a2ba7STejun Heo  * @wq: workqueue to drain
27729c5a2ba7STejun Heo  *
27739c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27749c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27759c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27769c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27779c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27789c5a2ba7STejun Heo  * takes too long.
27799c5a2ba7STejun Heo  */
27809c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27819c5a2ba7STejun Heo {
27829c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
27839c5a2ba7STejun Heo 	unsigned int cpu;
27849c5a2ba7STejun Heo 
27859c5a2ba7STejun Heo 	/*
27869c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27879c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
27889c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
27899c5a2ba7STejun Heo 	 */
27909c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27919c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
27929c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
27939c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27949c5a2ba7STejun Heo reflush:
27959c5a2ba7STejun Heo 	flush_workqueue(wq);
27969c5a2ba7STejun Heo 
27979c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27989c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2799fa2563e4SThomas Tuttle 		bool drained;
28009c5a2ba7STejun Heo 
2801*d565ed63STejun Heo 		spin_lock_irq(&cwq->pool->lock);
2802fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2803*d565ed63STejun Heo 		spin_unlock_irq(&cwq->pool->lock);
2804fa2563e4SThomas Tuttle 
2805fa2563e4SThomas Tuttle 		if (drained)
28069c5a2ba7STejun Heo 			continue;
28079c5a2ba7STejun Heo 
28089c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
28099c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2810044c782cSValentin Ilie 			pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
28119c5a2ba7STejun Heo 				wq->name, flush_cnt);
28129c5a2ba7STejun Heo 		goto reflush;
28139c5a2ba7STejun Heo 	}
28149c5a2ba7STejun Heo 
28159c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
28169c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
28179c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
28189c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
28199c5a2ba7STejun Heo }
28209c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
28219c5a2ba7STejun Heo 
2822606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2823baf59022STejun Heo {
2824baf59022STejun Heo 	struct worker *worker = NULL;
2825c9e7cf27STejun Heo 	struct worker_pool *pool;
2826baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2827baf59022STejun Heo 
2828baf59022STejun Heo 	might_sleep();
2829c9e7cf27STejun Heo 	pool = get_work_pool(work);
2830c9e7cf27STejun Heo 	if (!pool)
2831baf59022STejun Heo 		return false;
2832baf59022STejun Heo 
2833*d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2834baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2835baf59022STejun Heo 		/*
2836baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2837*d565ed63STejun Heo 		 * If it was re-queued to a different pool under us, we
2838baf59022STejun Heo 		 * are not going to wait.
2839baf59022STejun Heo 		 */
2840baf59022STejun Heo 		smp_rmb();
2841baf59022STejun Heo 		cwq = get_work_cwq(work);
2842*d565ed63STejun Heo 		if (unlikely(!cwq || pool != cwq->pool))
2843baf59022STejun Heo 			goto already_gone;
2844606a5020STejun Heo 	} else {
2845c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
2846baf59022STejun Heo 		if (!worker)
2847baf59022STejun Heo 			goto already_gone;
2848baf59022STejun Heo 		cwq = worker->current_cwq;
2849606a5020STejun Heo 	}
2850baf59022STejun Heo 
2851baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2852*d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2853baf59022STejun Heo 
2854e159489bSTejun Heo 	/*
2855e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2856e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2857e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2858e159489bSTejun Heo 	 * access.
2859e159489bSTejun Heo 	 */
2860e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2861baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2862e159489bSTejun Heo 	else
2863e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2864baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2865e159489bSTejun Heo 
2866baf59022STejun Heo 	return true;
2867baf59022STejun Heo already_gone:
2868*d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2869baf59022STejun Heo 	return false;
2870baf59022STejun Heo }
2871baf59022STejun Heo 
2872db700897SOleg Nesterov /**
2873401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2874401a8d04STejun Heo  * @work: the work to flush
2875db700897SOleg Nesterov  *
2876606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2877606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2878401a8d04STejun Heo  *
2879401a8d04STejun Heo  * RETURNS:
2880401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2881401a8d04STejun Heo  * %false if it was already idle.
2882db700897SOleg Nesterov  */
2883401a8d04STejun Heo bool flush_work(struct work_struct *work)
2884db700897SOleg Nesterov {
2885db700897SOleg Nesterov 	struct wq_barrier barr;
2886db700897SOleg Nesterov 
28870976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28880976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28890976dfc1SStephen Boyd 
2890606a5020STejun Heo 	if (start_flush_work(work, &barr)) {
2891db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2892dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2893401a8d04STejun Heo 		return true;
2894606a5020STejun Heo 	} else {
2895401a8d04STejun Heo 		return false;
2896db700897SOleg Nesterov 	}
2897606a5020STejun Heo }
2898db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2899db700897SOleg Nesterov 
290036e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2901401a8d04STejun Heo {
2902bbb68dfaSTejun Heo 	unsigned long flags;
29031f1f642eSOleg Nesterov 	int ret;
29041f1f642eSOleg Nesterov 
29051f1f642eSOleg Nesterov 	do {
2906bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2907bbb68dfaSTejun Heo 		/*
2908bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2909bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2910bbb68dfaSTejun Heo 		 */
2911bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2912606a5020STejun Heo 			flush_work(work);
29131f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
29141f1f642eSOleg Nesterov 
2915bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2916bbb68dfaSTejun Heo 	mark_work_canceling(work);
2917bbb68dfaSTejun Heo 	local_irq_restore(flags);
2918bbb68dfaSTejun Heo 
2919606a5020STejun Heo 	flush_work(work);
29207a22ad75STejun Heo 	clear_work_data(work);
29211f1f642eSOleg Nesterov 	return ret;
29221f1f642eSOleg Nesterov }
29231f1f642eSOleg Nesterov 
29246e84d644SOleg Nesterov /**
2925401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2926401a8d04STejun Heo  * @work: the work to cancel
29276e84d644SOleg Nesterov  *
2928401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2929401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2930401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2931401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
29321f1f642eSOleg Nesterov  *
2933401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2934401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
29356e84d644SOleg Nesterov  *
2936401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
29376e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2938401a8d04STejun Heo  *
2939401a8d04STejun Heo  * RETURNS:
2940401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
29416e84d644SOleg Nesterov  */
2942401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29436e84d644SOleg Nesterov {
294436e227d2STejun Heo 	return __cancel_work_timer(work, false);
2945b89deed3SOleg Nesterov }
294628e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2947b89deed3SOleg Nesterov 
29486e84d644SOleg Nesterov /**
2949401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2950401a8d04STejun Heo  * @dwork: the delayed work to flush
29516e84d644SOleg Nesterov  *
2952401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2953401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2954401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29551f1f642eSOleg Nesterov  *
2956401a8d04STejun Heo  * RETURNS:
2957401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2958401a8d04STejun Heo  * %false if it was already idle.
29596e84d644SOleg Nesterov  */
2960401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2961401a8d04STejun Heo {
29628930cabaSTejun Heo 	local_irq_disable();
2963401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
29641265057fSTejun Heo 		__queue_work(dwork->cpu,
2965401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
29668930cabaSTejun Heo 	local_irq_enable();
2967401a8d04STejun Heo 	return flush_work(&dwork->work);
2968401a8d04STejun Heo }
2969401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2970401a8d04STejun Heo 
2971401a8d04STejun Heo /**
297257b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
297357b30ae7STejun Heo  * @dwork: delayed_work to cancel
297409383498STejun Heo  *
297557b30ae7STejun Heo  * Kill off a pending delayed_work.  Returns %true if @dwork was pending
297657b30ae7STejun Heo  * and canceled; %false if wasn't pending.  Note that the work callback
297757b30ae7STejun Heo  * function may still be running on return, unless it returns %true and the
297857b30ae7STejun Heo  * work doesn't re-arm itself.  Explicitly flush or use
297957b30ae7STejun Heo  * cancel_delayed_work_sync() to wait on it.
298009383498STejun Heo  *
298157b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
298209383498STejun Heo  */
298357b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
298409383498STejun Heo {
298557b30ae7STejun Heo 	unsigned long flags;
298657b30ae7STejun Heo 	int ret;
298757b30ae7STejun Heo 
298857b30ae7STejun Heo 	do {
298957b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
299057b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
299157b30ae7STejun Heo 
299257b30ae7STejun Heo 	if (unlikely(ret < 0))
299357b30ae7STejun Heo 		return false;
299457b30ae7STejun Heo 
29957c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(&dwork->work,
29967c3eed5cSTejun Heo 					get_work_pool_id(&dwork->work));
299757b30ae7STejun Heo 	local_irq_restore(flags);
2998c0158ca6SDan Magenheimer 	return ret;
299909383498STejun Heo }
300057b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
300109383498STejun Heo 
300209383498STejun Heo /**
3003401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3004401a8d04STejun Heo  * @dwork: the delayed work cancel
3005401a8d04STejun Heo  *
3006401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
3007401a8d04STejun Heo  *
3008401a8d04STejun Heo  * RETURNS:
3009401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
3010401a8d04STejun Heo  */
3011401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
30126e84d644SOleg Nesterov {
301336e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
30146e84d644SOleg Nesterov }
3015f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
30161da177e4SLinus Torvalds 
30170fcb78c2SRolf Eike Beer /**
3018c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
3019c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
3020c1a220e7SZhang Rui  * @work: job to be done
3021c1a220e7SZhang Rui  *
3022c1a220e7SZhang Rui  * This puts a job on a specific cpu
3023c1a220e7SZhang Rui  */
3024d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work)
3025c1a220e7SZhang Rui {
3026d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
3027c1a220e7SZhang Rui }
3028c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
3029c1a220e7SZhang Rui 
30300fcb78c2SRolf Eike Beer /**
3031ae90dd5dSDave Jones  * schedule_work - put work task in global workqueue
30321da177e4SLinus Torvalds  * @work: job to be done
30331da177e4SLinus Torvalds  *
3034d4283e93STejun Heo  * Returns %false if @work was already on the kernel-global workqueue and
3035d4283e93STejun Heo  * %true otherwise.
303652bad64dSDavid Howells  *
30370fcb78c2SRolf Eike Beer  * This puts a job in the kernel-global workqueue if it was not already
30380fcb78c2SRolf Eike Beer  * queued and leaves it in the same position on the kernel-global
30390fcb78c2SRolf Eike Beer  * workqueue otherwise.
30401da177e4SLinus Torvalds  */
3041d4283e93STejun Heo bool schedule_work(struct work_struct *work)
30421da177e4SLinus Torvalds {
30430fcb78c2SRolf Eike Beer 	return queue_work(system_wq, work);
30441da177e4SLinus Torvalds }
30450fcb78c2SRolf Eike Beer EXPORT_SYMBOL(schedule_work);
30461da177e4SLinus Torvalds 
30470fcb78c2SRolf Eike Beer /**
30480fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
30490fcb78c2SRolf Eike Beer  * @cpu: cpu to use
30500fcb78c2SRolf Eike Beer  * @dwork: job to be done
30510fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
30520fcb78c2SRolf Eike Beer  *
30530fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
30540fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
30550fcb78c2SRolf Eike Beer  */
3056d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3057d4283e93STejun Heo 			      unsigned long delay)
30581da177e4SLinus Torvalds {
3059d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
30601da177e4SLinus Torvalds }
3061ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
30621da177e4SLinus Torvalds 
3063b6136773SAndrew Morton /**
30640a13c00eSTejun Heo  * schedule_delayed_work - put work task in global workqueue after delay
30650a13c00eSTejun Heo  * @dwork: job to be done
30660a13c00eSTejun Heo  * @delay: number of jiffies to wait or 0 for immediate execution
30670a13c00eSTejun Heo  *
30680a13c00eSTejun Heo  * After waiting for a given time this puts a job in the kernel-global
30690a13c00eSTejun Heo  * workqueue.
30700a13c00eSTejun Heo  */
3071d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
30720a13c00eSTejun Heo {
30730a13c00eSTejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
30740a13c00eSTejun Heo }
30750a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work);
30760a13c00eSTejun Heo 
30770a13c00eSTejun Heo /**
307831ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3079b6136773SAndrew Morton  * @func: the function to call
3080b6136773SAndrew Morton  *
308131ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
308231ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3083b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
308431ddd871STejun Heo  *
308531ddd871STejun Heo  * RETURNS:
308631ddd871STejun Heo  * 0 on success, -errno on failure.
3087b6136773SAndrew Morton  */
308865f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
308915316ba8SChristoph Lameter {
309015316ba8SChristoph Lameter 	int cpu;
309138f51568SNamhyung Kim 	struct work_struct __percpu *works;
309215316ba8SChristoph Lameter 
3093b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3094b6136773SAndrew Morton 	if (!works)
309515316ba8SChristoph Lameter 		return -ENOMEM;
3096b6136773SAndrew Morton 
309795402b38SGautham R Shenoy 	get_online_cpus();
309893981800STejun Heo 
309915316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
31009bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
31019bfb1839SIngo Molnar 
31029bfb1839SIngo Molnar 		INIT_WORK(work, func);
31038de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
310415316ba8SChristoph Lameter 	}
310593981800STejun Heo 
310693981800STejun Heo 	for_each_online_cpu(cpu)
31078616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
310893981800STejun Heo 
310995402b38SGautham R Shenoy 	put_online_cpus();
3110b6136773SAndrew Morton 	free_percpu(works);
311115316ba8SChristoph Lameter 	return 0;
311215316ba8SChristoph Lameter }
311315316ba8SChristoph Lameter 
3114eef6a7d5SAlan Stern /**
3115eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3116eef6a7d5SAlan Stern  *
3117eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3118eef6a7d5SAlan Stern  * completion.
3119eef6a7d5SAlan Stern  *
3120eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3121eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3122eef6a7d5SAlan Stern  * will lead to deadlock:
3123eef6a7d5SAlan Stern  *
3124eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3125eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3126eef6a7d5SAlan Stern  *
3127eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3128eef6a7d5SAlan Stern  *
3129eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3130eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3131eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3132eef6a7d5SAlan Stern  *
3133eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3134eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3135eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3136eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3137eef6a7d5SAlan Stern  */
31381da177e4SLinus Torvalds void flush_scheduled_work(void)
31391da177e4SLinus Torvalds {
3140d320c038STejun Heo 	flush_workqueue(system_wq);
31411da177e4SLinus Torvalds }
3142ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
31431da177e4SLinus Torvalds 
31441da177e4SLinus Torvalds /**
31451fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
31461fa44ecaSJames Bottomley  * @fn:		the function to execute
31471fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
31481fa44ecaSJames Bottomley  *		be available when the work executes)
31491fa44ecaSJames Bottomley  *
31501fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
31511fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
31521fa44ecaSJames Bottomley  *
31531fa44ecaSJames Bottomley  * Returns:	0 - function was executed
31541fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31551fa44ecaSJames Bottomley  */
315665f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31571fa44ecaSJames Bottomley {
31581fa44ecaSJames Bottomley 	if (!in_interrupt()) {
315965f27f38SDavid Howells 		fn(&ew->work);
31601fa44ecaSJames Bottomley 		return 0;
31611fa44ecaSJames Bottomley 	}
31621fa44ecaSJames Bottomley 
316365f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31641fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31651fa44ecaSJames Bottomley 
31661fa44ecaSJames Bottomley 	return 1;
31671fa44ecaSJames Bottomley }
31681fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31691fa44ecaSJames Bottomley 
31701da177e4SLinus Torvalds int keventd_up(void)
31711da177e4SLinus Torvalds {
3172d320c038STejun Heo 	return system_wq != NULL;
31731da177e4SLinus Torvalds }
31741da177e4SLinus Torvalds 
3175bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
31761da177e4SLinus Torvalds {
31773af24433SOleg Nesterov 	/*
31780f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
31790f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
31800f900049STejun Heo 	 * unsigned long long.
31813af24433SOleg Nesterov 	 */
31820f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
31830f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
31840f900049STejun Heo 				   __alignof__(unsigned long long));
31853af24433SOleg Nesterov 
3186e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3187f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3188931ac77eSTejun Heo 	else {
31890f900049STejun Heo 		void *ptr;
3190e1d8aa9fSFrederic Weisbecker 
31910f900049STejun Heo 		/*
3192f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3193f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3194f3421797STejun Heo 		 * allocated pointer which will be used for free.
31950f900049STejun Heo 		 */
3196bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3197bdbc5dd7STejun Heo 		if (ptr) {
3198bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3199bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3200bdbc5dd7STejun Heo 		}
32013af24433SOleg Nesterov 	}
32023af24433SOleg Nesterov 
32030415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3204bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3205bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
32060f900049STejun Heo }
32070f900049STejun Heo 
3208bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
320906ba38a9SOleg Nesterov {
3210e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3211bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3212f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3213f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3214f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
321506ba38a9SOleg Nesterov 	}
321606ba38a9SOleg Nesterov }
321706ba38a9SOleg Nesterov 
3218f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3219f3421797STejun Heo 			       const char *name)
3220b71ab8c2STejun Heo {
3221f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3222f3421797STejun Heo 
3223f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3224044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3225f3421797STejun Heo 			max_active, name, 1, lim);
3226b71ab8c2STejun Heo 
3227f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3228b71ab8c2STejun Heo }
3229b71ab8c2STejun Heo 
3230b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
323197e37d7bSTejun Heo 					       unsigned int flags,
32321e19ffc6STejun Heo 					       int max_active,
3233eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3234b196be89STejun Heo 					       const char *lock_name, ...)
32353af24433SOleg Nesterov {
3236b196be89STejun Heo 	va_list args, args1;
32373af24433SOleg Nesterov 	struct workqueue_struct *wq;
3238c34056a3STejun Heo 	unsigned int cpu;
3239b196be89STejun Heo 	size_t namelen;
3240b196be89STejun Heo 
3241b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3242b196be89STejun Heo 	va_start(args, lock_name);
3243b196be89STejun Heo 	va_copy(args1, args);
3244b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3245b196be89STejun Heo 
3246b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3247b196be89STejun Heo 	if (!wq)
3248b196be89STejun Heo 		goto err;
3249b196be89STejun Heo 
3250b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3251b196be89STejun Heo 	va_end(args);
3252b196be89STejun Heo 	va_end(args1);
32533af24433SOleg Nesterov 
3254f3421797STejun Heo 	/*
32556370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
32566370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
32576370a6adSTejun Heo 	 */
32586370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
32596370a6adSTejun Heo 		flags |= WQ_RESCUER;
32606370a6adSTejun Heo 
3261d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3262b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
32633af24433SOleg Nesterov 
3264b196be89STejun Heo 	/* init wq */
326597e37d7bSTejun Heo 	wq->flags = flags;
3266a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
326773f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
326873f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
326973f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
327073f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
32713af24433SOleg Nesterov 
3272eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3273cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
32743af24433SOleg Nesterov 
3275bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3276bdbc5dd7STejun Heo 		goto err;
3277bdbc5dd7STejun Heo 
3278f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
32791537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
32808b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
32813270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
32821537663fSTejun Heo 
32830f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
32843270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3285c34056a3STejun Heo 		cwq->wq = wq;
328673f53c4aSTejun Heo 		cwq->flush_color = -1;
32871e19ffc6STejun Heo 		cwq->max_active = max_active;
32881e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3289e22bee78STejun Heo 	}
32901537663fSTejun Heo 
3291e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3292e22bee78STejun Heo 		struct worker *rescuer;
3293e22bee78STejun Heo 
3294f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3295e22bee78STejun Heo 			goto err;
3296e22bee78STejun Heo 
3297e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3298e22bee78STejun Heo 		if (!rescuer)
3299e22bee78STejun Heo 			goto err;
3300e22bee78STejun Heo 
3301111c225aSTejun Heo 		rescuer->rescue_wq = wq;
3302111c225aSTejun Heo 		rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
3303b196be89STejun Heo 					       wq->name);
3304e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3305e22bee78STejun Heo 			goto err;
3306e22bee78STejun Heo 
3307e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3308e22bee78STejun Heo 		wake_up_process(rescuer->task);
33093af24433SOleg Nesterov 	}
33101537663fSTejun Heo 
33113af24433SOleg Nesterov 	/*
3312a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3313a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3314a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
33153af24433SOleg Nesterov 	 */
33163af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3317a0a1a5fdSTejun Heo 
331858a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3319f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3320a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3321a0a1a5fdSTejun Heo 
33223af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3323a0a1a5fdSTejun Heo 
33243af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
33253af24433SOleg Nesterov 
33263af24433SOleg Nesterov 	return wq;
33274690c4abSTejun Heo err:
33284690c4abSTejun Heo 	if (wq) {
3329bdbc5dd7STejun Heo 		free_cwqs(wq);
3330f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3331e22bee78STejun Heo 		kfree(wq->rescuer);
33324690c4abSTejun Heo 		kfree(wq);
33333af24433SOleg Nesterov 	}
33344690c4abSTejun Heo 	return NULL;
33351da177e4SLinus Torvalds }
3336d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
33371da177e4SLinus Torvalds 
33383af24433SOleg Nesterov /**
33393af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
33403af24433SOleg Nesterov  * @wq: target workqueue
33413af24433SOleg Nesterov  *
33423af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
33433af24433SOleg Nesterov  */
33443af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
33453af24433SOleg Nesterov {
3346c8e55f36STejun Heo 	unsigned int cpu;
33473af24433SOleg Nesterov 
33489c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
33499c5a2ba7STejun Heo 	drain_workqueue(wq);
3350c8efcc25STejun Heo 
3351a0a1a5fdSTejun Heo 	/*
3352a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3353a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3354a0a1a5fdSTejun Heo 	 */
335595402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
33563af24433SOleg Nesterov 	list_del(&wq->list);
335795402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
33583af24433SOleg Nesterov 
3359e22bee78STejun Heo 	/* sanity check */
3360f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
336173f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
336273f53c4aSTejun Heo 		int i;
33633af24433SOleg Nesterov 
336473f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
336573f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
33661e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
33671e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
336873f53c4aSTejun Heo 	}
33691537663fSTejun Heo 
3370e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3371e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3372f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
33738d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3374e22bee78STejun Heo 	}
3375e22bee78STejun Heo 
3376bdbc5dd7STejun Heo 	free_cwqs(wq);
33773af24433SOleg Nesterov 	kfree(wq);
33783af24433SOleg Nesterov }
33793af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
33803af24433SOleg Nesterov 
3381dcd989cbSTejun Heo /**
33829f4bd4cdSLai Jiangshan  * cwq_set_max_active - adjust max_active of a cwq
33839f4bd4cdSLai Jiangshan  * @cwq: target cpu_workqueue_struct
33849f4bd4cdSLai Jiangshan  * @max_active: new max_active value.
33859f4bd4cdSLai Jiangshan  *
33869f4bd4cdSLai Jiangshan  * Set @cwq->max_active to @max_active and activate delayed works if
33879f4bd4cdSLai Jiangshan  * increased.
33889f4bd4cdSLai Jiangshan  *
33899f4bd4cdSLai Jiangshan  * CONTEXT:
3390*d565ed63STejun Heo  * spin_lock_irq(pool->lock).
33919f4bd4cdSLai Jiangshan  */
33929f4bd4cdSLai Jiangshan static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
33939f4bd4cdSLai Jiangshan {
33949f4bd4cdSLai Jiangshan 	cwq->max_active = max_active;
33959f4bd4cdSLai Jiangshan 
33969f4bd4cdSLai Jiangshan 	while (!list_empty(&cwq->delayed_works) &&
33979f4bd4cdSLai Jiangshan 	       cwq->nr_active < cwq->max_active)
33989f4bd4cdSLai Jiangshan 		cwq_activate_first_delayed(cwq);
33999f4bd4cdSLai Jiangshan }
34009f4bd4cdSLai Jiangshan 
34019f4bd4cdSLai Jiangshan /**
3402dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3403dcd989cbSTejun Heo  * @wq: target workqueue
3404dcd989cbSTejun Heo  * @max_active: new max_active value.
3405dcd989cbSTejun Heo  *
3406dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3407dcd989cbSTejun Heo  *
3408dcd989cbSTejun Heo  * CONTEXT:
3409dcd989cbSTejun Heo  * Don't call from IRQ context.
3410dcd989cbSTejun Heo  */
3411dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3412dcd989cbSTejun Heo {
3413dcd989cbSTejun Heo 	unsigned int cpu;
3414dcd989cbSTejun Heo 
3415f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3416dcd989cbSTejun Heo 
3417dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3418dcd989cbSTejun Heo 
3419dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3420dcd989cbSTejun Heo 
3421f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
342235b6bb63STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
342335b6bb63STejun Heo 		struct worker_pool *pool = cwq->pool;
3424dcd989cbSTejun Heo 
3425*d565ed63STejun Heo 		spin_lock_irq(&pool->lock);
3426dcd989cbSTejun Heo 
342758a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
342835b6bb63STejun Heo 		    !(pool->flags & POOL_FREEZING))
342935b6bb63STejun Heo 			cwq_set_max_active(cwq, max_active);
3430dcd989cbSTejun Heo 
3431*d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
3432dcd989cbSTejun Heo 	}
3433dcd989cbSTejun Heo 
3434dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3435dcd989cbSTejun Heo }
3436dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3437dcd989cbSTejun Heo 
3438dcd989cbSTejun Heo /**
3439dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3440dcd989cbSTejun Heo  * @cpu: CPU in question
3441dcd989cbSTejun Heo  * @wq: target workqueue
3442dcd989cbSTejun Heo  *
3443dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3444dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3445dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3446dcd989cbSTejun Heo  *
3447dcd989cbSTejun Heo  * RETURNS:
3448dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3449dcd989cbSTejun Heo  */
3450dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3451dcd989cbSTejun Heo {
3452dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3453dcd989cbSTejun Heo 
3454dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3455dcd989cbSTejun Heo }
3456dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3457dcd989cbSTejun Heo 
3458dcd989cbSTejun Heo /**
3459dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3460dcd989cbSTejun Heo  * @work: the work to be tested
3461dcd989cbSTejun Heo  *
3462dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3463dcd989cbSTejun Heo  * synchronization around this function and the test result is
3464dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3465dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3466dcd989cbSTejun Heo  * running state.
3467dcd989cbSTejun Heo  *
3468dcd989cbSTejun Heo  * RETURNS:
3469dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3470dcd989cbSTejun Heo  */
3471dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3472dcd989cbSTejun Heo {
3473c9e7cf27STejun Heo 	struct worker_pool *pool = get_work_pool(work);
3474dcd989cbSTejun Heo 	unsigned long flags;
3475dcd989cbSTejun Heo 	unsigned int ret = 0;
3476dcd989cbSTejun Heo 
3477c9e7cf27STejun Heo 	if (!pool)
3478999767beSJoonsoo Kim 		return 0;
3479dcd989cbSTejun Heo 
3480*d565ed63STejun Heo 	spin_lock_irqsave(&pool->lock, flags);
3481dcd989cbSTejun Heo 
3482dcd989cbSTejun Heo 	if (work_pending(work))
3483dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3484c9e7cf27STejun Heo 	if (find_worker_executing_work(pool, work))
3485dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3486dcd989cbSTejun Heo 
3487*d565ed63STejun Heo 	spin_unlock_irqrestore(&pool->lock, flags);
3488dcd989cbSTejun Heo 
3489dcd989cbSTejun Heo 	return ret;
3490dcd989cbSTejun Heo }
3491dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3492dcd989cbSTejun Heo 
3493db7bccf4STejun Heo /*
3494db7bccf4STejun Heo  * CPU hotplug.
3495db7bccf4STejun Heo  *
3496e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3497e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3498e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3499e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3500e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3501e22bee78STejun Heo  * blocked draining impractical.
3502e22bee78STejun Heo  *
350324647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
3504628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
3505628c78e7STejun Heo  * cpu comes back online.
3506db7bccf4STejun Heo  */
3507db7bccf4STejun Heo 
350860373152STejun Heo /* claim manager positions of all pools */
3509b2eb83d1SLai Jiangshan static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
351060373152STejun Heo {
351160373152STejun Heo 	struct worker_pool *pool;
351260373152STejun Heo 
351360373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3514b2eb83d1SLai Jiangshan 		mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
3515*d565ed63STejun Heo 
3516*d565ed63STejun Heo 	local_irq_disable();
3517*d565ed63STejun Heo 	for_each_worker_pool(pool, gcwq)
3518*d565ed63STejun Heo 		spin_lock_nested(&pool->lock, pool - gcwq->pools);
351960373152STejun Heo }
352060373152STejun Heo 
352160373152STejun Heo /* release manager positions */
3522b2eb83d1SLai Jiangshan static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
352360373152STejun Heo {
352460373152STejun Heo 	struct worker_pool *pool;
352560373152STejun Heo 
3526*d565ed63STejun Heo 	for_each_worker_pool(pool, gcwq)
3527*d565ed63STejun Heo 		spin_unlock(&pool->lock);
3528*d565ed63STejun Heo 	local_irq_enable();
3529*d565ed63STejun Heo 
353060373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3531b2eb83d1SLai Jiangshan 		mutex_unlock(&pool->assoc_mutex);
353260373152STejun Heo }
353360373152STejun Heo 
3534628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work)
3535db7bccf4STejun Heo {
3536628c78e7STejun Heo 	struct global_cwq *gcwq = get_gcwq(smp_processor_id());
35374ce62e9eSTejun Heo 	struct worker_pool *pool;
3538db7bccf4STejun Heo 	struct worker *worker;
3539db7bccf4STejun Heo 	struct hlist_node *pos;
3540db7bccf4STejun Heo 	int i;
3541db7bccf4STejun Heo 
3542ec22ca5eSTejun Heo 	BUG_ON(gcwq->pools[0].cpu != smp_processor_id());
3543db7bccf4STejun Heo 
3544b2eb83d1SLai Jiangshan 	gcwq_claim_assoc_and_lock(gcwq);
3545e22bee78STejun Heo 
3546f2d5a0eeSTejun Heo 	/*
3547f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3548f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3549f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3550f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3551f2d5a0eeSTejun Heo 	 */
3552c9e7cf27STejun Heo 	for_each_worker_pool(pool, gcwq) {
35534ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3554403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3555db7bccf4STejun Heo 
3556c9e7cf27STejun Heo 		for_each_busy_worker(worker, i, pos, pool)
3557403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3558db7bccf4STejun Heo 
355924647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
3560c9e7cf27STejun Heo 	}
3561f2d5a0eeSTejun Heo 
3562b2eb83d1SLai Jiangshan 	gcwq_release_assoc_and_unlock(gcwq);
3563e22bee78STejun Heo 
3564e22bee78STejun Heo 	/*
3565628c78e7STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3566628c78e7STejun Heo 	 * sched callbacks see the %WORKER_UNBOUND flag.  This is necessary
3567628c78e7STejun Heo 	 * as scheduler callbacks may be invoked from other cpus.
3568628c78e7STejun Heo 	 */
3569628c78e7STejun Heo 	schedule();
3570628c78e7STejun Heo 
3571628c78e7STejun Heo 	/*
3572628c78e7STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After this,
3573628c78e7STejun Heo 	 * nr_running stays zero and need_more_worker() and keep_working()
3574628c78e7STejun Heo 	 * are always true as long as the worklist is not empty.  @gcwq now
3575628c78e7STejun Heo 	 * behaves as unbound (in terms of concurrency management) gcwq
3576628c78e7STejun Heo 	 * which is served by workers tied to the CPU.
3577628c78e7STejun Heo 	 *
3578628c78e7STejun Heo 	 * On return from this function, the current worker would trigger
3579628c78e7STejun Heo 	 * unbound chain execution of pending work items if other workers
3580628c78e7STejun Heo 	 * didn't already.
3581e22bee78STejun Heo 	 */
35824ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35834ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3584db7bccf4STejun Heo }
3585db7bccf4STejun Heo 
35868db25e78STejun Heo /*
35878db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
35888db25e78STejun Heo  * This will be registered high priority CPU notifier.
35898db25e78STejun Heo  */
35909fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
35911da177e4SLinus Torvalds 					       unsigned long action,
35921da177e4SLinus Torvalds 					       void *hcpu)
35931da177e4SLinus Torvalds {
35943af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3595db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
35964ce62e9eSTejun Heo 	struct worker_pool *pool;
35971da177e4SLinus Torvalds 
35988db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
35993af24433SOleg Nesterov 	case CPU_UP_PREPARE:
36004ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
36013ce63377STejun Heo 			struct worker *worker;
36023ce63377STejun Heo 
36033ce63377STejun Heo 			if (pool->nr_workers)
36043ce63377STejun Heo 				continue;
36053ce63377STejun Heo 
36063ce63377STejun Heo 			worker = create_worker(pool);
36073ce63377STejun Heo 			if (!worker)
36083ce63377STejun Heo 				return NOTIFY_BAD;
36093ce63377STejun Heo 
3610*d565ed63STejun Heo 			spin_lock_irq(&pool->lock);
36113ce63377STejun Heo 			start_worker(worker);
3612*d565ed63STejun Heo 			spin_unlock_irq(&pool->lock);
36133af24433SOleg Nesterov 		}
36141da177e4SLinus Torvalds 		break;
36151da177e4SLinus Torvalds 
361665758202STejun Heo 	case CPU_DOWN_FAILED:
361765758202STejun Heo 	case CPU_ONLINE:
3618b2eb83d1SLai Jiangshan 		gcwq_claim_assoc_and_lock(gcwq);
361924647570STejun Heo 		for_each_worker_pool(pool, gcwq)
362024647570STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
36218db25e78STejun Heo 		rebind_workers(gcwq);
3622b2eb83d1SLai Jiangshan 		gcwq_release_assoc_and_unlock(gcwq);
36238db25e78STejun Heo 		break;
362465758202STejun Heo 	}
362565758202STejun Heo 	return NOTIFY_OK;
362665758202STejun Heo }
362765758202STejun Heo 
362865758202STejun Heo /*
362965758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
363065758202STejun Heo  * This will be registered as low priority CPU notifier.
363165758202STejun Heo  */
36329fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
363365758202STejun Heo 						 unsigned long action,
363465758202STejun Heo 						 void *hcpu)
363565758202STejun Heo {
36368db25e78STejun Heo 	unsigned int cpu = (unsigned long)hcpu;
36378db25e78STejun Heo 	struct work_struct unbind_work;
36388db25e78STejun Heo 
363965758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
364065758202STejun Heo 	case CPU_DOWN_PREPARE:
36418db25e78STejun Heo 		/* unbinding should happen on the local CPU */
36428db25e78STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
36437635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
36448db25e78STejun Heo 		flush_work(&unbind_work);
36458db25e78STejun Heo 		break;
364665758202STejun Heo 	}
364765758202STejun Heo 	return NOTIFY_OK;
364865758202STejun Heo }
364965758202STejun Heo 
36502d3854a3SRusty Russell #ifdef CONFIG_SMP
36518ccad40dSRusty Russell 
36522d3854a3SRusty Russell struct work_for_cpu {
3653ed48ece2STejun Heo 	struct work_struct work;
36542d3854a3SRusty Russell 	long (*fn)(void *);
36552d3854a3SRusty Russell 	void *arg;
36562d3854a3SRusty Russell 	long ret;
36572d3854a3SRusty Russell };
36582d3854a3SRusty Russell 
3659ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
36602d3854a3SRusty Russell {
3661ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3662ed48ece2STejun Heo 
36632d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36642d3854a3SRusty Russell }
36652d3854a3SRusty Russell 
36662d3854a3SRusty Russell /**
36672d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36682d3854a3SRusty Russell  * @cpu: the cpu to run on
36692d3854a3SRusty Russell  * @fn: the function to run
36702d3854a3SRusty Russell  * @arg: the function arg
36712d3854a3SRusty Russell  *
367231ad9081SRusty Russell  * This will return the value @fn returns.
367331ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36746b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36752d3854a3SRusty Russell  */
36762d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36772d3854a3SRusty Russell {
3678ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
36792d3854a3SRusty Russell 
3680ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3681ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
3682ed48ece2STejun Heo 	flush_work(&wfc.work);
36832d3854a3SRusty Russell 	return wfc.ret;
36842d3854a3SRusty Russell }
36852d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36862d3854a3SRusty Russell #endif /* CONFIG_SMP */
36872d3854a3SRusty Russell 
3688a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3689e7577c50SRusty Russell 
3690a0a1a5fdSTejun Heo /**
3691a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3692a0a1a5fdSTejun Heo  *
369358a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
369458a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
369558a69cb4STejun Heo  * gcwq->worklist.
3696a0a1a5fdSTejun Heo  *
3697a0a1a5fdSTejun Heo  * CONTEXT:
3698*d565ed63STejun Heo  * Grabs and releases workqueue_lock and pool->lock's.
3699a0a1a5fdSTejun Heo  */
3700a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3701a0a1a5fdSTejun Heo {
3702a0a1a5fdSTejun Heo 	unsigned int cpu;
3703a0a1a5fdSTejun Heo 
3704a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3705a0a1a5fdSTejun Heo 
3706a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3707a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3708a0a1a5fdSTejun Heo 
3709f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37108b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
371135b6bb63STejun Heo 		struct worker_pool *pool;
3712bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37138b03ae3cSTejun Heo 
3714*d565ed63STejun Heo 		local_irq_disable();
37158b03ae3cSTejun Heo 
371635b6bb63STejun Heo 		for_each_worker_pool(pool, gcwq) {
3717*d565ed63STejun Heo 			spin_lock_nested(&pool->lock, pool - gcwq->pools);
3718*d565ed63STejun Heo 
371935b6bb63STejun Heo 			WARN_ON_ONCE(pool->flags & POOL_FREEZING);
372035b6bb63STejun Heo 			pool->flags |= POOL_FREEZING;
372135b6bb63STejun Heo 		}
3722db7bccf4STejun Heo 
3723a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3724a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3725a0a1a5fdSTejun Heo 
372658a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3727a0a1a5fdSTejun Heo 				cwq->max_active = 0;
37281da177e4SLinus Torvalds 		}
37298b03ae3cSTejun Heo 
3730*d565ed63STejun Heo 		for_each_worker_pool(pool, gcwq)
3731*d565ed63STejun Heo 			spin_unlock(&pool->lock);
3732*d565ed63STejun Heo 		local_irq_enable();
3733a0a1a5fdSTejun Heo 	}
3734a0a1a5fdSTejun Heo 
3735a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3736a0a1a5fdSTejun Heo }
3737a0a1a5fdSTejun Heo 
3738a0a1a5fdSTejun Heo /**
373958a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3740a0a1a5fdSTejun Heo  *
3741a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3742a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3743a0a1a5fdSTejun Heo  *
3744a0a1a5fdSTejun Heo  * CONTEXT:
3745a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3746a0a1a5fdSTejun Heo  *
3747a0a1a5fdSTejun Heo  * RETURNS:
374858a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
374958a69cb4STejun Heo  * is complete.
3750a0a1a5fdSTejun Heo  */
3751a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3752a0a1a5fdSTejun Heo {
3753a0a1a5fdSTejun Heo 	unsigned int cpu;
3754a0a1a5fdSTejun Heo 	bool busy = false;
3755a0a1a5fdSTejun Heo 
3756a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3757a0a1a5fdSTejun Heo 
3758a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3759a0a1a5fdSTejun Heo 
3760f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3761bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3762a0a1a5fdSTejun Heo 		/*
3763a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3764a0a1a5fdSTejun Heo 		 * to peek without lock.
3765a0a1a5fdSTejun Heo 		 */
3766a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3767a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3768a0a1a5fdSTejun Heo 
376958a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3770a0a1a5fdSTejun Heo 				continue;
3771a0a1a5fdSTejun Heo 
3772a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3773a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3774a0a1a5fdSTejun Heo 				busy = true;
3775a0a1a5fdSTejun Heo 				goto out_unlock;
3776a0a1a5fdSTejun Heo 			}
3777a0a1a5fdSTejun Heo 		}
3778a0a1a5fdSTejun Heo 	}
3779a0a1a5fdSTejun Heo out_unlock:
3780a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3781a0a1a5fdSTejun Heo 	return busy;
3782a0a1a5fdSTejun Heo }
3783a0a1a5fdSTejun Heo 
3784a0a1a5fdSTejun Heo /**
3785a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3786a0a1a5fdSTejun Heo  *
3787a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
37887e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3789a0a1a5fdSTejun Heo  *
3790a0a1a5fdSTejun Heo  * CONTEXT:
3791*d565ed63STejun Heo  * Grabs and releases workqueue_lock and pool->lock's.
3792a0a1a5fdSTejun Heo  */
3793a0a1a5fdSTejun Heo void thaw_workqueues(void)
3794a0a1a5fdSTejun Heo {
3795a0a1a5fdSTejun Heo 	unsigned int cpu;
3796a0a1a5fdSTejun Heo 
3797a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3798a0a1a5fdSTejun Heo 
3799a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3800a0a1a5fdSTejun Heo 		goto out_unlock;
3801a0a1a5fdSTejun Heo 
3802f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38038b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38044ce62e9eSTejun Heo 		struct worker_pool *pool;
3805bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
38068b03ae3cSTejun Heo 
3807*d565ed63STejun Heo 		local_irq_disable();
38088b03ae3cSTejun Heo 
380935b6bb63STejun Heo 		for_each_worker_pool(pool, gcwq) {
3810*d565ed63STejun Heo 			spin_lock_nested(&pool->lock, pool - gcwq->pools);
3811*d565ed63STejun Heo 
381235b6bb63STejun Heo 			WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
381335b6bb63STejun Heo 			pool->flags &= ~POOL_FREEZING;
381435b6bb63STejun Heo 		}
3815db7bccf4STejun Heo 
3816a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3817a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3818a0a1a5fdSTejun Heo 
381958a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3820a0a1a5fdSTejun Heo 				continue;
3821a0a1a5fdSTejun Heo 
3822a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
38239f4bd4cdSLai Jiangshan 			cwq_set_max_active(cwq, wq->saved_max_active);
3824a0a1a5fdSTejun Heo 		}
38258b03ae3cSTejun Heo 
3826*d565ed63STejun Heo 		for_each_worker_pool(pool, gcwq) {
38274ce62e9eSTejun Heo 			wake_up_worker(pool);
3828*d565ed63STejun Heo 			spin_unlock(&pool->lock);
3829*d565ed63STejun Heo 		}
3830*d565ed63STejun Heo 		local_irq_enable();
3831a0a1a5fdSTejun Heo 	}
3832a0a1a5fdSTejun Heo 
3833a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3834a0a1a5fdSTejun Heo out_unlock:
3835a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3836a0a1a5fdSTejun Heo }
3837a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3838a0a1a5fdSTejun Heo 
38396ee0578bSSuresh Siddha static int __init init_workqueues(void)
38401da177e4SLinus Torvalds {
3841c34056a3STejun Heo 	unsigned int cpu;
3842c34056a3STejun Heo 
38437c3eed5cSTejun Heo 	/* make sure we have enough bits for OFFQ pool ID */
38447c3eed5cSTejun Heo 	BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) <
38457c3eed5cSTejun Heo 		     WORK_CPU_LAST * NR_STD_WORKER_POOLS);
3846b5490077STejun Heo 
384765758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3848a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
38498b03ae3cSTejun Heo 
38508b03ae3cSTejun Heo 	/* initialize gcwqs */
3851f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38528b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38534ce62e9eSTejun Heo 		struct worker_pool *pool;
38548b03ae3cSTejun Heo 
38554ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38564ce62e9eSTejun Heo 			pool->gcwq = gcwq;
3857*d565ed63STejun Heo 			spin_lock_init(&pool->lock);
3858ec22ca5eSTejun Heo 			pool->cpu = cpu;
385924647570STejun Heo 			pool->flags |= POOL_DISASSOCIATED;
38604ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38614ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3862c9e7cf27STejun Heo 			hash_init(pool->busy_hash);
3863e22bee78STejun Heo 
38644ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38654ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38664ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3867e22bee78STejun Heo 
38684ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38694ce62e9eSTejun Heo 				    (unsigned long)pool);
38704ce62e9eSTejun Heo 
3871b2eb83d1SLai Jiangshan 			mutex_init(&pool->assoc_mutex);
38724ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38739daf9e67STejun Heo 
38749daf9e67STejun Heo 			/* alloc pool ID */
38759daf9e67STejun Heo 			BUG_ON(worker_pool_assign_id(pool));
38764ce62e9eSTejun Heo 		}
38778b03ae3cSTejun Heo 	}
38788b03ae3cSTejun Heo 
3879e22bee78STejun Heo 	/* create the initial worker */
3880f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3881e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38824ce62e9eSTejun Heo 		struct worker_pool *pool;
3883e22bee78STejun Heo 
38844ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38854ce62e9eSTejun Heo 			struct worker *worker;
38864ce62e9eSTejun Heo 
388724647570STejun Heo 			if (cpu != WORK_CPU_UNBOUND)
388824647570STejun Heo 				pool->flags &= ~POOL_DISASSOCIATED;
388924647570STejun Heo 
3890bc2ae0f5STejun Heo 			worker = create_worker(pool);
3891e22bee78STejun Heo 			BUG_ON(!worker);
3892*d565ed63STejun Heo 			spin_lock_irq(&pool->lock);
3893e22bee78STejun Heo 			start_worker(worker);
3894*d565ed63STejun Heo 			spin_unlock_irq(&pool->lock);
3895e22bee78STejun Heo 		}
38964ce62e9eSTejun Heo 	}
3897e22bee78STejun Heo 
3898d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
38991aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
3900d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3901f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3902f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
390324d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
390424d51addSTejun Heo 					      WQ_FREEZABLE, 0);
39051aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
3906ae930e0fSTejun Heo 	       !system_unbound_wq || !system_freezable_wq);
39076ee0578bSSuresh Siddha 	return 0;
39081da177e4SLinus Torvalds }
39096ee0578bSSuresh Siddha early_initcall(init_workqueues);
3910