xref: /linux-6.15/kernel/workqueue.c (revision 4ce62e9e)
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 */
5511ebea50STejun Heo 	POOL_HIGHPRI_PENDING	= 1 << 2,	/* highpri works on queue */
56db7bccf4STejun Heo 
57c8e55f36STejun Heo 	/* worker flags */
58c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
59c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
60c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
61e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
62db7bccf4STejun Heo 	WORKER_ROGUE		= 1 << 4,	/* not bound to any cpu */
63e22bee78STejun Heo 	WORKER_REBIND		= 1 << 5,	/* mom is home, come back */
64fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
65f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
66e22bee78STejun Heo 
67fb0e7bebSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
68f3421797STejun Heo 				  WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
69db7bccf4STejun Heo 
70db7bccf4STejun Heo 	/* gcwq->trustee_state */
71db7bccf4STejun Heo 	TRUSTEE_START		= 0,		/* start */
72db7bccf4STejun Heo 	TRUSTEE_IN_CHARGE	= 1,		/* trustee in charge of gcwq */
73db7bccf4STejun Heo 	TRUSTEE_BUTCHER		= 2,		/* butcher workers */
74db7bccf4STejun Heo 	TRUSTEE_RELEASE		= 3,		/* release workers */
75db7bccf4STejun Heo 	TRUSTEE_DONE		= 4,		/* trustee is done */
76c8e55f36STejun Heo 
77*4ce62e9eSTejun Heo 	NR_WORKER_POOLS		= 1,		/* # worker pools per gcwq */
78*4ce62e9eSTejun Heo 
79c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
80c8e55f36STejun Heo 	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
81c8e55f36STejun Heo 	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
82db7bccf4STejun Heo 
83e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
84e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
85e22bee78STejun Heo 
863233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
873233cdbdSTejun Heo 						/* call for help after 10ms
883233cdbdSTejun Heo 						   (min two ticks) */
89e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
90e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
91db7bccf4STejun Heo 	TRUSTEE_COOLDOWN	= HZ / 10,	/* for trustee draining */
921da177e4SLinus Torvalds 
931da177e4SLinus Torvalds 	/*
94e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
95e22bee78STejun Heo 	 * all cpus.  Give -20.
96e22bee78STejun Heo 	 */
97e22bee78STejun Heo 	RESCUER_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 
177bd7bdd43STejun Heo 	struct worker_pool	pool;		/* the worker 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 
279*4ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
280*4ce62e9eSTejun Heo 	for ((pool) = &(gcwq)->pool; (pool); (pool) = NULL)
281*4ce62e9eSTejun Heo 
282db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
283db7bccf4STejun Heo 	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
284db7bccf4STejun Heo 		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
285db7bccf4STejun Heo 
286f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
287f3421797STejun Heo 				  unsigned int sw)
288f3421797STejun Heo {
289f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
290f3421797STejun Heo 		if (sw & 1) {
291f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
292f3421797STejun Heo 			if (cpu < nr_cpu_ids)
293f3421797STejun Heo 				return cpu;
294f3421797STejun Heo 		}
295f3421797STejun Heo 		if (sw & 2)
296f3421797STejun Heo 			return WORK_CPU_UNBOUND;
297f3421797STejun Heo 	}
298f3421797STejun Heo 	return WORK_CPU_NONE;
299f3421797STejun Heo }
300f3421797STejun Heo 
301f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
302f3421797STejun Heo 				struct workqueue_struct *wq)
303f3421797STejun Heo {
304f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
305f3421797STejun Heo }
306f3421797STejun Heo 
30709884951STejun Heo /*
30809884951STejun Heo  * CPU iterators
30909884951STejun Heo  *
31009884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
31109884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
31209884951STejun Heo  * specific CPU.  The following iterators are similar to
31309884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
31409884951STejun Heo  *
31509884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
31609884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
31709884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
31809884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
31909884951STejun Heo  */
320f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
321f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
322f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
323f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
324f3421797STejun Heo 
325f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
326f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
327f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
328f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
329f3421797STejun Heo 
330f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
331f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
332f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
333f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
334f3421797STejun Heo 
335dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
336dc186ad7SThomas Gleixner 
337dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
338dc186ad7SThomas Gleixner 
33999777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
34099777288SStanislaw Gruszka {
34199777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
34299777288SStanislaw Gruszka }
34399777288SStanislaw Gruszka 
344dc186ad7SThomas Gleixner /*
345dc186ad7SThomas Gleixner  * fixup_init is called when:
346dc186ad7SThomas Gleixner  * - an active object is initialized
347dc186ad7SThomas Gleixner  */
348dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
349dc186ad7SThomas Gleixner {
350dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
351dc186ad7SThomas Gleixner 
352dc186ad7SThomas Gleixner 	switch (state) {
353dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
354dc186ad7SThomas Gleixner 		cancel_work_sync(work);
355dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
356dc186ad7SThomas Gleixner 		return 1;
357dc186ad7SThomas Gleixner 	default:
358dc186ad7SThomas Gleixner 		return 0;
359dc186ad7SThomas Gleixner 	}
360dc186ad7SThomas Gleixner }
361dc186ad7SThomas Gleixner 
362dc186ad7SThomas Gleixner /*
363dc186ad7SThomas Gleixner  * fixup_activate is called when:
364dc186ad7SThomas Gleixner  * - an active object is activated
365dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
366dc186ad7SThomas Gleixner  */
367dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
368dc186ad7SThomas Gleixner {
369dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
370dc186ad7SThomas Gleixner 
371dc186ad7SThomas Gleixner 	switch (state) {
372dc186ad7SThomas Gleixner 
373dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
374dc186ad7SThomas Gleixner 		/*
375dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
376dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
377dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
378dc186ad7SThomas Gleixner 		 */
37922df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
380dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
381dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
382dc186ad7SThomas Gleixner 			return 0;
383dc186ad7SThomas Gleixner 		}
384dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
385dc186ad7SThomas Gleixner 		return 0;
386dc186ad7SThomas Gleixner 
387dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
388dc186ad7SThomas Gleixner 		WARN_ON(1);
389dc186ad7SThomas Gleixner 
390dc186ad7SThomas Gleixner 	default:
391dc186ad7SThomas Gleixner 		return 0;
392dc186ad7SThomas Gleixner 	}
393dc186ad7SThomas Gleixner }
394dc186ad7SThomas Gleixner 
395dc186ad7SThomas Gleixner /*
396dc186ad7SThomas Gleixner  * fixup_free is called when:
397dc186ad7SThomas Gleixner  * - an active object is freed
398dc186ad7SThomas Gleixner  */
399dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
400dc186ad7SThomas Gleixner {
401dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
402dc186ad7SThomas Gleixner 
403dc186ad7SThomas Gleixner 	switch (state) {
404dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
405dc186ad7SThomas Gleixner 		cancel_work_sync(work);
406dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
407dc186ad7SThomas Gleixner 		return 1;
408dc186ad7SThomas Gleixner 	default:
409dc186ad7SThomas Gleixner 		return 0;
410dc186ad7SThomas Gleixner 	}
411dc186ad7SThomas Gleixner }
412dc186ad7SThomas Gleixner 
413dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
414dc186ad7SThomas Gleixner 	.name		= "work_struct",
41599777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
416dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
417dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
418dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
419dc186ad7SThomas Gleixner };
420dc186ad7SThomas Gleixner 
421dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
422dc186ad7SThomas Gleixner {
423dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
424dc186ad7SThomas Gleixner }
425dc186ad7SThomas Gleixner 
426dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
427dc186ad7SThomas Gleixner {
428dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
429dc186ad7SThomas Gleixner }
430dc186ad7SThomas Gleixner 
431dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
432dc186ad7SThomas Gleixner {
433dc186ad7SThomas Gleixner 	if (onstack)
434dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
435dc186ad7SThomas Gleixner 	else
436dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
437dc186ad7SThomas Gleixner }
438dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
439dc186ad7SThomas Gleixner 
440dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
441dc186ad7SThomas Gleixner {
442dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
443dc186ad7SThomas Gleixner }
444dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
445dc186ad7SThomas Gleixner 
446dc186ad7SThomas Gleixner #else
447dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
448dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
449dc186ad7SThomas Gleixner #endif
450dc186ad7SThomas Gleixner 
45195402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
45295402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4531da177e4SLinus Torvalds static LIST_HEAD(workqueues);
454a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4551da177e4SLinus Torvalds 
45614441960SOleg Nesterov /*
457e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
458e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
459e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
46014441960SOleg Nesterov  */
4618b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
462*4ce62e9eSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
463f756d5e2SNathan Lynch 
464f3421797STejun Heo /*
465f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
466f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
467f3421797STejun Heo  * workers have WORKER_UNBOUND set.
468f3421797STejun Heo  */
469f3421797STejun Heo static struct global_cwq unbound_global_cwq;
470*4ce62e9eSTejun Heo static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
471*4ce62e9eSTejun Heo 	[0 ... NR_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
472*4ce62e9eSTejun Heo };
473f3421797STejun Heo 
474c34056a3STejun Heo static int worker_thread(void *__worker);
4751da177e4SLinus Torvalds 
4768b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4771da177e4SLinus Torvalds {
478f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4798b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
480f3421797STejun Heo 	else
481f3421797STejun Heo 		return &unbound_global_cwq;
4821da177e4SLinus Torvalds }
4831da177e4SLinus Torvalds 
48463d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
485b1f4ec17SOleg Nesterov {
48663d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
487*4ce62e9eSTejun Heo 	int idx = 0;
48863d95a91STejun Heo 
489f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
490*4ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
491f3421797STejun Heo 	else
492*4ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
493b1f4ec17SOleg Nesterov }
494b1f4ec17SOleg Nesterov 
4954690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
4964690c4abSTejun Heo 					    struct workqueue_struct *wq)
497a848e3b6SOleg Nesterov {
498f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
499e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
500bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
501f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
502f3421797STejun Heo 		return wq->cpu_wq.single;
503f3421797STejun Heo 	return NULL;
504f3421797STejun Heo }
505a848e3b6SOleg Nesterov 
50673f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
50773f53c4aSTejun Heo {
50873f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
50973f53c4aSTejun Heo }
51073f53c4aSTejun Heo 
51173f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
51273f53c4aSTejun Heo {
51373f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
51473f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
51573f53c4aSTejun Heo }
51673f53c4aSTejun Heo 
51773f53c4aSTejun Heo static int work_next_color(int color)
51873f53c4aSTejun Heo {
51973f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5201da177e4SLinus Torvalds }
5211da177e4SLinus Torvalds 
5224594bf15SDavid Howells /*
523e120153dSTejun Heo  * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
524e120153dSTejun Heo  * work is on queue.  Once execution starts, WORK_STRUCT_CWQ is
525e120153dSTejun Heo  * cleared and the work data contains the cpu number it was last on.
5267a22ad75STejun Heo  *
5277a22ad75STejun Heo  * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
5287a22ad75STejun Heo  * cwq, cpu or clear work->data.  These functions should only be
5297a22ad75STejun Heo  * called while the work is owned - ie. while the PENDING bit is set.
5307a22ad75STejun Heo  *
5317a22ad75STejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq
5327a22ad75STejun Heo  * corresponding to a work.  gcwq is available once the work has been
5337a22ad75STejun Heo  * queued anywhere after initialization.  cwq is available only from
5347a22ad75STejun Heo  * queueing until execution starts.
5354594bf15SDavid Howells  */
5367a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5377a22ad75STejun Heo 				 unsigned long flags)
5387a22ad75STejun Heo {
5397a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5407a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5417a22ad75STejun Heo }
5427a22ad75STejun Heo 
5437a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5444690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5454690c4abSTejun Heo 			 unsigned long extra_flags)
546365970a1SDavid Howells {
5477a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
548e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
549365970a1SDavid Howells }
550365970a1SDavid Howells 
5517a22ad75STejun Heo static void set_work_cpu(struct work_struct *work, unsigned int cpu)
5524d707b9fSOleg Nesterov {
5537a22ad75STejun Heo 	set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
5544d707b9fSOleg Nesterov }
5554d707b9fSOleg Nesterov 
5567a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
557365970a1SDavid Howells {
5587a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5597a22ad75STejun Heo }
5607a22ad75STejun Heo 
5617a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5627a22ad75STejun Heo {
563e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5647a22ad75STejun Heo 
565e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
566e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
567e120153dSTejun Heo 	else
568e120153dSTejun Heo 		return NULL;
5697a22ad75STejun Heo }
5707a22ad75STejun Heo 
5717a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5727a22ad75STejun Heo {
573e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5747a22ad75STejun Heo 	unsigned int cpu;
5757a22ad75STejun Heo 
576e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
577e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
578bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
5797a22ad75STejun Heo 
5807a22ad75STejun Heo 	cpu = data >> WORK_STRUCT_FLAG_BITS;
581bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
5827a22ad75STejun Heo 		return NULL;
5837a22ad75STejun Heo 
584f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
5857a22ad75STejun Heo 	return get_gcwq(cpu);
586365970a1SDavid Howells }
587365970a1SDavid Howells 
588e22bee78STejun Heo /*
589e22bee78STejun Heo  * Policy functions.  These define the policies on how the global
590e22bee78STejun Heo  * worker pool is managed.  Unless noted otherwise, these functions
591e22bee78STejun Heo  * assume that they're being called with gcwq->lock held.
592e22bee78STejun Heo  */
593e22bee78STejun Heo 
59463d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
595649027d7STejun Heo {
59663d95a91STejun Heo 	return !atomic_read(get_pool_nr_running(pool)) ||
59711ebea50STejun Heo 		(pool->flags & POOL_HIGHPRI_PENDING);
598649027d7STejun Heo }
599649027d7STejun Heo 
600e22bee78STejun Heo /*
601e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
602e22bee78STejun Heo  * running workers.
603974271c4STejun Heo  *
604974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
605974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
606974271c4STejun Heo  * worklist isn't empty.
607e22bee78STejun Heo  */
60863d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
609e22bee78STejun Heo {
61063d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
611e22bee78STejun Heo }
612e22bee78STejun Heo 
613e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
61463d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
615e22bee78STejun Heo {
61663d95a91STejun Heo 	return pool->nr_idle;
617e22bee78STejun Heo }
618e22bee78STejun Heo 
619e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
62063d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
621e22bee78STejun Heo {
62263d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
623e22bee78STejun Heo 
62463d95a91STejun Heo 	return !list_empty(&pool->worklist) &&
62530310045STejun Heo 		(atomic_read(nr_running) <= 1 ||
62611ebea50STejun Heo 		 (pool->flags & POOL_HIGHPRI_PENDING));
627e22bee78STejun Heo }
628e22bee78STejun Heo 
629e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
63063d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
631e22bee78STejun Heo {
63263d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
633e22bee78STejun Heo }
634e22bee78STejun Heo 
635e22bee78STejun Heo /* Do I need to be the manager? */
63663d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
637e22bee78STejun Heo {
63863d95a91STejun Heo 	return need_to_create_worker(pool) ||
63911ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
640e22bee78STejun Heo }
641e22bee78STejun Heo 
642e22bee78STejun Heo /* Do we have too many workers and should some go away? */
64363d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
644e22bee78STejun Heo {
64511ebea50STejun Heo 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
64663d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
64763d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
648e22bee78STejun Heo 
649e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
650e22bee78STejun Heo }
651e22bee78STejun Heo 
652e22bee78STejun Heo /*
653e22bee78STejun Heo  * Wake up functions.
654e22bee78STejun Heo  */
655e22bee78STejun Heo 
6567e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
65763d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
6587e11629dSTejun Heo {
65963d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
6607e11629dSTejun Heo 		return NULL;
6617e11629dSTejun Heo 
66263d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
6637e11629dSTejun Heo }
6647e11629dSTejun Heo 
6657e11629dSTejun Heo /**
6667e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
66763d95a91STejun Heo  * @pool: worker pool to wake worker from
6687e11629dSTejun Heo  *
66963d95a91STejun Heo  * Wake up the first idle worker of @pool.
6707e11629dSTejun Heo  *
6717e11629dSTejun Heo  * CONTEXT:
6727e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
6737e11629dSTejun Heo  */
67463d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
6757e11629dSTejun Heo {
67663d95a91STejun Heo 	struct worker *worker = first_worker(pool);
6777e11629dSTejun Heo 
6787e11629dSTejun Heo 	if (likely(worker))
6797e11629dSTejun Heo 		wake_up_process(worker->task);
6807e11629dSTejun Heo }
6817e11629dSTejun Heo 
6824690c4abSTejun Heo /**
683e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
684e22bee78STejun Heo  * @task: task waking up
685e22bee78STejun Heo  * @cpu: CPU @task is waking up to
686e22bee78STejun Heo  *
687e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
688e22bee78STejun Heo  * being awoken.
689e22bee78STejun Heo  *
690e22bee78STejun Heo  * CONTEXT:
691e22bee78STejun Heo  * spin_lock_irq(rq->lock)
692e22bee78STejun Heo  */
693e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
694e22bee78STejun Heo {
695e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
696e22bee78STejun Heo 
6972d64672eSSteven Rostedt 	if (!(worker->flags & WORKER_NOT_RUNNING))
69863d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
699e22bee78STejun Heo }
700e22bee78STejun Heo 
701e22bee78STejun Heo /**
702e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
703e22bee78STejun Heo  * @task: task going to sleep
704e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
705e22bee78STejun Heo  *
706e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
707e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
708e22bee78STejun Heo  * returning pointer to its task.
709e22bee78STejun Heo  *
710e22bee78STejun Heo  * CONTEXT:
711e22bee78STejun Heo  * spin_lock_irq(rq->lock)
712e22bee78STejun Heo  *
713e22bee78STejun Heo  * RETURNS:
714e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
715e22bee78STejun Heo  */
716e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
717e22bee78STejun Heo 				       unsigned int cpu)
718e22bee78STejun Heo {
719e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
720bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
72163d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
722e22bee78STejun Heo 
7232d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
724e22bee78STejun Heo 		return NULL;
725e22bee78STejun Heo 
726e22bee78STejun Heo 	/* this can only happen on the local cpu */
727e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
728e22bee78STejun Heo 
729e22bee78STejun Heo 	/*
730e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
731e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
732e22bee78STejun Heo 	 * Please read comment there.
733e22bee78STejun Heo 	 *
734e22bee78STejun Heo 	 * NOT_RUNNING is clear.  This means that trustee is not in
735e22bee78STejun Heo 	 * charge and we're running on the local cpu w/ rq lock held
736e22bee78STejun Heo 	 * and preemption disabled, which in turn means that none else
737e22bee78STejun Heo 	 * could be manipulating idle_list, so dereferencing idle_list
738e22bee78STejun Heo 	 * without gcwq lock is safe.
739e22bee78STejun Heo 	 */
740bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
74163d95a91STejun Heo 		to_wakeup = first_worker(pool);
742e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
743e22bee78STejun Heo }
744e22bee78STejun Heo 
745e22bee78STejun Heo /**
746e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
747cb444766STejun Heo  * @worker: self
748d302f017STejun Heo  * @flags: flags to set
749d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
750d302f017STejun Heo  *
751e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
752e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
753e22bee78STejun Heo  * woken up.
754d302f017STejun Heo  *
755cb444766STejun Heo  * CONTEXT:
756cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
757d302f017STejun Heo  */
758d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
759d302f017STejun Heo 				    bool wakeup)
760d302f017STejun Heo {
761bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
762e22bee78STejun Heo 
763cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
764cb444766STejun Heo 
765e22bee78STejun Heo 	/*
766e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
767e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
768e22bee78STejun Heo 	 * @wakeup.
769e22bee78STejun Heo 	 */
770e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
771e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
77263d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
773e22bee78STejun Heo 
774e22bee78STejun Heo 		if (wakeup) {
775e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
776bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
77763d95a91STejun Heo 				wake_up_worker(pool);
778e22bee78STejun Heo 		} else
779e22bee78STejun Heo 			atomic_dec(nr_running);
780e22bee78STejun Heo 	}
781e22bee78STejun Heo 
782d302f017STejun Heo 	worker->flags |= flags;
783d302f017STejun Heo }
784d302f017STejun Heo 
785d302f017STejun Heo /**
786e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
787cb444766STejun Heo  * @worker: self
788d302f017STejun Heo  * @flags: flags to clear
789d302f017STejun Heo  *
790e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
791d302f017STejun Heo  *
792cb444766STejun Heo  * CONTEXT:
793cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
794d302f017STejun Heo  */
795d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
796d302f017STejun Heo {
79763d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
798e22bee78STejun Heo 	unsigned int oflags = worker->flags;
799e22bee78STejun Heo 
800cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
801cb444766STejun Heo 
802d302f017STejun Heo 	worker->flags &= ~flags;
803e22bee78STejun Heo 
80442c025f3STejun Heo 	/*
80542c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
80642c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
80742c025f3STejun Heo 	 * of multiple flags, not a single flag.
80842c025f3STejun Heo 	 */
809e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
810e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
81163d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
812d302f017STejun Heo }
813d302f017STejun Heo 
814d302f017STejun Heo /**
815c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
816c8e55f36STejun Heo  * @gcwq: gcwq of interest
817c8e55f36STejun Heo  * @work: work to be hashed
818c8e55f36STejun Heo  *
819c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
820c8e55f36STejun Heo  *
821c8e55f36STejun Heo  * CONTEXT:
822c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
823c8e55f36STejun Heo  *
824c8e55f36STejun Heo  * RETURNS:
825c8e55f36STejun Heo  * Pointer to the hash head.
826c8e55f36STejun Heo  */
827c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
828c8e55f36STejun Heo 					   struct work_struct *work)
829c8e55f36STejun Heo {
830c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
831c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
832c8e55f36STejun Heo 
833c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
834c8e55f36STejun Heo 	v >>= base_shift;
835c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
836c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
837c8e55f36STejun Heo 
838c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
839c8e55f36STejun Heo }
840c8e55f36STejun Heo 
841c8e55f36STejun Heo /**
8428cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
8438cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8448cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
8458cca0eeaSTejun Heo  * @work: work to find worker for
8468cca0eeaSTejun Heo  *
8478cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
8488cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
8498cca0eeaSTejun Heo  * work.
8508cca0eeaSTejun Heo  *
8518cca0eeaSTejun Heo  * CONTEXT:
8528cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8538cca0eeaSTejun Heo  *
8548cca0eeaSTejun Heo  * RETURNS:
8558cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8568cca0eeaSTejun Heo  * otherwise.
8578cca0eeaSTejun Heo  */
8588cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
8598cca0eeaSTejun Heo 						   struct hlist_head *bwh,
8608cca0eeaSTejun Heo 						   struct work_struct *work)
8618cca0eeaSTejun Heo {
8628cca0eeaSTejun Heo 	struct worker *worker;
8638cca0eeaSTejun Heo 	struct hlist_node *tmp;
8648cca0eeaSTejun Heo 
8658cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
8668cca0eeaSTejun Heo 		if (worker->current_work == work)
8678cca0eeaSTejun Heo 			return worker;
8688cca0eeaSTejun Heo 	return NULL;
8698cca0eeaSTejun Heo }
8708cca0eeaSTejun Heo 
8718cca0eeaSTejun Heo /**
8728cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8738cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8748cca0eeaSTejun Heo  * @work: work to find worker for
8758cca0eeaSTejun Heo  *
8768cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
8778cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
8788cca0eeaSTejun Heo  * function calculates @bwh itself.
8798cca0eeaSTejun Heo  *
8808cca0eeaSTejun Heo  * CONTEXT:
8818cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8828cca0eeaSTejun Heo  *
8838cca0eeaSTejun Heo  * RETURNS:
8848cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8858cca0eeaSTejun Heo  * otherwise.
8868cca0eeaSTejun Heo  */
8878cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8888cca0eeaSTejun Heo 						 struct work_struct *work)
8898cca0eeaSTejun Heo {
8908cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
8918cca0eeaSTejun Heo 					    work);
8928cca0eeaSTejun Heo }
8938cca0eeaSTejun Heo 
8948cca0eeaSTejun Heo /**
89563d95a91STejun Heo  * pool_determine_ins_pos - find insertion position
89663d95a91STejun Heo  * @pool: pool of interest
897649027d7STejun Heo  * @cwq: cwq a work is being queued for
898649027d7STejun Heo  *
89963d95a91STejun Heo  * A work for @cwq is about to be queued on @pool, determine insertion
900649027d7STejun Heo  * position for the work.  If @cwq is for HIGHPRI wq, the work is
901649027d7STejun Heo  * queued at the head of the queue but in FIFO order with respect to
902649027d7STejun Heo  * other HIGHPRI works; otherwise, at the end of the queue.  This
90311ebea50STejun Heo  * function also sets POOL_HIGHPRI_PENDING flag to hint @pool that
904649027d7STejun Heo  * there are HIGHPRI works pending.
905649027d7STejun Heo  *
906649027d7STejun Heo  * CONTEXT:
907649027d7STejun Heo  * spin_lock_irq(gcwq->lock).
908649027d7STejun Heo  *
909649027d7STejun Heo  * RETURNS:
910649027d7STejun Heo  * Pointer to inserstion position.
911649027d7STejun Heo  */
91263d95a91STejun Heo static inline struct list_head *pool_determine_ins_pos(struct worker_pool *pool,
9131da177e4SLinus Torvalds 					       struct cpu_workqueue_struct *cwq)
9141da177e4SLinus Torvalds {
915649027d7STejun Heo 	struct work_struct *twork;
9161da177e4SLinus Torvalds 
917649027d7STejun Heo 	if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
91863d95a91STejun Heo 		return &pool->worklist;
9191da177e4SLinus Torvalds 
92063d95a91STejun Heo 	list_for_each_entry(twork, &pool->worklist, entry) {
921649027d7STejun Heo 		struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
922649027d7STejun Heo 
923649027d7STejun Heo 		if (!(tcwq->wq->flags & WQ_HIGHPRI))
924649027d7STejun Heo 			break;
9251da177e4SLinus Torvalds 	}
9261da177e4SLinus Torvalds 
92711ebea50STejun Heo 	pool->flags |= POOL_HIGHPRI_PENDING;
928649027d7STejun Heo 	return &twork->entry;
929649027d7STejun Heo }
930649027d7STejun Heo 
931649027d7STejun Heo /**
9327e11629dSTejun Heo  * insert_work - insert a work into gcwq
9334690c4abSTejun Heo  * @cwq: cwq @work belongs to
9344690c4abSTejun Heo  * @work: work to insert
9354690c4abSTejun Heo  * @head: insertion point
9364690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
9374690c4abSTejun Heo  *
9387e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
9397e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
9404690c4abSTejun Heo  *
9414690c4abSTejun Heo  * CONTEXT:
9428b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
9431da177e4SLinus Torvalds  */
944b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
9454690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
9464690c4abSTejun Heo 			unsigned int extra_flags)
947b89deed3SOleg Nesterov {
94863d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
949e1d8aa9fSFrederic Weisbecker 
9504690c4abSTejun Heo 	/* we own @work, set data and link */
9517a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
9524690c4abSTejun Heo 
9536e84d644SOleg Nesterov 	/*
9546e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
9556e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
9566e84d644SOleg Nesterov 	 */
9576e84d644SOleg Nesterov 	smp_wmb();
9584690c4abSTejun Heo 
9591a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
960e22bee78STejun Heo 
961e22bee78STejun Heo 	/*
962e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
963e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
964e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
965e22bee78STejun Heo 	 */
966e22bee78STejun Heo 	smp_mb();
967e22bee78STejun Heo 
96863d95a91STejun Heo 	if (__need_more_worker(pool))
96963d95a91STejun Heo 		wake_up_worker(pool);
970b89deed3SOleg Nesterov }
971b89deed3SOleg Nesterov 
972c8efcc25STejun Heo /*
973c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
974c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
975c8efcc25STejun Heo  * cold paths.
976c8efcc25STejun Heo  */
977c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
978c8efcc25STejun Heo {
979c8efcc25STejun Heo 	unsigned long flags;
980c8efcc25STejun Heo 	unsigned int cpu;
981c8efcc25STejun Heo 
982c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
983c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
984c8efcc25STejun Heo 		struct worker *worker;
985c8efcc25STejun Heo 		struct hlist_node *pos;
986c8efcc25STejun Heo 		int i;
987c8efcc25STejun Heo 
988c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
989c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
990c8efcc25STejun Heo 			if (worker->task != current)
991c8efcc25STejun Heo 				continue;
992c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
993c8efcc25STejun Heo 			/*
994c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
995c8efcc25STejun Heo 			 * is headed to the same workqueue.
996c8efcc25STejun Heo 			 */
997c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
998c8efcc25STejun Heo 		}
999c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
1000c8efcc25STejun Heo 	}
1001c8efcc25STejun Heo 	return false;
1002c8efcc25STejun Heo }
1003c8efcc25STejun Heo 
10044690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
10051da177e4SLinus Torvalds 			 struct work_struct *work)
10061da177e4SLinus Torvalds {
1007502ca9d8STejun Heo 	struct global_cwq *gcwq;
1008502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
10091e19ffc6STejun Heo 	struct list_head *worklist;
10108a2e8e5dSTejun Heo 	unsigned int work_flags;
10111da177e4SLinus Torvalds 	unsigned long flags;
10121da177e4SLinus Torvalds 
1013dc186ad7SThomas Gleixner 	debug_work_activate(work);
10141e19ffc6STejun Heo 
1015c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
10169c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1017c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1018e41e704bSTejun Heo 		return;
1019e41e704bSTejun Heo 
1020c7fc77f7STejun Heo 	/* determine gcwq to use */
1021c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1022c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1023c7fc77f7STejun Heo 
1024f3421797STejun Heo 		if (unlikely(cpu == WORK_CPU_UNBOUND))
1025f3421797STejun Heo 			cpu = raw_smp_processor_id();
1026f3421797STejun Heo 
102718aa9effSTejun Heo 		/*
102818aa9effSTejun Heo 		 * It's multi cpu.  If @wq is non-reentrant and @work
102918aa9effSTejun Heo 		 * was previously on a different cpu, it might still
103018aa9effSTejun Heo 		 * be running there, in which case the work needs to
103118aa9effSTejun Heo 		 * be queued on that cpu to guarantee non-reentrance.
103218aa9effSTejun Heo 		 */
1033502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
103418aa9effSTejun Heo 		if (wq->flags & WQ_NON_REENTRANT &&
103518aa9effSTejun Heo 		    (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
103618aa9effSTejun Heo 			struct worker *worker;
103718aa9effSTejun Heo 
103818aa9effSTejun Heo 			spin_lock_irqsave(&last_gcwq->lock, flags);
103918aa9effSTejun Heo 
104018aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
104118aa9effSTejun Heo 
104218aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
104318aa9effSTejun Heo 				gcwq = last_gcwq;
104418aa9effSTejun Heo 			else {
104518aa9effSTejun Heo 				/* meh... not running there, queue here */
104618aa9effSTejun Heo 				spin_unlock_irqrestore(&last_gcwq->lock, flags);
104718aa9effSTejun Heo 				spin_lock_irqsave(&gcwq->lock, flags);
104818aa9effSTejun Heo 			}
104918aa9effSTejun Heo 		} else
10508b03ae3cSTejun Heo 			spin_lock_irqsave(&gcwq->lock, flags);
1051f3421797STejun Heo 	} else {
1052f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
1053f3421797STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1054502ca9d8STejun Heo 	}
1055502ca9d8STejun Heo 
1056502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1057502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1058cdadf009STejun Heo 	trace_workqueue_queue_work(cpu, cwq, work);
1059502ca9d8STejun Heo 
1060f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1061f5b2552bSDan Carpenter 		spin_unlock_irqrestore(&gcwq->lock, flags);
1062f5b2552bSDan Carpenter 		return;
1063f5b2552bSDan Carpenter 	}
10641e19ffc6STejun Heo 
106573f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
10668a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
10671e19ffc6STejun Heo 
10681e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1069cdadf009STejun Heo 		trace_workqueue_activate_work(work);
10701e19ffc6STejun Heo 		cwq->nr_active++;
107163d95a91STejun Heo 		worklist = pool_determine_ins_pos(cwq->pool, cwq);
10728a2e8e5dSTejun Heo 	} else {
10738a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
10741e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
10758a2e8e5dSTejun Heo 	}
10761e19ffc6STejun Heo 
10778a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
10781e19ffc6STejun Heo 
10798b03ae3cSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
10801da177e4SLinus Torvalds }
10811da177e4SLinus Torvalds 
10820fcb78c2SRolf Eike Beer /**
10830fcb78c2SRolf Eike Beer  * queue_work - queue work on a workqueue
10840fcb78c2SRolf Eike Beer  * @wq: workqueue to use
10850fcb78c2SRolf Eike Beer  * @work: work to queue
10860fcb78c2SRolf Eike Beer  *
1087057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
10881da177e4SLinus Torvalds  *
108900dfcaf7SOleg Nesterov  * We queue the work to the CPU on which it was submitted, but if the CPU dies
109000dfcaf7SOleg Nesterov  * it can be processed by another CPU.
10911da177e4SLinus Torvalds  */
10927ad5b3a5SHarvey Harrison int queue_work(struct workqueue_struct *wq, struct work_struct *work)
10931da177e4SLinus Torvalds {
1094ef1ca236SOleg Nesterov 	int ret;
10951da177e4SLinus Torvalds 
1096ef1ca236SOleg Nesterov 	ret = queue_work_on(get_cpu(), wq, work);
1097a848e3b6SOleg Nesterov 	put_cpu();
1098ef1ca236SOleg Nesterov 
10991da177e4SLinus Torvalds 	return ret;
11001da177e4SLinus Torvalds }
1101ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_work);
11021da177e4SLinus Torvalds 
1103c1a220e7SZhang Rui /**
1104c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1105c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1106c1a220e7SZhang Rui  * @wq: workqueue to use
1107c1a220e7SZhang Rui  * @work: work to queue
1108c1a220e7SZhang Rui  *
1109c1a220e7SZhang Rui  * Returns 0 if @work was already on a queue, non-zero otherwise.
1110c1a220e7SZhang Rui  *
1111c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1112c1a220e7SZhang Rui  * can't go away.
1113c1a220e7SZhang Rui  */
1114c1a220e7SZhang Rui int
1115c1a220e7SZhang Rui queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1116c1a220e7SZhang Rui {
1117c1a220e7SZhang Rui 	int ret = 0;
1118c1a220e7SZhang Rui 
111922df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
11204690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1121c1a220e7SZhang Rui 		ret = 1;
1122c1a220e7SZhang Rui 	}
1123c1a220e7SZhang Rui 	return ret;
1124c1a220e7SZhang Rui }
1125c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1126c1a220e7SZhang Rui 
11276d141c3fSLi Zefan static void delayed_work_timer_fn(unsigned long __data)
11281da177e4SLinus Torvalds {
112952bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
11307a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
11311da177e4SLinus Torvalds 
11324690c4abSTejun Heo 	__queue_work(smp_processor_id(), cwq->wq, &dwork->work);
11331da177e4SLinus Torvalds }
11341da177e4SLinus Torvalds 
11350fcb78c2SRolf Eike Beer /**
11360fcb78c2SRolf Eike Beer  * queue_delayed_work - queue work on a workqueue after delay
11370fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1138af9997e4SRandy Dunlap  * @dwork: delayable work to queue
11390fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11400fcb78c2SRolf Eike Beer  *
1141057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11420fcb78c2SRolf Eike Beer  */
11437ad5b3a5SHarvey Harrison int queue_delayed_work(struct workqueue_struct *wq,
114452bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11451da177e4SLinus Torvalds {
114652bad64dSDavid Howells 	if (delay == 0)
114763bc0362SOleg Nesterov 		return queue_work(wq, &dwork->work);
11481da177e4SLinus Torvalds 
114963bc0362SOleg Nesterov 	return queue_delayed_work_on(-1, wq, dwork, delay);
11501da177e4SLinus Torvalds }
1151ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work);
11521da177e4SLinus Torvalds 
11530fcb78c2SRolf Eike Beer /**
11540fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
11550fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
11560fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1157af9997e4SRandy Dunlap  * @dwork: work to queue
11580fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11590fcb78c2SRolf Eike Beer  *
1160057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11610fcb78c2SRolf Eike Beer  */
11627a6bc1cdSVenkatesh Pallipadi int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
116352bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11647a6bc1cdSVenkatesh Pallipadi {
11657a6bc1cdSVenkatesh Pallipadi 	int ret = 0;
116652bad64dSDavid Howells 	struct timer_list *timer = &dwork->timer;
116752bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
11687a6bc1cdSVenkatesh Pallipadi 
116922df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1170c7fc77f7STejun Heo 		unsigned int lcpu;
11717a22ad75STejun Heo 
11727a6bc1cdSVenkatesh Pallipadi 		BUG_ON(timer_pending(timer));
11737a6bc1cdSVenkatesh Pallipadi 		BUG_ON(!list_empty(&work->entry));
11747a6bc1cdSVenkatesh Pallipadi 
11758a3e77ccSAndrew Liu 		timer_stats_timer_set_start_info(&dwork->timer);
11768a3e77ccSAndrew Liu 
11777a22ad75STejun Heo 		/*
11787a22ad75STejun Heo 		 * This stores cwq for the moment, for the timer_fn.
11797a22ad75STejun Heo 		 * Note that the work's gcwq is preserved to allow
11807a22ad75STejun Heo 		 * reentrance detection for delayed works.
11817a22ad75STejun Heo 		 */
1182c7fc77f7STejun Heo 		if (!(wq->flags & WQ_UNBOUND)) {
1183c7fc77f7STejun Heo 			struct global_cwq *gcwq = get_work_gcwq(work);
1184c7fc77f7STejun Heo 
1185c7fc77f7STejun Heo 			if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1186c7fc77f7STejun Heo 				lcpu = gcwq->cpu;
1187c7fc77f7STejun Heo 			else
1188c7fc77f7STejun Heo 				lcpu = raw_smp_processor_id();
1189c7fc77f7STejun Heo 		} else
1190c7fc77f7STejun Heo 			lcpu = WORK_CPU_UNBOUND;
1191c7fc77f7STejun Heo 
11927a22ad75STejun Heo 		set_work_cwq(work, get_cwq(lcpu, wq), 0);
1193c7fc77f7STejun Heo 
11947a6bc1cdSVenkatesh Pallipadi 		timer->expires = jiffies + delay;
119552bad64dSDavid Howells 		timer->data = (unsigned long)dwork;
11967a6bc1cdSVenkatesh Pallipadi 		timer->function = delayed_work_timer_fn;
119763bc0362SOleg Nesterov 
119863bc0362SOleg Nesterov 		if (unlikely(cpu >= 0))
11997a6bc1cdSVenkatesh Pallipadi 			add_timer_on(timer, cpu);
120063bc0362SOleg Nesterov 		else
120163bc0362SOleg Nesterov 			add_timer(timer);
12027a6bc1cdSVenkatesh Pallipadi 		ret = 1;
12037a6bc1cdSVenkatesh Pallipadi 	}
12047a6bc1cdSVenkatesh Pallipadi 	return ret;
12057a6bc1cdSVenkatesh Pallipadi }
1206ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
12071da177e4SLinus Torvalds 
1208c8e55f36STejun Heo /**
1209c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1210c8e55f36STejun Heo  * @worker: worker which is entering idle state
1211c8e55f36STejun Heo  *
1212c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1213c8e55f36STejun Heo  * necessary.
1214c8e55f36STejun Heo  *
1215c8e55f36STejun Heo  * LOCKING:
1216c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1217c8e55f36STejun Heo  */
1218c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
12191da177e4SLinus Torvalds {
1220bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1221bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1222c8e55f36STejun Heo 
1223c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1224c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1225c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1226c8e55f36STejun Heo 
1227cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1228cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1229bd7bdd43STejun Heo 	pool->nr_idle++;
1230e22bee78STejun Heo 	worker->last_active = jiffies;
1231c8e55f36STejun Heo 
1232c8e55f36STejun Heo 	/* idle_list is LIFO */
1233bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1234db7bccf4STejun Heo 
1235e22bee78STejun Heo 	if (likely(!(worker->flags & WORKER_ROGUE))) {
123663d95a91STejun Heo 		if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1237bd7bdd43STejun Heo 			mod_timer(&pool->idle_timer,
1238e22bee78STejun Heo 				  jiffies + IDLE_WORKER_TIMEOUT);
1239e22bee78STejun Heo 	} else
1240db7bccf4STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1241cb444766STejun Heo 
1242544ecf31STejun Heo 	/*
1243544ecf31STejun Heo 	 * Sanity check nr_running.  Because trustee releases gcwq->lock
1244544ecf31STejun Heo 	 * between setting %WORKER_ROGUE and zapping nr_running, the
1245544ecf31STejun Heo 	 * warning may trigger spuriously.  Check iff trustee is idle.
1246544ecf31STejun Heo 	 */
1247544ecf31STejun Heo 	WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
1248bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
124963d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1250c8e55f36STejun Heo }
1251c8e55f36STejun Heo 
1252c8e55f36STejun Heo /**
1253c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1254c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1255c8e55f36STejun Heo  *
1256c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1257c8e55f36STejun Heo  *
1258c8e55f36STejun Heo  * LOCKING:
1259c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1260c8e55f36STejun Heo  */
1261c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1262c8e55f36STejun Heo {
1263bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1264c8e55f36STejun Heo 
1265c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1266d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1267bd7bdd43STejun Heo 	pool->nr_idle--;
1268c8e55f36STejun Heo 	list_del_init(&worker->entry);
1269c8e55f36STejun Heo }
1270c8e55f36STejun Heo 
1271e22bee78STejun Heo /**
1272e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1273e22bee78STejun Heo  * @worker: self
1274e22bee78STejun Heo  *
1275e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1276e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1277e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1278e22bee78STejun Heo  * guaranteed to execute on the cpu.
1279e22bee78STejun Heo  *
1280e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1281e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1282e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1283e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1284e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1285e22bee78STejun Heo  * [dis]associated in the meantime.
1286e22bee78STejun Heo  *
1287e22bee78STejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies
1288e22bee78STejun Heo  * the binding against GCWQ_DISASSOCIATED which is set during
1289e22bee78STejun Heo  * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1290e22bee78STejun Heo  * idle state or fetches works without dropping lock, it can guarantee
1291e22bee78STejun Heo  * the scheduling requirement described in the first paragraph.
1292e22bee78STejun Heo  *
1293e22bee78STejun Heo  * CONTEXT:
1294e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1295e22bee78STejun Heo  * held.
1296e22bee78STejun Heo  *
1297e22bee78STejun Heo  * RETURNS:
1298e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1299e22bee78STejun Heo  * bound), %false if offline.
1300e22bee78STejun Heo  */
1301e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1302972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1303e22bee78STejun Heo {
1304bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1305e22bee78STejun Heo 	struct task_struct *task = worker->task;
1306e22bee78STejun Heo 
1307e22bee78STejun Heo 	while (true) {
1308e22bee78STejun Heo 		/*
1309e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1310e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1311e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1312e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1313e22bee78STejun Heo 		 */
1314f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1315e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1316e22bee78STejun Heo 
1317e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1318e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1319e22bee78STejun Heo 			return false;
1320e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1321e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1322e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1323e22bee78STejun Heo 			return true;
1324e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1325e22bee78STejun Heo 
13265035b20fSTejun Heo 		/*
13275035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
13285035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
13295035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
13305035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
13315035b20fSTejun Heo 		 */
1332e22bee78STejun Heo 		cpu_relax();
13335035b20fSTejun Heo 		cond_resched();
1334e22bee78STejun Heo 	}
1335e22bee78STejun Heo }
1336e22bee78STejun Heo 
1337e22bee78STejun Heo /*
1338e22bee78STejun Heo  * Function for worker->rebind_work used to rebind rogue busy workers
1339e22bee78STejun Heo  * to the associated cpu which is coming back online.  This is
1340e22bee78STejun Heo  * scheduled by cpu up but can race with other cpu hotplug operations
1341e22bee78STejun Heo  * and may be executed twice without intervening cpu down.
1342e22bee78STejun Heo  */
1343e22bee78STejun Heo static void worker_rebind_fn(struct work_struct *work)
1344e22bee78STejun Heo {
1345e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1346bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1347e22bee78STejun Heo 
1348e22bee78STejun Heo 	if (worker_maybe_bind_and_lock(worker))
1349e22bee78STejun Heo 		worker_clr_flags(worker, WORKER_REBIND);
1350e22bee78STejun Heo 
1351e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1352e22bee78STejun Heo }
1353e22bee78STejun Heo 
1354c34056a3STejun Heo static struct worker *alloc_worker(void)
1355c34056a3STejun Heo {
1356c34056a3STejun Heo 	struct worker *worker;
1357c34056a3STejun Heo 
1358c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1359c8e55f36STejun Heo 	if (worker) {
1360c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1361affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1362e22bee78STejun Heo 		INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1363e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1364e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1365c8e55f36STejun Heo 	}
1366c34056a3STejun Heo 	return worker;
1367c34056a3STejun Heo }
1368c34056a3STejun Heo 
1369c34056a3STejun Heo /**
1370c34056a3STejun Heo  * create_worker - create a new workqueue worker
137163d95a91STejun Heo  * @pool: pool the new worker will belong to
1372c34056a3STejun Heo  * @bind: whether to set affinity to @cpu or not
1373c34056a3STejun Heo  *
137463d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1375c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1376c34056a3STejun Heo  * destroy_worker().
1377c34056a3STejun Heo  *
1378c34056a3STejun Heo  * CONTEXT:
1379c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1380c34056a3STejun Heo  *
1381c34056a3STejun Heo  * RETURNS:
1382c34056a3STejun Heo  * Pointer to the newly created worker.
1383c34056a3STejun Heo  */
138463d95a91STejun Heo static struct worker *create_worker(struct worker_pool *pool, bool bind)
1385c34056a3STejun Heo {
138663d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1387f3421797STejun Heo 	bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
1388c34056a3STejun Heo 	struct worker *worker = NULL;
1389f3421797STejun Heo 	int id = -1;
1390c34056a3STejun Heo 
13918b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1392bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
13938b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1394bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1395c34056a3STejun Heo 			goto fail;
13968b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1397c34056a3STejun Heo 	}
13988b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1399c34056a3STejun Heo 
1400c34056a3STejun Heo 	worker = alloc_worker();
1401c34056a3STejun Heo 	if (!worker)
1402c34056a3STejun Heo 		goto fail;
1403c34056a3STejun Heo 
1404bd7bdd43STejun Heo 	worker->pool = pool;
1405c34056a3STejun Heo 	worker->id = id;
1406c34056a3STejun Heo 
1407f3421797STejun Heo 	if (!on_unbound_cpu)
140894dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
140994dcf29aSEric Dumazet 						      worker,
141094dcf29aSEric Dumazet 						      cpu_to_node(gcwq->cpu),
1411f3421797STejun Heo 						      "kworker/%u:%d", gcwq->cpu, id);
1412f3421797STejun Heo 	else
1413f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
1414f3421797STejun Heo 					      "kworker/u:%d", id);
1415c34056a3STejun Heo 	if (IS_ERR(worker->task))
1416c34056a3STejun Heo 		goto fail;
1417c34056a3STejun Heo 
1418db7bccf4STejun Heo 	/*
1419db7bccf4STejun Heo 	 * A rogue worker will become a regular one if CPU comes
1420db7bccf4STejun Heo 	 * online later on.  Make sure every worker has
1421db7bccf4STejun Heo 	 * PF_THREAD_BOUND set.
1422db7bccf4STejun Heo 	 */
1423f3421797STejun Heo 	if (bind && !on_unbound_cpu)
14248b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1425f3421797STejun Heo 	else {
1426db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1427f3421797STejun Heo 		if (on_unbound_cpu)
1428f3421797STejun Heo 			worker->flags |= WORKER_UNBOUND;
1429f3421797STejun Heo 	}
1430c34056a3STejun Heo 
1431c34056a3STejun Heo 	return worker;
1432c34056a3STejun Heo fail:
1433c34056a3STejun Heo 	if (id >= 0) {
14348b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1435bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
14368b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1437c34056a3STejun Heo 	}
1438c34056a3STejun Heo 	kfree(worker);
1439c34056a3STejun Heo 	return NULL;
1440c34056a3STejun Heo }
1441c34056a3STejun Heo 
1442c34056a3STejun Heo /**
1443c34056a3STejun Heo  * start_worker - start a newly created worker
1444c34056a3STejun Heo  * @worker: worker to start
1445c34056a3STejun Heo  *
1446c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1447c34056a3STejun Heo  *
1448c34056a3STejun Heo  * CONTEXT:
14498b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1450c34056a3STejun Heo  */
1451c34056a3STejun Heo static void start_worker(struct worker *worker)
1452c34056a3STejun Heo {
1453cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1454bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1455c8e55f36STejun Heo 	worker_enter_idle(worker);
1456c34056a3STejun Heo 	wake_up_process(worker->task);
1457c34056a3STejun Heo }
1458c34056a3STejun Heo 
1459c34056a3STejun Heo /**
1460c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1461c34056a3STejun Heo  * @worker: worker to be destroyed
1462c34056a3STejun Heo  *
1463c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1464c8e55f36STejun Heo  *
1465c8e55f36STejun Heo  * CONTEXT:
1466c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1467c34056a3STejun Heo  */
1468c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1469c34056a3STejun Heo {
1470bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1471bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1472c34056a3STejun Heo 	int id = worker->id;
1473c34056a3STejun Heo 
1474c34056a3STejun Heo 	/* sanity check frenzy */
1475c34056a3STejun Heo 	BUG_ON(worker->current_work);
1476affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1477c34056a3STejun Heo 
1478c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1479bd7bdd43STejun Heo 		pool->nr_workers--;
1480c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1481bd7bdd43STejun Heo 		pool->nr_idle--;
1482c8e55f36STejun Heo 
1483c8e55f36STejun Heo 	list_del_init(&worker->entry);
1484cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1485c8e55f36STejun Heo 
1486c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1487c8e55f36STejun Heo 
1488c34056a3STejun Heo 	kthread_stop(worker->task);
1489c34056a3STejun Heo 	kfree(worker);
1490c34056a3STejun Heo 
14918b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1492bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1493c34056a3STejun Heo }
1494c34056a3STejun Heo 
149563d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1496e22bee78STejun Heo {
149763d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
149863d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1499e22bee78STejun Heo 
1500e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1501e22bee78STejun Heo 
150263d95a91STejun Heo 	if (too_many_workers(pool)) {
1503e22bee78STejun Heo 		struct worker *worker;
1504e22bee78STejun Heo 		unsigned long expires;
1505e22bee78STejun Heo 
1506e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
150763d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1508e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1509e22bee78STejun Heo 
1510e22bee78STejun Heo 		if (time_before(jiffies, expires))
151163d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1512e22bee78STejun Heo 		else {
1513e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
151411ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
151563d95a91STejun Heo 			wake_up_worker(pool);
1516e22bee78STejun Heo 		}
1517e22bee78STejun Heo 	}
1518e22bee78STejun Heo 
1519e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1520e22bee78STejun Heo }
1521e22bee78STejun Heo 
1522e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1523e22bee78STejun Heo {
1524e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1525e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1526f3421797STejun Heo 	unsigned int cpu;
1527e22bee78STejun Heo 
1528e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1529e22bee78STejun Heo 		return false;
1530e22bee78STejun Heo 
1531e22bee78STejun Heo 	/* mayday mayday mayday */
1532bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1533f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1534f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1535f3421797STejun Heo 		cpu = 0;
1536f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1537e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1538e22bee78STejun Heo 	return true;
1539e22bee78STejun Heo }
1540e22bee78STejun Heo 
154163d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1542e22bee78STejun Heo {
154363d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
154463d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1545e22bee78STejun Heo 	struct work_struct *work;
1546e22bee78STejun Heo 
1547e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1548e22bee78STejun Heo 
154963d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1550e22bee78STejun Heo 		/*
1551e22bee78STejun Heo 		 * We've been trying to create a new worker but
1552e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1553e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1554e22bee78STejun Heo 		 * rescuers.
1555e22bee78STejun Heo 		 */
155663d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1557e22bee78STejun Heo 			send_mayday(work);
1558e22bee78STejun Heo 	}
1559e22bee78STejun Heo 
1560e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1561e22bee78STejun Heo 
156263d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1563e22bee78STejun Heo }
1564e22bee78STejun Heo 
1565e22bee78STejun Heo /**
1566e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
156763d95a91STejun Heo  * @pool: pool to create a new worker for
1568e22bee78STejun Heo  *
156963d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1570e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1571e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
157263d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1573e22bee78STejun Heo  * possible allocation deadlock.
1574e22bee78STejun Heo  *
1575e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1576e22bee78STejun Heo  * may_start_working() true.
1577e22bee78STejun Heo  *
1578e22bee78STejun Heo  * LOCKING:
1579e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1580e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1581e22bee78STejun Heo  * manager.
1582e22bee78STejun Heo  *
1583e22bee78STejun Heo  * RETURNS:
1584e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1585e22bee78STejun Heo  * otherwise.
1586e22bee78STejun Heo  */
158763d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
158806bd6ebfSNamhyung Kim __releases(&gcwq->lock)
158906bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1590e22bee78STejun Heo {
159163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
159263d95a91STejun Heo 
159363d95a91STejun Heo 	if (!need_to_create_worker(pool))
1594e22bee78STejun Heo 		return false;
1595e22bee78STejun Heo restart:
15969f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
15979f9c2364STejun Heo 
1598e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
159963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1600e22bee78STejun Heo 
1601e22bee78STejun Heo 	while (true) {
1602e22bee78STejun Heo 		struct worker *worker;
1603e22bee78STejun Heo 
160463d95a91STejun Heo 		worker = create_worker(pool, true);
1605e22bee78STejun Heo 		if (worker) {
160663d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1607e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1608e22bee78STejun Heo 			start_worker(worker);
160963d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1610e22bee78STejun Heo 			return true;
1611e22bee78STejun Heo 		}
1612e22bee78STejun Heo 
161363d95a91STejun Heo 		if (!need_to_create_worker(pool))
1614e22bee78STejun Heo 			break;
1615e22bee78STejun Heo 
1616e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1617e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
16189f9c2364STejun Heo 
161963d95a91STejun Heo 		if (!need_to_create_worker(pool))
1620e22bee78STejun Heo 			break;
1621e22bee78STejun Heo 	}
1622e22bee78STejun Heo 
162363d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1624e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
162563d95a91STejun Heo 	if (need_to_create_worker(pool))
1626e22bee78STejun Heo 		goto restart;
1627e22bee78STejun Heo 	return true;
1628e22bee78STejun Heo }
1629e22bee78STejun Heo 
1630e22bee78STejun Heo /**
1631e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
163263d95a91STejun Heo  * @pool: pool to destroy workers for
1633e22bee78STejun Heo  *
163463d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
1635e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1636e22bee78STejun Heo  *
1637e22bee78STejun Heo  * LOCKING:
1638e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1639e22bee78STejun Heo  * multiple times.  Called only from manager.
1640e22bee78STejun Heo  *
1641e22bee78STejun Heo  * RETURNS:
1642e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1643e22bee78STejun Heo  * otherwise.
1644e22bee78STejun Heo  */
164563d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
1646e22bee78STejun Heo {
1647e22bee78STejun Heo 	bool ret = false;
1648e22bee78STejun Heo 
164963d95a91STejun Heo 	while (too_many_workers(pool)) {
1650e22bee78STejun Heo 		struct worker *worker;
1651e22bee78STejun Heo 		unsigned long expires;
1652e22bee78STejun Heo 
165363d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1654e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1655e22bee78STejun Heo 
1656e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
165763d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1658e22bee78STejun Heo 			break;
1659e22bee78STejun Heo 		}
1660e22bee78STejun Heo 
1661e22bee78STejun Heo 		destroy_worker(worker);
1662e22bee78STejun Heo 		ret = true;
1663e22bee78STejun Heo 	}
1664e22bee78STejun Heo 
1665e22bee78STejun Heo 	return ret;
1666e22bee78STejun Heo }
1667e22bee78STejun Heo 
1668e22bee78STejun Heo /**
1669e22bee78STejun Heo  * manage_workers - manage worker pool
1670e22bee78STejun Heo  * @worker: self
1671e22bee78STejun Heo  *
1672e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
1673e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1674e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
1675e22bee78STejun Heo  *
1676e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
1677e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
1678e22bee78STejun Heo  * and may_start_working() is true.
1679e22bee78STejun Heo  *
1680e22bee78STejun Heo  * CONTEXT:
1681e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1682e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
1683e22bee78STejun Heo  *
1684e22bee78STejun Heo  * RETURNS:
1685e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
1686e22bee78STejun Heo  * some action was taken.
1687e22bee78STejun Heo  */
1688e22bee78STejun Heo static bool manage_workers(struct worker *worker)
1689e22bee78STejun Heo {
169063d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
169163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1692e22bee78STejun Heo 	bool ret = false;
1693e22bee78STejun Heo 
169411ebea50STejun Heo 	if (pool->flags & POOL_MANAGING_WORKERS)
1695e22bee78STejun Heo 		return ret;
1696e22bee78STejun Heo 
169711ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
169811ebea50STejun Heo 	pool->flags |= POOL_MANAGING_WORKERS;
1699e22bee78STejun Heo 
1700e22bee78STejun Heo 	/*
1701e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
1702e22bee78STejun Heo 	 * on return.
1703e22bee78STejun Heo 	 */
170463d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
170563d95a91STejun Heo 	ret |= maybe_create_worker(pool);
1706e22bee78STejun Heo 
170711ebea50STejun Heo 	pool->flags &= ~POOL_MANAGING_WORKERS;
1708e22bee78STejun Heo 
1709e22bee78STejun Heo 	/*
1710e22bee78STejun Heo 	 * The trustee might be waiting to take over the manager
1711e22bee78STejun Heo 	 * position, tell it we're done.
1712e22bee78STejun Heo 	 */
1713e22bee78STejun Heo 	if (unlikely(gcwq->trustee))
1714e22bee78STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1715e22bee78STejun Heo 
1716e22bee78STejun Heo 	return ret;
1717e22bee78STejun Heo }
1718e22bee78STejun Heo 
1719a62428c0STejun Heo /**
1720affee4b2STejun Heo  * move_linked_works - move linked works to a list
1721affee4b2STejun Heo  * @work: start of series of works to be scheduled
1722affee4b2STejun Heo  * @head: target list to append @work to
1723affee4b2STejun Heo  * @nextp: out paramter for nested worklist walking
1724affee4b2STejun Heo  *
1725affee4b2STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1726affee4b2STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1727affee4b2STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1728affee4b2STejun Heo  *
1729affee4b2STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1730affee4b2STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1731affee4b2STejun Heo  * nested inside outer list_for_each_entry_safe().
1732affee4b2STejun Heo  *
1733affee4b2STejun Heo  * CONTEXT:
17348b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1735affee4b2STejun Heo  */
1736affee4b2STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1737affee4b2STejun Heo 			      struct work_struct **nextp)
1738affee4b2STejun Heo {
1739affee4b2STejun Heo 	struct work_struct *n;
1740affee4b2STejun Heo 
1741affee4b2STejun Heo 	/*
1742affee4b2STejun Heo 	 * Linked worklist will always end before the end of the list,
1743affee4b2STejun Heo 	 * use NULL for list head.
1744affee4b2STejun Heo 	 */
1745affee4b2STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1746affee4b2STejun Heo 		list_move_tail(&work->entry, head);
1747affee4b2STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1748affee4b2STejun Heo 			break;
1749affee4b2STejun Heo 	}
1750affee4b2STejun Heo 
1751affee4b2STejun Heo 	/*
1752affee4b2STejun Heo 	 * If we're already inside safe list traversal and have moved
1753affee4b2STejun Heo 	 * multiple works to the scheduled queue, the next position
1754affee4b2STejun Heo 	 * needs to be updated.
1755affee4b2STejun Heo 	 */
1756affee4b2STejun Heo 	if (nextp)
1757affee4b2STejun Heo 		*nextp = n;
1758affee4b2STejun Heo }
1759affee4b2STejun Heo 
17601e19ffc6STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
17611e19ffc6STejun Heo {
17621e19ffc6STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
17631da177e4SLinus Torvalds 						    struct work_struct, entry);
176463d95a91STejun Heo 	struct list_head *pos = pool_determine_ins_pos(cwq->pool, cwq);
17651e19ffc6STejun Heo 
1766cdadf009STejun Heo 	trace_workqueue_activate_work(work);
1767649027d7STejun Heo 	move_linked_works(work, pos, NULL);
17688a2e8e5dSTejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
17691e19ffc6STejun Heo 	cwq->nr_active++;
17701e19ffc6STejun Heo }
17711e19ffc6STejun Heo 
1772affee4b2STejun Heo /**
177373f53c4aSTejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
177473f53c4aSTejun Heo  * @cwq: cwq of interest
177573f53c4aSTejun Heo  * @color: color of work which left the queue
17768a2e8e5dSTejun Heo  * @delayed: for a delayed work
177773f53c4aSTejun Heo  *
177873f53c4aSTejun Heo  * A work either has completed or is removed from pending queue,
177973f53c4aSTejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
178073f53c4aSTejun Heo  *
178173f53c4aSTejun Heo  * CONTEXT:
17828b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
178373f53c4aSTejun Heo  */
17848a2e8e5dSTejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
17858a2e8e5dSTejun Heo 				 bool delayed)
178673f53c4aSTejun Heo {
178773f53c4aSTejun Heo 	/* ignore uncolored works */
178873f53c4aSTejun Heo 	if (color == WORK_NO_COLOR)
178973f53c4aSTejun Heo 		return;
179073f53c4aSTejun Heo 
179173f53c4aSTejun Heo 	cwq->nr_in_flight[color]--;
17921e19ffc6STejun Heo 
17938a2e8e5dSTejun Heo 	if (!delayed) {
17948a2e8e5dSTejun Heo 		cwq->nr_active--;
1795502ca9d8STejun Heo 		if (!list_empty(&cwq->delayed_works)) {
17961e19ffc6STejun Heo 			/* one down, submit a delayed one */
1797502ca9d8STejun Heo 			if (cwq->nr_active < cwq->max_active)
17981e19ffc6STejun Heo 				cwq_activate_first_delayed(cwq);
1799502ca9d8STejun Heo 		}
18008a2e8e5dSTejun Heo 	}
180173f53c4aSTejun Heo 
180273f53c4aSTejun Heo 	/* is flush in progress and are we at the flushing tip? */
180373f53c4aSTejun Heo 	if (likely(cwq->flush_color != color))
180473f53c4aSTejun Heo 		return;
180573f53c4aSTejun Heo 
180673f53c4aSTejun Heo 	/* are there still in-flight works? */
180773f53c4aSTejun Heo 	if (cwq->nr_in_flight[color])
180873f53c4aSTejun Heo 		return;
180973f53c4aSTejun Heo 
181073f53c4aSTejun Heo 	/* this cwq is done, clear flush_color */
181173f53c4aSTejun Heo 	cwq->flush_color = -1;
181273f53c4aSTejun Heo 
181373f53c4aSTejun Heo 	/*
181473f53c4aSTejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
181573f53c4aSTejun Heo 	 * will handle the rest.
181673f53c4aSTejun Heo 	 */
181773f53c4aSTejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
181873f53c4aSTejun Heo 		complete(&cwq->wq->first_flusher->done);
181973f53c4aSTejun Heo }
182073f53c4aSTejun Heo 
182173f53c4aSTejun Heo /**
1822a62428c0STejun Heo  * process_one_work - process single work
1823c34056a3STejun Heo  * @worker: self
1824a62428c0STejun Heo  * @work: work to process
1825a62428c0STejun Heo  *
1826a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
1827a62428c0STejun Heo  * process a single work including synchronization against and
1828a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
1829a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
1830a62428c0STejun Heo  * call this function to process a work.
1831a62428c0STejun Heo  *
1832a62428c0STejun Heo  * CONTEXT:
18338b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1834a62428c0STejun Heo  */
1835c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
183606bd6ebfSNamhyung Kim __releases(&gcwq->lock)
183706bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
18381da177e4SLinus Torvalds {
18397e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1840bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1841bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1842c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
1843fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
18446bb49e59SDavid Howells 	work_func_t f = work->func;
184573f53c4aSTejun Heo 	int work_color;
18467e11629dSTejun Heo 	struct worker *collision;
18474e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
18484e6045f1SJohannes Berg 	/*
1849a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
1850a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
1851a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
1852a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
1853a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
18544e6045f1SJohannes Berg 	 */
18554d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
18564d82a1deSPeter Zijlstra 
18574d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
18584e6045f1SJohannes Berg #endif
18597e11629dSTejun Heo 	/*
18607e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
18617e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
18627e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
18637e11629dSTejun Heo 	 * currently executing one.
18647e11629dSTejun Heo 	 */
18657e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
18667e11629dSTejun Heo 	if (unlikely(collision)) {
18677e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
18687e11629dSTejun Heo 		return;
18697e11629dSTejun Heo 	}
18701da177e4SLinus Torvalds 
1871a62428c0STejun Heo 	/* claim and process */
18721da177e4SLinus Torvalds 	debug_work_deactivate(work);
1873c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
1874c34056a3STejun Heo 	worker->current_work = work;
18758cca0eeaSTejun Heo 	worker->current_cwq = cwq;
187673f53c4aSTejun Heo 	work_color = get_work_color(work);
18777a22ad75STejun Heo 
18787a22ad75STejun Heo 	/* record the current cpu number in the work data and dequeue */
18797a22ad75STejun Heo 	set_work_cpu(work, gcwq->cpu);
1880a62428c0STejun Heo 	list_del_init(&work->entry);
1881a62428c0STejun Heo 
1882649027d7STejun Heo 	/*
1883649027d7STejun Heo 	 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1884649027d7STejun Heo 	 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1885649027d7STejun Heo 	 */
188611ebea50STejun Heo 	if (unlikely(pool->flags & POOL_HIGHPRI_PENDING)) {
1887bd7bdd43STejun Heo 		struct work_struct *nwork = list_first_entry(&pool->worklist,
1888649027d7STejun Heo 					 struct work_struct, entry);
1889649027d7STejun Heo 
1890bd7bdd43STejun Heo 		if (!list_empty(&pool->worklist) &&
1891649027d7STejun Heo 		    get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
189263d95a91STejun Heo 			wake_up_worker(pool);
1893649027d7STejun Heo 		else
189411ebea50STejun Heo 			pool->flags &= ~POOL_HIGHPRI_PENDING;
1895649027d7STejun Heo 	}
1896649027d7STejun Heo 
1897fb0e7bebSTejun Heo 	/*
1898fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
1899fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
1900fb0e7bebSTejun Heo 	 */
1901fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1902fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1903fb0e7bebSTejun Heo 
1904974271c4STejun Heo 	/*
1905974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
1906974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
1907974271c4STejun Heo 	 */
190863d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
190963d95a91STejun Heo 		wake_up_worker(pool);
1910974271c4STejun Heo 
19118b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
19121da177e4SLinus Torvalds 
191323b2e599SOleg Nesterov 	work_clear_pending(work);
1914e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
19153295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
1916e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
191765f27f38SDavid Howells 	f(work);
1918e36c886aSArjan van de Ven 	/*
1919e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
1920e36c886aSArjan van de Ven 	 * point will only record its address.
1921e36c886aSArjan van de Ven 	 */
1922e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
19233295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
19243295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
19251da177e4SLinus Torvalds 
1926d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1927d5abe669SPeter Zijlstra 		printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1928d5abe669SPeter Zijlstra 		       "%s/0x%08x/%d\n",
1929a62428c0STejun Heo 		       current->comm, preempt_count(), task_pid_nr(current));
1930d5abe669SPeter Zijlstra 		printk(KERN_ERR "    last function: ");
1931d5abe669SPeter Zijlstra 		print_symbol("%s\n", (unsigned long)f);
1932d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
1933d5abe669SPeter Zijlstra 		dump_stack();
1934d5abe669SPeter Zijlstra 	}
1935d5abe669SPeter Zijlstra 
19368b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1937a62428c0STejun Heo 
1938fb0e7bebSTejun Heo 	/* clear cpu intensive status */
1939fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1940fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1941fb0e7bebSTejun Heo 
1942a62428c0STejun Heo 	/* we're done with it, release */
1943c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
1944c34056a3STejun Heo 	worker->current_work = NULL;
19458cca0eeaSTejun Heo 	worker->current_cwq = NULL;
19468a2e8e5dSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color, false);
19471da177e4SLinus Torvalds }
19481da177e4SLinus Torvalds 
1949affee4b2STejun Heo /**
1950affee4b2STejun Heo  * process_scheduled_works - process scheduled works
1951affee4b2STejun Heo  * @worker: self
1952affee4b2STejun Heo  *
1953affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
1954affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
1955affee4b2STejun Heo  * fetches a work from the top and executes it.
1956affee4b2STejun Heo  *
1957affee4b2STejun Heo  * CONTEXT:
19588b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1959affee4b2STejun Heo  * multiple times.
1960affee4b2STejun Heo  */
1961affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
19621da177e4SLinus Torvalds {
1963affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
1964affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
1965a62428c0STejun Heo 						struct work_struct, entry);
1966c34056a3STejun Heo 		process_one_work(worker, work);
1967a62428c0STejun Heo 	}
19681da177e4SLinus Torvalds }
19691da177e4SLinus Torvalds 
19704690c4abSTejun Heo /**
19714690c4abSTejun Heo  * worker_thread - the worker thread function
1972c34056a3STejun Heo  * @__worker: self
19734690c4abSTejun Heo  *
1974e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
1975e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
1976e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
1977e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
1978e22bee78STejun Heo  * rescuer_thread().
19794690c4abSTejun Heo  */
1980c34056a3STejun Heo static int worker_thread(void *__worker)
19811da177e4SLinus Torvalds {
1982c34056a3STejun Heo 	struct worker *worker = __worker;
1983bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1984bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
19851da177e4SLinus Torvalds 
1986e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
1987e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
1988c8e55f36STejun Heo woke_up:
19898b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1990affee4b2STejun Heo 
1991c8e55f36STejun Heo 	/* DIE can be set only while we're idle, checking here is enough */
1992c8e55f36STejun Heo 	if (worker->flags & WORKER_DIE) {
1993c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
1994e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
1995c8e55f36STejun Heo 		return 0;
1996c8e55f36STejun Heo 	}
1997c8e55f36STejun Heo 
1998c8e55f36STejun Heo 	worker_leave_idle(worker);
1999db7bccf4STejun Heo recheck:
2000e22bee78STejun Heo 	/* no more worker necessary? */
200163d95a91STejun Heo 	if (!need_more_worker(pool))
2002e22bee78STejun Heo 		goto sleep;
2003e22bee78STejun Heo 
2004e22bee78STejun Heo 	/* do we need to manage? */
200563d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2006e22bee78STejun Heo 		goto recheck;
2007e22bee78STejun Heo 
2008c8e55f36STejun Heo 	/*
2009c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2010c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2011c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2012c8e55f36STejun Heo 	 */
2013c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2014c8e55f36STejun Heo 
2015e22bee78STejun Heo 	/*
2016e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2017e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2018e22bee78STejun Heo 	 * assumed the manager role.
2019e22bee78STejun Heo 	 */
2020e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2021e22bee78STejun Heo 
2022e22bee78STejun Heo 	do {
2023affee4b2STejun Heo 		struct work_struct *work =
2024bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2025affee4b2STejun Heo 					 struct work_struct, entry);
2026affee4b2STejun Heo 
2027c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2028affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2029affee4b2STejun Heo 			process_one_work(worker, work);
2030affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2031affee4b2STejun Heo 				process_scheduled_works(worker);
2032affee4b2STejun Heo 		} else {
2033c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2034affee4b2STejun Heo 			process_scheduled_works(worker);
2035affee4b2STejun Heo 		}
203663d95a91STejun Heo 	} while (keep_working(pool));
2037affee4b2STejun Heo 
2038e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2039d313dd85STejun Heo sleep:
204063d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2041e22bee78STejun Heo 		goto recheck;
2042d313dd85STejun Heo 
2043c8e55f36STejun Heo 	/*
2044e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2045e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2046e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2047e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2048e22bee78STejun Heo 	 * prevent losing any event.
2049c8e55f36STejun Heo 	 */
2050c8e55f36STejun Heo 	worker_enter_idle(worker);
2051c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
20528b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
20531da177e4SLinus Torvalds 	schedule();
2054c8e55f36STejun Heo 	goto woke_up;
20551da177e4SLinus Torvalds }
20561da177e4SLinus Torvalds 
2057e22bee78STejun Heo /**
2058e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2059e22bee78STejun Heo  * @__wq: the associated workqueue
2060e22bee78STejun Heo  *
2061e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2062e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2063e22bee78STejun Heo  *
2064e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2065e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2066e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2067e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2068e22bee78STejun Heo  * the problem rescuer solves.
2069e22bee78STejun Heo  *
2070e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2071e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2072e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2073e22bee78STejun Heo  *
2074e22bee78STejun Heo  * This should happen rarely.
2075e22bee78STejun Heo  */
2076e22bee78STejun Heo static int rescuer_thread(void *__wq)
2077e22bee78STejun Heo {
2078e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2079e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2080e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2081f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2082e22bee78STejun Heo 	unsigned int cpu;
2083e22bee78STejun Heo 
2084e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2085e22bee78STejun Heo repeat:
2086e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
20871da177e4SLinus Torvalds 
20881da177e4SLinus Torvalds 	if (kthread_should_stop())
2089e22bee78STejun Heo 		return 0;
20901da177e4SLinus Torvalds 
2091f3421797STejun Heo 	/*
2092f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2093f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2094f3421797STejun Heo 	 */
2095f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2096f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2097f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2098bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2099bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2100e22bee78STejun Heo 		struct work_struct *work, *n;
2101e22bee78STejun Heo 
2102e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2103f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2104e22bee78STejun Heo 
2105e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2106bd7bdd43STejun Heo 		rescuer->pool = pool;
2107e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2108e22bee78STejun Heo 
2109e22bee78STejun Heo 		/*
2110e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2111e22bee78STejun Heo 		 * process'em.
2112e22bee78STejun Heo 		 */
2113e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2114bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2115e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2116e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2117e22bee78STejun Heo 
2118e22bee78STejun Heo 		process_scheduled_works(rescuer);
21197576958aSTejun Heo 
21207576958aSTejun Heo 		/*
21217576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
21227576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
21237576958aSTejun Heo 		 * and stalling the execution.
21247576958aSTejun Heo 		 */
212563d95a91STejun Heo 		if (keep_working(pool))
212663d95a91STejun Heo 			wake_up_worker(pool);
21277576958aSTejun Heo 
2128e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
21291da177e4SLinus Torvalds 	}
21301da177e4SLinus Torvalds 
2131e22bee78STejun Heo 	schedule();
2132e22bee78STejun Heo 	goto repeat;
21331da177e4SLinus Torvalds }
21341da177e4SLinus Torvalds 
2135fc2e4d70SOleg Nesterov struct wq_barrier {
2136fc2e4d70SOleg Nesterov 	struct work_struct	work;
2137fc2e4d70SOleg Nesterov 	struct completion	done;
2138fc2e4d70SOleg Nesterov };
2139fc2e4d70SOleg Nesterov 
2140fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2141fc2e4d70SOleg Nesterov {
2142fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2143fc2e4d70SOleg Nesterov 	complete(&barr->done);
2144fc2e4d70SOleg Nesterov }
2145fc2e4d70SOleg Nesterov 
21464690c4abSTejun Heo /**
21474690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
21484690c4abSTejun Heo  * @cwq: cwq to insert barrier into
21494690c4abSTejun Heo  * @barr: wq_barrier to insert
2150affee4b2STejun Heo  * @target: target work to attach @barr to
2151affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
21524690c4abSTejun Heo  *
2153affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2154affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2155affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2156affee4b2STejun Heo  * cpu.
2157affee4b2STejun Heo  *
2158affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2159affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2160affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2161affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2162affee4b2STejun Heo  * after a work with LINKED flag set.
2163affee4b2STejun Heo  *
2164affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2165affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
21664690c4abSTejun Heo  *
21674690c4abSTejun Heo  * CONTEXT:
21688b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
21694690c4abSTejun Heo  */
217083c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2171affee4b2STejun Heo 			      struct wq_barrier *barr,
2172affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2173fc2e4d70SOleg Nesterov {
2174affee4b2STejun Heo 	struct list_head *head;
2175affee4b2STejun Heo 	unsigned int linked = 0;
2176affee4b2STejun Heo 
2177dc186ad7SThomas Gleixner 	/*
21788b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2179dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2180dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2181dc186ad7SThomas Gleixner 	 * might deadlock.
2182dc186ad7SThomas Gleixner 	 */
2183ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
218422df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2185fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
218683c22520SOleg Nesterov 
2187affee4b2STejun Heo 	/*
2188affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2189affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2190affee4b2STejun Heo 	 */
2191affee4b2STejun Heo 	if (worker)
2192affee4b2STejun Heo 		head = worker->scheduled.next;
2193affee4b2STejun Heo 	else {
2194affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2195affee4b2STejun Heo 
2196affee4b2STejun Heo 		head = target->entry.next;
2197affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2198affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2199affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2200affee4b2STejun Heo 	}
2201affee4b2STejun Heo 
2202dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2203affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2204affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2205fc2e4d70SOleg Nesterov }
2206fc2e4d70SOleg Nesterov 
220773f53c4aSTejun Heo /**
220873f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
220973f53c4aSTejun Heo  * @wq: workqueue being flushed
221073f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
221173f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
221273f53c4aSTejun Heo  *
221373f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
221473f53c4aSTejun Heo  *
221573f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
221673f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
221773f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
221873f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
221973f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
222073f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
222173f53c4aSTejun Heo  *
222273f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
222373f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
222473f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
222573f53c4aSTejun Heo  * is returned.
222673f53c4aSTejun Heo  *
222773f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
222873f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
222973f53c4aSTejun Heo  * advanced to @work_color.
223073f53c4aSTejun Heo  *
223173f53c4aSTejun Heo  * CONTEXT:
223273f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
223373f53c4aSTejun Heo  *
223473f53c4aSTejun Heo  * RETURNS:
223573f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
223673f53c4aSTejun Heo  * otherwise.
223773f53c4aSTejun Heo  */
223873f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
223973f53c4aSTejun Heo 				      int flush_color, int work_color)
22401da177e4SLinus Torvalds {
224173f53c4aSTejun Heo 	bool wait = false;
224273f53c4aSTejun Heo 	unsigned int cpu;
22431da177e4SLinus Torvalds 
224473f53c4aSTejun Heo 	if (flush_color >= 0) {
224573f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
224673f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2247dc186ad7SThomas Gleixner 	}
224814441960SOleg Nesterov 
2249f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
225073f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2251bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
22521da177e4SLinus Torvalds 
22538b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
225473f53c4aSTejun Heo 
225573f53c4aSTejun Heo 		if (flush_color >= 0) {
225673f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
225773f53c4aSTejun Heo 
225873f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
225973f53c4aSTejun Heo 				cwq->flush_color = flush_color;
226073f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
226173f53c4aSTejun Heo 				wait = true;
22621da177e4SLinus Torvalds 			}
226373f53c4aSTejun Heo 		}
226473f53c4aSTejun Heo 
226573f53c4aSTejun Heo 		if (work_color >= 0) {
226673f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
226773f53c4aSTejun Heo 			cwq->work_color = work_color;
226873f53c4aSTejun Heo 		}
226973f53c4aSTejun Heo 
22708b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
22711da177e4SLinus Torvalds 	}
22721da177e4SLinus Torvalds 
227373f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
227473f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
227573f53c4aSTejun Heo 
227673f53c4aSTejun Heo 	return wait;
227783c22520SOleg Nesterov }
22781da177e4SLinus Torvalds 
22790fcb78c2SRolf Eike Beer /**
22801da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
22810fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
22821da177e4SLinus Torvalds  *
22831da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
22841da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
22851da177e4SLinus Torvalds  *
2286fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2287fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
22881da177e4SLinus Torvalds  */
22897ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
22901da177e4SLinus Torvalds {
229173f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
229273f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
229373f53c4aSTejun Heo 		.flush_color = -1,
229473f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
229573f53c4aSTejun Heo 	};
229673f53c4aSTejun Heo 	int next_color;
2297b1f4ec17SOleg Nesterov 
22983295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
22993295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
230073f53c4aSTejun Heo 
230173f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
230273f53c4aSTejun Heo 
230373f53c4aSTejun Heo 	/*
230473f53c4aSTejun Heo 	 * Start-to-wait phase
230573f53c4aSTejun Heo 	 */
230673f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
230773f53c4aSTejun Heo 
230873f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
230973f53c4aSTejun Heo 		/*
231073f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
231173f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
231273f53c4aSTejun Heo 		 * by one.
231373f53c4aSTejun Heo 		 */
231473f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
231573f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
231673f53c4aSTejun Heo 		wq->work_color = next_color;
231773f53c4aSTejun Heo 
231873f53c4aSTejun Heo 		if (!wq->first_flusher) {
231973f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
232073f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
232173f53c4aSTejun Heo 
232273f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
232373f53c4aSTejun Heo 
232473f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
232573f53c4aSTejun Heo 						       wq->work_color)) {
232673f53c4aSTejun Heo 				/* nothing to flush, done */
232773f53c4aSTejun Heo 				wq->flush_color = next_color;
232873f53c4aSTejun Heo 				wq->first_flusher = NULL;
232973f53c4aSTejun Heo 				goto out_unlock;
233073f53c4aSTejun Heo 			}
233173f53c4aSTejun Heo 		} else {
233273f53c4aSTejun Heo 			/* wait in queue */
233373f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
233473f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
233573f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
233673f53c4aSTejun Heo 		}
233773f53c4aSTejun Heo 	} else {
233873f53c4aSTejun Heo 		/*
233973f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
234073f53c4aSTejun Heo 		 * The next flush completion will assign us
234173f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
234273f53c4aSTejun Heo 		 */
234373f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
234473f53c4aSTejun Heo 	}
234573f53c4aSTejun Heo 
234673f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
234773f53c4aSTejun Heo 
234873f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
234973f53c4aSTejun Heo 
235073f53c4aSTejun Heo 	/*
235173f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
235273f53c4aSTejun Heo 	 *
235373f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
235473f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
235573f53c4aSTejun Heo 	 */
235673f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
235773f53c4aSTejun Heo 		return;
235873f53c4aSTejun Heo 
235973f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
236073f53c4aSTejun Heo 
23614ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
23624ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
23634ce48b37STejun Heo 		goto out_unlock;
23644ce48b37STejun Heo 
236573f53c4aSTejun Heo 	wq->first_flusher = NULL;
236673f53c4aSTejun Heo 
236773f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
236873f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
236973f53c4aSTejun Heo 
237073f53c4aSTejun Heo 	while (true) {
237173f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
237273f53c4aSTejun Heo 
237373f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
237473f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
237573f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
237673f53c4aSTejun Heo 				break;
237773f53c4aSTejun Heo 			list_del_init(&next->list);
237873f53c4aSTejun Heo 			complete(&next->done);
237973f53c4aSTejun Heo 		}
238073f53c4aSTejun Heo 
238173f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
238273f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
238373f53c4aSTejun Heo 
238473f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
238573f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
238673f53c4aSTejun Heo 
238773f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
238873f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
238973f53c4aSTejun Heo 			/*
239073f53c4aSTejun Heo 			 * Assign the same color to all overflowed
239173f53c4aSTejun Heo 			 * flushers, advance work_color and append to
239273f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
239373f53c4aSTejun Heo 			 * phase for these overflowed flushers.
239473f53c4aSTejun Heo 			 */
239573f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
239673f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
239773f53c4aSTejun Heo 
239873f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
239973f53c4aSTejun Heo 
240073f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
240173f53c4aSTejun Heo 					      &wq->flusher_queue);
240273f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
240373f53c4aSTejun Heo 		}
240473f53c4aSTejun Heo 
240573f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
240673f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
240773f53c4aSTejun Heo 			break;
240873f53c4aSTejun Heo 		}
240973f53c4aSTejun Heo 
241073f53c4aSTejun Heo 		/*
241173f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
241273f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
241373f53c4aSTejun Heo 		 */
241473f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
241573f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
241673f53c4aSTejun Heo 
241773f53c4aSTejun Heo 		list_del_init(&next->list);
241873f53c4aSTejun Heo 		wq->first_flusher = next;
241973f53c4aSTejun Heo 
242073f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
242173f53c4aSTejun Heo 			break;
242273f53c4aSTejun Heo 
242373f53c4aSTejun Heo 		/*
242473f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
242573f53c4aSTejun Heo 		 * flusher and repeat cascading.
242673f53c4aSTejun Heo 		 */
242773f53c4aSTejun Heo 		wq->first_flusher = NULL;
242873f53c4aSTejun Heo 	}
242973f53c4aSTejun Heo 
243073f53c4aSTejun Heo out_unlock:
243173f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
24321da177e4SLinus Torvalds }
2433ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
24341da177e4SLinus Torvalds 
24359c5a2ba7STejun Heo /**
24369c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
24379c5a2ba7STejun Heo  * @wq: workqueue to drain
24389c5a2ba7STejun Heo  *
24399c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
24409c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
24419c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
24429c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
24439c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
24449c5a2ba7STejun Heo  * takes too long.
24459c5a2ba7STejun Heo  */
24469c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
24479c5a2ba7STejun Heo {
24489c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
24499c5a2ba7STejun Heo 	unsigned int cpu;
24509c5a2ba7STejun Heo 
24519c5a2ba7STejun Heo 	/*
24529c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
24539c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
24549c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
24559c5a2ba7STejun Heo 	 */
24569c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24579c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
24589c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
24599c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24609c5a2ba7STejun Heo reflush:
24619c5a2ba7STejun Heo 	flush_workqueue(wq);
24629c5a2ba7STejun Heo 
24639c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
24649c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2465fa2563e4SThomas Tuttle 		bool drained;
24669c5a2ba7STejun Heo 
2467bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2468fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2469bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2470fa2563e4SThomas Tuttle 
2471fa2563e4SThomas Tuttle 		if (drained)
24729c5a2ba7STejun Heo 			continue;
24739c5a2ba7STejun Heo 
24749c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
24759c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
24769c5a2ba7STejun Heo 			pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
24779c5a2ba7STejun Heo 				   wq->name, flush_cnt);
24789c5a2ba7STejun Heo 		goto reflush;
24799c5a2ba7STejun Heo 	}
24809c5a2ba7STejun Heo 
24819c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24829c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
24839c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
24849c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24859c5a2ba7STejun Heo }
24869c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
24879c5a2ba7STejun Heo 
2488baf59022STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2489baf59022STejun Heo 			     bool wait_executing)
2490baf59022STejun Heo {
2491baf59022STejun Heo 	struct worker *worker = NULL;
2492baf59022STejun Heo 	struct global_cwq *gcwq;
2493baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2494baf59022STejun Heo 
2495baf59022STejun Heo 	might_sleep();
2496baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2497baf59022STejun Heo 	if (!gcwq)
2498baf59022STejun Heo 		return false;
2499baf59022STejun Heo 
2500baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2501baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2502baf59022STejun Heo 		/*
2503baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2504baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2505baf59022STejun Heo 		 * are not going to wait.
2506baf59022STejun Heo 		 */
2507baf59022STejun Heo 		smp_rmb();
2508baf59022STejun Heo 		cwq = get_work_cwq(work);
2509bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2510baf59022STejun Heo 			goto already_gone;
2511baf59022STejun Heo 	} else if (wait_executing) {
2512baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2513baf59022STejun Heo 		if (!worker)
2514baf59022STejun Heo 			goto already_gone;
2515baf59022STejun Heo 		cwq = worker->current_cwq;
2516baf59022STejun Heo 	} else
2517baf59022STejun Heo 		goto already_gone;
2518baf59022STejun Heo 
2519baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2520baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2521baf59022STejun Heo 
2522e159489bSTejun Heo 	/*
2523e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2524e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2525e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2526e159489bSTejun Heo 	 * access.
2527e159489bSTejun Heo 	 */
2528e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2529baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2530e159489bSTejun Heo 	else
2531e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2532baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2533e159489bSTejun Heo 
2534baf59022STejun Heo 	return true;
2535baf59022STejun Heo already_gone:
2536baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2537baf59022STejun Heo 	return false;
2538baf59022STejun Heo }
2539baf59022STejun Heo 
2540db700897SOleg Nesterov /**
2541401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2542401a8d04STejun Heo  * @work: the work to flush
2543db700897SOleg Nesterov  *
2544401a8d04STejun Heo  * Wait until @work has finished execution.  This function considers
2545401a8d04STejun Heo  * only the last queueing instance of @work.  If @work has been
2546401a8d04STejun Heo  * enqueued across different CPUs on a non-reentrant workqueue or on
2547401a8d04STejun Heo  * multiple workqueues, @work might still be executing on return on
2548401a8d04STejun Heo  * some of the CPUs from earlier queueing.
2549a67da70dSOleg Nesterov  *
2550401a8d04STejun Heo  * If @work was queued only on a non-reentrant, ordered or unbound
2551401a8d04STejun Heo  * workqueue, @work is guaranteed to be idle on return if it hasn't
2552401a8d04STejun Heo  * been requeued since flush started.
2553401a8d04STejun Heo  *
2554401a8d04STejun Heo  * RETURNS:
2555401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2556401a8d04STejun Heo  * %false if it was already idle.
2557db700897SOleg Nesterov  */
2558401a8d04STejun Heo bool flush_work(struct work_struct *work)
2559db700897SOleg Nesterov {
2560db700897SOleg Nesterov 	struct wq_barrier barr;
2561db700897SOleg Nesterov 
25620976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
25630976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
25640976dfc1SStephen Boyd 
2565baf59022STejun Heo 	if (start_flush_work(work, &barr, true)) {
2566db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2567dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2568401a8d04STejun Heo 		return true;
2569baf59022STejun Heo 	} else
2570401a8d04STejun Heo 		return false;
2571db700897SOleg Nesterov }
2572db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2573db700897SOleg Nesterov 
2574401a8d04STejun Heo static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2575401a8d04STejun Heo {
2576401a8d04STejun Heo 	struct wq_barrier barr;
2577401a8d04STejun Heo 	struct worker *worker;
2578401a8d04STejun Heo 
2579401a8d04STejun Heo 	spin_lock_irq(&gcwq->lock);
2580401a8d04STejun Heo 
2581401a8d04STejun Heo 	worker = find_worker_executing_work(gcwq, work);
2582401a8d04STejun Heo 	if (unlikely(worker))
2583401a8d04STejun Heo 		insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2584401a8d04STejun Heo 
2585401a8d04STejun Heo 	spin_unlock_irq(&gcwq->lock);
2586401a8d04STejun Heo 
2587401a8d04STejun Heo 	if (unlikely(worker)) {
2588401a8d04STejun Heo 		wait_for_completion(&barr.done);
2589401a8d04STejun Heo 		destroy_work_on_stack(&barr.work);
2590401a8d04STejun Heo 		return true;
2591401a8d04STejun Heo 	} else
2592401a8d04STejun Heo 		return false;
2593401a8d04STejun Heo }
2594401a8d04STejun Heo 
2595401a8d04STejun Heo static bool wait_on_work(struct work_struct *work)
2596401a8d04STejun Heo {
2597401a8d04STejun Heo 	bool ret = false;
2598401a8d04STejun Heo 	int cpu;
2599401a8d04STejun Heo 
2600401a8d04STejun Heo 	might_sleep();
2601401a8d04STejun Heo 
2602401a8d04STejun Heo 	lock_map_acquire(&work->lockdep_map);
2603401a8d04STejun Heo 	lock_map_release(&work->lockdep_map);
2604401a8d04STejun Heo 
2605401a8d04STejun Heo 	for_each_gcwq_cpu(cpu)
2606401a8d04STejun Heo 		ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2607401a8d04STejun Heo 	return ret;
2608401a8d04STejun Heo }
2609401a8d04STejun Heo 
261009383498STejun Heo /**
261109383498STejun Heo  * flush_work_sync - wait until a work has finished execution
261209383498STejun Heo  * @work: the work to flush
261309383498STejun Heo  *
261409383498STejun Heo  * Wait until @work has finished execution.  On return, it's
261509383498STejun Heo  * guaranteed that all queueing instances of @work which happened
261609383498STejun Heo  * before this function is called are finished.  In other words, if
261709383498STejun Heo  * @work hasn't been requeued since this function was called, @work is
261809383498STejun Heo  * guaranteed to be idle on return.
261909383498STejun Heo  *
262009383498STejun Heo  * RETURNS:
262109383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
262209383498STejun Heo  * %false if it was already idle.
262309383498STejun Heo  */
262409383498STejun Heo bool flush_work_sync(struct work_struct *work)
262509383498STejun Heo {
262609383498STejun Heo 	struct wq_barrier barr;
262709383498STejun Heo 	bool pending, waited;
262809383498STejun Heo 
262909383498STejun Heo 	/* we'll wait for executions separately, queue barr only if pending */
263009383498STejun Heo 	pending = start_flush_work(work, &barr, false);
263109383498STejun Heo 
263209383498STejun Heo 	/* wait for executions to finish */
263309383498STejun Heo 	waited = wait_on_work(work);
263409383498STejun Heo 
263509383498STejun Heo 	/* wait for the pending one */
263609383498STejun Heo 	if (pending) {
263709383498STejun Heo 		wait_for_completion(&barr.done);
263809383498STejun Heo 		destroy_work_on_stack(&barr.work);
263909383498STejun Heo 	}
264009383498STejun Heo 
264109383498STejun Heo 	return pending || waited;
264209383498STejun Heo }
264309383498STejun Heo EXPORT_SYMBOL_GPL(flush_work_sync);
264409383498STejun Heo 
26456e84d644SOleg Nesterov /*
26461f1f642eSOleg Nesterov  * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
26476e84d644SOleg Nesterov  * so this work can't be re-armed in any way.
26486e84d644SOleg Nesterov  */
26496e84d644SOleg Nesterov static int try_to_grab_pending(struct work_struct *work)
26506e84d644SOleg Nesterov {
26518b03ae3cSTejun Heo 	struct global_cwq *gcwq;
26521f1f642eSOleg Nesterov 	int ret = -1;
26536e84d644SOleg Nesterov 
265422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
26551f1f642eSOleg Nesterov 		return 0;
26566e84d644SOleg Nesterov 
26576e84d644SOleg Nesterov 	/*
26586e84d644SOleg Nesterov 	 * The queueing is in progress, or it is already queued. Try to
26596e84d644SOleg Nesterov 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
26606e84d644SOleg Nesterov 	 */
26617a22ad75STejun Heo 	gcwq = get_work_gcwq(work);
26627a22ad75STejun Heo 	if (!gcwq)
26636e84d644SOleg Nesterov 		return ret;
26646e84d644SOleg Nesterov 
26658b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
26666e84d644SOleg Nesterov 	if (!list_empty(&work->entry)) {
26676e84d644SOleg Nesterov 		/*
26687a22ad75STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
26696e84d644SOleg Nesterov 		 * In that case we must see the new value after rmb(), see
26706e84d644SOleg Nesterov 		 * insert_work()->wmb().
26716e84d644SOleg Nesterov 		 */
26726e84d644SOleg Nesterov 		smp_rmb();
26737a22ad75STejun Heo 		if (gcwq == get_work_gcwq(work)) {
2674dc186ad7SThomas Gleixner 			debug_work_deactivate(work);
26756e84d644SOleg Nesterov 			list_del_init(&work->entry);
26767a22ad75STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
26778a2e8e5dSTejun Heo 				get_work_color(work),
26788a2e8e5dSTejun Heo 				*work_data_bits(work) & WORK_STRUCT_DELAYED);
26796e84d644SOleg Nesterov 			ret = 1;
26806e84d644SOleg Nesterov 		}
26816e84d644SOleg Nesterov 	}
26828b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
26836e84d644SOleg Nesterov 
26846e84d644SOleg Nesterov 	return ret;
26856e84d644SOleg Nesterov }
26866e84d644SOleg Nesterov 
2687401a8d04STejun Heo static bool __cancel_work_timer(struct work_struct *work,
26881f1f642eSOleg Nesterov 				struct timer_list* timer)
26891f1f642eSOleg Nesterov {
26901f1f642eSOleg Nesterov 	int ret;
26911f1f642eSOleg Nesterov 
26921f1f642eSOleg Nesterov 	do {
26931f1f642eSOleg Nesterov 		ret = (timer && likely(del_timer(timer)));
26941f1f642eSOleg Nesterov 		if (!ret)
26951f1f642eSOleg Nesterov 			ret = try_to_grab_pending(work);
26961f1f642eSOleg Nesterov 		wait_on_work(work);
26971f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
26981f1f642eSOleg Nesterov 
26997a22ad75STejun Heo 	clear_work_data(work);
27001f1f642eSOleg Nesterov 	return ret;
27011f1f642eSOleg Nesterov }
27021f1f642eSOleg Nesterov 
27036e84d644SOleg Nesterov /**
2704401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2705401a8d04STejun Heo  * @work: the work to cancel
27066e84d644SOleg Nesterov  *
2707401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2708401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2709401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2710401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
27111f1f642eSOleg Nesterov  *
2712401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2713401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
27146e84d644SOleg Nesterov  *
2715401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
27166e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2717401a8d04STejun Heo  *
2718401a8d04STejun Heo  * RETURNS:
2719401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
27206e84d644SOleg Nesterov  */
2721401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
27226e84d644SOleg Nesterov {
27231f1f642eSOleg Nesterov 	return __cancel_work_timer(work, NULL);
2724b89deed3SOleg Nesterov }
272528e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2726b89deed3SOleg Nesterov 
27276e84d644SOleg Nesterov /**
2728401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2729401a8d04STejun Heo  * @dwork: the delayed work to flush
27306e84d644SOleg Nesterov  *
2731401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2732401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2733401a8d04STejun Heo  * considers the last queueing instance of @dwork.
27341f1f642eSOleg Nesterov  *
2735401a8d04STejun Heo  * RETURNS:
2736401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2737401a8d04STejun Heo  * %false if it was already idle.
27386e84d644SOleg Nesterov  */
2739401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2740401a8d04STejun Heo {
2741401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
2742401a8d04STejun Heo 		__queue_work(raw_smp_processor_id(),
2743401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
2744401a8d04STejun Heo 	return flush_work(&dwork->work);
2745401a8d04STejun Heo }
2746401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2747401a8d04STejun Heo 
2748401a8d04STejun Heo /**
274909383498STejun Heo  * flush_delayed_work_sync - wait for a dwork to finish
275009383498STejun Heo  * @dwork: the delayed work to flush
275109383498STejun Heo  *
275209383498STejun Heo  * Delayed timer is cancelled and the pending work is queued for
275309383498STejun Heo  * execution immediately.  Other than timer handling, its behavior
275409383498STejun Heo  * is identical to flush_work_sync().
275509383498STejun Heo  *
275609383498STejun Heo  * RETURNS:
275709383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
275809383498STejun Heo  * %false if it was already idle.
275909383498STejun Heo  */
276009383498STejun Heo bool flush_delayed_work_sync(struct delayed_work *dwork)
276109383498STejun Heo {
276209383498STejun Heo 	if (del_timer_sync(&dwork->timer))
276309383498STejun Heo 		__queue_work(raw_smp_processor_id(),
276409383498STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
276509383498STejun Heo 	return flush_work_sync(&dwork->work);
276609383498STejun Heo }
276709383498STejun Heo EXPORT_SYMBOL(flush_delayed_work_sync);
276809383498STejun Heo 
276909383498STejun Heo /**
2770401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2771401a8d04STejun Heo  * @dwork: the delayed work cancel
2772401a8d04STejun Heo  *
2773401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2774401a8d04STejun Heo  *
2775401a8d04STejun Heo  * RETURNS:
2776401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2777401a8d04STejun Heo  */
2778401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
27796e84d644SOleg Nesterov {
27801f1f642eSOleg Nesterov 	return __cancel_work_timer(&dwork->work, &dwork->timer);
27816e84d644SOleg Nesterov }
2782f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
27831da177e4SLinus Torvalds 
27840fcb78c2SRolf Eike Beer /**
27850fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
27860fcb78c2SRolf Eike Beer  * @work: job to be done
27870fcb78c2SRolf Eike Beer  *
27885b0f437dSBart Van Assche  * Returns zero if @work was already on the kernel-global workqueue and
27895b0f437dSBart Van Assche  * non-zero otherwise.
27905b0f437dSBart Van Assche  *
27915b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
27925b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
27935b0f437dSBart Van Assche  * workqueue otherwise.
27940fcb78c2SRolf Eike Beer  */
27957ad5b3a5SHarvey Harrison int schedule_work(struct work_struct *work)
27961da177e4SLinus Torvalds {
2797d320c038STejun Heo 	return queue_work(system_wq, work);
27981da177e4SLinus Torvalds }
2799ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
28001da177e4SLinus Torvalds 
2801c1a220e7SZhang Rui /*
2802c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2803c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2804c1a220e7SZhang Rui  * @work: job to be done
2805c1a220e7SZhang Rui  *
2806c1a220e7SZhang Rui  * This puts a job on a specific cpu
2807c1a220e7SZhang Rui  */
2808c1a220e7SZhang Rui int schedule_work_on(int cpu, struct work_struct *work)
2809c1a220e7SZhang Rui {
2810d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2811c1a220e7SZhang Rui }
2812c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2813c1a220e7SZhang Rui 
28140fcb78c2SRolf Eike Beer /**
28150fcb78c2SRolf Eike Beer  * schedule_delayed_work - put work task in global workqueue after delay
281652bad64dSDavid Howells  * @dwork: job to be done
281752bad64dSDavid Howells  * @delay: number of jiffies to wait or 0 for immediate execution
28180fcb78c2SRolf Eike Beer  *
28190fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
28200fcb78c2SRolf Eike Beer  * workqueue.
28210fcb78c2SRolf Eike Beer  */
28227ad5b3a5SHarvey Harrison int schedule_delayed_work(struct delayed_work *dwork,
282382f67cd9SIngo Molnar 					unsigned long delay)
28241da177e4SLinus Torvalds {
2825d320c038STejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
28261da177e4SLinus Torvalds }
2827ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work);
28281da177e4SLinus Torvalds 
28290fcb78c2SRolf Eike Beer /**
28300fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
28310fcb78c2SRolf Eike Beer  * @cpu: cpu to use
283252bad64dSDavid Howells  * @dwork: job to be done
28330fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
28340fcb78c2SRolf Eike Beer  *
28350fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
28360fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
28370fcb78c2SRolf Eike Beer  */
28381da177e4SLinus Torvalds int schedule_delayed_work_on(int cpu,
283952bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
28401da177e4SLinus Torvalds {
2841d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
28421da177e4SLinus Torvalds }
2843ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
28441da177e4SLinus Torvalds 
2845b6136773SAndrew Morton /**
284631ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
2847b6136773SAndrew Morton  * @func: the function to call
2848b6136773SAndrew Morton  *
284931ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
285031ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
2851b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
285231ddd871STejun Heo  *
285331ddd871STejun Heo  * RETURNS:
285431ddd871STejun Heo  * 0 on success, -errno on failure.
2855b6136773SAndrew Morton  */
285665f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
285715316ba8SChristoph Lameter {
285815316ba8SChristoph Lameter 	int cpu;
285938f51568SNamhyung Kim 	struct work_struct __percpu *works;
286015316ba8SChristoph Lameter 
2861b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
2862b6136773SAndrew Morton 	if (!works)
286315316ba8SChristoph Lameter 		return -ENOMEM;
2864b6136773SAndrew Morton 
286595402b38SGautham R Shenoy 	get_online_cpus();
286693981800STejun Heo 
286715316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
28689bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
28699bfb1839SIngo Molnar 
28709bfb1839SIngo Molnar 		INIT_WORK(work, func);
28718de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
287215316ba8SChristoph Lameter 	}
287393981800STejun Heo 
287493981800STejun Heo 	for_each_online_cpu(cpu)
28758616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
287693981800STejun Heo 
287795402b38SGautham R Shenoy 	put_online_cpus();
2878b6136773SAndrew Morton 	free_percpu(works);
287915316ba8SChristoph Lameter 	return 0;
288015316ba8SChristoph Lameter }
288115316ba8SChristoph Lameter 
2882eef6a7d5SAlan Stern /**
2883eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
2884eef6a7d5SAlan Stern  *
2885eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
2886eef6a7d5SAlan Stern  * completion.
2887eef6a7d5SAlan Stern  *
2888eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
2889eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
2890eef6a7d5SAlan Stern  * will lead to deadlock:
2891eef6a7d5SAlan Stern  *
2892eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
2893eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
2894eef6a7d5SAlan Stern  *
2895eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
2896eef6a7d5SAlan Stern  *
2897eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
2898eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
2899eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
2900eef6a7d5SAlan Stern  *
2901eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
2902eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
2903eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
2904eef6a7d5SAlan Stern  * cancel_work_sync() instead.
2905eef6a7d5SAlan Stern  */
29061da177e4SLinus Torvalds void flush_scheduled_work(void)
29071da177e4SLinus Torvalds {
2908d320c038STejun Heo 	flush_workqueue(system_wq);
29091da177e4SLinus Torvalds }
2910ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
29111da177e4SLinus Torvalds 
29121da177e4SLinus Torvalds /**
29131fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
29141fa44ecaSJames Bottomley  * @fn:		the function to execute
29151fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
29161fa44ecaSJames Bottomley  *		be available when the work executes)
29171fa44ecaSJames Bottomley  *
29181fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
29191fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
29201fa44ecaSJames Bottomley  *
29211fa44ecaSJames Bottomley  * Returns:	0 - function was executed
29221fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
29231fa44ecaSJames Bottomley  */
292465f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
29251fa44ecaSJames Bottomley {
29261fa44ecaSJames Bottomley 	if (!in_interrupt()) {
292765f27f38SDavid Howells 		fn(&ew->work);
29281fa44ecaSJames Bottomley 		return 0;
29291fa44ecaSJames Bottomley 	}
29301fa44ecaSJames Bottomley 
293165f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
29321fa44ecaSJames Bottomley 	schedule_work(&ew->work);
29331fa44ecaSJames Bottomley 
29341fa44ecaSJames Bottomley 	return 1;
29351fa44ecaSJames Bottomley }
29361fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
29371fa44ecaSJames Bottomley 
29381da177e4SLinus Torvalds int keventd_up(void)
29391da177e4SLinus Torvalds {
2940d320c038STejun Heo 	return system_wq != NULL;
29411da177e4SLinus Torvalds }
29421da177e4SLinus Torvalds 
2943bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
29441da177e4SLinus Torvalds {
29453af24433SOleg Nesterov 	/*
29460f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
29470f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
29480f900049STejun Heo 	 * unsigned long long.
29493af24433SOleg Nesterov 	 */
29500f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
29510f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
29520f900049STejun Heo 				   __alignof__(unsigned long long));
29533af24433SOleg Nesterov 
2954e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2955f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2956931ac77eSTejun Heo 	else {
29570f900049STejun Heo 		void *ptr;
2958e1d8aa9fSFrederic Weisbecker 
29590f900049STejun Heo 		/*
2960f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
2961f3421797STejun Heo 		 * pointer at the end pointing back to the originally
2962f3421797STejun Heo 		 * allocated pointer which will be used for free.
29630f900049STejun Heo 		 */
2964bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2965bdbc5dd7STejun Heo 		if (ptr) {
2966bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2967bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
2968bdbc5dd7STejun Heo 		}
29693af24433SOleg Nesterov 	}
29703af24433SOleg Nesterov 
29710415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
2972bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2973bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
29740f900049STejun Heo }
29750f900049STejun Heo 
2976bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
297706ba38a9SOleg Nesterov {
2978e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2979bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
2980f3421797STejun Heo 	else if (wq->cpu_wq.single) {
2981f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
2982f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
298306ba38a9SOleg Nesterov 	}
298406ba38a9SOleg Nesterov }
298506ba38a9SOleg Nesterov 
2986f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
2987f3421797STejun Heo 			       const char *name)
2988b71ab8c2STejun Heo {
2989f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2990f3421797STejun Heo 
2991f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
2992b71ab8c2STejun Heo 		printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2993b71ab8c2STejun Heo 		       "is out of range, clamping between %d and %d\n",
2994f3421797STejun Heo 		       max_active, name, 1, lim);
2995b71ab8c2STejun Heo 
2996f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
2997b71ab8c2STejun Heo }
2998b71ab8c2STejun Heo 
2999b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
300097e37d7bSTejun Heo 					       unsigned int flags,
30011e19ffc6STejun Heo 					       int max_active,
3002eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3003b196be89STejun Heo 					       const char *lock_name, ...)
30043af24433SOleg Nesterov {
3005b196be89STejun Heo 	va_list args, args1;
30063af24433SOleg Nesterov 	struct workqueue_struct *wq;
3007c34056a3STejun Heo 	unsigned int cpu;
3008b196be89STejun Heo 	size_t namelen;
3009b196be89STejun Heo 
3010b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3011b196be89STejun Heo 	va_start(args, lock_name);
3012b196be89STejun Heo 	va_copy(args1, args);
3013b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3014b196be89STejun Heo 
3015b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3016b196be89STejun Heo 	if (!wq)
3017b196be89STejun Heo 		goto err;
3018b196be89STejun Heo 
3019b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3020b196be89STejun Heo 	va_end(args);
3021b196be89STejun Heo 	va_end(args1);
30223af24433SOleg Nesterov 
3023f3421797STejun Heo 	/*
30246370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
30256370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
30266370a6adSTejun Heo 	 */
30276370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
30286370a6adSTejun Heo 		flags |= WQ_RESCUER;
30296370a6adSTejun Heo 
3030d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3031b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
30323af24433SOleg Nesterov 
3033b196be89STejun Heo 	/* init wq */
303497e37d7bSTejun Heo 	wq->flags = flags;
3035a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
303673f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
303773f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
303873f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
303973f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
30403af24433SOleg Nesterov 
3041eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3042cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
30433af24433SOleg Nesterov 
3044bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3045bdbc5dd7STejun Heo 		goto err;
3046bdbc5dd7STejun Heo 
3047f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
30481537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
30498b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
30501537663fSTejun Heo 
30510f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
3052bd7bdd43STejun Heo 		cwq->pool = &gcwq->pool;
3053c34056a3STejun Heo 		cwq->wq = wq;
305473f53c4aSTejun Heo 		cwq->flush_color = -1;
30551e19ffc6STejun Heo 		cwq->max_active = max_active;
30561e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3057e22bee78STejun Heo 	}
30581537663fSTejun Heo 
3059e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3060e22bee78STejun Heo 		struct worker *rescuer;
3061e22bee78STejun Heo 
3062f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3063e22bee78STejun Heo 			goto err;
3064e22bee78STejun Heo 
3065e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3066e22bee78STejun Heo 		if (!rescuer)
3067e22bee78STejun Heo 			goto err;
3068e22bee78STejun Heo 
3069b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3070b196be89STejun Heo 					       wq->name);
3071e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3072e22bee78STejun Heo 			goto err;
3073e22bee78STejun Heo 
3074e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3075e22bee78STejun Heo 		wake_up_process(rescuer->task);
30763af24433SOleg Nesterov 	}
30771537663fSTejun Heo 
30783af24433SOleg Nesterov 	/*
3079a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3080a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3081a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
30823af24433SOleg Nesterov 	 */
30833af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3084a0a1a5fdSTejun Heo 
308558a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3086f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3087a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3088a0a1a5fdSTejun Heo 
30893af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3090a0a1a5fdSTejun Heo 
30913af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
30923af24433SOleg Nesterov 
30933af24433SOleg Nesterov 	return wq;
30944690c4abSTejun Heo err:
30954690c4abSTejun Heo 	if (wq) {
3096bdbc5dd7STejun Heo 		free_cwqs(wq);
3097f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3098e22bee78STejun Heo 		kfree(wq->rescuer);
30994690c4abSTejun Heo 		kfree(wq);
31003af24433SOleg Nesterov 	}
31014690c4abSTejun Heo 	return NULL;
31021da177e4SLinus Torvalds }
3103d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
31041da177e4SLinus Torvalds 
31053af24433SOleg Nesterov /**
31063af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
31073af24433SOleg Nesterov  * @wq: target workqueue
31083af24433SOleg Nesterov  *
31093af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
31103af24433SOleg Nesterov  */
31113af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
31123af24433SOleg Nesterov {
3113c8e55f36STejun Heo 	unsigned int cpu;
31143af24433SOleg Nesterov 
31159c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
31169c5a2ba7STejun Heo 	drain_workqueue(wq);
3117c8efcc25STejun Heo 
3118a0a1a5fdSTejun Heo 	/*
3119a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3120a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3121a0a1a5fdSTejun Heo 	 */
312295402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
31233af24433SOleg Nesterov 	list_del(&wq->list);
312495402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
31253af24433SOleg Nesterov 
3126e22bee78STejun Heo 	/* sanity check */
3127f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
312873f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
312973f53c4aSTejun Heo 		int i;
31303af24433SOleg Nesterov 
313173f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
313273f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
31331e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
31341e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
313573f53c4aSTejun Heo 	}
31361537663fSTejun Heo 
3137e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3138e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3139f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
31408d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3141e22bee78STejun Heo 	}
3142e22bee78STejun Heo 
3143bdbc5dd7STejun Heo 	free_cwqs(wq);
31443af24433SOleg Nesterov 	kfree(wq);
31453af24433SOleg Nesterov }
31463af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
31473af24433SOleg Nesterov 
3148dcd989cbSTejun Heo /**
3149dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3150dcd989cbSTejun Heo  * @wq: target workqueue
3151dcd989cbSTejun Heo  * @max_active: new max_active value.
3152dcd989cbSTejun Heo  *
3153dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3154dcd989cbSTejun Heo  *
3155dcd989cbSTejun Heo  * CONTEXT:
3156dcd989cbSTejun Heo  * Don't call from IRQ context.
3157dcd989cbSTejun Heo  */
3158dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3159dcd989cbSTejun Heo {
3160dcd989cbSTejun Heo 	unsigned int cpu;
3161dcd989cbSTejun Heo 
3162f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3163dcd989cbSTejun Heo 
3164dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3165dcd989cbSTejun Heo 
3166dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3167dcd989cbSTejun Heo 
3168f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3169dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3170dcd989cbSTejun Heo 
3171dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3172dcd989cbSTejun Heo 
317358a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3174dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3175dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3176dcd989cbSTejun Heo 
3177dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3178dcd989cbSTejun Heo 	}
3179dcd989cbSTejun Heo 
3180dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3181dcd989cbSTejun Heo }
3182dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3183dcd989cbSTejun Heo 
3184dcd989cbSTejun Heo /**
3185dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3186dcd989cbSTejun Heo  * @cpu: CPU in question
3187dcd989cbSTejun Heo  * @wq: target workqueue
3188dcd989cbSTejun Heo  *
3189dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3190dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3191dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3192dcd989cbSTejun Heo  *
3193dcd989cbSTejun Heo  * RETURNS:
3194dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3195dcd989cbSTejun Heo  */
3196dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3197dcd989cbSTejun Heo {
3198dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3199dcd989cbSTejun Heo 
3200dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3201dcd989cbSTejun Heo }
3202dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3203dcd989cbSTejun Heo 
3204dcd989cbSTejun Heo /**
3205dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3206dcd989cbSTejun Heo  * @work: the work of interest
3207dcd989cbSTejun Heo  *
3208dcd989cbSTejun Heo  * RETURNS:
3209bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3210dcd989cbSTejun Heo  */
3211dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3212dcd989cbSTejun Heo {
3213dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3214dcd989cbSTejun Heo 
3215bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3216dcd989cbSTejun Heo }
3217dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3218dcd989cbSTejun Heo 
3219dcd989cbSTejun Heo /**
3220dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3221dcd989cbSTejun Heo  * @work: the work to be tested
3222dcd989cbSTejun Heo  *
3223dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3224dcd989cbSTejun Heo  * synchronization around this function and the test result is
3225dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3226dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3227dcd989cbSTejun Heo  * running state.
3228dcd989cbSTejun Heo  *
3229dcd989cbSTejun Heo  * RETURNS:
3230dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3231dcd989cbSTejun Heo  */
3232dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3233dcd989cbSTejun Heo {
3234dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3235dcd989cbSTejun Heo 	unsigned long flags;
3236dcd989cbSTejun Heo 	unsigned int ret = 0;
3237dcd989cbSTejun Heo 
3238dcd989cbSTejun Heo 	if (!gcwq)
3239dcd989cbSTejun Heo 		return false;
3240dcd989cbSTejun Heo 
3241dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3242dcd989cbSTejun Heo 
3243dcd989cbSTejun Heo 	if (work_pending(work))
3244dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3245dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3246dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3247dcd989cbSTejun Heo 
3248dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3249dcd989cbSTejun Heo 
3250dcd989cbSTejun Heo 	return ret;
3251dcd989cbSTejun Heo }
3252dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3253dcd989cbSTejun Heo 
3254db7bccf4STejun Heo /*
3255db7bccf4STejun Heo  * CPU hotplug.
3256db7bccf4STejun Heo  *
3257e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3258e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3259e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3260e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3261e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3262e22bee78STejun Heo  * blocked draining impractical.
3263e22bee78STejun Heo  *
3264e22bee78STejun Heo  * This is solved by allowing a gcwq to be detached from CPU, running
3265e22bee78STejun Heo  * it with unbound (rogue) workers and allowing it to be reattached
3266e22bee78STejun Heo  * later if the cpu comes back online.  A separate thread is created
3267e22bee78STejun Heo  * to govern a gcwq in such state and is called the trustee of the
3268e22bee78STejun Heo  * gcwq.
3269db7bccf4STejun Heo  *
3270db7bccf4STejun Heo  * Trustee states and their descriptions.
3271db7bccf4STejun Heo  *
3272db7bccf4STejun Heo  * START	Command state used on startup.  On CPU_DOWN_PREPARE, a
3273db7bccf4STejun Heo  *		new trustee is started with this state.
3274db7bccf4STejun Heo  *
3275db7bccf4STejun Heo  * IN_CHARGE	Once started, trustee will enter this state after
3276e22bee78STejun Heo  *		assuming the manager role and making all existing
3277e22bee78STejun Heo  *		workers rogue.  DOWN_PREPARE waits for trustee to
3278e22bee78STejun Heo  *		enter this state.  After reaching IN_CHARGE, trustee
3279e22bee78STejun Heo  *		tries to execute the pending worklist until it's empty
3280e22bee78STejun Heo  *		and the state is set to BUTCHER, or the state is set
3281e22bee78STejun Heo  *		to RELEASE.
3282db7bccf4STejun Heo  *
3283db7bccf4STejun Heo  * BUTCHER	Command state which is set by the cpu callback after
3284db7bccf4STejun Heo  *		the cpu has went down.  Once this state is set trustee
3285db7bccf4STejun Heo  *		knows that there will be no new works on the worklist
3286db7bccf4STejun Heo  *		and once the worklist is empty it can proceed to
3287db7bccf4STejun Heo  *		killing idle workers.
3288db7bccf4STejun Heo  *
3289db7bccf4STejun Heo  * RELEASE	Command state which is set by the cpu callback if the
3290db7bccf4STejun Heo  *		cpu down has been canceled or it has come online
3291db7bccf4STejun Heo  *		again.  After recognizing this state, trustee stops
3292e22bee78STejun Heo  *		trying to drain or butcher and clears ROGUE, rebinds
3293e22bee78STejun Heo  *		all remaining workers back to the cpu and releases
3294e22bee78STejun Heo  *		manager role.
3295db7bccf4STejun Heo  *
3296db7bccf4STejun Heo  * DONE		Trustee will enter this state after BUTCHER or RELEASE
3297db7bccf4STejun Heo  *		is complete.
3298db7bccf4STejun Heo  *
3299db7bccf4STejun Heo  *          trustee                 CPU                draining
3300db7bccf4STejun Heo  *         took over                down               complete
3301db7bccf4STejun Heo  * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3302db7bccf4STejun Heo  *                        |                     |                  ^
3303db7bccf4STejun Heo  *                        | CPU is back online  v   return workers |
3304db7bccf4STejun Heo  *                         ----------------> RELEASE --------------
3305db7bccf4STejun Heo  */
3306db7bccf4STejun Heo 
3307db7bccf4STejun Heo /**
3308db7bccf4STejun Heo  * trustee_wait_event_timeout - timed event wait for trustee
3309db7bccf4STejun Heo  * @cond: condition to wait for
3310db7bccf4STejun Heo  * @timeout: timeout in jiffies
3311db7bccf4STejun Heo  *
3312db7bccf4STejun Heo  * wait_event_timeout() for trustee to use.  Handles locking and
3313db7bccf4STejun Heo  * checks for RELEASE request.
3314db7bccf4STejun Heo  *
3315db7bccf4STejun Heo  * CONTEXT:
3316db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3317db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3318db7bccf4STejun Heo  *
3319db7bccf4STejun Heo  * RETURNS:
3320db7bccf4STejun Heo  * Positive indicating left time if @cond is satisfied, 0 if timed
3321db7bccf4STejun Heo  * out, -1 if canceled.
3322db7bccf4STejun Heo  */
3323db7bccf4STejun Heo #define trustee_wait_event_timeout(cond, timeout) ({			\
3324db7bccf4STejun Heo 	long __ret = (timeout);						\
3325db7bccf4STejun Heo 	while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) &&	\
3326db7bccf4STejun Heo 	       __ret) {							\
3327db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);				\
3328db7bccf4STejun Heo 		__wait_event_timeout(gcwq->trustee_wait, (cond) ||	\
3329db7bccf4STejun Heo 			(gcwq->trustee_state == TRUSTEE_RELEASE),	\
3330db7bccf4STejun Heo 			__ret);						\
3331db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);				\
3332db7bccf4STejun Heo 	}								\
3333db7bccf4STejun Heo 	gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret);		\
3334db7bccf4STejun Heo })
3335db7bccf4STejun Heo 
3336db7bccf4STejun Heo /**
3337db7bccf4STejun Heo  * trustee_wait_event - event wait for trustee
3338db7bccf4STejun Heo  * @cond: condition to wait for
3339db7bccf4STejun Heo  *
3340db7bccf4STejun Heo  * wait_event() for trustee to use.  Automatically handles locking and
3341db7bccf4STejun Heo  * checks for CANCEL request.
3342db7bccf4STejun Heo  *
3343db7bccf4STejun Heo  * CONTEXT:
3344db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3345db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3346db7bccf4STejun Heo  *
3347db7bccf4STejun Heo  * RETURNS:
3348db7bccf4STejun Heo  * 0 if @cond is satisfied, -1 if canceled.
3349db7bccf4STejun Heo  */
3350db7bccf4STejun Heo #define trustee_wait_event(cond) ({					\
3351db7bccf4STejun Heo 	long __ret1;							\
3352db7bccf4STejun Heo 	__ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3353db7bccf4STejun Heo 	__ret1 < 0 ? -1 : 0;						\
3354db7bccf4STejun Heo })
3355db7bccf4STejun Heo 
3356*4ce62e9eSTejun Heo static bool gcwq_is_managing_workers(struct global_cwq *gcwq)
3357*4ce62e9eSTejun Heo {
3358*4ce62e9eSTejun Heo 	struct worker_pool *pool;
3359*4ce62e9eSTejun Heo 
3360*4ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
3361*4ce62e9eSTejun Heo 		if (pool->flags & POOL_MANAGING_WORKERS)
3362*4ce62e9eSTejun Heo 			return true;
3363*4ce62e9eSTejun Heo 	return false;
3364*4ce62e9eSTejun Heo }
3365*4ce62e9eSTejun Heo 
3366*4ce62e9eSTejun Heo static bool gcwq_has_idle_workers(struct global_cwq *gcwq)
3367*4ce62e9eSTejun Heo {
3368*4ce62e9eSTejun Heo 	struct worker_pool *pool;
3369*4ce62e9eSTejun Heo 
3370*4ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
3371*4ce62e9eSTejun Heo 		if (!list_empty(&pool->idle_list))
3372*4ce62e9eSTejun Heo 			return true;
3373*4ce62e9eSTejun Heo 	return false;
3374*4ce62e9eSTejun Heo }
3375*4ce62e9eSTejun Heo 
3376db7bccf4STejun Heo static int __cpuinit trustee_thread(void *__gcwq)
3377db7bccf4STejun Heo {
3378db7bccf4STejun Heo 	struct global_cwq *gcwq = __gcwq;
3379*4ce62e9eSTejun Heo 	struct worker_pool *pool;
3380db7bccf4STejun Heo 	struct worker *worker;
3381e22bee78STejun Heo 	struct work_struct *work;
3382db7bccf4STejun Heo 	struct hlist_node *pos;
3383e22bee78STejun Heo 	long rc;
3384db7bccf4STejun Heo 	int i;
3385db7bccf4STejun Heo 
3386db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3387db7bccf4STejun Heo 
3388db7bccf4STejun Heo 	spin_lock_irq(&gcwq->lock);
3389db7bccf4STejun Heo 	/*
3390e22bee78STejun Heo 	 * Claim the manager position and make all workers rogue.
3391e22bee78STejun Heo 	 * Trustee must be bound to the target cpu and can't be
3392e22bee78STejun Heo 	 * cancelled.
3393db7bccf4STejun Heo 	 */
3394db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3395*4ce62e9eSTejun Heo 	rc = trustee_wait_event(!gcwq_is_managing_workers(gcwq));
3396e22bee78STejun Heo 	BUG_ON(rc < 0);
3397e22bee78STejun Heo 
3398*4ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq) {
3399*4ce62e9eSTejun Heo 		pool->flags |= POOL_MANAGING_WORKERS;
3400db7bccf4STejun Heo 
3401*4ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3402cb444766STejun Heo 			worker->flags |= WORKER_ROGUE;
3403*4ce62e9eSTejun Heo 	}
3404db7bccf4STejun Heo 
3405db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3406cb444766STejun Heo 		worker->flags |= WORKER_ROGUE;
3407db7bccf4STejun Heo 
3408db7bccf4STejun Heo 	/*
3409e22bee78STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can
3410e22bee78STejun Heo 	 * guarantee sched callbacks see the rogue flag.  This is
3411e22bee78STejun Heo 	 * necessary as scheduler callbacks may be invoked from other
3412e22bee78STejun Heo 	 * cpus.
3413e22bee78STejun Heo 	 */
3414e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3415e22bee78STejun Heo 	schedule();
3416e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3417e22bee78STejun Heo 
3418e22bee78STejun Heo 	/*
3419cb444766STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After
3420cb444766STejun Heo 	 * this, nr_running stays zero and need_more_worker() and
3421cb444766STejun Heo 	 * keep_working() are always true as long as the worklist is
3422cb444766STejun Heo 	 * not empty.
3423e22bee78STejun Heo 	 */
3424*4ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
3425*4ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3426e22bee78STejun Heo 
3427e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3428*4ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
3429*4ce62e9eSTejun Heo 		del_timer_sync(&pool->idle_timer);
3430e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3431e22bee78STejun Heo 
3432e22bee78STejun Heo 	/*
3433db7bccf4STejun Heo 	 * We're now in charge.  Notify and proceed to drain.  We need
3434db7bccf4STejun Heo 	 * to keep the gcwq running during the whole CPU down
3435db7bccf4STejun Heo 	 * procedure as other cpu hotunplug callbacks may need to
3436db7bccf4STejun Heo 	 * flush currently running tasks.
3437db7bccf4STejun Heo 	 */
3438db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3439db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3440db7bccf4STejun Heo 
3441db7bccf4STejun Heo 	/*
3442db7bccf4STejun Heo 	 * The original cpu is in the process of dying and may go away
3443db7bccf4STejun Heo 	 * anytime now.  When that happens, we and all workers would
3444e22bee78STejun Heo 	 * be migrated to other cpus.  Try draining any left work.  We
3445e22bee78STejun Heo 	 * want to get it over with ASAP - spam rescuers, wake up as
3446e22bee78STejun Heo 	 * many idlers as necessary and create new ones till the
3447e22bee78STejun Heo 	 * worklist is empty.  Note that if the gcwq is frozen, there
344858a69cb4STejun Heo 	 * may be frozen works in freezable cwqs.  Don't declare
3449e22bee78STejun Heo 	 * completion while frozen.
3450db7bccf4STejun Heo 	 */
3451*4ce62e9eSTejun Heo 	while (true) {
3452*4ce62e9eSTejun Heo 		bool busy = false;
3453*4ce62e9eSTejun Heo 
3454*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
3455*4ce62e9eSTejun Heo 			busy |= pool->nr_workers != pool->nr_idle;
3456*4ce62e9eSTejun Heo 
3457*4ce62e9eSTejun Heo 		if (!busy && !(gcwq->flags & GCWQ_FREEZING) &&
3458*4ce62e9eSTejun Heo 		    gcwq->trustee_state != TRUSTEE_IN_CHARGE)
3459*4ce62e9eSTejun Heo 			break;
3460*4ce62e9eSTejun Heo 
3461*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3462e22bee78STejun Heo 			int nr_works = 0;
3463e22bee78STejun Heo 
3464*4ce62e9eSTejun Heo 			list_for_each_entry(work, &pool->worklist, entry) {
3465e22bee78STejun Heo 				send_mayday(work);
3466e22bee78STejun Heo 				nr_works++;
3467e22bee78STejun Heo 			}
3468e22bee78STejun Heo 
3469*4ce62e9eSTejun Heo 			list_for_each_entry(worker, &pool->idle_list, entry) {
3470e22bee78STejun Heo 				if (!nr_works--)
3471e22bee78STejun Heo 					break;
3472e22bee78STejun Heo 				wake_up_process(worker->task);
3473e22bee78STejun Heo 			}
3474e22bee78STejun Heo 
3475*4ce62e9eSTejun Heo 			if (need_to_create_worker(pool)) {
3476e22bee78STejun Heo 				spin_unlock_irq(&gcwq->lock);
3477*4ce62e9eSTejun Heo 				worker = create_worker(pool, false);
3478e22bee78STejun Heo 				spin_lock_irq(&gcwq->lock);
3479e22bee78STejun Heo 				if (worker) {
3480cb444766STejun Heo 					worker->flags |= WORKER_ROGUE;
3481e22bee78STejun Heo 					start_worker(worker);
3482e22bee78STejun Heo 				}
3483e22bee78STejun Heo 			}
3484*4ce62e9eSTejun Heo 		}
3485e22bee78STejun Heo 
3486db7bccf4STejun Heo 		/* give a breather */
3487db7bccf4STejun Heo 		if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3488db7bccf4STejun Heo 			break;
3489db7bccf4STejun Heo 	}
3490db7bccf4STejun Heo 
3491e22bee78STejun Heo 	/*
3492e22bee78STejun Heo 	 * Either all works have been scheduled and cpu is down, or
3493e22bee78STejun Heo 	 * cpu down has already been canceled.  Wait for and butcher
3494e22bee78STejun Heo 	 * all workers till we're canceled.
3495e22bee78STejun Heo 	 */
3496e22bee78STejun Heo 	do {
3497*4ce62e9eSTejun Heo 		rc = trustee_wait_event(gcwq_has_idle_workers(gcwq));
3498*4ce62e9eSTejun Heo 
3499*4ce62e9eSTejun Heo 		i = 0;
3500*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3501*4ce62e9eSTejun Heo 			while (!list_empty(&pool->idle_list)) {
3502*4ce62e9eSTejun Heo 				worker = list_first_entry(&pool->idle_list,
3503*4ce62e9eSTejun Heo 							  struct worker, entry);
3504*4ce62e9eSTejun Heo 				destroy_worker(worker);
3505*4ce62e9eSTejun Heo 			}
3506*4ce62e9eSTejun Heo 			i |= pool->nr_workers;
3507*4ce62e9eSTejun Heo 		}
3508*4ce62e9eSTejun Heo 	} while (i && rc >= 0);
3509e22bee78STejun Heo 
3510e22bee78STejun Heo 	/*
3511e22bee78STejun Heo 	 * At this point, either draining has completed and no worker
3512e22bee78STejun Heo 	 * is left, or cpu down has been canceled or the cpu is being
3513e22bee78STejun Heo 	 * brought back up.  There shouldn't be any idle one left.
3514e22bee78STejun Heo 	 * Tell the remaining busy ones to rebind once it finishes the
3515e22bee78STejun Heo 	 * currently scheduled works by scheduling the rebind_work.
3516e22bee78STejun Heo 	 */
3517*4ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
3518*4ce62e9eSTejun Heo 		WARN_ON(!list_empty(&pool->idle_list));
3519e22bee78STejun Heo 
3520e22bee78STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
3521e22bee78STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
3522e22bee78STejun Heo 
3523e22bee78STejun Heo 		/*
3524e22bee78STejun Heo 		 * Rebind_work may race with future cpu hotplug
3525e22bee78STejun Heo 		 * operations.  Use a separate flag to mark that
3526e22bee78STejun Heo 		 * rebinding is scheduled.
3527e22bee78STejun Heo 		 */
3528cb444766STejun Heo 		worker->flags |= WORKER_REBIND;
3529cb444766STejun Heo 		worker->flags &= ~WORKER_ROGUE;
3530e22bee78STejun Heo 
3531e22bee78STejun Heo 		/* queue rebind_work, wq doesn't matter, use the default one */
3532e22bee78STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3533e22bee78STejun Heo 				     work_data_bits(rebind_work)))
3534e22bee78STejun Heo 			continue;
3535e22bee78STejun Heo 
3536e22bee78STejun Heo 		debug_work_activate(rebind_work);
3537d320c038STejun Heo 		insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3538e22bee78STejun Heo 			    worker->scheduled.next,
3539e22bee78STejun Heo 			    work_color_to_flags(WORK_NO_COLOR));
3540e22bee78STejun Heo 	}
3541e22bee78STejun Heo 
3542e22bee78STejun Heo 	/* relinquish manager role */
3543*4ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
3544*4ce62e9eSTejun Heo 		pool->flags &= ~POOL_MANAGING_WORKERS;
3545e22bee78STejun Heo 
3546db7bccf4STejun Heo 	/* notify completion */
3547db7bccf4STejun Heo 	gcwq->trustee = NULL;
3548db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_DONE;
3549db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3550db7bccf4STejun Heo 	spin_unlock_irq(&gcwq->lock);
3551db7bccf4STejun Heo 	return 0;
3552db7bccf4STejun Heo }
3553db7bccf4STejun Heo 
3554db7bccf4STejun Heo /**
3555db7bccf4STejun Heo  * wait_trustee_state - wait for trustee to enter the specified state
3556db7bccf4STejun Heo  * @gcwq: gcwq the trustee of interest belongs to
3557db7bccf4STejun Heo  * @state: target state to wait for
3558db7bccf4STejun Heo  *
3559db7bccf4STejun Heo  * Wait for the trustee to reach @state.  DONE is already matched.
3560db7bccf4STejun Heo  *
3561db7bccf4STejun Heo  * CONTEXT:
3562db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3563db7bccf4STejun Heo  * multiple times.  To be used by cpu_callback.
3564db7bccf4STejun Heo  */
3565db7bccf4STejun Heo static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
356606bd6ebfSNamhyung Kim __releases(&gcwq->lock)
356706bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
3568db7bccf4STejun Heo {
3569db7bccf4STejun Heo 	if (!(gcwq->trustee_state == state ||
3570db7bccf4STejun Heo 	      gcwq->trustee_state == TRUSTEE_DONE)) {
3571db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);
3572db7bccf4STejun Heo 		__wait_event(gcwq->trustee_wait,
3573db7bccf4STejun Heo 			     gcwq->trustee_state == state ||
3574db7bccf4STejun Heo 			     gcwq->trustee_state == TRUSTEE_DONE);
3575db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);
3576db7bccf4STejun Heo 	}
3577db7bccf4STejun Heo }
3578db7bccf4STejun Heo 
35799c7b216dSChandra Seetharaman static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
35801da177e4SLinus Torvalds 						unsigned long action,
35811da177e4SLinus Torvalds 						void *hcpu)
35821da177e4SLinus Torvalds {
35833af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3584db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
3585db7bccf4STejun Heo 	struct task_struct *new_trustee = NULL;
3586*4ce62e9eSTejun Heo 	struct worker *new_workers[NR_WORKER_POOLS] = { };
3587*4ce62e9eSTejun Heo 	struct worker_pool *pool;
3588db7bccf4STejun Heo 	unsigned long flags;
3589*4ce62e9eSTejun Heo 	int i;
35901da177e4SLinus Torvalds 
35918bb78442SRafael J. Wysocki 	action &= ~CPU_TASKS_FROZEN;
35928bb78442SRafael J. Wysocki 
35931da177e4SLinus Torvalds 	switch (action) {
3594db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3595db7bccf4STejun Heo 		new_trustee = kthread_create(trustee_thread, gcwq,
3596db7bccf4STejun Heo 					     "workqueue_trustee/%d\n", cpu);
3597db7bccf4STejun Heo 		if (IS_ERR(new_trustee))
3598db7bccf4STejun Heo 			return notifier_from_errno(PTR_ERR(new_trustee));
3599db7bccf4STejun Heo 		kthread_bind(new_trustee, cpu);
3600e22bee78STejun Heo 		/* fall through */
36013af24433SOleg Nesterov 	case CPU_UP_PREPARE:
3602*4ce62e9eSTejun Heo 		i = 0;
3603*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3604*4ce62e9eSTejun Heo 			BUG_ON(pool->first_idle);
3605*4ce62e9eSTejun Heo 			new_workers[i] = create_worker(pool, false);
3606*4ce62e9eSTejun Heo 			if (!new_workers[i++])
3607*4ce62e9eSTejun Heo 				goto err_destroy;
36083af24433SOleg Nesterov 		}
3609db7bccf4STejun Heo 	}
36101537663fSTejun Heo 
3611db7bccf4STejun Heo 	/* some are called w/ irq disabled, don't disturb irq status */
3612db7bccf4STejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
36133af24433SOleg Nesterov 
36143af24433SOleg Nesterov 	switch (action) {
3615db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3616db7bccf4STejun Heo 		/* initialize trustee and tell it to acquire the gcwq */
3617db7bccf4STejun Heo 		BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3618db7bccf4STejun Heo 		gcwq->trustee = new_trustee;
3619db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_START;
3620db7bccf4STejun Heo 		wake_up_process(gcwq->trustee);
3621db7bccf4STejun Heo 		wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3622e22bee78STejun Heo 		/* fall through */
36233af24433SOleg Nesterov 	case CPU_UP_PREPARE:
3624*4ce62e9eSTejun Heo 		i = 0;
3625*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3626*4ce62e9eSTejun Heo 			BUG_ON(pool->first_idle);
3627*4ce62e9eSTejun Heo 			pool->first_idle = new_workers[i++];
3628*4ce62e9eSTejun Heo 		}
36291da177e4SLinus Torvalds 		break;
36301da177e4SLinus Torvalds 
3631e22bee78STejun Heo 	case CPU_DYING:
3632e22bee78STejun Heo 		/*
3633e22bee78STejun Heo 		 * Before this, the trustee and all workers except for
3634e22bee78STejun Heo 		 * the ones which are still executing works from
3635e22bee78STejun Heo 		 * before the last CPU down must be on the cpu.  After
3636e22bee78STejun Heo 		 * this, they'll all be diasporas.
3637e22bee78STejun Heo 		 */
3638e22bee78STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
3639db7bccf4STejun Heo 		break;
3640db7bccf4STejun Heo 
36413da1c84cSOleg Nesterov 	case CPU_POST_DEAD:
3642db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_BUTCHER;
3643e22bee78STejun Heo 		/* fall through */
3644e22bee78STejun Heo 	case CPU_UP_CANCELED:
3645*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3646*4ce62e9eSTejun Heo 			destroy_worker(pool->first_idle);
3647*4ce62e9eSTejun Heo 			pool->first_idle = NULL;
3648*4ce62e9eSTejun Heo 		}
3649db7bccf4STejun Heo 		break;
3650db7bccf4STejun Heo 
3651db7bccf4STejun Heo 	case CPU_DOWN_FAILED:
36521da177e4SLinus Torvalds 	case CPU_ONLINE:
3653e22bee78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
3654db7bccf4STejun Heo 		if (gcwq->trustee_state != TRUSTEE_DONE) {
3655db7bccf4STejun Heo 			gcwq->trustee_state = TRUSTEE_RELEASE;
3656db7bccf4STejun Heo 			wake_up_process(gcwq->trustee);
3657db7bccf4STejun Heo 			wait_trustee_state(gcwq, TRUSTEE_DONE);
3658db7bccf4STejun Heo 		}
36591da177e4SLinus Torvalds 
3660e22bee78STejun Heo 		/*
3661e22bee78STejun Heo 		 * Trustee is done and there might be no worker left.
3662e22bee78STejun Heo 		 * Put the first_idle in and request a real manager to
3663e22bee78STejun Heo 		 * take a look.
3664e22bee78STejun Heo 		 */
3665*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3666e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3667*4ce62e9eSTejun Heo 			kthread_bind(pool->first_idle->task, cpu);
3668e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3669*4ce62e9eSTejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
3670*4ce62e9eSTejun Heo 			start_worker(pool->first_idle);
3671*4ce62e9eSTejun Heo 			pool->first_idle = NULL;
3672*4ce62e9eSTejun Heo 		}
36731da177e4SLinus Torvalds 		break;
36741da177e4SLinus Torvalds 	}
36751da177e4SLinus Torvalds 
3676db7bccf4STejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
367700dfcaf7SOleg Nesterov 
36781537663fSTejun Heo 	return notifier_from_errno(0);
3679*4ce62e9eSTejun Heo 
3680*4ce62e9eSTejun Heo err_destroy:
3681*4ce62e9eSTejun Heo 	if (new_trustee)
3682*4ce62e9eSTejun Heo 		kthread_stop(new_trustee);
3683*4ce62e9eSTejun Heo 
3684*4ce62e9eSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3685*4ce62e9eSTejun Heo 	for (i = 0; i < NR_WORKER_POOLS; i++)
3686*4ce62e9eSTejun Heo 		if (new_workers[i])
3687*4ce62e9eSTejun Heo 			destroy_worker(new_workers[i]);
3688*4ce62e9eSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3689*4ce62e9eSTejun Heo 
3690*4ce62e9eSTejun Heo 	return NOTIFY_BAD;
36911da177e4SLinus Torvalds }
36921da177e4SLinus Torvalds 
36932d3854a3SRusty Russell #ifdef CONFIG_SMP
36948ccad40dSRusty Russell 
36952d3854a3SRusty Russell struct work_for_cpu {
36966b44003eSAndrew Morton 	struct completion completion;
36972d3854a3SRusty Russell 	long (*fn)(void *);
36982d3854a3SRusty Russell 	void *arg;
36992d3854a3SRusty Russell 	long ret;
37002d3854a3SRusty Russell };
37012d3854a3SRusty Russell 
37026b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
37032d3854a3SRusty Russell {
37046b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
37052d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
37066b44003eSAndrew Morton 	complete(&wfc->completion);
37076b44003eSAndrew Morton 	return 0;
37082d3854a3SRusty Russell }
37092d3854a3SRusty Russell 
37102d3854a3SRusty Russell /**
37112d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
37122d3854a3SRusty Russell  * @cpu: the cpu to run on
37132d3854a3SRusty Russell  * @fn: the function to run
37142d3854a3SRusty Russell  * @arg: the function arg
37152d3854a3SRusty Russell  *
371631ad9081SRusty Russell  * This will return the value @fn returns.
371731ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
37186b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
37192d3854a3SRusty Russell  */
37202d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
37212d3854a3SRusty Russell {
37226b44003eSAndrew Morton 	struct task_struct *sub_thread;
37236b44003eSAndrew Morton 	struct work_for_cpu wfc = {
37246b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
37256b44003eSAndrew Morton 		.fn = fn,
37266b44003eSAndrew Morton 		.arg = arg,
37276b44003eSAndrew Morton 	};
37282d3854a3SRusty Russell 
37296b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
37306b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
37316b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
37326b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
37336b44003eSAndrew Morton 	wake_up_process(sub_thread);
37346b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
37352d3854a3SRusty Russell 	return wfc.ret;
37362d3854a3SRusty Russell }
37372d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
37382d3854a3SRusty Russell #endif /* CONFIG_SMP */
37392d3854a3SRusty Russell 
3740a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3741e7577c50SRusty Russell 
3742a0a1a5fdSTejun Heo /**
3743a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3744a0a1a5fdSTejun Heo  *
374558a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
374658a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
374758a69cb4STejun Heo  * gcwq->worklist.
3748a0a1a5fdSTejun Heo  *
3749a0a1a5fdSTejun Heo  * CONTEXT:
37508b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3751a0a1a5fdSTejun Heo  */
3752a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3753a0a1a5fdSTejun Heo {
3754a0a1a5fdSTejun Heo 	unsigned int cpu;
3755a0a1a5fdSTejun Heo 
3756a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3757a0a1a5fdSTejun Heo 
3758a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3759a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3760a0a1a5fdSTejun Heo 
3761f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37628b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3763bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37648b03ae3cSTejun Heo 
37658b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37668b03ae3cSTejun Heo 
3767db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3768db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3769db7bccf4STejun Heo 
3770a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3771a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3772a0a1a5fdSTejun Heo 
377358a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3774a0a1a5fdSTejun Heo 				cwq->max_active = 0;
37751da177e4SLinus Torvalds 		}
37768b03ae3cSTejun Heo 
37778b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3778a0a1a5fdSTejun Heo 	}
3779a0a1a5fdSTejun Heo 
3780a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3781a0a1a5fdSTejun Heo }
3782a0a1a5fdSTejun Heo 
3783a0a1a5fdSTejun Heo /**
378458a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3785a0a1a5fdSTejun Heo  *
3786a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3787a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3788a0a1a5fdSTejun Heo  *
3789a0a1a5fdSTejun Heo  * CONTEXT:
3790a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3791a0a1a5fdSTejun Heo  *
3792a0a1a5fdSTejun Heo  * RETURNS:
379358a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
379458a69cb4STejun Heo  * is complete.
3795a0a1a5fdSTejun Heo  */
3796a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3797a0a1a5fdSTejun Heo {
3798a0a1a5fdSTejun Heo 	unsigned int cpu;
3799a0a1a5fdSTejun Heo 	bool busy = false;
3800a0a1a5fdSTejun Heo 
3801a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3802a0a1a5fdSTejun Heo 
3803a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3804a0a1a5fdSTejun Heo 
3805f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3806bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3807a0a1a5fdSTejun Heo 		/*
3808a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3809a0a1a5fdSTejun Heo 		 * to peek without lock.
3810a0a1a5fdSTejun Heo 		 */
3811a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3812a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3813a0a1a5fdSTejun Heo 
381458a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3815a0a1a5fdSTejun Heo 				continue;
3816a0a1a5fdSTejun Heo 
3817a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3818a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3819a0a1a5fdSTejun Heo 				busy = true;
3820a0a1a5fdSTejun Heo 				goto out_unlock;
3821a0a1a5fdSTejun Heo 			}
3822a0a1a5fdSTejun Heo 		}
3823a0a1a5fdSTejun Heo 	}
3824a0a1a5fdSTejun Heo out_unlock:
3825a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3826a0a1a5fdSTejun Heo 	return busy;
3827a0a1a5fdSTejun Heo }
3828a0a1a5fdSTejun Heo 
3829a0a1a5fdSTejun Heo /**
3830a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3831a0a1a5fdSTejun Heo  *
3832a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
38337e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3834a0a1a5fdSTejun Heo  *
3835a0a1a5fdSTejun Heo  * CONTEXT:
38368b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3837a0a1a5fdSTejun Heo  */
3838a0a1a5fdSTejun Heo void thaw_workqueues(void)
3839a0a1a5fdSTejun Heo {
3840a0a1a5fdSTejun Heo 	unsigned int cpu;
3841a0a1a5fdSTejun Heo 
3842a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3843a0a1a5fdSTejun Heo 
3844a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3845a0a1a5fdSTejun Heo 		goto out_unlock;
3846a0a1a5fdSTejun Heo 
3847f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38488b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3849*4ce62e9eSTejun Heo 		struct worker_pool *pool;
3850bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
38518b03ae3cSTejun Heo 
38528b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
38538b03ae3cSTejun Heo 
3854db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3855db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3856db7bccf4STejun Heo 
3857a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3858a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3859a0a1a5fdSTejun Heo 
386058a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3861a0a1a5fdSTejun Heo 				continue;
3862a0a1a5fdSTejun Heo 
3863a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3864a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3865a0a1a5fdSTejun Heo 
3866a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3867a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3868a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3869a0a1a5fdSTejun Heo 		}
38708b03ae3cSTejun Heo 
3871*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
3872*4ce62e9eSTejun Heo 			wake_up_worker(pool);
3873e22bee78STejun Heo 
38748b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3875a0a1a5fdSTejun Heo 	}
3876a0a1a5fdSTejun Heo 
3877a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3878a0a1a5fdSTejun Heo out_unlock:
3879a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3880a0a1a5fdSTejun Heo }
3881a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3882a0a1a5fdSTejun Heo 
38836ee0578bSSuresh Siddha static int __init init_workqueues(void)
38841da177e4SLinus Torvalds {
3885c34056a3STejun Heo 	unsigned int cpu;
3886c8e55f36STejun Heo 	int i;
3887c34056a3STejun Heo 
3888f6500947STejun Heo 	cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
38898b03ae3cSTejun Heo 
38908b03ae3cSTejun Heo 	/* initialize gcwqs */
3891f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38928b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3893*4ce62e9eSTejun Heo 		struct worker_pool *pool;
38948b03ae3cSTejun Heo 
38958b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
38968b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3897f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
38988b03ae3cSTejun Heo 
3899c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3900c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3901c8e55f36STejun Heo 
3902*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3903*4ce62e9eSTejun Heo 			pool->gcwq = gcwq;
3904*4ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
3905*4ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3906e22bee78STejun Heo 
3907*4ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
3908*4ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
3909*4ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3910e22bee78STejun Heo 
3911*4ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3912*4ce62e9eSTejun Heo 				    (unsigned long)pool);
3913*4ce62e9eSTejun Heo 
3914*4ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
3915*4ce62e9eSTejun Heo 		}
3916db7bccf4STejun Heo 
3917db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_DONE;
3918db7bccf4STejun Heo 		init_waitqueue_head(&gcwq->trustee_wait);
39198b03ae3cSTejun Heo 	}
39208b03ae3cSTejun Heo 
3921e22bee78STejun Heo 	/* create the initial worker */
3922f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3923e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3924*4ce62e9eSTejun Heo 		struct worker_pool *pool;
3925e22bee78STejun Heo 
3926477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3927477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
3928*4ce62e9eSTejun Heo 
3929*4ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3930*4ce62e9eSTejun Heo 			struct worker *worker;
3931*4ce62e9eSTejun Heo 
3932*4ce62e9eSTejun Heo 			worker = create_worker(pool, true);
3933e22bee78STejun Heo 			BUG_ON(!worker);
3934e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3935e22bee78STejun Heo 			start_worker(worker);
3936e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3937e22bee78STejun Heo 		}
3938*4ce62e9eSTejun Heo 	}
3939e22bee78STejun Heo 
3940d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
3941d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3942d320c038STejun Heo 	system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3943f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3944f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
394524d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
394624d51addSTejun Heo 					      WQ_FREEZABLE, 0);
394762d3c543SAlan Stern 	system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
394862d3c543SAlan Stern 			WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
3949e5cba24eSHitoshi Mitake 	BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
395062d3c543SAlan Stern 	       !system_unbound_wq || !system_freezable_wq ||
395162d3c543SAlan Stern 		!system_nrt_freezable_wq);
39526ee0578bSSuresh Siddha 	return 0;
39531da177e4SLinus Torvalds }
39546ee0578bSSuresh Siddha early_initcall(init_workqueues);
3955