xref: /linux-6.15/kernel/workqueue.c (revision 8376fe22)
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 
1863270476aSTejun Heo 	struct worker_pool	pools[2];	/* normal and highpri pools */
187db7bccf4STejun Heo 
18825511a47STejun Heo 	wait_queue_head_t	rebind_hold;	/* rebind hold wait */
1898b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1908b03ae3cSTejun Heo 
1918b03ae3cSTejun Heo /*
192502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1930f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1940f900049STejun Heo  * aligned at two's power of the number of flag bits.
1951da177e4SLinus Torvalds  */
1961da177e4SLinus Torvalds struct cpu_workqueue_struct {
197bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1984690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
19973f53c4aSTejun Heo 	int			work_color;	/* L: current color */
20073f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
20173f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
20273f53c4aSTejun Heo 						/* L: nr of in_flight works */
2031e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
204a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
2051e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
2060f900049STejun Heo };
2071da177e4SLinus Torvalds 
2081da177e4SLinus Torvalds /*
20973f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
21073f53c4aSTejun Heo  */
21173f53c4aSTejun Heo struct wq_flusher {
21273f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
21373f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
21473f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
21573f53c4aSTejun Heo };
2161da177e4SLinus Torvalds 
21773f53c4aSTejun Heo /*
218f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
219f2e005aaSTejun Heo  * used to determine whether there's something to be done.
220f2e005aaSTejun Heo  */
221f2e005aaSTejun Heo #ifdef CONFIG_SMP
222f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
223f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
224f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
225f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
226f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2279c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
228f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
229f2e005aaSTejun Heo #else
230f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
231f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
232f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
233f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
234f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
235f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
236f2e005aaSTejun Heo #endif
2371da177e4SLinus Torvalds 
2381da177e4SLinus Torvalds /*
2391da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2401da177e4SLinus Torvalds  * per-CPU workqueues:
2411da177e4SLinus Torvalds  */
2421da177e4SLinus Torvalds struct workqueue_struct {
2439c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
244bdbc5dd7STejun Heo 	union {
245bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
246bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
247bdbc5dd7STejun Heo 		unsigned long				v;
248bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2494690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
25073f53c4aSTejun Heo 
25173f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
25273f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
25373f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
25473f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
25573f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
25673f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
25773f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
25873f53c4aSTejun Heo 
259f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
260e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
261e22bee78STejun Heo 
2629c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
263dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2644e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2654e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2664e6045f1SJohannes Berg #endif
267b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2681da177e4SLinus Torvalds };
2691da177e4SLinus Torvalds 
270d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
271d320c038STejun Heo struct workqueue_struct *system_long_wq __read_mostly;
272d320c038STejun Heo struct workqueue_struct *system_nrt_wq __read_mostly;
273f3421797STejun Heo struct workqueue_struct *system_unbound_wq __read_mostly;
27424d51addSTejun Heo struct workqueue_struct *system_freezable_wq __read_mostly;
27562d3c543SAlan Stern struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
276d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
277d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
278d320c038STejun Heo EXPORT_SYMBOL_GPL(system_nrt_wq);
279f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
28024d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
28162d3c543SAlan Stern EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
282d320c038STejun Heo 
28397bd2347STejun Heo #define CREATE_TRACE_POINTS
28497bd2347STejun Heo #include <trace/events/workqueue.h>
28597bd2347STejun Heo 
2864ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
2873270476aSTejun Heo 	for ((pool) = &(gcwq)->pools[0];				\
2883270476aSTejun Heo 	     (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
2894ce62e9eSTejun Heo 
290db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
291db7bccf4STejun Heo 	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
292db7bccf4STejun Heo 		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
293db7bccf4STejun Heo 
294f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
295f3421797STejun Heo 				  unsigned int sw)
296f3421797STejun Heo {
297f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
298f3421797STejun Heo 		if (sw & 1) {
299f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
300f3421797STejun Heo 			if (cpu < nr_cpu_ids)
301f3421797STejun Heo 				return cpu;
302f3421797STejun Heo 		}
303f3421797STejun Heo 		if (sw & 2)
304f3421797STejun Heo 			return WORK_CPU_UNBOUND;
305f3421797STejun Heo 	}
306f3421797STejun Heo 	return WORK_CPU_NONE;
307f3421797STejun Heo }
308f3421797STejun Heo 
309f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
310f3421797STejun Heo 				struct workqueue_struct *wq)
311f3421797STejun Heo {
312f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
313f3421797STejun Heo }
314f3421797STejun Heo 
31509884951STejun Heo /*
31609884951STejun Heo  * CPU iterators
31709884951STejun Heo  *
31809884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
31909884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
32009884951STejun Heo  * specific CPU.  The following iterators are similar to
32109884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
32209884951STejun Heo  *
32309884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
32409884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
32509884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
32609884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
32709884951STejun Heo  */
328f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
329f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
330f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
331f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
332f3421797STejun Heo 
333f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
334f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
335f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
336f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
337f3421797STejun Heo 
338f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
339f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
340f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
341f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
342f3421797STejun Heo 
343dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
344dc186ad7SThomas Gleixner 
345dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
346dc186ad7SThomas Gleixner 
34799777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
34899777288SStanislaw Gruszka {
34999777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
35099777288SStanislaw Gruszka }
35199777288SStanislaw Gruszka 
352dc186ad7SThomas Gleixner /*
353dc186ad7SThomas Gleixner  * fixup_init is called when:
354dc186ad7SThomas Gleixner  * - an active object is initialized
355dc186ad7SThomas Gleixner  */
356dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
357dc186ad7SThomas Gleixner {
358dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
359dc186ad7SThomas Gleixner 
360dc186ad7SThomas Gleixner 	switch (state) {
361dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
362dc186ad7SThomas Gleixner 		cancel_work_sync(work);
363dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
364dc186ad7SThomas Gleixner 		return 1;
365dc186ad7SThomas Gleixner 	default:
366dc186ad7SThomas Gleixner 		return 0;
367dc186ad7SThomas Gleixner 	}
368dc186ad7SThomas Gleixner }
369dc186ad7SThomas Gleixner 
370dc186ad7SThomas Gleixner /*
371dc186ad7SThomas Gleixner  * fixup_activate is called when:
372dc186ad7SThomas Gleixner  * - an active object is activated
373dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
374dc186ad7SThomas Gleixner  */
375dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
376dc186ad7SThomas Gleixner {
377dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
378dc186ad7SThomas Gleixner 
379dc186ad7SThomas Gleixner 	switch (state) {
380dc186ad7SThomas Gleixner 
381dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
382dc186ad7SThomas Gleixner 		/*
383dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
384dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
385dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
386dc186ad7SThomas Gleixner 		 */
38722df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
388dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
389dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
390dc186ad7SThomas Gleixner 			return 0;
391dc186ad7SThomas Gleixner 		}
392dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
393dc186ad7SThomas Gleixner 		return 0;
394dc186ad7SThomas Gleixner 
395dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
396dc186ad7SThomas Gleixner 		WARN_ON(1);
397dc186ad7SThomas Gleixner 
398dc186ad7SThomas Gleixner 	default:
399dc186ad7SThomas Gleixner 		return 0;
400dc186ad7SThomas Gleixner 	}
401dc186ad7SThomas Gleixner }
402dc186ad7SThomas Gleixner 
403dc186ad7SThomas Gleixner /*
404dc186ad7SThomas Gleixner  * fixup_free is called when:
405dc186ad7SThomas Gleixner  * - an active object is freed
406dc186ad7SThomas Gleixner  */
407dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
408dc186ad7SThomas Gleixner {
409dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
410dc186ad7SThomas Gleixner 
411dc186ad7SThomas Gleixner 	switch (state) {
412dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
413dc186ad7SThomas Gleixner 		cancel_work_sync(work);
414dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
415dc186ad7SThomas Gleixner 		return 1;
416dc186ad7SThomas Gleixner 	default:
417dc186ad7SThomas Gleixner 		return 0;
418dc186ad7SThomas Gleixner 	}
419dc186ad7SThomas Gleixner }
420dc186ad7SThomas Gleixner 
421dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
422dc186ad7SThomas Gleixner 	.name		= "work_struct",
42399777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
424dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
425dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
426dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
427dc186ad7SThomas Gleixner };
428dc186ad7SThomas Gleixner 
429dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
430dc186ad7SThomas Gleixner {
431dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
432dc186ad7SThomas Gleixner }
433dc186ad7SThomas Gleixner 
434dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
435dc186ad7SThomas Gleixner {
436dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
437dc186ad7SThomas Gleixner }
438dc186ad7SThomas Gleixner 
439dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
440dc186ad7SThomas Gleixner {
441dc186ad7SThomas Gleixner 	if (onstack)
442dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
443dc186ad7SThomas Gleixner 	else
444dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
445dc186ad7SThomas Gleixner }
446dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
447dc186ad7SThomas Gleixner 
448dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
449dc186ad7SThomas Gleixner {
450dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
451dc186ad7SThomas Gleixner }
452dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
453dc186ad7SThomas Gleixner 
454dc186ad7SThomas Gleixner #else
455dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
456dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
457dc186ad7SThomas Gleixner #endif
458dc186ad7SThomas Gleixner 
45995402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
46095402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4611da177e4SLinus Torvalds static LIST_HEAD(workqueues);
462a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4631da177e4SLinus Torvalds 
46414441960SOleg Nesterov /*
465e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
466e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
467e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
46814441960SOleg Nesterov  */
4698b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
4704ce62e9eSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
471f756d5e2SNathan Lynch 
472f3421797STejun Heo /*
473f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
474f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
475f3421797STejun Heo  * workers have WORKER_UNBOUND set.
476f3421797STejun Heo  */
477f3421797STejun Heo static struct global_cwq unbound_global_cwq;
4784ce62e9eSTejun Heo static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
4794ce62e9eSTejun Heo 	[0 ... NR_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4804ce62e9eSTejun Heo };
481f3421797STejun Heo 
482c34056a3STejun Heo static int worker_thread(void *__worker);
4831da177e4SLinus Torvalds 
4843270476aSTejun Heo static int worker_pool_pri(struct worker_pool *pool)
4853270476aSTejun Heo {
4863270476aSTejun Heo 	return pool - pool->gcwq->pools;
4873270476aSTejun Heo }
4883270476aSTejun Heo 
4898b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4901da177e4SLinus Torvalds {
491f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4928b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
493f3421797STejun Heo 	else
494f3421797STejun Heo 		return &unbound_global_cwq;
4951da177e4SLinus Torvalds }
4961da177e4SLinus Torvalds 
49763d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
498b1f4ec17SOleg Nesterov {
49963d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
5003270476aSTejun Heo 	int idx = worker_pool_pri(pool);
50163d95a91STejun Heo 
502f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
5034ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
504f3421797STejun Heo 	else
5054ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
506b1f4ec17SOleg Nesterov }
507b1f4ec17SOleg Nesterov 
5084690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
5094690c4abSTejun Heo 					    struct workqueue_struct *wq)
510a848e3b6SOleg Nesterov {
511f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
512e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
513bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
514f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
515f3421797STejun Heo 		return wq->cpu_wq.single;
516f3421797STejun Heo 	return NULL;
517f3421797STejun Heo }
518a848e3b6SOleg Nesterov 
51973f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
52073f53c4aSTejun Heo {
52173f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
52273f53c4aSTejun Heo }
52373f53c4aSTejun Heo 
52473f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
52573f53c4aSTejun Heo {
52673f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
52773f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
52873f53c4aSTejun Heo }
52973f53c4aSTejun Heo 
53073f53c4aSTejun Heo static int work_next_color(int color)
53173f53c4aSTejun Heo {
53273f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5331da177e4SLinus Torvalds }
5341da177e4SLinus Torvalds 
5354594bf15SDavid Howells /*
536b5490077STejun Heo  * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
537b5490077STejun Heo  * contain the pointer to the queued cwq.  Once execution starts, the flag
538b5490077STejun Heo  * is cleared and the high bits contain OFFQ flags and CPU number.
5397a22ad75STejun Heo  *
540bbb68dfaSTejun Heo  * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
541bbb68dfaSTejun Heo  * and clear_work_data() can be used to set the cwq, cpu or clear
542bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
543bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5447a22ad75STejun Heo  *
545bbb68dfaSTejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
546bbb68dfaSTejun Heo  * a work.  gcwq is available once the work has been queued anywhere after
547bbb68dfaSTejun Heo  * initialization until it is sync canceled.  cwq is available only while
548bbb68dfaSTejun Heo  * the work item is queued.
549bbb68dfaSTejun Heo  *
550bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
551bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
552bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
553bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5544594bf15SDavid Howells  */
5557a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5567a22ad75STejun Heo 				 unsigned long flags)
5577a22ad75STejun Heo {
5587a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5597a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5607a22ad75STejun Heo }
5617a22ad75STejun Heo 
5627a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5634690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5644690c4abSTejun Heo 			 unsigned long extra_flags)
565365970a1SDavid Howells {
5667a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
567e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
568365970a1SDavid Howells }
569365970a1SDavid Howells 
5708930cabaSTejun Heo static void set_work_cpu_and_clear_pending(struct work_struct *work,
5718930cabaSTejun Heo 					   unsigned int cpu)
5724d707b9fSOleg Nesterov {
573b5490077STejun Heo 	set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
5744d707b9fSOleg Nesterov }
5754d707b9fSOleg Nesterov 
5767a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
577365970a1SDavid Howells {
5787a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5797a22ad75STejun Heo }
5807a22ad75STejun Heo 
5817a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5827a22ad75STejun Heo {
583e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5847a22ad75STejun Heo 
585e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
586e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
587e120153dSTejun Heo 	else
588e120153dSTejun Heo 		return NULL;
5897a22ad75STejun Heo }
5907a22ad75STejun Heo 
5917a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5927a22ad75STejun Heo {
593e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5947a22ad75STejun Heo 	unsigned int cpu;
5957a22ad75STejun Heo 
596e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
597e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
598bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
5997a22ad75STejun Heo 
600b5490077STejun Heo 	cpu = data >> WORK_OFFQ_CPU_SHIFT;
601bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
6027a22ad75STejun Heo 		return NULL;
6037a22ad75STejun Heo 
604f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
6057a22ad75STejun Heo 	return get_gcwq(cpu);
606365970a1SDavid Howells }
607365970a1SDavid Howells 
608bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
609bbb68dfaSTejun Heo {
610bbb68dfaSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
611bbb68dfaSTejun Heo 	unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
612bbb68dfaSTejun Heo 
613bbb68dfaSTejun Heo 	set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
614bbb68dfaSTejun Heo 		      WORK_STRUCT_PENDING);
615bbb68dfaSTejun Heo }
616bbb68dfaSTejun Heo 
617bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
618bbb68dfaSTejun Heo {
619bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
620bbb68dfaSTejun Heo 
621bbb68dfaSTejun Heo 	return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
622bbb68dfaSTejun Heo }
623bbb68dfaSTejun Heo 
624e22bee78STejun Heo /*
6253270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
6263270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
6273270476aSTejun Heo  * they're being called with gcwq->lock held.
628e22bee78STejun Heo  */
629e22bee78STejun Heo 
63063d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
631649027d7STejun Heo {
6323270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
633649027d7STejun Heo }
634649027d7STejun Heo 
635e22bee78STejun Heo /*
636e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
637e22bee78STejun Heo  * running workers.
638974271c4STejun Heo  *
639974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
640974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
641974271c4STejun Heo  * worklist isn't empty.
642e22bee78STejun Heo  */
64363d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
644e22bee78STejun Heo {
64563d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
646e22bee78STejun Heo }
647e22bee78STejun Heo 
648e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
64963d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
650e22bee78STejun Heo {
65163d95a91STejun Heo 	return pool->nr_idle;
652e22bee78STejun Heo }
653e22bee78STejun Heo 
654e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
65563d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
656e22bee78STejun Heo {
65763d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
658e22bee78STejun Heo 
6593270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
660e22bee78STejun Heo }
661e22bee78STejun Heo 
662e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
66363d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
664e22bee78STejun Heo {
66563d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
666e22bee78STejun Heo }
667e22bee78STejun Heo 
668e22bee78STejun Heo /* Do I need to be the manager? */
66963d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
670e22bee78STejun Heo {
67163d95a91STejun Heo 	return need_to_create_worker(pool) ||
67211ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
673e22bee78STejun Heo }
674e22bee78STejun Heo 
675e22bee78STejun Heo /* Do we have too many workers and should some go away? */
67663d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
677e22bee78STejun Heo {
67860373152STejun Heo 	bool managing = mutex_is_locked(&pool->manager_mutex);
67963d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
68063d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
681e22bee78STejun Heo 
682e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
683e22bee78STejun Heo }
684e22bee78STejun Heo 
685e22bee78STejun Heo /*
686e22bee78STejun Heo  * Wake up functions.
687e22bee78STejun Heo  */
688e22bee78STejun Heo 
6897e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
69063d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
6917e11629dSTejun Heo {
69263d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
6937e11629dSTejun Heo 		return NULL;
6947e11629dSTejun Heo 
69563d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
6967e11629dSTejun Heo }
6977e11629dSTejun Heo 
6987e11629dSTejun Heo /**
6997e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
70063d95a91STejun Heo  * @pool: worker pool to wake worker from
7017e11629dSTejun Heo  *
70263d95a91STejun Heo  * Wake up the first idle worker of @pool.
7037e11629dSTejun Heo  *
7047e11629dSTejun Heo  * CONTEXT:
7057e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
7067e11629dSTejun Heo  */
70763d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
7087e11629dSTejun Heo {
70963d95a91STejun Heo 	struct worker *worker = first_worker(pool);
7107e11629dSTejun Heo 
7117e11629dSTejun Heo 	if (likely(worker))
7127e11629dSTejun Heo 		wake_up_process(worker->task);
7137e11629dSTejun Heo }
7147e11629dSTejun Heo 
7154690c4abSTejun Heo /**
716e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
717e22bee78STejun Heo  * @task: task waking up
718e22bee78STejun Heo  * @cpu: CPU @task is waking up to
719e22bee78STejun Heo  *
720e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
721e22bee78STejun Heo  * being awoken.
722e22bee78STejun Heo  *
723e22bee78STejun Heo  * CONTEXT:
724e22bee78STejun Heo  * spin_lock_irq(rq->lock)
725e22bee78STejun Heo  */
726e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
727e22bee78STejun Heo {
728e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
729e22bee78STejun Heo 
7302d64672eSSteven Rostedt 	if (!(worker->flags & WORKER_NOT_RUNNING))
73163d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
732e22bee78STejun Heo }
733e22bee78STejun Heo 
734e22bee78STejun Heo /**
735e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
736e22bee78STejun Heo  * @task: task going to sleep
737e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
738e22bee78STejun Heo  *
739e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
740e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
741e22bee78STejun Heo  * returning pointer to its task.
742e22bee78STejun Heo  *
743e22bee78STejun Heo  * CONTEXT:
744e22bee78STejun Heo  * spin_lock_irq(rq->lock)
745e22bee78STejun Heo  *
746e22bee78STejun Heo  * RETURNS:
747e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
748e22bee78STejun Heo  */
749e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
750e22bee78STejun Heo 				       unsigned int cpu)
751e22bee78STejun Heo {
752e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
753bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
75463d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
755e22bee78STejun Heo 
7562d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
757e22bee78STejun Heo 		return NULL;
758e22bee78STejun Heo 
759e22bee78STejun Heo 	/* this can only happen on the local cpu */
760e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
761e22bee78STejun Heo 
762e22bee78STejun Heo 	/*
763e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
764e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
765e22bee78STejun Heo 	 * Please read comment there.
766e22bee78STejun Heo 	 *
767628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
768628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
769628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
770628c78e7STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without gcwq
771628c78e7STejun Heo 	 * lock is safe.
772e22bee78STejun Heo 	 */
773bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
77463d95a91STejun Heo 		to_wakeup = first_worker(pool);
775e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
776e22bee78STejun Heo }
777e22bee78STejun Heo 
778e22bee78STejun Heo /**
779e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
780cb444766STejun Heo  * @worker: self
781d302f017STejun Heo  * @flags: flags to set
782d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
783d302f017STejun Heo  *
784e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
785e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
786e22bee78STejun Heo  * woken up.
787d302f017STejun Heo  *
788cb444766STejun Heo  * CONTEXT:
789cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
790d302f017STejun Heo  */
791d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
792d302f017STejun Heo 				    bool wakeup)
793d302f017STejun Heo {
794bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
795e22bee78STejun Heo 
796cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
797cb444766STejun Heo 
798e22bee78STejun Heo 	/*
799e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
800e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
801e22bee78STejun Heo 	 * @wakeup.
802e22bee78STejun Heo 	 */
803e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
804e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
80563d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
806e22bee78STejun Heo 
807e22bee78STejun Heo 		if (wakeup) {
808e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
809bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
81063d95a91STejun Heo 				wake_up_worker(pool);
811e22bee78STejun Heo 		} else
812e22bee78STejun Heo 			atomic_dec(nr_running);
813e22bee78STejun Heo 	}
814e22bee78STejun Heo 
815d302f017STejun Heo 	worker->flags |= flags;
816d302f017STejun Heo }
817d302f017STejun Heo 
818d302f017STejun Heo /**
819e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
820cb444766STejun Heo  * @worker: self
821d302f017STejun Heo  * @flags: flags to clear
822d302f017STejun Heo  *
823e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
824d302f017STejun Heo  *
825cb444766STejun Heo  * CONTEXT:
826cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
827d302f017STejun Heo  */
828d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
829d302f017STejun Heo {
83063d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
831e22bee78STejun Heo 	unsigned int oflags = worker->flags;
832e22bee78STejun Heo 
833cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
834cb444766STejun Heo 
835d302f017STejun Heo 	worker->flags &= ~flags;
836e22bee78STejun Heo 
83742c025f3STejun Heo 	/*
83842c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
83942c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
84042c025f3STejun Heo 	 * of multiple flags, not a single flag.
84142c025f3STejun Heo 	 */
842e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
843e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
84463d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
845d302f017STejun Heo }
846d302f017STejun Heo 
847d302f017STejun Heo /**
848c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
849c8e55f36STejun Heo  * @gcwq: gcwq of interest
850c8e55f36STejun Heo  * @work: work to be hashed
851c8e55f36STejun Heo  *
852c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
853c8e55f36STejun Heo  *
854c8e55f36STejun Heo  * CONTEXT:
855c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
856c8e55f36STejun Heo  *
857c8e55f36STejun Heo  * RETURNS:
858c8e55f36STejun Heo  * Pointer to the hash head.
859c8e55f36STejun Heo  */
860c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
861c8e55f36STejun Heo 					   struct work_struct *work)
862c8e55f36STejun Heo {
863c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
864c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
865c8e55f36STejun Heo 
866c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
867c8e55f36STejun Heo 	v >>= base_shift;
868c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
869c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
870c8e55f36STejun Heo 
871c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
872c8e55f36STejun Heo }
873c8e55f36STejun Heo 
874c8e55f36STejun Heo /**
8758cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
8768cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8778cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
8788cca0eeaSTejun Heo  * @work: work to find worker for
8798cca0eeaSTejun Heo  *
8808cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
8818cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
8828cca0eeaSTejun Heo  * work.
8838cca0eeaSTejun Heo  *
8848cca0eeaSTejun Heo  * CONTEXT:
8858cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8868cca0eeaSTejun Heo  *
8878cca0eeaSTejun Heo  * RETURNS:
8888cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8898cca0eeaSTejun Heo  * otherwise.
8908cca0eeaSTejun Heo  */
8918cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
8928cca0eeaSTejun Heo 						   struct hlist_head *bwh,
8938cca0eeaSTejun Heo 						   struct work_struct *work)
8948cca0eeaSTejun Heo {
8958cca0eeaSTejun Heo 	struct worker *worker;
8968cca0eeaSTejun Heo 	struct hlist_node *tmp;
8978cca0eeaSTejun Heo 
8988cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
8998cca0eeaSTejun Heo 		if (worker->current_work == work)
9008cca0eeaSTejun Heo 			return worker;
9018cca0eeaSTejun Heo 	return NULL;
9028cca0eeaSTejun Heo }
9038cca0eeaSTejun Heo 
9048cca0eeaSTejun Heo /**
9058cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
9068cca0eeaSTejun Heo  * @gcwq: gcwq of interest
9078cca0eeaSTejun Heo  * @work: work to find worker for
9088cca0eeaSTejun Heo  *
9098cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
9108cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
9118cca0eeaSTejun Heo  * function calculates @bwh itself.
9128cca0eeaSTejun Heo  *
9138cca0eeaSTejun Heo  * CONTEXT:
9148cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
9158cca0eeaSTejun Heo  *
9168cca0eeaSTejun Heo  * RETURNS:
9178cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
9188cca0eeaSTejun Heo  * otherwise.
9198cca0eeaSTejun Heo  */
9208cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
9218cca0eeaSTejun Heo 						 struct work_struct *work)
9228cca0eeaSTejun Heo {
9238cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
9248cca0eeaSTejun Heo 					    work);
9258cca0eeaSTejun Heo }
9268cca0eeaSTejun Heo 
9278cca0eeaSTejun Heo /**
928bf4ede01STejun Heo  * move_linked_works - move linked works to a list
929bf4ede01STejun Heo  * @work: start of series of works to be scheduled
930bf4ede01STejun Heo  * @head: target list to append @work to
931bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
932bf4ede01STejun Heo  *
933bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
934bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
935bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
936bf4ede01STejun Heo  *
937bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
938bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
939bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
940bf4ede01STejun Heo  *
941bf4ede01STejun Heo  * CONTEXT:
942bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
943bf4ede01STejun Heo  */
944bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
945bf4ede01STejun Heo 			      struct work_struct **nextp)
946bf4ede01STejun Heo {
947bf4ede01STejun Heo 	struct work_struct *n;
948bf4ede01STejun Heo 
949bf4ede01STejun Heo 	/*
950bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
951bf4ede01STejun Heo 	 * use NULL for list head.
952bf4ede01STejun Heo 	 */
953bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
954bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
955bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
956bf4ede01STejun Heo 			break;
957bf4ede01STejun Heo 	}
958bf4ede01STejun Heo 
959bf4ede01STejun Heo 	/*
960bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
961bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
962bf4ede01STejun Heo 	 * needs to be updated.
963bf4ede01STejun Heo 	 */
964bf4ede01STejun Heo 	if (nextp)
965bf4ede01STejun Heo 		*nextp = n;
966bf4ede01STejun Heo }
967bf4ede01STejun Heo 
968bf4ede01STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
969bf4ede01STejun Heo {
970bf4ede01STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
971bf4ede01STejun Heo 						    struct work_struct, entry);
972bf4ede01STejun Heo 
973bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
974bf4ede01STejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
975bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
976bf4ede01STejun Heo 	cwq->nr_active++;
977bf4ede01STejun Heo }
978bf4ede01STejun Heo 
979bf4ede01STejun Heo /**
980bf4ede01STejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
981bf4ede01STejun Heo  * @cwq: cwq of interest
982bf4ede01STejun Heo  * @color: color of work which left the queue
983bf4ede01STejun Heo  * @delayed: for a delayed work
984bf4ede01STejun Heo  *
985bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
986bf4ede01STejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
987bf4ede01STejun Heo  *
988bf4ede01STejun Heo  * CONTEXT:
989bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
990bf4ede01STejun Heo  */
991bf4ede01STejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
992bf4ede01STejun Heo 				 bool delayed)
993bf4ede01STejun Heo {
994bf4ede01STejun Heo 	/* ignore uncolored works */
995bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
996bf4ede01STejun Heo 		return;
997bf4ede01STejun Heo 
998bf4ede01STejun Heo 	cwq->nr_in_flight[color]--;
999bf4ede01STejun Heo 
1000bf4ede01STejun Heo 	if (!delayed) {
1001bf4ede01STejun Heo 		cwq->nr_active--;
1002bf4ede01STejun Heo 		if (!list_empty(&cwq->delayed_works)) {
1003bf4ede01STejun Heo 			/* one down, submit a delayed one */
1004bf4ede01STejun Heo 			if (cwq->nr_active < cwq->max_active)
1005bf4ede01STejun Heo 				cwq_activate_first_delayed(cwq);
1006bf4ede01STejun Heo 		}
1007bf4ede01STejun Heo 	}
1008bf4ede01STejun Heo 
1009bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1010bf4ede01STejun Heo 	if (likely(cwq->flush_color != color))
1011bf4ede01STejun Heo 		return;
1012bf4ede01STejun Heo 
1013bf4ede01STejun Heo 	/* are there still in-flight works? */
1014bf4ede01STejun Heo 	if (cwq->nr_in_flight[color])
1015bf4ede01STejun Heo 		return;
1016bf4ede01STejun Heo 
1017bf4ede01STejun Heo 	/* this cwq is done, clear flush_color */
1018bf4ede01STejun Heo 	cwq->flush_color = -1;
1019bf4ede01STejun Heo 
1020bf4ede01STejun Heo 	/*
1021bf4ede01STejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
1022bf4ede01STejun Heo 	 * will handle the rest.
1023bf4ede01STejun Heo 	 */
1024bf4ede01STejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1025bf4ede01STejun Heo 		complete(&cwq->wq->first_flusher->done);
1026bf4ede01STejun Heo }
1027bf4ede01STejun Heo 
102836e227d2STejun Heo /**
1029bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
103036e227d2STejun Heo  * @work: work item to steal
103136e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1032bbb68dfaSTejun Heo  * @flags: place to store irq state
103336e227d2STejun Heo  *
103436e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
103536e227d2STejun Heo  * stable state - idle, on timer or on worklist.  Return values are
103636e227d2STejun Heo  *
103736e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
103836e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
103936e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1040bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1041bbb68dfaSTejun Heo  *		for arbitrarily long
104236e227d2STejun Heo  *
1043bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1044bbb68dfaSTejun Heo  * preempted while holding PENDING and @work off queue, preemption must be
1045bbb68dfaSTejun Heo  * disabled on entry.  This ensures that we don't return -EAGAIN while
1046bbb68dfaSTejun Heo  * another task is preempted in this function.
1047bbb68dfaSTejun Heo  *
1048bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1049bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1050bbb68dfaSTejun Heo  *
1051bbb68dfaSTejun Heo  * This function is safe to call from any context other than IRQ handler.
1052bbb68dfaSTejun Heo  * An IRQ handler may run on top of delayed_work_timer_fn() which can make
1053bbb68dfaSTejun Heo  * this function return -EAGAIN perpetually.
1054bf4ede01STejun Heo  */
1055bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1056bbb68dfaSTejun Heo 			       unsigned long *flags)
1057bf4ede01STejun Heo {
1058bf4ede01STejun Heo 	struct global_cwq *gcwq;
1059bf4ede01STejun Heo 
1060bbb68dfaSTejun Heo 	WARN_ON_ONCE(in_irq());
1061bbb68dfaSTejun Heo 
1062bbb68dfaSTejun Heo 	local_irq_save(*flags);
1063bbb68dfaSTejun Heo 
106436e227d2STejun Heo 	/* try to steal the timer if it exists */
106536e227d2STejun Heo 	if (is_dwork) {
106636e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
106736e227d2STejun Heo 
106836e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
106936e227d2STejun Heo 			return 1;
107036e227d2STejun Heo 	}
107136e227d2STejun Heo 
107236e227d2STejun Heo 	/* try to claim PENDING the normal way */
1073bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1074bf4ede01STejun Heo 		return 0;
1075bf4ede01STejun Heo 
1076bf4ede01STejun Heo 	/*
1077bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1078bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1079bf4ede01STejun Heo 	 */
1080bf4ede01STejun Heo 	gcwq = get_work_gcwq(work);
1081bf4ede01STejun Heo 	if (!gcwq)
1082bbb68dfaSTejun Heo 		goto fail;
1083bf4ede01STejun Heo 
1084bbb68dfaSTejun Heo 	spin_lock(&gcwq->lock);
1085bf4ede01STejun Heo 	if (!list_empty(&work->entry)) {
1086bf4ede01STejun Heo 		/*
1087bf4ede01STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
1088bf4ede01STejun Heo 		 * In that case we must see the new value after rmb(), see
1089bf4ede01STejun Heo 		 * insert_work()->wmb().
1090bf4ede01STejun Heo 		 */
1091bf4ede01STejun Heo 		smp_rmb();
1092bf4ede01STejun Heo 		if (gcwq == get_work_gcwq(work)) {
1093bf4ede01STejun Heo 			debug_work_deactivate(work);
1094bf4ede01STejun Heo 			list_del_init(&work->entry);
1095bf4ede01STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
1096bf4ede01STejun Heo 				get_work_color(work),
1097bf4ede01STejun Heo 				*work_data_bits(work) & WORK_STRUCT_DELAYED);
109836e227d2STejun Heo 
1099bbb68dfaSTejun Heo 			spin_unlock(&gcwq->lock);
110036e227d2STejun Heo 			return 1;
1101bf4ede01STejun Heo 		}
1102bf4ede01STejun Heo 	}
1103bbb68dfaSTejun Heo 	spin_unlock(&gcwq->lock);
1104bbb68dfaSTejun Heo fail:
1105bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1106bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1107bbb68dfaSTejun Heo 		return -ENOENT;
1108bbb68dfaSTejun Heo 	cpu_relax();
110936e227d2STejun Heo 	return -EAGAIN;
1110bf4ede01STejun Heo }
1111bf4ede01STejun Heo 
1112bf4ede01STejun Heo /**
11137e11629dSTejun Heo  * insert_work - insert a work into gcwq
11144690c4abSTejun Heo  * @cwq: cwq @work belongs to
11154690c4abSTejun Heo  * @work: work to insert
11164690c4abSTejun Heo  * @head: insertion point
11174690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
11184690c4abSTejun Heo  *
11197e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
11207e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
11214690c4abSTejun Heo  *
11224690c4abSTejun Heo  * CONTEXT:
11238b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
11241da177e4SLinus Torvalds  */
1125b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
11264690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
11274690c4abSTejun Heo 			unsigned int extra_flags)
1128b89deed3SOleg Nesterov {
112963d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
1130e1d8aa9fSFrederic Weisbecker 
11314690c4abSTejun Heo 	/* we own @work, set data and link */
11327a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
11334690c4abSTejun Heo 
11346e84d644SOleg Nesterov 	/*
11356e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
11366e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
11376e84d644SOleg Nesterov 	 */
11386e84d644SOleg Nesterov 	smp_wmb();
11394690c4abSTejun Heo 
11401a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
1141e22bee78STejun Heo 
1142e22bee78STejun Heo 	/*
1143e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
1144e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
1145e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
1146e22bee78STejun Heo 	 */
1147e22bee78STejun Heo 	smp_mb();
1148e22bee78STejun Heo 
114963d95a91STejun Heo 	if (__need_more_worker(pool))
115063d95a91STejun Heo 		wake_up_worker(pool);
1151b89deed3SOleg Nesterov }
1152b89deed3SOleg Nesterov 
1153c8efcc25STejun Heo /*
1154c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
1155c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
1156c8efcc25STejun Heo  * cold paths.
1157c8efcc25STejun Heo  */
1158c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1159c8efcc25STejun Heo {
1160c8efcc25STejun Heo 	unsigned long flags;
1161c8efcc25STejun Heo 	unsigned int cpu;
1162c8efcc25STejun Heo 
1163c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
1164c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
1165c8efcc25STejun Heo 		struct worker *worker;
1166c8efcc25STejun Heo 		struct hlist_node *pos;
1167c8efcc25STejun Heo 		int i;
1168c8efcc25STejun Heo 
1169c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1170c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
1171c8efcc25STejun Heo 			if (worker->task != current)
1172c8efcc25STejun Heo 				continue;
1173c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
1174c8efcc25STejun Heo 			/*
1175c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
1176c8efcc25STejun Heo 			 * is headed to the same workqueue.
1177c8efcc25STejun Heo 			 */
1178c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
1179c8efcc25STejun Heo 		}
1180c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
1181c8efcc25STejun Heo 	}
1182c8efcc25STejun Heo 	return false;
1183c8efcc25STejun Heo }
1184c8efcc25STejun Heo 
11854690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
11861da177e4SLinus Torvalds 			 struct work_struct *work)
11871da177e4SLinus Torvalds {
1188502ca9d8STejun Heo 	struct global_cwq *gcwq;
1189502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
11901e19ffc6STejun Heo 	struct list_head *worklist;
11918a2e8e5dSTejun Heo 	unsigned int work_flags;
11928930cabaSTejun Heo 
11938930cabaSTejun Heo 	/*
11948930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
11958930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
11968930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
11978930cabaSTejun Heo 	 * happen with IRQ disabled.
11988930cabaSTejun Heo 	 */
11998930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
12001da177e4SLinus Torvalds 
1201dc186ad7SThomas Gleixner 	debug_work_activate(work);
12021e19ffc6STejun Heo 
1203c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
12049c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1205c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1206e41e704bSTejun Heo 		return;
1207e41e704bSTejun Heo 
1208c7fc77f7STejun Heo 	/* determine gcwq to use */
1209c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1210c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1211c7fc77f7STejun Heo 
121257469821STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
1213f3421797STejun Heo 			cpu = raw_smp_processor_id();
1214f3421797STejun Heo 
121518aa9effSTejun Heo 		/*
121618aa9effSTejun Heo 		 * It's multi cpu.  If @wq is non-reentrant and @work
121718aa9effSTejun Heo 		 * was previously on a different cpu, it might still
121818aa9effSTejun Heo 		 * be running there, in which case the work needs to
121918aa9effSTejun Heo 		 * be queued on that cpu to guarantee non-reentrance.
122018aa9effSTejun Heo 		 */
1221502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
122218aa9effSTejun Heo 		if (wq->flags & WQ_NON_REENTRANT &&
122318aa9effSTejun Heo 		    (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
122418aa9effSTejun Heo 			struct worker *worker;
122518aa9effSTejun Heo 
12268930cabaSTejun Heo 			spin_lock(&last_gcwq->lock);
122718aa9effSTejun Heo 
122818aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
122918aa9effSTejun Heo 
123018aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
123118aa9effSTejun Heo 				gcwq = last_gcwq;
123218aa9effSTejun Heo 			else {
123318aa9effSTejun Heo 				/* meh... not running there, queue here */
12348930cabaSTejun Heo 				spin_unlock(&last_gcwq->lock);
12358930cabaSTejun Heo 				spin_lock(&gcwq->lock);
123618aa9effSTejun Heo 			}
12378930cabaSTejun Heo 		} else {
12388930cabaSTejun Heo 			spin_lock(&gcwq->lock);
12398930cabaSTejun Heo 		}
1240f3421797STejun Heo 	} else {
1241f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
12428930cabaSTejun Heo 		spin_lock(&gcwq->lock);
1243502ca9d8STejun Heo 	}
1244502ca9d8STejun Heo 
1245502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1246502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1247cdadf009STejun Heo 	trace_workqueue_queue_work(cpu, cwq, work);
1248502ca9d8STejun Heo 
1249f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
12508930cabaSTejun Heo 		spin_unlock(&gcwq->lock);
1251f5b2552bSDan Carpenter 		return;
1252f5b2552bSDan Carpenter 	}
12531e19ffc6STejun Heo 
125473f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
12558a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
12561e19ffc6STejun Heo 
12571e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1258cdadf009STejun Heo 		trace_workqueue_activate_work(work);
12591e19ffc6STejun Heo 		cwq->nr_active++;
12603270476aSTejun Heo 		worklist = &cwq->pool->worklist;
12618a2e8e5dSTejun Heo 	} else {
12628a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
12631e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
12648a2e8e5dSTejun Heo 	}
12651e19ffc6STejun Heo 
12668a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
12671e19ffc6STejun Heo 
12688930cabaSTejun Heo 	spin_unlock(&gcwq->lock);
12691da177e4SLinus Torvalds }
12701da177e4SLinus Torvalds 
12710fcb78c2SRolf Eike Beer /**
1272c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1273c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1274c1a220e7SZhang Rui  * @wq: workqueue to use
1275c1a220e7SZhang Rui  * @work: work to queue
1276c1a220e7SZhang Rui  *
1277d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
1278c1a220e7SZhang Rui  *
1279c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1280c1a220e7SZhang Rui  * can't go away.
1281c1a220e7SZhang Rui  */
1282d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1283d4283e93STejun Heo 		   struct work_struct *work)
1284c1a220e7SZhang Rui {
1285d4283e93STejun Heo 	bool ret = false;
12868930cabaSTejun Heo 	unsigned long flags;
12878930cabaSTejun Heo 
12888930cabaSTejun Heo 	local_irq_save(flags);
1289c1a220e7SZhang Rui 
129022df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
12914690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1292d4283e93STejun Heo 		ret = true;
1293c1a220e7SZhang Rui 	}
12948930cabaSTejun Heo 
12958930cabaSTejun Heo 	local_irq_restore(flags);
1296c1a220e7SZhang Rui 	return ret;
1297c1a220e7SZhang Rui }
1298c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1299c1a220e7SZhang Rui 
13000a13c00eSTejun Heo /**
13010a13c00eSTejun Heo  * queue_work - queue work on a workqueue
13020a13c00eSTejun Heo  * @wq: workqueue to use
13030a13c00eSTejun Heo  * @work: work to queue
13040a13c00eSTejun Heo  *
1305d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
13060a13c00eSTejun Heo  *
13070a13c00eSTejun Heo  * We queue the work to the CPU on which it was submitted, but if the CPU dies
13080a13c00eSTejun Heo  * it can be processed by another CPU.
13090a13c00eSTejun Heo  */
1310d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
13110a13c00eSTejun Heo {
131257469821STejun Heo 	return queue_work_on(WORK_CPU_UNBOUND, wq, work);
13130a13c00eSTejun Heo }
13140a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work);
13150a13c00eSTejun Heo 
1316d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
13171da177e4SLinus Torvalds {
131852bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
13197a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
13201da177e4SLinus Torvalds 
13218930cabaSTejun Heo 	local_irq_disable();
132257469821STejun Heo 	__queue_work(WORK_CPU_UNBOUND, cwq->wq, &dwork->work);
13238930cabaSTejun Heo 	local_irq_enable();
13241da177e4SLinus Torvalds }
1325d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
13261da177e4SLinus Torvalds 
13277beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
13287beb2edfSTejun Heo 				struct delayed_work *dwork, unsigned long delay)
13297beb2edfSTejun Heo {
13307beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
13317beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
13327beb2edfSTejun Heo 	unsigned int lcpu;
13337beb2edfSTejun Heo 
13347beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
13357beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
13367beb2edfSTejun Heo 	BUG_ON(timer_pending(timer));
13377beb2edfSTejun Heo 	BUG_ON(!list_empty(&work->entry));
13387beb2edfSTejun Heo 
13397beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
13407beb2edfSTejun Heo 
13417beb2edfSTejun Heo 	/*
13427beb2edfSTejun Heo 	 * This stores cwq for the moment, for the timer_fn.  Note that the
13437beb2edfSTejun Heo 	 * work's gcwq is preserved to allow reentrance detection for
13447beb2edfSTejun Heo 	 * delayed works.
13457beb2edfSTejun Heo 	 */
13467beb2edfSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
13477beb2edfSTejun Heo 		struct global_cwq *gcwq = get_work_gcwq(work);
13487beb2edfSTejun Heo 
13497beb2edfSTejun Heo 		if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
13507beb2edfSTejun Heo 			lcpu = gcwq->cpu;
13517beb2edfSTejun Heo 		else
13527beb2edfSTejun Heo 			lcpu = raw_smp_processor_id();
13537beb2edfSTejun Heo 	} else {
13547beb2edfSTejun Heo 		lcpu = WORK_CPU_UNBOUND;
13557beb2edfSTejun Heo 	}
13567beb2edfSTejun Heo 
13577beb2edfSTejun Heo 	set_work_cwq(work, get_cwq(lcpu, wq), 0);
13587beb2edfSTejun Heo 
13597beb2edfSTejun Heo 	timer->expires = jiffies + delay;
13607beb2edfSTejun Heo 
13617beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
13627beb2edfSTejun Heo 		add_timer_on(timer, cpu);
13637beb2edfSTejun Heo 	else
13647beb2edfSTejun Heo 		add_timer(timer);
13657beb2edfSTejun Heo }
13667beb2edfSTejun Heo 
13670fcb78c2SRolf Eike Beer /**
13680fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
13690fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
13700fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1371af9997e4SRandy Dunlap  * @dwork: work to queue
13720fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
13730fcb78c2SRolf Eike Beer  *
1374715f1300STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.  If
1375715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1376715f1300STejun Heo  * execution.
13770fcb78c2SRolf Eike Beer  */
1378d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
137952bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
13807a6bc1cdSVenkatesh Pallipadi {
138152bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1382d4283e93STejun Heo 	bool ret = false;
13838930cabaSTejun Heo 	unsigned long flags;
13848930cabaSTejun Heo 
1385715f1300STejun Heo 	if (!delay)
1386715f1300STejun Heo 		return queue_work_on(cpu, wq, &dwork->work);
1387715f1300STejun Heo 
13888930cabaSTejun Heo 	/* read the comment in __queue_work() */
13898930cabaSTejun Heo 	local_irq_save(flags);
13907a6bc1cdSVenkatesh Pallipadi 
139122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
13927beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1393d4283e93STejun Heo 		ret = true;
13947a6bc1cdSVenkatesh Pallipadi 	}
13958930cabaSTejun Heo 
13968930cabaSTejun Heo 	local_irq_restore(flags);
13977a6bc1cdSVenkatesh Pallipadi 	return ret;
13987a6bc1cdSVenkatesh Pallipadi }
1399ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
14001da177e4SLinus Torvalds 
1401c8e55f36STejun Heo /**
14020a13c00eSTejun Heo  * queue_delayed_work - queue work on a workqueue after delay
14030a13c00eSTejun Heo  * @wq: workqueue to use
14040a13c00eSTejun Heo  * @dwork: delayable work to queue
14050a13c00eSTejun Heo  * @delay: number of jiffies to wait before queueing
14060a13c00eSTejun Heo  *
1407715f1300STejun Heo  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
14080a13c00eSTejun Heo  */
1409d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq,
14100a13c00eSTejun Heo 			struct delayed_work *dwork, unsigned long delay)
14110a13c00eSTejun Heo {
141257469821STejun Heo 	return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14130a13c00eSTejun Heo }
14140a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work);
14150a13c00eSTejun Heo 
14160a13c00eSTejun Heo /**
1417*8376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1418*8376fe22STejun Heo  * @cpu: CPU number to execute work on
1419*8376fe22STejun Heo  * @wq: workqueue to use
1420*8376fe22STejun Heo  * @dwork: work to queue
1421*8376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
1422*8376fe22STejun Heo  *
1423*8376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1424*8376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
1425*8376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
1426*8376fe22STejun Heo  * current state.
1427*8376fe22STejun Heo  *
1428*8376fe22STejun Heo  * Returns %false if @dwork was idle and queued, %true if @dwork was
1429*8376fe22STejun Heo  * pending and its timer was modified.
1430*8376fe22STejun Heo  *
1431*8376fe22STejun Heo  * This function is safe to call from any context other than IRQ handler.
1432*8376fe22STejun Heo  * See try_to_grab_pending() for details.
1433*8376fe22STejun Heo  */
1434*8376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1435*8376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
1436*8376fe22STejun Heo {
1437*8376fe22STejun Heo 	unsigned long flags;
1438*8376fe22STejun Heo 	int ret;
1439*8376fe22STejun Heo 
1440*8376fe22STejun Heo 	do {
1441*8376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
1442*8376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
1443*8376fe22STejun Heo 
1444*8376fe22STejun Heo 	if (likely(ret >= 0)) {
1445*8376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1446*8376fe22STejun Heo 		local_irq_restore(flags);
1447*8376fe22STejun Heo 	}
1448*8376fe22STejun Heo 
1449*8376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
1450*8376fe22STejun Heo 	return ret;
1451*8376fe22STejun Heo }
1452*8376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1453*8376fe22STejun Heo 
1454*8376fe22STejun Heo /**
1455*8376fe22STejun Heo  * mod_delayed_work - modify delay of or queue a delayed work
1456*8376fe22STejun Heo  * @wq: workqueue to use
1457*8376fe22STejun Heo  * @dwork: work to queue
1458*8376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
1459*8376fe22STejun Heo  *
1460*8376fe22STejun Heo  * mod_delayed_work_on() on local CPU.
1461*8376fe22STejun Heo  */
1462*8376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1463*8376fe22STejun Heo 		      unsigned long delay)
1464*8376fe22STejun Heo {
1465*8376fe22STejun Heo 	return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1466*8376fe22STejun Heo }
1467*8376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work);
1468*8376fe22STejun Heo 
1469*8376fe22STejun Heo /**
1470c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1471c8e55f36STejun Heo  * @worker: worker which is entering idle state
1472c8e55f36STejun Heo  *
1473c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1474c8e55f36STejun Heo  * necessary.
1475c8e55f36STejun Heo  *
1476c8e55f36STejun Heo  * LOCKING:
1477c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1478c8e55f36STejun Heo  */
1479c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
14801da177e4SLinus Torvalds {
1481bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1482bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1483c8e55f36STejun Heo 
1484c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1485c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1486c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1487c8e55f36STejun Heo 
1488cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1489cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1490bd7bdd43STejun Heo 	pool->nr_idle++;
1491e22bee78STejun Heo 	worker->last_active = jiffies;
1492c8e55f36STejun Heo 
1493c8e55f36STejun Heo 	/* idle_list is LIFO */
1494bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1495db7bccf4STejun Heo 
149663d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1497628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1498cb444766STejun Heo 
1499544ecf31STejun Heo 	/*
1500628c78e7STejun Heo 	 * Sanity check nr_running.  Because gcwq_unbind_fn() releases
1501628c78e7STejun Heo 	 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1502628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1503628c78e7STejun Heo 	 * unbind is not in progress.
1504544ecf31STejun Heo 	 */
1505628c78e7STejun Heo 	WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
1506bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
150763d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1508c8e55f36STejun Heo }
1509c8e55f36STejun Heo 
1510c8e55f36STejun Heo /**
1511c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1512c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1513c8e55f36STejun Heo  *
1514c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1515c8e55f36STejun Heo  *
1516c8e55f36STejun Heo  * LOCKING:
1517c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1518c8e55f36STejun Heo  */
1519c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1520c8e55f36STejun Heo {
1521bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1522c8e55f36STejun Heo 
1523c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1524d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1525bd7bdd43STejun Heo 	pool->nr_idle--;
1526c8e55f36STejun Heo 	list_del_init(&worker->entry);
1527c8e55f36STejun Heo }
1528c8e55f36STejun Heo 
1529e22bee78STejun Heo /**
1530e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1531e22bee78STejun Heo  * @worker: self
1532e22bee78STejun Heo  *
1533e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1534e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1535e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1536e22bee78STejun Heo  * guaranteed to execute on the cpu.
1537e22bee78STejun Heo  *
1538e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1539e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1540e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1541e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1542e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1543e22bee78STejun Heo  * [dis]associated in the meantime.
1544e22bee78STejun Heo  *
1545f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1546f2d5a0eeSTejun Heo  * binding against %GCWQ_DISASSOCIATED which is set during
1547f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1548f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1549f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1550e22bee78STejun Heo  *
1551e22bee78STejun Heo  * CONTEXT:
1552e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1553e22bee78STejun Heo  * held.
1554e22bee78STejun Heo  *
1555e22bee78STejun Heo  * RETURNS:
1556e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1557e22bee78STejun Heo  * bound), %false if offline.
1558e22bee78STejun Heo  */
1559e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1560972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1561e22bee78STejun Heo {
1562bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1563e22bee78STejun Heo 	struct task_struct *task = worker->task;
1564e22bee78STejun Heo 
1565e22bee78STejun Heo 	while (true) {
1566e22bee78STejun Heo 		/*
1567e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1568e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1569e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1570e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1571e22bee78STejun Heo 		 */
1572f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1573e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1574e22bee78STejun Heo 
1575e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1576e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1577e22bee78STejun Heo 			return false;
1578e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1579e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1580e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1581e22bee78STejun Heo 			return true;
1582e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1583e22bee78STejun Heo 
15845035b20fSTejun Heo 		/*
15855035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
15865035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
15875035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
15885035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
15895035b20fSTejun Heo 		 */
1590e22bee78STejun Heo 		cpu_relax();
15915035b20fSTejun Heo 		cond_resched();
1592e22bee78STejun Heo 	}
1593e22bee78STejun Heo }
1594e22bee78STejun Heo 
159525511a47STejun Heo struct idle_rebind {
159625511a47STejun Heo 	int			cnt;		/* # workers to be rebound */
159725511a47STejun Heo 	struct completion	done;		/* all workers rebound */
159825511a47STejun Heo };
159925511a47STejun Heo 
1600e22bee78STejun Heo /*
160125511a47STejun Heo  * Rebind an idle @worker to its CPU.  During CPU onlining, this has to
160225511a47STejun Heo  * happen synchronously for idle workers.  worker_thread() will test
160325511a47STejun Heo  * %WORKER_REBIND before leaving idle and call this function.
160425511a47STejun Heo  */
160525511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
160625511a47STejun Heo {
160725511a47STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
160825511a47STejun Heo 
160925511a47STejun Heo 	/* CPU must be online at this point */
161025511a47STejun Heo 	WARN_ON(!worker_maybe_bind_and_lock(worker));
161125511a47STejun Heo 	if (!--worker->idle_rebind->cnt)
161225511a47STejun Heo 		complete(&worker->idle_rebind->done);
161325511a47STejun Heo 	spin_unlock_irq(&worker->pool->gcwq->lock);
161425511a47STejun Heo 
161525511a47STejun Heo 	/* we did our part, wait for rebind_workers() to finish up */
161625511a47STejun Heo 	wait_event(gcwq->rebind_hold, !(worker->flags & WORKER_REBIND));
161725511a47STejun Heo }
161825511a47STejun Heo 
161925511a47STejun Heo /*
162025511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1621403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1622403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1623403c821dSTejun Heo  * executed twice without intervening cpu down.
1624e22bee78STejun Heo  */
162525511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1626e22bee78STejun Heo {
1627e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1628bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1629e22bee78STejun Heo 
1630e22bee78STejun Heo 	if (worker_maybe_bind_and_lock(worker))
1631e22bee78STejun Heo 		worker_clr_flags(worker, WORKER_REBIND);
1632e22bee78STejun Heo 
1633e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1634e22bee78STejun Heo }
1635e22bee78STejun Heo 
163625511a47STejun Heo /**
163725511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
163825511a47STejun Heo  * @gcwq: gcwq of interest
163925511a47STejun Heo  *
164025511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
164125511a47STejun Heo  * is different for idle and busy ones.
164225511a47STejun Heo  *
164325511a47STejun Heo  * The idle ones should be rebound synchronously and idle rebinding should
164425511a47STejun Heo  * be complete before any worker starts executing work items with
164525511a47STejun Heo  * concurrency management enabled; otherwise, scheduler may oops trying to
164625511a47STejun Heo  * wake up non-local idle worker from wq_worker_sleeping().
164725511a47STejun Heo  *
164825511a47STejun Heo  * This is achieved by repeatedly requesting rebinding until all idle
164925511a47STejun Heo  * workers are known to have been rebound under @gcwq->lock and holding all
165025511a47STejun Heo  * idle workers from becoming busy until idle rebinding is complete.
165125511a47STejun Heo  *
165225511a47STejun Heo  * Once idle workers are rebound, busy workers can be rebound as they
165325511a47STejun Heo  * finish executing their current work items.  Queueing the rebind work at
165425511a47STejun Heo  * the head of their scheduled lists is enough.  Note that nr_running will
165525511a47STejun Heo  * be properbly bumped as busy workers rebind.
165625511a47STejun Heo  *
165725511a47STejun Heo  * On return, all workers are guaranteed to either be bound or have rebind
165825511a47STejun Heo  * work item scheduled.
165925511a47STejun Heo  */
166025511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
166125511a47STejun Heo 	__releases(&gcwq->lock) __acquires(&gcwq->lock)
166225511a47STejun Heo {
166325511a47STejun Heo 	struct idle_rebind idle_rebind;
166425511a47STejun Heo 	struct worker_pool *pool;
166525511a47STejun Heo 	struct worker *worker;
166625511a47STejun Heo 	struct hlist_node *pos;
166725511a47STejun Heo 	int i;
166825511a47STejun Heo 
166925511a47STejun Heo 	lockdep_assert_held(&gcwq->lock);
167025511a47STejun Heo 
167125511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
167225511a47STejun Heo 		lockdep_assert_held(&pool->manager_mutex);
167325511a47STejun Heo 
167425511a47STejun Heo 	/*
167525511a47STejun Heo 	 * Rebind idle workers.  Interlocked both ways.  We wait for
167625511a47STejun Heo 	 * workers to rebind via @idle_rebind.done.  Workers will wait for
167725511a47STejun Heo 	 * us to finish up by watching %WORKER_REBIND.
167825511a47STejun Heo 	 */
167925511a47STejun Heo 	init_completion(&idle_rebind.done);
168025511a47STejun Heo retry:
168125511a47STejun Heo 	idle_rebind.cnt = 1;
168225511a47STejun Heo 	INIT_COMPLETION(idle_rebind.done);
168325511a47STejun Heo 
168425511a47STejun Heo 	/* set REBIND and kick idle ones, we'll wait for these later */
168525511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
168625511a47STejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry) {
168725511a47STejun Heo 			if (worker->flags & WORKER_REBIND)
168825511a47STejun Heo 				continue;
168925511a47STejun Heo 
169025511a47STejun Heo 			/* morph UNBOUND to REBIND */
169125511a47STejun Heo 			worker->flags &= ~WORKER_UNBOUND;
169225511a47STejun Heo 			worker->flags |= WORKER_REBIND;
169325511a47STejun Heo 
169425511a47STejun Heo 			idle_rebind.cnt++;
169525511a47STejun Heo 			worker->idle_rebind = &idle_rebind;
169625511a47STejun Heo 
169725511a47STejun Heo 			/* worker_thread() will call idle_worker_rebind() */
169825511a47STejun Heo 			wake_up_process(worker->task);
169925511a47STejun Heo 		}
170025511a47STejun Heo 	}
170125511a47STejun Heo 
170225511a47STejun Heo 	if (--idle_rebind.cnt) {
170325511a47STejun Heo 		spin_unlock_irq(&gcwq->lock);
170425511a47STejun Heo 		wait_for_completion(&idle_rebind.done);
170525511a47STejun Heo 		spin_lock_irq(&gcwq->lock);
170625511a47STejun Heo 		/* busy ones might have become idle while waiting, retry */
170725511a47STejun Heo 		goto retry;
170825511a47STejun Heo 	}
170925511a47STejun Heo 
171025511a47STejun Heo 	/*
171125511a47STejun Heo 	 * All idle workers are rebound and waiting for %WORKER_REBIND to
171225511a47STejun Heo 	 * be cleared inside idle_worker_rebind().  Clear and release.
171325511a47STejun Heo 	 * Clearing %WORKER_REBIND from this foreign context is safe
171425511a47STejun Heo 	 * because these workers are still guaranteed to be idle.
171525511a47STejun Heo 	 */
171625511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
171725511a47STejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
171825511a47STejun Heo 			worker->flags &= ~WORKER_REBIND;
171925511a47STejun Heo 
172025511a47STejun Heo 	wake_up_all(&gcwq->rebind_hold);
172125511a47STejun Heo 
172225511a47STejun Heo 	/* rebind busy workers */
172325511a47STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
172425511a47STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
172525511a47STejun Heo 
172625511a47STejun Heo 		/* morph UNBOUND to REBIND */
172725511a47STejun Heo 		worker->flags &= ~WORKER_UNBOUND;
172825511a47STejun Heo 		worker->flags |= WORKER_REBIND;
172925511a47STejun Heo 
173025511a47STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
173125511a47STejun Heo 				     work_data_bits(rebind_work)))
173225511a47STejun Heo 			continue;
173325511a47STejun Heo 
173425511a47STejun Heo 		/* wq doesn't matter, use the default one */
173525511a47STejun Heo 		debug_work_activate(rebind_work);
173625511a47STejun Heo 		insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
173725511a47STejun Heo 			    worker->scheduled.next,
173825511a47STejun Heo 			    work_color_to_flags(WORK_NO_COLOR));
173925511a47STejun Heo 	}
174025511a47STejun Heo }
174125511a47STejun Heo 
1742c34056a3STejun Heo static struct worker *alloc_worker(void)
1743c34056a3STejun Heo {
1744c34056a3STejun Heo 	struct worker *worker;
1745c34056a3STejun Heo 
1746c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1747c8e55f36STejun Heo 	if (worker) {
1748c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1749affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
175025511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1751e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1752e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1753c8e55f36STejun Heo 	}
1754c34056a3STejun Heo 	return worker;
1755c34056a3STejun Heo }
1756c34056a3STejun Heo 
1757c34056a3STejun Heo /**
1758c34056a3STejun Heo  * create_worker - create a new workqueue worker
175963d95a91STejun Heo  * @pool: pool the new worker will belong to
1760c34056a3STejun Heo  *
176163d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1762c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1763c34056a3STejun Heo  * destroy_worker().
1764c34056a3STejun Heo  *
1765c34056a3STejun Heo  * CONTEXT:
1766c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1767c34056a3STejun Heo  *
1768c34056a3STejun Heo  * RETURNS:
1769c34056a3STejun Heo  * Pointer to the newly created worker.
1770c34056a3STejun Heo  */
1771bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1772c34056a3STejun Heo {
177363d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
17743270476aSTejun Heo 	const char *pri = worker_pool_pri(pool) ? "H" : "";
1775c34056a3STejun Heo 	struct worker *worker = NULL;
1776f3421797STejun Heo 	int id = -1;
1777c34056a3STejun Heo 
17788b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1779bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
17808b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1781bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1782c34056a3STejun Heo 			goto fail;
17838b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1784c34056a3STejun Heo 	}
17858b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1786c34056a3STejun Heo 
1787c34056a3STejun Heo 	worker = alloc_worker();
1788c34056a3STejun Heo 	if (!worker)
1789c34056a3STejun Heo 		goto fail;
1790c34056a3STejun Heo 
1791bd7bdd43STejun Heo 	worker->pool = pool;
1792c34056a3STejun Heo 	worker->id = id;
1793c34056a3STejun Heo 
1794bc2ae0f5STejun Heo 	if (gcwq->cpu != WORK_CPU_UNBOUND)
179594dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
17963270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
17973270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1798f3421797STejun Heo 	else
1799f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
18003270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1801c34056a3STejun Heo 	if (IS_ERR(worker->task))
1802c34056a3STejun Heo 		goto fail;
1803c34056a3STejun Heo 
18043270476aSTejun Heo 	if (worker_pool_pri(pool))
18053270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
18063270476aSTejun Heo 
1807db7bccf4STejun Heo 	/*
1808bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
1809bc2ae0f5STejun Heo 	 * %GCWQ_DISASSOCIATED.  The caller is responsible for ensuring the
1810bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1811bc2ae0f5STejun Heo 	 * above the flag definition for details.
1812bc2ae0f5STejun Heo 	 *
1813bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1814bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1815db7bccf4STejun Heo 	 */
1816bc2ae0f5STejun Heo 	if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
18178b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1818bc2ae0f5STejun Heo 	} else {
1819db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1820f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1821f3421797STejun Heo 	}
1822c34056a3STejun Heo 
1823c34056a3STejun Heo 	return worker;
1824c34056a3STejun Heo fail:
1825c34056a3STejun Heo 	if (id >= 0) {
18268b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1827bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
18288b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1829c34056a3STejun Heo 	}
1830c34056a3STejun Heo 	kfree(worker);
1831c34056a3STejun Heo 	return NULL;
1832c34056a3STejun Heo }
1833c34056a3STejun Heo 
1834c34056a3STejun Heo /**
1835c34056a3STejun Heo  * start_worker - start a newly created worker
1836c34056a3STejun Heo  * @worker: worker to start
1837c34056a3STejun Heo  *
1838c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1839c34056a3STejun Heo  *
1840c34056a3STejun Heo  * CONTEXT:
18418b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1842c34056a3STejun Heo  */
1843c34056a3STejun Heo static void start_worker(struct worker *worker)
1844c34056a3STejun Heo {
1845cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1846bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1847c8e55f36STejun Heo 	worker_enter_idle(worker);
1848c34056a3STejun Heo 	wake_up_process(worker->task);
1849c34056a3STejun Heo }
1850c34056a3STejun Heo 
1851c34056a3STejun Heo /**
1852c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1853c34056a3STejun Heo  * @worker: worker to be destroyed
1854c34056a3STejun Heo  *
1855c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1856c8e55f36STejun Heo  *
1857c8e55f36STejun Heo  * CONTEXT:
1858c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1859c34056a3STejun Heo  */
1860c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1861c34056a3STejun Heo {
1862bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1863bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1864c34056a3STejun Heo 	int id = worker->id;
1865c34056a3STejun Heo 
1866c34056a3STejun Heo 	/* sanity check frenzy */
1867c34056a3STejun Heo 	BUG_ON(worker->current_work);
1868affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1869c34056a3STejun Heo 
1870c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1871bd7bdd43STejun Heo 		pool->nr_workers--;
1872c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1873bd7bdd43STejun Heo 		pool->nr_idle--;
1874c8e55f36STejun Heo 
1875c8e55f36STejun Heo 	list_del_init(&worker->entry);
1876cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1877c8e55f36STejun Heo 
1878c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1879c8e55f36STejun Heo 
1880c34056a3STejun Heo 	kthread_stop(worker->task);
1881c34056a3STejun Heo 	kfree(worker);
1882c34056a3STejun Heo 
18838b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1884bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1885c34056a3STejun Heo }
1886c34056a3STejun Heo 
188763d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1888e22bee78STejun Heo {
188963d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
189063d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1891e22bee78STejun Heo 
1892e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1893e22bee78STejun Heo 
189463d95a91STejun Heo 	if (too_many_workers(pool)) {
1895e22bee78STejun Heo 		struct worker *worker;
1896e22bee78STejun Heo 		unsigned long expires;
1897e22bee78STejun Heo 
1898e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
189963d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1900e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1901e22bee78STejun Heo 
1902e22bee78STejun Heo 		if (time_before(jiffies, expires))
190363d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1904e22bee78STejun Heo 		else {
1905e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
190611ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
190763d95a91STejun Heo 			wake_up_worker(pool);
1908e22bee78STejun Heo 		}
1909e22bee78STejun Heo 	}
1910e22bee78STejun Heo 
1911e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1912e22bee78STejun Heo }
1913e22bee78STejun Heo 
1914e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1915e22bee78STejun Heo {
1916e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1917e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1918f3421797STejun Heo 	unsigned int cpu;
1919e22bee78STejun Heo 
1920e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1921e22bee78STejun Heo 		return false;
1922e22bee78STejun Heo 
1923e22bee78STejun Heo 	/* mayday mayday mayday */
1924bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1925f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1926f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1927f3421797STejun Heo 		cpu = 0;
1928f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1929e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1930e22bee78STejun Heo 	return true;
1931e22bee78STejun Heo }
1932e22bee78STejun Heo 
193363d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1934e22bee78STejun Heo {
193563d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
193663d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1937e22bee78STejun Heo 	struct work_struct *work;
1938e22bee78STejun Heo 
1939e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1940e22bee78STejun Heo 
194163d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1942e22bee78STejun Heo 		/*
1943e22bee78STejun Heo 		 * We've been trying to create a new worker but
1944e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1945e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1946e22bee78STejun Heo 		 * rescuers.
1947e22bee78STejun Heo 		 */
194863d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1949e22bee78STejun Heo 			send_mayday(work);
1950e22bee78STejun Heo 	}
1951e22bee78STejun Heo 
1952e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1953e22bee78STejun Heo 
195463d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1955e22bee78STejun Heo }
1956e22bee78STejun Heo 
1957e22bee78STejun Heo /**
1958e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
195963d95a91STejun Heo  * @pool: pool to create a new worker for
1960e22bee78STejun Heo  *
196163d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1962e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1963e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
196463d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1965e22bee78STejun Heo  * possible allocation deadlock.
1966e22bee78STejun Heo  *
1967e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1968e22bee78STejun Heo  * may_start_working() true.
1969e22bee78STejun Heo  *
1970e22bee78STejun Heo  * LOCKING:
1971e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1972e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1973e22bee78STejun Heo  * manager.
1974e22bee78STejun Heo  *
1975e22bee78STejun Heo  * RETURNS:
1976e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1977e22bee78STejun Heo  * otherwise.
1978e22bee78STejun Heo  */
197963d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
198006bd6ebfSNamhyung Kim __releases(&gcwq->lock)
198106bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1982e22bee78STejun Heo {
198363d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
198463d95a91STejun Heo 
198563d95a91STejun Heo 	if (!need_to_create_worker(pool))
1986e22bee78STejun Heo 		return false;
1987e22bee78STejun Heo restart:
19889f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
19899f9c2364STejun Heo 
1990e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
199163d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1992e22bee78STejun Heo 
1993e22bee78STejun Heo 	while (true) {
1994e22bee78STejun Heo 		struct worker *worker;
1995e22bee78STejun Heo 
1996bc2ae0f5STejun Heo 		worker = create_worker(pool);
1997e22bee78STejun Heo 		if (worker) {
199863d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1999e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
2000e22bee78STejun Heo 			start_worker(worker);
200163d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
2002e22bee78STejun Heo 			return true;
2003e22bee78STejun Heo 		}
2004e22bee78STejun Heo 
200563d95a91STejun Heo 		if (!need_to_create_worker(pool))
2006e22bee78STejun Heo 			break;
2007e22bee78STejun Heo 
2008e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
2009e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
20109f9c2364STejun Heo 
201163d95a91STejun Heo 		if (!need_to_create_worker(pool))
2012e22bee78STejun Heo 			break;
2013e22bee78STejun Heo 	}
2014e22bee78STejun Heo 
201563d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2016e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
201763d95a91STejun Heo 	if (need_to_create_worker(pool))
2018e22bee78STejun Heo 		goto restart;
2019e22bee78STejun Heo 	return true;
2020e22bee78STejun Heo }
2021e22bee78STejun Heo 
2022e22bee78STejun Heo /**
2023e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
202463d95a91STejun Heo  * @pool: pool to destroy workers for
2025e22bee78STejun Heo  *
202663d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
2027e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
2028e22bee78STejun Heo  *
2029e22bee78STejun Heo  * LOCKING:
2030e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2031e22bee78STejun Heo  * multiple times.  Called only from manager.
2032e22bee78STejun Heo  *
2033e22bee78STejun Heo  * RETURNS:
2034e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
2035e22bee78STejun Heo  * otherwise.
2036e22bee78STejun Heo  */
203763d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
2038e22bee78STejun Heo {
2039e22bee78STejun Heo 	bool ret = false;
2040e22bee78STejun Heo 
204163d95a91STejun Heo 	while (too_many_workers(pool)) {
2042e22bee78STejun Heo 		struct worker *worker;
2043e22bee78STejun Heo 		unsigned long expires;
2044e22bee78STejun Heo 
204563d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2046e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2047e22bee78STejun Heo 
2048e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
204963d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2050e22bee78STejun Heo 			break;
2051e22bee78STejun Heo 		}
2052e22bee78STejun Heo 
2053e22bee78STejun Heo 		destroy_worker(worker);
2054e22bee78STejun Heo 		ret = true;
2055e22bee78STejun Heo 	}
2056e22bee78STejun Heo 
2057e22bee78STejun Heo 	return ret;
2058e22bee78STejun Heo }
2059e22bee78STejun Heo 
2060e22bee78STejun Heo /**
2061e22bee78STejun Heo  * manage_workers - manage worker pool
2062e22bee78STejun Heo  * @worker: self
2063e22bee78STejun Heo  *
2064e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
2065e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2066e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
2067e22bee78STejun Heo  *
2068e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2069e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2070e22bee78STejun Heo  * and may_start_working() is true.
2071e22bee78STejun Heo  *
2072e22bee78STejun Heo  * CONTEXT:
2073e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2074e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2075e22bee78STejun Heo  *
2076e22bee78STejun Heo  * RETURNS:
2077e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
2078e22bee78STejun Heo  * some action was taken.
2079e22bee78STejun Heo  */
2080e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2081e22bee78STejun Heo {
208263d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2083e22bee78STejun Heo 	bool ret = false;
2084e22bee78STejun Heo 
208560373152STejun Heo 	if (!mutex_trylock(&pool->manager_mutex))
2086e22bee78STejun Heo 		return ret;
2087e22bee78STejun Heo 
208811ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2089e22bee78STejun Heo 
2090e22bee78STejun Heo 	/*
2091e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2092e22bee78STejun Heo 	 * on return.
2093e22bee78STejun Heo 	 */
209463d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
209563d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2096e22bee78STejun Heo 
209760373152STejun Heo 	mutex_unlock(&pool->manager_mutex);
2098e22bee78STejun Heo 	return ret;
2099e22bee78STejun Heo }
2100e22bee78STejun Heo 
2101a62428c0STejun Heo /**
2102a62428c0STejun Heo  * process_one_work - process single work
2103c34056a3STejun Heo  * @worker: self
2104a62428c0STejun Heo  * @work: work to process
2105a62428c0STejun Heo  *
2106a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2107a62428c0STejun Heo  * process a single work including synchronization against and
2108a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2109a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2110a62428c0STejun Heo  * call this function to process a work.
2111a62428c0STejun Heo  *
2112a62428c0STejun Heo  * CONTEXT:
21138b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
2114a62428c0STejun Heo  */
2115c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
211606bd6ebfSNamhyung Kim __releases(&gcwq->lock)
211706bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
21181da177e4SLinus Torvalds {
21197e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2120bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2121bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
2122c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
2123fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
21246bb49e59SDavid Howells 	work_func_t f = work->func;
212573f53c4aSTejun Heo 	int work_color;
21267e11629dSTejun Heo 	struct worker *collision;
21274e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21284e6045f1SJohannes Berg 	/*
2129a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2130a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2131a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2132a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2133a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21344e6045f1SJohannes Berg 	 */
21354d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21364d82a1deSPeter Zijlstra 
21374d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21384e6045f1SJohannes Berg #endif
21396fec10a1STejun Heo 	/*
21406fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21416fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
21426fec10a1STejun Heo 	 * unbound or a disassociated gcwq.
21436fec10a1STejun Heo 	 */
214425511a47STejun Heo 	WARN_ON_ONCE(!(worker->flags & (WORKER_UNBOUND | WORKER_REBIND)) &&
21456fec10a1STejun Heo 		     !(gcwq->flags & GCWQ_DISASSOCIATED) &&
214625511a47STejun Heo 		     raw_smp_processor_id() != gcwq->cpu);
214725511a47STejun Heo 
21487e11629dSTejun Heo 	/*
21497e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21507e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21517e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21527e11629dSTejun Heo 	 * currently executing one.
21537e11629dSTejun Heo 	 */
21547e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
21557e11629dSTejun Heo 	if (unlikely(collision)) {
21567e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21577e11629dSTejun Heo 		return;
21587e11629dSTejun Heo 	}
21591da177e4SLinus Torvalds 
21608930cabaSTejun Heo 	/* claim and dequeue */
21611da177e4SLinus Torvalds 	debug_work_deactivate(work);
2162c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
2163c34056a3STejun Heo 	worker->current_work = work;
21648cca0eeaSTejun Heo 	worker->current_cwq = cwq;
216573f53c4aSTejun Heo 	work_color = get_work_color(work);
21667a22ad75STejun Heo 
2167a62428c0STejun Heo 	list_del_init(&work->entry);
2168a62428c0STejun Heo 
2169649027d7STejun Heo 	/*
2170fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2171fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2172fb0e7bebSTejun Heo 	 */
2173fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2174fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2175fb0e7bebSTejun Heo 
2176974271c4STejun Heo 	/*
2177974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
2178974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2179974271c4STejun Heo 	 */
218063d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
218163d95a91STejun Heo 		wake_up_worker(pool);
2182974271c4STejun Heo 
21838930cabaSTejun Heo 	/*
21848930cabaSTejun Heo 	 * Record the last CPU and clear PENDING.  The following wmb is
21858930cabaSTejun Heo 	 * paired with the implied mb in test_and_set_bit(PENDING) and
21868930cabaSTejun Heo 	 * ensures all updates to @work made here are visible to and
21878930cabaSTejun Heo 	 * precede any updates by the next PENDING owner.  Also, clear
21888930cabaSTejun Heo 	 * PENDING inside @gcwq->lock so that PENDING and queued state
21898930cabaSTejun Heo 	 * changes happen together while IRQ is disabled.
21908930cabaSTejun Heo 	 */
21918930cabaSTejun Heo 	smp_wmb();
21928930cabaSTejun Heo 	set_work_cpu_and_clear_pending(work, gcwq->cpu);
21931da177e4SLinus Torvalds 
21948930cabaSTejun Heo 	spin_unlock_irq(&gcwq->lock);
2195959d1af8STejun Heo 
2196e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
21973295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2198e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
219965f27f38SDavid Howells 	f(work);
2200e36c886aSArjan van de Ven 	/*
2201e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2202e36c886aSArjan van de Ven 	 * point will only record its address.
2203e36c886aSArjan van de Ven 	 */
2204e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22053295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
22063295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
22071da177e4SLinus Torvalds 
2208d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2209d5abe669SPeter Zijlstra 		printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
2210d5abe669SPeter Zijlstra 		       "%s/0x%08x/%d\n",
2211a62428c0STejun Heo 		       current->comm, preempt_count(), task_pid_nr(current));
2212d5abe669SPeter Zijlstra 		printk(KERN_ERR "    last function: ");
2213d5abe669SPeter Zijlstra 		print_symbol("%s\n", (unsigned long)f);
2214d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2215d5abe669SPeter Zijlstra 		dump_stack();
2216d5abe669SPeter Zijlstra 	}
2217d5abe669SPeter Zijlstra 
22188b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2219a62428c0STejun Heo 
2220fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2221fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2222fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2223fb0e7bebSTejun Heo 
2224a62428c0STejun Heo 	/* we're done with it, release */
2225c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
2226c34056a3STejun Heo 	worker->current_work = NULL;
22278cca0eeaSTejun Heo 	worker->current_cwq = NULL;
22288a2e8e5dSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color, false);
22291da177e4SLinus Torvalds }
22301da177e4SLinus Torvalds 
2231affee4b2STejun Heo /**
2232affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2233affee4b2STejun Heo  * @worker: self
2234affee4b2STejun Heo  *
2235affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2236affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2237affee4b2STejun Heo  * fetches a work from the top and executes it.
2238affee4b2STejun Heo  *
2239affee4b2STejun Heo  * CONTEXT:
22408b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2241affee4b2STejun Heo  * multiple times.
2242affee4b2STejun Heo  */
2243affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22441da177e4SLinus Torvalds {
2245affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2246affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2247a62428c0STejun Heo 						struct work_struct, entry);
2248c34056a3STejun Heo 		process_one_work(worker, work);
2249a62428c0STejun Heo 	}
22501da177e4SLinus Torvalds }
22511da177e4SLinus Torvalds 
22524690c4abSTejun Heo /**
22534690c4abSTejun Heo  * worker_thread - the worker thread function
2254c34056a3STejun Heo  * @__worker: self
22554690c4abSTejun Heo  *
2256e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2257e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2258e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2259e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2260e22bee78STejun Heo  * rescuer_thread().
22614690c4abSTejun Heo  */
2262c34056a3STejun Heo static int worker_thread(void *__worker)
22631da177e4SLinus Torvalds {
2264c34056a3STejun Heo 	struct worker *worker = __worker;
2265bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2266bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
22671da177e4SLinus Torvalds 
2268e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2269e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2270c8e55f36STejun Heo woke_up:
22718b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2272affee4b2STejun Heo 
227325511a47STejun Heo 	/*
227425511a47STejun Heo 	 * DIE can be set only while idle and REBIND set while busy has
227525511a47STejun Heo 	 * @worker->rebind_work scheduled.  Checking here is enough.
227625511a47STejun Heo 	 */
227725511a47STejun Heo 	if (unlikely(worker->flags & (WORKER_REBIND | WORKER_DIE))) {
2278c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
227925511a47STejun Heo 
228025511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2281e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2282c8e55f36STejun Heo 			return 0;
2283c8e55f36STejun Heo 		}
2284c8e55f36STejun Heo 
228525511a47STejun Heo 		idle_worker_rebind(worker);
228625511a47STejun Heo 		goto woke_up;
228725511a47STejun Heo 	}
228825511a47STejun Heo 
2289c8e55f36STejun Heo 	worker_leave_idle(worker);
2290db7bccf4STejun Heo recheck:
2291e22bee78STejun Heo 	/* no more worker necessary? */
229263d95a91STejun Heo 	if (!need_more_worker(pool))
2293e22bee78STejun Heo 		goto sleep;
2294e22bee78STejun Heo 
2295e22bee78STejun Heo 	/* do we need to manage? */
229663d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2297e22bee78STejun Heo 		goto recheck;
2298e22bee78STejun Heo 
2299c8e55f36STejun Heo 	/*
2300c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2301c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2302c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2303c8e55f36STejun Heo 	 */
2304c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2305c8e55f36STejun Heo 
2306e22bee78STejun Heo 	/*
2307e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2308e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2309e22bee78STejun Heo 	 * assumed the manager role.
2310e22bee78STejun Heo 	 */
2311e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2312e22bee78STejun Heo 
2313e22bee78STejun Heo 	do {
2314affee4b2STejun Heo 		struct work_struct *work =
2315bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2316affee4b2STejun Heo 					 struct work_struct, entry);
2317affee4b2STejun Heo 
2318c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2319affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2320affee4b2STejun Heo 			process_one_work(worker, work);
2321affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2322affee4b2STejun Heo 				process_scheduled_works(worker);
2323affee4b2STejun Heo 		} else {
2324c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2325affee4b2STejun Heo 			process_scheduled_works(worker);
2326affee4b2STejun Heo 		}
232763d95a91STejun Heo 	} while (keep_working(pool));
2328affee4b2STejun Heo 
2329e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2330d313dd85STejun Heo sleep:
233163d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2332e22bee78STejun Heo 		goto recheck;
2333d313dd85STejun Heo 
2334c8e55f36STejun Heo 	/*
2335e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2336e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2337e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2338e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2339e22bee78STejun Heo 	 * prevent losing any event.
2340c8e55f36STejun Heo 	 */
2341c8e55f36STejun Heo 	worker_enter_idle(worker);
2342c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
23438b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23441da177e4SLinus Torvalds 	schedule();
2345c8e55f36STejun Heo 	goto woke_up;
23461da177e4SLinus Torvalds }
23471da177e4SLinus Torvalds 
2348e22bee78STejun Heo /**
2349e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2350e22bee78STejun Heo  * @__wq: the associated workqueue
2351e22bee78STejun Heo  *
2352e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2353e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2354e22bee78STejun Heo  *
2355e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2356e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2357e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2358e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2359e22bee78STejun Heo  * the problem rescuer solves.
2360e22bee78STejun Heo  *
2361e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2362e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2363e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2364e22bee78STejun Heo  *
2365e22bee78STejun Heo  * This should happen rarely.
2366e22bee78STejun Heo  */
2367e22bee78STejun Heo static int rescuer_thread(void *__wq)
2368e22bee78STejun Heo {
2369e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2370e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2371e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2372f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2373e22bee78STejun Heo 	unsigned int cpu;
2374e22bee78STejun Heo 
2375e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2376e22bee78STejun Heo repeat:
2377e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
23781da177e4SLinus Torvalds 
23791da177e4SLinus Torvalds 	if (kthread_should_stop())
2380e22bee78STejun Heo 		return 0;
23811da177e4SLinus Torvalds 
2382f3421797STejun Heo 	/*
2383f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2384f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2385f3421797STejun Heo 	 */
2386f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2387f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2388f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2389bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2390bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2391e22bee78STejun Heo 		struct work_struct *work, *n;
2392e22bee78STejun Heo 
2393e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2394f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2395e22bee78STejun Heo 
2396e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2397bd7bdd43STejun Heo 		rescuer->pool = pool;
2398e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2399e22bee78STejun Heo 
2400e22bee78STejun Heo 		/*
2401e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2402e22bee78STejun Heo 		 * process'em.
2403e22bee78STejun Heo 		 */
2404e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2405bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2406e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2407e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2408e22bee78STejun Heo 
2409e22bee78STejun Heo 		process_scheduled_works(rescuer);
24107576958aSTejun Heo 
24117576958aSTejun Heo 		/*
24127576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
24137576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24147576958aSTejun Heo 		 * and stalling the execution.
24157576958aSTejun Heo 		 */
241663d95a91STejun Heo 		if (keep_working(pool))
241763d95a91STejun Heo 			wake_up_worker(pool);
24187576958aSTejun Heo 
2419e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
24201da177e4SLinus Torvalds 	}
24211da177e4SLinus Torvalds 
2422e22bee78STejun Heo 	schedule();
2423e22bee78STejun Heo 	goto repeat;
24241da177e4SLinus Torvalds }
24251da177e4SLinus Torvalds 
2426fc2e4d70SOleg Nesterov struct wq_barrier {
2427fc2e4d70SOleg Nesterov 	struct work_struct	work;
2428fc2e4d70SOleg Nesterov 	struct completion	done;
2429fc2e4d70SOleg Nesterov };
2430fc2e4d70SOleg Nesterov 
2431fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2432fc2e4d70SOleg Nesterov {
2433fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2434fc2e4d70SOleg Nesterov 	complete(&barr->done);
2435fc2e4d70SOleg Nesterov }
2436fc2e4d70SOleg Nesterov 
24374690c4abSTejun Heo /**
24384690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
24394690c4abSTejun Heo  * @cwq: cwq to insert barrier into
24404690c4abSTejun Heo  * @barr: wq_barrier to insert
2441affee4b2STejun Heo  * @target: target work to attach @barr to
2442affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24434690c4abSTejun Heo  *
2444affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2445affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2446affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2447affee4b2STejun Heo  * cpu.
2448affee4b2STejun Heo  *
2449affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2450affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2451affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2452affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2453affee4b2STejun Heo  * after a work with LINKED flag set.
2454affee4b2STejun Heo  *
2455affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2456affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
24574690c4abSTejun Heo  *
24584690c4abSTejun Heo  * CONTEXT:
24598b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
24604690c4abSTejun Heo  */
246183c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2462affee4b2STejun Heo 			      struct wq_barrier *barr,
2463affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2464fc2e4d70SOleg Nesterov {
2465affee4b2STejun Heo 	struct list_head *head;
2466affee4b2STejun Heo 	unsigned int linked = 0;
2467affee4b2STejun Heo 
2468dc186ad7SThomas Gleixner 	/*
24698b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2470dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2471dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2472dc186ad7SThomas Gleixner 	 * might deadlock.
2473dc186ad7SThomas Gleixner 	 */
2474ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
247522df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2476fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
247783c22520SOleg Nesterov 
2478affee4b2STejun Heo 	/*
2479affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2480affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2481affee4b2STejun Heo 	 */
2482affee4b2STejun Heo 	if (worker)
2483affee4b2STejun Heo 		head = worker->scheduled.next;
2484affee4b2STejun Heo 	else {
2485affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2486affee4b2STejun Heo 
2487affee4b2STejun Heo 		head = target->entry.next;
2488affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2489affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2490affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2491affee4b2STejun Heo 	}
2492affee4b2STejun Heo 
2493dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2494affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2495affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2496fc2e4d70SOleg Nesterov }
2497fc2e4d70SOleg Nesterov 
249873f53c4aSTejun Heo /**
249973f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
250073f53c4aSTejun Heo  * @wq: workqueue being flushed
250173f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
250273f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
250373f53c4aSTejun Heo  *
250473f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
250573f53c4aSTejun Heo  *
250673f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
250773f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
250873f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
250973f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
251073f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
251173f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
251273f53c4aSTejun Heo  *
251373f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
251473f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
251573f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
251673f53c4aSTejun Heo  * is returned.
251773f53c4aSTejun Heo  *
251873f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
251973f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
252073f53c4aSTejun Heo  * advanced to @work_color.
252173f53c4aSTejun Heo  *
252273f53c4aSTejun Heo  * CONTEXT:
252373f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
252473f53c4aSTejun Heo  *
252573f53c4aSTejun Heo  * RETURNS:
252673f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
252773f53c4aSTejun Heo  * otherwise.
252873f53c4aSTejun Heo  */
252973f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
253073f53c4aSTejun Heo 				      int flush_color, int work_color)
25311da177e4SLinus Torvalds {
253273f53c4aSTejun Heo 	bool wait = false;
253373f53c4aSTejun Heo 	unsigned int cpu;
25341da177e4SLinus Torvalds 
253573f53c4aSTejun Heo 	if (flush_color >= 0) {
253673f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
253773f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2538dc186ad7SThomas Gleixner 	}
253914441960SOleg Nesterov 
2540f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
254173f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2542bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
25431da177e4SLinus Torvalds 
25448b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
254573f53c4aSTejun Heo 
254673f53c4aSTejun Heo 		if (flush_color >= 0) {
254773f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
254873f53c4aSTejun Heo 
254973f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
255073f53c4aSTejun Heo 				cwq->flush_color = flush_color;
255173f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
255273f53c4aSTejun Heo 				wait = true;
25531da177e4SLinus Torvalds 			}
255473f53c4aSTejun Heo 		}
255573f53c4aSTejun Heo 
255673f53c4aSTejun Heo 		if (work_color >= 0) {
255773f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
255873f53c4aSTejun Heo 			cwq->work_color = work_color;
255973f53c4aSTejun Heo 		}
256073f53c4aSTejun Heo 
25618b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
25621da177e4SLinus Torvalds 	}
25631da177e4SLinus Torvalds 
256473f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
256573f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
256673f53c4aSTejun Heo 
256773f53c4aSTejun Heo 	return wait;
256883c22520SOleg Nesterov }
25691da177e4SLinus Torvalds 
25700fcb78c2SRolf Eike Beer /**
25711da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
25720fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
25731da177e4SLinus Torvalds  *
25741da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
25751da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
25761da177e4SLinus Torvalds  *
2577fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2578fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
25791da177e4SLinus Torvalds  */
25807ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
25811da177e4SLinus Torvalds {
258273f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
258373f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
258473f53c4aSTejun Heo 		.flush_color = -1,
258573f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
258673f53c4aSTejun Heo 	};
258773f53c4aSTejun Heo 	int next_color;
2588b1f4ec17SOleg Nesterov 
25893295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
25903295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
259173f53c4aSTejun Heo 
259273f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
259373f53c4aSTejun Heo 
259473f53c4aSTejun Heo 	/*
259573f53c4aSTejun Heo 	 * Start-to-wait phase
259673f53c4aSTejun Heo 	 */
259773f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
259873f53c4aSTejun Heo 
259973f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
260073f53c4aSTejun Heo 		/*
260173f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
260273f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
260373f53c4aSTejun Heo 		 * by one.
260473f53c4aSTejun Heo 		 */
260573f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
260673f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
260773f53c4aSTejun Heo 		wq->work_color = next_color;
260873f53c4aSTejun Heo 
260973f53c4aSTejun Heo 		if (!wq->first_flusher) {
261073f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
261173f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
261273f53c4aSTejun Heo 
261373f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
261473f53c4aSTejun Heo 
261573f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
261673f53c4aSTejun Heo 						       wq->work_color)) {
261773f53c4aSTejun Heo 				/* nothing to flush, done */
261873f53c4aSTejun Heo 				wq->flush_color = next_color;
261973f53c4aSTejun Heo 				wq->first_flusher = NULL;
262073f53c4aSTejun Heo 				goto out_unlock;
262173f53c4aSTejun Heo 			}
262273f53c4aSTejun Heo 		} else {
262373f53c4aSTejun Heo 			/* wait in queue */
262473f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
262573f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
262673f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
262773f53c4aSTejun Heo 		}
262873f53c4aSTejun Heo 	} else {
262973f53c4aSTejun Heo 		/*
263073f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
263173f53c4aSTejun Heo 		 * The next flush completion will assign us
263273f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
263373f53c4aSTejun Heo 		 */
263473f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
263573f53c4aSTejun Heo 	}
263673f53c4aSTejun Heo 
263773f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
263873f53c4aSTejun Heo 
263973f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
264073f53c4aSTejun Heo 
264173f53c4aSTejun Heo 	/*
264273f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
264373f53c4aSTejun Heo 	 *
264473f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
264573f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
264673f53c4aSTejun Heo 	 */
264773f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
264873f53c4aSTejun Heo 		return;
264973f53c4aSTejun Heo 
265073f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
265173f53c4aSTejun Heo 
26524ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26534ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26544ce48b37STejun Heo 		goto out_unlock;
26554ce48b37STejun Heo 
265673f53c4aSTejun Heo 	wq->first_flusher = NULL;
265773f53c4aSTejun Heo 
265873f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
265973f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
266073f53c4aSTejun Heo 
266173f53c4aSTejun Heo 	while (true) {
266273f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
266373f53c4aSTejun Heo 
266473f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
266573f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
266673f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
266773f53c4aSTejun Heo 				break;
266873f53c4aSTejun Heo 			list_del_init(&next->list);
266973f53c4aSTejun Heo 			complete(&next->done);
267073f53c4aSTejun Heo 		}
267173f53c4aSTejun Heo 
267273f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
267373f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
267473f53c4aSTejun Heo 
267573f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
267673f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
267773f53c4aSTejun Heo 
267873f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
267973f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
268073f53c4aSTejun Heo 			/*
268173f53c4aSTejun Heo 			 * Assign the same color to all overflowed
268273f53c4aSTejun Heo 			 * flushers, advance work_color and append to
268373f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
268473f53c4aSTejun Heo 			 * phase for these overflowed flushers.
268573f53c4aSTejun Heo 			 */
268673f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
268773f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
268873f53c4aSTejun Heo 
268973f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
269073f53c4aSTejun Heo 
269173f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
269273f53c4aSTejun Heo 					      &wq->flusher_queue);
269373f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
269473f53c4aSTejun Heo 		}
269573f53c4aSTejun Heo 
269673f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
269773f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
269873f53c4aSTejun Heo 			break;
269973f53c4aSTejun Heo 		}
270073f53c4aSTejun Heo 
270173f53c4aSTejun Heo 		/*
270273f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
270373f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
270473f53c4aSTejun Heo 		 */
270573f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
270673f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
270773f53c4aSTejun Heo 
270873f53c4aSTejun Heo 		list_del_init(&next->list);
270973f53c4aSTejun Heo 		wq->first_flusher = next;
271073f53c4aSTejun Heo 
271173f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
271273f53c4aSTejun Heo 			break;
271373f53c4aSTejun Heo 
271473f53c4aSTejun Heo 		/*
271573f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
271673f53c4aSTejun Heo 		 * flusher and repeat cascading.
271773f53c4aSTejun Heo 		 */
271873f53c4aSTejun Heo 		wq->first_flusher = NULL;
271973f53c4aSTejun Heo 	}
272073f53c4aSTejun Heo 
272173f53c4aSTejun Heo out_unlock:
272273f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
27231da177e4SLinus Torvalds }
2724ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27251da177e4SLinus Torvalds 
27269c5a2ba7STejun Heo /**
27279c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27289c5a2ba7STejun Heo  * @wq: workqueue to drain
27299c5a2ba7STejun Heo  *
27309c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27319c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27329c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27339c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27349c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27359c5a2ba7STejun Heo  * takes too long.
27369c5a2ba7STejun Heo  */
27379c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27389c5a2ba7STejun Heo {
27399c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
27409c5a2ba7STejun Heo 	unsigned int cpu;
27419c5a2ba7STejun Heo 
27429c5a2ba7STejun Heo 	/*
27439c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27449c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
27459c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
27469c5a2ba7STejun Heo 	 */
27479c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27489c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
27499c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
27509c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27519c5a2ba7STejun Heo reflush:
27529c5a2ba7STejun Heo 	flush_workqueue(wq);
27539c5a2ba7STejun Heo 
27549c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27559c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2756fa2563e4SThomas Tuttle 		bool drained;
27579c5a2ba7STejun Heo 
2758bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2759fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2760bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2761fa2563e4SThomas Tuttle 
2762fa2563e4SThomas Tuttle 		if (drained)
27639c5a2ba7STejun Heo 			continue;
27649c5a2ba7STejun Heo 
27659c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27669c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
27679c5a2ba7STejun Heo 			pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
27689c5a2ba7STejun Heo 				   wq->name, flush_cnt);
27699c5a2ba7STejun Heo 		goto reflush;
27709c5a2ba7STejun Heo 	}
27719c5a2ba7STejun Heo 
27729c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27739c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
27749c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
27759c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27769c5a2ba7STejun Heo }
27779c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
27789c5a2ba7STejun Heo 
2779baf59022STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2780baf59022STejun Heo 			     bool wait_executing)
2781baf59022STejun Heo {
2782baf59022STejun Heo 	struct worker *worker = NULL;
2783baf59022STejun Heo 	struct global_cwq *gcwq;
2784baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2785baf59022STejun Heo 
2786baf59022STejun Heo 	might_sleep();
2787baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2788baf59022STejun Heo 	if (!gcwq)
2789baf59022STejun Heo 		return false;
2790baf59022STejun Heo 
2791baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2792baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2793baf59022STejun Heo 		/*
2794baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2795baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2796baf59022STejun Heo 		 * are not going to wait.
2797baf59022STejun Heo 		 */
2798baf59022STejun Heo 		smp_rmb();
2799baf59022STejun Heo 		cwq = get_work_cwq(work);
2800bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2801baf59022STejun Heo 			goto already_gone;
2802baf59022STejun Heo 	} else if (wait_executing) {
2803baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2804baf59022STejun Heo 		if (!worker)
2805baf59022STejun Heo 			goto already_gone;
2806baf59022STejun Heo 		cwq = worker->current_cwq;
2807baf59022STejun Heo 	} else
2808baf59022STejun Heo 		goto already_gone;
2809baf59022STejun Heo 
2810baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2811baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2812baf59022STejun Heo 
2813e159489bSTejun Heo 	/*
2814e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2815e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2816e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2817e159489bSTejun Heo 	 * access.
2818e159489bSTejun Heo 	 */
2819e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2820baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2821e159489bSTejun Heo 	else
2822e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2823baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2824e159489bSTejun Heo 
2825baf59022STejun Heo 	return true;
2826baf59022STejun Heo already_gone:
2827baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2828baf59022STejun Heo 	return false;
2829baf59022STejun Heo }
2830baf59022STejun Heo 
2831db700897SOleg Nesterov /**
2832401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2833401a8d04STejun Heo  * @work: the work to flush
2834db700897SOleg Nesterov  *
2835401a8d04STejun Heo  * Wait until @work has finished execution.  This function considers
2836401a8d04STejun Heo  * only the last queueing instance of @work.  If @work has been
2837401a8d04STejun Heo  * enqueued across different CPUs on a non-reentrant workqueue or on
2838401a8d04STejun Heo  * multiple workqueues, @work might still be executing on return on
2839401a8d04STejun Heo  * some of the CPUs from earlier queueing.
2840a67da70dSOleg Nesterov  *
2841401a8d04STejun Heo  * If @work was queued only on a non-reentrant, ordered or unbound
2842401a8d04STejun Heo  * workqueue, @work is guaranteed to be idle on return if it hasn't
2843401a8d04STejun Heo  * been requeued since flush started.
2844401a8d04STejun Heo  *
2845401a8d04STejun Heo  * RETURNS:
2846401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2847401a8d04STejun Heo  * %false if it was already idle.
2848db700897SOleg Nesterov  */
2849401a8d04STejun Heo bool flush_work(struct work_struct *work)
2850db700897SOleg Nesterov {
2851db700897SOleg Nesterov 	struct wq_barrier barr;
2852db700897SOleg Nesterov 
28530976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28540976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28550976dfc1SStephen Boyd 
2856baf59022STejun Heo 	if (start_flush_work(work, &barr, true)) {
2857db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2858dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2859401a8d04STejun Heo 		return true;
2860baf59022STejun Heo 	} else
2861401a8d04STejun Heo 		return false;
2862db700897SOleg Nesterov }
2863db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2864db700897SOleg Nesterov 
2865401a8d04STejun Heo static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2866401a8d04STejun Heo {
2867401a8d04STejun Heo 	struct wq_barrier barr;
2868401a8d04STejun Heo 	struct worker *worker;
2869401a8d04STejun Heo 
2870401a8d04STejun Heo 	spin_lock_irq(&gcwq->lock);
2871401a8d04STejun Heo 
2872401a8d04STejun Heo 	worker = find_worker_executing_work(gcwq, work);
2873401a8d04STejun Heo 	if (unlikely(worker))
2874401a8d04STejun Heo 		insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2875401a8d04STejun Heo 
2876401a8d04STejun Heo 	spin_unlock_irq(&gcwq->lock);
2877401a8d04STejun Heo 
2878401a8d04STejun Heo 	if (unlikely(worker)) {
2879401a8d04STejun Heo 		wait_for_completion(&barr.done);
2880401a8d04STejun Heo 		destroy_work_on_stack(&barr.work);
2881401a8d04STejun Heo 		return true;
2882401a8d04STejun Heo 	} else
2883401a8d04STejun Heo 		return false;
2884401a8d04STejun Heo }
2885401a8d04STejun Heo 
2886401a8d04STejun Heo static bool wait_on_work(struct work_struct *work)
2887401a8d04STejun Heo {
2888401a8d04STejun Heo 	bool ret = false;
2889401a8d04STejun Heo 	int cpu;
2890401a8d04STejun Heo 
2891401a8d04STejun Heo 	might_sleep();
2892401a8d04STejun Heo 
2893401a8d04STejun Heo 	lock_map_acquire(&work->lockdep_map);
2894401a8d04STejun Heo 	lock_map_release(&work->lockdep_map);
2895401a8d04STejun Heo 
2896401a8d04STejun Heo 	for_each_gcwq_cpu(cpu)
2897401a8d04STejun Heo 		ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2898401a8d04STejun Heo 	return ret;
2899401a8d04STejun Heo }
2900401a8d04STejun Heo 
290109383498STejun Heo /**
290209383498STejun Heo  * flush_work_sync - wait until a work has finished execution
290309383498STejun Heo  * @work: the work to flush
290409383498STejun Heo  *
290509383498STejun Heo  * Wait until @work has finished execution.  On return, it's
290609383498STejun Heo  * guaranteed that all queueing instances of @work which happened
290709383498STejun Heo  * before this function is called are finished.  In other words, if
290809383498STejun Heo  * @work hasn't been requeued since this function was called, @work is
290909383498STejun Heo  * guaranteed to be idle on return.
291009383498STejun Heo  *
291109383498STejun Heo  * RETURNS:
291209383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
291309383498STejun Heo  * %false if it was already idle.
291409383498STejun Heo  */
291509383498STejun Heo bool flush_work_sync(struct work_struct *work)
291609383498STejun Heo {
291709383498STejun Heo 	struct wq_barrier barr;
291809383498STejun Heo 	bool pending, waited;
291909383498STejun Heo 
292009383498STejun Heo 	/* we'll wait for executions separately, queue barr only if pending */
292109383498STejun Heo 	pending = start_flush_work(work, &barr, false);
292209383498STejun Heo 
292309383498STejun Heo 	/* wait for executions to finish */
292409383498STejun Heo 	waited = wait_on_work(work);
292509383498STejun Heo 
292609383498STejun Heo 	/* wait for the pending one */
292709383498STejun Heo 	if (pending) {
292809383498STejun Heo 		wait_for_completion(&barr.done);
292909383498STejun Heo 		destroy_work_on_stack(&barr.work);
293009383498STejun Heo 	}
293109383498STejun Heo 
293209383498STejun Heo 	return pending || waited;
293309383498STejun Heo }
293409383498STejun Heo EXPORT_SYMBOL_GPL(flush_work_sync);
293509383498STejun Heo 
293636e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
29371f1f642eSOleg Nesterov {
2938bbb68dfaSTejun Heo 	unsigned long flags;
29391f1f642eSOleg Nesterov 	int ret;
29401f1f642eSOleg Nesterov 
29411f1f642eSOleg Nesterov 	do {
2942bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2943bbb68dfaSTejun Heo 		/*
2944bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2945bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2946bbb68dfaSTejun Heo 		 */
2947bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
29481f1f642eSOleg Nesterov 			wait_on_work(work);
29491f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
29501f1f642eSOleg Nesterov 
2951bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2952bbb68dfaSTejun Heo 	mark_work_canceling(work);
2953bbb68dfaSTejun Heo 	local_irq_restore(flags);
2954bbb68dfaSTejun Heo 
2955bbb68dfaSTejun Heo 	wait_on_work(work);
29567a22ad75STejun Heo 	clear_work_data(work);
29571f1f642eSOleg Nesterov 	return ret;
29581f1f642eSOleg Nesterov }
29591f1f642eSOleg Nesterov 
29606e84d644SOleg Nesterov /**
2961401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2962401a8d04STejun Heo  * @work: the work to cancel
29636e84d644SOleg Nesterov  *
2964401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2965401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2966401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2967401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
29681f1f642eSOleg Nesterov  *
2969401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2970401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
29716e84d644SOleg Nesterov  *
2972401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
29736e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2974401a8d04STejun Heo  *
2975401a8d04STejun Heo  * RETURNS:
2976401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
29776e84d644SOleg Nesterov  */
2978401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29796e84d644SOleg Nesterov {
298036e227d2STejun Heo 	return __cancel_work_timer(work, false);
2981b89deed3SOleg Nesterov }
298228e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2983b89deed3SOleg Nesterov 
29846e84d644SOleg Nesterov /**
2985401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2986401a8d04STejun Heo  * @dwork: the delayed work to flush
29876e84d644SOleg Nesterov  *
2988401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2989401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2990401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29911f1f642eSOleg Nesterov  *
2992401a8d04STejun Heo  * RETURNS:
2993401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2994401a8d04STejun Heo  * %false if it was already idle.
29956e84d644SOleg Nesterov  */
2996401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2997401a8d04STejun Heo {
29988930cabaSTejun Heo 	local_irq_disable();
2999401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
300057469821STejun Heo 		__queue_work(WORK_CPU_UNBOUND,
3001401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
30028930cabaSTejun Heo 	local_irq_enable();
3003401a8d04STejun Heo 	return flush_work(&dwork->work);
3004401a8d04STejun Heo }
3005401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
3006401a8d04STejun Heo 
3007401a8d04STejun Heo /**
300809383498STejun Heo  * flush_delayed_work_sync - wait for a dwork to finish
300909383498STejun Heo  * @dwork: the delayed work to flush
301009383498STejun Heo  *
301109383498STejun Heo  * Delayed timer is cancelled and the pending work is queued for
301209383498STejun Heo  * execution immediately.  Other than timer handling, its behavior
301309383498STejun Heo  * is identical to flush_work_sync().
301409383498STejun Heo  *
301509383498STejun Heo  * RETURNS:
301609383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
301709383498STejun Heo  * %false if it was already idle.
301809383498STejun Heo  */
301909383498STejun Heo bool flush_delayed_work_sync(struct delayed_work *dwork)
302009383498STejun Heo {
30218930cabaSTejun Heo 	local_irq_disable();
302209383498STejun Heo 	if (del_timer_sync(&dwork->timer))
302357469821STejun Heo 		__queue_work(WORK_CPU_UNBOUND,
302409383498STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
30258930cabaSTejun Heo 	local_irq_enable();
302609383498STejun Heo 	return flush_work_sync(&dwork->work);
302709383498STejun Heo }
302809383498STejun Heo EXPORT_SYMBOL(flush_delayed_work_sync);
302909383498STejun Heo 
303009383498STejun Heo /**
3031401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3032401a8d04STejun Heo  * @dwork: the delayed work cancel
3033401a8d04STejun Heo  *
3034401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
3035401a8d04STejun Heo  *
3036401a8d04STejun Heo  * RETURNS:
3037401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
3038401a8d04STejun Heo  */
3039401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
30406e84d644SOleg Nesterov {
304136e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
30426e84d644SOleg Nesterov }
3043f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
30441da177e4SLinus Torvalds 
3045d4283e93STejun Heo /**
30460a13c00eSTejun Heo  * schedule_work_on - put work task on a specific cpu
30470a13c00eSTejun Heo  * @cpu: cpu to put the work task on
30480a13c00eSTejun Heo  * @work: job to be done
30490a13c00eSTejun Heo  *
30500a13c00eSTejun Heo  * This puts a job on a specific cpu
30510a13c00eSTejun Heo  */
3052d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work)
30530a13c00eSTejun Heo {
30540a13c00eSTejun Heo 	return queue_work_on(cpu, system_wq, work);
30550a13c00eSTejun Heo }
30560a13c00eSTejun Heo EXPORT_SYMBOL(schedule_work_on);
30570a13c00eSTejun Heo 
30580fcb78c2SRolf Eike Beer /**
30590fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
30600fcb78c2SRolf Eike Beer  * @work: job to be done
30610fcb78c2SRolf Eike Beer  *
3062d4283e93STejun Heo  * Returns %false if @work was already on the kernel-global workqueue and
3063d4283e93STejun Heo  * %true otherwise.
30645b0f437dSBart Van Assche  *
30655b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
30665b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
30675b0f437dSBart Van Assche  * workqueue otherwise.
30680fcb78c2SRolf Eike Beer  */
3069d4283e93STejun Heo bool schedule_work(struct work_struct *work)
30701da177e4SLinus Torvalds {
3071d320c038STejun Heo 	return queue_work(system_wq, work);
30721da177e4SLinus Torvalds }
3073ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
30741da177e4SLinus Torvalds 
30750fcb78c2SRolf Eike Beer /**
30760fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
30770fcb78c2SRolf Eike Beer  * @cpu: cpu to use
307852bad64dSDavid Howells  * @dwork: job to be done
30790fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
30800fcb78c2SRolf Eike Beer  *
30810fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
30820fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
30830fcb78c2SRolf Eike Beer  */
3084d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3085d4283e93STejun Heo 			      unsigned long delay)
30861da177e4SLinus Torvalds {
3087d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
30881da177e4SLinus Torvalds }
3089ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
30901da177e4SLinus Torvalds 
3091b6136773SAndrew Morton /**
30920a13c00eSTejun Heo  * schedule_delayed_work - put work task in global workqueue after delay
30930a13c00eSTejun Heo  * @dwork: job to be done
30940a13c00eSTejun Heo  * @delay: number of jiffies to wait or 0 for immediate execution
30950a13c00eSTejun Heo  *
30960a13c00eSTejun Heo  * After waiting for a given time this puts a job in the kernel-global
30970a13c00eSTejun Heo  * workqueue.
30980a13c00eSTejun Heo  */
3099d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
31000a13c00eSTejun Heo {
31010a13c00eSTejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
31020a13c00eSTejun Heo }
31030a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work);
31040a13c00eSTejun Heo 
31050a13c00eSTejun Heo /**
310631ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3107b6136773SAndrew Morton  * @func: the function to call
3108b6136773SAndrew Morton  *
310931ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
311031ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3111b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
311231ddd871STejun Heo  *
311331ddd871STejun Heo  * RETURNS:
311431ddd871STejun Heo  * 0 on success, -errno on failure.
3115b6136773SAndrew Morton  */
311665f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
311715316ba8SChristoph Lameter {
311815316ba8SChristoph Lameter 	int cpu;
311938f51568SNamhyung Kim 	struct work_struct __percpu *works;
312015316ba8SChristoph Lameter 
3121b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3122b6136773SAndrew Morton 	if (!works)
312315316ba8SChristoph Lameter 		return -ENOMEM;
3124b6136773SAndrew Morton 
312595402b38SGautham R Shenoy 	get_online_cpus();
312693981800STejun Heo 
312715316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
31289bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
31299bfb1839SIngo Molnar 
31309bfb1839SIngo Molnar 		INIT_WORK(work, func);
31318de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
313215316ba8SChristoph Lameter 	}
313393981800STejun Heo 
313493981800STejun Heo 	for_each_online_cpu(cpu)
31358616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
313693981800STejun Heo 
313795402b38SGautham R Shenoy 	put_online_cpus();
3138b6136773SAndrew Morton 	free_percpu(works);
313915316ba8SChristoph Lameter 	return 0;
314015316ba8SChristoph Lameter }
314115316ba8SChristoph Lameter 
3142eef6a7d5SAlan Stern /**
3143eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3144eef6a7d5SAlan Stern  *
3145eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3146eef6a7d5SAlan Stern  * completion.
3147eef6a7d5SAlan Stern  *
3148eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3149eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3150eef6a7d5SAlan Stern  * will lead to deadlock:
3151eef6a7d5SAlan Stern  *
3152eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3153eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3154eef6a7d5SAlan Stern  *
3155eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3156eef6a7d5SAlan Stern  *
3157eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3158eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3159eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3160eef6a7d5SAlan Stern  *
3161eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3162eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3163eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3164eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3165eef6a7d5SAlan Stern  */
31661da177e4SLinus Torvalds void flush_scheduled_work(void)
31671da177e4SLinus Torvalds {
3168d320c038STejun Heo 	flush_workqueue(system_wq);
31691da177e4SLinus Torvalds }
3170ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
31711da177e4SLinus Torvalds 
31721da177e4SLinus Torvalds /**
31731fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
31741fa44ecaSJames Bottomley  * @fn:		the function to execute
31751fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
31761fa44ecaSJames Bottomley  *		be available when the work executes)
31771fa44ecaSJames Bottomley  *
31781fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
31791fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
31801fa44ecaSJames Bottomley  *
31811fa44ecaSJames Bottomley  * Returns:	0 - function was executed
31821fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31831fa44ecaSJames Bottomley  */
318465f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31851fa44ecaSJames Bottomley {
31861fa44ecaSJames Bottomley 	if (!in_interrupt()) {
318765f27f38SDavid Howells 		fn(&ew->work);
31881fa44ecaSJames Bottomley 		return 0;
31891fa44ecaSJames Bottomley 	}
31901fa44ecaSJames Bottomley 
319165f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31921fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31931fa44ecaSJames Bottomley 
31941fa44ecaSJames Bottomley 	return 1;
31951fa44ecaSJames Bottomley }
31961fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31971fa44ecaSJames Bottomley 
31981da177e4SLinus Torvalds int keventd_up(void)
31991da177e4SLinus Torvalds {
3200d320c038STejun Heo 	return system_wq != NULL;
32011da177e4SLinus Torvalds }
32021da177e4SLinus Torvalds 
3203bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
32041da177e4SLinus Torvalds {
32053af24433SOleg Nesterov 	/*
32060f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
32070f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
32080f900049STejun Heo 	 * unsigned long long.
32093af24433SOleg Nesterov 	 */
32100f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
32110f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
32120f900049STejun Heo 				   __alignof__(unsigned long long));
32133af24433SOleg Nesterov 
3214e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3215f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3216931ac77eSTejun Heo 	else {
32170f900049STejun Heo 		void *ptr;
3218e1d8aa9fSFrederic Weisbecker 
32190f900049STejun Heo 		/*
3220f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3221f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3222f3421797STejun Heo 		 * allocated pointer which will be used for free.
32230f900049STejun Heo 		 */
3224bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3225bdbc5dd7STejun Heo 		if (ptr) {
3226bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3227bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3228bdbc5dd7STejun Heo 		}
32293af24433SOleg Nesterov 	}
32303af24433SOleg Nesterov 
32310415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3232bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3233bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
32340f900049STejun Heo }
32350f900049STejun Heo 
3236bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
323706ba38a9SOleg Nesterov {
3238e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3239bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3240f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3241f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3242f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
324306ba38a9SOleg Nesterov 	}
324406ba38a9SOleg Nesterov }
324506ba38a9SOleg Nesterov 
3246f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3247f3421797STejun Heo 			       const char *name)
3248b71ab8c2STejun Heo {
3249f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3250f3421797STejun Heo 
3251f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3252b71ab8c2STejun Heo 		printk(KERN_WARNING "workqueue: max_active %d requested for %s "
3253b71ab8c2STejun Heo 		       "is out of range, clamping between %d and %d\n",
3254f3421797STejun Heo 		       max_active, name, 1, lim);
3255b71ab8c2STejun Heo 
3256f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3257b71ab8c2STejun Heo }
3258b71ab8c2STejun Heo 
3259b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
326097e37d7bSTejun Heo 					       unsigned int flags,
32611e19ffc6STejun Heo 					       int max_active,
3262eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3263b196be89STejun Heo 					       const char *lock_name, ...)
32643af24433SOleg Nesterov {
3265b196be89STejun Heo 	va_list args, args1;
32663af24433SOleg Nesterov 	struct workqueue_struct *wq;
3267c34056a3STejun Heo 	unsigned int cpu;
3268b196be89STejun Heo 	size_t namelen;
3269b196be89STejun Heo 
3270b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3271b196be89STejun Heo 	va_start(args, lock_name);
3272b196be89STejun Heo 	va_copy(args1, args);
3273b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3274b196be89STejun Heo 
3275b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3276b196be89STejun Heo 	if (!wq)
3277b196be89STejun Heo 		goto err;
3278b196be89STejun Heo 
3279b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3280b196be89STejun Heo 	va_end(args);
3281b196be89STejun Heo 	va_end(args1);
32823af24433SOleg Nesterov 
3283f3421797STejun Heo 	/*
32846370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
32856370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
32866370a6adSTejun Heo 	 */
32876370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
32886370a6adSTejun Heo 		flags |= WQ_RESCUER;
32896370a6adSTejun Heo 
3290d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3291b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
32923af24433SOleg Nesterov 
3293b196be89STejun Heo 	/* init wq */
329497e37d7bSTejun Heo 	wq->flags = flags;
3295a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
329673f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
329773f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
329873f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
329973f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
33003af24433SOleg Nesterov 
3301eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3302cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
33033af24433SOleg Nesterov 
3304bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3305bdbc5dd7STejun Heo 		goto err;
3306bdbc5dd7STejun Heo 
3307f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
33081537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
33098b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
33103270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
33111537663fSTejun Heo 
33120f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
33133270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3314c34056a3STejun Heo 		cwq->wq = wq;
331573f53c4aSTejun Heo 		cwq->flush_color = -1;
33161e19ffc6STejun Heo 		cwq->max_active = max_active;
33171e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3318e22bee78STejun Heo 	}
33191537663fSTejun Heo 
3320e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3321e22bee78STejun Heo 		struct worker *rescuer;
3322e22bee78STejun Heo 
3323f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3324e22bee78STejun Heo 			goto err;
3325e22bee78STejun Heo 
3326e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3327e22bee78STejun Heo 		if (!rescuer)
3328e22bee78STejun Heo 			goto err;
3329e22bee78STejun Heo 
3330b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3331b196be89STejun Heo 					       wq->name);
3332e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3333e22bee78STejun Heo 			goto err;
3334e22bee78STejun Heo 
3335e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3336e22bee78STejun Heo 		wake_up_process(rescuer->task);
33373af24433SOleg Nesterov 	}
33381537663fSTejun Heo 
33393af24433SOleg Nesterov 	/*
3340a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3341a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3342a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
33433af24433SOleg Nesterov 	 */
33443af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3345a0a1a5fdSTejun Heo 
334658a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3347f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3348a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3349a0a1a5fdSTejun Heo 
33503af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3351a0a1a5fdSTejun Heo 
33523af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
33533af24433SOleg Nesterov 
33543af24433SOleg Nesterov 	return wq;
33554690c4abSTejun Heo err:
33564690c4abSTejun Heo 	if (wq) {
3357bdbc5dd7STejun Heo 		free_cwqs(wq);
3358f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3359e22bee78STejun Heo 		kfree(wq->rescuer);
33604690c4abSTejun Heo 		kfree(wq);
33613af24433SOleg Nesterov 	}
33624690c4abSTejun Heo 	return NULL;
33631da177e4SLinus Torvalds }
3364d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
33651da177e4SLinus Torvalds 
33663af24433SOleg Nesterov /**
33673af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
33683af24433SOleg Nesterov  * @wq: target workqueue
33693af24433SOleg Nesterov  *
33703af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
33713af24433SOleg Nesterov  */
33723af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
33733af24433SOleg Nesterov {
3374c8e55f36STejun Heo 	unsigned int cpu;
33753af24433SOleg Nesterov 
33769c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
33779c5a2ba7STejun Heo 	drain_workqueue(wq);
3378c8efcc25STejun Heo 
3379a0a1a5fdSTejun Heo 	/*
3380a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3381a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3382a0a1a5fdSTejun Heo 	 */
338395402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
33843af24433SOleg Nesterov 	list_del(&wq->list);
338595402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
33863af24433SOleg Nesterov 
3387e22bee78STejun Heo 	/* sanity check */
3388f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
338973f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
339073f53c4aSTejun Heo 		int i;
33913af24433SOleg Nesterov 
339273f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
339373f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
33941e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
33951e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
339673f53c4aSTejun Heo 	}
33971537663fSTejun Heo 
3398e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3399e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3400f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
34018d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3402e22bee78STejun Heo 	}
3403e22bee78STejun Heo 
3404bdbc5dd7STejun Heo 	free_cwqs(wq);
34053af24433SOleg Nesterov 	kfree(wq);
34063af24433SOleg Nesterov }
34073af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
34083af24433SOleg Nesterov 
3409dcd989cbSTejun Heo /**
3410dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3411dcd989cbSTejun Heo  * @wq: target workqueue
3412dcd989cbSTejun Heo  * @max_active: new max_active value.
3413dcd989cbSTejun Heo  *
3414dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3415dcd989cbSTejun Heo  *
3416dcd989cbSTejun Heo  * CONTEXT:
3417dcd989cbSTejun Heo  * Don't call from IRQ context.
3418dcd989cbSTejun Heo  */
3419dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3420dcd989cbSTejun Heo {
3421dcd989cbSTejun Heo 	unsigned int cpu;
3422dcd989cbSTejun Heo 
3423f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3424dcd989cbSTejun Heo 
3425dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3426dcd989cbSTejun Heo 
3427dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3428dcd989cbSTejun Heo 
3429f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3430dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3431dcd989cbSTejun Heo 
3432dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3433dcd989cbSTejun Heo 
343458a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3435dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3436dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3437dcd989cbSTejun Heo 
3438dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3439dcd989cbSTejun Heo 	}
3440dcd989cbSTejun Heo 
3441dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3442dcd989cbSTejun Heo }
3443dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3444dcd989cbSTejun Heo 
3445dcd989cbSTejun Heo /**
3446dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3447dcd989cbSTejun Heo  * @cpu: CPU in question
3448dcd989cbSTejun Heo  * @wq: target workqueue
3449dcd989cbSTejun Heo  *
3450dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3451dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3452dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3453dcd989cbSTejun Heo  *
3454dcd989cbSTejun Heo  * RETURNS:
3455dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3456dcd989cbSTejun Heo  */
3457dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3458dcd989cbSTejun Heo {
3459dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3460dcd989cbSTejun Heo 
3461dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3462dcd989cbSTejun Heo }
3463dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3464dcd989cbSTejun Heo 
3465dcd989cbSTejun Heo /**
3466dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3467dcd989cbSTejun Heo  * @work: the work of interest
3468dcd989cbSTejun Heo  *
3469dcd989cbSTejun Heo  * RETURNS:
3470bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3471dcd989cbSTejun Heo  */
3472dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3473dcd989cbSTejun Heo {
3474dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3475dcd989cbSTejun Heo 
3476bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3477dcd989cbSTejun Heo }
3478dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3479dcd989cbSTejun Heo 
3480dcd989cbSTejun Heo /**
3481dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3482dcd989cbSTejun Heo  * @work: the work to be tested
3483dcd989cbSTejun Heo  *
3484dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3485dcd989cbSTejun Heo  * synchronization around this function and the test result is
3486dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3487dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3488dcd989cbSTejun Heo  * running state.
3489dcd989cbSTejun Heo  *
3490dcd989cbSTejun Heo  * RETURNS:
3491dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3492dcd989cbSTejun Heo  */
3493dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3494dcd989cbSTejun Heo {
3495dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3496dcd989cbSTejun Heo 	unsigned long flags;
3497dcd989cbSTejun Heo 	unsigned int ret = 0;
3498dcd989cbSTejun Heo 
3499dcd989cbSTejun Heo 	if (!gcwq)
3500dcd989cbSTejun Heo 		return false;
3501dcd989cbSTejun Heo 
3502dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3503dcd989cbSTejun Heo 
3504dcd989cbSTejun Heo 	if (work_pending(work))
3505dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3506dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3507dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3508dcd989cbSTejun Heo 
3509dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3510dcd989cbSTejun Heo 
3511dcd989cbSTejun Heo 	return ret;
3512dcd989cbSTejun Heo }
3513dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3514dcd989cbSTejun Heo 
3515db7bccf4STejun Heo /*
3516db7bccf4STejun Heo  * CPU hotplug.
3517db7bccf4STejun Heo  *
3518e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3519e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3520e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3521e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3522e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3523e22bee78STejun Heo  * blocked draining impractical.
3524e22bee78STejun Heo  *
3525628c78e7STejun Heo  * This is solved by allowing a gcwq to be disassociated from the CPU
3526628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
3527628c78e7STejun Heo  * cpu comes back online.
3528db7bccf4STejun Heo  */
3529db7bccf4STejun Heo 
353060373152STejun Heo /* claim manager positions of all pools */
35318db25e78STejun Heo static void gcwq_claim_management_and_lock(struct global_cwq *gcwq)
353260373152STejun Heo {
353360373152STejun Heo 	struct worker_pool *pool;
353460373152STejun Heo 
353560373152STejun Heo 	for_each_worker_pool(pool, gcwq)
353660373152STejun Heo 		mutex_lock_nested(&pool->manager_mutex, pool - gcwq->pools);
35378db25e78STejun Heo 	spin_lock_irq(&gcwq->lock);
353860373152STejun Heo }
353960373152STejun Heo 
354060373152STejun Heo /* release manager positions */
35418db25e78STejun Heo static void gcwq_release_management_and_unlock(struct global_cwq *gcwq)
354260373152STejun Heo {
354360373152STejun Heo 	struct worker_pool *pool;
354460373152STejun Heo 
35458db25e78STejun Heo 	spin_unlock_irq(&gcwq->lock);
354660373152STejun Heo 	for_each_worker_pool(pool, gcwq)
354760373152STejun Heo 		mutex_unlock(&pool->manager_mutex);
354860373152STejun Heo }
354960373152STejun Heo 
3550628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work)
3551db7bccf4STejun Heo {
3552628c78e7STejun Heo 	struct global_cwq *gcwq = get_gcwq(smp_processor_id());
35534ce62e9eSTejun Heo 	struct worker_pool *pool;
3554db7bccf4STejun Heo 	struct worker *worker;
3555db7bccf4STejun Heo 	struct hlist_node *pos;
3556db7bccf4STejun Heo 	int i;
3557db7bccf4STejun Heo 
3558db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3559db7bccf4STejun Heo 
35608db25e78STejun Heo 	gcwq_claim_management_and_lock(gcwq);
3561e22bee78STejun Heo 
3562f2d5a0eeSTejun Heo 	/*
3563f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3564f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3565f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3566f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3567f2d5a0eeSTejun Heo 	 */
356860373152STejun Heo 	for_each_worker_pool(pool, gcwq)
35694ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3570403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3571db7bccf4STejun Heo 
3572db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3573403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3574db7bccf4STejun Heo 
3575f2d5a0eeSTejun Heo 	gcwq->flags |= GCWQ_DISASSOCIATED;
3576f2d5a0eeSTejun Heo 
35778db25e78STejun Heo 	gcwq_release_management_and_unlock(gcwq);
3578e22bee78STejun Heo 
3579e22bee78STejun Heo 	/*
3580628c78e7STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3581628c78e7STejun Heo 	 * sched callbacks see the %WORKER_UNBOUND flag.  This is necessary
3582628c78e7STejun Heo 	 * as scheduler callbacks may be invoked from other cpus.
3583628c78e7STejun Heo 	 */
3584628c78e7STejun Heo 	schedule();
3585628c78e7STejun Heo 
3586628c78e7STejun Heo 	/*
3587628c78e7STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After this,
3588628c78e7STejun Heo 	 * nr_running stays zero and need_more_worker() and keep_working()
3589628c78e7STejun Heo 	 * are always true as long as the worklist is not empty.  @gcwq now
3590628c78e7STejun Heo 	 * behaves as unbound (in terms of concurrency management) gcwq
3591628c78e7STejun Heo 	 * which is served by workers tied to the CPU.
3592628c78e7STejun Heo 	 *
3593628c78e7STejun Heo 	 * On return from this function, the current worker would trigger
3594628c78e7STejun Heo 	 * unbound chain execution of pending work items if other workers
3595628c78e7STejun Heo 	 * didn't already.
3596e22bee78STejun Heo 	 */
35974ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35984ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3599db7bccf4STejun Heo }
3600db7bccf4STejun Heo 
36018db25e78STejun Heo /*
36028db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
36038db25e78STejun Heo  * This will be registered high priority CPU notifier.
36048db25e78STejun Heo  */
36058db25e78STejun Heo static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
36061da177e4SLinus Torvalds 					       unsigned long action,
36071da177e4SLinus Torvalds 					       void *hcpu)
36081da177e4SLinus Torvalds {
36093af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3610db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
36114ce62e9eSTejun Heo 	struct worker_pool *pool;
36121da177e4SLinus Torvalds 
36138db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
36143af24433SOleg Nesterov 	case CPU_UP_PREPARE:
36154ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
36163ce63377STejun Heo 			struct worker *worker;
36173ce63377STejun Heo 
36183ce63377STejun Heo 			if (pool->nr_workers)
36193ce63377STejun Heo 				continue;
36203ce63377STejun Heo 
36213ce63377STejun Heo 			worker = create_worker(pool);
36223ce63377STejun Heo 			if (!worker)
36233ce63377STejun Heo 				return NOTIFY_BAD;
36243ce63377STejun Heo 
36253ce63377STejun Heo 			spin_lock_irq(&gcwq->lock);
36263ce63377STejun Heo 			start_worker(worker);
36273ce63377STejun Heo 			spin_unlock_irq(&gcwq->lock);
36283af24433SOleg Nesterov 		}
36291da177e4SLinus Torvalds 		break;
36301da177e4SLinus Torvalds 
363165758202STejun Heo 	case CPU_DOWN_FAILED:
363265758202STejun Heo 	case CPU_ONLINE:
36338db25e78STejun Heo 		gcwq_claim_management_and_lock(gcwq);
36348db25e78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
36358db25e78STejun Heo 		rebind_workers(gcwq);
36368db25e78STejun Heo 		gcwq_release_management_and_unlock(gcwq);
36378db25e78STejun Heo 		break;
363865758202STejun Heo 	}
363965758202STejun Heo 	return NOTIFY_OK;
364065758202STejun Heo }
364165758202STejun Heo 
364265758202STejun Heo /*
364365758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
364465758202STejun Heo  * This will be registered as low priority CPU notifier.
364565758202STejun Heo  */
364665758202STejun Heo static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
364765758202STejun Heo 						 unsigned long action,
364865758202STejun Heo 						 void *hcpu)
364965758202STejun Heo {
36508db25e78STejun Heo 	unsigned int cpu = (unsigned long)hcpu;
36518db25e78STejun Heo 	struct work_struct unbind_work;
36528db25e78STejun Heo 
365365758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
365465758202STejun Heo 	case CPU_DOWN_PREPARE:
36558db25e78STejun Heo 		/* unbinding should happen on the local CPU */
36568db25e78STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
36578db25e78STejun Heo 		schedule_work_on(cpu, &unbind_work);
36588db25e78STejun Heo 		flush_work(&unbind_work);
36598db25e78STejun Heo 		break;
366065758202STejun Heo 	}
366165758202STejun Heo 	return NOTIFY_OK;
366265758202STejun Heo }
366365758202STejun Heo 
36642d3854a3SRusty Russell #ifdef CONFIG_SMP
36658ccad40dSRusty Russell 
36662d3854a3SRusty Russell struct work_for_cpu {
36676b44003eSAndrew Morton 	struct completion completion;
36682d3854a3SRusty Russell 	long (*fn)(void *);
36692d3854a3SRusty Russell 	void *arg;
36702d3854a3SRusty Russell 	long ret;
36712d3854a3SRusty Russell };
36722d3854a3SRusty Russell 
36736b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
36742d3854a3SRusty Russell {
36756b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
36762d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36776b44003eSAndrew Morton 	complete(&wfc->completion);
36786b44003eSAndrew Morton 	return 0;
36792d3854a3SRusty Russell }
36802d3854a3SRusty Russell 
36812d3854a3SRusty Russell /**
36822d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36832d3854a3SRusty Russell  * @cpu: the cpu to run on
36842d3854a3SRusty Russell  * @fn: the function to run
36852d3854a3SRusty Russell  * @arg: the function arg
36862d3854a3SRusty Russell  *
368731ad9081SRusty Russell  * This will return the value @fn returns.
368831ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36896b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36902d3854a3SRusty Russell  */
36912d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36922d3854a3SRusty Russell {
36936b44003eSAndrew Morton 	struct task_struct *sub_thread;
36946b44003eSAndrew Morton 	struct work_for_cpu wfc = {
36956b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
36966b44003eSAndrew Morton 		.fn = fn,
36976b44003eSAndrew Morton 		.arg = arg,
36986b44003eSAndrew Morton 	};
36992d3854a3SRusty Russell 
37006b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
37016b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
37026b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
37036b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
37046b44003eSAndrew Morton 	wake_up_process(sub_thread);
37056b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
37062d3854a3SRusty Russell 	return wfc.ret;
37072d3854a3SRusty Russell }
37082d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
37092d3854a3SRusty Russell #endif /* CONFIG_SMP */
37102d3854a3SRusty Russell 
3711a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3712e7577c50SRusty Russell 
3713a0a1a5fdSTejun Heo /**
3714a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3715a0a1a5fdSTejun Heo  *
371658a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
371758a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
371858a69cb4STejun Heo  * gcwq->worklist.
3719a0a1a5fdSTejun Heo  *
3720a0a1a5fdSTejun Heo  * CONTEXT:
37218b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3722a0a1a5fdSTejun Heo  */
3723a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3724a0a1a5fdSTejun Heo {
3725a0a1a5fdSTejun Heo 	unsigned int cpu;
3726a0a1a5fdSTejun Heo 
3727a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3728a0a1a5fdSTejun Heo 
3729a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3730a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3731a0a1a5fdSTejun Heo 
3732f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37338b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3734bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37358b03ae3cSTejun Heo 
37368b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37378b03ae3cSTejun Heo 
3738db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3739db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3740db7bccf4STejun Heo 
3741a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3742a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3743a0a1a5fdSTejun Heo 
374458a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3745a0a1a5fdSTejun Heo 				cwq->max_active = 0;
37461da177e4SLinus Torvalds 		}
37478b03ae3cSTejun Heo 
37488b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3749a0a1a5fdSTejun Heo 	}
3750a0a1a5fdSTejun Heo 
3751a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3752a0a1a5fdSTejun Heo }
3753a0a1a5fdSTejun Heo 
3754a0a1a5fdSTejun Heo /**
375558a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3756a0a1a5fdSTejun Heo  *
3757a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3758a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3759a0a1a5fdSTejun Heo  *
3760a0a1a5fdSTejun Heo  * CONTEXT:
3761a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3762a0a1a5fdSTejun Heo  *
3763a0a1a5fdSTejun Heo  * RETURNS:
376458a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
376558a69cb4STejun Heo  * is complete.
3766a0a1a5fdSTejun Heo  */
3767a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3768a0a1a5fdSTejun Heo {
3769a0a1a5fdSTejun Heo 	unsigned int cpu;
3770a0a1a5fdSTejun Heo 	bool busy = false;
3771a0a1a5fdSTejun Heo 
3772a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3773a0a1a5fdSTejun Heo 
3774a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3775a0a1a5fdSTejun Heo 
3776f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3777bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3778a0a1a5fdSTejun Heo 		/*
3779a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3780a0a1a5fdSTejun Heo 		 * to peek without lock.
3781a0a1a5fdSTejun Heo 		 */
3782a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3783a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3784a0a1a5fdSTejun Heo 
378558a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3786a0a1a5fdSTejun Heo 				continue;
3787a0a1a5fdSTejun Heo 
3788a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3789a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3790a0a1a5fdSTejun Heo 				busy = true;
3791a0a1a5fdSTejun Heo 				goto out_unlock;
3792a0a1a5fdSTejun Heo 			}
3793a0a1a5fdSTejun Heo 		}
3794a0a1a5fdSTejun Heo 	}
3795a0a1a5fdSTejun Heo out_unlock:
3796a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3797a0a1a5fdSTejun Heo 	return busy;
3798a0a1a5fdSTejun Heo }
3799a0a1a5fdSTejun Heo 
3800a0a1a5fdSTejun Heo /**
3801a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3802a0a1a5fdSTejun Heo  *
3803a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
38047e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3805a0a1a5fdSTejun Heo  *
3806a0a1a5fdSTejun Heo  * CONTEXT:
38078b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3808a0a1a5fdSTejun Heo  */
3809a0a1a5fdSTejun Heo void thaw_workqueues(void)
3810a0a1a5fdSTejun Heo {
3811a0a1a5fdSTejun Heo 	unsigned int cpu;
3812a0a1a5fdSTejun Heo 
3813a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3814a0a1a5fdSTejun Heo 
3815a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3816a0a1a5fdSTejun Heo 		goto out_unlock;
3817a0a1a5fdSTejun Heo 
3818f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38198b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38204ce62e9eSTejun Heo 		struct worker_pool *pool;
3821bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
38228b03ae3cSTejun Heo 
38238b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
38248b03ae3cSTejun Heo 
3825db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3826db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3827db7bccf4STejun Heo 
3828a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3829a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3830a0a1a5fdSTejun Heo 
383158a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3832a0a1a5fdSTejun Heo 				continue;
3833a0a1a5fdSTejun Heo 
3834a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3835a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3836a0a1a5fdSTejun Heo 
3837a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3838a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3839a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3840a0a1a5fdSTejun Heo 		}
38418b03ae3cSTejun Heo 
38424ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
38434ce62e9eSTejun Heo 			wake_up_worker(pool);
3844e22bee78STejun Heo 
38458b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3846a0a1a5fdSTejun Heo 	}
3847a0a1a5fdSTejun Heo 
3848a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3849a0a1a5fdSTejun Heo out_unlock:
3850a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3851a0a1a5fdSTejun Heo }
3852a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3853a0a1a5fdSTejun Heo 
38546ee0578bSSuresh Siddha static int __init init_workqueues(void)
38551da177e4SLinus Torvalds {
3856c34056a3STejun Heo 	unsigned int cpu;
3857c8e55f36STejun Heo 	int i;
3858c34056a3STejun Heo 
3859b5490077STejun Heo 	/* make sure we have enough bits for OFFQ CPU number */
3860b5490077STejun Heo 	BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3861b5490077STejun Heo 		     WORK_CPU_LAST);
3862b5490077STejun Heo 
386365758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
386465758202STejun Heo 	cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
38658b03ae3cSTejun Heo 
38668b03ae3cSTejun Heo 	/* initialize gcwqs */
3867f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38688b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38694ce62e9eSTejun Heo 		struct worker_pool *pool;
38708b03ae3cSTejun Heo 
38718b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
38728b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3873f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
38748b03ae3cSTejun Heo 
3875c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3876c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3877c8e55f36STejun Heo 
38784ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38794ce62e9eSTejun Heo 			pool->gcwq = gcwq;
38804ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38814ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3882e22bee78STejun Heo 
38834ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38844ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38854ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3886e22bee78STejun Heo 
38874ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38884ce62e9eSTejun Heo 				    (unsigned long)pool);
38894ce62e9eSTejun Heo 
389060373152STejun Heo 			mutex_init(&pool->manager_mutex);
38914ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38924ce62e9eSTejun Heo 		}
3893db7bccf4STejun Heo 
389425511a47STejun Heo 		init_waitqueue_head(&gcwq->rebind_hold);
38958b03ae3cSTejun Heo 	}
38968b03ae3cSTejun Heo 
3897e22bee78STejun Heo 	/* create the initial worker */
3898f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3899e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
39004ce62e9eSTejun Heo 		struct worker_pool *pool;
3901e22bee78STejun Heo 
3902477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3903477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
39044ce62e9eSTejun Heo 
39054ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
39064ce62e9eSTejun Heo 			struct worker *worker;
39074ce62e9eSTejun Heo 
3908bc2ae0f5STejun Heo 			worker = create_worker(pool);
3909e22bee78STejun Heo 			BUG_ON(!worker);
3910e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3911e22bee78STejun Heo 			start_worker(worker);
3912e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3913e22bee78STejun Heo 		}
39144ce62e9eSTejun Heo 	}
3915e22bee78STejun Heo 
3916d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
3917d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3918d320c038STejun Heo 	system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3919f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3920f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
392124d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
392224d51addSTejun Heo 					      WQ_FREEZABLE, 0);
392362d3c543SAlan Stern 	system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
392462d3c543SAlan Stern 			WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
3925e5cba24eSHitoshi Mitake 	BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
392662d3c543SAlan Stern 	       !system_unbound_wq || !system_freezable_wq ||
392762d3c543SAlan Stern 		!system_nrt_freezable_wq);
39286ee0578bSSuresh Siddha 	return 0;
39291da177e4SLinus Torvalds }
39306ee0578bSSuresh Siddha early_initcall(init_workqueues);
3931