xref: /linux-6.15/kernel/workqueue.c (revision 35b6bb63)
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 */
68*35b6bb63STejun 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  *
1118b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1124690c4abSTejun Heo  *
113e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
114e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
115e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
11624647570STejun Heo  *    If 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 */
12711ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
128bd7bdd43STejun Heo 
129bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
130bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
131ea1abd61SLai Jiangshan 
132ea1abd61SLai Jiangshan 	/* nr_idle includes the ones off idle_list for rebinding */
133bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
134bd7bdd43STejun Heo 
135bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
136bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
137bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
138bd7bdd43STejun Heo 
13924647570STejun Heo 	struct mutex		assoc_mutex;	/* protect POOL_DISASSOCIATED */
140bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
141bd7bdd43STejun Heo };
142bd7bdd43STejun Heo 
1434690c4abSTejun Heo /*
144e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
145e22bee78STejun Heo  * and all works are queued and processed here regardless of their
146e22bee78STejun Heo  * target workqueues.
1478b03ae3cSTejun Heo  */
1488b03ae3cSTejun Heo struct global_cwq {
1498b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1508b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
151c8e55f36STejun Heo 
152bd7bdd43STejun Heo 	/* workers are chained either in busy_hash or pool idle_list */
15342f8570fSSasha Levin 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
154c8e55f36STejun Heo 						/* L: hash of busy workers */
155c8e55f36STejun Heo 
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 
257db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
25842f8570fSSasha Levin 	hash_for_each(gcwq->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 
448c34056a3STejun Heo static int worker_thread(void *__worker);
449e2905b29STejun Heo static unsigned int work_cpu(struct work_struct *work);
4501da177e4SLinus Torvalds 
451e34cdddbSTejun Heo static int std_worker_pool_pri(struct worker_pool *pool)
4523270476aSTejun Heo {
4533270476aSTejun Heo 	return pool - pool->gcwq->pools;
4543270476aSTejun Heo }
4553270476aSTejun Heo 
4568b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4571da177e4SLinus Torvalds {
458f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4598b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
460f3421797STejun Heo 	else
461f3421797STejun Heo 		return &unbound_global_cwq;
4621da177e4SLinus Torvalds }
4631da177e4SLinus Torvalds 
46463d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
465b1f4ec17SOleg Nesterov {
46663d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
467e34cdddbSTejun Heo 	int idx = std_worker_pool_pri(pool);
46863d95a91STejun Heo 
469f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4704ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
471f3421797STejun Heo 	else
4724ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
473b1f4ec17SOleg Nesterov }
474b1f4ec17SOleg Nesterov 
4754690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
4764690c4abSTejun Heo 					    struct workqueue_struct *wq)
477a848e3b6SOleg Nesterov {
478f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
479e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
480bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
481f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
482f3421797STejun Heo 		return wq->cpu_wq.single;
483f3421797STejun Heo 	return NULL;
484f3421797STejun Heo }
485a848e3b6SOleg Nesterov 
48673f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
48773f53c4aSTejun Heo {
48873f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
48973f53c4aSTejun Heo }
49073f53c4aSTejun Heo 
49173f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
49273f53c4aSTejun Heo {
49373f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
49473f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
49573f53c4aSTejun Heo }
49673f53c4aSTejun Heo 
49773f53c4aSTejun Heo static int work_next_color(int color)
49873f53c4aSTejun Heo {
49973f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5001da177e4SLinus Torvalds }
5011da177e4SLinus Torvalds 
5024594bf15SDavid Howells /*
503b5490077STejun Heo  * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
504b5490077STejun Heo  * contain the pointer to the queued cwq.  Once execution starts, the flag
505b5490077STejun Heo  * is cleared and the high bits contain OFFQ flags and CPU number.
5067a22ad75STejun Heo  *
507bbb68dfaSTejun Heo  * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
508bbb68dfaSTejun Heo  * and clear_work_data() can be used to set the cwq, cpu or clear
509bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
510bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5117a22ad75STejun Heo  *
512bbb68dfaSTejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
513bbb68dfaSTejun Heo  * a work.  gcwq is available once the work has been queued anywhere after
514bbb68dfaSTejun Heo  * initialization until it is sync canceled.  cwq is available only while
515bbb68dfaSTejun Heo  * the work item is queued.
516bbb68dfaSTejun Heo  *
517bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
518bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
519bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
520bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5214594bf15SDavid Howells  */
5227a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5237a22ad75STejun Heo 				 unsigned long flags)
5247a22ad75STejun Heo {
5257a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5267a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5277a22ad75STejun Heo }
5287a22ad75STejun Heo 
5297a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5304690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5314690c4abSTejun Heo 			 unsigned long extra_flags)
532365970a1SDavid Howells {
5337a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
534e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
535365970a1SDavid Howells }
536365970a1SDavid Howells 
5378930cabaSTejun Heo static void set_work_cpu_and_clear_pending(struct work_struct *work,
5388930cabaSTejun Heo 					   unsigned int cpu)
5394d707b9fSOleg Nesterov {
54023657bb1STejun Heo 	/*
54123657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
54223657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
54323657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
54423657bb1STejun Heo 	 * owner.
54523657bb1STejun Heo 	 */
54623657bb1STejun Heo 	smp_wmb();
547b5490077STejun Heo 	set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
5484d707b9fSOleg Nesterov }
5494d707b9fSOleg Nesterov 
5507a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
551365970a1SDavid Howells {
55223657bb1STejun Heo 	smp_wmb();	/* see set_work_cpu_and_clear_pending() */
5537a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5547a22ad75STejun Heo }
5557a22ad75STejun Heo 
5567a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5577a22ad75STejun Heo {
558e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5597a22ad75STejun Heo 
560e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
561e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
562e120153dSTejun Heo 	else
563e120153dSTejun Heo 		return NULL;
5647a22ad75STejun Heo }
5657a22ad75STejun Heo 
5667a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5677a22ad75STejun Heo {
568e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5697a22ad75STejun Heo 	unsigned int cpu;
5707a22ad75STejun Heo 
571e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
572e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
573bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
5747a22ad75STejun Heo 
575b5490077STejun Heo 	cpu = data >> WORK_OFFQ_CPU_SHIFT;
576bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
5777a22ad75STejun Heo 		return NULL;
5787a22ad75STejun Heo 
579f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
5807a22ad75STejun Heo 	return get_gcwq(cpu);
581365970a1SDavid Howells }
582365970a1SDavid Howells 
583bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
584bbb68dfaSTejun Heo {
585bbb68dfaSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
586bbb68dfaSTejun Heo 	unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
587bbb68dfaSTejun Heo 
588bbb68dfaSTejun Heo 	set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
589bbb68dfaSTejun Heo 		      WORK_STRUCT_PENDING);
590bbb68dfaSTejun Heo }
591bbb68dfaSTejun Heo 
592bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
593bbb68dfaSTejun Heo {
594bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
595bbb68dfaSTejun Heo 
596bbb68dfaSTejun Heo 	return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
597bbb68dfaSTejun Heo }
598bbb68dfaSTejun Heo 
599e22bee78STejun Heo /*
6003270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
6013270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
6023270476aSTejun Heo  * they're being called with gcwq->lock held.
603e22bee78STejun Heo  */
604e22bee78STejun Heo 
60563d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
606649027d7STejun Heo {
6073270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
608649027d7STejun Heo }
609649027d7STejun Heo 
610e22bee78STejun Heo /*
611e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
612e22bee78STejun Heo  * running workers.
613974271c4STejun Heo  *
614974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
615974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
616974271c4STejun Heo  * worklist isn't empty.
617e22bee78STejun Heo  */
61863d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
619e22bee78STejun Heo {
62063d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
621e22bee78STejun Heo }
622e22bee78STejun Heo 
623e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
62463d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
625e22bee78STejun Heo {
62663d95a91STejun Heo 	return pool->nr_idle;
627e22bee78STejun Heo }
628e22bee78STejun Heo 
629e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
63063d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
631e22bee78STejun Heo {
63263d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
633e22bee78STejun Heo 
6343270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
635e22bee78STejun Heo }
636e22bee78STejun Heo 
637e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
63863d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
639e22bee78STejun Heo {
64063d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
641e22bee78STejun Heo }
642e22bee78STejun Heo 
643e22bee78STejun Heo /* Do I need to be the manager? */
64463d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
645e22bee78STejun Heo {
64663d95a91STejun Heo 	return need_to_create_worker(pool) ||
64711ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
648e22bee78STejun Heo }
649e22bee78STejun Heo 
650e22bee78STejun Heo /* Do we have too many workers and should some go away? */
65163d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
652e22bee78STejun Heo {
653552a37e9SLai Jiangshan 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
65463d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
65563d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
656e22bee78STejun Heo 
657ea1abd61SLai Jiangshan 	/*
658ea1abd61SLai Jiangshan 	 * nr_idle and idle_list may disagree if idle rebinding is in
659ea1abd61SLai Jiangshan 	 * progress.  Never return %true if idle_list is empty.
660ea1abd61SLai Jiangshan 	 */
661ea1abd61SLai Jiangshan 	if (list_empty(&pool->idle_list))
662ea1abd61SLai Jiangshan 		return false;
663ea1abd61SLai Jiangshan 
664e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
665e22bee78STejun Heo }
666e22bee78STejun Heo 
667e22bee78STejun Heo /*
668e22bee78STejun Heo  * Wake up functions.
669e22bee78STejun Heo  */
670e22bee78STejun Heo 
6717e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
67263d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
6737e11629dSTejun Heo {
67463d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
6757e11629dSTejun Heo 		return NULL;
6767e11629dSTejun Heo 
67763d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
6787e11629dSTejun Heo }
6797e11629dSTejun Heo 
6807e11629dSTejun Heo /**
6817e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
68263d95a91STejun Heo  * @pool: worker pool to wake worker from
6837e11629dSTejun Heo  *
68463d95a91STejun Heo  * Wake up the first idle worker of @pool.
6857e11629dSTejun Heo  *
6867e11629dSTejun Heo  * CONTEXT:
6877e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
6887e11629dSTejun Heo  */
68963d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
6907e11629dSTejun Heo {
69163d95a91STejun Heo 	struct worker *worker = first_worker(pool);
6927e11629dSTejun Heo 
6937e11629dSTejun Heo 	if (likely(worker))
6947e11629dSTejun Heo 		wake_up_process(worker->task);
6957e11629dSTejun Heo }
6967e11629dSTejun Heo 
6974690c4abSTejun Heo /**
698e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
699e22bee78STejun Heo  * @task: task waking up
700e22bee78STejun Heo  * @cpu: CPU @task is waking up to
701e22bee78STejun Heo  *
702e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
703e22bee78STejun Heo  * being awoken.
704e22bee78STejun Heo  *
705e22bee78STejun Heo  * CONTEXT:
706e22bee78STejun Heo  * spin_lock_irq(rq->lock)
707e22bee78STejun Heo  */
708e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
709e22bee78STejun Heo {
710e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
711e22bee78STejun Heo 
71236576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
71336576000SJoonsoo Kim 		WARN_ON_ONCE(worker->pool->gcwq->cpu != cpu);
71463d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
715e22bee78STejun Heo 	}
71636576000SJoonsoo Kim }
717e22bee78STejun Heo 
718e22bee78STejun Heo /**
719e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
720e22bee78STejun Heo  * @task: task going to sleep
721e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
722e22bee78STejun Heo  *
723e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
724e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
725e22bee78STejun Heo  * returning pointer to its task.
726e22bee78STejun Heo  *
727e22bee78STejun Heo  * CONTEXT:
728e22bee78STejun Heo  * spin_lock_irq(rq->lock)
729e22bee78STejun Heo  *
730e22bee78STejun Heo  * RETURNS:
731e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
732e22bee78STejun Heo  */
733e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
734e22bee78STejun Heo 				       unsigned int cpu)
735e22bee78STejun Heo {
736e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
737111c225aSTejun Heo 	struct worker_pool *pool;
738111c225aSTejun Heo 	atomic_t *nr_running;
739e22bee78STejun Heo 
740111c225aSTejun Heo 	/*
741111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
742111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
743111c225aSTejun Heo 	 * checking NOT_RUNNING.
744111c225aSTejun Heo 	 */
7452d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
746e22bee78STejun Heo 		return NULL;
747e22bee78STejun Heo 
748111c225aSTejun Heo 	pool = worker->pool;
749111c225aSTejun Heo 	nr_running = get_pool_nr_running(pool);
750111c225aSTejun Heo 
751e22bee78STejun Heo 	/* this can only happen on the local cpu */
752e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
753e22bee78STejun Heo 
754e22bee78STejun Heo 	/*
755e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
756e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
757e22bee78STejun Heo 	 * Please read comment there.
758e22bee78STejun Heo 	 *
759628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
760628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
761628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
762628c78e7STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without gcwq
763628c78e7STejun Heo 	 * lock is safe.
764e22bee78STejun Heo 	 */
765bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
76663d95a91STejun Heo 		to_wakeup = first_worker(pool);
767e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
768e22bee78STejun Heo }
769e22bee78STejun Heo 
770e22bee78STejun Heo /**
771e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
772cb444766STejun Heo  * @worker: self
773d302f017STejun Heo  * @flags: flags to set
774d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
775d302f017STejun Heo  *
776e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
777e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
778e22bee78STejun Heo  * woken up.
779d302f017STejun Heo  *
780cb444766STejun Heo  * CONTEXT:
781cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
782d302f017STejun Heo  */
783d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
784d302f017STejun Heo 				    bool wakeup)
785d302f017STejun Heo {
786bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
787e22bee78STejun Heo 
788cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
789cb444766STejun Heo 
790e22bee78STejun Heo 	/*
791e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
792e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
793e22bee78STejun Heo 	 * @wakeup.
794e22bee78STejun Heo 	 */
795e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
796e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
79763d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
798e22bee78STejun Heo 
799e22bee78STejun Heo 		if (wakeup) {
800e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
801bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
80263d95a91STejun Heo 				wake_up_worker(pool);
803e22bee78STejun Heo 		} else
804e22bee78STejun Heo 			atomic_dec(nr_running);
805e22bee78STejun Heo 	}
806e22bee78STejun Heo 
807d302f017STejun Heo 	worker->flags |= flags;
808d302f017STejun Heo }
809d302f017STejun Heo 
810d302f017STejun Heo /**
811e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
812cb444766STejun Heo  * @worker: self
813d302f017STejun Heo  * @flags: flags to clear
814d302f017STejun Heo  *
815e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
816d302f017STejun Heo  *
817cb444766STejun Heo  * CONTEXT:
818cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
819d302f017STejun Heo  */
820d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
821d302f017STejun Heo {
82263d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
823e22bee78STejun Heo 	unsigned int oflags = worker->flags;
824e22bee78STejun Heo 
825cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
826cb444766STejun Heo 
827d302f017STejun Heo 	worker->flags &= ~flags;
828e22bee78STejun Heo 
82942c025f3STejun Heo 	/*
83042c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
83142c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
83242c025f3STejun Heo 	 * of multiple flags, not a single flag.
83342c025f3STejun Heo 	 */
834e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
835e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
83663d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
837d302f017STejun Heo }
838d302f017STejun Heo 
839d302f017STejun Heo /**
8408cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8418cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8428cca0eeaSTejun Heo  * @work: work to find worker for
8438cca0eeaSTejun Heo  *
844a2c1c57bSTejun Heo  * Find a worker which is executing @work on @gcwq by searching
845a2c1c57bSTejun Heo  * @gcwq->busy_hash which is keyed by the address of @work.  For a worker
846a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
847a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
848a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
849a2c1c57bSTejun Heo  * being executed.
850a2c1c57bSTejun Heo  *
851a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
852a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
853a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
854a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
855a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
856a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
857a2c1c57bSTejun Heo  *
858a2c1c57bSTejun Heo  * This function checks the work item address, work function and workqueue
859a2c1c57bSTejun Heo  * to avoid false positives.  Note that this isn't complete as one may
860a2c1c57bSTejun Heo  * construct a work function which can introduce dependency onto itself
861a2c1c57bSTejun Heo  * through a recycled work item.  Well, if somebody wants to shoot oneself
862a2c1c57bSTejun Heo  * in the foot that badly, there's only so much we can do, and if such
863a2c1c57bSTejun Heo  * deadlock actually occurs, it should be easy to locate the culprit work
864a2c1c57bSTejun Heo  * function.
8658cca0eeaSTejun Heo  *
8668cca0eeaSTejun Heo  * CONTEXT:
8678cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8688cca0eeaSTejun Heo  *
8698cca0eeaSTejun Heo  * RETURNS:
8708cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8718cca0eeaSTejun Heo  * otherwise.
8728cca0eeaSTejun Heo  */
8738cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8748cca0eeaSTejun Heo 						 struct work_struct *work)
8758cca0eeaSTejun Heo {
87642f8570fSSasha Levin 	struct worker *worker;
87742f8570fSSasha Levin 	struct hlist_node *tmp;
87842f8570fSSasha Levin 
879a2c1c57bSTejun Heo 	hash_for_each_possible(gcwq->busy_hash, worker, tmp, hentry,
880a2c1c57bSTejun Heo 			       (unsigned long)work)
881a2c1c57bSTejun Heo 		if (worker->current_work == work &&
882a2c1c57bSTejun Heo 		    worker->current_func == work->func)
88342f8570fSSasha Levin 			return worker;
88442f8570fSSasha Levin 
88542f8570fSSasha Levin 	return NULL;
8868cca0eeaSTejun Heo }
8878cca0eeaSTejun Heo 
8888cca0eeaSTejun Heo /**
889bf4ede01STejun Heo  * move_linked_works - move linked works to a list
890bf4ede01STejun Heo  * @work: start of series of works to be scheduled
891bf4ede01STejun Heo  * @head: target list to append @work to
892bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
893bf4ede01STejun Heo  *
894bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
895bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
896bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
897bf4ede01STejun Heo  *
898bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
899bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
900bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
901bf4ede01STejun Heo  *
902bf4ede01STejun Heo  * CONTEXT:
903bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
904bf4ede01STejun Heo  */
905bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
906bf4ede01STejun Heo 			      struct work_struct **nextp)
907bf4ede01STejun Heo {
908bf4ede01STejun Heo 	struct work_struct *n;
909bf4ede01STejun Heo 
910bf4ede01STejun Heo 	/*
911bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
912bf4ede01STejun Heo 	 * use NULL for list head.
913bf4ede01STejun Heo 	 */
914bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
915bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
916bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
917bf4ede01STejun Heo 			break;
918bf4ede01STejun Heo 	}
919bf4ede01STejun Heo 
920bf4ede01STejun Heo 	/*
921bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
922bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
923bf4ede01STejun Heo 	 * needs to be updated.
924bf4ede01STejun Heo 	 */
925bf4ede01STejun Heo 	if (nextp)
926bf4ede01STejun Heo 		*nextp = n;
927bf4ede01STejun Heo }
928bf4ede01STejun Heo 
9293aa62497SLai Jiangshan static void cwq_activate_delayed_work(struct work_struct *work)
930bf4ede01STejun Heo {
9313aa62497SLai Jiangshan 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
932bf4ede01STejun Heo 
933bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
934bf4ede01STejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
935bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
936bf4ede01STejun Heo 	cwq->nr_active++;
937bf4ede01STejun Heo }
938bf4ede01STejun Heo 
9393aa62497SLai Jiangshan static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
9403aa62497SLai Jiangshan {
9413aa62497SLai Jiangshan 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
9423aa62497SLai Jiangshan 						    struct work_struct, entry);
9433aa62497SLai Jiangshan 
9443aa62497SLai Jiangshan 	cwq_activate_delayed_work(work);
9453aa62497SLai Jiangshan }
9463aa62497SLai Jiangshan 
947bf4ede01STejun Heo /**
948bf4ede01STejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
949bf4ede01STejun Heo  * @cwq: cwq of interest
950bf4ede01STejun Heo  * @color: color of work which left the queue
951bf4ede01STejun Heo  *
952bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
953bf4ede01STejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
954bf4ede01STejun Heo  *
955bf4ede01STejun Heo  * CONTEXT:
956bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
957bf4ede01STejun Heo  */
958b3f9f405SLai Jiangshan static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
959bf4ede01STejun Heo {
960bf4ede01STejun Heo 	/* ignore uncolored works */
961bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
962bf4ede01STejun Heo 		return;
963bf4ede01STejun Heo 
964bf4ede01STejun Heo 	cwq->nr_in_flight[color]--;
965bf4ede01STejun Heo 
966bf4ede01STejun Heo 	cwq->nr_active--;
967bf4ede01STejun Heo 	if (!list_empty(&cwq->delayed_works)) {
968bf4ede01STejun Heo 		/* one down, submit a delayed one */
969bf4ede01STejun Heo 		if (cwq->nr_active < cwq->max_active)
970bf4ede01STejun Heo 			cwq_activate_first_delayed(cwq);
971bf4ede01STejun Heo 	}
972bf4ede01STejun Heo 
973bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
974bf4ede01STejun Heo 	if (likely(cwq->flush_color != color))
975bf4ede01STejun Heo 		return;
976bf4ede01STejun Heo 
977bf4ede01STejun Heo 	/* are there still in-flight works? */
978bf4ede01STejun Heo 	if (cwq->nr_in_flight[color])
979bf4ede01STejun Heo 		return;
980bf4ede01STejun Heo 
981bf4ede01STejun Heo 	/* this cwq is done, clear flush_color */
982bf4ede01STejun Heo 	cwq->flush_color = -1;
983bf4ede01STejun Heo 
984bf4ede01STejun Heo 	/*
985bf4ede01STejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
986bf4ede01STejun Heo 	 * will handle the rest.
987bf4ede01STejun Heo 	 */
988bf4ede01STejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
989bf4ede01STejun Heo 		complete(&cwq->wq->first_flusher->done);
990bf4ede01STejun Heo }
991bf4ede01STejun Heo 
99236e227d2STejun Heo /**
993bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
99436e227d2STejun Heo  * @work: work item to steal
99536e227d2STejun Heo  * @is_dwork: @work is a delayed_work
996bbb68dfaSTejun Heo  * @flags: place to store irq state
99736e227d2STejun Heo  *
99836e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
99936e227d2STejun Heo  * stable state - idle, on timer or on worklist.  Return values are
100036e227d2STejun Heo  *
100136e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
100236e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
100336e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1004bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1005bbb68dfaSTejun Heo  *		for arbitrarily long
100636e227d2STejun Heo  *
1007bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1008e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1009e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1010e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1011bbb68dfaSTejun Heo  *
1012bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1013bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1014bbb68dfaSTejun Heo  *
1015e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1016bf4ede01STejun Heo  */
1017bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1018bbb68dfaSTejun Heo 			       unsigned long *flags)
1019bf4ede01STejun Heo {
1020bf4ede01STejun Heo 	struct global_cwq *gcwq;
1021bf4ede01STejun Heo 
1022bbb68dfaSTejun Heo 	local_irq_save(*flags);
1023bbb68dfaSTejun Heo 
102436e227d2STejun Heo 	/* try to steal the timer if it exists */
102536e227d2STejun Heo 	if (is_dwork) {
102636e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
102736e227d2STejun Heo 
1028e0aecdd8STejun Heo 		/*
1029e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1030e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1031e0aecdd8STejun Heo 		 * running on the local CPU.
1032e0aecdd8STejun Heo 		 */
103336e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
103436e227d2STejun Heo 			return 1;
103536e227d2STejun Heo 	}
103636e227d2STejun Heo 
103736e227d2STejun Heo 	/* try to claim PENDING the normal way */
1038bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1039bf4ede01STejun Heo 		return 0;
1040bf4ede01STejun Heo 
1041bf4ede01STejun Heo 	/*
1042bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1043bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1044bf4ede01STejun Heo 	 */
1045bf4ede01STejun Heo 	gcwq = get_work_gcwq(work);
1046bf4ede01STejun Heo 	if (!gcwq)
1047bbb68dfaSTejun Heo 		goto fail;
1048bf4ede01STejun Heo 
1049bbb68dfaSTejun Heo 	spin_lock(&gcwq->lock);
1050bf4ede01STejun Heo 	if (!list_empty(&work->entry)) {
1051bf4ede01STejun Heo 		/*
1052bf4ede01STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
1053bf4ede01STejun Heo 		 * In that case we must see the new value after rmb(), see
1054bf4ede01STejun Heo 		 * insert_work()->wmb().
1055bf4ede01STejun Heo 		 */
1056bf4ede01STejun Heo 		smp_rmb();
1057bf4ede01STejun Heo 		if (gcwq == get_work_gcwq(work)) {
1058bf4ede01STejun Heo 			debug_work_deactivate(work);
10593aa62497SLai Jiangshan 
10603aa62497SLai Jiangshan 			/*
10613aa62497SLai Jiangshan 			 * A delayed work item cannot be grabbed directly
10623aa62497SLai Jiangshan 			 * because it might have linked NO_COLOR work items
10633aa62497SLai Jiangshan 			 * which, if left on the delayed_list, will confuse
10643aa62497SLai Jiangshan 			 * cwq->nr_active management later on and cause
10653aa62497SLai Jiangshan 			 * stall.  Make sure the work item is activated
10663aa62497SLai Jiangshan 			 * before grabbing.
10673aa62497SLai Jiangshan 			 */
10683aa62497SLai Jiangshan 			if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
10693aa62497SLai Jiangshan 				cwq_activate_delayed_work(work);
10703aa62497SLai Jiangshan 
1071bf4ede01STejun Heo 			list_del_init(&work->entry);
1072bf4ede01STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
1073b3f9f405SLai Jiangshan 				get_work_color(work));
107436e227d2STejun Heo 
1075bbb68dfaSTejun Heo 			spin_unlock(&gcwq->lock);
107636e227d2STejun Heo 			return 1;
1077bf4ede01STejun Heo 		}
1078bf4ede01STejun Heo 	}
1079bbb68dfaSTejun Heo 	spin_unlock(&gcwq->lock);
1080bbb68dfaSTejun Heo fail:
1081bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1082bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1083bbb68dfaSTejun Heo 		return -ENOENT;
1084bbb68dfaSTejun Heo 	cpu_relax();
108536e227d2STejun Heo 	return -EAGAIN;
1086bf4ede01STejun Heo }
1087bf4ede01STejun Heo 
1088bf4ede01STejun Heo /**
10897e11629dSTejun Heo  * insert_work - insert a work into gcwq
10904690c4abSTejun Heo  * @cwq: cwq @work belongs to
10914690c4abSTejun Heo  * @work: work to insert
10924690c4abSTejun Heo  * @head: insertion point
10934690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
10944690c4abSTejun Heo  *
10957e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
10967e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
10974690c4abSTejun Heo  *
10984690c4abSTejun Heo  * CONTEXT:
10998b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
11001da177e4SLinus Torvalds  */
1101b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
11024690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
11034690c4abSTejun Heo 			unsigned int extra_flags)
1104b89deed3SOleg Nesterov {
110563d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
1106e1d8aa9fSFrederic Weisbecker 
11074690c4abSTejun Heo 	/* we own @work, set data and link */
11087a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
11094690c4abSTejun Heo 
11106e84d644SOleg Nesterov 	/*
11116e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
11126e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
11136e84d644SOleg Nesterov 	 */
11146e84d644SOleg Nesterov 	smp_wmb();
11154690c4abSTejun Heo 
11161a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
1117e22bee78STejun Heo 
1118e22bee78STejun Heo 	/*
1119e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
1120e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
1121e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
1122e22bee78STejun Heo 	 */
1123e22bee78STejun Heo 	smp_mb();
1124e22bee78STejun Heo 
112563d95a91STejun Heo 	if (__need_more_worker(pool))
112663d95a91STejun Heo 		wake_up_worker(pool);
1127b89deed3SOleg Nesterov }
1128b89deed3SOleg Nesterov 
1129c8efcc25STejun Heo /*
1130c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
1131c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
1132c8efcc25STejun Heo  * cold paths.
1133c8efcc25STejun Heo  */
1134c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1135c8efcc25STejun Heo {
1136c8efcc25STejun Heo 	unsigned long flags;
1137c8efcc25STejun Heo 	unsigned int cpu;
1138c8efcc25STejun Heo 
1139c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
1140c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
1141c8efcc25STejun Heo 		struct worker *worker;
1142c8efcc25STejun Heo 		struct hlist_node *pos;
1143c8efcc25STejun Heo 		int i;
1144c8efcc25STejun Heo 
1145c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1146c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
1147c8efcc25STejun Heo 			if (worker->task != current)
1148c8efcc25STejun Heo 				continue;
1149c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
1150c8efcc25STejun Heo 			/*
1151c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
1152c8efcc25STejun Heo 			 * is headed to the same workqueue.
1153c8efcc25STejun Heo 			 */
1154c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
1155c8efcc25STejun Heo 		}
1156c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
1157c8efcc25STejun Heo 	}
1158c8efcc25STejun Heo 	return false;
1159c8efcc25STejun Heo }
1160c8efcc25STejun Heo 
11614690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
11621da177e4SLinus Torvalds 			 struct work_struct *work)
11631da177e4SLinus Torvalds {
1164502ca9d8STejun Heo 	struct global_cwq *gcwq;
1165502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
11661e19ffc6STejun Heo 	struct list_head *worklist;
11678a2e8e5dSTejun Heo 	unsigned int work_flags;
1168b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
11698930cabaSTejun Heo 
11708930cabaSTejun Heo 	/*
11718930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
11728930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
11738930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
11748930cabaSTejun Heo 	 * happen with IRQ disabled.
11758930cabaSTejun Heo 	 */
11768930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
11771da177e4SLinus Torvalds 
1178dc186ad7SThomas Gleixner 	debug_work_activate(work);
11791e19ffc6STejun Heo 
1180c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
11819c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1182c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1183e41e704bSTejun Heo 		return;
1184e41e704bSTejun Heo 
1185c7fc77f7STejun Heo 	/* determine gcwq to use */
1186c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1187c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1188c7fc77f7STejun Heo 
118957469821STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
1190f3421797STejun Heo 			cpu = raw_smp_processor_id();
1191f3421797STejun Heo 
119218aa9effSTejun Heo 		/*
1193dbf2576eSTejun Heo 		 * It's multi cpu.  If @work was previously on a different
1194dbf2576eSTejun Heo 		 * cpu, it might still be running there, in which case the
1195dbf2576eSTejun Heo 		 * work needs to be queued on that cpu to guarantee
1196dbf2576eSTejun Heo 		 * non-reentrancy.
119718aa9effSTejun Heo 		 */
1198502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
1199dbf2576eSTejun Heo 		last_gcwq = get_work_gcwq(work);
1200dbf2576eSTejun Heo 
1201dbf2576eSTejun Heo 		if (last_gcwq && last_gcwq != gcwq) {
120218aa9effSTejun Heo 			struct worker *worker;
120318aa9effSTejun Heo 
12048930cabaSTejun Heo 			spin_lock(&last_gcwq->lock);
120518aa9effSTejun Heo 
120618aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
120718aa9effSTejun Heo 
120818aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
120918aa9effSTejun Heo 				gcwq = last_gcwq;
121018aa9effSTejun Heo 			else {
121118aa9effSTejun Heo 				/* meh... not running there, queue here */
12128930cabaSTejun Heo 				spin_unlock(&last_gcwq->lock);
12138930cabaSTejun Heo 				spin_lock(&gcwq->lock);
121418aa9effSTejun Heo 			}
12158930cabaSTejun Heo 		} else {
12168930cabaSTejun Heo 			spin_lock(&gcwq->lock);
12178930cabaSTejun Heo 		}
1218f3421797STejun Heo 	} else {
1219f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
12208930cabaSTejun Heo 		spin_lock(&gcwq->lock);
1221502ca9d8STejun Heo 	}
1222502ca9d8STejun Heo 
1223502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1224502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1225b75cac93SJoonsoo Kim 	trace_workqueue_queue_work(req_cpu, cwq, work);
1226502ca9d8STejun Heo 
1227f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
12288930cabaSTejun Heo 		spin_unlock(&gcwq->lock);
1229f5b2552bSDan Carpenter 		return;
1230f5b2552bSDan Carpenter 	}
12311e19ffc6STejun Heo 
123273f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
12338a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
12341e19ffc6STejun Heo 
12351e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1236cdadf009STejun Heo 		trace_workqueue_activate_work(work);
12371e19ffc6STejun Heo 		cwq->nr_active++;
12383270476aSTejun Heo 		worklist = &cwq->pool->worklist;
12398a2e8e5dSTejun Heo 	} else {
12408a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
12411e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
12428a2e8e5dSTejun Heo 	}
12431e19ffc6STejun Heo 
12448a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
12451e19ffc6STejun Heo 
12468930cabaSTejun Heo 	spin_unlock(&gcwq->lock);
12471da177e4SLinus Torvalds }
12481da177e4SLinus Torvalds 
12490fcb78c2SRolf Eike Beer /**
1250c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1251c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1252c1a220e7SZhang Rui  * @wq: workqueue to use
1253c1a220e7SZhang Rui  * @work: work to queue
1254c1a220e7SZhang Rui  *
1255d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
1256c1a220e7SZhang Rui  *
1257c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1258c1a220e7SZhang Rui  * can't go away.
1259c1a220e7SZhang Rui  */
1260d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1261d4283e93STejun Heo 		   struct work_struct *work)
1262c1a220e7SZhang Rui {
1263d4283e93STejun Heo 	bool ret = false;
12648930cabaSTejun Heo 	unsigned long flags;
12658930cabaSTejun Heo 
12668930cabaSTejun Heo 	local_irq_save(flags);
1267c1a220e7SZhang Rui 
126822df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
12694690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1270d4283e93STejun Heo 		ret = true;
1271c1a220e7SZhang Rui 	}
12728930cabaSTejun Heo 
12738930cabaSTejun Heo 	local_irq_restore(flags);
1274c1a220e7SZhang Rui 	return ret;
1275c1a220e7SZhang Rui }
1276c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1277c1a220e7SZhang Rui 
12780a13c00eSTejun Heo /**
12790a13c00eSTejun Heo  * queue_work - queue work on a workqueue
12800a13c00eSTejun Heo  * @wq: workqueue to use
12810a13c00eSTejun Heo  * @work: work to queue
12820a13c00eSTejun Heo  *
1283d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
12840a13c00eSTejun Heo  *
12850a13c00eSTejun Heo  * We queue the work to the CPU on which it was submitted, but if the CPU dies
12860a13c00eSTejun Heo  * it can be processed by another CPU.
12870a13c00eSTejun Heo  */
1288d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
12890a13c00eSTejun Heo {
129057469821STejun Heo 	return queue_work_on(WORK_CPU_UNBOUND, wq, work);
12910a13c00eSTejun Heo }
12920a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work);
12930a13c00eSTejun Heo 
1294d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
12951da177e4SLinus Torvalds {
129652bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
12977a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
12981da177e4SLinus Torvalds 
1299e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
13001265057fSTejun Heo 	__queue_work(dwork->cpu, cwq->wq, &dwork->work);
13011da177e4SLinus Torvalds }
1302d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
13031da177e4SLinus Torvalds 
13047beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
130552bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
13061da177e4SLinus Torvalds {
13077beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
13087beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
13097beb2edfSTejun Heo 	unsigned int lcpu;
13101da177e4SLinus Torvalds 
13117beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
13127beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
1313fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1314fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
13157beb2edfSTejun Heo 
13168852aac2STejun Heo 	/*
13178852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
13188852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
13198852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
13208852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
13218852aac2STejun Heo 	 */
13228852aac2STejun Heo 	if (!delay) {
13238852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
13248852aac2STejun Heo 		return;
13258852aac2STejun Heo 	}
13268852aac2STejun Heo 
13277beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
13287beb2edfSTejun Heo 
13297beb2edfSTejun Heo 	/*
13307beb2edfSTejun Heo 	 * This stores cwq for the moment, for the timer_fn.  Note that the
13317beb2edfSTejun Heo 	 * work's gcwq is preserved to allow reentrance detection for
13327beb2edfSTejun Heo 	 * delayed works.
13337beb2edfSTejun Heo 	 */
13347beb2edfSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
13357beb2edfSTejun Heo 		struct global_cwq *gcwq = get_work_gcwq(work);
13367beb2edfSTejun Heo 
1337e42986deSJoonsoo Kim 		/*
1338e42986deSJoonsoo Kim 		 * If we cannot get the last gcwq from @work directly,
1339e42986deSJoonsoo Kim 		 * select the last CPU such that it avoids unnecessarily
1340e42986deSJoonsoo Kim 		 * triggering non-reentrancy check in __queue_work().
1341e42986deSJoonsoo Kim 		 */
1342e42986deSJoonsoo Kim 		lcpu = cpu;
1343e42986deSJoonsoo Kim 		if (gcwq)
13447beb2edfSTejun Heo 			lcpu = gcwq->cpu;
1345e42986deSJoonsoo Kim 		if (lcpu == WORK_CPU_UNBOUND)
13467beb2edfSTejun Heo 			lcpu = raw_smp_processor_id();
13477beb2edfSTejun Heo 	} else {
13487beb2edfSTejun Heo 		lcpu = WORK_CPU_UNBOUND;
13491da177e4SLinus Torvalds 	}
13507beb2edfSTejun Heo 
13517beb2edfSTejun Heo 	set_work_cwq(work, get_cwq(lcpu, wq), 0);
13527beb2edfSTejun Heo 
13531265057fSTejun Heo 	dwork->cpu = cpu;
13547beb2edfSTejun Heo 	timer->expires = jiffies + delay;
13557beb2edfSTejun Heo 
13567beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
13577beb2edfSTejun Heo 		add_timer_on(timer, cpu);
13587beb2edfSTejun Heo 	else
13597beb2edfSTejun Heo 		add_timer(timer);
13607beb2edfSTejun Heo }
13611da177e4SLinus Torvalds 
13620fcb78c2SRolf Eike Beer /**
13630fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
13640fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
13650fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1366af9997e4SRandy Dunlap  * @dwork: work to queue
13670fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
13680fcb78c2SRolf Eike Beer  *
1369715f1300STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.  If
1370715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1371715f1300STejun Heo  * execution.
13720fcb78c2SRolf Eike Beer  */
1373d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
137452bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
13757a6bc1cdSVenkatesh Pallipadi {
137652bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1377d4283e93STejun Heo 	bool ret = false;
13788930cabaSTejun Heo 	unsigned long flags;
13798930cabaSTejun Heo 
13808930cabaSTejun Heo 	/* read the comment in __queue_work() */
13818930cabaSTejun Heo 	local_irq_save(flags);
13827a6bc1cdSVenkatesh Pallipadi 
138322df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
13847beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1385d4283e93STejun Heo 		ret = true;
13867a6bc1cdSVenkatesh Pallipadi 	}
13878930cabaSTejun Heo 
13888930cabaSTejun Heo 	local_irq_restore(flags);
13897a6bc1cdSVenkatesh Pallipadi 	return ret;
13907a6bc1cdSVenkatesh Pallipadi }
1391ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
13921da177e4SLinus Torvalds 
1393c8e55f36STejun Heo /**
13940a13c00eSTejun Heo  * queue_delayed_work - queue work on a workqueue after delay
13950a13c00eSTejun Heo  * @wq: workqueue to use
13960a13c00eSTejun Heo  * @dwork: delayable work to queue
13970a13c00eSTejun Heo  * @delay: number of jiffies to wait before queueing
13980a13c00eSTejun Heo  *
1399715f1300STejun Heo  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
14000a13c00eSTejun Heo  */
1401d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq,
14020a13c00eSTejun Heo 			struct delayed_work *dwork, unsigned long delay)
14030a13c00eSTejun Heo {
140457469821STejun Heo 	return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14050a13c00eSTejun Heo }
14060a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work);
14070a13c00eSTejun Heo 
14080a13c00eSTejun Heo /**
14098376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
14108376fe22STejun Heo  * @cpu: CPU number to execute work on
14118376fe22STejun Heo  * @wq: workqueue to use
14128376fe22STejun Heo  * @dwork: work to queue
14138376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14148376fe22STejun Heo  *
14158376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
14168376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
14178376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
14188376fe22STejun Heo  * current state.
14198376fe22STejun Heo  *
14208376fe22STejun Heo  * Returns %false if @dwork was idle and queued, %true if @dwork was
14218376fe22STejun Heo  * pending and its timer was modified.
14228376fe22STejun Heo  *
1423e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
14248376fe22STejun Heo  * See try_to_grab_pending() for details.
14258376fe22STejun Heo  */
14268376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
14278376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
14288376fe22STejun Heo {
14298376fe22STejun Heo 	unsigned long flags;
14308376fe22STejun Heo 	int ret;
14318376fe22STejun Heo 
14328376fe22STejun Heo 	do {
14338376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
14348376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
14358376fe22STejun Heo 
14368376fe22STejun Heo 	if (likely(ret >= 0)) {
14378376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
14388376fe22STejun Heo 		local_irq_restore(flags);
14398376fe22STejun Heo 	}
14408376fe22STejun Heo 
14418376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
14428376fe22STejun Heo 	return ret;
14438376fe22STejun Heo }
14448376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
14458376fe22STejun Heo 
14468376fe22STejun Heo /**
14478376fe22STejun Heo  * mod_delayed_work - modify delay of or queue a delayed work
14488376fe22STejun Heo  * @wq: workqueue to use
14498376fe22STejun Heo  * @dwork: work to queue
14508376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14518376fe22STejun Heo  *
14528376fe22STejun Heo  * mod_delayed_work_on() on local CPU.
14538376fe22STejun Heo  */
14548376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
14558376fe22STejun Heo 		      unsigned long delay)
14568376fe22STejun Heo {
14578376fe22STejun Heo 	return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14588376fe22STejun Heo }
14598376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work);
14608376fe22STejun Heo 
14618376fe22STejun Heo /**
1462c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1463c8e55f36STejun Heo  * @worker: worker which is entering idle state
1464c8e55f36STejun Heo  *
1465c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1466c8e55f36STejun Heo  * necessary.
1467c8e55f36STejun Heo  *
1468c8e55f36STejun Heo  * LOCKING:
1469c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1470c8e55f36STejun Heo  */
1471c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
14721da177e4SLinus Torvalds {
1473bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1474c8e55f36STejun Heo 
1475c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1476c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1477c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1478c8e55f36STejun Heo 
1479cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1480cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1481bd7bdd43STejun Heo 	pool->nr_idle++;
1482e22bee78STejun Heo 	worker->last_active = jiffies;
1483c8e55f36STejun Heo 
1484c8e55f36STejun Heo 	/* idle_list is LIFO */
1485bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1486db7bccf4STejun Heo 
148763d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1488628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1489cb444766STejun Heo 
1490544ecf31STejun Heo 	/*
1491628c78e7STejun Heo 	 * Sanity check nr_running.  Because gcwq_unbind_fn() releases
1492628c78e7STejun Heo 	 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1493628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1494628c78e7STejun Heo 	 * unbind is not in progress.
1495544ecf31STejun Heo 	 */
149624647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1497bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
149863d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1499c8e55f36STejun Heo }
1500c8e55f36STejun Heo 
1501c8e55f36STejun Heo /**
1502c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1503c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1504c8e55f36STejun Heo  *
1505c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1506c8e55f36STejun Heo  *
1507c8e55f36STejun Heo  * LOCKING:
1508c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1509c8e55f36STejun Heo  */
1510c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1511c8e55f36STejun Heo {
1512bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1513c8e55f36STejun Heo 
1514c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1515d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1516bd7bdd43STejun Heo 	pool->nr_idle--;
1517c8e55f36STejun Heo 	list_del_init(&worker->entry);
1518c8e55f36STejun Heo }
1519c8e55f36STejun Heo 
1520e22bee78STejun Heo /**
1521e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1522e22bee78STejun Heo  * @worker: self
1523e22bee78STejun Heo  *
1524e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1525e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1526e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1527e22bee78STejun Heo  * guaranteed to execute on the cpu.
1528e22bee78STejun Heo  *
1529e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1530e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1531e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1532e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1533e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1534e22bee78STejun Heo  * [dis]associated in the meantime.
1535e22bee78STejun Heo  *
1536f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
153724647570STejun Heo  * binding against %POOL_DISASSOCIATED which is set during
1538f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1539f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1540f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1541e22bee78STejun Heo  *
1542e22bee78STejun Heo  * CONTEXT:
1543e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1544e22bee78STejun Heo  * held.
1545e22bee78STejun Heo  *
1546e22bee78STejun Heo  * RETURNS:
1547e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1548e22bee78STejun Heo  * bound), %false if offline.
1549e22bee78STejun Heo  */
1550e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1551972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1552e22bee78STejun Heo {
155324647570STejun Heo 	struct worker_pool *pool = worker->pool;
155424647570STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1555e22bee78STejun Heo 	struct task_struct *task = worker->task;
1556e22bee78STejun Heo 
1557e22bee78STejun Heo 	while (true) {
1558e22bee78STejun Heo 		/*
1559e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1560e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1561e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
156224647570STejun Heo 		 * against POOL_DISASSOCIATED.
1563e22bee78STejun Heo 		 */
156424647570STejun Heo 		if (!(pool->flags & POOL_DISASSOCIATED))
1565e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1566e22bee78STejun Heo 
1567e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
156824647570STejun Heo 		if (pool->flags & POOL_DISASSOCIATED)
1569e22bee78STejun Heo 			return false;
1570e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1571e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1572e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1573e22bee78STejun Heo 			return true;
1574e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1575e22bee78STejun Heo 
15765035b20fSTejun Heo 		/*
15775035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
15785035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
15795035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
15805035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
15815035b20fSTejun Heo 		 */
1582e22bee78STejun Heo 		cpu_relax();
15835035b20fSTejun Heo 		cond_resched();
1584e22bee78STejun Heo 	}
1585e22bee78STejun Heo }
1586e22bee78STejun Heo 
1587e22bee78STejun Heo /*
1588ea1abd61SLai Jiangshan  * Rebind an idle @worker to its CPU.  worker_thread() will test
15895f7dabfdSLai Jiangshan  * list_empty(@worker->entry) before leaving idle and call this function.
159025511a47STejun Heo  */
159125511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
159225511a47STejun Heo {
159325511a47STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
159425511a47STejun Heo 
15955f7dabfdSLai Jiangshan 	/* CPU may go down again inbetween, clear UNBOUND only on success */
15965f7dabfdSLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
15975f7dabfdSLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
159825511a47STejun Heo 
1599ea1abd61SLai Jiangshan 	/* rebind complete, become available again */
1600ea1abd61SLai Jiangshan 	list_add(&worker->entry, &worker->pool->idle_list);
1601ea1abd61SLai Jiangshan 	spin_unlock_irq(&gcwq->lock);
160225511a47STejun Heo }
160325511a47STejun Heo 
160425511a47STejun Heo /*
160525511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1606403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1607403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1608403c821dSTejun Heo  * executed twice without intervening cpu down.
1609e22bee78STejun Heo  */
161025511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1611e22bee78STejun Heo {
1612e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1613bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1614e22bee78STejun Heo 
1615eab6d828SLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
1616eab6d828SLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
1617e22bee78STejun Heo 
1618e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1619e22bee78STejun Heo }
1620e22bee78STejun Heo 
162125511a47STejun Heo /**
162225511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
162325511a47STejun Heo  * @gcwq: gcwq of interest
162425511a47STejun Heo  *
162525511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
162625511a47STejun Heo  * is different for idle and busy ones.
162725511a47STejun Heo  *
1628ea1abd61SLai Jiangshan  * Idle ones will be removed from the idle_list and woken up.  They will
1629ea1abd61SLai Jiangshan  * add themselves back after completing rebind.  This ensures that the
1630ea1abd61SLai Jiangshan  * idle_list doesn't contain any unbound workers when re-bound busy workers
1631ea1abd61SLai Jiangshan  * try to perform local wake-ups for concurrency management.
163225511a47STejun Heo  *
1633ea1abd61SLai Jiangshan  * Busy workers can rebind after they finish their current work items.
1634ea1abd61SLai Jiangshan  * Queueing the rebind work item at the head of the scheduled list is
1635ea1abd61SLai Jiangshan  * enough.  Note that nr_running will be properly bumped as busy workers
1636ea1abd61SLai Jiangshan  * rebind.
163725511a47STejun Heo  *
1638ea1abd61SLai Jiangshan  * On return, all non-manager workers are scheduled for rebind - see
1639ea1abd61SLai Jiangshan  * manage_workers() for the manager special case.  Any idle worker
1640ea1abd61SLai Jiangshan  * including the manager will not appear on @idle_list until rebind is
1641ea1abd61SLai Jiangshan  * complete, making local wake-ups safe.
164225511a47STejun Heo  */
164325511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
164425511a47STejun Heo {
164525511a47STejun Heo 	struct worker_pool *pool;
1646ea1abd61SLai Jiangshan 	struct worker *worker, *n;
164725511a47STejun Heo 	struct hlist_node *pos;
164825511a47STejun Heo 	int i;
164925511a47STejun Heo 
165025511a47STejun Heo 	lockdep_assert_held(&gcwq->lock);
165125511a47STejun Heo 
165225511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
1653b2eb83d1SLai Jiangshan 		lockdep_assert_held(&pool->assoc_mutex);
165425511a47STejun Heo 
16555f7dabfdSLai Jiangshan 	/* dequeue and kick idle ones */
165625511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
1657ea1abd61SLai Jiangshan 		list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1658ea1abd61SLai Jiangshan 			/*
1659ea1abd61SLai Jiangshan 			 * idle workers should be off @pool->idle_list
1660ea1abd61SLai Jiangshan 			 * until rebind is complete to avoid receiving
1661ea1abd61SLai Jiangshan 			 * premature local wake-ups.
1662ea1abd61SLai Jiangshan 			 */
1663ea1abd61SLai Jiangshan 			list_del_init(&worker->entry);
166425511a47STejun Heo 
166525511a47STejun Heo 			/*
16665f7dabfdSLai Jiangshan 			 * worker_thread() will see the above dequeuing
16675f7dabfdSLai Jiangshan 			 * and call idle_worker_rebind().
166825511a47STejun Heo 			 */
166925511a47STejun Heo 			wake_up_process(worker->task);
167025511a47STejun Heo 		}
167125511a47STejun Heo 	}
167225511a47STejun Heo 
1673ea1abd61SLai Jiangshan 	/* rebind busy workers */
167425511a47STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
167525511a47STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
1676e2b6a6d5SJoonsoo Kim 		struct workqueue_struct *wq;
167725511a47STejun Heo 
167825511a47STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
167925511a47STejun Heo 				     work_data_bits(rebind_work)))
168025511a47STejun Heo 			continue;
168125511a47STejun Heo 
168225511a47STejun Heo 		debug_work_activate(rebind_work);
168390beca5dSTejun Heo 
168490beca5dSTejun Heo 		/*
1685e2b6a6d5SJoonsoo Kim 		 * wq doesn't really matter but let's keep @worker->pool
1686e2b6a6d5SJoonsoo Kim 		 * and @cwq->pool consistent for sanity.
168790beca5dSTejun Heo 		 */
1688e34cdddbSTejun Heo 		if (std_worker_pool_pri(worker->pool))
1689e2b6a6d5SJoonsoo Kim 			wq = system_highpri_wq;
1690e2b6a6d5SJoonsoo Kim 		else
1691e2b6a6d5SJoonsoo Kim 			wq = system_wq;
1692ec58815aSTejun Heo 
1693e2b6a6d5SJoonsoo Kim 		insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
169425511a47STejun Heo 			worker->scheduled.next,
169525511a47STejun Heo 			work_color_to_flags(WORK_NO_COLOR));
1696ec58815aSTejun Heo 	}
169725511a47STejun Heo }
169825511a47STejun Heo 
1699c34056a3STejun Heo static struct worker *alloc_worker(void)
1700c34056a3STejun Heo {
1701c34056a3STejun Heo 	struct worker *worker;
1702c34056a3STejun Heo 
1703c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1704c8e55f36STejun Heo 	if (worker) {
1705c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1706affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
170725511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1708e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1709e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1710c8e55f36STejun Heo 	}
1711c34056a3STejun Heo 	return worker;
1712c34056a3STejun Heo }
1713c34056a3STejun Heo 
1714c34056a3STejun Heo /**
1715c34056a3STejun Heo  * create_worker - create a new workqueue worker
171663d95a91STejun Heo  * @pool: pool the new worker will belong to
1717c34056a3STejun Heo  *
171863d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1719c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1720c34056a3STejun Heo  * destroy_worker().
1721c34056a3STejun Heo  *
1722c34056a3STejun Heo  * CONTEXT:
1723c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1724c34056a3STejun Heo  *
1725c34056a3STejun Heo  * RETURNS:
1726c34056a3STejun Heo  * Pointer to the newly created worker.
1727c34056a3STejun Heo  */
1728bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1729c34056a3STejun Heo {
173063d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1731e34cdddbSTejun Heo 	const char *pri = std_worker_pool_pri(pool) ? "H" : "";
1732c34056a3STejun Heo 	struct worker *worker = NULL;
1733f3421797STejun Heo 	int id = -1;
1734c34056a3STejun Heo 
17358b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1736bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
17378b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1738bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1739c34056a3STejun Heo 			goto fail;
17408b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1741c34056a3STejun Heo 	}
17428b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1743c34056a3STejun Heo 
1744c34056a3STejun Heo 	worker = alloc_worker();
1745c34056a3STejun Heo 	if (!worker)
1746c34056a3STejun Heo 		goto fail;
1747c34056a3STejun Heo 
1748bd7bdd43STejun Heo 	worker->pool = pool;
1749c34056a3STejun Heo 	worker->id = id;
1750c34056a3STejun Heo 
1751bc2ae0f5STejun Heo 	if (gcwq->cpu != WORK_CPU_UNBOUND)
175294dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
17533270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
17543270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1755f3421797STejun Heo 	else
1756f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
17573270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1758c34056a3STejun Heo 	if (IS_ERR(worker->task))
1759c34056a3STejun Heo 		goto fail;
1760c34056a3STejun Heo 
1761e34cdddbSTejun Heo 	if (std_worker_pool_pri(pool))
17623270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
17633270476aSTejun Heo 
1764db7bccf4STejun Heo 	/*
1765bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
176624647570STejun Heo 	 * %POOL_DISASSOCIATED.  The caller is responsible for ensuring the
1767bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1768bc2ae0f5STejun Heo 	 * above the flag definition for details.
1769bc2ae0f5STejun Heo 	 *
1770bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1771bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1772db7bccf4STejun Heo 	 */
177324647570STejun Heo 	if (!(pool->flags & POOL_DISASSOCIATED)) {
17748b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1775bc2ae0f5STejun Heo 	} else {
1776db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1777f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1778f3421797STejun Heo 	}
1779c34056a3STejun Heo 
1780c34056a3STejun Heo 	return worker;
1781c34056a3STejun Heo fail:
1782c34056a3STejun Heo 	if (id >= 0) {
17838b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1784bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
17858b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1786c34056a3STejun Heo 	}
1787c34056a3STejun Heo 	kfree(worker);
1788c34056a3STejun Heo 	return NULL;
1789c34056a3STejun Heo }
1790c34056a3STejun Heo 
1791c34056a3STejun Heo /**
1792c34056a3STejun Heo  * start_worker - start a newly created worker
1793c34056a3STejun Heo  * @worker: worker to start
1794c34056a3STejun Heo  *
1795c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1796c34056a3STejun Heo  *
1797c34056a3STejun Heo  * CONTEXT:
17988b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1799c34056a3STejun Heo  */
1800c34056a3STejun Heo static void start_worker(struct worker *worker)
1801c34056a3STejun Heo {
1802cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1803bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1804c8e55f36STejun Heo 	worker_enter_idle(worker);
1805c34056a3STejun Heo 	wake_up_process(worker->task);
1806c34056a3STejun Heo }
1807c34056a3STejun Heo 
1808c34056a3STejun Heo /**
1809c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1810c34056a3STejun Heo  * @worker: worker to be destroyed
1811c34056a3STejun Heo  *
1812c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1813c8e55f36STejun Heo  *
1814c8e55f36STejun Heo  * CONTEXT:
1815c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1816c34056a3STejun Heo  */
1817c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1818c34056a3STejun Heo {
1819bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1820bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1821c34056a3STejun Heo 	int id = worker->id;
1822c34056a3STejun Heo 
1823c34056a3STejun Heo 	/* sanity check frenzy */
1824c34056a3STejun Heo 	BUG_ON(worker->current_work);
1825affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1826c34056a3STejun Heo 
1827c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1828bd7bdd43STejun Heo 		pool->nr_workers--;
1829c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1830bd7bdd43STejun Heo 		pool->nr_idle--;
1831c8e55f36STejun Heo 
1832c8e55f36STejun Heo 	list_del_init(&worker->entry);
1833cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1834c8e55f36STejun Heo 
1835c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1836c8e55f36STejun Heo 
1837c34056a3STejun Heo 	kthread_stop(worker->task);
1838c34056a3STejun Heo 	kfree(worker);
1839c34056a3STejun Heo 
18408b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1841bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1842c34056a3STejun Heo }
1843c34056a3STejun Heo 
184463d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1845e22bee78STejun Heo {
184663d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
184763d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1848e22bee78STejun Heo 
1849e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1850e22bee78STejun Heo 
185163d95a91STejun Heo 	if (too_many_workers(pool)) {
1852e22bee78STejun Heo 		struct worker *worker;
1853e22bee78STejun Heo 		unsigned long expires;
1854e22bee78STejun Heo 
1855e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
185663d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1857e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1858e22bee78STejun Heo 
1859e22bee78STejun Heo 		if (time_before(jiffies, expires))
186063d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1861e22bee78STejun Heo 		else {
1862e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
186311ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
186463d95a91STejun Heo 			wake_up_worker(pool);
1865e22bee78STejun Heo 		}
1866e22bee78STejun Heo 	}
1867e22bee78STejun Heo 
1868e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1869e22bee78STejun Heo }
1870e22bee78STejun Heo 
1871e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1872e22bee78STejun Heo {
1873e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1874e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1875f3421797STejun Heo 	unsigned int cpu;
1876e22bee78STejun Heo 
1877e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1878e22bee78STejun Heo 		return false;
1879e22bee78STejun Heo 
1880e22bee78STejun Heo 	/* mayday mayday mayday */
1881bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1882f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1883f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1884f3421797STejun Heo 		cpu = 0;
1885f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1886e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1887e22bee78STejun Heo 	return true;
1888e22bee78STejun Heo }
1889e22bee78STejun Heo 
189063d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1891e22bee78STejun Heo {
189263d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
189363d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1894e22bee78STejun Heo 	struct work_struct *work;
1895e22bee78STejun Heo 
1896e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1897e22bee78STejun Heo 
189863d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1899e22bee78STejun Heo 		/*
1900e22bee78STejun Heo 		 * We've been trying to create a new worker but
1901e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1902e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1903e22bee78STejun Heo 		 * rescuers.
1904e22bee78STejun Heo 		 */
190563d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1906e22bee78STejun Heo 			send_mayday(work);
1907e22bee78STejun Heo 	}
1908e22bee78STejun Heo 
1909e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1910e22bee78STejun Heo 
191163d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1912e22bee78STejun Heo }
1913e22bee78STejun Heo 
1914e22bee78STejun Heo /**
1915e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
191663d95a91STejun Heo  * @pool: pool to create a new worker for
1917e22bee78STejun Heo  *
191863d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1919e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1920e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
192163d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1922e22bee78STejun Heo  * possible allocation deadlock.
1923e22bee78STejun Heo  *
1924e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1925e22bee78STejun Heo  * may_start_working() true.
1926e22bee78STejun Heo  *
1927e22bee78STejun Heo  * LOCKING:
1928e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1929e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1930e22bee78STejun Heo  * manager.
1931e22bee78STejun Heo  *
1932e22bee78STejun Heo  * RETURNS:
1933e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1934e22bee78STejun Heo  * otherwise.
1935e22bee78STejun Heo  */
193663d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
193706bd6ebfSNamhyung Kim __releases(&gcwq->lock)
193806bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1939e22bee78STejun Heo {
194063d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
194163d95a91STejun Heo 
194263d95a91STejun Heo 	if (!need_to_create_worker(pool))
1943e22bee78STejun Heo 		return false;
1944e22bee78STejun Heo restart:
19459f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
19469f9c2364STejun Heo 
1947e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
194863d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1949e22bee78STejun Heo 
1950e22bee78STejun Heo 	while (true) {
1951e22bee78STejun Heo 		struct worker *worker;
1952e22bee78STejun Heo 
1953bc2ae0f5STejun Heo 		worker = create_worker(pool);
1954e22bee78STejun Heo 		if (worker) {
195563d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1956e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1957e22bee78STejun Heo 			start_worker(worker);
195863d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1959e22bee78STejun Heo 			return true;
1960e22bee78STejun Heo 		}
1961e22bee78STejun Heo 
196263d95a91STejun Heo 		if (!need_to_create_worker(pool))
1963e22bee78STejun Heo 			break;
1964e22bee78STejun Heo 
1965e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1966e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
19679f9c2364STejun Heo 
196863d95a91STejun Heo 		if (!need_to_create_worker(pool))
1969e22bee78STejun Heo 			break;
1970e22bee78STejun Heo 	}
1971e22bee78STejun Heo 
197263d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1973e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
197463d95a91STejun Heo 	if (need_to_create_worker(pool))
1975e22bee78STejun Heo 		goto restart;
1976e22bee78STejun Heo 	return true;
1977e22bee78STejun Heo }
1978e22bee78STejun Heo 
1979e22bee78STejun Heo /**
1980e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
198163d95a91STejun Heo  * @pool: pool to destroy workers for
1982e22bee78STejun Heo  *
198363d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
1984e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1985e22bee78STejun Heo  *
1986e22bee78STejun Heo  * LOCKING:
1987e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1988e22bee78STejun Heo  * multiple times.  Called only from manager.
1989e22bee78STejun Heo  *
1990e22bee78STejun Heo  * RETURNS:
1991e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1992e22bee78STejun Heo  * otherwise.
1993e22bee78STejun Heo  */
199463d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
1995e22bee78STejun Heo {
1996e22bee78STejun Heo 	bool ret = false;
1997e22bee78STejun Heo 
199863d95a91STejun Heo 	while (too_many_workers(pool)) {
1999e22bee78STejun Heo 		struct worker *worker;
2000e22bee78STejun Heo 		unsigned long expires;
2001e22bee78STejun Heo 
200263d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2003e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2004e22bee78STejun Heo 
2005e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
200663d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2007e22bee78STejun Heo 			break;
2008e22bee78STejun Heo 		}
2009e22bee78STejun Heo 
2010e22bee78STejun Heo 		destroy_worker(worker);
2011e22bee78STejun Heo 		ret = true;
2012e22bee78STejun Heo 	}
2013e22bee78STejun Heo 
2014e22bee78STejun Heo 	return ret;
2015e22bee78STejun Heo }
2016e22bee78STejun Heo 
2017e22bee78STejun Heo /**
2018e22bee78STejun Heo  * manage_workers - manage worker pool
2019e22bee78STejun Heo  * @worker: self
2020e22bee78STejun Heo  *
2021e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
2022e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2023e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
2024e22bee78STejun Heo  *
2025e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2026e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2027e22bee78STejun Heo  * and may_start_working() is true.
2028e22bee78STejun Heo  *
2029e22bee78STejun Heo  * CONTEXT:
2030e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2031e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2032e22bee78STejun Heo  *
2033e22bee78STejun Heo  * RETURNS:
2034e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
2035e22bee78STejun Heo  * some action was taken.
2036e22bee78STejun Heo  */
2037e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2038e22bee78STejun Heo {
203963d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2040e22bee78STejun Heo 	bool ret = false;
2041e22bee78STejun Heo 
2042ee378aa4SLai Jiangshan 	if (pool->flags & POOL_MANAGING_WORKERS)
2043e22bee78STejun Heo 		return ret;
2044e22bee78STejun Heo 
2045552a37e9SLai Jiangshan 	pool->flags |= POOL_MANAGING_WORKERS;
2046ee378aa4SLai Jiangshan 
2047ee378aa4SLai Jiangshan 	/*
2048ee378aa4SLai Jiangshan 	 * To simplify both worker management and CPU hotplug, hold off
2049ee378aa4SLai Jiangshan 	 * management while hotplug is in progress.  CPU hotplug path can't
2050ee378aa4SLai Jiangshan 	 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2051ee378aa4SLai Jiangshan 	 * lead to idle worker depletion (all become busy thinking someone
2052ee378aa4SLai Jiangshan 	 * else is managing) which in turn can result in deadlock under
2053b2eb83d1SLai Jiangshan 	 * extreme circumstances.  Use @pool->assoc_mutex to synchronize
2054ee378aa4SLai Jiangshan 	 * manager against CPU hotplug.
2055ee378aa4SLai Jiangshan 	 *
2056b2eb83d1SLai Jiangshan 	 * assoc_mutex would always be free unless CPU hotplug is in
2057ee378aa4SLai Jiangshan 	 * progress.  trylock first without dropping @gcwq->lock.
2058ee378aa4SLai Jiangshan 	 */
2059b2eb83d1SLai Jiangshan 	if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
2060ee378aa4SLai Jiangshan 		spin_unlock_irq(&pool->gcwq->lock);
2061b2eb83d1SLai Jiangshan 		mutex_lock(&pool->assoc_mutex);
2062ee378aa4SLai Jiangshan 		/*
2063ee378aa4SLai Jiangshan 		 * CPU hotplug could have happened while we were waiting
2064b2eb83d1SLai Jiangshan 		 * for assoc_mutex.  Hotplug itself can't handle us
2065ee378aa4SLai Jiangshan 		 * because manager isn't either on idle or busy list, and
2066ee378aa4SLai Jiangshan 		 * @gcwq's state and ours could have deviated.
2067ee378aa4SLai Jiangshan 		 *
2068b2eb83d1SLai Jiangshan 		 * As hotplug is now excluded via assoc_mutex, we can
2069ee378aa4SLai Jiangshan 		 * simply try to bind.  It will succeed or fail depending
2070ee378aa4SLai Jiangshan 		 * on @gcwq's current state.  Try it and adjust
2071ee378aa4SLai Jiangshan 		 * %WORKER_UNBOUND accordingly.
2072ee378aa4SLai Jiangshan 		 */
2073ee378aa4SLai Jiangshan 		if (worker_maybe_bind_and_lock(worker))
2074ee378aa4SLai Jiangshan 			worker->flags &= ~WORKER_UNBOUND;
2075ee378aa4SLai Jiangshan 		else
2076ee378aa4SLai Jiangshan 			worker->flags |= WORKER_UNBOUND;
2077ee378aa4SLai Jiangshan 
2078ee378aa4SLai Jiangshan 		ret = true;
2079ee378aa4SLai Jiangshan 	}
2080ee378aa4SLai Jiangshan 
208111ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2082e22bee78STejun Heo 
2083e22bee78STejun Heo 	/*
2084e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2085e22bee78STejun Heo 	 * on return.
2086e22bee78STejun Heo 	 */
208763d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
208863d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2089e22bee78STejun Heo 
2090552a37e9SLai Jiangshan 	pool->flags &= ~POOL_MANAGING_WORKERS;
2091b2eb83d1SLai Jiangshan 	mutex_unlock(&pool->assoc_mutex);
2092e22bee78STejun Heo 	return ret;
2093e22bee78STejun Heo }
2094e22bee78STejun Heo 
2095a62428c0STejun Heo /**
2096a62428c0STejun Heo  * process_one_work - process single work
2097c34056a3STejun Heo  * @worker: self
2098a62428c0STejun Heo  * @work: work to process
2099a62428c0STejun Heo  *
2100a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2101a62428c0STejun Heo  * process a single work including synchronization against and
2102a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2103a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2104a62428c0STejun Heo  * call this function to process a work.
2105a62428c0STejun Heo  *
2106a62428c0STejun Heo  * CONTEXT:
21078b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
2108a62428c0STejun Heo  */
2109c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
211006bd6ebfSNamhyung Kim __releases(&gcwq->lock)
211106bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
21121da177e4SLinus Torvalds {
21137e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2114bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2115bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
2116fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
211773f53c4aSTejun Heo 	int work_color;
21187e11629dSTejun Heo 	struct worker *collision;
21194e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21204e6045f1SJohannes Berg 	/*
2121a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2122a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2123a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2124a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2125a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21264e6045f1SJohannes Berg 	 */
21274d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21284d82a1deSPeter Zijlstra 
21294d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21304e6045f1SJohannes Berg #endif
21316fec10a1STejun Heo 	/*
21326fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21336fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
213424647570STejun Heo 	 * unbound or a disassociated pool.
21356fec10a1STejun Heo 	 */
21365f7dabfdSLai Jiangshan 	WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
213724647570STejun Heo 		     !(pool->flags & POOL_DISASSOCIATED) &&
213825511a47STejun Heo 		     raw_smp_processor_id() != gcwq->cpu);
213925511a47STejun Heo 
21407e11629dSTejun Heo 	/*
21417e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21427e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21437e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21447e11629dSTejun Heo 	 * currently executing one.
21457e11629dSTejun Heo 	 */
214642f8570fSSasha Levin 	collision = find_worker_executing_work(gcwq, work);
21477e11629dSTejun Heo 	if (unlikely(collision)) {
21487e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21497e11629dSTejun Heo 		return;
21507e11629dSTejun Heo 	}
21511da177e4SLinus Torvalds 
21528930cabaSTejun Heo 	/* claim and dequeue */
21531da177e4SLinus Torvalds 	debug_work_deactivate(work);
2154023f27d3STejun Heo 	hash_add(gcwq->busy_hash, &worker->hentry, (unsigned long)work);
2155c34056a3STejun Heo 	worker->current_work = work;
2156a2c1c57bSTejun Heo 	worker->current_func = work->func;
21578cca0eeaSTejun Heo 	worker->current_cwq = cwq;
215873f53c4aSTejun Heo 	work_color = get_work_color(work);
21597a22ad75STejun Heo 
2160a62428c0STejun Heo 	list_del_init(&work->entry);
2161a62428c0STejun Heo 
2162649027d7STejun Heo 	/*
2163fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2164fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2165fb0e7bebSTejun Heo 	 */
2166fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2167fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2168fb0e7bebSTejun Heo 
2169974271c4STejun Heo 	/*
2170974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
2171974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2172974271c4STejun Heo 	 */
217363d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
217463d95a91STejun Heo 		wake_up_worker(pool);
2175974271c4STejun Heo 
21768930cabaSTejun Heo 	/*
217723657bb1STejun Heo 	 * Record the last CPU and clear PENDING which should be the last
217823657bb1STejun Heo 	 * update to @work.  Also, do this inside @gcwq->lock so that
217923657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
218023657bb1STejun Heo 	 * disabled.
21818930cabaSTejun Heo 	 */
21828930cabaSTejun Heo 	set_work_cpu_and_clear_pending(work, gcwq->cpu);
21831da177e4SLinus Torvalds 
21841da177e4SLinus Torvalds 	spin_unlock_irq(&gcwq->lock);
2185365970a1SDavid Howells 
2186e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
21873295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2188e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2189a2c1c57bSTejun Heo 	worker->current_func(work);
2190e36c886aSArjan van de Ven 	/*
2191e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2192e36c886aSArjan van de Ven 	 * point will only record its address.
2193e36c886aSArjan van de Ven 	 */
2194e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
21953295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
21963295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
21971da177e4SLinus Torvalds 
2198d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2199044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2200044c782cSValentin Ilie 		       "     last function: %pf\n",
2201a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2202a2c1c57bSTejun Heo 		       worker->current_func);
2203d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2204d5abe669SPeter Zijlstra 		dump_stack();
2205d5abe669SPeter Zijlstra 	}
2206d5abe669SPeter Zijlstra 
22078b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2208a62428c0STejun Heo 
2209fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2210fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2211fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2212fb0e7bebSTejun Heo 
2213a62428c0STejun Heo 	/* we're done with it, release */
221442f8570fSSasha Levin 	hash_del(&worker->hentry);
2215c34056a3STejun Heo 	worker->current_work = NULL;
2216a2c1c57bSTejun Heo 	worker->current_func = NULL;
22178cca0eeaSTejun Heo 	worker->current_cwq = NULL;
2218b3f9f405SLai Jiangshan 	cwq_dec_nr_in_flight(cwq, work_color);
22191da177e4SLinus Torvalds }
22201da177e4SLinus Torvalds 
2221affee4b2STejun Heo /**
2222affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2223affee4b2STejun Heo  * @worker: self
2224affee4b2STejun Heo  *
2225affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2226affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2227affee4b2STejun Heo  * fetches a work from the top and executes it.
2228affee4b2STejun Heo  *
2229affee4b2STejun Heo  * CONTEXT:
22308b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2231affee4b2STejun Heo  * multiple times.
2232affee4b2STejun Heo  */
2233affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22341da177e4SLinus Torvalds {
2235affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2236affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2237a62428c0STejun Heo 						struct work_struct, entry);
2238c34056a3STejun Heo 		process_one_work(worker, work);
2239a62428c0STejun Heo 	}
22401da177e4SLinus Torvalds }
22411da177e4SLinus Torvalds 
22424690c4abSTejun Heo /**
22434690c4abSTejun Heo  * worker_thread - the worker thread function
2244c34056a3STejun Heo  * @__worker: self
22454690c4abSTejun Heo  *
2246e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2247e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2248e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2249e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2250e22bee78STejun Heo  * rescuer_thread().
22514690c4abSTejun Heo  */
2252c34056a3STejun Heo static int worker_thread(void *__worker)
22531da177e4SLinus Torvalds {
2254c34056a3STejun Heo 	struct worker *worker = __worker;
2255bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2256bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
22571da177e4SLinus Torvalds 
2258e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2259e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2260c8e55f36STejun Heo woke_up:
22618b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2262affee4b2STejun Heo 
22635f7dabfdSLai Jiangshan 	/* we are off idle list if destruction or rebind is requested */
22645f7dabfdSLai Jiangshan 	if (unlikely(list_empty(&worker->entry))) {
2265c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
226625511a47STejun Heo 
22675f7dabfdSLai Jiangshan 		/* if DIE is set, destruction is requested */
226825511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2269e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2270c8e55f36STejun Heo 			return 0;
2271c8e55f36STejun Heo 		}
2272c8e55f36STejun Heo 
22735f7dabfdSLai Jiangshan 		/* otherwise, rebind */
227425511a47STejun Heo 		idle_worker_rebind(worker);
227525511a47STejun Heo 		goto woke_up;
227625511a47STejun Heo 	}
227725511a47STejun Heo 
2278c8e55f36STejun Heo 	worker_leave_idle(worker);
2279db7bccf4STejun Heo recheck:
2280e22bee78STejun Heo 	/* no more worker necessary? */
228163d95a91STejun Heo 	if (!need_more_worker(pool))
2282e22bee78STejun Heo 		goto sleep;
2283e22bee78STejun Heo 
2284e22bee78STejun Heo 	/* do we need to manage? */
228563d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2286e22bee78STejun Heo 		goto recheck;
2287e22bee78STejun Heo 
2288c8e55f36STejun Heo 	/*
2289c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2290c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2291c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2292c8e55f36STejun Heo 	 */
2293c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2294c8e55f36STejun Heo 
2295e22bee78STejun Heo 	/*
2296e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2297e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2298e22bee78STejun Heo 	 * assumed the manager role.
2299e22bee78STejun Heo 	 */
2300e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2301e22bee78STejun Heo 
2302e22bee78STejun Heo 	do {
2303affee4b2STejun Heo 		struct work_struct *work =
2304bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2305affee4b2STejun Heo 					 struct work_struct, entry);
2306affee4b2STejun Heo 
2307c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2308affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2309affee4b2STejun Heo 			process_one_work(worker, work);
2310affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2311affee4b2STejun Heo 				process_scheduled_works(worker);
2312affee4b2STejun Heo 		} else {
2313c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2314affee4b2STejun Heo 			process_scheduled_works(worker);
2315affee4b2STejun Heo 		}
231663d95a91STejun Heo 	} while (keep_working(pool));
2317affee4b2STejun Heo 
2318e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2319d313dd85STejun Heo sleep:
232063d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2321e22bee78STejun Heo 		goto recheck;
2322d313dd85STejun Heo 
2323c8e55f36STejun Heo 	/*
2324e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2325e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2326e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2327e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2328e22bee78STejun Heo 	 * prevent losing any event.
2329c8e55f36STejun Heo 	 */
2330c8e55f36STejun Heo 	worker_enter_idle(worker);
2331c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
23328b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23331da177e4SLinus Torvalds 	schedule();
2334c8e55f36STejun Heo 	goto woke_up;
23351da177e4SLinus Torvalds }
23361da177e4SLinus Torvalds 
2337e22bee78STejun Heo /**
2338e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2339111c225aSTejun Heo  * @__rescuer: self
2340e22bee78STejun Heo  *
2341e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2342e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2343e22bee78STejun Heo  *
2344e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2345e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2346e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2347e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2348e22bee78STejun Heo  * the problem rescuer solves.
2349e22bee78STejun Heo  *
2350e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2351e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2352e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2353e22bee78STejun Heo  *
2354e22bee78STejun Heo  * This should happen rarely.
2355e22bee78STejun Heo  */
2356111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2357e22bee78STejun Heo {
2358111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2359111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2360e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2361f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2362e22bee78STejun Heo 	unsigned int cpu;
2363e22bee78STejun Heo 
2364e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2365111c225aSTejun Heo 
2366111c225aSTejun Heo 	/*
2367111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2368111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2369111c225aSTejun Heo 	 */
2370111c225aSTejun Heo 	rescuer->task->flags |= PF_WQ_WORKER;
2371e22bee78STejun Heo repeat:
2372e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
23731da177e4SLinus Torvalds 
2374412d32e6SMike Galbraith 	if (kthread_should_stop()) {
2375412d32e6SMike Galbraith 		__set_current_state(TASK_RUNNING);
2376111c225aSTejun Heo 		rescuer->task->flags &= ~PF_WQ_WORKER;
2377e22bee78STejun Heo 		return 0;
2378412d32e6SMike Galbraith 	}
23791da177e4SLinus Torvalds 
2380f3421797STejun Heo 	/*
2381f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2382f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2383f3421797STejun Heo 	 */
2384f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2385f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2386f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2387bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2388bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2389e22bee78STejun Heo 		struct work_struct *work, *n;
2390e22bee78STejun Heo 
2391e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2392f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2393e22bee78STejun Heo 
2394e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2395bd7bdd43STejun Heo 		rescuer->pool = pool;
2396e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2397e22bee78STejun Heo 
2398e22bee78STejun Heo 		/*
2399e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2400e22bee78STejun Heo 		 * process'em.
2401e22bee78STejun Heo 		 */
2402e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2403bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2404e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2405e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2406e22bee78STejun Heo 
2407e22bee78STejun Heo 		process_scheduled_works(rescuer);
24087576958aSTejun Heo 
24097576958aSTejun Heo 		/*
24107576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
24117576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24127576958aSTejun Heo 		 * and stalling the execution.
24137576958aSTejun Heo 		 */
241463d95a91STejun Heo 		if (keep_working(pool))
241563d95a91STejun Heo 			wake_up_worker(pool);
24167576958aSTejun Heo 
2417e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
24181da177e4SLinus Torvalds 	}
24191da177e4SLinus Torvalds 
2420111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2421111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2422e22bee78STejun Heo 	schedule();
2423e22bee78STejun Heo 	goto repeat;
24241da177e4SLinus Torvalds }
24251da177e4SLinus Torvalds 
2426fc2e4d70SOleg Nesterov struct wq_barrier {
2427fc2e4d70SOleg Nesterov 	struct work_struct	work;
2428fc2e4d70SOleg Nesterov 	struct completion	done;
2429fc2e4d70SOleg Nesterov };
2430fc2e4d70SOleg Nesterov 
2431fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2432fc2e4d70SOleg Nesterov {
2433fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2434fc2e4d70SOleg Nesterov 	complete(&barr->done);
2435fc2e4d70SOleg Nesterov }
2436fc2e4d70SOleg Nesterov 
24374690c4abSTejun Heo /**
24384690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
24394690c4abSTejun Heo  * @cwq: cwq to insert barrier into
24404690c4abSTejun Heo  * @barr: wq_barrier to insert
2441affee4b2STejun Heo  * @target: target work to attach @barr to
2442affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24434690c4abSTejun Heo  *
2444affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2445affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2446affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2447affee4b2STejun Heo  * cpu.
2448affee4b2STejun Heo  *
2449affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2450affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2451affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2452affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2453affee4b2STejun Heo  * after a work with LINKED flag set.
2454affee4b2STejun Heo  *
2455affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2456affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
24574690c4abSTejun Heo  *
24584690c4abSTejun Heo  * CONTEXT:
24598b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
24604690c4abSTejun Heo  */
246183c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2462affee4b2STejun Heo 			      struct wq_barrier *barr,
2463affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2464fc2e4d70SOleg Nesterov {
2465affee4b2STejun Heo 	struct list_head *head;
2466affee4b2STejun Heo 	unsigned int linked = 0;
2467affee4b2STejun Heo 
2468dc186ad7SThomas Gleixner 	/*
24698b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2470dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2471dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2472dc186ad7SThomas Gleixner 	 * might deadlock.
2473dc186ad7SThomas Gleixner 	 */
2474ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
247522df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2476fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
247783c22520SOleg Nesterov 
2478affee4b2STejun Heo 	/*
2479affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2480affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2481affee4b2STejun Heo 	 */
2482affee4b2STejun Heo 	if (worker)
2483affee4b2STejun Heo 		head = worker->scheduled.next;
2484affee4b2STejun Heo 	else {
2485affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2486affee4b2STejun Heo 
2487affee4b2STejun Heo 		head = target->entry.next;
2488affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2489affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2490affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2491affee4b2STejun Heo 	}
2492affee4b2STejun Heo 
2493dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2494affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2495affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2496fc2e4d70SOleg Nesterov }
2497fc2e4d70SOleg Nesterov 
249873f53c4aSTejun Heo /**
249973f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
250073f53c4aSTejun Heo  * @wq: workqueue being flushed
250173f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
250273f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
250373f53c4aSTejun Heo  *
250473f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
250573f53c4aSTejun Heo  *
250673f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
250773f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
250873f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
250973f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
251073f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
251173f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
251273f53c4aSTejun Heo  *
251373f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
251473f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
251573f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
251673f53c4aSTejun Heo  * is returned.
251773f53c4aSTejun Heo  *
251873f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
251973f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
252073f53c4aSTejun Heo  * advanced to @work_color.
252173f53c4aSTejun Heo  *
252273f53c4aSTejun Heo  * CONTEXT:
252373f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
252473f53c4aSTejun Heo  *
252573f53c4aSTejun Heo  * RETURNS:
252673f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
252773f53c4aSTejun Heo  * otherwise.
252873f53c4aSTejun Heo  */
252973f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
253073f53c4aSTejun Heo 				      int flush_color, int work_color)
25311da177e4SLinus Torvalds {
253273f53c4aSTejun Heo 	bool wait = false;
253373f53c4aSTejun Heo 	unsigned int cpu;
25341da177e4SLinus Torvalds 
253573f53c4aSTejun Heo 	if (flush_color >= 0) {
253673f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
253773f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2538dc186ad7SThomas Gleixner 	}
253914441960SOleg Nesterov 
2540f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
254173f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2542bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
25431da177e4SLinus Torvalds 
25448b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
254573f53c4aSTejun Heo 
254673f53c4aSTejun Heo 		if (flush_color >= 0) {
254773f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
254873f53c4aSTejun Heo 
254973f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
255073f53c4aSTejun Heo 				cwq->flush_color = flush_color;
255173f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
255273f53c4aSTejun Heo 				wait = true;
25531da177e4SLinus Torvalds 			}
255473f53c4aSTejun Heo 		}
255573f53c4aSTejun Heo 
255673f53c4aSTejun Heo 		if (work_color >= 0) {
255773f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
255873f53c4aSTejun Heo 			cwq->work_color = work_color;
255973f53c4aSTejun Heo 		}
256073f53c4aSTejun Heo 
25618b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
25621da177e4SLinus Torvalds 	}
25631da177e4SLinus Torvalds 
256473f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
256573f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
256673f53c4aSTejun Heo 
256773f53c4aSTejun Heo 	return wait;
256883c22520SOleg Nesterov }
25691da177e4SLinus Torvalds 
25700fcb78c2SRolf Eike Beer /**
25711da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
25720fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
25731da177e4SLinus Torvalds  *
25741da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
25751da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
25761da177e4SLinus Torvalds  *
2577fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2578fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
25791da177e4SLinus Torvalds  */
25807ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
25811da177e4SLinus Torvalds {
258273f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
258373f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
258473f53c4aSTejun Heo 		.flush_color = -1,
258573f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
258673f53c4aSTejun Heo 	};
258773f53c4aSTejun Heo 	int next_color;
2588b1f4ec17SOleg Nesterov 
25893295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
25903295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
259173f53c4aSTejun Heo 
259273f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
259373f53c4aSTejun Heo 
259473f53c4aSTejun Heo 	/*
259573f53c4aSTejun Heo 	 * Start-to-wait phase
259673f53c4aSTejun Heo 	 */
259773f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
259873f53c4aSTejun Heo 
259973f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
260073f53c4aSTejun Heo 		/*
260173f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
260273f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
260373f53c4aSTejun Heo 		 * by one.
260473f53c4aSTejun Heo 		 */
260573f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
260673f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
260773f53c4aSTejun Heo 		wq->work_color = next_color;
260873f53c4aSTejun Heo 
260973f53c4aSTejun Heo 		if (!wq->first_flusher) {
261073f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
261173f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
261273f53c4aSTejun Heo 
261373f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
261473f53c4aSTejun Heo 
261573f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
261673f53c4aSTejun Heo 						       wq->work_color)) {
261773f53c4aSTejun Heo 				/* nothing to flush, done */
261873f53c4aSTejun Heo 				wq->flush_color = next_color;
261973f53c4aSTejun Heo 				wq->first_flusher = NULL;
262073f53c4aSTejun Heo 				goto out_unlock;
262173f53c4aSTejun Heo 			}
262273f53c4aSTejun Heo 		} else {
262373f53c4aSTejun Heo 			/* wait in queue */
262473f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
262573f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
262673f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
262773f53c4aSTejun Heo 		}
262873f53c4aSTejun Heo 	} else {
262973f53c4aSTejun Heo 		/*
263073f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
263173f53c4aSTejun Heo 		 * The next flush completion will assign us
263273f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
263373f53c4aSTejun Heo 		 */
263473f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
263573f53c4aSTejun Heo 	}
263673f53c4aSTejun Heo 
263773f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
263873f53c4aSTejun Heo 
263973f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
264073f53c4aSTejun Heo 
264173f53c4aSTejun Heo 	/*
264273f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
264373f53c4aSTejun Heo 	 *
264473f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
264573f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
264673f53c4aSTejun Heo 	 */
264773f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
264873f53c4aSTejun Heo 		return;
264973f53c4aSTejun Heo 
265073f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
265173f53c4aSTejun Heo 
26524ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26534ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26544ce48b37STejun Heo 		goto out_unlock;
26554ce48b37STejun Heo 
265673f53c4aSTejun Heo 	wq->first_flusher = NULL;
265773f53c4aSTejun Heo 
265873f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
265973f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
266073f53c4aSTejun Heo 
266173f53c4aSTejun Heo 	while (true) {
266273f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
266373f53c4aSTejun Heo 
266473f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
266573f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
266673f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
266773f53c4aSTejun Heo 				break;
266873f53c4aSTejun Heo 			list_del_init(&next->list);
266973f53c4aSTejun Heo 			complete(&next->done);
267073f53c4aSTejun Heo 		}
267173f53c4aSTejun Heo 
267273f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
267373f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
267473f53c4aSTejun Heo 
267573f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
267673f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
267773f53c4aSTejun Heo 
267873f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
267973f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
268073f53c4aSTejun Heo 			/*
268173f53c4aSTejun Heo 			 * Assign the same color to all overflowed
268273f53c4aSTejun Heo 			 * flushers, advance work_color and append to
268373f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
268473f53c4aSTejun Heo 			 * phase for these overflowed flushers.
268573f53c4aSTejun Heo 			 */
268673f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
268773f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
268873f53c4aSTejun Heo 
268973f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
269073f53c4aSTejun Heo 
269173f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
269273f53c4aSTejun Heo 					      &wq->flusher_queue);
269373f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
269473f53c4aSTejun Heo 		}
269573f53c4aSTejun Heo 
269673f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
269773f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
269873f53c4aSTejun Heo 			break;
269973f53c4aSTejun Heo 		}
270073f53c4aSTejun Heo 
270173f53c4aSTejun Heo 		/*
270273f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
270373f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
270473f53c4aSTejun Heo 		 */
270573f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
270673f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
270773f53c4aSTejun Heo 
270873f53c4aSTejun Heo 		list_del_init(&next->list);
270973f53c4aSTejun Heo 		wq->first_flusher = next;
271073f53c4aSTejun Heo 
271173f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
271273f53c4aSTejun Heo 			break;
271373f53c4aSTejun Heo 
271473f53c4aSTejun Heo 		/*
271573f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
271673f53c4aSTejun Heo 		 * flusher and repeat cascading.
271773f53c4aSTejun Heo 		 */
271873f53c4aSTejun Heo 		wq->first_flusher = NULL;
271973f53c4aSTejun Heo 	}
272073f53c4aSTejun Heo 
272173f53c4aSTejun Heo out_unlock:
272273f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
27231da177e4SLinus Torvalds }
2724ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27251da177e4SLinus Torvalds 
27269c5a2ba7STejun Heo /**
27279c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27289c5a2ba7STejun Heo  * @wq: workqueue to drain
27299c5a2ba7STejun Heo  *
27309c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27319c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27329c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27339c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27349c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27359c5a2ba7STejun Heo  * takes too long.
27369c5a2ba7STejun Heo  */
27379c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27389c5a2ba7STejun Heo {
27399c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
27409c5a2ba7STejun Heo 	unsigned int cpu;
27419c5a2ba7STejun Heo 
27429c5a2ba7STejun Heo 	/*
27439c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27449c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
27459c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
27469c5a2ba7STejun Heo 	 */
27479c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27489c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
27499c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
27509c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27519c5a2ba7STejun Heo reflush:
27529c5a2ba7STejun Heo 	flush_workqueue(wq);
27539c5a2ba7STejun Heo 
27549c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27559c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2756fa2563e4SThomas Tuttle 		bool drained;
27579c5a2ba7STejun Heo 
2758bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2759fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2760bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2761fa2563e4SThomas Tuttle 
2762fa2563e4SThomas Tuttle 		if (drained)
27639c5a2ba7STejun Heo 			continue;
27649c5a2ba7STejun Heo 
27659c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27669c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2767044c782cSValentin Ilie 			pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
27689c5a2ba7STejun Heo 				wq->name, flush_cnt);
27699c5a2ba7STejun Heo 		goto reflush;
27709c5a2ba7STejun Heo 	}
27719c5a2ba7STejun Heo 
27729c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27739c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
27749c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
27759c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27769c5a2ba7STejun Heo }
27779c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
27789c5a2ba7STejun Heo 
2779606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2780baf59022STejun Heo {
2781baf59022STejun Heo 	struct worker *worker = NULL;
2782baf59022STejun Heo 	struct global_cwq *gcwq;
2783baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2784baf59022STejun Heo 
2785baf59022STejun Heo 	might_sleep();
2786baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2787baf59022STejun Heo 	if (!gcwq)
2788baf59022STejun Heo 		return false;
2789baf59022STejun Heo 
2790baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2791baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2792baf59022STejun Heo 		/*
2793baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2794baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2795baf59022STejun Heo 		 * are not going to wait.
2796baf59022STejun Heo 		 */
2797baf59022STejun Heo 		smp_rmb();
2798baf59022STejun Heo 		cwq = get_work_cwq(work);
2799bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2800baf59022STejun Heo 			goto already_gone;
2801606a5020STejun Heo 	} else {
2802baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2803baf59022STejun Heo 		if (!worker)
2804baf59022STejun Heo 			goto already_gone;
2805baf59022STejun Heo 		cwq = worker->current_cwq;
2806606a5020STejun Heo 	}
2807baf59022STejun Heo 
2808baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2809baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2810baf59022STejun Heo 
2811e159489bSTejun Heo 	/*
2812e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2813e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2814e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2815e159489bSTejun Heo 	 * access.
2816e159489bSTejun Heo 	 */
2817e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2818baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2819e159489bSTejun Heo 	else
2820e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2821baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2822e159489bSTejun Heo 
2823baf59022STejun Heo 	return true;
2824baf59022STejun Heo already_gone:
2825baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2826baf59022STejun Heo 	return false;
2827baf59022STejun Heo }
2828baf59022STejun Heo 
2829db700897SOleg Nesterov /**
2830401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2831401a8d04STejun Heo  * @work: the work to flush
2832db700897SOleg Nesterov  *
2833606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2834606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2835401a8d04STejun Heo  *
2836401a8d04STejun Heo  * RETURNS:
2837401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2838401a8d04STejun Heo  * %false if it was already idle.
2839db700897SOleg Nesterov  */
2840401a8d04STejun Heo bool flush_work(struct work_struct *work)
2841db700897SOleg Nesterov {
2842db700897SOleg Nesterov 	struct wq_barrier barr;
2843db700897SOleg Nesterov 
28440976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28450976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28460976dfc1SStephen Boyd 
2847606a5020STejun Heo 	if (start_flush_work(work, &barr)) {
2848db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2849dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2850401a8d04STejun Heo 		return true;
2851606a5020STejun Heo 	} else {
2852401a8d04STejun Heo 		return false;
2853db700897SOleg Nesterov 	}
2854606a5020STejun Heo }
2855db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2856db700897SOleg Nesterov 
285736e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2858401a8d04STejun Heo {
2859bbb68dfaSTejun Heo 	unsigned long flags;
28601f1f642eSOleg Nesterov 	int ret;
28611f1f642eSOleg Nesterov 
28621f1f642eSOleg Nesterov 	do {
2863bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2864bbb68dfaSTejun Heo 		/*
2865bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2866bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2867bbb68dfaSTejun Heo 		 */
2868bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2869606a5020STejun Heo 			flush_work(work);
28701f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
28711f1f642eSOleg Nesterov 
2872bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2873bbb68dfaSTejun Heo 	mark_work_canceling(work);
2874bbb68dfaSTejun Heo 	local_irq_restore(flags);
2875bbb68dfaSTejun Heo 
2876606a5020STejun Heo 	flush_work(work);
28777a22ad75STejun Heo 	clear_work_data(work);
28781f1f642eSOleg Nesterov 	return ret;
28791f1f642eSOleg Nesterov }
28801f1f642eSOleg Nesterov 
28816e84d644SOleg Nesterov /**
2882401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2883401a8d04STejun Heo  * @work: the work to cancel
28846e84d644SOleg Nesterov  *
2885401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2886401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2887401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2888401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
28891f1f642eSOleg Nesterov  *
2890401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2891401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
28926e84d644SOleg Nesterov  *
2893401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
28946e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2895401a8d04STejun Heo  *
2896401a8d04STejun Heo  * RETURNS:
2897401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
28986e84d644SOleg Nesterov  */
2899401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29006e84d644SOleg Nesterov {
290136e227d2STejun Heo 	return __cancel_work_timer(work, false);
2902b89deed3SOleg Nesterov }
290328e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2904b89deed3SOleg Nesterov 
29056e84d644SOleg Nesterov /**
2906401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2907401a8d04STejun Heo  * @dwork: the delayed work to flush
29086e84d644SOleg Nesterov  *
2909401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2910401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2911401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29121f1f642eSOleg Nesterov  *
2913401a8d04STejun Heo  * RETURNS:
2914401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2915401a8d04STejun Heo  * %false if it was already idle.
29166e84d644SOleg Nesterov  */
2917401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2918401a8d04STejun Heo {
29198930cabaSTejun Heo 	local_irq_disable();
2920401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
29211265057fSTejun Heo 		__queue_work(dwork->cpu,
2922401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
29238930cabaSTejun Heo 	local_irq_enable();
2924401a8d04STejun Heo 	return flush_work(&dwork->work);
2925401a8d04STejun Heo }
2926401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2927401a8d04STejun Heo 
2928401a8d04STejun Heo /**
292957b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
293057b30ae7STejun Heo  * @dwork: delayed_work to cancel
293109383498STejun Heo  *
293257b30ae7STejun Heo  * Kill off a pending delayed_work.  Returns %true if @dwork was pending
293357b30ae7STejun Heo  * and canceled; %false if wasn't pending.  Note that the work callback
293457b30ae7STejun Heo  * function may still be running on return, unless it returns %true and the
293557b30ae7STejun Heo  * work doesn't re-arm itself.  Explicitly flush or use
293657b30ae7STejun Heo  * cancel_delayed_work_sync() to wait on it.
293709383498STejun Heo  *
293857b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
293909383498STejun Heo  */
294057b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
294109383498STejun Heo {
294257b30ae7STejun Heo 	unsigned long flags;
294357b30ae7STejun Heo 	int ret;
294457b30ae7STejun Heo 
294557b30ae7STejun Heo 	do {
294657b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
294757b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
294857b30ae7STejun Heo 
294957b30ae7STejun Heo 	if (unlikely(ret < 0))
295057b30ae7STejun Heo 		return false;
295157b30ae7STejun Heo 
295257b30ae7STejun Heo 	set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
295357b30ae7STejun Heo 	local_irq_restore(flags);
2954c0158ca6SDan Magenheimer 	return ret;
295509383498STejun Heo }
295657b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
295709383498STejun Heo 
295809383498STejun Heo /**
2959401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2960401a8d04STejun Heo  * @dwork: the delayed work cancel
2961401a8d04STejun Heo  *
2962401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2963401a8d04STejun Heo  *
2964401a8d04STejun Heo  * RETURNS:
2965401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2966401a8d04STejun Heo  */
2967401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
29686e84d644SOleg Nesterov {
296936e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
29706e84d644SOleg Nesterov }
2971f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
29721da177e4SLinus Torvalds 
29730fcb78c2SRolf Eike Beer /**
2974c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2975c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2976c1a220e7SZhang Rui  * @work: job to be done
2977c1a220e7SZhang Rui  *
2978c1a220e7SZhang Rui  * This puts a job on a specific cpu
2979c1a220e7SZhang Rui  */
2980d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work)
2981c1a220e7SZhang Rui {
2982d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2983c1a220e7SZhang Rui }
2984c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2985c1a220e7SZhang Rui 
29860fcb78c2SRolf Eike Beer /**
2987ae90dd5dSDave Jones  * schedule_work - put work task in global workqueue
29881da177e4SLinus Torvalds  * @work: job to be done
29891da177e4SLinus Torvalds  *
2990d4283e93STejun Heo  * Returns %false if @work was already on the kernel-global workqueue and
2991d4283e93STejun Heo  * %true otherwise.
299252bad64dSDavid Howells  *
29930fcb78c2SRolf Eike Beer  * This puts a job in the kernel-global workqueue if it was not already
29940fcb78c2SRolf Eike Beer  * queued and leaves it in the same position on the kernel-global
29950fcb78c2SRolf Eike Beer  * workqueue otherwise.
29961da177e4SLinus Torvalds  */
2997d4283e93STejun Heo bool schedule_work(struct work_struct *work)
29981da177e4SLinus Torvalds {
29990fcb78c2SRolf Eike Beer 	return queue_work(system_wq, work);
30001da177e4SLinus Torvalds }
30010fcb78c2SRolf Eike Beer EXPORT_SYMBOL(schedule_work);
30021da177e4SLinus Torvalds 
30030fcb78c2SRolf Eike Beer /**
30040fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
30050fcb78c2SRolf Eike Beer  * @cpu: cpu to use
30060fcb78c2SRolf Eike Beer  * @dwork: job to be done
30070fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
30080fcb78c2SRolf Eike Beer  *
30090fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
30100fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
30110fcb78c2SRolf Eike Beer  */
3012d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3013d4283e93STejun Heo 			      unsigned long delay)
30141da177e4SLinus Torvalds {
3015d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
30161da177e4SLinus Torvalds }
3017ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
30181da177e4SLinus Torvalds 
3019b6136773SAndrew Morton /**
30200a13c00eSTejun Heo  * schedule_delayed_work - put work task in global workqueue after delay
30210a13c00eSTejun Heo  * @dwork: job to be done
30220a13c00eSTejun Heo  * @delay: number of jiffies to wait or 0 for immediate execution
30230a13c00eSTejun Heo  *
30240a13c00eSTejun Heo  * After waiting for a given time this puts a job in the kernel-global
30250a13c00eSTejun Heo  * workqueue.
30260a13c00eSTejun Heo  */
3027d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
30280a13c00eSTejun Heo {
30290a13c00eSTejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
30300a13c00eSTejun Heo }
30310a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work);
30320a13c00eSTejun Heo 
30330a13c00eSTejun Heo /**
303431ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3035b6136773SAndrew Morton  * @func: the function to call
3036b6136773SAndrew Morton  *
303731ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
303831ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3039b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
304031ddd871STejun Heo  *
304131ddd871STejun Heo  * RETURNS:
304231ddd871STejun Heo  * 0 on success, -errno on failure.
3043b6136773SAndrew Morton  */
304465f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
304515316ba8SChristoph Lameter {
304615316ba8SChristoph Lameter 	int cpu;
304738f51568SNamhyung Kim 	struct work_struct __percpu *works;
304815316ba8SChristoph Lameter 
3049b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3050b6136773SAndrew Morton 	if (!works)
305115316ba8SChristoph Lameter 		return -ENOMEM;
3052b6136773SAndrew Morton 
305395402b38SGautham R Shenoy 	get_online_cpus();
305493981800STejun Heo 
305515316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
30569bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
30579bfb1839SIngo Molnar 
30589bfb1839SIngo Molnar 		INIT_WORK(work, func);
30598de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
306015316ba8SChristoph Lameter 	}
306193981800STejun Heo 
306293981800STejun Heo 	for_each_online_cpu(cpu)
30638616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
306493981800STejun Heo 
306595402b38SGautham R Shenoy 	put_online_cpus();
3066b6136773SAndrew Morton 	free_percpu(works);
306715316ba8SChristoph Lameter 	return 0;
306815316ba8SChristoph Lameter }
306915316ba8SChristoph Lameter 
3070eef6a7d5SAlan Stern /**
3071eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3072eef6a7d5SAlan Stern  *
3073eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3074eef6a7d5SAlan Stern  * completion.
3075eef6a7d5SAlan Stern  *
3076eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3077eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3078eef6a7d5SAlan Stern  * will lead to deadlock:
3079eef6a7d5SAlan Stern  *
3080eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3081eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3082eef6a7d5SAlan Stern  *
3083eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3084eef6a7d5SAlan Stern  *
3085eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3086eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3087eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3088eef6a7d5SAlan Stern  *
3089eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3090eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3091eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3092eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3093eef6a7d5SAlan Stern  */
30941da177e4SLinus Torvalds void flush_scheduled_work(void)
30951da177e4SLinus Torvalds {
3096d320c038STejun Heo 	flush_workqueue(system_wq);
30971da177e4SLinus Torvalds }
3098ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
30991da177e4SLinus Torvalds 
31001da177e4SLinus Torvalds /**
31011fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
31021fa44ecaSJames Bottomley  * @fn:		the function to execute
31031fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
31041fa44ecaSJames Bottomley  *		be available when the work executes)
31051fa44ecaSJames Bottomley  *
31061fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
31071fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
31081fa44ecaSJames Bottomley  *
31091fa44ecaSJames Bottomley  * Returns:	0 - function was executed
31101fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31111fa44ecaSJames Bottomley  */
311265f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31131fa44ecaSJames Bottomley {
31141fa44ecaSJames Bottomley 	if (!in_interrupt()) {
311565f27f38SDavid Howells 		fn(&ew->work);
31161fa44ecaSJames Bottomley 		return 0;
31171fa44ecaSJames Bottomley 	}
31181fa44ecaSJames Bottomley 
311965f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31201fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31211fa44ecaSJames Bottomley 
31221fa44ecaSJames Bottomley 	return 1;
31231fa44ecaSJames Bottomley }
31241fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31251fa44ecaSJames Bottomley 
31261da177e4SLinus Torvalds int keventd_up(void)
31271da177e4SLinus Torvalds {
3128d320c038STejun Heo 	return system_wq != NULL;
31291da177e4SLinus Torvalds }
31301da177e4SLinus Torvalds 
3131bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
31321da177e4SLinus Torvalds {
31333af24433SOleg Nesterov 	/*
31340f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
31350f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
31360f900049STejun Heo 	 * unsigned long long.
31373af24433SOleg Nesterov 	 */
31380f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
31390f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
31400f900049STejun Heo 				   __alignof__(unsigned long long));
31413af24433SOleg Nesterov 
3142e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3143f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3144931ac77eSTejun Heo 	else {
31450f900049STejun Heo 		void *ptr;
3146e1d8aa9fSFrederic Weisbecker 
31470f900049STejun Heo 		/*
3148f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3149f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3150f3421797STejun Heo 		 * allocated pointer which will be used for free.
31510f900049STejun Heo 		 */
3152bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3153bdbc5dd7STejun Heo 		if (ptr) {
3154bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3155bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3156bdbc5dd7STejun Heo 		}
31573af24433SOleg Nesterov 	}
31583af24433SOleg Nesterov 
31590415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3160bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3161bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
31620f900049STejun Heo }
31630f900049STejun Heo 
3164bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
316506ba38a9SOleg Nesterov {
3166e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3167bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3168f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3169f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3170f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
317106ba38a9SOleg Nesterov 	}
317206ba38a9SOleg Nesterov }
317306ba38a9SOleg Nesterov 
3174f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3175f3421797STejun Heo 			       const char *name)
3176b71ab8c2STejun Heo {
3177f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3178f3421797STejun Heo 
3179f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3180044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3181f3421797STejun Heo 			max_active, name, 1, lim);
3182b71ab8c2STejun Heo 
3183f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3184b71ab8c2STejun Heo }
3185b71ab8c2STejun Heo 
3186b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
318797e37d7bSTejun Heo 					       unsigned int flags,
31881e19ffc6STejun Heo 					       int max_active,
3189eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3190b196be89STejun Heo 					       const char *lock_name, ...)
31913af24433SOleg Nesterov {
3192b196be89STejun Heo 	va_list args, args1;
31933af24433SOleg Nesterov 	struct workqueue_struct *wq;
3194c34056a3STejun Heo 	unsigned int cpu;
3195b196be89STejun Heo 	size_t namelen;
3196b196be89STejun Heo 
3197b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3198b196be89STejun Heo 	va_start(args, lock_name);
3199b196be89STejun Heo 	va_copy(args1, args);
3200b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3201b196be89STejun Heo 
3202b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3203b196be89STejun Heo 	if (!wq)
3204b196be89STejun Heo 		goto err;
3205b196be89STejun Heo 
3206b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3207b196be89STejun Heo 	va_end(args);
3208b196be89STejun Heo 	va_end(args1);
32093af24433SOleg Nesterov 
3210f3421797STejun Heo 	/*
32116370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
32126370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
32136370a6adSTejun Heo 	 */
32146370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
32156370a6adSTejun Heo 		flags |= WQ_RESCUER;
32166370a6adSTejun Heo 
3217d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3218b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
32193af24433SOleg Nesterov 
3220b196be89STejun Heo 	/* init wq */
322197e37d7bSTejun Heo 	wq->flags = flags;
3222a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
322373f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
322473f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
322573f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
322673f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
32273af24433SOleg Nesterov 
3228eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3229cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
32303af24433SOleg Nesterov 
3231bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3232bdbc5dd7STejun Heo 		goto err;
3233bdbc5dd7STejun Heo 
3234f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
32351537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
32368b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
32373270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
32381537663fSTejun Heo 
32390f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
32403270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3241c34056a3STejun Heo 		cwq->wq = wq;
324273f53c4aSTejun Heo 		cwq->flush_color = -1;
32431e19ffc6STejun Heo 		cwq->max_active = max_active;
32441e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3245e22bee78STejun Heo 	}
32461537663fSTejun Heo 
3247e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3248e22bee78STejun Heo 		struct worker *rescuer;
3249e22bee78STejun Heo 
3250f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3251e22bee78STejun Heo 			goto err;
3252e22bee78STejun Heo 
3253e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3254e22bee78STejun Heo 		if (!rescuer)
3255e22bee78STejun Heo 			goto err;
3256e22bee78STejun Heo 
3257111c225aSTejun Heo 		rescuer->rescue_wq = wq;
3258111c225aSTejun Heo 		rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
3259b196be89STejun Heo 					       wq->name);
3260e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3261e22bee78STejun Heo 			goto err;
3262e22bee78STejun Heo 
3263e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3264e22bee78STejun Heo 		wake_up_process(rescuer->task);
32653af24433SOleg Nesterov 	}
32661537663fSTejun Heo 
32673af24433SOleg Nesterov 	/*
3268a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3269a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3270a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
32713af24433SOleg Nesterov 	 */
32723af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3273a0a1a5fdSTejun Heo 
327458a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3275f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3276a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3277a0a1a5fdSTejun Heo 
32783af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3279a0a1a5fdSTejun Heo 
32803af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
32813af24433SOleg Nesterov 
32823af24433SOleg Nesterov 	return wq;
32834690c4abSTejun Heo err:
32844690c4abSTejun Heo 	if (wq) {
3285bdbc5dd7STejun Heo 		free_cwqs(wq);
3286f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3287e22bee78STejun Heo 		kfree(wq->rescuer);
32884690c4abSTejun Heo 		kfree(wq);
32893af24433SOleg Nesterov 	}
32904690c4abSTejun Heo 	return NULL;
32911da177e4SLinus Torvalds }
3292d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
32931da177e4SLinus Torvalds 
32943af24433SOleg Nesterov /**
32953af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
32963af24433SOleg Nesterov  * @wq: target workqueue
32973af24433SOleg Nesterov  *
32983af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
32993af24433SOleg Nesterov  */
33003af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
33013af24433SOleg Nesterov {
3302c8e55f36STejun Heo 	unsigned int cpu;
33033af24433SOleg Nesterov 
33049c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
33059c5a2ba7STejun Heo 	drain_workqueue(wq);
3306c8efcc25STejun Heo 
3307a0a1a5fdSTejun Heo 	/*
3308a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3309a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3310a0a1a5fdSTejun Heo 	 */
331195402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
33123af24433SOleg Nesterov 	list_del(&wq->list);
331395402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
33143af24433SOleg Nesterov 
3315e22bee78STejun Heo 	/* sanity check */
3316f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
331773f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
331873f53c4aSTejun Heo 		int i;
33193af24433SOleg Nesterov 
332073f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
332173f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
33221e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
33231e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
332473f53c4aSTejun Heo 	}
33251537663fSTejun Heo 
3326e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3327e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3328f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
33298d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3330e22bee78STejun Heo 	}
3331e22bee78STejun Heo 
3332bdbc5dd7STejun Heo 	free_cwqs(wq);
33333af24433SOleg Nesterov 	kfree(wq);
33343af24433SOleg Nesterov }
33353af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
33363af24433SOleg Nesterov 
3337dcd989cbSTejun Heo /**
33389f4bd4cdSLai Jiangshan  * cwq_set_max_active - adjust max_active of a cwq
33399f4bd4cdSLai Jiangshan  * @cwq: target cpu_workqueue_struct
33409f4bd4cdSLai Jiangshan  * @max_active: new max_active value.
33419f4bd4cdSLai Jiangshan  *
33429f4bd4cdSLai Jiangshan  * Set @cwq->max_active to @max_active and activate delayed works if
33439f4bd4cdSLai Jiangshan  * increased.
33449f4bd4cdSLai Jiangshan  *
33459f4bd4cdSLai Jiangshan  * CONTEXT:
33469f4bd4cdSLai Jiangshan  * spin_lock_irq(gcwq->lock).
33479f4bd4cdSLai Jiangshan  */
33489f4bd4cdSLai Jiangshan static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
33499f4bd4cdSLai Jiangshan {
33509f4bd4cdSLai Jiangshan 	cwq->max_active = max_active;
33519f4bd4cdSLai Jiangshan 
33529f4bd4cdSLai Jiangshan 	while (!list_empty(&cwq->delayed_works) &&
33539f4bd4cdSLai Jiangshan 	       cwq->nr_active < cwq->max_active)
33549f4bd4cdSLai Jiangshan 		cwq_activate_first_delayed(cwq);
33559f4bd4cdSLai Jiangshan }
33569f4bd4cdSLai Jiangshan 
33579f4bd4cdSLai Jiangshan /**
3358dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3359dcd989cbSTejun Heo  * @wq: target workqueue
3360dcd989cbSTejun Heo  * @max_active: new max_active value.
3361dcd989cbSTejun Heo  *
3362dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3363dcd989cbSTejun Heo  *
3364dcd989cbSTejun Heo  * CONTEXT:
3365dcd989cbSTejun Heo  * Don't call from IRQ context.
3366dcd989cbSTejun Heo  */
3367dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3368dcd989cbSTejun Heo {
3369dcd989cbSTejun Heo 	unsigned int cpu;
3370dcd989cbSTejun Heo 
3371f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3372dcd989cbSTejun Heo 
3373dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3374dcd989cbSTejun Heo 
3375dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3376dcd989cbSTejun Heo 
3377f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3378*35b6bb63STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3379*35b6bb63STejun Heo 		struct worker_pool *pool = cwq->pool;
3380*35b6bb63STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
3381dcd989cbSTejun Heo 
3382dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3383dcd989cbSTejun Heo 
338458a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3385*35b6bb63STejun Heo 		    !(pool->flags & POOL_FREEZING))
3386*35b6bb63STejun Heo 			cwq_set_max_active(cwq, max_active);
3387dcd989cbSTejun Heo 
3388dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3389dcd989cbSTejun Heo 	}
3390dcd989cbSTejun Heo 
3391dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3392dcd989cbSTejun Heo }
3393dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3394dcd989cbSTejun Heo 
3395dcd989cbSTejun Heo /**
3396dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3397dcd989cbSTejun Heo  * @cpu: CPU in question
3398dcd989cbSTejun Heo  * @wq: target workqueue
3399dcd989cbSTejun Heo  *
3400dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3401dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3402dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3403dcd989cbSTejun Heo  *
3404dcd989cbSTejun Heo  * RETURNS:
3405dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3406dcd989cbSTejun Heo  */
3407dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3408dcd989cbSTejun Heo {
3409dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3410dcd989cbSTejun Heo 
3411dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3412dcd989cbSTejun Heo }
3413dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3414dcd989cbSTejun Heo 
3415dcd989cbSTejun Heo /**
3416dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3417dcd989cbSTejun Heo  * @work: the work of interest
3418dcd989cbSTejun Heo  *
3419dcd989cbSTejun Heo  * RETURNS:
3420bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3421dcd989cbSTejun Heo  */
3422e2905b29STejun Heo static unsigned int work_cpu(struct work_struct *work)
3423dcd989cbSTejun Heo {
3424dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3425dcd989cbSTejun Heo 
3426bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3427dcd989cbSTejun Heo }
3428dcd989cbSTejun Heo 
3429dcd989cbSTejun Heo /**
3430dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3431dcd989cbSTejun Heo  * @work: the work to be tested
3432dcd989cbSTejun Heo  *
3433dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3434dcd989cbSTejun Heo  * synchronization around this function and the test result is
3435dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3436dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3437dcd989cbSTejun Heo  * running state.
3438dcd989cbSTejun Heo  *
3439dcd989cbSTejun Heo  * RETURNS:
3440dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3441dcd989cbSTejun Heo  */
3442dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3443dcd989cbSTejun Heo {
3444dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3445dcd989cbSTejun Heo 	unsigned long flags;
3446dcd989cbSTejun Heo 	unsigned int ret = 0;
3447dcd989cbSTejun Heo 
3448dcd989cbSTejun Heo 	if (!gcwq)
3449999767beSJoonsoo Kim 		return 0;
3450dcd989cbSTejun Heo 
3451dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3452dcd989cbSTejun Heo 
3453dcd989cbSTejun Heo 	if (work_pending(work))
3454dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3455dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3456dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3457dcd989cbSTejun Heo 
3458dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3459dcd989cbSTejun Heo 
3460dcd989cbSTejun Heo 	return ret;
3461dcd989cbSTejun Heo }
3462dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3463dcd989cbSTejun Heo 
3464db7bccf4STejun Heo /*
3465db7bccf4STejun Heo  * CPU hotplug.
3466db7bccf4STejun Heo  *
3467e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3468e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3469e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3470e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3471e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3472e22bee78STejun Heo  * blocked draining impractical.
3473e22bee78STejun Heo  *
347424647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
3475628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
3476628c78e7STejun Heo  * cpu comes back online.
3477db7bccf4STejun Heo  */
3478db7bccf4STejun Heo 
347960373152STejun Heo /* claim manager positions of all pools */
3480b2eb83d1SLai Jiangshan static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
348160373152STejun Heo {
348260373152STejun Heo 	struct worker_pool *pool;
348360373152STejun Heo 
348460373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3485b2eb83d1SLai Jiangshan 		mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
34868db25e78STejun Heo 	spin_lock_irq(&gcwq->lock);
348760373152STejun Heo }
348860373152STejun Heo 
348960373152STejun Heo /* release manager positions */
3490b2eb83d1SLai Jiangshan static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
349160373152STejun Heo {
349260373152STejun Heo 	struct worker_pool *pool;
349360373152STejun Heo 
34948db25e78STejun Heo 	spin_unlock_irq(&gcwq->lock);
349560373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3496b2eb83d1SLai Jiangshan 		mutex_unlock(&pool->assoc_mutex);
349760373152STejun Heo }
349860373152STejun Heo 
3499628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work)
3500db7bccf4STejun Heo {
3501628c78e7STejun Heo 	struct global_cwq *gcwq = get_gcwq(smp_processor_id());
35024ce62e9eSTejun Heo 	struct worker_pool *pool;
3503db7bccf4STejun Heo 	struct worker *worker;
3504db7bccf4STejun Heo 	struct hlist_node *pos;
3505db7bccf4STejun Heo 	int i;
3506db7bccf4STejun Heo 
3507db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3508db7bccf4STejun Heo 
3509b2eb83d1SLai Jiangshan 	gcwq_claim_assoc_and_lock(gcwq);
3510e22bee78STejun Heo 
3511f2d5a0eeSTejun Heo 	/*
3512f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3513f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3514f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3515f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3516f2d5a0eeSTejun Heo 	 */
351760373152STejun Heo 	for_each_worker_pool(pool, gcwq)
35184ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3519403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3520db7bccf4STejun Heo 
3521db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3522403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3523db7bccf4STejun Heo 
352424647570STejun Heo 	for_each_worker_pool(pool, gcwq)
352524647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
3526f2d5a0eeSTejun Heo 
3527b2eb83d1SLai Jiangshan 	gcwq_release_assoc_and_unlock(gcwq);
3528e22bee78STejun Heo 
3529e22bee78STejun Heo 	/*
3530628c78e7STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3531628c78e7STejun Heo 	 * sched callbacks see the %WORKER_UNBOUND flag.  This is necessary
3532628c78e7STejun Heo 	 * as scheduler callbacks may be invoked from other cpus.
3533628c78e7STejun Heo 	 */
3534628c78e7STejun Heo 	schedule();
3535628c78e7STejun Heo 
3536628c78e7STejun Heo 	/*
3537628c78e7STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After this,
3538628c78e7STejun Heo 	 * nr_running stays zero and need_more_worker() and keep_working()
3539628c78e7STejun Heo 	 * are always true as long as the worklist is not empty.  @gcwq now
3540628c78e7STejun Heo 	 * behaves as unbound (in terms of concurrency management) gcwq
3541628c78e7STejun Heo 	 * which is served by workers tied to the CPU.
3542628c78e7STejun Heo 	 *
3543628c78e7STejun Heo 	 * On return from this function, the current worker would trigger
3544628c78e7STejun Heo 	 * unbound chain execution of pending work items if other workers
3545628c78e7STejun Heo 	 * didn't already.
3546e22bee78STejun Heo 	 */
35474ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35484ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3549db7bccf4STejun Heo }
3550db7bccf4STejun Heo 
35518db25e78STejun Heo /*
35528db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
35538db25e78STejun Heo  * This will be registered high priority CPU notifier.
35548db25e78STejun Heo  */
35559fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
35561da177e4SLinus Torvalds 					       unsigned long action,
35571da177e4SLinus Torvalds 					       void *hcpu)
35581da177e4SLinus Torvalds {
35593af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3560db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
35614ce62e9eSTejun Heo 	struct worker_pool *pool;
35621da177e4SLinus Torvalds 
35638db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
35643af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35654ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35663ce63377STejun Heo 			struct worker *worker;
35673ce63377STejun Heo 
35683ce63377STejun Heo 			if (pool->nr_workers)
35693ce63377STejun Heo 				continue;
35703ce63377STejun Heo 
35713ce63377STejun Heo 			worker = create_worker(pool);
35723ce63377STejun Heo 			if (!worker)
35733ce63377STejun Heo 				return NOTIFY_BAD;
35743ce63377STejun Heo 
35753ce63377STejun Heo 			spin_lock_irq(&gcwq->lock);
35763ce63377STejun Heo 			start_worker(worker);
35773ce63377STejun Heo 			spin_unlock_irq(&gcwq->lock);
35783af24433SOleg Nesterov 		}
35791da177e4SLinus Torvalds 		break;
35801da177e4SLinus Torvalds 
358165758202STejun Heo 	case CPU_DOWN_FAILED:
358265758202STejun Heo 	case CPU_ONLINE:
3583b2eb83d1SLai Jiangshan 		gcwq_claim_assoc_and_lock(gcwq);
358424647570STejun Heo 		for_each_worker_pool(pool, gcwq)
358524647570STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
35868db25e78STejun Heo 		rebind_workers(gcwq);
3587b2eb83d1SLai Jiangshan 		gcwq_release_assoc_and_unlock(gcwq);
35888db25e78STejun Heo 		break;
358965758202STejun Heo 	}
359065758202STejun Heo 	return NOTIFY_OK;
359165758202STejun Heo }
359265758202STejun Heo 
359365758202STejun Heo /*
359465758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
359565758202STejun Heo  * This will be registered as low priority CPU notifier.
359665758202STejun Heo  */
35979fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
359865758202STejun Heo 						 unsigned long action,
359965758202STejun Heo 						 void *hcpu)
360065758202STejun Heo {
36018db25e78STejun Heo 	unsigned int cpu = (unsigned long)hcpu;
36028db25e78STejun Heo 	struct work_struct unbind_work;
36038db25e78STejun Heo 
360465758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
360565758202STejun Heo 	case CPU_DOWN_PREPARE:
36068db25e78STejun Heo 		/* unbinding should happen on the local CPU */
36078db25e78STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
36087635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
36098db25e78STejun Heo 		flush_work(&unbind_work);
36108db25e78STejun Heo 		break;
361165758202STejun Heo 	}
361265758202STejun Heo 	return NOTIFY_OK;
361365758202STejun Heo }
361465758202STejun Heo 
36152d3854a3SRusty Russell #ifdef CONFIG_SMP
36168ccad40dSRusty Russell 
36172d3854a3SRusty Russell struct work_for_cpu {
3618ed48ece2STejun Heo 	struct work_struct work;
36192d3854a3SRusty Russell 	long (*fn)(void *);
36202d3854a3SRusty Russell 	void *arg;
36212d3854a3SRusty Russell 	long ret;
36222d3854a3SRusty Russell };
36232d3854a3SRusty Russell 
3624ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
36252d3854a3SRusty Russell {
3626ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3627ed48ece2STejun Heo 
36282d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36292d3854a3SRusty Russell }
36302d3854a3SRusty Russell 
36312d3854a3SRusty Russell /**
36322d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36332d3854a3SRusty Russell  * @cpu: the cpu to run on
36342d3854a3SRusty Russell  * @fn: the function to run
36352d3854a3SRusty Russell  * @arg: the function arg
36362d3854a3SRusty Russell  *
363731ad9081SRusty Russell  * This will return the value @fn returns.
363831ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36396b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36402d3854a3SRusty Russell  */
36412d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36422d3854a3SRusty Russell {
3643ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
36442d3854a3SRusty Russell 
3645ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3646ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
3647ed48ece2STejun Heo 	flush_work(&wfc.work);
36482d3854a3SRusty Russell 	return wfc.ret;
36492d3854a3SRusty Russell }
36502d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36512d3854a3SRusty Russell #endif /* CONFIG_SMP */
36522d3854a3SRusty Russell 
3653a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3654e7577c50SRusty Russell 
3655a0a1a5fdSTejun Heo /**
3656a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3657a0a1a5fdSTejun Heo  *
365858a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
365958a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
366058a69cb4STejun Heo  * gcwq->worklist.
3661a0a1a5fdSTejun Heo  *
3662a0a1a5fdSTejun Heo  * CONTEXT:
36638b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3664a0a1a5fdSTejun Heo  */
3665a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3666a0a1a5fdSTejun Heo {
3667a0a1a5fdSTejun Heo 	unsigned int cpu;
3668a0a1a5fdSTejun Heo 
3669a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3670a0a1a5fdSTejun Heo 
3671a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3672a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3673a0a1a5fdSTejun Heo 
3674f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
36758b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3676*35b6bb63STejun Heo 		struct worker_pool *pool;
3677bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
36788b03ae3cSTejun Heo 
36798b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
36808b03ae3cSTejun Heo 
3681*35b6bb63STejun Heo 		for_each_worker_pool(pool, gcwq) {
3682*35b6bb63STejun Heo 			WARN_ON_ONCE(pool->flags & POOL_FREEZING);
3683*35b6bb63STejun Heo 			pool->flags |= POOL_FREEZING;
3684*35b6bb63STejun Heo 		}
3685db7bccf4STejun Heo 
3686a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3687a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3688a0a1a5fdSTejun Heo 
368958a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3690a0a1a5fdSTejun Heo 				cwq->max_active = 0;
36911da177e4SLinus Torvalds 		}
36928b03ae3cSTejun Heo 
36938b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3694a0a1a5fdSTejun Heo 	}
3695a0a1a5fdSTejun Heo 
3696a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3697a0a1a5fdSTejun Heo }
3698a0a1a5fdSTejun Heo 
3699a0a1a5fdSTejun Heo /**
370058a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3701a0a1a5fdSTejun Heo  *
3702a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3703a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3704a0a1a5fdSTejun Heo  *
3705a0a1a5fdSTejun Heo  * CONTEXT:
3706a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3707a0a1a5fdSTejun Heo  *
3708a0a1a5fdSTejun Heo  * RETURNS:
370958a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
371058a69cb4STejun Heo  * is complete.
3711a0a1a5fdSTejun Heo  */
3712a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3713a0a1a5fdSTejun Heo {
3714a0a1a5fdSTejun Heo 	unsigned int cpu;
3715a0a1a5fdSTejun Heo 	bool busy = false;
3716a0a1a5fdSTejun Heo 
3717a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3718a0a1a5fdSTejun Heo 
3719a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3720a0a1a5fdSTejun Heo 
3721f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3722bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3723a0a1a5fdSTejun Heo 		/*
3724a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3725a0a1a5fdSTejun Heo 		 * to peek without lock.
3726a0a1a5fdSTejun Heo 		 */
3727a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3728a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3729a0a1a5fdSTejun Heo 
373058a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3731a0a1a5fdSTejun Heo 				continue;
3732a0a1a5fdSTejun Heo 
3733a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3734a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3735a0a1a5fdSTejun Heo 				busy = true;
3736a0a1a5fdSTejun Heo 				goto out_unlock;
3737a0a1a5fdSTejun Heo 			}
3738a0a1a5fdSTejun Heo 		}
3739a0a1a5fdSTejun Heo 	}
3740a0a1a5fdSTejun Heo out_unlock:
3741a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3742a0a1a5fdSTejun Heo 	return busy;
3743a0a1a5fdSTejun Heo }
3744a0a1a5fdSTejun Heo 
3745a0a1a5fdSTejun Heo /**
3746a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3747a0a1a5fdSTejun Heo  *
3748a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
37497e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3750a0a1a5fdSTejun Heo  *
3751a0a1a5fdSTejun Heo  * CONTEXT:
37528b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3753a0a1a5fdSTejun Heo  */
3754a0a1a5fdSTejun Heo void thaw_workqueues(void)
3755a0a1a5fdSTejun Heo {
3756a0a1a5fdSTejun Heo 	unsigned int cpu;
3757a0a1a5fdSTejun Heo 
3758a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3759a0a1a5fdSTejun Heo 
3760a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3761a0a1a5fdSTejun Heo 		goto out_unlock;
3762a0a1a5fdSTejun Heo 
3763f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37648b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
37654ce62e9eSTejun Heo 		struct worker_pool *pool;
3766bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37678b03ae3cSTejun Heo 
37688b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37698b03ae3cSTejun Heo 
3770*35b6bb63STejun Heo 		for_each_worker_pool(pool, gcwq) {
3771*35b6bb63STejun Heo 			WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
3772*35b6bb63STejun Heo 			pool->flags &= ~POOL_FREEZING;
3773*35b6bb63STejun Heo 		}
3774db7bccf4STejun Heo 
3775a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3776a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3777a0a1a5fdSTejun Heo 
377858a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3779a0a1a5fdSTejun Heo 				continue;
3780a0a1a5fdSTejun Heo 
3781a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
37829f4bd4cdSLai Jiangshan 			cwq_set_max_active(cwq, wq->saved_max_active);
3783a0a1a5fdSTejun Heo 		}
37848b03ae3cSTejun Heo 
37854ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
37864ce62e9eSTejun Heo 			wake_up_worker(pool);
3787e22bee78STejun Heo 
37888b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3789a0a1a5fdSTejun Heo 	}
3790a0a1a5fdSTejun Heo 
3791a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3792a0a1a5fdSTejun Heo out_unlock:
3793a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3794a0a1a5fdSTejun Heo }
3795a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3796a0a1a5fdSTejun Heo 
37976ee0578bSSuresh Siddha static int __init init_workqueues(void)
37981da177e4SLinus Torvalds {
3799c34056a3STejun Heo 	unsigned int cpu;
3800c34056a3STejun Heo 
3801b5490077STejun Heo 	/* make sure we have enough bits for OFFQ CPU number */
3802b5490077STejun Heo 	BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3803b5490077STejun Heo 		     WORK_CPU_LAST);
3804b5490077STejun Heo 
380565758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3806a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
38078b03ae3cSTejun Heo 
38088b03ae3cSTejun Heo 	/* initialize gcwqs */
3809f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38108b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38114ce62e9eSTejun Heo 		struct worker_pool *pool;
38128b03ae3cSTejun Heo 
38138b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
38148b03ae3cSTejun Heo 		gcwq->cpu = cpu;
38158b03ae3cSTejun Heo 
381642f8570fSSasha Levin 		hash_init(gcwq->busy_hash);
3817c8e55f36STejun Heo 
38184ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38194ce62e9eSTejun Heo 			pool->gcwq = gcwq;
382024647570STejun Heo 			pool->flags |= POOL_DISASSOCIATED;
38214ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38224ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3823e22bee78STejun Heo 
38244ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38254ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38264ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3827e22bee78STejun Heo 
38284ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38294ce62e9eSTejun Heo 				    (unsigned long)pool);
38304ce62e9eSTejun Heo 
3831b2eb83d1SLai Jiangshan 			mutex_init(&pool->assoc_mutex);
38324ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38334ce62e9eSTejun Heo 		}
38348b03ae3cSTejun Heo 	}
38358b03ae3cSTejun Heo 
3836e22bee78STejun Heo 	/* create the initial worker */
3837f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3838e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38394ce62e9eSTejun Heo 		struct worker_pool *pool;
3840e22bee78STejun Heo 
38414ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38424ce62e9eSTejun Heo 			struct worker *worker;
38434ce62e9eSTejun Heo 
384424647570STejun Heo 			if (cpu != WORK_CPU_UNBOUND)
384524647570STejun Heo 				pool->flags &= ~POOL_DISASSOCIATED;
384624647570STejun Heo 
3847bc2ae0f5STejun Heo 			worker = create_worker(pool);
3848e22bee78STejun Heo 			BUG_ON(!worker);
3849e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3850e22bee78STejun Heo 			start_worker(worker);
3851e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3852e22bee78STejun Heo 		}
38534ce62e9eSTejun Heo 	}
3854e22bee78STejun Heo 
3855d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
38561aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
3857d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3858f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3859f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
386024d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
386124d51addSTejun Heo 					      WQ_FREEZABLE, 0);
38621aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
3863ae930e0fSTejun Heo 	       !system_unbound_wq || !system_freezable_wq);
38646ee0578bSSuresh Siddha 	return 0;
38651da177e4SLinus Torvalds }
38666ee0578bSSuresh Siddha early_initcall(init_workqueues);
3867