xref: /linux-6.15/kernel/workqueue.c (revision 403c821d)
11da177e4SLinus Torvalds /*
2c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
31da177e4SLinus Torvalds  *
4c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
51da177e4SLinus Torvalds  *
61da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
71da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
8e1f8e874SFrancois Cami  *     Andrew Morton
91da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
101da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1189ada679SChristoph Lameter  *
12cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
13c54fce6eSTejun Heo  *
14c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
15c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
16c54fce6eSTejun Heo  *
17c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
18c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
19c54fce6eSTejun Heo  * automatically managed.  There is one worker pool for each CPU and
20c54fce6eSTejun Heo  * one extra for works which are better served by workers which are
21c54fce6eSTejun Heo  * not bound to any specific CPU.
22c54fce6eSTejun Heo  *
23c54fce6eSTejun Heo  * Please read Documentation/workqueue.txt for details.
241da177e4SLinus Torvalds  */
251da177e4SLinus Torvalds 
269984de1aSPaul Gortmaker #include <linux/export.h>
271da177e4SLinus Torvalds #include <linux/kernel.h>
281da177e4SLinus Torvalds #include <linux/sched.h>
291da177e4SLinus Torvalds #include <linux/init.h>
301da177e4SLinus Torvalds #include <linux/signal.h>
311da177e4SLinus Torvalds #include <linux/completion.h>
321da177e4SLinus Torvalds #include <linux/workqueue.h>
331da177e4SLinus Torvalds #include <linux/slab.h>
341da177e4SLinus Torvalds #include <linux/cpu.h>
351da177e4SLinus Torvalds #include <linux/notifier.h>
361da177e4SLinus Torvalds #include <linux/kthread.h>
371fa44ecaSJames Bottomley #include <linux/hardirq.h>
3846934023SChristoph Lameter #include <linux/mempolicy.h>
39341a5958SRafael J. Wysocki #include <linux/freezer.h>
40d5abe669SPeter Zijlstra #include <linux/kallsyms.h>
41d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
424e6045f1SJohannes Berg #include <linux/lockdep.h>
43c34056a3STejun Heo #include <linux/idr.h>
44e22bee78STejun Heo 
45e22bee78STejun Heo #include "workqueue_sched.h"
461da177e4SLinus Torvalds 
47c8e55f36STejun Heo enum {
48db7bccf4STejun Heo 	/* global_cwq flags */
4911ebea50STejun Heo 	GCWQ_DISASSOCIATED	= 1 << 0,	/* cpu can't serve workers */
5011ebea50STejun Heo 	GCWQ_FREEZING		= 1 << 1,	/* freeze in progress */
5111ebea50STejun Heo 
5211ebea50STejun Heo 	/* pool flags */
5311ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
5411ebea50STejun Heo 	POOL_MANAGING_WORKERS	= 1 << 1,	/* managing workers */
55db7bccf4STejun Heo 
56c8e55f36STejun Heo 	/* worker flags */
57c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
58c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
59c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
60e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
61e22bee78STejun Heo 	WORKER_REBIND		= 1 << 5,	/* mom is home, come back */
62fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
63f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
64e22bee78STejun Heo 
65*403c821dSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_REBIND | WORKER_UNBOUND |
66*403c821dSTejun Heo 				  WORKER_CPU_INTENSIVE,
67db7bccf4STejun Heo 
68db7bccf4STejun Heo 	/* gcwq->trustee_state */
69db7bccf4STejun Heo 	TRUSTEE_START		= 0,		/* start */
70db7bccf4STejun Heo 	TRUSTEE_IN_CHARGE	= 1,		/* trustee in charge of gcwq */
71db7bccf4STejun Heo 	TRUSTEE_BUTCHER		= 2,		/* butcher workers */
72db7bccf4STejun Heo 	TRUSTEE_RELEASE		= 3,		/* release workers */
73db7bccf4STejun Heo 	TRUSTEE_DONE		= 4,		/* trustee is done */
74c8e55f36STejun Heo 
753270476aSTejun Heo 	NR_WORKER_POOLS		= 2,		/* # worker pools per gcwq */
764ce62e9eSTejun Heo 
77c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
78c8e55f36STejun Heo 	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
79c8e55f36STejun Heo 	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
80db7bccf4STejun Heo 
81e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
82e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
83e22bee78STejun Heo 
843233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
853233cdbdSTejun Heo 						/* call for help after 10ms
863233cdbdSTejun Heo 						   (min two ticks) */
87e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
88e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
89db7bccf4STejun Heo 	TRUSTEE_COOLDOWN	= HZ / 10,	/* for trustee draining */
901da177e4SLinus Torvalds 
911da177e4SLinus Torvalds 	/*
92e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
93e22bee78STejun Heo 	 * all cpus.  Give -20.
94e22bee78STejun Heo 	 */
95e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
963270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
97c8e55f36STejun Heo };
98c8e55f36STejun Heo 
991da177e4SLinus Torvalds /*
1004690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1014690c4abSTejun Heo  *
102e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
103e41e704bSTejun Heo  *    everyone else.
1044690c4abSTejun Heo  *
105e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
106e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
107e22bee78STejun Heo  *
1088b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1094690c4abSTejun Heo  *
110e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
111e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
112e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
113f3421797STejun Heo  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
114e22bee78STejun Heo  *
11573f53c4aSTejun Heo  * F: wq->flush_mutex protected.
11673f53c4aSTejun Heo  *
1174690c4abSTejun Heo  * W: workqueue_lock protected.
1184690c4abSTejun Heo  */
1194690c4abSTejun Heo 
1208b03ae3cSTejun Heo struct global_cwq;
121bd7bdd43STejun Heo struct worker_pool;
122c34056a3STejun Heo 
123e22bee78STejun Heo /*
124e22bee78STejun Heo  * The poor guys doing the actual heavy lifting.  All on-duty workers
125e22bee78STejun Heo  * are either serving the manager role, on idle list or on busy hash.
126e22bee78STejun Heo  */
127c34056a3STejun Heo struct worker {
128c8e55f36STejun Heo 	/* on idle list while idle, on busy hash table while busy */
129c8e55f36STejun Heo 	union {
130c8e55f36STejun Heo 		struct list_head	entry;	/* L: while idle */
131c8e55f36STejun Heo 		struct hlist_node	hentry;	/* L: while busy */
132c8e55f36STejun Heo 	};
133c8e55f36STejun Heo 
134c34056a3STejun Heo 	struct work_struct	*current_work;	/* L: work being processed */
1358cca0eeaSTejun Heo 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
136affee4b2STejun Heo 	struct list_head	scheduled;	/* L: scheduled works */
137c34056a3STejun Heo 	struct task_struct	*task;		/* I: worker task */
138bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
139e22bee78STejun Heo 	/* 64 bytes boundary on 64bit, 32 on 32bit */
140e22bee78STejun Heo 	unsigned long		last_active;	/* L: last active timestamp */
141e22bee78STejun Heo 	unsigned int		flags;		/* X: flags */
142c34056a3STejun Heo 	int			id;		/* I: worker id */
143e22bee78STejun Heo 	struct work_struct	rebind_work;	/* L: rebind worker to cpu */
144c34056a3STejun Heo };
145c34056a3STejun Heo 
146bd7bdd43STejun Heo struct worker_pool {
147bd7bdd43STejun Heo 	struct global_cwq	*gcwq;		/* I: the owning gcwq */
14811ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
149bd7bdd43STejun Heo 
150bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
151bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
152bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
153bd7bdd43STejun Heo 
154bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
155bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
156bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
157bd7bdd43STejun Heo 
158bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
159bd7bdd43STejun Heo 	struct worker		*first_idle;	/* L: first idle worker */
160bd7bdd43STejun Heo };
161bd7bdd43STejun Heo 
1624690c4abSTejun Heo /*
163e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
164e22bee78STejun Heo  * and all works are queued and processed here regardless of their
165e22bee78STejun Heo  * target workqueues.
1668b03ae3cSTejun Heo  */
1678b03ae3cSTejun Heo struct global_cwq {
1688b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1698b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
170db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
171c8e55f36STejun Heo 
172bd7bdd43STejun Heo 	/* workers are chained either in busy_hash or pool idle_list */
173c8e55f36STejun Heo 	struct hlist_head	busy_hash[BUSY_WORKER_HASH_SIZE];
174c8e55f36STejun Heo 						/* L: hash of busy workers */
175c8e55f36STejun Heo 
1763270476aSTejun Heo 	struct worker_pool	pools[2];	/* normal and highpri pools */
177db7bccf4STejun Heo 
178db7bccf4STejun Heo 	struct task_struct	*trustee;	/* L: for gcwq shutdown */
179db7bccf4STejun Heo 	unsigned int		trustee_state;	/* L: trustee state */
180db7bccf4STejun Heo 	wait_queue_head_t	trustee_wait;	/* trustee wait */
1818b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1828b03ae3cSTejun Heo 
1838b03ae3cSTejun Heo /*
184502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1850f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1860f900049STejun Heo  * aligned at two's power of the number of flag bits.
1871da177e4SLinus Torvalds  */
1881da177e4SLinus Torvalds struct cpu_workqueue_struct {
189bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1904690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
19173f53c4aSTejun Heo 	int			work_color;	/* L: current color */
19273f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
19373f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
19473f53c4aSTejun Heo 						/* L: nr of in_flight works */
1951e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
196a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
1971e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
1980f900049STejun Heo };
1991da177e4SLinus Torvalds 
2001da177e4SLinus Torvalds /*
20173f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
20273f53c4aSTejun Heo  */
20373f53c4aSTejun Heo struct wq_flusher {
20473f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
20573f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
20673f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
20773f53c4aSTejun Heo };
2081da177e4SLinus Torvalds 
20973f53c4aSTejun Heo /*
210f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
211f2e005aaSTejun Heo  * used to determine whether there's something to be done.
212f2e005aaSTejun Heo  */
213f2e005aaSTejun Heo #ifdef CONFIG_SMP
214f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
215f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
216f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
217f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
218f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2199c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
220f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
221f2e005aaSTejun Heo #else
222f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
223f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
224f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
225f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
226f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
227f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
228f2e005aaSTejun Heo #endif
2291da177e4SLinus Torvalds 
2301da177e4SLinus Torvalds /*
2311da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2321da177e4SLinus Torvalds  * per-CPU workqueues:
2331da177e4SLinus Torvalds  */
2341da177e4SLinus Torvalds struct workqueue_struct {
2359c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
236bdbc5dd7STejun Heo 	union {
237bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
238bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
239bdbc5dd7STejun Heo 		unsigned long				v;
240bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2414690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
24273f53c4aSTejun Heo 
24373f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
24473f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
24573f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
24673f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
24773f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
24873f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
24973f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
25073f53c4aSTejun Heo 
251f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
252e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
253e22bee78STejun Heo 
2549c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
255dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2564e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2574e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2584e6045f1SJohannes Berg #endif
259b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2601da177e4SLinus Torvalds };
2611da177e4SLinus Torvalds 
262d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
263d320c038STejun Heo struct workqueue_struct *system_long_wq __read_mostly;
264d320c038STejun Heo struct workqueue_struct *system_nrt_wq __read_mostly;
265f3421797STejun Heo struct workqueue_struct *system_unbound_wq __read_mostly;
26624d51addSTejun Heo struct workqueue_struct *system_freezable_wq __read_mostly;
26762d3c543SAlan Stern struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
268d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
269d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
270d320c038STejun Heo EXPORT_SYMBOL_GPL(system_nrt_wq);
271f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
27224d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
27362d3c543SAlan Stern EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
274d320c038STejun Heo 
27597bd2347STejun Heo #define CREATE_TRACE_POINTS
27697bd2347STejun Heo #include <trace/events/workqueue.h>
27797bd2347STejun Heo 
2784ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
2793270476aSTejun Heo 	for ((pool) = &(gcwq)->pools[0];				\
2803270476aSTejun Heo 	     (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
2814ce62e9eSTejun 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);
4624ce62e9eSTejun 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;
4704ce62e9eSTejun Heo static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
4714ce62e9eSTejun Heo 	[0 ... NR_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4724ce62e9eSTejun Heo };
473f3421797STejun Heo 
474c34056a3STejun Heo static int worker_thread(void *__worker);
4751da177e4SLinus Torvalds 
4763270476aSTejun Heo static int worker_pool_pri(struct worker_pool *pool)
4773270476aSTejun Heo {
4783270476aSTejun Heo 	return pool - pool->gcwq->pools;
4793270476aSTejun Heo }
4803270476aSTejun Heo 
4818b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4821da177e4SLinus Torvalds {
483f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4848b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
485f3421797STejun Heo 	else
486f3421797STejun Heo 		return &unbound_global_cwq;
4871da177e4SLinus Torvalds }
4881da177e4SLinus Torvalds 
48963d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
490b1f4ec17SOleg Nesterov {
49163d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
4923270476aSTejun Heo 	int idx = worker_pool_pri(pool);
49363d95a91STejun Heo 
494f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4954ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
496f3421797STejun Heo 	else
4974ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
498b1f4ec17SOleg Nesterov }
499b1f4ec17SOleg Nesterov 
5004690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
5014690c4abSTejun Heo 					    struct workqueue_struct *wq)
502a848e3b6SOleg Nesterov {
503f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
504e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
505bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
506f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
507f3421797STejun Heo 		return wq->cpu_wq.single;
508f3421797STejun Heo 	return NULL;
509f3421797STejun Heo }
510a848e3b6SOleg Nesterov 
51173f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
51273f53c4aSTejun Heo {
51373f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
51473f53c4aSTejun Heo }
51573f53c4aSTejun Heo 
51673f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
51773f53c4aSTejun Heo {
51873f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
51973f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
52073f53c4aSTejun Heo }
52173f53c4aSTejun Heo 
52273f53c4aSTejun Heo static int work_next_color(int color)
52373f53c4aSTejun Heo {
52473f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5251da177e4SLinus Torvalds }
5261da177e4SLinus Torvalds 
5274594bf15SDavid Howells /*
528e120153dSTejun Heo  * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
529e120153dSTejun Heo  * work is on queue.  Once execution starts, WORK_STRUCT_CWQ is
530e120153dSTejun Heo  * cleared and the work data contains the cpu number it was last on.
5317a22ad75STejun Heo  *
5327a22ad75STejun Heo  * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
5337a22ad75STejun Heo  * cwq, cpu or clear work->data.  These functions should only be
5347a22ad75STejun Heo  * called while the work is owned - ie. while the PENDING bit is set.
5357a22ad75STejun Heo  *
5367a22ad75STejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq
5377a22ad75STejun Heo  * corresponding to a work.  gcwq is available once the work has been
5387a22ad75STejun Heo  * queued anywhere after initialization.  cwq is available only from
5397a22ad75STejun Heo  * queueing until execution starts.
5404594bf15SDavid Howells  */
5417a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5427a22ad75STejun Heo 				 unsigned long flags)
5437a22ad75STejun Heo {
5447a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5457a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5467a22ad75STejun Heo }
5477a22ad75STejun Heo 
5487a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5494690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5504690c4abSTejun Heo 			 unsigned long extra_flags)
551365970a1SDavid Howells {
5527a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
553e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
554365970a1SDavid Howells }
555365970a1SDavid Howells 
5567a22ad75STejun Heo static void set_work_cpu(struct work_struct *work, unsigned int cpu)
5574d707b9fSOleg Nesterov {
5587a22ad75STejun Heo 	set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
5594d707b9fSOleg Nesterov }
5604d707b9fSOleg Nesterov 
5617a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
562365970a1SDavid Howells {
5637a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5647a22ad75STejun Heo }
5657a22ad75STejun Heo 
5667a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5677a22ad75STejun Heo {
568e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5697a22ad75STejun Heo 
570e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
571e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
572e120153dSTejun Heo 	else
573e120153dSTejun Heo 		return NULL;
5747a22ad75STejun Heo }
5757a22ad75STejun Heo 
5767a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5777a22ad75STejun Heo {
578e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5797a22ad75STejun Heo 	unsigned int cpu;
5807a22ad75STejun Heo 
581e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
582e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
583bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
5847a22ad75STejun Heo 
5857a22ad75STejun Heo 	cpu = data >> WORK_STRUCT_FLAG_BITS;
586bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
5877a22ad75STejun Heo 		return NULL;
5887a22ad75STejun Heo 
589f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
5907a22ad75STejun Heo 	return get_gcwq(cpu);
591365970a1SDavid Howells }
592365970a1SDavid Howells 
593e22bee78STejun Heo /*
5943270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
5953270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
5963270476aSTejun Heo  * they're being called with gcwq->lock held.
597e22bee78STejun Heo  */
598e22bee78STejun Heo 
59963d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
600649027d7STejun Heo {
6013270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
602649027d7STejun Heo }
603649027d7STejun Heo 
604e22bee78STejun Heo /*
605e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
606e22bee78STejun Heo  * running workers.
607974271c4STejun Heo  *
608974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
609974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
610974271c4STejun Heo  * worklist isn't empty.
611e22bee78STejun Heo  */
61263d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
613e22bee78STejun Heo {
61463d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
615e22bee78STejun Heo }
616e22bee78STejun Heo 
617e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
61863d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
619e22bee78STejun Heo {
62063d95a91STejun Heo 	return pool->nr_idle;
621e22bee78STejun Heo }
622e22bee78STejun Heo 
623e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
62463d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
625e22bee78STejun Heo {
62663d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
627e22bee78STejun Heo 
6283270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
629e22bee78STejun Heo }
630e22bee78STejun Heo 
631e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
63263d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
633e22bee78STejun Heo {
63463d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
635e22bee78STejun Heo }
636e22bee78STejun Heo 
637e22bee78STejun Heo /* Do I need to be the manager? */
63863d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
639e22bee78STejun Heo {
64063d95a91STejun Heo 	return need_to_create_worker(pool) ||
64111ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
642e22bee78STejun Heo }
643e22bee78STejun Heo 
644e22bee78STejun Heo /* Do we have too many workers and should some go away? */
64563d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
646e22bee78STejun Heo {
64711ebea50STejun Heo 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
64863d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
64963d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
650e22bee78STejun Heo 
651e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
652e22bee78STejun Heo }
653e22bee78STejun Heo 
654e22bee78STejun Heo /*
655e22bee78STejun Heo  * Wake up functions.
656e22bee78STejun Heo  */
657e22bee78STejun Heo 
6587e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
65963d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
6607e11629dSTejun Heo {
66163d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
6627e11629dSTejun Heo 		return NULL;
6637e11629dSTejun Heo 
66463d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
6657e11629dSTejun Heo }
6667e11629dSTejun Heo 
6677e11629dSTejun Heo /**
6687e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
66963d95a91STejun Heo  * @pool: worker pool to wake worker from
6707e11629dSTejun Heo  *
67163d95a91STejun Heo  * Wake up the first idle worker of @pool.
6727e11629dSTejun Heo  *
6737e11629dSTejun Heo  * CONTEXT:
6747e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
6757e11629dSTejun Heo  */
67663d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
6777e11629dSTejun Heo {
67863d95a91STejun Heo 	struct worker *worker = first_worker(pool);
6797e11629dSTejun Heo 
6807e11629dSTejun Heo 	if (likely(worker))
6817e11629dSTejun Heo 		wake_up_process(worker->task);
6827e11629dSTejun Heo }
6837e11629dSTejun Heo 
6844690c4abSTejun Heo /**
685e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
686e22bee78STejun Heo  * @task: task waking up
687e22bee78STejun Heo  * @cpu: CPU @task is waking up to
688e22bee78STejun Heo  *
689e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
690e22bee78STejun Heo  * being awoken.
691e22bee78STejun Heo  *
692e22bee78STejun Heo  * CONTEXT:
693e22bee78STejun Heo  * spin_lock_irq(rq->lock)
694e22bee78STejun Heo  */
695e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
696e22bee78STejun Heo {
697e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
698e22bee78STejun Heo 
6992d64672eSSteven Rostedt 	if (!(worker->flags & WORKER_NOT_RUNNING))
70063d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
701e22bee78STejun Heo }
702e22bee78STejun Heo 
703e22bee78STejun Heo /**
704e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
705e22bee78STejun Heo  * @task: task going to sleep
706e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
707e22bee78STejun Heo  *
708e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
709e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
710e22bee78STejun Heo  * returning pointer to its task.
711e22bee78STejun Heo  *
712e22bee78STejun Heo  * CONTEXT:
713e22bee78STejun Heo  * spin_lock_irq(rq->lock)
714e22bee78STejun Heo  *
715e22bee78STejun Heo  * RETURNS:
716e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
717e22bee78STejun Heo  */
718e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
719e22bee78STejun Heo 				       unsigned int cpu)
720e22bee78STejun Heo {
721e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
722bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
72363d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
724e22bee78STejun Heo 
7252d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
726e22bee78STejun Heo 		return NULL;
727e22bee78STejun Heo 
728e22bee78STejun Heo 	/* this can only happen on the local cpu */
729e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
730e22bee78STejun Heo 
731e22bee78STejun Heo 	/*
732e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
733e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
734e22bee78STejun Heo 	 * Please read comment there.
735e22bee78STejun Heo 	 *
736e22bee78STejun Heo 	 * NOT_RUNNING is clear.  This means that trustee is not in
737e22bee78STejun Heo 	 * charge and we're running on the local cpu w/ rq lock held
738e22bee78STejun Heo 	 * and preemption disabled, which in turn means that none else
739e22bee78STejun Heo 	 * could be manipulating idle_list, so dereferencing idle_list
740e22bee78STejun Heo 	 * without gcwq lock is safe.
741e22bee78STejun Heo 	 */
742bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
74363d95a91STejun Heo 		to_wakeup = first_worker(pool);
744e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
745e22bee78STejun Heo }
746e22bee78STejun Heo 
747e22bee78STejun Heo /**
748e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
749cb444766STejun Heo  * @worker: self
750d302f017STejun Heo  * @flags: flags to set
751d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
752d302f017STejun Heo  *
753e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
754e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
755e22bee78STejun Heo  * woken up.
756d302f017STejun Heo  *
757cb444766STejun Heo  * CONTEXT:
758cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
759d302f017STejun Heo  */
760d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
761d302f017STejun Heo 				    bool wakeup)
762d302f017STejun Heo {
763bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
764e22bee78STejun Heo 
765cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
766cb444766STejun Heo 
767e22bee78STejun Heo 	/*
768e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
769e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
770e22bee78STejun Heo 	 * @wakeup.
771e22bee78STejun Heo 	 */
772e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
773e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
77463d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
775e22bee78STejun Heo 
776e22bee78STejun Heo 		if (wakeup) {
777e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
778bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
77963d95a91STejun Heo 				wake_up_worker(pool);
780e22bee78STejun Heo 		} else
781e22bee78STejun Heo 			atomic_dec(nr_running);
782e22bee78STejun Heo 	}
783e22bee78STejun Heo 
784d302f017STejun Heo 	worker->flags |= flags;
785d302f017STejun Heo }
786d302f017STejun Heo 
787d302f017STejun Heo /**
788e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
789cb444766STejun Heo  * @worker: self
790d302f017STejun Heo  * @flags: flags to clear
791d302f017STejun Heo  *
792e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
793d302f017STejun Heo  *
794cb444766STejun Heo  * CONTEXT:
795cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
796d302f017STejun Heo  */
797d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
798d302f017STejun Heo {
79963d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
800e22bee78STejun Heo 	unsigned int oflags = worker->flags;
801e22bee78STejun Heo 
802cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
803cb444766STejun Heo 
804d302f017STejun Heo 	worker->flags &= ~flags;
805e22bee78STejun Heo 
80642c025f3STejun Heo 	/*
80742c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
80842c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
80942c025f3STejun Heo 	 * of multiple flags, not a single flag.
81042c025f3STejun Heo 	 */
811e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
812e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
81363d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
814d302f017STejun Heo }
815d302f017STejun Heo 
816d302f017STejun Heo /**
817c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
818c8e55f36STejun Heo  * @gcwq: gcwq of interest
819c8e55f36STejun Heo  * @work: work to be hashed
820c8e55f36STejun Heo  *
821c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
822c8e55f36STejun Heo  *
823c8e55f36STejun Heo  * CONTEXT:
824c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
825c8e55f36STejun Heo  *
826c8e55f36STejun Heo  * RETURNS:
827c8e55f36STejun Heo  * Pointer to the hash head.
828c8e55f36STejun Heo  */
829c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
830c8e55f36STejun Heo 					   struct work_struct *work)
831c8e55f36STejun Heo {
832c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
833c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
834c8e55f36STejun Heo 
835c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
836c8e55f36STejun Heo 	v >>= base_shift;
837c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
838c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
839c8e55f36STejun Heo 
840c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
841c8e55f36STejun Heo }
842c8e55f36STejun Heo 
843c8e55f36STejun Heo /**
8448cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
8458cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8468cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
8478cca0eeaSTejun Heo  * @work: work to find worker for
8488cca0eeaSTejun Heo  *
8498cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
8508cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
8518cca0eeaSTejun Heo  * work.
8528cca0eeaSTejun Heo  *
8538cca0eeaSTejun Heo  * CONTEXT:
8548cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8558cca0eeaSTejun Heo  *
8568cca0eeaSTejun Heo  * RETURNS:
8578cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8588cca0eeaSTejun Heo  * otherwise.
8598cca0eeaSTejun Heo  */
8608cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
8618cca0eeaSTejun Heo 						   struct hlist_head *bwh,
8628cca0eeaSTejun Heo 						   struct work_struct *work)
8638cca0eeaSTejun Heo {
8648cca0eeaSTejun Heo 	struct worker *worker;
8658cca0eeaSTejun Heo 	struct hlist_node *tmp;
8668cca0eeaSTejun Heo 
8678cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
8688cca0eeaSTejun Heo 		if (worker->current_work == work)
8698cca0eeaSTejun Heo 			return worker;
8708cca0eeaSTejun Heo 	return NULL;
8718cca0eeaSTejun Heo }
8728cca0eeaSTejun Heo 
8738cca0eeaSTejun Heo /**
8748cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8758cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8768cca0eeaSTejun Heo  * @work: work to find worker for
8778cca0eeaSTejun Heo  *
8788cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
8798cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
8808cca0eeaSTejun Heo  * function calculates @bwh itself.
8818cca0eeaSTejun Heo  *
8828cca0eeaSTejun Heo  * CONTEXT:
8838cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8848cca0eeaSTejun Heo  *
8858cca0eeaSTejun Heo  * RETURNS:
8868cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8878cca0eeaSTejun Heo  * otherwise.
8888cca0eeaSTejun Heo  */
8898cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8908cca0eeaSTejun Heo 						 struct work_struct *work)
8918cca0eeaSTejun Heo {
8928cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
8938cca0eeaSTejun Heo 					    work);
8948cca0eeaSTejun Heo }
8958cca0eeaSTejun Heo 
8968cca0eeaSTejun Heo /**
8977e11629dSTejun Heo  * insert_work - insert a work into gcwq
8984690c4abSTejun Heo  * @cwq: cwq @work belongs to
8994690c4abSTejun Heo  * @work: work to insert
9004690c4abSTejun Heo  * @head: insertion point
9014690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
9024690c4abSTejun Heo  *
9037e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
9047e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
9054690c4abSTejun Heo  *
9064690c4abSTejun Heo  * CONTEXT:
9078b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
9081da177e4SLinus Torvalds  */
909b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
9104690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
9114690c4abSTejun Heo 			unsigned int extra_flags)
912b89deed3SOleg Nesterov {
91363d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
914e1d8aa9fSFrederic Weisbecker 
9154690c4abSTejun Heo 	/* we own @work, set data and link */
9167a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
9174690c4abSTejun Heo 
9186e84d644SOleg Nesterov 	/*
9196e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
9206e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
9216e84d644SOleg Nesterov 	 */
9226e84d644SOleg Nesterov 	smp_wmb();
9234690c4abSTejun Heo 
9241a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
925e22bee78STejun Heo 
926e22bee78STejun Heo 	/*
927e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
928e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
929e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
930e22bee78STejun Heo 	 */
931e22bee78STejun Heo 	smp_mb();
932e22bee78STejun Heo 
93363d95a91STejun Heo 	if (__need_more_worker(pool))
93463d95a91STejun Heo 		wake_up_worker(pool);
935b89deed3SOleg Nesterov }
936b89deed3SOleg Nesterov 
937c8efcc25STejun Heo /*
938c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
939c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
940c8efcc25STejun Heo  * cold paths.
941c8efcc25STejun Heo  */
942c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
943c8efcc25STejun Heo {
944c8efcc25STejun Heo 	unsigned long flags;
945c8efcc25STejun Heo 	unsigned int cpu;
946c8efcc25STejun Heo 
947c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
948c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
949c8efcc25STejun Heo 		struct worker *worker;
950c8efcc25STejun Heo 		struct hlist_node *pos;
951c8efcc25STejun Heo 		int i;
952c8efcc25STejun Heo 
953c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
954c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
955c8efcc25STejun Heo 			if (worker->task != current)
956c8efcc25STejun Heo 				continue;
957c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
958c8efcc25STejun Heo 			/*
959c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
960c8efcc25STejun Heo 			 * is headed to the same workqueue.
961c8efcc25STejun Heo 			 */
962c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
963c8efcc25STejun Heo 		}
964c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
965c8efcc25STejun Heo 	}
966c8efcc25STejun Heo 	return false;
967c8efcc25STejun Heo }
968c8efcc25STejun Heo 
9694690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
9701da177e4SLinus Torvalds 			 struct work_struct *work)
9711da177e4SLinus Torvalds {
972502ca9d8STejun Heo 	struct global_cwq *gcwq;
973502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
9741e19ffc6STejun Heo 	struct list_head *worklist;
9758a2e8e5dSTejun Heo 	unsigned int work_flags;
9761da177e4SLinus Torvalds 	unsigned long flags;
9771da177e4SLinus Torvalds 
978dc186ad7SThomas Gleixner 	debug_work_activate(work);
9791e19ffc6STejun Heo 
980c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
9819c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
982c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
983e41e704bSTejun Heo 		return;
984e41e704bSTejun Heo 
985c7fc77f7STejun Heo 	/* determine gcwq to use */
986c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
987c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
988c7fc77f7STejun Heo 
989f3421797STejun Heo 		if (unlikely(cpu == WORK_CPU_UNBOUND))
990f3421797STejun Heo 			cpu = raw_smp_processor_id();
991f3421797STejun Heo 
99218aa9effSTejun Heo 		/*
99318aa9effSTejun Heo 		 * It's multi cpu.  If @wq is non-reentrant and @work
99418aa9effSTejun Heo 		 * was previously on a different cpu, it might still
99518aa9effSTejun Heo 		 * be running there, in which case the work needs to
99618aa9effSTejun Heo 		 * be queued on that cpu to guarantee non-reentrance.
99718aa9effSTejun Heo 		 */
998502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
99918aa9effSTejun Heo 		if (wq->flags & WQ_NON_REENTRANT &&
100018aa9effSTejun Heo 		    (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
100118aa9effSTejun Heo 			struct worker *worker;
100218aa9effSTejun Heo 
100318aa9effSTejun Heo 			spin_lock_irqsave(&last_gcwq->lock, flags);
100418aa9effSTejun Heo 
100518aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
100618aa9effSTejun Heo 
100718aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
100818aa9effSTejun Heo 				gcwq = last_gcwq;
100918aa9effSTejun Heo 			else {
101018aa9effSTejun Heo 				/* meh... not running there, queue here */
101118aa9effSTejun Heo 				spin_unlock_irqrestore(&last_gcwq->lock, flags);
101218aa9effSTejun Heo 				spin_lock_irqsave(&gcwq->lock, flags);
101318aa9effSTejun Heo 			}
101418aa9effSTejun Heo 		} else
10158b03ae3cSTejun Heo 			spin_lock_irqsave(&gcwq->lock, flags);
1016f3421797STejun Heo 	} else {
1017f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
1018f3421797STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1019502ca9d8STejun Heo 	}
1020502ca9d8STejun Heo 
1021502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1022502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1023cdadf009STejun Heo 	trace_workqueue_queue_work(cpu, cwq, work);
1024502ca9d8STejun Heo 
1025f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1026f5b2552bSDan Carpenter 		spin_unlock_irqrestore(&gcwq->lock, flags);
1027f5b2552bSDan Carpenter 		return;
1028f5b2552bSDan Carpenter 	}
10291e19ffc6STejun Heo 
103073f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
10318a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
10321e19ffc6STejun Heo 
10331e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1034cdadf009STejun Heo 		trace_workqueue_activate_work(work);
10351e19ffc6STejun Heo 		cwq->nr_active++;
10363270476aSTejun Heo 		worklist = &cwq->pool->worklist;
10378a2e8e5dSTejun Heo 	} else {
10388a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
10391e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
10408a2e8e5dSTejun Heo 	}
10411e19ffc6STejun Heo 
10428a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
10431e19ffc6STejun Heo 
10448b03ae3cSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
10451da177e4SLinus Torvalds }
10461da177e4SLinus Torvalds 
10470fcb78c2SRolf Eike Beer /**
10480fcb78c2SRolf Eike Beer  * queue_work - queue work on a workqueue
10490fcb78c2SRolf Eike Beer  * @wq: workqueue to use
10500fcb78c2SRolf Eike Beer  * @work: work to queue
10510fcb78c2SRolf Eike Beer  *
1052057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
10531da177e4SLinus Torvalds  *
105400dfcaf7SOleg Nesterov  * We queue the work to the CPU on which it was submitted, but if the CPU dies
105500dfcaf7SOleg Nesterov  * it can be processed by another CPU.
10561da177e4SLinus Torvalds  */
10577ad5b3a5SHarvey Harrison int queue_work(struct workqueue_struct *wq, struct work_struct *work)
10581da177e4SLinus Torvalds {
1059ef1ca236SOleg Nesterov 	int ret;
10601da177e4SLinus Torvalds 
1061ef1ca236SOleg Nesterov 	ret = queue_work_on(get_cpu(), wq, work);
1062a848e3b6SOleg Nesterov 	put_cpu();
1063ef1ca236SOleg Nesterov 
10641da177e4SLinus Torvalds 	return ret;
10651da177e4SLinus Torvalds }
1066ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_work);
10671da177e4SLinus Torvalds 
1068c1a220e7SZhang Rui /**
1069c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1070c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1071c1a220e7SZhang Rui  * @wq: workqueue to use
1072c1a220e7SZhang Rui  * @work: work to queue
1073c1a220e7SZhang Rui  *
1074c1a220e7SZhang Rui  * Returns 0 if @work was already on a queue, non-zero otherwise.
1075c1a220e7SZhang Rui  *
1076c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1077c1a220e7SZhang Rui  * can't go away.
1078c1a220e7SZhang Rui  */
1079c1a220e7SZhang Rui int
1080c1a220e7SZhang Rui queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1081c1a220e7SZhang Rui {
1082c1a220e7SZhang Rui 	int ret = 0;
1083c1a220e7SZhang Rui 
108422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
10854690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1086c1a220e7SZhang Rui 		ret = 1;
1087c1a220e7SZhang Rui 	}
1088c1a220e7SZhang Rui 	return ret;
1089c1a220e7SZhang Rui }
1090c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1091c1a220e7SZhang Rui 
10926d141c3fSLi Zefan static void delayed_work_timer_fn(unsigned long __data)
10931da177e4SLinus Torvalds {
109452bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
10957a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
10961da177e4SLinus Torvalds 
10974690c4abSTejun Heo 	__queue_work(smp_processor_id(), cwq->wq, &dwork->work);
10981da177e4SLinus Torvalds }
10991da177e4SLinus Torvalds 
11000fcb78c2SRolf Eike Beer /**
11010fcb78c2SRolf Eike Beer  * queue_delayed_work - queue work on a workqueue after delay
11020fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1103af9997e4SRandy Dunlap  * @dwork: delayable work to queue
11040fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11050fcb78c2SRolf Eike Beer  *
1106057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11070fcb78c2SRolf Eike Beer  */
11087ad5b3a5SHarvey Harrison int queue_delayed_work(struct workqueue_struct *wq,
110952bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11101da177e4SLinus Torvalds {
111152bad64dSDavid Howells 	if (delay == 0)
111263bc0362SOleg Nesterov 		return queue_work(wq, &dwork->work);
11131da177e4SLinus Torvalds 
111463bc0362SOleg Nesterov 	return queue_delayed_work_on(-1, wq, dwork, delay);
11151da177e4SLinus Torvalds }
1116ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work);
11171da177e4SLinus Torvalds 
11180fcb78c2SRolf Eike Beer /**
11190fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
11200fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
11210fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1122af9997e4SRandy Dunlap  * @dwork: work to queue
11230fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11240fcb78c2SRolf Eike Beer  *
1125057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11260fcb78c2SRolf Eike Beer  */
11277a6bc1cdSVenkatesh Pallipadi int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
112852bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11297a6bc1cdSVenkatesh Pallipadi {
11307a6bc1cdSVenkatesh Pallipadi 	int ret = 0;
113152bad64dSDavid Howells 	struct timer_list *timer = &dwork->timer;
113252bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
11337a6bc1cdSVenkatesh Pallipadi 
113422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1135c7fc77f7STejun Heo 		unsigned int lcpu;
11367a22ad75STejun Heo 
11377a6bc1cdSVenkatesh Pallipadi 		BUG_ON(timer_pending(timer));
11387a6bc1cdSVenkatesh Pallipadi 		BUG_ON(!list_empty(&work->entry));
11397a6bc1cdSVenkatesh Pallipadi 
11408a3e77ccSAndrew Liu 		timer_stats_timer_set_start_info(&dwork->timer);
11418a3e77ccSAndrew Liu 
11427a22ad75STejun Heo 		/*
11437a22ad75STejun Heo 		 * This stores cwq for the moment, for the timer_fn.
11447a22ad75STejun Heo 		 * Note that the work's gcwq is preserved to allow
11457a22ad75STejun Heo 		 * reentrance detection for delayed works.
11467a22ad75STejun Heo 		 */
1147c7fc77f7STejun Heo 		if (!(wq->flags & WQ_UNBOUND)) {
1148c7fc77f7STejun Heo 			struct global_cwq *gcwq = get_work_gcwq(work);
1149c7fc77f7STejun Heo 
1150c7fc77f7STejun Heo 			if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1151c7fc77f7STejun Heo 				lcpu = gcwq->cpu;
1152c7fc77f7STejun Heo 			else
1153c7fc77f7STejun Heo 				lcpu = raw_smp_processor_id();
1154c7fc77f7STejun Heo 		} else
1155c7fc77f7STejun Heo 			lcpu = WORK_CPU_UNBOUND;
1156c7fc77f7STejun Heo 
11577a22ad75STejun Heo 		set_work_cwq(work, get_cwq(lcpu, wq), 0);
1158c7fc77f7STejun Heo 
11597a6bc1cdSVenkatesh Pallipadi 		timer->expires = jiffies + delay;
116052bad64dSDavid Howells 		timer->data = (unsigned long)dwork;
11617a6bc1cdSVenkatesh Pallipadi 		timer->function = delayed_work_timer_fn;
116263bc0362SOleg Nesterov 
116363bc0362SOleg Nesterov 		if (unlikely(cpu >= 0))
11647a6bc1cdSVenkatesh Pallipadi 			add_timer_on(timer, cpu);
116563bc0362SOleg Nesterov 		else
116663bc0362SOleg Nesterov 			add_timer(timer);
11677a6bc1cdSVenkatesh Pallipadi 		ret = 1;
11687a6bc1cdSVenkatesh Pallipadi 	}
11697a6bc1cdSVenkatesh Pallipadi 	return ret;
11707a6bc1cdSVenkatesh Pallipadi }
1171ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
11721da177e4SLinus Torvalds 
1173c8e55f36STejun Heo /**
1174c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1175c8e55f36STejun Heo  * @worker: worker which is entering idle state
1176c8e55f36STejun Heo  *
1177c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1178c8e55f36STejun Heo  * necessary.
1179c8e55f36STejun Heo  *
1180c8e55f36STejun Heo  * LOCKING:
1181c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1182c8e55f36STejun Heo  */
1183c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
11841da177e4SLinus Torvalds {
1185bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1186bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1187c8e55f36STejun Heo 
1188c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1189c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1190c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1191c8e55f36STejun Heo 
1192cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1193cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1194bd7bdd43STejun Heo 	pool->nr_idle++;
1195e22bee78STejun Heo 	worker->last_active = jiffies;
1196c8e55f36STejun Heo 
1197c8e55f36STejun Heo 	/* idle_list is LIFO */
1198bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1199db7bccf4STejun Heo 
1200*403c821dSTejun Heo 	if (likely(gcwq->trustee_state != TRUSTEE_DONE)) {
120163d95a91STejun Heo 		if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1202bd7bdd43STejun Heo 			mod_timer(&pool->idle_timer,
1203e22bee78STejun Heo 				  jiffies + IDLE_WORKER_TIMEOUT);
1204e22bee78STejun Heo 	} else
1205db7bccf4STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1206cb444766STejun Heo 
1207544ecf31STejun Heo 	/*
1208544ecf31STejun Heo 	 * Sanity check nr_running.  Because trustee releases gcwq->lock
1209*403c821dSTejun Heo 	 * between setting %WORKER_UNBOUND and zapping nr_running, the
1210544ecf31STejun Heo 	 * warning may trigger spuriously.  Check iff trustee is idle.
1211544ecf31STejun Heo 	 */
1212544ecf31STejun Heo 	WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
1213bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
121463d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1215c8e55f36STejun Heo }
1216c8e55f36STejun Heo 
1217c8e55f36STejun Heo /**
1218c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1219c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1220c8e55f36STejun Heo  *
1221c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1222c8e55f36STejun Heo  *
1223c8e55f36STejun Heo  * LOCKING:
1224c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1225c8e55f36STejun Heo  */
1226c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1227c8e55f36STejun Heo {
1228bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1229c8e55f36STejun Heo 
1230c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1231d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1232bd7bdd43STejun Heo 	pool->nr_idle--;
1233c8e55f36STejun Heo 	list_del_init(&worker->entry);
1234c8e55f36STejun Heo }
1235c8e55f36STejun Heo 
1236e22bee78STejun Heo /**
1237e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1238e22bee78STejun Heo  * @worker: self
1239e22bee78STejun Heo  *
1240e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1241e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1242e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1243e22bee78STejun Heo  * guaranteed to execute on the cpu.
1244e22bee78STejun Heo  *
1245e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1246e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1247e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1248e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1249e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1250e22bee78STejun Heo  * [dis]associated in the meantime.
1251e22bee78STejun Heo  *
1252f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1253f2d5a0eeSTejun Heo  * binding against %GCWQ_DISASSOCIATED which is set during
1254f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1255f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1256f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1257e22bee78STejun Heo  *
1258e22bee78STejun Heo  * CONTEXT:
1259e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1260e22bee78STejun Heo  * held.
1261e22bee78STejun Heo  *
1262e22bee78STejun Heo  * RETURNS:
1263e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1264e22bee78STejun Heo  * bound), %false if offline.
1265e22bee78STejun Heo  */
1266e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1267972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1268e22bee78STejun Heo {
1269bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1270e22bee78STejun Heo 	struct task_struct *task = worker->task;
1271e22bee78STejun Heo 
1272e22bee78STejun Heo 	while (true) {
1273e22bee78STejun Heo 		/*
1274e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1275e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1276e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1277e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1278e22bee78STejun Heo 		 */
1279f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1280e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1281e22bee78STejun Heo 
1282e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1283e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1284e22bee78STejun Heo 			return false;
1285e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1286e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1287e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1288e22bee78STejun Heo 			return true;
1289e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1290e22bee78STejun Heo 
12915035b20fSTejun Heo 		/*
12925035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
12935035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
12945035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
12955035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
12965035b20fSTejun Heo 		 */
1297e22bee78STejun Heo 		cpu_relax();
12985035b20fSTejun Heo 		cond_resched();
1299e22bee78STejun Heo 	}
1300e22bee78STejun Heo }
1301e22bee78STejun Heo 
1302e22bee78STejun Heo /*
1303*403c821dSTejun Heo  * Function for worker->rebind_work used to rebind unbound busy workers to
1304*403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1305*403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1306*403c821dSTejun Heo  * executed twice without intervening cpu down.
1307e22bee78STejun Heo  */
1308e22bee78STejun Heo static void worker_rebind_fn(struct work_struct *work)
1309e22bee78STejun Heo {
1310e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1311bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1312e22bee78STejun Heo 
1313e22bee78STejun Heo 	if (worker_maybe_bind_and_lock(worker))
1314e22bee78STejun Heo 		worker_clr_flags(worker, WORKER_REBIND);
1315e22bee78STejun Heo 
1316e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1317e22bee78STejun Heo }
1318e22bee78STejun Heo 
1319c34056a3STejun Heo static struct worker *alloc_worker(void)
1320c34056a3STejun Heo {
1321c34056a3STejun Heo 	struct worker *worker;
1322c34056a3STejun Heo 
1323c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1324c8e55f36STejun Heo 	if (worker) {
1325c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1326affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1327e22bee78STejun Heo 		INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1328e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1329e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1330c8e55f36STejun Heo 	}
1331c34056a3STejun Heo 	return worker;
1332c34056a3STejun Heo }
1333c34056a3STejun Heo 
1334c34056a3STejun Heo /**
1335c34056a3STejun Heo  * create_worker - create a new workqueue worker
133663d95a91STejun Heo  * @pool: pool the new worker will belong to
1337c34056a3STejun Heo  * @bind: whether to set affinity to @cpu or not
1338c34056a3STejun Heo  *
133963d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1340c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1341c34056a3STejun Heo  * destroy_worker().
1342c34056a3STejun Heo  *
1343c34056a3STejun Heo  * CONTEXT:
1344c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1345c34056a3STejun Heo  *
1346c34056a3STejun Heo  * RETURNS:
1347c34056a3STejun Heo  * Pointer to the newly created worker.
1348c34056a3STejun Heo  */
134963d95a91STejun Heo static struct worker *create_worker(struct worker_pool *pool, bool bind)
1350c34056a3STejun Heo {
135163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1352f3421797STejun Heo 	bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
13533270476aSTejun Heo 	const char *pri = worker_pool_pri(pool) ? "H" : "";
1354c34056a3STejun Heo 	struct worker *worker = NULL;
1355f3421797STejun Heo 	int id = -1;
1356c34056a3STejun Heo 
13578b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1358bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
13598b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1360bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1361c34056a3STejun Heo 			goto fail;
13628b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1363c34056a3STejun Heo 	}
13648b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1365c34056a3STejun Heo 
1366c34056a3STejun Heo 	worker = alloc_worker();
1367c34056a3STejun Heo 	if (!worker)
1368c34056a3STejun Heo 		goto fail;
1369c34056a3STejun Heo 
1370bd7bdd43STejun Heo 	worker->pool = pool;
1371c34056a3STejun Heo 	worker->id = id;
1372c34056a3STejun Heo 
1373f3421797STejun Heo 	if (!on_unbound_cpu)
137494dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
13753270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
13763270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1377f3421797STejun Heo 	else
1378f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
13793270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1380c34056a3STejun Heo 	if (IS_ERR(worker->task))
1381c34056a3STejun Heo 		goto fail;
1382c34056a3STejun Heo 
13833270476aSTejun Heo 	if (worker_pool_pri(pool))
13843270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
13853270476aSTejun Heo 
1386db7bccf4STejun Heo 	/*
1387*403c821dSTejun Heo 	 * An unbound worker will become a regular one if CPU comes online
1388*403c821dSTejun Heo 	 * later on.  Make sure every worker has PF_THREAD_BOUND set.
1389db7bccf4STejun Heo 	 */
1390f3421797STejun Heo 	if (bind && !on_unbound_cpu)
13918b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1392f3421797STejun Heo 	else {
1393db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1394f3421797STejun Heo 		if (on_unbound_cpu)
1395f3421797STejun Heo 			worker->flags |= WORKER_UNBOUND;
1396f3421797STejun Heo 	}
1397c34056a3STejun Heo 
1398c34056a3STejun Heo 	return worker;
1399c34056a3STejun Heo fail:
1400c34056a3STejun Heo 	if (id >= 0) {
14018b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1402bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
14038b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1404c34056a3STejun Heo 	}
1405c34056a3STejun Heo 	kfree(worker);
1406c34056a3STejun Heo 	return NULL;
1407c34056a3STejun Heo }
1408c34056a3STejun Heo 
1409c34056a3STejun Heo /**
1410c34056a3STejun Heo  * start_worker - start a newly created worker
1411c34056a3STejun Heo  * @worker: worker to start
1412c34056a3STejun Heo  *
1413c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1414c34056a3STejun Heo  *
1415c34056a3STejun Heo  * CONTEXT:
14168b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1417c34056a3STejun Heo  */
1418c34056a3STejun Heo static void start_worker(struct worker *worker)
1419c34056a3STejun Heo {
1420cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1421bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1422c8e55f36STejun Heo 	worker_enter_idle(worker);
1423c34056a3STejun Heo 	wake_up_process(worker->task);
1424c34056a3STejun Heo }
1425c34056a3STejun Heo 
1426c34056a3STejun Heo /**
1427c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1428c34056a3STejun Heo  * @worker: worker to be destroyed
1429c34056a3STejun Heo  *
1430c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1431c8e55f36STejun Heo  *
1432c8e55f36STejun Heo  * CONTEXT:
1433c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1434c34056a3STejun Heo  */
1435c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1436c34056a3STejun Heo {
1437bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1438bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1439c34056a3STejun Heo 	int id = worker->id;
1440c34056a3STejun Heo 
1441c34056a3STejun Heo 	/* sanity check frenzy */
1442c34056a3STejun Heo 	BUG_ON(worker->current_work);
1443affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1444c34056a3STejun Heo 
1445c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1446bd7bdd43STejun Heo 		pool->nr_workers--;
1447c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1448bd7bdd43STejun Heo 		pool->nr_idle--;
1449c8e55f36STejun Heo 
1450c8e55f36STejun Heo 	list_del_init(&worker->entry);
1451cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1452c8e55f36STejun Heo 
1453c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1454c8e55f36STejun Heo 
1455c34056a3STejun Heo 	kthread_stop(worker->task);
1456c34056a3STejun Heo 	kfree(worker);
1457c34056a3STejun Heo 
14588b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1459bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1460c34056a3STejun Heo }
1461c34056a3STejun Heo 
146263d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1463e22bee78STejun Heo {
146463d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
146563d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1466e22bee78STejun Heo 
1467e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1468e22bee78STejun Heo 
146963d95a91STejun Heo 	if (too_many_workers(pool)) {
1470e22bee78STejun Heo 		struct worker *worker;
1471e22bee78STejun Heo 		unsigned long expires;
1472e22bee78STejun Heo 
1473e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
147463d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1475e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1476e22bee78STejun Heo 
1477e22bee78STejun Heo 		if (time_before(jiffies, expires))
147863d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1479e22bee78STejun Heo 		else {
1480e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
148111ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
148263d95a91STejun Heo 			wake_up_worker(pool);
1483e22bee78STejun Heo 		}
1484e22bee78STejun Heo 	}
1485e22bee78STejun Heo 
1486e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1487e22bee78STejun Heo }
1488e22bee78STejun Heo 
1489e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1490e22bee78STejun Heo {
1491e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1492e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1493f3421797STejun Heo 	unsigned int cpu;
1494e22bee78STejun Heo 
1495e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1496e22bee78STejun Heo 		return false;
1497e22bee78STejun Heo 
1498e22bee78STejun Heo 	/* mayday mayday mayday */
1499bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1500f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1501f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1502f3421797STejun Heo 		cpu = 0;
1503f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1504e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1505e22bee78STejun Heo 	return true;
1506e22bee78STejun Heo }
1507e22bee78STejun Heo 
150863d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1509e22bee78STejun Heo {
151063d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
151163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1512e22bee78STejun Heo 	struct work_struct *work;
1513e22bee78STejun Heo 
1514e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1515e22bee78STejun Heo 
151663d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1517e22bee78STejun Heo 		/*
1518e22bee78STejun Heo 		 * We've been trying to create a new worker but
1519e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1520e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1521e22bee78STejun Heo 		 * rescuers.
1522e22bee78STejun Heo 		 */
152363d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1524e22bee78STejun Heo 			send_mayday(work);
1525e22bee78STejun Heo 	}
1526e22bee78STejun Heo 
1527e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1528e22bee78STejun Heo 
152963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1530e22bee78STejun Heo }
1531e22bee78STejun Heo 
1532e22bee78STejun Heo /**
1533e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
153463d95a91STejun Heo  * @pool: pool to create a new worker for
1535e22bee78STejun Heo  *
153663d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1537e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1538e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
153963d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1540e22bee78STejun Heo  * possible allocation deadlock.
1541e22bee78STejun Heo  *
1542e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1543e22bee78STejun Heo  * may_start_working() true.
1544e22bee78STejun Heo  *
1545e22bee78STejun Heo  * LOCKING:
1546e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1547e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1548e22bee78STejun Heo  * manager.
1549e22bee78STejun Heo  *
1550e22bee78STejun Heo  * RETURNS:
1551e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1552e22bee78STejun Heo  * otherwise.
1553e22bee78STejun Heo  */
155463d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
155506bd6ebfSNamhyung Kim __releases(&gcwq->lock)
155606bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1557e22bee78STejun Heo {
155863d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
155963d95a91STejun Heo 
156063d95a91STejun Heo 	if (!need_to_create_worker(pool))
1561e22bee78STejun Heo 		return false;
1562e22bee78STejun Heo restart:
15639f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
15649f9c2364STejun Heo 
1565e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
156663d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1567e22bee78STejun Heo 
1568e22bee78STejun Heo 	while (true) {
1569e22bee78STejun Heo 		struct worker *worker;
1570e22bee78STejun Heo 
157163d95a91STejun Heo 		worker = create_worker(pool, true);
1572e22bee78STejun Heo 		if (worker) {
157363d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1574e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1575e22bee78STejun Heo 			start_worker(worker);
157663d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1577e22bee78STejun Heo 			return true;
1578e22bee78STejun Heo 		}
1579e22bee78STejun Heo 
158063d95a91STejun Heo 		if (!need_to_create_worker(pool))
1581e22bee78STejun Heo 			break;
1582e22bee78STejun Heo 
1583e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1584e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
15859f9c2364STejun Heo 
158663d95a91STejun Heo 		if (!need_to_create_worker(pool))
1587e22bee78STejun Heo 			break;
1588e22bee78STejun Heo 	}
1589e22bee78STejun Heo 
159063d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1591e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
159263d95a91STejun Heo 	if (need_to_create_worker(pool))
1593e22bee78STejun Heo 		goto restart;
1594e22bee78STejun Heo 	return true;
1595e22bee78STejun Heo }
1596e22bee78STejun Heo 
1597e22bee78STejun Heo /**
1598e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
159963d95a91STejun Heo  * @pool: pool to destroy workers for
1600e22bee78STejun Heo  *
160163d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
1602e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1603e22bee78STejun Heo  *
1604e22bee78STejun Heo  * LOCKING:
1605e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1606e22bee78STejun Heo  * multiple times.  Called only from manager.
1607e22bee78STejun Heo  *
1608e22bee78STejun Heo  * RETURNS:
1609e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1610e22bee78STejun Heo  * otherwise.
1611e22bee78STejun Heo  */
161263d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
1613e22bee78STejun Heo {
1614e22bee78STejun Heo 	bool ret = false;
1615e22bee78STejun Heo 
161663d95a91STejun Heo 	while (too_many_workers(pool)) {
1617e22bee78STejun Heo 		struct worker *worker;
1618e22bee78STejun Heo 		unsigned long expires;
1619e22bee78STejun Heo 
162063d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1621e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1622e22bee78STejun Heo 
1623e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
162463d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1625e22bee78STejun Heo 			break;
1626e22bee78STejun Heo 		}
1627e22bee78STejun Heo 
1628e22bee78STejun Heo 		destroy_worker(worker);
1629e22bee78STejun Heo 		ret = true;
1630e22bee78STejun Heo 	}
1631e22bee78STejun Heo 
1632e22bee78STejun Heo 	return ret;
1633e22bee78STejun Heo }
1634e22bee78STejun Heo 
1635e22bee78STejun Heo /**
1636e22bee78STejun Heo  * manage_workers - manage worker pool
1637e22bee78STejun Heo  * @worker: self
1638e22bee78STejun Heo  *
1639e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
1640e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1641e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
1642e22bee78STejun Heo  *
1643e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
1644e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
1645e22bee78STejun Heo  * and may_start_working() is true.
1646e22bee78STejun Heo  *
1647e22bee78STejun Heo  * CONTEXT:
1648e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1649e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
1650e22bee78STejun Heo  *
1651e22bee78STejun Heo  * RETURNS:
1652e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
1653e22bee78STejun Heo  * some action was taken.
1654e22bee78STejun Heo  */
1655e22bee78STejun Heo static bool manage_workers(struct worker *worker)
1656e22bee78STejun Heo {
165763d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
165863d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1659e22bee78STejun Heo 	bool ret = false;
1660e22bee78STejun Heo 
166111ebea50STejun Heo 	if (pool->flags & POOL_MANAGING_WORKERS)
1662e22bee78STejun Heo 		return ret;
1663e22bee78STejun Heo 
166411ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
166511ebea50STejun Heo 	pool->flags |= POOL_MANAGING_WORKERS;
1666e22bee78STejun Heo 
1667e22bee78STejun Heo 	/*
1668e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
1669e22bee78STejun Heo 	 * on return.
1670e22bee78STejun Heo 	 */
167163d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
167263d95a91STejun Heo 	ret |= maybe_create_worker(pool);
1673e22bee78STejun Heo 
167411ebea50STejun Heo 	pool->flags &= ~POOL_MANAGING_WORKERS;
1675e22bee78STejun Heo 
1676e22bee78STejun Heo 	/*
1677e22bee78STejun Heo 	 * The trustee might be waiting to take over the manager
1678e22bee78STejun Heo 	 * position, tell it we're done.
1679e22bee78STejun Heo 	 */
1680e22bee78STejun Heo 	if (unlikely(gcwq->trustee))
1681e22bee78STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1682e22bee78STejun Heo 
1683e22bee78STejun Heo 	return ret;
1684e22bee78STejun Heo }
1685e22bee78STejun Heo 
1686a62428c0STejun Heo /**
1687affee4b2STejun Heo  * move_linked_works - move linked works to a list
1688affee4b2STejun Heo  * @work: start of series of works to be scheduled
1689affee4b2STejun Heo  * @head: target list to append @work to
1690affee4b2STejun Heo  * @nextp: out paramter for nested worklist walking
1691affee4b2STejun Heo  *
1692affee4b2STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1693affee4b2STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1694affee4b2STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1695affee4b2STejun Heo  *
1696affee4b2STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1697affee4b2STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1698affee4b2STejun Heo  * nested inside outer list_for_each_entry_safe().
1699affee4b2STejun Heo  *
1700affee4b2STejun Heo  * CONTEXT:
17018b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1702affee4b2STejun Heo  */
1703affee4b2STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1704affee4b2STejun Heo 			      struct work_struct **nextp)
1705affee4b2STejun Heo {
1706affee4b2STejun Heo 	struct work_struct *n;
1707affee4b2STejun Heo 
1708affee4b2STejun Heo 	/*
1709affee4b2STejun Heo 	 * Linked worklist will always end before the end of the list,
1710affee4b2STejun Heo 	 * use NULL for list head.
1711affee4b2STejun Heo 	 */
1712affee4b2STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1713affee4b2STejun Heo 		list_move_tail(&work->entry, head);
1714affee4b2STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1715affee4b2STejun Heo 			break;
1716affee4b2STejun Heo 	}
1717affee4b2STejun Heo 
1718affee4b2STejun Heo 	/*
1719affee4b2STejun Heo 	 * If we're already inside safe list traversal and have moved
1720affee4b2STejun Heo 	 * multiple works to the scheduled queue, the next position
1721affee4b2STejun Heo 	 * needs to be updated.
1722affee4b2STejun Heo 	 */
1723affee4b2STejun Heo 	if (nextp)
1724affee4b2STejun Heo 		*nextp = n;
1725affee4b2STejun Heo }
1726affee4b2STejun Heo 
17271e19ffc6STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
17281e19ffc6STejun Heo {
17291e19ffc6STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
17301da177e4SLinus Torvalds 						    struct work_struct, entry);
17311e19ffc6STejun Heo 
1732cdadf009STejun Heo 	trace_workqueue_activate_work(work);
17333270476aSTejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
17348a2e8e5dSTejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
17351e19ffc6STejun Heo 	cwq->nr_active++;
17361e19ffc6STejun Heo }
17371e19ffc6STejun Heo 
1738affee4b2STejun Heo /**
173973f53c4aSTejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
174073f53c4aSTejun Heo  * @cwq: cwq of interest
174173f53c4aSTejun Heo  * @color: color of work which left the queue
17428a2e8e5dSTejun Heo  * @delayed: for a delayed work
174373f53c4aSTejun Heo  *
174473f53c4aSTejun Heo  * A work either has completed or is removed from pending queue,
174573f53c4aSTejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
174673f53c4aSTejun Heo  *
174773f53c4aSTejun Heo  * CONTEXT:
17488b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
174973f53c4aSTejun Heo  */
17508a2e8e5dSTejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
17518a2e8e5dSTejun Heo 				 bool delayed)
175273f53c4aSTejun Heo {
175373f53c4aSTejun Heo 	/* ignore uncolored works */
175473f53c4aSTejun Heo 	if (color == WORK_NO_COLOR)
175573f53c4aSTejun Heo 		return;
175673f53c4aSTejun Heo 
175773f53c4aSTejun Heo 	cwq->nr_in_flight[color]--;
17581e19ffc6STejun Heo 
17598a2e8e5dSTejun Heo 	if (!delayed) {
17608a2e8e5dSTejun Heo 		cwq->nr_active--;
1761502ca9d8STejun Heo 		if (!list_empty(&cwq->delayed_works)) {
17621e19ffc6STejun Heo 			/* one down, submit a delayed one */
1763502ca9d8STejun Heo 			if (cwq->nr_active < cwq->max_active)
17641e19ffc6STejun Heo 				cwq_activate_first_delayed(cwq);
1765502ca9d8STejun Heo 		}
17668a2e8e5dSTejun Heo 	}
176773f53c4aSTejun Heo 
176873f53c4aSTejun Heo 	/* is flush in progress and are we at the flushing tip? */
176973f53c4aSTejun Heo 	if (likely(cwq->flush_color != color))
177073f53c4aSTejun Heo 		return;
177173f53c4aSTejun Heo 
177273f53c4aSTejun Heo 	/* are there still in-flight works? */
177373f53c4aSTejun Heo 	if (cwq->nr_in_flight[color])
177473f53c4aSTejun Heo 		return;
177573f53c4aSTejun Heo 
177673f53c4aSTejun Heo 	/* this cwq is done, clear flush_color */
177773f53c4aSTejun Heo 	cwq->flush_color = -1;
177873f53c4aSTejun Heo 
177973f53c4aSTejun Heo 	/*
178073f53c4aSTejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
178173f53c4aSTejun Heo 	 * will handle the rest.
178273f53c4aSTejun Heo 	 */
178373f53c4aSTejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
178473f53c4aSTejun Heo 		complete(&cwq->wq->first_flusher->done);
178573f53c4aSTejun Heo }
178673f53c4aSTejun Heo 
178773f53c4aSTejun Heo /**
1788a62428c0STejun Heo  * process_one_work - process single work
1789c34056a3STejun Heo  * @worker: self
1790a62428c0STejun Heo  * @work: work to process
1791a62428c0STejun Heo  *
1792a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
1793a62428c0STejun Heo  * process a single work including synchronization against and
1794a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
1795a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
1796a62428c0STejun Heo  * call this function to process a work.
1797a62428c0STejun Heo  *
1798a62428c0STejun Heo  * CONTEXT:
17998b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1800a62428c0STejun Heo  */
1801c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
180206bd6ebfSNamhyung Kim __releases(&gcwq->lock)
180306bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
18041da177e4SLinus Torvalds {
18057e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1806bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1807bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1808c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
1809fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
18106bb49e59SDavid Howells 	work_func_t f = work->func;
181173f53c4aSTejun Heo 	int work_color;
18127e11629dSTejun Heo 	struct worker *collision;
18134e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
18144e6045f1SJohannes Berg 	/*
1815a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
1816a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
1817a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
1818a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
1819a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
18204e6045f1SJohannes Berg 	 */
18214d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
18224d82a1deSPeter Zijlstra 
18234d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
18244e6045f1SJohannes Berg #endif
18257e11629dSTejun Heo 	/*
18267e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
18277e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
18287e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
18297e11629dSTejun Heo 	 * currently executing one.
18307e11629dSTejun Heo 	 */
18317e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
18327e11629dSTejun Heo 	if (unlikely(collision)) {
18337e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
18347e11629dSTejun Heo 		return;
18357e11629dSTejun Heo 	}
18361da177e4SLinus Torvalds 
1837a62428c0STejun Heo 	/* claim and process */
18381da177e4SLinus Torvalds 	debug_work_deactivate(work);
1839c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
1840c34056a3STejun Heo 	worker->current_work = work;
18418cca0eeaSTejun Heo 	worker->current_cwq = cwq;
184273f53c4aSTejun Heo 	work_color = get_work_color(work);
18437a22ad75STejun Heo 
18447a22ad75STejun Heo 	/* record the current cpu number in the work data and dequeue */
18457a22ad75STejun Heo 	set_work_cpu(work, gcwq->cpu);
1846a62428c0STejun Heo 	list_del_init(&work->entry);
1847a62428c0STejun Heo 
1848649027d7STejun Heo 	/*
1849fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
1850fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
1851fb0e7bebSTejun Heo 	 */
1852fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1853fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1854fb0e7bebSTejun Heo 
1855974271c4STejun Heo 	/*
1856974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
1857974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
1858974271c4STejun Heo 	 */
185963d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
186063d95a91STejun Heo 		wake_up_worker(pool);
1861974271c4STejun Heo 
18628b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
18631da177e4SLinus Torvalds 
186423b2e599SOleg Nesterov 	work_clear_pending(work);
1865e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
18663295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
1867e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
186865f27f38SDavid Howells 	f(work);
1869e36c886aSArjan van de Ven 	/*
1870e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
1871e36c886aSArjan van de Ven 	 * point will only record its address.
1872e36c886aSArjan van de Ven 	 */
1873e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
18743295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
18753295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
18761da177e4SLinus Torvalds 
1877d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1878d5abe669SPeter Zijlstra 		printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1879d5abe669SPeter Zijlstra 		       "%s/0x%08x/%d\n",
1880a62428c0STejun Heo 		       current->comm, preempt_count(), task_pid_nr(current));
1881d5abe669SPeter Zijlstra 		printk(KERN_ERR "    last function: ");
1882d5abe669SPeter Zijlstra 		print_symbol("%s\n", (unsigned long)f);
1883d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
1884d5abe669SPeter Zijlstra 		dump_stack();
1885d5abe669SPeter Zijlstra 	}
1886d5abe669SPeter Zijlstra 
18878b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1888a62428c0STejun Heo 
1889fb0e7bebSTejun Heo 	/* clear cpu intensive status */
1890fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1891fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1892fb0e7bebSTejun Heo 
1893a62428c0STejun Heo 	/* we're done with it, release */
1894c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
1895c34056a3STejun Heo 	worker->current_work = NULL;
18968cca0eeaSTejun Heo 	worker->current_cwq = NULL;
18978a2e8e5dSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color, false);
18981da177e4SLinus Torvalds }
18991da177e4SLinus Torvalds 
1900affee4b2STejun Heo /**
1901affee4b2STejun Heo  * process_scheduled_works - process scheduled works
1902affee4b2STejun Heo  * @worker: self
1903affee4b2STejun Heo  *
1904affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
1905affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
1906affee4b2STejun Heo  * fetches a work from the top and executes it.
1907affee4b2STejun Heo  *
1908affee4b2STejun Heo  * CONTEXT:
19098b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1910affee4b2STejun Heo  * multiple times.
1911affee4b2STejun Heo  */
1912affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
19131da177e4SLinus Torvalds {
1914affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
1915affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
1916a62428c0STejun Heo 						struct work_struct, entry);
1917c34056a3STejun Heo 		process_one_work(worker, work);
1918a62428c0STejun Heo 	}
19191da177e4SLinus Torvalds }
19201da177e4SLinus Torvalds 
19214690c4abSTejun Heo /**
19224690c4abSTejun Heo  * worker_thread - the worker thread function
1923c34056a3STejun Heo  * @__worker: self
19244690c4abSTejun Heo  *
1925e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
1926e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
1927e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
1928e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
1929e22bee78STejun Heo  * rescuer_thread().
19304690c4abSTejun Heo  */
1931c34056a3STejun Heo static int worker_thread(void *__worker)
19321da177e4SLinus Torvalds {
1933c34056a3STejun Heo 	struct worker *worker = __worker;
1934bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1935bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
19361da177e4SLinus Torvalds 
1937e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
1938e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
1939c8e55f36STejun Heo woke_up:
19408b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1941affee4b2STejun Heo 
1942c8e55f36STejun Heo 	/* DIE can be set only while we're idle, checking here is enough */
1943c8e55f36STejun Heo 	if (worker->flags & WORKER_DIE) {
1944c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
1945e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
1946c8e55f36STejun Heo 		return 0;
1947c8e55f36STejun Heo 	}
1948c8e55f36STejun Heo 
1949c8e55f36STejun Heo 	worker_leave_idle(worker);
1950db7bccf4STejun Heo recheck:
1951e22bee78STejun Heo 	/* no more worker necessary? */
195263d95a91STejun Heo 	if (!need_more_worker(pool))
1953e22bee78STejun Heo 		goto sleep;
1954e22bee78STejun Heo 
1955e22bee78STejun Heo 	/* do we need to manage? */
195663d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
1957e22bee78STejun Heo 		goto recheck;
1958e22bee78STejun Heo 
1959c8e55f36STejun Heo 	/*
1960c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
1961c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
1962c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
1963c8e55f36STejun Heo 	 */
1964c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1965c8e55f36STejun Heo 
1966e22bee78STejun Heo 	/*
1967e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
1968e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
1969e22bee78STejun Heo 	 * assumed the manager role.
1970e22bee78STejun Heo 	 */
1971e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
1972e22bee78STejun Heo 
1973e22bee78STejun Heo 	do {
1974affee4b2STejun Heo 		struct work_struct *work =
1975bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
1976affee4b2STejun Heo 					 struct work_struct, entry);
1977affee4b2STejun Heo 
1978c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1979affee4b2STejun Heo 			/* optimization path, not strictly necessary */
1980affee4b2STejun Heo 			process_one_work(worker, work);
1981affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
1982affee4b2STejun Heo 				process_scheduled_works(worker);
1983affee4b2STejun Heo 		} else {
1984c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
1985affee4b2STejun Heo 			process_scheduled_works(worker);
1986affee4b2STejun Heo 		}
198763d95a91STejun Heo 	} while (keep_working(pool));
1988affee4b2STejun Heo 
1989e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
1990d313dd85STejun Heo sleep:
199163d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
1992e22bee78STejun Heo 		goto recheck;
1993d313dd85STejun Heo 
1994c8e55f36STejun Heo 	/*
1995e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
1996e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
1997e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
1998e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
1999e22bee78STejun Heo 	 * prevent losing any event.
2000c8e55f36STejun Heo 	 */
2001c8e55f36STejun Heo 	worker_enter_idle(worker);
2002c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
20038b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
20041da177e4SLinus Torvalds 	schedule();
2005c8e55f36STejun Heo 	goto woke_up;
20061da177e4SLinus Torvalds }
20071da177e4SLinus Torvalds 
2008e22bee78STejun Heo /**
2009e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2010e22bee78STejun Heo  * @__wq: the associated workqueue
2011e22bee78STejun Heo  *
2012e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2013e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2014e22bee78STejun Heo  *
2015e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2016e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2017e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2018e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2019e22bee78STejun Heo  * the problem rescuer solves.
2020e22bee78STejun Heo  *
2021e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2022e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2023e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2024e22bee78STejun Heo  *
2025e22bee78STejun Heo  * This should happen rarely.
2026e22bee78STejun Heo  */
2027e22bee78STejun Heo static int rescuer_thread(void *__wq)
2028e22bee78STejun Heo {
2029e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2030e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2031e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2032f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2033e22bee78STejun Heo 	unsigned int cpu;
2034e22bee78STejun Heo 
2035e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2036e22bee78STejun Heo repeat:
2037e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
20381da177e4SLinus Torvalds 
20391da177e4SLinus Torvalds 	if (kthread_should_stop())
2040e22bee78STejun Heo 		return 0;
20411da177e4SLinus Torvalds 
2042f3421797STejun Heo 	/*
2043f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2044f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2045f3421797STejun Heo 	 */
2046f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2047f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2048f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2049bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2050bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2051e22bee78STejun Heo 		struct work_struct *work, *n;
2052e22bee78STejun Heo 
2053e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2054f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2055e22bee78STejun Heo 
2056e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2057bd7bdd43STejun Heo 		rescuer->pool = pool;
2058e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2059e22bee78STejun Heo 
2060e22bee78STejun Heo 		/*
2061e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2062e22bee78STejun Heo 		 * process'em.
2063e22bee78STejun Heo 		 */
2064e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2065bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2066e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2067e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2068e22bee78STejun Heo 
2069e22bee78STejun Heo 		process_scheduled_works(rescuer);
20707576958aSTejun Heo 
20717576958aSTejun Heo 		/*
20727576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
20737576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
20747576958aSTejun Heo 		 * and stalling the execution.
20757576958aSTejun Heo 		 */
207663d95a91STejun Heo 		if (keep_working(pool))
207763d95a91STejun Heo 			wake_up_worker(pool);
20787576958aSTejun Heo 
2079e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
20801da177e4SLinus Torvalds 	}
20811da177e4SLinus Torvalds 
2082e22bee78STejun Heo 	schedule();
2083e22bee78STejun Heo 	goto repeat;
20841da177e4SLinus Torvalds }
20851da177e4SLinus Torvalds 
2086fc2e4d70SOleg Nesterov struct wq_barrier {
2087fc2e4d70SOleg Nesterov 	struct work_struct	work;
2088fc2e4d70SOleg Nesterov 	struct completion	done;
2089fc2e4d70SOleg Nesterov };
2090fc2e4d70SOleg Nesterov 
2091fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2092fc2e4d70SOleg Nesterov {
2093fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2094fc2e4d70SOleg Nesterov 	complete(&barr->done);
2095fc2e4d70SOleg Nesterov }
2096fc2e4d70SOleg Nesterov 
20974690c4abSTejun Heo /**
20984690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
20994690c4abSTejun Heo  * @cwq: cwq to insert barrier into
21004690c4abSTejun Heo  * @barr: wq_barrier to insert
2101affee4b2STejun Heo  * @target: target work to attach @barr to
2102affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
21034690c4abSTejun Heo  *
2104affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2105affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2106affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2107affee4b2STejun Heo  * cpu.
2108affee4b2STejun Heo  *
2109affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2110affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2111affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2112affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2113affee4b2STejun Heo  * after a work with LINKED flag set.
2114affee4b2STejun Heo  *
2115affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2116affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
21174690c4abSTejun Heo  *
21184690c4abSTejun Heo  * CONTEXT:
21198b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
21204690c4abSTejun Heo  */
212183c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2122affee4b2STejun Heo 			      struct wq_barrier *barr,
2123affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2124fc2e4d70SOleg Nesterov {
2125affee4b2STejun Heo 	struct list_head *head;
2126affee4b2STejun Heo 	unsigned int linked = 0;
2127affee4b2STejun Heo 
2128dc186ad7SThomas Gleixner 	/*
21298b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2130dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2131dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2132dc186ad7SThomas Gleixner 	 * might deadlock.
2133dc186ad7SThomas Gleixner 	 */
2134ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
213522df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2136fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
213783c22520SOleg Nesterov 
2138affee4b2STejun Heo 	/*
2139affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2140affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2141affee4b2STejun Heo 	 */
2142affee4b2STejun Heo 	if (worker)
2143affee4b2STejun Heo 		head = worker->scheduled.next;
2144affee4b2STejun Heo 	else {
2145affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2146affee4b2STejun Heo 
2147affee4b2STejun Heo 		head = target->entry.next;
2148affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2149affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2150affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2151affee4b2STejun Heo 	}
2152affee4b2STejun Heo 
2153dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2154affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2155affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2156fc2e4d70SOleg Nesterov }
2157fc2e4d70SOleg Nesterov 
215873f53c4aSTejun Heo /**
215973f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
216073f53c4aSTejun Heo  * @wq: workqueue being flushed
216173f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
216273f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
216373f53c4aSTejun Heo  *
216473f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
216573f53c4aSTejun Heo  *
216673f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
216773f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
216873f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
216973f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
217073f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
217173f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
217273f53c4aSTejun Heo  *
217373f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
217473f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
217573f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
217673f53c4aSTejun Heo  * is returned.
217773f53c4aSTejun Heo  *
217873f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
217973f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
218073f53c4aSTejun Heo  * advanced to @work_color.
218173f53c4aSTejun Heo  *
218273f53c4aSTejun Heo  * CONTEXT:
218373f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
218473f53c4aSTejun Heo  *
218573f53c4aSTejun Heo  * RETURNS:
218673f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
218773f53c4aSTejun Heo  * otherwise.
218873f53c4aSTejun Heo  */
218973f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
219073f53c4aSTejun Heo 				      int flush_color, int work_color)
21911da177e4SLinus Torvalds {
219273f53c4aSTejun Heo 	bool wait = false;
219373f53c4aSTejun Heo 	unsigned int cpu;
21941da177e4SLinus Torvalds 
219573f53c4aSTejun Heo 	if (flush_color >= 0) {
219673f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
219773f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2198dc186ad7SThomas Gleixner 	}
219914441960SOleg Nesterov 
2200f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
220173f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2202bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
22031da177e4SLinus Torvalds 
22048b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
220573f53c4aSTejun Heo 
220673f53c4aSTejun Heo 		if (flush_color >= 0) {
220773f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
220873f53c4aSTejun Heo 
220973f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
221073f53c4aSTejun Heo 				cwq->flush_color = flush_color;
221173f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
221273f53c4aSTejun Heo 				wait = true;
22131da177e4SLinus Torvalds 			}
221473f53c4aSTejun Heo 		}
221573f53c4aSTejun Heo 
221673f53c4aSTejun Heo 		if (work_color >= 0) {
221773f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
221873f53c4aSTejun Heo 			cwq->work_color = work_color;
221973f53c4aSTejun Heo 		}
222073f53c4aSTejun Heo 
22218b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
22221da177e4SLinus Torvalds 	}
22231da177e4SLinus Torvalds 
222473f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
222573f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
222673f53c4aSTejun Heo 
222773f53c4aSTejun Heo 	return wait;
222883c22520SOleg Nesterov }
22291da177e4SLinus Torvalds 
22300fcb78c2SRolf Eike Beer /**
22311da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
22320fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
22331da177e4SLinus Torvalds  *
22341da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
22351da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
22361da177e4SLinus Torvalds  *
2237fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2238fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
22391da177e4SLinus Torvalds  */
22407ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
22411da177e4SLinus Torvalds {
224273f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
224373f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
224473f53c4aSTejun Heo 		.flush_color = -1,
224573f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
224673f53c4aSTejun Heo 	};
224773f53c4aSTejun Heo 	int next_color;
2248b1f4ec17SOleg Nesterov 
22493295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
22503295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
225173f53c4aSTejun Heo 
225273f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
225373f53c4aSTejun Heo 
225473f53c4aSTejun Heo 	/*
225573f53c4aSTejun Heo 	 * Start-to-wait phase
225673f53c4aSTejun Heo 	 */
225773f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
225873f53c4aSTejun Heo 
225973f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
226073f53c4aSTejun Heo 		/*
226173f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
226273f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
226373f53c4aSTejun Heo 		 * by one.
226473f53c4aSTejun Heo 		 */
226573f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
226673f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
226773f53c4aSTejun Heo 		wq->work_color = next_color;
226873f53c4aSTejun Heo 
226973f53c4aSTejun Heo 		if (!wq->first_flusher) {
227073f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
227173f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
227273f53c4aSTejun Heo 
227373f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
227473f53c4aSTejun Heo 
227573f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
227673f53c4aSTejun Heo 						       wq->work_color)) {
227773f53c4aSTejun Heo 				/* nothing to flush, done */
227873f53c4aSTejun Heo 				wq->flush_color = next_color;
227973f53c4aSTejun Heo 				wq->first_flusher = NULL;
228073f53c4aSTejun Heo 				goto out_unlock;
228173f53c4aSTejun Heo 			}
228273f53c4aSTejun Heo 		} else {
228373f53c4aSTejun Heo 			/* wait in queue */
228473f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
228573f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
228673f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
228773f53c4aSTejun Heo 		}
228873f53c4aSTejun Heo 	} else {
228973f53c4aSTejun Heo 		/*
229073f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
229173f53c4aSTejun Heo 		 * The next flush completion will assign us
229273f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
229373f53c4aSTejun Heo 		 */
229473f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
229573f53c4aSTejun Heo 	}
229673f53c4aSTejun Heo 
229773f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
229873f53c4aSTejun Heo 
229973f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
230073f53c4aSTejun Heo 
230173f53c4aSTejun Heo 	/*
230273f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
230373f53c4aSTejun Heo 	 *
230473f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
230573f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
230673f53c4aSTejun Heo 	 */
230773f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
230873f53c4aSTejun Heo 		return;
230973f53c4aSTejun Heo 
231073f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
231173f53c4aSTejun Heo 
23124ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
23134ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
23144ce48b37STejun Heo 		goto out_unlock;
23154ce48b37STejun Heo 
231673f53c4aSTejun Heo 	wq->first_flusher = NULL;
231773f53c4aSTejun Heo 
231873f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
231973f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
232073f53c4aSTejun Heo 
232173f53c4aSTejun Heo 	while (true) {
232273f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
232373f53c4aSTejun Heo 
232473f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
232573f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
232673f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
232773f53c4aSTejun Heo 				break;
232873f53c4aSTejun Heo 			list_del_init(&next->list);
232973f53c4aSTejun Heo 			complete(&next->done);
233073f53c4aSTejun Heo 		}
233173f53c4aSTejun Heo 
233273f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
233373f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
233473f53c4aSTejun Heo 
233573f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
233673f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
233773f53c4aSTejun Heo 
233873f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
233973f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
234073f53c4aSTejun Heo 			/*
234173f53c4aSTejun Heo 			 * Assign the same color to all overflowed
234273f53c4aSTejun Heo 			 * flushers, advance work_color and append to
234373f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
234473f53c4aSTejun Heo 			 * phase for these overflowed flushers.
234573f53c4aSTejun Heo 			 */
234673f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
234773f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
234873f53c4aSTejun Heo 
234973f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
235073f53c4aSTejun Heo 
235173f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
235273f53c4aSTejun Heo 					      &wq->flusher_queue);
235373f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
235473f53c4aSTejun Heo 		}
235573f53c4aSTejun Heo 
235673f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
235773f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
235873f53c4aSTejun Heo 			break;
235973f53c4aSTejun Heo 		}
236073f53c4aSTejun Heo 
236173f53c4aSTejun Heo 		/*
236273f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
236373f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
236473f53c4aSTejun Heo 		 */
236573f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
236673f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
236773f53c4aSTejun Heo 
236873f53c4aSTejun Heo 		list_del_init(&next->list);
236973f53c4aSTejun Heo 		wq->first_flusher = next;
237073f53c4aSTejun Heo 
237173f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
237273f53c4aSTejun Heo 			break;
237373f53c4aSTejun Heo 
237473f53c4aSTejun Heo 		/*
237573f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
237673f53c4aSTejun Heo 		 * flusher and repeat cascading.
237773f53c4aSTejun Heo 		 */
237873f53c4aSTejun Heo 		wq->first_flusher = NULL;
237973f53c4aSTejun Heo 	}
238073f53c4aSTejun Heo 
238173f53c4aSTejun Heo out_unlock:
238273f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
23831da177e4SLinus Torvalds }
2384ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
23851da177e4SLinus Torvalds 
23869c5a2ba7STejun Heo /**
23879c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
23889c5a2ba7STejun Heo  * @wq: workqueue to drain
23899c5a2ba7STejun Heo  *
23909c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
23919c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
23929c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
23939c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
23949c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
23959c5a2ba7STejun Heo  * takes too long.
23969c5a2ba7STejun Heo  */
23979c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
23989c5a2ba7STejun Heo {
23999c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
24009c5a2ba7STejun Heo 	unsigned int cpu;
24019c5a2ba7STejun Heo 
24029c5a2ba7STejun Heo 	/*
24039c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
24049c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
24059c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
24069c5a2ba7STejun Heo 	 */
24079c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24089c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
24099c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
24109c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24119c5a2ba7STejun Heo reflush:
24129c5a2ba7STejun Heo 	flush_workqueue(wq);
24139c5a2ba7STejun Heo 
24149c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
24159c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2416fa2563e4SThomas Tuttle 		bool drained;
24179c5a2ba7STejun Heo 
2418bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2419fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2420bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2421fa2563e4SThomas Tuttle 
2422fa2563e4SThomas Tuttle 		if (drained)
24239c5a2ba7STejun Heo 			continue;
24249c5a2ba7STejun Heo 
24259c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
24269c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
24279c5a2ba7STejun Heo 			pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
24289c5a2ba7STejun Heo 				   wq->name, flush_cnt);
24299c5a2ba7STejun Heo 		goto reflush;
24309c5a2ba7STejun Heo 	}
24319c5a2ba7STejun Heo 
24329c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24339c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
24349c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
24359c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24369c5a2ba7STejun Heo }
24379c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
24389c5a2ba7STejun Heo 
2439baf59022STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2440baf59022STejun Heo 			     bool wait_executing)
2441baf59022STejun Heo {
2442baf59022STejun Heo 	struct worker *worker = NULL;
2443baf59022STejun Heo 	struct global_cwq *gcwq;
2444baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2445baf59022STejun Heo 
2446baf59022STejun Heo 	might_sleep();
2447baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2448baf59022STejun Heo 	if (!gcwq)
2449baf59022STejun Heo 		return false;
2450baf59022STejun Heo 
2451baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2452baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2453baf59022STejun Heo 		/*
2454baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2455baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2456baf59022STejun Heo 		 * are not going to wait.
2457baf59022STejun Heo 		 */
2458baf59022STejun Heo 		smp_rmb();
2459baf59022STejun Heo 		cwq = get_work_cwq(work);
2460bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2461baf59022STejun Heo 			goto already_gone;
2462baf59022STejun Heo 	} else if (wait_executing) {
2463baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2464baf59022STejun Heo 		if (!worker)
2465baf59022STejun Heo 			goto already_gone;
2466baf59022STejun Heo 		cwq = worker->current_cwq;
2467baf59022STejun Heo 	} else
2468baf59022STejun Heo 		goto already_gone;
2469baf59022STejun Heo 
2470baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2471baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2472baf59022STejun Heo 
2473e159489bSTejun Heo 	/*
2474e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2475e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2476e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2477e159489bSTejun Heo 	 * access.
2478e159489bSTejun Heo 	 */
2479e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2480baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2481e159489bSTejun Heo 	else
2482e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2483baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2484e159489bSTejun Heo 
2485baf59022STejun Heo 	return true;
2486baf59022STejun Heo already_gone:
2487baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2488baf59022STejun Heo 	return false;
2489baf59022STejun Heo }
2490baf59022STejun Heo 
2491db700897SOleg Nesterov /**
2492401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2493401a8d04STejun Heo  * @work: the work to flush
2494db700897SOleg Nesterov  *
2495401a8d04STejun Heo  * Wait until @work has finished execution.  This function considers
2496401a8d04STejun Heo  * only the last queueing instance of @work.  If @work has been
2497401a8d04STejun Heo  * enqueued across different CPUs on a non-reentrant workqueue or on
2498401a8d04STejun Heo  * multiple workqueues, @work might still be executing on return on
2499401a8d04STejun Heo  * some of the CPUs from earlier queueing.
2500a67da70dSOleg Nesterov  *
2501401a8d04STejun Heo  * If @work was queued only on a non-reentrant, ordered or unbound
2502401a8d04STejun Heo  * workqueue, @work is guaranteed to be idle on return if it hasn't
2503401a8d04STejun Heo  * been requeued since flush started.
2504401a8d04STejun Heo  *
2505401a8d04STejun Heo  * RETURNS:
2506401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2507401a8d04STejun Heo  * %false if it was already idle.
2508db700897SOleg Nesterov  */
2509401a8d04STejun Heo bool flush_work(struct work_struct *work)
2510db700897SOleg Nesterov {
2511db700897SOleg Nesterov 	struct wq_barrier barr;
2512db700897SOleg Nesterov 
25130976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
25140976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
25150976dfc1SStephen Boyd 
2516baf59022STejun Heo 	if (start_flush_work(work, &barr, true)) {
2517db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2518dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2519401a8d04STejun Heo 		return true;
2520baf59022STejun Heo 	} else
2521401a8d04STejun Heo 		return false;
2522db700897SOleg Nesterov }
2523db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2524db700897SOleg Nesterov 
2525401a8d04STejun Heo static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2526401a8d04STejun Heo {
2527401a8d04STejun Heo 	struct wq_barrier barr;
2528401a8d04STejun Heo 	struct worker *worker;
2529401a8d04STejun Heo 
2530401a8d04STejun Heo 	spin_lock_irq(&gcwq->lock);
2531401a8d04STejun Heo 
2532401a8d04STejun Heo 	worker = find_worker_executing_work(gcwq, work);
2533401a8d04STejun Heo 	if (unlikely(worker))
2534401a8d04STejun Heo 		insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2535401a8d04STejun Heo 
2536401a8d04STejun Heo 	spin_unlock_irq(&gcwq->lock);
2537401a8d04STejun Heo 
2538401a8d04STejun Heo 	if (unlikely(worker)) {
2539401a8d04STejun Heo 		wait_for_completion(&barr.done);
2540401a8d04STejun Heo 		destroy_work_on_stack(&barr.work);
2541401a8d04STejun Heo 		return true;
2542401a8d04STejun Heo 	} else
2543401a8d04STejun Heo 		return false;
2544401a8d04STejun Heo }
2545401a8d04STejun Heo 
2546401a8d04STejun Heo static bool wait_on_work(struct work_struct *work)
2547401a8d04STejun Heo {
2548401a8d04STejun Heo 	bool ret = false;
2549401a8d04STejun Heo 	int cpu;
2550401a8d04STejun Heo 
2551401a8d04STejun Heo 	might_sleep();
2552401a8d04STejun Heo 
2553401a8d04STejun Heo 	lock_map_acquire(&work->lockdep_map);
2554401a8d04STejun Heo 	lock_map_release(&work->lockdep_map);
2555401a8d04STejun Heo 
2556401a8d04STejun Heo 	for_each_gcwq_cpu(cpu)
2557401a8d04STejun Heo 		ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2558401a8d04STejun Heo 	return ret;
2559401a8d04STejun Heo }
2560401a8d04STejun Heo 
256109383498STejun Heo /**
256209383498STejun Heo  * flush_work_sync - wait until a work has finished execution
256309383498STejun Heo  * @work: the work to flush
256409383498STejun Heo  *
256509383498STejun Heo  * Wait until @work has finished execution.  On return, it's
256609383498STejun Heo  * guaranteed that all queueing instances of @work which happened
256709383498STejun Heo  * before this function is called are finished.  In other words, if
256809383498STejun Heo  * @work hasn't been requeued since this function was called, @work is
256909383498STejun Heo  * guaranteed to be idle on return.
257009383498STejun Heo  *
257109383498STejun Heo  * RETURNS:
257209383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
257309383498STejun Heo  * %false if it was already idle.
257409383498STejun Heo  */
257509383498STejun Heo bool flush_work_sync(struct work_struct *work)
257609383498STejun Heo {
257709383498STejun Heo 	struct wq_barrier barr;
257809383498STejun Heo 	bool pending, waited;
257909383498STejun Heo 
258009383498STejun Heo 	/* we'll wait for executions separately, queue barr only if pending */
258109383498STejun Heo 	pending = start_flush_work(work, &barr, false);
258209383498STejun Heo 
258309383498STejun Heo 	/* wait for executions to finish */
258409383498STejun Heo 	waited = wait_on_work(work);
258509383498STejun Heo 
258609383498STejun Heo 	/* wait for the pending one */
258709383498STejun Heo 	if (pending) {
258809383498STejun Heo 		wait_for_completion(&barr.done);
258909383498STejun Heo 		destroy_work_on_stack(&barr.work);
259009383498STejun Heo 	}
259109383498STejun Heo 
259209383498STejun Heo 	return pending || waited;
259309383498STejun Heo }
259409383498STejun Heo EXPORT_SYMBOL_GPL(flush_work_sync);
259509383498STejun Heo 
25966e84d644SOleg Nesterov /*
25971f1f642eSOleg Nesterov  * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
25986e84d644SOleg Nesterov  * so this work can't be re-armed in any way.
25996e84d644SOleg Nesterov  */
26006e84d644SOleg Nesterov static int try_to_grab_pending(struct work_struct *work)
26016e84d644SOleg Nesterov {
26028b03ae3cSTejun Heo 	struct global_cwq *gcwq;
26031f1f642eSOleg Nesterov 	int ret = -1;
26046e84d644SOleg Nesterov 
260522df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
26061f1f642eSOleg Nesterov 		return 0;
26076e84d644SOleg Nesterov 
26086e84d644SOleg Nesterov 	/*
26096e84d644SOleg Nesterov 	 * The queueing is in progress, or it is already queued. Try to
26106e84d644SOleg Nesterov 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
26116e84d644SOleg Nesterov 	 */
26127a22ad75STejun Heo 	gcwq = get_work_gcwq(work);
26137a22ad75STejun Heo 	if (!gcwq)
26146e84d644SOleg Nesterov 		return ret;
26156e84d644SOleg Nesterov 
26168b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
26176e84d644SOleg Nesterov 	if (!list_empty(&work->entry)) {
26186e84d644SOleg Nesterov 		/*
26197a22ad75STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
26206e84d644SOleg Nesterov 		 * In that case we must see the new value after rmb(), see
26216e84d644SOleg Nesterov 		 * insert_work()->wmb().
26226e84d644SOleg Nesterov 		 */
26236e84d644SOleg Nesterov 		smp_rmb();
26247a22ad75STejun Heo 		if (gcwq == get_work_gcwq(work)) {
2625dc186ad7SThomas Gleixner 			debug_work_deactivate(work);
26266e84d644SOleg Nesterov 			list_del_init(&work->entry);
26277a22ad75STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
26288a2e8e5dSTejun Heo 				get_work_color(work),
26298a2e8e5dSTejun Heo 				*work_data_bits(work) & WORK_STRUCT_DELAYED);
26306e84d644SOleg Nesterov 			ret = 1;
26316e84d644SOleg Nesterov 		}
26326e84d644SOleg Nesterov 	}
26338b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
26346e84d644SOleg Nesterov 
26356e84d644SOleg Nesterov 	return ret;
26366e84d644SOleg Nesterov }
26376e84d644SOleg Nesterov 
2638401a8d04STejun Heo static bool __cancel_work_timer(struct work_struct *work,
26391f1f642eSOleg Nesterov 				struct timer_list* timer)
26401f1f642eSOleg Nesterov {
26411f1f642eSOleg Nesterov 	int ret;
26421f1f642eSOleg Nesterov 
26431f1f642eSOleg Nesterov 	do {
26441f1f642eSOleg Nesterov 		ret = (timer && likely(del_timer(timer)));
26451f1f642eSOleg Nesterov 		if (!ret)
26461f1f642eSOleg Nesterov 			ret = try_to_grab_pending(work);
26471f1f642eSOleg Nesterov 		wait_on_work(work);
26481f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
26491f1f642eSOleg Nesterov 
26507a22ad75STejun Heo 	clear_work_data(work);
26511f1f642eSOleg Nesterov 	return ret;
26521f1f642eSOleg Nesterov }
26531f1f642eSOleg Nesterov 
26546e84d644SOleg Nesterov /**
2655401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2656401a8d04STejun Heo  * @work: the work to cancel
26576e84d644SOleg Nesterov  *
2658401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2659401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2660401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2661401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
26621f1f642eSOleg Nesterov  *
2663401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2664401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
26656e84d644SOleg Nesterov  *
2666401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
26676e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2668401a8d04STejun Heo  *
2669401a8d04STejun Heo  * RETURNS:
2670401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
26716e84d644SOleg Nesterov  */
2672401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
26736e84d644SOleg Nesterov {
26741f1f642eSOleg Nesterov 	return __cancel_work_timer(work, NULL);
2675b89deed3SOleg Nesterov }
267628e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2677b89deed3SOleg Nesterov 
26786e84d644SOleg Nesterov /**
2679401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2680401a8d04STejun Heo  * @dwork: the delayed work to flush
26816e84d644SOleg Nesterov  *
2682401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2683401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2684401a8d04STejun Heo  * considers the last queueing instance of @dwork.
26851f1f642eSOleg Nesterov  *
2686401a8d04STejun Heo  * RETURNS:
2687401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2688401a8d04STejun Heo  * %false if it was already idle.
26896e84d644SOleg Nesterov  */
2690401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2691401a8d04STejun Heo {
2692401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
2693401a8d04STejun Heo 		__queue_work(raw_smp_processor_id(),
2694401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
2695401a8d04STejun Heo 	return flush_work(&dwork->work);
2696401a8d04STejun Heo }
2697401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2698401a8d04STejun Heo 
2699401a8d04STejun Heo /**
270009383498STejun Heo  * flush_delayed_work_sync - wait for a dwork to finish
270109383498STejun Heo  * @dwork: the delayed work to flush
270209383498STejun Heo  *
270309383498STejun Heo  * Delayed timer is cancelled and the pending work is queued for
270409383498STejun Heo  * execution immediately.  Other than timer handling, its behavior
270509383498STejun Heo  * is identical to flush_work_sync().
270609383498STejun Heo  *
270709383498STejun Heo  * RETURNS:
270809383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
270909383498STejun Heo  * %false if it was already idle.
271009383498STejun Heo  */
271109383498STejun Heo bool flush_delayed_work_sync(struct delayed_work *dwork)
271209383498STejun Heo {
271309383498STejun Heo 	if (del_timer_sync(&dwork->timer))
271409383498STejun Heo 		__queue_work(raw_smp_processor_id(),
271509383498STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
271609383498STejun Heo 	return flush_work_sync(&dwork->work);
271709383498STejun Heo }
271809383498STejun Heo EXPORT_SYMBOL(flush_delayed_work_sync);
271909383498STejun Heo 
272009383498STejun Heo /**
2721401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2722401a8d04STejun Heo  * @dwork: the delayed work cancel
2723401a8d04STejun Heo  *
2724401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2725401a8d04STejun Heo  *
2726401a8d04STejun Heo  * RETURNS:
2727401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2728401a8d04STejun Heo  */
2729401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
27306e84d644SOleg Nesterov {
27311f1f642eSOleg Nesterov 	return __cancel_work_timer(&dwork->work, &dwork->timer);
27326e84d644SOleg Nesterov }
2733f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
27341da177e4SLinus Torvalds 
27350fcb78c2SRolf Eike Beer /**
27360fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
27370fcb78c2SRolf Eike Beer  * @work: job to be done
27380fcb78c2SRolf Eike Beer  *
27395b0f437dSBart Van Assche  * Returns zero if @work was already on the kernel-global workqueue and
27405b0f437dSBart Van Assche  * non-zero otherwise.
27415b0f437dSBart Van Assche  *
27425b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
27435b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
27445b0f437dSBart Van Assche  * workqueue otherwise.
27450fcb78c2SRolf Eike Beer  */
27467ad5b3a5SHarvey Harrison int schedule_work(struct work_struct *work)
27471da177e4SLinus Torvalds {
2748d320c038STejun Heo 	return queue_work(system_wq, work);
27491da177e4SLinus Torvalds }
2750ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
27511da177e4SLinus Torvalds 
2752c1a220e7SZhang Rui /*
2753c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2754c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2755c1a220e7SZhang Rui  * @work: job to be done
2756c1a220e7SZhang Rui  *
2757c1a220e7SZhang Rui  * This puts a job on a specific cpu
2758c1a220e7SZhang Rui  */
2759c1a220e7SZhang Rui int schedule_work_on(int cpu, struct work_struct *work)
2760c1a220e7SZhang Rui {
2761d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2762c1a220e7SZhang Rui }
2763c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2764c1a220e7SZhang Rui 
27650fcb78c2SRolf Eike Beer /**
27660fcb78c2SRolf Eike Beer  * schedule_delayed_work - put work task in global workqueue after delay
276752bad64dSDavid Howells  * @dwork: job to be done
276852bad64dSDavid Howells  * @delay: number of jiffies to wait or 0 for immediate execution
27690fcb78c2SRolf Eike Beer  *
27700fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
27710fcb78c2SRolf Eike Beer  * workqueue.
27720fcb78c2SRolf Eike Beer  */
27737ad5b3a5SHarvey Harrison int schedule_delayed_work(struct delayed_work *dwork,
277482f67cd9SIngo Molnar 					unsigned long delay)
27751da177e4SLinus Torvalds {
2776d320c038STejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
27771da177e4SLinus Torvalds }
2778ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work);
27791da177e4SLinus Torvalds 
27800fcb78c2SRolf Eike Beer /**
27810fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
27820fcb78c2SRolf Eike Beer  * @cpu: cpu to use
278352bad64dSDavid Howells  * @dwork: job to be done
27840fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
27850fcb78c2SRolf Eike Beer  *
27860fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
27870fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
27880fcb78c2SRolf Eike Beer  */
27891da177e4SLinus Torvalds int schedule_delayed_work_on(int cpu,
279052bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
27911da177e4SLinus Torvalds {
2792d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
27931da177e4SLinus Torvalds }
2794ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
27951da177e4SLinus Torvalds 
2796b6136773SAndrew Morton /**
279731ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
2798b6136773SAndrew Morton  * @func: the function to call
2799b6136773SAndrew Morton  *
280031ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
280131ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
2802b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
280331ddd871STejun Heo  *
280431ddd871STejun Heo  * RETURNS:
280531ddd871STejun Heo  * 0 on success, -errno on failure.
2806b6136773SAndrew Morton  */
280765f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
280815316ba8SChristoph Lameter {
280915316ba8SChristoph Lameter 	int cpu;
281038f51568SNamhyung Kim 	struct work_struct __percpu *works;
281115316ba8SChristoph Lameter 
2812b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
2813b6136773SAndrew Morton 	if (!works)
281415316ba8SChristoph Lameter 		return -ENOMEM;
2815b6136773SAndrew Morton 
281695402b38SGautham R Shenoy 	get_online_cpus();
281793981800STejun Heo 
281815316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
28199bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
28209bfb1839SIngo Molnar 
28219bfb1839SIngo Molnar 		INIT_WORK(work, func);
28228de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
282315316ba8SChristoph Lameter 	}
282493981800STejun Heo 
282593981800STejun Heo 	for_each_online_cpu(cpu)
28268616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
282793981800STejun Heo 
282895402b38SGautham R Shenoy 	put_online_cpus();
2829b6136773SAndrew Morton 	free_percpu(works);
283015316ba8SChristoph Lameter 	return 0;
283115316ba8SChristoph Lameter }
283215316ba8SChristoph Lameter 
2833eef6a7d5SAlan Stern /**
2834eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
2835eef6a7d5SAlan Stern  *
2836eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
2837eef6a7d5SAlan Stern  * completion.
2838eef6a7d5SAlan Stern  *
2839eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
2840eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
2841eef6a7d5SAlan Stern  * will lead to deadlock:
2842eef6a7d5SAlan Stern  *
2843eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
2844eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
2845eef6a7d5SAlan Stern  *
2846eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
2847eef6a7d5SAlan Stern  *
2848eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
2849eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
2850eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
2851eef6a7d5SAlan Stern  *
2852eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
2853eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
2854eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
2855eef6a7d5SAlan Stern  * cancel_work_sync() instead.
2856eef6a7d5SAlan Stern  */
28571da177e4SLinus Torvalds void flush_scheduled_work(void)
28581da177e4SLinus Torvalds {
2859d320c038STejun Heo 	flush_workqueue(system_wq);
28601da177e4SLinus Torvalds }
2861ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
28621da177e4SLinus Torvalds 
28631da177e4SLinus Torvalds /**
28641fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
28651fa44ecaSJames Bottomley  * @fn:		the function to execute
28661fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
28671fa44ecaSJames Bottomley  *		be available when the work executes)
28681fa44ecaSJames Bottomley  *
28691fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
28701fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
28711fa44ecaSJames Bottomley  *
28721fa44ecaSJames Bottomley  * Returns:	0 - function was executed
28731fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
28741fa44ecaSJames Bottomley  */
287565f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
28761fa44ecaSJames Bottomley {
28771fa44ecaSJames Bottomley 	if (!in_interrupt()) {
287865f27f38SDavid Howells 		fn(&ew->work);
28791fa44ecaSJames Bottomley 		return 0;
28801fa44ecaSJames Bottomley 	}
28811fa44ecaSJames Bottomley 
288265f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
28831fa44ecaSJames Bottomley 	schedule_work(&ew->work);
28841fa44ecaSJames Bottomley 
28851fa44ecaSJames Bottomley 	return 1;
28861fa44ecaSJames Bottomley }
28871fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
28881fa44ecaSJames Bottomley 
28891da177e4SLinus Torvalds int keventd_up(void)
28901da177e4SLinus Torvalds {
2891d320c038STejun Heo 	return system_wq != NULL;
28921da177e4SLinus Torvalds }
28931da177e4SLinus Torvalds 
2894bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
28951da177e4SLinus Torvalds {
28963af24433SOleg Nesterov 	/*
28970f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
28980f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
28990f900049STejun Heo 	 * unsigned long long.
29003af24433SOleg Nesterov 	 */
29010f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
29020f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
29030f900049STejun Heo 				   __alignof__(unsigned long long));
29043af24433SOleg Nesterov 
2905e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2906f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2907931ac77eSTejun Heo 	else {
29080f900049STejun Heo 		void *ptr;
2909e1d8aa9fSFrederic Weisbecker 
29100f900049STejun Heo 		/*
2911f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
2912f3421797STejun Heo 		 * pointer at the end pointing back to the originally
2913f3421797STejun Heo 		 * allocated pointer which will be used for free.
29140f900049STejun Heo 		 */
2915bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2916bdbc5dd7STejun Heo 		if (ptr) {
2917bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2918bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
2919bdbc5dd7STejun Heo 		}
29203af24433SOleg Nesterov 	}
29213af24433SOleg Nesterov 
29220415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
2923bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2924bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
29250f900049STejun Heo }
29260f900049STejun Heo 
2927bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
292806ba38a9SOleg Nesterov {
2929e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2930bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
2931f3421797STejun Heo 	else if (wq->cpu_wq.single) {
2932f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
2933f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
293406ba38a9SOleg Nesterov 	}
293506ba38a9SOleg Nesterov }
293606ba38a9SOleg Nesterov 
2937f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
2938f3421797STejun Heo 			       const char *name)
2939b71ab8c2STejun Heo {
2940f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2941f3421797STejun Heo 
2942f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
2943b71ab8c2STejun Heo 		printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2944b71ab8c2STejun Heo 		       "is out of range, clamping between %d and %d\n",
2945f3421797STejun Heo 		       max_active, name, 1, lim);
2946b71ab8c2STejun Heo 
2947f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
2948b71ab8c2STejun Heo }
2949b71ab8c2STejun Heo 
2950b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
295197e37d7bSTejun Heo 					       unsigned int flags,
29521e19ffc6STejun Heo 					       int max_active,
2953eb13ba87SJohannes Berg 					       struct lock_class_key *key,
2954b196be89STejun Heo 					       const char *lock_name, ...)
29553af24433SOleg Nesterov {
2956b196be89STejun Heo 	va_list args, args1;
29573af24433SOleg Nesterov 	struct workqueue_struct *wq;
2958c34056a3STejun Heo 	unsigned int cpu;
2959b196be89STejun Heo 	size_t namelen;
2960b196be89STejun Heo 
2961b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
2962b196be89STejun Heo 	va_start(args, lock_name);
2963b196be89STejun Heo 	va_copy(args1, args);
2964b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
2965b196be89STejun Heo 
2966b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
2967b196be89STejun Heo 	if (!wq)
2968b196be89STejun Heo 		goto err;
2969b196be89STejun Heo 
2970b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
2971b196be89STejun Heo 	va_end(args);
2972b196be89STejun Heo 	va_end(args1);
29733af24433SOleg Nesterov 
2974f3421797STejun Heo 	/*
29756370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
29766370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
29776370a6adSTejun Heo 	 */
29786370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
29796370a6adSTejun Heo 		flags |= WQ_RESCUER;
29806370a6adSTejun Heo 
2981d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
2982b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
29833af24433SOleg Nesterov 
2984b196be89STejun Heo 	/* init wq */
298597e37d7bSTejun Heo 	wq->flags = flags;
2986a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
298773f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
298873f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
298973f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
299073f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
29913af24433SOleg Nesterov 
2992eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
2993cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
29943af24433SOleg Nesterov 
2995bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
2996bdbc5dd7STejun Heo 		goto err;
2997bdbc5dd7STejun Heo 
2998f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
29991537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
30008b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
30013270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
30021537663fSTejun Heo 
30030f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
30043270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3005c34056a3STejun Heo 		cwq->wq = wq;
300673f53c4aSTejun Heo 		cwq->flush_color = -1;
30071e19ffc6STejun Heo 		cwq->max_active = max_active;
30081e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3009e22bee78STejun Heo 	}
30101537663fSTejun Heo 
3011e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3012e22bee78STejun Heo 		struct worker *rescuer;
3013e22bee78STejun Heo 
3014f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3015e22bee78STejun Heo 			goto err;
3016e22bee78STejun Heo 
3017e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3018e22bee78STejun Heo 		if (!rescuer)
3019e22bee78STejun Heo 			goto err;
3020e22bee78STejun Heo 
3021b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3022b196be89STejun Heo 					       wq->name);
3023e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3024e22bee78STejun Heo 			goto err;
3025e22bee78STejun Heo 
3026e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3027e22bee78STejun Heo 		wake_up_process(rescuer->task);
30283af24433SOleg Nesterov 	}
30291537663fSTejun Heo 
30303af24433SOleg Nesterov 	/*
3031a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3032a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3033a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
30343af24433SOleg Nesterov 	 */
30353af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3036a0a1a5fdSTejun Heo 
303758a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3038f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3039a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3040a0a1a5fdSTejun Heo 
30413af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3042a0a1a5fdSTejun Heo 
30433af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
30443af24433SOleg Nesterov 
30453af24433SOleg Nesterov 	return wq;
30464690c4abSTejun Heo err:
30474690c4abSTejun Heo 	if (wq) {
3048bdbc5dd7STejun Heo 		free_cwqs(wq);
3049f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3050e22bee78STejun Heo 		kfree(wq->rescuer);
30514690c4abSTejun Heo 		kfree(wq);
30523af24433SOleg Nesterov 	}
30534690c4abSTejun Heo 	return NULL;
30541da177e4SLinus Torvalds }
3055d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
30561da177e4SLinus Torvalds 
30573af24433SOleg Nesterov /**
30583af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
30593af24433SOleg Nesterov  * @wq: target workqueue
30603af24433SOleg Nesterov  *
30613af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
30623af24433SOleg Nesterov  */
30633af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
30643af24433SOleg Nesterov {
3065c8e55f36STejun Heo 	unsigned int cpu;
30663af24433SOleg Nesterov 
30679c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
30689c5a2ba7STejun Heo 	drain_workqueue(wq);
3069c8efcc25STejun Heo 
3070a0a1a5fdSTejun Heo 	/*
3071a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3072a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3073a0a1a5fdSTejun Heo 	 */
307495402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
30753af24433SOleg Nesterov 	list_del(&wq->list);
307695402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
30773af24433SOleg Nesterov 
3078e22bee78STejun Heo 	/* sanity check */
3079f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
308073f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
308173f53c4aSTejun Heo 		int i;
30823af24433SOleg Nesterov 
308373f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
308473f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
30851e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
30861e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
308773f53c4aSTejun Heo 	}
30881537663fSTejun Heo 
3089e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3090e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3091f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
30928d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3093e22bee78STejun Heo 	}
3094e22bee78STejun Heo 
3095bdbc5dd7STejun Heo 	free_cwqs(wq);
30963af24433SOleg Nesterov 	kfree(wq);
30973af24433SOleg Nesterov }
30983af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
30993af24433SOleg Nesterov 
3100dcd989cbSTejun Heo /**
3101dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3102dcd989cbSTejun Heo  * @wq: target workqueue
3103dcd989cbSTejun Heo  * @max_active: new max_active value.
3104dcd989cbSTejun Heo  *
3105dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3106dcd989cbSTejun Heo  *
3107dcd989cbSTejun Heo  * CONTEXT:
3108dcd989cbSTejun Heo  * Don't call from IRQ context.
3109dcd989cbSTejun Heo  */
3110dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3111dcd989cbSTejun Heo {
3112dcd989cbSTejun Heo 	unsigned int cpu;
3113dcd989cbSTejun Heo 
3114f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3115dcd989cbSTejun Heo 
3116dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3117dcd989cbSTejun Heo 
3118dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3119dcd989cbSTejun Heo 
3120f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3121dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3122dcd989cbSTejun Heo 
3123dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3124dcd989cbSTejun Heo 
312558a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3126dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3127dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3128dcd989cbSTejun Heo 
3129dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3130dcd989cbSTejun Heo 	}
3131dcd989cbSTejun Heo 
3132dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3133dcd989cbSTejun Heo }
3134dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3135dcd989cbSTejun Heo 
3136dcd989cbSTejun Heo /**
3137dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3138dcd989cbSTejun Heo  * @cpu: CPU in question
3139dcd989cbSTejun Heo  * @wq: target workqueue
3140dcd989cbSTejun Heo  *
3141dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3142dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3143dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3144dcd989cbSTejun Heo  *
3145dcd989cbSTejun Heo  * RETURNS:
3146dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3147dcd989cbSTejun Heo  */
3148dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3149dcd989cbSTejun Heo {
3150dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3151dcd989cbSTejun Heo 
3152dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3153dcd989cbSTejun Heo }
3154dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3155dcd989cbSTejun Heo 
3156dcd989cbSTejun Heo /**
3157dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3158dcd989cbSTejun Heo  * @work: the work of interest
3159dcd989cbSTejun Heo  *
3160dcd989cbSTejun Heo  * RETURNS:
3161bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3162dcd989cbSTejun Heo  */
3163dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3164dcd989cbSTejun Heo {
3165dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3166dcd989cbSTejun Heo 
3167bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3168dcd989cbSTejun Heo }
3169dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3170dcd989cbSTejun Heo 
3171dcd989cbSTejun Heo /**
3172dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3173dcd989cbSTejun Heo  * @work: the work to be tested
3174dcd989cbSTejun Heo  *
3175dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3176dcd989cbSTejun Heo  * synchronization around this function and the test result is
3177dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3178dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3179dcd989cbSTejun Heo  * running state.
3180dcd989cbSTejun Heo  *
3181dcd989cbSTejun Heo  * RETURNS:
3182dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3183dcd989cbSTejun Heo  */
3184dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3185dcd989cbSTejun Heo {
3186dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3187dcd989cbSTejun Heo 	unsigned long flags;
3188dcd989cbSTejun Heo 	unsigned int ret = 0;
3189dcd989cbSTejun Heo 
3190dcd989cbSTejun Heo 	if (!gcwq)
3191dcd989cbSTejun Heo 		return false;
3192dcd989cbSTejun Heo 
3193dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3194dcd989cbSTejun Heo 
3195dcd989cbSTejun Heo 	if (work_pending(work))
3196dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3197dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3198dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3199dcd989cbSTejun Heo 
3200dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3201dcd989cbSTejun Heo 
3202dcd989cbSTejun Heo 	return ret;
3203dcd989cbSTejun Heo }
3204dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3205dcd989cbSTejun Heo 
3206db7bccf4STejun Heo /*
3207db7bccf4STejun Heo  * CPU hotplug.
3208db7bccf4STejun Heo  *
3209e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3210e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3211e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3212e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3213e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3214e22bee78STejun Heo  * blocked draining impractical.
3215e22bee78STejun Heo  *
3216*403c821dSTejun Heo  * This is solved by allowing a gcwq to be detached from CPU, running it
3217*403c821dSTejun Heo  * with unbound workers and allowing it to be reattached later if the cpu
3218*403c821dSTejun Heo  * comes back online.  A separate thread is created to govern a gcwq in
3219*403c821dSTejun Heo  * such state and is called the trustee of the gcwq.
3220db7bccf4STejun Heo  *
3221db7bccf4STejun Heo  * Trustee states and their descriptions.
3222db7bccf4STejun Heo  *
3223db7bccf4STejun Heo  * START	Command state used on startup.  On CPU_DOWN_PREPARE, a
3224db7bccf4STejun Heo  *		new trustee is started with this state.
3225db7bccf4STejun Heo  *
3226db7bccf4STejun Heo  * IN_CHARGE	Once started, trustee will enter this state after
3227e22bee78STejun Heo  *		assuming the manager role and making all existing
3228e22bee78STejun Heo  *		workers rogue.  DOWN_PREPARE waits for trustee to
3229e22bee78STejun Heo  *		enter this state.  After reaching IN_CHARGE, trustee
3230e22bee78STejun Heo  *		tries to execute the pending worklist until it's empty
3231e22bee78STejun Heo  *		and the state is set to BUTCHER, or the state is set
3232e22bee78STejun Heo  *		to RELEASE.
3233db7bccf4STejun Heo  *
3234db7bccf4STejun Heo  * BUTCHER	Command state which is set by the cpu callback after
3235db7bccf4STejun Heo  *		the cpu has went down.  Once this state is set trustee
3236db7bccf4STejun Heo  *		knows that there will be no new works on the worklist
3237db7bccf4STejun Heo  *		and once the worklist is empty it can proceed to
3238db7bccf4STejun Heo  *		killing idle workers.
3239db7bccf4STejun Heo  *
3240db7bccf4STejun Heo  * RELEASE	Command state which is set by the cpu callback if the
3241db7bccf4STejun Heo  *		cpu down has been canceled or it has come online
3242db7bccf4STejun Heo  *		again.  After recognizing this state, trustee stops
3243e22bee78STejun Heo  *		trying to drain or butcher and clears ROGUE, rebinds
3244e22bee78STejun Heo  *		all remaining workers back to the cpu and releases
3245e22bee78STejun Heo  *		manager role.
3246db7bccf4STejun Heo  *
3247db7bccf4STejun Heo  * DONE		Trustee will enter this state after BUTCHER or RELEASE
3248db7bccf4STejun Heo  *		is complete.
3249db7bccf4STejun Heo  *
3250db7bccf4STejun Heo  *          trustee                 CPU                draining
3251db7bccf4STejun Heo  *         took over                down               complete
3252db7bccf4STejun Heo  * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3253db7bccf4STejun Heo  *                        |                     |                  ^
3254db7bccf4STejun Heo  *                        | CPU is back online  v   return workers |
3255db7bccf4STejun Heo  *                         ----------------> RELEASE --------------
3256db7bccf4STejun Heo  */
3257db7bccf4STejun Heo 
3258db7bccf4STejun Heo /**
3259db7bccf4STejun Heo  * trustee_wait_event_timeout - timed event wait for trustee
3260db7bccf4STejun Heo  * @cond: condition to wait for
3261db7bccf4STejun Heo  * @timeout: timeout in jiffies
3262db7bccf4STejun Heo  *
3263db7bccf4STejun Heo  * wait_event_timeout() for trustee to use.  Handles locking and
3264db7bccf4STejun Heo  * checks for RELEASE request.
3265db7bccf4STejun Heo  *
3266db7bccf4STejun Heo  * CONTEXT:
3267db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3268db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3269db7bccf4STejun Heo  *
3270db7bccf4STejun Heo  * RETURNS:
3271db7bccf4STejun Heo  * Positive indicating left time if @cond is satisfied, 0 if timed
3272db7bccf4STejun Heo  * out, -1 if canceled.
3273db7bccf4STejun Heo  */
3274db7bccf4STejun Heo #define trustee_wait_event_timeout(cond, timeout) ({			\
3275db7bccf4STejun Heo 	long __ret = (timeout);						\
3276db7bccf4STejun Heo 	while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) &&	\
3277db7bccf4STejun Heo 	       __ret) {							\
3278db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);				\
3279db7bccf4STejun Heo 		__wait_event_timeout(gcwq->trustee_wait, (cond) ||	\
3280db7bccf4STejun Heo 			(gcwq->trustee_state == TRUSTEE_RELEASE),	\
3281db7bccf4STejun Heo 			__ret);						\
3282db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);				\
3283db7bccf4STejun Heo 	}								\
3284db7bccf4STejun Heo 	gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret);		\
3285db7bccf4STejun Heo })
3286db7bccf4STejun Heo 
3287db7bccf4STejun Heo /**
3288db7bccf4STejun Heo  * trustee_wait_event - event wait for trustee
3289db7bccf4STejun Heo  * @cond: condition to wait for
3290db7bccf4STejun Heo  *
3291db7bccf4STejun Heo  * wait_event() for trustee to use.  Automatically handles locking and
3292db7bccf4STejun Heo  * checks for CANCEL request.
3293db7bccf4STejun Heo  *
3294db7bccf4STejun Heo  * CONTEXT:
3295db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3296db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3297db7bccf4STejun Heo  *
3298db7bccf4STejun Heo  * RETURNS:
3299db7bccf4STejun Heo  * 0 if @cond is satisfied, -1 if canceled.
3300db7bccf4STejun Heo  */
3301db7bccf4STejun Heo #define trustee_wait_event(cond) ({					\
3302db7bccf4STejun Heo 	long __ret1;							\
3303db7bccf4STejun Heo 	__ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3304db7bccf4STejun Heo 	__ret1 < 0 ? -1 : 0;						\
3305db7bccf4STejun Heo })
3306db7bccf4STejun Heo 
33074ce62e9eSTejun Heo static bool gcwq_is_managing_workers(struct global_cwq *gcwq)
33084ce62e9eSTejun Heo {
33094ce62e9eSTejun Heo 	struct worker_pool *pool;
33104ce62e9eSTejun Heo 
33114ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
33124ce62e9eSTejun Heo 		if (pool->flags & POOL_MANAGING_WORKERS)
33134ce62e9eSTejun Heo 			return true;
33144ce62e9eSTejun Heo 	return false;
33154ce62e9eSTejun Heo }
33164ce62e9eSTejun Heo 
33174ce62e9eSTejun Heo static bool gcwq_has_idle_workers(struct global_cwq *gcwq)
33184ce62e9eSTejun Heo {
33194ce62e9eSTejun Heo 	struct worker_pool *pool;
33204ce62e9eSTejun Heo 
33214ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
33224ce62e9eSTejun Heo 		if (!list_empty(&pool->idle_list))
33234ce62e9eSTejun Heo 			return true;
33244ce62e9eSTejun Heo 	return false;
33254ce62e9eSTejun Heo }
33264ce62e9eSTejun Heo 
3327db7bccf4STejun Heo static int __cpuinit trustee_thread(void *__gcwq)
3328db7bccf4STejun Heo {
3329db7bccf4STejun Heo 	struct global_cwq *gcwq = __gcwq;
33304ce62e9eSTejun Heo 	struct worker_pool *pool;
3331db7bccf4STejun Heo 	struct worker *worker;
3332e22bee78STejun Heo 	struct work_struct *work;
3333db7bccf4STejun Heo 	struct hlist_node *pos;
3334e22bee78STejun Heo 	long rc;
3335db7bccf4STejun Heo 	int i;
3336db7bccf4STejun Heo 
3337db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3338db7bccf4STejun Heo 
3339db7bccf4STejun Heo 	spin_lock_irq(&gcwq->lock);
3340db7bccf4STejun Heo 	/*
3341e22bee78STejun Heo 	 * Claim the manager position and make all workers rogue.
3342e22bee78STejun Heo 	 * Trustee must be bound to the target cpu and can't be
3343e22bee78STejun Heo 	 * cancelled.
3344db7bccf4STejun Heo 	 */
3345db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
33464ce62e9eSTejun Heo 	rc = trustee_wait_event(!gcwq_is_managing_workers(gcwq));
3347e22bee78STejun Heo 	BUG_ON(rc < 0);
3348e22bee78STejun Heo 
3349f2d5a0eeSTejun Heo 	/*
3350f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3351f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3352f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3353f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3354f2d5a0eeSTejun Heo 	 */
33554ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq) {
33564ce62e9eSTejun Heo 		pool->flags |= POOL_MANAGING_WORKERS;
3357db7bccf4STejun Heo 
33584ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3359*403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
33604ce62e9eSTejun Heo 	}
3361db7bccf4STejun Heo 
3362db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3363*403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3364db7bccf4STejun Heo 
3365f2d5a0eeSTejun Heo 	gcwq->flags |= GCWQ_DISASSOCIATED;
3366f2d5a0eeSTejun Heo 
3367db7bccf4STejun Heo 	/*
3368*403c821dSTejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3369*403c821dSTejun Heo 	 * sched callbacks see the unbound flag.  This is necessary as
3370*403c821dSTejun Heo 	 * scheduler callbacks may be invoked from other cpus.
3371e22bee78STejun Heo 	 */
3372e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3373e22bee78STejun Heo 	schedule();
3374e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3375e22bee78STejun Heo 
3376e22bee78STejun Heo 	/*
3377cb444766STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After
3378cb444766STejun Heo 	 * this, nr_running stays zero and need_more_worker() and
3379cb444766STejun Heo 	 * keep_working() are always true as long as the worklist is
3380cb444766STejun Heo 	 * not empty.
3381e22bee78STejun Heo 	 */
33824ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
33834ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3384e22bee78STejun Heo 
3385e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
33864ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
33874ce62e9eSTejun Heo 		del_timer_sync(&pool->idle_timer);
3388e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3389e22bee78STejun Heo 
3390e22bee78STejun Heo 	/*
3391db7bccf4STejun Heo 	 * We're now in charge.  Notify and proceed to drain.  We need
3392db7bccf4STejun Heo 	 * to keep the gcwq running during the whole CPU down
3393db7bccf4STejun Heo 	 * procedure as other cpu hotunplug callbacks may need to
3394db7bccf4STejun Heo 	 * flush currently running tasks.
3395db7bccf4STejun Heo 	 */
3396db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3397db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3398db7bccf4STejun Heo 
3399db7bccf4STejun Heo 	/*
3400db7bccf4STejun Heo 	 * The original cpu is in the process of dying and may go away
3401db7bccf4STejun Heo 	 * anytime now.  When that happens, we and all workers would
3402e22bee78STejun Heo 	 * be migrated to other cpus.  Try draining any left work.  We
3403e22bee78STejun Heo 	 * want to get it over with ASAP - spam rescuers, wake up as
3404e22bee78STejun Heo 	 * many idlers as necessary and create new ones till the
3405e22bee78STejun Heo 	 * worklist is empty.  Note that if the gcwq is frozen, there
340658a69cb4STejun Heo 	 * may be frozen works in freezable cwqs.  Don't declare
3407e22bee78STejun Heo 	 * completion while frozen.
3408db7bccf4STejun Heo 	 */
34094ce62e9eSTejun Heo 	while (true) {
34104ce62e9eSTejun Heo 		bool busy = false;
34114ce62e9eSTejun Heo 
34124ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
34134ce62e9eSTejun Heo 			busy |= pool->nr_workers != pool->nr_idle;
34144ce62e9eSTejun Heo 
34154ce62e9eSTejun Heo 		if (!busy && !(gcwq->flags & GCWQ_FREEZING) &&
34164ce62e9eSTejun Heo 		    gcwq->trustee_state != TRUSTEE_IN_CHARGE)
34174ce62e9eSTejun Heo 			break;
34184ce62e9eSTejun Heo 
34194ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3420e22bee78STejun Heo 			int nr_works = 0;
3421e22bee78STejun Heo 
34224ce62e9eSTejun Heo 			list_for_each_entry(work, &pool->worklist, entry) {
3423e22bee78STejun Heo 				send_mayday(work);
3424e22bee78STejun Heo 				nr_works++;
3425e22bee78STejun Heo 			}
3426e22bee78STejun Heo 
34274ce62e9eSTejun Heo 			list_for_each_entry(worker, &pool->idle_list, entry) {
3428e22bee78STejun Heo 				if (!nr_works--)
3429e22bee78STejun Heo 					break;
3430e22bee78STejun Heo 				wake_up_process(worker->task);
3431e22bee78STejun Heo 			}
3432e22bee78STejun Heo 
34334ce62e9eSTejun Heo 			if (need_to_create_worker(pool)) {
3434e22bee78STejun Heo 				spin_unlock_irq(&gcwq->lock);
34354ce62e9eSTejun Heo 				worker = create_worker(pool, false);
3436e22bee78STejun Heo 				spin_lock_irq(&gcwq->lock);
3437e22bee78STejun Heo 				if (worker) {
3438*403c821dSTejun Heo 					worker->flags |= WORKER_UNBOUND;
3439e22bee78STejun Heo 					start_worker(worker);
3440e22bee78STejun Heo 				}
3441e22bee78STejun Heo 			}
34424ce62e9eSTejun Heo 		}
3443e22bee78STejun Heo 
3444db7bccf4STejun Heo 		/* give a breather */
3445db7bccf4STejun Heo 		if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3446db7bccf4STejun Heo 			break;
3447db7bccf4STejun Heo 	}
3448db7bccf4STejun Heo 
3449e22bee78STejun Heo 	/*
3450e22bee78STejun Heo 	 * Either all works have been scheduled and cpu is down, or
3451e22bee78STejun Heo 	 * cpu down has already been canceled.  Wait for and butcher
3452e22bee78STejun Heo 	 * all workers till we're canceled.
3453e22bee78STejun Heo 	 */
3454e22bee78STejun Heo 	do {
34554ce62e9eSTejun Heo 		rc = trustee_wait_event(gcwq_has_idle_workers(gcwq));
34564ce62e9eSTejun Heo 
34574ce62e9eSTejun Heo 		i = 0;
34584ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
34594ce62e9eSTejun Heo 			while (!list_empty(&pool->idle_list)) {
34604ce62e9eSTejun Heo 				worker = list_first_entry(&pool->idle_list,
34614ce62e9eSTejun Heo 							  struct worker, entry);
34624ce62e9eSTejun Heo 				destroy_worker(worker);
34634ce62e9eSTejun Heo 			}
34644ce62e9eSTejun Heo 			i |= pool->nr_workers;
34654ce62e9eSTejun Heo 		}
34664ce62e9eSTejun Heo 	} while (i && rc >= 0);
3467e22bee78STejun Heo 
3468e22bee78STejun Heo 	/*
3469e22bee78STejun Heo 	 * At this point, either draining has completed and no worker
3470e22bee78STejun Heo 	 * is left, or cpu down has been canceled or the cpu is being
3471e22bee78STejun Heo 	 * brought back up.  There shouldn't be any idle one left.
3472e22bee78STejun Heo 	 * Tell the remaining busy ones to rebind once it finishes the
3473e22bee78STejun Heo 	 * currently scheduled works by scheduling the rebind_work.
3474e22bee78STejun Heo 	 */
34754ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
34764ce62e9eSTejun Heo 		WARN_ON(!list_empty(&pool->idle_list));
3477e22bee78STejun Heo 
3478e22bee78STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
3479e22bee78STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
3480e22bee78STejun Heo 
3481e22bee78STejun Heo 		/*
3482e22bee78STejun Heo 		 * Rebind_work may race with future cpu hotplug
3483e22bee78STejun Heo 		 * operations.  Use a separate flag to mark that
3484e22bee78STejun Heo 		 * rebinding is scheduled.
3485e22bee78STejun Heo 		 */
3486cb444766STejun Heo 		worker->flags |= WORKER_REBIND;
3487*403c821dSTejun Heo 		worker->flags &= ~WORKER_UNBOUND;
3488e22bee78STejun Heo 
3489e22bee78STejun Heo 		/* queue rebind_work, wq doesn't matter, use the default one */
3490e22bee78STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3491e22bee78STejun Heo 				     work_data_bits(rebind_work)))
3492e22bee78STejun Heo 			continue;
3493e22bee78STejun Heo 
3494e22bee78STejun Heo 		debug_work_activate(rebind_work);
3495d320c038STejun Heo 		insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3496e22bee78STejun Heo 			    worker->scheduled.next,
3497e22bee78STejun Heo 			    work_color_to_flags(WORK_NO_COLOR));
3498e22bee78STejun Heo 	}
3499e22bee78STejun Heo 
3500e22bee78STejun Heo 	/* relinquish manager role */
35014ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35024ce62e9eSTejun Heo 		pool->flags &= ~POOL_MANAGING_WORKERS;
3503e22bee78STejun Heo 
3504db7bccf4STejun Heo 	/* notify completion */
3505db7bccf4STejun Heo 	gcwq->trustee = NULL;
3506db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_DONE;
3507db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3508db7bccf4STejun Heo 	spin_unlock_irq(&gcwq->lock);
3509db7bccf4STejun Heo 	return 0;
3510db7bccf4STejun Heo }
3511db7bccf4STejun Heo 
3512db7bccf4STejun Heo /**
3513db7bccf4STejun Heo  * wait_trustee_state - wait for trustee to enter the specified state
3514db7bccf4STejun Heo  * @gcwq: gcwq the trustee of interest belongs to
3515db7bccf4STejun Heo  * @state: target state to wait for
3516db7bccf4STejun Heo  *
3517db7bccf4STejun Heo  * Wait for the trustee to reach @state.  DONE is already matched.
3518db7bccf4STejun Heo  *
3519db7bccf4STejun Heo  * CONTEXT:
3520db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3521db7bccf4STejun Heo  * multiple times.  To be used by cpu_callback.
3522db7bccf4STejun Heo  */
3523db7bccf4STejun Heo static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
352406bd6ebfSNamhyung Kim __releases(&gcwq->lock)
352506bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
3526db7bccf4STejun Heo {
3527db7bccf4STejun Heo 	if (!(gcwq->trustee_state == state ||
3528db7bccf4STejun Heo 	      gcwq->trustee_state == TRUSTEE_DONE)) {
3529db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);
3530db7bccf4STejun Heo 		__wait_event(gcwq->trustee_wait,
3531db7bccf4STejun Heo 			     gcwq->trustee_state == state ||
3532db7bccf4STejun Heo 			     gcwq->trustee_state == TRUSTEE_DONE);
3533db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);
3534db7bccf4STejun Heo 	}
3535db7bccf4STejun Heo }
3536db7bccf4STejun Heo 
35379c7b216dSChandra Seetharaman static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
35381da177e4SLinus Torvalds 						unsigned long action,
35391da177e4SLinus Torvalds 						void *hcpu)
35401da177e4SLinus Torvalds {
35413af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3542db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
3543db7bccf4STejun Heo 	struct task_struct *new_trustee = NULL;
35444ce62e9eSTejun Heo 	struct worker *new_workers[NR_WORKER_POOLS] = { };
35454ce62e9eSTejun Heo 	struct worker_pool *pool;
3546db7bccf4STejun Heo 	unsigned long flags;
35474ce62e9eSTejun Heo 	int i;
35481da177e4SLinus Torvalds 
35498bb78442SRafael J. Wysocki 	action &= ~CPU_TASKS_FROZEN;
35508bb78442SRafael J. Wysocki 
35511da177e4SLinus Torvalds 	switch (action) {
3552db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3553db7bccf4STejun Heo 		new_trustee = kthread_create(trustee_thread, gcwq,
3554db7bccf4STejun Heo 					     "workqueue_trustee/%d\n", cpu);
3555db7bccf4STejun Heo 		if (IS_ERR(new_trustee))
3556db7bccf4STejun Heo 			return notifier_from_errno(PTR_ERR(new_trustee));
3557db7bccf4STejun Heo 		kthread_bind(new_trustee, cpu);
3558e22bee78STejun Heo 		/* fall through */
35593af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35604ce62e9eSTejun Heo 		i = 0;
35614ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35624ce62e9eSTejun Heo 			BUG_ON(pool->first_idle);
35634ce62e9eSTejun Heo 			new_workers[i] = create_worker(pool, false);
35644ce62e9eSTejun Heo 			if (!new_workers[i++])
35654ce62e9eSTejun Heo 				goto err_destroy;
35663af24433SOleg Nesterov 		}
3567db7bccf4STejun Heo 	}
35681537663fSTejun Heo 
3569db7bccf4STejun Heo 	/* some are called w/ irq disabled, don't disturb irq status */
3570db7bccf4STejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
35713af24433SOleg Nesterov 
35723af24433SOleg Nesterov 	switch (action) {
3573db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3574db7bccf4STejun Heo 		/* initialize trustee and tell it to acquire the gcwq */
3575db7bccf4STejun Heo 		BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3576db7bccf4STejun Heo 		gcwq->trustee = new_trustee;
3577db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_START;
3578db7bccf4STejun Heo 		wake_up_process(gcwq->trustee);
3579db7bccf4STejun Heo 		wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3580e22bee78STejun Heo 		/* fall through */
35813af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35824ce62e9eSTejun Heo 		i = 0;
35834ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35844ce62e9eSTejun Heo 			BUG_ON(pool->first_idle);
35854ce62e9eSTejun Heo 			pool->first_idle = new_workers[i++];
35864ce62e9eSTejun Heo 		}
35871da177e4SLinus Torvalds 		break;
35881da177e4SLinus Torvalds 
35893da1c84cSOleg Nesterov 	case CPU_POST_DEAD:
3590db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_BUTCHER;
3591e22bee78STejun Heo 		/* fall through */
3592e22bee78STejun Heo 	case CPU_UP_CANCELED:
35934ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35944ce62e9eSTejun Heo 			destroy_worker(pool->first_idle);
35954ce62e9eSTejun Heo 			pool->first_idle = NULL;
35964ce62e9eSTejun Heo 		}
3597db7bccf4STejun Heo 		break;
3598db7bccf4STejun Heo 
3599db7bccf4STejun Heo 	case CPU_DOWN_FAILED:
36001da177e4SLinus Torvalds 	case CPU_ONLINE:
3601e22bee78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
3602db7bccf4STejun Heo 		if (gcwq->trustee_state != TRUSTEE_DONE) {
3603db7bccf4STejun Heo 			gcwq->trustee_state = TRUSTEE_RELEASE;
3604db7bccf4STejun Heo 			wake_up_process(gcwq->trustee);
3605db7bccf4STejun Heo 			wait_trustee_state(gcwq, TRUSTEE_DONE);
3606db7bccf4STejun Heo 		}
36071da177e4SLinus Torvalds 
3608e22bee78STejun Heo 		/*
3609e22bee78STejun Heo 		 * Trustee is done and there might be no worker left.
3610e22bee78STejun Heo 		 * Put the first_idle in and request a real manager to
3611e22bee78STejun Heo 		 * take a look.
3612e22bee78STejun Heo 		 */
36134ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3614e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
36154ce62e9eSTejun Heo 			kthread_bind(pool->first_idle->task, cpu);
3616e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
36174ce62e9eSTejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
36184ce62e9eSTejun Heo 			start_worker(pool->first_idle);
36194ce62e9eSTejun Heo 			pool->first_idle = NULL;
36204ce62e9eSTejun Heo 		}
36211da177e4SLinus Torvalds 		break;
36221da177e4SLinus Torvalds 	}
36231da177e4SLinus Torvalds 
3624db7bccf4STejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
362500dfcaf7SOleg Nesterov 
36261537663fSTejun Heo 	return notifier_from_errno(0);
36274ce62e9eSTejun Heo 
36284ce62e9eSTejun Heo err_destroy:
36294ce62e9eSTejun Heo 	if (new_trustee)
36304ce62e9eSTejun Heo 		kthread_stop(new_trustee);
36314ce62e9eSTejun Heo 
36324ce62e9eSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
36334ce62e9eSTejun Heo 	for (i = 0; i < NR_WORKER_POOLS; i++)
36344ce62e9eSTejun Heo 		if (new_workers[i])
36354ce62e9eSTejun Heo 			destroy_worker(new_workers[i]);
36364ce62e9eSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
36374ce62e9eSTejun Heo 
36384ce62e9eSTejun Heo 	return NOTIFY_BAD;
36391da177e4SLinus Torvalds }
36401da177e4SLinus Torvalds 
364165758202STejun Heo /*
364265758202STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
364365758202STejun Heo  * This will be registered high priority CPU notifier.
364465758202STejun Heo  */
364565758202STejun Heo static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
364665758202STejun Heo 					       unsigned long action,
364765758202STejun Heo 					       void *hcpu)
364865758202STejun Heo {
364965758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
365065758202STejun Heo 	case CPU_UP_PREPARE:
365165758202STejun Heo 	case CPU_UP_CANCELED:
365265758202STejun Heo 	case CPU_DOWN_FAILED:
365365758202STejun Heo 	case CPU_ONLINE:
365465758202STejun Heo 		return workqueue_cpu_callback(nfb, action, hcpu);
365565758202STejun Heo 	}
365665758202STejun Heo 	return NOTIFY_OK;
365765758202STejun Heo }
365865758202STejun Heo 
365965758202STejun Heo /*
366065758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
366165758202STejun Heo  * This will be registered as low priority CPU notifier.
366265758202STejun Heo  */
366365758202STejun Heo static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
366465758202STejun Heo 						 unsigned long action,
366565758202STejun Heo 						 void *hcpu)
366665758202STejun Heo {
366765758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
366865758202STejun Heo 	case CPU_DOWN_PREPARE:
366965758202STejun Heo 	case CPU_POST_DEAD:
367065758202STejun Heo 		return workqueue_cpu_callback(nfb, action, hcpu);
367165758202STejun Heo 	}
367265758202STejun Heo 	return NOTIFY_OK;
367365758202STejun Heo }
367465758202STejun Heo 
36752d3854a3SRusty Russell #ifdef CONFIG_SMP
36768ccad40dSRusty Russell 
36772d3854a3SRusty Russell struct work_for_cpu {
36786b44003eSAndrew Morton 	struct completion completion;
36792d3854a3SRusty Russell 	long (*fn)(void *);
36802d3854a3SRusty Russell 	void *arg;
36812d3854a3SRusty Russell 	long ret;
36822d3854a3SRusty Russell };
36832d3854a3SRusty Russell 
36846b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
36852d3854a3SRusty Russell {
36866b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
36872d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36886b44003eSAndrew Morton 	complete(&wfc->completion);
36896b44003eSAndrew Morton 	return 0;
36902d3854a3SRusty Russell }
36912d3854a3SRusty Russell 
36922d3854a3SRusty Russell /**
36932d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36942d3854a3SRusty Russell  * @cpu: the cpu to run on
36952d3854a3SRusty Russell  * @fn: the function to run
36962d3854a3SRusty Russell  * @arg: the function arg
36972d3854a3SRusty Russell  *
369831ad9081SRusty Russell  * This will return the value @fn returns.
369931ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
37006b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
37012d3854a3SRusty Russell  */
37022d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
37032d3854a3SRusty Russell {
37046b44003eSAndrew Morton 	struct task_struct *sub_thread;
37056b44003eSAndrew Morton 	struct work_for_cpu wfc = {
37066b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
37076b44003eSAndrew Morton 		.fn = fn,
37086b44003eSAndrew Morton 		.arg = arg,
37096b44003eSAndrew Morton 	};
37102d3854a3SRusty Russell 
37116b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
37126b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
37136b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
37146b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
37156b44003eSAndrew Morton 	wake_up_process(sub_thread);
37166b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
37172d3854a3SRusty Russell 	return wfc.ret;
37182d3854a3SRusty Russell }
37192d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
37202d3854a3SRusty Russell #endif /* CONFIG_SMP */
37212d3854a3SRusty Russell 
3722a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3723e7577c50SRusty Russell 
3724a0a1a5fdSTejun Heo /**
3725a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3726a0a1a5fdSTejun Heo  *
372758a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
372858a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
372958a69cb4STejun Heo  * gcwq->worklist.
3730a0a1a5fdSTejun Heo  *
3731a0a1a5fdSTejun Heo  * CONTEXT:
37328b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3733a0a1a5fdSTejun Heo  */
3734a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3735a0a1a5fdSTejun Heo {
3736a0a1a5fdSTejun Heo 	unsigned int cpu;
3737a0a1a5fdSTejun Heo 
3738a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3739a0a1a5fdSTejun Heo 
3740a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3741a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3742a0a1a5fdSTejun Heo 
3743f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37448b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3745bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37468b03ae3cSTejun Heo 
37478b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37488b03ae3cSTejun Heo 
3749db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3750db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3751db7bccf4STejun Heo 
3752a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3753a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3754a0a1a5fdSTejun Heo 
375558a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3756a0a1a5fdSTejun Heo 				cwq->max_active = 0;
37571da177e4SLinus Torvalds 		}
37588b03ae3cSTejun Heo 
37598b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3760a0a1a5fdSTejun Heo 	}
3761a0a1a5fdSTejun Heo 
3762a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3763a0a1a5fdSTejun Heo }
3764a0a1a5fdSTejun Heo 
3765a0a1a5fdSTejun Heo /**
376658a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3767a0a1a5fdSTejun Heo  *
3768a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3769a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3770a0a1a5fdSTejun Heo  *
3771a0a1a5fdSTejun Heo  * CONTEXT:
3772a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3773a0a1a5fdSTejun Heo  *
3774a0a1a5fdSTejun Heo  * RETURNS:
377558a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
377658a69cb4STejun Heo  * is complete.
3777a0a1a5fdSTejun Heo  */
3778a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3779a0a1a5fdSTejun Heo {
3780a0a1a5fdSTejun Heo 	unsigned int cpu;
3781a0a1a5fdSTejun Heo 	bool busy = false;
3782a0a1a5fdSTejun Heo 
3783a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3784a0a1a5fdSTejun Heo 
3785a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3786a0a1a5fdSTejun Heo 
3787f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3788bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3789a0a1a5fdSTejun Heo 		/*
3790a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3791a0a1a5fdSTejun Heo 		 * to peek without lock.
3792a0a1a5fdSTejun Heo 		 */
3793a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3794a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3795a0a1a5fdSTejun Heo 
379658a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3797a0a1a5fdSTejun Heo 				continue;
3798a0a1a5fdSTejun Heo 
3799a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3800a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3801a0a1a5fdSTejun Heo 				busy = true;
3802a0a1a5fdSTejun Heo 				goto out_unlock;
3803a0a1a5fdSTejun Heo 			}
3804a0a1a5fdSTejun Heo 		}
3805a0a1a5fdSTejun Heo 	}
3806a0a1a5fdSTejun Heo out_unlock:
3807a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3808a0a1a5fdSTejun Heo 	return busy;
3809a0a1a5fdSTejun Heo }
3810a0a1a5fdSTejun Heo 
3811a0a1a5fdSTejun Heo /**
3812a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3813a0a1a5fdSTejun Heo  *
3814a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
38157e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3816a0a1a5fdSTejun Heo  *
3817a0a1a5fdSTejun Heo  * CONTEXT:
38188b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3819a0a1a5fdSTejun Heo  */
3820a0a1a5fdSTejun Heo void thaw_workqueues(void)
3821a0a1a5fdSTejun Heo {
3822a0a1a5fdSTejun Heo 	unsigned int cpu;
3823a0a1a5fdSTejun Heo 
3824a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3825a0a1a5fdSTejun Heo 
3826a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3827a0a1a5fdSTejun Heo 		goto out_unlock;
3828a0a1a5fdSTejun Heo 
3829f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38308b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38314ce62e9eSTejun Heo 		struct worker_pool *pool;
3832bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
38338b03ae3cSTejun Heo 
38348b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
38358b03ae3cSTejun Heo 
3836db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3837db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3838db7bccf4STejun Heo 
3839a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3840a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3841a0a1a5fdSTejun Heo 
384258a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3843a0a1a5fdSTejun Heo 				continue;
3844a0a1a5fdSTejun Heo 
3845a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3846a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3847a0a1a5fdSTejun Heo 
3848a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3849a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3850a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3851a0a1a5fdSTejun Heo 		}
38528b03ae3cSTejun Heo 
38534ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
38544ce62e9eSTejun Heo 			wake_up_worker(pool);
3855e22bee78STejun Heo 
38568b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3857a0a1a5fdSTejun Heo 	}
3858a0a1a5fdSTejun Heo 
3859a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3860a0a1a5fdSTejun Heo out_unlock:
3861a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3862a0a1a5fdSTejun Heo }
3863a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3864a0a1a5fdSTejun Heo 
38656ee0578bSSuresh Siddha static int __init init_workqueues(void)
38661da177e4SLinus Torvalds {
3867c34056a3STejun Heo 	unsigned int cpu;
3868c8e55f36STejun Heo 	int i;
3869c34056a3STejun Heo 
387065758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
387165758202STejun Heo 	cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
38728b03ae3cSTejun Heo 
38738b03ae3cSTejun Heo 	/* initialize gcwqs */
3874f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38758b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38764ce62e9eSTejun Heo 		struct worker_pool *pool;
38778b03ae3cSTejun Heo 
38788b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
38798b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3880f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
38818b03ae3cSTejun Heo 
3882c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3883c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3884c8e55f36STejun Heo 
38854ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38864ce62e9eSTejun Heo 			pool->gcwq = gcwq;
38874ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38884ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3889e22bee78STejun Heo 
38904ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38914ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38924ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3893e22bee78STejun Heo 
38944ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38954ce62e9eSTejun Heo 				    (unsigned long)pool);
38964ce62e9eSTejun Heo 
38974ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38984ce62e9eSTejun Heo 		}
3899db7bccf4STejun Heo 
3900db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_DONE;
3901db7bccf4STejun Heo 		init_waitqueue_head(&gcwq->trustee_wait);
39028b03ae3cSTejun Heo 	}
39038b03ae3cSTejun Heo 
3904e22bee78STejun Heo 	/* create the initial worker */
3905f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3906e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
39074ce62e9eSTejun Heo 		struct worker_pool *pool;
3908e22bee78STejun Heo 
3909477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3910477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
39114ce62e9eSTejun Heo 
39124ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
39134ce62e9eSTejun Heo 			struct worker *worker;
39144ce62e9eSTejun Heo 
39154ce62e9eSTejun Heo 			worker = create_worker(pool, true);
3916e22bee78STejun Heo 			BUG_ON(!worker);
3917e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3918e22bee78STejun Heo 			start_worker(worker);
3919e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3920e22bee78STejun Heo 		}
39214ce62e9eSTejun Heo 	}
3922e22bee78STejun Heo 
3923d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
3924d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3925d320c038STejun Heo 	system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3926f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3927f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
392824d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
392924d51addSTejun Heo 					      WQ_FREEZABLE, 0);
393062d3c543SAlan Stern 	system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
393162d3c543SAlan Stern 			WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
3932e5cba24eSHitoshi Mitake 	BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
393362d3c543SAlan Stern 	       !system_unbound_wq || !system_freezable_wq ||
393462d3c543SAlan Stern 		!system_nrt_freezable_wq);
39356ee0578bSSuresh Siddha 	return 0;
39361da177e4SLinus Torvalds }
39376ee0578bSSuresh Siddha early_initcall(init_workqueues);
3938