xref: /linux-6.15/kernel/workqueue.c (revision a5b4e57d)
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 
980bf4ede01STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
981bf4ede01STejun Heo {
982bf4ede01STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
983bf4ede01STejun Heo 						    struct work_struct, entry);
984bf4ede01STejun Heo 
985bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
986bf4ede01STejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
987bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
988bf4ede01STejun Heo 	cwq->nr_active++;
989bf4ede01STejun Heo }
990bf4ede01STejun Heo 
991bf4ede01STejun Heo /**
992bf4ede01STejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
993bf4ede01STejun Heo  * @cwq: cwq of interest
994bf4ede01STejun Heo  * @color: color of work which left the queue
995bf4ede01STejun Heo  * @delayed: for a delayed work
996bf4ede01STejun Heo  *
997bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
998bf4ede01STejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
999bf4ede01STejun Heo  *
1000bf4ede01STejun Heo  * CONTEXT:
1001bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
1002bf4ede01STejun Heo  */
1003bf4ede01STejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1004bf4ede01STejun Heo 				 bool delayed)
1005bf4ede01STejun Heo {
1006bf4ede01STejun Heo 	/* ignore uncolored works */
1007bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
1008bf4ede01STejun Heo 		return;
1009bf4ede01STejun Heo 
1010bf4ede01STejun Heo 	cwq->nr_in_flight[color]--;
1011bf4ede01STejun Heo 
1012bf4ede01STejun Heo 	if (!delayed) {
1013bf4ede01STejun Heo 		cwq->nr_active--;
1014bf4ede01STejun Heo 		if (!list_empty(&cwq->delayed_works)) {
1015bf4ede01STejun Heo 			/* one down, submit a delayed one */
1016bf4ede01STejun Heo 			if (cwq->nr_active < cwq->max_active)
1017bf4ede01STejun Heo 				cwq_activate_first_delayed(cwq);
1018bf4ede01STejun Heo 		}
1019bf4ede01STejun Heo 	}
1020bf4ede01STejun Heo 
1021bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1022bf4ede01STejun Heo 	if (likely(cwq->flush_color != color))
1023bf4ede01STejun Heo 		return;
1024bf4ede01STejun Heo 
1025bf4ede01STejun Heo 	/* are there still in-flight works? */
1026bf4ede01STejun Heo 	if (cwq->nr_in_flight[color])
1027bf4ede01STejun Heo 		return;
1028bf4ede01STejun Heo 
1029bf4ede01STejun Heo 	/* this cwq is done, clear flush_color */
1030bf4ede01STejun Heo 	cwq->flush_color = -1;
1031bf4ede01STejun Heo 
1032bf4ede01STejun Heo 	/*
1033bf4ede01STejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
1034bf4ede01STejun Heo 	 * will handle the rest.
1035bf4ede01STejun Heo 	 */
1036bf4ede01STejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1037bf4ede01STejun Heo 		complete(&cwq->wq->first_flusher->done);
1038bf4ede01STejun Heo }
1039bf4ede01STejun Heo 
104036e227d2STejun Heo /**
1041bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
104236e227d2STejun Heo  * @work: work item to steal
104336e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1044bbb68dfaSTejun Heo  * @flags: place to store irq state
104536e227d2STejun Heo  *
104636e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
104736e227d2STejun Heo  * stable state - idle, on timer or on worklist.  Return values are
104836e227d2STejun Heo  *
104936e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
105036e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
105136e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1052bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1053bbb68dfaSTejun Heo  *		for arbitrarily long
105436e227d2STejun Heo  *
1055bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1056e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1057e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1058e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1059bbb68dfaSTejun Heo  *
1060bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1061bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1062bbb68dfaSTejun Heo  *
1063e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1064bf4ede01STejun Heo  */
1065bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1066bbb68dfaSTejun Heo 			       unsigned long *flags)
1067bf4ede01STejun Heo {
1068bf4ede01STejun Heo 	struct global_cwq *gcwq;
1069bf4ede01STejun Heo 
1070bbb68dfaSTejun Heo 	WARN_ON_ONCE(in_irq());
1071bbb68dfaSTejun Heo 
1072bbb68dfaSTejun Heo 	local_irq_save(*flags);
1073bbb68dfaSTejun Heo 
107436e227d2STejun Heo 	/* try to steal the timer if it exists */
107536e227d2STejun Heo 	if (is_dwork) {
107636e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
107736e227d2STejun Heo 
1078e0aecdd8STejun Heo 		/*
1079e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1080e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1081e0aecdd8STejun Heo 		 * running on the local CPU.
1082e0aecdd8STejun Heo 		 */
108336e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
108436e227d2STejun Heo 			return 1;
108536e227d2STejun Heo 	}
108636e227d2STejun Heo 
108736e227d2STejun Heo 	/* try to claim PENDING the normal way */
1088bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1089bf4ede01STejun Heo 		return 0;
1090bf4ede01STejun Heo 
1091bf4ede01STejun Heo 	/*
1092bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1093bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1094bf4ede01STejun Heo 	 */
1095bf4ede01STejun Heo 	gcwq = get_work_gcwq(work);
1096bf4ede01STejun Heo 	if (!gcwq)
1097bbb68dfaSTejun Heo 		goto fail;
1098bf4ede01STejun Heo 
1099bbb68dfaSTejun Heo 	spin_lock(&gcwq->lock);
1100bf4ede01STejun Heo 	if (!list_empty(&work->entry)) {
1101bf4ede01STejun Heo 		/*
1102bf4ede01STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
1103bf4ede01STejun Heo 		 * In that case we must see the new value after rmb(), see
1104bf4ede01STejun Heo 		 * insert_work()->wmb().
1105bf4ede01STejun Heo 		 */
1106bf4ede01STejun Heo 		smp_rmb();
1107bf4ede01STejun Heo 		if (gcwq == get_work_gcwq(work)) {
1108bf4ede01STejun Heo 			debug_work_deactivate(work);
1109bf4ede01STejun Heo 			list_del_init(&work->entry);
1110bf4ede01STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
1111bf4ede01STejun Heo 				get_work_color(work),
1112bf4ede01STejun Heo 				*work_data_bits(work) & WORK_STRUCT_DELAYED);
111336e227d2STejun Heo 
1114bbb68dfaSTejun Heo 			spin_unlock(&gcwq->lock);
111536e227d2STejun Heo 			return 1;
1116bf4ede01STejun Heo 		}
1117bf4ede01STejun Heo 	}
1118bbb68dfaSTejun Heo 	spin_unlock(&gcwq->lock);
1119bbb68dfaSTejun Heo fail:
1120bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1121bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1122bbb68dfaSTejun Heo 		return -ENOENT;
1123bbb68dfaSTejun Heo 	cpu_relax();
112436e227d2STejun Heo 	return -EAGAIN;
1125bf4ede01STejun Heo }
1126bf4ede01STejun Heo 
1127bf4ede01STejun Heo /**
11287e11629dSTejun Heo  * insert_work - insert a work into gcwq
11294690c4abSTejun Heo  * @cwq: cwq @work belongs to
11304690c4abSTejun Heo  * @work: work to insert
11314690c4abSTejun Heo  * @head: insertion point
11324690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
11334690c4abSTejun Heo  *
11347e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
11357e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
11364690c4abSTejun Heo  *
11374690c4abSTejun Heo  * CONTEXT:
11388b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
11391da177e4SLinus Torvalds  */
1140b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
11414690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
11424690c4abSTejun Heo 			unsigned int extra_flags)
1143b89deed3SOleg Nesterov {
114463d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
1145e1d8aa9fSFrederic Weisbecker 
11464690c4abSTejun Heo 	/* we own @work, set data and link */
11477a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
11484690c4abSTejun Heo 
11496e84d644SOleg Nesterov 	/*
11506e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
11516e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
11526e84d644SOleg Nesterov 	 */
11536e84d644SOleg Nesterov 	smp_wmb();
11544690c4abSTejun Heo 
11551a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
1156e22bee78STejun Heo 
1157e22bee78STejun Heo 	/*
1158e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
1159e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
1160e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
1161e22bee78STejun Heo 	 */
1162e22bee78STejun Heo 	smp_mb();
1163e22bee78STejun Heo 
116463d95a91STejun Heo 	if (__need_more_worker(pool))
116563d95a91STejun Heo 		wake_up_worker(pool);
1166b89deed3SOleg Nesterov }
1167b89deed3SOleg Nesterov 
1168c8efcc25STejun Heo /*
1169c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
1170c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
1171c8efcc25STejun Heo  * cold paths.
1172c8efcc25STejun Heo  */
1173c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1174c8efcc25STejun Heo {
1175c8efcc25STejun Heo 	unsigned long flags;
1176c8efcc25STejun Heo 	unsigned int cpu;
1177c8efcc25STejun Heo 
1178c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
1179c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
1180c8efcc25STejun Heo 		struct worker *worker;
1181c8efcc25STejun Heo 		struct hlist_node *pos;
1182c8efcc25STejun Heo 		int i;
1183c8efcc25STejun Heo 
1184c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1185c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
1186c8efcc25STejun Heo 			if (worker->task != current)
1187c8efcc25STejun Heo 				continue;
1188c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
1189c8efcc25STejun Heo 			/*
1190c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
1191c8efcc25STejun Heo 			 * is headed to the same workqueue.
1192c8efcc25STejun Heo 			 */
1193c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
1194c8efcc25STejun Heo 		}
1195c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
1196c8efcc25STejun Heo 	}
1197c8efcc25STejun Heo 	return false;
1198c8efcc25STejun Heo }
1199c8efcc25STejun Heo 
12004690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
12011da177e4SLinus Torvalds 			 struct work_struct *work)
12021da177e4SLinus Torvalds {
1203502ca9d8STejun Heo 	struct global_cwq *gcwq;
1204502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
12051e19ffc6STejun Heo 	struct list_head *worklist;
12068a2e8e5dSTejun Heo 	unsigned int work_flags;
1207b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
12088930cabaSTejun Heo 
12098930cabaSTejun Heo 	/*
12108930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
12118930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
12128930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
12138930cabaSTejun Heo 	 * happen with IRQ disabled.
12148930cabaSTejun Heo 	 */
12158930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
12161da177e4SLinus Torvalds 
1217dc186ad7SThomas Gleixner 	debug_work_activate(work);
12181e19ffc6STejun Heo 
1219c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
12209c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1221c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1222e41e704bSTejun Heo 		return;
1223e41e704bSTejun Heo 
1224c7fc77f7STejun Heo 	/* determine gcwq to use */
1225c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1226c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1227c7fc77f7STejun Heo 
122857469821STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
1229f3421797STejun Heo 			cpu = raw_smp_processor_id();
1230f3421797STejun Heo 
123118aa9effSTejun Heo 		/*
1232dbf2576eSTejun Heo 		 * It's multi cpu.  If @work was previously on a different
1233dbf2576eSTejun Heo 		 * cpu, it might still be running there, in which case the
1234dbf2576eSTejun Heo 		 * work needs to be queued on that cpu to guarantee
1235dbf2576eSTejun Heo 		 * non-reentrancy.
123618aa9effSTejun Heo 		 */
1237502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
1238dbf2576eSTejun Heo 		last_gcwq = get_work_gcwq(work);
1239dbf2576eSTejun Heo 
1240dbf2576eSTejun Heo 		if (last_gcwq && last_gcwq != gcwq) {
124118aa9effSTejun Heo 			struct worker *worker;
124218aa9effSTejun Heo 
12438930cabaSTejun Heo 			spin_lock(&last_gcwq->lock);
124418aa9effSTejun Heo 
124518aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
124618aa9effSTejun Heo 
124718aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
124818aa9effSTejun Heo 				gcwq = last_gcwq;
124918aa9effSTejun Heo 			else {
125018aa9effSTejun Heo 				/* meh... not running there, queue here */
12518930cabaSTejun Heo 				spin_unlock(&last_gcwq->lock);
12528930cabaSTejun Heo 				spin_lock(&gcwq->lock);
125318aa9effSTejun Heo 			}
12548930cabaSTejun Heo 		} else {
12558930cabaSTejun Heo 			spin_lock(&gcwq->lock);
12568930cabaSTejun Heo 		}
1257f3421797STejun Heo 	} else {
1258f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
12598930cabaSTejun Heo 		spin_lock(&gcwq->lock);
1260502ca9d8STejun Heo 	}
1261502ca9d8STejun Heo 
1262502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1263502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1264b75cac93SJoonsoo Kim 	trace_workqueue_queue_work(req_cpu, cwq, work);
1265502ca9d8STejun Heo 
1266f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
12678930cabaSTejun Heo 		spin_unlock(&gcwq->lock);
1268f5b2552bSDan Carpenter 		return;
1269f5b2552bSDan Carpenter 	}
12701e19ffc6STejun Heo 
127173f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
12728a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
12731e19ffc6STejun Heo 
12741e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1275cdadf009STejun Heo 		trace_workqueue_activate_work(work);
12761e19ffc6STejun Heo 		cwq->nr_active++;
12773270476aSTejun Heo 		worklist = &cwq->pool->worklist;
12788a2e8e5dSTejun Heo 	} else {
12798a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
12801e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
12818a2e8e5dSTejun Heo 	}
12821e19ffc6STejun Heo 
12838a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
12841e19ffc6STejun Heo 
12858930cabaSTejun Heo 	spin_unlock(&gcwq->lock);
12861da177e4SLinus Torvalds }
12871da177e4SLinus Torvalds 
12880fcb78c2SRolf Eike Beer /**
1289c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1290c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1291c1a220e7SZhang Rui  * @wq: workqueue to use
1292c1a220e7SZhang Rui  * @work: work to queue
1293c1a220e7SZhang Rui  *
1294d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
1295c1a220e7SZhang Rui  *
1296c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1297c1a220e7SZhang Rui  * can't go away.
1298c1a220e7SZhang Rui  */
1299d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1300d4283e93STejun Heo 		   struct work_struct *work)
1301c1a220e7SZhang Rui {
1302d4283e93STejun Heo 	bool ret = false;
13038930cabaSTejun Heo 	unsigned long flags;
13048930cabaSTejun Heo 
13058930cabaSTejun Heo 	local_irq_save(flags);
1306c1a220e7SZhang Rui 
130722df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
13084690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1309d4283e93STejun Heo 		ret = true;
1310c1a220e7SZhang Rui 	}
13118930cabaSTejun Heo 
13128930cabaSTejun Heo 	local_irq_restore(flags);
1313c1a220e7SZhang Rui 	return ret;
1314c1a220e7SZhang Rui }
1315c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1316c1a220e7SZhang Rui 
13170a13c00eSTejun Heo /**
13180a13c00eSTejun Heo  * queue_work - queue work on a workqueue
13190a13c00eSTejun Heo  * @wq: workqueue to use
13200a13c00eSTejun Heo  * @work: work to queue
13210a13c00eSTejun Heo  *
1322d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
13230a13c00eSTejun Heo  *
13240a13c00eSTejun Heo  * We queue the work to the CPU on which it was submitted, but if the CPU dies
13250a13c00eSTejun Heo  * it can be processed by another CPU.
13260a13c00eSTejun Heo  */
1327d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
13280a13c00eSTejun Heo {
132957469821STejun Heo 	return queue_work_on(WORK_CPU_UNBOUND, wq, work);
13300a13c00eSTejun Heo }
13310a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work);
13320a13c00eSTejun Heo 
1333d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
13341da177e4SLinus Torvalds {
133552bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
13367a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
13371da177e4SLinus Torvalds 
1338e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
13391265057fSTejun Heo 	__queue_work(dwork->cpu, cwq->wq, &dwork->work);
13401da177e4SLinus Torvalds }
1341d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
13421da177e4SLinus Torvalds 
13437beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
13447beb2edfSTejun Heo 				struct delayed_work *dwork, unsigned long delay)
13457beb2edfSTejun Heo {
13467beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
13477beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
13487beb2edfSTejun Heo 	unsigned int lcpu;
13497beb2edfSTejun Heo 
13507beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
13517beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
13527beb2edfSTejun Heo 	BUG_ON(timer_pending(timer));
13537beb2edfSTejun Heo 	BUG_ON(!list_empty(&work->entry));
13547beb2edfSTejun Heo 
13557beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
13567beb2edfSTejun Heo 
13577beb2edfSTejun Heo 	/*
13587beb2edfSTejun Heo 	 * This stores cwq for the moment, for the timer_fn.  Note that the
13597beb2edfSTejun Heo 	 * work's gcwq is preserved to allow reentrance detection for
13607beb2edfSTejun Heo 	 * delayed works.
13617beb2edfSTejun Heo 	 */
13627beb2edfSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
13637beb2edfSTejun Heo 		struct global_cwq *gcwq = get_work_gcwq(work);
13647beb2edfSTejun Heo 
1365e42986deSJoonsoo Kim 		/*
1366e42986deSJoonsoo Kim 		 * If we cannot get the last gcwq from @work directly,
1367e42986deSJoonsoo Kim 		 * select the last CPU such that it avoids unnecessarily
1368e42986deSJoonsoo Kim 		 * triggering non-reentrancy check in __queue_work().
1369e42986deSJoonsoo Kim 		 */
1370e42986deSJoonsoo Kim 		lcpu = cpu;
1371e42986deSJoonsoo Kim 		if (gcwq)
13727beb2edfSTejun Heo 			lcpu = gcwq->cpu;
1373e42986deSJoonsoo Kim 		if (lcpu == WORK_CPU_UNBOUND)
13747beb2edfSTejun Heo 			lcpu = raw_smp_processor_id();
13757beb2edfSTejun Heo 	} else {
13767beb2edfSTejun Heo 		lcpu = WORK_CPU_UNBOUND;
13777beb2edfSTejun Heo 	}
13787beb2edfSTejun Heo 
13797beb2edfSTejun Heo 	set_work_cwq(work, get_cwq(lcpu, wq), 0);
13807beb2edfSTejun Heo 
13811265057fSTejun Heo 	dwork->cpu = cpu;
13827beb2edfSTejun Heo 	timer->expires = jiffies + delay;
13837beb2edfSTejun Heo 
13847beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
13857beb2edfSTejun Heo 		add_timer_on(timer, cpu);
13867beb2edfSTejun Heo 	else
13877beb2edfSTejun Heo 		add_timer(timer);
13887beb2edfSTejun Heo }
13897beb2edfSTejun Heo 
13900fcb78c2SRolf Eike Beer /**
13910fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
13920fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
13930fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1394af9997e4SRandy Dunlap  * @dwork: work to queue
13950fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
13960fcb78c2SRolf Eike Beer  *
1397715f1300STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.  If
1398715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1399715f1300STejun Heo  * execution.
14000fcb78c2SRolf Eike Beer  */
1401d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
140252bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
14037a6bc1cdSVenkatesh Pallipadi {
140452bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1405d4283e93STejun Heo 	bool ret = false;
14068930cabaSTejun Heo 	unsigned long flags;
14078930cabaSTejun Heo 
1408715f1300STejun Heo 	if (!delay)
1409715f1300STejun Heo 		return queue_work_on(cpu, wq, &dwork->work);
1410715f1300STejun Heo 
14118930cabaSTejun Heo 	/* read the comment in __queue_work() */
14128930cabaSTejun Heo 	local_irq_save(flags);
14137a6bc1cdSVenkatesh Pallipadi 
141422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14157beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1416d4283e93STejun Heo 		ret = true;
14177a6bc1cdSVenkatesh Pallipadi 	}
14188930cabaSTejun Heo 
14198930cabaSTejun Heo 	local_irq_restore(flags);
14207a6bc1cdSVenkatesh Pallipadi 	return ret;
14217a6bc1cdSVenkatesh Pallipadi }
1422ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
14231da177e4SLinus Torvalds 
1424c8e55f36STejun Heo /**
14250a13c00eSTejun Heo  * queue_delayed_work - queue work on a workqueue after delay
14260a13c00eSTejun Heo  * @wq: workqueue to use
14270a13c00eSTejun Heo  * @dwork: delayable work to queue
14280a13c00eSTejun Heo  * @delay: number of jiffies to wait before queueing
14290a13c00eSTejun Heo  *
1430715f1300STejun Heo  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
14310a13c00eSTejun Heo  */
1432d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq,
14330a13c00eSTejun Heo 			struct delayed_work *dwork, unsigned long delay)
14340a13c00eSTejun Heo {
143557469821STejun Heo 	return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14360a13c00eSTejun Heo }
14370a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work);
14380a13c00eSTejun Heo 
14390a13c00eSTejun Heo /**
14408376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
14418376fe22STejun Heo  * @cpu: CPU number to execute work on
14428376fe22STejun Heo  * @wq: workqueue to use
14438376fe22STejun Heo  * @dwork: work to queue
14448376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14458376fe22STejun Heo  *
14468376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
14478376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
14488376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
14498376fe22STejun Heo  * current state.
14508376fe22STejun Heo  *
14518376fe22STejun Heo  * Returns %false if @dwork was idle and queued, %true if @dwork was
14528376fe22STejun Heo  * pending and its timer was modified.
14538376fe22STejun Heo  *
1454e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
14558376fe22STejun Heo  * See try_to_grab_pending() for details.
14568376fe22STejun Heo  */
14578376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
14588376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
14598376fe22STejun Heo {
14608376fe22STejun Heo 	unsigned long flags;
14618376fe22STejun Heo 	int ret;
14628376fe22STejun Heo 
14638376fe22STejun Heo 	do {
14648376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
14658376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
14668376fe22STejun Heo 
14678376fe22STejun Heo 	if (likely(ret >= 0)) {
14688376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
14698376fe22STejun Heo 		local_irq_restore(flags);
14708376fe22STejun Heo 	}
14718376fe22STejun Heo 
14728376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
14738376fe22STejun Heo 	return ret;
14748376fe22STejun Heo }
14758376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
14768376fe22STejun Heo 
14778376fe22STejun Heo /**
14788376fe22STejun Heo  * mod_delayed_work - modify delay of or queue a delayed work
14798376fe22STejun Heo  * @wq: workqueue to use
14808376fe22STejun Heo  * @dwork: work to queue
14818376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14828376fe22STejun Heo  *
14838376fe22STejun Heo  * mod_delayed_work_on() on local CPU.
14848376fe22STejun Heo  */
14858376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
14868376fe22STejun Heo 		      unsigned long delay)
14878376fe22STejun Heo {
14888376fe22STejun Heo 	return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14898376fe22STejun Heo }
14908376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work);
14918376fe22STejun Heo 
14928376fe22STejun Heo /**
1493c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1494c8e55f36STejun Heo  * @worker: worker which is entering idle state
1495c8e55f36STejun Heo  *
1496c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1497c8e55f36STejun Heo  * necessary.
1498c8e55f36STejun Heo  *
1499c8e55f36STejun Heo  * LOCKING:
1500c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1501c8e55f36STejun Heo  */
1502c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
15031da177e4SLinus Torvalds {
1504bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1505bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1506c8e55f36STejun Heo 
1507c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1508c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1509c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1510c8e55f36STejun Heo 
1511cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1512cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1513bd7bdd43STejun Heo 	pool->nr_idle++;
1514e22bee78STejun Heo 	worker->last_active = jiffies;
1515c8e55f36STejun Heo 
1516c8e55f36STejun Heo 	/* idle_list is LIFO */
1517bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1518db7bccf4STejun Heo 
151963d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1520628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1521cb444766STejun Heo 
1522544ecf31STejun Heo 	/*
1523628c78e7STejun Heo 	 * Sanity check nr_running.  Because gcwq_unbind_fn() releases
1524628c78e7STejun Heo 	 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1525628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1526628c78e7STejun Heo 	 * unbind is not in progress.
1527544ecf31STejun Heo 	 */
1528628c78e7STejun Heo 	WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
1529bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
153063d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1531c8e55f36STejun Heo }
1532c8e55f36STejun Heo 
1533c8e55f36STejun Heo /**
1534c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1535c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1536c8e55f36STejun Heo  *
1537c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1538c8e55f36STejun Heo  *
1539c8e55f36STejun Heo  * LOCKING:
1540c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1541c8e55f36STejun Heo  */
1542c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1543c8e55f36STejun Heo {
1544bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1545c8e55f36STejun Heo 
1546c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1547d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1548bd7bdd43STejun Heo 	pool->nr_idle--;
1549c8e55f36STejun Heo 	list_del_init(&worker->entry);
1550c8e55f36STejun Heo }
1551c8e55f36STejun Heo 
1552e22bee78STejun Heo /**
1553e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1554e22bee78STejun Heo  * @worker: self
1555e22bee78STejun Heo  *
1556e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1557e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1558e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1559e22bee78STejun Heo  * guaranteed to execute on the cpu.
1560e22bee78STejun Heo  *
1561e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1562e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1563e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1564e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1565e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1566e22bee78STejun Heo  * [dis]associated in the meantime.
1567e22bee78STejun Heo  *
1568f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1569f2d5a0eeSTejun Heo  * binding against %GCWQ_DISASSOCIATED which is set during
1570f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1571f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1572f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1573e22bee78STejun Heo  *
1574e22bee78STejun Heo  * CONTEXT:
1575e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1576e22bee78STejun Heo  * held.
1577e22bee78STejun Heo  *
1578e22bee78STejun Heo  * RETURNS:
1579e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1580e22bee78STejun Heo  * bound), %false if offline.
1581e22bee78STejun Heo  */
1582e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1583972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1584e22bee78STejun Heo {
1585bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1586e22bee78STejun Heo 	struct task_struct *task = worker->task;
1587e22bee78STejun Heo 
1588e22bee78STejun Heo 	while (true) {
1589e22bee78STejun Heo 		/*
1590e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1591e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1592e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1593e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1594e22bee78STejun Heo 		 */
1595f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1596e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1597e22bee78STejun Heo 
1598e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1599e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1600e22bee78STejun Heo 			return false;
1601e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1602e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1603e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1604e22bee78STejun Heo 			return true;
1605e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1606e22bee78STejun Heo 
16075035b20fSTejun Heo 		/*
16085035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
16095035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
16105035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
16115035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
16125035b20fSTejun Heo 		 */
1613e22bee78STejun Heo 		cpu_relax();
16145035b20fSTejun Heo 		cond_resched();
1615e22bee78STejun Heo 	}
1616e22bee78STejun Heo }
1617e22bee78STejun Heo 
1618e22bee78STejun Heo /*
1619ea1abd61SLai Jiangshan  * Rebind an idle @worker to its CPU.  worker_thread() will test
16205f7dabfdSLai Jiangshan  * list_empty(@worker->entry) before leaving idle and call this function.
162125511a47STejun Heo  */
162225511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
162325511a47STejun Heo {
162425511a47STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
162525511a47STejun Heo 
16265f7dabfdSLai Jiangshan 	/* CPU may go down again inbetween, clear UNBOUND only on success */
16275f7dabfdSLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
16285f7dabfdSLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
1629ea1abd61SLai Jiangshan 
1630ea1abd61SLai Jiangshan 	/* rebind complete, become available again */
1631ea1abd61SLai Jiangshan 	list_add(&worker->entry, &worker->pool->idle_list);
1632ea1abd61SLai Jiangshan 	spin_unlock_irq(&gcwq->lock);
163325511a47STejun Heo }
163425511a47STejun Heo 
163525511a47STejun Heo /*
163625511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1637403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1638403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1639403c821dSTejun Heo  * executed twice without intervening cpu down.
1640e22bee78STejun Heo  */
164125511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1642e22bee78STejun Heo {
1643e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1644bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1645e22bee78STejun Heo 
1646eab6d828SLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
1647eab6d828SLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
1648e22bee78STejun Heo 
1649e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1650e22bee78STejun Heo }
1651e22bee78STejun Heo 
165225511a47STejun Heo /**
165325511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
165425511a47STejun Heo  * @gcwq: gcwq of interest
165525511a47STejun Heo  *
165625511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
165725511a47STejun Heo  * is different for idle and busy ones.
165825511a47STejun Heo  *
1659ea1abd61SLai Jiangshan  * Idle ones will be removed from the idle_list and woken up.  They will
1660ea1abd61SLai Jiangshan  * add themselves back after completing rebind.  This ensures that the
1661ea1abd61SLai Jiangshan  * idle_list doesn't contain any unbound workers when re-bound busy workers
1662ea1abd61SLai Jiangshan  * try to perform local wake-ups for concurrency management.
166325511a47STejun Heo  *
1664ea1abd61SLai Jiangshan  * Busy workers can rebind after they finish their current work items.
1665ea1abd61SLai Jiangshan  * Queueing the rebind work item at the head of the scheduled list is
1666ea1abd61SLai Jiangshan  * enough.  Note that nr_running will be properly bumped as busy workers
1667ea1abd61SLai Jiangshan  * rebind.
166825511a47STejun Heo  *
1669ea1abd61SLai Jiangshan  * On return, all non-manager workers are scheduled for rebind - see
1670ea1abd61SLai Jiangshan  * manage_workers() for the manager special case.  Any idle worker
1671ea1abd61SLai Jiangshan  * including the manager will not appear on @idle_list until rebind is
1672ea1abd61SLai Jiangshan  * complete, making local wake-ups safe.
167325511a47STejun Heo  */
167425511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
167525511a47STejun Heo {
167625511a47STejun Heo 	struct worker_pool *pool;
1677ea1abd61SLai Jiangshan 	struct worker *worker, *n;
167825511a47STejun Heo 	struct hlist_node *pos;
167925511a47STejun Heo 	int i;
168025511a47STejun Heo 
168125511a47STejun Heo 	lockdep_assert_held(&gcwq->lock);
168225511a47STejun Heo 
168325511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
1684b2eb83d1SLai Jiangshan 		lockdep_assert_held(&pool->assoc_mutex);
168525511a47STejun Heo 
16865f7dabfdSLai Jiangshan 	/* dequeue and kick idle ones */
168725511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
1688ea1abd61SLai Jiangshan 		list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1689ea1abd61SLai Jiangshan 			/*
1690ea1abd61SLai Jiangshan 			 * idle workers should be off @pool->idle_list
1691ea1abd61SLai Jiangshan 			 * until rebind is complete to avoid receiving
1692ea1abd61SLai Jiangshan 			 * premature local wake-ups.
1693ea1abd61SLai Jiangshan 			 */
1694ea1abd61SLai Jiangshan 			list_del_init(&worker->entry);
169525511a47STejun Heo 
16965f7dabfdSLai Jiangshan 			/*
16975f7dabfdSLai Jiangshan 			 * worker_thread() will see the above dequeuing
16985f7dabfdSLai Jiangshan 			 * and call idle_worker_rebind().
16995f7dabfdSLai Jiangshan 			 */
170025511a47STejun Heo 			wake_up_process(worker->task);
170125511a47STejun Heo 		}
170225511a47STejun Heo 	}
170325511a47STejun Heo 
1704ea1abd61SLai Jiangshan 	/* rebind busy workers */
170525511a47STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
170625511a47STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
1707e2b6a6d5SJoonsoo Kim 		struct workqueue_struct *wq;
170825511a47STejun Heo 
170925511a47STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
171025511a47STejun Heo 				     work_data_bits(rebind_work)))
171125511a47STejun Heo 			continue;
171225511a47STejun Heo 
171325511a47STejun Heo 		debug_work_activate(rebind_work);
1714e2b6a6d5SJoonsoo Kim 
1715e2b6a6d5SJoonsoo Kim 		/*
1716e2b6a6d5SJoonsoo Kim 		 * wq doesn't really matter but let's keep @worker->pool
1717e2b6a6d5SJoonsoo Kim 		 * and @cwq->pool consistent for sanity.
1718e2b6a6d5SJoonsoo Kim 		 */
1719e2b6a6d5SJoonsoo Kim 		if (worker_pool_pri(worker->pool))
1720e2b6a6d5SJoonsoo Kim 			wq = system_highpri_wq;
1721e2b6a6d5SJoonsoo Kim 		else
1722e2b6a6d5SJoonsoo Kim 			wq = system_wq;
1723e2b6a6d5SJoonsoo Kim 
1724e2b6a6d5SJoonsoo Kim 		insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
172525511a47STejun Heo 			worker->scheduled.next,
172625511a47STejun Heo 			work_color_to_flags(WORK_NO_COLOR));
172725511a47STejun Heo 	}
172825511a47STejun Heo }
172925511a47STejun Heo 
1730c34056a3STejun Heo static struct worker *alloc_worker(void)
1731c34056a3STejun Heo {
1732c34056a3STejun Heo 	struct worker *worker;
1733c34056a3STejun Heo 
1734c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1735c8e55f36STejun Heo 	if (worker) {
1736c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1737affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
173825511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1739e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1740e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1741c8e55f36STejun Heo 	}
1742c34056a3STejun Heo 	return worker;
1743c34056a3STejun Heo }
1744c34056a3STejun Heo 
1745c34056a3STejun Heo /**
1746c34056a3STejun Heo  * create_worker - create a new workqueue worker
174763d95a91STejun Heo  * @pool: pool the new worker will belong to
1748c34056a3STejun Heo  *
174963d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1750c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1751c34056a3STejun Heo  * destroy_worker().
1752c34056a3STejun Heo  *
1753c34056a3STejun Heo  * CONTEXT:
1754c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1755c34056a3STejun Heo  *
1756c34056a3STejun Heo  * RETURNS:
1757c34056a3STejun Heo  * Pointer to the newly created worker.
1758c34056a3STejun Heo  */
1759bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1760c34056a3STejun Heo {
176163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
17623270476aSTejun Heo 	const char *pri = worker_pool_pri(pool) ? "H" : "";
1763c34056a3STejun Heo 	struct worker *worker = NULL;
1764f3421797STejun Heo 	int id = -1;
1765c34056a3STejun Heo 
17668b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1767bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
17688b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1769bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1770c34056a3STejun Heo 			goto fail;
17718b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1772c34056a3STejun Heo 	}
17738b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1774c34056a3STejun Heo 
1775c34056a3STejun Heo 	worker = alloc_worker();
1776c34056a3STejun Heo 	if (!worker)
1777c34056a3STejun Heo 		goto fail;
1778c34056a3STejun Heo 
1779bd7bdd43STejun Heo 	worker->pool = pool;
1780c34056a3STejun Heo 	worker->id = id;
1781c34056a3STejun Heo 
1782bc2ae0f5STejun Heo 	if (gcwq->cpu != WORK_CPU_UNBOUND)
178394dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
17843270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
17853270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1786f3421797STejun Heo 	else
1787f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
17883270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1789c34056a3STejun Heo 	if (IS_ERR(worker->task))
1790c34056a3STejun Heo 		goto fail;
1791c34056a3STejun Heo 
17923270476aSTejun Heo 	if (worker_pool_pri(pool))
17933270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
17943270476aSTejun Heo 
1795db7bccf4STejun Heo 	/*
1796bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
1797bc2ae0f5STejun Heo 	 * %GCWQ_DISASSOCIATED.  The caller is responsible for ensuring the
1798bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1799bc2ae0f5STejun Heo 	 * above the flag definition for details.
1800bc2ae0f5STejun Heo 	 *
1801bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1802bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1803db7bccf4STejun Heo 	 */
1804bc2ae0f5STejun Heo 	if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
18058b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1806bc2ae0f5STejun Heo 	} else {
1807db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1808f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1809f3421797STejun Heo 	}
1810c34056a3STejun Heo 
1811c34056a3STejun Heo 	return worker;
1812c34056a3STejun Heo fail:
1813c34056a3STejun Heo 	if (id >= 0) {
18148b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1815bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
18168b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1817c34056a3STejun Heo 	}
1818c34056a3STejun Heo 	kfree(worker);
1819c34056a3STejun Heo 	return NULL;
1820c34056a3STejun Heo }
1821c34056a3STejun Heo 
1822c34056a3STejun Heo /**
1823c34056a3STejun Heo  * start_worker - start a newly created worker
1824c34056a3STejun Heo  * @worker: worker to start
1825c34056a3STejun Heo  *
1826c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1827c34056a3STejun Heo  *
1828c34056a3STejun Heo  * CONTEXT:
18298b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1830c34056a3STejun Heo  */
1831c34056a3STejun Heo static void start_worker(struct worker *worker)
1832c34056a3STejun Heo {
1833cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1834bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1835c8e55f36STejun Heo 	worker_enter_idle(worker);
1836c34056a3STejun Heo 	wake_up_process(worker->task);
1837c34056a3STejun Heo }
1838c34056a3STejun Heo 
1839c34056a3STejun Heo /**
1840c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1841c34056a3STejun Heo  * @worker: worker to be destroyed
1842c34056a3STejun Heo  *
1843c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1844c8e55f36STejun Heo  *
1845c8e55f36STejun Heo  * CONTEXT:
1846c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1847c34056a3STejun Heo  */
1848c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1849c34056a3STejun Heo {
1850bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1851bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1852c34056a3STejun Heo 	int id = worker->id;
1853c34056a3STejun Heo 
1854c34056a3STejun Heo 	/* sanity check frenzy */
1855c34056a3STejun Heo 	BUG_ON(worker->current_work);
1856affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1857c34056a3STejun Heo 
1858c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1859bd7bdd43STejun Heo 		pool->nr_workers--;
1860c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1861bd7bdd43STejun Heo 		pool->nr_idle--;
1862c8e55f36STejun Heo 
1863c8e55f36STejun Heo 	list_del_init(&worker->entry);
1864cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1865c8e55f36STejun Heo 
1866c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1867c8e55f36STejun Heo 
1868c34056a3STejun Heo 	kthread_stop(worker->task);
1869c34056a3STejun Heo 	kfree(worker);
1870c34056a3STejun Heo 
18718b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1872bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1873c34056a3STejun Heo }
1874c34056a3STejun Heo 
187563d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1876e22bee78STejun Heo {
187763d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
187863d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1879e22bee78STejun Heo 
1880e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1881e22bee78STejun Heo 
188263d95a91STejun Heo 	if (too_many_workers(pool)) {
1883e22bee78STejun Heo 		struct worker *worker;
1884e22bee78STejun Heo 		unsigned long expires;
1885e22bee78STejun Heo 
1886e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
188763d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1888e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1889e22bee78STejun Heo 
1890e22bee78STejun Heo 		if (time_before(jiffies, expires))
189163d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1892e22bee78STejun Heo 		else {
1893e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
189411ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
189563d95a91STejun Heo 			wake_up_worker(pool);
1896e22bee78STejun Heo 		}
1897e22bee78STejun Heo 	}
1898e22bee78STejun Heo 
1899e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1900e22bee78STejun Heo }
1901e22bee78STejun Heo 
1902e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1903e22bee78STejun Heo {
1904e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1905e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1906f3421797STejun Heo 	unsigned int cpu;
1907e22bee78STejun Heo 
1908e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1909e22bee78STejun Heo 		return false;
1910e22bee78STejun Heo 
1911e22bee78STejun Heo 	/* mayday mayday mayday */
1912bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1913f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1914f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1915f3421797STejun Heo 		cpu = 0;
1916f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1917e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1918e22bee78STejun Heo 	return true;
1919e22bee78STejun Heo }
1920e22bee78STejun Heo 
192163d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1922e22bee78STejun Heo {
192363d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
192463d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1925e22bee78STejun Heo 	struct work_struct *work;
1926e22bee78STejun Heo 
1927e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1928e22bee78STejun Heo 
192963d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1930e22bee78STejun Heo 		/*
1931e22bee78STejun Heo 		 * We've been trying to create a new worker but
1932e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1933e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1934e22bee78STejun Heo 		 * rescuers.
1935e22bee78STejun Heo 		 */
193663d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1937e22bee78STejun Heo 			send_mayday(work);
1938e22bee78STejun Heo 	}
1939e22bee78STejun Heo 
1940e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1941e22bee78STejun Heo 
194263d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1943e22bee78STejun Heo }
1944e22bee78STejun Heo 
1945e22bee78STejun Heo /**
1946e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
194763d95a91STejun Heo  * @pool: pool to create a new worker for
1948e22bee78STejun Heo  *
194963d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1950e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1951e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
195263d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1953e22bee78STejun Heo  * possible allocation deadlock.
1954e22bee78STejun Heo  *
1955e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1956e22bee78STejun Heo  * may_start_working() true.
1957e22bee78STejun Heo  *
1958e22bee78STejun Heo  * LOCKING:
1959e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1960e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1961e22bee78STejun Heo  * manager.
1962e22bee78STejun Heo  *
1963e22bee78STejun Heo  * RETURNS:
1964e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1965e22bee78STejun Heo  * otherwise.
1966e22bee78STejun Heo  */
196763d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
196806bd6ebfSNamhyung Kim __releases(&gcwq->lock)
196906bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1970e22bee78STejun Heo {
197163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
197263d95a91STejun Heo 
197363d95a91STejun Heo 	if (!need_to_create_worker(pool))
1974e22bee78STejun Heo 		return false;
1975e22bee78STejun Heo restart:
19769f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
19779f9c2364STejun Heo 
1978e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
197963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1980e22bee78STejun Heo 
1981e22bee78STejun Heo 	while (true) {
1982e22bee78STejun Heo 		struct worker *worker;
1983e22bee78STejun Heo 
1984bc2ae0f5STejun Heo 		worker = create_worker(pool);
1985e22bee78STejun Heo 		if (worker) {
198663d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1987e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1988e22bee78STejun Heo 			start_worker(worker);
198963d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1990e22bee78STejun Heo 			return true;
1991e22bee78STejun Heo 		}
1992e22bee78STejun Heo 
199363d95a91STejun Heo 		if (!need_to_create_worker(pool))
1994e22bee78STejun Heo 			break;
1995e22bee78STejun Heo 
1996e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1997e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
19989f9c2364STejun Heo 
199963d95a91STejun Heo 		if (!need_to_create_worker(pool))
2000e22bee78STejun Heo 			break;
2001e22bee78STejun Heo 	}
2002e22bee78STejun Heo 
200363d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2004e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
200563d95a91STejun Heo 	if (need_to_create_worker(pool))
2006e22bee78STejun Heo 		goto restart;
2007e22bee78STejun Heo 	return true;
2008e22bee78STejun Heo }
2009e22bee78STejun Heo 
2010e22bee78STejun Heo /**
2011e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
201263d95a91STejun Heo  * @pool: pool to destroy workers for
2013e22bee78STejun Heo  *
201463d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
2015e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
2016e22bee78STejun Heo  *
2017e22bee78STejun Heo  * LOCKING:
2018e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2019e22bee78STejun Heo  * multiple times.  Called only from manager.
2020e22bee78STejun Heo  *
2021e22bee78STejun Heo  * RETURNS:
2022e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
2023e22bee78STejun Heo  * otherwise.
2024e22bee78STejun Heo  */
202563d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
2026e22bee78STejun Heo {
2027e22bee78STejun Heo 	bool ret = false;
2028e22bee78STejun Heo 
202963d95a91STejun Heo 	while (too_many_workers(pool)) {
2030e22bee78STejun Heo 		struct worker *worker;
2031e22bee78STejun Heo 		unsigned long expires;
2032e22bee78STejun Heo 
203363d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2034e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2035e22bee78STejun Heo 
2036e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
203763d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2038e22bee78STejun Heo 			break;
2039e22bee78STejun Heo 		}
2040e22bee78STejun Heo 
2041e22bee78STejun Heo 		destroy_worker(worker);
2042e22bee78STejun Heo 		ret = true;
2043e22bee78STejun Heo 	}
2044e22bee78STejun Heo 
2045e22bee78STejun Heo 	return ret;
2046e22bee78STejun Heo }
2047e22bee78STejun Heo 
2048e22bee78STejun Heo /**
2049e22bee78STejun Heo  * manage_workers - manage worker pool
2050e22bee78STejun Heo  * @worker: self
2051e22bee78STejun Heo  *
2052e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
2053e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2054e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
2055e22bee78STejun Heo  *
2056e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2057e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2058e22bee78STejun Heo  * and may_start_working() is true.
2059e22bee78STejun Heo  *
2060e22bee78STejun Heo  * CONTEXT:
2061e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2062e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2063e22bee78STejun Heo  *
2064e22bee78STejun Heo  * RETURNS:
2065e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
2066e22bee78STejun Heo  * some action was taken.
2067e22bee78STejun Heo  */
2068e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2069e22bee78STejun Heo {
207063d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2071e22bee78STejun Heo 	bool ret = false;
2072e22bee78STejun Heo 
2073ee378aa4SLai Jiangshan 	if (pool->flags & POOL_MANAGING_WORKERS)
2074e22bee78STejun Heo 		return ret;
2075e22bee78STejun Heo 
2076552a37e9SLai Jiangshan 	pool->flags |= POOL_MANAGING_WORKERS;
2077ee378aa4SLai Jiangshan 
2078ee378aa4SLai Jiangshan 	/*
2079ee378aa4SLai Jiangshan 	 * To simplify both worker management and CPU hotplug, hold off
2080ee378aa4SLai Jiangshan 	 * management while hotplug is in progress.  CPU hotplug path can't
2081ee378aa4SLai Jiangshan 	 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2082ee378aa4SLai Jiangshan 	 * lead to idle worker depletion (all become busy thinking someone
2083ee378aa4SLai Jiangshan 	 * else is managing) which in turn can result in deadlock under
2084b2eb83d1SLai Jiangshan 	 * extreme circumstances.  Use @pool->assoc_mutex to synchronize
2085ee378aa4SLai Jiangshan 	 * manager against CPU hotplug.
2086ee378aa4SLai Jiangshan 	 *
2087b2eb83d1SLai Jiangshan 	 * assoc_mutex would always be free unless CPU hotplug is in
2088ee378aa4SLai Jiangshan 	 * progress.  trylock first without dropping @gcwq->lock.
2089ee378aa4SLai Jiangshan 	 */
2090b2eb83d1SLai Jiangshan 	if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
2091ee378aa4SLai Jiangshan 		spin_unlock_irq(&pool->gcwq->lock);
2092b2eb83d1SLai Jiangshan 		mutex_lock(&pool->assoc_mutex);
2093ee378aa4SLai Jiangshan 		/*
2094ee378aa4SLai Jiangshan 		 * CPU hotplug could have happened while we were waiting
2095b2eb83d1SLai Jiangshan 		 * for assoc_mutex.  Hotplug itself can't handle us
2096ee378aa4SLai Jiangshan 		 * because manager isn't either on idle or busy list, and
2097ee378aa4SLai Jiangshan 		 * @gcwq's state and ours could have deviated.
2098ee378aa4SLai Jiangshan 		 *
2099b2eb83d1SLai Jiangshan 		 * As hotplug is now excluded via assoc_mutex, we can
2100ee378aa4SLai Jiangshan 		 * simply try to bind.  It will succeed or fail depending
2101ee378aa4SLai Jiangshan 		 * on @gcwq's current state.  Try it and adjust
2102ee378aa4SLai Jiangshan 		 * %WORKER_UNBOUND accordingly.
2103ee378aa4SLai Jiangshan 		 */
2104ee378aa4SLai Jiangshan 		if (worker_maybe_bind_and_lock(worker))
2105ee378aa4SLai Jiangshan 			worker->flags &= ~WORKER_UNBOUND;
2106ee378aa4SLai Jiangshan 		else
2107ee378aa4SLai Jiangshan 			worker->flags |= WORKER_UNBOUND;
2108ee378aa4SLai Jiangshan 
2109ee378aa4SLai Jiangshan 		ret = true;
2110ee378aa4SLai Jiangshan 	}
2111ee378aa4SLai Jiangshan 
211211ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2113e22bee78STejun Heo 
2114e22bee78STejun Heo 	/*
2115e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2116e22bee78STejun Heo 	 * on return.
2117e22bee78STejun Heo 	 */
211863d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
211963d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2120e22bee78STejun Heo 
2121552a37e9SLai Jiangshan 	pool->flags &= ~POOL_MANAGING_WORKERS;
2122b2eb83d1SLai Jiangshan 	mutex_unlock(&pool->assoc_mutex);
2123e22bee78STejun Heo 	return ret;
2124e22bee78STejun Heo }
2125e22bee78STejun Heo 
2126a62428c0STejun Heo /**
2127a62428c0STejun Heo  * process_one_work - process single work
2128c34056a3STejun Heo  * @worker: self
2129a62428c0STejun Heo  * @work: work to process
2130a62428c0STejun Heo  *
2131a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2132a62428c0STejun Heo  * process a single work including synchronization against and
2133a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2134a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2135a62428c0STejun Heo  * call this function to process a work.
2136a62428c0STejun Heo  *
2137a62428c0STejun Heo  * CONTEXT:
21388b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
2139a62428c0STejun Heo  */
2140c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
214106bd6ebfSNamhyung Kim __releases(&gcwq->lock)
214206bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
21431da177e4SLinus Torvalds {
21447e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2145bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2146bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
2147c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
2148fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
21496bb49e59SDavid Howells 	work_func_t f = work->func;
215073f53c4aSTejun Heo 	int work_color;
21517e11629dSTejun Heo 	struct worker *collision;
21524e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21534e6045f1SJohannes Berg 	/*
2154a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2155a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2156a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2157a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2158a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21594e6045f1SJohannes Berg 	 */
21604d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21614d82a1deSPeter Zijlstra 
21624d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21634e6045f1SJohannes Berg #endif
21646fec10a1STejun Heo 	/*
21656fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21666fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
21676fec10a1STejun Heo 	 * unbound or a disassociated gcwq.
21686fec10a1STejun Heo 	 */
21695f7dabfdSLai Jiangshan 	WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
21706fec10a1STejun Heo 		     !(gcwq->flags & GCWQ_DISASSOCIATED) &&
217125511a47STejun Heo 		     raw_smp_processor_id() != gcwq->cpu);
217225511a47STejun Heo 
21737e11629dSTejun Heo 	/*
21747e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21757e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21767e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21777e11629dSTejun Heo 	 * currently executing one.
21787e11629dSTejun Heo 	 */
21797e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
21807e11629dSTejun Heo 	if (unlikely(collision)) {
21817e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21827e11629dSTejun Heo 		return;
21837e11629dSTejun Heo 	}
21841da177e4SLinus Torvalds 
21858930cabaSTejun Heo 	/* claim and dequeue */
21861da177e4SLinus Torvalds 	debug_work_deactivate(work);
2187c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
2188c34056a3STejun Heo 	worker->current_work = work;
21898cca0eeaSTejun Heo 	worker->current_cwq = cwq;
219073f53c4aSTejun Heo 	work_color = get_work_color(work);
21917a22ad75STejun Heo 
2192a62428c0STejun Heo 	list_del_init(&work->entry);
2193a62428c0STejun Heo 
2194649027d7STejun Heo 	/*
2195fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2196fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2197fb0e7bebSTejun Heo 	 */
2198fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2199fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2200fb0e7bebSTejun Heo 
2201974271c4STejun Heo 	/*
2202974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
2203974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2204974271c4STejun Heo 	 */
220563d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
220663d95a91STejun Heo 		wake_up_worker(pool);
2207974271c4STejun Heo 
22088930cabaSTejun Heo 	/*
220923657bb1STejun Heo 	 * Record the last CPU and clear PENDING which should be the last
221023657bb1STejun Heo 	 * update to @work.  Also, do this inside @gcwq->lock so that
221123657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
221223657bb1STejun Heo 	 * disabled.
22138930cabaSTejun Heo 	 */
22148930cabaSTejun Heo 	set_work_cpu_and_clear_pending(work, gcwq->cpu);
22151da177e4SLinus Torvalds 
22168930cabaSTejun Heo 	spin_unlock_irq(&gcwq->lock);
2217959d1af8STejun Heo 
2218e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
22193295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2220e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
222165f27f38SDavid Howells 	f(work);
2222e36c886aSArjan van de Ven 	/*
2223e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2224e36c886aSArjan van de Ven 	 * point will only record its address.
2225e36c886aSArjan van de Ven 	 */
2226e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22273295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
22283295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
22291da177e4SLinus Torvalds 
2230d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2231044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2232044c782cSValentin Ilie 		       "     last function: %pf\n",
2233044c782cSValentin Ilie 		       current->comm, preempt_count(), task_pid_nr(current), f);
2234d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2235d5abe669SPeter Zijlstra 		dump_stack();
2236d5abe669SPeter Zijlstra 	}
2237d5abe669SPeter Zijlstra 
22388b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2239a62428c0STejun Heo 
2240fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2241fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2242fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2243fb0e7bebSTejun Heo 
2244a62428c0STejun Heo 	/* we're done with it, release */
2245c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
2246c34056a3STejun Heo 	worker->current_work = NULL;
22478cca0eeaSTejun Heo 	worker->current_cwq = NULL;
22488a2e8e5dSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color, false);
22491da177e4SLinus Torvalds }
22501da177e4SLinus Torvalds 
2251affee4b2STejun Heo /**
2252affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2253affee4b2STejun Heo  * @worker: self
2254affee4b2STejun Heo  *
2255affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2256affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2257affee4b2STejun Heo  * fetches a work from the top and executes it.
2258affee4b2STejun Heo  *
2259affee4b2STejun Heo  * CONTEXT:
22608b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2261affee4b2STejun Heo  * multiple times.
2262affee4b2STejun Heo  */
2263affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22641da177e4SLinus Torvalds {
2265affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2266affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2267a62428c0STejun Heo 						struct work_struct, entry);
2268c34056a3STejun Heo 		process_one_work(worker, work);
2269a62428c0STejun Heo 	}
22701da177e4SLinus Torvalds }
22711da177e4SLinus Torvalds 
22724690c4abSTejun Heo /**
22734690c4abSTejun Heo  * worker_thread - the worker thread function
2274c34056a3STejun Heo  * @__worker: self
22754690c4abSTejun Heo  *
2276e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2277e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2278e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2279e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2280e22bee78STejun Heo  * rescuer_thread().
22814690c4abSTejun Heo  */
2282c34056a3STejun Heo static int worker_thread(void *__worker)
22831da177e4SLinus Torvalds {
2284c34056a3STejun Heo 	struct worker *worker = __worker;
2285bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2286bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
22871da177e4SLinus Torvalds 
2288e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2289e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2290c8e55f36STejun Heo woke_up:
22918b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2292affee4b2STejun Heo 
22935f7dabfdSLai Jiangshan 	/* we are off idle list if destruction or rebind is requested */
22945f7dabfdSLai Jiangshan 	if (unlikely(list_empty(&worker->entry))) {
2295c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
229625511a47STejun Heo 
22975f7dabfdSLai Jiangshan 		/* if DIE is set, destruction is requested */
229825511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2299e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2300c8e55f36STejun Heo 			return 0;
2301c8e55f36STejun Heo 		}
2302c8e55f36STejun Heo 
23035f7dabfdSLai Jiangshan 		/* otherwise, rebind */
230425511a47STejun Heo 		idle_worker_rebind(worker);
230525511a47STejun Heo 		goto woke_up;
230625511a47STejun Heo 	}
230725511a47STejun Heo 
2308c8e55f36STejun Heo 	worker_leave_idle(worker);
2309db7bccf4STejun Heo recheck:
2310e22bee78STejun Heo 	/* no more worker necessary? */
231163d95a91STejun Heo 	if (!need_more_worker(pool))
2312e22bee78STejun Heo 		goto sleep;
2313e22bee78STejun Heo 
2314e22bee78STejun Heo 	/* do we need to manage? */
231563d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2316e22bee78STejun Heo 		goto recheck;
2317e22bee78STejun Heo 
2318c8e55f36STejun Heo 	/*
2319c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2320c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2321c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2322c8e55f36STejun Heo 	 */
2323c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2324c8e55f36STejun Heo 
2325e22bee78STejun Heo 	/*
2326e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2327e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2328e22bee78STejun Heo 	 * assumed the manager role.
2329e22bee78STejun Heo 	 */
2330e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2331e22bee78STejun Heo 
2332e22bee78STejun Heo 	do {
2333affee4b2STejun Heo 		struct work_struct *work =
2334bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2335affee4b2STejun Heo 					 struct work_struct, entry);
2336affee4b2STejun Heo 
2337c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2338affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2339affee4b2STejun Heo 			process_one_work(worker, work);
2340affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2341affee4b2STejun Heo 				process_scheduled_works(worker);
2342affee4b2STejun Heo 		} else {
2343c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2344affee4b2STejun Heo 			process_scheduled_works(worker);
2345affee4b2STejun Heo 		}
234663d95a91STejun Heo 	} while (keep_working(pool));
2347affee4b2STejun Heo 
2348e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2349d313dd85STejun Heo sleep:
235063d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2351e22bee78STejun Heo 		goto recheck;
2352d313dd85STejun Heo 
2353c8e55f36STejun Heo 	/*
2354e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2355e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2356e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2357e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2358e22bee78STejun Heo 	 * prevent losing any event.
2359c8e55f36STejun Heo 	 */
2360c8e55f36STejun Heo 	worker_enter_idle(worker);
2361c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
23628b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23631da177e4SLinus Torvalds 	schedule();
2364c8e55f36STejun Heo 	goto woke_up;
23651da177e4SLinus Torvalds }
23661da177e4SLinus Torvalds 
2367e22bee78STejun Heo /**
2368e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2369e22bee78STejun Heo  * @__wq: the associated workqueue
2370e22bee78STejun Heo  *
2371e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2372e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2373e22bee78STejun Heo  *
2374e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2375e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2376e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2377e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2378e22bee78STejun Heo  * the problem rescuer solves.
2379e22bee78STejun Heo  *
2380e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2381e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2382e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2383e22bee78STejun Heo  *
2384e22bee78STejun Heo  * This should happen rarely.
2385e22bee78STejun Heo  */
2386e22bee78STejun Heo static int rescuer_thread(void *__wq)
2387e22bee78STejun Heo {
2388e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2389e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2390e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2391f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2392e22bee78STejun Heo 	unsigned int cpu;
2393e22bee78STejun Heo 
2394e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2395e22bee78STejun Heo repeat:
2396e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
23971da177e4SLinus Torvalds 
23981da177e4SLinus Torvalds 	if (kthread_should_stop())
2399e22bee78STejun Heo 		return 0;
24001da177e4SLinus Torvalds 
2401f3421797STejun Heo 	/*
2402f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2403f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2404f3421797STejun Heo 	 */
2405f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2406f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2407f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2408bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2409bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2410e22bee78STejun Heo 		struct work_struct *work, *n;
2411e22bee78STejun Heo 
2412e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2413f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2414e22bee78STejun Heo 
2415e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2416bd7bdd43STejun Heo 		rescuer->pool = pool;
2417e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2418e22bee78STejun Heo 
2419e22bee78STejun Heo 		/*
2420e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2421e22bee78STejun Heo 		 * process'em.
2422e22bee78STejun Heo 		 */
2423e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2424bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2425e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2426e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2427e22bee78STejun Heo 
2428e22bee78STejun Heo 		process_scheduled_works(rescuer);
24297576958aSTejun Heo 
24307576958aSTejun Heo 		/*
24317576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
24327576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24337576958aSTejun Heo 		 * and stalling the execution.
24347576958aSTejun Heo 		 */
243563d95a91STejun Heo 		if (keep_working(pool))
243663d95a91STejun Heo 			wake_up_worker(pool);
24377576958aSTejun Heo 
2438e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
24391da177e4SLinus Torvalds 	}
24401da177e4SLinus Torvalds 
2441e22bee78STejun Heo 	schedule();
2442e22bee78STejun Heo 	goto repeat;
24431da177e4SLinus Torvalds }
24441da177e4SLinus Torvalds 
2445fc2e4d70SOleg Nesterov struct wq_barrier {
2446fc2e4d70SOleg Nesterov 	struct work_struct	work;
2447fc2e4d70SOleg Nesterov 	struct completion	done;
2448fc2e4d70SOleg Nesterov };
2449fc2e4d70SOleg Nesterov 
2450fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2451fc2e4d70SOleg Nesterov {
2452fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2453fc2e4d70SOleg Nesterov 	complete(&barr->done);
2454fc2e4d70SOleg Nesterov }
2455fc2e4d70SOleg Nesterov 
24564690c4abSTejun Heo /**
24574690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
24584690c4abSTejun Heo  * @cwq: cwq to insert barrier into
24594690c4abSTejun Heo  * @barr: wq_barrier to insert
2460affee4b2STejun Heo  * @target: target work to attach @barr to
2461affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24624690c4abSTejun Heo  *
2463affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2464affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2465affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2466affee4b2STejun Heo  * cpu.
2467affee4b2STejun Heo  *
2468affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2469affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2470affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2471affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2472affee4b2STejun Heo  * after a work with LINKED flag set.
2473affee4b2STejun Heo  *
2474affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2475affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
24764690c4abSTejun Heo  *
24774690c4abSTejun Heo  * CONTEXT:
24788b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
24794690c4abSTejun Heo  */
248083c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2481affee4b2STejun Heo 			      struct wq_barrier *barr,
2482affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2483fc2e4d70SOleg Nesterov {
2484affee4b2STejun Heo 	struct list_head *head;
2485affee4b2STejun Heo 	unsigned int linked = 0;
2486affee4b2STejun Heo 
2487dc186ad7SThomas Gleixner 	/*
24888b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2489dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2490dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2491dc186ad7SThomas Gleixner 	 * might deadlock.
2492dc186ad7SThomas Gleixner 	 */
2493ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
249422df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2495fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
249683c22520SOleg Nesterov 
2497affee4b2STejun Heo 	/*
2498affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2499affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2500affee4b2STejun Heo 	 */
2501affee4b2STejun Heo 	if (worker)
2502affee4b2STejun Heo 		head = worker->scheduled.next;
2503affee4b2STejun Heo 	else {
2504affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2505affee4b2STejun Heo 
2506affee4b2STejun Heo 		head = target->entry.next;
2507affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2508affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2509affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2510affee4b2STejun Heo 	}
2511affee4b2STejun Heo 
2512dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2513affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2514affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2515fc2e4d70SOleg Nesterov }
2516fc2e4d70SOleg Nesterov 
251773f53c4aSTejun Heo /**
251873f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
251973f53c4aSTejun Heo  * @wq: workqueue being flushed
252073f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
252173f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
252273f53c4aSTejun Heo  *
252373f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
252473f53c4aSTejun Heo  *
252573f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
252673f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
252773f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
252873f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
252973f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
253073f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
253173f53c4aSTejun Heo  *
253273f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
253373f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
253473f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
253573f53c4aSTejun Heo  * is returned.
253673f53c4aSTejun Heo  *
253773f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
253873f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
253973f53c4aSTejun Heo  * advanced to @work_color.
254073f53c4aSTejun Heo  *
254173f53c4aSTejun Heo  * CONTEXT:
254273f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
254373f53c4aSTejun Heo  *
254473f53c4aSTejun Heo  * RETURNS:
254573f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
254673f53c4aSTejun Heo  * otherwise.
254773f53c4aSTejun Heo  */
254873f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
254973f53c4aSTejun Heo 				      int flush_color, int work_color)
25501da177e4SLinus Torvalds {
255173f53c4aSTejun Heo 	bool wait = false;
255273f53c4aSTejun Heo 	unsigned int cpu;
25531da177e4SLinus Torvalds 
255473f53c4aSTejun Heo 	if (flush_color >= 0) {
255573f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
255673f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2557dc186ad7SThomas Gleixner 	}
255814441960SOleg Nesterov 
2559f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
256073f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2561bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
25621da177e4SLinus Torvalds 
25638b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
256473f53c4aSTejun Heo 
256573f53c4aSTejun Heo 		if (flush_color >= 0) {
256673f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
256773f53c4aSTejun Heo 
256873f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
256973f53c4aSTejun Heo 				cwq->flush_color = flush_color;
257073f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
257173f53c4aSTejun Heo 				wait = true;
25721da177e4SLinus Torvalds 			}
257373f53c4aSTejun Heo 		}
257473f53c4aSTejun Heo 
257573f53c4aSTejun Heo 		if (work_color >= 0) {
257673f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
257773f53c4aSTejun Heo 			cwq->work_color = work_color;
257873f53c4aSTejun Heo 		}
257973f53c4aSTejun Heo 
25808b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
25811da177e4SLinus Torvalds 	}
25821da177e4SLinus Torvalds 
258373f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
258473f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
258573f53c4aSTejun Heo 
258673f53c4aSTejun Heo 	return wait;
258783c22520SOleg Nesterov }
25881da177e4SLinus Torvalds 
25890fcb78c2SRolf Eike Beer /**
25901da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
25910fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
25921da177e4SLinus Torvalds  *
25931da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
25941da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
25951da177e4SLinus Torvalds  *
2596fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2597fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
25981da177e4SLinus Torvalds  */
25997ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
26001da177e4SLinus Torvalds {
260173f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
260273f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
260373f53c4aSTejun Heo 		.flush_color = -1,
260473f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
260573f53c4aSTejun Heo 	};
260673f53c4aSTejun Heo 	int next_color;
2607b1f4ec17SOleg Nesterov 
26083295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
26093295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
261073f53c4aSTejun Heo 
261173f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
261273f53c4aSTejun Heo 
261373f53c4aSTejun Heo 	/*
261473f53c4aSTejun Heo 	 * Start-to-wait phase
261573f53c4aSTejun Heo 	 */
261673f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
261773f53c4aSTejun Heo 
261873f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
261973f53c4aSTejun Heo 		/*
262073f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
262173f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
262273f53c4aSTejun Heo 		 * by one.
262373f53c4aSTejun Heo 		 */
262473f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
262573f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
262673f53c4aSTejun Heo 		wq->work_color = next_color;
262773f53c4aSTejun Heo 
262873f53c4aSTejun Heo 		if (!wq->first_flusher) {
262973f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
263073f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
263173f53c4aSTejun Heo 
263273f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
263373f53c4aSTejun Heo 
263473f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
263573f53c4aSTejun Heo 						       wq->work_color)) {
263673f53c4aSTejun Heo 				/* nothing to flush, done */
263773f53c4aSTejun Heo 				wq->flush_color = next_color;
263873f53c4aSTejun Heo 				wq->first_flusher = NULL;
263973f53c4aSTejun Heo 				goto out_unlock;
264073f53c4aSTejun Heo 			}
264173f53c4aSTejun Heo 		} else {
264273f53c4aSTejun Heo 			/* wait in queue */
264373f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
264473f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
264573f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
264673f53c4aSTejun Heo 		}
264773f53c4aSTejun Heo 	} else {
264873f53c4aSTejun Heo 		/*
264973f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
265073f53c4aSTejun Heo 		 * The next flush completion will assign us
265173f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
265273f53c4aSTejun Heo 		 */
265373f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
265473f53c4aSTejun Heo 	}
265573f53c4aSTejun Heo 
265673f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
265773f53c4aSTejun Heo 
265873f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
265973f53c4aSTejun Heo 
266073f53c4aSTejun Heo 	/*
266173f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
266273f53c4aSTejun Heo 	 *
266373f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
266473f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
266573f53c4aSTejun Heo 	 */
266673f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
266773f53c4aSTejun Heo 		return;
266873f53c4aSTejun Heo 
266973f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
267073f53c4aSTejun Heo 
26714ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26724ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26734ce48b37STejun Heo 		goto out_unlock;
26744ce48b37STejun Heo 
267573f53c4aSTejun Heo 	wq->first_flusher = NULL;
267673f53c4aSTejun Heo 
267773f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
267873f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
267973f53c4aSTejun Heo 
268073f53c4aSTejun Heo 	while (true) {
268173f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
268273f53c4aSTejun Heo 
268373f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
268473f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
268573f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
268673f53c4aSTejun Heo 				break;
268773f53c4aSTejun Heo 			list_del_init(&next->list);
268873f53c4aSTejun Heo 			complete(&next->done);
268973f53c4aSTejun Heo 		}
269073f53c4aSTejun Heo 
269173f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
269273f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
269373f53c4aSTejun Heo 
269473f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
269573f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
269673f53c4aSTejun Heo 
269773f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
269873f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
269973f53c4aSTejun Heo 			/*
270073f53c4aSTejun Heo 			 * Assign the same color to all overflowed
270173f53c4aSTejun Heo 			 * flushers, advance work_color and append to
270273f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
270373f53c4aSTejun Heo 			 * phase for these overflowed flushers.
270473f53c4aSTejun Heo 			 */
270573f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
270673f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
270773f53c4aSTejun Heo 
270873f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
270973f53c4aSTejun Heo 
271073f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
271173f53c4aSTejun Heo 					      &wq->flusher_queue);
271273f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
271373f53c4aSTejun Heo 		}
271473f53c4aSTejun Heo 
271573f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
271673f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
271773f53c4aSTejun Heo 			break;
271873f53c4aSTejun Heo 		}
271973f53c4aSTejun Heo 
272073f53c4aSTejun Heo 		/*
272173f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
272273f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
272373f53c4aSTejun Heo 		 */
272473f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
272573f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
272673f53c4aSTejun Heo 
272773f53c4aSTejun Heo 		list_del_init(&next->list);
272873f53c4aSTejun Heo 		wq->first_flusher = next;
272973f53c4aSTejun Heo 
273073f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
273173f53c4aSTejun Heo 			break;
273273f53c4aSTejun Heo 
273373f53c4aSTejun Heo 		/*
273473f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
273573f53c4aSTejun Heo 		 * flusher and repeat cascading.
273673f53c4aSTejun Heo 		 */
273773f53c4aSTejun Heo 		wq->first_flusher = NULL;
273873f53c4aSTejun Heo 	}
273973f53c4aSTejun Heo 
274073f53c4aSTejun Heo out_unlock:
274173f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
27421da177e4SLinus Torvalds }
2743ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27441da177e4SLinus Torvalds 
27459c5a2ba7STejun Heo /**
27469c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27479c5a2ba7STejun Heo  * @wq: workqueue to drain
27489c5a2ba7STejun Heo  *
27499c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27509c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27519c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27529c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27539c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27549c5a2ba7STejun Heo  * takes too long.
27559c5a2ba7STejun Heo  */
27569c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27579c5a2ba7STejun Heo {
27589c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
27599c5a2ba7STejun Heo 	unsigned int cpu;
27609c5a2ba7STejun Heo 
27619c5a2ba7STejun Heo 	/*
27629c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27639c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
27649c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
27659c5a2ba7STejun Heo 	 */
27669c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27679c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
27689c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
27699c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27709c5a2ba7STejun Heo reflush:
27719c5a2ba7STejun Heo 	flush_workqueue(wq);
27729c5a2ba7STejun Heo 
27739c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27749c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2775fa2563e4SThomas Tuttle 		bool drained;
27769c5a2ba7STejun Heo 
2777bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2778fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2779bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2780fa2563e4SThomas Tuttle 
2781fa2563e4SThomas Tuttle 		if (drained)
27829c5a2ba7STejun Heo 			continue;
27839c5a2ba7STejun Heo 
27849c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27859c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2786044c782cSValentin Ilie 			pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
27879c5a2ba7STejun Heo 				wq->name, flush_cnt);
27889c5a2ba7STejun Heo 		goto reflush;
27899c5a2ba7STejun Heo 	}
27909c5a2ba7STejun Heo 
27919c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27929c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
27939c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
27949c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27959c5a2ba7STejun Heo }
27969c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
27979c5a2ba7STejun Heo 
2798606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2799baf59022STejun Heo {
2800baf59022STejun Heo 	struct worker *worker = NULL;
2801baf59022STejun Heo 	struct global_cwq *gcwq;
2802baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2803baf59022STejun Heo 
2804baf59022STejun Heo 	might_sleep();
2805baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2806baf59022STejun Heo 	if (!gcwq)
2807baf59022STejun Heo 		return false;
2808baf59022STejun Heo 
2809baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2810baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2811baf59022STejun Heo 		/*
2812baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2813baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2814baf59022STejun Heo 		 * are not going to wait.
2815baf59022STejun Heo 		 */
2816baf59022STejun Heo 		smp_rmb();
2817baf59022STejun Heo 		cwq = get_work_cwq(work);
2818bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2819baf59022STejun Heo 			goto already_gone;
2820606a5020STejun Heo 	} else {
2821baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2822baf59022STejun Heo 		if (!worker)
2823baf59022STejun Heo 			goto already_gone;
2824baf59022STejun Heo 		cwq = worker->current_cwq;
2825606a5020STejun Heo 	}
2826baf59022STejun Heo 
2827baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2828baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2829baf59022STejun Heo 
2830e159489bSTejun Heo 	/*
2831e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2832e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2833e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2834e159489bSTejun Heo 	 * access.
2835e159489bSTejun Heo 	 */
2836e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2837baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2838e159489bSTejun Heo 	else
2839e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2840baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2841e159489bSTejun Heo 
2842baf59022STejun Heo 	return true;
2843baf59022STejun Heo already_gone:
2844baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2845baf59022STejun Heo 	return false;
2846baf59022STejun Heo }
2847baf59022STejun Heo 
2848db700897SOleg Nesterov /**
2849401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2850401a8d04STejun Heo  * @work: the work to flush
2851db700897SOleg Nesterov  *
2852606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2853606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2854401a8d04STejun Heo  *
2855401a8d04STejun Heo  * RETURNS:
2856401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2857401a8d04STejun Heo  * %false if it was already idle.
2858db700897SOleg Nesterov  */
2859401a8d04STejun Heo bool flush_work(struct work_struct *work)
2860db700897SOleg Nesterov {
2861db700897SOleg Nesterov 	struct wq_barrier barr;
2862db700897SOleg Nesterov 
28630976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28640976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28650976dfc1SStephen Boyd 
2866606a5020STejun Heo 	if (start_flush_work(work, &barr)) {
2867db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2868dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2869401a8d04STejun Heo 		return true;
2870606a5020STejun Heo 	} else {
2871401a8d04STejun Heo 		return false;
2872db700897SOleg Nesterov 	}
2873606a5020STejun Heo }
2874db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2875db700897SOleg Nesterov 
287636e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
28771f1f642eSOleg Nesterov {
2878bbb68dfaSTejun Heo 	unsigned long flags;
28791f1f642eSOleg Nesterov 	int ret;
28801f1f642eSOleg Nesterov 
28811f1f642eSOleg Nesterov 	do {
2882bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2883bbb68dfaSTejun Heo 		/*
2884bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2885bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2886bbb68dfaSTejun Heo 		 */
2887bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2888606a5020STejun Heo 			flush_work(work);
28891f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
28901f1f642eSOleg Nesterov 
2891bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2892bbb68dfaSTejun Heo 	mark_work_canceling(work);
2893bbb68dfaSTejun Heo 	local_irq_restore(flags);
2894bbb68dfaSTejun Heo 
2895606a5020STejun Heo 	flush_work(work);
28967a22ad75STejun Heo 	clear_work_data(work);
28971f1f642eSOleg Nesterov 	return ret;
28981f1f642eSOleg Nesterov }
28991f1f642eSOleg Nesterov 
29006e84d644SOleg Nesterov /**
2901401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2902401a8d04STejun Heo  * @work: the work to cancel
29036e84d644SOleg Nesterov  *
2904401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2905401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2906401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2907401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
29081f1f642eSOleg Nesterov  *
2909401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2910401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
29116e84d644SOleg Nesterov  *
2912401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
29136e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2914401a8d04STejun Heo  *
2915401a8d04STejun Heo  * RETURNS:
2916401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
29176e84d644SOleg Nesterov  */
2918401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29196e84d644SOleg Nesterov {
292036e227d2STejun Heo 	return __cancel_work_timer(work, false);
2921b89deed3SOleg Nesterov }
292228e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2923b89deed3SOleg Nesterov 
29246e84d644SOleg Nesterov /**
2925401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2926401a8d04STejun Heo  * @dwork: the delayed work to flush
29276e84d644SOleg Nesterov  *
2928401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2929401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2930401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29311f1f642eSOleg Nesterov  *
2932401a8d04STejun Heo  * RETURNS:
2933401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2934401a8d04STejun Heo  * %false if it was already idle.
29356e84d644SOleg Nesterov  */
2936401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2937401a8d04STejun Heo {
29388930cabaSTejun Heo 	local_irq_disable();
2939401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
29401265057fSTejun Heo 		__queue_work(dwork->cpu,
2941401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
29428930cabaSTejun Heo 	local_irq_enable();
2943401a8d04STejun Heo 	return flush_work(&dwork->work);
2944401a8d04STejun Heo }
2945401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2946401a8d04STejun Heo 
2947401a8d04STejun Heo /**
294857b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
294957b30ae7STejun Heo  * @dwork: delayed_work to cancel
295057b30ae7STejun Heo  *
295157b30ae7STejun Heo  * Kill off a pending delayed_work.  Returns %true if @dwork was pending
295257b30ae7STejun Heo  * and canceled; %false if wasn't pending.  Note that the work callback
295357b30ae7STejun Heo  * function may still be running on return, unless it returns %true and the
295457b30ae7STejun Heo  * work doesn't re-arm itself.  Explicitly flush or use
295557b30ae7STejun Heo  * cancel_delayed_work_sync() to wait on it.
295657b30ae7STejun Heo  *
295757b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
295857b30ae7STejun Heo  */
295957b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
296057b30ae7STejun Heo {
296157b30ae7STejun Heo 	unsigned long flags;
296257b30ae7STejun Heo 	int ret;
296357b30ae7STejun Heo 
296457b30ae7STejun Heo 	do {
296557b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
296657b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
296757b30ae7STejun Heo 
296857b30ae7STejun Heo 	if (unlikely(ret < 0))
296957b30ae7STejun Heo 		return false;
297057b30ae7STejun Heo 
297157b30ae7STejun Heo 	set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
297257b30ae7STejun Heo 	local_irq_restore(flags);
297357b30ae7STejun Heo 	return true;
297457b30ae7STejun Heo }
297557b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
297657b30ae7STejun Heo 
297757b30ae7STejun Heo /**
2978401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2979401a8d04STejun Heo  * @dwork: the delayed work cancel
2980401a8d04STejun Heo  *
2981401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2982401a8d04STejun Heo  *
2983401a8d04STejun Heo  * RETURNS:
2984401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2985401a8d04STejun Heo  */
2986401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
29876e84d644SOleg Nesterov {
298836e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
29896e84d644SOleg Nesterov }
2990f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
29911da177e4SLinus Torvalds 
2992d4283e93STejun Heo /**
29930a13c00eSTejun Heo  * schedule_work_on - put work task on a specific cpu
29940a13c00eSTejun Heo  * @cpu: cpu to put the work task on
29950a13c00eSTejun Heo  * @work: job to be done
29960a13c00eSTejun Heo  *
29970a13c00eSTejun Heo  * This puts a job on a specific cpu
29980a13c00eSTejun Heo  */
2999d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work)
30000a13c00eSTejun Heo {
30010a13c00eSTejun Heo 	return queue_work_on(cpu, system_wq, work);
30020a13c00eSTejun Heo }
30030a13c00eSTejun Heo EXPORT_SYMBOL(schedule_work_on);
30040a13c00eSTejun Heo 
30050fcb78c2SRolf Eike Beer /**
30060fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
30070fcb78c2SRolf Eike Beer  * @work: job to be done
30080fcb78c2SRolf Eike Beer  *
3009d4283e93STejun Heo  * Returns %false if @work was already on the kernel-global workqueue and
3010d4283e93STejun Heo  * %true otherwise.
30115b0f437dSBart Van Assche  *
30125b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
30135b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
30145b0f437dSBart Van Assche  * workqueue otherwise.
30150fcb78c2SRolf Eike Beer  */
3016d4283e93STejun Heo bool schedule_work(struct work_struct *work)
30171da177e4SLinus Torvalds {
3018d320c038STejun Heo 	return queue_work(system_wq, work);
30191da177e4SLinus Torvalds }
3020ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
30211da177e4SLinus Torvalds 
30220fcb78c2SRolf Eike Beer /**
30230fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
30240fcb78c2SRolf Eike Beer  * @cpu: cpu to use
302552bad64dSDavid Howells  * @dwork: job to be done
30260fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
30270fcb78c2SRolf Eike Beer  *
30280fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
30290fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
30300fcb78c2SRolf Eike Beer  */
3031d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3032d4283e93STejun Heo 			      unsigned long delay)
30331da177e4SLinus Torvalds {
3034d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
30351da177e4SLinus Torvalds }
3036ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
30371da177e4SLinus Torvalds 
3038b6136773SAndrew Morton /**
30390a13c00eSTejun Heo  * schedule_delayed_work - put work task in global workqueue after delay
30400a13c00eSTejun Heo  * @dwork: job to be done
30410a13c00eSTejun Heo  * @delay: number of jiffies to wait or 0 for immediate execution
30420a13c00eSTejun Heo  *
30430a13c00eSTejun Heo  * After waiting for a given time this puts a job in the kernel-global
30440a13c00eSTejun Heo  * workqueue.
30450a13c00eSTejun Heo  */
3046d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
30470a13c00eSTejun Heo {
30480a13c00eSTejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
30490a13c00eSTejun Heo }
30500a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work);
30510a13c00eSTejun Heo 
30520a13c00eSTejun Heo /**
305331ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3054b6136773SAndrew Morton  * @func: the function to call
3055b6136773SAndrew Morton  *
305631ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
305731ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3058b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
305931ddd871STejun Heo  *
306031ddd871STejun Heo  * RETURNS:
306131ddd871STejun Heo  * 0 on success, -errno on failure.
3062b6136773SAndrew Morton  */
306365f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
306415316ba8SChristoph Lameter {
306515316ba8SChristoph Lameter 	int cpu;
306638f51568SNamhyung Kim 	struct work_struct __percpu *works;
306715316ba8SChristoph Lameter 
3068b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3069b6136773SAndrew Morton 	if (!works)
307015316ba8SChristoph Lameter 		return -ENOMEM;
3071b6136773SAndrew Morton 
307295402b38SGautham R Shenoy 	get_online_cpus();
307393981800STejun Heo 
307415316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
30759bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
30769bfb1839SIngo Molnar 
30779bfb1839SIngo Molnar 		INIT_WORK(work, func);
30788de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
307915316ba8SChristoph Lameter 	}
308093981800STejun Heo 
308193981800STejun Heo 	for_each_online_cpu(cpu)
30828616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
308393981800STejun Heo 
308495402b38SGautham R Shenoy 	put_online_cpus();
3085b6136773SAndrew Morton 	free_percpu(works);
308615316ba8SChristoph Lameter 	return 0;
308715316ba8SChristoph Lameter }
308815316ba8SChristoph Lameter 
3089eef6a7d5SAlan Stern /**
3090eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3091eef6a7d5SAlan Stern  *
3092eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3093eef6a7d5SAlan Stern  * completion.
3094eef6a7d5SAlan Stern  *
3095eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3096eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3097eef6a7d5SAlan Stern  * will lead to deadlock:
3098eef6a7d5SAlan Stern  *
3099eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3100eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3101eef6a7d5SAlan Stern  *
3102eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3103eef6a7d5SAlan Stern  *
3104eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3105eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3106eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3107eef6a7d5SAlan Stern  *
3108eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3109eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3110eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3111eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3112eef6a7d5SAlan Stern  */
31131da177e4SLinus Torvalds void flush_scheduled_work(void)
31141da177e4SLinus Torvalds {
3115d320c038STejun Heo 	flush_workqueue(system_wq);
31161da177e4SLinus Torvalds }
3117ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
31181da177e4SLinus Torvalds 
31191da177e4SLinus Torvalds /**
31201fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
31211fa44ecaSJames Bottomley  * @fn:		the function to execute
31221fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
31231fa44ecaSJames Bottomley  *		be available when the work executes)
31241fa44ecaSJames Bottomley  *
31251fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
31261fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
31271fa44ecaSJames Bottomley  *
31281fa44ecaSJames Bottomley  * Returns:	0 - function was executed
31291fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31301fa44ecaSJames Bottomley  */
313165f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31321fa44ecaSJames Bottomley {
31331fa44ecaSJames Bottomley 	if (!in_interrupt()) {
313465f27f38SDavid Howells 		fn(&ew->work);
31351fa44ecaSJames Bottomley 		return 0;
31361fa44ecaSJames Bottomley 	}
31371fa44ecaSJames Bottomley 
313865f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31391fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31401fa44ecaSJames Bottomley 
31411fa44ecaSJames Bottomley 	return 1;
31421fa44ecaSJames Bottomley }
31431fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31441fa44ecaSJames Bottomley 
31451da177e4SLinus Torvalds int keventd_up(void)
31461da177e4SLinus Torvalds {
3147d320c038STejun Heo 	return system_wq != NULL;
31481da177e4SLinus Torvalds }
31491da177e4SLinus Torvalds 
3150bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
31511da177e4SLinus Torvalds {
31523af24433SOleg Nesterov 	/*
31530f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
31540f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
31550f900049STejun Heo 	 * unsigned long long.
31563af24433SOleg Nesterov 	 */
31570f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
31580f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
31590f900049STejun Heo 				   __alignof__(unsigned long long));
31603af24433SOleg Nesterov 
3161e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3162f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3163931ac77eSTejun Heo 	else {
31640f900049STejun Heo 		void *ptr;
3165e1d8aa9fSFrederic Weisbecker 
31660f900049STejun Heo 		/*
3167f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3168f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3169f3421797STejun Heo 		 * allocated pointer which will be used for free.
31700f900049STejun Heo 		 */
3171bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3172bdbc5dd7STejun Heo 		if (ptr) {
3173bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3174bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3175bdbc5dd7STejun Heo 		}
31763af24433SOleg Nesterov 	}
31773af24433SOleg Nesterov 
31780415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3179bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3180bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
31810f900049STejun Heo }
31820f900049STejun Heo 
3183bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
318406ba38a9SOleg Nesterov {
3185e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3186bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3187f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3188f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3189f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
319006ba38a9SOleg Nesterov 	}
319106ba38a9SOleg Nesterov }
319206ba38a9SOleg Nesterov 
3193f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3194f3421797STejun Heo 			       const char *name)
3195b71ab8c2STejun Heo {
3196f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3197f3421797STejun Heo 
3198f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3199044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3200f3421797STejun Heo 			max_active, name, 1, lim);
3201b71ab8c2STejun Heo 
3202f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3203b71ab8c2STejun Heo }
3204b71ab8c2STejun Heo 
3205b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
320697e37d7bSTejun Heo 					       unsigned int flags,
32071e19ffc6STejun Heo 					       int max_active,
3208eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3209b196be89STejun Heo 					       const char *lock_name, ...)
32103af24433SOleg Nesterov {
3211b196be89STejun Heo 	va_list args, args1;
32123af24433SOleg Nesterov 	struct workqueue_struct *wq;
3213c34056a3STejun Heo 	unsigned int cpu;
3214b196be89STejun Heo 	size_t namelen;
3215b196be89STejun Heo 
3216b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3217b196be89STejun Heo 	va_start(args, lock_name);
3218b196be89STejun Heo 	va_copy(args1, args);
3219b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3220b196be89STejun Heo 
3221b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3222b196be89STejun Heo 	if (!wq)
3223b196be89STejun Heo 		goto err;
3224b196be89STejun Heo 
3225b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3226b196be89STejun Heo 	va_end(args);
3227b196be89STejun Heo 	va_end(args1);
32283af24433SOleg Nesterov 
3229f3421797STejun Heo 	/*
32306370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
32316370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
32326370a6adSTejun Heo 	 */
32336370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
32346370a6adSTejun Heo 		flags |= WQ_RESCUER;
32356370a6adSTejun Heo 
3236d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3237b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
32383af24433SOleg Nesterov 
3239b196be89STejun Heo 	/* init wq */
324097e37d7bSTejun Heo 	wq->flags = flags;
3241a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
324273f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
324373f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
324473f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
324573f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
32463af24433SOleg Nesterov 
3247eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3248cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
32493af24433SOleg Nesterov 
3250bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3251bdbc5dd7STejun Heo 		goto err;
3252bdbc5dd7STejun Heo 
3253f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
32541537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
32558b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
32563270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
32571537663fSTejun Heo 
32580f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
32593270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3260c34056a3STejun Heo 		cwq->wq = wq;
326173f53c4aSTejun Heo 		cwq->flush_color = -1;
32621e19ffc6STejun Heo 		cwq->max_active = max_active;
32631e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3264e22bee78STejun Heo 	}
32651537663fSTejun Heo 
3266e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3267e22bee78STejun Heo 		struct worker *rescuer;
3268e22bee78STejun Heo 
3269f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3270e22bee78STejun Heo 			goto err;
3271e22bee78STejun Heo 
3272e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3273e22bee78STejun Heo 		if (!rescuer)
3274e22bee78STejun Heo 			goto err;
3275e22bee78STejun Heo 
3276b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3277b196be89STejun Heo 					       wq->name);
3278e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3279e22bee78STejun Heo 			goto err;
3280e22bee78STejun Heo 
3281e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3282e22bee78STejun Heo 		wake_up_process(rescuer->task);
32833af24433SOleg Nesterov 	}
32841537663fSTejun Heo 
32853af24433SOleg Nesterov 	/*
3286a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3287a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3288a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
32893af24433SOleg Nesterov 	 */
32903af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3291a0a1a5fdSTejun Heo 
329258a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3293f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3294a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3295a0a1a5fdSTejun Heo 
32963af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3297a0a1a5fdSTejun Heo 
32983af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
32993af24433SOleg Nesterov 
33003af24433SOleg Nesterov 	return wq;
33014690c4abSTejun Heo err:
33024690c4abSTejun Heo 	if (wq) {
3303bdbc5dd7STejun Heo 		free_cwqs(wq);
3304f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3305e22bee78STejun Heo 		kfree(wq->rescuer);
33064690c4abSTejun Heo 		kfree(wq);
33073af24433SOleg Nesterov 	}
33084690c4abSTejun Heo 	return NULL;
33091da177e4SLinus Torvalds }
3310d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
33111da177e4SLinus Torvalds 
33123af24433SOleg Nesterov /**
33133af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
33143af24433SOleg Nesterov  * @wq: target workqueue
33153af24433SOleg Nesterov  *
33163af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
33173af24433SOleg Nesterov  */
33183af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
33193af24433SOleg Nesterov {
3320c8e55f36STejun Heo 	unsigned int cpu;
33213af24433SOleg Nesterov 
33229c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
33239c5a2ba7STejun Heo 	drain_workqueue(wq);
3324c8efcc25STejun Heo 
3325a0a1a5fdSTejun Heo 	/*
3326a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3327a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3328a0a1a5fdSTejun Heo 	 */
332995402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
33303af24433SOleg Nesterov 	list_del(&wq->list);
333195402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
33323af24433SOleg Nesterov 
3333e22bee78STejun Heo 	/* sanity check */
3334f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
333573f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
333673f53c4aSTejun Heo 		int i;
33373af24433SOleg Nesterov 
333873f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
333973f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
33401e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
33411e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
334273f53c4aSTejun Heo 	}
33431537663fSTejun Heo 
3344e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3345e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3346f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
33478d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3348e22bee78STejun Heo 	}
3349e22bee78STejun Heo 
3350bdbc5dd7STejun Heo 	free_cwqs(wq);
33513af24433SOleg Nesterov 	kfree(wq);
33523af24433SOleg Nesterov }
33533af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
33543af24433SOleg Nesterov 
3355dcd989cbSTejun Heo /**
3356dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3357dcd989cbSTejun Heo  * @wq: target workqueue
3358dcd989cbSTejun Heo  * @max_active: new max_active value.
3359dcd989cbSTejun Heo  *
3360dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3361dcd989cbSTejun Heo  *
3362dcd989cbSTejun Heo  * CONTEXT:
3363dcd989cbSTejun Heo  * Don't call from IRQ context.
3364dcd989cbSTejun Heo  */
3365dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3366dcd989cbSTejun Heo {
3367dcd989cbSTejun Heo 	unsigned int cpu;
3368dcd989cbSTejun Heo 
3369f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3370dcd989cbSTejun Heo 
3371dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3372dcd989cbSTejun Heo 
3373dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3374dcd989cbSTejun Heo 
3375f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3376dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3377dcd989cbSTejun Heo 
3378dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3379dcd989cbSTejun Heo 
338058a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3381dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3382dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3383dcd989cbSTejun Heo 
3384dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3385dcd989cbSTejun Heo 	}
3386dcd989cbSTejun Heo 
3387dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3388dcd989cbSTejun Heo }
3389dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3390dcd989cbSTejun Heo 
3391dcd989cbSTejun Heo /**
3392dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3393dcd989cbSTejun Heo  * @cpu: CPU in question
3394dcd989cbSTejun Heo  * @wq: target workqueue
3395dcd989cbSTejun Heo  *
3396dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3397dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3398dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3399dcd989cbSTejun Heo  *
3400dcd989cbSTejun Heo  * RETURNS:
3401dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3402dcd989cbSTejun Heo  */
3403dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3404dcd989cbSTejun Heo {
3405dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3406dcd989cbSTejun Heo 
3407dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3408dcd989cbSTejun Heo }
3409dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3410dcd989cbSTejun Heo 
3411dcd989cbSTejun Heo /**
3412dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3413dcd989cbSTejun Heo  * @work: the work of interest
3414dcd989cbSTejun Heo  *
3415dcd989cbSTejun Heo  * RETURNS:
3416bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3417dcd989cbSTejun Heo  */
3418dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3419dcd989cbSTejun Heo {
3420dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3421dcd989cbSTejun Heo 
3422bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3423dcd989cbSTejun Heo }
3424dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3425dcd989cbSTejun Heo 
3426dcd989cbSTejun Heo /**
3427dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3428dcd989cbSTejun Heo  * @work: the work to be tested
3429dcd989cbSTejun Heo  *
3430dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3431dcd989cbSTejun Heo  * synchronization around this function and the test result is
3432dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3433dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3434dcd989cbSTejun Heo  * running state.
3435dcd989cbSTejun Heo  *
3436dcd989cbSTejun Heo  * RETURNS:
3437dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3438dcd989cbSTejun Heo  */
3439dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3440dcd989cbSTejun Heo {
3441dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3442dcd989cbSTejun Heo 	unsigned long flags;
3443dcd989cbSTejun Heo 	unsigned int ret = 0;
3444dcd989cbSTejun Heo 
3445dcd989cbSTejun Heo 	if (!gcwq)
3446dcd989cbSTejun Heo 		return false;
3447dcd989cbSTejun Heo 
3448dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3449dcd989cbSTejun Heo 
3450dcd989cbSTejun Heo 	if (work_pending(work))
3451dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3452dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3453dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3454dcd989cbSTejun Heo 
3455dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3456dcd989cbSTejun Heo 
3457dcd989cbSTejun Heo 	return ret;
3458dcd989cbSTejun Heo }
3459dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3460dcd989cbSTejun Heo 
3461db7bccf4STejun Heo /*
3462db7bccf4STejun Heo  * CPU hotplug.
3463db7bccf4STejun Heo  *
3464e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3465e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3466e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3467e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3468e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3469e22bee78STejun Heo  * blocked draining impractical.
3470e22bee78STejun Heo  *
3471628c78e7STejun Heo  * This is solved by allowing a gcwq to be disassociated from the CPU
3472628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
3473628c78e7STejun Heo  * cpu comes back online.
3474db7bccf4STejun Heo  */
3475db7bccf4STejun Heo 
347660373152STejun Heo /* claim manager positions of all pools */
3477b2eb83d1SLai Jiangshan static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
347860373152STejun Heo {
347960373152STejun Heo 	struct worker_pool *pool;
348060373152STejun Heo 
348160373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3482b2eb83d1SLai Jiangshan 		mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
34838db25e78STejun Heo 	spin_lock_irq(&gcwq->lock);
348460373152STejun Heo }
348560373152STejun Heo 
348660373152STejun Heo /* release manager positions */
3487b2eb83d1SLai Jiangshan static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
348860373152STejun Heo {
348960373152STejun Heo 	struct worker_pool *pool;
349060373152STejun Heo 
34918db25e78STejun Heo 	spin_unlock_irq(&gcwq->lock);
349260373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3493b2eb83d1SLai Jiangshan 		mutex_unlock(&pool->assoc_mutex);
349460373152STejun Heo }
349560373152STejun Heo 
3496628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work)
3497db7bccf4STejun Heo {
3498628c78e7STejun Heo 	struct global_cwq *gcwq = get_gcwq(smp_processor_id());
34994ce62e9eSTejun Heo 	struct worker_pool *pool;
3500db7bccf4STejun Heo 	struct worker *worker;
3501db7bccf4STejun Heo 	struct hlist_node *pos;
3502db7bccf4STejun Heo 	int i;
3503db7bccf4STejun Heo 
3504db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3505db7bccf4STejun Heo 
3506b2eb83d1SLai Jiangshan 	gcwq_claim_assoc_and_lock(gcwq);
3507e22bee78STejun Heo 
3508f2d5a0eeSTejun Heo 	/*
3509f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3510f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3511f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3512f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3513f2d5a0eeSTejun Heo 	 */
351460373152STejun Heo 	for_each_worker_pool(pool, gcwq)
35154ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3516403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3517db7bccf4STejun Heo 
3518db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3519403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3520db7bccf4STejun Heo 
3521f2d5a0eeSTejun Heo 	gcwq->flags |= GCWQ_DISASSOCIATED;
3522f2d5a0eeSTejun Heo 
3523b2eb83d1SLai Jiangshan 	gcwq_release_assoc_and_unlock(gcwq);
3524e22bee78STejun Heo 
3525e22bee78STejun Heo 	/*
3526628c78e7STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3527628c78e7STejun Heo 	 * sched callbacks see the %WORKER_UNBOUND flag.  This is necessary
3528628c78e7STejun Heo 	 * as scheduler callbacks may be invoked from other cpus.
3529628c78e7STejun Heo 	 */
3530628c78e7STejun Heo 	schedule();
3531628c78e7STejun Heo 
3532628c78e7STejun Heo 	/*
3533628c78e7STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After this,
3534628c78e7STejun Heo 	 * nr_running stays zero and need_more_worker() and keep_working()
3535628c78e7STejun Heo 	 * are always true as long as the worklist is not empty.  @gcwq now
3536628c78e7STejun Heo 	 * behaves as unbound (in terms of concurrency management) gcwq
3537628c78e7STejun Heo 	 * which is served by workers tied to the CPU.
3538628c78e7STejun Heo 	 *
3539628c78e7STejun Heo 	 * On return from this function, the current worker would trigger
3540628c78e7STejun Heo 	 * unbound chain execution of pending work items if other workers
3541628c78e7STejun Heo 	 * didn't already.
3542e22bee78STejun Heo 	 */
35434ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35444ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3545db7bccf4STejun Heo }
3546db7bccf4STejun Heo 
35478db25e78STejun Heo /*
35488db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
35498db25e78STejun Heo  * This will be registered high priority CPU notifier.
35508db25e78STejun Heo  */
35519fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
35521da177e4SLinus Torvalds 					       unsigned long action,
35531da177e4SLinus Torvalds 					       void *hcpu)
35541da177e4SLinus Torvalds {
35553af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3556db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
35574ce62e9eSTejun Heo 	struct worker_pool *pool;
35581da177e4SLinus Torvalds 
35598db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
35603af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35614ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35623ce63377STejun Heo 			struct worker *worker;
35633ce63377STejun Heo 
35643ce63377STejun Heo 			if (pool->nr_workers)
35653ce63377STejun Heo 				continue;
35663ce63377STejun Heo 
35673ce63377STejun Heo 			worker = create_worker(pool);
35683ce63377STejun Heo 			if (!worker)
35693ce63377STejun Heo 				return NOTIFY_BAD;
35703ce63377STejun Heo 
35713ce63377STejun Heo 			spin_lock_irq(&gcwq->lock);
35723ce63377STejun Heo 			start_worker(worker);
35733ce63377STejun Heo 			spin_unlock_irq(&gcwq->lock);
35743af24433SOleg Nesterov 		}
35751da177e4SLinus Torvalds 		break;
35761da177e4SLinus Torvalds 
357765758202STejun Heo 	case CPU_DOWN_FAILED:
357865758202STejun Heo 	case CPU_ONLINE:
3579b2eb83d1SLai Jiangshan 		gcwq_claim_assoc_and_lock(gcwq);
35808db25e78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
35818db25e78STejun Heo 		rebind_workers(gcwq);
3582b2eb83d1SLai Jiangshan 		gcwq_release_assoc_and_unlock(gcwq);
35838db25e78STejun Heo 		break;
358465758202STejun Heo 	}
358565758202STejun Heo 	return NOTIFY_OK;
358665758202STejun Heo }
358765758202STejun Heo 
358865758202STejun Heo /*
358965758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
359065758202STejun Heo  * This will be registered as low priority CPU notifier.
359165758202STejun Heo  */
35929fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
359365758202STejun Heo 						 unsigned long action,
359465758202STejun Heo 						 void *hcpu)
359565758202STejun Heo {
35968db25e78STejun Heo 	unsigned int cpu = (unsigned long)hcpu;
35978db25e78STejun Heo 	struct work_struct unbind_work;
35988db25e78STejun Heo 
359965758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
360065758202STejun Heo 	case CPU_DOWN_PREPARE:
36018db25e78STejun Heo 		/* unbinding should happen on the local CPU */
36028db25e78STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
36037635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
36048db25e78STejun Heo 		flush_work(&unbind_work);
36058db25e78STejun Heo 		break;
360665758202STejun Heo 	}
360765758202STejun Heo 	return NOTIFY_OK;
360865758202STejun Heo }
360965758202STejun Heo 
36102d3854a3SRusty Russell #ifdef CONFIG_SMP
36118ccad40dSRusty Russell 
36122d3854a3SRusty Russell struct work_for_cpu {
36136b44003eSAndrew Morton 	struct completion completion;
36142d3854a3SRusty Russell 	long (*fn)(void *);
36152d3854a3SRusty Russell 	void *arg;
36162d3854a3SRusty Russell 	long ret;
36172d3854a3SRusty Russell };
36182d3854a3SRusty Russell 
36196b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
36202d3854a3SRusty Russell {
36216b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
36222d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36236b44003eSAndrew Morton 	complete(&wfc->completion);
36246b44003eSAndrew Morton 	return 0;
36252d3854a3SRusty Russell }
36262d3854a3SRusty Russell 
36272d3854a3SRusty Russell /**
36282d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36292d3854a3SRusty Russell  * @cpu: the cpu to run on
36302d3854a3SRusty Russell  * @fn: the function to run
36312d3854a3SRusty Russell  * @arg: the function arg
36322d3854a3SRusty Russell  *
363331ad9081SRusty Russell  * This will return the value @fn returns.
363431ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36356b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36362d3854a3SRusty Russell  */
36372d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36382d3854a3SRusty Russell {
36396b44003eSAndrew Morton 	struct task_struct *sub_thread;
36406b44003eSAndrew Morton 	struct work_for_cpu wfc = {
36416b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
36426b44003eSAndrew Morton 		.fn = fn,
36436b44003eSAndrew Morton 		.arg = arg,
36446b44003eSAndrew Morton 	};
36452d3854a3SRusty Russell 
36466b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
36476b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
36486b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
36496b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
36506b44003eSAndrew Morton 	wake_up_process(sub_thread);
36516b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
36522d3854a3SRusty Russell 	return wfc.ret;
36532d3854a3SRusty Russell }
36542d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36552d3854a3SRusty Russell #endif /* CONFIG_SMP */
36562d3854a3SRusty Russell 
3657a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3658e7577c50SRusty Russell 
3659a0a1a5fdSTejun Heo /**
3660a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3661a0a1a5fdSTejun Heo  *
366258a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
366358a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
366458a69cb4STejun Heo  * gcwq->worklist.
3665a0a1a5fdSTejun Heo  *
3666a0a1a5fdSTejun Heo  * CONTEXT:
36678b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3668a0a1a5fdSTejun Heo  */
3669a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3670a0a1a5fdSTejun Heo {
3671a0a1a5fdSTejun Heo 	unsigned int cpu;
3672a0a1a5fdSTejun Heo 
3673a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3674a0a1a5fdSTejun Heo 
3675a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3676a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3677a0a1a5fdSTejun Heo 
3678f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
36798b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3680bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
36818b03ae3cSTejun Heo 
36828b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
36838b03ae3cSTejun Heo 
3684db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3685db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3686db7bccf4STejun Heo 
3687a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3688a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3689a0a1a5fdSTejun Heo 
369058a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3691a0a1a5fdSTejun Heo 				cwq->max_active = 0;
36921da177e4SLinus Torvalds 		}
36938b03ae3cSTejun Heo 
36948b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3695a0a1a5fdSTejun Heo 	}
3696a0a1a5fdSTejun Heo 
3697a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3698a0a1a5fdSTejun Heo }
3699a0a1a5fdSTejun Heo 
3700a0a1a5fdSTejun Heo /**
370158a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3702a0a1a5fdSTejun Heo  *
3703a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3704a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3705a0a1a5fdSTejun Heo  *
3706a0a1a5fdSTejun Heo  * CONTEXT:
3707a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3708a0a1a5fdSTejun Heo  *
3709a0a1a5fdSTejun Heo  * RETURNS:
371058a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
371158a69cb4STejun Heo  * is complete.
3712a0a1a5fdSTejun Heo  */
3713a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3714a0a1a5fdSTejun Heo {
3715a0a1a5fdSTejun Heo 	unsigned int cpu;
3716a0a1a5fdSTejun Heo 	bool busy = false;
3717a0a1a5fdSTejun Heo 
3718a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3719a0a1a5fdSTejun Heo 
3720a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3721a0a1a5fdSTejun Heo 
3722f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3723bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3724a0a1a5fdSTejun Heo 		/*
3725a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3726a0a1a5fdSTejun Heo 		 * to peek without lock.
3727a0a1a5fdSTejun Heo 		 */
3728a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3729a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3730a0a1a5fdSTejun Heo 
373158a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3732a0a1a5fdSTejun Heo 				continue;
3733a0a1a5fdSTejun Heo 
3734a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3735a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3736a0a1a5fdSTejun Heo 				busy = true;
3737a0a1a5fdSTejun Heo 				goto out_unlock;
3738a0a1a5fdSTejun Heo 			}
3739a0a1a5fdSTejun Heo 		}
3740a0a1a5fdSTejun Heo 	}
3741a0a1a5fdSTejun Heo out_unlock:
3742a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3743a0a1a5fdSTejun Heo 	return busy;
3744a0a1a5fdSTejun Heo }
3745a0a1a5fdSTejun Heo 
3746a0a1a5fdSTejun Heo /**
3747a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3748a0a1a5fdSTejun Heo  *
3749a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
37507e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3751a0a1a5fdSTejun Heo  *
3752a0a1a5fdSTejun Heo  * CONTEXT:
37538b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3754a0a1a5fdSTejun Heo  */
3755a0a1a5fdSTejun Heo void thaw_workqueues(void)
3756a0a1a5fdSTejun Heo {
3757a0a1a5fdSTejun Heo 	unsigned int cpu;
3758a0a1a5fdSTejun Heo 
3759a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3760a0a1a5fdSTejun Heo 
3761a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3762a0a1a5fdSTejun Heo 		goto out_unlock;
3763a0a1a5fdSTejun Heo 
3764f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37658b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
37664ce62e9eSTejun Heo 		struct worker_pool *pool;
3767bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37688b03ae3cSTejun Heo 
37698b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37708b03ae3cSTejun Heo 
3771db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3772db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3773db7bccf4STejun Heo 
3774a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3775a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3776a0a1a5fdSTejun Heo 
377758a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3778a0a1a5fdSTejun Heo 				continue;
3779a0a1a5fdSTejun Heo 
3780a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3781a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3782a0a1a5fdSTejun Heo 
3783a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3784a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3785a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3786a0a1a5fdSTejun Heo 		}
37878b03ae3cSTejun Heo 
37884ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
37894ce62e9eSTejun Heo 			wake_up_worker(pool);
3790e22bee78STejun Heo 
37918b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3792a0a1a5fdSTejun Heo 	}
3793a0a1a5fdSTejun Heo 
3794a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3795a0a1a5fdSTejun Heo out_unlock:
3796a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3797a0a1a5fdSTejun Heo }
3798a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3799a0a1a5fdSTejun Heo 
38006ee0578bSSuresh Siddha static int __init init_workqueues(void)
38011da177e4SLinus Torvalds {
3802c34056a3STejun Heo 	unsigned int cpu;
3803c8e55f36STejun Heo 	int i;
3804c34056a3STejun Heo 
3805b5490077STejun Heo 	/* make sure we have enough bits for OFFQ CPU number */
3806b5490077STejun Heo 	BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3807b5490077STejun Heo 		     WORK_CPU_LAST);
3808b5490077STejun Heo 
380965758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3810*a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
38118b03ae3cSTejun Heo 
38128b03ae3cSTejun Heo 	/* initialize gcwqs */
3813f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38148b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38154ce62e9eSTejun Heo 		struct worker_pool *pool;
38168b03ae3cSTejun Heo 
38178b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
38188b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3819f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
38208b03ae3cSTejun Heo 
3821c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3822c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3823c8e55f36STejun Heo 
38244ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38254ce62e9eSTejun Heo 			pool->gcwq = gcwq;
38264ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38274ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3828e22bee78STejun Heo 
38294ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38304ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38314ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3832e22bee78STejun Heo 
38334ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38344ce62e9eSTejun Heo 				    (unsigned long)pool);
38354ce62e9eSTejun Heo 
3836b2eb83d1SLai Jiangshan 			mutex_init(&pool->assoc_mutex);
38374ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38384ce62e9eSTejun Heo 		}
38398b03ae3cSTejun Heo 	}
38408b03ae3cSTejun Heo 
3841e22bee78STejun Heo 	/* create the initial worker */
3842f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3843e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38444ce62e9eSTejun Heo 		struct worker_pool *pool;
3845e22bee78STejun Heo 
3846477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3847477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
38484ce62e9eSTejun Heo 
38494ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38504ce62e9eSTejun Heo 			struct worker *worker;
38514ce62e9eSTejun Heo 
3852bc2ae0f5STejun Heo 			worker = create_worker(pool);
3853e22bee78STejun Heo 			BUG_ON(!worker);
3854e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3855e22bee78STejun Heo 			start_worker(worker);
3856e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3857e22bee78STejun Heo 		}
38584ce62e9eSTejun Heo 	}
3859e22bee78STejun Heo 
3860d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
38611aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
3862d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3863f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3864f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
386524d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
386624d51addSTejun Heo 					      WQ_FREEZABLE, 0);
38671aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
3868ae930e0fSTejun Heo 	       !system_unbound_wq || !system_freezable_wq);
38696ee0578bSSuresh Siddha 	return 0;
38701da177e4SLinus Torvalds }
38716ee0578bSSuresh Siddha early_initcall(init_workqueues);
3872