xref: /linux-6.15/kernel/workqueue.c (revision f2d5a0ee)
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 {
48db7bccf4STejun Heo 	/* global_cwq flags */
4911ebea50STejun Heo 	GCWQ_DISASSOCIATED	= 1 << 0,	/* cpu can't serve workers */
5011ebea50STejun Heo 	GCWQ_FREEZING		= 1 << 1,	/* freeze in progress */
5111ebea50STejun Heo 
5211ebea50STejun Heo 	/* pool flags */
5311ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
5411ebea50STejun Heo 	POOL_MANAGING_WORKERS	= 1 << 1,	/* managing workers */
55db7bccf4STejun Heo 
56c8e55f36STejun Heo 	/* worker flags */
57c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
58c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
59c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
60e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
61db7bccf4STejun Heo 	WORKER_ROGUE		= 1 << 4,	/* not bound to any cpu */
62e22bee78STejun Heo 	WORKER_REBIND		= 1 << 5,	/* mom is home, come back */
63fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
64f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
65e22bee78STejun Heo 
66fb0e7bebSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
67f3421797STejun Heo 				  WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
68db7bccf4STejun Heo 
69db7bccf4STejun Heo 	/* gcwq->trustee_state */
70db7bccf4STejun Heo 	TRUSTEE_START		= 0,		/* start */
71db7bccf4STejun Heo 	TRUSTEE_IN_CHARGE	= 1,		/* trustee in charge of gcwq */
72db7bccf4STejun Heo 	TRUSTEE_BUTCHER		= 2,		/* butcher workers */
73db7bccf4STejun Heo 	TRUSTEE_RELEASE		= 3,		/* release workers */
74db7bccf4STejun Heo 	TRUSTEE_DONE		= 4,		/* trustee is done */
75c8e55f36STejun Heo 
763270476aSTejun Heo 	NR_WORKER_POOLS		= 2,		/* # worker pools per gcwq */
774ce62e9eSTejun Heo 
78c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
79c8e55f36STejun Heo 	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
80c8e55f36STejun Heo 	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
81db7bccf4STejun Heo 
82e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
83e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
84e22bee78STejun Heo 
853233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
863233cdbdSTejun Heo 						/* call for help after 10ms
873233cdbdSTejun Heo 						   (min two ticks) */
88e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
89e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
90db7bccf4STejun Heo 	TRUSTEE_COOLDOWN	= HZ / 10,	/* for trustee draining */
911da177e4SLinus Torvalds 
921da177e4SLinus Torvalds 	/*
93e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
94e22bee78STejun Heo 	 * all cpus.  Give -20.
95e22bee78STejun Heo 	 */
96e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
973270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
98c8e55f36STejun Heo };
99c8e55f36STejun Heo 
1001da177e4SLinus Torvalds /*
1014690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1024690c4abSTejun Heo  *
103e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
104e41e704bSTejun Heo  *    everyone else.
1054690c4abSTejun Heo  *
106e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
107e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
108e22bee78STejun Heo  *
1098b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1104690c4abSTejun Heo  *
111e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
112e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
113e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
114f3421797STejun Heo  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
115e22bee78STejun Heo  *
11673f53c4aSTejun Heo  * F: wq->flush_mutex protected.
11773f53c4aSTejun Heo  *
1184690c4abSTejun Heo  * W: workqueue_lock protected.
1194690c4abSTejun Heo  */
1204690c4abSTejun Heo 
1218b03ae3cSTejun Heo struct global_cwq;
122bd7bdd43STejun Heo struct worker_pool;
123c34056a3STejun Heo 
124e22bee78STejun Heo /*
125e22bee78STejun Heo  * The poor guys doing the actual heavy lifting.  All on-duty workers
126e22bee78STejun Heo  * are either serving the manager role, on idle list or on busy hash.
127e22bee78STejun Heo  */
128c34056a3STejun Heo struct worker {
129c8e55f36STejun Heo 	/* on idle list while idle, on busy hash table while busy */
130c8e55f36STejun Heo 	union {
131c8e55f36STejun Heo 		struct list_head	entry;	/* L: while idle */
132c8e55f36STejun Heo 		struct hlist_node	hentry;	/* L: while busy */
133c8e55f36STejun Heo 	};
134c8e55f36STejun Heo 
135c34056a3STejun Heo 	struct work_struct	*current_work;	/* L: work being processed */
1368cca0eeaSTejun Heo 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
137affee4b2STejun Heo 	struct list_head	scheduled;	/* L: scheduled works */
138c34056a3STejun Heo 	struct task_struct	*task;		/* I: worker task */
139bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
140e22bee78STejun Heo 	/* 64 bytes boundary on 64bit, 32 on 32bit */
141e22bee78STejun Heo 	unsigned long		last_active;	/* L: last active timestamp */
142e22bee78STejun Heo 	unsigned int		flags;		/* X: flags */
143c34056a3STejun Heo 	int			id;		/* I: worker id */
144e22bee78STejun Heo 	struct work_struct	rebind_work;	/* L: rebind worker to cpu */
145c34056a3STejun Heo };
146c34056a3STejun Heo 
147bd7bdd43STejun Heo struct worker_pool {
148bd7bdd43STejun Heo 	struct global_cwq	*gcwq;		/* I: the owning gcwq */
14911ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
150bd7bdd43STejun Heo 
151bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
152bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
153bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
154bd7bdd43STejun Heo 
155bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
156bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
157bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
158bd7bdd43STejun Heo 
159bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
160bd7bdd43STejun Heo 	struct worker		*first_idle;	/* L: first idle worker */
161bd7bdd43STejun Heo };
162bd7bdd43STejun Heo 
1634690c4abSTejun Heo /*
164e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
165e22bee78STejun Heo  * and all works are queued and processed here regardless of their
166e22bee78STejun Heo  * target workqueues.
1678b03ae3cSTejun Heo  */
1688b03ae3cSTejun Heo struct global_cwq {
1698b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1708b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
171db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
172c8e55f36STejun Heo 
173bd7bdd43STejun Heo 	/* workers are chained either in busy_hash or pool idle_list */
174c8e55f36STejun Heo 	struct hlist_head	busy_hash[BUSY_WORKER_HASH_SIZE];
175c8e55f36STejun Heo 						/* L: hash of busy workers */
176c8e55f36STejun Heo 
1773270476aSTejun Heo 	struct worker_pool	pools[2];	/* normal and highpri pools */
178db7bccf4STejun Heo 
179db7bccf4STejun Heo 	struct task_struct	*trustee;	/* L: for gcwq shutdown */
180db7bccf4STejun Heo 	unsigned int		trustee_state;	/* L: trustee state */
181db7bccf4STejun Heo 	wait_queue_head_t	trustee_wait;	/* trustee wait */
1828b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1838b03ae3cSTejun Heo 
1848b03ae3cSTejun Heo /*
185502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1860f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1870f900049STejun Heo  * aligned at two's power of the number of flag bits.
1881da177e4SLinus Torvalds  */
1891da177e4SLinus Torvalds struct cpu_workqueue_struct {
190bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1914690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
19273f53c4aSTejun Heo 	int			work_color;	/* L: current color */
19373f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
19473f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
19573f53c4aSTejun Heo 						/* L: nr of in_flight works */
1961e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
197a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
1981e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
1990f900049STejun Heo };
2001da177e4SLinus Torvalds 
2011da177e4SLinus Torvalds /*
20273f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
20373f53c4aSTejun Heo  */
20473f53c4aSTejun Heo struct wq_flusher {
20573f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
20673f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
20773f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
20873f53c4aSTejun Heo };
2091da177e4SLinus Torvalds 
21073f53c4aSTejun Heo /*
211f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
212f2e005aaSTejun Heo  * used to determine whether there's something to be done.
213f2e005aaSTejun Heo  */
214f2e005aaSTejun Heo #ifdef CONFIG_SMP
215f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
216f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
217f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
218f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
219f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2209c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
221f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
222f2e005aaSTejun Heo #else
223f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
224f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
225f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
226f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
227f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
228f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
229f2e005aaSTejun Heo #endif
2301da177e4SLinus Torvalds 
2311da177e4SLinus Torvalds /*
2321da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2331da177e4SLinus Torvalds  * per-CPU workqueues:
2341da177e4SLinus Torvalds  */
2351da177e4SLinus Torvalds struct workqueue_struct {
2369c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
237bdbc5dd7STejun Heo 	union {
238bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
239bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
240bdbc5dd7STejun Heo 		unsigned long				v;
241bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2424690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
24373f53c4aSTejun Heo 
24473f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
24573f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
24673f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
24773f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
24873f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
24973f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
25073f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
25173f53c4aSTejun Heo 
252f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
253e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
254e22bee78STejun Heo 
2559c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
256dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2574e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2584e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2594e6045f1SJohannes Berg #endif
260b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2611da177e4SLinus Torvalds };
2621da177e4SLinus Torvalds 
263d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
264d320c038STejun Heo struct workqueue_struct *system_long_wq __read_mostly;
265d320c038STejun Heo struct workqueue_struct *system_nrt_wq __read_mostly;
266f3421797STejun Heo struct workqueue_struct *system_unbound_wq __read_mostly;
26724d51addSTejun Heo struct workqueue_struct *system_freezable_wq __read_mostly;
26862d3c543SAlan Stern struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
269d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
270d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
271d320c038STejun Heo EXPORT_SYMBOL_GPL(system_nrt_wq);
272f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
27324d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
27462d3c543SAlan Stern EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
275d320c038STejun Heo 
27697bd2347STejun Heo #define CREATE_TRACE_POINTS
27797bd2347STejun Heo #include <trace/events/workqueue.h>
27897bd2347STejun Heo 
2794ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
2803270476aSTejun Heo 	for ((pool) = &(gcwq)->pools[0];				\
2813270476aSTejun Heo 	     (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
2824ce62e9eSTejun Heo 
283db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
284db7bccf4STejun Heo 	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
285db7bccf4STejun Heo 		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
286db7bccf4STejun Heo 
287f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
288f3421797STejun Heo 				  unsigned int sw)
289f3421797STejun Heo {
290f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
291f3421797STejun Heo 		if (sw & 1) {
292f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
293f3421797STejun Heo 			if (cpu < nr_cpu_ids)
294f3421797STejun Heo 				return cpu;
295f3421797STejun Heo 		}
296f3421797STejun Heo 		if (sw & 2)
297f3421797STejun Heo 			return WORK_CPU_UNBOUND;
298f3421797STejun Heo 	}
299f3421797STejun Heo 	return WORK_CPU_NONE;
300f3421797STejun Heo }
301f3421797STejun Heo 
302f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
303f3421797STejun Heo 				struct workqueue_struct *wq)
304f3421797STejun Heo {
305f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
306f3421797STejun Heo }
307f3421797STejun Heo 
30809884951STejun Heo /*
30909884951STejun Heo  * CPU iterators
31009884951STejun Heo  *
31109884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
31209884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
31309884951STejun Heo  * specific CPU.  The following iterators are similar to
31409884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
31509884951STejun Heo  *
31609884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
31709884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
31809884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
31909884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
32009884951STejun Heo  */
321f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
322f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
323f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
324f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
325f3421797STejun Heo 
326f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
327f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
328f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
329f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
330f3421797STejun Heo 
331f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
332f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
333f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
334f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
335f3421797STejun Heo 
336dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
337dc186ad7SThomas Gleixner 
338dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
339dc186ad7SThomas Gleixner 
34099777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
34199777288SStanislaw Gruszka {
34299777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
34399777288SStanislaw Gruszka }
34499777288SStanislaw Gruszka 
345dc186ad7SThomas Gleixner /*
346dc186ad7SThomas Gleixner  * fixup_init is called when:
347dc186ad7SThomas Gleixner  * - an active object is initialized
348dc186ad7SThomas Gleixner  */
349dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
350dc186ad7SThomas Gleixner {
351dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
352dc186ad7SThomas Gleixner 
353dc186ad7SThomas Gleixner 	switch (state) {
354dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
355dc186ad7SThomas Gleixner 		cancel_work_sync(work);
356dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
357dc186ad7SThomas Gleixner 		return 1;
358dc186ad7SThomas Gleixner 	default:
359dc186ad7SThomas Gleixner 		return 0;
360dc186ad7SThomas Gleixner 	}
361dc186ad7SThomas Gleixner }
362dc186ad7SThomas Gleixner 
363dc186ad7SThomas Gleixner /*
364dc186ad7SThomas Gleixner  * fixup_activate is called when:
365dc186ad7SThomas Gleixner  * - an active object is activated
366dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
367dc186ad7SThomas Gleixner  */
368dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
369dc186ad7SThomas Gleixner {
370dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
371dc186ad7SThomas Gleixner 
372dc186ad7SThomas Gleixner 	switch (state) {
373dc186ad7SThomas Gleixner 
374dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
375dc186ad7SThomas Gleixner 		/*
376dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
377dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
378dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
379dc186ad7SThomas Gleixner 		 */
38022df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
381dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
382dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
383dc186ad7SThomas Gleixner 			return 0;
384dc186ad7SThomas Gleixner 		}
385dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
386dc186ad7SThomas Gleixner 		return 0;
387dc186ad7SThomas Gleixner 
388dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
389dc186ad7SThomas Gleixner 		WARN_ON(1);
390dc186ad7SThomas Gleixner 
391dc186ad7SThomas Gleixner 	default:
392dc186ad7SThomas Gleixner 		return 0;
393dc186ad7SThomas Gleixner 	}
394dc186ad7SThomas Gleixner }
395dc186ad7SThomas Gleixner 
396dc186ad7SThomas Gleixner /*
397dc186ad7SThomas Gleixner  * fixup_free is called when:
398dc186ad7SThomas Gleixner  * - an active object is freed
399dc186ad7SThomas Gleixner  */
400dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
401dc186ad7SThomas Gleixner {
402dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
403dc186ad7SThomas Gleixner 
404dc186ad7SThomas Gleixner 	switch (state) {
405dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
406dc186ad7SThomas Gleixner 		cancel_work_sync(work);
407dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
408dc186ad7SThomas Gleixner 		return 1;
409dc186ad7SThomas Gleixner 	default:
410dc186ad7SThomas Gleixner 		return 0;
411dc186ad7SThomas Gleixner 	}
412dc186ad7SThomas Gleixner }
413dc186ad7SThomas Gleixner 
414dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
415dc186ad7SThomas Gleixner 	.name		= "work_struct",
41699777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
417dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
418dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
419dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
420dc186ad7SThomas Gleixner };
421dc186ad7SThomas Gleixner 
422dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
423dc186ad7SThomas Gleixner {
424dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
425dc186ad7SThomas Gleixner }
426dc186ad7SThomas Gleixner 
427dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
428dc186ad7SThomas Gleixner {
429dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
430dc186ad7SThomas Gleixner }
431dc186ad7SThomas Gleixner 
432dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
433dc186ad7SThomas Gleixner {
434dc186ad7SThomas Gleixner 	if (onstack)
435dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
436dc186ad7SThomas Gleixner 	else
437dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
438dc186ad7SThomas Gleixner }
439dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
440dc186ad7SThomas Gleixner 
441dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
442dc186ad7SThomas Gleixner {
443dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
444dc186ad7SThomas Gleixner }
445dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
446dc186ad7SThomas Gleixner 
447dc186ad7SThomas Gleixner #else
448dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
449dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
450dc186ad7SThomas Gleixner #endif
451dc186ad7SThomas Gleixner 
45295402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
45395402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4541da177e4SLinus Torvalds static LIST_HEAD(workqueues);
455a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4561da177e4SLinus Torvalds 
45714441960SOleg Nesterov /*
458e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
459e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
460e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
46114441960SOleg Nesterov  */
4628b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
4634ce62e9eSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
464f756d5e2SNathan Lynch 
465f3421797STejun Heo /*
466f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
467f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
468f3421797STejun Heo  * workers have WORKER_UNBOUND set.
469f3421797STejun Heo  */
470f3421797STejun Heo static struct global_cwq unbound_global_cwq;
4714ce62e9eSTejun Heo static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
4724ce62e9eSTejun Heo 	[0 ... NR_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4734ce62e9eSTejun Heo };
474f3421797STejun Heo 
475c34056a3STejun Heo static int worker_thread(void *__worker);
4761da177e4SLinus Torvalds 
4773270476aSTejun Heo static int worker_pool_pri(struct worker_pool *pool)
4783270476aSTejun Heo {
4793270476aSTejun Heo 	return pool - pool->gcwq->pools;
4803270476aSTejun Heo }
4813270476aSTejun Heo 
4828b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4831da177e4SLinus Torvalds {
484f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4858b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
486f3421797STejun Heo 	else
487f3421797STejun Heo 		return &unbound_global_cwq;
4881da177e4SLinus Torvalds }
4891da177e4SLinus Torvalds 
49063d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
491b1f4ec17SOleg Nesterov {
49263d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
4933270476aSTejun Heo 	int idx = worker_pool_pri(pool);
49463d95a91STejun Heo 
495f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4964ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
497f3421797STejun Heo 	else
4984ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
499b1f4ec17SOleg Nesterov }
500b1f4ec17SOleg Nesterov 
5014690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
5024690c4abSTejun Heo 					    struct workqueue_struct *wq)
503a848e3b6SOleg Nesterov {
504f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
505e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
506bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
507f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
508f3421797STejun Heo 		return wq->cpu_wq.single;
509f3421797STejun Heo 	return NULL;
510f3421797STejun Heo }
511a848e3b6SOleg Nesterov 
51273f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
51373f53c4aSTejun Heo {
51473f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
51573f53c4aSTejun Heo }
51673f53c4aSTejun Heo 
51773f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
51873f53c4aSTejun Heo {
51973f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
52073f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
52173f53c4aSTejun Heo }
52273f53c4aSTejun Heo 
52373f53c4aSTejun Heo static int work_next_color(int color)
52473f53c4aSTejun Heo {
52573f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5261da177e4SLinus Torvalds }
5271da177e4SLinus Torvalds 
5284594bf15SDavid Howells /*
529e120153dSTejun Heo  * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
530e120153dSTejun Heo  * work is on queue.  Once execution starts, WORK_STRUCT_CWQ is
531e120153dSTejun Heo  * cleared and the work data contains the cpu number it was last on.
5327a22ad75STejun Heo  *
5337a22ad75STejun Heo  * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
5347a22ad75STejun Heo  * cwq, cpu or clear work->data.  These functions should only be
5357a22ad75STejun Heo  * called while the work is owned - ie. while the PENDING bit is set.
5367a22ad75STejun Heo  *
5377a22ad75STejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq
5387a22ad75STejun Heo  * corresponding to a work.  gcwq is available once the work has been
5397a22ad75STejun Heo  * queued anywhere after initialization.  cwq is available only from
5407a22ad75STejun Heo  * queueing until execution starts.
5414594bf15SDavid Howells  */
5427a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5437a22ad75STejun Heo 				 unsigned long flags)
5447a22ad75STejun Heo {
5457a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5467a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5477a22ad75STejun Heo }
5487a22ad75STejun Heo 
5497a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5504690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5514690c4abSTejun Heo 			 unsigned long extra_flags)
552365970a1SDavid Howells {
5537a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
554e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
555365970a1SDavid Howells }
556365970a1SDavid Howells 
5577a22ad75STejun Heo static void set_work_cpu(struct work_struct *work, unsigned int cpu)
5584d707b9fSOleg Nesterov {
5597a22ad75STejun Heo 	set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
5604d707b9fSOleg Nesterov }
5614d707b9fSOleg Nesterov 
5627a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
563365970a1SDavid Howells {
5647a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5657a22ad75STejun Heo }
5667a22ad75STejun Heo 
5677a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5687a22ad75STejun Heo {
569e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5707a22ad75STejun Heo 
571e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
572e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
573e120153dSTejun Heo 	else
574e120153dSTejun Heo 		return NULL;
5757a22ad75STejun Heo }
5767a22ad75STejun Heo 
5777a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5787a22ad75STejun Heo {
579e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5807a22ad75STejun Heo 	unsigned int cpu;
5817a22ad75STejun Heo 
582e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
583e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
584bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
5857a22ad75STejun Heo 
5867a22ad75STejun Heo 	cpu = data >> WORK_STRUCT_FLAG_BITS;
587bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
5887a22ad75STejun Heo 		return NULL;
5897a22ad75STejun Heo 
590f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
5917a22ad75STejun Heo 	return get_gcwq(cpu);
592365970a1SDavid Howells }
593365970a1SDavid Howells 
594e22bee78STejun Heo /*
5953270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
5963270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
5973270476aSTejun Heo  * they're being called with gcwq->lock held.
598e22bee78STejun Heo  */
599e22bee78STejun Heo 
60063d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
601649027d7STejun Heo {
6023270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
603649027d7STejun Heo }
604649027d7STejun Heo 
605e22bee78STejun Heo /*
606e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
607e22bee78STejun Heo  * running workers.
608974271c4STejun Heo  *
609974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
610974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
611974271c4STejun Heo  * worklist isn't empty.
612e22bee78STejun Heo  */
61363d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
614e22bee78STejun Heo {
61563d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
616e22bee78STejun Heo }
617e22bee78STejun Heo 
618e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
61963d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
620e22bee78STejun Heo {
62163d95a91STejun Heo 	return pool->nr_idle;
622e22bee78STejun Heo }
623e22bee78STejun Heo 
624e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
62563d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
626e22bee78STejun Heo {
62763d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
628e22bee78STejun Heo 
6293270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
630e22bee78STejun Heo }
631e22bee78STejun Heo 
632e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
63363d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
634e22bee78STejun Heo {
63563d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
636e22bee78STejun Heo }
637e22bee78STejun Heo 
638e22bee78STejun Heo /* Do I need to be the manager? */
63963d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
640e22bee78STejun Heo {
64163d95a91STejun Heo 	return need_to_create_worker(pool) ||
64211ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
643e22bee78STejun Heo }
644e22bee78STejun Heo 
645e22bee78STejun Heo /* Do we have too many workers and should some go away? */
64663d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
647e22bee78STejun Heo {
64811ebea50STejun Heo 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
64963d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
65063d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
651e22bee78STejun Heo 
652e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
653e22bee78STejun Heo }
654e22bee78STejun Heo 
655e22bee78STejun Heo /*
656e22bee78STejun Heo  * Wake up functions.
657e22bee78STejun Heo  */
658e22bee78STejun Heo 
6597e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
66063d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
6617e11629dSTejun Heo {
66263d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
6637e11629dSTejun Heo 		return NULL;
6647e11629dSTejun Heo 
66563d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
6667e11629dSTejun Heo }
6677e11629dSTejun Heo 
6687e11629dSTejun Heo /**
6697e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
67063d95a91STejun Heo  * @pool: worker pool to wake worker from
6717e11629dSTejun Heo  *
67263d95a91STejun Heo  * Wake up the first idle worker of @pool.
6737e11629dSTejun Heo  *
6747e11629dSTejun Heo  * CONTEXT:
6757e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
6767e11629dSTejun Heo  */
67763d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
6787e11629dSTejun Heo {
67963d95a91STejun Heo 	struct worker *worker = first_worker(pool);
6807e11629dSTejun Heo 
6817e11629dSTejun Heo 	if (likely(worker))
6827e11629dSTejun Heo 		wake_up_process(worker->task);
6837e11629dSTejun Heo }
6847e11629dSTejun Heo 
6854690c4abSTejun Heo /**
686e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
687e22bee78STejun Heo  * @task: task waking up
688e22bee78STejun Heo  * @cpu: CPU @task is waking up to
689e22bee78STejun Heo  *
690e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
691e22bee78STejun Heo  * being awoken.
692e22bee78STejun Heo  *
693e22bee78STejun Heo  * CONTEXT:
694e22bee78STejun Heo  * spin_lock_irq(rq->lock)
695e22bee78STejun Heo  */
696e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
697e22bee78STejun Heo {
698e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
699e22bee78STejun Heo 
7002d64672eSSteven Rostedt 	if (!(worker->flags & WORKER_NOT_RUNNING))
70163d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
702e22bee78STejun Heo }
703e22bee78STejun Heo 
704e22bee78STejun Heo /**
705e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
706e22bee78STejun Heo  * @task: task going to sleep
707e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
708e22bee78STejun Heo  *
709e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
710e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
711e22bee78STejun Heo  * returning pointer to its task.
712e22bee78STejun Heo  *
713e22bee78STejun Heo  * CONTEXT:
714e22bee78STejun Heo  * spin_lock_irq(rq->lock)
715e22bee78STejun Heo  *
716e22bee78STejun Heo  * RETURNS:
717e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
718e22bee78STejun Heo  */
719e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
720e22bee78STejun Heo 				       unsigned int cpu)
721e22bee78STejun Heo {
722e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
723bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
72463d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
725e22bee78STejun Heo 
7262d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
727e22bee78STejun Heo 		return NULL;
728e22bee78STejun Heo 
729e22bee78STejun Heo 	/* this can only happen on the local cpu */
730e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
731e22bee78STejun Heo 
732e22bee78STejun Heo 	/*
733e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
734e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
735e22bee78STejun Heo 	 * Please read comment there.
736e22bee78STejun Heo 	 *
737e22bee78STejun Heo 	 * NOT_RUNNING is clear.  This means that trustee is not in
738e22bee78STejun Heo 	 * charge and we're running on the local cpu w/ rq lock held
739e22bee78STejun Heo 	 * and preemption disabled, which in turn means that none else
740e22bee78STejun Heo 	 * could be manipulating idle_list, so dereferencing idle_list
741e22bee78STejun Heo 	 * without gcwq lock is safe.
742e22bee78STejun Heo 	 */
743bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
74463d95a91STejun Heo 		to_wakeup = first_worker(pool);
745e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
746e22bee78STejun Heo }
747e22bee78STejun Heo 
748e22bee78STejun Heo /**
749e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
750cb444766STejun Heo  * @worker: self
751d302f017STejun Heo  * @flags: flags to set
752d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
753d302f017STejun Heo  *
754e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
755e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
756e22bee78STejun Heo  * woken up.
757d302f017STejun Heo  *
758cb444766STejun Heo  * CONTEXT:
759cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
760d302f017STejun Heo  */
761d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
762d302f017STejun Heo 				    bool wakeup)
763d302f017STejun Heo {
764bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
765e22bee78STejun Heo 
766cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
767cb444766STejun Heo 
768e22bee78STejun Heo 	/*
769e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
770e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
771e22bee78STejun Heo 	 * @wakeup.
772e22bee78STejun Heo 	 */
773e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
774e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
77563d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
776e22bee78STejun Heo 
777e22bee78STejun Heo 		if (wakeup) {
778e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
779bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
78063d95a91STejun Heo 				wake_up_worker(pool);
781e22bee78STejun Heo 		} else
782e22bee78STejun Heo 			atomic_dec(nr_running);
783e22bee78STejun Heo 	}
784e22bee78STejun Heo 
785d302f017STejun Heo 	worker->flags |= flags;
786d302f017STejun Heo }
787d302f017STejun Heo 
788d302f017STejun Heo /**
789e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
790cb444766STejun Heo  * @worker: self
791d302f017STejun Heo  * @flags: flags to clear
792d302f017STejun Heo  *
793e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
794d302f017STejun Heo  *
795cb444766STejun Heo  * CONTEXT:
796cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
797d302f017STejun Heo  */
798d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
799d302f017STejun Heo {
80063d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
801e22bee78STejun Heo 	unsigned int oflags = worker->flags;
802e22bee78STejun Heo 
803cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
804cb444766STejun Heo 
805d302f017STejun Heo 	worker->flags &= ~flags;
806e22bee78STejun Heo 
80742c025f3STejun Heo 	/*
80842c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
80942c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
81042c025f3STejun Heo 	 * of multiple flags, not a single flag.
81142c025f3STejun Heo 	 */
812e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
813e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
81463d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
815d302f017STejun Heo }
816d302f017STejun Heo 
817d302f017STejun Heo /**
818c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
819c8e55f36STejun Heo  * @gcwq: gcwq of interest
820c8e55f36STejun Heo  * @work: work to be hashed
821c8e55f36STejun Heo  *
822c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
823c8e55f36STejun Heo  *
824c8e55f36STejun Heo  * CONTEXT:
825c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
826c8e55f36STejun Heo  *
827c8e55f36STejun Heo  * RETURNS:
828c8e55f36STejun Heo  * Pointer to the hash head.
829c8e55f36STejun Heo  */
830c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
831c8e55f36STejun Heo 					   struct work_struct *work)
832c8e55f36STejun Heo {
833c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
834c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
835c8e55f36STejun Heo 
836c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
837c8e55f36STejun Heo 	v >>= base_shift;
838c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
839c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
840c8e55f36STejun Heo 
841c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
842c8e55f36STejun Heo }
843c8e55f36STejun Heo 
844c8e55f36STejun Heo /**
8458cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
8468cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8478cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
8488cca0eeaSTejun Heo  * @work: work to find worker for
8498cca0eeaSTejun Heo  *
8508cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
8518cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
8528cca0eeaSTejun Heo  * work.
8538cca0eeaSTejun Heo  *
8548cca0eeaSTejun Heo  * CONTEXT:
8558cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8568cca0eeaSTejun Heo  *
8578cca0eeaSTejun Heo  * RETURNS:
8588cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8598cca0eeaSTejun Heo  * otherwise.
8608cca0eeaSTejun Heo  */
8618cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
8628cca0eeaSTejun Heo 						   struct hlist_head *bwh,
8638cca0eeaSTejun Heo 						   struct work_struct *work)
8648cca0eeaSTejun Heo {
8658cca0eeaSTejun Heo 	struct worker *worker;
8668cca0eeaSTejun Heo 	struct hlist_node *tmp;
8678cca0eeaSTejun Heo 
8688cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
8698cca0eeaSTejun Heo 		if (worker->current_work == work)
8708cca0eeaSTejun Heo 			return worker;
8718cca0eeaSTejun Heo 	return NULL;
8728cca0eeaSTejun Heo }
8738cca0eeaSTejun Heo 
8748cca0eeaSTejun Heo /**
8758cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8768cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8778cca0eeaSTejun Heo  * @work: work to find worker for
8788cca0eeaSTejun Heo  *
8798cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
8808cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
8818cca0eeaSTejun Heo  * function calculates @bwh itself.
8828cca0eeaSTejun Heo  *
8838cca0eeaSTejun Heo  * CONTEXT:
8848cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8858cca0eeaSTejun Heo  *
8868cca0eeaSTejun Heo  * RETURNS:
8878cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8888cca0eeaSTejun Heo  * otherwise.
8898cca0eeaSTejun Heo  */
8908cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8918cca0eeaSTejun Heo 						 struct work_struct *work)
8928cca0eeaSTejun Heo {
8938cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
8948cca0eeaSTejun Heo 					    work);
8958cca0eeaSTejun Heo }
8968cca0eeaSTejun Heo 
8978cca0eeaSTejun Heo /**
8987e11629dSTejun Heo  * insert_work - insert a work into gcwq
8994690c4abSTejun Heo  * @cwq: cwq @work belongs to
9004690c4abSTejun Heo  * @work: work to insert
9014690c4abSTejun Heo  * @head: insertion point
9024690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
9034690c4abSTejun Heo  *
9047e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
9057e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
9064690c4abSTejun Heo  *
9074690c4abSTejun Heo  * CONTEXT:
9088b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
9091da177e4SLinus Torvalds  */
910b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
9114690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
9124690c4abSTejun Heo 			unsigned int extra_flags)
913b89deed3SOleg Nesterov {
91463d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
915e1d8aa9fSFrederic Weisbecker 
9164690c4abSTejun Heo 	/* we own @work, set data and link */
9177a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
9184690c4abSTejun Heo 
9196e84d644SOleg Nesterov 	/*
9206e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
9216e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
9226e84d644SOleg Nesterov 	 */
9236e84d644SOleg Nesterov 	smp_wmb();
9244690c4abSTejun Heo 
9251a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
926e22bee78STejun Heo 
927e22bee78STejun Heo 	/*
928e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
929e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
930e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
931e22bee78STejun Heo 	 */
932e22bee78STejun Heo 	smp_mb();
933e22bee78STejun Heo 
93463d95a91STejun Heo 	if (__need_more_worker(pool))
93563d95a91STejun Heo 		wake_up_worker(pool);
936b89deed3SOleg Nesterov }
937b89deed3SOleg Nesterov 
938c8efcc25STejun Heo /*
939c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
940c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
941c8efcc25STejun Heo  * cold paths.
942c8efcc25STejun Heo  */
943c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
944c8efcc25STejun Heo {
945c8efcc25STejun Heo 	unsigned long flags;
946c8efcc25STejun Heo 	unsigned int cpu;
947c8efcc25STejun Heo 
948c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
949c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
950c8efcc25STejun Heo 		struct worker *worker;
951c8efcc25STejun Heo 		struct hlist_node *pos;
952c8efcc25STejun Heo 		int i;
953c8efcc25STejun Heo 
954c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
955c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
956c8efcc25STejun Heo 			if (worker->task != current)
957c8efcc25STejun Heo 				continue;
958c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
959c8efcc25STejun Heo 			/*
960c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
961c8efcc25STejun Heo 			 * is headed to the same workqueue.
962c8efcc25STejun Heo 			 */
963c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
964c8efcc25STejun Heo 		}
965c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
966c8efcc25STejun Heo 	}
967c8efcc25STejun Heo 	return false;
968c8efcc25STejun Heo }
969c8efcc25STejun Heo 
9704690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
9711da177e4SLinus Torvalds 			 struct work_struct *work)
9721da177e4SLinus Torvalds {
973502ca9d8STejun Heo 	struct global_cwq *gcwq;
974502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
9751e19ffc6STejun Heo 	struct list_head *worklist;
9768a2e8e5dSTejun Heo 	unsigned int work_flags;
9771da177e4SLinus Torvalds 	unsigned long flags;
9781da177e4SLinus Torvalds 
979dc186ad7SThomas Gleixner 	debug_work_activate(work);
9801e19ffc6STejun Heo 
981c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
9829c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
983c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
984e41e704bSTejun Heo 		return;
985e41e704bSTejun Heo 
986c7fc77f7STejun Heo 	/* determine gcwq to use */
987c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
988c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
989c7fc77f7STejun Heo 
990f3421797STejun Heo 		if (unlikely(cpu == WORK_CPU_UNBOUND))
991f3421797STejun Heo 			cpu = raw_smp_processor_id();
992f3421797STejun Heo 
99318aa9effSTejun Heo 		/*
99418aa9effSTejun Heo 		 * It's multi cpu.  If @wq is non-reentrant and @work
99518aa9effSTejun Heo 		 * was previously on a different cpu, it might still
99618aa9effSTejun Heo 		 * be running there, in which case the work needs to
99718aa9effSTejun Heo 		 * be queued on that cpu to guarantee non-reentrance.
99818aa9effSTejun Heo 		 */
999502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
100018aa9effSTejun Heo 		if (wq->flags & WQ_NON_REENTRANT &&
100118aa9effSTejun Heo 		    (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
100218aa9effSTejun Heo 			struct worker *worker;
100318aa9effSTejun Heo 
100418aa9effSTejun Heo 			spin_lock_irqsave(&last_gcwq->lock, flags);
100518aa9effSTejun Heo 
100618aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
100718aa9effSTejun Heo 
100818aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
100918aa9effSTejun Heo 				gcwq = last_gcwq;
101018aa9effSTejun Heo 			else {
101118aa9effSTejun Heo 				/* meh... not running there, queue here */
101218aa9effSTejun Heo 				spin_unlock_irqrestore(&last_gcwq->lock, flags);
101318aa9effSTejun Heo 				spin_lock_irqsave(&gcwq->lock, flags);
101418aa9effSTejun Heo 			}
101518aa9effSTejun Heo 		} else
10168b03ae3cSTejun Heo 			spin_lock_irqsave(&gcwq->lock, flags);
1017f3421797STejun Heo 	} else {
1018f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
1019f3421797STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1020502ca9d8STejun Heo 	}
1021502ca9d8STejun Heo 
1022502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1023502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1024cdadf009STejun Heo 	trace_workqueue_queue_work(cpu, cwq, work);
1025502ca9d8STejun Heo 
1026f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1027f5b2552bSDan Carpenter 		spin_unlock_irqrestore(&gcwq->lock, flags);
1028f5b2552bSDan Carpenter 		return;
1029f5b2552bSDan Carpenter 	}
10301e19ffc6STejun Heo 
103173f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
10328a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
10331e19ffc6STejun Heo 
10341e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1035cdadf009STejun Heo 		trace_workqueue_activate_work(work);
10361e19ffc6STejun Heo 		cwq->nr_active++;
10373270476aSTejun Heo 		worklist = &cwq->pool->worklist;
10388a2e8e5dSTejun Heo 	} else {
10398a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
10401e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
10418a2e8e5dSTejun Heo 	}
10421e19ffc6STejun Heo 
10438a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
10441e19ffc6STejun Heo 
10458b03ae3cSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
10461da177e4SLinus Torvalds }
10471da177e4SLinus Torvalds 
10480fcb78c2SRolf Eike Beer /**
10490fcb78c2SRolf Eike Beer  * queue_work - queue work on a workqueue
10500fcb78c2SRolf Eike Beer  * @wq: workqueue to use
10510fcb78c2SRolf Eike Beer  * @work: work to queue
10520fcb78c2SRolf Eike Beer  *
1053057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
10541da177e4SLinus Torvalds  *
105500dfcaf7SOleg Nesterov  * We queue the work to the CPU on which it was submitted, but if the CPU dies
105600dfcaf7SOleg Nesterov  * it can be processed by another CPU.
10571da177e4SLinus Torvalds  */
10587ad5b3a5SHarvey Harrison int queue_work(struct workqueue_struct *wq, struct work_struct *work)
10591da177e4SLinus Torvalds {
1060ef1ca236SOleg Nesterov 	int ret;
10611da177e4SLinus Torvalds 
1062ef1ca236SOleg Nesterov 	ret = queue_work_on(get_cpu(), wq, work);
1063a848e3b6SOleg Nesterov 	put_cpu();
1064ef1ca236SOleg Nesterov 
10651da177e4SLinus Torvalds 	return ret;
10661da177e4SLinus Torvalds }
1067ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_work);
10681da177e4SLinus Torvalds 
1069c1a220e7SZhang Rui /**
1070c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1071c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1072c1a220e7SZhang Rui  * @wq: workqueue to use
1073c1a220e7SZhang Rui  * @work: work to queue
1074c1a220e7SZhang Rui  *
1075c1a220e7SZhang Rui  * Returns 0 if @work was already on a queue, non-zero otherwise.
1076c1a220e7SZhang Rui  *
1077c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1078c1a220e7SZhang Rui  * can't go away.
1079c1a220e7SZhang Rui  */
1080c1a220e7SZhang Rui int
1081c1a220e7SZhang Rui queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1082c1a220e7SZhang Rui {
1083c1a220e7SZhang Rui 	int ret = 0;
1084c1a220e7SZhang Rui 
108522df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
10864690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1087c1a220e7SZhang Rui 		ret = 1;
1088c1a220e7SZhang Rui 	}
1089c1a220e7SZhang Rui 	return ret;
1090c1a220e7SZhang Rui }
1091c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1092c1a220e7SZhang Rui 
10936d141c3fSLi Zefan static void delayed_work_timer_fn(unsigned long __data)
10941da177e4SLinus Torvalds {
109552bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
10967a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
10971da177e4SLinus Torvalds 
10984690c4abSTejun Heo 	__queue_work(smp_processor_id(), cwq->wq, &dwork->work);
10991da177e4SLinus Torvalds }
11001da177e4SLinus Torvalds 
11010fcb78c2SRolf Eike Beer /**
11020fcb78c2SRolf Eike Beer  * queue_delayed_work - queue work on a workqueue after delay
11030fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1104af9997e4SRandy Dunlap  * @dwork: delayable work to queue
11050fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11060fcb78c2SRolf Eike Beer  *
1107057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11080fcb78c2SRolf Eike Beer  */
11097ad5b3a5SHarvey Harrison int queue_delayed_work(struct workqueue_struct *wq,
111052bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11111da177e4SLinus Torvalds {
111252bad64dSDavid Howells 	if (delay == 0)
111363bc0362SOleg Nesterov 		return queue_work(wq, &dwork->work);
11141da177e4SLinus Torvalds 
111563bc0362SOleg Nesterov 	return queue_delayed_work_on(-1, wq, dwork, delay);
11161da177e4SLinus Torvalds }
1117ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work);
11181da177e4SLinus Torvalds 
11190fcb78c2SRolf Eike Beer /**
11200fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
11210fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
11220fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1123af9997e4SRandy Dunlap  * @dwork: work to queue
11240fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11250fcb78c2SRolf Eike Beer  *
1126057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11270fcb78c2SRolf Eike Beer  */
11287a6bc1cdSVenkatesh Pallipadi int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
112952bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11307a6bc1cdSVenkatesh Pallipadi {
11317a6bc1cdSVenkatesh Pallipadi 	int ret = 0;
113252bad64dSDavid Howells 	struct timer_list *timer = &dwork->timer;
113352bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
11347a6bc1cdSVenkatesh Pallipadi 
113522df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1136c7fc77f7STejun Heo 		unsigned int lcpu;
11377a22ad75STejun Heo 
11387a6bc1cdSVenkatesh Pallipadi 		BUG_ON(timer_pending(timer));
11397a6bc1cdSVenkatesh Pallipadi 		BUG_ON(!list_empty(&work->entry));
11407a6bc1cdSVenkatesh Pallipadi 
11418a3e77ccSAndrew Liu 		timer_stats_timer_set_start_info(&dwork->timer);
11428a3e77ccSAndrew Liu 
11437a22ad75STejun Heo 		/*
11447a22ad75STejun Heo 		 * This stores cwq for the moment, for the timer_fn.
11457a22ad75STejun Heo 		 * Note that the work's gcwq is preserved to allow
11467a22ad75STejun Heo 		 * reentrance detection for delayed works.
11477a22ad75STejun Heo 		 */
1148c7fc77f7STejun Heo 		if (!(wq->flags & WQ_UNBOUND)) {
1149c7fc77f7STejun Heo 			struct global_cwq *gcwq = get_work_gcwq(work);
1150c7fc77f7STejun Heo 
1151c7fc77f7STejun Heo 			if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1152c7fc77f7STejun Heo 				lcpu = gcwq->cpu;
1153c7fc77f7STejun Heo 			else
1154c7fc77f7STejun Heo 				lcpu = raw_smp_processor_id();
1155c7fc77f7STejun Heo 		} else
1156c7fc77f7STejun Heo 			lcpu = WORK_CPU_UNBOUND;
1157c7fc77f7STejun Heo 
11587a22ad75STejun Heo 		set_work_cwq(work, get_cwq(lcpu, wq), 0);
1159c7fc77f7STejun Heo 
11607a6bc1cdSVenkatesh Pallipadi 		timer->expires = jiffies + delay;
116152bad64dSDavid Howells 		timer->data = (unsigned long)dwork;
11627a6bc1cdSVenkatesh Pallipadi 		timer->function = delayed_work_timer_fn;
116363bc0362SOleg Nesterov 
116463bc0362SOleg Nesterov 		if (unlikely(cpu >= 0))
11657a6bc1cdSVenkatesh Pallipadi 			add_timer_on(timer, cpu);
116663bc0362SOleg Nesterov 		else
116763bc0362SOleg Nesterov 			add_timer(timer);
11687a6bc1cdSVenkatesh Pallipadi 		ret = 1;
11697a6bc1cdSVenkatesh Pallipadi 	}
11707a6bc1cdSVenkatesh Pallipadi 	return ret;
11717a6bc1cdSVenkatesh Pallipadi }
1172ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
11731da177e4SLinus Torvalds 
1174c8e55f36STejun Heo /**
1175c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1176c8e55f36STejun Heo  * @worker: worker which is entering idle state
1177c8e55f36STejun Heo  *
1178c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1179c8e55f36STejun Heo  * necessary.
1180c8e55f36STejun Heo  *
1181c8e55f36STejun Heo  * LOCKING:
1182c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1183c8e55f36STejun Heo  */
1184c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
11851da177e4SLinus Torvalds {
1186bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1187bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1188c8e55f36STejun Heo 
1189c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1190c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1191c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1192c8e55f36STejun Heo 
1193cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1194cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1195bd7bdd43STejun Heo 	pool->nr_idle++;
1196e22bee78STejun Heo 	worker->last_active = jiffies;
1197c8e55f36STejun Heo 
1198c8e55f36STejun Heo 	/* idle_list is LIFO */
1199bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1200db7bccf4STejun Heo 
1201e22bee78STejun Heo 	if (likely(!(worker->flags & WORKER_ROGUE))) {
120263d95a91STejun Heo 		if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1203bd7bdd43STejun Heo 			mod_timer(&pool->idle_timer,
1204e22bee78STejun Heo 				  jiffies + IDLE_WORKER_TIMEOUT);
1205e22bee78STejun Heo 	} else
1206db7bccf4STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1207cb444766STejun Heo 
1208544ecf31STejun Heo 	/*
1209544ecf31STejun Heo 	 * Sanity check nr_running.  Because trustee releases gcwq->lock
1210544ecf31STejun Heo 	 * between setting %WORKER_ROGUE and zapping nr_running, the
1211544ecf31STejun Heo 	 * warning may trigger spuriously.  Check iff trustee is idle.
1212544ecf31STejun Heo 	 */
1213544ecf31STejun Heo 	WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
1214bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
121563d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1216c8e55f36STejun Heo }
1217c8e55f36STejun Heo 
1218c8e55f36STejun Heo /**
1219c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1220c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1221c8e55f36STejun Heo  *
1222c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1223c8e55f36STejun Heo  *
1224c8e55f36STejun Heo  * LOCKING:
1225c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1226c8e55f36STejun Heo  */
1227c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1228c8e55f36STejun Heo {
1229bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1230c8e55f36STejun Heo 
1231c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1232d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1233bd7bdd43STejun Heo 	pool->nr_idle--;
1234c8e55f36STejun Heo 	list_del_init(&worker->entry);
1235c8e55f36STejun Heo }
1236c8e55f36STejun Heo 
1237e22bee78STejun Heo /**
1238e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1239e22bee78STejun Heo  * @worker: self
1240e22bee78STejun Heo  *
1241e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1242e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1243e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1244e22bee78STejun Heo  * guaranteed to execute on the cpu.
1245e22bee78STejun Heo  *
1246e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1247e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1248e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1249e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1250e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1251e22bee78STejun Heo  * [dis]associated in the meantime.
1252e22bee78STejun Heo  *
1253*f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1254*f2d5a0eeSTejun Heo  * binding against %GCWQ_DISASSOCIATED which is set during
1255*f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1256*f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1257*f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1258e22bee78STejun Heo  *
1259e22bee78STejun Heo  * CONTEXT:
1260e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1261e22bee78STejun Heo  * held.
1262e22bee78STejun Heo  *
1263e22bee78STejun Heo  * RETURNS:
1264e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1265e22bee78STejun Heo  * bound), %false if offline.
1266e22bee78STejun Heo  */
1267e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1268972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1269e22bee78STejun Heo {
1270bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1271e22bee78STejun Heo 	struct task_struct *task = worker->task;
1272e22bee78STejun Heo 
1273e22bee78STejun Heo 	while (true) {
1274e22bee78STejun Heo 		/*
1275e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1276e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1277e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1278e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1279e22bee78STejun Heo 		 */
1280f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1281e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1282e22bee78STejun Heo 
1283e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1284e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1285e22bee78STejun Heo 			return false;
1286e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1287e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1288e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1289e22bee78STejun Heo 			return true;
1290e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1291e22bee78STejun Heo 
12925035b20fSTejun Heo 		/*
12935035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
12945035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
12955035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
12965035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
12975035b20fSTejun Heo 		 */
1298e22bee78STejun Heo 		cpu_relax();
12995035b20fSTejun Heo 		cond_resched();
1300e22bee78STejun Heo 	}
1301e22bee78STejun Heo }
1302e22bee78STejun Heo 
1303e22bee78STejun Heo /*
1304e22bee78STejun Heo  * Function for worker->rebind_work used to rebind rogue busy workers
1305e22bee78STejun Heo  * to the associated cpu which is coming back online.  This is
1306e22bee78STejun Heo  * scheduled by cpu up but can race with other cpu hotplug operations
1307e22bee78STejun Heo  * and may be executed twice without intervening cpu down.
1308e22bee78STejun Heo  */
1309e22bee78STejun Heo static void worker_rebind_fn(struct work_struct *work)
1310e22bee78STejun Heo {
1311e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1312bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1313e22bee78STejun Heo 
1314e22bee78STejun Heo 	if (worker_maybe_bind_and_lock(worker))
1315e22bee78STejun Heo 		worker_clr_flags(worker, WORKER_REBIND);
1316e22bee78STejun Heo 
1317e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1318e22bee78STejun Heo }
1319e22bee78STejun Heo 
1320c34056a3STejun Heo static struct worker *alloc_worker(void)
1321c34056a3STejun Heo {
1322c34056a3STejun Heo 	struct worker *worker;
1323c34056a3STejun Heo 
1324c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1325c8e55f36STejun Heo 	if (worker) {
1326c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1327affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1328e22bee78STejun Heo 		INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1329e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1330e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1331c8e55f36STejun Heo 	}
1332c34056a3STejun Heo 	return worker;
1333c34056a3STejun Heo }
1334c34056a3STejun Heo 
1335c34056a3STejun Heo /**
1336c34056a3STejun Heo  * create_worker - create a new workqueue worker
133763d95a91STejun Heo  * @pool: pool the new worker will belong to
1338c34056a3STejun Heo  * @bind: whether to set affinity to @cpu or not
1339c34056a3STejun Heo  *
134063d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1341c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1342c34056a3STejun Heo  * destroy_worker().
1343c34056a3STejun Heo  *
1344c34056a3STejun Heo  * CONTEXT:
1345c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1346c34056a3STejun Heo  *
1347c34056a3STejun Heo  * RETURNS:
1348c34056a3STejun Heo  * Pointer to the newly created worker.
1349c34056a3STejun Heo  */
135063d95a91STejun Heo static struct worker *create_worker(struct worker_pool *pool, bool bind)
1351c34056a3STejun Heo {
135263d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1353f3421797STejun Heo 	bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
13543270476aSTejun Heo 	const char *pri = worker_pool_pri(pool) ? "H" : "";
1355c34056a3STejun Heo 	struct worker *worker = NULL;
1356f3421797STejun Heo 	int id = -1;
1357c34056a3STejun Heo 
13588b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1359bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
13608b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1361bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1362c34056a3STejun Heo 			goto fail;
13638b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1364c34056a3STejun Heo 	}
13658b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1366c34056a3STejun Heo 
1367c34056a3STejun Heo 	worker = alloc_worker();
1368c34056a3STejun Heo 	if (!worker)
1369c34056a3STejun Heo 		goto fail;
1370c34056a3STejun Heo 
1371bd7bdd43STejun Heo 	worker->pool = pool;
1372c34056a3STejun Heo 	worker->id = id;
1373c34056a3STejun Heo 
1374f3421797STejun Heo 	if (!on_unbound_cpu)
137594dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
13763270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
13773270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1378f3421797STejun Heo 	else
1379f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
13803270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1381c34056a3STejun Heo 	if (IS_ERR(worker->task))
1382c34056a3STejun Heo 		goto fail;
1383c34056a3STejun Heo 
13843270476aSTejun Heo 	if (worker_pool_pri(pool))
13853270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
13863270476aSTejun Heo 
1387db7bccf4STejun Heo 	/*
1388db7bccf4STejun Heo 	 * A rogue worker will become a regular one if CPU comes
1389db7bccf4STejun Heo 	 * online later on.  Make sure every worker has
1390db7bccf4STejun Heo 	 * PF_THREAD_BOUND set.
1391db7bccf4STejun Heo 	 */
1392f3421797STejun Heo 	if (bind && !on_unbound_cpu)
13938b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1394f3421797STejun Heo 	else {
1395db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1396f3421797STejun Heo 		if (on_unbound_cpu)
1397f3421797STejun Heo 			worker->flags |= WORKER_UNBOUND;
1398f3421797STejun Heo 	}
1399c34056a3STejun Heo 
1400c34056a3STejun Heo 	return worker;
1401c34056a3STejun Heo fail:
1402c34056a3STejun Heo 	if (id >= 0) {
14038b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1404bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
14058b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1406c34056a3STejun Heo 	}
1407c34056a3STejun Heo 	kfree(worker);
1408c34056a3STejun Heo 	return NULL;
1409c34056a3STejun Heo }
1410c34056a3STejun Heo 
1411c34056a3STejun Heo /**
1412c34056a3STejun Heo  * start_worker - start a newly created worker
1413c34056a3STejun Heo  * @worker: worker to start
1414c34056a3STejun Heo  *
1415c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1416c34056a3STejun Heo  *
1417c34056a3STejun Heo  * CONTEXT:
14188b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1419c34056a3STejun Heo  */
1420c34056a3STejun Heo static void start_worker(struct worker *worker)
1421c34056a3STejun Heo {
1422cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1423bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1424c8e55f36STejun Heo 	worker_enter_idle(worker);
1425c34056a3STejun Heo 	wake_up_process(worker->task);
1426c34056a3STejun Heo }
1427c34056a3STejun Heo 
1428c34056a3STejun Heo /**
1429c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1430c34056a3STejun Heo  * @worker: worker to be destroyed
1431c34056a3STejun Heo  *
1432c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1433c8e55f36STejun Heo  *
1434c8e55f36STejun Heo  * CONTEXT:
1435c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1436c34056a3STejun Heo  */
1437c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1438c34056a3STejun Heo {
1439bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1440bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1441c34056a3STejun Heo 	int id = worker->id;
1442c34056a3STejun Heo 
1443c34056a3STejun Heo 	/* sanity check frenzy */
1444c34056a3STejun Heo 	BUG_ON(worker->current_work);
1445affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1446c34056a3STejun Heo 
1447c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1448bd7bdd43STejun Heo 		pool->nr_workers--;
1449c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1450bd7bdd43STejun Heo 		pool->nr_idle--;
1451c8e55f36STejun Heo 
1452c8e55f36STejun Heo 	list_del_init(&worker->entry);
1453cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1454c8e55f36STejun Heo 
1455c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1456c8e55f36STejun Heo 
1457c34056a3STejun Heo 	kthread_stop(worker->task);
1458c34056a3STejun Heo 	kfree(worker);
1459c34056a3STejun Heo 
14608b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1461bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1462c34056a3STejun Heo }
1463c34056a3STejun Heo 
146463d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1465e22bee78STejun Heo {
146663d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
146763d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1468e22bee78STejun Heo 
1469e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1470e22bee78STejun Heo 
147163d95a91STejun Heo 	if (too_many_workers(pool)) {
1472e22bee78STejun Heo 		struct worker *worker;
1473e22bee78STejun Heo 		unsigned long expires;
1474e22bee78STejun Heo 
1475e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
147663d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1477e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1478e22bee78STejun Heo 
1479e22bee78STejun Heo 		if (time_before(jiffies, expires))
148063d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1481e22bee78STejun Heo 		else {
1482e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
148311ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
148463d95a91STejun Heo 			wake_up_worker(pool);
1485e22bee78STejun Heo 		}
1486e22bee78STejun Heo 	}
1487e22bee78STejun Heo 
1488e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1489e22bee78STejun Heo }
1490e22bee78STejun Heo 
1491e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1492e22bee78STejun Heo {
1493e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1494e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1495f3421797STejun Heo 	unsigned int cpu;
1496e22bee78STejun Heo 
1497e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1498e22bee78STejun Heo 		return false;
1499e22bee78STejun Heo 
1500e22bee78STejun Heo 	/* mayday mayday mayday */
1501bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1502f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1503f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1504f3421797STejun Heo 		cpu = 0;
1505f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1506e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1507e22bee78STejun Heo 	return true;
1508e22bee78STejun Heo }
1509e22bee78STejun Heo 
151063d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1511e22bee78STejun Heo {
151263d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
151363d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1514e22bee78STejun Heo 	struct work_struct *work;
1515e22bee78STejun Heo 
1516e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1517e22bee78STejun Heo 
151863d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1519e22bee78STejun Heo 		/*
1520e22bee78STejun Heo 		 * We've been trying to create a new worker but
1521e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1522e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1523e22bee78STejun Heo 		 * rescuers.
1524e22bee78STejun Heo 		 */
152563d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1526e22bee78STejun Heo 			send_mayday(work);
1527e22bee78STejun Heo 	}
1528e22bee78STejun Heo 
1529e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1530e22bee78STejun Heo 
153163d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1532e22bee78STejun Heo }
1533e22bee78STejun Heo 
1534e22bee78STejun Heo /**
1535e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
153663d95a91STejun Heo  * @pool: pool to create a new worker for
1537e22bee78STejun Heo  *
153863d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1539e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1540e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
154163d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1542e22bee78STejun Heo  * possible allocation deadlock.
1543e22bee78STejun Heo  *
1544e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1545e22bee78STejun Heo  * may_start_working() true.
1546e22bee78STejun Heo  *
1547e22bee78STejun Heo  * LOCKING:
1548e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1549e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1550e22bee78STejun Heo  * manager.
1551e22bee78STejun Heo  *
1552e22bee78STejun Heo  * RETURNS:
1553e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1554e22bee78STejun Heo  * otherwise.
1555e22bee78STejun Heo  */
155663d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
155706bd6ebfSNamhyung Kim __releases(&gcwq->lock)
155806bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1559e22bee78STejun Heo {
156063d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
156163d95a91STejun Heo 
156263d95a91STejun Heo 	if (!need_to_create_worker(pool))
1563e22bee78STejun Heo 		return false;
1564e22bee78STejun Heo restart:
15659f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
15669f9c2364STejun Heo 
1567e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
156863d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1569e22bee78STejun Heo 
1570e22bee78STejun Heo 	while (true) {
1571e22bee78STejun Heo 		struct worker *worker;
1572e22bee78STejun Heo 
157363d95a91STejun Heo 		worker = create_worker(pool, true);
1574e22bee78STejun Heo 		if (worker) {
157563d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1576e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1577e22bee78STejun Heo 			start_worker(worker);
157863d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1579e22bee78STejun Heo 			return true;
1580e22bee78STejun Heo 		}
1581e22bee78STejun Heo 
158263d95a91STejun Heo 		if (!need_to_create_worker(pool))
1583e22bee78STejun Heo 			break;
1584e22bee78STejun Heo 
1585e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1586e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
15879f9c2364STejun Heo 
158863d95a91STejun Heo 		if (!need_to_create_worker(pool))
1589e22bee78STejun Heo 			break;
1590e22bee78STejun Heo 	}
1591e22bee78STejun Heo 
159263d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1593e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
159463d95a91STejun Heo 	if (need_to_create_worker(pool))
1595e22bee78STejun Heo 		goto restart;
1596e22bee78STejun Heo 	return true;
1597e22bee78STejun Heo }
1598e22bee78STejun Heo 
1599e22bee78STejun Heo /**
1600e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
160163d95a91STejun Heo  * @pool: pool to destroy workers for
1602e22bee78STejun Heo  *
160363d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
1604e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1605e22bee78STejun Heo  *
1606e22bee78STejun Heo  * LOCKING:
1607e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1608e22bee78STejun Heo  * multiple times.  Called only from manager.
1609e22bee78STejun Heo  *
1610e22bee78STejun Heo  * RETURNS:
1611e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1612e22bee78STejun Heo  * otherwise.
1613e22bee78STejun Heo  */
161463d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
1615e22bee78STejun Heo {
1616e22bee78STejun Heo 	bool ret = false;
1617e22bee78STejun Heo 
161863d95a91STejun Heo 	while (too_many_workers(pool)) {
1619e22bee78STejun Heo 		struct worker *worker;
1620e22bee78STejun Heo 		unsigned long expires;
1621e22bee78STejun Heo 
162263d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1623e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1624e22bee78STejun Heo 
1625e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
162663d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1627e22bee78STejun Heo 			break;
1628e22bee78STejun Heo 		}
1629e22bee78STejun Heo 
1630e22bee78STejun Heo 		destroy_worker(worker);
1631e22bee78STejun Heo 		ret = true;
1632e22bee78STejun Heo 	}
1633e22bee78STejun Heo 
1634e22bee78STejun Heo 	return ret;
1635e22bee78STejun Heo }
1636e22bee78STejun Heo 
1637e22bee78STejun Heo /**
1638e22bee78STejun Heo  * manage_workers - manage worker pool
1639e22bee78STejun Heo  * @worker: self
1640e22bee78STejun Heo  *
1641e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
1642e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1643e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
1644e22bee78STejun Heo  *
1645e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
1646e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
1647e22bee78STejun Heo  * and may_start_working() is true.
1648e22bee78STejun Heo  *
1649e22bee78STejun Heo  * CONTEXT:
1650e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1651e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
1652e22bee78STejun Heo  *
1653e22bee78STejun Heo  * RETURNS:
1654e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
1655e22bee78STejun Heo  * some action was taken.
1656e22bee78STejun Heo  */
1657e22bee78STejun Heo static bool manage_workers(struct worker *worker)
1658e22bee78STejun Heo {
165963d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
166063d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1661e22bee78STejun Heo 	bool ret = false;
1662e22bee78STejun Heo 
166311ebea50STejun Heo 	if (pool->flags & POOL_MANAGING_WORKERS)
1664e22bee78STejun Heo 		return ret;
1665e22bee78STejun Heo 
166611ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
166711ebea50STejun Heo 	pool->flags |= POOL_MANAGING_WORKERS;
1668e22bee78STejun Heo 
1669e22bee78STejun Heo 	/*
1670e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
1671e22bee78STejun Heo 	 * on return.
1672e22bee78STejun Heo 	 */
167363d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
167463d95a91STejun Heo 	ret |= maybe_create_worker(pool);
1675e22bee78STejun Heo 
167611ebea50STejun Heo 	pool->flags &= ~POOL_MANAGING_WORKERS;
1677e22bee78STejun Heo 
1678e22bee78STejun Heo 	/*
1679e22bee78STejun Heo 	 * The trustee might be waiting to take over the manager
1680e22bee78STejun Heo 	 * position, tell it we're done.
1681e22bee78STejun Heo 	 */
1682e22bee78STejun Heo 	if (unlikely(gcwq->trustee))
1683e22bee78STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1684e22bee78STejun Heo 
1685e22bee78STejun Heo 	return ret;
1686e22bee78STejun Heo }
1687e22bee78STejun Heo 
1688a62428c0STejun Heo /**
1689affee4b2STejun Heo  * move_linked_works - move linked works to a list
1690affee4b2STejun Heo  * @work: start of series of works to be scheduled
1691affee4b2STejun Heo  * @head: target list to append @work to
1692affee4b2STejun Heo  * @nextp: out paramter for nested worklist walking
1693affee4b2STejun Heo  *
1694affee4b2STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1695affee4b2STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1696affee4b2STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1697affee4b2STejun Heo  *
1698affee4b2STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1699affee4b2STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1700affee4b2STejun Heo  * nested inside outer list_for_each_entry_safe().
1701affee4b2STejun Heo  *
1702affee4b2STejun Heo  * CONTEXT:
17038b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1704affee4b2STejun Heo  */
1705affee4b2STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1706affee4b2STejun Heo 			      struct work_struct **nextp)
1707affee4b2STejun Heo {
1708affee4b2STejun Heo 	struct work_struct *n;
1709affee4b2STejun Heo 
1710affee4b2STejun Heo 	/*
1711affee4b2STejun Heo 	 * Linked worklist will always end before the end of the list,
1712affee4b2STejun Heo 	 * use NULL for list head.
1713affee4b2STejun Heo 	 */
1714affee4b2STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1715affee4b2STejun Heo 		list_move_tail(&work->entry, head);
1716affee4b2STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1717affee4b2STejun Heo 			break;
1718affee4b2STejun Heo 	}
1719affee4b2STejun Heo 
1720affee4b2STejun Heo 	/*
1721affee4b2STejun Heo 	 * If we're already inside safe list traversal and have moved
1722affee4b2STejun Heo 	 * multiple works to the scheduled queue, the next position
1723affee4b2STejun Heo 	 * needs to be updated.
1724affee4b2STejun Heo 	 */
1725affee4b2STejun Heo 	if (nextp)
1726affee4b2STejun Heo 		*nextp = n;
1727affee4b2STejun Heo }
1728affee4b2STejun Heo 
17291e19ffc6STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
17301e19ffc6STejun Heo {
17311e19ffc6STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
17321da177e4SLinus Torvalds 						    struct work_struct, entry);
17331e19ffc6STejun Heo 
1734cdadf009STejun Heo 	trace_workqueue_activate_work(work);
17353270476aSTejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
17368a2e8e5dSTejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
17371e19ffc6STejun Heo 	cwq->nr_active++;
17381e19ffc6STejun Heo }
17391e19ffc6STejun Heo 
1740affee4b2STejun Heo /**
174173f53c4aSTejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
174273f53c4aSTejun Heo  * @cwq: cwq of interest
174373f53c4aSTejun Heo  * @color: color of work which left the queue
17448a2e8e5dSTejun Heo  * @delayed: for a delayed work
174573f53c4aSTejun Heo  *
174673f53c4aSTejun Heo  * A work either has completed or is removed from pending queue,
174773f53c4aSTejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
174873f53c4aSTejun Heo  *
174973f53c4aSTejun Heo  * CONTEXT:
17508b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
175173f53c4aSTejun Heo  */
17528a2e8e5dSTejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
17538a2e8e5dSTejun Heo 				 bool delayed)
175473f53c4aSTejun Heo {
175573f53c4aSTejun Heo 	/* ignore uncolored works */
175673f53c4aSTejun Heo 	if (color == WORK_NO_COLOR)
175773f53c4aSTejun Heo 		return;
175873f53c4aSTejun Heo 
175973f53c4aSTejun Heo 	cwq->nr_in_flight[color]--;
17601e19ffc6STejun Heo 
17618a2e8e5dSTejun Heo 	if (!delayed) {
17628a2e8e5dSTejun Heo 		cwq->nr_active--;
1763502ca9d8STejun Heo 		if (!list_empty(&cwq->delayed_works)) {
17641e19ffc6STejun Heo 			/* one down, submit a delayed one */
1765502ca9d8STejun Heo 			if (cwq->nr_active < cwq->max_active)
17661e19ffc6STejun Heo 				cwq_activate_first_delayed(cwq);
1767502ca9d8STejun Heo 		}
17688a2e8e5dSTejun Heo 	}
176973f53c4aSTejun Heo 
177073f53c4aSTejun Heo 	/* is flush in progress and are we at the flushing tip? */
177173f53c4aSTejun Heo 	if (likely(cwq->flush_color != color))
177273f53c4aSTejun Heo 		return;
177373f53c4aSTejun Heo 
177473f53c4aSTejun Heo 	/* are there still in-flight works? */
177573f53c4aSTejun Heo 	if (cwq->nr_in_flight[color])
177673f53c4aSTejun Heo 		return;
177773f53c4aSTejun Heo 
177873f53c4aSTejun Heo 	/* this cwq is done, clear flush_color */
177973f53c4aSTejun Heo 	cwq->flush_color = -1;
178073f53c4aSTejun Heo 
178173f53c4aSTejun Heo 	/*
178273f53c4aSTejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
178373f53c4aSTejun Heo 	 * will handle the rest.
178473f53c4aSTejun Heo 	 */
178573f53c4aSTejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
178673f53c4aSTejun Heo 		complete(&cwq->wq->first_flusher->done);
178773f53c4aSTejun Heo }
178873f53c4aSTejun Heo 
178973f53c4aSTejun Heo /**
1790a62428c0STejun Heo  * process_one_work - process single work
1791c34056a3STejun Heo  * @worker: self
1792a62428c0STejun Heo  * @work: work to process
1793a62428c0STejun Heo  *
1794a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
1795a62428c0STejun Heo  * process a single work including synchronization against and
1796a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
1797a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
1798a62428c0STejun Heo  * call this function to process a work.
1799a62428c0STejun Heo  *
1800a62428c0STejun Heo  * CONTEXT:
18018b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1802a62428c0STejun Heo  */
1803c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
180406bd6ebfSNamhyung Kim __releases(&gcwq->lock)
180506bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
18061da177e4SLinus Torvalds {
18077e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1808bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1809bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1810c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
1811fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
18126bb49e59SDavid Howells 	work_func_t f = work->func;
181373f53c4aSTejun Heo 	int work_color;
18147e11629dSTejun Heo 	struct worker *collision;
18154e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
18164e6045f1SJohannes Berg 	/*
1817a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
1818a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
1819a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
1820a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
1821a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
18224e6045f1SJohannes Berg 	 */
18234d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
18244d82a1deSPeter Zijlstra 
18254d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
18264e6045f1SJohannes Berg #endif
18277e11629dSTejun Heo 	/*
18287e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
18297e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
18307e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
18317e11629dSTejun Heo 	 * currently executing one.
18327e11629dSTejun Heo 	 */
18337e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
18347e11629dSTejun Heo 	if (unlikely(collision)) {
18357e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
18367e11629dSTejun Heo 		return;
18377e11629dSTejun Heo 	}
18381da177e4SLinus Torvalds 
1839a62428c0STejun Heo 	/* claim and process */
18401da177e4SLinus Torvalds 	debug_work_deactivate(work);
1841c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
1842c34056a3STejun Heo 	worker->current_work = work;
18438cca0eeaSTejun Heo 	worker->current_cwq = cwq;
184473f53c4aSTejun Heo 	work_color = get_work_color(work);
18457a22ad75STejun Heo 
18467a22ad75STejun Heo 	/* record the current cpu number in the work data and dequeue */
18477a22ad75STejun Heo 	set_work_cpu(work, gcwq->cpu);
1848a62428c0STejun Heo 	list_del_init(&work->entry);
1849a62428c0STejun Heo 
1850649027d7STejun Heo 	/*
1851fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
1852fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
1853fb0e7bebSTejun Heo 	 */
1854fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1855fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1856fb0e7bebSTejun Heo 
1857974271c4STejun Heo 	/*
1858974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
1859974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
1860974271c4STejun Heo 	 */
186163d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
186263d95a91STejun Heo 		wake_up_worker(pool);
1863974271c4STejun Heo 
18648b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
18651da177e4SLinus Torvalds 
186623b2e599SOleg Nesterov 	work_clear_pending(work);
1867e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
18683295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
1869e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
187065f27f38SDavid Howells 	f(work);
1871e36c886aSArjan van de Ven 	/*
1872e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
1873e36c886aSArjan van de Ven 	 * point will only record its address.
1874e36c886aSArjan van de Ven 	 */
1875e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
18763295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
18773295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
18781da177e4SLinus Torvalds 
1879d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1880d5abe669SPeter Zijlstra 		printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1881d5abe669SPeter Zijlstra 		       "%s/0x%08x/%d\n",
1882a62428c0STejun Heo 		       current->comm, preempt_count(), task_pid_nr(current));
1883d5abe669SPeter Zijlstra 		printk(KERN_ERR "    last function: ");
1884d5abe669SPeter Zijlstra 		print_symbol("%s\n", (unsigned long)f);
1885d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
1886d5abe669SPeter Zijlstra 		dump_stack();
1887d5abe669SPeter Zijlstra 	}
1888d5abe669SPeter Zijlstra 
18898b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1890a62428c0STejun Heo 
1891fb0e7bebSTejun Heo 	/* clear cpu intensive status */
1892fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1893fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1894fb0e7bebSTejun Heo 
1895a62428c0STejun Heo 	/* we're done with it, release */
1896c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
1897c34056a3STejun Heo 	worker->current_work = NULL;
18988cca0eeaSTejun Heo 	worker->current_cwq = NULL;
18998a2e8e5dSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color, false);
19001da177e4SLinus Torvalds }
19011da177e4SLinus Torvalds 
1902affee4b2STejun Heo /**
1903affee4b2STejun Heo  * process_scheduled_works - process scheduled works
1904affee4b2STejun Heo  * @worker: self
1905affee4b2STejun Heo  *
1906affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
1907affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
1908affee4b2STejun Heo  * fetches a work from the top and executes it.
1909affee4b2STejun Heo  *
1910affee4b2STejun Heo  * CONTEXT:
19118b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1912affee4b2STejun Heo  * multiple times.
1913affee4b2STejun Heo  */
1914affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
19151da177e4SLinus Torvalds {
1916affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
1917affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
1918a62428c0STejun Heo 						struct work_struct, entry);
1919c34056a3STejun Heo 		process_one_work(worker, work);
1920a62428c0STejun Heo 	}
19211da177e4SLinus Torvalds }
19221da177e4SLinus Torvalds 
19234690c4abSTejun Heo /**
19244690c4abSTejun Heo  * worker_thread - the worker thread function
1925c34056a3STejun Heo  * @__worker: self
19264690c4abSTejun Heo  *
1927e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
1928e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
1929e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
1930e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
1931e22bee78STejun Heo  * rescuer_thread().
19324690c4abSTejun Heo  */
1933c34056a3STejun Heo static int worker_thread(void *__worker)
19341da177e4SLinus Torvalds {
1935c34056a3STejun Heo 	struct worker *worker = __worker;
1936bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1937bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
19381da177e4SLinus Torvalds 
1939e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
1940e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
1941c8e55f36STejun Heo woke_up:
19428b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1943affee4b2STejun Heo 
1944c8e55f36STejun Heo 	/* DIE can be set only while we're idle, checking here is enough */
1945c8e55f36STejun Heo 	if (worker->flags & WORKER_DIE) {
1946c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
1947e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
1948c8e55f36STejun Heo 		return 0;
1949c8e55f36STejun Heo 	}
1950c8e55f36STejun Heo 
1951c8e55f36STejun Heo 	worker_leave_idle(worker);
1952db7bccf4STejun Heo recheck:
1953e22bee78STejun Heo 	/* no more worker necessary? */
195463d95a91STejun Heo 	if (!need_more_worker(pool))
1955e22bee78STejun Heo 		goto sleep;
1956e22bee78STejun Heo 
1957e22bee78STejun Heo 	/* do we need to manage? */
195863d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
1959e22bee78STejun Heo 		goto recheck;
1960e22bee78STejun Heo 
1961c8e55f36STejun Heo 	/*
1962c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
1963c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
1964c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
1965c8e55f36STejun Heo 	 */
1966c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1967c8e55f36STejun Heo 
1968e22bee78STejun Heo 	/*
1969e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
1970e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
1971e22bee78STejun Heo 	 * assumed the manager role.
1972e22bee78STejun Heo 	 */
1973e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
1974e22bee78STejun Heo 
1975e22bee78STejun Heo 	do {
1976affee4b2STejun Heo 		struct work_struct *work =
1977bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
1978affee4b2STejun Heo 					 struct work_struct, entry);
1979affee4b2STejun Heo 
1980c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1981affee4b2STejun Heo 			/* optimization path, not strictly necessary */
1982affee4b2STejun Heo 			process_one_work(worker, work);
1983affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
1984affee4b2STejun Heo 				process_scheduled_works(worker);
1985affee4b2STejun Heo 		} else {
1986c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
1987affee4b2STejun Heo 			process_scheduled_works(worker);
1988affee4b2STejun Heo 		}
198963d95a91STejun Heo 	} while (keep_working(pool));
1990affee4b2STejun Heo 
1991e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
1992d313dd85STejun Heo sleep:
199363d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
1994e22bee78STejun Heo 		goto recheck;
1995d313dd85STejun Heo 
1996c8e55f36STejun Heo 	/*
1997e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
1998e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
1999e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2000e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2001e22bee78STejun Heo 	 * prevent losing any event.
2002c8e55f36STejun Heo 	 */
2003c8e55f36STejun Heo 	worker_enter_idle(worker);
2004c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
20058b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
20061da177e4SLinus Torvalds 	schedule();
2007c8e55f36STejun Heo 	goto woke_up;
20081da177e4SLinus Torvalds }
20091da177e4SLinus Torvalds 
2010e22bee78STejun Heo /**
2011e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2012e22bee78STejun Heo  * @__wq: the associated workqueue
2013e22bee78STejun Heo  *
2014e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2015e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2016e22bee78STejun Heo  *
2017e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2018e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2019e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2020e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2021e22bee78STejun Heo  * the problem rescuer solves.
2022e22bee78STejun Heo  *
2023e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2024e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2025e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2026e22bee78STejun Heo  *
2027e22bee78STejun Heo  * This should happen rarely.
2028e22bee78STejun Heo  */
2029e22bee78STejun Heo static int rescuer_thread(void *__wq)
2030e22bee78STejun Heo {
2031e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2032e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2033e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2034f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2035e22bee78STejun Heo 	unsigned int cpu;
2036e22bee78STejun Heo 
2037e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2038e22bee78STejun Heo repeat:
2039e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
20401da177e4SLinus Torvalds 
20411da177e4SLinus Torvalds 	if (kthread_should_stop())
2042e22bee78STejun Heo 		return 0;
20431da177e4SLinus Torvalds 
2044f3421797STejun Heo 	/*
2045f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2046f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2047f3421797STejun Heo 	 */
2048f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2049f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2050f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2051bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2052bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2053e22bee78STejun Heo 		struct work_struct *work, *n;
2054e22bee78STejun Heo 
2055e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2056f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2057e22bee78STejun Heo 
2058e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2059bd7bdd43STejun Heo 		rescuer->pool = pool;
2060e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2061e22bee78STejun Heo 
2062e22bee78STejun Heo 		/*
2063e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2064e22bee78STejun Heo 		 * process'em.
2065e22bee78STejun Heo 		 */
2066e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2067bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2068e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2069e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2070e22bee78STejun Heo 
2071e22bee78STejun Heo 		process_scheduled_works(rescuer);
20727576958aSTejun Heo 
20737576958aSTejun Heo 		/*
20747576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
20757576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
20767576958aSTejun Heo 		 * and stalling the execution.
20777576958aSTejun Heo 		 */
207863d95a91STejun Heo 		if (keep_working(pool))
207963d95a91STejun Heo 			wake_up_worker(pool);
20807576958aSTejun Heo 
2081e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
20821da177e4SLinus Torvalds 	}
20831da177e4SLinus Torvalds 
2084e22bee78STejun Heo 	schedule();
2085e22bee78STejun Heo 	goto repeat;
20861da177e4SLinus Torvalds }
20871da177e4SLinus Torvalds 
2088fc2e4d70SOleg Nesterov struct wq_barrier {
2089fc2e4d70SOleg Nesterov 	struct work_struct	work;
2090fc2e4d70SOleg Nesterov 	struct completion	done;
2091fc2e4d70SOleg Nesterov };
2092fc2e4d70SOleg Nesterov 
2093fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2094fc2e4d70SOleg Nesterov {
2095fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2096fc2e4d70SOleg Nesterov 	complete(&barr->done);
2097fc2e4d70SOleg Nesterov }
2098fc2e4d70SOleg Nesterov 
20994690c4abSTejun Heo /**
21004690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
21014690c4abSTejun Heo  * @cwq: cwq to insert barrier into
21024690c4abSTejun Heo  * @barr: wq_barrier to insert
2103affee4b2STejun Heo  * @target: target work to attach @barr to
2104affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
21054690c4abSTejun Heo  *
2106affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2107affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2108affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2109affee4b2STejun Heo  * cpu.
2110affee4b2STejun Heo  *
2111affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2112affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2113affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2114affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2115affee4b2STejun Heo  * after a work with LINKED flag set.
2116affee4b2STejun Heo  *
2117affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2118affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
21194690c4abSTejun Heo  *
21204690c4abSTejun Heo  * CONTEXT:
21218b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
21224690c4abSTejun Heo  */
212383c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2124affee4b2STejun Heo 			      struct wq_barrier *barr,
2125affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2126fc2e4d70SOleg Nesterov {
2127affee4b2STejun Heo 	struct list_head *head;
2128affee4b2STejun Heo 	unsigned int linked = 0;
2129affee4b2STejun Heo 
2130dc186ad7SThomas Gleixner 	/*
21318b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2132dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2133dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2134dc186ad7SThomas Gleixner 	 * might deadlock.
2135dc186ad7SThomas Gleixner 	 */
2136ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
213722df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2138fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
213983c22520SOleg Nesterov 
2140affee4b2STejun Heo 	/*
2141affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2142affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2143affee4b2STejun Heo 	 */
2144affee4b2STejun Heo 	if (worker)
2145affee4b2STejun Heo 		head = worker->scheduled.next;
2146affee4b2STejun Heo 	else {
2147affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2148affee4b2STejun Heo 
2149affee4b2STejun Heo 		head = target->entry.next;
2150affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2151affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2152affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2153affee4b2STejun Heo 	}
2154affee4b2STejun Heo 
2155dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2156affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2157affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2158fc2e4d70SOleg Nesterov }
2159fc2e4d70SOleg Nesterov 
216073f53c4aSTejun Heo /**
216173f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
216273f53c4aSTejun Heo  * @wq: workqueue being flushed
216373f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
216473f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
216573f53c4aSTejun Heo  *
216673f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
216773f53c4aSTejun Heo  *
216873f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
216973f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
217073f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
217173f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
217273f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
217373f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
217473f53c4aSTejun Heo  *
217573f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
217673f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
217773f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
217873f53c4aSTejun Heo  * is returned.
217973f53c4aSTejun Heo  *
218073f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
218173f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
218273f53c4aSTejun Heo  * advanced to @work_color.
218373f53c4aSTejun Heo  *
218473f53c4aSTejun Heo  * CONTEXT:
218573f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
218673f53c4aSTejun Heo  *
218773f53c4aSTejun Heo  * RETURNS:
218873f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
218973f53c4aSTejun Heo  * otherwise.
219073f53c4aSTejun Heo  */
219173f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
219273f53c4aSTejun Heo 				      int flush_color, int work_color)
21931da177e4SLinus Torvalds {
219473f53c4aSTejun Heo 	bool wait = false;
219573f53c4aSTejun Heo 	unsigned int cpu;
21961da177e4SLinus Torvalds 
219773f53c4aSTejun Heo 	if (flush_color >= 0) {
219873f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
219973f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2200dc186ad7SThomas Gleixner 	}
220114441960SOleg Nesterov 
2202f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
220373f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2204bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
22051da177e4SLinus Torvalds 
22068b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
220773f53c4aSTejun Heo 
220873f53c4aSTejun Heo 		if (flush_color >= 0) {
220973f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
221073f53c4aSTejun Heo 
221173f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
221273f53c4aSTejun Heo 				cwq->flush_color = flush_color;
221373f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
221473f53c4aSTejun Heo 				wait = true;
22151da177e4SLinus Torvalds 			}
221673f53c4aSTejun Heo 		}
221773f53c4aSTejun Heo 
221873f53c4aSTejun Heo 		if (work_color >= 0) {
221973f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
222073f53c4aSTejun Heo 			cwq->work_color = work_color;
222173f53c4aSTejun Heo 		}
222273f53c4aSTejun Heo 
22238b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
22241da177e4SLinus Torvalds 	}
22251da177e4SLinus Torvalds 
222673f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
222773f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
222873f53c4aSTejun Heo 
222973f53c4aSTejun Heo 	return wait;
223083c22520SOleg Nesterov }
22311da177e4SLinus Torvalds 
22320fcb78c2SRolf Eike Beer /**
22331da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
22340fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
22351da177e4SLinus Torvalds  *
22361da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
22371da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
22381da177e4SLinus Torvalds  *
2239fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2240fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
22411da177e4SLinus Torvalds  */
22427ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
22431da177e4SLinus Torvalds {
224473f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
224573f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
224673f53c4aSTejun Heo 		.flush_color = -1,
224773f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
224873f53c4aSTejun Heo 	};
224973f53c4aSTejun Heo 	int next_color;
2250b1f4ec17SOleg Nesterov 
22513295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
22523295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
225373f53c4aSTejun Heo 
225473f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
225573f53c4aSTejun Heo 
225673f53c4aSTejun Heo 	/*
225773f53c4aSTejun Heo 	 * Start-to-wait phase
225873f53c4aSTejun Heo 	 */
225973f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
226073f53c4aSTejun Heo 
226173f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
226273f53c4aSTejun Heo 		/*
226373f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
226473f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
226573f53c4aSTejun Heo 		 * by one.
226673f53c4aSTejun Heo 		 */
226773f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
226873f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
226973f53c4aSTejun Heo 		wq->work_color = next_color;
227073f53c4aSTejun Heo 
227173f53c4aSTejun Heo 		if (!wq->first_flusher) {
227273f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
227373f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
227473f53c4aSTejun Heo 
227573f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
227673f53c4aSTejun Heo 
227773f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
227873f53c4aSTejun Heo 						       wq->work_color)) {
227973f53c4aSTejun Heo 				/* nothing to flush, done */
228073f53c4aSTejun Heo 				wq->flush_color = next_color;
228173f53c4aSTejun Heo 				wq->first_flusher = NULL;
228273f53c4aSTejun Heo 				goto out_unlock;
228373f53c4aSTejun Heo 			}
228473f53c4aSTejun Heo 		} else {
228573f53c4aSTejun Heo 			/* wait in queue */
228673f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
228773f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
228873f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
228973f53c4aSTejun Heo 		}
229073f53c4aSTejun Heo 	} else {
229173f53c4aSTejun Heo 		/*
229273f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
229373f53c4aSTejun Heo 		 * The next flush completion will assign us
229473f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
229573f53c4aSTejun Heo 		 */
229673f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
229773f53c4aSTejun Heo 	}
229873f53c4aSTejun Heo 
229973f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
230073f53c4aSTejun Heo 
230173f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
230273f53c4aSTejun Heo 
230373f53c4aSTejun Heo 	/*
230473f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
230573f53c4aSTejun Heo 	 *
230673f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
230773f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
230873f53c4aSTejun Heo 	 */
230973f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
231073f53c4aSTejun Heo 		return;
231173f53c4aSTejun Heo 
231273f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
231373f53c4aSTejun Heo 
23144ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
23154ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
23164ce48b37STejun Heo 		goto out_unlock;
23174ce48b37STejun Heo 
231873f53c4aSTejun Heo 	wq->first_flusher = NULL;
231973f53c4aSTejun Heo 
232073f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
232173f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
232273f53c4aSTejun Heo 
232373f53c4aSTejun Heo 	while (true) {
232473f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
232573f53c4aSTejun Heo 
232673f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
232773f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
232873f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
232973f53c4aSTejun Heo 				break;
233073f53c4aSTejun Heo 			list_del_init(&next->list);
233173f53c4aSTejun Heo 			complete(&next->done);
233273f53c4aSTejun Heo 		}
233373f53c4aSTejun Heo 
233473f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
233573f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
233673f53c4aSTejun Heo 
233773f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
233873f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
233973f53c4aSTejun Heo 
234073f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
234173f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
234273f53c4aSTejun Heo 			/*
234373f53c4aSTejun Heo 			 * Assign the same color to all overflowed
234473f53c4aSTejun Heo 			 * flushers, advance work_color and append to
234573f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
234673f53c4aSTejun Heo 			 * phase for these overflowed flushers.
234773f53c4aSTejun Heo 			 */
234873f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
234973f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
235073f53c4aSTejun Heo 
235173f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
235273f53c4aSTejun Heo 
235373f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
235473f53c4aSTejun Heo 					      &wq->flusher_queue);
235573f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
235673f53c4aSTejun Heo 		}
235773f53c4aSTejun Heo 
235873f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
235973f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
236073f53c4aSTejun Heo 			break;
236173f53c4aSTejun Heo 		}
236273f53c4aSTejun Heo 
236373f53c4aSTejun Heo 		/*
236473f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
236573f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
236673f53c4aSTejun Heo 		 */
236773f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
236873f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
236973f53c4aSTejun Heo 
237073f53c4aSTejun Heo 		list_del_init(&next->list);
237173f53c4aSTejun Heo 		wq->first_flusher = next;
237273f53c4aSTejun Heo 
237373f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
237473f53c4aSTejun Heo 			break;
237573f53c4aSTejun Heo 
237673f53c4aSTejun Heo 		/*
237773f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
237873f53c4aSTejun Heo 		 * flusher and repeat cascading.
237973f53c4aSTejun Heo 		 */
238073f53c4aSTejun Heo 		wq->first_flusher = NULL;
238173f53c4aSTejun Heo 	}
238273f53c4aSTejun Heo 
238373f53c4aSTejun Heo out_unlock:
238473f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
23851da177e4SLinus Torvalds }
2386ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
23871da177e4SLinus Torvalds 
23889c5a2ba7STejun Heo /**
23899c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
23909c5a2ba7STejun Heo  * @wq: workqueue to drain
23919c5a2ba7STejun Heo  *
23929c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
23939c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
23949c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
23959c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
23969c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
23979c5a2ba7STejun Heo  * takes too long.
23989c5a2ba7STejun Heo  */
23999c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
24009c5a2ba7STejun Heo {
24019c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
24029c5a2ba7STejun Heo 	unsigned int cpu;
24039c5a2ba7STejun Heo 
24049c5a2ba7STejun Heo 	/*
24059c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
24069c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
24079c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
24089c5a2ba7STejun Heo 	 */
24099c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24109c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
24119c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
24129c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24139c5a2ba7STejun Heo reflush:
24149c5a2ba7STejun Heo 	flush_workqueue(wq);
24159c5a2ba7STejun Heo 
24169c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
24179c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2418fa2563e4SThomas Tuttle 		bool drained;
24199c5a2ba7STejun Heo 
2420bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2421fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2422bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2423fa2563e4SThomas Tuttle 
2424fa2563e4SThomas Tuttle 		if (drained)
24259c5a2ba7STejun Heo 			continue;
24269c5a2ba7STejun Heo 
24279c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
24289c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
24299c5a2ba7STejun Heo 			pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
24309c5a2ba7STejun Heo 				   wq->name, flush_cnt);
24319c5a2ba7STejun Heo 		goto reflush;
24329c5a2ba7STejun Heo 	}
24339c5a2ba7STejun Heo 
24349c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24359c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
24369c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
24379c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24389c5a2ba7STejun Heo }
24399c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
24409c5a2ba7STejun Heo 
2441baf59022STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2442baf59022STejun Heo 			     bool wait_executing)
2443baf59022STejun Heo {
2444baf59022STejun Heo 	struct worker *worker = NULL;
2445baf59022STejun Heo 	struct global_cwq *gcwq;
2446baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2447baf59022STejun Heo 
2448baf59022STejun Heo 	might_sleep();
2449baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2450baf59022STejun Heo 	if (!gcwq)
2451baf59022STejun Heo 		return false;
2452baf59022STejun Heo 
2453baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2454baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2455baf59022STejun Heo 		/*
2456baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2457baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2458baf59022STejun Heo 		 * are not going to wait.
2459baf59022STejun Heo 		 */
2460baf59022STejun Heo 		smp_rmb();
2461baf59022STejun Heo 		cwq = get_work_cwq(work);
2462bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2463baf59022STejun Heo 			goto already_gone;
2464baf59022STejun Heo 	} else if (wait_executing) {
2465baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2466baf59022STejun Heo 		if (!worker)
2467baf59022STejun Heo 			goto already_gone;
2468baf59022STejun Heo 		cwq = worker->current_cwq;
2469baf59022STejun Heo 	} else
2470baf59022STejun Heo 		goto already_gone;
2471baf59022STejun Heo 
2472baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2473baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2474baf59022STejun Heo 
2475e159489bSTejun Heo 	/*
2476e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2477e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2478e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2479e159489bSTejun Heo 	 * access.
2480e159489bSTejun Heo 	 */
2481e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2482baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2483e159489bSTejun Heo 	else
2484e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2485baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2486e159489bSTejun Heo 
2487baf59022STejun Heo 	return true;
2488baf59022STejun Heo already_gone:
2489baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2490baf59022STejun Heo 	return false;
2491baf59022STejun Heo }
2492baf59022STejun Heo 
2493db700897SOleg Nesterov /**
2494401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2495401a8d04STejun Heo  * @work: the work to flush
2496db700897SOleg Nesterov  *
2497401a8d04STejun Heo  * Wait until @work has finished execution.  This function considers
2498401a8d04STejun Heo  * only the last queueing instance of @work.  If @work has been
2499401a8d04STejun Heo  * enqueued across different CPUs on a non-reentrant workqueue or on
2500401a8d04STejun Heo  * multiple workqueues, @work might still be executing on return on
2501401a8d04STejun Heo  * some of the CPUs from earlier queueing.
2502a67da70dSOleg Nesterov  *
2503401a8d04STejun Heo  * If @work was queued only on a non-reentrant, ordered or unbound
2504401a8d04STejun Heo  * workqueue, @work is guaranteed to be idle on return if it hasn't
2505401a8d04STejun Heo  * been requeued since flush started.
2506401a8d04STejun Heo  *
2507401a8d04STejun Heo  * RETURNS:
2508401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2509401a8d04STejun Heo  * %false if it was already idle.
2510db700897SOleg Nesterov  */
2511401a8d04STejun Heo bool flush_work(struct work_struct *work)
2512db700897SOleg Nesterov {
2513db700897SOleg Nesterov 	struct wq_barrier barr;
2514db700897SOleg Nesterov 
25150976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
25160976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
25170976dfc1SStephen Boyd 
2518baf59022STejun Heo 	if (start_flush_work(work, &barr, true)) {
2519db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2520dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2521401a8d04STejun Heo 		return true;
2522baf59022STejun Heo 	} else
2523401a8d04STejun Heo 		return false;
2524db700897SOleg Nesterov }
2525db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2526db700897SOleg Nesterov 
2527401a8d04STejun Heo static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2528401a8d04STejun Heo {
2529401a8d04STejun Heo 	struct wq_barrier barr;
2530401a8d04STejun Heo 	struct worker *worker;
2531401a8d04STejun Heo 
2532401a8d04STejun Heo 	spin_lock_irq(&gcwq->lock);
2533401a8d04STejun Heo 
2534401a8d04STejun Heo 	worker = find_worker_executing_work(gcwq, work);
2535401a8d04STejun Heo 	if (unlikely(worker))
2536401a8d04STejun Heo 		insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2537401a8d04STejun Heo 
2538401a8d04STejun Heo 	spin_unlock_irq(&gcwq->lock);
2539401a8d04STejun Heo 
2540401a8d04STejun Heo 	if (unlikely(worker)) {
2541401a8d04STejun Heo 		wait_for_completion(&barr.done);
2542401a8d04STejun Heo 		destroy_work_on_stack(&barr.work);
2543401a8d04STejun Heo 		return true;
2544401a8d04STejun Heo 	} else
2545401a8d04STejun Heo 		return false;
2546401a8d04STejun Heo }
2547401a8d04STejun Heo 
2548401a8d04STejun Heo static bool wait_on_work(struct work_struct *work)
2549401a8d04STejun Heo {
2550401a8d04STejun Heo 	bool ret = false;
2551401a8d04STejun Heo 	int cpu;
2552401a8d04STejun Heo 
2553401a8d04STejun Heo 	might_sleep();
2554401a8d04STejun Heo 
2555401a8d04STejun Heo 	lock_map_acquire(&work->lockdep_map);
2556401a8d04STejun Heo 	lock_map_release(&work->lockdep_map);
2557401a8d04STejun Heo 
2558401a8d04STejun Heo 	for_each_gcwq_cpu(cpu)
2559401a8d04STejun Heo 		ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2560401a8d04STejun Heo 	return ret;
2561401a8d04STejun Heo }
2562401a8d04STejun Heo 
256309383498STejun Heo /**
256409383498STejun Heo  * flush_work_sync - wait until a work has finished execution
256509383498STejun Heo  * @work: the work to flush
256609383498STejun Heo  *
256709383498STejun Heo  * Wait until @work has finished execution.  On return, it's
256809383498STejun Heo  * guaranteed that all queueing instances of @work which happened
256909383498STejun Heo  * before this function is called are finished.  In other words, if
257009383498STejun Heo  * @work hasn't been requeued since this function was called, @work is
257109383498STejun Heo  * guaranteed to be idle on return.
257209383498STejun Heo  *
257309383498STejun Heo  * RETURNS:
257409383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
257509383498STejun Heo  * %false if it was already idle.
257609383498STejun Heo  */
257709383498STejun Heo bool flush_work_sync(struct work_struct *work)
257809383498STejun Heo {
257909383498STejun Heo 	struct wq_barrier barr;
258009383498STejun Heo 	bool pending, waited;
258109383498STejun Heo 
258209383498STejun Heo 	/* we'll wait for executions separately, queue barr only if pending */
258309383498STejun Heo 	pending = start_flush_work(work, &barr, false);
258409383498STejun Heo 
258509383498STejun Heo 	/* wait for executions to finish */
258609383498STejun Heo 	waited = wait_on_work(work);
258709383498STejun Heo 
258809383498STejun Heo 	/* wait for the pending one */
258909383498STejun Heo 	if (pending) {
259009383498STejun Heo 		wait_for_completion(&barr.done);
259109383498STejun Heo 		destroy_work_on_stack(&barr.work);
259209383498STejun Heo 	}
259309383498STejun Heo 
259409383498STejun Heo 	return pending || waited;
259509383498STejun Heo }
259609383498STejun Heo EXPORT_SYMBOL_GPL(flush_work_sync);
259709383498STejun Heo 
25986e84d644SOleg Nesterov /*
25991f1f642eSOleg Nesterov  * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
26006e84d644SOleg Nesterov  * so this work can't be re-armed in any way.
26016e84d644SOleg Nesterov  */
26026e84d644SOleg Nesterov static int try_to_grab_pending(struct work_struct *work)
26036e84d644SOleg Nesterov {
26048b03ae3cSTejun Heo 	struct global_cwq *gcwq;
26051f1f642eSOleg Nesterov 	int ret = -1;
26066e84d644SOleg Nesterov 
260722df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
26081f1f642eSOleg Nesterov 		return 0;
26096e84d644SOleg Nesterov 
26106e84d644SOleg Nesterov 	/*
26116e84d644SOleg Nesterov 	 * The queueing is in progress, or it is already queued. Try to
26126e84d644SOleg Nesterov 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
26136e84d644SOleg Nesterov 	 */
26147a22ad75STejun Heo 	gcwq = get_work_gcwq(work);
26157a22ad75STejun Heo 	if (!gcwq)
26166e84d644SOleg Nesterov 		return ret;
26176e84d644SOleg Nesterov 
26188b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
26196e84d644SOleg Nesterov 	if (!list_empty(&work->entry)) {
26206e84d644SOleg Nesterov 		/*
26217a22ad75STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
26226e84d644SOleg Nesterov 		 * In that case we must see the new value after rmb(), see
26236e84d644SOleg Nesterov 		 * insert_work()->wmb().
26246e84d644SOleg Nesterov 		 */
26256e84d644SOleg Nesterov 		smp_rmb();
26267a22ad75STejun Heo 		if (gcwq == get_work_gcwq(work)) {
2627dc186ad7SThomas Gleixner 			debug_work_deactivate(work);
26286e84d644SOleg Nesterov 			list_del_init(&work->entry);
26297a22ad75STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
26308a2e8e5dSTejun Heo 				get_work_color(work),
26318a2e8e5dSTejun Heo 				*work_data_bits(work) & WORK_STRUCT_DELAYED);
26326e84d644SOleg Nesterov 			ret = 1;
26336e84d644SOleg Nesterov 		}
26346e84d644SOleg Nesterov 	}
26358b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
26366e84d644SOleg Nesterov 
26376e84d644SOleg Nesterov 	return ret;
26386e84d644SOleg Nesterov }
26396e84d644SOleg Nesterov 
2640401a8d04STejun Heo static bool __cancel_work_timer(struct work_struct *work,
26411f1f642eSOleg Nesterov 				struct timer_list* timer)
26421f1f642eSOleg Nesterov {
26431f1f642eSOleg Nesterov 	int ret;
26441f1f642eSOleg Nesterov 
26451f1f642eSOleg Nesterov 	do {
26461f1f642eSOleg Nesterov 		ret = (timer && likely(del_timer(timer)));
26471f1f642eSOleg Nesterov 		if (!ret)
26481f1f642eSOleg Nesterov 			ret = try_to_grab_pending(work);
26491f1f642eSOleg Nesterov 		wait_on_work(work);
26501f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
26511f1f642eSOleg Nesterov 
26527a22ad75STejun Heo 	clear_work_data(work);
26531f1f642eSOleg Nesterov 	return ret;
26541f1f642eSOleg Nesterov }
26551f1f642eSOleg Nesterov 
26566e84d644SOleg Nesterov /**
2657401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2658401a8d04STejun Heo  * @work: the work to cancel
26596e84d644SOleg Nesterov  *
2660401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2661401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2662401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2663401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
26641f1f642eSOleg Nesterov  *
2665401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2666401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
26676e84d644SOleg Nesterov  *
2668401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
26696e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2670401a8d04STejun Heo  *
2671401a8d04STejun Heo  * RETURNS:
2672401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
26736e84d644SOleg Nesterov  */
2674401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
26756e84d644SOleg Nesterov {
26761f1f642eSOleg Nesterov 	return __cancel_work_timer(work, NULL);
2677b89deed3SOleg Nesterov }
267828e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2679b89deed3SOleg Nesterov 
26806e84d644SOleg Nesterov /**
2681401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2682401a8d04STejun Heo  * @dwork: the delayed work to flush
26836e84d644SOleg Nesterov  *
2684401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2685401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2686401a8d04STejun Heo  * considers the last queueing instance of @dwork.
26871f1f642eSOleg Nesterov  *
2688401a8d04STejun Heo  * RETURNS:
2689401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2690401a8d04STejun Heo  * %false if it was already idle.
26916e84d644SOleg Nesterov  */
2692401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2693401a8d04STejun Heo {
2694401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
2695401a8d04STejun Heo 		__queue_work(raw_smp_processor_id(),
2696401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
2697401a8d04STejun Heo 	return flush_work(&dwork->work);
2698401a8d04STejun Heo }
2699401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2700401a8d04STejun Heo 
2701401a8d04STejun Heo /**
270209383498STejun Heo  * flush_delayed_work_sync - wait for a dwork to finish
270309383498STejun Heo  * @dwork: the delayed work to flush
270409383498STejun Heo  *
270509383498STejun Heo  * Delayed timer is cancelled and the pending work is queued for
270609383498STejun Heo  * execution immediately.  Other than timer handling, its behavior
270709383498STejun Heo  * is identical to flush_work_sync().
270809383498STejun Heo  *
270909383498STejun Heo  * RETURNS:
271009383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
271109383498STejun Heo  * %false if it was already idle.
271209383498STejun Heo  */
271309383498STejun Heo bool flush_delayed_work_sync(struct delayed_work *dwork)
271409383498STejun Heo {
271509383498STejun Heo 	if (del_timer_sync(&dwork->timer))
271609383498STejun Heo 		__queue_work(raw_smp_processor_id(),
271709383498STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
271809383498STejun Heo 	return flush_work_sync(&dwork->work);
271909383498STejun Heo }
272009383498STejun Heo EXPORT_SYMBOL(flush_delayed_work_sync);
272109383498STejun Heo 
272209383498STejun Heo /**
2723401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2724401a8d04STejun Heo  * @dwork: the delayed work cancel
2725401a8d04STejun Heo  *
2726401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2727401a8d04STejun Heo  *
2728401a8d04STejun Heo  * RETURNS:
2729401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2730401a8d04STejun Heo  */
2731401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
27326e84d644SOleg Nesterov {
27331f1f642eSOleg Nesterov 	return __cancel_work_timer(&dwork->work, &dwork->timer);
27346e84d644SOleg Nesterov }
2735f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
27361da177e4SLinus Torvalds 
27370fcb78c2SRolf Eike Beer /**
27380fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
27390fcb78c2SRolf Eike Beer  * @work: job to be done
27400fcb78c2SRolf Eike Beer  *
27415b0f437dSBart Van Assche  * Returns zero if @work was already on the kernel-global workqueue and
27425b0f437dSBart Van Assche  * non-zero otherwise.
27435b0f437dSBart Van Assche  *
27445b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
27455b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
27465b0f437dSBart Van Assche  * workqueue otherwise.
27470fcb78c2SRolf Eike Beer  */
27487ad5b3a5SHarvey Harrison int schedule_work(struct work_struct *work)
27491da177e4SLinus Torvalds {
2750d320c038STejun Heo 	return queue_work(system_wq, work);
27511da177e4SLinus Torvalds }
2752ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
27531da177e4SLinus Torvalds 
2754c1a220e7SZhang Rui /*
2755c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2756c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2757c1a220e7SZhang Rui  * @work: job to be done
2758c1a220e7SZhang Rui  *
2759c1a220e7SZhang Rui  * This puts a job on a specific cpu
2760c1a220e7SZhang Rui  */
2761c1a220e7SZhang Rui int schedule_work_on(int cpu, struct work_struct *work)
2762c1a220e7SZhang Rui {
2763d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2764c1a220e7SZhang Rui }
2765c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2766c1a220e7SZhang Rui 
27670fcb78c2SRolf Eike Beer /**
27680fcb78c2SRolf Eike Beer  * schedule_delayed_work - put work task in global workqueue after delay
276952bad64dSDavid Howells  * @dwork: job to be done
277052bad64dSDavid Howells  * @delay: number of jiffies to wait or 0 for immediate execution
27710fcb78c2SRolf Eike Beer  *
27720fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
27730fcb78c2SRolf Eike Beer  * workqueue.
27740fcb78c2SRolf Eike Beer  */
27757ad5b3a5SHarvey Harrison int schedule_delayed_work(struct delayed_work *dwork,
277682f67cd9SIngo Molnar 					unsigned long delay)
27771da177e4SLinus Torvalds {
2778d320c038STejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
27791da177e4SLinus Torvalds }
2780ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work);
27811da177e4SLinus Torvalds 
27820fcb78c2SRolf Eike Beer /**
27830fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
27840fcb78c2SRolf Eike Beer  * @cpu: cpu to use
278552bad64dSDavid Howells  * @dwork: job to be done
27860fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
27870fcb78c2SRolf Eike Beer  *
27880fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
27890fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
27900fcb78c2SRolf Eike Beer  */
27911da177e4SLinus Torvalds int schedule_delayed_work_on(int cpu,
279252bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
27931da177e4SLinus Torvalds {
2794d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
27951da177e4SLinus Torvalds }
2796ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
27971da177e4SLinus Torvalds 
2798b6136773SAndrew Morton /**
279931ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
2800b6136773SAndrew Morton  * @func: the function to call
2801b6136773SAndrew Morton  *
280231ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
280331ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
2804b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
280531ddd871STejun Heo  *
280631ddd871STejun Heo  * RETURNS:
280731ddd871STejun Heo  * 0 on success, -errno on failure.
2808b6136773SAndrew Morton  */
280965f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
281015316ba8SChristoph Lameter {
281115316ba8SChristoph Lameter 	int cpu;
281238f51568SNamhyung Kim 	struct work_struct __percpu *works;
281315316ba8SChristoph Lameter 
2814b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
2815b6136773SAndrew Morton 	if (!works)
281615316ba8SChristoph Lameter 		return -ENOMEM;
2817b6136773SAndrew Morton 
281895402b38SGautham R Shenoy 	get_online_cpus();
281993981800STejun Heo 
282015316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
28219bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
28229bfb1839SIngo Molnar 
28239bfb1839SIngo Molnar 		INIT_WORK(work, func);
28248de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
282515316ba8SChristoph Lameter 	}
282693981800STejun Heo 
282793981800STejun Heo 	for_each_online_cpu(cpu)
28288616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
282993981800STejun Heo 
283095402b38SGautham R Shenoy 	put_online_cpus();
2831b6136773SAndrew Morton 	free_percpu(works);
283215316ba8SChristoph Lameter 	return 0;
283315316ba8SChristoph Lameter }
283415316ba8SChristoph Lameter 
2835eef6a7d5SAlan Stern /**
2836eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
2837eef6a7d5SAlan Stern  *
2838eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
2839eef6a7d5SAlan Stern  * completion.
2840eef6a7d5SAlan Stern  *
2841eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
2842eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
2843eef6a7d5SAlan Stern  * will lead to deadlock:
2844eef6a7d5SAlan Stern  *
2845eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
2846eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
2847eef6a7d5SAlan Stern  *
2848eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
2849eef6a7d5SAlan Stern  *
2850eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
2851eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
2852eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
2853eef6a7d5SAlan Stern  *
2854eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
2855eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
2856eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
2857eef6a7d5SAlan Stern  * cancel_work_sync() instead.
2858eef6a7d5SAlan Stern  */
28591da177e4SLinus Torvalds void flush_scheduled_work(void)
28601da177e4SLinus Torvalds {
2861d320c038STejun Heo 	flush_workqueue(system_wq);
28621da177e4SLinus Torvalds }
2863ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
28641da177e4SLinus Torvalds 
28651da177e4SLinus Torvalds /**
28661fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
28671fa44ecaSJames Bottomley  * @fn:		the function to execute
28681fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
28691fa44ecaSJames Bottomley  *		be available when the work executes)
28701fa44ecaSJames Bottomley  *
28711fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
28721fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
28731fa44ecaSJames Bottomley  *
28741fa44ecaSJames Bottomley  * Returns:	0 - function was executed
28751fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
28761fa44ecaSJames Bottomley  */
287765f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
28781fa44ecaSJames Bottomley {
28791fa44ecaSJames Bottomley 	if (!in_interrupt()) {
288065f27f38SDavid Howells 		fn(&ew->work);
28811fa44ecaSJames Bottomley 		return 0;
28821fa44ecaSJames Bottomley 	}
28831fa44ecaSJames Bottomley 
288465f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
28851fa44ecaSJames Bottomley 	schedule_work(&ew->work);
28861fa44ecaSJames Bottomley 
28871fa44ecaSJames Bottomley 	return 1;
28881fa44ecaSJames Bottomley }
28891fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
28901fa44ecaSJames Bottomley 
28911da177e4SLinus Torvalds int keventd_up(void)
28921da177e4SLinus Torvalds {
2893d320c038STejun Heo 	return system_wq != NULL;
28941da177e4SLinus Torvalds }
28951da177e4SLinus Torvalds 
2896bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
28971da177e4SLinus Torvalds {
28983af24433SOleg Nesterov 	/*
28990f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
29000f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
29010f900049STejun Heo 	 * unsigned long long.
29023af24433SOleg Nesterov 	 */
29030f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
29040f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
29050f900049STejun Heo 				   __alignof__(unsigned long long));
29063af24433SOleg Nesterov 
2907e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2908f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2909931ac77eSTejun Heo 	else {
29100f900049STejun Heo 		void *ptr;
2911e1d8aa9fSFrederic Weisbecker 
29120f900049STejun Heo 		/*
2913f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
2914f3421797STejun Heo 		 * pointer at the end pointing back to the originally
2915f3421797STejun Heo 		 * allocated pointer which will be used for free.
29160f900049STejun Heo 		 */
2917bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2918bdbc5dd7STejun Heo 		if (ptr) {
2919bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2920bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
2921bdbc5dd7STejun Heo 		}
29223af24433SOleg Nesterov 	}
29233af24433SOleg Nesterov 
29240415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
2925bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2926bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
29270f900049STejun Heo }
29280f900049STejun Heo 
2929bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
293006ba38a9SOleg Nesterov {
2931e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2932bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
2933f3421797STejun Heo 	else if (wq->cpu_wq.single) {
2934f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
2935f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
293606ba38a9SOleg Nesterov 	}
293706ba38a9SOleg Nesterov }
293806ba38a9SOleg Nesterov 
2939f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
2940f3421797STejun Heo 			       const char *name)
2941b71ab8c2STejun Heo {
2942f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2943f3421797STejun Heo 
2944f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
2945b71ab8c2STejun Heo 		printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2946b71ab8c2STejun Heo 		       "is out of range, clamping between %d and %d\n",
2947f3421797STejun Heo 		       max_active, name, 1, lim);
2948b71ab8c2STejun Heo 
2949f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
2950b71ab8c2STejun Heo }
2951b71ab8c2STejun Heo 
2952b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
295397e37d7bSTejun Heo 					       unsigned int flags,
29541e19ffc6STejun Heo 					       int max_active,
2955eb13ba87SJohannes Berg 					       struct lock_class_key *key,
2956b196be89STejun Heo 					       const char *lock_name, ...)
29573af24433SOleg Nesterov {
2958b196be89STejun Heo 	va_list args, args1;
29593af24433SOleg Nesterov 	struct workqueue_struct *wq;
2960c34056a3STejun Heo 	unsigned int cpu;
2961b196be89STejun Heo 	size_t namelen;
2962b196be89STejun Heo 
2963b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
2964b196be89STejun Heo 	va_start(args, lock_name);
2965b196be89STejun Heo 	va_copy(args1, args);
2966b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
2967b196be89STejun Heo 
2968b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
2969b196be89STejun Heo 	if (!wq)
2970b196be89STejun Heo 		goto err;
2971b196be89STejun Heo 
2972b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
2973b196be89STejun Heo 	va_end(args);
2974b196be89STejun Heo 	va_end(args1);
29753af24433SOleg Nesterov 
2976f3421797STejun Heo 	/*
29776370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
29786370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
29796370a6adSTejun Heo 	 */
29806370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
29816370a6adSTejun Heo 		flags |= WQ_RESCUER;
29826370a6adSTejun Heo 
2983d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
2984b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
29853af24433SOleg Nesterov 
2986b196be89STejun Heo 	/* init wq */
298797e37d7bSTejun Heo 	wq->flags = flags;
2988a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
298973f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
299073f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
299173f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
299273f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
29933af24433SOleg Nesterov 
2994eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
2995cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
29963af24433SOleg Nesterov 
2997bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
2998bdbc5dd7STejun Heo 		goto err;
2999bdbc5dd7STejun Heo 
3000f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
30011537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
30028b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
30033270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
30041537663fSTejun Heo 
30050f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
30063270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3007c34056a3STejun Heo 		cwq->wq = wq;
300873f53c4aSTejun Heo 		cwq->flush_color = -1;
30091e19ffc6STejun Heo 		cwq->max_active = max_active;
30101e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3011e22bee78STejun Heo 	}
30121537663fSTejun Heo 
3013e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3014e22bee78STejun Heo 		struct worker *rescuer;
3015e22bee78STejun Heo 
3016f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3017e22bee78STejun Heo 			goto err;
3018e22bee78STejun Heo 
3019e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3020e22bee78STejun Heo 		if (!rescuer)
3021e22bee78STejun Heo 			goto err;
3022e22bee78STejun Heo 
3023b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3024b196be89STejun Heo 					       wq->name);
3025e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3026e22bee78STejun Heo 			goto err;
3027e22bee78STejun Heo 
3028e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3029e22bee78STejun Heo 		wake_up_process(rescuer->task);
30303af24433SOleg Nesterov 	}
30311537663fSTejun Heo 
30323af24433SOleg Nesterov 	/*
3033a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3034a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3035a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
30363af24433SOleg Nesterov 	 */
30373af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3038a0a1a5fdSTejun Heo 
303958a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3040f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3041a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3042a0a1a5fdSTejun Heo 
30433af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3044a0a1a5fdSTejun Heo 
30453af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
30463af24433SOleg Nesterov 
30473af24433SOleg Nesterov 	return wq;
30484690c4abSTejun Heo err:
30494690c4abSTejun Heo 	if (wq) {
3050bdbc5dd7STejun Heo 		free_cwqs(wq);
3051f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3052e22bee78STejun Heo 		kfree(wq->rescuer);
30534690c4abSTejun Heo 		kfree(wq);
30543af24433SOleg Nesterov 	}
30554690c4abSTejun Heo 	return NULL;
30561da177e4SLinus Torvalds }
3057d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
30581da177e4SLinus Torvalds 
30593af24433SOleg Nesterov /**
30603af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
30613af24433SOleg Nesterov  * @wq: target workqueue
30623af24433SOleg Nesterov  *
30633af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
30643af24433SOleg Nesterov  */
30653af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
30663af24433SOleg Nesterov {
3067c8e55f36STejun Heo 	unsigned int cpu;
30683af24433SOleg Nesterov 
30699c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
30709c5a2ba7STejun Heo 	drain_workqueue(wq);
3071c8efcc25STejun Heo 
3072a0a1a5fdSTejun Heo 	/*
3073a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3074a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3075a0a1a5fdSTejun Heo 	 */
307695402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
30773af24433SOleg Nesterov 	list_del(&wq->list);
307895402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
30793af24433SOleg Nesterov 
3080e22bee78STejun Heo 	/* sanity check */
3081f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
308273f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
308373f53c4aSTejun Heo 		int i;
30843af24433SOleg Nesterov 
308573f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
308673f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
30871e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
30881e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
308973f53c4aSTejun Heo 	}
30901537663fSTejun Heo 
3091e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3092e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3093f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
30948d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3095e22bee78STejun Heo 	}
3096e22bee78STejun Heo 
3097bdbc5dd7STejun Heo 	free_cwqs(wq);
30983af24433SOleg Nesterov 	kfree(wq);
30993af24433SOleg Nesterov }
31003af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
31013af24433SOleg Nesterov 
3102dcd989cbSTejun Heo /**
3103dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3104dcd989cbSTejun Heo  * @wq: target workqueue
3105dcd989cbSTejun Heo  * @max_active: new max_active value.
3106dcd989cbSTejun Heo  *
3107dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3108dcd989cbSTejun Heo  *
3109dcd989cbSTejun Heo  * CONTEXT:
3110dcd989cbSTejun Heo  * Don't call from IRQ context.
3111dcd989cbSTejun Heo  */
3112dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3113dcd989cbSTejun Heo {
3114dcd989cbSTejun Heo 	unsigned int cpu;
3115dcd989cbSTejun Heo 
3116f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3117dcd989cbSTejun Heo 
3118dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3119dcd989cbSTejun Heo 
3120dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3121dcd989cbSTejun Heo 
3122f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3123dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3124dcd989cbSTejun Heo 
3125dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3126dcd989cbSTejun Heo 
312758a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3128dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3129dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3130dcd989cbSTejun Heo 
3131dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3132dcd989cbSTejun Heo 	}
3133dcd989cbSTejun Heo 
3134dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3135dcd989cbSTejun Heo }
3136dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3137dcd989cbSTejun Heo 
3138dcd989cbSTejun Heo /**
3139dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3140dcd989cbSTejun Heo  * @cpu: CPU in question
3141dcd989cbSTejun Heo  * @wq: target workqueue
3142dcd989cbSTejun Heo  *
3143dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3144dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3145dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3146dcd989cbSTejun Heo  *
3147dcd989cbSTejun Heo  * RETURNS:
3148dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3149dcd989cbSTejun Heo  */
3150dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3151dcd989cbSTejun Heo {
3152dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3153dcd989cbSTejun Heo 
3154dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3155dcd989cbSTejun Heo }
3156dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3157dcd989cbSTejun Heo 
3158dcd989cbSTejun Heo /**
3159dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3160dcd989cbSTejun Heo  * @work: the work of interest
3161dcd989cbSTejun Heo  *
3162dcd989cbSTejun Heo  * RETURNS:
3163bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3164dcd989cbSTejun Heo  */
3165dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3166dcd989cbSTejun Heo {
3167dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3168dcd989cbSTejun Heo 
3169bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3170dcd989cbSTejun Heo }
3171dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3172dcd989cbSTejun Heo 
3173dcd989cbSTejun Heo /**
3174dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3175dcd989cbSTejun Heo  * @work: the work to be tested
3176dcd989cbSTejun Heo  *
3177dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3178dcd989cbSTejun Heo  * synchronization around this function and the test result is
3179dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3180dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3181dcd989cbSTejun Heo  * running state.
3182dcd989cbSTejun Heo  *
3183dcd989cbSTejun Heo  * RETURNS:
3184dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3185dcd989cbSTejun Heo  */
3186dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3187dcd989cbSTejun Heo {
3188dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3189dcd989cbSTejun Heo 	unsigned long flags;
3190dcd989cbSTejun Heo 	unsigned int ret = 0;
3191dcd989cbSTejun Heo 
3192dcd989cbSTejun Heo 	if (!gcwq)
3193dcd989cbSTejun Heo 		return false;
3194dcd989cbSTejun Heo 
3195dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3196dcd989cbSTejun Heo 
3197dcd989cbSTejun Heo 	if (work_pending(work))
3198dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3199dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3200dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3201dcd989cbSTejun Heo 
3202dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3203dcd989cbSTejun Heo 
3204dcd989cbSTejun Heo 	return ret;
3205dcd989cbSTejun Heo }
3206dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3207dcd989cbSTejun Heo 
3208db7bccf4STejun Heo /*
3209db7bccf4STejun Heo  * CPU hotplug.
3210db7bccf4STejun Heo  *
3211e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3212e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3213e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3214e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3215e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3216e22bee78STejun Heo  * blocked draining impractical.
3217e22bee78STejun Heo  *
3218e22bee78STejun Heo  * This is solved by allowing a gcwq to be detached from CPU, running
3219e22bee78STejun Heo  * it with unbound (rogue) workers and allowing it to be reattached
3220e22bee78STejun Heo  * later if the cpu comes back online.  A separate thread is created
3221e22bee78STejun Heo  * to govern a gcwq in such state and is called the trustee of the
3222e22bee78STejun Heo  * gcwq.
3223db7bccf4STejun Heo  *
3224db7bccf4STejun Heo  * Trustee states and their descriptions.
3225db7bccf4STejun Heo  *
3226db7bccf4STejun Heo  * START	Command state used on startup.  On CPU_DOWN_PREPARE, a
3227db7bccf4STejun Heo  *		new trustee is started with this state.
3228db7bccf4STejun Heo  *
3229db7bccf4STejun Heo  * IN_CHARGE	Once started, trustee will enter this state after
3230e22bee78STejun Heo  *		assuming the manager role and making all existing
3231e22bee78STejun Heo  *		workers rogue.  DOWN_PREPARE waits for trustee to
3232e22bee78STejun Heo  *		enter this state.  After reaching IN_CHARGE, trustee
3233e22bee78STejun Heo  *		tries to execute the pending worklist until it's empty
3234e22bee78STejun Heo  *		and the state is set to BUTCHER, or the state is set
3235e22bee78STejun Heo  *		to RELEASE.
3236db7bccf4STejun Heo  *
3237db7bccf4STejun Heo  * BUTCHER	Command state which is set by the cpu callback after
3238db7bccf4STejun Heo  *		the cpu has went down.  Once this state is set trustee
3239db7bccf4STejun Heo  *		knows that there will be no new works on the worklist
3240db7bccf4STejun Heo  *		and once the worklist is empty it can proceed to
3241db7bccf4STejun Heo  *		killing idle workers.
3242db7bccf4STejun Heo  *
3243db7bccf4STejun Heo  * RELEASE	Command state which is set by the cpu callback if the
3244db7bccf4STejun Heo  *		cpu down has been canceled or it has come online
3245db7bccf4STejun Heo  *		again.  After recognizing this state, trustee stops
3246e22bee78STejun Heo  *		trying to drain or butcher and clears ROGUE, rebinds
3247e22bee78STejun Heo  *		all remaining workers back to the cpu and releases
3248e22bee78STejun Heo  *		manager role.
3249db7bccf4STejun Heo  *
3250db7bccf4STejun Heo  * DONE		Trustee will enter this state after BUTCHER or RELEASE
3251db7bccf4STejun Heo  *		is complete.
3252db7bccf4STejun Heo  *
3253db7bccf4STejun Heo  *          trustee                 CPU                draining
3254db7bccf4STejun Heo  *         took over                down               complete
3255db7bccf4STejun Heo  * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3256db7bccf4STejun Heo  *                        |                     |                  ^
3257db7bccf4STejun Heo  *                        | CPU is back online  v   return workers |
3258db7bccf4STejun Heo  *                         ----------------> RELEASE --------------
3259db7bccf4STejun Heo  */
3260db7bccf4STejun Heo 
3261db7bccf4STejun Heo /**
3262db7bccf4STejun Heo  * trustee_wait_event_timeout - timed event wait for trustee
3263db7bccf4STejun Heo  * @cond: condition to wait for
3264db7bccf4STejun Heo  * @timeout: timeout in jiffies
3265db7bccf4STejun Heo  *
3266db7bccf4STejun Heo  * wait_event_timeout() for trustee to use.  Handles locking and
3267db7bccf4STejun Heo  * checks for RELEASE request.
3268db7bccf4STejun Heo  *
3269db7bccf4STejun Heo  * CONTEXT:
3270db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3271db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3272db7bccf4STejun Heo  *
3273db7bccf4STejun Heo  * RETURNS:
3274db7bccf4STejun Heo  * Positive indicating left time if @cond is satisfied, 0 if timed
3275db7bccf4STejun Heo  * out, -1 if canceled.
3276db7bccf4STejun Heo  */
3277db7bccf4STejun Heo #define trustee_wait_event_timeout(cond, timeout) ({			\
3278db7bccf4STejun Heo 	long __ret = (timeout);						\
3279db7bccf4STejun Heo 	while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) &&	\
3280db7bccf4STejun Heo 	       __ret) {							\
3281db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);				\
3282db7bccf4STejun Heo 		__wait_event_timeout(gcwq->trustee_wait, (cond) ||	\
3283db7bccf4STejun Heo 			(gcwq->trustee_state == TRUSTEE_RELEASE),	\
3284db7bccf4STejun Heo 			__ret);						\
3285db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);				\
3286db7bccf4STejun Heo 	}								\
3287db7bccf4STejun Heo 	gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret);		\
3288db7bccf4STejun Heo })
3289db7bccf4STejun Heo 
3290db7bccf4STejun Heo /**
3291db7bccf4STejun Heo  * trustee_wait_event - event wait for trustee
3292db7bccf4STejun Heo  * @cond: condition to wait for
3293db7bccf4STejun Heo  *
3294db7bccf4STejun Heo  * wait_event() for trustee to use.  Automatically handles locking and
3295db7bccf4STejun Heo  * checks for CANCEL request.
3296db7bccf4STejun Heo  *
3297db7bccf4STejun Heo  * CONTEXT:
3298db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3299db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3300db7bccf4STejun Heo  *
3301db7bccf4STejun Heo  * RETURNS:
3302db7bccf4STejun Heo  * 0 if @cond is satisfied, -1 if canceled.
3303db7bccf4STejun Heo  */
3304db7bccf4STejun Heo #define trustee_wait_event(cond) ({					\
3305db7bccf4STejun Heo 	long __ret1;							\
3306db7bccf4STejun Heo 	__ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3307db7bccf4STejun Heo 	__ret1 < 0 ? -1 : 0;						\
3308db7bccf4STejun Heo })
3309db7bccf4STejun Heo 
33104ce62e9eSTejun Heo static bool gcwq_is_managing_workers(struct global_cwq *gcwq)
33114ce62e9eSTejun Heo {
33124ce62e9eSTejun Heo 	struct worker_pool *pool;
33134ce62e9eSTejun Heo 
33144ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
33154ce62e9eSTejun Heo 		if (pool->flags & POOL_MANAGING_WORKERS)
33164ce62e9eSTejun Heo 			return true;
33174ce62e9eSTejun Heo 	return false;
33184ce62e9eSTejun Heo }
33194ce62e9eSTejun Heo 
33204ce62e9eSTejun Heo static bool gcwq_has_idle_workers(struct global_cwq *gcwq)
33214ce62e9eSTejun Heo {
33224ce62e9eSTejun Heo 	struct worker_pool *pool;
33234ce62e9eSTejun Heo 
33244ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
33254ce62e9eSTejun Heo 		if (!list_empty(&pool->idle_list))
33264ce62e9eSTejun Heo 			return true;
33274ce62e9eSTejun Heo 	return false;
33284ce62e9eSTejun Heo }
33294ce62e9eSTejun Heo 
3330db7bccf4STejun Heo static int __cpuinit trustee_thread(void *__gcwq)
3331db7bccf4STejun Heo {
3332db7bccf4STejun Heo 	struct global_cwq *gcwq = __gcwq;
33334ce62e9eSTejun Heo 	struct worker_pool *pool;
3334db7bccf4STejun Heo 	struct worker *worker;
3335e22bee78STejun Heo 	struct work_struct *work;
3336db7bccf4STejun Heo 	struct hlist_node *pos;
3337e22bee78STejun Heo 	long rc;
3338db7bccf4STejun Heo 	int i;
3339db7bccf4STejun Heo 
3340db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3341db7bccf4STejun Heo 
3342db7bccf4STejun Heo 	spin_lock_irq(&gcwq->lock);
3343db7bccf4STejun Heo 	/*
3344e22bee78STejun Heo 	 * Claim the manager position and make all workers rogue.
3345e22bee78STejun Heo 	 * Trustee must be bound to the target cpu and can't be
3346e22bee78STejun Heo 	 * cancelled.
3347db7bccf4STejun Heo 	 */
3348db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
33494ce62e9eSTejun Heo 	rc = trustee_wait_event(!gcwq_is_managing_workers(gcwq));
3350e22bee78STejun Heo 	BUG_ON(rc < 0);
3351e22bee78STejun Heo 
3352*f2d5a0eeSTejun Heo 	/*
3353*f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3354*f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3355*f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3356*f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3357*f2d5a0eeSTejun Heo 	 */
33584ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq) {
33594ce62e9eSTejun Heo 		pool->flags |= POOL_MANAGING_WORKERS;
3360db7bccf4STejun Heo 
33614ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3362cb444766STejun Heo 			worker->flags |= WORKER_ROGUE;
33634ce62e9eSTejun Heo 	}
3364db7bccf4STejun Heo 
3365db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3366cb444766STejun Heo 		worker->flags |= WORKER_ROGUE;
3367db7bccf4STejun Heo 
3368*f2d5a0eeSTejun Heo 	gcwq->flags |= GCWQ_DISASSOCIATED;
3369*f2d5a0eeSTejun Heo 
3370db7bccf4STejun Heo 	/*
3371e22bee78STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can
3372e22bee78STejun Heo 	 * guarantee sched callbacks see the rogue flag.  This is
3373e22bee78STejun Heo 	 * necessary as scheduler callbacks may be invoked from other
3374e22bee78STejun Heo 	 * cpus.
3375e22bee78STejun Heo 	 */
3376e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3377e22bee78STejun Heo 	schedule();
3378e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3379e22bee78STejun Heo 
3380e22bee78STejun Heo 	/*
3381cb444766STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After
3382cb444766STejun Heo 	 * this, nr_running stays zero and need_more_worker() and
3383cb444766STejun Heo 	 * keep_working() are always true as long as the worklist is
3384cb444766STejun Heo 	 * not empty.
3385e22bee78STejun Heo 	 */
33864ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
33874ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3388e22bee78STejun Heo 
3389e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
33904ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
33914ce62e9eSTejun Heo 		del_timer_sync(&pool->idle_timer);
3392e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3393e22bee78STejun Heo 
3394e22bee78STejun Heo 	/*
3395db7bccf4STejun Heo 	 * We're now in charge.  Notify and proceed to drain.  We need
3396db7bccf4STejun Heo 	 * to keep the gcwq running during the whole CPU down
3397db7bccf4STejun Heo 	 * procedure as other cpu hotunplug callbacks may need to
3398db7bccf4STejun Heo 	 * flush currently running tasks.
3399db7bccf4STejun Heo 	 */
3400db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3401db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3402db7bccf4STejun Heo 
3403db7bccf4STejun Heo 	/*
3404db7bccf4STejun Heo 	 * The original cpu is in the process of dying and may go away
3405db7bccf4STejun Heo 	 * anytime now.  When that happens, we and all workers would
3406e22bee78STejun Heo 	 * be migrated to other cpus.  Try draining any left work.  We
3407e22bee78STejun Heo 	 * want to get it over with ASAP - spam rescuers, wake up as
3408e22bee78STejun Heo 	 * many idlers as necessary and create new ones till the
3409e22bee78STejun Heo 	 * worklist is empty.  Note that if the gcwq is frozen, there
341058a69cb4STejun Heo 	 * may be frozen works in freezable cwqs.  Don't declare
3411e22bee78STejun Heo 	 * completion while frozen.
3412db7bccf4STejun Heo 	 */
34134ce62e9eSTejun Heo 	while (true) {
34144ce62e9eSTejun Heo 		bool busy = false;
34154ce62e9eSTejun Heo 
34164ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
34174ce62e9eSTejun Heo 			busy |= pool->nr_workers != pool->nr_idle;
34184ce62e9eSTejun Heo 
34194ce62e9eSTejun Heo 		if (!busy && !(gcwq->flags & GCWQ_FREEZING) &&
34204ce62e9eSTejun Heo 		    gcwq->trustee_state != TRUSTEE_IN_CHARGE)
34214ce62e9eSTejun Heo 			break;
34224ce62e9eSTejun Heo 
34234ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3424e22bee78STejun Heo 			int nr_works = 0;
3425e22bee78STejun Heo 
34264ce62e9eSTejun Heo 			list_for_each_entry(work, &pool->worklist, entry) {
3427e22bee78STejun Heo 				send_mayday(work);
3428e22bee78STejun Heo 				nr_works++;
3429e22bee78STejun Heo 			}
3430e22bee78STejun Heo 
34314ce62e9eSTejun Heo 			list_for_each_entry(worker, &pool->idle_list, entry) {
3432e22bee78STejun Heo 				if (!nr_works--)
3433e22bee78STejun Heo 					break;
3434e22bee78STejun Heo 				wake_up_process(worker->task);
3435e22bee78STejun Heo 			}
3436e22bee78STejun Heo 
34374ce62e9eSTejun Heo 			if (need_to_create_worker(pool)) {
3438e22bee78STejun Heo 				spin_unlock_irq(&gcwq->lock);
34394ce62e9eSTejun Heo 				worker = create_worker(pool, false);
3440e22bee78STejun Heo 				spin_lock_irq(&gcwq->lock);
3441e22bee78STejun Heo 				if (worker) {
3442cb444766STejun Heo 					worker->flags |= WORKER_ROGUE;
3443e22bee78STejun Heo 					start_worker(worker);
3444e22bee78STejun Heo 				}
3445e22bee78STejun Heo 			}
34464ce62e9eSTejun Heo 		}
3447e22bee78STejun Heo 
3448db7bccf4STejun Heo 		/* give a breather */
3449db7bccf4STejun Heo 		if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3450db7bccf4STejun Heo 			break;
3451db7bccf4STejun Heo 	}
3452db7bccf4STejun Heo 
3453e22bee78STejun Heo 	/*
3454e22bee78STejun Heo 	 * Either all works have been scheduled and cpu is down, or
3455e22bee78STejun Heo 	 * cpu down has already been canceled.  Wait for and butcher
3456e22bee78STejun Heo 	 * all workers till we're canceled.
3457e22bee78STejun Heo 	 */
3458e22bee78STejun Heo 	do {
34594ce62e9eSTejun Heo 		rc = trustee_wait_event(gcwq_has_idle_workers(gcwq));
34604ce62e9eSTejun Heo 
34614ce62e9eSTejun Heo 		i = 0;
34624ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
34634ce62e9eSTejun Heo 			while (!list_empty(&pool->idle_list)) {
34644ce62e9eSTejun Heo 				worker = list_first_entry(&pool->idle_list,
34654ce62e9eSTejun Heo 							  struct worker, entry);
34664ce62e9eSTejun Heo 				destroy_worker(worker);
34674ce62e9eSTejun Heo 			}
34684ce62e9eSTejun Heo 			i |= pool->nr_workers;
34694ce62e9eSTejun Heo 		}
34704ce62e9eSTejun Heo 	} while (i && rc >= 0);
3471e22bee78STejun Heo 
3472e22bee78STejun Heo 	/*
3473e22bee78STejun Heo 	 * At this point, either draining has completed and no worker
3474e22bee78STejun Heo 	 * is left, or cpu down has been canceled or the cpu is being
3475e22bee78STejun Heo 	 * brought back up.  There shouldn't be any idle one left.
3476e22bee78STejun Heo 	 * Tell the remaining busy ones to rebind once it finishes the
3477e22bee78STejun Heo 	 * currently scheduled works by scheduling the rebind_work.
3478e22bee78STejun Heo 	 */
34794ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
34804ce62e9eSTejun Heo 		WARN_ON(!list_empty(&pool->idle_list));
3481e22bee78STejun Heo 
3482e22bee78STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
3483e22bee78STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
3484e22bee78STejun Heo 
3485e22bee78STejun Heo 		/*
3486e22bee78STejun Heo 		 * Rebind_work may race with future cpu hotplug
3487e22bee78STejun Heo 		 * operations.  Use a separate flag to mark that
3488e22bee78STejun Heo 		 * rebinding is scheduled.
3489e22bee78STejun Heo 		 */
3490cb444766STejun Heo 		worker->flags |= WORKER_REBIND;
3491cb444766STejun Heo 		worker->flags &= ~WORKER_ROGUE;
3492e22bee78STejun Heo 
3493e22bee78STejun Heo 		/* queue rebind_work, wq doesn't matter, use the default one */
3494e22bee78STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3495e22bee78STejun Heo 				     work_data_bits(rebind_work)))
3496e22bee78STejun Heo 			continue;
3497e22bee78STejun Heo 
3498e22bee78STejun Heo 		debug_work_activate(rebind_work);
3499d320c038STejun Heo 		insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3500e22bee78STejun Heo 			    worker->scheduled.next,
3501e22bee78STejun Heo 			    work_color_to_flags(WORK_NO_COLOR));
3502e22bee78STejun Heo 	}
3503e22bee78STejun Heo 
3504e22bee78STejun Heo 	/* relinquish manager role */
35054ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35064ce62e9eSTejun Heo 		pool->flags &= ~POOL_MANAGING_WORKERS;
3507e22bee78STejun Heo 
3508db7bccf4STejun Heo 	/* notify completion */
3509db7bccf4STejun Heo 	gcwq->trustee = NULL;
3510db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_DONE;
3511db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3512db7bccf4STejun Heo 	spin_unlock_irq(&gcwq->lock);
3513db7bccf4STejun Heo 	return 0;
3514db7bccf4STejun Heo }
3515db7bccf4STejun Heo 
3516db7bccf4STejun Heo /**
3517db7bccf4STejun Heo  * wait_trustee_state - wait for trustee to enter the specified state
3518db7bccf4STejun Heo  * @gcwq: gcwq the trustee of interest belongs to
3519db7bccf4STejun Heo  * @state: target state to wait for
3520db7bccf4STejun Heo  *
3521db7bccf4STejun Heo  * Wait for the trustee to reach @state.  DONE is already matched.
3522db7bccf4STejun Heo  *
3523db7bccf4STejun Heo  * CONTEXT:
3524db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3525db7bccf4STejun Heo  * multiple times.  To be used by cpu_callback.
3526db7bccf4STejun Heo  */
3527db7bccf4STejun Heo static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
352806bd6ebfSNamhyung Kim __releases(&gcwq->lock)
352906bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
3530db7bccf4STejun Heo {
3531db7bccf4STejun Heo 	if (!(gcwq->trustee_state == state ||
3532db7bccf4STejun Heo 	      gcwq->trustee_state == TRUSTEE_DONE)) {
3533db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);
3534db7bccf4STejun Heo 		__wait_event(gcwq->trustee_wait,
3535db7bccf4STejun Heo 			     gcwq->trustee_state == state ||
3536db7bccf4STejun Heo 			     gcwq->trustee_state == TRUSTEE_DONE);
3537db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);
3538db7bccf4STejun Heo 	}
3539db7bccf4STejun Heo }
3540db7bccf4STejun Heo 
35419c7b216dSChandra Seetharaman static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
35421da177e4SLinus Torvalds 						unsigned long action,
35431da177e4SLinus Torvalds 						void *hcpu)
35441da177e4SLinus Torvalds {
35453af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3546db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
3547db7bccf4STejun Heo 	struct task_struct *new_trustee = NULL;
35484ce62e9eSTejun Heo 	struct worker *new_workers[NR_WORKER_POOLS] = { };
35494ce62e9eSTejun Heo 	struct worker_pool *pool;
3550db7bccf4STejun Heo 	unsigned long flags;
35514ce62e9eSTejun Heo 	int i;
35521da177e4SLinus Torvalds 
35538bb78442SRafael J. Wysocki 	action &= ~CPU_TASKS_FROZEN;
35548bb78442SRafael J. Wysocki 
35551da177e4SLinus Torvalds 	switch (action) {
3556db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3557db7bccf4STejun Heo 		new_trustee = kthread_create(trustee_thread, gcwq,
3558db7bccf4STejun Heo 					     "workqueue_trustee/%d\n", cpu);
3559db7bccf4STejun Heo 		if (IS_ERR(new_trustee))
3560db7bccf4STejun Heo 			return notifier_from_errno(PTR_ERR(new_trustee));
3561db7bccf4STejun Heo 		kthread_bind(new_trustee, cpu);
3562e22bee78STejun Heo 		/* fall through */
35633af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35644ce62e9eSTejun Heo 		i = 0;
35654ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35664ce62e9eSTejun Heo 			BUG_ON(pool->first_idle);
35674ce62e9eSTejun Heo 			new_workers[i] = create_worker(pool, false);
35684ce62e9eSTejun Heo 			if (!new_workers[i++])
35694ce62e9eSTejun Heo 				goto err_destroy;
35703af24433SOleg Nesterov 		}
3571db7bccf4STejun Heo 	}
35721537663fSTejun Heo 
3573db7bccf4STejun Heo 	/* some are called w/ irq disabled, don't disturb irq status */
3574db7bccf4STejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
35753af24433SOleg Nesterov 
35763af24433SOleg Nesterov 	switch (action) {
3577db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3578db7bccf4STejun Heo 		/* initialize trustee and tell it to acquire the gcwq */
3579db7bccf4STejun Heo 		BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3580db7bccf4STejun Heo 		gcwq->trustee = new_trustee;
3581db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_START;
3582db7bccf4STejun Heo 		wake_up_process(gcwq->trustee);
3583db7bccf4STejun Heo 		wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3584e22bee78STejun Heo 		/* fall through */
35853af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35864ce62e9eSTejun Heo 		i = 0;
35874ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35884ce62e9eSTejun Heo 			BUG_ON(pool->first_idle);
35894ce62e9eSTejun Heo 			pool->first_idle = new_workers[i++];
35904ce62e9eSTejun Heo 		}
35911da177e4SLinus Torvalds 		break;
35921da177e4SLinus Torvalds 
35933da1c84cSOleg Nesterov 	case CPU_POST_DEAD:
3594db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_BUTCHER;
3595e22bee78STejun Heo 		/* fall through */
3596e22bee78STejun Heo 	case CPU_UP_CANCELED:
35974ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35984ce62e9eSTejun Heo 			destroy_worker(pool->first_idle);
35994ce62e9eSTejun Heo 			pool->first_idle = NULL;
36004ce62e9eSTejun Heo 		}
3601db7bccf4STejun Heo 		break;
3602db7bccf4STejun Heo 
3603db7bccf4STejun Heo 	case CPU_DOWN_FAILED:
36041da177e4SLinus Torvalds 	case CPU_ONLINE:
3605e22bee78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
3606db7bccf4STejun Heo 		if (gcwq->trustee_state != TRUSTEE_DONE) {
3607db7bccf4STejun Heo 			gcwq->trustee_state = TRUSTEE_RELEASE;
3608db7bccf4STejun Heo 			wake_up_process(gcwq->trustee);
3609db7bccf4STejun Heo 			wait_trustee_state(gcwq, TRUSTEE_DONE);
3610db7bccf4STejun Heo 		}
36111da177e4SLinus Torvalds 
3612e22bee78STejun Heo 		/*
3613e22bee78STejun Heo 		 * Trustee is done and there might be no worker left.
3614e22bee78STejun Heo 		 * Put the first_idle in and request a real manager to
3615e22bee78STejun Heo 		 * take a look.
3616e22bee78STejun Heo 		 */
36174ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3618e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
36194ce62e9eSTejun Heo 			kthread_bind(pool->first_idle->task, cpu);
3620e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
36214ce62e9eSTejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
36224ce62e9eSTejun Heo 			start_worker(pool->first_idle);
36234ce62e9eSTejun Heo 			pool->first_idle = NULL;
36244ce62e9eSTejun Heo 		}
36251da177e4SLinus Torvalds 		break;
36261da177e4SLinus Torvalds 	}
36271da177e4SLinus Torvalds 
3628db7bccf4STejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
362900dfcaf7SOleg Nesterov 
36301537663fSTejun Heo 	return notifier_from_errno(0);
36314ce62e9eSTejun Heo 
36324ce62e9eSTejun Heo err_destroy:
36334ce62e9eSTejun Heo 	if (new_trustee)
36344ce62e9eSTejun Heo 		kthread_stop(new_trustee);
36354ce62e9eSTejun Heo 
36364ce62e9eSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
36374ce62e9eSTejun Heo 	for (i = 0; i < NR_WORKER_POOLS; i++)
36384ce62e9eSTejun Heo 		if (new_workers[i])
36394ce62e9eSTejun Heo 			destroy_worker(new_workers[i]);
36404ce62e9eSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
36414ce62e9eSTejun Heo 
36424ce62e9eSTejun Heo 	return NOTIFY_BAD;
36431da177e4SLinus Torvalds }
36441da177e4SLinus Torvalds 
364565758202STejun Heo /*
364665758202STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
364765758202STejun Heo  * This will be registered high priority CPU notifier.
364865758202STejun Heo  */
364965758202STejun Heo static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
365065758202STejun Heo 					       unsigned long action,
365165758202STejun Heo 					       void *hcpu)
365265758202STejun Heo {
365365758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
365465758202STejun Heo 	case CPU_UP_PREPARE:
365565758202STejun Heo 	case CPU_UP_CANCELED:
365665758202STejun Heo 	case CPU_DOWN_FAILED:
365765758202STejun Heo 	case CPU_ONLINE:
365865758202STejun Heo 		return workqueue_cpu_callback(nfb, action, hcpu);
365965758202STejun Heo 	}
366065758202STejun Heo 	return NOTIFY_OK;
366165758202STejun Heo }
366265758202STejun Heo 
366365758202STejun Heo /*
366465758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
366565758202STejun Heo  * This will be registered as low priority CPU notifier.
366665758202STejun Heo  */
366765758202STejun Heo static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
366865758202STejun Heo 						 unsigned long action,
366965758202STejun Heo 						 void *hcpu)
367065758202STejun Heo {
367165758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
367265758202STejun Heo 	case CPU_DOWN_PREPARE:
367365758202STejun Heo 	case CPU_POST_DEAD:
367465758202STejun Heo 		return workqueue_cpu_callback(nfb, action, hcpu);
367565758202STejun Heo 	}
367665758202STejun Heo 	return NOTIFY_OK;
367765758202STejun Heo }
367865758202STejun Heo 
36792d3854a3SRusty Russell #ifdef CONFIG_SMP
36808ccad40dSRusty Russell 
36812d3854a3SRusty Russell struct work_for_cpu {
36826b44003eSAndrew Morton 	struct completion completion;
36832d3854a3SRusty Russell 	long (*fn)(void *);
36842d3854a3SRusty Russell 	void *arg;
36852d3854a3SRusty Russell 	long ret;
36862d3854a3SRusty Russell };
36872d3854a3SRusty Russell 
36886b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
36892d3854a3SRusty Russell {
36906b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
36912d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36926b44003eSAndrew Morton 	complete(&wfc->completion);
36936b44003eSAndrew Morton 	return 0;
36942d3854a3SRusty Russell }
36952d3854a3SRusty Russell 
36962d3854a3SRusty Russell /**
36972d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36982d3854a3SRusty Russell  * @cpu: the cpu to run on
36992d3854a3SRusty Russell  * @fn: the function to run
37002d3854a3SRusty Russell  * @arg: the function arg
37012d3854a3SRusty Russell  *
370231ad9081SRusty Russell  * This will return the value @fn returns.
370331ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
37046b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
37052d3854a3SRusty Russell  */
37062d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
37072d3854a3SRusty Russell {
37086b44003eSAndrew Morton 	struct task_struct *sub_thread;
37096b44003eSAndrew Morton 	struct work_for_cpu wfc = {
37106b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
37116b44003eSAndrew Morton 		.fn = fn,
37126b44003eSAndrew Morton 		.arg = arg,
37136b44003eSAndrew Morton 	};
37142d3854a3SRusty Russell 
37156b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
37166b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
37176b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
37186b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
37196b44003eSAndrew Morton 	wake_up_process(sub_thread);
37206b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
37212d3854a3SRusty Russell 	return wfc.ret;
37222d3854a3SRusty Russell }
37232d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
37242d3854a3SRusty Russell #endif /* CONFIG_SMP */
37252d3854a3SRusty Russell 
3726a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3727e7577c50SRusty Russell 
3728a0a1a5fdSTejun Heo /**
3729a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3730a0a1a5fdSTejun Heo  *
373158a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
373258a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
373358a69cb4STejun Heo  * gcwq->worklist.
3734a0a1a5fdSTejun Heo  *
3735a0a1a5fdSTejun Heo  * CONTEXT:
37368b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3737a0a1a5fdSTejun Heo  */
3738a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3739a0a1a5fdSTejun Heo {
3740a0a1a5fdSTejun Heo 	unsigned int cpu;
3741a0a1a5fdSTejun Heo 
3742a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3743a0a1a5fdSTejun Heo 
3744a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3745a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3746a0a1a5fdSTejun Heo 
3747f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37488b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3749bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37508b03ae3cSTejun Heo 
37518b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37528b03ae3cSTejun Heo 
3753db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3754db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3755db7bccf4STejun Heo 
3756a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3757a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3758a0a1a5fdSTejun Heo 
375958a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3760a0a1a5fdSTejun Heo 				cwq->max_active = 0;
37611da177e4SLinus Torvalds 		}
37628b03ae3cSTejun Heo 
37638b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3764a0a1a5fdSTejun Heo 	}
3765a0a1a5fdSTejun Heo 
3766a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3767a0a1a5fdSTejun Heo }
3768a0a1a5fdSTejun Heo 
3769a0a1a5fdSTejun Heo /**
377058a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3771a0a1a5fdSTejun Heo  *
3772a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3773a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3774a0a1a5fdSTejun Heo  *
3775a0a1a5fdSTejun Heo  * CONTEXT:
3776a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3777a0a1a5fdSTejun Heo  *
3778a0a1a5fdSTejun Heo  * RETURNS:
377958a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
378058a69cb4STejun Heo  * is complete.
3781a0a1a5fdSTejun Heo  */
3782a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3783a0a1a5fdSTejun Heo {
3784a0a1a5fdSTejun Heo 	unsigned int cpu;
3785a0a1a5fdSTejun Heo 	bool busy = false;
3786a0a1a5fdSTejun Heo 
3787a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3788a0a1a5fdSTejun Heo 
3789a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3790a0a1a5fdSTejun Heo 
3791f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3792bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3793a0a1a5fdSTejun Heo 		/*
3794a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3795a0a1a5fdSTejun Heo 		 * to peek without lock.
3796a0a1a5fdSTejun Heo 		 */
3797a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3798a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3799a0a1a5fdSTejun Heo 
380058a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3801a0a1a5fdSTejun Heo 				continue;
3802a0a1a5fdSTejun Heo 
3803a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3804a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3805a0a1a5fdSTejun Heo 				busy = true;
3806a0a1a5fdSTejun Heo 				goto out_unlock;
3807a0a1a5fdSTejun Heo 			}
3808a0a1a5fdSTejun Heo 		}
3809a0a1a5fdSTejun Heo 	}
3810a0a1a5fdSTejun Heo out_unlock:
3811a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3812a0a1a5fdSTejun Heo 	return busy;
3813a0a1a5fdSTejun Heo }
3814a0a1a5fdSTejun Heo 
3815a0a1a5fdSTejun Heo /**
3816a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3817a0a1a5fdSTejun Heo  *
3818a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
38197e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3820a0a1a5fdSTejun Heo  *
3821a0a1a5fdSTejun Heo  * CONTEXT:
38228b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3823a0a1a5fdSTejun Heo  */
3824a0a1a5fdSTejun Heo void thaw_workqueues(void)
3825a0a1a5fdSTejun Heo {
3826a0a1a5fdSTejun Heo 	unsigned int cpu;
3827a0a1a5fdSTejun Heo 
3828a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3829a0a1a5fdSTejun Heo 
3830a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3831a0a1a5fdSTejun Heo 		goto out_unlock;
3832a0a1a5fdSTejun Heo 
3833f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38348b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38354ce62e9eSTejun Heo 		struct worker_pool *pool;
3836bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
38378b03ae3cSTejun Heo 
38388b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
38398b03ae3cSTejun Heo 
3840db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3841db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3842db7bccf4STejun Heo 
3843a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3844a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3845a0a1a5fdSTejun Heo 
384658a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3847a0a1a5fdSTejun Heo 				continue;
3848a0a1a5fdSTejun Heo 
3849a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3850a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3851a0a1a5fdSTejun Heo 
3852a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3853a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3854a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3855a0a1a5fdSTejun Heo 		}
38568b03ae3cSTejun Heo 
38574ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
38584ce62e9eSTejun Heo 			wake_up_worker(pool);
3859e22bee78STejun Heo 
38608b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3861a0a1a5fdSTejun Heo 	}
3862a0a1a5fdSTejun Heo 
3863a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3864a0a1a5fdSTejun Heo out_unlock:
3865a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3866a0a1a5fdSTejun Heo }
3867a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3868a0a1a5fdSTejun Heo 
38696ee0578bSSuresh Siddha static int __init init_workqueues(void)
38701da177e4SLinus Torvalds {
3871c34056a3STejun Heo 	unsigned int cpu;
3872c8e55f36STejun Heo 	int i;
3873c34056a3STejun Heo 
387465758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
387565758202STejun Heo 	cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
38768b03ae3cSTejun Heo 
38778b03ae3cSTejun Heo 	/* initialize gcwqs */
3878f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38798b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38804ce62e9eSTejun Heo 		struct worker_pool *pool;
38818b03ae3cSTejun Heo 
38828b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
38838b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3884f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
38858b03ae3cSTejun Heo 
3886c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3887c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3888c8e55f36STejun Heo 
38894ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38904ce62e9eSTejun Heo 			pool->gcwq = gcwq;
38914ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38924ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3893e22bee78STejun Heo 
38944ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38954ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38964ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3897e22bee78STejun Heo 
38984ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38994ce62e9eSTejun Heo 				    (unsigned long)pool);
39004ce62e9eSTejun Heo 
39014ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
39024ce62e9eSTejun Heo 		}
3903db7bccf4STejun Heo 
3904db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_DONE;
3905db7bccf4STejun Heo 		init_waitqueue_head(&gcwq->trustee_wait);
39068b03ae3cSTejun Heo 	}
39078b03ae3cSTejun Heo 
3908e22bee78STejun Heo 	/* create the initial worker */
3909f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3910e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
39114ce62e9eSTejun Heo 		struct worker_pool *pool;
3912e22bee78STejun Heo 
3913477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3914477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
39154ce62e9eSTejun Heo 
39164ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
39174ce62e9eSTejun Heo 			struct worker *worker;
39184ce62e9eSTejun Heo 
39194ce62e9eSTejun Heo 			worker = create_worker(pool, true);
3920e22bee78STejun Heo 			BUG_ON(!worker);
3921e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3922e22bee78STejun Heo 			start_worker(worker);
3923e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3924e22bee78STejun Heo 		}
39254ce62e9eSTejun Heo 	}
3926e22bee78STejun Heo 
3927d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
3928d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3929d320c038STejun Heo 	system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3930f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3931f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
393224d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
393324d51addSTejun Heo 					      WQ_FREEZABLE, 0);
393462d3c543SAlan Stern 	system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
393562d3c543SAlan Stern 			WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
3936e5cba24eSHitoshi Mitake 	BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
393762d3c543SAlan Stern 	       !system_unbound_wq || !system_freezable_wq ||
393862d3c543SAlan Stern 		!system_nrt_freezable_wq);
39396ee0578bSSuresh Siddha 	return 0;
39401da177e4SLinus Torvalds }
39416ee0578bSSuresh Siddha early_initcall(init_workqueues);
3942