xref: /linux-6.15/kernel/workqueue.c (revision ae930e0f)
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>
44e22bee78STejun Heo 
45e22bee78STejun Heo #include "workqueue_sched.h"
461da177e4SLinus Torvalds 
47c8e55f36STejun Heo enum {
48bc2ae0f5STejun Heo 	/*
49bc2ae0f5STejun Heo 	 * global_cwq flags
50bc2ae0f5STejun Heo 	 *
51bc2ae0f5STejun Heo 	 * A bound gcwq is either associated or disassociated with its CPU.
52bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
53bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
54bc2ae0f5STejun Heo 	 * is in effect.
55bc2ae0f5STejun Heo 	 *
56bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
57bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
58bc2ae0f5STejun Heo 	 * be executing on any CPU.  The gcwq behaves as an unbound one.
59bc2ae0f5STejun Heo 	 *
60bc2ae0f5STejun Heo 	 * Note that DISASSOCIATED can be flipped only while holding
61bc2ae0f5STejun Heo 	 * managership of all pools on the gcwq to avoid changing binding
62bc2ae0f5STejun Heo 	 * state while create_worker() is in progress.
63bc2ae0f5STejun Heo 	 */
6411ebea50STejun Heo 	GCWQ_DISASSOCIATED	= 1 << 0,	/* cpu can't serve workers */
6511ebea50STejun Heo 	GCWQ_FREEZING		= 1 << 1,	/* freeze in progress */
6611ebea50STejun Heo 
6711ebea50STejun Heo 	/* pool flags */
6811ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
69db7bccf4STejun Heo 
70c8e55f36STejun Heo 	/* worker flags */
71c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
72c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
73c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
74e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
75e22bee78STejun Heo 	WORKER_REBIND		= 1 << 5,	/* mom is home, come back */
76fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
77f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
78e22bee78STejun Heo 
79403c821dSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_REBIND | WORKER_UNBOUND |
80403c821dSTejun Heo 				  WORKER_CPU_INTENSIVE,
81db7bccf4STejun Heo 
823270476aSTejun Heo 	NR_WORKER_POOLS		= 2,		/* # worker pools per gcwq */
834ce62e9eSTejun Heo 
84c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
85c8e55f36STejun Heo 	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
86c8e55f36STejun Heo 	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
87db7bccf4STejun Heo 
88e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
89e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
90e22bee78STejun Heo 
913233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
923233cdbdSTejun Heo 						/* call for help after 10ms
933233cdbdSTejun Heo 						   (min two ticks) */
94e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
95e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
961da177e4SLinus Torvalds 
971da177e4SLinus Torvalds 	/*
98e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
99e22bee78STejun Heo 	 * all cpus.  Give -20.
100e22bee78STejun Heo 	 */
101e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
1023270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
103c8e55f36STejun Heo };
104c8e55f36STejun Heo 
1051da177e4SLinus Torvalds /*
1064690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1074690c4abSTejun Heo  *
108e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
109e41e704bSTejun Heo  *    everyone else.
1104690c4abSTejun Heo  *
111e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
112e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
113e22bee78STejun Heo  *
1148b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1154690c4abSTejun Heo  *
116e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
117e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
118e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
119f3421797STejun Heo  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
120e22bee78STejun Heo  *
12173f53c4aSTejun Heo  * F: wq->flush_mutex protected.
12273f53c4aSTejun Heo  *
1234690c4abSTejun Heo  * W: workqueue_lock protected.
1244690c4abSTejun Heo  */
1254690c4abSTejun Heo 
1268b03ae3cSTejun Heo struct global_cwq;
127bd7bdd43STejun Heo struct worker_pool;
12825511a47STejun Heo struct idle_rebind;
129c34056a3STejun Heo 
130e22bee78STejun Heo /*
131e22bee78STejun Heo  * The poor guys doing the actual heavy lifting.  All on-duty workers
132e22bee78STejun Heo  * are either serving the manager role, on idle list or on busy hash.
133e22bee78STejun Heo  */
134c34056a3STejun Heo struct worker {
135c8e55f36STejun Heo 	/* on idle list while idle, on busy hash table while busy */
136c8e55f36STejun Heo 	union {
137c8e55f36STejun Heo 		struct list_head	entry;	/* L: while idle */
138c8e55f36STejun Heo 		struct hlist_node	hentry;	/* L: while busy */
139c8e55f36STejun Heo 	};
140c8e55f36STejun Heo 
141c34056a3STejun Heo 	struct work_struct	*current_work;	/* L: work being processed */
1428cca0eeaSTejun Heo 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
143affee4b2STejun Heo 	struct list_head	scheduled;	/* L: scheduled works */
144c34056a3STejun Heo 	struct task_struct	*task;		/* I: worker task */
145bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
146e22bee78STejun Heo 	/* 64 bytes boundary on 64bit, 32 on 32bit */
147e22bee78STejun Heo 	unsigned long		last_active;	/* L: last active timestamp */
148e22bee78STejun Heo 	unsigned int		flags;		/* X: flags */
149c34056a3STejun Heo 	int			id;		/* I: worker id */
15025511a47STejun Heo 
15125511a47STejun Heo 	/* for rebinding worker to CPU */
15225511a47STejun Heo 	struct idle_rebind	*idle_rebind;	/* L: for idle worker */
15325511a47STejun Heo 	struct work_struct	rebind_work;	/* L: for busy worker */
154c34056a3STejun Heo };
155c34056a3STejun Heo 
156bd7bdd43STejun Heo struct worker_pool {
157bd7bdd43STejun Heo 	struct global_cwq	*gcwq;		/* I: the owning gcwq */
15811ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
159bd7bdd43STejun Heo 
160bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
161bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
162bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
163bd7bdd43STejun Heo 
164bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
165bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
166bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
167bd7bdd43STejun Heo 
16860373152STejun Heo 	struct mutex		manager_mutex;	/* mutex manager should hold */
169bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
170bd7bdd43STejun Heo };
171bd7bdd43STejun Heo 
1724690c4abSTejun Heo /*
173e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
174e22bee78STejun Heo  * and all works are queued and processed here regardless of their
175e22bee78STejun Heo  * target workqueues.
1768b03ae3cSTejun Heo  */
1778b03ae3cSTejun Heo struct global_cwq {
1788b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1798b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
180db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
181c8e55f36STejun Heo 
182bd7bdd43STejun Heo 	/* workers are chained either in busy_hash or pool idle_list */
183c8e55f36STejun Heo 	struct hlist_head	busy_hash[BUSY_WORKER_HASH_SIZE];
184c8e55f36STejun Heo 						/* L: hash of busy workers */
185c8e55f36STejun Heo 
186330dad5bSJoonsoo Kim 	struct worker_pool	pools[NR_WORKER_POOLS];
187330dad5bSJoonsoo Kim 						/* normal and highpri pools */
188db7bccf4STejun Heo 
18925511a47STejun Heo 	wait_queue_head_t	rebind_hold;	/* rebind hold wait */
1908b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1918b03ae3cSTejun Heo 
1928b03ae3cSTejun Heo /*
193502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1940f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1950f900049STejun Heo  * aligned at two's power of the number of flag bits.
1961da177e4SLinus Torvalds  */
1971da177e4SLinus Torvalds struct cpu_workqueue_struct {
198bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1994690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
20073f53c4aSTejun Heo 	int			work_color;	/* L: current color */
20173f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
20273f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
20373f53c4aSTejun Heo 						/* L: nr of in_flight works */
2041e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
205a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
2061e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
2070f900049STejun Heo };
2081da177e4SLinus Torvalds 
2091da177e4SLinus Torvalds /*
21073f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
21173f53c4aSTejun Heo  */
21273f53c4aSTejun Heo struct wq_flusher {
21373f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
21473f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
21573f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
21673f53c4aSTejun Heo };
2171da177e4SLinus Torvalds 
21873f53c4aSTejun Heo /*
219f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
220f2e005aaSTejun Heo  * used to determine whether there's something to be done.
221f2e005aaSTejun Heo  */
222f2e005aaSTejun Heo #ifdef CONFIG_SMP
223f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
224f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
225f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
226f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
227f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2289c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
229f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
230f2e005aaSTejun Heo #else
231f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
232f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
233f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
234f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
235f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
236f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
237f2e005aaSTejun Heo #endif
2381da177e4SLinus Torvalds 
2391da177e4SLinus Torvalds /*
2401da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2411da177e4SLinus Torvalds  * per-CPU workqueues:
2421da177e4SLinus Torvalds  */
2431da177e4SLinus Torvalds struct workqueue_struct {
2449c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
245bdbc5dd7STejun Heo 	union {
246bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
247bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
248bdbc5dd7STejun Heo 		unsigned long				v;
249bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2504690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
25173f53c4aSTejun Heo 
25273f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
25373f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
25473f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
25573f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
25673f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
25773f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
25873f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
25973f53c4aSTejun Heo 
260f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
261e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
262e22bee78STejun Heo 
2639c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
264dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2654e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2664e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2674e6045f1SJohannes Berg #endif
268b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2691da177e4SLinus Torvalds };
2701da177e4SLinus Torvalds 
271d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
272d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
273044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
2741aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
275044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
276d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
277044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
278f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
279044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
28024d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
281d320c038STejun Heo 
28297bd2347STejun Heo #define CREATE_TRACE_POINTS
28397bd2347STejun Heo #include <trace/events/workqueue.h>
28497bd2347STejun Heo 
2854ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
2863270476aSTejun Heo 	for ((pool) = &(gcwq)->pools[0];				\
2873270476aSTejun Heo 	     (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
2884ce62e9eSTejun Heo 
289db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
290db7bccf4STejun Heo 	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
291db7bccf4STejun Heo 		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
292db7bccf4STejun Heo 
293f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
294f3421797STejun Heo 				  unsigned int sw)
295f3421797STejun Heo {
296f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
297f3421797STejun Heo 		if (sw & 1) {
298f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
299f3421797STejun Heo 			if (cpu < nr_cpu_ids)
300f3421797STejun Heo 				return cpu;
301f3421797STejun Heo 		}
302f3421797STejun Heo 		if (sw & 2)
303f3421797STejun Heo 			return WORK_CPU_UNBOUND;
304f3421797STejun Heo 	}
305f3421797STejun Heo 	return WORK_CPU_NONE;
306f3421797STejun Heo }
307f3421797STejun Heo 
308f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
309f3421797STejun Heo 				struct workqueue_struct *wq)
310f3421797STejun Heo {
311f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
312f3421797STejun Heo }
313f3421797STejun Heo 
31409884951STejun Heo /*
31509884951STejun Heo  * CPU iterators
31609884951STejun Heo  *
31709884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
31809884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
31909884951STejun Heo  * specific CPU.  The following iterators are similar to
32009884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
32109884951STejun Heo  *
32209884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
32309884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
32409884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
32509884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
32609884951STejun Heo  */
327f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
328f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
329f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
330f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
331f3421797STejun Heo 
332f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
333f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
334f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
335f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
336f3421797STejun Heo 
337f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
338f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
339f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
340f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
341f3421797STejun Heo 
342dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
343dc186ad7SThomas Gleixner 
344dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
345dc186ad7SThomas Gleixner 
34699777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
34799777288SStanislaw Gruszka {
34899777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
34999777288SStanislaw Gruszka }
35099777288SStanislaw Gruszka 
351dc186ad7SThomas Gleixner /*
352dc186ad7SThomas Gleixner  * fixup_init is called when:
353dc186ad7SThomas Gleixner  * - an active object is initialized
354dc186ad7SThomas Gleixner  */
355dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
356dc186ad7SThomas Gleixner {
357dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
358dc186ad7SThomas Gleixner 
359dc186ad7SThomas Gleixner 	switch (state) {
360dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
361dc186ad7SThomas Gleixner 		cancel_work_sync(work);
362dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
363dc186ad7SThomas Gleixner 		return 1;
364dc186ad7SThomas Gleixner 	default:
365dc186ad7SThomas Gleixner 		return 0;
366dc186ad7SThomas Gleixner 	}
367dc186ad7SThomas Gleixner }
368dc186ad7SThomas Gleixner 
369dc186ad7SThomas Gleixner /*
370dc186ad7SThomas Gleixner  * fixup_activate is called when:
371dc186ad7SThomas Gleixner  * - an active object is activated
372dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
373dc186ad7SThomas Gleixner  */
374dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
375dc186ad7SThomas Gleixner {
376dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
377dc186ad7SThomas Gleixner 
378dc186ad7SThomas Gleixner 	switch (state) {
379dc186ad7SThomas Gleixner 
380dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
381dc186ad7SThomas Gleixner 		/*
382dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
383dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
384dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
385dc186ad7SThomas Gleixner 		 */
38622df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
387dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
388dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
389dc186ad7SThomas Gleixner 			return 0;
390dc186ad7SThomas Gleixner 		}
391dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
392dc186ad7SThomas Gleixner 		return 0;
393dc186ad7SThomas Gleixner 
394dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
395dc186ad7SThomas Gleixner 		WARN_ON(1);
396dc186ad7SThomas Gleixner 
397dc186ad7SThomas Gleixner 	default:
398dc186ad7SThomas Gleixner 		return 0;
399dc186ad7SThomas Gleixner 	}
400dc186ad7SThomas Gleixner }
401dc186ad7SThomas Gleixner 
402dc186ad7SThomas Gleixner /*
403dc186ad7SThomas Gleixner  * fixup_free is called when:
404dc186ad7SThomas Gleixner  * - an active object is freed
405dc186ad7SThomas Gleixner  */
406dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
407dc186ad7SThomas Gleixner {
408dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
409dc186ad7SThomas Gleixner 
410dc186ad7SThomas Gleixner 	switch (state) {
411dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
412dc186ad7SThomas Gleixner 		cancel_work_sync(work);
413dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
414dc186ad7SThomas Gleixner 		return 1;
415dc186ad7SThomas Gleixner 	default:
416dc186ad7SThomas Gleixner 		return 0;
417dc186ad7SThomas Gleixner 	}
418dc186ad7SThomas Gleixner }
419dc186ad7SThomas Gleixner 
420dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
421dc186ad7SThomas Gleixner 	.name		= "work_struct",
42299777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
423dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
424dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
425dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
426dc186ad7SThomas Gleixner };
427dc186ad7SThomas Gleixner 
428dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
429dc186ad7SThomas Gleixner {
430dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
431dc186ad7SThomas Gleixner }
432dc186ad7SThomas Gleixner 
433dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
434dc186ad7SThomas Gleixner {
435dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
436dc186ad7SThomas Gleixner }
437dc186ad7SThomas Gleixner 
438dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
439dc186ad7SThomas Gleixner {
440dc186ad7SThomas Gleixner 	if (onstack)
441dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
442dc186ad7SThomas Gleixner 	else
443dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
444dc186ad7SThomas Gleixner }
445dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
446dc186ad7SThomas Gleixner 
447dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
448dc186ad7SThomas Gleixner {
449dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
450dc186ad7SThomas Gleixner }
451dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
452dc186ad7SThomas Gleixner 
453dc186ad7SThomas Gleixner #else
454dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
455dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
456dc186ad7SThomas Gleixner #endif
457dc186ad7SThomas Gleixner 
45895402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
45995402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4601da177e4SLinus Torvalds static LIST_HEAD(workqueues);
461a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4621da177e4SLinus Torvalds 
46314441960SOleg Nesterov /*
464e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
465e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
466e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
46714441960SOleg Nesterov  */
4688b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
4694ce62e9eSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
470f756d5e2SNathan Lynch 
471f3421797STejun Heo /*
472f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
473f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
474f3421797STejun Heo  * workers have WORKER_UNBOUND set.
475f3421797STejun Heo  */
476f3421797STejun Heo static struct global_cwq unbound_global_cwq;
4774ce62e9eSTejun Heo static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
4784ce62e9eSTejun Heo 	[0 ... NR_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4794ce62e9eSTejun Heo };
480f3421797STejun Heo 
481c34056a3STejun Heo static int worker_thread(void *__worker);
4821da177e4SLinus Torvalds 
4833270476aSTejun Heo static int worker_pool_pri(struct worker_pool *pool)
4843270476aSTejun Heo {
4853270476aSTejun Heo 	return pool - pool->gcwq->pools;
4863270476aSTejun Heo }
4873270476aSTejun Heo 
4888b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4891da177e4SLinus Torvalds {
490f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4918b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
492f3421797STejun Heo 	else
493f3421797STejun Heo 		return &unbound_global_cwq;
4941da177e4SLinus Torvalds }
4951da177e4SLinus Torvalds 
49663d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
497b1f4ec17SOleg Nesterov {
49863d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
4993270476aSTejun Heo 	int idx = worker_pool_pri(pool);
50063d95a91STejun Heo 
501f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
5024ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
503f3421797STejun Heo 	else
5044ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
505b1f4ec17SOleg Nesterov }
506b1f4ec17SOleg Nesterov 
5074690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
5084690c4abSTejun Heo 					    struct workqueue_struct *wq)
509a848e3b6SOleg Nesterov {
510f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
511e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
512bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
513f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
514f3421797STejun Heo 		return wq->cpu_wq.single;
515f3421797STejun Heo 	return NULL;
516f3421797STejun Heo }
517a848e3b6SOleg Nesterov 
51873f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
51973f53c4aSTejun Heo {
52073f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
52173f53c4aSTejun Heo }
52273f53c4aSTejun Heo 
52373f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
52473f53c4aSTejun Heo {
52573f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
52673f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
52773f53c4aSTejun Heo }
52873f53c4aSTejun Heo 
52973f53c4aSTejun Heo static int work_next_color(int color)
53073f53c4aSTejun Heo {
53173f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5321da177e4SLinus Torvalds }
5331da177e4SLinus Torvalds 
5344594bf15SDavid Howells /*
535b5490077STejun Heo  * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
536b5490077STejun Heo  * contain the pointer to the queued cwq.  Once execution starts, the flag
537b5490077STejun Heo  * is cleared and the high bits contain OFFQ flags and CPU number.
5387a22ad75STejun Heo  *
539bbb68dfaSTejun Heo  * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
540bbb68dfaSTejun Heo  * and clear_work_data() can be used to set the cwq, cpu or clear
541bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
542bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5437a22ad75STejun Heo  *
544bbb68dfaSTejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
545bbb68dfaSTejun Heo  * a work.  gcwq is available once the work has been queued anywhere after
546bbb68dfaSTejun Heo  * initialization until it is sync canceled.  cwq is available only while
547bbb68dfaSTejun Heo  * the work item is queued.
548bbb68dfaSTejun Heo  *
549bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
550bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
551bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
552bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5534594bf15SDavid Howells  */
5547a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5557a22ad75STejun Heo 				 unsigned long flags)
5567a22ad75STejun Heo {
5577a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5587a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5597a22ad75STejun Heo }
5607a22ad75STejun Heo 
5617a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5624690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5634690c4abSTejun Heo 			 unsigned long extra_flags)
564365970a1SDavid Howells {
5657a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
566e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
567365970a1SDavid Howells }
568365970a1SDavid Howells 
5698930cabaSTejun Heo static void set_work_cpu_and_clear_pending(struct work_struct *work,
5708930cabaSTejun Heo 					   unsigned int cpu)
5714d707b9fSOleg Nesterov {
57223657bb1STejun Heo 	/*
57323657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
57423657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
57523657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
57623657bb1STejun Heo 	 * owner.
57723657bb1STejun Heo 	 */
57823657bb1STejun Heo 	smp_wmb();
579b5490077STejun Heo 	set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
5804d707b9fSOleg Nesterov }
5814d707b9fSOleg Nesterov 
5827a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
583365970a1SDavid Howells {
58423657bb1STejun Heo 	smp_wmb();	/* see set_work_cpu_and_clear_pending() */
5857a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5867a22ad75STejun Heo }
5877a22ad75STejun Heo 
5887a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5897a22ad75STejun Heo {
590e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5917a22ad75STejun Heo 
592e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
593e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
594e120153dSTejun Heo 	else
595e120153dSTejun Heo 		return NULL;
5967a22ad75STejun Heo }
5977a22ad75STejun Heo 
5987a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5997a22ad75STejun Heo {
600e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
6017a22ad75STejun Heo 	unsigned int cpu;
6027a22ad75STejun Heo 
603e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
604e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
605bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
6067a22ad75STejun Heo 
607b5490077STejun Heo 	cpu = data >> WORK_OFFQ_CPU_SHIFT;
608bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
6097a22ad75STejun Heo 		return NULL;
6107a22ad75STejun Heo 
611f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
6127a22ad75STejun Heo 	return get_gcwq(cpu);
613365970a1SDavid Howells }
614365970a1SDavid Howells 
615bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
616bbb68dfaSTejun Heo {
617bbb68dfaSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
618bbb68dfaSTejun Heo 	unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
619bbb68dfaSTejun Heo 
620bbb68dfaSTejun Heo 	set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
621bbb68dfaSTejun Heo 		      WORK_STRUCT_PENDING);
622bbb68dfaSTejun Heo }
623bbb68dfaSTejun Heo 
624bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
625bbb68dfaSTejun Heo {
626bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
627bbb68dfaSTejun Heo 
628bbb68dfaSTejun Heo 	return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
629bbb68dfaSTejun Heo }
630bbb68dfaSTejun Heo 
631e22bee78STejun Heo /*
6323270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
6333270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
6343270476aSTejun Heo  * they're being called with gcwq->lock held.
635e22bee78STejun Heo  */
636e22bee78STejun Heo 
63763d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
638649027d7STejun Heo {
6393270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
640649027d7STejun Heo }
641649027d7STejun Heo 
642e22bee78STejun Heo /*
643e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
644e22bee78STejun Heo  * running workers.
645974271c4STejun Heo  *
646974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
647974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
648974271c4STejun Heo  * worklist isn't empty.
649e22bee78STejun Heo  */
65063d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
651e22bee78STejun Heo {
65263d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
653e22bee78STejun Heo }
654e22bee78STejun Heo 
655e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
65663d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
657e22bee78STejun Heo {
65863d95a91STejun Heo 	return pool->nr_idle;
659e22bee78STejun Heo }
660e22bee78STejun Heo 
661e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
66263d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
663e22bee78STejun Heo {
66463d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
665e22bee78STejun Heo 
6663270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
667e22bee78STejun Heo }
668e22bee78STejun Heo 
669e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
67063d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
671e22bee78STejun Heo {
67263d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
673e22bee78STejun Heo }
674e22bee78STejun Heo 
675e22bee78STejun Heo /* Do I need to be the manager? */
67663d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
677e22bee78STejun Heo {
67863d95a91STejun Heo 	return need_to_create_worker(pool) ||
67911ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
680e22bee78STejun Heo }
681e22bee78STejun Heo 
682e22bee78STejun Heo /* Do we have too many workers and should some go away? */
68363d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
684e22bee78STejun Heo {
68560373152STejun Heo 	bool managing = mutex_is_locked(&pool->manager_mutex);
68663d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
68763d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
688e22bee78STejun Heo 
689e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
690e22bee78STejun Heo }
691e22bee78STejun Heo 
692e22bee78STejun Heo /*
693e22bee78STejun Heo  * Wake up functions.
694e22bee78STejun Heo  */
695e22bee78STejun Heo 
6967e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
69763d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
6987e11629dSTejun Heo {
69963d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
7007e11629dSTejun Heo 		return NULL;
7017e11629dSTejun Heo 
70263d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
7037e11629dSTejun Heo }
7047e11629dSTejun Heo 
7057e11629dSTejun Heo /**
7067e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
70763d95a91STejun Heo  * @pool: worker pool to wake worker from
7087e11629dSTejun Heo  *
70963d95a91STejun Heo  * Wake up the first idle worker of @pool.
7107e11629dSTejun Heo  *
7117e11629dSTejun Heo  * CONTEXT:
7127e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
7137e11629dSTejun Heo  */
71463d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
7157e11629dSTejun Heo {
71663d95a91STejun Heo 	struct worker *worker = first_worker(pool);
7177e11629dSTejun Heo 
7187e11629dSTejun Heo 	if (likely(worker))
7197e11629dSTejun Heo 		wake_up_process(worker->task);
7207e11629dSTejun Heo }
7217e11629dSTejun Heo 
7224690c4abSTejun Heo /**
723e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
724e22bee78STejun Heo  * @task: task waking up
725e22bee78STejun Heo  * @cpu: CPU @task is waking up to
726e22bee78STejun Heo  *
727e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
728e22bee78STejun Heo  * being awoken.
729e22bee78STejun Heo  *
730e22bee78STejun Heo  * CONTEXT:
731e22bee78STejun Heo  * spin_lock_irq(rq->lock)
732e22bee78STejun Heo  */
733e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
734e22bee78STejun Heo {
735e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
736e22bee78STejun Heo 
7372d64672eSSteven Rostedt 	if (!(worker->flags & WORKER_NOT_RUNNING))
73863d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
739e22bee78STejun Heo }
740e22bee78STejun Heo 
741e22bee78STejun Heo /**
742e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
743e22bee78STejun Heo  * @task: task going to sleep
744e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
745e22bee78STejun Heo  *
746e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
747e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
748e22bee78STejun Heo  * returning pointer to its task.
749e22bee78STejun Heo  *
750e22bee78STejun Heo  * CONTEXT:
751e22bee78STejun Heo  * spin_lock_irq(rq->lock)
752e22bee78STejun Heo  *
753e22bee78STejun Heo  * RETURNS:
754e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
755e22bee78STejun Heo  */
756e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
757e22bee78STejun Heo 				       unsigned int cpu)
758e22bee78STejun Heo {
759e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
760bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
76163d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
762e22bee78STejun Heo 
7632d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
764e22bee78STejun Heo 		return NULL;
765e22bee78STejun Heo 
766e22bee78STejun Heo 	/* this can only happen on the local cpu */
767e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
768e22bee78STejun Heo 
769e22bee78STejun Heo 	/*
770e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
771e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
772e22bee78STejun Heo 	 * Please read comment there.
773e22bee78STejun Heo 	 *
774628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
775628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
776628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
777628c78e7STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without gcwq
778628c78e7STejun Heo 	 * lock is safe.
779e22bee78STejun Heo 	 */
780bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
78163d95a91STejun Heo 		to_wakeup = first_worker(pool);
782e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
783e22bee78STejun Heo }
784e22bee78STejun Heo 
785e22bee78STejun Heo /**
786e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
787cb444766STejun Heo  * @worker: self
788d302f017STejun Heo  * @flags: flags to set
789d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
790d302f017STejun Heo  *
791e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
792e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
793e22bee78STejun Heo  * woken up.
794d302f017STejun Heo  *
795cb444766STejun Heo  * CONTEXT:
796cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
797d302f017STejun Heo  */
798d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
799d302f017STejun Heo 				    bool wakeup)
800d302f017STejun Heo {
801bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
802e22bee78STejun Heo 
803cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
804cb444766STejun Heo 
805e22bee78STejun Heo 	/*
806e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
807e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
808e22bee78STejun Heo 	 * @wakeup.
809e22bee78STejun Heo 	 */
810e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
811e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
81263d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
813e22bee78STejun Heo 
814e22bee78STejun Heo 		if (wakeup) {
815e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
816bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
81763d95a91STejun Heo 				wake_up_worker(pool);
818e22bee78STejun Heo 		} else
819e22bee78STejun Heo 			atomic_dec(nr_running);
820e22bee78STejun Heo 	}
821e22bee78STejun Heo 
822d302f017STejun Heo 	worker->flags |= flags;
823d302f017STejun Heo }
824d302f017STejun Heo 
825d302f017STejun Heo /**
826e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
827cb444766STejun Heo  * @worker: self
828d302f017STejun Heo  * @flags: flags to clear
829d302f017STejun Heo  *
830e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
831d302f017STejun Heo  *
832cb444766STejun Heo  * CONTEXT:
833cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
834d302f017STejun Heo  */
835d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
836d302f017STejun Heo {
83763d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
838e22bee78STejun Heo 	unsigned int oflags = worker->flags;
839e22bee78STejun Heo 
840cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
841cb444766STejun Heo 
842d302f017STejun Heo 	worker->flags &= ~flags;
843e22bee78STejun Heo 
84442c025f3STejun Heo 	/*
84542c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
84642c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
84742c025f3STejun Heo 	 * of multiple flags, not a single flag.
84842c025f3STejun Heo 	 */
849e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
850e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
85163d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
852d302f017STejun Heo }
853d302f017STejun Heo 
854d302f017STejun Heo /**
855c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
856c8e55f36STejun Heo  * @gcwq: gcwq of interest
857c8e55f36STejun Heo  * @work: work to be hashed
858c8e55f36STejun Heo  *
859c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
860c8e55f36STejun Heo  *
861c8e55f36STejun Heo  * CONTEXT:
862c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
863c8e55f36STejun Heo  *
864c8e55f36STejun Heo  * RETURNS:
865c8e55f36STejun Heo  * Pointer to the hash head.
866c8e55f36STejun Heo  */
867c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
868c8e55f36STejun Heo 					   struct work_struct *work)
869c8e55f36STejun Heo {
870c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
871c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
872c8e55f36STejun Heo 
873c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
874c8e55f36STejun Heo 	v >>= base_shift;
875c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
876c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
877c8e55f36STejun Heo 
878c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
879c8e55f36STejun Heo }
880c8e55f36STejun Heo 
881c8e55f36STejun Heo /**
8828cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
8838cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8848cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
8858cca0eeaSTejun Heo  * @work: work to find worker for
8868cca0eeaSTejun Heo  *
8878cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
8888cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
8898cca0eeaSTejun Heo  * work.
8908cca0eeaSTejun Heo  *
8918cca0eeaSTejun Heo  * CONTEXT:
8928cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8938cca0eeaSTejun Heo  *
8948cca0eeaSTejun Heo  * RETURNS:
8958cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8968cca0eeaSTejun Heo  * otherwise.
8978cca0eeaSTejun Heo  */
8988cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
8998cca0eeaSTejun Heo 						   struct hlist_head *bwh,
9008cca0eeaSTejun Heo 						   struct work_struct *work)
9018cca0eeaSTejun Heo {
9028cca0eeaSTejun Heo 	struct worker *worker;
9038cca0eeaSTejun Heo 	struct hlist_node *tmp;
9048cca0eeaSTejun Heo 
9058cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
9068cca0eeaSTejun Heo 		if (worker->current_work == work)
9078cca0eeaSTejun Heo 			return worker;
9088cca0eeaSTejun Heo 	return NULL;
9098cca0eeaSTejun Heo }
9108cca0eeaSTejun Heo 
9118cca0eeaSTejun Heo /**
9128cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
9138cca0eeaSTejun Heo  * @gcwq: gcwq of interest
9148cca0eeaSTejun Heo  * @work: work to find worker for
9158cca0eeaSTejun Heo  *
9168cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
9178cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
9188cca0eeaSTejun Heo  * function calculates @bwh itself.
9198cca0eeaSTejun Heo  *
9208cca0eeaSTejun Heo  * CONTEXT:
9218cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
9228cca0eeaSTejun Heo  *
9238cca0eeaSTejun Heo  * RETURNS:
9248cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
9258cca0eeaSTejun Heo  * otherwise.
9268cca0eeaSTejun Heo  */
9278cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
9288cca0eeaSTejun Heo 						 struct work_struct *work)
9298cca0eeaSTejun Heo {
9308cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
9318cca0eeaSTejun Heo 					    work);
9328cca0eeaSTejun Heo }
9338cca0eeaSTejun Heo 
9348cca0eeaSTejun Heo /**
935bf4ede01STejun Heo  * move_linked_works - move linked works to a list
936bf4ede01STejun Heo  * @work: start of series of works to be scheduled
937bf4ede01STejun Heo  * @head: target list to append @work to
938bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
939bf4ede01STejun Heo  *
940bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
941bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
942bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
943bf4ede01STejun Heo  *
944bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
945bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
946bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
947bf4ede01STejun Heo  *
948bf4ede01STejun Heo  * CONTEXT:
949bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
950bf4ede01STejun Heo  */
951bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
952bf4ede01STejun Heo 			      struct work_struct **nextp)
953bf4ede01STejun Heo {
954bf4ede01STejun Heo 	struct work_struct *n;
955bf4ede01STejun Heo 
956bf4ede01STejun Heo 	/*
957bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
958bf4ede01STejun Heo 	 * use NULL for list head.
959bf4ede01STejun Heo 	 */
960bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
961bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
962bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
963bf4ede01STejun Heo 			break;
964bf4ede01STejun Heo 	}
965bf4ede01STejun Heo 
966bf4ede01STejun Heo 	/*
967bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
968bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
969bf4ede01STejun Heo 	 * needs to be updated.
970bf4ede01STejun Heo 	 */
971bf4ede01STejun Heo 	if (nextp)
972bf4ede01STejun Heo 		*nextp = n;
973bf4ede01STejun Heo }
974bf4ede01STejun Heo 
975bf4ede01STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
976bf4ede01STejun Heo {
977bf4ede01STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
978bf4ede01STejun Heo 						    struct work_struct, entry);
979bf4ede01STejun Heo 
980bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
981bf4ede01STejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
982bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
983bf4ede01STejun Heo 	cwq->nr_active++;
984bf4ede01STejun Heo }
985bf4ede01STejun Heo 
986bf4ede01STejun Heo /**
987bf4ede01STejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
988bf4ede01STejun Heo  * @cwq: cwq of interest
989bf4ede01STejun Heo  * @color: color of work which left the queue
990bf4ede01STejun Heo  * @delayed: for a delayed work
991bf4ede01STejun Heo  *
992bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
993bf4ede01STejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
994bf4ede01STejun Heo  *
995bf4ede01STejun Heo  * CONTEXT:
996bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
997bf4ede01STejun Heo  */
998bf4ede01STejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
999bf4ede01STejun Heo 				 bool delayed)
1000bf4ede01STejun Heo {
1001bf4ede01STejun Heo 	/* ignore uncolored works */
1002bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
1003bf4ede01STejun Heo 		return;
1004bf4ede01STejun Heo 
1005bf4ede01STejun Heo 	cwq->nr_in_flight[color]--;
1006bf4ede01STejun Heo 
1007bf4ede01STejun Heo 	if (!delayed) {
1008bf4ede01STejun Heo 		cwq->nr_active--;
1009bf4ede01STejun Heo 		if (!list_empty(&cwq->delayed_works)) {
1010bf4ede01STejun Heo 			/* one down, submit a delayed one */
1011bf4ede01STejun Heo 			if (cwq->nr_active < cwq->max_active)
1012bf4ede01STejun Heo 				cwq_activate_first_delayed(cwq);
1013bf4ede01STejun Heo 		}
1014bf4ede01STejun Heo 	}
1015bf4ede01STejun Heo 
1016bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1017bf4ede01STejun Heo 	if (likely(cwq->flush_color != color))
1018bf4ede01STejun Heo 		return;
1019bf4ede01STejun Heo 
1020bf4ede01STejun Heo 	/* are there still in-flight works? */
1021bf4ede01STejun Heo 	if (cwq->nr_in_flight[color])
1022bf4ede01STejun Heo 		return;
1023bf4ede01STejun Heo 
1024bf4ede01STejun Heo 	/* this cwq is done, clear flush_color */
1025bf4ede01STejun Heo 	cwq->flush_color = -1;
1026bf4ede01STejun Heo 
1027bf4ede01STejun Heo 	/*
1028bf4ede01STejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
1029bf4ede01STejun Heo 	 * will handle the rest.
1030bf4ede01STejun Heo 	 */
1031bf4ede01STejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1032bf4ede01STejun Heo 		complete(&cwq->wq->first_flusher->done);
1033bf4ede01STejun Heo }
1034bf4ede01STejun Heo 
103536e227d2STejun Heo /**
1036bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
103736e227d2STejun Heo  * @work: work item to steal
103836e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1039bbb68dfaSTejun Heo  * @flags: place to store irq state
104036e227d2STejun Heo  *
104136e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
104236e227d2STejun Heo  * stable state - idle, on timer or on worklist.  Return values are
104336e227d2STejun Heo  *
104436e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
104536e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
104636e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1047bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1048bbb68dfaSTejun Heo  *		for arbitrarily long
104936e227d2STejun Heo  *
1050bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1051bbb68dfaSTejun Heo  * preempted while holding PENDING and @work off queue, preemption must be
1052bbb68dfaSTejun Heo  * disabled on entry.  This ensures that we don't return -EAGAIN while
1053bbb68dfaSTejun Heo  * another task is preempted in this function.
1054bbb68dfaSTejun Heo  *
1055bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1056bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1057bbb68dfaSTejun Heo  *
1058bbb68dfaSTejun Heo  * This function is safe to call from any context other than IRQ handler.
1059bbb68dfaSTejun Heo  * An IRQ handler may run on top of delayed_work_timer_fn() which can make
1060bbb68dfaSTejun Heo  * this function return -EAGAIN perpetually.
1061bf4ede01STejun Heo  */
1062bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1063bbb68dfaSTejun Heo 			       unsigned long *flags)
1064bf4ede01STejun Heo {
1065bf4ede01STejun Heo 	struct global_cwq *gcwq;
1066bf4ede01STejun Heo 
1067bbb68dfaSTejun Heo 	WARN_ON_ONCE(in_irq());
1068bbb68dfaSTejun Heo 
1069bbb68dfaSTejun Heo 	local_irq_save(*flags);
1070bbb68dfaSTejun Heo 
107136e227d2STejun Heo 	/* try to steal the timer if it exists */
107236e227d2STejun Heo 	if (is_dwork) {
107336e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
107436e227d2STejun Heo 
107536e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
107636e227d2STejun Heo 			return 1;
107736e227d2STejun Heo 	}
107836e227d2STejun Heo 
107936e227d2STejun Heo 	/* try to claim PENDING the normal way */
1080bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1081bf4ede01STejun Heo 		return 0;
1082bf4ede01STejun Heo 
1083bf4ede01STejun Heo 	/*
1084bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1085bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1086bf4ede01STejun Heo 	 */
1087bf4ede01STejun Heo 	gcwq = get_work_gcwq(work);
1088bf4ede01STejun Heo 	if (!gcwq)
1089bbb68dfaSTejun Heo 		goto fail;
1090bf4ede01STejun Heo 
1091bbb68dfaSTejun Heo 	spin_lock(&gcwq->lock);
1092bf4ede01STejun Heo 	if (!list_empty(&work->entry)) {
1093bf4ede01STejun Heo 		/*
1094bf4ede01STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
1095bf4ede01STejun Heo 		 * In that case we must see the new value after rmb(), see
1096bf4ede01STejun Heo 		 * insert_work()->wmb().
1097bf4ede01STejun Heo 		 */
1098bf4ede01STejun Heo 		smp_rmb();
1099bf4ede01STejun Heo 		if (gcwq == get_work_gcwq(work)) {
1100bf4ede01STejun Heo 			debug_work_deactivate(work);
1101bf4ede01STejun Heo 			list_del_init(&work->entry);
1102bf4ede01STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
1103bf4ede01STejun Heo 				get_work_color(work),
1104bf4ede01STejun Heo 				*work_data_bits(work) & WORK_STRUCT_DELAYED);
110536e227d2STejun Heo 
1106bbb68dfaSTejun Heo 			spin_unlock(&gcwq->lock);
110736e227d2STejun Heo 			return 1;
1108bf4ede01STejun Heo 		}
1109bf4ede01STejun Heo 	}
1110bbb68dfaSTejun Heo 	spin_unlock(&gcwq->lock);
1111bbb68dfaSTejun Heo fail:
1112bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1113bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1114bbb68dfaSTejun Heo 		return -ENOENT;
1115bbb68dfaSTejun Heo 	cpu_relax();
111636e227d2STejun Heo 	return -EAGAIN;
1117bf4ede01STejun Heo }
1118bf4ede01STejun Heo 
1119bf4ede01STejun Heo /**
11207e11629dSTejun Heo  * insert_work - insert a work into gcwq
11214690c4abSTejun Heo  * @cwq: cwq @work belongs to
11224690c4abSTejun Heo  * @work: work to insert
11234690c4abSTejun Heo  * @head: insertion point
11244690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
11254690c4abSTejun Heo  *
11267e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
11277e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
11284690c4abSTejun Heo  *
11294690c4abSTejun Heo  * CONTEXT:
11308b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
11311da177e4SLinus Torvalds  */
1132b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
11334690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
11344690c4abSTejun Heo 			unsigned int extra_flags)
1135b89deed3SOleg Nesterov {
113663d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
1137e1d8aa9fSFrederic Weisbecker 
11384690c4abSTejun Heo 	/* we own @work, set data and link */
11397a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
11404690c4abSTejun Heo 
11416e84d644SOleg Nesterov 	/*
11426e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
11436e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
11446e84d644SOleg Nesterov 	 */
11456e84d644SOleg Nesterov 	smp_wmb();
11464690c4abSTejun Heo 
11471a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
1148e22bee78STejun Heo 
1149e22bee78STejun Heo 	/*
1150e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
1151e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
1152e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
1153e22bee78STejun Heo 	 */
1154e22bee78STejun Heo 	smp_mb();
1155e22bee78STejun Heo 
115663d95a91STejun Heo 	if (__need_more_worker(pool))
115763d95a91STejun Heo 		wake_up_worker(pool);
1158b89deed3SOleg Nesterov }
1159b89deed3SOleg Nesterov 
1160c8efcc25STejun Heo /*
1161c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
1162c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
1163c8efcc25STejun Heo  * cold paths.
1164c8efcc25STejun Heo  */
1165c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1166c8efcc25STejun Heo {
1167c8efcc25STejun Heo 	unsigned long flags;
1168c8efcc25STejun Heo 	unsigned int cpu;
1169c8efcc25STejun Heo 
1170c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
1171c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
1172c8efcc25STejun Heo 		struct worker *worker;
1173c8efcc25STejun Heo 		struct hlist_node *pos;
1174c8efcc25STejun Heo 		int i;
1175c8efcc25STejun Heo 
1176c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1177c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
1178c8efcc25STejun Heo 			if (worker->task != current)
1179c8efcc25STejun Heo 				continue;
1180c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
1181c8efcc25STejun Heo 			/*
1182c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
1183c8efcc25STejun Heo 			 * is headed to the same workqueue.
1184c8efcc25STejun Heo 			 */
1185c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
1186c8efcc25STejun Heo 		}
1187c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
1188c8efcc25STejun Heo 	}
1189c8efcc25STejun Heo 	return false;
1190c8efcc25STejun Heo }
1191c8efcc25STejun Heo 
11924690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
11931da177e4SLinus Torvalds 			 struct work_struct *work)
11941da177e4SLinus Torvalds {
1195502ca9d8STejun Heo 	struct global_cwq *gcwq;
1196502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
11971e19ffc6STejun Heo 	struct list_head *worklist;
11988a2e8e5dSTejun Heo 	unsigned int work_flags;
1199b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
12008930cabaSTejun Heo 
12018930cabaSTejun Heo 	/*
12028930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
12038930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
12048930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
12058930cabaSTejun Heo 	 * happen with IRQ disabled.
12068930cabaSTejun Heo 	 */
12078930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
12081da177e4SLinus Torvalds 
1209dc186ad7SThomas Gleixner 	debug_work_activate(work);
12101e19ffc6STejun Heo 
1211c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
12129c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1213c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1214e41e704bSTejun Heo 		return;
1215e41e704bSTejun Heo 
1216c7fc77f7STejun Heo 	/* determine gcwq to use */
1217c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1218c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1219c7fc77f7STejun Heo 
122057469821STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
1221f3421797STejun Heo 			cpu = raw_smp_processor_id();
1222f3421797STejun Heo 
122318aa9effSTejun Heo 		/*
1224dbf2576eSTejun Heo 		 * It's multi cpu.  If @work was previously on a different
1225dbf2576eSTejun Heo 		 * cpu, it might still be running there, in which case the
1226dbf2576eSTejun Heo 		 * work needs to be queued on that cpu to guarantee
1227dbf2576eSTejun Heo 		 * non-reentrancy.
122818aa9effSTejun Heo 		 */
1229502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
1230dbf2576eSTejun Heo 		last_gcwq = get_work_gcwq(work);
1231dbf2576eSTejun Heo 
1232dbf2576eSTejun Heo 		if (last_gcwq && last_gcwq != gcwq) {
123318aa9effSTejun Heo 			struct worker *worker;
123418aa9effSTejun Heo 
12358930cabaSTejun Heo 			spin_lock(&last_gcwq->lock);
123618aa9effSTejun Heo 
123718aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
123818aa9effSTejun Heo 
123918aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
124018aa9effSTejun Heo 				gcwq = last_gcwq;
124118aa9effSTejun Heo 			else {
124218aa9effSTejun Heo 				/* meh... not running there, queue here */
12438930cabaSTejun Heo 				spin_unlock(&last_gcwq->lock);
12448930cabaSTejun Heo 				spin_lock(&gcwq->lock);
124518aa9effSTejun Heo 			}
12468930cabaSTejun Heo 		} else {
12478930cabaSTejun Heo 			spin_lock(&gcwq->lock);
12488930cabaSTejun Heo 		}
1249f3421797STejun Heo 	} else {
1250f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
12518930cabaSTejun Heo 		spin_lock(&gcwq->lock);
1252502ca9d8STejun Heo 	}
1253502ca9d8STejun Heo 
1254502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1255502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1256b75cac93SJoonsoo Kim 	trace_workqueue_queue_work(req_cpu, cwq, work);
1257502ca9d8STejun Heo 
1258f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
12598930cabaSTejun Heo 		spin_unlock(&gcwq->lock);
1260f5b2552bSDan Carpenter 		return;
1261f5b2552bSDan Carpenter 	}
12621e19ffc6STejun Heo 
126373f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
12648a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
12651e19ffc6STejun Heo 
12661e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1267cdadf009STejun Heo 		trace_workqueue_activate_work(work);
12681e19ffc6STejun Heo 		cwq->nr_active++;
12693270476aSTejun Heo 		worklist = &cwq->pool->worklist;
12708a2e8e5dSTejun Heo 	} else {
12718a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
12721e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
12738a2e8e5dSTejun Heo 	}
12741e19ffc6STejun Heo 
12758a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
12761e19ffc6STejun Heo 
12778930cabaSTejun Heo 	spin_unlock(&gcwq->lock);
12781da177e4SLinus Torvalds }
12791da177e4SLinus Torvalds 
12800fcb78c2SRolf Eike Beer /**
1281c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1282c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1283c1a220e7SZhang Rui  * @wq: workqueue to use
1284c1a220e7SZhang Rui  * @work: work to queue
1285c1a220e7SZhang Rui  *
1286d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
1287c1a220e7SZhang Rui  *
1288c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1289c1a220e7SZhang Rui  * can't go away.
1290c1a220e7SZhang Rui  */
1291d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1292d4283e93STejun Heo 		   struct work_struct *work)
1293c1a220e7SZhang Rui {
1294d4283e93STejun Heo 	bool ret = false;
12958930cabaSTejun Heo 	unsigned long flags;
12968930cabaSTejun Heo 
12978930cabaSTejun Heo 	local_irq_save(flags);
1298c1a220e7SZhang Rui 
129922df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
13004690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1301d4283e93STejun Heo 		ret = true;
1302c1a220e7SZhang Rui 	}
13038930cabaSTejun Heo 
13048930cabaSTejun Heo 	local_irq_restore(flags);
1305c1a220e7SZhang Rui 	return ret;
1306c1a220e7SZhang Rui }
1307c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1308c1a220e7SZhang Rui 
13090a13c00eSTejun Heo /**
13100a13c00eSTejun Heo  * queue_work - queue work on a workqueue
13110a13c00eSTejun Heo  * @wq: workqueue to use
13120a13c00eSTejun Heo  * @work: work to queue
13130a13c00eSTejun Heo  *
1314d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
13150a13c00eSTejun Heo  *
13160a13c00eSTejun Heo  * We queue the work to the CPU on which it was submitted, but if the CPU dies
13170a13c00eSTejun Heo  * it can be processed by another CPU.
13180a13c00eSTejun Heo  */
1319d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
13200a13c00eSTejun Heo {
132157469821STejun Heo 	return queue_work_on(WORK_CPU_UNBOUND, wq, work);
13220a13c00eSTejun Heo }
13230a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work);
13240a13c00eSTejun Heo 
1325d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
13261da177e4SLinus Torvalds {
132752bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
13287a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
13291da177e4SLinus Torvalds 
13308930cabaSTejun Heo 	local_irq_disable();
13311265057fSTejun Heo 	__queue_work(dwork->cpu, cwq->wq, &dwork->work);
13328930cabaSTejun Heo 	local_irq_enable();
13331da177e4SLinus Torvalds }
1334d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
13351da177e4SLinus Torvalds 
13367beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
13377beb2edfSTejun Heo 				struct delayed_work *dwork, unsigned long delay)
13387beb2edfSTejun Heo {
13397beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
13407beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
13417beb2edfSTejun Heo 	unsigned int lcpu;
13427beb2edfSTejun Heo 
13437beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
13447beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
13457beb2edfSTejun Heo 	BUG_ON(timer_pending(timer));
13467beb2edfSTejun Heo 	BUG_ON(!list_empty(&work->entry));
13477beb2edfSTejun Heo 
13487beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
13497beb2edfSTejun Heo 
13507beb2edfSTejun Heo 	/*
13517beb2edfSTejun Heo 	 * This stores cwq for the moment, for the timer_fn.  Note that the
13527beb2edfSTejun Heo 	 * work's gcwq is preserved to allow reentrance detection for
13537beb2edfSTejun Heo 	 * delayed works.
13547beb2edfSTejun Heo 	 */
13557beb2edfSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
13567beb2edfSTejun Heo 		struct global_cwq *gcwq = get_work_gcwq(work);
13577beb2edfSTejun Heo 
1358e42986deSJoonsoo Kim 		/*
1359e42986deSJoonsoo Kim 		 * If we cannot get the last gcwq from @work directly,
1360e42986deSJoonsoo Kim 		 * select the last CPU such that it avoids unnecessarily
1361e42986deSJoonsoo Kim 		 * triggering non-reentrancy check in __queue_work().
1362e42986deSJoonsoo Kim 		 */
1363e42986deSJoonsoo Kim 		lcpu = cpu;
1364e42986deSJoonsoo Kim 		if (gcwq)
13657beb2edfSTejun Heo 			lcpu = gcwq->cpu;
1366e42986deSJoonsoo Kim 		if (lcpu == WORK_CPU_UNBOUND)
13677beb2edfSTejun Heo 			lcpu = raw_smp_processor_id();
13687beb2edfSTejun Heo 	} else {
13697beb2edfSTejun Heo 		lcpu = WORK_CPU_UNBOUND;
13707beb2edfSTejun Heo 	}
13717beb2edfSTejun Heo 
13727beb2edfSTejun Heo 	set_work_cwq(work, get_cwq(lcpu, wq), 0);
13737beb2edfSTejun Heo 
13741265057fSTejun Heo 	dwork->cpu = cpu;
13757beb2edfSTejun Heo 	timer->expires = jiffies + delay;
13767beb2edfSTejun Heo 
13777beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
13787beb2edfSTejun Heo 		add_timer_on(timer, cpu);
13797beb2edfSTejun Heo 	else
13807beb2edfSTejun Heo 		add_timer(timer);
13817beb2edfSTejun Heo }
13827beb2edfSTejun Heo 
13830fcb78c2SRolf Eike Beer /**
13840fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
13850fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
13860fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1387af9997e4SRandy Dunlap  * @dwork: work to queue
13880fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
13890fcb78c2SRolf Eike Beer  *
1390715f1300STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.  If
1391715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1392715f1300STejun Heo  * execution.
13930fcb78c2SRolf Eike Beer  */
1394d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
139552bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
13967a6bc1cdSVenkatesh Pallipadi {
139752bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1398d4283e93STejun Heo 	bool ret = false;
13998930cabaSTejun Heo 	unsigned long flags;
14008930cabaSTejun Heo 
1401715f1300STejun Heo 	if (!delay)
1402715f1300STejun Heo 		return queue_work_on(cpu, wq, &dwork->work);
1403715f1300STejun Heo 
14048930cabaSTejun Heo 	/* read the comment in __queue_work() */
14058930cabaSTejun Heo 	local_irq_save(flags);
14067a6bc1cdSVenkatesh Pallipadi 
140722df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14087beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1409d4283e93STejun Heo 		ret = true;
14107a6bc1cdSVenkatesh Pallipadi 	}
14118930cabaSTejun Heo 
14128930cabaSTejun Heo 	local_irq_restore(flags);
14137a6bc1cdSVenkatesh Pallipadi 	return ret;
14147a6bc1cdSVenkatesh Pallipadi }
1415ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
14161da177e4SLinus Torvalds 
1417c8e55f36STejun Heo /**
14180a13c00eSTejun Heo  * queue_delayed_work - queue work on a workqueue after delay
14190a13c00eSTejun Heo  * @wq: workqueue to use
14200a13c00eSTejun Heo  * @dwork: delayable work to queue
14210a13c00eSTejun Heo  * @delay: number of jiffies to wait before queueing
14220a13c00eSTejun Heo  *
1423715f1300STejun Heo  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
14240a13c00eSTejun Heo  */
1425d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq,
14260a13c00eSTejun Heo 			struct delayed_work *dwork, unsigned long delay)
14270a13c00eSTejun Heo {
142857469821STejun Heo 	return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14290a13c00eSTejun Heo }
14300a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work);
14310a13c00eSTejun Heo 
14320a13c00eSTejun Heo /**
14338376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
14348376fe22STejun Heo  * @cpu: CPU number to execute work on
14358376fe22STejun Heo  * @wq: workqueue to use
14368376fe22STejun Heo  * @dwork: work to queue
14378376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14388376fe22STejun Heo  *
14398376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
14408376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
14418376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
14428376fe22STejun Heo  * current state.
14438376fe22STejun Heo  *
14448376fe22STejun Heo  * Returns %false if @dwork was idle and queued, %true if @dwork was
14458376fe22STejun Heo  * pending and its timer was modified.
14468376fe22STejun Heo  *
14478376fe22STejun Heo  * This function is safe to call from any context other than IRQ handler.
14488376fe22STejun Heo  * See try_to_grab_pending() for details.
14498376fe22STejun Heo  */
14508376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
14518376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
14528376fe22STejun Heo {
14538376fe22STejun Heo 	unsigned long flags;
14548376fe22STejun Heo 	int ret;
14558376fe22STejun Heo 
14568376fe22STejun Heo 	do {
14578376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
14588376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
14598376fe22STejun Heo 
14608376fe22STejun Heo 	if (likely(ret >= 0)) {
14618376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
14628376fe22STejun Heo 		local_irq_restore(flags);
14638376fe22STejun Heo 	}
14648376fe22STejun Heo 
14658376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
14668376fe22STejun Heo 	return ret;
14678376fe22STejun Heo }
14688376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
14698376fe22STejun Heo 
14708376fe22STejun Heo /**
14718376fe22STejun Heo  * mod_delayed_work - modify delay of or queue a delayed work
14728376fe22STejun Heo  * @wq: workqueue to use
14738376fe22STejun Heo  * @dwork: work to queue
14748376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14758376fe22STejun Heo  *
14768376fe22STejun Heo  * mod_delayed_work_on() on local CPU.
14778376fe22STejun Heo  */
14788376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
14798376fe22STejun Heo 		      unsigned long delay)
14808376fe22STejun Heo {
14818376fe22STejun Heo 	return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14828376fe22STejun Heo }
14838376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work);
14848376fe22STejun Heo 
14858376fe22STejun Heo /**
1486c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1487c8e55f36STejun Heo  * @worker: worker which is entering idle state
1488c8e55f36STejun Heo  *
1489c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1490c8e55f36STejun Heo  * necessary.
1491c8e55f36STejun Heo  *
1492c8e55f36STejun Heo  * LOCKING:
1493c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1494c8e55f36STejun Heo  */
1495c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
14961da177e4SLinus Torvalds {
1497bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1498bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1499c8e55f36STejun Heo 
1500c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1501c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1502c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1503c8e55f36STejun Heo 
1504cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1505cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1506bd7bdd43STejun Heo 	pool->nr_idle++;
1507e22bee78STejun Heo 	worker->last_active = jiffies;
1508c8e55f36STejun Heo 
1509c8e55f36STejun Heo 	/* idle_list is LIFO */
1510bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1511db7bccf4STejun Heo 
151263d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1513628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1514cb444766STejun Heo 
1515544ecf31STejun Heo 	/*
1516628c78e7STejun Heo 	 * Sanity check nr_running.  Because gcwq_unbind_fn() releases
1517628c78e7STejun Heo 	 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1518628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1519628c78e7STejun Heo 	 * unbind is not in progress.
1520544ecf31STejun Heo 	 */
1521628c78e7STejun Heo 	WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
1522bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
152363d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1524c8e55f36STejun Heo }
1525c8e55f36STejun Heo 
1526c8e55f36STejun Heo /**
1527c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1528c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1529c8e55f36STejun Heo  *
1530c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1531c8e55f36STejun Heo  *
1532c8e55f36STejun Heo  * LOCKING:
1533c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1534c8e55f36STejun Heo  */
1535c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1536c8e55f36STejun Heo {
1537bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1538c8e55f36STejun Heo 
1539c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1540d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1541bd7bdd43STejun Heo 	pool->nr_idle--;
1542c8e55f36STejun Heo 	list_del_init(&worker->entry);
1543c8e55f36STejun Heo }
1544c8e55f36STejun Heo 
1545e22bee78STejun Heo /**
1546e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1547e22bee78STejun Heo  * @worker: self
1548e22bee78STejun Heo  *
1549e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1550e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1551e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1552e22bee78STejun Heo  * guaranteed to execute on the cpu.
1553e22bee78STejun Heo  *
1554e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1555e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1556e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1557e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1558e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1559e22bee78STejun Heo  * [dis]associated in the meantime.
1560e22bee78STejun Heo  *
1561f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1562f2d5a0eeSTejun Heo  * binding against %GCWQ_DISASSOCIATED which is set during
1563f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1564f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1565f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1566e22bee78STejun Heo  *
1567e22bee78STejun Heo  * CONTEXT:
1568e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1569e22bee78STejun Heo  * held.
1570e22bee78STejun Heo  *
1571e22bee78STejun Heo  * RETURNS:
1572e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1573e22bee78STejun Heo  * bound), %false if offline.
1574e22bee78STejun Heo  */
1575e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1576972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1577e22bee78STejun Heo {
1578bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1579e22bee78STejun Heo 	struct task_struct *task = worker->task;
1580e22bee78STejun Heo 
1581e22bee78STejun Heo 	while (true) {
1582e22bee78STejun Heo 		/*
1583e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1584e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1585e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1586e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1587e22bee78STejun Heo 		 */
1588f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1589e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1590e22bee78STejun Heo 
1591e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1592e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1593e22bee78STejun Heo 			return false;
1594e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1595e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1596e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1597e22bee78STejun Heo 			return true;
1598e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1599e22bee78STejun Heo 
16005035b20fSTejun Heo 		/*
16015035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
16025035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
16035035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
16045035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
16055035b20fSTejun Heo 		 */
1606e22bee78STejun Heo 		cpu_relax();
16075035b20fSTejun Heo 		cond_resched();
1608e22bee78STejun Heo 	}
1609e22bee78STejun Heo }
1610e22bee78STejun Heo 
161125511a47STejun Heo struct idle_rebind {
161225511a47STejun Heo 	int			cnt;		/* # workers to be rebound */
161325511a47STejun Heo 	struct completion	done;		/* all workers rebound */
161425511a47STejun Heo };
161525511a47STejun Heo 
1616e22bee78STejun Heo /*
161725511a47STejun Heo  * Rebind an idle @worker to its CPU.  During CPU onlining, this has to
161825511a47STejun Heo  * happen synchronously for idle workers.  worker_thread() will test
161925511a47STejun Heo  * %WORKER_REBIND before leaving idle and call this function.
162025511a47STejun Heo  */
162125511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
162225511a47STejun Heo {
162325511a47STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
162425511a47STejun Heo 
162525511a47STejun Heo 	/* CPU must be online at this point */
162625511a47STejun Heo 	WARN_ON(!worker_maybe_bind_and_lock(worker));
162725511a47STejun Heo 	if (!--worker->idle_rebind->cnt)
162825511a47STejun Heo 		complete(&worker->idle_rebind->done);
162925511a47STejun Heo 	spin_unlock_irq(&worker->pool->gcwq->lock);
163025511a47STejun Heo 
163125511a47STejun Heo 	/* we did our part, wait for rebind_workers() to finish up */
163225511a47STejun Heo 	wait_event(gcwq->rebind_hold, !(worker->flags & WORKER_REBIND));
163325511a47STejun Heo }
163425511a47STejun Heo 
163525511a47STejun Heo /*
163625511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1637403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1638403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1639403c821dSTejun Heo  * executed twice without intervening cpu down.
1640e22bee78STejun Heo  */
164125511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1642e22bee78STejun Heo {
1643e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1644bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1645e22bee78STejun Heo 
1646e22bee78STejun Heo 	if (worker_maybe_bind_and_lock(worker))
1647e22bee78STejun Heo 		worker_clr_flags(worker, WORKER_REBIND);
1648e22bee78STejun Heo 
1649e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1650e22bee78STejun Heo }
1651e22bee78STejun Heo 
165225511a47STejun Heo /**
165325511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
165425511a47STejun Heo  * @gcwq: gcwq of interest
165525511a47STejun Heo  *
165625511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
165725511a47STejun Heo  * is different for idle and busy ones.
165825511a47STejun Heo  *
165925511a47STejun Heo  * The idle ones should be rebound synchronously and idle rebinding should
166025511a47STejun Heo  * be complete before any worker starts executing work items with
166125511a47STejun Heo  * concurrency management enabled; otherwise, scheduler may oops trying to
166225511a47STejun Heo  * wake up non-local idle worker from wq_worker_sleeping().
166325511a47STejun Heo  *
166425511a47STejun Heo  * This is achieved by repeatedly requesting rebinding until all idle
166525511a47STejun Heo  * workers are known to have been rebound under @gcwq->lock and holding all
166625511a47STejun Heo  * idle workers from becoming busy until idle rebinding is complete.
166725511a47STejun Heo  *
166825511a47STejun Heo  * Once idle workers are rebound, busy workers can be rebound as they
166925511a47STejun Heo  * finish executing their current work items.  Queueing the rebind work at
167025511a47STejun Heo  * the head of their scheduled lists is enough.  Note that nr_running will
167125511a47STejun Heo  * be properbly bumped as busy workers rebind.
167225511a47STejun Heo  *
167325511a47STejun Heo  * On return, all workers are guaranteed to either be bound or have rebind
167425511a47STejun Heo  * work item scheduled.
167525511a47STejun Heo  */
167625511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
167725511a47STejun Heo 	__releases(&gcwq->lock) __acquires(&gcwq->lock)
167825511a47STejun Heo {
167925511a47STejun Heo 	struct idle_rebind idle_rebind;
168025511a47STejun Heo 	struct worker_pool *pool;
168125511a47STejun Heo 	struct worker *worker;
168225511a47STejun Heo 	struct hlist_node *pos;
168325511a47STejun Heo 	int i;
168425511a47STejun Heo 
168525511a47STejun Heo 	lockdep_assert_held(&gcwq->lock);
168625511a47STejun Heo 
168725511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
168825511a47STejun Heo 		lockdep_assert_held(&pool->manager_mutex);
168925511a47STejun Heo 
169025511a47STejun Heo 	/*
169125511a47STejun Heo 	 * Rebind idle workers.  Interlocked both ways.  We wait for
169225511a47STejun Heo 	 * workers to rebind via @idle_rebind.done.  Workers will wait for
169325511a47STejun Heo 	 * us to finish up by watching %WORKER_REBIND.
169425511a47STejun Heo 	 */
169525511a47STejun Heo 	init_completion(&idle_rebind.done);
169625511a47STejun Heo retry:
169725511a47STejun Heo 	idle_rebind.cnt = 1;
169825511a47STejun Heo 	INIT_COMPLETION(idle_rebind.done);
169925511a47STejun Heo 
170025511a47STejun Heo 	/* set REBIND and kick idle ones, we'll wait for these later */
170125511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
170225511a47STejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry) {
170325511a47STejun Heo 			if (worker->flags & WORKER_REBIND)
170425511a47STejun Heo 				continue;
170525511a47STejun Heo 
170625511a47STejun Heo 			/* morph UNBOUND to REBIND */
170725511a47STejun Heo 			worker->flags &= ~WORKER_UNBOUND;
170825511a47STejun Heo 			worker->flags |= WORKER_REBIND;
170925511a47STejun Heo 
171025511a47STejun Heo 			idle_rebind.cnt++;
171125511a47STejun Heo 			worker->idle_rebind = &idle_rebind;
171225511a47STejun Heo 
171325511a47STejun Heo 			/* worker_thread() will call idle_worker_rebind() */
171425511a47STejun Heo 			wake_up_process(worker->task);
171525511a47STejun Heo 		}
171625511a47STejun Heo 	}
171725511a47STejun Heo 
171825511a47STejun Heo 	if (--idle_rebind.cnt) {
171925511a47STejun Heo 		spin_unlock_irq(&gcwq->lock);
172025511a47STejun Heo 		wait_for_completion(&idle_rebind.done);
172125511a47STejun Heo 		spin_lock_irq(&gcwq->lock);
172225511a47STejun Heo 		/* busy ones might have become idle while waiting, retry */
172325511a47STejun Heo 		goto retry;
172425511a47STejun Heo 	}
172525511a47STejun Heo 
172625511a47STejun Heo 	/*
172725511a47STejun Heo 	 * All idle workers are rebound and waiting for %WORKER_REBIND to
172825511a47STejun Heo 	 * be cleared inside idle_worker_rebind().  Clear and release.
172925511a47STejun Heo 	 * Clearing %WORKER_REBIND from this foreign context is safe
173025511a47STejun Heo 	 * because these workers are still guaranteed to be idle.
173125511a47STejun Heo 	 */
173225511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
173325511a47STejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
173425511a47STejun Heo 			worker->flags &= ~WORKER_REBIND;
173525511a47STejun Heo 
173625511a47STejun Heo 	wake_up_all(&gcwq->rebind_hold);
173725511a47STejun Heo 
173825511a47STejun Heo 	/* rebind busy workers */
173925511a47STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
174025511a47STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
1741e2b6a6d5SJoonsoo Kim 		struct workqueue_struct *wq;
174225511a47STejun Heo 
174325511a47STejun Heo 		/* morph UNBOUND to REBIND */
174425511a47STejun Heo 		worker->flags &= ~WORKER_UNBOUND;
174525511a47STejun Heo 		worker->flags |= WORKER_REBIND;
174625511a47STejun Heo 
174725511a47STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
174825511a47STejun Heo 				     work_data_bits(rebind_work)))
174925511a47STejun Heo 			continue;
175025511a47STejun Heo 
175125511a47STejun Heo 		debug_work_activate(rebind_work);
1752e2b6a6d5SJoonsoo Kim 
1753e2b6a6d5SJoonsoo Kim 		/*
1754e2b6a6d5SJoonsoo Kim 		 * wq doesn't really matter but let's keep @worker->pool
1755e2b6a6d5SJoonsoo Kim 		 * and @cwq->pool consistent for sanity.
1756e2b6a6d5SJoonsoo Kim 		 */
1757e2b6a6d5SJoonsoo Kim 		if (worker_pool_pri(worker->pool))
1758e2b6a6d5SJoonsoo Kim 			wq = system_highpri_wq;
1759e2b6a6d5SJoonsoo Kim 		else
1760e2b6a6d5SJoonsoo Kim 			wq = system_wq;
1761e2b6a6d5SJoonsoo Kim 
1762e2b6a6d5SJoonsoo Kim 		insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
176325511a47STejun Heo 			worker->scheduled.next,
176425511a47STejun Heo 			work_color_to_flags(WORK_NO_COLOR));
176525511a47STejun Heo 	}
176625511a47STejun Heo }
176725511a47STejun Heo 
1768c34056a3STejun Heo static struct worker *alloc_worker(void)
1769c34056a3STejun Heo {
1770c34056a3STejun Heo 	struct worker *worker;
1771c34056a3STejun Heo 
1772c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1773c8e55f36STejun Heo 	if (worker) {
1774c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1775affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
177625511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1777e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1778e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1779c8e55f36STejun Heo 	}
1780c34056a3STejun Heo 	return worker;
1781c34056a3STejun Heo }
1782c34056a3STejun Heo 
1783c34056a3STejun Heo /**
1784c34056a3STejun Heo  * create_worker - create a new workqueue worker
178563d95a91STejun Heo  * @pool: pool the new worker will belong to
1786c34056a3STejun Heo  *
178763d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1788c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1789c34056a3STejun Heo  * destroy_worker().
1790c34056a3STejun Heo  *
1791c34056a3STejun Heo  * CONTEXT:
1792c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1793c34056a3STejun Heo  *
1794c34056a3STejun Heo  * RETURNS:
1795c34056a3STejun Heo  * Pointer to the newly created worker.
1796c34056a3STejun Heo  */
1797bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1798c34056a3STejun Heo {
179963d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
18003270476aSTejun Heo 	const char *pri = worker_pool_pri(pool) ? "H" : "";
1801c34056a3STejun Heo 	struct worker *worker = NULL;
1802f3421797STejun Heo 	int id = -1;
1803c34056a3STejun Heo 
18048b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1805bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
18068b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1807bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1808c34056a3STejun Heo 			goto fail;
18098b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1810c34056a3STejun Heo 	}
18118b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1812c34056a3STejun Heo 
1813c34056a3STejun Heo 	worker = alloc_worker();
1814c34056a3STejun Heo 	if (!worker)
1815c34056a3STejun Heo 		goto fail;
1816c34056a3STejun Heo 
1817bd7bdd43STejun Heo 	worker->pool = pool;
1818c34056a3STejun Heo 	worker->id = id;
1819c34056a3STejun Heo 
1820bc2ae0f5STejun Heo 	if (gcwq->cpu != WORK_CPU_UNBOUND)
182194dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
18223270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
18233270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1824f3421797STejun Heo 	else
1825f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
18263270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1827c34056a3STejun Heo 	if (IS_ERR(worker->task))
1828c34056a3STejun Heo 		goto fail;
1829c34056a3STejun Heo 
18303270476aSTejun Heo 	if (worker_pool_pri(pool))
18313270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
18323270476aSTejun Heo 
1833db7bccf4STejun Heo 	/*
1834bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
1835bc2ae0f5STejun Heo 	 * %GCWQ_DISASSOCIATED.  The caller is responsible for ensuring the
1836bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1837bc2ae0f5STejun Heo 	 * above the flag definition for details.
1838bc2ae0f5STejun Heo 	 *
1839bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1840bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1841db7bccf4STejun Heo 	 */
1842bc2ae0f5STejun Heo 	if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
18438b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1844bc2ae0f5STejun Heo 	} else {
1845db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1846f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1847f3421797STejun Heo 	}
1848c34056a3STejun Heo 
1849c34056a3STejun Heo 	return worker;
1850c34056a3STejun Heo fail:
1851c34056a3STejun Heo 	if (id >= 0) {
18528b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1853bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
18548b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1855c34056a3STejun Heo 	}
1856c34056a3STejun Heo 	kfree(worker);
1857c34056a3STejun Heo 	return NULL;
1858c34056a3STejun Heo }
1859c34056a3STejun Heo 
1860c34056a3STejun Heo /**
1861c34056a3STejun Heo  * start_worker - start a newly created worker
1862c34056a3STejun Heo  * @worker: worker to start
1863c34056a3STejun Heo  *
1864c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1865c34056a3STejun Heo  *
1866c34056a3STejun Heo  * CONTEXT:
18678b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1868c34056a3STejun Heo  */
1869c34056a3STejun Heo static void start_worker(struct worker *worker)
1870c34056a3STejun Heo {
1871cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1872bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1873c8e55f36STejun Heo 	worker_enter_idle(worker);
1874c34056a3STejun Heo 	wake_up_process(worker->task);
1875c34056a3STejun Heo }
1876c34056a3STejun Heo 
1877c34056a3STejun Heo /**
1878c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1879c34056a3STejun Heo  * @worker: worker to be destroyed
1880c34056a3STejun Heo  *
1881c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1882c8e55f36STejun Heo  *
1883c8e55f36STejun Heo  * CONTEXT:
1884c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1885c34056a3STejun Heo  */
1886c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1887c34056a3STejun Heo {
1888bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1889bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1890c34056a3STejun Heo 	int id = worker->id;
1891c34056a3STejun Heo 
1892c34056a3STejun Heo 	/* sanity check frenzy */
1893c34056a3STejun Heo 	BUG_ON(worker->current_work);
1894affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1895c34056a3STejun Heo 
1896c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1897bd7bdd43STejun Heo 		pool->nr_workers--;
1898c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1899bd7bdd43STejun Heo 		pool->nr_idle--;
1900c8e55f36STejun Heo 
1901c8e55f36STejun Heo 	list_del_init(&worker->entry);
1902cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1903c8e55f36STejun Heo 
1904c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1905c8e55f36STejun Heo 
1906c34056a3STejun Heo 	kthread_stop(worker->task);
1907c34056a3STejun Heo 	kfree(worker);
1908c34056a3STejun Heo 
19098b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1910bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1911c34056a3STejun Heo }
1912c34056a3STejun Heo 
191363d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1914e22bee78STejun Heo {
191563d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
191663d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1917e22bee78STejun Heo 
1918e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1919e22bee78STejun Heo 
192063d95a91STejun Heo 	if (too_many_workers(pool)) {
1921e22bee78STejun Heo 		struct worker *worker;
1922e22bee78STejun Heo 		unsigned long expires;
1923e22bee78STejun Heo 
1924e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
192563d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1926e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1927e22bee78STejun Heo 
1928e22bee78STejun Heo 		if (time_before(jiffies, expires))
192963d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1930e22bee78STejun Heo 		else {
1931e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
193211ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
193363d95a91STejun Heo 			wake_up_worker(pool);
1934e22bee78STejun Heo 		}
1935e22bee78STejun Heo 	}
1936e22bee78STejun Heo 
1937e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1938e22bee78STejun Heo }
1939e22bee78STejun Heo 
1940e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1941e22bee78STejun Heo {
1942e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1943e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1944f3421797STejun Heo 	unsigned int cpu;
1945e22bee78STejun Heo 
1946e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1947e22bee78STejun Heo 		return false;
1948e22bee78STejun Heo 
1949e22bee78STejun Heo 	/* mayday mayday mayday */
1950bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1951f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1952f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1953f3421797STejun Heo 		cpu = 0;
1954f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1955e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1956e22bee78STejun Heo 	return true;
1957e22bee78STejun Heo }
1958e22bee78STejun Heo 
195963d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1960e22bee78STejun Heo {
196163d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
196263d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1963e22bee78STejun Heo 	struct work_struct *work;
1964e22bee78STejun Heo 
1965e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1966e22bee78STejun Heo 
196763d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1968e22bee78STejun Heo 		/*
1969e22bee78STejun Heo 		 * We've been trying to create a new worker but
1970e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1971e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1972e22bee78STejun Heo 		 * rescuers.
1973e22bee78STejun Heo 		 */
197463d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1975e22bee78STejun Heo 			send_mayday(work);
1976e22bee78STejun Heo 	}
1977e22bee78STejun Heo 
1978e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1979e22bee78STejun Heo 
198063d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1981e22bee78STejun Heo }
1982e22bee78STejun Heo 
1983e22bee78STejun Heo /**
1984e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
198563d95a91STejun Heo  * @pool: pool to create a new worker for
1986e22bee78STejun Heo  *
198763d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1988e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1989e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
199063d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1991e22bee78STejun Heo  * possible allocation deadlock.
1992e22bee78STejun Heo  *
1993e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1994e22bee78STejun Heo  * may_start_working() true.
1995e22bee78STejun Heo  *
1996e22bee78STejun Heo  * LOCKING:
1997e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1998e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1999e22bee78STejun Heo  * manager.
2000e22bee78STejun Heo  *
2001e22bee78STejun Heo  * RETURNS:
2002e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
2003e22bee78STejun Heo  * otherwise.
2004e22bee78STejun Heo  */
200563d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
200606bd6ebfSNamhyung Kim __releases(&gcwq->lock)
200706bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
2008e22bee78STejun Heo {
200963d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
201063d95a91STejun Heo 
201163d95a91STejun Heo 	if (!need_to_create_worker(pool))
2012e22bee78STejun Heo 		return false;
2013e22bee78STejun Heo restart:
20149f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
20159f9c2364STejun Heo 
2016e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
201763d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2018e22bee78STejun Heo 
2019e22bee78STejun Heo 	while (true) {
2020e22bee78STejun Heo 		struct worker *worker;
2021e22bee78STejun Heo 
2022bc2ae0f5STejun Heo 		worker = create_worker(pool);
2023e22bee78STejun Heo 		if (worker) {
202463d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
2025e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
2026e22bee78STejun Heo 			start_worker(worker);
202763d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
2028e22bee78STejun Heo 			return true;
2029e22bee78STejun Heo 		}
2030e22bee78STejun Heo 
203163d95a91STejun Heo 		if (!need_to_create_worker(pool))
2032e22bee78STejun Heo 			break;
2033e22bee78STejun Heo 
2034e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
2035e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
20369f9c2364STejun Heo 
203763d95a91STejun Heo 		if (!need_to_create_worker(pool))
2038e22bee78STejun Heo 			break;
2039e22bee78STejun Heo 	}
2040e22bee78STejun Heo 
204163d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2042e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
204363d95a91STejun Heo 	if (need_to_create_worker(pool))
2044e22bee78STejun Heo 		goto restart;
2045e22bee78STejun Heo 	return true;
2046e22bee78STejun Heo }
2047e22bee78STejun Heo 
2048e22bee78STejun Heo /**
2049e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
205063d95a91STejun Heo  * @pool: pool to destroy workers for
2051e22bee78STejun Heo  *
205263d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
2053e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
2054e22bee78STejun Heo  *
2055e22bee78STejun Heo  * LOCKING:
2056e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2057e22bee78STejun Heo  * multiple times.  Called only from manager.
2058e22bee78STejun Heo  *
2059e22bee78STejun Heo  * RETURNS:
2060e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
2061e22bee78STejun Heo  * otherwise.
2062e22bee78STejun Heo  */
206363d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
2064e22bee78STejun Heo {
2065e22bee78STejun Heo 	bool ret = false;
2066e22bee78STejun Heo 
206763d95a91STejun Heo 	while (too_many_workers(pool)) {
2068e22bee78STejun Heo 		struct worker *worker;
2069e22bee78STejun Heo 		unsigned long expires;
2070e22bee78STejun Heo 
207163d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2072e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2073e22bee78STejun Heo 
2074e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
207563d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2076e22bee78STejun Heo 			break;
2077e22bee78STejun Heo 		}
2078e22bee78STejun Heo 
2079e22bee78STejun Heo 		destroy_worker(worker);
2080e22bee78STejun Heo 		ret = true;
2081e22bee78STejun Heo 	}
2082e22bee78STejun Heo 
2083e22bee78STejun Heo 	return ret;
2084e22bee78STejun Heo }
2085e22bee78STejun Heo 
2086e22bee78STejun Heo /**
2087e22bee78STejun Heo  * manage_workers - manage worker pool
2088e22bee78STejun Heo  * @worker: self
2089e22bee78STejun Heo  *
2090e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
2091e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2092e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
2093e22bee78STejun Heo  *
2094e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2095e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2096e22bee78STejun Heo  * and may_start_working() is true.
2097e22bee78STejun Heo  *
2098e22bee78STejun Heo  * CONTEXT:
2099e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2100e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2101e22bee78STejun Heo  *
2102e22bee78STejun Heo  * RETURNS:
2103e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
2104e22bee78STejun Heo  * some action was taken.
2105e22bee78STejun Heo  */
2106e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2107e22bee78STejun Heo {
210863d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2109e22bee78STejun Heo 	bool ret = false;
2110e22bee78STejun Heo 
211160373152STejun Heo 	if (!mutex_trylock(&pool->manager_mutex))
2112e22bee78STejun Heo 		return ret;
2113e22bee78STejun Heo 
211411ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2115e22bee78STejun Heo 
2116e22bee78STejun Heo 	/*
2117e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2118e22bee78STejun Heo 	 * on return.
2119e22bee78STejun Heo 	 */
212063d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
212163d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2122e22bee78STejun Heo 
212360373152STejun Heo 	mutex_unlock(&pool->manager_mutex);
2124e22bee78STejun Heo 	return ret;
2125e22bee78STejun Heo }
2126e22bee78STejun Heo 
2127a62428c0STejun Heo /**
2128a62428c0STejun Heo  * process_one_work - process single work
2129c34056a3STejun Heo  * @worker: self
2130a62428c0STejun Heo  * @work: work to process
2131a62428c0STejun Heo  *
2132a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2133a62428c0STejun Heo  * process a single work including synchronization against and
2134a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2135a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2136a62428c0STejun Heo  * call this function to process a work.
2137a62428c0STejun Heo  *
2138a62428c0STejun Heo  * CONTEXT:
21398b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
2140a62428c0STejun Heo  */
2141c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
214206bd6ebfSNamhyung Kim __releases(&gcwq->lock)
214306bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
21441da177e4SLinus Torvalds {
21457e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2146bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2147bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
2148c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
2149fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
21506bb49e59SDavid Howells 	work_func_t f = work->func;
215173f53c4aSTejun Heo 	int work_color;
21527e11629dSTejun Heo 	struct worker *collision;
21534e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21544e6045f1SJohannes Berg 	/*
2155a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2156a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2157a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2158a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2159a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21604e6045f1SJohannes Berg 	 */
21614d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21624d82a1deSPeter Zijlstra 
21634d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21644e6045f1SJohannes Berg #endif
21656fec10a1STejun Heo 	/*
21666fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21676fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
21686fec10a1STejun Heo 	 * unbound or a disassociated gcwq.
21696fec10a1STejun Heo 	 */
217025511a47STejun Heo 	WARN_ON_ONCE(!(worker->flags & (WORKER_UNBOUND | WORKER_REBIND)) &&
21716fec10a1STejun Heo 		     !(gcwq->flags & GCWQ_DISASSOCIATED) &&
217225511a47STejun Heo 		     raw_smp_processor_id() != gcwq->cpu);
217325511a47STejun Heo 
21747e11629dSTejun Heo 	/*
21757e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21767e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21777e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21787e11629dSTejun Heo 	 * currently executing one.
21797e11629dSTejun Heo 	 */
21807e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
21817e11629dSTejun Heo 	if (unlikely(collision)) {
21827e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21837e11629dSTejun Heo 		return;
21847e11629dSTejun Heo 	}
21851da177e4SLinus Torvalds 
21868930cabaSTejun Heo 	/* claim and dequeue */
21871da177e4SLinus Torvalds 	debug_work_deactivate(work);
2188c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
2189c34056a3STejun Heo 	worker->current_work = work;
21908cca0eeaSTejun Heo 	worker->current_cwq = cwq;
219173f53c4aSTejun Heo 	work_color = get_work_color(work);
21927a22ad75STejun Heo 
2193a62428c0STejun Heo 	list_del_init(&work->entry);
2194a62428c0STejun Heo 
2195649027d7STejun Heo 	/*
2196fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2197fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2198fb0e7bebSTejun Heo 	 */
2199fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2200fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2201fb0e7bebSTejun Heo 
2202974271c4STejun Heo 	/*
2203974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
2204974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2205974271c4STejun Heo 	 */
220663d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
220763d95a91STejun Heo 		wake_up_worker(pool);
2208974271c4STejun Heo 
22098930cabaSTejun Heo 	/*
221023657bb1STejun Heo 	 * Record the last CPU and clear PENDING which should be the last
221123657bb1STejun Heo 	 * update to @work.  Also, do this inside @gcwq->lock so that
221223657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
221323657bb1STejun Heo 	 * disabled.
22148930cabaSTejun Heo 	 */
22158930cabaSTejun Heo 	set_work_cpu_and_clear_pending(work, gcwq->cpu);
22161da177e4SLinus Torvalds 
22178930cabaSTejun Heo 	spin_unlock_irq(&gcwq->lock);
2218959d1af8STejun Heo 
2219e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
22203295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2221e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
222265f27f38SDavid Howells 	f(work);
2223e36c886aSArjan van de Ven 	/*
2224e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2225e36c886aSArjan van de Ven 	 * point will only record its address.
2226e36c886aSArjan van de Ven 	 */
2227e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22283295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
22293295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
22301da177e4SLinus Torvalds 
2231d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2232044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2233044c782cSValentin Ilie 		       "     last function: %pf\n",
2234044c782cSValentin Ilie 		       current->comm, preempt_count(), task_pid_nr(current), f);
2235d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2236d5abe669SPeter Zijlstra 		dump_stack();
2237d5abe669SPeter Zijlstra 	}
2238d5abe669SPeter Zijlstra 
22398b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2240a62428c0STejun Heo 
2241fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2242fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2243fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2244fb0e7bebSTejun Heo 
2245a62428c0STejun Heo 	/* we're done with it, release */
2246c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
2247c34056a3STejun Heo 	worker->current_work = NULL;
22488cca0eeaSTejun Heo 	worker->current_cwq = NULL;
22498a2e8e5dSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color, false);
22501da177e4SLinus Torvalds }
22511da177e4SLinus Torvalds 
2252affee4b2STejun Heo /**
2253affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2254affee4b2STejun Heo  * @worker: self
2255affee4b2STejun Heo  *
2256affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2257affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2258affee4b2STejun Heo  * fetches a work from the top and executes it.
2259affee4b2STejun Heo  *
2260affee4b2STejun Heo  * CONTEXT:
22618b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2262affee4b2STejun Heo  * multiple times.
2263affee4b2STejun Heo  */
2264affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22651da177e4SLinus Torvalds {
2266affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2267affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2268a62428c0STejun Heo 						struct work_struct, entry);
2269c34056a3STejun Heo 		process_one_work(worker, work);
2270a62428c0STejun Heo 	}
22711da177e4SLinus Torvalds }
22721da177e4SLinus Torvalds 
22734690c4abSTejun Heo /**
22744690c4abSTejun Heo  * worker_thread - the worker thread function
2275c34056a3STejun Heo  * @__worker: self
22764690c4abSTejun Heo  *
2277e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2278e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2279e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2280e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2281e22bee78STejun Heo  * rescuer_thread().
22824690c4abSTejun Heo  */
2283c34056a3STejun Heo static int worker_thread(void *__worker)
22841da177e4SLinus Torvalds {
2285c34056a3STejun Heo 	struct worker *worker = __worker;
2286bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2287bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
22881da177e4SLinus Torvalds 
2289e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2290e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2291c8e55f36STejun Heo woke_up:
22928b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2293affee4b2STejun Heo 
229425511a47STejun Heo 	/*
229525511a47STejun Heo 	 * DIE can be set only while idle and REBIND set while busy has
229625511a47STejun Heo 	 * @worker->rebind_work scheduled.  Checking here is enough.
229725511a47STejun Heo 	 */
229825511a47STejun Heo 	if (unlikely(worker->flags & (WORKER_REBIND | WORKER_DIE))) {
2299c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
230025511a47STejun Heo 
230125511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2302e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2303c8e55f36STejun Heo 			return 0;
2304c8e55f36STejun Heo 		}
2305c8e55f36STejun Heo 
230625511a47STejun Heo 		idle_worker_rebind(worker);
230725511a47STejun Heo 		goto woke_up;
230825511a47STejun Heo 	}
230925511a47STejun Heo 
2310c8e55f36STejun Heo 	worker_leave_idle(worker);
2311db7bccf4STejun Heo recheck:
2312e22bee78STejun Heo 	/* no more worker necessary? */
231363d95a91STejun Heo 	if (!need_more_worker(pool))
2314e22bee78STejun Heo 		goto sleep;
2315e22bee78STejun Heo 
2316e22bee78STejun Heo 	/* do we need to manage? */
231763d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2318e22bee78STejun Heo 		goto recheck;
2319e22bee78STejun Heo 
2320c8e55f36STejun Heo 	/*
2321c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2322c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2323c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2324c8e55f36STejun Heo 	 */
2325c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2326c8e55f36STejun Heo 
2327e22bee78STejun Heo 	/*
2328e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2329e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2330e22bee78STejun Heo 	 * assumed the manager role.
2331e22bee78STejun Heo 	 */
2332e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2333e22bee78STejun Heo 
2334e22bee78STejun Heo 	do {
2335affee4b2STejun Heo 		struct work_struct *work =
2336bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2337affee4b2STejun Heo 					 struct work_struct, entry);
2338affee4b2STejun Heo 
2339c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2340affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2341affee4b2STejun Heo 			process_one_work(worker, work);
2342affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2343affee4b2STejun Heo 				process_scheduled_works(worker);
2344affee4b2STejun Heo 		} else {
2345c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2346affee4b2STejun Heo 			process_scheduled_works(worker);
2347affee4b2STejun Heo 		}
234863d95a91STejun Heo 	} while (keep_working(pool));
2349affee4b2STejun Heo 
2350e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2351d313dd85STejun Heo sleep:
235263d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2353e22bee78STejun Heo 		goto recheck;
2354d313dd85STejun Heo 
2355c8e55f36STejun Heo 	/*
2356e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2357e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2358e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2359e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2360e22bee78STejun Heo 	 * prevent losing any event.
2361c8e55f36STejun Heo 	 */
2362c8e55f36STejun Heo 	worker_enter_idle(worker);
2363c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
23648b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23651da177e4SLinus Torvalds 	schedule();
2366c8e55f36STejun Heo 	goto woke_up;
23671da177e4SLinus Torvalds }
23681da177e4SLinus Torvalds 
2369e22bee78STejun Heo /**
2370e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2371e22bee78STejun Heo  * @__wq: the associated workqueue
2372e22bee78STejun Heo  *
2373e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2374e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2375e22bee78STejun Heo  *
2376e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2377e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2378e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2379e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2380e22bee78STejun Heo  * the problem rescuer solves.
2381e22bee78STejun Heo  *
2382e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2383e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2384e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2385e22bee78STejun Heo  *
2386e22bee78STejun Heo  * This should happen rarely.
2387e22bee78STejun Heo  */
2388e22bee78STejun Heo static int rescuer_thread(void *__wq)
2389e22bee78STejun Heo {
2390e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2391e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2392e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2393f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2394e22bee78STejun Heo 	unsigned int cpu;
2395e22bee78STejun Heo 
2396e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2397e22bee78STejun Heo repeat:
2398e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
23991da177e4SLinus Torvalds 
24001da177e4SLinus Torvalds 	if (kthread_should_stop())
2401e22bee78STejun Heo 		return 0;
24021da177e4SLinus Torvalds 
2403f3421797STejun Heo 	/*
2404f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2405f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2406f3421797STejun Heo 	 */
2407f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2408f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2409f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2410bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2411bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2412e22bee78STejun Heo 		struct work_struct *work, *n;
2413e22bee78STejun Heo 
2414e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2415f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2416e22bee78STejun Heo 
2417e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2418bd7bdd43STejun Heo 		rescuer->pool = pool;
2419e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2420e22bee78STejun Heo 
2421e22bee78STejun Heo 		/*
2422e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2423e22bee78STejun Heo 		 * process'em.
2424e22bee78STejun Heo 		 */
2425e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2426bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2427e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2428e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2429e22bee78STejun Heo 
2430e22bee78STejun Heo 		process_scheduled_works(rescuer);
24317576958aSTejun Heo 
24327576958aSTejun Heo 		/*
24337576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
24347576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24357576958aSTejun Heo 		 * and stalling the execution.
24367576958aSTejun Heo 		 */
243763d95a91STejun Heo 		if (keep_working(pool))
243863d95a91STejun Heo 			wake_up_worker(pool);
24397576958aSTejun Heo 
2440e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
24411da177e4SLinus Torvalds 	}
24421da177e4SLinus Torvalds 
2443e22bee78STejun Heo 	schedule();
2444e22bee78STejun Heo 	goto repeat;
24451da177e4SLinus Torvalds }
24461da177e4SLinus Torvalds 
2447fc2e4d70SOleg Nesterov struct wq_barrier {
2448fc2e4d70SOleg Nesterov 	struct work_struct	work;
2449fc2e4d70SOleg Nesterov 	struct completion	done;
2450fc2e4d70SOleg Nesterov };
2451fc2e4d70SOleg Nesterov 
2452fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2453fc2e4d70SOleg Nesterov {
2454fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2455fc2e4d70SOleg Nesterov 	complete(&barr->done);
2456fc2e4d70SOleg Nesterov }
2457fc2e4d70SOleg Nesterov 
24584690c4abSTejun Heo /**
24594690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
24604690c4abSTejun Heo  * @cwq: cwq to insert barrier into
24614690c4abSTejun Heo  * @barr: wq_barrier to insert
2462affee4b2STejun Heo  * @target: target work to attach @barr to
2463affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24644690c4abSTejun Heo  *
2465affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2466affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2467affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2468affee4b2STejun Heo  * cpu.
2469affee4b2STejun Heo  *
2470affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2471affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2472affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2473affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2474affee4b2STejun Heo  * after a work with LINKED flag set.
2475affee4b2STejun Heo  *
2476affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2477affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
24784690c4abSTejun Heo  *
24794690c4abSTejun Heo  * CONTEXT:
24808b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
24814690c4abSTejun Heo  */
248283c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2483affee4b2STejun Heo 			      struct wq_barrier *barr,
2484affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2485fc2e4d70SOleg Nesterov {
2486affee4b2STejun Heo 	struct list_head *head;
2487affee4b2STejun Heo 	unsigned int linked = 0;
2488affee4b2STejun Heo 
2489dc186ad7SThomas Gleixner 	/*
24908b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2491dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2492dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2493dc186ad7SThomas Gleixner 	 * might deadlock.
2494dc186ad7SThomas Gleixner 	 */
2495ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
249622df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2497fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
249883c22520SOleg Nesterov 
2499affee4b2STejun Heo 	/*
2500affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2501affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2502affee4b2STejun Heo 	 */
2503affee4b2STejun Heo 	if (worker)
2504affee4b2STejun Heo 		head = worker->scheduled.next;
2505affee4b2STejun Heo 	else {
2506affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2507affee4b2STejun Heo 
2508affee4b2STejun Heo 		head = target->entry.next;
2509affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2510affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2511affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2512affee4b2STejun Heo 	}
2513affee4b2STejun Heo 
2514dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2515affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2516affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2517fc2e4d70SOleg Nesterov }
2518fc2e4d70SOleg Nesterov 
251973f53c4aSTejun Heo /**
252073f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
252173f53c4aSTejun Heo  * @wq: workqueue being flushed
252273f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
252373f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
252473f53c4aSTejun Heo  *
252573f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
252673f53c4aSTejun Heo  *
252773f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
252873f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
252973f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
253073f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
253173f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
253273f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
253373f53c4aSTejun Heo  *
253473f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
253573f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
253673f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
253773f53c4aSTejun Heo  * is returned.
253873f53c4aSTejun Heo  *
253973f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
254073f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
254173f53c4aSTejun Heo  * advanced to @work_color.
254273f53c4aSTejun Heo  *
254373f53c4aSTejun Heo  * CONTEXT:
254473f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
254573f53c4aSTejun Heo  *
254673f53c4aSTejun Heo  * RETURNS:
254773f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
254873f53c4aSTejun Heo  * otherwise.
254973f53c4aSTejun Heo  */
255073f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
255173f53c4aSTejun Heo 				      int flush_color, int work_color)
25521da177e4SLinus Torvalds {
255373f53c4aSTejun Heo 	bool wait = false;
255473f53c4aSTejun Heo 	unsigned int cpu;
25551da177e4SLinus Torvalds 
255673f53c4aSTejun Heo 	if (flush_color >= 0) {
255773f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
255873f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2559dc186ad7SThomas Gleixner 	}
256014441960SOleg Nesterov 
2561f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
256273f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2563bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
25641da177e4SLinus Torvalds 
25658b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
256673f53c4aSTejun Heo 
256773f53c4aSTejun Heo 		if (flush_color >= 0) {
256873f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
256973f53c4aSTejun Heo 
257073f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
257173f53c4aSTejun Heo 				cwq->flush_color = flush_color;
257273f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
257373f53c4aSTejun Heo 				wait = true;
25741da177e4SLinus Torvalds 			}
257573f53c4aSTejun Heo 		}
257673f53c4aSTejun Heo 
257773f53c4aSTejun Heo 		if (work_color >= 0) {
257873f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
257973f53c4aSTejun Heo 			cwq->work_color = work_color;
258073f53c4aSTejun Heo 		}
258173f53c4aSTejun Heo 
25828b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
25831da177e4SLinus Torvalds 	}
25841da177e4SLinus Torvalds 
258573f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
258673f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
258773f53c4aSTejun Heo 
258873f53c4aSTejun Heo 	return wait;
258983c22520SOleg Nesterov }
25901da177e4SLinus Torvalds 
25910fcb78c2SRolf Eike Beer /**
25921da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
25930fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
25941da177e4SLinus Torvalds  *
25951da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
25961da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
25971da177e4SLinus Torvalds  *
2598fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2599fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
26001da177e4SLinus Torvalds  */
26017ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
26021da177e4SLinus Torvalds {
260373f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
260473f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
260573f53c4aSTejun Heo 		.flush_color = -1,
260673f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
260773f53c4aSTejun Heo 	};
260873f53c4aSTejun Heo 	int next_color;
2609b1f4ec17SOleg Nesterov 
26103295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
26113295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
261273f53c4aSTejun Heo 
261373f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
261473f53c4aSTejun Heo 
261573f53c4aSTejun Heo 	/*
261673f53c4aSTejun Heo 	 * Start-to-wait phase
261773f53c4aSTejun Heo 	 */
261873f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
261973f53c4aSTejun Heo 
262073f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
262173f53c4aSTejun Heo 		/*
262273f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
262373f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
262473f53c4aSTejun Heo 		 * by one.
262573f53c4aSTejun Heo 		 */
262673f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
262773f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
262873f53c4aSTejun Heo 		wq->work_color = next_color;
262973f53c4aSTejun Heo 
263073f53c4aSTejun Heo 		if (!wq->first_flusher) {
263173f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
263273f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
263373f53c4aSTejun Heo 
263473f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
263573f53c4aSTejun Heo 
263673f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
263773f53c4aSTejun Heo 						       wq->work_color)) {
263873f53c4aSTejun Heo 				/* nothing to flush, done */
263973f53c4aSTejun Heo 				wq->flush_color = next_color;
264073f53c4aSTejun Heo 				wq->first_flusher = NULL;
264173f53c4aSTejun Heo 				goto out_unlock;
264273f53c4aSTejun Heo 			}
264373f53c4aSTejun Heo 		} else {
264473f53c4aSTejun Heo 			/* wait in queue */
264573f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
264673f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
264773f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
264873f53c4aSTejun Heo 		}
264973f53c4aSTejun Heo 	} else {
265073f53c4aSTejun Heo 		/*
265173f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
265273f53c4aSTejun Heo 		 * The next flush completion will assign us
265373f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
265473f53c4aSTejun Heo 		 */
265573f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
265673f53c4aSTejun Heo 	}
265773f53c4aSTejun Heo 
265873f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
265973f53c4aSTejun Heo 
266073f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
266173f53c4aSTejun Heo 
266273f53c4aSTejun Heo 	/*
266373f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
266473f53c4aSTejun Heo 	 *
266573f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
266673f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
266773f53c4aSTejun Heo 	 */
266873f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
266973f53c4aSTejun Heo 		return;
267073f53c4aSTejun Heo 
267173f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
267273f53c4aSTejun Heo 
26734ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26744ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26754ce48b37STejun Heo 		goto out_unlock;
26764ce48b37STejun Heo 
267773f53c4aSTejun Heo 	wq->first_flusher = NULL;
267873f53c4aSTejun Heo 
267973f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
268073f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
268173f53c4aSTejun Heo 
268273f53c4aSTejun Heo 	while (true) {
268373f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
268473f53c4aSTejun Heo 
268573f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
268673f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
268773f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
268873f53c4aSTejun Heo 				break;
268973f53c4aSTejun Heo 			list_del_init(&next->list);
269073f53c4aSTejun Heo 			complete(&next->done);
269173f53c4aSTejun Heo 		}
269273f53c4aSTejun Heo 
269373f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
269473f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
269573f53c4aSTejun Heo 
269673f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
269773f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
269873f53c4aSTejun Heo 
269973f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
270073f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
270173f53c4aSTejun Heo 			/*
270273f53c4aSTejun Heo 			 * Assign the same color to all overflowed
270373f53c4aSTejun Heo 			 * flushers, advance work_color and append to
270473f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
270573f53c4aSTejun Heo 			 * phase for these overflowed flushers.
270673f53c4aSTejun Heo 			 */
270773f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
270873f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
270973f53c4aSTejun Heo 
271073f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
271173f53c4aSTejun Heo 
271273f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
271373f53c4aSTejun Heo 					      &wq->flusher_queue);
271473f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
271573f53c4aSTejun Heo 		}
271673f53c4aSTejun Heo 
271773f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
271873f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
271973f53c4aSTejun Heo 			break;
272073f53c4aSTejun Heo 		}
272173f53c4aSTejun Heo 
272273f53c4aSTejun Heo 		/*
272373f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
272473f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
272573f53c4aSTejun Heo 		 */
272673f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
272773f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
272873f53c4aSTejun Heo 
272973f53c4aSTejun Heo 		list_del_init(&next->list);
273073f53c4aSTejun Heo 		wq->first_flusher = next;
273173f53c4aSTejun Heo 
273273f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
273373f53c4aSTejun Heo 			break;
273473f53c4aSTejun Heo 
273573f53c4aSTejun Heo 		/*
273673f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
273773f53c4aSTejun Heo 		 * flusher and repeat cascading.
273873f53c4aSTejun Heo 		 */
273973f53c4aSTejun Heo 		wq->first_flusher = NULL;
274073f53c4aSTejun Heo 	}
274173f53c4aSTejun Heo 
274273f53c4aSTejun Heo out_unlock:
274373f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
27441da177e4SLinus Torvalds }
2745ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27461da177e4SLinus Torvalds 
27479c5a2ba7STejun Heo /**
27489c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27499c5a2ba7STejun Heo  * @wq: workqueue to drain
27509c5a2ba7STejun Heo  *
27519c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27529c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27539c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27549c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27559c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27569c5a2ba7STejun Heo  * takes too long.
27579c5a2ba7STejun Heo  */
27589c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27599c5a2ba7STejun Heo {
27609c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
27619c5a2ba7STejun Heo 	unsigned int cpu;
27629c5a2ba7STejun Heo 
27639c5a2ba7STejun Heo 	/*
27649c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27659c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
27669c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
27679c5a2ba7STejun Heo 	 */
27689c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27699c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
27709c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
27719c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27729c5a2ba7STejun Heo reflush:
27739c5a2ba7STejun Heo 	flush_workqueue(wq);
27749c5a2ba7STejun Heo 
27759c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27769c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2777fa2563e4SThomas Tuttle 		bool drained;
27789c5a2ba7STejun Heo 
2779bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2780fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2781bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2782fa2563e4SThomas Tuttle 
2783fa2563e4SThomas Tuttle 		if (drained)
27849c5a2ba7STejun Heo 			continue;
27859c5a2ba7STejun Heo 
27869c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27879c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2788044c782cSValentin Ilie 			pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
27899c5a2ba7STejun Heo 				wq->name, flush_cnt);
27909c5a2ba7STejun Heo 		goto reflush;
27919c5a2ba7STejun Heo 	}
27929c5a2ba7STejun Heo 
27939c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27949c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
27959c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
27969c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27979c5a2ba7STejun Heo }
27989c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
27999c5a2ba7STejun Heo 
2800606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2801baf59022STejun Heo {
2802baf59022STejun Heo 	struct worker *worker = NULL;
2803baf59022STejun Heo 	struct global_cwq *gcwq;
2804baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2805baf59022STejun Heo 
2806baf59022STejun Heo 	might_sleep();
2807baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2808baf59022STejun Heo 	if (!gcwq)
2809baf59022STejun Heo 		return false;
2810baf59022STejun Heo 
2811baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2812baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2813baf59022STejun Heo 		/*
2814baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2815baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2816baf59022STejun Heo 		 * are not going to wait.
2817baf59022STejun Heo 		 */
2818baf59022STejun Heo 		smp_rmb();
2819baf59022STejun Heo 		cwq = get_work_cwq(work);
2820bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2821baf59022STejun Heo 			goto already_gone;
2822606a5020STejun Heo 	} else {
2823baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2824baf59022STejun Heo 		if (!worker)
2825baf59022STejun Heo 			goto already_gone;
2826baf59022STejun Heo 		cwq = worker->current_cwq;
2827606a5020STejun Heo 	}
2828baf59022STejun Heo 
2829baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2830baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2831baf59022STejun Heo 
2832e159489bSTejun Heo 	/*
2833e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2834e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2835e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2836e159489bSTejun Heo 	 * access.
2837e159489bSTejun Heo 	 */
2838e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2839baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2840e159489bSTejun Heo 	else
2841e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2842baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2843e159489bSTejun Heo 
2844baf59022STejun Heo 	return true;
2845baf59022STejun Heo already_gone:
2846baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2847baf59022STejun Heo 	return false;
2848baf59022STejun Heo }
2849baf59022STejun Heo 
2850db700897SOleg Nesterov /**
2851401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2852401a8d04STejun Heo  * @work: the work to flush
2853db700897SOleg Nesterov  *
2854606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2855606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2856401a8d04STejun Heo  *
2857401a8d04STejun Heo  * RETURNS:
2858401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2859401a8d04STejun Heo  * %false if it was already idle.
2860db700897SOleg Nesterov  */
2861401a8d04STejun Heo bool flush_work(struct work_struct *work)
2862db700897SOleg Nesterov {
2863db700897SOleg Nesterov 	struct wq_barrier barr;
2864db700897SOleg Nesterov 
28650976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28660976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28670976dfc1SStephen Boyd 
2868606a5020STejun Heo 	if (start_flush_work(work, &barr)) {
2869db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2870dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2871401a8d04STejun Heo 		return true;
2872606a5020STejun Heo 	} else {
2873401a8d04STejun Heo 		return false;
2874db700897SOleg Nesterov 	}
2875606a5020STejun Heo }
2876db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2877db700897SOleg Nesterov 
287836e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
28791f1f642eSOleg Nesterov {
2880bbb68dfaSTejun Heo 	unsigned long flags;
28811f1f642eSOleg Nesterov 	int ret;
28821f1f642eSOleg Nesterov 
28831f1f642eSOleg Nesterov 	do {
2884bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2885bbb68dfaSTejun Heo 		/*
2886bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2887bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2888bbb68dfaSTejun Heo 		 */
2889bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2890606a5020STejun Heo 			flush_work(work);
28911f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
28921f1f642eSOleg Nesterov 
2893bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2894bbb68dfaSTejun Heo 	mark_work_canceling(work);
2895bbb68dfaSTejun Heo 	local_irq_restore(flags);
2896bbb68dfaSTejun Heo 
2897606a5020STejun Heo 	flush_work(work);
28987a22ad75STejun Heo 	clear_work_data(work);
28991f1f642eSOleg Nesterov 	return ret;
29001f1f642eSOleg Nesterov }
29011f1f642eSOleg Nesterov 
29026e84d644SOleg Nesterov /**
2903401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2904401a8d04STejun Heo  * @work: the work to cancel
29056e84d644SOleg Nesterov  *
2906401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2907401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2908401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2909401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
29101f1f642eSOleg Nesterov  *
2911401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2912401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
29136e84d644SOleg Nesterov  *
2914401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
29156e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2916401a8d04STejun Heo  *
2917401a8d04STejun Heo  * RETURNS:
2918401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
29196e84d644SOleg Nesterov  */
2920401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29216e84d644SOleg Nesterov {
292236e227d2STejun Heo 	return __cancel_work_timer(work, false);
2923b89deed3SOleg Nesterov }
292428e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2925b89deed3SOleg Nesterov 
29266e84d644SOleg Nesterov /**
2927401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2928401a8d04STejun Heo  * @dwork: the delayed work to flush
29296e84d644SOleg Nesterov  *
2930401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2931401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2932401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29331f1f642eSOleg Nesterov  *
2934401a8d04STejun Heo  * RETURNS:
2935401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2936401a8d04STejun Heo  * %false if it was already idle.
29376e84d644SOleg Nesterov  */
2938401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2939401a8d04STejun Heo {
29408930cabaSTejun Heo 	local_irq_disable();
2941401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
29421265057fSTejun Heo 		__queue_work(dwork->cpu,
2943401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
29448930cabaSTejun Heo 	local_irq_enable();
2945401a8d04STejun Heo 	return flush_work(&dwork->work);
2946401a8d04STejun Heo }
2947401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2948401a8d04STejun Heo 
2949401a8d04STejun Heo /**
2950401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2951401a8d04STejun Heo  * @dwork: the delayed work cancel
2952401a8d04STejun Heo  *
2953401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2954401a8d04STejun Heo  *
2955401a8d04STejun Heo  * RETURNS:
2956401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2957401a8d04STejun Heo  */
2958401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
29596e84d644SOleg Nesterov {
296036e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
29616e84d644SOleg Nesterov }
2962f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
29631da177e4SLinus Torvalds 
2964d4283e93STejun Heo /**
29650a13c00eSTejun Heo  * schedule_work_on - put work task on a specific cpu
29660a13c00eSTejun Heo  * @cpu: cpu to put the work task on
29670a13c00eSTejun Heo  * @work: job to be done
29680a13c00eSTejun Heo  *
29690a13c00eSTejun Heo  * This puts a job on a specific cpu
29700a13c00eSTejun Heo  */
2971d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work)
29720a13c00eSTejun Heo {
29730a13c00eSTejun Heo 	return queue_work_on(cpu, system_wq, work);
29740a13c00eSTejun Heo }
29750a13c00eSTejun Heo EXPORT_SYMBOL(schedule_work_on);
29760a13c00eSTejun Heo 
29770fcb78c2SRolf Eike Beer /**
29780fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
29790fcb78c2SRolf Eike Beer  * @work: job to be done
29800fcb78c2SRolf Eike Beer  *
2981d4283e93STejun Heo  * Returns %false if @work was already on the kernel-global workqueue and
2982d4283e93STejun Heo  * %true otherwise.
29835b0f437dSBart Van Assche  *
29845b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
29855b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
29865b0f437dSBart Van Assche  * workqueue otherwise.
29870fcb78c2SRolf Eike Beer  */
2988d4283e93STejun Heo bool schedule_work(struct work_struct *work)
29891da177e4SLinus Torvalds {
2990d320c038STejun Heo 	return queue_work(system_wq, work);
29911da177e4SLinus Torvalds }
2992ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
29931da177e4SLinus Torvalds 
29940fcb78c2SRolf Eike Beer /**
29950fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
29960fcb78c2SRolf Eike Beer  * @cpu: cpu to use
299752bad64dSDavid Howells  * @dwork: job to be done
29980fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
29990fcb78c2SRolf Eike Beer  *
30000fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
30010fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
30020fcb78c2SRolf Eike Beer  */
3003d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3004d4283e93STejun Heo 			      unsigned long delay)
30051da177e4SLinus Torvalds {
3006d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
30071da177e4SLinus Torvalds }
3008ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
30091da177e4SLinus Torvalds 
3010b6136773SAndrew Morton /**
30110a13c00eSTejun Heo  * schedule_delayed_work - put work task in global workqueue after delay
30120a13c00eSTejun Heo  * @dwork: job to be done
30130a13c00eSTejun Heo  * @delay: number of jiffies to wait or 0 for immediate execution
30140a13c00eSTejun Heo  *
30150a13c00eSTejun Heo  * After waiting for a given time this puts a job in the kernel-global
30160a13c00eSTejun Heo  * workqueue.
30170a13c00eSTejun Heo  */
3018d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
30190a13c00eSTejun Heo {
30200a13c00eSTejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
30210a13c00eSTejun Heo }
30220a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work);
30230a13c00eSTejun Heo 
30240a13c00eSTejun Heo /**
302531ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3026b6136773SAndrew Morton  * @func: the function to call
3027b6136773SAndrew Morton  *
302831ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
302931ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3030b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
303131ddd871STejun Heo  *
303231ddd871STejun Heo  * RETURNS:
303331ddd871STejun Heo  * 0 on success, -errno on failure.
3034b6136773SAndrew Morton  */
303565f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
303615316ba8SChristoph Lameter {
303715316ba8SChristoph Lameter 	int cpu;
303838f51568SNamhyung Kim 	struct work_struct __percpu *works;
303915316ba8SChristoph Lameter 
3040b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3041b6136773SAndrew Morton 	if (!works)
304215316ba8SChristoph Lameter 		return -ENOMEM;
3043b6136773SAndrew Morton 
304495402b38SGautham R Shenoy 	get_online_cpus();
304593981800STejun Heo 
304615316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
30479bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
30489bfb1839SIngo Molnar 
30499bfb1839SIngo Molnar 		INIT_WORK(work, func);
30508de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
305115316ba8SChristoph Lameter 	}
305293981800STejun Heo 
305393981800STejun Heo 	for_each_online_cpu(cpu)
30548616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
305593981800STejun Heo 
305695402b38SGautham R Shenoy 	put_online_cpus();
3057b6136773SAndrew Morton 	free_percpu(works);
305815316ba8SChristoph Lameter 	return 0;
305915316ba8SChristoph Lameter }
306015316ba8SChristoph Lameter 
3061eef6a7d5SAlan Stern /**
3062eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3063eef6a7d5SAlan Stern  *
3064eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3065eef6a7d5SAlan Stern  * completion.
3066eef6a7d5SAlan Stern  *
3067eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3068eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3069eef6a7d5SAlan Stern  * will lead to deadlock:
3070eef6a7d5SAlan Stern  *
3071eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3072eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3073eef6a7d5SAlan Stern  *
3074eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3075eef6a7d5SAlan Stern  *
3076eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3077eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3078eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3079eef6a7d5SAlan Stern  *
3080eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3081eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3082eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3083eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3084eef6a7d5SAlan Stern  */
30851da177e4SLinus Torvalds void flush_scheduled_work(void)
30861da177e4SLinus Torvalds {
3087d320c038STejun Heo 	flush_workqueue(system_wq);
30881da177e4SLinus Torvalds }
3089ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
30901da177e4SLinus Torvalds 
30911da177e4SLinus Torvalds /**
30921fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
30931fa44ecaSJames Bottomley  * @fn:		the function to execute
30941fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
30951fa44ecaSJames Bottomley  *		be available when the work executes)
30961fa44ecaSJames Bottomley  *
30971fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
30981fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
30991fa44ecaSJames Bottomley  *
31001fa44ecaSJames Bottomley  * Returns:	0 - function was executed
31011fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31021fa44ecaSJames Bottomley  */
310365f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31041fa44ecaSJames Bottomley {
31051fa44ecaSJames Bottomley 	if (!in_interrupt()) {
310665f27f38SDavid Howells 		fn(&ew->work);
31071fa44ecaSJames Bottomley 		return 0;
31081fa44ecaSJames Bottomley 	}
31091fa44ecaSJames Bottomley 
311065f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31111fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31121fa44ecaSJames Bottomley 
31131fa44ecaSJames Bottomley 	return 1;
31141fa44ecaSJames Bottomley }
31151fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31161fa44ecaSJames Bottomley 
31171da177e4SLinus Torvalds int keventd_up(void)
31181da177e4SLinus Torvalds {
3119d320c038STejun Heo 	return system_wq != NULL;
31201da177e4SLinus Torvalds }
31211da177e4SLinus Torvalds 
3122bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
31231da177e4SLinus Torvalds {
31243af24433SOleg Nesterov 	/*
31250f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
31260f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
31270f900049STejun Heo 	 * unsigned long long.
31283af24433SOleg Nesterov 	 */
31290f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
31300f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
31310f900049STejun Heo 				   __alignof__(unsigned long long));
31323af24433SOleg Nesterov 
3133e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3134f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3135931ac77eSTejun Heo 	else {
31360f900049STejun Heo 		void *ptr;
3137e1d8aa9fSFrederic Weisbecker 
31380f900049STejun Heo 		/*
3139f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3140f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3141f3421797STejun Heo 		 * allocated pointer which will be used for free.
31420f900049STejun Heo 		 */
3143bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3144bdbc5dd7STejun Heo 		if (ptr) {
3145bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3146bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3147bdbc5dd7STejun Heo 		}
31483af24433SOleg Nesterov 	}
31493af24433SOleg Nesterov 
31500415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3151bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3152bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
31530f900049STejun Heo }
31540f900049STejun Heo 
3155bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
315606ba38a9SOleg Nesterov {
3157e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3158bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3159f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3160f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3161f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
316206ba38a9SOleg Nesterov 	}
316306ba38a9SOleg Nesterov }
316406ba38a9SOleg Nesterov 
3165f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3166f3421797STejun Heo 			       const char *name)
3167b71ab8c2STejun Heo {
3168f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3169f3421797STejun Heo 
3170f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3171044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3172f3421797STejun Heo 			max_active, name, 1, lim);
3173b71ab8c2STejun Heo 
3174f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3175b71ab8c2STejun Heo }
3176b71ab8c2STejun Heo 
3177b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
317897e37d7bSTejun Heo 					       unsigned int flags,
31791e19ffc6STejun Heo 					       int max_active,
3180eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3181b196be89STejun Heo 					       const char *lock_name, ...)
31823af24433SOleg Nesterov {
3183b196be89STejun Heo 	va_list args, args1;
31843af24433SOleg Nesterov 	struct workqueue_struct *wq;
3185c34056a3STejun Heo 	unsigned int cpu;
3186b196be89STejun Heo 	size_t namelen;
3187b196be89STejun Heo 
3188b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3189b196be89STejun Heo 	va_start(args, lock_name);
3190b196be89STejun Heo 	va_copy(args1, args);
3191b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3192b196be89STejun Heo 
3193b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3194b196be89STejun Heo 	if (!wq)
3195b196be89STejun Heo 		goto err;
3196b196be89STejun Heo 
3197b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3198b196be89STejun Heo 	va_end(args);
3199b196be89STejun Heo 	va_end(args1);
32003af24433SOleg Nesterov 
3201f3421797STejun Heo 	/*
32026370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
32036370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
32046370a6adSTejun Heo 	 */
32056370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
32066370a6adSTejun Heo 		flags |= WQ_RESCUER;
32076370a6adSTejun Heo 
3208d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3209b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
32103af24433SOleg Nesterov 
3211b196be89STejun Heo 	/* init wq */
321297e37d7bSTejun Heo 	wq->flags = flags;
3213a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
321473f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
321573f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
321673f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
321773f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
32183af24433SOleg Nesterov 
3219eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3220cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
32213af24433SOleg Nesterov 
3222bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3223bdbc5dd7STejun Heo 		goto err;
3224bdbc5dd7STejun Heo 
3225f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
32261537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
32278b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
32283270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
32291537663fSTejun Heo 
32300f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
32313270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3232c34056a3STejun Heo 		cwq->wq = wq;
323373f53c4aSTejun Heo 		cwq->flush_color = -1;
32341e19ffc6STejun Heo 		cwq->max_active = max_active;
32351e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3236e22bee78STejun Heo 	}
32371537663fSTejun Heo 
3238e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3239e22bee78STejun Heo 		struct worker *rescuer;
3240e22bee78STejun Heo 
3241f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3242e22bee78STejun Heo 			goto err;
3243e22bee78STejun Heo 
3244e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3245e22bee78STejun Heo 		if (!rescuer)
3246e22bee78STejun Heo 			goto err;
3247e22bee78STejun Heo 
3248b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3249b196be89STejun Heo 					       wq->name);
3250e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3251e22bee78STejun Heo 			goto err;
3252e22bee78STejun Heo 
3253e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3254e22bee78STejun Heo 		wake_up_process(rescuer->task);
32553af24433SOleg Nesterov 	}
32561537663fSTejun Heo 
32573af24433SOleg Nesterov 	/*
3258a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3259a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3260a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
32613af24433SOleg Nesterov 	 */
32623af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3263a0a1a5fdSTejun Heo 
326458a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3265f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3266a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3267a0a1a5fdSTejun Heo 
32683af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3269a0a1a5fdSTejun Heo 
32703af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
32713af24433SOleg Nesterov 
32723af24433SOleg Nesterov 	return wq;
32734690c4abSTejun Heo err:
32744690c4abSTejun Heo 	if (wq) {
3275bdbc5dd7STejun Heo 		free_cwqs(wq);
3276f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3277e22bee78STejun Heo 		kfree(wq->rescuer);
32784690c4abSTejun Heo 		kfree(wq);
32793af24433SOleg Nesterov 	}
32804690c4abSTejun Heo 	return NULL;
32811da177e4SLinus Torvalds }
3282d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
32831da177e4SLinus Torvalds 
32843af24433SOleg Nesterov /**
32853af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
32863af24433SOleg Nesterov  * @wq: target workqueue
32873af24433SOleg Nesterov  *
32883af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
32893af24433SOleg Nesterov  */
32903af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
32913af24433SOleg Nesterov {
3292c8e55f36STejun Heo 	unsigned int cpu;
32933af24433SOleg Nesterov 
32949c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
32959c5a2ba7STejun Heo 	drain_workqueue(wq);
3296c8efcc25STejun Heo 
3297a0a1a5fdSTejun Heo 	/*
3298a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3299a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3300a0a1a5fdSTejun Heo 	 */
330195402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
33023af24433SOleg Nesterov 	list_del(&wq->list);
330395402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
33043af24433SOleg Nesterov 
3305e22bee78STejun Heo 	/* sanity check */
3306f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
330773f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
330873f53c4aSTejun Heo 		int i;
33093af24433SOleg Nesterov 
331073f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
331173f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
33121e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
33131e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
331473f53c4aSTejun Heo 	}
33151537663fSTejun Heo 
3316e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3317e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3318f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
33198d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3320e22bee78STejun Heo 	}
3321e22bee78STejun Heo 
3322bdbc5dd7STejun Heo 	free_cwqs(wq);
33233af24433SOleg Nesterov 	kfree(wq);
33243af24433SOleg Nesterov }
33253af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
33263af24433SOleg Nesterov 
3327dcd989cbSTejun Heo /**
3328dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3329dcd989cbSTejun Heo  * @wq: target workqueue
3330dcd989cbSTejun Heo  * @max_active: new max_active value.
3331dcd989cbSTejun Heo  *
3332dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3333dcd989cbSTejun Heo  *
3334dcd989cbSTejun Heo  * CONTEXT:
3335dcd989cbSTejun Heo  * Don't call from IRQ context.
3336dcd989cbSTejun Heo  */
3337dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3338dcd989cbSTejun Heo {
3339dcd989cbSTejun Heo 	unsigned int cpu;
3340dcd989cbSTejun Heo 
3341f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3342dcd989cbSTejun Heo 
3343dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3344dcd989cbSTejun Heo 
3345dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3346dcd989cbSTejun Heo 
3347f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3348dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3349dcd989cbSTejun Heo 
3350dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3351dcd989cbSTejun Heo 
335258a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3353dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3354dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3355dcd989cbSTejun Heo 
3356dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3357dcd989cbSTejun Heo 	}
3358dcd989cbSTejun Heo 
3359dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3360dcd989cbSTejun Heo }
3361dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3362dcd989cbSTejun Heo 
3363dcd989cbSTejun Heo /**
3364dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3365dcd989cbSTejun Heo  * @cpu: CPU in question
3366dcd989cbSTejun Heo  * @wq: target workqueue
3367dcd989cbSTejun Heo  *
3368dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3369dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3370dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3371dcd989cbSTejun Heo  *
3372dcd989cbSTejun Heo  * RETURNS:
3373dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3374dcd989cbSTejun Heo  */
3375dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3376dcd989cbSTejun Heo {
3377dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3378dcd989cbSTejun Heo 
3379dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3380dcd989cbSTejun Heo }
3381dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3382dcd989cbSTejun Heo 
3383dcd989cbSTejun Heo /**
3384dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3385dcd989cbSTejun Heo  * @work: the work of interest
3386dcd989cbSTejun Heo  *
3387dcd989cbSTejun Heo  * RETURNS:
3388bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3389dcd989cbSTejun Heo  */
3390dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3391dcd989cbSTejun Heo {
3392dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3393dcd989cbSTejun Heo 
3394bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3395dcd989cbSTejun Heo }
3396dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3397dcd989cbSTejun Heo 
3398dcd989cbSTejun Heo /**
3399dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3400dcd989cbSTejun Heo  * @work: the work to be tested
3401dcd989cbSTejun Heo  *
3402dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3403dcd989cbSTejun Heo  * synchronization around this function and the test result is
3404dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3405dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3406dcd989cbSTejun Heo  * running state.
3407dcd989cbSTejun Heo  *
3408dcd989cbSTejun Heo  * RETURNS:
3409dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3410dcd989cbSTejun Heo  */
3411dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3412dcd989cbSTejun Heo {
3413dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3414dcd989cbSTejun Heo 	unsigned long flags;
3415dcd989cbSTejun Heo 	unsigned int ret = 0;
3416dcd989cbSTejun Heo 
3417dcd989cbSTejun Heo 	if (!gcwq)
3418dcd989cbSTejun Heo 		return false;
3419dcd989cbSTejun Heo 
3420dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3421dcd989cbSTejun Heo 
3422dcd989cbSTejun Heo 	if (work_pending(work))
3423dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3424dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3425dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3426dcd989cbSTejun Heo 
3427dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3428dcd989cbSTejun Heo 
3429dcd989cbSTejun Heo 	return ret;
3430dcd989cbSTejun Heo }
3431dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3432dcd989cbSTejun Heo 
3433db7bccf4STejun Heo /*
3434db7bccf4STejun Heo  * CPU hotplug.
3435db7bccf4STejun Heo  *
3436e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3437e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3438e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3439e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3440e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3441e22bee78STejun Heo  * blocked draining impractical.
3442e22bee78STejun Heo  *
3443628c78e7STejun Heo  * This is solved by allowing a gcwq to be disassociated from the CPU
3444628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
3445628c78e7STejun Heo  * cpu comes back online.
3446db7bccf4STejun Heo  */
3447db7bccf4STejun Heo 
344860373152STejun Heo /* claim manager positions of all pools */
34498db25e78STejun Heo static void gcwq_claim_management_and_lock(struct global_cwq *gcwq)
345060373152STejun Heo {
345160373152STejun Heo 	struct worker_pool *pool;
345260373152STejun Heo 
345360373152STejun Heo 	for_each_worker_pool(pool, gcwq)
345460373152STejun Heo 		mutex_lock_nested(&pool->manager_mutex, pool - gcwq->pools);
34558db25e78STejun Heo 	spin_lock_irq(&gcwq->lock);
345660373152STejun Heo }
345760373152STejun Heo 
345860373152STejun Heo /* release manager positions */
34598db25e78STejun Heo static void gcwq_release_management_and_unlock(struct global_cwq *gcwq)
346060373152STejun Heo {
346160373152STejun Heo 	struct worker_pool *pool;
346260373152STejun Heo 
34638db25e78STejun Heo 	spin_unlock_irq(&gcwq->lock);
346460373152STejun Heo 	for_each_worker_pool(pool, gcwq)
346560373152STejun Heo 		mutex_unlock(&pool->manager_mutex);
346660373152STejun Heo }
346760373152STejun Heo 
3468628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work)
3469db7bccf4STejun Heo {
3470628c78e7STejun Heo 	struct global_cwq *gcwq = get_gcwq(smp_processor_id());
34714ce62e9eSTejun Heo 	struct worker_pool *pool;
3472db7bccf4STejun Heo 	struct worker *worker;
3473db7bccf4STejun Heo 	struct hlist_node *pos;
3474db7bccf4STejun Heo 	int i;
3475db7bccf4STejun Heo 
3476db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3477db7bccf4STejun Heo 
34788db25e78STejun Heo 	gcwq_claim_management_and_lock(gcwq);
3479e22bee78STejun Heo 
3480f2d5a0eeSTejun Heo 	/*
3481f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3482f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3483f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3484f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3485f2d5a0eeSTejun Heo 	 */
348660373152STejun Heo 	for_each_worker_pool(pool, gcwq)
34874ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3488403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3489db7bccf4STejun Heo 
3490db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3491403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3492db7bccf4STejun Heo 
3493f2d5a0eeSTejun Heo 	gcwq->flags |= GCWQ_DISASSOCIATED;
3494f2d5a0eeSTejun Heo 
34958db25e78STejun Heo 	gcwq_release_management_and_unlock(gcwq);
3496e22bee78STejun Heo 
3497e22bee78STejun Heo 	/*
3498628c78e7STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3499628c78e7STejun Heo 	 * sched callbacks see the %WORKER_UNBOUND flag.  This is necessary
3500628c78e7STejun Heo 	 * as scheduler callbacks may be invoked from other cpus.
3501628c78e7STejun Heo 	 */
3502628c78e7STejun Heo 	schedule();
3503628c78e7STejun Heo 
3504628c78e7STejun Heo 	/*
3505628c78e7STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After this,
3506628c78e7STejun Heo 	 * nr_running stays zero and need_more_worker() and keep_working()
3507628c78e7STejun Heo 	 * are always true as long as the worklist is not empty.  @gcwq now
3508628c78e7STejun Heo 	 * behaves as unbound (in terms of concurrency management) gcwq
3509628c78e7STejun Heo 	 * which is served by workers tied to the CPU.
3510628c78e7STejun Heo 	 *
3511628c78e7STejun Heo 	 * On return from this function, the current worker would trigger
3512628c78e7STejun Heo 	 * unbound chain execution of pending work items if other workers
3513628c78e7STejun Heo 	 * didn't already.
3514e22bee78STejun Heo 	 */
35154ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35164ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3517db7bccf4STejun Heo }
3518db7bccf4STejun Heo 
35198db25e78STejun Heo /*
35208db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
35218db25e78STejun Heo  * This will be registered high priority CPU notifier.
35228db25e78STejun Heo  */
35238db25e78STejun Heo static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
35241da177e4SLinus Torvalds 					       unsigned long action,
35251da177e4SLinus Torvalds 					       void *hcpu)
35261da177e4SLinus Torvalds {
35273af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3528db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
35294ce62e9eSTejun Heo 	struct worker_pool *pool;
35301da177e4SLinus Torvalds 
35318db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
35323af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35334ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35343ce63377STejun Heo 			struct worker *worker;
35353ce63377STejun Heo 
35363ce63377STejun Heo 			if (pool->nr_workers)
35373ce63377STejun Heo 				continue;
35383ce63377STejun Heo 
35393ce63377STejun Heo 			worker = create_worker(pool);
35403ce63377STejun Heo 			if (!worker)
35413ce63377STejun Heo 				return NOTIFY_BAD;
35423ce63377STejun Heo 
35433ce63377STejun Heo 			spin_lock_irq(&gcwq->lock);
35443ce63377STejun Heo 			start_worker(worker);
35453ce63377STejun Heo 			spin_unlock_irq(&gcwq->lock);
35463af24433SOleg Nesterov 		}
35471da177e4SLinus Torvalds 		break;
35481da177e4SLinus Torvalds 
354965758202STejun Heo 	case CPU_DOWN_FAILED:
355065758202STejun Heo 	case CPU_ONLINE:
35518db25e78STejun Heo 		gcwq_claim_management_and_lock(gcwq);
35528db25e78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
35538db25e78STejun Heo 		rebind_workers(gcwq);
35548db25e78STejun Heo 		gcwq_release_management_and_unlock(gcwq);
35558db25e78STejun Heo 		break;
355665758202STejun Heo 	}
355765758202STejun Heo 	return NOTIFY_OK;
355865758202STejun Heo }
355965758202STejun Heo 
356065758202STejun Heo /*
356165758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
356265758202STejun Heo  * This will be registered as low priority CPU notifier.
356365758202STejun Heo  */
356465758202STejun Heo static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
356565758202STejun Heo 						 unsigned long action,
356665758202STejun Heo 						 void *hcpu)
356765758202STejun Heo {
35688db25e78STejun Heo 	unsigned int cpu = (unsigned long)hcpu;
35698db25e78STejun Heo 	struct work_struct unbind_work;
35708db25e78STejun Heo 
357165758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
357265758202STejun Heo 	case CPU_DOWN_PREPARE:
35738db25e78STejun Heo 		/* unbinding should happen on the local CPU */
35748db25e78STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
35757635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
35768db25e78STejun Heo 		flush_work(&unbind_work);
35778db25e78STejun Heo 		break;
357865758202STejun Heo 	}
357965758202STejun Heo 	return NOTIFY_OK;
358065758202STejun Heo }
358165758202STejun Heo 
35822d3854a3SRusty Russell #ifdef CONFIG_SMP
35838ccad40dSRusty Russell 
35842d3854a3SRusty Russell struct work_for_cpu {
35856b44003eSAndrew Morton 	struct completion completion;
35862d3854a3SRusty Russell 	long (*fn)(void *);
35872d3854a3SRusty Russell 	void *arg;
35882d3854a3SRusty Russell 	long ret;
35892d3854a3SRusty Russell };
35902d3854a3SRusty Russell 
35916b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
35922d3854a3SRusty Russell {
35936b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
35942d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
35956b44003eSAndrew Morton 	complete(&wfc->completion);
35966b44003eSAndrew Morton 	return 0;
35972d3854a3SRusty Russell }
35982d3854a3SRusty Russell 
35992d3854a3SRusty Russell /**
36002d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36012d3854a3SRusty Russell  * @cpu: the cpu to run on
36022d3854a3SRusty Russell  * @fn: the function to run
36032d3854a3SRusty Russell  * @arg: the function arg
36042d3854a3SRusty Russell  *
360531ad9081SRusty Russell  * This will return the value @fn returns.
360631ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36076b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36082d3854a3SRusty Russell  */
36092d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36102d3854a3SRusty Russell {
36116b44003eSAndrew Morton 	struct task_struct *sub_thread;
36126b44003eSAndrew Morton 	struct work_for_cpu wfc = {
36136b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
36146b44003eSAndrew Morton 		.fn = fn,
36156b44003eSAndrew Morton 		.arg = arg,
36166b44003eSAndrew Morton 	};
36172d3854a3SRusty Russell 
36186b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
36196b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
36206b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
36216b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
36226b44003eSAndrew Morton 	wake_up_process(sub_thread);
36236b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
36242d3854a3SRusty Russell 	return wfc.ret;
36252d3854a3SRusty Russell }
36262d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36272d3854a3SRusty Russell #endif /* CONFIG_SMP */
36282d3854a3SRusty Russell 
3629a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3630e7577c50SRusty Russell 
3631a0a1a5fdSTejun Heo /**
3632a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3633a0a1a5fdSTejun Heo  *
363458a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
363558a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
363658a69cb4STejun Heo  * gcwq->worklist.
3637a0a1a5fdSTejun Heo  *
3638a0a1a5fdSTejun Heo  * CONTEXT:
36398b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3640a0a1a5fdSTejun Heo  */
3641a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3642a0a1a5fdSTejun Heo {
3643a0a1a5fdSTejun Heo 	unsigned int cpu;
3644a0a1a5fdSTejun Heo 
3645a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3646a0a1a5fdSTejun Heo 
3647a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3648a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3649a0a1a5fdSTejun Heo 
3650f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
36518b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3652bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
36538b03ae3cSTejun Heo 
36548b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
36558b03ae3cSTejun Heo 
3656db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3657db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3658db7bccf4STejun Heo 
3659a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3660a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3661a0a1a5fdSTejun Heo 
366258a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3663a0a1a5fdSTejun Heo 				cwq->max_active = 0;
36641da177e4SLinus Torvalds 		}
36658b03ae3cSTejun Heo 
36668b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3667a0a1a5fdSTejun Heo 	}
3668a0a1a5fdSTejun Heo 
3669a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3670a0a1a5fdSTejun Heo }
3671a0a1a5fdSTejun Heo 
3672a0a1a5fdSTejun Heo /**
367358a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3674a0a1a5fdSTejun Heo  *
3675a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3676a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3677a0a1a5fdSTejun Heo  *
3678a0a1a5fdSTejun Heo  * CONTEXT:
3679a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3680a0a1a5fdSTejun Heo  *
3681a0a1a5fdSTejun Heo  * RETURNS:
368258a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
368358a69cb4STejun Heo  * is complete.
3684a0a1a5fdSTejun Heo  */
3685a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3686a0a1a5fdSTejun Heo {
3687a0a1a5fdSTejun Heo 	unsigned int cpu;
3688a0a1a5fdSTejun Heo 	bool busy = false;
3689a0a1a5fdSTejun Heo 
3690a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3691a0a1a5fdSTejun Heo 
3692a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3693a0a1a5fdSTejun Heo 
3694f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3695bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3696a0a1a5fdSTejun Heo 		/*
3697a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3698a0a1a5fdSTejun Heo 		 * to peek without lock.
3699a0a1a5fdSTejun Heo 		 */
3700a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3701a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3702a0a1a5fdSTejun Heo 
370358a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3704a0a1a5fdSTejun Heo 				continue;
3705a0a1a5fdSTejun Heo 
3706a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3707a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3708a0a1a5fdSTejun Heo 				busy = true;
3709a0a1a5fdSTejun Heo 				goto out_unlock;
3710a0a1a5fdSTejun Heo 			}
3711a0a1a5fdSTejun Heo 		}
3712a0a1a5fdSTejun Heo 	}
3713a0a1a5fdSTejun Heo out_unlock:
3714a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3715a0a1a5fdSTejun Heo 	return busy;
3716a0a1a5fdSTejun Heo }
3717a0a1a5fdSTejun Heo 
3718a0a1a5fdSTejun Heo /**
3719a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3720a0a1a5fdSTejun Heo  *
3721a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
37227e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3723a0a1a5fdSTejun Heo  *
3724a0a1a5fdSTejun Heo  * CONTEXT:
37258b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3726a0a1a5fdSTejun Heo  */
3727a0a1a5fdSTejun Heo void thaw_workqueues(void)
3728a0a1a5fdSTejun Heo {
3729a0a1a5fdSTejun Heo 	unsigned int cpu;
3730a0a1a5fdSTejun Heo 
3731a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3732a0a1a5fdSTejun Heo 
3733a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3734a0a1a5fdSTejun Heo 		goto out_unlock;
3735a0a1a5fdSTejun Heo 
3736f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37378b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
37384ce62e9eSTejun Heo 		struct worker_pool *pool;
3739bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37408b03ae3cSTejun Heo 
37418b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37428b03ae3cSTejun Heo 
3743db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3744db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3745db7bccf4STejun Heo 
3746a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3747a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3748a0a1a5fdSTejun Heo 
374958a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3750a0a1a5fdSTejun Heo 				continue;
3751a0a1a5fdSTejun Heo 
3752a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3753a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3754a0a1a5fdSTejun Heo 
3755a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3756a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3757a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3758a0a1a5fdSTejun Heo 		}
37598b03ae3cSTejun Heo 
37604ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
37614ce62e9eSTejun Heo 			wake_up_worker(pool);
3762e22bee78STejun Heo 
37638b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3764a0a1a5fdSTejun Heo 	}
3765a0a1a5fdSTejun Heo 
3766a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3767a0a1a5fdSTejun Heo out_unlock:
3768a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3769a0a1a5fdSTejun Heo }
3770a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3771a0a1a5fdSTejun Heo 
37726ee0578bSSuresh Siddha static int __init init_workqueues(void)
37731da177e4SLinus Torvalds {
3774c34056a3STejun Heo 	unsigned int cpu;
3775c8e55f36STejun Heo 	int i;
3776c34056a3STejun Heo 
3777b5490077STejun Heo 	/* make sure we have enough bits for OFFQ CPU number */
3778b5490077STejun Heo 	BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3779b5490077STejun Heo 		     WORK_CPU_LAST);
3780b5490077STejun Heo 
378165758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
378265758202STejun Heo 	cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
37838b03ae3cSTejun Heo 
37848b03ae3cSTejun Heo 	/* initialize gcwqs */
3785f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37868b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
37874ce62e9eSTejun Heo 		struct worker_pool *pool;
37888b03ae3cSTejun Heo 
37898b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
37908b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3791f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
37928b03ae3cSTejun Heo 
3793c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3794c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3795c8e55f36STejun Heo 
37964ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
37974ce62e9eSTejun Heo 			pool->gcwq = gcwq;
37984ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
37994ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3800e22bee78STejun Heo 
38014ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38024ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38034ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3804e22bee78STejun Heo 
38054ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38064ce62e9eSTejun Heo 				    (unsigned long)pool);
38074ce62e9eSTejun Heo 
380860373152STejun Heo 			mutex_init(&pool->manager_mutex);
38094ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38104ce62e9eSTejun Heo 		}
3811db7bccf4STejun Heo 
381225511a47STejun Heo 		init_waitqueue_head(&gcwq->rebind_hold);
38138b03ae3cSTejun Heo 	}
38148b03ae3cSTejun Heo 
3815e22bee78STejun Heo 	/* create the initial worker */
3816f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3817e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38184ce62e9eSTejun Heo 		struct worker_pool *pool;
3819e22bee78STejun Heo 
3820477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3821477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
38224ce62e9eSTejun Heo 
38234ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38244ce62e9eSTejun Heo 			struct worker *worker;
38254ce62e9eSTejun Heo 
3826bc2ae0f5STejun Heo 			worker = create_worker(pool);
3827e22bee78STejun Heo 			BUG_ON(!worker);
3828e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3829e22bee78STejun Heo 			start_worker(worker);
3830e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3831e22bee78STejun Heo 		}
38324ce62e9eSTejun Heo 	}
3833e22bee78STejun Heo 
3834d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
38351aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
3836d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3837f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3838f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
383924d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
384024d51addSTejun Heo 					      WQ_FREEZABLE, 0);
38411aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
3842*ae930e0fSTejun Heo 	       !system_unbound_wq || !system_freezable_wq);
38436ee0578bSSuresh Siddha 	return 0;
38441da177e4SLinus Torvalds }
38456ee0578bSSuresh Siddha early_initcall(init_workqueues);
3846