xref: /linux-6.15/kernel/workqueue.c (revision 24647570)
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 	/*
50bc2ae0f5STejun Heo 	 * global_cwq flags
51*24647570STejun Heo 	 */
52*24647570STejun Heo 	GCWQ_FREEZING		= 1 << 1,	/* freeze in progress */
53*24647570STejun Heo 
54*24647570STejun Heo 	/*
55*24647570STejun Heo 	 * worker_pool flags
56bc2ae0f5STejun Heo 	 *
57*24647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
58bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
59bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
60bc2ae0f5STejun Heo 	 * is in effect.
61bc2ae0f5STejun Heo 	 *
62bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
63bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
64*24647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
65bc2ae0f5STejun Heo 	 *
66bc2ae0f5STejun Heo 	 * Note that DISASSOCIATED can be flipped only while holding
67*24647570STejun Heo 	 * assoc_mutex to avoid changing binding state while
68*24647570STejun Heo 	 * create_worker() is in progress.
69bc2ae0f5STejun Heo 	 */
7011ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
71552a37e9SLai Jiangshan 	POOL_MANAGING_WORKERS   = 1 << 1,       /* managing workers */
72*24647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
73db7bccf4STejun Heo 
74c8e55f36STejun Heo 	/* worker flags */
75c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
76c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
77c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
78e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
79fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
80f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
81e22bee78STejun Heo 
825f7dabfdSLai Jiangshan 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_UNBOUND |
83403c821dSTejun Heo 				  WORKER_CPU_INTENSIVE,
84db7bccf4STejun Heo 
85e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
864ce62e9eSTejun Heo 
87c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
88db7bccf4STejun Heo 
89e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
90e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
91e22bee78STejun Heo 
923233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
933233cdbdSTejun Heo 						/* call for help after 10ms
943233cdbdSTejun Heo 						   (min two ticks) */
95e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
96e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
971da177e4SLinus Torvalds 
981da177e4SLinus Torvalds 	/*
99e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
100e22bee78STejun Heo 	 * all cpus.  Give -20.
101e22bee78STejun Heo 	 */
102e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
1033270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
104c8e55f36STejun Heo };
105c8e55f36STejun Heo 
1061da177e4SLinus Torvalds /*
1074690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1084690c4abSTejun Heo  *
109e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
110e41e704bSTejun Heo  *    everyone else.
1114690c4abSTejun Heo  *
112e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
113e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
114e22bee78STejun Heo  *
1158b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1164690c4abSTejun Heo  *
117e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
118e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
119e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
120*24647570STejun Heo  *    If POOL_DISASSOCIATED is set, it's identical to L.
121e22bee78STejun Heo  *
12273f53c4aSTejun Heo  * F: wq->flush_mutex protected.
12373f53c4aSTejun Heo  *
1244690c4abSTejun Heo  * W: workqueue_lock protected.
1254690c4abSTejun Heo  */
1264690c4abSTejun Heo 
1272eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
128c34056a3STejun Heo 
129bd7bdd43STejun Heo struct worker_pool {
130bd7bdd43STejun Heo 	struct global_cwq	*gcwq;		/* I: the owning gcwq */
13111ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
132bd7bdd43STejun Heo 
133bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
134bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
135ea1abd61SLai Jiangshan 
136ea1abd61SLai Jiangshan 	/* nr_idle includes the ones off idle_list for rebinding */
137bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
138bd7bdd43STejun Heo 
139bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
140bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
141bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
142bd7bdd43STejun Heo 
143*24647570STejun Heo 	struct mutex		assoc_mutex;	/* protect POOL_DISASSOCIATED */
144bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
145bd7bdd43STejun Heo };
146bd7bdd43STejun Heo 
1474690c4abSTejun Heo /*
148e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
149e22bee78STejun Heo  * and all works are queued and processed here regardless of their
150e22bee78STejun Heo  * target workqueues.
1518b03ae3cSTejun Heo  */
1528b03ae3cSTejun Heo struct global_cwq {
1538b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1548b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
155db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
156c8e55f36STejun Heo 
157bd7bdd43STejun Heo 	/* workers are chained either in busy_hash or pool idle_list */
15842f8570fSSasha Levin 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
159c8e55f36STejun Heo 						/* L: hash of busy workers */
160c8e55f36STejun Heo 
161e34cdddbSTejun Heo 	struct worker_pool	pools[NR_STD_WORKER_POOLS];
162330dad5bSJoonsoo Kim 						/* normal and highpri pools */
1638b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1648b03ae3cSTejun Heo 
1658b03ae3cSTejun Heo /*
166502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1670f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1680f900049STejun Heo  * aligned at two's power of the number of flag bits.
1691da177e4SLinus Torvalds  */
1701da177e4SLinus Torvalds struct cpu_workqueue_struct {
171bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1724690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
17373f53c4aSTejun Heo 	int			work_color;	/* L: current color */
17473f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
17573f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
17673f53c4aSTejun Heo 						/* L: nr of in_flight works */
1771e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
178a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
1791e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
1800f900049STejun Heo };
1811da177e4SLinus Torvalds 
1821da177e4SLinus Torvalds /*
18373f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
18473f53c4aSTejun Heo  */
18573f53c4aSTejun Heo struct wq_flusher {
18673f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
18773f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
18873f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
18973f53c4aSTejun Heo };
1901da177e4SLinus Torvalds 
19173f53c4aSTejun Heo /*
192f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
193f2e005aaSTejun Heo  * used to determine whether there's something to be done.
194f2e005aaSTejun Heo  */
195f2e005aaSTejun Heo #ifdef CONFIG_SMP
196f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
197f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
198f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
199f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
200f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2019c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
202f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
203f2e005aaSTejun Heo #else
204f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
205f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
206f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
207f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
208f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
209f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
210f2e005aaSTejun Heo #endif
2111da177e4SLinus Torvalds 
2121da177e4SLinus Torvalds /*
2131da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2141da177e4SLinus Torvalds  * per-CPU workqueues:
2151da177e4SLinus Torvalds  */
2161da177e4SLinus Torvalds struct workqueue_struct {
2179c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
218bdbc5dd7STejun Heo 	union {
219bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
220bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
221bdbc5dd7STejun Heo 		unsigned long				v;
222bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2234690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
22473f53c4aSTejun Heo 
22573f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
22673f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
22773f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
22873f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
22973f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
23073f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
23173f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
23273f53c4aSTejun Heo 
233f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
234e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
235e22bee78STejun Heo 
2369c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
237dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2384e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2394e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2404e6045f1SJohannes Berg #endif
241b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2421da177e4SLinus Torvalds };
2431da177e4SLinus Torvalds 
244d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
245d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
246044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
2471aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
248044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
249d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
250044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
251f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
252044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
25324d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
254d320c038STejun Heo 
25597bd2347STejun Heo #define CREATE_TRACE_POINTS
25697bd2347STejun Heo #include <trace/events/workqueue.h>
25797bd2347STejun Heo 
2584ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
2593270476aSTejun Heo 	for ((pool) = &(gcwq)->pools[0];				\
260e34cdddbSTejun Heo 	     (pool) < &(gcwq)->pools[NR_STD_WORKER_POOLS]; (pool)++)
2614ce62e9eSTejun Heo 
262db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
26342f8570fSSasha Levin 	hash_for_each(gcwq->busy_hash, i, pos, worker, hentry)
264db7bccf4STejun Heo 
265f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
266f3421797STejun Heo 				  unsigned int sw)
267f3421797STejun Heo {
268f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
269f3421797STejun Heo 		if (sw & 1) {
270f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
271f3421797STejun Heo 			if (cpu < nr_cpu_ids)
272f3421797STejun Heo 				return cpu;
273f3421797STejun Heo 		}
274f3421797STejun Heo 		if (sw & 2)
275f3421797STejun Heo 			return WORK_CPU_UNBOUND;
276f3421797STejun Heo 	}
277f3421797STejun Heo 	return WORK_CPU_NONE;
278f3421797STejun Heo }
279f3421797STejun Heo 
280f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
281f3421797STejun Heo 				struct workqueue_struct *wq)
282f3421797STejun Heo {
283f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
284f3421797STejun Heo }
285f3421797STejun Heo 
28609884951STejun Heo /*
28709884951STejun Heo  * CPU iterators
28809884951STejun Heo  *
28909884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
29009884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
29109884951STejun Heo  * specific CPU.  The following iterators are similar to
29209884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
29309884951STejun Heo  *
29409884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
29509884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
29609884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
29709884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
29809884951STejun Heo  */
299f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
300f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
301f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
302f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
303f3421797STejun Heo 
304f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
305f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
306f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
307f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
308f3421797STejun Heo 
309f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
310f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
311f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
312f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
313f3421797STejun Heo 
314dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
315dc186ad7SThomas Gleixner 
316dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
317dc186ad7SThomas Gleixner 
31899777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
31999777288SStanislaw Gruszka {
32099777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
32199777288SStanislaw Gruszka }
32299777288SStanislaw Gruszka 
323dc186ad7SThomas Gleixner /*
324dc186ad7SThomas Gleixner  * fixup_init is called when:
325dc186ad7SThomas Gleixner  * - an active object is initialized
326dc186ad7SThomas Gleixner  */
327dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
328dc186ad7SThomas Gleixner {
329dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
330dc186ad7SThomas Gleixner 
331dc186ad7SThomas Gleixner 	switch (state) {
332dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
333dc186ad7SThomas Gleixner 		cancel_work_sync(work);
334dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
335dc186ad7SThomas Gleixner 		return 1;
336dc186ad7SThomas Gleixner 	default:
337dc186ad7SThomas Gleixner 		return 0;
338dc186ad7SThomas Gleixner 	}
339dc186ad7SThomas Gleixner }
340dc186ad7SThomas Gleixner 
341dc186ad7SThomas Gleixner /*
342dc186ad7SThomas Gleixner  * fixup_activate is called when:
343dc186ad7SThomas Gleixner  * - an active object is activated
344dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
345dc186ad7SThomas Gleixner  */
346dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
347dc186ad7SThomas Gleixner {
348dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
349dc186ad7SThomas Gleixner 
350dc186ad7SThomas Gleixner 	switch (state) {
351dc186ad7SThomas Gleixner 
352dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
353dc186ad7SThomas Gleixner 		/*
354dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
355dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
356dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
357dc186ad7SThomas Gleixner 		 */
35822df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
359dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
360dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
361dc186ad7SThomas Gleixner 			return 0;
362dc186ad7SThomas Gleixner 		}
363dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
364dc186ad7SThomas Gleixner 		return 0;
365dc186ad7SThomas Gleixner 
366dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
367dc186ad7SThomas Gleixner 		WARN_ON(1);
368dc186ad7SThomas Gleixner 
369dc186ad7SThomas Gleixner 	default:
370dc186ad7SThomas Gleixner 		return 0;
371dc186ad7SThomas Gleixner 	}
372dc186ad7SThomas Gleixner }
373dc186ad7SThomas Gleixner 
374dc186ad7SThomas Gleixner /*
375dc186ad7SThomas Gleixner  * fixup_free is called when:
376dc186ad7SThomas Gleixner  * - an active object is freed
377dc186ad7SThomas Gleixner  */
378dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
379dc186ad7SThomas Gleixner {
380dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
381dc186ad7SThomas Gleixner 
382dc186ad7SThomas Gleixner 	switch (state) {
383dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
384dc186ad7SThomas Gleixner 		cancel_work_sync(work);
385dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
386dc186ad7SThomas Gleixner 		return 1;
387dc186ad7SThomas Gleixner 	default:
388dc186ad7SThomas Gleixner 		return 0;
389dc186ad7SThomas Gleixner 	}
390dc186ad7SThomas Gleixner }
391dc186ad7SThomas Gleixner 
392dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
393dc186ad7SThomas Gleixner 	.name		= "work_struct",
39499777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
395dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
396dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
397dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
398dc186ad7SThomas Gleixner };
399dc186ad7SThomas Gleixner 
400dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
401dc186ad7SThomas Gleixner {
402dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
403dc186ad7SThomas Gleixner }
404dc186ad7SThomas Gleixner 
405dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
406dc186ad7SThomas Gleixner {
407dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
408dc186ad7SThomas Gleixner }
409dc186ad7SThomas Gleixner 
410dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
411dc186ad7SThomas Gleixner {
412dc186ad7SThomas Gleixner 	if (onstack)
413dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
414dc186ad7SThomas Gleixner 	else
415dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
416dc186ad7SThomas Gleixner }
417dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
418dc186ad7SThomas Gleixner 
419dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
420dc186ad7SThomas Gleixner {
421dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
422dc186ad7SThomas Gleixner }
423dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
424dc186ad7SThomas Gleixner 
425dc186ad7SThomas Gleixner #else
426dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
427dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
428dc186ad7SThomas Gleixner #endif
429dc186ad7SThomas Gleixner 
43095402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
43195402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4321da177e4SLinus Torvalds static LIST_HEAD(workqueues);
433a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4341da177e4SLinus Torvalds 
43514441960SOleg Nesterov /*
436e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
437e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
438e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
43914441960SOleg Nesterov  */
4408b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
441e34cdddbSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_STD_WORKER_POOLS]);
442f756d5e2SNathan Lynch 
443f3421797STejun Heo /*
444*24647570STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The pools
445*24647570STejun Heo  * for online CPUs have POOL_DISASSOCIATED set, and all their workers have
446*24647570STejun Heo  * WORKER_UNBOUND set.
447f3421797STejun Heo  */
448f3421797STejun Heo static struct global_cwq unbound_global_cwq;
449e34cdddbSTejun Heo static atomic_t unbound_pool_nr_running[NR_STD_WORKER_POOLS] = {
450e34cdddbSTejun Heo 	[0 ... NR_STD_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4514ce62e9eSTejun Heo };
452f3421797STejun Heo 
453c34056a3STejun Heo static int worker_thread(void *__worker);
454e2905b29STejun Heo static unsigned int work_cpu(struct work_struct *work);
4551da177e4SLinus Torvalds 
456e34cdddbSTejun Heo static int std_worker_pool_pri(struct worker_pool *pool)
4573270476aSTejun Heo {
4583270476aSTejun Heo 	return pool - pool->gcwq->pools;
4593270476aSTejun Heo }
4603270476aSTejun Heo 
4618b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4621da177e4SLinus Torvalds {
463f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4648b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
465f3421797STejun Heo 	else
466f3421797STejun Heo 		return &unbound_global_cwq;
4671da177e4SLinus Torvalds }
4681da177e4SLinus Torvalds 
46963d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
470b1f4ec17SOleg Nesterov {
47163d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
472e34cdddbSTejun Heo 	int idx = std_worker_pool_pri(pool);
47363d95a91STejun Heo 
474f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4754ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
476f3421797STejun Heo 	else
4774ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
478b1f4ec17SOleg Nesterov }
479b1f4ec17SOleg Nesterov 
4804690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
4814690c4abSTejun Heo 					    struct workqueue_struct *wq)
482a848e3b6SOleg Nesterov {
483f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
484e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
485bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
486f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
487f3421797STejun Heo 		return wq->cpu_wq.single;
488f3421797STejun Heo 	return NULL;
489f3421797STejun Heo }
490a848e3b6SOleg Nesterov 
49173f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
49273f53c4aSTejun Heo {
49373f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
49473f53c4aSTejun Heo }
49573f53c4aSTejun Heo 
49673f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
49773f53c4aSTejun Heo {
49873f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
49973f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
50073f53c4aSTejun Heo }
50173f53c4aSTejun Heo 
50273f53c4aSTejun Heo static int work_next_color(int color)
50373f53c4aSTejun Heo {
50473f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5051da177e4SLinus Torvalds }
5061da177e4SLinus Torvalds 
5074594bf15SDavid Howells /*
508b5490077STejun Heo  * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
509b5490077STejun Heo  * contain the pointer to the queued cwq.  Once execution starts, the flag
510b5490077STejun Heo  * is cleared and the high bits contain OFFQ flags and CPU number.
5117a22ad75STejun Heo  *
512bbb68dfaSTejun Heo  * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
513bbb68dfaSTejun Heo  * and clear_work_data() can be used to set the cwq, cpu or clear
514bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
515bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5167a22ad75STejun Heo  *
517bbb68dfaSTejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
518bbb68dfaSTejun Heo  * a work.  gcwq is available once the work has been queued anywhere after
519bbb68dfaSTejun Heo  * initialization until it is sync canceled.  cwq is available only while
520bbb68dfaSTejun Heo  * the work item is queued.
521bbb68dfaSTejun Heo  *
522bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
523bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
524bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
525bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5264594bf15SDavid Howells  */
5277a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5287a22ad75STejun Heo 				 unsigned long flags)
5297a22ad75STejun Heo {
5307a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5317a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5327a22ad75STejun Heo }
5337a22ad75STejun Heo 
5347a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5354690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5364690c4abSTejun Heo 			 unsigned long extra_flags)
537365970a1SDavid Howells {
5387a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
539e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
540365970a1SDavid Howells }
541365970a1SDavid Howells 
5428930cabaSTejun Heo static void set_work_cpu_and_clear_pending(struct work_struct *work,
5438930cabaSTejun Heo 					   unsigned int cpu)
5444d707b9fSOleg Nesterov {
54523657bb1STejun Heo 	/*
54623657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
54723657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
54823657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
54923657bb1STejun Heo 	 * owner.
55023657bb1STejun Heo 	 */
55123657bb1STejun Heo 	smp_wmb();
552b5490077STejun Heo 	set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
5534d707b9fSOleg Nesterov }
5544d707b9fSOleg Nesterov 
5557a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
556365970a1SDavid Howells {
55723657bb1STejun Heo 	smp_wmb();	/* see set_work_cpu_and_clear_pending() */
5587a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5597a22ad75STejun Heo }
5607a22ad75STejun Heo 
5617a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5627a22ad75STejun Heo {
563e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5647a22ad75STejun Heo 
565e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
566e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
567e120153dSTejun Heo 	else
568e120153dSTejun Heo 		return NULL;
5697a22ad75STejun Heo }
5707a22ad75STejun Heo 
5717a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5727a22ad75STejun Heo {
573e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5747a22ad75STejun Heo 	unsigned int cpu;
5757a22ad75STejun Heo 
576e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
577e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
578bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
5797a22ad75STejun Heo 
580b5490077STejun Heo 	cpu = data >> WORK_OFFQ_CPU_SHIFT;
581bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
5827a22ad75STejun Heo 		return NULL;
5837a22ad75STejun Heo 
584f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
5857a22ad75STejun Heo 	return get_gcwq(cpu);
586365970a1SDavid Howells }
587365970a1SDavid Howells 
588bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
589bbb68dfaSTejun Heo {
590bbb68dfaSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
591bbb68dfaSTejun Heo 	unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
592bbb68dfaSTejun Heo 
593bbb68dfaSTejun Heo 	set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
594bbb68dfaSTejun Heo 		      WORK_STRUCT_PENDING);
595bbb68dfaSTejun Heo }
596bbb68dfaSTejun Heo 
597bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
598bbb68dfaSTejun Heo {
599bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
600bbb68dfaSTejun Heo 
601bbb68dfaSTejun Heo 	return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
602bbb68dfaSTejun Heo }
603bbb68dfaSTejun Heo 
604e22bee78STejun Heo /*
6053270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
6063270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
6073270476aSTejun Heo  * they're being called with gcwq->lock held.
608e22bee78STejun Heo  */
609e22bee78STejun Heo 
61063d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
611649027d7STejun Heo {
6123270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
613649027d7STejun Heo }
614649027d7STejun Heo 
615e22bee78STejun Heo /*
616e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
617e22bee78STejun Heo  * running workers.
618974271c4STejun Heo  *
619974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
620974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
621974271c4STejun Heo  * worklist isn't empty.
622e22bee78STejun Heo  */
62363d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
624e22bee78STejun Heo {
62563d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
626e22bee78STejun Heo }
627e22bee78STejun Heo 
628e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
62963d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
630e22bee78STejun Heo {
63163d95a91STejun Heo 	return pool->nr_idle;
632e22bee78STejun Heo }
633e22bee78STejun Heo 
634e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
63563d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
636e22bee78STejun Heo {
63763d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
638e22bee78STejun Heo 
6393270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
640e22bee78STejun Heo }
641e22bee78STejun Heo 
642e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
64363d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
644e22bee78STejun Heo {
64563d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
646e22bee78STejun Heo }
647e22bee78STejun Heo 
648e22bee78STejun Heo /* Do I need to be the manager? */
64963d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
650e22bee78STejun Heo {
65163d95a91STejun Heo 	return need_to_create_worker(pool) ||
65211ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
653e22bee78STejun Heo }
654e22bee78STejun Heo 
655e22bee78STejun Heo /* Do we have too many workers and should some go away? */
65663d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
657e22bee78STejun Heo {
658552a37e9SLai Jiangshan 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
65963d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
66063d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
661e22bee78STejun Heo 
662ea1abd61SLai Jiangshan 	/*
663ea1abd61SLai Jiangshan 	 * nr_idle and idle_list may disagree if idle rebinding is in
664ea1abd61SLai Jiangshan 	 * progress.  Never return %true if idle_list is empty.
665ea1abd61SLai Jiangshan 	 */
666ea1abd61SLai Jiangshan 	if (list_empty(&pool->idle_list))
667ea1abd61SLai Jiangshan 		return false;
668ea1abd61SLai Jiangshan 
669e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
670e22bee78STejun Heo }
671e22bee78STejun Heo 
672e22bee78STejun Heo /*
673e22bee78STejun Heo  * Wake up functions.
674e22bee78STejun Heo  */
675e22bee78STejun Heo 
6767e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
67763d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
6787e11629dSTejun Heo {
67963d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
6807e11629dSTejun Heo 		return NULL;
6817e11629dSTejun Heo 
68263d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
6837e11629dSTejun Heo }
6847e11629dSTejun Heo 
6857e11629dSTejun Heo /**
6867e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
68763d95a91STejun Heo  * @pool: worker pool to wake worker from
6887e11629dSTejun Heo  *
68963d95a91STejun Heo  * Wake up the first idle worker of @pool.
6907e11629dSTejun Heo  *
6917e11629dSTejun Heo  * CONTEXT:
6927e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
6937e11629dSTejun Heo  */
69463d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
6957e11629dSTejun Heo {
69663d95a91STejun Heo 	struct worker *worker = first_worker(pool);
6977e11629dSTejun Heo 
6987e11629dSTejun Heo 	if (likely(worker))
6997e11629dSTejun Heo 		wake_up_process(worker->task);
7007e11629dSTejun Heo }
7017e11629dSTejun Heo 
7024690c4abSTejun Heo /**
703e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
704e22bee78STejun Heo  * @task: task waking up
705e22bee78STejun Heo  * @cpu: CPU @task is waking up to
706e22bee78STejun Heo  *
707e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
708e22bee78STejun Heo  * being awoken.
709e22bee78STejun Heo  *
710e22bee78STejun Heo  * CONTEXT:
711e22bee78STejun Heo  * spin_lock_irq(rq->lock)
712e22bee78STejun Heo  */
713e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
714e22bee78STejun Heo {
715e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
716e22bee78STejun Heo 
71736576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
71836576000SJoonsoo Kim 		WARN_ON_ONCE(worker->pool->gcwq->cpu != cpu);
71963d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
720e22bee78STejun Heo 	}
72136576000SJoonsoo Kim }
722e22bee78STejun Heo 
723e22bee78STejun Heo /**
724e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
725e22bee78STejun Heo  * @task: task going to sleep
726e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
727e22bee78STejun Heo  *
728e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
729e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
730e22bee78STejun Heo  * returning pointer to its task.
731e22bee78STejun Heo  *
732e22bee78STejun Heo  * CONTEXT:
733e22bee78STejun Heo  * spin_lock_irq(rq->lock)
734e22bee78STejun Heo  *
735e22bee78STejun Heo  * RETURNS:
736e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
737e22bee78STejun Heo  */
738e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
739e22bee78STejun Heo 				       unsigned int cpu)
740e22bee78STejun Heo {
741e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
742111c225aSTejun Heo 	struct worker_pool *pool;
743111c225aSTejun Heo 	atomic_t *nr_running;
744e22bee78STejun Heo 
745111c225aSTejun Heo 	/*
746111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
747111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
748111c225aSTejun Heo 	 * checking NOT_RUNNING.
749111c225aSTejun Heo 	 */
7502d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
751e22bee78STejun Heo 		return NULL;
752e22bee78STejun Heo 
753111c225aSTejun Heo 	pool = worker->pool;
754111c225aSTejun Heo 	nr_running = get_pool_nr_running(pool);
755111c225aSTejun Heo 
756e22bee78STejun Heo 	/* this can only happen on the local cpu */
757e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
758e22bee78STejun Heo 
759e22bee78STejun Heo 	/*
760e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
761e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
762e22bee78STejun Heo 	 * Please read comment there.
763e22bee78STejun Heo 	 *
764628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
765628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
766628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
767628c78e7STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without gcwq
768628c78e7STejun Heo 	 * lock is safe.
769e22bee78STejun Heo 	 */
770bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
77163d95a91STejun Heo 		to_wakeup = first_worker(pool);
772e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
773e22bee78STejun Heo }
774e22bee78STejun Heo 
775e22bee78STejun Heo /**
776e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
777cb444766STejun Heo  * @worker: self
778d302f017STejun Heo  * @flags: flags to set
779d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
780d302f017STejun Heo  *
781e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
782e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
783e22bee78STejun Heo  * woken up.
784d302f017STejun Heo  *
785cb444766STejun Heo  * CONTEXT:
786cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
787d302f017STejun Heo  */
788d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
789d302f017STejun Heo 				    bool wakeup)
790d302f017STejun Heo {
791bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
792e22bee78STejun Heo 
793cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
794cb444766STejun Heo 
795e22bee78STejun Heo 	/*
796e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
797e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
798e22bee78STejun Heo 	 * @wakeup.
799e22bee78STejun Heo 	 */
800e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
801e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
80263d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
803e22bee78STejun Heo 
804e22bee78STejun Heo 		if (wakeup) {
805e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
806bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
80763d95a91STejun Heo 				wake_up_worker(pool);
808e22bee78STejun Heo 		} else
809e22bee78STejun Heo 			atomic_dec(nr_running);
810e22bee78STejun Heo 	}
811e22bee78STejun Heo 
812d302f017STejun Heo 	worker->flags |= flags;
813d302f017STejun Heo }
814d302f017STejun Heo 
815d302f017STejun Heo /**
816e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
817cb444766STejun Heo  * @worker: self
818d302f017STejun Heo  * @flags: flags to clear
819d302f017STejun Heo  *
820e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
821d302f017STejun Heo  *
822cb444766STejun Heo  * CONTEXT:
823cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
824d302f017STejun Heo  */
825d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
826d302f017STejun Heo {
82763d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
828e22bee78STejun Heo 	unsigned int oflags = worker->flags;
829e22bee78STejun Heo 
830cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
831cb444766STejun Heo 
832d302f017STejun Heo 	worker->flags &= ~flags;
833e22bee78STejun Heo 
83442c025f3STejun Heo 	/*
83542c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
83642c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
83742c025f3STejun Heo 	 * of multiple flags, not a single flag.
83842c025f3STejun Heo 	 */
839e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
840e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
84163d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
842d302f017STejun Heo }
843d302f017STejun Heo 
844d302f017STejun Heo /**
8458cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8468cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8478cca0eeaSTejun Heo  * @work: work to find worker for
8488cca0eeaSTejun Heo  *
849a2c1c57bSTejun Heo  * Find a worker which is executing @work on @gcwq by searching
850a2c1c57bSTejun Heo  * @gcwq->busy_hash which is keyed by the address of @work.  For a worker
851a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
852a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
853a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
854a2c1c57bSTejun Heo  * being executed.
855a2c1c57bSTejun Heo  *
856a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
857a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
858a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
859a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
860a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
861a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
862a2c1c57bSTejun Heo  *
863a2c1c57bSTejun Heo  * This function checks the work item address, work function and workqueue
864a2c1c57bSTejun Heo  * to avoid false positives.  Note that this isn't complete as one may
865a2c1c57bSTejun Heo  * construct a work function which can introduce dependency onto itself
866a2c1c57bSTejun Heo  * through a recycled work item.  Well, if somebody wants to shoot oneself
867a2c1c57bSTejun Heo  * in the foot that badly, there's only so much we can do, and if such
868a2c1c57bSTejun Heo  * deadlock actually occurs, it should be easy to locate the culprit work
869a2c1c57bSTejun Heo  * function.
8708cca0eeaSTejun Heo  *
8718cca0eeaSTejun Heo  * CONTEXT:
8728cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8738cca0eeaSTejun Heo  *
8748cca0eeaSTejun Heo  * RETURNS:
8758cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8768cca0eeaSTejun Heo  * otherwise.
8778cca0eeaSTejun Heo  */
8788cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8798cca0eeaSTejun Heo 						 struct work_struct *work)
8808cca0eeaSTejun Heo {
88142f8570fSSasha Levin 	struct worker *worker;
88242f8570fSSasha Levin 	struct hlist_node *tmp;
88342f8570fSSasha Levin 
884a2c1c57bSTejun Heo 	hash_for_each_possible(gcwq->busy_hash, worker, tmp, hentry,
885a2c1c57bSTejun Heo 			       (unsigned long)work)
886a2c1c57bSTejun Heo 		if (worker->current_work == work &&
887a2c1c57bSTejun Heo 		    worker->current_func == work->func)
88842f8570fSSasha Levin 			return worker;
88942f8570fSSasha Levin 
89042f8570fSSasha Levin 	return NULL;
8918cca0eeaSTejun Heo }
8928cca0eeaSTejun Heo 
8938cca0eeaSTejun Heo /**
894bf4ede01STejun Heo  * move_linked_works - move linked works to a list
895bf4ede01STejun Heo  * @work: start of series of works to be scheduled
896bf4ede01STejun Heo  * @head: target list to append @work to
897bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
898bf4ede01STejun Heo  *
899bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
900bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
901bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
902bf4ede01STejun Heo  *
903bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
904bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
905bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
906bf4ede01STejun Heo  *
907bf4ede01STejun Heo  * CONTEXT:
908bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
909bf4ede01STejun Heo  */
910bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
911bf4ede01STejun Heo 			      struct work_struct **nextp)
912bf4ede01STejun Heo {
913bf4ede01STejun Heo 	struct work_struct *n;
914bf4ede01STejun Heo 
915bf4ede01STejun Heo 	/*
916bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
917bf4ede01STejun Heo 	 * use NULL for list head.
918bf4ede01STejun Heo 	 */
919bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
920bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
921bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
922bf4ede01STejun Heo 			break;
923bf4ede01STejun Heo 	}
924bf4ede01STejun Heo 
925bf4ede01STejun Heo 	/*
926bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
927bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
928bf4ede01STejun Heo 	 * needs to be updated.
929bf4ede01STejun Heo 	 */
930bf4ede01STejun Heo 	if (nextp)
931bf4ede01STejun Heo 		*nextp = n;
932bf4ede01STejun Heo }
933bf4ede01STejun Heo 
9343aa62497SLai Jiangshan static void cwq_activate_delayed_work(struct work_struct *work)
935bf4ede01STejun Heo {
9363aa62497SLai Jiangshan 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
937bf4ede01STejun Heo 
938bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
939bf4ede01STejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
940bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
941bf4ede01STejun Heo 	cwq->nr_active++;
942bf4ede01STejun Heo }
943bf4ede01STejun Heo 
9443aa62497SLai Jiangshan static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
9453aa62497SLai Jiangshan {
9463aa62497SLai Jiangshan 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
9473aa62497SLai Jiangshan 						    struct work_struct, entry);
9483aa62497SLai Jiangshan 
9493aa62497SLai Jiangshan 	cwq_activate_delayed_work(work);
9503aa62497SLai Jiangshan }
9513aa62497SLai Jiangshan 
952bf4ede01STejun Heo /**
953bf4ede01STejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
954bf4ede01STejun Heo  * @cwq: cwq of interest
955bf4ede01STejun Heo  * @color: color of work which left the queue
956bf4ede01STejun Heo  *
957bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
958bf4ede01STejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
959bf4ede01STejun Heo  *
960bf4ede01STejun Heo  * CONTEXT:
961bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
962bf4ede01STejun Heo  */
963b3f9f405SLai Jiangshan static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
964bf4ede01STejun Heo {
965bf4ede01STejun Heo 	/* ignore uncolored works */
966bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
967bf4ede01STejun Heo 		return;
968bf4ede01STejun Heo 
969bf4ede01STejun Heo 	cwq->nr_in_flight[color]--;
970bf4ede01STejun Heo 
971bf4ede01STejun Heo 	cwq->nr_active--;
972bf4ede01STejun Heo 	if (!list_empty(&cwq->delayed_works)) {
973bf4ede01STejun Heo 		/* one down, submit a delayed one */
974bf4ede01STejun Heo 		if (cwq->nr_active < cwq->max_active)
975bf4ede01STejun Heo 			cwq_activate_first_delayed(cwq);
976bf4ede01STejun Heo 	}
977bf4ede01STejun Heo 
978bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
979bf4ede01STejun Heo 	if (likely(cwq->flush_color != color))
980bf4ede01STejun Heo 		return;
981bf4ede01STejun Heo 
982bf4ede01STejun Heo 	/* are there still in-flight works? */
983bf4ede01STejun Heo 	if (cwq->nr_in_flight[color])
984bf4ede01STejun Heo 		return;
985bf4ede01STejun Heo 
986bf4ede01STejun Heo 	/* this cwq is done, clear flush_color */
987bf4ede01STejun Heo 	cwq->flush_color = -1;
988bf4ede01STejun Heo 
989bf4ede01STejun Heo 	/*
990bf4ede01STejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
991bf4ede01STejun Heo 	 * will handle the rest.
992bf4ede01STejun Heo 	 */
993bf4ede01STejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
994bf4ede01STejun Heo 		complete(&cwq->wq->first_flusher->done);
995bf4ede01STejun Heo }
996bf4ede01STejun Heo 
99736e227d2STejun Heo /**
998bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
99936e227d2STejun Heo  * @work: work item to steal
100036e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1001bbb68dfaSTejun Heo  * @flags: place to store irq state
100236e227d2STejun Heo  *
100336e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
100436e227d2STejun Heo  * stable state - idle, on timer or on worklist.  Return values are
100536e227d2STejun Heo  *
100636e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
100736e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
100836e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1009bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1010bbb68dfaSTejun Heo  *		for arbitrarily long
101136e227d2STejun Heo  *
1012bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1013e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1014e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1015e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1016bbb68dfaSTejun Heo  *
1017bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1018bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1019bbb68dfaSTejun Heo  *
1020e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1021bf4ede01STejun Heo  */
1022bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1023bbb68dfaSTejun Heo 			       unsigned long *flags)
1024bf4ede01STejun Heo {
1025bf4ede01STejun Heo 	struct global_cwq *gcwq;
1026bf4ede01STejun Heo 
1027bbb68dfaSTejun Heo 	local_irq_save(*flags);
1028bbb68dfaSTejun Heo 
102936e227d2STejun Heo 	/* try to steal the timer if it exists */
103036e227d2STejun Heo 	if (is_dwork) {
103136e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
103236e227d2STejun Heo 
1033e0aecdd8STejun Heo 		/*
1034e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1035e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1036e0aecdd8STejun Heo 		 * running on the local CPU.
1037e0aecdd8STejun Heo 		 */
103836e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
103936e227d2STejun Heo 			return 1;
104036e227d2STejun Heo 	}
104136e227d2STejun Heo 
104236e227d2STejun Heo 	/* try to claim PENDING the normal way */
1043bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1044bf4ede01STejun Heo 		return 0;
1045bf4ede01STejun Heo 
1046bf4ede01STejun Heo 	/*
1047bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1048bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1049bf4ede01STejun Heo 	 */
1050bf4ede01STejun Heo 	gcwq = get_work_gcwq(work);
1051bf4ede01STejun Heo 	if (!gcwq)
1052bbb68dfaSTejun Heo 		goto fail;
1053bf4ede01STejun Heo 
1054bbb68dfaSTejun Heo 	spin_lock(&gcwq->lock);
1055bf4ede01STejun Heo 	if (!list_empty(&work->entry)) {
1056bf4ede01STejun Heo 		/*
1057bf4ede01STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
1058bf4ede01STejun Heo 		 * In that case we must see the new value after rmb(), see
1059bf4ede01STejun Heo 		 * insert_work()->wmb().
1060bf4ede01STejun Heo 		 */
1061bf4ede01STejun Heo 		smp_rmb();
1062bf4ede01STejun Heo 		if (gcwq == get_work_gcwq(work)) {
1063bf4ede01STejun Heo 			debug_work_deactivate(work);
10643aa62497SLai Jiangshan 
10653aa62497SLai Jiangshan 			/*
10663aa62497SLai Jiangshan 			 * A delayed work item cannot be grabbed directly
10673aa62497SLai Jiangshan 			 * because it might have linked NO_COLOR work items
10683aa62497SLai Jiangshan 			 * which, if left on the delayed_list, will confuse
10693aa62497SLai Jiangshan 			 * cwq->nr_active management later on and cause
10703aa62497SLai Jiangshan 			 * stall.  Make sure the work item is activated
10713aa62497SLai Jiangshan 			 * before grabbing.
10723aa62497SLai Jiangshan 			 */
10733aa62497SLai Jiangshan 			if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
10743aa62497SLai Jiangshan 				cwq_activate_delayed_work(work);
10753aa62497SLai Jiangshan 
1076bf4ede01STejun Heo 			list_del_init(&work->entry);
1077bf4ede01STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
1078b3f9f405SLai Jiangshan 				get_work_color(work));
107936e227d2STejun Heo 
1080bbb68dfaSTejun Heo 			spin_unlock(&gcwq->lock);
108136e227d2STejun Heo 			return 1;
1082bf4ede01STejun Heo 		}
1083bf4ede01STejun Heo 	}
1084bbb68dfaSTejun Heo 	spin_unlock(&gcwq->lock);
1085bbb68dfaSTejun Heo fail:
1086bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1087bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1088bbb68dfaSTejun Heo 		return -ENOENT;
1089bbb68dfaSTejun Heo 	cpu_relax();
109036e227d2STejun Heo 	return -EAGAIN;
1091bf4ede01STejun Heo }
1092bf4ede01STejun Heo 
1093bf4ede01STejun Heo /**
10947e11629dSTejun Heo  * insert_work - insert a work into gcwq
10954690c4abSTejun Heo  * @cwq: cwq @work belongs to
10964690c4abSTejun Heo  * @work: work to insert
10974690c4abSTejun Heo  * @head: insertion point
10984690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
10994690c4abSTejun Heo  *
11007e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
11017e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
11024690c4abSTejun Heo  *
11034690c4abSTejun Heo  * CONTEXT:
11048b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
11051da177e4SLinus Torvalds  */
1106b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
11074690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
11084690c4abSTejun Heo 			unsigned int extra_flags)
1109b89deed3SOleg Nesterov {
111063d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
1111e1d8aa9fSFrederic Weisbecker 
11124690c4abSTejun Heo 	/* we own @work, set data and link */
11137a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
11144690c4abSTejun Heo 
11156e84d644SOleg Nesterov 	/*
11166e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
11176e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
11186e84d644SOleg Nesterov 	 */
11196e84d644SOleg Nesterov 	smp_wmb();
11204690c4abSTejun Heo 
11211a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
1122e22bee78STejun Heo 
1123e22bee78STejun Heo 	/*
1124e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
1125e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
1126e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
1127e22bee78STejun Heo 	 */
1128e22bee78STejun Heo 	smp_mb();
1129e22bee78STejun Heo 
113063d95a91STejun Heo 	if (__need_more_worker(pool))
113163d95a91STejun Heo 		wake_up_worker(pool);
1132b89deed3SOleg Nesterov }
1133b89deed3SOleg Nesterov 
1134c8efcc25STejun Heo /*
1135c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
1136c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
1137c8efcc25STejun Heo  * cold paths.
1138c8efcc25STejun Heo  */
1139c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1140c8efcc25STejun Heo {
1141c8efcc25STejun Heo 	unsigned long flags;
1142c8efcc25STejun Heo 	unsigned int cpu;
1143c8efcc25STejun Heo 
1144c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
1145c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
1146c8efcc25STejun Heo 		struct worker *worker;
1147c8efcc25STejun Heo 		struct hlist_node *pos;
1148c8efcc25STejun Heo 		int i;
1149c8efcc25STejun Heo 
1150c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1151c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
1152c8efcc25STejun Heo 			if (worker->task != current)
1153c8efcc25STejun Heo 				continue;
1154c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
1155c8efcc25STejun Heo 			/*
1156c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
1157c8efcc25STejun Heo 			 * is headed to the same workqueue.
1158c8efcc25STejun Heo 			 */
1159c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
1160c8efcc25STejun Heo 		}
1161c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
1162c8efcc25STejun Heo 	}
1163c8efcc25STejun Heo 	return false;
1164c8efcc25STejun Heo }
1165c8efcc25STejun Heo 
11664690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
11671da177e4SLinus Torvalds 			 struct work_struct *work)
11681da177e4SLinus Torvalds {
1169502ca9d8STejun Heo 	struct global_cwq *gcwq;
1170502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
11711e19ffc6STejun Heo 	struct list_head *worklist;
11728a2e8e5dSTejun Heo 	unsigned int work_flags;
1173b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
11748930cabaSTejun Heo 
11758930cabaSTejun Heo 	/*
11768930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
11778930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
11788930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
11798930cabaSTejun Heo 	 * happen with IRQ disabled.
11808930cabaSTejun Heo 	 */
11818930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
11821da177e4SLinus Torvalds 
1183dc186ad7SThomas Gleixner 	debug_work_activate(work);
11841e19ffc6STejun Heo 
1185c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
11869c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1187c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1188e41e704bSTejun Heo 		return;
1189e41e704bSTejun Heo 
1190c7fc77f7STejun Heo 	/* determine gcwq to use */
1191c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1192c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1193c7fc77f7STejun Heo 
119457469821STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
1195f3421797STejun Heo 			cpu = raw_smp_processor_id();
1196f3421797STejun Heo 
119718aa9effSTejun Heo 		/*
1198dbf2576eSTejun Heo 		 * It's multi cpu.  If @work was previously on a different
1199dbf2576eSTejun Heo 		 * cpu, it might still be running there, in which case the
1200dbf2576eSTejun Heo 		 * work needs to be queued on that cpu to guarantee
1201dbf2576eSTejun Heo 		 * non-reentrancy.
120218aa9effSTejun Heo 		 */
1203502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
1204dbf2576eSTejun Heo 		last_gcwq = get_work_gcwq(work);
1205dbf2576eSTejun Heo 
1206dbf2576eSTejun Heo 		if (last_gcwq && last_gcwq != gcwq) {
120718aa9effSTejun Heo 			struct worker *worker;
120818aa9effSTejun Heo 
12098930cabaSTejun Heo 			spin_lock(&last_gcwq->lock);
121018aa9effSTejun Heo 
121118aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
121218aa9effSTejun Heo 
121318aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
121418aa9effSTejun Heo 				gcwq = last_gcwq;
121518aa9effSTejun Heo 			else {
121618aa9effSTejun Heo 				/* meh... not running there, queue here */
12178930cabaSTejun Heo 				spin_unlock(&last_gcwq->lock);
12188930cabaSTejun Heo 				spin_lock(&gcwq->lock);
121918aa9effSTejun Heo 			}
12208930cabaSTejun Heo 		} else {
12218930cabaSTejun Heo 			spin_lock(&gcwq->lock);
12228930cabaSTejun Heo 		}
1223f3421797STejun Heo 	} else {
1224f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
12258930cabaSTejun Heo 		spin_lock(&gcwq->lock);
1226502ca9d8STejun Heo 	}
1227502ca9d8STejun Heo 
1228502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1229502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1230b75cac93SJoonsoo Kim 	trace_workqueue_queue_work(req_cpu, cwq, work);
1231502ca9d8STejun Heo 
1232f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
12338930cabaSTejun Heo 		spin_unlock(&gcwq->lock);
1234f5b2552bSDan Carpenter 		return;
1235f5b2552bSDan Carpenter 	}
12361e19ffc6STejun Heo 
123773f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
12388a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
12391e19ffc6STejun Heo 
12401e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1241cdadf009STejun Heo 		trace_workqueue_activate_work(work);
12421e19ffc6STejun Heo 		cwq->nr_active++;
12433270476aSTejun Heo 		worklist = &cwq->pool->worklist;
12448a2e8e5dSTejun Heo 	} else {
12458a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
12461e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
12478a2e8e5dSTejun Heo 	}
12481e19ffc6STejun Heo 
12498a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
12501e19ffc6STejun Heo 
12518930cabaSTejun Heo 	spin_unlock(&gcwq->lock);
12521da177e4SLinus Torvalds }
12531da177e4SLinus Torvalds 
12540fcb78c2SRolf Eike Beer /**
1255c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1256c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1257c1a220e7SZhang Rui  * @wq: workqueue to use
1258c1a220e7SZhang Rui  * @work: work to queue
1259c1a220e7SZhang Rui  *
1260d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
1261c1a220e7SZhang Rui  *
1262c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1263c1a220e7SZhang Rui  * can't go away.
1264c1a220e7SZhang Rui  */
1265d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1266d4283e93STejun Heo 		   struct work_struct *work)
1267c1a220e7SZhang Rui {
1268d4283e93STejun Heo 	bool ret = false;
12698930cabaSTejun Heo 	unsigned long flags;
12708930cabaSTejun Heo 
12718930cabaSTejun Heo 	local_irq_save(flags);
1272c1a220e7SZhang Rui 
127322df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
12744690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1275d4283e93STejun Heo 		ret = true;
1276c1a220e7SZhang Rui 	}
12778930cabaSTejun Heo 
12788930cabaSTejun Heo 	local_irq_restore(flags);
1279c1a220e7SZhang Rui 	return ret;
1280c1a220e7SZhang Rui }
1281c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1282c1a220e7SZhang Rui 
12830a13c00eSTejun Heo /**
12840a13c00eSTejun Heo  * queue_work - queue work on a workqueue
12850a13c00eSTejun Heo  * @wq: workqueue to use
12860a13c00eSTejun Heo  * @work: work to queue
12870a13c00eSTejun Heo  *
1288d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
12890a13c00eSTejun Heo  *
12900a13c00eSTejun Heo  * We queue the work to the CPU on which it was submitted, but if the CPU dies
12910a13c00eSTejun Heo  * it can be processed by another CPU.
12920a13c00eSTejun Heo  */
1293d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
12940a13c00eSTejun Heo {
129557469821STejun Heo 	return queue_work_on(WORK_CPU_UNBOUND, wq, work);
12960a13c00eSTejun Heo }
12970a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work);
12980a13c00eSTejun Heo 
1299d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
13001da177e4SLinus Torvalds {
130152bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
13027a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
13031da177e4SLinus Torvalds 
1304e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
13051265057fSTejun Heo 	__queue_work(dwork->cpu, cwq->wq, &dwork->work);
13061da177e4SLinus Torvalds }
1307d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
13081da177e4SLinus Torvalds 
13097beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
131052bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
13111da177e4SLinus Torvalds {
13127beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
13137beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
13147beb2edfSTejun Heo 	unsigned int lcpu;
13151da177e4SLinus Torvalds 
13167beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
13177beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
1318fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1319fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
13207beb2edfSTejun Heo 
13218852aac2STejun Heo 	/*
13228852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
13238852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
13248852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
13258852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
13268852aac2STejun Heo 	 */
13278852aac2STejun Heo 	if (!delay) {
13288852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
13298852aac2STejun Heo 		return;
13308852aac2STejun Heo 	}
13318852aac2STejun Heo 
13327beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
13337beb2edfSTejun Heo 
13347beb2edfSTejun Heo 	/*
13357beb2edfSTejun Heo 	 * This stores cwq for the moment, for the timer_fn.  Note that the
13367beb2edfSTejun Heo 	 * work's gcwq is preserved to allow reentrance detection for
13377beb2edfSTejun Heo 	 * delayed works.
13387beb2edfSTejun Heo 	 */
13397beb2edfSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
13407beb2edfSTejun Heo 		struct global_cwq *gcwq = get_work_gcwq(work);
13417beb2edfSTejun Heo 
1342e42986deSJoonsoo Kim 		/*
1343e42986deSJoonsoo Kim 		 * If we cannot get the last gcwq from @work directly,
1344e42986deSJoonsoo Kim 		 * select the last CPU such that it avoids unnecessarily
1345e42986deSJoonsoo Kim 		 * triggering non-reentrancy check in __queue_work().
1346e42986deSJoonsoo Kim 		 */
1347e42986deSJoonsoo Kim 		lcpu = cpu;
1348e42986deSJoonsoo Kim 		if (gcwq)
13497beb2edfSTejun Heo 			lcpu = gcwq->cpu;
1350e42986deSJoonsoo Kim 		if (lcpu == WORK_CPU_UNBOUND)
13517beb2edfSTejun Heo 			lcpu = raw_smp_processor_id();
13527beb2edfSTejun Heo 	} else {
13537beb2edfSTejun Heo 		lcpu = WORK_CPU_UNBOUND;
13541da177e4SLinus Torvalds 	}
13557beb2edfSTejun Heo 
13567beb2edfSTejun Heo 	set_work_cwq(work, get_cwq(lcpu, wq), 0);
13577beb2edfSTejun Heo 
13581265057fSTejun Heo 	dwork->cpu = cpu;
13597beb2edfSTejun Heo 	timer->expires = jiffies + delay;
13607beb2edfSTejun Heo 
13617beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
13627beb2edfSTejun Heo 		add_timer_on(timer, cpu);
13637beb2edfSTejun Heo 	else
13647beb2edfSTejun Heo 		add_timer(timer);
13657beb2edfSTejun Heo }
13661da177e4SLinus Torvalds 
13670fcb78c2SRolf Eike Beer /**
13680fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
13690fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
13700fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1371af9997e4SRandy Dunlap  * @dwork: work to queue
13720fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
13730fcb78c2SRolf Eike Beer  *
1374715f1300STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.  If
1375715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1376715f1300STejun Heo  * execution.
13770fcb78c2SRolf Eike Beer  */
1378d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
137952bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
13807a6bc1cdSVenkatesh Pallipadi {
138152bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1382d4283e93STejun Heo 	bool ret = false;
13838930cabaSTejun Heo 	unsigned long flags;
13848930cabaSTejun Heo 
13858930cabaSTejun Heo 	/* read the comment in __queue_work() */
13868930cabaSTejun Heo 	local_irq_save(flags);
13877a6bc1cdSVenkatesh Pallipadi 
138822df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
13897beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1390d4283e93STejun Heo 		ret = true;
13917a6bc1cdSVenkatesh Pallipadi 	}
13928930cabaSTejun Heo 
13938930cabaSTejun Heo 	local_irq_restore(flags);
13947a6bc1cdSVenkatesh Pallipadi 	return ret;
13957a6bc1cdSVenkatesh Pallipadi }
1396ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
13971da177e4SLinus Torvalds 
1398c8e55f36STejun Heo /**
13990a13c00eSTejun Heo  * queue_delayed_work - queue work on a workqueue after delay
14000a13c00eSTejun Heo  * @wq: workqueue to use
14010a13c00eSTejun Heo  * @dwork: delayable work to queue
14020a13c00eSTejun Heo  * @delay: number of jiffies to wait before queueing
14030a13c00eSTejun Heo  *
1404715f1300STejun Heo  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
14050a13c00eSTejun Heo  */
1406d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq,
14070a13c00eSTejun Heo 			struct delayed_work *dwork, unsigned long delay)
14080a13c00eSTejun Heo {
140957469821STejun Heo 	return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14100a13c00eSTejun Heo }
14110a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work);
14120a13c00eSTejun Heo 
14130a13c00eSTejun Heo /**
14148376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
14158376fe22STejun Heo  * @cpu: CPU number to execute work on
14168376fe22STejun Heo  * @wq: workqueue to use
14178376fe22STejun Heo  * @dwork: work to queue
14188376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14198376fe22STejun Heo  *
14208376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
14218376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
14228376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
14238376fe22STejun Heo  * current state.
14248376fe22STejun Heo  *
14258376fe22STejun Heo  * Returns %false if @dwork was idle and queued, %true if @dwork was
14268376fe22STejun Heo  * pending and its timer was modified.
14278376fe22STejun Heo  *
1428e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
14298376fe22STejun Heo  * See try_to_grab_pending() for details.
14308376fe22STejun Heo  */
14318376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
14328376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
14338376fe22STejun Heo {
14348376fe22STejun Heo 	unsigned long flags;
14358376fe22STejun Heo 	int ret;
14368376fe22STejun Heo 
14378376fe22STejun Heo 	do {
14388376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
14398376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
14408376fe22STejun Heo 
14418376fe22STejun Heo 	if (likely(ret >= 0)) {
14428376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
14438376fe22STejun Heo 		local_irq_restore(flags);
14448376fe22STejun Heo 	}
14458376fe22STejun Heo 
14468376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
14478376fe22STejun Heo 	return ret;
14488376fe22STejun Heo }
14498376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
14508376fe22STejun Heo 
14518376fe22STejun Heo /**
14528376fe22STejun Heo  * mod_delayed_work - modify delay of or queue a delayed work
14538376fe22STejun Heo  * @wq: workqueue to use
14548376fe22STejun Heo  * @dwork: work to queue
14558376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14568376fe22STejun Heo  *
14578376fe22STejun Heo  * mod_delayed_work_on() on local CPU.
14588376fe22STejun Heo  */
14598376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
14608376fe22STejun Heo 		      unsigned long delay)
14618376fe22STejun Heo {
14628376fe22STejun Heo 	return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14638376fe22STejun Heo }
14648376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work);
14658376fe22STejun Heo 
14668376fe22STejun Heo /**
1467c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1468c8e55f36STejun Heo  * @worker: worker which is entering idle state
1469c8e55f36STejun Heo  *
1470c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1471c8e55f36STejun Heo  * necessary.
1472c8e55f36STejun Heo  *
1473c8e55f36STejun Heo  * LOCKING:
1474c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1475c8e55f36STejun Heo  */
1476c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
14771da177e4SLinus Torvalds {
1478bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1479c8e55f36STejun Heo 
1480c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1481c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1482c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1483c8e55f36STejun Heo 
1484cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1485cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1486bd7bdd43STejun Heo 	pool->nr_idle++;
1487e22bee78STejun Heo 	worker->last_active = jiffies;
1488c8e55f36STejun Heo 
1489c8e55f36STejun Heo 	/* idle_list is LIFO */
1490bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1491db7bccf4STejun Heo 
149263d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1493628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1494cb444766STejun Heo 
1495544ecf31STejun Heo 	/*
1496628c78e7STejun Heo 	 * Sanity check nr_running.  Because gcwq_unbind_fn() releases
1497628c78e7STejun Heo 	 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1498628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1499628c78e7STejun Heo 	 * unbind is not in progress.
1500544ecf31STejun Heo 	 */
1501*24647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1502bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
150363d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1504c8e55f36STejun Heo }
1505c8e55f36STejun Heo 
1506c8e55f36STejun Heo /**
1507c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1508c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1509c8e55f36STejun Heo  *
1510c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1511c8e55f36STejun Heo  *
1512c8e55f36STejun Heo  * LOCKING:
1513c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1514c8e55f36STejun Heo  */
1515c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1516c8e55f36STejun Heo {
1517bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1518c8e55f36STejun Heo 
1519c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1520d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1521bd7bdd43STejun Heo 	pool->nr_idle--;
1522c8e55f36STejun Heo 	list_del_init(&worker->entry);
1523c8e55f36STejun Heo }
1524c8e55f36STejun Heo 
1525e22bee78STejun Heo /**
1526e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1527e22bee78STejun Heo  * @worker: self
1528e22bee78STejun Heo  *
1529e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1530e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1531e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1532e22bee78STejun Heo  * guaranteed to execute on the cpu.
1533e22bee78STejun Heo  *
1534e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1535e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1536e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1537e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1538e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1539e22bee78STejun Heo  * [dis]associated in the meantime.
1540e22bee78STejun Heo  *
1541f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1542*24647570STejun Heo  * binding against %POOL_DISASSOCIATED which is set during
1543f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1544f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1545f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1546e22bee78STejun Heo  *
1547e22bee78STejun Heo  * CONTEXT:
1548e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1549e22bee78STejun Heo  * held.
1550e22bee78STejun Heo  *
1551e22bee78STejun Heo  * RETURNS:
1552e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1553e22bee78STejun Heo  * bound), %false if offline.
1554e22bee78STejun Heo  */
1555e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1556972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1557e22bee78STejun Heo {
1558*24647570STejun Heo 	struct worker_pool *pool = worker->pool;
1559*24647570STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1560e22bee78STejun Heo 	struct task_struct *task = worker->task;
1561e22bee78STejun Heo 
1562e22bee78STejun Heo 	while (true) {
1563e22bee78STejun Heo 		/*
1564e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1565e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1566e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1567*24647570STejun Heo 		 * against POOL_DISASSOCIATED.
1568e22bee78STejun Heo 		 */
1569*24647570STejun Heo 		if (!(pool->flags & POOL_DISASSOCIATED))
1570e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1571e22bee78STejun Heo 
1572e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1573*24647570STejun Heo 		if (pool->flags & POOL_DISASSOCIATED)
1574e22bee78STejun Heo 			return false;
1575e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1576e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1577e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1578e22bee78STejun Heo 			return true;
1579e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1580e22bee78STejun Heo 
15815035b20fSTejun Heo 		/*
15825035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
15835035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
15845035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
15855035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
15865035b20fSTejun Heo 		 */
1587e22bee78STejun Heo 		cpu_relax();
15885035b20fSTejun Heo 		cond_resched();
1589e22bee78STejun Heo 	}
1590e22bee78STejun Heo }
1591e22bee78STejun Heo 
1592e22bee78STejun Heo /*
1593ea1abd61SLai Jiangshan  * Rebind an idle @worker to its CPU.  worker_thread() will test
15945f7dabfdSLai Jiangshan  * list_empty(@worker->entry) before leaving idle and call this function.
159525511a47STejun Heo  */
159625511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
159725511a47STejun Heo {
159825511a47STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
159925511a47STejun Heo 
16005f7dabfdSLai Jiangshan 	/* CPU may go down again inbetween, clear UNBOUND only on success */
16015f7dabfdSLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
16025f7dabfdSLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
160325511a47STejun Heo 
1604ea1abd61SLai Jiangshan 	/* rebind complete, become available again */
1605ea1abd61SLai Jiangshan 	list_add(&worker->entry, &worker->pool->idle_list);
1606ea1abd61SLai Jiangshan 	spin_unlock_irq(&gcwq->lock);
160725511a47STejun Heo }
160825511a47STejun Heo 
160925511a47STejun Heo /*
161025511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1611403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1612403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1613403c821dSTejun Heo  * executed twice without intervening cpu down.
1614e22bee78STejun Heo  */
161525511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1616e22bee78STejun Heo {
1617e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1618bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1619e22bee78STejun Heo 
1620eab6d828SLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
1621eab6d828SLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
1622e22bee78STejun Heo 
1623e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1624e22bee78STejun Heo }
1625e22bee78STejun Heo 
162625511a47STejun Heo /**
162725511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
162825511a47STejun Heo  * @gcwq: gcwq of interest
162925511a47STejun Heo  *
163025511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
163125511a47STejun Heo  * is different for idle and busy ones.
163225511a47STejun Heo  *
1633ea1abd61SLai Jiangshan  * Idle ones will be removed from the idle_list and woken up.  They will
1634ea1abd61SLai Jiangshan  * add themselves back after completing rebind.  This ensures that the
1635ea1abd61SLai Jiangshan  * idle_list doesn't contain any unbound workers when re-bound busy workers
1636ea1abd61SLai Jiangshan  * try to perform local wake-ups for concurrency management.
163725511a47STejun Heo  *
1638ea1abd61SLai Jiangshan  * Busy workers can rebind after they finish their current work items.
1639ea1abd61SLai Jiangshan  * Queueing the rebind work item at the head of the scheduled list is
1640ea1abd61SLai Jiangshan  * enough.  Note that nr_running will be properly bumped as busy workers
1641ea1abd61SLai Jiangshan  * rebind.
164225511a47STejun Heo  *
1643ea1abd61SLai Jiangshan  * On return, all non-manager workers are scheduled for rebind - see
1644ea1abd61SLai Jiangshan  * manage_workers() for the manager special case.  Any idle worker
1645ea1abd61SLai Jiangshan  * including the manager will not appear on @idle_list until rebind is
1646ea1abd61SLai Jiangshan  * complete, making local wake-ups safe.
164725511a47STejun Heo  */
164825511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
164925511a47STejun Heo {
165025511a47STejun Heo 	struct worker_pool *pool;
1651ea1abd61SLai Jiangshan 	struct worker *worker, *n;
165225511a47STejun Heo 	struct hlist_node *pos;
165325511a47STejun Heo 	int i;
165425511a47STejun Heo 
165525511a47STejun Heo 	lockdep_assert_held(&gcwq->lock);
165625511a47STejun Heo 
165725511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
1658b2eb83d1SLai Jiangshan 		lockdep_assert_held(&pool->assoc_mutex);
165925511a47STejun Heo 
16605f7dabfdSLai Jiangshan 	/* dequeue and kick idle ones */
166125511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
1662ea1abd61SLai Jiangshan 		list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1663ea1abd61SLai Jiangshan 			/*
1664ea1abd61SLai Jiangshan 			 * idle workers should be off @pool->idle_list
1665ea1abd61SLai Jiangshan 			 * until rebind is complete to avoid receiving
1666ea1abd61SLai Jiangshan 			 * premature local wake-ups.
1667ea1abd61SLai Jiangshan 			 */
1668ea1abd61SLai Jiangshan 			list_del_init(&worker->entry);
166925511a47STejun Heo 
167025511a47STejun Heo 			/*
16715f7dabfdSLai Jiangshan 			 * worker_thread() will see the above dequeuing
16725f7dabfdSLai Jiangshan 			 * and call idle_worker_rebind().
167325511a47STejun Heo 			 */
167425511a47STejun Heo 			wake_up_process(worker->task);
167525511a47STejun Heo 		}
167625511a47STejun Heo 	}
167725511a47STejun Heo 
1678ea1abd61SLai Jiangshan 	/* rebind busy workers */
167925511a47STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
168025511a47STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
1681e2b6a6d5SJoonsoo Kim 		struct workqueue_struct *wq;
168225511a47STejun Heo 
168325511a47STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
168425511a47STejun Heo 				     work_data_bits(rebind_work)))
168525511a47STejun Heo 			continue;
168625511a47STejun Heo 
168725511a47STejun Heo 		debug_work_activate(rebind_work);
168890beca5dSTejun Heo 
168990beca5dSTejun Heo 		/*
1690e2b6a6d5SJoonsoo Kim 		 * wq doesn't really matter but let's keep @worker->pool
1691e2b6a6d5SJoonsoo Kim 		 * and @cwq->pool consistent for sanity.
169290beca5dSTejun Heo 		 */
1693e34cdddbSTejun Heo 		if (std_worker_pool_pri(worker->pool))
1694e2b6a6d5SJoonsoo Kim 			wq = system_highpri_wq;
1695e2b6a6d5SJoonsoo Kim 		else
1696e2b6a6d5SJoonsoo Kim 			wq = system_wq;
1697ec58815aSTejun Heo 
1698e2b6a6d5SJoonsoo Kim 		insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
169925511a47STejun Heo 			worker->scheduled.next,
170025511a47STejun Heo 			work_color_to_flags(WORK_NO_COLOR));
1701ec58815aSTejun Heo 	}
170225511a47STejun Heo }
170325511a47STejun Heo 
1704c34056a3STejun Heo static struct worker *alloc_worker(void)
1705c34056a3STejun Heo {
1706c34056a3STejun Heo 	struct worker *worker;
1707c34056a3STejun Heo 
1708c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1709c8e55f36STejun Heo 	if (worker) {
1710c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1711affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
171225511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1713e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1714e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1715c8e55f36STejun Heo 	}
1716c34056a3STejun Heo 	return worker;
1717c34056a3STejun Heo }
1718c34056a3STejun Heo 
1719c34056a3STejun Heo /**
1720c34056a3STejun Heo  * create_worker - create a new workqueue worker
172163d95a91STejun Heo  * @pool: pool the new worker will belong to
1722c34056a3STejun Heo  *
172363d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1724c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1725c34056a3STejun Heo  * destroy_worker().
1726c34056a3STejun Heo  *
1727c34056a3STejun Heo  * CONTEXT:
1728c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1729c34056a3STejun Heo  *
1730c34056a3STejun Heo  * RETURNS:
1731c34056a3STejun Heo  * Pointer to the newly created worker.
1732c34056a3STejun Heo  */
1733bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1734c34056a3STejun Heo {
173563d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1736e34cdddbSTejun Heo 	const char *pri = std_worker_pool_pri(pool) ? "H" : "";
1737c34056a3STejun Heo 	struct worker *worker = NULL;
1738f3421797STejun Heo 	int id = -1;
1739c34056a3STejun Heo 
17408b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1741bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
17428b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1743bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1744c34056a3STejun Heo 			goto fail;
17458b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1746c34056a3STejun Heo 	}
17478b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1748c34056a3STejun Heo 
1749c34056a3STejun Heo 	worker = alloc_worker();
1750c34056a3STejun Heo 	if (!worker)
1751c34056a3STejun Heo 		goto fail;
1752c34056a3STejun Heo 
1753bd7bdd43STejun Heo 	worker->pool = pool;
1754c34056a3STejun Heo 	worker->id = id;
1755c34056a3STejun Heo 
1756bc2ae0f5STejun Heo 	if (gcwq->cpu != WORK_CPU_UNBOUND)
175794dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
17583270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
17593270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1760f3421797STejun Heo 	else
1761f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
17623270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1763c34056a3STejun Heo 	if (IS_ERR(worker->task))
1764c34056a3STejun Heo 		goto fail;
1765c34056a3STejun Heo 
1766e34cdddbSTejun Heo 	if (std_worker_pool_pri(pool))
17673270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
17683270476aSTejun Heo 
1769db7bccf4STejun Heo 	/*
1770bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
1771*24647570STejun Heo 	 * %POOL_DISASSOCIATED.  The caller is responsible for ensuring the
1772bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1773bc2ae0f5STejun Heo 	 * above the flag definition for details.
1774bc2ae0f5STejun Heo 	 *
1775bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1776bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1777db7bccf4STejun Heo 	 */
1778*24647570STejun Heo 	if (!(pool->flags & POOL_DISASSOCIATED)) {
17798b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1780bc2ae0f5STejun Heo 	} else {
1781db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1782f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1783f3421797STejun Heo 	}
1784c34056a3STejun Heo 
1785c34056a3STejun Heo 	return worker;
1786c34056a3STejun Heo fail:
1787c34056a3STejun Heo 	if (id >= 0) {
17888b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1789bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
17908b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1791c34056a3STejun Heo 	}
1792c34056a3STejun Heo 	kfree(worker);
1793c34056a3STejun Heo 	return NULL;
1794c34056a3STejun Heo }
1795c34056a3STejun Heo 
1796c34056a3STejun Heo /**
1797c34056a3STejun Heo  * start_worker - start a newly created worker
1798c34056a3STejun Heo  * @worker: worker to start
1799c34056a3STejun Heo  *
1800c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1801c34056a3STejun Heo  *
1802c34056a3STejun Heo  * CONTEXT:
18038b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1804c34056a3STejun Heo  */
1805c34056a3STejun Heo static void start_worker(struct worker *worker)
1806c34056a3STejun Heo {
1807cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1808bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1809c8e55f36STejun Heo 	worker_enter_idle(worker);
1810c34056a3STejun Heo 	wake_up_process(worker->task);
1811c34056a3STejun Heo }
1812c34056a3STejun Heo 
1813c34056a3STejun Heo /**
1814c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1815c34056a3STejun Heo  * @worker: worker to be destroyed
1816c34056a3STejun Heo  *
1817c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1818c8e55f36STejun Heo  *
1819c8e55f36STejun Heo  * CONTEXT:
1820c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1821c34056a3STejun Heo  */
1822c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1823c34056a3STejun Heo {
1824bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1825bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1826c34056a3STejun Heo 	int id = worker->id;
1827c34056a3STejun Heo 
1828c34056a3STejun Heo 	/* sanity check frenzy */
1829c34056a3STejun Heo 	BUG_ON(worker->current_work);
1830affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1831c34056a3STejun Heo 
1832c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1833bd7bdd43STejun Heo 		pool->nr_workers--;
1834c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1835bd7bdd43STejun Heo 		pool->nr_idle--;
1836c8e55f36STejun Heo 
1837c8e55f36STejun Heo 	list_del_init(&worker->entry);
1838cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1839c8e55f36STejun Heo 
1840c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1841c8e55f36STejun Heo 
1842c34056a3STejun Heo 	kthread_stop(worker->task);
1843c34056a3STejun Heo 	kfree(worker);
1844c34056a3STejun Heo 
18458b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1846bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1847c34056a3STejun Heo }
1848c34056a3STejun Heo 
184963d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1850e22bee78STejun Heo {
185163d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
185263d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1853e22bee78STejun Heo 
1854e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1855e22bee78STejun Heo 
185663d95a91STejun Heo 	if (too_many_workers(pool)) {
1857e22bee78STejun Heo 		struct worker *worker;
1858e22bee78STejun Heo 		unsigned long expires;
1859e22bee78STejun Heo 
1860e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
186163d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1862e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1863e22bee78STejun Heo 
1864e22bee78STejun Heo 		if (time_before(jiffies, expires))
186563d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1866e22bee78STejun Heo 		else {
1867e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
186811ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
186963d95a91STejun Heo 			wake_up_worker(pool);
1870e22bee78STejun Heo 		}
1871e22bee78STejun Heo 	}
1872e22bee78STejun Heo 
1873e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1874e22bee78STejun Heo }
1875e22bee78STejun Heo 
1876e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1877e22bee78STejun Heo {
1878e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1879e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1880f3421797STejun Heo 	unsigned int cpu;
1881e22bee78STejun Heo 
1882e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1883e22bee78STejun Heo 		return false;
1884e22bee78STejun Heo 
1885e22bee78STejun Heo 	/* mayday mayday mayday */
1886bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1887f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1888f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1889f3421797STejun Heo 		cpu = 0;
1890f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1891e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1892e22bee78STejun Heo 	return true;
1893e22bee78STejun Heo }
1894e22bee78STejun Heo 
189563d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1896e22bee78STejun Heo {
189763d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
189863d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1899e22bee78STejun Heo 	struct work_struct *work;
1900e22bee78STejun Heo 
1901e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1902e22bee78STejun Heo 
190363d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1904e22bee78STejun Heo 		/*
1905e22bee78STejun Heo 		 * We've been trying to create a new worker but
1906e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1907e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1908e22bee78STejun Heo 		 * rescuers.
1909e22bee78STejun Heo 		 */
191063d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1911e22bee78STejun Heo 			send_mayday(work);
1912e22bee78STejun Heo 	}
1913e22bee78STejun Heo 
1914e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1915e22bee78STejun Heo 
191663d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1917e22bee78STejun Heo }
1918e22bee78STejun Heo 
1919e22bee78STejun Heo /**
1920e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
192163d95a91STejun Heo  * @pool: pool to create a new worker for
1922e22bee78STejun Heo  *
192363d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1924e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1925e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
192663d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1927e22bee78STejun Heo  * possible allocation deadlock.
1928e22bee78STejun Heo  *
1929e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1930e22bee78STejun Heo  * may_start_working() true.
1931e22bee78STejun Heo  *
1932e22bee78STejun Heo  * LOCKING:
1933e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1934e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1935e22bee78STejun Heo  * manager.
1936e22bee78STejun Heo  *
1937e22bee78STejun Heo  * RETURNS:
1938e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1939e22bee78STejun Heo  * otherwise.
1940e22bee78STejun Heo  */
194163d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
194206bd6ebfSNamhyung Kim __releases(&gcwq->lock)
194306bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1944e22bee78STejun Heo {
194563d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
194663d95a91STejun Heo 
194763d95a91STejun Heo 	if (!need_to_create_worker(pool))
1948e22bee78STejun Heo 		return false;
1949e22bee78STejun Heo restart:
19509f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
19519f9c2364STejun Heo 
1952e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
195363d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1954e22bee78STejun Heo 
1955e22bee78STejun Heo 	while (true) {
1956e22bee78STejun Heo 		struct worker *worker;
1957e22bee78STejun Heo 
1958bc2ae0f5STejun Heo 		worker = create_worker(pool);
1959e22bee78STejun Heo 		if (worker) {
196063d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1961e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1962e22bee78STejun Heo 			start_worker(worker);
196363d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1964e22bee78STejun Heo 			return true;
1965e22bee78STejun Heo 		}
1966e22bee78STejun Heo 
196763d95a91STejun Heo 		if (!need_to_create_worker(pool))
1968e22bee78STejun Heo 			break;
1969e22bee78STejun Heo 
1970e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1971e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
19729f9c2364STejun Heo 
197363d95a91STejun Heo 		if (!need_to_create_worker(pool))
1974e22bee78STejun Heo 			break;
1975e22bee78STejun Heo 	}
1976e22bee78STejun Heo 
197763d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1978e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
197963d95a91STejun Heo 	if (need_to_create_worker(pool))
1980e22bee78STejun Heo 		goto restart;
1981e22bee78STejun Heo 	return true;
1982e22bee78STejun Heo }
1983e22bee78STejun Heo 
1984e22bee78STejun Heo /**
1985e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
198663d95a91STejun Heo  * @pool: pool to destroy workers for
1987e22bee78STejun Heo  *
198863d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
1989e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1990e22bee78STejun Heo  *
1991e22bee78STejun Heo  * LOCKING:
1992e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1993e22bee78STejun Heo  * multiple times.  Called only from manager.
1994e22bee78STejun Heo  *
1995e22bee78STejun Heo  * RETURNS:
1996e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1997e22bee78STejun Heo  * otherwise.
1998e22bee78STejun Heo  */
199963d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
2000e22bee78STejun Heo {
2001e22bee78STejun Heo 	bool ret = false;
2002e22bee78STejun Heo 
200363d95a91STejun Heo 	while (too_many_workers(pool)) {
2004e22bee78STejun Heo 		struct worker *worker;
2005e22bee78STejun Heo 		unsigned long expires;
2006e22bee78STejun Heo 
200763d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2008e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2009e22bee78STejun Heo 
2010e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
201163d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2012e22bee78STejun Heo 			break;
2013e22bee78STejun Heo 		}
2014e22bee78STejun Heo 
2015e22bee78STejun Heo 		destroy_worker(worker);
2016e22bee78STejun Heo 		ret = true;
2017e22bee78STejun Heo 	}
2018e22bee78STejun Heo 
2019e22bee78STejun Heo 	return ret;
2020e22bee78STejun Heo }
2021e22bee78STejun Heo 
2022e22bee78STejun Heo /**
2023e22bee78STejun Heo  * manage_workers - manage worker pool
2024e22bee78STejun Heo  * @worker: self
2025e22bee78STejun Heo  *
2026e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
2027e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2028e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
2029e22bee78STejun Heo  *
2030e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2031e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2032e22bee78STejun Heo  * and may_start_working() is true.
2033e22bee78STejun Heo  *
2034e22bee78STejun Heo  * CONTEXT:
2035e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2036e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2037e22bee78STejun Heo  *
2038e22bee78STejun Heo  * RETURNS:
2039e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
2040e22bee78STejun Heo  * some action was taken.
2041e22bee78STejun Heo  */
2042e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2043e22bee78STejun Heo {
204463d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2045e22bee78STejun Heo 	bool ret = false;
2046e22bee78STejun Heo 
2047ee378aa4SLai Jiangshan 	if (pool->flags & POOL_MANAGING_WORKERS)
2048e22bee78STejun Heo 		return ret;
2049e22bee78STejun Heo 
2050552a37e9SLai Jiangshan 	pool->flags |= POOL_MANAGING_WORKERS;
2051ee378aa4SLai Jiangshan 
2052ee378aa4SLai Jiangshan 	/*
2053ee378aa4SLai Jiangshan 	 * To simplify both worker management and CPU hotplug, hold off
2054ee378aa4SLai Jiangshan 	 * management while hotplug is in progress.  CPU hotplug path can't
2055ee378aa4SLai Jiangshan 	 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2056ee378aa4SLai Jiangshan 	 * lead to idle worker depletion (all become busy thinking someone
2057ee378aa4SLai Jiangshan 	 * else is managing) which in turn can result in deadlock under
2058b2eb83d1SLai Jiangshan 	 * extreme circumstances.  Use @pool->assoc_mutex to synchronize
2059ee378aa4SLai Jiangshan 	 * manager against CPU hotplug.
2060ee378aa4SLai Jiangshan 	 *
2061b2eb83d1SLai Jiangshan 	 * assoc_mutex would always be free unless CPU hotplug is in
2062ee378aa4SLai Jiangshan 	 * progress.  trylock first without dropping @gcwq->lock.
2063ee378aa4SLai Jiangshan 	 */
2064b2eb83d1SLai Jiangshan 	if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
2065ee378aa4SLai Jiangshan 		spin_unlock_irq(&pool->gcwq->lock);
2066b2eb83d1SLai Jiangshan 		mutex_lock(&pool->assoc_mutex);
2067ee378aa4SLai Jiangshan 		/*
2068ee378aa4SLai Jiangshan 		 * CPU hotplug could have happened while we were waiting
2069b2eb83d1SLai Jiangshan 		 * for assoc_mutex.  Hotplug itself can't handle us
2070ee378aa4SLai Jiangshan 		 * because manager isn't either on idle or busy list, and
2071ee378aa4SLai Jiangshan 		 * @gcwq's state and ours could have deviated.
2072ee378aa4SLai Jiangshan 		 *
2073b2eb83d1SLai Jiangshan 		 * As hotplug is now excluded via assoc_mutex, we can
2074ee378aa4SLai Jiangshan 		 * simply try to bind.  It will succeed or fail depending
2075ee378aa4SLai Jiangshan 		 * on @gcwq's current state.  Try it and adjust
2076ee378aa4SLai Jiangshan 		 * %WORKER_UNBOUND accordingly.
2077ee378aa4SLai Jiangshan 		 */
2078ee378aa4SLai Jiangshan 		if (worker_maybe_bind_and_lock(worker))
2079ee378aa4SLai Jiangshan 			worker->flags &= ~WORKER_UNBOUND;
2080ee378aa4SLai Jiangshan 		else
2081ee378aa4SLai Jiangshan 			worker->flags |= WORKER_UNBOUND;
2082ee378aa4SLai Jiangshan 
2083ee378aa4SLai Jiangshan 		ret = true;
2084ee378aa4SLai Jiangshan 	}
2085ee378aa4SLai Jiangshan 
208611ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2087e22bee78STejun Heo 
2088e22bee78STejun Heo 	/*
2089e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2090e22bee78STejun Heo 	 * on return.
2091e22bee78STejun Heo 	 */
209263d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
209363d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2094e22bee78STejun Heo 
2095552a37e9SLai Jiangshan 	pool->flags &= ~POOL_MANAGING_WORKERS;
2096b2eb83d1SLai Jiangshan 	mutex_unlock(&pool->assoc_mutex);
2097e22bee78STejun Heo 	return ret;
2098e22bee78STejun Heo }
2099e22bee78STejun Heo 
2100a62428c0STejun Heo /**
2101a62428c0STejun Heo  * process_one_work - process single work
2102c34056a3STejun Heo  * @worker: self
2103a62428c0STejun Heo  * @work: work to process
2104a62428c0STejun Heo  *
2105a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2106a62428c0STejun Heo  * process a single work including synchronization against and
2107a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2108a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2109a62428c0STejun Heo  * call this function to process a work.
2110a62428c0STejun Heo  *
2111a62428c0STejun Heo  * CONTEXT:
21128b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
2113a62428c0STejun Heo  */
2114c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
211506bd6ebfSNamhyung Kim __releases(&gcwq->lock)
211606bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
21171da177e4SLinus Torvalds {
21187e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2119bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2120bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
2121fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
212273f53c4aSTejun Heo 	int work_color;
21237e11629dSTejun Heo 	struct worker *collision;
21244e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21254e6045f1SJohannes Berg 	/*
2126a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2127a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2128a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2129a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2130a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21314e6045f1SJohannes Berg 	 */
21324d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21334d82a1deSPeter Zijlstra 
21344d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21354e6045f1SJohannes Berg #endif
21366fec10a1STejun Heo 	/*
21376fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21386fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
2139*24647570STejun Heo 	 * unbound or a disassociated pool.
21406fec10a1STejun Heo 	 */
21415f7dabfdSLai Jiangshan 	WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
2142*24647570STejun Heo 		     !(pool->flags & POOL_DISASSOCIATED) &&
214325511a47STejun Heo 		     raw_smp_processor_id() != gcwq->cpu);
214425511a47STejun Heo 
21457e11629dSTejun Heo 	/*
21467e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21477e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21487e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21497e11629dSTejun Heo 	 * currently executing one.
21507e11629dSTejun Heo 	 */
215142f8570fSSasha Levin 	collision = find_worker_executing_work(gcwq, work);
21527e11629dSTejun Heo 	if (unlikely(collision)) {
21537e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21547e11629dSTejun Heo 		return;
21557e11629dSTejun Heo 	}
21561da177e4SLinus Torvalds 
21578930cabaSTejun Heo 	/* claim and dequeue */
21581da177e4SLinus Torvalds 	debug_work_deactivate(work);
2159023f27d3STejun Heo 	hash_add(gcwq->busy_hash, &worker->hentry, (unsigned long)work);
2160c34056a3STejun Heo 	worker->current_work = work;
2161a2c1c57bSTejun Heo 	worker->current_func = work->func;
21628cca0eeaSTejun Heo 	worker->current_cwq = cwq;
216373f53c4aSTejun Heo 	work_color = get_work_color(work);
21647a22ad75STejun Heo 
2165a62428c0STejun Heo 	list_del_init(&work->entry);
2166a62428c0STejun Heo 
2167649027d7STejun Heo 	/*
2168fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2169fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2170fb0e7bebSTejun Heo 	 */
2171fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2172fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2173fb0e7bebSTejun Heo 
2174974271c4STejun Heo 	/*
2175974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
2176974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2177974271c4STejun Heo 	 */
217863d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
217963d95a91STejun Heo 		wake_up_worker(pool);
2180974271c4STejun Heo 
21818930cabaSTejun Heo 	/*
218223657bb1STejun Heo 	 * Record the last CPU and clear PENDING which should be the last
218323657bb1STejun Heo 	 * update to @work.  Also, do this inside @gcwq->lock so that
218423657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
218523657bb1STejun Heo 	 * disabled.
21868930cabaSTejun Heo 	 */
21878930cabaSTejun Heo 	set_work_cpu_and_clear_pending(work, gcwq->cpu);
21881da177e4SLinus Torvalds 
21891da177e4SLinus Torvalds 	spin_unlock_irq(&gcwq->lock);
2190365970a1SDavid Howells 
2191e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
21923295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2193e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2194a2c1c57bSTejun Heo 	worker->current_func(work);
2195e36c886aSArjan van de Ven 	/*
2196e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2197e36c886aSArjan van de Ven 	 * point will only record its address.
2198e36c886aSArjan van de Ven 	 */
2199e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22003295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
22013295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
22021da177e4SLinus Torvalds 
2203d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2204044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2205044c782cSValentin Ilie 		       "     last function: %pf\n",
2206a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2207a2c1c57bSTejun Heo 		       worker->current_func);
2208d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2209d5abe669SPeter Zijlstra 		dump_stack();
2210d5abe669SPeter Zijlstra 	}
2211d5abe669SPeter Zijlstra 
22128b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2213a62428c0STejun Heo 
2214fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2215fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2216fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2217fb0e7bebSTejun Heo 
2218a62428c0STejun Heo 	/* we're done with it, release */
221942f8570fSSasha Levin 	hash_del(&worker->hentry);
2220c34056a3STejun Heo 	worker->current_work = NULL;
2221a2c1c57bSTejun Heo 	worker->current_func = NULL;
22228cca0eeaSTejun Heo 	worker->current_cwq = NULL;
2223b3f9f405SLai Jiangshan 	cwq_dec_nr_in_flight(cwq, work_color);
22241da177e4SLinus Torvalds }
22251da177e4SLinus Torvalds 
2226affee4b2STejun Heo /**
2227affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2228affee4b2STejun Heo  * @worker: self
2229affee4b2STejun Heo  *
2230affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2231affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2232affee4b2STejun Heo  * fetches a work from the top and executes it.
2233affee4b2STejun Heo  *
2234affee4b2STejun Heo  * CONTEXT:
22358b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2236affee4b2STejun Heo  * multiple times.
2237affee4b2STejun Heo  */
2238affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22391da177e4SLinus Torvalds {
2240affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2241affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2242a62428c0STejun Heo 						struct work_struct, entry);
2243c34056a3STejun Heo 		process_one_work(worker, work);
2244a62428c0STejun Heo 	}
22451da177e4SLinus Torvalds }
22461da177e4SLinus Torvalds 
22474690c4abSTejun Heo /**
22484690c4abSTejun Heo  * worker_thread - the worker thread function
2249c34056a3STejun Heo  * @__worker: self
22504690c4abSTejun Heo  *
2251e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2252e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2253e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2254e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2255e22bee78STejun Heo  * rescuer_thread().
22564690c4abSTejun Heo  */
2257c34056a3STejun Heo static int worker_thread(void *__worker)
22581da177e4SLinus Torvalds {
2259c34056a3STejun Heo 	struct worker *worker = __worker;
2260bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2261bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
22621da177e4SLinus Torvalds 
2263e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2264e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2265c8e55f36STejun Heo woke_up:
22668b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2267affee4b2STejun Heo 
22685f7dabfdSLai Jiangshan 	/* we are off idle list if destruction or rebind is requested */
22695f7dabfdSLai Jiangshan 	if (unlikely(list_empty(&worker->entry))) {
2270c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
227125511a47STejun Heo 
22725f7dabfdSLai Jiangshan 		/* if DIE is set, destruction is requested */
227325511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2274e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2275c8e55f36STejun Heo 			return 0;
2276c8e55f36STejun Heo 		}
2277c8e55f36STejun Heo 
22785f7dabfdSLai Jiangshan 		/* otherwise, rebind */
227925511a47STejun Heo 		idle_worker_rebind(worker);
228025511a47STejun Heo 		goto woke_up;
228125511a47STejun Heo 	}
228225511a47STejun Heo 
2283c8e55f36STejun Heo 	worker_leave_idle(worker);
2284db7bccf4STejun Heo recheck:
2285e22bee78STejun Heo 	/* no more worker necessary? */
228663d95a91STejun Heo 	if (!need_more_worker(pool))
2287e22bee78STejun Heo 		goto sleep;
2288e22bee78STejun Heo 
2289e22bee78STejun Heo 	/* do we need to manage? */
229063d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2291e22bee78STejun Heo 		goto recheck;
2292e22bee78STejun Heo 
2293c8e55f36STejun Heo 	/*
2294c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2295c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2296c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2297c8e55f36STejun Heo 	 */
2298c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2299c8e55f36STejun Heo 
2300e22bee78STejun Heo 	/*
2301e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2302e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2303e22bee78STejun Heo 	 * assumed the manager role.
2304e22bee78STejun Heo 	 */
2305e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2306e22bee78STejun Heo 
2307e22bee78STejun Heo 	do {
2308affee4b2STejun Heo 		struct work_struct *work =
2309bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2310affee4b2STejun Heo 					 struct work_struct, entry);
2311affee4b2STejun Heo 
2312c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2313affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2314affee4b2STejun Heo 			process_one_work(worker, work);
2315affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2316affee4b2STejun Heo 				process_scheduled_works(worker);
2317affee4b2STejun Heo 		} else {
2318c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2319affee4b2STejun Heo 			process_scheduled_works(worker);
2320affee4b2STejun Heo 		}
232163d95a91STejun Heo 	} while (keep_working(pool));
2322affee4b2STejun Heo 
2323e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2324d313dd85STejun Heo sleep:
232563d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2326e22bee78STejun Heo 		goto recheck;
2327d313dd85STejun Heo 
2328c8e55f36STejun Heo 	/*
2329e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2330e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2331e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2332e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2333e22bee78STejun Heo 	 * prevent losing any event.
2334c8e55f36STejun Heo 	 */
2335c8e55f36STejun Heo 	worker_enter_idle(worker);
2336c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
23378b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23381da177e4SLinus Torvalds 	schedule();
2339c8e55f36STejun Heo 	goto woke_up;
23401da177e4SLinus Torvalds }
23411da177e4SLinus Torvalds 
2342e22bee78STejun Heo /**
2343e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2344111c225aSTejun Heo  * @__rescuer: self
2345e22bee78STejun Heo  *
2346e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2347e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2348e22bee78STejun Heo  *
2349e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2350e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2351e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2352e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2353e22bee78STejun Heo  * the problem rescuer solves.
2354e22bee78STejun Heo  *
2355e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2356e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2357e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2358e22bee78STejun Heo  *
2359e22bee78STejun Heo  * This should happen rarely.
2360e22bee78STejun Heo  */
2361111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2362e22bee78STejun Heo {
2363111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2364111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2365e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2366f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2367e22bee78STejun Heo 	unsigned int cpu;
2368e22bee78STejun Heo 
2369e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2370111c225aSTejun Heo 
2371111c225aSTejun Heo 	/*
2372111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2373111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2374111c225aSTejun Heo 	 */
2375111c225aSTejun Heo 	rescuer->task->flags |= PF_WQ_WORKER;
2376e22bee78STejun Heo repeat:
2377e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
23781da177e4SLinus Torvalds 
2379412d32e6SMike Galbraith 	if (kthread_should_stop()) {
2380412d32e6SMike Galbraith 		__set_current_state(TASK_RUNNING);
2381111c225aSTejun Heo 		rescuer->task->flags &= ~PF_WQ_WORKER;
2382e22bee78STejun Heo 		return 0;
2383412d32e6SMike Galbraith 	}
23841da177e4SLinus Torvalds 
2385f3421797STejun Heo 	/*
2386f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2387f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2388f3421797STejun Heo 	 */
2389f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2390f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2391f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2392bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2393bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2394e22bee78STejun Heo 		struct work_struct *work, *n;
2395e22bee78STejun Heo 
2396e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2397f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2398e22bee78STejun Heo 
2399e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2400bd7bdd43STejun Heo 		rescuer->pool = pool;
2401e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2402e22bee78STejun Heo 
2403e22bee78STejun Heo 		/*
2404e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2405e22bee78STejun Heo 		 * process'em.
2406e22bee78STejun Heo 		 */
2407e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2408bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2409e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2410e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2411e22bee78STejun Heo 
2412e22bee78STejun Heo 		process_scheduled_works(rescuer);
24137576958aSTejun Heo 
24147576958aSTejun Heo 		/*
24157576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
24167576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24177576958aSTejun Heo 		 * and stalling the execution.
24187576958aSTejun Heo 		 */
241963d95a91STejun Heo 		if (keep_working(pool))
242063d95a91STejun Heo 			wake_up_worker(pool);
24217576958aSTejun Heo 
2422e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
24231da177e4SLinus Torvalds 	}
24241da177e4SLinus Torvalds 
2425111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2426111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2427e22bee78STejun Heo 	schedule();
2428e22bee78STejun Heo 	goto repeat;
24291da177e4SLinus Torvalds }
24301da177e4SLinus Torvalds 
2431fc2e4d70SOleg Nesterov struct wq_barrier {
2432fc2e4d70SOleg Nesterov 	struct work_struct	work;
2433fc2e4d70SOleg Nesterov 	struct completion	done;
2434fc2e4d70SOleg Nesterov };
2435fc2e4d70SOleg Nesterov 
2436fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2437fc2e4d70SOleg Nesterov {
2438fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2439fc2e4d70SOleg Nesterov 	complete(&barr->done);
2440fc2e4d70SOleg Nesterov }
2441fc2e4d70SOleg Nesterov 
24424690c4abSTejun Heo /**
24434690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
24444690c4abSTejun Heo  * @cwq: cwq to insert barrier into
24454690c4abSTejun Heo  * @barr: wq_barrier to insert
2446affee4b2STejun Heo  * @target: target work to attach @barr to
2447affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24484690c4abSTejun Heo  *
2449affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2450affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2451affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2452affee4b2STejun Heo  * cpu.
2453affee4b2STejun Heo  *
2454affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2455affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2456affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2457affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2458affee4b2STejun Heo  * after a work with LINKED flag set.
2459affee4b2STejun Heo  *
2460affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2461affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
24624690c4abSTejun Heo  *
24634690c4abSTejun Heo  * CONTEXT:
24648b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
24654690c4abSTejun Heo  */
246683c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2467affee4b2STejun Heo 			      struct wq_barrier *barr,
2468affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2469fc2e4d70SOleg Nesterov {
2470affee4b2STejun Heo 	struct list_head *head;
2471affee4b2STejun Heo 	unsigned int linked = 0;
2472affee4b2STejun Heo 
2473dc186ad7SThomas Gleixner 	/*
24748b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2475dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2476dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2477dc186ad7SThomas Gleixner 	 * might deadlock.
2478dc186ad7SThomas Gleixner 	 */
2479ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
248022df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2481fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
248283c22520SOleg Nesterov 
2483affee4b2STejun Heo 	/*
2484affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2485affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2486affee4b2STejun Heo 	 */
2487affee4b2STejun Heo 	if (worker)
2488affee4b2STejun Heo 		head = worker->scheduled.next;
2489affee4b2STejun Heo 	else {
2490affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2491affee4b2STejun Heo 
2492affee4b2STejun Heo 		head = target->entry.next;
2493affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2494affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2495affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2496affee4b2STejun Heo 	}
2497affee4b2STejun Heo 
2498dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2499affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2500affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2501fc2e4d70SOleg Nesterov }
2502fc2e4d70SOleg Nesterov 
250373f53c4aSTejun Heo /**
250473f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
250573f53c4aSTejun Heo  * @wq: workqueue being flushed
250673f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
250773f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
250873f53c4aSTejun Heo  *
250973f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
251073f53c4aSTejun Heo  *
251173f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
251273f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
251373f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
251473f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
251573f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
251673f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
251773f53c4aSTejun Heo  *
251873f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
251973f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
252073f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
252173f53c4aSTejun Heo  * is returned.
252273f53c4aSTejun Heo  *
252373f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
252473f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
252573f53c4aSTejun Heo  * advanced to @work_color.
252673f53c4aSTejun Heo  *
252773f53c4aSTejun Heo  * CONTEXT:
252873f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
252973f53c4aSTejun Heo  *
253073f53c4aSTejun Heo  * RETURNS:
253173f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
253273f53c4aSTejun Heo  * otherwise.
253373f53c4aSTejun Heo  */
253473f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
253573f53c4aSTejun Heo 				      int flush_color, int work_color)
25361da177e4SLinus Torvalds {
253773f53c4aSTejun Heo 	bool wait = false;
253873f53c4aSTejun Heo 	unsigned int cpu;
25391da177e4SLinus Torvalds 
254073f53c4aSTejun Heo 	if (flush_color >= 0) {
254173f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
254273f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2543dc186ad7SThomas Gleixner 	}
254414441960SOleg Nesterov 
2545f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
254673f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2547bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
25481da177e4SLinus Torvalds 
25498b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
255073f53c4aSTejun Heo 
255173f53c4aSTejun Heo 		if (flush_color >= 0) {
255273f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
255373f53c4aSTejun Heo 
255473f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
255573f53c4aSTejun Heo 				cwq->flush_color = flush_color;
255673f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
255773f53c4aSTejun Heo 				wait = true;
25581da177e4SLinus Torvalds 			}
255973f53c4aSTejun Heo 		}
256073f53c4aSTejun Heo 
256173f53c4aSTejun Heo 		if (work_color >= 0) {
256273f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
256373f53c4aSTejun Heo 			cwq->work_color = work_color;
256473f53c4aSTejun Heo 		}
256573f53c4aSTejun Heo 
25668b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
25671da177e4SLinus Torvalds 	}
25681da177e4SLinus Torvalds 
256973f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
257073f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
257173f53c4aSTejun Heo 
257273f53c4aSTejun Heo 	return wait;
257383c22520SOleg Nesterov }
25741da177e4SLinus Torvalds 
25750fcb78c2SRolf Eike Beer /**
25761da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
25770fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
25781da177e4SLinus Torvalds  *
25791da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
25801da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
25811da177e4SLinus Torvalds  *
2582fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2583fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
25841da177e4SLinus Torvalds  */
25857ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
25861da177e4SLinus Torvalds {
258773f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
258873f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
258973f53c4aSTejun Heo 		.flush_color = -1,
259073f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
259173f53c4aSTejun Heo 	};
259273f53c4aSTejun Heo 	int next_color;
2593b1f4ec17SOleg Nesterov 
25943295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
25953295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
259673f53c4aSTejun Heo 
259773f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
259873f53c4aSTejun Heo 
259973f53c4aSTejun Heo 	/*
260073f53c4aSTejun Heo 	 * Start-to-wait phase
260173f53c4aSTejun Heo 	 */
260273f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
260373f53c4aSTejun Heo 
260473f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
260573f53c4aSTejun Heo 		/*
260673f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
260773f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
260873f53c4aSTejun Heo 		 * by one.
260973f53c4aSTejun Heo 		 */
261073f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
261173f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
261273f53c4aSTejun Heo 		wq->work_color = next_color;
261373f53c4aSTejun Heo 
261473f53c4aSTejun Heo 		if (!wq->first_flusher) {
261573f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
261673f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
261773f53c4aSTejun Heo 
261873f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
261973f53c4aSTejun Heo 
262073f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
262173f53c4aSTejun Heo 						       wq->work_color)) {
262273f53c4aSTejun Heo 				/* nothing to flush, done */
262373f53c4aSTejun Heo 				wq->flush_color = next_color;
262473f53c4aSTejun Heo 				wq->first_flusher = NULL;
262573f53c4aSTejun Heo 				goto out_unlock;
262673f53c4aSTejun Heo 			}
262773f53c4aSTejun Heo 		} else {
262873f53c4aSTejun Heo 			/* wait in queue */
262973f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
263073f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
263173f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
263273f53c4aSTejun Heo 		}
263373f53c4aSTejun Heo 	} else {
263473f53c4aSTejun Heo 		/*
263573f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
263673f53c4aSTejun Heo 		 * The next flush completion will assign us
263773f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
263873f53c4aSTejun Heo 		 */
263973f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
264073f53c4aSTejun Heo 	}
264173f53c4aSTejun Heo 
264273f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
264373f53c4aSTejun Heo 
264473f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
264573f53c4aSTejun Heo 
264673f53c4aSTejun Heo 	/*
264773f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
264873f53c4aSTejun Heo 	 *
264973f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
265073f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
265173f53c4aSTejun Heo 	 */
265273f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
265373f53c4aSTejun Heo 		return;
265473f53c4aSTejun Heo 
265573f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
265673f53c4aSTejun Heo 
26574ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26584ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26594ce48b37STejun Heo 		goto out_unlock;
26604ce48b37STejun Heo 
266173f53c4aSTejun Heo 	wq->first_flusher = NULL;
266273f53c4aSTejun Heo 
266373f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
266473f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
266573f53c4aSTejun Heo 
266673f53c4aSTejun Heo 	while (true) {
266773f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
266873f53c4aSTejun Heo 
266973f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
267073f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
267173f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
267273f53c4aSTejun Heo 				break;
267373f53c4aSTejun Heo 			list_del_init(&next->list);
267473f53c4aSTejun Heo 			complete(&next->done);
267573f53c4aSTejun Heo 		}
267673f53c4aSTejun Heo 
267773f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
267873f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
267973f53c4aSTejun Heo 
268073f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
268173f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
268273f53c4aSTejun Heo 
268373f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
268473f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
268573f53c4aSTejun Heo 			/*
268673f53c4aSTejun Heo 			 * Assign the same color to all overflowed
268773f53c4aSTejun Heo 			 * flushers, advance work_color and append to
268873f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
268973f53c4aSTejun Heo 			 * phase for these overflowed flushers.
269073f53c4aSTejun Heo 			 */
269173f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
269273f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
269373f53c4aSTejun Heo 
269473f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
269573f53c4aSTejun Heo 
269673f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
269773f53c4aSTejun Heo 					      &wq->flusher_queue);
269873f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
269973f53c4aSTejun Heo 		}
270073f53c4aSTejun Heo 
270173f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
270273f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
270373f53c4aSTejun Heo 			break;
270473f53c4aSTejun Heo 		}
270573f53c4aSTejun Heo 
270673f53c4aSTejun Heo 		/*
270773f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
270873f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
270973f53c4aSTejun Heo 		 */
271073f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
271173f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
271273f53c4aSTejun Heo 
271373f53c4aSTejun Heo 		list_del_init(&next->list);
271473f53c4aSTejun Heo 		wq->first_flusher = next;
271573f53c4aSTejun Heo 
271673f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
271773f53c4aSTejun Heo 			break;
271873f53c4aSTejun Heo 
271973f53c4aSTejun Heo 		/*
272073f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
272173f53c4aSTejun Heo 		 * flusher and repeat cascading.
272273f53c4aSTejun Heo 		 */
272373f53c4aSTejun Heo 		wq->first_flusher = NULL;
272473f53c4aSTejun Heo 	}
272573f53c4aSTejun Heo 
272673f53c4aSTejun Heo out_unlock:
272773f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
27281da177e4SLinus Torvalds }
2729ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27301da177e4SLinus Torvalds 
27319c5a2ba7STejun Heo /**
27329c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27339c5a2ba7STejun Heo  * @wq: workqueue to drain
27349c5a2ba7STejun Heo  *
27359c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27369c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27379c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27389c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27399c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27409c5a2ba7STejun Heo  * takes too long.
27419c5a2ba7STejun Heo  */
27429c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27439c5a2ba7STejun Heo {
27449c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
27459c5a2ba7STejun Heo 	unsigned int cpu;
27469c5a2ba7STejun Heo 
27479c5a2ba7STejun Heo 	/*
27489c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27499c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
27509c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
27519c5a2ba7STejun Heo 	 */
27529c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27539c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
27549c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
27559c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27569c5a2ba7STejun Heo reflush:
27579c5a2ba7STejun Heo 	flush_workqueue(wq);
27589c5a2ba7STejun Heo 
27599c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27609c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2761fa2563e4SThomas Tuttle 		bool drained;
27629c5a2ba7STejun Heo 
2763bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2764fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2765bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2766fa2563e4SThomas Tuttle 
2767fa2563e4SThomas Tuttle 		if (drained)
27689c5a2ba7STejun Heo 			continue;
27699c5a2ba7STejun Heo 
27709c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27719c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2772044c782cSValentin Ilie 			pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
27739c5a2ba7STejun Heo 				wq->name, flush_cnt);
27749c5a2ba7STejun Heo 		goto reflush;
27759c5a2ba7STejun Heo 	}
27769c5a2ba7STejun Heo 
27779c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27789c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
27799c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
27809c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27819c5a2ba7STejun Heo }
27829c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
27839c5a2ba7STejun Heo 
2784606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2785baf59022STejun Heo {
2786baf59022STejun Heo 	struct worker *worker = NULL;
2787baf59022STejun Heo 	struct global_cwq *gcwq;
2788baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2789baf59022STejun Heo 
2790baf59022STejun Heo 	might_sleep();
2791baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2792baf59022STejun Heo 	if (!gcwq)
2793baf59022STejun Heo 		return false;
2794baf59022STejun Heo 
2795baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2796baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2797baf59022STejun Heo 		/*
2798baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2799baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2800baf59022STejun Heo 		 * are not going to wait.
2801baf59022STejun Heo 		 */
2802baf59022STejun Heo 		smp_rmb();
2803baf59022STejun Heo 		cwq = get_work_cwq(work);
2804bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2805baf59022STejun Heo 			goto already_gone;
2806606a5020STejun Heo 	} else {
2807baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2808baf59022STejun Heo 		if (!worker)
2809baf59022STejun Heo 			goto already_gone;
2810baf59022STejun Heo 		cwq = worker->current_cwq;
2811606a5020STejun Heo 	}
2812baf59022STejun Heo 
2813baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2814baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2815baf59022STejun Heo 
2816e159489bSTejun Heo 	/*
2817e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2818e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2819e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2820e159489bSTejun Heo 	 * access.
2821e159489bSTejun Heo 	 */
2822e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2823baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2824e159489bSTejun Heo 	else
2825e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2826baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2827e159489bSTejun Heo 
2828baf59022STejun Heo 	return true;
2829baf59022STejun Heo already_gone:
2830baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2831baf59022STejun Heo 	return false;
2832baf59022STejun Heo }
2833baf59022STejun Heo 
2834db700897SOleg Nesterov /**
2835401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2836401a8d04STejun Heo  * @work: the work to flush
2837db700897SOleg Nesterov  *
2838606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2839606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2840401a8d04STejun Heo  *
2841401a8d04STejun Heo  * RETURNS:
2842401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2843401a8d04STejun Heo  * %false if it was already idle.
2844db700897SOleg Nesterov  */
2845401a8d04STejun Heo bool flush_work(struct work_struct *work)
2846db700897SOleg Nesterov {
2847db700897SOleg Nesterov 	struct wq_barrier barr;
2848db700897SOleg Nesterov 
28490976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28500976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28510976dfc1SStephen Boyd 
2852606a5020STejun Heo 	if (start_flush_work(work, &barr)) {
2853db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2854dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2855401a8d04STejun Heo 		return true;
2856606a5020STejun Heo 	} else {
2857401a8d04STejun Heo 		return false;
2858db700897SOleg Nesterov 	}
2859606a5020STejun Heo }
2860db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2861db700897SOleg Nesterov 
286236e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2863401a8d04STejun Heo {
2864bbb68dfaSTejun Heo 	unsigned long flags;
28651f1f642eSOleg Nesterov 	int ret;
28661f1f642eSOleg Nesterov 
28671f1f642eSOleg Nesterov 	do {
2868bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2869bbb68dfaSTejun Heo 		/*
2870bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2871bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2872bbb68dfaSTejun Heo 		 */
2873bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2874606a5020STejun Heo 			flush_work(work);
28751f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
28761f1f642eSOleg Nesterov 
2877bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2878bbb68dfaSTejun Heo 	mark_work_canceling(work);
2879bbb68dfaSTejun Heo 	local_irq_restore(flags);
2880bbb68dfaSTejun Heo 
2881606a5020STejun Heo 	flush_work(work);
28827a22ad75STejun Heo 	clear_work_data(work);
28831f1f642eSOleg Nesterov 	return ret;
28841f1f642eSOleg Nesterov }
28851f1f642eSOleg Nesterov 
28866e84d644SOleg Nesterov /**
2887401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2888401a8d04STejun Heo  * @work: the work to cancel
28896e84d644SOleg Nesterov  *
2890401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2891401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2892401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2893401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
28941f1f642eSOleg Nesterov  *
2895401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2896401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
28976e84d644SOleg Nesterov  *
2898401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
28996e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2900401a8d04STejun Heo  *
2901401a8d04STejun Heo  * RETURNS:
2902401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
29036e84d644SOleg Nesterov  */
2904401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29056e84d644SOleg Nesterov {
290636e227d2STejun Heo 	return __cancel_work_timer(work, false);
2907b89deed3SOleg Nesterov }
290828e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2909b89deed3SOleg Nesterov 
29106e84d644SOleg Nesterov /**
2911401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2912401a8d04STejun Heo  * @dwork: the delayed work to flush
29136e84d644SOleg Nesterov  *
2914401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2915401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2916401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29171f1f642eSOleg Nesterov  *
2918401a8d04STejun Heo  * RETURNS:
2919401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2920401a8d04STejun Heo  * %false if it was already idle.
29216e84d644SOleg Nesterov  */
2922401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2923401a8d04STejun Heo {
29248930cabaSTejun Heo 	local_irq_disable();
2925401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
29261265057fSTejun Heo 		__queue_work(dwork->cpu,
2927401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
29288930cabaSTejun Heo 	local_irq_enable();
2929401a8d04STejun Heo 	return flush_work(&dwork->work);
2930401a8d04STejun Heo }
2931401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2932401a8d04STejun Heo 
2933401a8d04STejun Heo /**
293457b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
293557b30ae7STejun Heo  * @dwork: delayed_work to cancel
293609383498STejun Heo  *
293757b30ae7STejun Heo  * Kill off a pending delayed_work.  Returns %true if @dwork was pending
293857b30ae7STejun Heo  * and canceled; %false if wasn't pending.  Note that the work callback
293957b30ae7STejun Heo  * function may still be running on return, unless it returns %true and the
294057b30ae7STejun Heo  * work doesn't re-arm itself.  Explicitly flush or use
294157b30ae7STejun Heo  * cancel_delayed_work_sync() to wait on it.
294209383498STejun Heo  *
294357b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
294409383498STejun Heo  */
294557b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
294609383498STejun Heo {
294757b30ae7STejun Heo 	unsigned long flags;
294857b30ae7STejun Heo 	int ret;
294957b30ae7STejun Heo 
295057b30ae7STejun Heo 	do {
295157b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
295257b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
295357b30ae7STejun Heo 
295457b30ae7STejun Heo 	if (unlikely(ret < 0))
295557b30ae7STejun Heo 		return false;
295657b30ae7STejun Heo 
295757b30ae7STejun Heo 	set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
295857b30ae7STejun Heo 	local_irq_restore(flags);
2959c0158ca6SDan Magenheimer 	return ret;
296009383498STejun Heo }
296157b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
296209383498STejun Heo 
296309383498STejun Heo /**
2964401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2965401a8d04STejun Heo  * @dwork: the delayed work cancel
2966401a8d04STejun Heo  *
2967401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2968401a8d04STejun Heo  *
2969401a8d04STejun Heo  * RETURNS:
2970401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2971401a8d04STejun Heo  */
2972401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
29736e84d644SOleg Nesterov {
297436e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
29756e84d644SOleg Nesterov }
2976f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
29771da177e4SLinus Torvalds 
29780fcb78c2SRolf Eike Beer /**
2979c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2980c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2981c1a220e7SZhang Rui  * @work: job to be done
2982c1a220e7SZhang Rui  *
2983c1a220e7SZhang Rui  * This puts a job on a specific cpu
2984c1a220e7SZhang Rui  */
2985d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work)
2986c1a220e7SZhang Rui {
2987d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2988c1a220e7SZhang Rui }
2989c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2990c1a220e7SZhang Rui 
29910fcb78c2SRolf Eike Beer /**
2992ae90dd5dSDave Jones  * schedule_work - put work task in global workqueue
29931da177e4SLinus Torvalds  * @work: job to be done
29941da177e4SLinus Torvalds  *
2995d4283e93STejun Heo  * Returns %false if @work was already on the kernel-global workqueue and
2996d4283e93STejun Heo  * %true otherwise.
299752bad64dSDavid Howells  *
29980fcb78c2SRolf Eike Beer  * This puts a job in the kernel-global workqueue if it was not already
29990fcb78c2SRolf Eike Beer  * queued and leaves it in the same position on the kernel-global
30000fcb78c2SRolf Eike Beer  * workqueue otherwise.
30011da177e4SLinus Torvalds  */
3002d4283e93STejun Heo bool schedule_work(struct work_struct *work)
30031da177e4SLinus Torvalds {
30040fcb78c2SRolf Eike Beer 	return queue_work(system_wq, work);
30051da177e4SLinus Torvalds }
30060fcb78c2SRolf Eike Beer EXPORT_SYMBOL(schedule_work);
30071da177e4SLinus Torvalds 
30080fcb78c2SRolf Eike Beer /**
30090fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
30100fcb78c2SRolf Eike Beer  * @cpu: cpu to use
30110fcb78c2SRolf Eike Beer  * @dwork: job to be done
30120fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
30130fcb78c2SRolf Eike Beer  *
30140fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
30150fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
30160fcb78c2SRolf Eike Beer  */
3017d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3018d4283e93STejun Heo 			      unsigned long delay)
30191da177e4SLinus Torvalds {
3020d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
30211da177e4SLinus Torvalds }
3022ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
30231da177e4SLinus Torvalds 
3024b6136773SAndrew Morton /**
30250a13c00eSTejun Heo  * schedule_delayed_work - put work task in global workqueue after delay
30260a13c00eSTejun Heo  * @dwork: job to be done
30270a13c00eSTejun Heo  * @delay: number of jiffies to wait or 0 for immediate execution
30280a13c00eSTejun Heo  *
30290a13c00eSTejun Heo  * After waiting for a given time this puts a job in the kernel-global
30300a13c00eSTejun Heo  * workqueue.
30310a13c00eSTejun Heo  */
3032d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
30330a13c00eSTejun Heo {
30340a13c00eSTejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
30350a13c00eSTejun Heo }
30360a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work);
30370a13c00eSTejun Heo 
30380a13c00eSTejun Heo /**
303931ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3040b6136773SAndrew Morton  * @func: the function to call
3041b6136773SAndrew Morton  *
304231ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
304331ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3044b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
304531ddd871STejun Heo  *
304631ddd871STejun Heo  * RETURNS:
304731ddd871STejun Heo  * 0 on success, -errno on failure.
3048b6136773SAndrew Morton  */
304965f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
305015316ba8SChristoph Lameter {
305115316ba8SChristoph Lameter 	int cpu;
305238f51568SNamhyung Kim 	struct work_struct __percpu *works;
305315316ba8SChristoph Lameter 
3054b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3055b6136773SAndrew Morton 	if (!works)
305615316ba8SChristoph Lameter 		return -ENOMEM;
3057b6136773SAndrew Morton 
305895402b38SGautham R Shenoy 	get_online_cpus();
305993981800STejun Heo 
306015316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
30619bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
30629bfb1839SIngo Molnar 
30639bfb1839SIngo Molnar 		INIT_WORK(work, func);
30648de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
306515316ba8SChristoph Lameter 	}
306693981800STejun Heo 
306793981800STejun Heo 	for_each_online_cpu(cpu)
30688616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
306993981800STejun Heo 
307095402b38SGautham R Shenoy 	put_online_cpus();
3071b6136773SAndrew Morton 	free_percpu(works);
307215316ba8SChristoph Lameter 	return 0;
307315316ba8SChristoph Lameter }
307415316ba8SChristoph Lameter 
3075eef6a7d5SAlan Stern /**
3076eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3077eef6a7d5SAlan Stern  *
3078eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3079eef6a7d5SAlan Stern  * completion.
3080eef6a7d5SAlan Stern  *
3081eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3082eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3083eef6a7d5SAlan Stern  * will lead to deadlock:
3084eef6a7d5SAlan Stern  *
3085eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3086eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3087eef6a7d5SAlan Stern  *
3088eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3089eef6a7d5SAlan Stern  *
3090eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3091eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3092eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3093eef6a7d5SAlan Stern  *
3094eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3095eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3096eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3097eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3098eef6a7d5SAlan Stern  */
30991da177e4SLinus Torvalds void flush_scheduled_work(void)
31001da177e4SLinus Torvalds {
3101d320c038STejun Heo 	flush_workqueue(system_wq);
31021da177e4SLinus Torvalds }
3103ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
31041da177e4SLinus Torvalds 
31051da177e4SLinus Torvalds /**
31061fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
31071fa44ecaSJames Bottomley  * @fn:		the function to execute
31081fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
31091fa44ecaSJames Bottomley  *		be available when the work executes)
31101fa44ecaSJames Bottomley  *
31111fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
31121fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
31131fa44ecaSJames Bottomley  *
31141fa44ecaSJames Bottomley  * Returns:	0 - function was executed
31151fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31161fa44ecaSJames Bottomley  */
311765f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31181fa44ecaSJames Bottomley {
31191fa44ecaSJames Bottomley 	if (!in_interrupt()) {
312065f27f38SDavid Howells 		fn(&ew->work);
31211fa44ecaSJames Bottomley 		return 0;
31221fa44ecaSJames Bottomley 	}
31231fa44ecaSJames Bottomley 
312465f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31251fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31261fa44ecaSJames Bottomley 
31271fa44ecaSJames Bottomley 	return 1;
31281fa44ecaSJames Bottomley }
31291fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31301fa44ecaSJames Bottomley 
31311da177e4SLinus Torvalds int keventd_up(void)
31321da177e4SLinus Torvalds {
3133d320c038STejun Heo 	return system_wq != NULL;
31341da177e4SLinus Torvalds }
31351da177e4SLinus Torvalds 
3136bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
31371da177e4SLinus Torvalds {
31383af24433SOleg Nesterov 	/*
31390f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
31400f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
31410f900049STejun Heo 	 * unsigned long long.
31423af24433SOleg Nesterov 	 */
31430f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
31440f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
31450f900049STejun Heo 				   __alignof__(unsigned long long));
31463af24433SOleg Nesterov 
3147e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3148f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3149931ac77eSTejun Heo 	else {
31500f900049STejun Heo 		void *ptr;
3151e1d8aa9fSFrederic Weisbecker 
31520f900049STejun Heo 		/*
3153f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3154f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3155f3421797STejun Heo 		 * allocated pointer which will be used for free.
31560f900049STejun Heo 		 */
3157bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3158bdbc5dd7STejun Heo 		if (ptr) {
3159bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3160bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3161bdbc5dd7STejun Heo 		}
31623af24433SOleg Nesterov 	}
31633af24433SOleg Nesterov 
31640415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3165bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3166bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
31670f900049STejun Heo }
31680f900049STejun Heo 
3169bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
317006ba38a9SOleg Nesterov {
3171e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3172bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3173f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3174f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3175f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
317606ba38a9SOleg Nesterov 	}
317706ba38a9SOleg Nesterov }
317806ba38a9SOleg Nesterov 
3179f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3180f3421797STejun Heo 			       const char *name)
3181b71ab8c2STejun Heo {
3182f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3183f3421797STejun Heo 
3184f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3185044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3186f3421797STejun Heo 			max_active, name, 1, lim);
3187b71ab8c2STejun Heo 
3188f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3189b71ab8c2STejun Heo }
3190b71ab8c2STejun Heo 
3191b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
319297e37d7bSTejun Heo 					       unsigned int flags,
31931e19ffc6STejun Heo 					       int max_active,
3194eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3195b196be89STejun Heo 					       const char *lock_name, ...)
31963af24433SOleg Nesterov {
3197b196be89STejun Heo 	va_list args, args1;
31983af24433SOleg Nesterov 	struct workqueue_struct *wq;
3199c34056a3STejun Heo 	unsigned int cpu;
3200b196be89STejun Heo 	size_t namelen;
3201b196be89STejun Heo 
3202b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3203b196be89STejun Heo 	va_start(args, lock_name);
3204b196be89STejun Heo 	va_copy(args1, args);
3205b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3206b196be89STejun Heo 
3207b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3208b196be89STejun Heo 	if (!wq)
3209b196be89STejun Heo 		goto err;
3210b196be89STejun Heo 
3211b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3212b196be89STejun Heo 	va_end(args);
3213b196be89STejun Heo 	va_end(args1);
32143af24433SOleg Nesterov 
3215f3421797STejun Heo 	/*
32166370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
32176370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
32186370a6adSTejun Heo 	 */
32196370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
32206370a6adSTejun Heo 		flags |= WQ_RESCUER;
32216370a6adSTejun Heo 
3222d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3223b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
32243af24433SOleg Nesterov 
3225b196be89STejun Heo 	/* init wq */
322697e37d7bSTejun Heo 	wq->flags = flags;
3227a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
322873f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
322973f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
323073f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
323173f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
32323af24433SOleg Nesterov 
3233eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3234cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
32353af24433SOleg Nesterov 
3236bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3237bdbc5dd7STejun Heo 		goto err;
3238bdbc5dd7STejun Heo 
3239f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
32401537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
32418b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
32423270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
32431537663fSTejun Heo 
32440f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
32453270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3246c34056a3STejun Heo 		cwq->wq = wq;
324773f53c4aSTejun Heo 		cwq->flush_color = -1;
32481e19ffc6STejun Heo 		cwq->max_active = max_active;
32491e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3250e22bee78STejun Heo 	}
32511537663fSTejun Heo 
3252e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3253e22bee78STejun Heo 		struct worker *rescuer;
3254e22bee78STejun Heo 
3255f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3256e22bee78STejun Heo 			goto err;
3257e22bee78STejun Heo 
3258e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3259e22bee78STejun Heo 		if (!rescuer)
3260e22bee78STejun Heo 			goto err;
3261e22bee78STejun Heo 
3262111c225aSTejun Heo 		rescuer->rescue_wq = wq;
3263111c225aSTejun Heo 		rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
3264b196be89STejun Heo 					       wq->name);
3265e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3266e22bee78STejun Heo 			goto err;
3267e22bee78STejun Heo 
3268e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3269e22bee78STejun Heo 		wake_up_process(rescuer->task);
32703af24433SOleg Nesterov 	}
32711537663fSTejun Heo 
32723af24433SOleg Nesterov 	/*
3273a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3274a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3275a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
32763af24433SOleg Nesterov 	 */
32773af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3278a0a1a5fdSTejun Heo 
327958a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3280f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3281a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3282a0a1a5fdSTejun Heo 
32833af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3284a0a1a5fdSTejun Heo 
32853af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
32863af24433SOleg Nesterov 
32873af24433SOleg Nesterov 	return wq;
32884690c4abSTejun Heo err:
32894690c4abSTejun Heo 	if (wq) {
3290bdbc5dd7STejun Heo 		free_cwqs(wq);
3291f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3292e22bee78STejun Heo 		kfree(wq->rescuer);
32934690c4abSTejun Heo 		kfree(wq);
32943af24433SOleg Nesterov 	}
32954690c4abSTejun Heo 	return NULL;
32961da177e4SLinus Torvalds }
3297d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
32981da177e4SLinus Torvalds 
32993af24433SOleg Nesterov /**
33003af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
33013af24433SOleg Nesterov  * @wq: target workqueue
33023af24433SOleg Nesterov  *
33033af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
33043af24433SOleg Nesterov  */
33053af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
33063af24433SOleg Nesterov {
3307c8e55f36STejun Heo 	unsigned int cpu;
33083af24433SOleg Nesterov 
33099c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
33109c5a2ba7STejun Heo 	drain_workqueue(wq);
3311c8efcc25STejun Heo 
3312a0a1a5fdSTejun Heo 	/*
3313a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3314a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3315a0a1a5fdSTejun Heo 	 */
331695402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
33173af24433SOleg Nesterov 	list_del(&wq->list);
331895402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
33193af24433SOleg Nesterov 
3320e22bee78STejun Heo 	/* sanity check */
3321f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
332273f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
332373f53c4aSTejun Heo 		int i;
33243af24433SOleg Nesterov 
332573f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
332673f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
33271e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
33281e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
332973f53c4aSTejun Heo 	}
33301537663fSTejun Heo 
3331e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3332e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3333f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
33348d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3335e22bee78STejun Heo 	}
3336e22bee78STejun Heo 
3337bdbc5dd7STejun Heo 	free_cwqs(wq);
33383af24433SOleg Nesterov 	kfree(wq);
33393af24433SOleg Nesterov }
33403af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
33413af24433SOleg Nesterov 
3342dcd989cbSTejun Heo /**
33439f4bd4cdSLai Jiangshan  * cwq_set_max_active - adjust max_active of a cwq
33449f4bd4cdSLai Jiangshan  * @cwq: target cpu_workqueue_struct
33459f4bd4cdSLai Jiangshan  * @max_active: new max_active value.
33469f4bd4cdSLai Jiangshan  *
33479f4bd4cdSLai Jiangshan  * Set @cwq->max_active to @max_active and activate delayed works if
33489f4bd4cdSLai Jiangshan  * increased.
33499f4bd4cdSLai Jiangshan  *
33509f4bd4cdSLai Jiangshan  * CONTEXT:
33519f4bd4cdSLai Jiangshan  * spin_lock_irq(gcwq->lock).
33529f4bd4cdSLai Jiangshan  */
33539f4bd4cdSLai Jiangshan static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
33549f4bd4cdSLai Jiangshan {
33559f4bd4cdSLai Jiangshan 	cwq->max_active = max_active;
33569f4bd4cdSLai Jiangshan 
33579f4bd4cdSLai Jiangshan 	while (!list_empty(&cwq->delayed_works) &&
33589f4bd4cdSLai Jiangshan 	       cwq->nr_active < cwq->max_active)
33599f4bd4cdSLai Jiangshan 		cwq_activate_first_delayed(cwq);
33609f4bd4cdSLai Jiangshan }
33619f4bd4cdSLai Jiangshan 
33629f4bd4cdSLai Jiangshan /**
3363dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3364dcd989cbSTejun Heo  * @wq: target workqueue
3365dcd989cbSTejun Heo  * @max_active: new max_active value.
3366dcd989cbSTejun Heo  *
3367dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3368dcd989cbSTejun Heo  *
3369dcd989cbSTejun Heo  * CONTEXT:
3370dcd989cbSTejun Heo  * Don't call from IRQ context.
3371dcd989cbSTejun Heo  */
3372dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3373dcd989cbSTejun Heo {
3374dcd989cbSTejun Heo 	unsigned int cpu;
3375dcd989cbSTejun Heo 
3376f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3377dcd989cbSTejun Heo 
3378dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3379dcd989cbSTejun Heo 
3380dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3381dcd989cbSTejun Heo 
3382f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3383dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3384dcd989cbSTejun Heo 
3385dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3386dcd989cbSTejun Heo 
338758a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3388dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
338970369b11SLai Jiangshan 			cwq_set_max_active(get_cwq(gcwq->cpu, wq), max_active);
3390dcd989cbSTejun Heo 
3391dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3392dcd989cbSTejun Heo 	}
3393dcd989cbSTejun Heo 
3394dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3395dcd989cbSTejun Heo }
3396dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3397dcd989cbSTejun Heo 
3398dcd989cbSTejun Heo /**
3399dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3400dcd989cbSTejun Heo  * @cpu: CPU in question
3401dcd989cbSTejun Heo  * @wq: target workqueue
3402dcd989cbSTejun Heo  *
3403dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3404dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3405dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3406dcd989cbSTejun Heo  *
3407dcd989cbSTejun Heo  * RETURNS:
3408dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3409dcd989cbSTejun Heo  */
3410dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3411dcd989cbSTejun Heo {
3412dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3413dcd989cbSTejun Heo 
3414dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3415dcd989cbSTejun Heo }
3416dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3417dcd989cbSTejun Heo 
3418dcd989cbSTejun Heo /**
3419dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3420dcd989cbSTejun Heo  * @work: the work of interest
3421dcd989cbSTejun Heo  *
3422dcd989cbSTejun Heo  * RETURNS:
3423bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3424dcd989cbSTejun Heo  */
3425e2905b29STejun Heo static unsigned int work_cpu(struct work_struct *work)
3426dcd989cbSTejun Heo {
3427dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3428dcd989cbSTejun Heo 
3429bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3430dcd989cbSTejun Heo }
3431dcd989cbSTejun Heo 
3432dcd989cbSTejun Heo /**
3433dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3434dcd989cbSTejun Heo  * @work: the work to be tested
3435dcd989cbSTejun Heo  *
3436dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3437dcd989cbSTejun Heo  * synchronization around this function and the test result is
3438dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3439dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3440dcd989cbSTejun Heo  * running state.
3441dcd989cbSTejun Heo  *
3442dcd989cbSTejun Heo  * RETURNS:
3443dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3444dcd989cbSTejun Heo  */
3445dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3446dcd989cbSTejun Heo {
3447dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3448dcd989cbSTejun Heo 	unsigned long flags;
3449dcd989cbSTejun Heo 	unsigned int ret = 0;
3450dcd989cbSTejun Heo 
3451dcd989cbSTejun Heo 	if (!gcwq)
3452999767beSJoonsoo Kim 		return 0;
3453dcd989cbSTejun Heo 
3454dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3455dcd989cbSTejun Heo 
3456dcd989cbSTejun Heo 	if (work_pending(work))
3457dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3458dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3459dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3460dcd989cbSTejun Heo 
3461dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3462dcd989cbSTejun Heo 
3463dcd989cbSTejun Heo 	return ret;
3464dcd989cbSTejun Heo }
3465dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3466dcd989cbSTejun Heo 
3467db7bccf4STejun Heo /*
3468db7bccf4STejun Heo  * CPU hotplug.
3469db7bccf4STejun Heo  *
3470e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3471e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3472e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3473e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3474e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3475e22bee78STejun Heo  * blocked draining impractical.
3476e22bee78STejun Heo  *
3477*24647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
3478628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
3479628c78e7STejun Heo  * cpu comes back online.
3480db7bccf4STejun Heo  */
3481db7bccf4STejun Heo 
348260373152STejun Heo /* claim manager positions of all pools */
3483b2eb83d1SLai Jiangshan static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
348460373152STejun Heo {
348560373152STejun Heo 	struct worker_pool *pool;
348660373152STejun Heo 
348760373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3488b2eb83d1SLai Jiangshan 		mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
34898db25e78STejun Heo 	spin_lock_irq(&gcwq->lock);
349060373152STejun Heo }
349160373152STejun Heo 
349260373152STejun Heo /* release manager positions */
3493b2eb83d1SLai Jiangshan static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
349460373152STejun Heo {
349560373152STejun Heo 	struct worker_pool *pool;
349660373152STejun Heo 
34978db25e78STejun Heo 	spin_unlock_irq(&gcwq->lock);
349860373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3499b2eb83d1SLai Jiangshan 		mutex_unlock(&pool->assoc_mutex);
350060373152STejun Heo }
350160373152STejun Heo 
3502628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work)
3503db7bccf4STejun Heo {
3504628c78e7STejun Heo 	struct global_cwq *gcwq = get_gcwq(smp_processor_id());
35054ce62e9eSTejun Heo 	struct worker_pool *pool;
3506db7bccf4STejun Heo 	struct worker *worker;
3507db7bccf4STejun Heo 	struct hlist_node *pos;
3508db7bccf4STejun Heo 	int i;
3509db7bccf4STejun Heo 
3510db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3511db7bccf4STejun Heo 
3512b2eb83d1SLai Jiangshan 	gcwq_claim_assoc_and_lock(gcwq);
3513e22bee78STejun Heo 
3514f2d5a0eeSTejun Heo 	/*
3515f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3516f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3517f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3518f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3519f2d5a0eeSTejun Heo 	 */
352060373152STejun Heo 	for_each_worker_pool(pool, gcwq)
35214ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3522403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3523db7bccf4STejun Heo 
3524db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3525403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3526db7bccf4STejun Heo 
3527*24647570STejun Heo 	for_each_worker_pool(pool, gcwq)
3528*24647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
3529f2d5a0eeSTejun Heo 
3530b2eb83d1SLai Jiangshan 	gcwq_release_assoc_and_unlock(gcwq);
3531e22bee78STejun Heo 
3532e22bee78STejun Heo 	/*
3533628c78e7STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3534628c78e7STejun Heo 	 * sched callbacks see the %WORKER_UNBOUND flag.  This is necessary
3535628c78e7STejun Heo 	 * as scheduler callbacks may be invoked from other cpus.
3536628c78e7STejun Heo 	 */
3537628c78e7STejun Heo 	schedule();
3538628c78e7STejun Heo 
3539628c78e7STejun Heo 	/*
3540628c78e7STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After this,
3541628c78e7STejun Heo 	 * nr_running stays zero and need_more_worker() and keep_working()
3542628c78e7STejun Heo 	 * are always true as long as the worklist is not empty.  @gcwq now
3543628c78e7STejun Heo 	 * behaves as unbound (in terms of concurrency management) gcwq
3544628c78e7STejun Heo 	 * which is served by workers tied to the CPU.
3545628c78e7STejun Heo 	 *
3546628c78e7STejun Heo 	 * On return from this function, the current worker would trigger
3547628c78e7STejun Heo 	 * unbound chain execution of pending work items if other workers
3548628c78e7STejun Heo 	 * didn't already.
3549e22bee78STejun Heo 	 */
35504ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35514ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3552db7bccf4STejun Heo }
3553db7bccf4STejun Heo 
35548db25e78STejun Heo /*
35558db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
35568db25e78STejun Heo  * This will be registered high priority CPU notifier.
35578db25e78STejun Heo  */
35589fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
35591da177e4SLinus Torvalds 					       unsigned long action,
35601da177e4SLinus Torvalds 					       void *hcpu)
35611da177e4SLinus Torvalds {
35623af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3563db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
35644ce62e9eSTejun Heo 	struct worker_pool *pool;
35651da177e4SLinus Torvalds 
35668db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
35673af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35684ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35693ce63377STejun Heo 			struct worker *worker;
35703ce63377STejun Heo 
35713ce63377STejun Heo 			if (pool->nr_workers)
35723ce63377STejun Heo 				continue;
35733ce63377STejun Heo 
35743ce63377STejun Heo 			worker = create_worker(pool);
35753ce63377STejun Heo 			if (!worker)
35763ce63377STejun Heo 				return NOTIFY_BAD;
35773ce63377STejun Heo 
35783ce63377STejun Heo 			spin_lock_irq(&gcwq->lock);
35793ce63377STejun Heo 			start_worker(worker);
35803ce63377STejun Heo 			spin_unlock_irq(&gcwq->lock);
35813af24433SOleg Nesterov 		}
35821da177e4SLinus Torvalds 		break;
35831da177e4SLinus Torvalds 
358465758202STejun Heo 	case CPU_DOWN_FAILED:
358565758202STejun Heo 	case CPU_ONLINE:
3586b2eb83d1SLai Jiangshan 		gcwq_claim_assoc_and_lock(gcwq);
3587*24647570STejun Heo 		for_each_worker_pool(pool, gcwq)
3588*24647570STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
35898db25e78STejun Heo 		rebind_workers(gcwq);
3590b2eb83d1SLai Jiangshan 		gcwq_release_assoc_and_unlock(gcwq);
35918db25e78STejun Heo 		break;
359265758202STejun Heo 	}
359365758202STejun Heo 	return NOTIFY_OK;
359465758202STejun Heo }
359565758202STejun Heo 
359665758202STejun Heo /*
359765758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
359865758202STejun Heo  * This will be registered as low priority CPU notifier.
359965758202STejun Heo  */
36009fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
360165758202STejun Heo 						 unsigned long action,
360265758202STejun Heo 						 void *hcpu)
360365758202STejun Heo {
36048db25e78STejun Heo 	unsigned int cpu = (unsigned long)hcpu;
36058db25e78STejun Heo 	struct work_struct unbind_work;
36068db25e78STejun Heo 
360765758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
360865758202STejun Heo 	case CPU_DOWN_PREPARE:
36098db25e78STejun Heo 		/* unbinding should happen on the local CPU */
36108db25e78STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
36117635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
36128db25e78STejun Heo 		flush_work(&unbind_work);
36138db25e78STejun Heo 		break;
361465758202STejun Heo 	}
361565758202STejun Heo 	return NOTIFY_OK;
361665758202STejun Heo }
361765758202STejun Heo 
36182d3854a3SRusty Russell #ifdef CONFIG_SMP
36198ccad40dSRusty Russell 
36202d3854a3SRusty Russell struct work_for_cpu {
3621ed48ece2STejun Heo 	struct work_struct work;
36222d3854a3SRusty Russell 	long (*fn)(void *);
36232d3854a3SRusty Russell 	void *arg;
36242d3854a3SRusty Russell 	long ret;
36252d3854a3SRusty Russell };
36262d3854a3SRusty Russell 
3627ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
36282d3854a3SRusty Russell {
3629ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3630ed48ece2STejun Heo 
36312d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36322d3854a3SRusty Russell }
36332d3854a3SRusty Russell 
36342d3854a3SRusty Russell /**
36352d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36362d3854a3SRusty Russell  * @cpu: the cpu to run on
36372d3854a3SRusty Russell  * @fn: the function to run
36382d3854a3SRusty Russell  * @arg: the function arg
36392d3854a3SRusty Russell  *
364031ad9081SRusty Russell  * This will return the value @fn returns.
364131ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36426b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36432d3854a3SRusty Russell  */
36442d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36452d3854a3SRusty Russell {
3646ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
36472d3854a3SRusty Russell 
3648ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3649ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
3650ed48ece2STejun Heo 	flush_work(&wfc.work);
36512d3854a3SRusty Russell 	return wfc.ret;
36522d3854a3SRusty Russell }
36532d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36542d3854a3SRusty Russell #endif /* CONFIG_SMP */
36552d3854a3SRusty Russell 
3656a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3657e7577c50SRusty Russell 
3658a0a1a5fdSTejun Heo /**
3659a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3660a0a1a5fdSTejun Heo  *
366158a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
366258a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
366358a69cb4STejun Heo  * gcwq->worklist.
3664a0a1a5fdSTejun Heo  *
3665a0a1a5fdSTejun Heo  * CONTEXT:
36668b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3667a0a1a5fdSTejun Heo  */
3668a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3669a0a1a5fdSTejun Heo {
3670a0a1a5fdSTejun Heo 	unsigned int cpu;
3671a0a1a5fdSTejun Heo 
3672a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3673a0a1a5fdSTejun Heo 
3674a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3675a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3676a0a1a5fdSTejun Heo 
3677f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
36788b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3679bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
36808b03ae3cSTejun Heo 
36818b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
36828b03ae3cSTejun Heo 
3683db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3684db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
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 
3770db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3771db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3772db7bccf4STejun Heo 
3773a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3774a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3775a0a1a5fdSTejun Heo 
377658a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3777a0a1a5fdSTejun Heo 				continue;
3778a0a1a5fdSTejun Heo 
3779a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
37809f4bd4cdSLai Jiangshan 			cwq_set_max_active(cwq, wq->saved_max_active);
3781a0a1a5fdSTejun Heo 		}
37828b03ae3cSTejun Heo 
37834ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
37844ce62e9eSTejun Heo 			wake_up_worker(pool);
3785e22bee78STejun Heo 
37868b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3787a0a1a5fdSTejun Heo 	}
3788a0a1a5fdSTejun Heo 
3789a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3790a0a1a5fdSTejun Heo out_unlock:
3791a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3792a0a1a5fdSTejun Heo }
3793a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3794a0a1a5fdSTejun Heo 
37956ee0578bSSuresh Siddha static int __init init_workqueues(void)
37961da177e4SLinus Torvalds {
3797c34056a3STejun Heo 	unsigned int cpu;
3798c34056a3STejun Heo 
3799b5490077STejun Heo 	/* make sure we have enough bits for OFFQ CPU number */
3800b5490077STejun Heo 	BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3801b5490077STejun Heo 		     WORK_CPU_LAST);
3802b5490077STejun Heo 
380365758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3804a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
38058b03ae3cSTejun Heo 
38068b03ae3cSTejun Heo 	/* initialize gcwqs */
3807f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38088b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38094ce62e9eSTejun Heo 		struct worker_pool *pool;
38108b03ae3cSTejun Heo 
38118b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
38128b03ae3cSTejun Heo 		gcwq->cpu = cpu;
38138b03ae3cSTejun Heo 
381442f8570fSSasha Levin 		hash_init(gcwq->busy_hash);
3815c8e55f36STejun Heo 
38164ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38174ce62e9eSTejun Heo 			pool->gcwq = gcwq;
3818*24647570STejun Heo 			pool->flags |= POOL_DISASSOCIATED;
38194ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38204ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3821e22bee78STejun Heo 
38224ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38234ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38244ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3825e22bee78STejun Heo 
38264ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38274ce62e9eSTejun Heo 				    (unsigned long)pool);
38284ce62e9eSTejun Heo 
3829b2eb83d1SLai Jiangshan 			mutex_init(&pool->assoc_mutex);
38304ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38314ce62e9eSTejun Heo 		}
38328b03ae3cSTejun Heo 	}
38338b03ae3cSTejun Heo 
3834e22bee78STejun Heo 	/* create the initial worker */
3835f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3836e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38374ce62e9eSTejun Heo 		struct worker_pool *pool;
3838e22bee78STejun Heo 
38394ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38404ce62e9eSTejun Heo 			struct worker *worker;
38414ce62e9eSTejun Heo 
3842*24647570STejun Heo 			if (cpu != WORK_CPU_UNBOUND)
3843*24647570STejun Heo 				pool->flags &= ~POOL_DISASSOCIATED;
3844*24647570STejun Heo 
3845bc2ae0f5STejun Heo 			worker = create_worker(pool);
3846e22bee78STejun Heo 			BUG_ON(!worker);
3847e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3848e22bee78STejun Heo 			start_worker(worker);
3849e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3850e22bee78STejun Heo 		}
38514ce62e9eSTejun Heo 	}
3852e22bee78STejun Heo 
3853d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
38541aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
3855d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3856f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3857f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
385824d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
385924d51addSTejun Heo 					      WQ_FREEZABLE, 0);
38601aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
3861ae930e0fSTejun Heo 	       !system_unbound_wq || !system_freezable_wq);
38626ee0578bSSuresh Siddha 	return 0;
38631da177e4SLinus Torvalds }
38646ee0578bSSuresh Siddha early_initcall(init_workqueues);
3865