xref: /linux-6.15/kernel/workqueue.c (revision 9f4bd4cd)
11da177e4SLinus Torvalds /*
2c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
31da177e4SLinus Torvalds  *
4c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
51da177e4SLinus Torvalds  *
61da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
71da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
8e1f8e874SFrancois Cami  *     Andrew Morton
91da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
101da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1189ada679SChristoph Lameter  *
12cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
13c54fce6eSTejun Heo  *
14c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
15c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
16c54fce6eSTejun Heo  *
17c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
18c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
19c54fce6eSTejun Heo  * automatically managed.  There is one worker pool for each CPU and
20c54fce6eSTejun Heo  * one extra for works which are better served by workers which are
21c54fce6eSTejun Heo  * not bound to any specific CPU.
22c54fce6eSTejun Heo  *
23c54fce6eSTejun Heo  * Please read Documentation/workqueue.txt for details.
241da177e4SLinus Torvalds  */
251da177e4SLinus Torvalds 
269984de1aSPaul Gortmaker #include <linux/export.h>
271da177e4SLinus Torvalds #include <linux/kernel.h>
281da177e4SLinus Torvalds #include <linux/sched.h>
291da177e4SLinus Torvalds #include <linux/init.h>
301da177e4SLinus Torvalds #include <linux/signal.h>
311da177e4SLinus Torvalds #include <linux/completion.h>
321da177e4SLinus Torvalds #include <linux/workqueue.h>
331da177e4SLinus Torvalds #include <linux/slab.h>
341da177e4SLinus Torvalds #include <linux/cpu.h>
351da177e4SLinus Torvalds #include <linux/notifier.h>
361da177e4SLinus Torvalds #include <linux/kthread.h>
371fa44ecaSJames Bottomley #include <linux/hardirq.h>
3846934023SChristoph Lameter #include <linux/mempolicy.h>
39341a5958SRafael J. Wysocki #include <linux/freezer.h>
40d5abe669SPeter Zijlstra #include <linux/kallsyms.h>
41d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
424e6045f1SJohannes Berg #include <linux/lockdep.h>
43c34056a3STejun Heo #include <linux/idr.h>
44e22bee78STejun Heo 
45e22bee78STejun Heo #include "workqueue_sched.h"
461da177e4SLinus Torvalds 
47c8e55f36STejun Heo enum {
48bc2ae0f5STejun Heo 	/*
49bc2ae0f5STejun Heo 	 * global_cwq flags
50bc2ae0f5STejun Heo 	 *
51bc2ae0f5STejun Heo 	 * A bound gcwq is either associated or disassociated with its CPU.
52bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
53bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
54bc2ae0f5STejun Heo 	 * is in effect.
55bc2ae0f5STejun Heo 	 *
56bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
57bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
58bc2ae0f5STejun Heo 	 * be executing on any CPU.  The gcwq behaves as an unbound one.
59bc2ae0f5STejun Heo 	 *
60bc2ae0f5STejun Heo 	 * Note that DISASSOCIATED can be flipped only while holding
61b2eb83d1SLai Jiangshan 	 * assoc_mutex of all pools on the gcwq to avoid changing binding
62bc2ae0f5STejun Heo 	 * state while create_worker() is in progress.
63bc2ae0f5STejun Heo 	 */
6411ebea50STejun Heo 	GCWQ_DISASSOCIATED	= 1 << 0,	/* cpu can't serve workers */
6511ebea50STejun Heo 	GCWQ_FREEZING		= 1 << 1,	/* freeze in progress */
6611ebea50STejun Heo 
6711ebea50STejun Heo 	/* pool flags */
6811ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
69552a37e9SLai Jiangshan 	POOL_MANAGING_WORKERS   = 1 << 1,       /* managing workers */
70db7bccf4STejun Heo 
71c8e55f36STejun Heo 	/* worker flags */
72c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
73c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
74c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
75e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
76fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
77f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
78e22bee78STejun Heo 
795f7dabfdSLai Jiangshan 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_UNBOUND |
80403c821dSTejun Heo 				  WORKER_CPU_INTENSIVE,
81db7bccf4STejun Heo 
823270476aSTejun Heo 	NR_WORKER_POOLS		= 2,		/* # worker pools per gcwq */
834ce62e9eSTejun Heo 
84c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
85c8e55f36STejun Heo 	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
86c8e55f36STejun Heo 	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
87db7bccf4STejun Heo 
88e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
89e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
90e22bee78STejun Heo 
913233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
923233cdbdSTejun Heo 						/* call for help after 10ms
933233cdbdSTejun Heo 						   (min two ticks) */
94e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
95e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
961da177e4SLinus Torvalds 
971da177e4SLinus Torvalds 	/*
98e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
99e22bee78STejun Heo 	 * all cpus.  Give -20.
100e22bee78STejun Heo 	 */
101e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
1023270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
103c8e55f36STejun Heo };
104c8e55f36STejun Heo 
1051da177e4SLinus Torvalds /*
1064690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1074690c4abSTejun Heo  *
108e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
109e41e704bSTejun Heo  *    everyone else.
1104690c4abSTejun Heo  *
111e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
112e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
113e22bee78STejun Heo  *
1148b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1154690c4abSTejun Heo  *
116e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
117e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
118e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
119f3421797STejun Heo  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
120e22bee78STejun Heo  *
12173f53c4aSTejun Heo  * F: wq->flush_mutex protected.
12273f53c4aSTejun Heo  *
1234690c4abSTejun Heo  * W: workqueue_lock protected.
1244690c4abSTejun Heo  */
1254690c4abSTejun Heo 
1268b03ae3cSTejun Heo struct global_cwq;
127bd7bdd43STejun Heo struct worker_pool;
128c34056a3STejun Heo 
129e22bee78STejun Heo /*
130e22bee78STejun Heo  * The poor guys doing the actual heavy lifting.  All on-duty workers
131e22bee78STejun Heo  * are either serving the manager role, on idle list or on busy hash.
132e22bee78STejun Heo  */
133c34056a3STejun Heo struct worker {
134c8e55f36STejun Heo 	/* on idle list while idle, on busy hash table while busy */
135c8e55f36STejun Heo 	union {
136c8e55f36STejun Heo 		struct list_head	entry;	/* L: while idle */
137c8e55f36STejun Heo 		struct hlist_node	hentry;	/* L: while busy */
138c8e55f36STejun Heo 	};
139c8e55f36STejun Heo 
140c34056a3STejun Heo 	struct work_struct	*current_work;	/* L: work being processed */
1418cca0eeaSTejun Heo 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
142affee4b2STejun Heo 	struct list_head	scheduled;	/* L: scheduled works */
143c34056a3STejun Heo 	struct task_struct	*task;		/* I: worker task */
144bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
145e22bee78STejun Heo 	/* 64 bytes boundary on 64bit, 32 on 32bit */
146e22bee78STejun Heo 	unsigned long		last_active;	/* L: last active timestamp */
147e22bee78STejun Heo 	unsigned int		flags;		/* X: flags */
148c34056a3STejun Heo 	int			id;		/* I: worker id */
14925511a47STejun Heo 
15025511a47STejun Heo 	/* for rebinding worker to CPU */
15125511a47STejun Heo 	struct work_struct	rebind_work;	/* L: for busy worker */
152c34056a3STejun Heo };
153c34056a3STejun Heo 
154bd7bdd43STejun Heo struct worker_pool {
155bd7bdd43STejun Heo 	struct global_cwq	*gcwq;		/* I: the owning gcwq */
15611ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
157bd7bdd43STejun Heo 
158bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
159bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
160ea1abd61SLai Jiangshan 
161ea1abd61SLai Jiangshan 	/* nr_idle includes the ones off idle_list for rebinding */
162bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
163bd7bdd43STejun Heo 
164bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
165bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
166bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
167bd7bdd43STejun Heo 
168b2eb83d1SLai Jiangshan 	struct mutex		assoc_mutex;	/* protect GCWQ_DISASSOCIATED */
169bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
170bd7bdd43STejun Heo };
171bd7bdd43STejun Heo 
1724690c4abSTejun Heo /*
173e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
174e22bee78STejun Heo  * and all works are queued and processed here regardless of their
175e22bee78STejun Heo  * target workqueues.
1768b03ae3cSTejun Heo  */
1778b03ae3cSTejun Heo struct global_cwq {
1788b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1798b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
180db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
181c8e55f36STejun Heo 
182bd7bdd43STejun Heo 	/* workers are chained either in busy_hash or pool idle_list */
183c8e55f36STejun Heo 	struct hlist_head	busy_hash[BUSY_WORKER_HASH_SIZE];
184c8e55f36STejun Heo 						/* L: hash of busy workers */
185c8e55f36STejun Heo 
186330dad5bSJoonsoo Kim 	struct worker_pool	pools[NR_WORKER_POOLS];
187330dad5bSJoonsoo Kim 						/* normal and highpri pools */
1888b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1898b03ae3cSTejun Heo 
1908b03ae3cSTejun Heo /*
191502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1920f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1930f900049STejun Heo  * aligned at two's power of the number of flag bits.
1941da177e4SLinus Torvalds  */
1951da177e4SLinus Torvalds struct cpu_workqueue_struct {
196bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1974690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
19873f53c4aSTejun Heo 	int			work_color;	/* L: current color */
19973f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
20073f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
20173f53c4aSTejun Heo 						/* L: nr of in_flight works */
2021e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
203a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
2041e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
2050f900049STejun Heo };
2061da177e4SLinus Torvalds 
2071da177e4SLinus Torvalds /*
20873f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
20973f53c4aSTejun Heo  */
21073f53c4aSTejun Heo struct wq_flusher {
21173f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
21273f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
21373f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
21473f53c4aSTejun Heo };
2151da177e4SLinus Torvalds 
21673f53c4aSTejun Heo /*
217f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
218f2e005aaSTejun Heo  * used to determine whether there's something to be done.
219f2e005aaSTejun Heo  */
220f2e005aaSTejun Heo #ifdef CONFIG_SMP
221f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
222f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
223f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
224f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
225f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2269c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
227f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
228f2e005aaSTejun Heo #else
229f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
230f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
231f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
232f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
233f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
234f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
235f2e005aaSTejun Heo #endif
2361da177e4SLinus Torvalds 
2371da177e4SLinus Torvalds /*
2381da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2391da177e4SLinus Torvalds  * per-CPU workqueues:
2401da177e4SLinus Torvalds  */
2411da177e4SLinus Torvalds struct workqueue_struct {
2429c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
243bdbc5dd7STejun Heo 	union {
244bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
245bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
246bdbc5dd7STejun Heo 		unsigned long				v;
247bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2484690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
24973f53c4aSTejun Heo 
25073f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
25173f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
25273f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
25373f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
25473f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
25573f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
25673f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
25773f53c4aSTejun Heo 
258f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
259e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
260e22bee78STejun Heo 
2619c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
262dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2634e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2644e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2654e6045f1SJohannes Berg #endif
266b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2671da177e4SLinus Torvalds };
2681da177e4SLinus Torvalds 
269d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
270d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
271044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
2721aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
273044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
274d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
275044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
276f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
277044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
27824d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
279d320c038STejun Heo 
28097bd2347STejun Heo #define CREATE_TRACE_POINTS
28197bd2347STejun Heo #include <trace/events/workqueue.h>
28297bd2347STejun Heo 
2834ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
2843270476aSTejun Heo 	for ((pool) = &(gcwq)->pools[0];				\
2853270476aSTejun Heo 	     (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
2864ce62e9eSTejun Heo 
287db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
288db7bccf4STejun Heo 	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
289db7bccf4STejun Heo 		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
290db7bccf4STejun Heo 
291f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
292f3421797STejun Heo 				  unsigned int sw)
293f3421797STejun Heo {
294f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
295f3421797STejun Heo 		if (sw & 1) {
296f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
297f3421797STejun Heo 			if (cpu < nr_cpu_ids)
298f3421797STejun Heo 				return cpu;
299f3421797STejun Heo 		}
300f3421797STejun Heo 		if (sw & 2)
301f3421797STejun Heo 			return WORK_CPU_UNBOUND;
302f3421797STejun Heo 	}
303f3421797STejun Heo 	return WORK_CPU_NONE;
304f3421797STejun Heo }
305f3421797STejun Heo 
306f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
307f3421797STejun Heo 				struct workqueue_struct *wq)
308f3421797STejun Heo {
309f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
310f3421797STejun Heo }
311f3421797STejun Heo 
31209884951STejun Heo /*
31309884951STejun Heo  * CPU iterators
31409884951STejun Heo  *
31509884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
31609884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
31709884951STejun Heo  * specific CPU.  The following iterators are similar to
31809884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
31909884951STejun Heo  *
32009884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
32109884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
32209884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
32309884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
32409884951STejun Heo  */
325f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
326f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
327f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
328f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
329f3421797STejun Heo 
330f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
331f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
332f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
333f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
334f3421797STejun Heo 
335f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
336f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
337f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
338f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
339f3421797STejun Heo 
340dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
341dc186ad7SThomas Gleixner 
342dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
343dc186ad7SThomas Gleixner 
34499777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
34599777288SStanislaw Gruszka {
34699777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
34799777288SStanislaw Gruszka }
34899777288SStanislaw Gruszka 
349dc186ad7SThomas Gleixner /*
350dc186ad7SThomas Gleixner  * fixup_init is called when:
351dc186ad7SThomas Gleixner  * - an active object is initialized
352dc186ad7SThomas Gleixner  */
353dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
354dc186ad7SThomas Gleixner {
355dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
356dc186ad7SThomas Gleixner 
357dc186ad7SThomas Gleixner 	switch (state) {
358dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
359dc186ad7SThomas Gleixner 		cancel_work_sync(work);
360dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
361dc186ad7SThomas Gleixner 		return 1;
362dc186ad7SThomas Gleixner 	default:
363dc186ad7SThomas Gleixner 		return 0;
364dc186ad7SThomas Gleixner 	}
365dc186ad7SThomas Gleixner }
366dc186ad7SThomas Gleixner 
367dc186ad7SThomas Gleixner /*
368dc186ad7SThomas Gleixner  * fixup_activate is called when:
369dc186ad7SThomas Gleixner  * - an active object is activated
370dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
371dc186ad7SThomas Gleixner  */
372dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
373dc186ad7SThomas Gleixner {
374dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
375dc186ad7SThomas Gleixner 
376dc186ad7SThomas Gleixner 	switch (state) {
377dc186ad7SThomas Gleixner 
378dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
379dc186ad7SThomas Gleixner 		/*
380dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
381dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
382dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
383dc186ad7SThomas Gleixner 		 */
38422df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
385dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
386dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
387dc186ad7SThomas Gleixner 			return 0;
388dc186ad7SThomas Gleixner 		}
389dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
390dc186ad7SThomas Gleixner 		return 0;
391dc186ad7SThomas Gleixner 
392dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
393dc186ad7SThomas Gleixner 		WARN_ON(1);
394dc186ad7SThomas Gleixner 
395dc186ad7SThomas Gleixner 	default:
396dc186ad7SThomas Gleixner 		return 0;
397dc186ad7SThomas Gleixner 	}
398dc186ad7SThomas Gleixner }
399dc186ad7SThomas Gleixner 
400dc186ad7SThomas Gleixner /*
401dc186ad7SThomas Gleixner  * fixup_free is called when:
402dc186ad7SThomas Gleixner  * - an active object is freed
403dc186ad7SThomas Gleixner  */
404dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
405dc186ad7SThomas Gleixner {
406dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
407dc186ad7SThomas Gleixner 
408dc186ad7SThomas Gleixner 	switch (state) {
409dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
410dc186ad7SThomas Gleixner 		cancel_work_sync(work);
411dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
412dc186ad7SThomas Gleixner 		return 1;
413dc186ad7SThomas Gleixner 	default:
414dc186ad7SThomas Gleixner 		return 0;
415dc186ad7SThomas Gleixner 	}
416dc186ad7SThomas Gleixner }
417dc186ad7SThomas Gleixner 
418dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
419dc186ad7SThomas Gleixner 	.name		= "work_struct",
42099777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
421dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
422dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
423dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
424dc186ad7SThomas Gleixner };
425dc186ad7SThomas Gleixner 
426dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
427dc186ad7SThomas Gleixner {
428dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
429dc186ad7SThomas Gleixner }
430dc186ad7SThomas Gleixner 
431dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
432dc186ad7SThomas Gleixner {
433dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
434dc186ad7SThomas Gleixner }
435dc186ad7SThomas Gleixner 
436dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
437dc186ad7SThomas Gleixner {
438dc186ad7SThomas Gleixner 	if (onstack)
439dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
440dc186ad7SThomas Gleixner 	else
441dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
442dc186ad7SThomas Gleixner }
443dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
444dc186ad7SThomas Gleixner 
445dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
446dc186ad7SThomas Gleixner {
447dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
448dc186ad7SThomas Gleixner }
449dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
450dc186ad7SThomas Gleixner 
451dc186ad7SThomas Gleixner #else
452dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
453dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
454dc186ad7SThomas Gleixner #endif
455dc186ad7SThomas Gleixner 
45695402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
45795402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4581da177e4SLinus Torvalds static LIST_HEAD(workqueues);
459a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4601da177e4SLinus Torvalds 
46114441960SOleg Nesterov /*
462e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
463e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
464e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
46514441960SOleg Nesterov  */
4668b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
4674ce62e9eSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
468f756d5e2SNathan Lynch 
469f3421797STejun Heo /*
470f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
471f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
472f3421797STejun Heo  * workers have WORKER_UNBOUND set.
473f3421797STejun Heo  */
474f3421797STejun Heo static struct global_cwq unbound_global_cwq;
4754ce62e9eSTejun Heo static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
4764ce62e9eSTejun Heo 	[0 ... NR_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4774ce62e9eSTejun Heo };
478f3421797STejun Heo 
479c34056a3STejun Heo static int worker_thread(void *__worker);
4801da177e4SLinus Torvalds 
4813270476aSTejun Heo static int worker_pool_pri(struct worker_pool *pool)
4823270476aSTejun Heo {
4833270476aSTejun Heo 	return pool - pool->gcwq->pools;
4843270476aSTejun Heo }
4853270476aSTejun Heo 
4868b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4871da177e4SLinus Torvalds {
488f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4898b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
490f3421797STejun Heo 	else
491f3421797STejun Heo 		return &unbound_global_cwq;
4921da177e4SLinus Torvalds }
4931da177e4SLinus Torvalds 
49463d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
495b1f4ec17SOleg Nesterov {
49663d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
4973270476aSTejun Heo 	int idx = worker_pool_pri(pool);
49863d95a91STejun Heo 
499f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
5004ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
501f3421797STejun Heo 	else
5024ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
503b1f4ec17SOleg Nesterov }
504b1f4ec17SOleg Nesterov 
5054690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
5064690c4abSTejun Heo 					    struct workqueue_struct *wq)
507a848e3b6SOleg Nesterov {
508f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
509e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
510bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
511f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
512f3421797STejun Heo 		return wq->cpu_wq.single;
513f3421797STejun Heo 	return NULL;
514f3421797STejun Heo }
515a848e3b6SOleg Nesterov 
51673f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
51773f53c4aSTejun Heo {
51873f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
51973f53c4aSTejun Heo }
52073f53c4aSTejun Heo 
52173f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
52273f53c4aSTejun Heo {
52373f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
52473f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
52573f53c4aSTejun Heo }
52673f53c4aSTejun Heo 
52773f53c4aSTejun Heo static int work_next_color(int color)
52873f53c4aSTejun Heo {
52973f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5301da177e4SLinus Torvalds }
5311da177e4SLinus Torvalds 
5324594bf15SDavid Howells /*
533b5490077STejun Heo  * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
534b5490077STejun Heo  * contain the pointer to the queued cwq.  Once execution starts, the flag
535b5490077STejun Heo  * is cleared and the high bits contain OFFQ flags and CPU number.
5367a22ad75STejun Heo  *
537bbb68dfaSTejun Heo  * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
538bbb68dfaSTejun Heo  * and clear_work_data() can be used to set the cwq, cpu or clear
539bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
540bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5417a22ad75STejun Heo  *
542bbb68dfaSTejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
543bbb68dfaSTejun Heo  * a work.  gcwq is available once the work has been queued anywhere after
544bbb68dfaSTejun Heo  * initialization until it is sync canceled.  cwq is available only while
545bbb68dfaSTejun Heo  * the work item is queued.
546bbb68dfaSTejun Heo  *
547bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
548bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
549bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
550bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5514594bf15SDavid Howells  */
5527a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5537a22ad75STejun Heo 				 unsigned long flags)
5547a22ad75STejun Heo {
5557a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5567a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5577a22ad75STejun Heo }
5587a22ad75STejun Heo 
5597a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5604690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5614690c4abSTejun Heo 			 unsigned long extra_flags)
562365970a1SDavid Howells {
5637a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
564e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
565365970a1SDavid Howells }
566365970a1SDavid Howells 
5678930cabaSTejun Heo static void set_work_cpu_and_clear_pending(struct work_struct *work,
5688930cabaSTejun Heo 					   unsigned int cpu)
5694d707b9fSOleg Nesterov {
57023657bb1STejun Heo 	/*
57123657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
57223657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
57323657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
57423657bb1STejun Heo 	 * owner.
57523657bb1STejun Heo 	 */
57623657bb1STejun Heo 	smp_wmb();
577b5490077STejun Heo 	set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
5784d707b9fSOleg Nesterov }
5794d707b9fSOleg Nesterov 
5807a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
581365970a1SDavid Howells {
58223657bb1STejun Heo 	smp_wmb();	/* see set_work_cpu_and_clear_pending() */
5837a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5847a22ad75STejun Heo }
5857a22ad75STejun Heo 
5867a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5877a22ad75STejun Heo {
588e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5897a22ad75STejun Heo 
590e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
591e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
592e120153dSTejun Heo 	else
593e120153dSTejun Heo 		return NULL;
5947a22ad75STejun Heo }
5957a22ad75STejun Heo 
5967a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5977a22ad75STejun Heo {
598e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5997a22ad75STejun Heo 	unsigned int cpu;
6007a22ad75STejun Heo 
601e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
602e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
603bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
6047a22ad75STejun Heo 
605b5490077STejun Heo 	cpu = data >> WORK_OFFQ_CPU_SHIFT;
606bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
6077a22ad75STejun Heo 		return NULL;
6087a22ad75STejun Heo 
609f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
6107a22ad75STejun Heo 	return get_gcwq(cpu);
611365970a1SDavid Howells }
612365970a1SDavid Howells 
613bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
614bbb68dfaSTejun Heo {
615bbb68dfaSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
616bbb68dfaSTejun Heo 	unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
617bbb68dfaSTejun Heo 
618bbb68dfaSTejun Heo 	set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
619bbb68dfaSTejun Heo 		      WORK_STRUCT_PENDING);
620bbb68dfaSTejun Heo }
621bbb68dfaSTejun Heo 
622bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
623bbb68dfaSTejun Heo {
624bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
625bbb68dfaSTejun Heo 
626bbb68dfaSTejun Heo 	return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
627bbb68dfaSTejun Heo }
628bbb68dfaSTejun Heo 
629e22bee78STejun Heo /*
6303270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
6313270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
6323270476aSTejun Heo  * they're being called with gcwq->lock held.
633e22bee78STejun Heo  */
634e22bee78STejun Heo 
63563d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
636649027d7STejun Heo {
6373270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
638649027d7STejun Heo }
639649027d7STejun Heo 
640e22bee78STejun Heo /*
641e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
642e22bee78STejun Heo  * running workers.
643974271c4STejun Heo  *
644974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
645974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
646974271c4STejun Heo  * worklist isn't empty.
647e22bee78STejun Heo  */
64863d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
649e22bee78STejun Heo {
65063d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
651e22bee78STejun Heo }
652e22bee78STejun Heo 
653e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
65463d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
655e22bee78STejun Heo {
65663d95a91STejun Heo 	return pool->nr_idle;
657e22bee78STejun Heo }
658e22bee78STejun Heo 
659e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
66063d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
661e22bee78STejun Heo {
66263d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
663e22bee78STejun Heo 
6643270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
665e22bee78STejun Heo }
666e22bee78STejun Heo 
667e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
66863d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
669e22bee78STejun Heo {
67063d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
671e22bee78STejun Heo }
672e22bee78STejun Heo 
673e22bee78STejun Heo /* Do I need to be the manager? */
67463d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
675e22bee78STejun Heo {
67663d95a91STejun Heo 	return need_to_create_worker(pool) ||
67711ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
678e22bee78STejun Heo }
679e22bee78STejun Heo 
680e22bee78STejun Heo /* Do we have too many workers and should some go away? */
68163d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
682e22bee78STejun Heo {
683552a37e9SLai Jiangshan 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
68463d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
68563d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
686e22bee78STejun Heo 
687ea1abd61SLai Jiangshan 	/*
688ea1abd61SLai Jiangshan 	 * nr_idle and idle_list may disagree if idle rebinding is in
689ea1abd61SLai Jiangshan 	 * progress.  Never return %true if idle_list is empty.
690ea1abd61SLai Jiangshan 	 */
691ea1abd61SLai Jiangshan 	if (list_empty(&pool->idle_list))
692ea1abd61SLai Jiangshan 		return false;
693ea1abd61SLai Jiangshan 
694e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
695e22bee78STejun Heo }
696e22bee78STejun Heo 
697e22bee78STejun Heo /*
698e22bee78STejun Heo  * Wake up functions.
699e22bee78STejun Heo  */
700e22bee78STejun Heo 
7017e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
70263d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
7037e11629dSTejun Heo {
70463d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
7057e11629dSTejun Heo 		return NULL;
7067e11629dSTejun Heo 
70763d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
7087e11629dSTejun Heo }
7097e11629dSTejun Heo 
7107e11629dSTejun Heo /**
7117e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
71263d95a91STejun Heo  * @pool: worker pool to wake worker from
7137e11629dSTejun Heo  *
71463d95a91STejun Heo  * Wake up the first idle worker of @pool.
7157e11629dSTejun Heo  *
7167e11629dSTejun Heo  * CONTEXT:
7177e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
7187e11629dSTejun Heo  */
71963d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
7207e11629dSTejun Heo {
72163d95a91STejun Heo 	struct worker *worker = first_worker(pool);
7227e11629dSTejun Heo 
7237e11629dSTejun Heo 	if (likely(worker))
7247e11629dSTejun Heo 		wake_up_process(worker->task);
7257e11629dSTejun Heo }
7267e11629dSTejun Heo 
7274690c4abSTejun Heo /**
728e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
729e22bee78STejun Heo  * @task: task waking up
730e22bee78STejun Heo  * @cpu: CPU @task is waking up to
731e22bee78STejun Heo  *
732e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
733e22bee78STejun Heo  * being awoken.
734e22bee78STejun Heo  *
735e22bee78STejun Heo  * CONTEXT:
736e22bee78STejun Heo  * spin_lock_irq(rq->lock)
737e22bee78STejun Heo  */
738e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
739e22bee78STejun Heo {
740e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
741e22bee78STejun Heo 
7422d64672eSSteven Rostedt 	if (!(worker->flags & WORKER_NOT_RUNNING))
74363d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
744e22bee78STejun Heo }
745e22bee78STejun Heo 
746e22bee78STejun Heo /**
747e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
748e22bee78STejun Heo  * @task: task going to sleep
749e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
750e22bee78STejun Heo  *
751e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
752e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
753e22bee78STejun Heo  * returning pointer to its task.
754e22bee78STejun Heo  *
755e22bee78STejun Heo  * CONTEXT:
756e22bee78STejun Heo  * spin_lock_irq(rq->lock)
757e22bee78STejun Heo  *
758e22bee78STejun Heo  * RETURNS:
759e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
760e22bee78STejun Heo  */
761e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
762e22bee78STejun Heo 				       unsigned int cpu)
763e22bee78STejun Heo {
764e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
765bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
76663d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
767e22bee78STejun Heo 
7682d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
769e22bee78STejun Heo 		return NULL;
770e22bee78STejun Heo 
771e22bee78STejun Heo 	/* this can only happen on the local cpu */
772e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
773e22bee78STejun Heo 
774e22bee78STejun Heo 	/*
775e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
776e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
777e22bee78STejun Heo 	 * Please read comment there.
778e22bee78STejun Heo 	 *
779628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
780628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
781628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
782628c78e7STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without gcwq
783628c78e7STejun Heo 	 * lock is safe.
784e22bee78STejun Heo 	 */
785bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
78663d95a91STejun Heo 		to_wakeup = first_worker(pool);
787e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
788e22bee78STejun Heo }
789e22bee78STejun Heo 
790e22bee78STejun Heo /**
791e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
792cb444766STejun Heo  * @worker: self
793d302f017STejun Heo  * @flags: flags to set
794d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
795d302f017STejun Heo  *
796e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
797e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
798e22bee78STejun Heo  * woken up.
799d302f017STejun Heo  *
800cb444766STejun Heo  * CONTEXT:
801cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
802d302f017STejun Heo  */
803d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
804d302f017STejun Heo 				    bool wakeup)
805d302f017STejun Heo {
806bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
807e22bee78STejun Heo 
808cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
809cb444766STejun Heo 
810e22bee78STejun Heo 	/*
811e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
812e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
813e22bee78STejun Heo 	 * @wakeup.
814e22bee78STejun Heo 	 */
815e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
816e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
81763d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
818e22bee78STejun Heo 
819e22bee78STejun Heo 		if (wakeup) {
820e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
821bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
82263d95a91STejun Heo 				wake_up_worker(pool);
823e22bee78STejun Heo 		} else
824e22bee78STejun Heo 			atomic_dec(nr_running);
825e22bee78STejun Heo 	}
826e22bee78STejun Heo 
827d302f017STejun Heo 	worker->flags |= flags;
828d302f017STejun Heo }
829d302f017STejun Heo 
830d302f017STejun Heo /**
831e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
832cb444766STejun Heo  * @worker: self
833d302f017STejun Heo  * @flags: flags to clear
834d302f017STejun Heo  *
835e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
836d302f017STejun Heo  *
837cb444766STejun Heo  * CONTEXT:
838cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
839d302f017STejun Heo  */
840d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
841d302f017STejun Heo {
84263d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
843e22bee78STejun Heo 	unsigned int oflags = worker->flags;
844e22bee78STejun Heo 
845cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
846cb444766STejun Heo 
847d302f017STejun Heo 	worker->flags &= ~flags;
848e22bee78STejun Heo 
84942c025f3STejun Heo 	/*
85042c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
85142c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
85242c025f3STejun Heo 	 * of multiple flags, not a single flag.
85342c025f3STejun Heo 	 */
854e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
855e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
85663d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
857d302f017STejun Heo }
858d302f017STejun Heo 
859d302f017STejun Heo /**
860c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
861c8e55f36STejun Heo  * @gcwq: gcwq of interest
862c8e55f36STejun Heo  * @work: work to be hashed
863c8e55f36STejun Heo  *
864c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
865c8e55f36STejun Heo  *
866c8e55f36STejun Heo  * CONTEXT:
867c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
868c8e55f36STejun Heo  *
869c8e55f36STejun Heo  * RETURNS:
870c8e55f36STejun Heo  * Pointer to the hash head.
871c8e55f36STejun Heo  */
872c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
873c8e55f36STejun Heo 					   struct work_struct *work)
874c8e55f36STejun Heo {
875c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
876c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
877c8e55f36STejun Heo 
878c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
879c8e55f36STejun Heo 	v >>= base_shift;
880c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
881c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
882c8e55f36STejun Heo 
883c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
884c8e55f36STejun Heo }
885c8e55f36STejun Heo 
886c8e55f36STejun Heo /**
8878cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
8888cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8898cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
8908cca0eeaSTejun Heo  * @work: work to find worker for
8918cca0eeaSTejun Heo  *
8928cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
8938cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
8948cca0eeaSTejun Heo  * work.
8958cca0eeaSTejun Heo  *
8968cca0eeaSTejun Heo  * CONTEXT:
8978cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8988cca0eeaSTejun Heo  *
8998cca0eeaSTejun Heo  * RETURNS:
9008cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
9018cca0eeaSTejun Heo  * otherwise.
9028cca0eeaSTejun Heo  */
9038cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
9048cca0eeaSTejun Heo 						   struct hlist_head *bwh,
9058cca0eeaSTejun Heo 						   struct work_struct *work)
9068cca0eeaSTejun Heo {
9078cca0eeaSTejun Heo 	struct worker *worker;
9088cca0eeaSTejun Heo 	struct hlist_node *tmp;
9098cca0eeaSTejun Heo 
9108cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
9118cca0eeaSTejun Heo 		if (worker->current_work == work)
9128cca0eeaSTejun Heo 			return worker;
9138cca0eeaSTejun Heo 	return NULL;
9148cca0eeaSTejun Heo }
9158cca0eeaSTejun Heo 
9168cca0eeaSTejun Heo /**
9178cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
9188cca0eeaSTejun Heo  * @gcwq: gcwq of interest
9198cca0eeaSTejun Heo  * @work: work to find worker for
9208cca0eeaSTejun Heo  *
9218cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
9228cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
9238cca0eeaSTejun Heo  * function calculates @bwh itself.
9248cca0eeaSTejun Heo  *
9258cca0eeaSTejun Heo  * CONTEXT:
9268cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
9278cca0eeaSTejun Heo  *
9288cca0eeaSTejun Heo  * RETURNS:
9298cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
9308cca0eeaSTejun Heo  * otherwise.
9318cca0eeaSTejun Heo  */
9328cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
9338cca0eeaSTejun Heo 						 struct work_struct *work)
9348cca0eeaSTejun Heo {
9358cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
9368cca0eeaSTejun Heo 					    work);
9378cca0eeaSTejun Heo }
9388cca0eeaSTejun Heo 
9398cca0eeaSTejun Heo /**
940bf4ede01STejun Heo  * move_linked_works - move linked works to a list
941bf4ede01STejun Heo  * @work: start of series of works to be scheduled
942bf4ede01STejun Heo  * @head: target list to append @work to
943bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
944bf4ede01STejun Heo  *
945bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
946bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
947bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
948bf4ede01STejun Heo  *
949bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
950bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
951bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
952bf4ede01STejun Heo  *
953bf4ede01STejun Heo  * CONTEXT:
954bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
955bf4ede01STejun Heo  */
956bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
957bf4ede01STejun Heo 			      struct work_struct **nextp)
958bf4ede01STejun Heo {
959bf4ede01STejun Heo 	struct work_struct *n;
960bf4ede01STejun Heo 
961bf4ede01STejun Heo 	/*
962bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
963bf4ede01STejun Heo 	 * use NULL for list head.
964bf4ede01STejun Heo 	 */
965bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
966bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
967bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
968bf4ede01STejun Heo 			break;
969bf4ede01STejun Heo 	}
970bf4ede01STejun Heo 
971bf4ede01STejun Heo 	/*
972bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
973bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
974bf4ede01STejun Heo 	 * needs to be updated.
975bf4ede01STejun Heo 	 */
976bf4ede01STejun Heo 	if (nextp)
977bf4ede01STejun Heo 		*nextp = n;
978bf4ede01STejun Heo }
979bf4ede01STejun Heo 
9803aa62497SLai Jiangshan static void cwq_activate_delayed_work(struct work_struct *work)
981bf4ede01STejun Heo {
9823aa62497SLai Jiangshan 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
983bf4ede01STejun Heo 
984bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
985bf4ede01STejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
986bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
987bf4ede01STejun Heo 	cwq->nr_active++;
988bf4ede01STejun Heo }
989bf4ede01STejun Heo 
9903aa62497SLai Jiangshan static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
9913aa62497SLai Jiangshan {
9923aa62497SLai Jiangshan 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
9933aa62497SLai Jiangshan 						    struct work_struct, entry);
9943aa62497SLai Jiangshan 
9953aa62497SLai Jiangshan 	cwq_activate_delayed_work(work);
9963aa62497SLai Jiangshan }
9973aa62497SLai Jiangshan 
998bf4ede01STejun Heo /**
999bf4ede01STejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1000bf4ede01STejun Heo  * @cwq: cwq of interest
1001bf4ede01STejun Heo  * @color: color of work which left the queue
1002bf4ede01STejun Heo  *
1003bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1004bf4ede01STejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
1005bf4ede01STejun Heo  *
1006bf4ede01STejun Heo  * CONTEXT:
1007bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
1008bf4ede01STejun Heo  */
1009b3f9f405SLai Jiangshan static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
1010bf4ede01STejun Heo {
1011bf4ede01STejun Heo 	/* ignore uncolored works */
1012bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
1013bf4ede01STejun Heo 		return;
1014bf4ede01STejun Heo 
1015bf4ede01STejun Heo 	cwq->nr_in_flight[color]--;
1016bf4ede01STejun Heo 
1017bf4ede01STejun Heo 	cwq->nr_active--;
1018bf4ede01STejun Heo 	if (!list_empty(&cwq->delayed_works)) {
1019bf4ede01STejun Heo 		/* one down, submit a delayed one */
1020bf4ede01STejun Heo 		if (cwq->nr_active < cwq->max_active)
1021bf4ede01STejun Heo 			cwq_activate_first_delayed(cwq);
1022bf4ede01STejun Heo 	}
1023bf4ede01STejun Heo 
1024bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1025bf4ede01STejun Heo 	if (likely(cwq->flush_color != color))
1026bf4ede01STejun Heo 		return;
1027bf4ede01STejun Heo 
1028bf4ede01STejun Heo 	/* are there still in-flight works? */
1029bf4ede01STejun Heo 	if (cwq->nr_in_flight[color])
1030bf4ede01STejun Heo 		return;
1031bf4ede01STejun Heo 
1032bf4ede01STejun Heo 	/* this cwq is done, clear flush_color */
1033bf4ede01STejun Heo 	cwq->flush_color = -1;
1034bf4ede01STejun Heo 
1035bf4ede01STejun Heo 	/*
1036bf4ede01STejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
1037bf4ede01STejun Heo 	 * will handle the rest.
1038bf4ede01STejun Heo 	 */
1039bf4ede01STejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1040bf4ede01STejun Heo 		complete(&cwq->wq->first_flusher->done);
1041bf4ede01STejun Heo }
1042bf4ede01STejun Heo 
104336e227d2STejun Heo /**
1044bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
104536e227d2STejun Heo  * @work: work item to steal
104636e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1047bbb68dfaSTejun Heo  * @flags: place to store irq state
104836e227d2STejun Heo  *
104936e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
105036e227d2STejun Heo  * stable state - idle, on timer or on worklist.  Return values are
105136e227d2STejun Heo  *
105236e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
105336e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
105436e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1055bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1056bbb68dfaSTejun Heo  *		for arbitrarily long
105736e227d2STejun Heo  *
1058bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1059e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1060e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1061e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1062bbb68dfaSTejun Heo  *
1063bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1064bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1065bbb68dfaSTejun Heo  *
1066e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1067bf4ede01STejun Heo  */
1068bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1069bbb68dfaSTejun Heo 			       unsigned long *flags)
1070bf4ede01STejun Heo {
1071bf4ede01STejun Heo 	struct global_cwq *gcwq;
1072bf4ede01STejun Heo 
1073bbb68dfaSTejun Heo 	WARN_ON_ONCE(in_irq());
1074bbb68dfaSTejun Heo 
1075bbb68dfaSTejun Heo 	local_irq_save(*flags);
1076bbb68dfaSTejun Heo 
107736e227d2STejun Heo 	/* try to steal the timer if it exists */
107836e227d2STejun Heo 	if (is_dwork) {
107936e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
108036e227d2STejun Heo 
1081e0aecdd8STejun Heo 		/*
1082e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1083e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1084e0aecdd8STejun Heo 		 * running on the local CPU.
1085e0aecdd8STejun Heo 		 */
108636e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
108736e227d2STejun Heo 			return 1;
108836e227d2STejun Heo 	}
108936e227d2STejun Heo 
109036e227d2STejun Heo 	/* try to claim PENDING the normal way */
1091bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1092bf4ede01STejun Heo 		return 0;
1093bf4ede01STejun Heo 
1094bf4ede01STejun Heo 	/*
1095bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1096bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1097bf4ede01STejun Heo 	 */
1098bf4ede01STejun Heo 	gcwq = get_work_gcwq(work);
1099bf4ede01STejun Heo 	if (!gcwq)
1100bbb68dfaSTejun Heo 		goto fail;
1101bf4ede01STejun Heo 
1102bbb68dfaSTejun Heo 	spin_lock(&gcwq->lock);
1103bf4ede01STejun Heo 	if (!list_empty(&work->entry)) {
1104bf4ede01STejun Heo 		/*
1105bf4ede01STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
1106bf4ede01STejun Heo 		 * In that case we must see the new value after rmb(), see
1107bf4ede01STejun Heo 		 * insert_work()->wmb().
1108bf4ede01STejun Heo 		 */
1109bf4ede01STejun Heo 		smp_rmb();
1110bf4ede01STejun Heo 		if (gcwq == get_work_gcwq(work)) {
1111bf4ede01STejun Heo 			debug_work_deactivate(work);
11123aa62497SLai Jiangshan 
11133aa62497SLai Jiangshan 			/*
11143aa62497SLai Jiangshan 			 * A delayed work item cannot be grabbed directly
11153aa62497SLai Jiangshan 			 * because it might have linked NO_COLOR work items
11163aa62497SLai Jiangshan 			 * which, if left on the delayed_list, will confuse
11173aa62497SLai Jiangshan 			 * cwq->nr_active management later on and cause
11183aa62497SLai Jiangshan 			 * stall.  Make sure the work item is activated
11193aa62497SLai Jiangshan 			 * before grabbing.
11203aa62497SLai Jiangshan 			 */
11213aa62497SLai Jiangshan 			if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
11223aa62497SLai Jiangshan 				cwq_activate_delayed_work(work);
11233aa62497SLai Jiangshan 
1124bf4ede01STejun Heo 			list_del_init(&work->entry);
1125bf4ede01STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
1126b3f9f405SLai Jiangshan 				get_work_color(work));
112736e227d2STejun Heo 
1128bbb68dfaSTejun Heo 			spin_unlock(&gcwq->lock);
112936e227d2STejun Heo 			return 1;
1130bf4ede01STejun Heo 		}
1131bf4ede01STejun Heo 	}
1132bbb68dfaSTejun Heo 	spin_unlock(&gcwq->lock);
1133bbb68dfaSTejun Heo fail:
1134bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1135bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1136bbb68dfaSTejun Heo 		return -ENOENT;
1137bbb68dfaSTejun Heo 	cpu_relax();
113836e227d2STejun Heo 	return -EAGAIN;
1139bf4ede01STejun Heo }
1140bf4ede01STejun Heo 
1141bf4ede01STejun Heo /**
11427e11629dSTejun Heo  * insert_work - insert a work into gcwq
11434690c4abSTejun Heo  * @cwq: cwq @work belongs to
11444690c4abSTejun Heo  * @work: work to insert
11454690c4abSTejun Heo  * @head: insertion point
11464690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
11474690c4abSTejun Heo  *
11487e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
11497e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
11504690c4abSTejun Heo  *
11514690c4abSTejun Heo  * CONTEXT:
11528b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
11531da177e4SLinus Torvalds  */
1154b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
11554690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
11564690c4abSTejun Heo 			unsigned int extra_flags)
1157b89deed3SOleg Nesterov {
115863d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
1159e1d8aa9fSFrederic Weisbecker 
11604690c4abSTejun Heo 	/* we own @work, set data and link */
11617a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
11624690c4abSTejun Heo 
11636e84d644SOleg Nesterov 	/*
11646e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
11656e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
11666e84d644SOleg Nesterov 	 */
11676e84d644SOleg Nesterov 	smp_wmb();
11684690c4abSTejun Heo 
11691a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
1170e22bee78STejun Heo 
1171e22bee78STejun Heo 	/*
1172e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
1173e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
1174e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
1175e22bee78STejun Heo 	 */
1176e22bee78STejun Heo 	smp_mb();
1177e22bee78STejun Heo 
117863d95a91STejun Heo 	if (__need_more_worker(pool))
117963d95a91STejun Heo 		wake_up_worker(pool);
1180b89deed3SOleg Nesterov }
1181b89deed3SOleg Nesterov 
1182c8efcc25STejun Heo /*
1183c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
1184c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
1185c8efcc25STejun Heo  * cold paths.
1186c8efcc25STejun Heo  */
1187c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1188c8efcc25STejun Heo {
1189c8efcc25STejun Heo 	unsigned long flags;
1190c8efcc25STejun Heo 	unsigned int cpu;
1191c8efcc25STejun Heo 
1192c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
1193c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
1194c8efcc25STejun Heo 		struct worker *worker;
1195c8efcc25STejun Heo 		struct hlist_node *pos;
1196c8efcc25STejun Heo 		int i;
1197c8efcc25STejun Heo 
1198c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1199c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
1200c8efcc25STejun Heo 			if (worker->task != current)
1201c8efcc25STejun Heo 				continue;
1202c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
1203c8efcc25STejun Heo 			/*
1204c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
1205c8efcc25STejun Heo 			 * is headed to the same workqueue.
1206c8efcc25STejun Heo 			 */
1207c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
1208c8efcc25STejun Heo 		}
1209c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
1210c8efcc25STejun Heo 	}
1211c8efcc25STejun Heo 	return false;
1212c8efcc25STejun Heo }
1213c8efcc25STejun Heo 
12144690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
12151da177e4SLinus Torvalds 			 struct work_struct *work)
12161da177e4SLinus Torvalds {
1217502ca9d8STejun Heo 	struct global_cwq *gcwq;
1218502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
12191e19ffc6STejun Heo 	struct list_head *worklist;
12208a2e8e5dSTejun Heo 	unsigned int work_flags;
1221b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
12228930cabaSTejun Heo 
12238930cabaSTejun Heo 	/*
12248930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
12258930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
12268930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
12278930cabaSTejun Heo 	 * happen with IRQ disabled.
12288930cabaSTejun Heo 	 */
12298930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
12301da177e4SLinus Torvalds 
1231dc186ad7SThomas Gleixner 	debug_work_activate(work);
12321e19ffc6STejun Heo 
1233c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
12349c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1235c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1236e41e704bSTejun Heo 		return;
1237e41e704bSTejun Heo 
1238c7fc77f7STejun Heo 	/* determine gcwq to use */
1239c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1240c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1241c7fc77f7STejun Heo 
124257469821STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
1243f3421797STejun Heo 			cpu = raw_smp_processor_id();
1244f3421797STejun Heo 
124518aa9effSTejun Heo 		/*
1246dbf2576eSTejun Heo 		 * It's multi cpu.  If @work was previously on a different
1247dbf2576eSTejun Heo 		 * cpu, it might still be running there, in which case the
1248dbf2576eSTejun Heo 		 * work needs to be queued on that cpu to guarantee
1249dbf2576eSTejun Heo 		 * non-reentrancy.
125018aa9effSTejun Heo 		 */
1251502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
1252dbf2576eSTejun Heo 		last_gcwq = get_work_gcwq(work);
1253dbf2576eSTejun Heo 
1254dbf2576eSTejun Heo 		if (last_gcwq && last_gcwq != gcwq) {
125518aa9effSTejun Heo 			struct worker *worker;
125618aa9effSTejun Heo 
12578930cabaSTejun Heo 			spin_lock(&last_gcwq->lock);
125818aa9effSTejun Heo 
125918aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
126018aa9effSTejun Heo 
126118aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
126218aa9effSTejun Heo 				gcwq = last_gcwq;
126318aa9effSTejun Heo 			else {
126418aa9effSTejun Heo 				/* meh... not running there, queue here */
12658930cabaSTejun Heo 				spin_unlock(&last_gcwq->lock);
12668930cabaSTejun Heo 				spin_lock(&gcwq->lock);
126718aa9effSTejun Heo 			}
12688930cabaSTejun Heo 		} else {
12698930cabaSTejun Heo 			spin_lock(&gcwq->lock);
12708930cabaSTejun Heo 		}
1271f3421797STejun Heo 	} else {
1272f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
12738930cabaSTejun Heo 		spin_lock(&gcwq->lock);
1274502ca9d8STejun Heo 	}
1275502ca9d8STejun Heo 
1276502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1277502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1278b75cac93SJoonsoo Kim 	trace_workqueue_queue_work(req_cpu, cwq, work);
1279502ca9d8STejun Heo 
1280f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
12818930cabaSTejun Heo 		spin_unlock(&gcwq->lock);
1282f5b2552bSDan Carpenter 		return;
1283f5b2552bSDan Carpenter 	}
12841e19ffc6STejun Heo 
128573f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
12868a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
12871e19ffc6STejun Heo 
12881e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1289cdadf009STejun Heo 		trace_workqueue_activate_work(work);
12901e19ffc6STejun Heo 		cwq->nr_active++;
12913270476aSTejun Heo 		worklist = &cwq->pool->worklist;
12928a2e8e5dSTejun Heo 	} else {
12938a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
12941e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
12958a2e8e5dSTejun Heo 	}
12961e19ffc6STejun Heo 
12978a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
12981e19ffc6STejun Heo 
12998930cabaSTejun Heo 	spin_unlock(&gcwq->lock);
13001da177e4SLinus Torvalds }
13011da177e4SLinus Torvalds 
13020fcb78c2SRolf Eike Beer /**
1303c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1304c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1305c1a220e7SZhang Rui  * @wq: workqueue to use
1306c1a220e7SZhang Rui  * @work: work to queue
1307c1a220e7SZhang Rui  *
1308d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
1309c1a220e7SZhang Rui  *
1310c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1311c1a220e7SZhang Rui  * can't go away.
1312c1a220e7SZhang Rui  */
1313d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1314d4283e93STejun Heo 		   struct work_struct *work)
1315c1a220e7SZhang Rui {
1316d4283e93STejun Heo 	bool ret = false;
13178930cabaSTejun Heo 	unsigned long flags;
13188930cabaSTejun Heo 
13198930cabaSTejun Heo 	local_irq_save(flags);
1320c1a220e7SZhang Rui 
132122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
13224690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1323d4283e93STejun Heo 		ret = true;
1324c1a220e7SZhang Rui 	}
13258930cabaSTejun Heo 
13268930cabaSTejun Heo 	local_irq_restore(flags);
1327c1a220e7SZhang Rui 	return ret;
1328c1a220e7SZhang Rui }
1329c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1330c1a220e7SZhang Rui 
13310a13c00eSTejun Heo /**
13320a13c00eSTejun Heo  * queue_work - queue work on a workqueue
13330a13c00eSTejun Heo  * @wq: workqueue to use
13340a13c00eSTejun Heo  * @work: work to queue
13350a13c00eSTejun Heo  *
1336d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
13370a13c00eSTejun Heo  *
13380a13c00eSTejun Heo  * We queue the work to the CPU on which it was submitted, but if the CPU dies
13390a13c00eSTejun Heo  * it can be processed by another CPU.
13400a13c00eSTejun Heo  */
1341d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
13420a13c00eSTejun Heo {
134357469821STejun Heo 	return queue_work_on(WORK_CPU_UNBOUND, wq, work);
13440a13c00eSTejun Heo }
13450a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work);
13460a13c00eSTejun Heo 
1347d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
13481da177e4SLinus Torvalds {
134952bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
13507a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
13511da177e4SLinus Torvalds 
1352e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
13531265057fSTejun Heo 	__queue_work(dwork->cpu, cwq->wq, &dwork->work);
13541da177e4SLinus Torvalds }
1355d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
13561da177e4SLinus Torvalds 
13577beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
13587beb2edfSTejun Heo 				struct delayed_work *dwork, unsigned long delay)
13597beb2edfSTejun Heo {
13607beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
13617beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
13627beb2edfSTejun Heo 	unsigned int lcpu;
13637beb2edfSTejun Heo 
13647beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
13657beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
13667beb2edfSTejun Heo 	BUG_ON(timer_pending(timer));
13677beb2edfSTejun Heo 	BUG_ON(!list_empty(&work->entry));
13687beb2edfSTejun Heo 
13697beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
13707beb2edfSTejun Heo 
13717beb2edfSTejun Heo 	/*
13727beb2edfSTejun Heo 	 * This stores cwq for the moment, for the timer_fn.  Note that the
13737beb2edfSTejun Heo 	 * work's gcwq is preserved to allow reentrance detection for
13747beb2edfSTejun Heo 	 * delayed works.
13757beb2edfSTejun Heo 	 */
13767beb2edfSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
13777beb2edfSTejun Heo 		struct global_cwq *gcwq = get_work_gcwq(work);
13787beb2edfSTejun Heo 
1379e42986deSJoonsoo Kim 		/*
1380e42986deSJoonsoo Kim 		 * If we cannot get the last gcwq from @work directly,
1381e42986deSJoonsoo Kim 		 * select the last CPU such that it avoids unnecessarily
1382e42986deSJoonsoo Kim 		 * triggering non-reentrancy check in __queue_work().
1383e42986deSJoonsoo Kim 		 */
1384e42986deSJoonsoo Kim 		lcpu = cpu;
1385e42986deSJoonsoo Kim 		if (gcwq)
13867beb2edfSTejun Heo 			lcpu = gcwq->cpu;
1387e42986deSJoonsoo Kim 		if (lcpu == WORK_CPU_UNBOUND)
13887beb2edfSTejun Heo 			lcpu = raw_smp_processor_id();
13897beb2edfSTejun Heo 	} else {
13907beb2edfSTejun Heo 		lcpu = WORK_CPU_UNBOUND;
13917beb2edfSTejun Heo 	}
13927beb2edfSTejun Heo 
13937beb2edfSTejun Heo 	set_work_cwq(work, get_cwq(lcpu, wq), 0);
13947beb2edfSTejun Heo 
13951265057fSTejun Heo 	dwork->cpu = cpu;
13967beb2edfSTejun Heo 	timer->expires = jiffies + delay;
13977beb2edfSTejun Heo 
13987beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
13997beb2edfSTejun Heo 		add_timer_on(timer, cpu);
14007beb2edfSTejun Heo 	else
14017beb2edfSTejun Heo 		add_timer(timer);
14027beb2edfSTejun Heo }
14037beb2edfSTejun Heo 
14040fcb78c2SRolf Eike Beer /**
14050fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
14060fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
14070fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1408af9997e4SRandy Dunlap  * @dwork: work to queue
14090fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
14100fcb78c2SRolf Eike Beer  *
1411715f1300STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.  If
1412715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1413715f1300STejun Heo  * execution.
14140fcb78c2SRolf Eike Beer  */
1415d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
141652bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
14177a6bc1cdSVenkatesh Pallipadi {
141852bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1419d4283e93STejun Heo 	bool ret = false;
14208930cabaSTejun Heo 	unsigned long flags;
14218930cabaSTejun Heo 
1422715f1300STejun Heo 	if (!delay)
1423715f1300STejun Heo 		return queue_work_on(cpu, wq, &dwork->work);
1424715f1300STejun Heo 
14258930cabaSTejun Heo 	/* read the comment in __queue_work() */
14268930cabaSTejun Heo 	local_irq_save(flags);
14277a6bc1cdSVenkatesh Pallipadi 
142822df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14297beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1430d4283e93STejun Heo 		ret = true;
14317a6bc1cdSVenkatesh Pallipadi 	}
14328930cabaSTejun Heo 
14338930cabaSTejun Heo 	local_irq_restore(flags);
14347a6bc1cdSVenkatesh Pallipadi 	return ret;
14357a6bc1cdSVenkatesh Pallipadi }
1436ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
14371da177e4SLinus Torvalds 
1438c8e55f36STejun Heo /**
14390a13c00eSTejun Heo  * queue_delayed_work - queue work on a workqueue after delay
14400a13c00eSTejun Heo  * @wq: workqueue to use
14410a13c00eSTejun Heo  * @dwork: delayable work to queue
14420a13c00eSTejun Heo  * @delay: number of jiffies to wait before queueing
14430a13c00eSTejun Heo  *
1444715f1300STejun Heo  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
14450a13c00eSTejun Heo  */
1446d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq,
14470a13c00eSTejun Heo 			struct delayed_work *dwork, unsigned long delay)
14480a13c00eSTejun Heo {
144957469821STejun Heo 	return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14500a13c00eSTejun Heo }
14510a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work);
14520a13c00eSTejun Heo 
14530a13c00eSTejun Heo /**
14548376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
14558376fe22STejun Heo  * @cpu: CPU number to execute work on
14568376fe22STejun Heo  * @wq: workqueue to use
14578376fe22STejun Heo  * @dwork: work to queue
14588376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14598376fe22STejun Heo  *
14608376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
14618376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
14628376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
14638376fe22STejun Heo  * current state.
14648376fe22STejun Heo  *
14658376fe22STejun Heo  * Returns %false if @dwork was idle and queued, %true if @dwork was
14668376fe22STejun Heo  * pending and its timer was modified.
14678376fe22STejun Heo  *
1468e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
14698376fe22STejun Heo  * See try_to_grab_pending() for details.
14708376fe22STejun Heo  */
14718376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
14728376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
14738376fe22STejun Heo {
14748376fe22STejun Heo 	unsigned long flags;
14758376fe22STejun Heo 	int ret;
14768376fe22STejun Heo 
14778376fe22STejun Heo 	do {
14788376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
14798376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
14808376fe22STejun Heo 
14818376fe22STejun Heo 	if (likely(ret >= 0)) {
14828376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
14838376fe22STejun Heo 		local_irq_restore(flags);
14848376fe22STejun Heo 	}
14858376fe22STejun Heo 
14868376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
14878376fe22STejun Heo 	return ret;
14888376fe22STejun Heo }
14898376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
14908376fe22STejun Heo 
14918376fe22STejun Heo /**
14928376fe22STejun Heo  * mod_delayed_work - modify delay of or queue a delayed work
14938376fe22STejun Heo  * @wq: workqueue to use
14948376fe22STejun Heo  * @dwork: work to queue
14958376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14968376fe22STejun Heo  *
14978376fe22STejun Heo  * mod_delayed_work_on() on local CPU.
14988376fe22STejun Heo  */
14998376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
15008376fe22STejun Heo 		      unsigned long delay)
15018376fe22STejun Heo {
15028376fe22STejun Heo 	return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
15038376fe22STejun Heo }
15048376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work);
15058376fe22STejun Heo 
15068376fe22STejun Heo /**
1507c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1508c8e55f36STejun Heo  * @worker: worker which is entering idle state
1509c8e55f36STejun Heo  *
1510c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1511c8e55f36STejun Heo  * necessary.
1512c8e55f36STejun Heo  *
1513c8e55f36STejun Heo  * LOCKING:
1514c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1515c8e55f36STejun Heo  */
1516c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
15171da177e4SLinus Torvalds {
1518bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1519bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1520c8e55f36STejun Heo 
1521c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1522c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1523c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1524c8e55f36STejun Heo 
1525cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1526cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1527bd7bdd43STejun Heo 	pool->nr_idle++;
1528e22bee78STejun Heo 	worker->last_active = jiffies;
1529c8e55f36STejun Heo 
1530c8e55f36STejun Heo 	/* idle_list is LIFO */
1531bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1532db7bccf4STejun Heo 
153363d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1534628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1535cb444766STejun Heo 
1536544ecf31STejun Heo 	/*
1537628c78e7STejun Heo 	 * Sanity check nr_running.  Because gcwq_unbind_fn() releases
1538628c78e7STejun Heo 	 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1539628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1540628c78e7STejun Heo 	 * unbind is not in progress.
1541544ecf31STejun Heo 	 */
1542628c78e7STejun Heo 	WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
1543bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
154463d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1545c8e55f36STejun Heo }
1546c8e55f36STejun Heo 
1547c8e55f36STejun Heo /**
1548c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1549c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1550c8e55f36STejun Heo  *
1551c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1552c8e55f36STejun Heo  *
1553c8e55f36STejun Heo  * LOCKING:
1554c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1555c8e55f36STejun Heo  */
1556c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1557c8e55f36STejun Heo {
1558bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1559c8e55f36STejun Heo 
1560c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1561d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1562bd7bdd43STejun Heo 	pool->nr_idle--;
1563c8e55f36STejun Heo 	list_del_init(&worker->entry);
1564c8e55f36STejun Heo }
1565c8e55f36STejun Heo 
1566e22bee78STejun Heo /**
1567e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1568e22bee78STejun Heo  * @worker: self
1569e22bee78STejun Heo  *
1570e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1571e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1572e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1573e22bee78STejun Heo  * guaranteed to execute on the cpu.
1574e22bee78STejun Heo  *
1575e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1576e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1577e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1578e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1579e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1580e22bee78STejun Heo  * [dis]associated in the meantime.
1581e22bee78STejun Heo  *
1582f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1583f2d5a0eeSTejun Heo  * binding against %GCWQ_DISASSOCIATED which is set during
1584f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1585f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1586f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1587e22bee78STejun Heo  *
1588e22bee78STejun Heo  * CONTEXT:
1589e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1590e22bee78STejun Heo  * held.
1591e22bee78STejun Heo  *
1592e22bee78STejun Heo  * RETURNS:
1593e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1594e22bee78STejun Heo  * bound), %false if offline.
1595e22bee78STejun Heo  */
1596e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1597972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1598e22bee78STejun Heo {
1599bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1600e22bee78STejun Heo 	struct task_struct *task = worker->task;
1601e22bee78STejun Heo 
1602e22bee78STejun Heo 	while (true) {
1603e22bee78STejun Heo 		/*
1604e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1605e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1606e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1607e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1608e22bee78STejun Heo 		 */
1609f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1610e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1611e22bee78STejun Heo 
1612e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1613e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1614e22bee78STejun Heo 			return false;
1615e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1616e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1617e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1618e22bee78STejun Heo 			return true;
1619e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1620e22bee78STejun Heo 
16215035b20fSTejun Heo 		/*
16225035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
16235035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
16245035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
16255035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
16265035b20fSTejun Heo 		 */
1627e22bee78STejun Heo 		cpu_relax();
16285035b20fSTejun Heo 		cond_resched();
1629e22bee78STejun Heo 	}
1630e22bee78STejun Heo }
1631e22bee78STejun Heo 
1632e22bee78STejun Heo /*
1633ea1abd61SLai Jiangshan  * Rebind an idle @worker to its CPU.  worker_thread() will test
16345f7dabfdSLai Jiangshan  * list_empty(@worker->entry) before leaving idle and call this function.
163525511a47STejun Heo  */
163625511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
163725511a47STejun Heo {
163825511a47STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
163925511a47STejun Heo 
16405f7dabfdSLai Jiangshan 	/* CPU may go down again inbetween, clear UNBOUND only on success */
16415f7dabfdSLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
16425f7dabfdSLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
1643ea1abd61SLai Jiangshan 
1644ea1abd61SLai Jiangshan 	/* rebind complete, become available again */
1645ea1abd61SLai Jiangshan 	list_add(&worker->entry, &worker->pool->idle_list);
1646ea1abd61SLai Jiangshan 	spin_unlock_irq(&gcwq->lock);
164725511a47STejun Heo }
164825511a47STejun Heo 
164925511a47STejun Heo /*
165025511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1651403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1652403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1653403c821dSTejun Heo  * executed twice without intervening cpu down.
1654e22bee78STejun Heo  */
165525511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1656e22bee78STejun Heo {
1657e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1658bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1659e22bee78STejun Heo 
1660eab6d828SLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
1661eab6d828SLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
1662e22bee78STejun Heo 
1663e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1664e22bee78STejun Heo }
1665e22bee78STejun Heo 
166625511a47STejun Heo /**
166725511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
166825511a47STejun Heo  * @gcwq: gcwq of interest
166925511a47STejun Heo  *
167025511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
167125511a47STejun Heo  * is different for idle and busy ones.
167225511a47STejun Heo  *
1673ea1abd61SLai Jiangshan  * Idle ones will be removed from the idle_list and woken up.  They will
1674ea1abd61SLai Jiangshan  * add themselves back after completing rebind.  This ensures that the
1675ea1abd61SLai Jiangshan  * idle_list doesn't contain any unbound workers when re-bound busy workers
1676ea1abd61SLai Jiangshan  * try to perform local wake-ups for concurrency management.
167725511a47STejun Heo  *
1678ea1abd61SLai Jiangshan  * Busy workers can rebind after they finish their current work items.
1679ea1abd61SLai Jiangshan  * Queueing the rebind work item at the head of the scheduled list is
1680ea1abd61SLai Jiangshan  * enough.  Note that nr_running will be properly bumped as busy workers
1681ea1abd61SLai Jiangshan  * rebind.
168225511a47STejun Heo  *
1683ea1abd61SLai Jiangshan  * On return, all non-manager workers are scheduled for rebind - see
1684ea1abd61SLai Jiangshan  * manage_workers() for the manager special case.  Any idle worker
1685ea1abd61SLai Jiangshan  * including the manager will not appear on @idle_list until rebind is
1686ea1abd61SLai Jiangshan  * complete, making local wake-ups safe.
168725511a47STejun Heo  */
168825511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
168925511a47STejun Heo {
169025511a47STejun Heo 	struct worker_pool *pool;
1691ea1abd61SLai Jiangshan 	struct worker *worker, *n;
169225511a47STejun Heo 	struct hlist_node *pos;
169325511a47STejun Heo 	int i;
169425511a47STejun Heo 
169525511a47STejun Heo 	lockdep_assert_held(&gcwq->lock);
169625511a47STejun Heo 
169725511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
1698b2eb83d1SLai Jiangshan 		lockdep_assert_held(&pool->assoc_mutex);
169925511a47STejun Heo 
17005f7dabfdSLai Jiangshan 	/* dequeue and kick idle ones */
170125511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
1702ea1abd61SLai Jiangshan 		list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1703ea1abd61SLai Jiangshan 			/*
1704ea1abd61SLai Jiangshan 			 * idle workers should be off @pool->idle_list
1705ea1abd61SLai Jiangshan 			 * until rebind is complete to avoid receiving
1706ea1abd61SLai Jiangshan 			 * premature local wake-ups.
1707ea1abd61SLai Jiangshan 			 */
1708ea1abd61SLai Jiangshan 			list_del_init(&worker->entry);
170925511a47STejun Heo 
17105f7dabfdSLai Jiangshan 			/*
17115f7dabfdSLai Jiangshan 			 * worker_thread() will see the above dequeuing
17125f7dabfdSLai Jiangshan 			 * and call idle_worker_rebind().
17135f7dabfdSLai Jiangshan 			 */
171425511a47STejun Heo 			wake_up_process(worker->task);
171525511a47STejun Heo 		}
171625511a47STejun Heo 	}
171725511a47STejun Heo 
1718ea1abd61SLai Jiangshan 	/* rebind busy workers */
171925511a47STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
172025511a47STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
1721e2b6a6d5SJoonsoo Kim 		struct workqueue_struct *wq;
172225511a47STejun Heo 
172325511a47STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
172425511a47STejun Heo 				     work_data_bits(rebind_work)))
172525511a47STejun Heo 			continue;
172625511a47STejun Heo 
172725511a47STejun Heo 		debug_work_activate(rebind_work);
1728e2b6a6d5SJoonsoo Kim 
1729e2b6a6d5SJoonsoo Kim 		/*
1730e2b6a6d5SJoonsoo Kim 		 * wq doesn't really matter but let's keep @worker->pool
1731e2b6a6d5SJoonsoo Kim 		 * and @cwq->pool consistent for sanity.
1732e2b6a6d5SJoonsoo Kim 		 */
1733e2b6a6d5SJoonsoo Kim 		if (worker_pool_pri(worker->pool))
1734e2b6a6d5SJoonsoo Kim 			wq = system_highpri_wq;
1735e2b6a6d5SJoonsoo Kim 		else
1736e2b6a6d5SJoonsoo Kim 			wq = system_wq;
1737e2b6a6d5SJoonsoo Kim 
1738e2b6a6d5SJoonsoo Kim 		insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
173925511a47STejun Heo 			worker->scheduled.next,
174025511a47STejun Heo 			work_color_to_flags(WORK_NO_COLOR));
174125511a47STejun Heo 	}
174225511a47STejun Heo }
174325511a47STejun Heo 
1744c34056a3STejun Heo static struct worker *alloc_worker(void)
1745c34056a3STejun Heo {
1746c34056a3STejun Heo 	struct worker *worker;
1747c34056a3STejun Heo 
1748c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1749c8e55f36STejun Heo 	if (worker) {
1750c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1751affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
175225511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1753e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1754e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1755c8e55f36STejun Heo 	}
1756c34056a3STejun Heo 	return worker;
1757c34056a3STejun Heo }
1758c34056a3STejun Heo 
1759c34056a3STejun Heo /**
1760c34056a3STejun Heo  * create_worker - create a new workqueue worker
176163d95a91STejun Heo  * @pool: pool the new worker will belong to
1762c34056a3STejun Heo  *
176363d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1764c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1765c34056a3STejun Heo  * destroy_worker().
1766c34056a3STejun Heo  *
1767c34056a3STejun Heo  * CONTEXT:
1768c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1769c34056a3STejun Heo  *
1770c34056a3STejun Heo  * RETURNS:
1771c34056a3STejun Heo  * Pointer to the newly created worker.
1772c34056a3STejun Heo  */
1773bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1774c34056a3STejun Heo {
177563d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
17763270476aSTejun Heo 	const char *pri = worker_pool_pri(pool) ? "H" : "";
1777c34056a3STejun Heo 	struct worker *worker = NULL;
1778f3421797STejun Heo 	int id = -1;
1779c34056a3STejun Heo 
17808b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1781bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
17828b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1783bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1784c34056a3STejun Heo 			goto fail;
17858b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1786c34056a3STejun Heo 	}
17878b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1788c34056a3STejun Heo 
1789c34056a3STejun Heo 	worker = alloc_worker();
1790c34056a3STejun Heo 	if (!worker)
1791c34056a3STejun Heo 		goto fail;
1792c34056a3STejun Heo 
1793bd7bdd43STejun Heo 	worker->pool = pool;
1794c34056a3STejun Heo 	worker->id = id;
1795c34056a3STejun Heo 
1796bc2ae0f5STejun Heo 	if (gcwq->cpu != WORK_CPU_UNBOUND)
179794dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
17983270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
17993270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1800f3421797STejun Heo 	else
1801f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
18023270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1803c34056a3STejun Heo 	if (IS_ERR(worker->task))
1804c34056a3STejun Heo 		goto fail;
1805c34056a3STejun Heo 
18063270476aSTejun Heo 	if (worker_pool_pri(pool))
18073270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
18083270476aSTejun Heo 
1809db7bccf4STejun Heo 	/*
1810bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
1811bc2ae0f5STejun Heo 	 * %GCWQ_DISASSOCIATED.  The caller is responsible for ensuring the
1812bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1813bc2ae0f5STejun Heo 	 * above the flag definition for details.
1814bc2ae0f5STejun Heo 	 *
1815bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1816bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1817db7bccf4STejun Heo 	 */
1818bc2ae0f5STejun Heo 	if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
18198b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1820bc2ae0f5STejun Heo 	} else {
1821db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1822f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1823f3421797STejun Heo 	}
1824c34056a3STejun Heo 
1825c34056a3STejun Heo 	return worker;
1826c34056a3STejun Heo fail:
1827c34056a3STejun Heo 	if (id >= 0) {
18288b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1829bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
18308b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1831c34056a3STejun Heo 	}
1832c34056a3STejun Heo 	kfree(worker);
1833c34056a3STejun Heo 	return NULL;
1834c34056a3STejun Heo }
1835c34056a3STejun Heo 
1836c34056a3STejun Heo /**
1837c34056a3STejun Heo  * start_worker - start a newly created worker
1838c34056a3STejun Heo  * @worker: worker to start
1839c34056a3STejun Heo  *
1840c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1841c34056a3STejun Heo  *
1842c34056a3STejun Heo  * CONTEXT:
18438b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1844c34056a3STejun Heo  */
1845c34056a3STejun Heo static void start_worker(struct worker *worker)
1846c34056a3STejun Heo {
1847cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1848bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1849c8e55f36STejun Heo 	worker_enter_idle(worker);
1850c34056a3STejun Heo 	wake_up_process(worker->task);
1851c34056a3STejun Heo }
1852c34056a3STejun Heo 
1853c34056a3STejun Heo /**
1854c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1855c34056a3STejun Heo  * @worker: worker to be destroyed
1856c34056a3STejun Heo  *
1857c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1858c8e55f36STejun Heo  *
1859c8e55f36STejun Heo  * CONTEXT:
1860c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1861c34056a3STejun Heo  */
1862c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1863c34056a3STejun Heo {
1864bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1865bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1866c34056a3STejun Heo 	int id = worker->id;
1867c34056a3STejun Heo 
1868c34056a3STejun Heo 	/* sanity check frenzy */
1869c34056a3STejun Heo 	BUG_ON(worker->current_work);
1870affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1871c34056a3STejun Heo 
1872c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1873bd7bdd43STejun Heo 		pool->nr_workers--;
1874c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1875bd7bdd43STejun Heo 		pool->nr_idle--;
1876c8e55f36STejun Heo 
1877c8e55f36STejun Heo 	list_del_init(&worker->entry);
1878cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1879c8e55f36STejun Heo 
1880c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1881c8e55f36STejun Heo 
1882c34056a3STejun Heo 	kthread_stop(worker->task);
1883c34056a3STejun Heo 	kfree(worker);
1884c34056a3STejun Heo 
18858b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1886bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1887c34056a3STejun Heo }
1888c34056a3STejun Heo 
188963d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1890e22bee78STejun Heo {
189163d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
189263d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1893e22bee78STejun Heo 
1894e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1895e22bee78STejun Heo 
189663d95a91STejun Heo 	if (too_many_workers(pool)) {
1897e22bee78STejun Heo 		struct worker *worker;
1898e22bee78STejun Heo 		unsigned long expires;
1899e22bee78STejun Heo 
1900e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
190163d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1902e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1903e22bee78STejun Heo 
1904e22bee78STejun Heo 		if (time_before(jiffies, expires))
190563d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1906e22bee78STejun Heo 		else {
1907e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
190811ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
190963d95a91STejun Heo 			wake_up_worker(pool);
1910e22bee78STejun Heo 		}
1911e22bee78STejun Heo 	}
1912e22bee78STejun Heo 
1913e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1914e22bee78STejun Heo }
1915e22bee78STejun Heo 
1916e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1917e22bee78STejun Heo {
1918e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1919e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1920f3421797STejun Heo 	unsigned int cpu;
1921e22bee78STejun Heo 
1922e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1923e22bee78STejun Heo 		return false;
1924e22bee78STejun Heo 
1925e22bee78STejun Heo 	/* mayday mayday mayday */
1926bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1927f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1928f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1929f3421797STejun Heo 		cpu = 0;
1930f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1931e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1932e22bee78STejun Heo 	return true;
1933e22bee78STejun Heo }
1934e22bee78STejun Heo 
193563d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1936e22bee78STejun Heo {
193763d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
193863d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1939e22bee78STejun Heo 	struct work_struct *work;
1940e22bee78STejun Heo 
1941e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1942e22bee78STejun Heo 
194363d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1944e22bee78STejun Heo 		/*
1945e22bee78STejun Heo 		 * We've been trying to create a new worker but
1946e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1947e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1948e22bee78STejun Heo 		 * rescuers.
1949e22bee78STejun Heo 		 */
195063d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1951e22bee78STejun Heo 			send_mayday(work);
1952e22bee78STejun Heo 	}
1953e22bee78STejun Heo 
1954e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1955e22bee78STejun Heo 
195663d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1957e22bee78STejun Heo }
1958e22bee78STejun Heo 
1959e22bee78STejun Heo /**
1960e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
196163d95a91STejun Heo  * @pool: pool to create a new worker for
1962e22bee78STejun Heo  *
196363d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1964e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1965e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
196663d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1967e22bee78STejun Heo  * possible allocation deadlock.
1968e22bee78STejun Heo  *
1969e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1970e22bee78STejun Heo  * may_start_working() true.
1971e22bee78STejun Heo  *
1972e22bee78STejun Heo  * LOCKING:
1973e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1974e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1975e22bee78STejun Heo  * manager.
1976e22bee78STejun Heo  *
1977e22bee78STejun Heo  * RETURNS:
1978e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1979e22bee78STejun Heo  * otherwise.
1980e22bee78STejun Heo  */
198163d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
198206bd6ebfSNamhyung Kim __releases(&gcwq->lock)
198306bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1984e22bee78STejun Heo {
198563d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
198663d95a91STejun Heo 
198763d95a91STejun Heo 	if (!need_to_create_worker(pool))
1988e22bee78STejun Heo 		return false;
1989e22bee78STejun Heo restart:
19909f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
19919f9c2364STejun Heo 
1992e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
199363d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1994e22bee78STejun Heo 
1995e22bee78STejun Heo 	while (true) {
1996e22bee78STejun Heo 		struct worker *worker;
1997e22bee78STejun Heo 
1998bc2ae0f5STejun Heo 		worker = create_worker(pool);
1999e22bee78STejun Heo 		if (worker) {
200063d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
2001e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
2002e22bee78STejun Heo 			start_worker(worker);
200363d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
2004e22bee78STejun Heo 			return true;
2005e22bee78STejun Heo 		}
2006e22bee78STejun Heo 
200763d95a91STejun Heo 		if (!need_to_create_worker(pool))
2008e22bee78STejun Heo 			break;
2009e22bee78STejun Heo 
2010e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
2011e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
20129f9c2364STejun Heo 
201363d95a91STejun Heo 		if (!need_to_create_worker(pool))
2014e22bee78STejun Heo 			break;
2015e22bee78STejun Heo 	}
2016e22bee78STejun Heo 
201763d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2018e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
201963d95a91STejun Heo 	if (need_to_create_worker(pool))
2020e22bee78STejun Heo 		goto restart;
2021e22bee78STejun Heo 	return true;
2022e22bee78STejun Heo }
2023e22bee78STejun Heo 
2024e22bee78STejun Heo /**
2025e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
202663d95a91STejun Heo  * @pool: pool to destroy workers for
2027e22bee78STejun Heo  *
202863d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
2029e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
2030e22bee78STejun Heo  *
2031e22bee78STejun Heo  * LOCKING:
2032e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2033e22bee78STejun Heo  * multiple times.  Called only from manager.
2034e22bee78STejun Heo  *
2035e22bee78STejun Heo  * RETURNS:
2036e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
2037e22bee78STejun Heo  * otherwise.
2038e22bee78STejun Heo  */
203963d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
2040e22bee78STejun Heo {
2041e22bee78STejun Heo 	bool ret = false;
2042e22bee78STejun Heo 
204363d95a91STejun Heo 	while (too_many_workers(pool)) {
2044e22bee78STejun Heo 		struct worker *worker;
2045e22bee78STejun Heo 		unsigned long expires;
2046e22bee78STejun Heo 
204763d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2048e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2049e22bee78STejun Heo 
2050e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
205163d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2052e22bee78STejun Heo 			break;
2053e22bee78STejun Heo 		}
2054e22bee78STejun Heo 
2055e22bee78STejun Heo 		destroy_worker(worker);
2056e22bee78STejun Heo 		ret = true;
2057e22bee78STejun Heo 	}
2058e22bee78STejun Heo 
2059e22bee78STejun Heo 	return ret;
2060e22bee78STejun Heo }
2061e22bee78STejun Heo 
2062e22bee78STejun Heo /**
2063e22bee78STejun Heo  * manage_workers - manage worker pool
2064e22bee78STejun Heo  * @worker: self
2065e22bee78STejun Heo  *
2066e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
2067e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2068e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
2069e22bee78STejun Heo  *
2070e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2071e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2072e22bee78STejun Heo  * and may_start_working() is true.
2073e22bee78STejun Heo  *
2074e22bee78STejun Heo  * CONTEXT:
2075e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2076e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2077e22bee78STejun Heo  *
2078e22bee78STejun Heo  * RETURNS:
2079e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
2080e22bee78STejun Heo  * some action was taken.
2081e22bee78STejun Heo  */
2082e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2083e22bee78STejun Heo {
208463d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2085e22bee78STejun Heo 	bool ret = false;
2086e22bee78STejun Heo 
2087ee378aa4SLai Jiangshan 	if (pool->flags & POOL_MANAGING_WORKERS)
2088e22bee78STejun Heo 		return ret;
2089e22bee78STejun Heo 
2090552a37e9SLai Jiangshan 	pool->flags |= POOL_MANAGING_WORKERS;
2091ee378aa4SLai Jiangshan 
2092ee378aa4SLai Jiangshan 	/*
2093ee378aa4SLai Jiangshan 	 * To simplify both worker management and CPU hotplug, hold off
2094ee378aa4SLai Jiangshan 	 * management while hotplug is in progress.  CPU hotplug path can't
2095ee378aa4SLai Jiangshan 	 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2096ee378aa4SLai Jiangshan 	 * lead to idle worker depletion (all become busy thinking someone
2097ee378aa4SLai Jiangshan 	 * else is managing) which in turn can result in deadlock under
2098b2eb83d1SLai Jiangshan 	 * extreme circumstances.  Use @pool->assoc_mutex to synchronize
2099ee378aa4SLai Jiangshan 	 * manager against CPU hotplug.
2100ee378aa4SLai Jiangshan 	 *
2101b2eb83d1SLai Jiangshan 	 * assoc_mutex would always be free unless CPU hotplug is in
2102ee378aa4SLai Jiangshan 	 * progress.  trylock first without dropping @gcwq->lock.
2103ee378aa4SLai Jiangshan 	 */
2104b2eb83d1SLai Jiangshan 	if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
2105ee378aa4SLai Jiangshan 		spin_unlock_irq(&pool->gcwq->lock);
2106b2eb83d1SLai Jiangshan 		mutex_lock(&pool->assoc_mutex);
2107ee378aa4SLai Jiangshan 		/*
2108ee378aa4SLai Jiangshan 		 * CPU hotplug could have happened while we were waiting
2109b2eb83d1SLai Jiangshan 		 * for assoc_mutex.  Hotplug itself can't handle us
2110ee378aa4SLai Jiangshan 		 * because manager isn't either on idle or busy list, and
2111ee378aa4SLai Jiangshan 		 * @gcwq's state and ours could have deviated.
2112ee378aa4SLai Jiangshan 		 *
2113b2eb83d1SLai Jiangshan 		 * As hotplug is now excluded via assoc_mutex, we can
2114ee378aa4SLai Jiangshan 		 * simply try to bind.  It will succeed or fail depending
2115ee378aa4SLai Jiangshan 		 * on @gcwq's current state.  Try it and adjust
2116ee378aa4SLai Jiangshan 		 * %WORKER_UNBOUND accordingly.
2117ee378aa4SLai Jiangshan 		 */
2118ee378aa4SLai Jiangshan 		if (worker_maybe_bind_and_lock(worker))
2119ee378aa4SLai Jiangshan 			worker->flags &= ~WORKER_UNBOUND;
2120ee378aa4SLai Jiangshan 		else
2121ee378aa4SLai Jiangshan 			worker->flags |= WORKER_UNBOUND;
2122ee378aa4SLai Jiangshan 
2123ee378aa4SLai Jiangshan 		ret = true;
2124ee378aa4SLai Jiangshan 	}
2125ee378aa4SLai Jiangshan 
212611ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2127e22bee78STejun Heo 
2128e22bee78STejun Heo 	/*
2129e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2130e22bee78STejun Heo 	 * on return.
2131e22bee78STejun Heo 	 */
213263d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
213363d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2134e22bee78STejun Heo 
2135552a37e9SLai Jiangshan 	pool->flags &= ~POOL_MANAGING_WORKERS;
2136b2eb83d1SLai Jiangshan 	mutex_unlock(&pool->assoc_mutex);
2137e22bee78STejun Heo 	return ret;
2138e22bee78STejun Heo }
2139e22bee78STejun Heo 
2140a62428c0STejun Heo /**
2141a62428c0STejun Heo  * process_one_work - process single work
2142c34056a3STejun Heo  * @worker: self
2143a62428c0STejun Heo  * @work: work to process
2144a62428c0STejun Heo  *
2145a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2146a62428c0STejun Heo  * process a single work including synchronization against and
2147a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2148a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2149a62428c0STejun Heo  * call this function to process a work.
2150a62428c0STejun Heo  *
2151a62428c0STejun Heo  * CONTEXT:
21528b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
2153a62428c0STejun Heo  */
2154c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
215506bd6ebfSNamhyung Kim __releases(&gcwq->lock)
215606bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
21571da177e4SLinus Torvalds {
21587e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2159bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2160bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
2161c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
2162fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
21636bb49e59SDavid Howells 	work_func_t f = work->func;
216473f53c4aSTejun Heo 	int work_color;
21657e11629dSTejun Heo 	struct worker *collision;
21664e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21674e6045f1SJohannes Berg 	/*
2168a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2169a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2170a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2171a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2172a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21734e6045f1SJohannes Berg 	 */
21744d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21754d82a1deSPeter Zijlstra 
21764d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21774e6045f1SJohannes Berg #endif
21786fec10a1STejun Heo 	/*
21796fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21806fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
21816fec10a1STejun Heo 	 * unbound or a disassociated gcwq.
21826fec10a1STejun Heo 	 */
21835f7dabfdSLai Jiangshan 	WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
21846fec10a1STejun Heo 		     !(gcwq->flags & GCWQ_DISASSOCIATED) &&
218525511a47STejun Heo 		     raw_smp_processor_id() != gcwq->cpu);
218625511a47STejun Heo 
21877e11629dSTejun Heo 	/*
21887e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21897e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21907e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21917e11629dSTejun Heo 	 * currently executing one.
21927e11629dSTejun Heo 	 */
21937e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
21947e11629dSTejun Heo 	if (unlikely(collision)) {
21957e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21967e11629dSTejun Heo 		return;
21977e11629dSTejun Heo 	}
21981da177e4SLinus Torvalds 
21998930cabaSTejun Heo 	/* claim and dequeue */
22001da177e4SLinus Torvalds 	debug_work_deactivate(work);
2201c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
2202c34056a3STejun Heo 	worker->current_work = work;
22038cca0eeaSTejun Heo 	worker->current_cwq = cwq;
220473f53c4aSTejun Heo 	work_color = get_work_color(work);
22057a22ad75STejun Heo 
2206a62428c0STejun Heo 	list_del_init(&work->entry);
2207a62428c0STejun Heo 
2208649027d7STejun Heo 	/*
2209fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2210fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2211fb0e7bebSTejun Heo 	 */
2212fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2213fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2214fb0e7bebSTejun Heo 
2215974271c4STejun Heo 	/*
2216974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
2217974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2218974271c4STejun Heo 	 */
221963d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
222063d95a91STejun Heo 		wake_up_worker(pool);
2221974271c4STejun Heo 
22228930cabaSTejun Heo 	/*
222323657bb1STejun Heo 	 * Record the last CPU and clear PENDING which should be the last
222423657bb1STejun Heo 	 * update to @work.  Also, do this inside @gcwq->lock so that
222523657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
222623657bb1STejun Heo 	 * disabled.
22278930cabaSTejun Heo 	 */
22288930cabaSTejun Heo 	set_work_cpu_and_clear_pending(work, gcwq->cpu);
22291da177e4SLinus Torvalds 
22308930cabaSTejun Heo 	spin_unlock_irq(&gcwq->lock);
2231959d1af8STejun Heo 
2232e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
22333295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2234e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
223565f27f38SDavid Howells 	f(work);
2236e36c886aSArjan van de Ven 	/*
2237e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2238e36c886aSArjan van de Ven 	 * point will only record its address.
2239e36c886aSArjan van de Ven 	 */
2240e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22413295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
22423295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
22431da177e4SLinus Torvalds 
2244d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2245044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2246044c782cSValentin Ilie 		       "     last function: %pf\n",
2247044c782cSValentin Ilie 		       current->comm, preempt_count(), task_pid_nr(current), f);
2248d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2249d5abe669SPeter Zijlstra 		dump_stack();
2250d5abe669SPeter Zijlstra 	}
2251d5abe669SPeter Zijlstra 
22528b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2253a62428c0STejun Heo 
2254fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2255fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2256fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2257fb0e7bebSTejun Heo 
2258a62428c0STejun Heo 	/* we're done with it, release */
2259c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
2260c34056a3STejun Heo 	worker->current_work = NULL;
22618cca0eeaSTejun Heo 	worker->current_cwq = NULL;
2262b3f9f405SLai Jiangshan 	cwq_dec_nr_in_flight(cwq, work_color);
22631da177e4SLinus Torvalds }
22641da177e4SLinus Torvalds 
2265affee4b2STejun Heo /**
2266affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2267affee4b2STejun Heo  * @worker: self
2268affee4b2STejun Heo  *
2269affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2270affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2271affee4b2STejun Heo  * fetches a work from the top and executes it.
2272affee4b2STejun Heo  *
2273affee4b2STejun Heo  * CONTEXT:
22748b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2275affee4b2STejun Heo  * multiple times.
2276affee4b2STejun Heo  */
2277affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22781da177e4SLinus Torvalds {
2279affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2280affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2281a62428c0STejun Heo 						struct work_struct, entry);
2282c34056a3STejun Heo 		process_one_work(worker, work);
2283a62428c0STejun Heo 	}
22841da177e4SLinus Torvalds }
22851da177e4SLinus Torvalds 
22864690c4abSTejun Heo /**
22874690c4abSTejun Heo  * worker_thread - the worker thread function
2288c34056a3STejun Heo  * @__worker: self
22894690c4abSTejun Heo  *
2290e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2291e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2292e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2293e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2294e22bee78STejun Heo  * rescuer_thread().
22954690c4abSTejun Heo  */
2296c34056a3STejun Heo static int worker_thread(void *__worker)
22971da177e4SLinus Torvalds {
2298c34056a3STejun Heo 	struct worker *worker = __worker;
2299bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2300bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
23011da177e4SLinus Torvalds 
2302e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2303e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2304c8e55f36STejun Heo woke_up:
23058b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2306affee4b2STejun Heo 
23075f7dabfdSLai Jiangshan 	/* we are off idle list if destruction or rebind is requested */
23085f7dabfdSLai Jiangshan 	if (unlikely(list_empty(&worker->entry))) {
2309c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
231025511a47STejun Heo 
23115f7dabfdSLai Jiangshan 		/* if DIE is set, destruction is requested */
231225511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2313e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2314c8e55f36STejun Heo 			return 0;
2315c8e55f36STejun Heo 		}
2316c8e55f36STejun Heo 
23175f7dabfdSLai Jiangshan 		/* otherwise, rebind */
231825511a47STejun Heo 		idle_worker_rebind(worker);
231925511a47STejun Heo 		goto woke_up;
232025511a47STejun Heo 	}
232125511a47STejun Heo 
2322c8e55f36STejun Heo 	worker_leave_idle(worker);
2323db7bccf4STejun Heo recheck:
2324e22bee78STejun Heo 	/* no more worker necessary? */
232563d95a91STejun Heo 	if (!need_more_worker(pool))
2326e22bee78STejun Heo 		goto sleep;
2327e22bee78STejun Heo 
2328e22bee78STejun Heo 	/* do we need to manage? */
232963d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2330e22bee78STejun Heo 		goto recheck;
2331e22bee78STejun Heo 
2332c8e55f36STejun Heo 	/*
2333c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2334c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2335c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2336c8e55f36STejun Heo 	 */
2337c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2338c8e55f36STejun Heo 
2339e22bee78STejun Heo 	/*
2340e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2341e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2342e22bee78STejun Heo 	 * assumed the manager role.
2343e22bee78STejun Heo 	 */
2344e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2345e22bee78STejun Heo 
2346e22bee78STejun Heo 	do {
2347affee4b2STejun Heo 		struct work_struct *work =
2348bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2349affee4b2STejun Heo 					 struct work_struct, entry);
2350affee4b2STejun Heo 
2351c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2352affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2353affee4b2STejun Heo 			process_one_work(worker, work);
2354affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2355affee4b2STejun Heo 				process_scheduled_works(worker);
2356affee4b2STejun Heo 		} else {
2357c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2358affee4b2STejun Heo 			process_scheduled_works(worker);
2359affee4b2STejun Heo 		}
236063d95a91STejun Heo 	} while (keep_working(pool));
2361affee4b2STejun Heo 
2362e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2363d313dd85STejun Heo sleep:
236463d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2365e22bee78STejun Heo 		goto recheck;
2366d313dd85STejun Heo 
2367c8e55f36STejun Heo 	/*
2368e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2369e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2370e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2371e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2372e22bee78STejun Heo 	 * prevent losing any event.
2373c8e55f36STejun Heo 	 */
2374c8e55f36STejun Heo 	worker_enter_idle(worker);
2375c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
23768b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23771da177e4SLinus Torvalds 	schedule();
2378c8e55f36STejun Heo 	goto woke_up;
23791da177e4SLinus Torvalds }
23801da177e4SLinus Torvalds 
2381e22bee78STejun Heo /**
2382e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2383e22bee78STejun Heo  * @__wq: the associated workqueue
2384e22bee78STejun Heo  *
2385e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2386e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2387e22bee78STejun Heo  *
2388e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2389e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2390e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2391e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2392e22bee78STejun Heo  * the problem rescuer solves.
2393e22bee78STejun Heo  *
2394e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2395e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2396e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2397e22bee78STejun Heo  *
2398e22bee78STejun Heo  * This should happen rarely.
2399e22bee78STejun Heo  */
2400e22bee78STejun Heo static int rescuer_thread(void *__wq)
2401e22bee78STejun Heo {
2402e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2403e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2404e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2405f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2406e22bee78STejun Heo 	unsigned int cpu;
2407e22bee78STejun Heo 
2408e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2409e22bee78STejun Heo repeat:
2410e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
24111da177e4SLinus Torvalds 
24121da177e4SLinus Torvalds 	if (kthread_should_stop())
2413e22bee78STejun Heo 		return 0;
24141da177e4SLinus Torvalds 
2415f3421797STejun Heo 	/*
2416f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2417f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2418f3421797STejun Heo 	 */
2419f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2420f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2421f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2422bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2423bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2424e22bee78STejun Heo 		struct work_struct *work, *n;
2425e22bee78STejun Heo 
2426e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2427f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2428e22bee78STejun Heo 
2429e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2430bd7bdd43STejun Heo 		rescuer->pool = pool;
2431e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2432e22bee78STejun Heo 
2433e22bee78STejun Heo 		/*
2434e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2435e22bee78STejun Heo 		 * process'em.
2436e22bee78STejun Heo 		 */
2437e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2438bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2439e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2440e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2441e22bee78STejun Heo 
2442e22bee78STejun Heo 		process_scheduled_works(rescuer);
24437576958aSTejun Heo 
24447576958aSTejun Heo 		/*
24457576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
24467576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24477576958aSTejun Heo 		 * and stalling the execution.
24487576958aSTejun Heo 		 */
244963d95a91STejun Heo 		if (keep_working(pool))
245063d95a91STejun Heo 			wake_up_worker(pool);
24517576958aSTejun Heo 
2452e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
24531da177e4SLinus Torvalds 	}
24541da177e4SLinus Torvalds 
2455e22bee78STejun Heo 	schedule();
2456e22bee78STejun Heo 	goto repeat;
24571da177e4SLinus Torvalds }
24581da177e4SLinus Torvalds 
2459fc2e4d70SOleg Nesterov struct wq_barrier {
2460fc2e4d70SOleg Nesterov 	struct work_struct	work;
2461fc2e4d70SOleg Nesterov 	struct completion	done;
2462fc2e4d70SOleg Nesterov };
2463fc2e4d70SOleg Nesterov 
2464fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2465fc2e4d70SOleg Nesterov {
2466fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2467fc2e4d70SOleg Nesterov 	complete(&barr->done);
2468fc2e4d70SOleg Nesterov }
2469fc2e4d70SOleg Nesterov 
24704690c4abSTejun Heo /**
24714690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
24724690c4abSTejun Heo  * @cwq: cwq to insert barrier into
24734690c4abSTejun Heo  * @barr: wq_barrier to insert
2474affee4b2STejun Heo  * @target: target work to attach @barr to
2475affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24764690c4abSTejun Heo  *
2477affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2478affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2479affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2480affee4b2STejun Heo  * cpu.
2481affee4b2STejun Heo  *
2482affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2483affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2484affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2485affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2486affee4b2STejun Heo  * after a work with LINKED flag set.
2487affee4b2STejun Heo  *
2488affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2489affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
24904690c4abSTejun Heo  *
24914690c4abSTejun Heo  * CONTEXT:
24928b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
24934690c4abSTejun Heo  */
249483c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2495affee4b2STejun Heo 			      struct wq_barrier *barr,
2496affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2497fc2e4d70SOleg Nesterov {
2498affee4b2STejun Heo 	struct list_head *head;
2499affee4b2STejun Heo 	unsigned int linked = 0;
2500affee4b2STejun Heo 
2501dc186ad7SThomas Gleixner 	/*
25028b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2503dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2504dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2505dc186ad7SThomas Gleixner 	 * might deadlock.
2506dc186ad7SThomas Gleixner 	 */
2507ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
250822df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2509fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
251083c22520SOleg Nesterov 
2511affee4b2STejun Heo 	/*
2512affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2513affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2514affee4b2STejun Heo 	 */
2515affee4b2STejun Heo 	if (worker)
2516affee4b2STejun Heo 		head = worker->scheduled.next;
2517affee4b2STejun Heo 	else {
2518affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2519affee4b2STejun Heo 
2520affee4b2STejun Heo 		head = target->entry.next;
2521affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2522affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2523affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2524affee4b2STejun Heo 	}
2525affee4b2STejun Heo 
2526dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2527affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2528affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2529fc2e4d70SOleg Nesterov }
2530fc2e4d70SOleg Nesterov 
253173f53c4aSTejun Heo /**
253273f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
253373f53c4aSTejun Heo  * @wq: workqueue being flushed
253473f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
253573f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
253673f53c4aSTejun Heo  *
253773f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
253873f53c4aSTejun Heo  *
253973f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
254073f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
254173f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
254273f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
254373f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
254473f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
254573f53c4aSTejun Heo  *
254673f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
254773f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
254873f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
254973f53c4aSTejun Heo  * is returned.
255073f53c4aSTejun Heo  *
255173f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
255273f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
255373f53c4aSTejun Heo  * advanced to @work_color.
255473f53c4aSTejun Heo  *
255573f53c4aSTejun Heo  * CONTEXT:
255673f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
255773f53c4aSTejun Heo  *
255873f53c4aSTejun Heo  * RETURNS:
255973f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
256073f53c4aSTejun Heo  * otherwise.
256173f53c4aSTejun Heo  */
256273f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
256373f53c4aSTejun Heo 				      int flush_color, int work_color)
25641da177e4SLinus Torvalds {
256573f53c4aSTejun Heo 	bool wait = false;
256673f53c4aSTejun Heo 	unsigned int cpu;
25671da177e4SLinus Torvalds 
256873f53c4aSTejun Heo 	if (flush_color >= 0) {
256973f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
257073f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2571dc186ad7SThomas Gleixner 	}
257214441960SOleg Nesterov 
2573f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
257473f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2575bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
25761da177e4SLinus Torvalds 
25778b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
257873f53c4aSTejun Heo 
257973f53c4aSTejun Heo 		if (flush_color >= 0) {
258073f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
258173f53c4aSTejun Heo 
258273f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
258373f53c4aSTejun Heo 				cwq->flush_color = flush_color;
258473f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
258573f53c4aSTejun Heo 				wait = true;
25861da177e4SLinus Torvalds 			}
258773f53c4aSTejun Heo 		}
258873f53c4aSTejun Heo 
258973f53c4aSTejun Heo 		if (work_color >= 0) {
259073f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
259173f53c4aSTejun Heo 			cwq->work_color = work_color;
259273f53c4aSTejun Heo 		}
259373f53c4aSTejun Heo 
25948b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
25951da177e4SLinus Torvalds 	}
25961da177e4SLinus Torvalds 
259773f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
259873f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
259973f53c4aSTejun Heo 
260073f53c4aSTejun Heo 	return wait;
260183c22520SOleg Nesterov }
26021da177e4SLinus Torvalds 
26030fcb78c2SRolf Eike Beer /**
26041da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
26050fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
26061da177e4SLinus Torvalds  *
26071da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
26081da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
26091da177e4SLinus Torvalds  *
2610fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2611fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
26121da177e4SLinus Torvalds  */
26137ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
26141da177e4SLinus Torvalds {
261573f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
261673f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
261773f53c4aSTejun Heo 		.flush_color = -1,
261873f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
261973f53c4aSTejun Heo 	};
262073f53c4aSTejun Heo 	int next_color;
2621b1f4ec17SOleg Nesterov 
26223295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
26233295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
262473f53c4aSTejun Heo 
262573f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
262673f53c4aSTejun Heo 
262773f53c4aSTejun Heo 	/*
262873f53c4aSTejun Heo 	 * Start-to-wait phase
262973f53c4aSTejun Heo 	 */
263073f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
263173f53c4aSTejun Heo 
263273f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
263373f53c4aSTejun Heo 		/*
263473f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
263573f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
263673f53c4aSTejun Heo 		 * by one.
263773f53c4aSTejun Heo 		 */
263873f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
263973f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
264073f53c4aSTejun Heo 		wq->work_color = next_color;
264173f53c4aSTejun Heo 
264273f53c4aSTejun Heo 		if (!wq->first_flusher) {
264373f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
264473f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
264573f53c4aSTejun Heo 
264673f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
264773f53c4aSTejun Heo 
264873f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
264973f53c4aSTejun Heo 						       wq->work_color)) {
265073f53c4aSTejun Heo 				/* nothing to flush, done */
265173f53c4aSTejun Heo 				wq->flush_color = next_color;
265273f53c4aSTejun Heo 				wq->first_flusher = NULL;
265373f53c4aSTejun Heo 				goto out_unlock;
265473f53c4aSTejun Heo 			}
265573f53c4aSTejun Heo 		} else {
265673f53c4aSTejun Heo 			/* wait in queue */
265773f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
265873f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
265973f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
266073f53c4aSTejun Heo 		}
266173f53c4aSTejun Heo 	} else {
266273f53c4aSTejun Heo 		/*
266373f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
266473f53c4aSTejun Heo 		 * The next flush completion will assign us
266573f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
266673f53c4aSTejun Heo 		 */
266773f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
266873f53c4aSTejun Heo 	}
266973f53c4aSTejun Heo 
267073f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
267173f53c4aSTejun Heo 
267273f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
267373f53c4aSTejun Heo 
267473f53c4aSTejun Heo 	/*
267573f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
267673f53c4aSTejun Heo 	 *
267773f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
267873f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
267973f53c4aSTejun Heo 	 */
268073f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
268173f53c4aSTejun Heo 		return;
268273f53c4aSTejun Heo 
268373f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
268473f53c4aSTejun Heo 
26854ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26864ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26874ce48b37STejun Heo 		goto out_unlock;
26884ce48b37STejun Heo 
268973f53c4aSTejun Heo 	wq->first_flusher = NULL;
269073f53c4aSTejun Heo 
269173f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
269273f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
269373f53c4aSTejun Heo 
269473f53c4aSTejun Heo 	while (true) {
269573f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
269673f53c4aSTejun Heo 
269773f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
269873f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
269973f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
270073f53c4aSTejun Heo 				break;
270173f53c4aSTejun Heo 			list_del_init(&next->list);
270273f53c4aSTejun Heo 			complete(&next->done);
270373f53c4aSTejun Heo 		}
270473f53c4aSTejun Heo 
270573f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
270673f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
270773f53c4aSTejun Heo 
270873f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
270973f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
271073f53c4aSTejun Heo 
271173f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
271273f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
271373f53c4aSTejun Heo 			/*
271473f53c4aSTejun Heo 			 * Assign the same color to all overflowed
271573f53c4aSTejun Heo 			 * flushers, advance work_color and append to
271673f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
271773f53c4aSTejun Heo 			 * phase for these overflowed flushers.
271873f53c4aSTejun Heo 			 */
271973f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
272073f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
272173f53c4aSTejun Heo 
272273f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
272373f53c4aSTejun Heo 
272473f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
272573f53c4aSTejun Heo 					      &wq->flusher_queue);
272673f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
272773f53c4aSTejun Heo 		}
272873f53c4aSTejun Heo 
272973f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
273073f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
273173f53c4aSTejun Heo 			break;
273273f53c4aSTejun Heo 		}
273373f53c4aSTejun Heo 
273473f53c4aSTejun Heo 		/*
273573f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
273673f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
273773f53c4aSTejun Heo 		 */
273873f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
273973f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
274073f53c4aSTejun Heo 
274173f53c4aSTejun Heo 		list_del_init(&next->list);
274273f53c4aSTejun Heo 		wq->first_flusher = next;
274373f53c4aSTejun Heo 
274473f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
274573f53c4aSTejun Heo 			break;
274673f53c4aSTejun Heo 
274773f53c4aSTejun Heo 		/*
274873f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
274973f53c4aSTejun Heo 		 * flusher and repeat cascading.
275073f53c4aSTejun Heo 		 */
275173f53c4aSTejun Heo 		wq->first_flusher = NULL;
275273f53c4aSTejun Heo 	}
275373f53c4aSTejun Heo 
275473f53c4aSTejun Heo out_unlock:
275573f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
27561da177e4SLinus Torvalds }
2757ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27581da177e4SLinus Torvalds 
27599c5a2ba7STejun Heo /**
27609c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27619c5a2ba7STejun Heo  * @wq: workqueue to drain
27629c5a2ba7STejun Heo  *
27639c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27649c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27659c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27669c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27679c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27689c5a2ba7STejun Heo  * takes too long.
27699c5a2ba7STejun Heo  */
27709c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27719c5a2ba7STejun Heo {
27729c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
27739c5a2ba7STejun Heo 	unsigned int cpu;
27749c5a2ba7STejun Heo 
27759c5a2ba7STejun Heo 	/*
27769c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27779c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
27789c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
27799c5a2ba7STejun Heo 	 */
27809c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27819c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
27829c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
27839c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27849c5a2ba7STejun Heo reflush:
27859c5a2ba7STejun Heo 	flush_workqueue(wq);
27869c5a2ba7STejun Heo 
27879c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27889c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2789fa2563e4SThomas Tuttle 		bool drained;
27909c5a2ba7STejun Heo 
2791bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2792fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2793bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2794fa2563e4SThomas Tuttle 
2795fa2563e4SThomas Tuttle 		if (drained)
27969c5a2ba7STejun Heo 			continue;
27979c5a2ba7STejun Heo 
27989c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27999c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2800044c782cSValentin Ilie 			pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
28019c5a2ba7STejun Heo 				wq->name, flush_cnt);
28029c5a2ba7STejun Heo 		goto reflush;
28039c5a2ba7STejun Heo 	}
28049c5a2ba7STejun Heo 
28059c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
28069c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
28079c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
28089c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
28099c5a2ba7STejun Heo }
28109c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
28119c5a2ba7STejun Heo 
2812606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2813baf59022STejun Heo {
2814baf59022STejun Heo 	struct worker *worker = NULL;
2815baf59022STejun Heo 	struct global_cwq *gcwq;
2816baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2817baf59022STejun Heo 
2818baf59022STejun Heo 	might_sleep();
2819baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2820baf59022STejun Heo 	if (!gcwq)
2821baf59022STejun Heo 		return false;
2822baf59022STejun Heo 
2823baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2824baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2825baf59022STejun Heo 		/*
2826baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2827baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2828baf59022STejun Heo 		 * are not going to wait.
2829baf59022STejun Heo 		 */
2830baf59022STejun Heo 		smp_rmb();
2831baf59022STejun Heo 		cwq = get_work_cwq(work);
2832bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2833baf59022STejun Heo 			goto already_gone;
2834606a5020STejun Heo 	} else {
2835baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2836baf59022STejun Heo 		if (!worker)
2837baf59022STejun Heo 			goto already_gone;
2838baf59022STejun Heo 		cwq = worker->current_cwq;
2839606a5020STejun Heo 	}
2840baf59022STejun Heo 
2841baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2842baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2843baf59022STejun Heo 
2844e159489bSTejun Heo 	/*
2845e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2846e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2847e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2848e159489bSTejun Heo 	 * access.
2849e159489bSTejun Heo 	 */
2850e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2851baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2852e159489bSTejun Heo 	else
2853e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2854baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2855e159489bSTejun Heo 
2856baf59022STejun Heo 	return true;
2857baf59022STejun Heo already_gone:
2858baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2859baf59022STejun Heo 	return false;
2860baf59022STejun Heo }
2861baf59022STejun Heo 
2862db700897SOleg Nesterov /**
2863401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2864401a8d04STejun Heo  * @work: the work to flush
2865db700897SOleg Nesterov  *
2866606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2867606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2868401a8d04STejun Heo  *
2869401a8d04STejun Heo  * RETURNS:
2870401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2871401a8d04STejun Heo  * %false if it was already idle.
2872db700897SOleg Nesterov  */
2873401a8d04STejun Heo bool flush_work(struct work_struct *work)
2874db700897SOleg Nesterov {
2875db700897SOleg Nesterov 	struct wq_barrier barr;
2876db700897SOleg Nesterov 
28770976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28780976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28790976dfc1SStephen Boyd 
2880606a5020STejun Heo 	if (start_flush_work(work, &barr)) {
2881db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2882dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2883401a8d04STejun Heo 		return true;
2884606a5020STejun Heo 	} else {
2885401a8d04STejun Heo 		return false;
2886db700897SOleg Nesterov 	}
2887606a5020STejun Heo }
2888db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2889db700897SOleg Nesterov 
289036e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
28911f1f642eSOleg Nesterov {
2892bbb68dfaSTejun Heo 	unsigned long flags;
28931f1f642eSOleg Nesterov 	int ret;
28941f1f642eSOleg Nesterov 
28951f1f642eSOleg Nesterov 	do {
2896bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2897bbb68dfaSTejun Heo 		/*
2898bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2899bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2900bbb68dfaSTejun Heo 		 */
2901bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2902606a5020STejun Heo 			flush_work(work);
29031f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
29041f1f642eSOleg Nesterov 
2905bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2906bbb68dfaSTejun Heo 	mark_work_canceling(work);
2907bbb68dfaSTejun Heo 	local_irq_restore(flags);
2908bbb68dfaSTejun Heo 
2909606a5020STejun Heo 	flush_work(work);
29107a22ad75STejun Heo 	clear_work_data(work);
29111f1f642eSOleg Nesterov 	return ret;
29121f1f642eSOleg Nesterov }
29131f1f642eSOleg Nesterov 
29146e84d644SOleg Nesterov /**
2915401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2916401a8d04STejun Heo  * @work: the work to cancel
29176e84d644SOleg Nesterov  *
2918401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2919401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2920401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2921401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
29221f1f642eSOleg Nesterov  *
2923401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2924401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
29256e84d644SOleg Nesterov  *
2926401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
29276e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2928401a8d04STejun Heo  *
2929401a8d04STejun Heo  * RETURNS:
2930401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
29316e84d644SOleg Nesterov  */
2932401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29336e84d644SOleg Nesterov {
293436e227d2STejun Heo 	return __cancel_work_timer(work, false);
2935b89deed3SOleg Nesterov }
293628e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2937b89deed3SOleg Nesterov 
29386e84d644SOleg Nesterov /**
2939401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2940401a8d04STejun Heo  * @dwork: the delayed work to flush
29416e84d644SOleg Nesterov  *
2942401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2943401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2944401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29451f1f642eSOleg Nesterov  *
2946401a8d04STejun Heo  * RETURNS:
2947401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2948401a8d04STejun Heo  * %false if it was already idle.
29496e84d644SOleg Nesterov  */
2950401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2951401a8d04STejun Heo {
29528930cabaSTejun Heo 	local_irq_disable();
2953401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
29541265057fSTejun Heo 		__queue_work(dwork->cpu,
2955401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
29568930cabaSTejun Heo 	local_irq_enable();
2957401a8d04STejun Heo 	return flush_work(&dwork->work);
2958401a8d04STejun Heo }
2959401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2960401a8d04STejun Heo 
2961401a8d04STejun Heo /**
296257b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
296357b30ae7STejun Heo  * @dwork: delayed_work to cancel
296457b30ae7STejun Heo  *
296557b30ae7STejun Heo  * Kill off a pending delayed_work.  Returns %true if @dwork was pending
296657b30ae7STejun Heo  * and canceled; %false if wasn't pending.  Note that the work callback
296757b30ae7STejun Heo  * function may still be running on return, unless it returns %true and the
296857b30ae7STejun Heo  * work doesn't re-arm itself.  Explicitly flush or use
296957b30ae7STejun Heo  * cancel_delayed_work_sync() to wait on it.
297057b30ae7STejun Heo  *
297157b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
297257b30ae7STejun Heo  */
297357b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
297457b30ae7STejun Heo {
297557b30ae7STejun Heo 	unsigned long flags;
297657b30ae7STejun Heo 	int ret;
297757b30ae7STejun Heo 
297857b30ae7STejun Heo 	do {
297957b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
298057b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
298157b30ae7STejun Heo 
298257b30ae7STejun Heo 	if (unlikely(ret < 0))
298357b30ae7STejun Heo 		return false;
298457b30ae7STejun Heo 
298557b30ae7STejun Heo 	set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
298657b30ae7STejun Heo 	local_irq_restore(flags);
298757b30ae7STejun Heo 	return true;
298857b30ae7STejun Heo }
298957b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
299057b30ae7STejun Heo 
299157b30ae7STejun Heo /**
2992401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2993401a8d04STejun Heo  * @dwork: the delayed work cancel
2994401a8d04STejun Heo  *
2995401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2996401a8d04STejun Heo  *
2997401a8d04STejun Heo  * RETURNS:
2998401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2999401a8d04STejun Heo  */
3000401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
30016e84d644SOleg Nesterov {
300236e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
30036e84d644SOleg Nesterov }
3004f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
30051da177e4SLinus Torvalds 
3006d4283e93STejun Heo /**
30070a13c00eSTejun Heo  * schedule_work_on - put work task on a specific cpu
30080a13c00eSTejun Heo  * @cpu: cpu to put the work task on
30090a13c00eSTejun Heo  * @work: job to be done
30100a13c00eSTejun Heo  *
30110a13c00eSTejun Heo  * This puts a job on a specific cpu
30120a13c00eSTejun Heo  */
3013d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work)
30140a13c00eSTejun Heo {
30150a13c00eSTejun Heo 	return queue_work_on(cpu, system_wq, work);
30160a13c00eSTejun Heo }
30170a13c00eSTejun Heo EXPORT_SYMBOL(schedule_work_on);
30180a13c00eSTejun Heo 
30190fcb78c2SRolf Eike Beer /**
30200fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
30210fcb78c2SRolf Eike Beer  * @work: job to be done
30220fcb78c2SRolf Eike Beer  *
3023d4283e93STejun Heo  * Returns %false if @work was already on the kernel-global workqueue and
3024d4283e93STejun Heo  * %true otherwise.
30255b0f437dSBart Van Assche  *
30265b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
30275b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
30285b0f437dSBart Van Assche  * workqueue otherwise.
30290fcb78c2SRolf Eike Beer  */
3030d4283e93STejun Heo bool schedule_work(struct work_struct *work)
30311da177e4SLinus Torvalds {
3032d320c038STejun Heo 	return queue_work(system_wq, work);
30331da177e4SLinus Torvalds }
3034ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
30351da177e4SLinus Torvalds 
30360fcb78c2SRolf Eike Beer /**
30370fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
30380fcb78c2SRolf Eike Beer  * @cpu: cpu to use
303952bad64dSDavid Howells  * @dwork: job to be done
30400fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
30410fcb78c2SRolf Eike Beer  *
30420fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
30430fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
30440fcb78c2SRolf Eike Beer  */
3045d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3046d4283e93STejun Heo 			      unsigned long delay)
30471da177e4SLinus Torvalds {
3048d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
30491da177e4SLinus Torvalds }
3050ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
30511da177e4SLinus Torvalds 
3052b6136773SAndrew Morton /**
30530a13c00eSTejun Heo  * schedule_delayed_work - put work task in global workqueue after delay
30540a13c00eSTejun Heo  * @dwork: job to be done
30550a13c00eSTejun Heo  * @delay: number of jiffies to wait or 0 for immediate execution
30560a13c00eSTejun Heo  *
30570a13c00eSTejun Heo  * After waiting for a given time this puts a job in the kernel-global
30580a13c00eSTejun Heo  * workqueue.
30590a13c00eSTejun Heo  */
3060d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
30610a13c00eSTejun Heo {
30620a13c00eSTejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
30630a13c00eSTejun Heo }
30640a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work);
30650a13c00eSTejun Heo 
30660a13c00eSTejun Heo /**
306731ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3068b6136773SAndrew Morton  * @func: the function to call
3069b6136773SAndrew Morton  *
307031ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
307131ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3072b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
307331ddd871STejun Heo  *
307431ddd871STejun Heo  * RETURNS:
307531ddd871STejun Heo  * 0 on success, -errno on failure.
3076b6136773SAndrew Morton  */
307765f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
307815316ba8SChristoph Lameter {
307915316ba8SChristoph Lameter 	int cpu;
308038f51568SNamhyung Kim 	struct work_struct __percpu *works;
308115316ba8SChristoph Lameter 
3082b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3083b6136773SAndrew Morton 	if (!works)
308415316ba8SChristoph Lameter 		return -ENOMEM;
3085b6136773SAndrew Morton 
308695402b38SGautham R Shenoy 	get_online_cpus();
308793981800STejun Heo 
308815316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
30899bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
30909bfb1839SIngo Molnar 
30919bfb1839SIngo Molnar 		INIT_WORK(work, func);
30928de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
309315316ba8SChristoph Lameter 	}
309493981800STejun Heo 
309593981800STejun Heo 	for_each_online_cpu(cpu)
30968616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
309793981800STejun Heo 
309895402b38SGautham R Shenoy 	put_online_cpus();
3099b6136773SAndrew Morton 	free_percpu(works);
310015316ba8SChristoph Lameter 	return 0;
310115316ba8SChristoph Lameter }
310215316ba8SChristoph Lameter 
3103eef6a7d5SAlan Stern /**
3104eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3105eef6a7d5SAlan Stern  *
3106eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3107eef6a7d5SAlan Stern  * completion.
3108eef6a7d5SAlan Stern  *
3109eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3110eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3111eef6a7d5SAlan Stern  * will lead to deadlock:
3112eef6a7d5SAlan Stern  *
3113eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3114eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3115eef6a7d5SAlan Stern  *
3116eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3117eef6a7d5SAlan Stern  *
3118eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3119eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3120eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3121eef6a7d5SAlan Stern  *
3122eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3123eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3124eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3125eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3126eef6a7d5SAlan Stern  */
31271da177e4SLinus Torvalds void flush_scheduled_work(void)
31281da177e4SLinus Torvalds {
3129d320c038STejun Heo 	flush_workqueue(system_wq);
31301da177e4SLinus Torvalds }
3131ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
31321da177e4SLinus Torvalds 
31331da177e4SLinus Torvalds /**
31341fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
31351fa44ecaSJames Bottomley  * @fn:		the function to execute
31361fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
31371fa44ecaSJames Bottomley  *		be available when the work executes)
31381fa44ecaSJames Bottomley  *
31391fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
31401fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
31411fa44ecaSJames Bottomley  *
31421fa44ecaSJames Bottomley  * Returns:	0 - function was executed
31431fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31441fa44ecaSJames Bottomley  */
314565f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31461fa44ecaSJames Bottomley {
31471fa44ecaSJames Bottomley 	if (!in_interrupt()) {
314865f27f38SDavid Howells 		fn(&ew->work);
31491fa44ecaSJames Bottomley 		return 0;
31501fa44ecaSJames Bottomley 	}
31511fa44ecaSJames Bottomley 
315265f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31531fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31541fa44ecaSJames Bottomley 
31551fa44ecaSJames Bottomley 	return 1;
31561fa44ecaSJames Bottomley }
31571fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31581fa44ecaSJames Bottomley 
31591da177e4SLinus Torvalds int keventd_up(void)
31601da177e4SLinus Torvalds {
3161d320c038STejun Heo 	return system_wq != NULL;
31621da177e4SLinus Torvalds }
31631da177e4SLinus Torvalds 
3164bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
31651da177e4SLinus Torvalds {
31663af24433SOleg Nesterov 	/*
31670f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
31680f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
31690f900049STejun Heo 	 * unsigned long long.
31703af24433SOleg Nesterov 	 */
31710f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
31720f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
31730f900049STejun Heo 				   __alignof__(unsigned long long));
31743af24433SOleg Nesterov 
3175e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3176f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3177931ac77eSTejun Heo 	else {
31780f900049STejun Heo 		void *ptr;
3179e1d8aa9fSFrederic Weisbecker 
31800f900049STejun Heo 		/*
3181f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3182f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3183f3421797STejun Heo 		 * allocated pointer which will be used for free.
31840f900049STejun Heo 		 */
3185bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3186bdbc5dd7STejun Heo 		if (ptr) {
3187bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3188bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3189bdbc5dd7STejun Heo 		}
31903af24433SOleg Nesterov 	}
31913af24433SOleg Nesterov 
31920415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3193bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3194bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
31950f900049STejun Heo }
31960f900049STejun Heo 
3197bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
319806ba38a9SOleg Nesterov {
3199e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3200bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3201f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3202f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3203f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
320406ba38a9SOleg Nesterov 	}
320506ba38a9SOleg Nesterov }
320606ba38a9SOleg Nesterov 
3207f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3208f3421797STejun Heo 			       const char *name)
3209b71ab8c2STejun Heo {
3210f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3211f3421797STejun Heo 
3212f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3213044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3214f3421797STejun Heo 			max_active, name, 1, lim);
3215b71ab8c2STejun Heo 
3216f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3217b71ab8c2STejun Heo }
3218b71ab8c2STejun Heo 
3219b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
322097e37d7bSTejun Heo 					       unsigned int flags,
32211e19ffc6STejun Heo 					       int max_active,
3222eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3223b196be89STejun Heo 					       const char *lock_name, ...)
32243af24433SOleg Nesterov {
3225b196be89STejun Heo 	va_list args, args1;
32263af24433SOleg Nesterov 	struct workqueue_struct *wq;
3227c34056a3STejun Heo 	unsigned int cpu;
3228b196be89STejun Heo 	size_t namelen;
3229b196be89STejun Heo 
3230b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3231b196be89STejun Heo 	va_start(args, lock_name);
3232b196be89STejun Heo 	va_copy(args1, args);
3233b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3234b196be89STejun Heo 
3235b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3236b196be89STejun Heo 	if (!wq)
3237b196be89STejun Heo 		goto err;
3238b196be89STejun Heo 
3239b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3240b196be89STejun Heo 	va_end(args);
3241b196be89STejun Heo 	va_end(args1);
32423af24433SOleg Nesterov 
3243f3421797STejun Heo 	/*
32446370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
32456370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
32466370a6adSTejun Heo 	 */
32476370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
32486370a6adSTejun Heo 		flags |= WQ_RESCUER;
32496370a6adSTejun Heo 
3250d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3251b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
32523af24433SOleg Nesterov 
3253b196be89STejun Heo 	/* init wq */
325497e37d7bSTejun Heo 	wq->flags = flags;
3255a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
325673f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
325773f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
325873f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
325973f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
32603af24433SOleg Nesterov 
3261eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3262cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
32633af24433SOleg Nesterov 
3264bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3265bdbc5dd7STejun Heo 		goto err;
3266bdbc5dd7STejun Heo 
3267f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
32681537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
32698b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
32703270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
32711537663fSTejun Heo 
32720f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
32733270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3274c34056a3STejun Heo 		cwq->wq = wq;
327573f53c4aSTejun Heo 		cwq->flush_color = -1;
32761e19ffc6STejun Heo 		cwq->max_active = max_active;
32771e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3278e22bee78STejun Heo 	}
32791537663fSTejun Heo 
3280e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3281e22bee78STejun Heo 		struct worker *rescuer;
3282e22bee78STejun Heo 
3283f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3284e22bee78STejun Heo 			goto err;
3285e22bee78STejun Heo 
3286e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3287e22bee78STejun Heo 		if (!rescuer)
3288e22bee78STejun Heo 			goto err;
3289e22bee78STejun Heo 
3290b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3291b196be89STejun Heo 					       wq->name);
3292e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3293e22bee78STejun Heo 			goto err;
3294e22bee78STejun Heo 
3295e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3296e22bee78STejun Heo 		wake_up_process(rescuer->task);
32973af24433SOleg Nesterov 	}
32981537663fSTejun Heo 
32993af24433SOleg Nesterov 	/*
3300a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3301a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3302a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
33033af24433SOleg Nesterov 	 */
33043af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3305a0a1a5fdSTejun Heo 
330658a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3307f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3308a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3309a0a1a5fdSTejun Heo 
33103af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3311a0a1a5fdSTejun Heo 
33123af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
33133af24433SOleg Nesterov 
33143af24433SOleg Nesterov 	return wq;
33154690c4abSTejun Heo err:
33164690c4abSTejun Heo 	if (wq) {
3317bdbc5dd7STejun Heo 		free_cwqs(wq);
3318f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3319e22bee78STejun Heo 		kfree(wq->rescuer);
33204690c4abSTejun Heo 		kfree(wq);
33213af24433SOleg Nesterov 	}
33224690c4abSTejun Heo 	return NULL;
33231da177e4SLinus Torvalds }
3324d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
33251da177e4SLinus Torvalds 
33263af24433SOleg Nesterov /**
33273af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
33283af24433SOleg Nesterov  * @wq: target workqueue
33293af24433SOleg Nesterov  *
33303af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
33313af24433SOleg Nesterov  */
33323af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
33333af24433SOleg Nesterov {
3334c8e55f36STejun Heo 	unsigned int cpu;
33353af24433SOleg Nesterov 
33369c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
33379c5a2ba7STejun Heo 	drain_workqueue(wq);
3338c8efcc25STejun Heo 
3339a0a1a5fdSTejun Heo 	/*
3340a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3341a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3342a0a1a5fdSTejun Heo 	 */
334395402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
33443af24433SOleg Nesterov 	list_del(&wq->list);
334595402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
33463af24433SOleg Nesterov 
3347e22bee78STejun Heo 	/* sanity check */
3348f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
334973f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
335073f53c4aSTejun Heo 		int i;
33513af24433SOleg Nesterov 
335273f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
335373f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
33541e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
33551e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
335673f53c4aSTejun Heo 	}
33571537663fSTejun Heo 
3358e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3359e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3360f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
33618d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3362e22bee78STejun Heo 	}
3363e22bee78STejun Heo 
3364bdbc5dd7STejun Heo 	free_cwqs(wq);
33653af24433SOleg Nesterov 	kfree(wq);
33663af24433SOleg Nesterov }
33673af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
33683af24433SOleg Nesterov 
3369dcd989cbSTejun Heo /**
3370*9f4bd4cdSLai Jiangshan  * cwq_set_max_active - adjust max_active of a cwq
3371*9f4bd4cdSLai Jiangshan  * @cwq: target cpu_workqueue_struct
3372*9f4bd4cdSLai Jiangshan  * @max_active: new max_active value.
3373*9f4bd4cdSLai Jiangshan  *
3374*9f4bd4cdSLai Jiangshan  * Set @cwq->max_active to @max_active and activate delayed works if
3375*9f4bd4cdSLai Jiangshan  * increased.
3376*9f4bd4cdSLai Jiangshan  *
3377*9f4bd4cdSLai Jiangshan  * CONTEXT:
3378*9f4bd4cdSLai Jiangshan  * spin_lock_irq(gcwq->lock).
3379*9f4bd4cdSLai Jiangshan  */
3380*9f4bd4cdSLai Jiangshan static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
3381*9f4bd4cdSLai Jiangshan {
3382*9f4bd4cdSLai Jiangshan 	cwq->max_active = max_active;
3383*9f4bd4cdSLai Jiangshan 
3384*9f4bd4cdSLai Jiangshan 	while (!list_empty(&cwq->delayed_works) &&
3385*9f4bd4cdSLai Jiangshan 	       cwq->nr_active < cwq->max_active)
3386*9f4bd4cdSLai Jiangshan 		cwq_activate_first_delayed(cwq);
3387*9f4bd4cdSLai Jiangshan }
3388*9f4bd4cdSLai Jiangshan 
3389*9f4bd4cdSLai Jiangshan /**
3390dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3391dcd989cbSTejun Heo  * @wq: target workqueue
3392dcd989cbSTejun Heo  * @max_active: new max_active value.
3393dcd989cbSTejun Heo  *
3394dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3395dcd989cbSTejun Heo  *
3396dcd989cbSTejun Heo  * CONTEXT:
3397dcd989cbSTejun Heo  * Don't call from IRQ context.
3398dcd989cbSTejun Heo  */
3399dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3400dcd989cbSTejun Heo {
3401dcd989cbSTejun Heo 	unsigned int cpu;
3402dcd989cbSTejun Heo 
3403f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3404dcd989cbSTejun Heo 
3405dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3406dcd989cbSTejun Heo 
3407dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3408dcd989cbSTejun Heo 
3409f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3410dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3411dcd989cbSTejun Heo 
3412dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3413dcd989cbSTejun Heo 
341458a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3415dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3416dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3417dcd989cbSTejun Heo 
3418dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3419dcd989cbSTejun Heo 	}
3420dcd989cbSTejun Heo 
3421dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3422dcd989cbSTejun Heo }
3423dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3424dcd989cbSTejun Heo 
3425dcd989cbSTejun Heo /**
3426dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3427dcd989cbSTejun Heo  * @cpu: CPU in question
3428dcd989cbSTejun Heo  * @wq: target workqueue
3429dcd989cbSTejun Heo  *
3430dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3431dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3432dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3433dcd989cbSTejun Heo  *
3434dcd989cbSTejun Heo  * RETURNS:
3435dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3436dcd989cbSTejun Heo  */
3437dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3438dcd989cbSTejun Heo {
3439dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3440dcd989cbSTejun Heo 
3441dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3442dcd989cbSTejun Heo }
3443dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3444dcd989cbSTejun Heo 
3445dcd989cbSTejun Heo /**
3446dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3447dcd989cbSTejun Heo  * @work: the work of interest
3448dcd989cbSTejun Heo  *
3449dcd989cbSTejun Heo  * RETURNS:
3450bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3451dcd989cbSTejun Heo  */
3452dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3453dcd989cbSTejun Heo {
3454dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3455dcd989cbSTejun Heo 
3456bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3457dcd989cbSTejun Heo }
3458dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3459dcd989cbSTejun Heo 
3460dcd989cbSTejun Heo /**
3461dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3462dcd989cbSTejun Heo  * @work: the work to be tested
3463dcd989cbSTejun Heo  *
3464dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3465dcd989cbSTejun Heo  * synchronization around this function and the test result is
3466dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3467dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3468dcd989cbSTejun Heo  * running state.
3469dcd989cbSTejun Heo  *
3470dcd989cbSTejun Heo  * RETURNS:
3471dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3472dcd989cbSTejun Heo  */
3473dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3474dcd989cbSTejun Heo {
3475dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3476dcd989cbSTejun Heo 	unsigned long flags;
3477dcd989cbSTejun Heo 	unsigned int ret = 0;
3478dcd989cbSTejun Heo 
3479dcd989cbSTejun Heo 	if (!gcwq)
3480dcd989cbSTejun Heo 		return false;
3481dcd989cbSTejun Heo 
3482dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3483dcd989cbSTejun Heo 
3484dcd989cbSTejun Heo 	if (work_pending(work))
3485dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3486dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3487dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3488dcd989cbSTejun Heo 
3489dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3490dcd989cbSTejun Heo 
3491dcd989cbSTejun Heo 	return ret;
3492dcd989cbSTejun Heo }
3493dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3494dcd989cbSTejun Heo 
3495db7bccf4STejun Heo /*
3496db7bccf4STejun Heo  * CPU hotplug.
3497db7bccf4STejun Heo  *
3498e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3499e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3500e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3501e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3502e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3503e22bee78STejun Heo  * blocked draining impractical.
3504e22bee78STejun Heo  *
3505628c78e7STejun Heo  * This is solved by allowing a gcwq to be disassociated from the CPU
3506628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
3507628c78e7STejun Heo  * cpu comes back online.
3508db7bccf4STejun Heo  */
3509db7bccf4STejun Heo 
351060373152STejun Heo /* claim manager positions of all pools */
3511b2eb83d1SLai Jiangshan static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
351260373152STejun Heo {
351360373152STejun Heo 	struct worker_pool *pool;
351460373152STejun Heo 
351560373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3516b2eb83d1SLai Jiangshan 		mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
35178db25e78STejun Heo 	spin_lock_irq(&gcwq->lock);
351860373152STejun Heo }
351960373152STejun Heo 
352060373152STejun Heo /* release manager positions */
3521b2eb83d1SLai Jiangshan static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
352260373152STejun Heo {
352360373152STejun Heo 	struct worker_pool *pool;
352460373152STejun Heo 
35258db25e78STejun Heo 	spin_unlock_irq(&gcwq->lock);
352660373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3527b2eb83d1SLai Jiangshan 		mutex_unlock(&pool->assoc_mutex);
352860373152STejun Heo }
352960373152STejun Heo 
3530628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work)
3531db7bccf4STejun Heo {
3532628c78e7STejun Heo 	struct global_cwq *gcwq = get_gcwq(smp_processor_id());
35334ce62e9eSTejun Heo 	struct worker_pool *pool;
3534db7bccf4STejun Heo 	struct worker *worker;
3535db7bccf4STejun Heo 	struct hlist_node *pos;
3536db7bccf4STejun Heo 	int i;
3537db7bccf4STejun Heo 
3538db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3539db7bccf4STejun Heo 
3540b2eb83d1SLai Jiangshan 	gcwq_claim_assoc_and_lock(gcwq);
3541e22bee78STejun Heo 
3542f2d5a0eeSTejun Heo 	/*
3543f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3544f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3545f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3546f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3547f2d5a0eeSTejun Heo 	 */
354860373152STejun Heo 	for_each_worker_pool(pool, gcwq)
35494ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3550403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3551db7bccf4STejun Heo 
3552db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3553403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3554db7bccf4STejun Heo 
3555f2d5a0eeSTejun Heo 	gcwq->flags |= GCWQ_DISASSOCIATED;
3556f2d5a0eeSTejun Heo 
3557b2eb83d1SLai Jiangshan 	gcwq_release_assoc_and_unlock(gcwq);
3558e22bee78STejun Heo 
3559e22bee78STejun Heo 	/*
3560628c78e7STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3561628c78e7STejun Heo 	 * sched callbacks see the %WORKER_UNBOUND flag.  This is necessary
3562628c78e7STejun Heo 	 * as scheduler callbacks may be invoked from other cpus.
3563628c78e7STejun Heo 	 */
3564628c78e7STejun Heo 	schedule();
3565628c78e7STejun Heo 
3566628c78e7STejun Heo 	/*
3567628c78e7STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After this,
3568628c78e7STejun Heo 	 * nr_running stays zero and need_more_worker() and keep_working()
3569628c78e7STejun Heo 	 * are always true as long as the worklist is not empty.  @gcwq now
3570628c78e7STejun Heo 	 * behaves as unbound (in terms of concurrency management) gcwq
3571628c78e7STejun Heo 	 * which is served by workers tied to the CPU.
3572628c78e7STejun Heo 	 *
3573628c78e7STejun Heo 	 * On return from this function, the current worker would trigger
3574628c78e7STejun Heo 	 * unbound chain execution of pending work items if other workers
3575628c78e7STejun Heo 	 * didn't already.
3576e22bee78STejun Heo 	 */
35774ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35784ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3579db7bccf4STejun Heo }
3580db7bccf4STejun Heo 
35818db25e78STejun Heo /*
35828db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
35838db25e78STejun Heo  * This will be registered high priority CPU notifier.
35848db25e78STejun Heo  */
35859fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
35861da177e4SLinus Torvalds 					       unsigned long action,
35871da177e4SLinus Torvalds 					       void *hcpu)
35881da177e4SLinus Torvalds {
35893af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3590db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
35914ce62e9eSTejun Heo 	struct worker_pool *pool;
35921da177e4SLinus Torvalds 
35938db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
35943af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35954ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35963ce63377STejun Heo 			struct worker *worker;
35973ce63377STejun Heo 
35983ce63377STejun Heo 			if (pool->nr_workers)
35993ce63377STejun Heo 				continue;
36003ce63377STejun Heo 
36013ce63377STejun Heo 			worker = create_worker(pool);
36023ce63377STejun Heo 			if (!worker)
36033ce63377STejun Heo 				return NOTIFY_BAD;
36043ce63377STejun Heo 
36053ce63377STejun Heo 			spin_lock_irq(&gcwq->lock);
36063ce63377STejun Heo 			start_worker(worker);
36073ce63377STejun Heo 			spin_unlock_irq(&gcwq->lock);
36083af24433SOleg Nesterov 		}
36091da177e4SLinus Torvalds 		break;
36101da177e4SLinus Torvalds 
361165758202STejun Heo 	case CPU_DOWN_FAILED:
361265758202STejun Heo 	case CPU_ONLINE:
3613b2eb83d1SLai Jiangshan 		gcwq_claim_assoc_and_lock(gcwq);
36148db25e78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
36158db25e78STejun Heo 		rebind_workers(gcwq);
3616b2eb83d1SLai Jiangshan 		gcwq_release_assoc_and_unlock(gcwq);
36178db25e78STejun Heo 		break;
361865758202STejun Heo 	}
361965758202STejun Heo 	return NOTIFY_OK;
362065758202STejun Heo }
362165758202STejun Heo 
362265758202STejun Heo /*
362365758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
362465758202STejun Heo  * This will be registered as low priority CPU notifier.
362565758202STejun Heo  */
36269fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
362765758202STejun Heo 						 unsigned long action,
362865758202STejun Heo 						 void *hcpu)
362965758202STejun Heo {
36308db25e78STejun Heo 	unsigned int cpu = (unsigned long)hcpu;
36318db25e78STejun Heo 	struct work_struct unbind_work;
36328db25e78STejun Heo 
363365758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
363465758202STejun Heo 	case CPU_DOWN_PREPARE:
36358db25e78STejun Heo 		/* unbinding should happen on the local CPU */
36368db25e78STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
36377635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
36388db25e78STejun Heo 		flush_work(&unbind_work);
36398db25e78STejun Heo 		break;
364065758202STejun Heo 	}
364165758202STejun Heo 	return NOTIFY_OK;
364265758202STejun Heo }
364365758202STejun Heo 
36442d3854a3SRusty Russell #ifdef CONFIG_SMP
36458ccad40dSRusty Russell 
36462d3854a3SRusty Russell struct work_for_cpu {
36476b44003eSAndrew Morton 	struct completion completion;
36482d3854a3SRusty Russell 	long (*fn)(void *);
36492d3854a3SRusty Russell 	void *arg;
36502d3854a3SRusty Russell 	long ret;
36512d3854a3SRusty Russell };
36522d3854a3SRusty Russell 
36536b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
36542d3854a3SRusty Russell {
36556b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
36562d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36576b44003eSAndrew Morton 	complete(&wfc->completion);
36586b44003eSAndrew Morton 	return 0;
36592d3854a3SRusty Russell }
36602d3854a3SRusty Russell 
36612d3854a3SRusty Russell /**
36622d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36632d3854a3SRusty Russell  * @cpu: the cpu to run on
36642d3854a3SRusty Russell  * @fn: the function to run
36652d3854a3SRusty Russell  * @arg: the function arg
36662d3854a3SRusty Russell  *
366731ad9081SRusty Russell  * This will return the value @fn returns.
366831ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36696b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36702d3854a3SRusty Russell  */
36712d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36722d3854a3SRusty Russell {
36736b44003eSAndrew Morton 	struct task_struct *sub_thread;
36746b44003eSAndrew Morton 	struct work_for_cpu wfc = {
36756b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
36766b44003eSAndrew Morton 		.fn = fn,
36776b44003eSAndrew Morton 		.arg = arg,
36786b44003eSAndrew Morton 	};
36792d3854a3SRusty Russell 
36806b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
36816b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
36826b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
36836b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
36846b44003eSAndrew Morton 	wake_up_process(sub_thread);
36856b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
36862d3854a3SRusty Russell 	return wfc.ret;
36872d3854a3SRusty Russell }
36882d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36892d3854a3SRusty Russell #endif /* CONFIG_SMP */
36902d3854a3SRusty Russell 
3691a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3692e7577c50SRusty Russell 
3693a0a1a5fdSTejun Heo /**
3694a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3695a0a1a5fdSTejun Heo  *
369658a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
369758a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
369858a69cb4STejun Heo  * gcwq->worklist.
3699a0a1a5fdSTejun Heo  *
3700a0a1a5fdSTejun Heo  * CONTEXT:
37018b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3702a0a1a5fdSTejun Heo  */
3703a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3704a0a1a5fdSTejun Heo {
3705a0a1a5fdSTejun Heo 	unsigned int cpu;
3706a0a1a5fdSTejun Heo 
3707a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3708a0a1a5fdSTejun Heo 
3709a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3710a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3711a0a1a5fdSTejun Heo 
3712f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37138b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3714bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37158b03ae3cSTejun Heo 
37168b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37178b03ae3cSTejun Heo 
3718db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3719db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3720db7bccf4STejun Heo 
3721a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3722a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3723a0a1a5fdSTejun Heo 
372458a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3725a0a1a5fdSTejun Heo 				cwq->max_active = 0;
37261da177e4SLinus Torvalds 		}
37278b03ae3cSTejun Heo 
37288b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3729a0a1a5fdSTejun Heo 	}
3730a0a1a5fdSTejun Heo 
3731a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3732a0a1a5fdSTejun Heo }
3733a0a1a5fdSTejun Heo 
3734a0a1a5fdSTejun Heo /**
373558a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3736a0a1a5fdSTejun Heo  *
3737a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3738a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3739a0a1a5fdSTejun Heo  *
3740a0a1a5fdSTejun Heo  * CONTEXT:
3741a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3742a0a1a5fdSTejun Heo  *
3743a0a1a5fdSTejun Heo  * RETURNS:
374458a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
374558a69cb4STejun Heo  * is complete.
3746a0a1a5fdSTejun Heo  */
3747a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3748a0a1a5fdSTejun Heo {
3749a0a1a5fdSTejun Heo 	unsigned int cpu;
3750a0a1a5fdSTejun Heo 	bool busy = false;
3751a0a1a5fdSTejun Heo 
3752a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3753a0a1a5fdSTejun Heo 
3754a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3755a0a1a5fdSTejun Heo 
3756f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3757bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3758a0a1a5fdSTejun Heo 		/*
3759a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3760a0a1a5fdSTejun Heo 		 * to peek without lock.
3761a0a1a5fdSTejun Heo 		 */
3762a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3763a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3764a0a1a5fdSTejun Heo 
376558a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3766a0a1a5fdSTejun Heo 				continue;
3767a0a1a5fdSTejun Heo 
3768a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3769a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3770a0a1a5fdSTejun Heo 				busy = true;
3771a0a1a5fdSTejun Heo 				goto out_unlock;
3772a0a1a5fdSTejun Heo 			}
3773a0a1a5fdSTejun Heo 		}
3774a0a1a5fdSTejun Heo 	}
3775a0a1a5fdSTejun Heo out_unlock:
3776a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3777a0a1a5fdSTejun Heo 	return busy;
3778a0a1a5fdSTejun Heo }
3779a0a1a5fdSTejun Heo 
3780a0a1a5fdSTejun Heo /**
3781a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3782a0a1a5fdSTejun Heo  *
3783a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
37847e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3785a0a1a5fdSTejun Heo  *
3786a0a1a5fdSTejun Heo  * CONTEXT:
37878b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3788a0a1a5fdSTejun Heo  */
3789a0a1a5fdSTejun Heo void thaw_workqueues(void)
3790a0a1a5fdSTejun Heo {
3791a0a1a5fdSTejun Heo 	unsigned int cpu;
3792a0a1a5fdSTejun Heo 
3793a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3794a0a1a5fdSTejun Heo 
3795a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3796a0a1a5fdSTejun Heo 		goto out_unlock;
3797a0a1a5fdSTejun Heo 
3798f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37998b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38004ce62e9eSTejun Heo 		struct worker_pool *pool;
3801bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
38028b03ae3cSTejun Heo 
38038b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
38048b03ae3cSTejun Heo 
3805db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3806db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3807db7bccf4STejun Heo 
3808a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3809a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3810a0a1a5fdSTejun Heo 
381158a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3812a0a1a5fdSTejun Heo 				continue;
3813a0a1a5fdSTejun Heo 
3814a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3815*9f4bd4cdSLai Jiangshan 			cwq_set_max_active(cwq, wq->saved_max_active);
3816a0a1a5fdSTejun Heo 		}
38178b03ae3cSTejun Heo 
38184ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
38194ce62e9eSTejun Heo 			wake_up_worker(pool);
3820e22bee78STejun Heo 
38218b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3822a0a1a5fdSTejun Heo 	}
3823a0a1a5fdSTejun Heo 
3824a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3825a0a1a5fdSTejun Heo out_unlock:
3826a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3827a0a1a5fdSTejun Heo }
3828a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3829a0a1a5fdSTejun Heo 
38306ee0578bSSuresh Siddha static int __init init_workqueues(void)
38311da177e4SLinus Torvalds {
3832c34056a3STejun Heo 	unsigned int cpu;
3833c8e55f36STejun Heo 	int i;
3834c34056a3STejun Heo 
3835b5490077STejun Heo 	/* make sure we have enough bits for OFFQ CPU number */
3836b5490077STejun Heo 	BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3837b5490077STejun Heo 		     WORK_CPU_LAST);
3838b5490077STejun Heo 
383965758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3840a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
38418b03ae3cSTejun Heo 
38428b03ae3cSTejun Heo 	/* initialize gcwqs */
3843f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38448b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38454ce62e9eSTejun Heo 		struct worker_pool *pool;
38468b03ae3cSTejun Heo 
38478b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
38488b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3849f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
38508b03ae3cSTejun Heo 
3851c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3852c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3853c8e55f36STejun Heo 
38544ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38554ce62e9eSTejun Heo 			pool->gcwq = gcwq;
38564ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38574ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3858e22bee78STejun Heo 
38594ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38604ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38614ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3862e22bee78STejun Heo 
38634ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38644ce62e9eSTejun Heo 				    (unsigned long)pool);
38654ce62e9eSTejun Heo 
3866b2eb83d1SLai Jiangshan 			mutex_init(&pool->assoc_mutex);
38674ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38684ce62e9eSTejun Heo 		}
38698b03ae3cSTejun Heo 	}
38708b03ae3cSTejun Heo 
3871e22bee78STejun Heo 	/* create the initial worker */
3872f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3873e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38744ce62e9eSTejun Heo 		struct worker_pool *pool;
3875e22bee78STejun Heo 
3876477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3877477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
38784ce62e9eSTejun Heo 
38794ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38804ce62e9eSTejun Heo 			struct worker *worker;
38814ce62e9eSTejun Heo 
3882bc2ae0f5STejun Heo 			worker = create_worker(pool);
3883e22bee78STejun Heo 			BUG_ON(!worker);
3884e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3885e22bee78STejun Heo 			start_worker(worker);
3886e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3887e22bee78STejun Heo 		}
38884ce62e9eSTejun Heo 	}
3889e22bee78STejun Heo 
3890d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
38911aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
3892d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3893f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3894f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
389524d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
389624d51addSTejun Heo 					      WQ_FREEZABLE, 0);
38971aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
3898ae930e0fSTejun Heo 	       !system_unbound_wq || !system_freezable_wq);
38996ee0578bSSuresh Siddha 	return 0;
39001da177e4SLinus Torvalds }
39016ee0578bSSuresh Siddha early_initcall(init_workqueues);
3902