xref: /linux-6.15/kernel/workqueue.c (revision 023f27d3)
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>
4442f8570fSSasha Levin #include <linux/hashtable.h>
45e22bee78STejun Heo 
46e22bee78STejun Heo #include "workqueue_sched.h"
471da177e4SLinus Torvalds 
48c8e55f36STejun Heo enum {
49bc2ae0f5STejun Heo 	/*
50bc2ae0f5STejun Heo 	 * global_cwq flags
51bc2ae0f5STejun Heo 	 *
52bc2ae0f5STejun Heo 	 * A bound gcwq is either associated or disassociated with its CPU.
53bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
54bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
55bc2ae0f5STejun Heo 	 * is in effect.
56bc2ae0f5STejun Heo 	 *
57bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
58bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
59bc2ae0f5STejun Heo 	 * be executing on any CPU.  The gcwq behaves as an unbound one.
60bc2ae0f5STejun Heo 	 *
61bc2ae0f5STejun Heo 	 * Note that DISASSOCIATED can be flipped only while holding
62b2eb83d1SLai Jiangshan 	 * assoc_mutex of all pools on the gcwq to avoid changing binding
63bc2ae0f5STejun Heo 	 * state while create_worker() is in progress.
64bc2ae0f5STejun Heo 	 */
6511ebea50STejun Heo 	GCWQ_DISASSOCIATED	= 1 << 0,	/* cpu can't serve workers */
6611ebea50STejun Heo 	GCWQ_FREEZING		= 1 << 1,	/* freeze in progress */
6711ebea50STejun Heo 
6811ebea50STejun Heo 	/* pool flags */
6911ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
70552a37e9SLai Jiangshan 	POOL_MANAGING_WORKERS   = 1 << 1,       /* managing workers */
71db7bccf4STejun Heo 
72c8e55f36STejun Heo 	/* worker flags */
73c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
74c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
75c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
76e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
77fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
78f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
79e22bee78STejun Heo 
805f7dabfdSLai Jiangshan 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_UNBOUND |
81403c821dSTejun Heo 				  WORKER_CPU_INTENSIVE,
82db7bccf4STejun Heo 
833270476aSTejun Heo 	NR_WORKER_POOLS		= 2,		/* # worker pools per gcwq */
844ce62e9eSTejun Heo 
85c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
86db7bccf4STejun Heo 
87e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
88e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
89e22bee78STejun Heo 
903233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
913233cdbdSTejun Heo 						/* call for help after 10ms
923233cdbdSTejun Heo 						   (min two ticks) */
93e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
94e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
951da177e4SLinus Torvalds 
961da177e4SLinus Torvalds 	/*
97e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
98e22bee78STejun Heo 	 * all cpus.  Give -20.
99e22bee78STejun Heo 	 */
100e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
1013270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
102c8e55f36STejun Heo };
103c8e55f36STejun Heo 
1041da177e4SLinus Torvalds /*
1054690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1064690c4abSTejun Heo  *
107e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
108e41e704bSTejun Heo  *    everyone else.
1094690c4abSTejun Heo  *
110e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
111e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
112e22bee78STejun Heo  *
1138b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1144690c4abSTejun Heo  *
115e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
116e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
117e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
118f3421797STejun Heo  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
119e22bee78STejun Heo  *
12073f53c4aSTejun Heo  * F: wq->flush_mutex protected.
12173f53c4aSTejun Heo  *
1224690c4abSTejun Heo  * W: workqueue_lock protected.
1234690c4abSTejun Heo  */
1244690c4abSTejun Heo 
1258b03ae3cSTejun Heo struct global_cwq;
126bd7bdd43STejun Heo struct worker_pool;
127c34056a3STejun Heo 
128e22bee78STejun Heo /*
129e22bee78STejun Heo  * The poor guys doing the actual heavy lifting.  All on-duty workers
130e22bee78STejun Heo  * are either serving the manager role, on idle list or on busy hash.
131e22bee78STejun Heo  */
132c34056a3STejun Heo struct worker {
133c8e55f36STejun Heo 	/* on idle list while idle, on busy hash table while busy */
134c8e55f36STejun Heo 	union {
135c8e55f36STejun Heo 		struct list_head	entry;	/* L: while idle */
136c8e55f36STejun Heo 		struct hlist_node	hentry;	/* L: while busy */
137c8e55f36STejun Heo 	};
138c8e55f36STejun Heo 
139c34056a3STejun Heo 	struct work_struct	*current_work;	/* L: work being processed */
140a2c1c57bSTejun Heo 	work_func_t		current_func;	/* L: current_work's fn */
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 */
18342f8570fSSasha Levin 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
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)			\
28842f8570fSSasha Levin 	hash_for_each(gcwq->busy_hash, i, pos, worker, hentry)
289db7bccf4STejun Heo 
290f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
291f3421797STejun Heo 				  unsigned int sw)
292f3421797STejun Heo {
293f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
294f3421797STejun Heo 		if (sw & 1) {
295f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
296f3421797STejun Heo 			if (cpu < nr_cpu_ids)
297f3421797STejun Heo 				return cpu;
298f3421797STejun Heo 		}
299f3421797STejun Heo 		if (sw & 2)
300f3421797STejun Heo 			return WORK_CPU_UNBOUND;
301f3421797STejun Heo 	}
302f3421797STejun Heo 	return WORK_CPU_NONE;
303f3421797STejun Heo }
304f3421797STejun Heo 
305f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
306f3421797STejun Heo 				struct workqueue_struct *wq)
307f3421797STejun Heo {
308f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
309f3421797STejun Heo }
310f3421797STejun Heo 
31109884951STejun Heo /*
31209884951STejun Heo  * CPU iterators
31309884951STejun Heo  *
31409884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
31509884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
31609884951STejun Heo  * specific CPU.  The following iterators are similar to
31709884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
31809884951STejun Heo  *
31909884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
32009884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
32109884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
32209884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
32309884951STejun Heo  */
324f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
325f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
326f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
327f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
328f3421797STejun Heo 
329f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
330f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
331f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
332f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
333f3421797STejun Heo 
334f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
335f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
336f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
337f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
338f3421797STejun Heo 
339dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
340dc186ad7SThomas Gleixner 
341dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
342dc186ad7SThomas Gleixner 
34399777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
34499777288SStanislaw Gruszka {
34599777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
34699777288SStanislaw Gruszka }
34799777288SStanislaw Gruszka 
348dc186ad7SThomas Gleixner /*
349dc186ad7SThomas Gleixner  * fixup_init is called when:
350dc186ad7SThomas Gleixner  * - an active object is initialized
351dc186ad7SThomas Gleixner  */
352dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
353dc186ad7SThomas Gleixner {
354dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
355dc186ad7SThomas Gleixner 
356dc186ad7SThomas Gleixner 	switch (state) {
357dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
358dc186ad7SThomas Gleixner 		cancel_work_sync(work);
359dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
360dc186ad7SThomas Gleixner 		return 1;
361dc186ad7SThomas Gleixner 	default:
362dc186ad7SThomas Gleixner 		return 0;
363dc186ad7SThomas Gleixner 	}
364dc186ad7SThomas Gleixner }
365dc186ad7SThomas Gleixner 
366dc186ad7SThomas Gleixner /*
367dc186ad7SThomas Gleixner  * fixup_activate is called when:
368dc186ad7SThomas Gleixner  * - an active object is activated
369dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
370dc186ad7SThomas Gleixner  */
371dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
372dc186ad7SThomas Gleixner {
373dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
374dc186ad7SThomas Gleixner 
375dc186ad7SThomas Gleixner 	switch (state) {
376dc186ad7SThomas Gleixner 
377dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
378dc186ad7SThomas Gleixner 		/*
379dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
380dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
381dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
382dc186ad7SThomas Gleixner 		 */
38322df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
384dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
385dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
386dc186ad7SThomas Gleixner 			return 0;
387dc186ad7SThomas Gleixner 		}
388dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
389dc186ad7SThomas Gleixner 		return 0;
390dc186ad7SThomas Gleixner 
391dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
392dc186ad7SThomas Gleixner 		WARN_ON(1);
393dc186ad7SThomas Gleixner 
394dc186ad7SThomas Gleixner 	default:
395dc186ad7SThomas Gleixner 		return 0;
396dc186ad7SThomas Gleixner 	}
397dc186ad7SThomas Gleixner }
398dc186ad7SThomas Gleixner 
399dc186ad7SThomas Gleixner /*
400dc186ad7SThomas Gleixner  * fixup_free is called when:
401dc186ad7SThomas Gleixner  * - an active object is freed
402dc186ad7SThomas Gleixner  */
403dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
404dc186ad7SThomas Gleixner {
405dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
406dc186ad7SThomas Gleixner 
407dc186ad7SThomas Gleixner 	switch (state) {
408dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
409dc186ad7SThomas Gleixner 		cancel_work_sync(work);
410dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
411dc186ad7SThomas Gleixner 		return 1;
412dc186ad7SThomas Gleixner 	default:
413dc186ad7SThomas Gleixner 		return 0;
414dc186ad7SThomas Gleixner 	}
415dc186ad7SThomas Gleixner }
416dc186ad7SThomas Gleixner 
417dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
418dc186ad7SThomas Gleixner 	.name		= "work_struct",
41999777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
420dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
421dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
422dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
423dc186ad7SThomas Gleixner };
424dc186ad7SThomas Gleixner 
425dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
426dc186ad7SThomas Gleixner {
427dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
428dc186ad7SThomas Gleixner }
429dc186ad7SThomas Gleixner 
430dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
431dc186ad7SThomas Gleixner {
432dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
433dc186ad7SThomas Gleixner }
434dc186ad7SThomas Gleixner 
435dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
436dc186ad7SThomas Gleixner {
437dc186ad7SThomas Gleixner 	if (onstack)
438dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
439dc186ad7SThomas Gleixner 	else
440dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
441dc186ad7SThomas Gleixner }
442dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
443dc186ad7SThomas Gleixner 
444dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
445dc186ad7SThomas Gleixner {
446dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
447dc186ad7SThomas Gleixner }
448dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
449dc186ad7SThomas Gleixner 
450dc186ad7SThomas Gleixner #else
451dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
452dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
453dc186ad7SThomas Gleixner #endif
454dc186ad7SThomas Gleixner 
45595402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
45695402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4571da177e4SLinus Torvalds static LIST_HEAD(workqueues);
458a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4591da177e4SLinus Torvalds 
46014441960SOleg Nesterov /*
461e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
462e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
463e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
46414441960SOleg Nesterov  */
4658b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
4664ce62e9eSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
467f756d5e2SNathan Lynch 
468f3421797STejun Heo /*
469f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
470f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
471f3421797STejun Heo  * workers have WORKER_UNBOUND set.
472f3421797STejun Heo  */
473f3421797STejun Heo static struct global_cwq unbound_global_cwq;
4744ce62e9eSTejun Heo static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
4754ce62e9eSTejun Heo 	[0 ... NR_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4764ce62e9eSTejun Heo };
477f3421797STejun Heo 
478c34056a3STejun Heo static int worker_thread(void *__worker);
4791da177e4SLinus Torvalds 
4803270476aSTejun Heo static int worker_pool_pri(struct worker_pool *pool)
4813270476aSTejun Heo {
4823270476aSTejun Heo 	return pool - pool->gcwq->pools;
4833270476aSTejun Heo }
4843270476aSTejun Heo 
4858b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4861da177e4SLinus Torvalds {
487f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4888b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
489f3421797STejun Heo 	else
490f3421797STejun Heo 		return &unbound_global_cwq;
4911da177e4SLinus Torvalds }
4921da177e4SLinus Torvalds 
49363d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
494b1f4ec17SOleg Nesterov {
49563d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
4963270476aSTejun Heo 	int idx = worker_pool_pri(pool);
49763d95a91STejun Heo 
498f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4994ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
500f3421797STejun Heo 	else
5014ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
502b1f4ec17SOleg Nesterov }
503b1f4ec17SOleg Nesterov 
5044690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
5054690c4abSTejun Heo 					    struct workqueue_struct *wq)
506a848e3b6SOleg Nesterov {
507f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
508e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
509bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
510f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
511f3421797STejun Heo 		return wq->cpu_wq.single;
512f3421797STejun Heo 	return NULL;
513f3421797STejun Heo }
514a848e3b6SOleg Nesterov 
51573f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
51673f53c4aSTejun Heo {
51773f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
51873f53c4aSTejun Heo }
51973f53c4aSTejun Heo 
52073f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
52173f53c4aSTejun Heo {
52273f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
52373f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
52473f53c4aSTejun Heo }
52573f53c4aSTejun Heo 
52673f53c4aSTejun Heo static int work_next_color(int color)
52773f53c4aSTejun Heo {
52873f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5291da177e4SLinus Torvalds }
5301da177e4SLinus Torvalds 
5314594bf15SDavid Howells /*
532b5490077STejun Heo  * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
533b5490077STejun Heo  * contain the pointer to the queued cwq.  Once execution starts, the flag
534b5490077STejun Heo  * is cleared and the high bits contain OFFQ flags and CPU number.
5357a22ad75STejun Heo  *
536bbb68dfaSTejun Heo  * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
537bbb68dfaSTejun Heo  * and clear_work_data() can be used to set the cwq, cpu or clear
538bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
539bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5407a22ad75STejun Heo  *
541bbb68dfaSTejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
542bbb68dfaSTejun Heo  * a work.  gcwq is available once the work has been queued anywhere after
543bbb68dfaSTejun Heo  * initialization until it is sync canceled.  cwq is available only while
544bbb68dfaSTejun Heo  * the work item is queued.
545bbb68dfaSTejun Heo  *
546bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
547bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
548bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
549bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5504594bf15SDavid Howells  */
5517a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5527a22ad75STejun Heo 				 unsigned long flags)
5537a22ad75STejun Heo {
5547a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5557a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5567a22ad75STejun Heo }
5577a22ad75STejun Heo 
5587a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5594690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5604690c4abSTejun Heo 			 unsigned long extra_flags)
561365970a1SDavid Howells {
5627a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
563e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
564365970a1SDavid Howells }
565365970a1SDavid Howells 
5668930cabaSTejun Heo static void set_work_cpu_and_clear_pending(struct work_struct *work,
5678930cabaSTejun Heo 					   unsigned int cpu)
5684d707b9fSOleg Nesterov {
56923657bb1STejun Heo 	/*
57023657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
57123657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
57223657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
57323657bb1STejun Heo 	 * owner.
57423657bb1STejun Heo 	 */
57523657bb1STejun Heo 	smp_wmb();
576b5490077STejun Heo 	set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
5774d707b9fSOleg Nesterov }
5784d707b9fSOleg Nesterov 
5797a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
580365970a1SDavid Howells {
58123657bb1STejun Heo 	smp_wmb();	/* see set_work_cpu_and_clear_pending() */
5827a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5837a22ad75STejun Heo }
5847a22ad75STejun Heo 
5857a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5867a22ad75STejun Heo {
587e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5887a22ad75STejun Heo 
589e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
590e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
591e120153dSTejun Heo 	else
592e120153dSTejun Heo 		return NULL;
5937a22ad75STejun Heo }
5947a22ad75STejun Heo 
5957a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5967a22ad75STejun Heo {
597e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5987a22ad75STejun Heo 	unsigned int cpu;
5997a22ad75STejun Heo 
600e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
601e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
602bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
6037a22ad75STejun Heo 
604b5490077STejun Heo 	cpu = data >> WORK_OFFQ_CPU_SHIFT;
605bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
6067a22ad75STejun Heo 		return NULL;
6077a22ad75STejun Heo 
608f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
6097a22ad75STejun Heo 	return get_gcwq(cpu);
610365970a1SDavid Howells }
611365970a1SDavid Howells 
612bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
613bbb68dfaSTejun Heo {
614bbb68dfaSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
615bbb68dfaSTejun Heo 	unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
616bbb68dfaSTejun Heo 
617bbb68dfaSTejun Heo 	set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
618bbb68dfaSTejun Heo 		      WORK_STRUCT_PENDING);
619bbb68dfaSTejun Heo }
620bbb68dfaSTejun Heo 
621bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
622bbb68dfaSTejun Heo {
623bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
624bbb68dfaSTejun Heo 
625bbb68dfaSTejun Heo 	return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
626bbb68dfaSTejun Heo }
627bbb68dfaSTejun Heo 
628e22bee78STejun Heo /*
6293270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
6303270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
6313270476aSTejun Heo  * they're being called with gcwq->lock held.
632e22bee78STejun Heo  */
633e22bee78STejun Heo 
63463d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
635649027d7STejun Heo {
6363270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
637649027d7STejun Heo }
638649027d7STejun Heo 
639e22bee78STejun Heo /*
640e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
641e22bee78STejun Heo  * running workers.
642974271c4STejun Heo  *
643974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
644974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
645974271c4STejun Heo  * worklist isn't empty.
646e22bee78STejun Heo  */
64763d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
648e22bee78STejun Heo {
64963d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
650e22bee78STejun Heo }
651e22bee78STejun Heo 
652e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
65363d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
654e22bee78STejun Heo {
65563d95a91STejun Heo 	return pool->nr_idle;
656e22bee78STejun Heo }
657e22bee78STejun Heo 
658e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
65963d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
660e22bee78STejun Heo {
66163d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
662e22bee78STejun Heo 
6633270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
664e22bee78STejun Heo }
665e22bee78STejun Heo 
666e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
66763d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
668e22bee78STejun Heo {
66963d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
670e22bee78STejun Heo }
671e22bee78STejun Heo 
672e22bee78STejun Heo /* Do I need to be the manager? */
67363d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
674e22bee78STejun Heo {
67563d95a91STejun Heo 	return need_to_create_worker(pool) ||
67611ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
677e22bee78STejun Heo }
678e22bee78STejun Heo 
679e22bee78STejun Heo /* Do we have too many workers and should some go away? */
68063d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
681e22bee78STejun Heo {
682552a37e9SLai Jiangshan 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
68363d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
68463d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
685e22bee78STejun Heo 
686ea1abd61SLai Jiangshan 	/*
687ea1abd61SLai Jiangshan 	 * nr_idle and idle_list may disagree if idle rebinding is in
688ea1abd61SLai Jiangshan 	 * progress.  Never return %true if idle_list is empty.
689ea1abd61SLai Jiangshan 	 */
690ea1abd61SLai Jiangshan 	if (list_empty(&pool->idle_list))
691ea1abd61SLai Jiangshan 		return false;
692ea1abd61SLai Jiangshan 
693e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
694e22bee78STejun Heo }
695e22bee78STejun Heo 
696e22bee78STejun Heo /*
697e22bee78STejun Heo  * Wake up functions.
698e22bee78STejun Heo  */
699e22bee78STejun Heo 
7007e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
70163d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
7027e11629dSTejun Heo {
70363d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
7047e11629dSTejun Heo 		return NULL;
7057e11629dSTejun Heo 
70663d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
7077e11629dSTejun Heo }
7087e11629dSTejun Heo 
7097e11629dSTejun Heo /**
7107e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
71163d95a91STejun Heo  * @pool: worker pool to wake worker from
7127e11629dSTejun Heo  *
71363d95a91STejun Heo  * Wake up the first idle worker of @pool.
7147e11629dSTejun Heo  *
7157e11629dSTejun Heo  * CONTEXT:
7167e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
7177e11629dSTejun Heo  */
71863d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
7197e11629dSTejun Heo {
72063d95a91STejun Heo 	struct worker *worker = first_worker(pool);
7217e11629dSTejun Heo 
7227e11629dSTejun Heo 	if (likely(worker))
7237e11629dSTejun Heo 		wake_up_process(worker->task);
7247e11629dSTejun Heo }
7257e11629dSTejun Heo 
7264690c4abSTejun Heo /**
727e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
728e22bee78STejun Heo  * @task: task waking up
729e22bee78STejun Heo  * @cpu: CPU @task is waking up to
730e22bee78STejun Heo  *
731e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
732e22bee78STejun Heo  * being awoken.
733e22bee78STejun Heo  *
734e22bee78STejun Heo  * CONTEXT:
735e22bee78STejun Heo  * spin_lock_irq(rq->lock)
736e22bee78STejun Heo  */
737e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
738e22bee78STejun Heo {
739e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
740e22bee78STejun Heo 
74136576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
74236576000SJoonsoo Kim 		WARN_ON_ONCE(worker->pool->gcwq->cpu != cpu);
74363d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
744e22bee78STejun Heo 	}
74536576000SJoonsoo Kim }
746e22bee78STejun Heo 
747e22bee78STejun Heo /**
748e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
749e22bee78STejun Heo  * @task: task going to sleep
750e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
751e22bee78STejun Heo  *
752e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
753e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
754e22bee78STejun Heo  * returning pointer to its task.
755e22bee78STejun Heo  *
756e22bee78STejun Heo  * CONTEXT:
757e22bee78STejun Heo  * spin_lock_irq(rq->lock)
758e22bee78STejun Heo  *
759e22bee78STejun Heo  * RETURNS:
760e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
761e22bee78STejun Heo  */
762e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
763e22bee78STejun Heo 				       unsigned int cpu)
764e22bee78STejun Heo {
765e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
766bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
76763d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
768e22bee78STejun Heo 
7692d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
770e22bee78STejun Heo 		return NULL;
771e22bee78STejun Heo 
772e22bee78STejun Heo 	/* this can only happen on the local cpu */
773e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
774e22bee78STejun Heo 
775e22bee78STejun Heo 	/*
776e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
777e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
778e22bee78STejun Heo 	 * Please read comment there.
779e22bee78STejun Heo 	 *
780628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
781628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
782628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
783628c78e7STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without gcwq
784628c78e7STejun Heo 	 * lock is safe.
785e22bee78STejun Heo 	 */
786bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
78763d95a91STejun Heo 		to_wakeup = first_worker(pool);
788e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
789e22bee78STejun Heo }
790e22bee78STejun Heo 
791e22bee78STejun Heo /**
792e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
793cb444766STejun Heo  * @worker: self
794d302f017STejun Heo  * @flags: flags to set
795d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
796d302f017STejun Heo  *
797e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
798e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
799e22bee78STejun Heo  * woken up.
800d302f017STejun Heo  *
801cb444766STejun Heo  * CONTEXT:
802cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
803d302f017STejun Heo  */
804d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
805d302f017STejun Heo 				    bool wakeup)
806d302f017STejun Heo {
807bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
808e22bee78STejun Heo 
809cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
810cb444766STejun Heo 
811e22bee78STejun Heo 	/*
812e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
813e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
814e22bee78STejun Heo 	 * @wakeup.
815e22bee78STejun Heo 	 */
816e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
817e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
81863d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
819e22bee78STejun Heo 
820e22bee78STejun Heo 		if (wakeup) {
821e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
822bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
82363d95a91STejun Heo 				wake_up_worker(pool);
824e22bee78STejun Heo 		} else
825e22bee78STejun Heo 			atomic_dec(nr_running);
826e22bee78STejun Heo 	}
827e22bee78STejun Heo 
828d302f017STejun Heo 	worker->flags |= flags;
829d302f017STejun Heo }
830d302f017STejun Heo 
831d302f017STejun Heo /**
832e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
833cb444766STejun Heo  * @worker: self
834d302f017STejun Heo  * @flags: flags to clear
835d302f017STejun Heo  *
836e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
837d302f017STejun Heo  *
838cb444766STejun Heo  * CONTEXT:
839cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
840d302f017STejun Heo  */
841d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
842d302f017STejun Heo {
84363d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
844e22bee78STejun Heo 	unsigned int oflags = worker->flags;
845e22bee78STejun Heo 
846cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
847cb444766STejun Heo 
848d302f017STejun Heo 	worker->flags &= ~flags;
849e22bee78STejun Heo 
85042c025f3STejun Heo 	/*
85142c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
85242c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
85342c025f3STejun Heo 	 * of multiple flags, not a single flag.
85442c025f3STejun Heo 	 */
855e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
856e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
85763d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
858d302f017STejun Heo }
859d302f017STejun Heo 
860d302f017STejun Heo /**
8618cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8628cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8638cca0eeaSTejun Heo  * @work: work to find worker for
8648cca0eeaSTejun Heo  *
865a2c1c57bSTejun Heo  * Find a worker which is executing @work on @gcwq by searching
866a2c1c57bSTejun Heo  * @gcwq->busy_hash which is keyed by the address of @work.  For a worker
867a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
868a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
869a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
870a2c1c57bSTejun Heo  * being executed.
871a2c1c57bSTejun Heo  *
872a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
873a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
874a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
875a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
876a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
877a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
878a2c1c57bSTejun Heo  *
879a2c1c57bSTejun Heo  * This function checks the work item address, work function and workqueue
880a2c1c57bSTejun Heo  * to avoid false positives.  Note that this isn't complete as one may
881a2c1c57bSTejun Heo  * construct a work function which can introduce dependency onto itself
882a2c1c57bSTejun Heo  * through a recycled work item.  Well, if somebody wants to shoot oneself
883a2c1c57bSTejun Heo  * in the foot that badly, there's only so much we can do, and if such
884a2c1c57bSTejun Heo  * deadlock actually occurs, it should be easy to locate the culprit work
885a2c1c57bSTejun Heo  * function.
8868cca0eeaSTejun Heo  *
8878cca0eeaSTejun Heo  * CONTEXT:
8888cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8898cca0eeaSTejun Heo  *
8908cca0eeaSTejun Heo  * RETURNS:
8918cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8928cca0eeaSTejun Heo  * otherwise.
8938cca0eeaSTejun Heo  */
8948cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8958cca0eeaSTejun Heo 						 struct work_struct *work)
8968cca0eeaSTejun Heo {
89742f8570fSSasha Levin 	struct worker *worker;
89842f8570fSSasha Levin 	struct hlist_node *tmp;
89942f8570fSSasha Levin 
900a2c1c57bSTejun Heo 	hash_for_each_possible(gcwq->busy_hash, worker, tmp, hentry,
901a2c1c57bSTejun Heo 			       (unsigned long)work)
902a2c1c57bSTejun Heo 		if (worker->current_work == work &&
903a2c1c57bSTejun Heo 		    worker->current_func == work->func)
90442f8570fSSasha Levin 			return worker;
90542f8570fSSasha Levin 
90642f8570fSSasha Levin 	return NULL;
9078cca0eeaSTejun Heo }
9088cca0eeaSTejun Heo 
9098cca0eeaSTejun Heo /**
910bf4ede01STejun Heo  * move_linked_works - move linked works to a list
911bf4ede01STejun Heo  * @work: start of series of works to be scheduled
912bf4ede01STejun Heo  * @head: target list to append @work to
913bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
914bf4ede01STejun Heo  *
915bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
916bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
917bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
918bf4ede01STejun Heo  *
919bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
920bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
921bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
922bf4ede01STejun Heo  *
923bf4ede01STejun Heo  * CONTEXT:
924bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
925bf4ede01STejun Heo  */
926bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
927bf4ede01STejun Heo 			      struct work_struct **nextp)
928bf4ede01STejun Heo {
929bf4ede01STejun Heo 	struct work_struct *n;
930bf4ede01STejun Heo 
931bf4ede01STejun Heo 	/*
932bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
933bf4ede01STejun Heo 	 * use NULL for list head.
934bf4ede01STejun Heo 	 */
935bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
936bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
937bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
938bf4ede01STejun Heo 			break;
939bf4ede01STejun Heo 	}
940bf4ede01STejun Heo 
941bf4ede01STejun Heo 	/*
942bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
943bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
944bf4ede01STejun Heo 	 * needs to be updated.
945bf4ede01STejun Heo 	 */
946bf4ede01STejun Heo 	if (nextp)
947bf4ede01STejun Heo 		*nextp = n;
948bf4ede01STejun Heo }
949bf4ede01STejun Heo 
9503aa62497SLai Jiangshan static void cwq_activate_delayed_work(struct work_struct *work)
951bf4ede01STejun Heo {
9523aa62497SLai Jiangshan 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
953bf4ede01STejun Heo 
954bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
955bf4ede01STejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
956bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
957bf4ede01STejun Heo 	cwq->nr_active++;
958bf4ede01STejun Heo }
959bf4ede01STejun Heo 
9603aa62497SLai Jiangshan static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
9613aa62497SLai Jiangshan {
9623aa62497SLai Jiangshan 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
9633aa62497SLai Jiangshan 						    struct work_struct, entry);
9643aa62497SLai Jiangshan 
9653aa62497SLai Jiangshan 	cwq_activate_delayed_work(work);
9663aa62497SLai Jiangshan }
9673aa62497SLai Jiangshan 
968bf4ede01STejun Heo /**
969bf4ede01STejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
970bf4ede01STejun Heo  * @cwq: cwq of interest
971bf4ede01STejun Heo  * @color: color of work which left the queue
972bf4ede01STejun Heo  *
973bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
974bf4ede01STejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
975bf4ede01STejun Heo  *
976bf4ede01STejun Heo  * CONTEXT:
977bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
978bf4ede01STejun Heo  */
979b3f9f405SLai Jiangshan static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
980bf4ede01STejun Heo {
981bf4ede01STejun Heo 	/* ignore uncolored works */
982bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
983bf4ede01STejun Heo 		return;
984bf4ede01STejun Heo 
985bf4ede01STejun Heo 	cwq->nr_in_flight[color]--;
986bf4ede01STejun Heo 
987bf4ede01STejun Heo 	cwq->nr_active--;
988bf4ede01STejun Heo 	if (!list_empty(&cwq->delayed_works)) {
989bf4ede01STejun Heo 		/* one down, submit a delayed one */
990bf4ede01STejun Heo 		if (cwq->nr_active < cwq->max_active)
991bf4ede01STejun Heo 			cwq_activate_first_delayed(cwq);
992bf4ede01STejun Heo 	}
993bf4ede01STejun Heo 
994bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
995bf4ede01STejun Heo 	if (likely(cwq->flush_color != color))
996bf4ede01STejun Heo 		return;
997bf4ede01STejun Heo 
998bf4ede01STejun Heo 	/* are there still in-flight works? */
999bf4ede01STejun Heo 	if (cwq->nr_in_flight[color])
1000bf4ede01STejun Heo 		return;
1001bf4ede01STejun Heo 
1002bf4ede01STejun Heo 	/* this cwq is done, clear flush_color */
1003bf4ede01STejun Heo 	cwq->flush_color = -1;
1004bf4ede01STejun Heo 
1005bf4ede01STejun Heo 	/*
1006bf4ede01STejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
1007bf4ede01STejun Heo 	 * will handle the rest.
1008bf4ede01STejun Heo 	 */
1009bf4ede01STejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1010bf4ede01STejun Heo 		complete(&cwq->wq->first_flusher->done);
1011bf4ede01STejun Heo }
1012bf4ede01STejun Heo 
101336e227d2STejun Heo /**
1014bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
101536e227d2STejun Heo  * @work: work item to steal
101636e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1017bbb68dfaSTejun Heo  * @flags: place to store irq state
101836e227d2STejun Heo  *
101936e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
102036e227d2STejun Heo  * stable state - idle, on timer or on worklist.  Return values are
102136e227d2STejun Heo  *
102236e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
102336e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
102436e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1025bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1026bbb68dfaSTejun Heo  *		for arbitrarily long
102736e227d2STejun Heo  *
1028bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1029e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1030e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1031e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1032bbb68dfaSTejun Heo  *
1033bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1034bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1035bbb68dfaSTejun Heo  *
1036e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1037bf4ede01STejun Heo  */
1038bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1039bbb68dfaSTejun Heo 			       unsigned long *flags)
1040bf4ede01STejun Heo {
1041bf4ede01STejun Heo 	struct global_cwq *gcwq;
1042bf4ede01STejun Heo 
1043bbb68dfaSTejun Heo 	local_irq_save(*flags);
1044bbb68dfaSTejun Heo 
104536e227d2STejun Heo 	/* try to steal the timer if it exists */
104636e227d2STejun Heo 	if (is_dwork) {
104736e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
104836e227d2STejun Heo 
1049e0aecdd8STejun Heo 		/*
1050e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1051e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1052e0aecdd8STejun Heo 		 * running on the local CPU.
1053e0aecdd8STejun Heo 		 */
105436e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
105536e227d2STejun Heo 			return 1;
105636e227d2STejun Heo 	}
105736e227d2STejun Heo 
105836e227d2STejun Heo 	/* try to claim PENDING the normal way */
1059bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1060bf4ede01STejun Heo 		return 0;
1061bf4ede01STejun Heo 
1062bf4ede01STejun Heo 	/*
1063bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1064bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1065bf4ede01STejun Heo 	 */
1066bf4ede01STejun Heo 	gcwq = get_work_gcwq(work);
1067bf4ede01STejun Heo 	if (!gcwq)
1068bbb68dfaSTejun Heo 		goto fail;
1069bf4ede01STejun Heo 
1070bbb68dfaSTejun Heo 	spin_lock(&gcwq->lock);
1071bf4ede01STejun Heo 	if (!list_empty(&work->entry)) {
1072bf4ede01STejun Heo 		/*
1073bf4ede01STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
1074bf4ede01STejun Heo 		 * In that case we must see the new value after rmb(), see
1075bf4ede01STejun Heo 		 * insert_work()->wmb().
1076bf4ede01STejun Heo 		 */
1077bf4ede01STejun Heo 		smp_rmb();
1078bf4ede01STejun Heo 		if (gcwq == get_work_gcwq(work)) {
1079bf4ede01STejun Heo 			debug_work_deactivate(work);
10803aa62497SLai Jiangshan 
10813aa62497SLai Jiangshan 			/*
10823aa62497SLai Jiangshan 			 * A delayed work item cannot be grabbed directly
10833aa62497SLai Jiangshan 			 * because it might have linked NO_COLOR work items
10843aa62497SLai Jiangshan 			 * which, if left on the delayed_list, will confuse
10853aa62497SLai Jiangshan 			 * cwq->nr_active management later on and cause
10863aa62497SLai Jiangshan 			 * stall.  Make sure the work item is activated
10873aa62497SLai Jiangshan 			 * before grabbing.
10883aa62497SLai Jiangshan 			 */
10893aa62497SLai Jiangshan 			if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
10903aa62497SLai Jiangshan 				cwq_activate_delayed_work(work);
10913aa62497SLai Jiangshan 
1092bf4ede01STejun Heo 			list_del_init(&work->entry);
1093bf4ede01STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
1094b3f9f405SLai Jiangshan 				get_work_color(work));
109536e227d2STejun Heo 
1096bbb68dfaSTejun Heo 			spin_unlock(&gcwq->lock);
109736e227d2STejun Heo 			return 1;
1098bf4ede01STejun Heo 		}
1099bf4ede01STejun Heo 	}
1100bbb68dfaSTejun Heo 	spin_unlock(&gcwq->lock);
1101bbb68dfaSTejun Heo fail:
1102bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1103bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1104bbb68dfaSTejun Heo 		return -ENOENT;
1105bbb68dfaSTejun Heo 	cpu_relax();
110636e227d2STejun Heo 	return -EAGAIN;
1107bf4ede01STejun Heo }
1108bf4ede01STejun Heo 
1109bf4ede01STejun Heo /**
11107e11629dSTejun Heo  * insert_work - insert a work into gcwq
11114690c4abSTejun Heo  * @cwq: cwq @work belongs to
11124690c4abSTejun Heo  * @work: work to insert
11134690c4abSTejun Heo  * @head: insertion point
11144690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
11154690c4abSTejun Heo  *
11167e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
11177e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
11184690c4abSTejun Heo  *
11194690c4abSTejun Heo  * CONTEXT:
11208b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
11211da177e4SLinus Torvalds  */
1122b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
11234690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
11244690c4abSTejun Heo 			unsigned int extra_flags)
1125b89deed3SOleg Nesterov {
112663d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
1127e1d8aa9fSFrederic Weisbecker 
11284690c4abSTejun Heo 	/* we own @work, set data and link */
11297a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
11304690c4abSTejun Heo 
11316e84d644SOleg Nesterov 	/*
11326e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
11336e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
11346e84d644SOleg Nesterov 	 */
11356e84d644SOleg Nesterov 	smp_wmb();
11364690c4abSTejun Heo 
11371a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
1138e22bee78STejun Heo 
1139e22bee78STejun Heo 	/*
1140e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
1141e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
1142e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
1143e22bee78STejun Heo 	 */
1144e22bee78STejun Heo 	smp_mb();
1145e22bee78STejun Heo 
114663d95a91STejun Heo 	if (__need_more_worker(pool))
114763d95a91STejun Heo 		wake_up_worker(pool);
1148b89deed3SOleg Nesterov }
1149b89deed3SOleg Nesterov 
1150c8efcc25STejun Heo /*
1151c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
1152c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
1153c8efcc25STejun Heo  * cold paths.
1154c8efcc25STejun Heo  */
1155c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1156c8efcc25STejun Heo {
1157c8efcc25STejun Heo 	unsigned long flags;
1158c8efcc25STejun Heo 	unsigned int cpu;
1159c8efcc25STejun Heo 
1160c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
1161c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
1162c8efcc25STejun Heo 		struct worker *worker;
1163c8efcc25STejun Heo 		struct hlist_node *pos;
1164c8efcc25STejun Heo 		int i;
1165c8efcc25STejun Heo 
1166c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1167c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
1168c8efcc25STejun Heo 			if (worker->task != current)
1169c8efcc25STejun Heo 				continue;
1170c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
1171c8efcc25STejun Heo 			/*
1172c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
1173c8efcc25STejun Heo 			 * is headed to the same workqueue.
1174c8efcc25STejun Heo 			 */
1175c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
1176c8efcc25STejun Heo 		}
1177c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
1178c8efcc25STejun Heo 	}
1179c8efcc25STejun Heo 	return false;
1180c8efcc25STejun Heo }
1181c8efcc25STejun Heo 
11824690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
11831da177e4SLinus Torvalds 			 struct work_struct *work)
11841da177e4SLinus Torvalds {
1185502ca9d8STejun Heo 	struct global_cwq *gcwq;
1186502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
11871e19ffc6STejun Heo 	struct list_head *worklist;
11888a2e8e5dSTejun Heo 	unsigned int work_flags;
1189b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
11908930cabaSTejun Heo 
11918930cabaSTejun Heo 	/*
11928930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
11938930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
11948930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
11958930cabaSTejun Heo 	 * happen with IRQ disabled.
11968930cabaSTejun Heo 	 */
11978930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
11981da177e4SLinus Torvalds 
1199dc186ad7SThomas Gleixner 	debug_work_activate(work);
12001e19ffc6STejun Heo 
1201c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
12029c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1203c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1204e41e704bSTejun Heo 		return;
1205e41e704bSTejun Heo 
1206c7fc77f7STejun Heo 	/* determine gcwq to use */
1207c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1208c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1209c7fc77f7STejun Heo 
121057469821STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
1211f3421797STejun Heo 			cpu = raw_smp_processor_id();
1212f3421797STejun Heo 
121318aa9effSTejun Heo 		/*
1214dbf2576eSTejun Heo 		 * It's multi cpu.  If @work was previously on a different
1215dbf2576eSTejun Heo 		 * cpu, it might still be running there, in which case the
1216dbf2576eSTejun Heo 		 * work needs to be queued on that cpu to guarantee
1217dbf2576eSTejun Heo 		 * non-reentrancy.
121818aa9effSTejun Heo 		 */
1219502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
1220dbf2576eSTejun Heo 		last_gcwq = get_work_gcwq(work);
1221dbf2576eSTejun Heo 
1222dbf2576eSTejun Heo 		if (last_gcwq && last_gcwq != gcwq) {
122318aa9effSTejun Heo 			struct worker *worker;
122418aa9effSTejun Heo 
12258930cabaSTejun Heo 			spin_lock(&last_gcwq->lock);
122618aa9effSTejun Heo 
122718aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
122818aa9effSTejun Heo 
122918aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
123018aa9effSTejun Heo 				gcwq = last_gcwq;
123118aa9effSTejun Heo 			else {
123218aa9effSTejun Heo 				/* meh... not running there, queue here */
12338930cabaSTejun Heo 				spin_unlock(&last_gcwq->lock);
12348930cabaSTejun Heo 				spin_lock(&gcwq->lock);
123518aa9effSTejun Heo 			}
12368930cabaSTejun Heo 		} else {
12378930cabaSTejun Heo 			spin_lock(&gcwq->lock);
12388930cabaSTejun Heo 		}
1239f3421797STejun Heo 	} else {
1240f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
12418930cabaSTejun Heo 		spin_lock(&gcwq->lock);
1242502ca9d8STejun Heo 	}
1243502ca9d8STejun Heo 
1244502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1245502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1246b75cac93SJoonsoo Kim 	trace_workqueue_queue_work(req_cpu, cwq, work);
1247502ca9d8STejun Heo 
1248f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
12498930cabaSTejun Heo 		spin_unlock(&gcwq->lock);
1250f5b2552bSDan Carpenter 		return;
1251f5b2552bSDan Carpenter 	}
12521e19ffc6STejun Heo 
125373f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
12548a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
12551e19ffc6STejun Heo 
12561e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1257cdadf009STejun Heo 		trace_workqueue_activate_work(work);
12581e19ffc6STejun Heo 		cwq->nr_active++;
12593270476aSTejun Heo 		worklist = &cwq->pool->worklist;
12608a2e8e5dSTejun Heo 	} else {
12618a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
12621e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
12638a2e8e5dSTejun Heo 	}
12641e19ffc6STejun Heo 
12658a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
12661e19ffc6STejun Heo 
12678930cabaSTejun Heo 	spin_unlock(&gcwq->lock);
12681da177e4SLinus Torvalds }
12691da177e4SLinus Torvalds 
12700fcb78c2SRolf Eike Beer /**
1271c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1272c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1273c1a220e7SZhang Rui  * @wq: workqueue to use
1274c1a220e7SZhang Rui  * @work: work to queue
1275c1a220e7SZhang Rui  *
1276d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
1277c1a220e7SZhang Rui  *
1278c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1279c1a220e7SZhang Rui  * can't go away.
1280c1a220e7SZhang Rui  */
1281d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1282d4283e93STejun Heo 		   struct work_struct *work)
1283c1a220e7SZhang Rui {
1284d4283e93STejun Heo 	bool ret = false;
12858930cabaSTejun Heo 	unsigned long flags;
12868930cabaSTejun Heo 
12878930cabaSTejun Heo 	local_irq_save(flags);
1288c1a220e7SZhang Rui 
128922df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
12904690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1291d4283e93STejun Heo 		ret = true;
1292c1a220e7SZhang Rui 	}
12938930cabaSTejun Heo 
12948930cabaSTejun Heo 	local_irq_restore(flags);
1295c1a220e7SZhang Rui 	return ret;
1296c1a220e7SZhang Rui }
1297c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1298c1a220e7SZhang Rui 
12990a13c00eSTejun Heo /**
13000a13c00eSTejun Heo  * queue_work - queue work on a workqueue
13010a13c00eSTejun Heo  * @wq: workqueue to use
13020a13c00eSTejun Heo  * @work: work to queue
13030a13c00eSTejun Heo  *
1304d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
13050a13c00eSTejun Heo  *
13060a13c00eSTejun Heo  * We queue the work to the CPU on which it was submitted, but if the CPU dies
13070a13c00eSTejun Heo  * it can be processed by another CPU.
13080a13c00eSTejun Heo  */
1309d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
13100a13c00eSTejun Heo {
131157469821STejun Heo 	return queue_work_on(WORK_CPU_UNBOUND, wq, work);
13120a13c00eSTejun Heo }
13130a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work);
13140a13c00eSTejun Heo 
1315d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
13161da177e4SLinus Torvalds {
131752bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
13187a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
13191da177e4SLinus Torvalds 
1320e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
13211265057fSTejun Heo 	__queue_work(dwork->cpu, cwq->wq, &dwork->work);
13221da177e4SLinus Torvalds }
1323d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
13241da177e4SLinus Torvalds 
13257beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
132652bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
13271da177e4SLinus Torvalds {
13287beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
13297beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
13307beb2edfSTejun Heo 	unsigned int lcpu;
13311da177e4SLinus Torvalds 
13327beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
13337beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
1334fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1335fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
13367beb2edfSTejun Heo 
13378852aac2STejun Heo 	/*
13388852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
13398852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
13408852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
13418852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
13428852aac2STejun Heo 	 */
13438852aac2STejun Heo 	if (!delay) {
13448852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
13458852aac2STejun Heo 		return;
13468852aac2STejun Heo 	}
13478852aac2STejun Heo 
13487beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
13497beb2edfSTejun Heo 
13507beb2edfSTejun Heo 	/*
13517beb2edfSTejun Heo 	 * This stores cwq for the moment, for the timer_fn.  Note that the
13527beb2edfSTejun Heo 	 * work's gcwq is preserved to allow reentrance detection for
13537beb2edfSTejun Heo 	 * delayed works.
13547beb2edfSTejun Heo 	 */
13557beb2edfSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
13567beb2edfSTejun Heo 		struct global_cwq *gcwq = get_work_gcwq(work);
13577beb2edfSTejun Heo 
1358e42986deSJoonsoo Kim 		/*
1359e42986deSJoonsoo Kim 		 * If we cannot get the last gcwq from @work directly,
1360e42986deSJoonsoo Kim 		 * select the last CPU such that it avoids unnecessarily
1361e42986deSJoonsoo Kim 		 * triggering non-reentrancy check in __queue_work().
1362e42986deSJoonsoo Kim 		 */
1363e42986deSJoonsoo Kim 		lcpu = cpu;
1364e42986deSJoonsoo Kim 		if (gcwq)
13657beb2edfSTejun Heo 			lcpu = gcwq->cpu;
1366e42986deSJoonsoo Kim 		if (lcpu == WORK_CPU_UNBOUND)
13677beb2edfSTejun Heo 			lcpu = raw_smp_processor_id();
13687beb2edfSTejun Heo 	} else {
13697beb2edfSTejun Heo 		lcpu = WORK_CPU_UNBOUND;
13701da177e4SLinus Torvalds 	}
13717beb2edfSTejun Heo 
13727beb2edfSTejun Heo 	set_work_cwq(work, get_cwq(lcpu, wq), 0);
13737beb2edfSTejun Heo 
13741265057fSTejun Heo 	dwork->cpu = cpu;
13757beb2edfSTejun Heo 	timer->expires = jiffies + delay;
13767beb2edfSTejun Heo 
13777beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
13787beb2edfSTejun Heo 		add_timer_on(timer, cpu);
13797beb2edfSTejun Heo 	else
13807beb2edfSTejun Heo 		add_timer(timer);
13817beb2edfSTejun Heo }
13821da177e4SLinus Torvalds 
13830fcb78c2SRolf Eike Beer /**
13840fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
13850fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
13860fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1387af9997e4SRandy Dunlap  * @dwork: work to queue
13880fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
13890fcb78c2SRolf Eike Beer  *
1390715f1300STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.  If
1391715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1392715f1300STejun Heo  * execution.
13930fcb78c2SRolf Eike Beer  */
1394d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
139552bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
13967a6bc1cdSVenkatesh Pallipadi {
139752bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1398d4283e93STejun Heo 	bool ret = false;
13998930cabaSTejun Heo 	unsigned long flags;
14008930cabaSTejun Heo 
14018930cabaSTejun Heo 	/* read the comment in __queue_work() */
14028930cabaSTejun Heo 	local_irq_save(flags);
14037a6bc1cdSVenkatesh Pallipadi 
140422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14057beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1406d4283e93STejun Heo 		ret = true;
14077a6bc1cdSVenkatesh Pallipadi 	}
14088930cabaSTejun Heo 
14098930cabaSTejun Heo 	local_irq_restore(flags);
14107a6bc1cdSVenkatesh Pallipadi 	return ret;
14117a6bc1cdSVenkatesh Pallipadi }
1412ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
14131da177e4SLinus Torvalds 
1414c8e55f36STejun Heo /**
14150a13c00eSTejun Heo  * queue_delayed_work - queue work on a workqueue after delay
14160a13c00eSTejun Heo  * @wq: workqueue to use
14170a13c00eSTejun Heo  * @dwork: delayable work to queue
14180a13c00eSTejun Heo  * @delay: number of jiffies to wait before queueing
14190a13c00eSTejun Heo  *
1420715f1300STejun Heo  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
14210a13c00eSTejun Heo  */
1422d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq,
14230a13c00eSTejun Heo 			struct delayed_work *dwork, unsigned long delay)
14240a13c00eSTejun Heo {
142557469821STejun Heo 	return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14260a13c00eSTejun Heo }
14270a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work);
14280a13c00eSTejun Heo 
14290a13c00eSTejun Heo /**
14308376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
14318376fe22STejun Heo  * @cpu: CPU number to execute work on
14328376fe22STejun Heo  * @wq: workqueue to use
14338376fe22STejun Heo  * @dwork: work to queue
14348376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14358376fe22STejun Heo  *
14368376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
14378376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
14388376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
14398376fe22STejun Heo  * current state.
14408376fe22STejun Heo  *
14418376fe22STejun Heo  * Returns %false if @dwork was idle and queued, %true if @dwork was
14428376fe22STejun Heo  * pending and its timer was modified.
14438376fe22STejun Heo  *
1444e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
14458376fe22STejun Heo  * See try_to_grab_pending() for details.
14468376fe22STejun Heo  */
14478376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
14488376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
14498376fe22STejun Heo {
14508376fe22STejun Heo 	unsigned long flags;
14518376fe22STejun Heo 	int ret;
14528376fe22STejun Heo 
14538376fe22STejun Heo 	do {
14548376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
14558376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
14568376fe22STejun Heo 
14578376fe22STejun Heo 	if (likely(ret >= 0)) {
14588376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
14598376fe22STejun Heo 		local_irq_restore(flags);
14608376fe22STejun Heo 	}
14618376fe22STejun Heo 
14628376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
14638376fe22STejun Heo 	return ret;
14648376fe22STejun Heo }
14658376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
14668376fe22STejun Heo 
14678376fe22STejun Heo /**
14688376fe22STejun Heo  * mod_delayed_work - modify delay of or queue a delayed work
14698376fe22STejun Heo  * @wq: workqueue to use
14708376fe22STejun Heo  * @dwork: work to queue
14718376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14728376fe22STejun Heo  *
14738376fe22STejun Heo  * mod_delayed_work_on() on local CPU.
14748376fe22STejun Heo  */
14758376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
14768376fe22STejun Heo 		      unsigned long delay)
14778376fe22STejun Heo {
14788376fe22STejun Heo 	return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14798376fe22STejun Heo }
14808376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work);
14818376fe22STejun Heo 
14828376fe22STejun Heo /**
1483c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1484c8e55f36STejun Heo  * @worker: worker which is entering idle state
1485c8e55f36STejun Heo  *
1486c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1487c8e55f36STejun Heo  * necessary.
1488c8e55f36STejun Heo  *
1489c8e55f36STejun Heo  * LOCKING:
1490c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1491c8e55f36STejun Heo  */
1492c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
14931da177e4SLinus Torvalds {
1494bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1495bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1496c8e55f36STejun Heo 
1497c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1498c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1499c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1500c8e55f36STejun Heo 
1501cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1502cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1503bd7bdd43STejun Heo 	pool->nr_idle++;
1504e22bee78STejun Heo 	worker->last_active = jiffies;
1505c8e55f36STejun Heo 
1506c8e55f36STejun Heo 	/* idle_list is LIFO */
1507bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1508db7bccf4STejun Heo 
150963d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1510628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1511cb444766STejun Heo 
1512544ecf31STejun Heo 	/*
1513628c78e7STejun Heo 	 * Sanity check nr_running.  Because gcwq_unbind_fn() releases
1514628c78e7STejun Heo 	 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1515628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1516628c78e7STejun Heo 	 * unbind is not in progress.
1517544ecf31STejun Heo 	 */
1518628c78e7STejun Heo 	WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
1519bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
152063d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1521c8e55f36STejun Heo }
1522c8e55f36STejun Heo 
1523c8e55f36STejun Heo /**
1524c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1525c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1526c8e55f36STejun Heo  *
1527c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1528c8e55f36STejun Heo  *
1529c8e55f36STejun Heo  * LOCKING:
1530c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1531c8e55f36STejun Heo  */
1532c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1533c8e55f36STejun Heo {
1534bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1535c8e55f36STejun Heo 
1536c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1537d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1538bd7bdd43STejun Heo 	pool->nr_idle--;
1539c8e55f36STejun Heo 	list_del_init(&worker->entry);
1540c8e55f36STejun Heo }
1541c8e55f36STejun Heo 
1542e22bee78STejun Heo /**
1543e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1544e22bee78STejun Heo  * @worker: self
1545e22bee78STejun Heo  *
1546e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1547e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1548e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1549e22bee78STejun Heo  * guaranteed to execute on the cpu.
1550e22bee78STejun Heo  *
1551e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1552e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1553e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1554e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1555e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1556e22bee78STejun Heo  * [dis]associated in the meantime.
1557e22bee78STejun Heo  *
1558f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1559f2d5a0eeSTejun Heo  * binding against %GCWQ_DISASSOCIATED which is set during
1560f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1561f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1562f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1563e22bee78STejun Heo  *
1564e22bee78STejun Heo  * CONTEXT:
1565e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1566e22bee78STejun Heo  * held.
1567e22bee78STejun Heo  *
1568e22bee78STejun Heo  * RETURNS:
1569e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1570e22bee78STejun Heo  * bound), %false if offline.
1571e22bee78STejun Heo  */
1572e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1573972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1574e22bee78STejun Heo {
1575bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1576e22bee78STejun Heo 	struct task_struct *task = worker->task;
1577e22bee78STejun Heo 
1578e22bee78STejun Heo 	while (true) {
1579e22bee78STejun Heo 		/*
1580e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1581e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1582e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1583e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1584e22bee78STejun Heo 		 */
1585f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1586e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1587e22bee78STejun Heo 
1588e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1589e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1590e22bee78STejun Heo 			return false;
1591e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1592e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1593e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1594e22bee78STejun Heo 			return true;
1595e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1596e22bee78STejun Heo 
15975035b20fSTejun Heo 		/*
15985035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
15995035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
16005035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
16015035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
16025035b20fSTejun Heo 		 */
1603e22bee78STejun Heo 		cpu_relax();
16045035b20fSTejun Heo 		cond_resched();
1605e22bee78STejun Heo 	}
1606e22bee78STejun Heo }
1607e22bee78STejun Heo 
1608e22bee78STejun Heo /*
1609ea1abd61SLai Jiangshan  * Rebind an idle @worker to its CPU.  worker_thread() will test
16105f7dabfdSLai Jiangshan  * list_empty(@worker->entry) before leaving idle and call this function.
161125511a47STejun Heo  */
161225511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
161325511a47STejun Heo {
161425511a47STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
161525511a47STejun Heo 
16165f7dabfdSLai Jiangshan 	/* CPU may go down again inbetween, clear UNBOUND only on success */
16175f7dabfdSLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
16185f7dabfdSLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
161925511a47STejun Heo 
1620ea1abd61SLai Jiangshan 	/* rebind complete, become available again */
1621ea1abd61SLai Jiangshan 	list_add(&worker->entry, &worker->pool->idle_list);
1622ea1abd61SLai Jiangshan 	spin_unlock_irq(&gcwq->lock);
162325511a47STejun Heo }
162425511a47STejun Heo 
162525511a47STejun Heo /*
162625511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1627403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1628403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1629403c821dSTejun Heo  * executed twice without intervening cpu down.
1630e22bee78STejun Heo  */
163125511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1632e22bee78STejun Heo {
1633e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1634bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1635e22bee78STejun Heo 
1636eab6d828SLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
1637eab6d828SLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
1638e22bee78STejun Heo 
1639e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1640e22bee78STejun Heo }
1641e22bee78STejun Heo 
164225511a47STejun Heo /**
164325511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
164425511a47STejun Heo  * @gcwq: gcwq of interest
164525511a47STejun Heo  *
164625511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
164725511a47STejun Heo  * is different for idle and busy ones.
164825511a47STejun Heo  *
1649ea1abd61SLai Jiangshan  * Idle ones will be removed from the idle_list and woken up.  They will
1650ea1abd61SLai Jiangshan  * add themselves back after completing rebind.  This ensures that the
1651ea1abd61SLai Jiangshan  * idle_list doesn't contain any unbound workers when re-bound busy workers
1652ea1abd61SLai Jiangshan  * try to perform local wake-ups for concurrency management.
165325511a47STejun Heo  *
1654ea1abd61SLai Jiangshan  * Busy workers can rebind after they finish their current work items.
1655ea1abd61SLai Jiangshan  * Queueing the rebind work item at the head of the scheduled list is
1656ea1abd61SLai Jiangshan  * enough.  Note that nr_running will be properly bumped as busy workers
1657ea1abd61SLai Jiangshan  * rebind.
165825511a47STejun Heo  *
1659ea1abd61SLai Jiangshan  * On return, all non-manager workers are scheduled for rebind - see
1660ea1abd61SLai Jiangshan  * manage_workers() for the manager special case.  Any idle worker
1661ea1abd61SLai Jiangshan  * including the manager will not appear on @idle_list until rebind is
1662ea1abd61SLai Jiangshan  * complete, making local wake-ups safe.
166325511a47STejun Heo  */
166425511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
166525511a47STejun Heo {
166625511a47STejun Heo 	struct worker_pool *pool;
1667ea1abd61SLai Jiangshan 	struct worker *worker, *n;
166825511a47STejun Heo 	struct hlist_node *pos;
166925511a47STejun Heo 	int i;
167025511a47STejun Heo 
167125511a47STejun Heo 	lockdep_assert_held(&gcwq->lock);
167225511a47STejun Heo 
167325511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
1674b2eb83d1SLai Jiangshan 		lockdep_assert_held(&pool->assoc_mutex);
167525511a47STejun Heo 
16765f7dabfdSLai Jiangshan 	/* dequeue and kick idle ones */
167725511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
1678ea1abd61SLai Jiangshan 		list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1679ea1abd61SLai Jiangshan 			/*
1680ea1abd61SLai Jiangshan 			 * idle workers should be off @pool->idle_list
1681ea1abd61SLai Jiangshan 			 * until rebind is complete to avoid receiving
1682ea1abd61SLai Jiangshan 			 * premature local wake-ups.
1683ea1abd61SLai Jiangshan 			 */
1684ea1abd61SLai Jiangshan 			list_del_init(&worker->entry);
168525511a47STejun Heo 
168625511a47STejun Heo 			/*
16875f7dabfdSLai Jiangshan 			 * worker_thread() will see the above dequeuing
16885f7dabfdSLai Jiangshan 			 * and call idle_worker_rebind().
168925511a47STejun Heo 			 */
169025511a47STejun Heo 			wake_up_process(worker->task);
169125511a47STejun Heo 		}
169225511a47STejun Heo 	}
169325511a47STejun Heo 
1694ea1abd61SLai Jiangshan 	/* rebind busy workers */
169525511a47STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
169625511a47STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
1697e2b6a6d5SJoonsoo Kim 		struct workqueue_struct *wq;
169825511a47STejun Heo 
169925511a47STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
170025511a47STejun Heo 				     work_data_bits(rebind_work)))
170125511a47STejun Heo 			continue;
170225511a47STejun Heo 
170325511a47STejun Heo 		debug_work_activate(rebind_work);
170490beca5dSTejun Heo 
170590beca5dSTejun Heo 		/*
1706e2b6a6d5SJoonsoo Kim 		 * wq doesn't really matter but let's keep @worker->pool
1707e2b6a6d5SJoonsoo Kim 		 * and @cwq->pool consistent for sanity.
170890beca5dSTejun Heo 		 */
1709e2b6a6d5SJoonsoo Kim 		if (worker_pool_pri(worker->pool))
1710e2b6a6d5SJoonsoo Kim 			wq = system_highpri_wq;
1711e2b6a6d5SJoonsoo Kim 		else
1712e2b6a6d5SJoonsoo Kim 			wq = system_wq;
1713ec58815aSTejun Heo 
1714e2b6a6d5SJoonsoo Kim 		insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
171525511a47STejun Heo 			worker->scheduled.next,
171625511a47STejun Heo 			work_color_to_flags(WORK_NO_COLOR));
1717ec58815aSTejun Heo 	}
171825511a47STejun Heo }
171925511a47STejun Heo 
1720c34056a3STejun Heo static struct worker *alloc_worker(void)
1721c34056a3STejun Heo {
1722c34056a3STejun Heo 	struct worker *worker;
1723c34056a3STejun Heo 
1724c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1725c8e55f36STejun Heo 	if (worker) {
1726c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1727affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
172825511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1729e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1730e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1731c8e55f36STejun Heo 	}
1732c34056a3STejun Heo 	return worker;
1733c34056a3STejun Heo }
1734c34056a3STejun Heo 
1735c34056a3STejun Heo /**
1736c34056a3STejun Heo  * create_worker - create a new workqueue worker
173763d95a91STejun Heo  * @pool: pool the new worker will belong to
1738c34056a3STejun Heo  *
173963d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1740c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1741c34056a3STejun Heo  * destroy_worker().
1742c34056a3STejun Heo  *
1743c34056a3STejun Heo  * CONTEXT:
1744c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1745c34056a3STejun Heo  *
1746c34056a3STejun Heo  * RETURNS:
1747c34056a3STejun Heo  * Pointer to the newly created worker.
1748c34056a3STejun Heo  */
1749bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1750c34056a3STejun Heo {
175163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
17523270476aSTejun Heo 	const char *pri = worker_pool_pri(pool) ? "H" : "";
1753c34056a3STejun Heo 	struct worker *worker = NULL;
1754f3421797STejun Heo 	int id = -1;
1755c34056a3STejun Heo 
17568b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1757bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
17588b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1759bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1760c34056a3STejun Heo 			goto fail;
17618b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1762c34056a3STejun Heo 	}
17638b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1764c34056a3STejun Heo 
1765c34056a3STejun Heo 	worker = alloc_worker();
1766c34056a3STejun Heo 	if (!worker)
1767c34056a3STejun Heo 		goto fail;
1768c34056a3STejun Heo 
1769bd7bdd43STejun Heo 	worker->pool = pool;
1770c34056a3STejun Heo 	worker->id = id;
1771c34056a3STejun Heo 
1772bc2ae0f5STejun Heo 	if (gcwq->cpu != WORK_CPU_UNBOUND)
177394dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
17743270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
17753270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1776f3421797STejun Heo 	else
1777f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
17783270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1779c34056a3STejun Heo 	if (IS_ERR(worker->task))
1780c34056a3STejun Heo 		goto fail;
1781c34056a3STejun Heo 
17823270476aSTejun Heo 	if (worker_pool_pri(pool))
17833270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
17843270476aSTejun Heo 
1785db7bccf4STejun Heo 	/*
1786bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
1787bc2ae0f5STejun Heo 	 * %GCWQ_DISASSOCIATED.  The caller is responsible for ensuring the
1788bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1789bc2ae0f5STejun Heo 	 * above the flag definition for details.
1790bc2ae0f5STejun Heo 	 *
1791bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1792bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1793db7bccf4STejun Heo 	 */
1794bc2ae0f5STejun Heo 	if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
17958b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1796bc2ae0f5STejun Heo 	} else {
1797db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1798f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1799f3421797STejun Heo 	}
1800c34056a3STejun Heo 
1801c34056a3STejun Heo 	return worker;
1802c34056a3STejun Heo fail:
1803c34056a3STejun Heo 	if (id >= 0) {
18048b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1805bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
18068b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1807c34056a3STejun Heo 	}
1808c34056a3STejun Heo 	kfree(worker);
1809c34056a3STejun Heo 	return NULL;
1810c34056a3STejun Heo }
1811c34056a3STejun Heo 
1812c34056a3STejun Heo /**
1813c34056a3STejun Heo  * start_worker - start a newly created worker
1814c34056a3STejun Heo  * @worker: worker to start
1815c34056a3STejun Heo  *
1816c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1817c34056a3STejun Heo  *
1818c34056a3STejun Heo  * CONTEXT:
18198b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1820c34056a3STejun Heo  */
1821c34056a3STejun Heo static void start_worker(struct worker *worker)
1822c34056a3STejun Heo {
1823cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1824bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1825c8e55f36STejun Heo 	worker_enter_idle(worker);
1826c34056a3STejun Heo 	wake_up_process(worker->task);
1827c34056a3STejun Heo }
1828c34056a3STejun Heo 
1829c34056a3STejun Heo /**
1830c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1831c34056a3STejun Heo  * @worker: worker to be destroyed
1832c34056a3STejun Heo  *
1833c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1834c8e55f36STejun Heo  *
1835c8e55f36STejun Heo  * CONTEXT:
1836c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1837c34056a3STejun Heo  */
1838c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1839c34056a3STejun Heo {
1840bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1841bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1842c34056a3STejun Heo 	int id = worker->id;
1843c34056a3STejun Heo 
1844c34056a3STejun Heo 	/* sanity check frenzy */
1845c34056a3STejun Heo 	BUG_ON(worker->current_work);
1846affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1847c34056a3STejun Heo 
1848c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1849bd7bdd43STejun Heo 		pool->nr_workers--;
1850c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1851bd7bdd43STejun Heo 		pool->nr_idle--;
1852c8e55f36STejun Heo 
1853c8e55f36STejun Heo 	list_del_init(&worker->entry);
1854cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1855c8e55f36STejun Heo 
1856c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1857c8e55f36STejun Heo 
1858c34056a3STejun Heo 	kthread_stop(worker->task);
1859c34056a3STejun Heo 	kfree(worker);
1860c34056a3STejun Heo 
18618b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1862bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1863c34056a3STejun Heo }
1864c34056a3STejun Heo 
186563d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1866e22bee78STejun Heo {
186763d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
186863d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1869e22bee78STejun Heo 
1870e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1871e22bee78STejun Heo 
187263d95a91STejun Heo 	if (too_many_workers(pool)) {
1873e22bee78STejun Heo 		struct worker *worker;
1874e22bee78STejun Heo 		unsigned long expires;
1875e22bee78STejun Heo 
1876e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
187763d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1878e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1879e22bee78STejun Heo 
1880e22bee78STejun Heo 		if (time_before(jiffies, expires))
188163d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1882e22bee78STejun Heo 		else {
1883e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
188411ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
188563d95a91STejun Heo 			wake_up_worker(pool);
1886e22bee78STejun Heo 		}
1887e22bee78STejun Heo 	}
1888e22bee78STejun Heo 
1889e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1890e22bee78STejun Heo }
1891e22bee78STejun Heo 
1892e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1893e22bee78STejun Heo {
1894e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1895e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1896f3421797STejun Heo 	unsigned int cpu;
1897e22bee78STejun Heo 
1898e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1899e22bee78STejun Heo 		return false;
1900e22bee78STejun Heo 
1901e22bee78STejun Heo 	/* mayday mayday mayday */
1902bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1903f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1904f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1905f3421797STejun Heo 		cpu = 0;
1906f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1907e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1908e22bee78STejun Heo 	return true;
1909e22bee78STejun Heo }
1910e22bee78STejun Heo 
191163d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1912e22bee78STejun Heo {
191363d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
191463d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1915e22bee78STejun Heo 	struct work_struct *work;
1916e22bee78STejun Heo 
1917e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1918e22bee78STejun Heo 
191963d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1920e22bee78STejun Heo 		/*
1921e22bee78STejun Heo 		 * We've been trying to create a new worker but
1922e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1923e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1924e22bee78STejun Heo 		 * rescuers.
1925e22bee78STejun Heo 		 */
192663d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1927e22bee78STejun Heo 			send_mayday(work);
1928e22bee78STejun Heo 	}
1929e22bee78STejun Heo 
1930e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1931e22bee78STejun Heo 
193263d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1933e22bee78STejun Heo }
1934e22bee78STejun Heo 
1935e22bee78STejun Heo /**
1936e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
193763d95a91STejun Heo  * @pool: pool to create a new worker for
1938e22bee78STejun Heo  *
193963d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1940e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1941e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
194263d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1943e22bee78STejun Heo  * possible allocation deadlock.
1944e22bee78STejun Heo  *
1945e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1946e22bee78STejun Heo  * may_start_working() true.
1947e22bee78STejun Heo  *
1948e22bee78STejun Heo  * LOCKING:
1949e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1950e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1951e22bee78STejun Heo  * manager.
1952e22bee78STejun Heo  *
1953e22bee78STejun Heo  * RETURNS:
1954e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1955e22bee78STejun Heo  * otherwise.
1956e22bee78STejun Heo  */
195763d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
195806bd6ebfSNamhyung Kim __releases(&gcwq->lock)
195906bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1960e22bee78STejun Heo {
196163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
196263d95a91STejun Heo 
196363d95a91STejun Heo 	if (!need_to_create_worker(pool))
1964e22bee78STejun Heo 		return false;
1965e22bee78STejun Heo restart:
19669f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
19679f9c2364STejun Heo 
1968e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
196963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1970e22bee78STejun Heo 
1971e22bee78STejun Heo 	while (true) {
1972e22bee78STejun Heo 		struct worker *worker;
1973e22bee78STejun Heo 
1974bc2ae0f5STejun Heo 		worker = create_worker(pool);
1975e22bee78STejun Heo 		if (worker) {
197663d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1977e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1978e22bee78STejun Heo 			start_worker(worker);
197963d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1980e22bee78STejun Heo 			return true;
1981e22bee78STejun Heo 		}
1982e22bee78STejun Heo 
198363d95a91STejun Heo 		if (!need_to_create_worker(pool))
1984e22bee78STejun Heo 			break;
1985e22bee78STejun Heo 
1986e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1987e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
19889f9c2364STejun Heo 
198963d95a91STejun Heo 		if (!need_to_create_worker(pool))
1990e22bee78STejun Heo 			break;
1991e22bee78STejun Heo 	}
1992e22bee78STejun Heo 
199363d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1994e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
199563d95a91STejun Heo 	if (need_to_create_worker(pool))
1996e22bee78STejun Heo 		goto restart;
1997e22bee78STejun Heo 	return true;
1998e22bee78STejun Heo }
1999e22bee78STejun Heo 
2000e22bee78STejun Heo /**
2001e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
200263d95a91STejun Heo  * @pool: pool to destroy workers for
2003e22bee78STejun Heo  *
200463d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
2005e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
2006e22bee78STejun Heo  *
2007e22bee78STejun Heo  * LOCKING:
2008e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2009e22bee78STejun Heo  * multiple times.  Called only from manager.
2010e22bee78STejun Heo  *
2011e22bee78STejun Heo  * RETURNS:
2012e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
2013e22bee78STejun Heo  * otherwise.
2014e22bee78STejun Heo  */
201563d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
2016e22bee78STejun Heo {
2017e22bee78STejun Heo 	bool ret = false;
2018e22bee78STejun Heo 
201963d95a91STejun Heo 	while (too_many_workers(pool)) {
2020e22bee78STejun Heo 		struct worker *worker;
2021e22bee78STejun Heo 		unsigned long expires;
2022e22bee78STejun Heo 
202363d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2024e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2025e22bee78STejun Heo 
2026e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
202763d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2028e22bee78STejun Heo 			break;
2029e22bee78STejun Heo 		}
2030e22bee78STejun Heo 
2031e22bee78STejun Heo 		destroy_worker(worker);
2032e22bee78STejun Heo 		ret = true;
2033e22bee78STejun Heo 	}
2034e22bee78STejun Heo 
2035e22bee78STejun Heo 	return ret;
2036e22bee78STejun Heo }
2037e22bee78STejun Heo 
2038e22bee78STejun Heo /**
2039e22bee78STejun Heo  * manage_workers - manage worker pool
2040e22bee78STejun Heo  * @worker: self
2041e22bee78STejun Heo  *
2042e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
2043e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2044e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
2045e22bee78STejun Heo  *
2046e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2047e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2048e22bee78STejun Heo  * and may_start_working() is true.
2049e22bee78STejun Heo  *
2050e22bee78STejun Heo  * CONTEXT:
2051e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2052e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2053e22bee78STejun Heo  *
2054e22bee78STejun Heo  * RETURNS:
2055e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
2056e22bee78STejun Heo  * some action was taken.
2057e22bee78STejun Heo  */
2058e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2059e22bee78STejun Heo {
206063d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2061e22bee78STejun Heo 	bool ret = false;
2062e22bee78STejun Heo 
2063ee378aa4SLai Jiangshan 	if (pool->flags & POOL_MANAGING_WORKERS)
2064e22bee78STejun Heo 		return ret;
2065e22bee78STejun Heo 
2066552a37e9SLai Jiangshan 	pool->flags |= POOL_MANAGING_WORKERS;
2067ee378aa4SLai Jiangshan 
2068ee378aa4SLai Jiangshan 	/*
2069ee378aa4SLai Jiangshan 	 * To simplify both worker management and CPU hotplug, hold off
2070ee378aa4SLai Jiangshan 	 * management while hotplug is in progress.  CPU hotplug path can't
2071ee378aa4SLai Jiangshan 	 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2072ee378aa4SLai Jiangshan 	 * lead to idle worker depletion (all become busy thinking someone
2073ee378aa4SLai Jiangshan 	 * else is managing) which in turn can result in deadlock under
2074b2eb83d1SLai Jiangshan 	 * extreme circumstances.  Use @pool->assoc_mutex to synchronize
2075ee378aa4SLai Jiangshan 	 * manager against CPU hotplug.
2076ee378aa4SLai Jiangshan 	 *
2077b2eb83d1SLai Jiangshan 	 * assoc_mutex would always be free unless CPU hotplug is in
2078ee378aa4SLai Jiangshan 	 * progress.  trylock first without dropping @gcwq->lock.
2079ee378aa4SLai Jiangshan 	 */
2080b2eb83d1SLai Jiangshan 	if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
2081ee378aa4SLai Jiangshan 		spin_unlock_irq(&pool->gcwq->lock);
2082b2eb83d1SLai Jiangshan 		mutex_lock(&pool->assoc_mutex);
2083ee378aa4SLai Jiangshan 		/*
2084ee378aa4SLai Jiangshan 		 * CPU hotplug could have happened while we were waiting
2085b2eb83d1SLai Jiangshan 		 * for assoc_mutex.  Hotplug itself can't handle us
2086ee378aa4SLai Jiangshan 		 * because manager isn't either on idle or busy list, and
2087ee378aa4SLai Jiangshan 		 * @gcwq's state and ours could have deviated.
2088ee378aa4SLai Jiangshan 		 *
2089b2eb83d1SLai Jiangshan 		 * As hotplug is now excluded via assoc_mutex, we can
2090ee378aa4SLai Jiangshan 		 * simply try to bind.  It will succeed or fail depending
2091ee378aa4SLai Jiangshan 		 * on @gcwq's current state.  Try it and adjust
2092ee378aa4SLai Jiangshan 		 * %WORKER_UNBOUND accordingly.
2093ee378aa4SLai Jiangshan 		 */
2094ee378aa4SLai Jiangshan 		if (worker_maybe_bind_and_lock(worker))
2095ee378aa4SLai Jiangshan 			worker->flags &= ~WORKER_UNBOUND;
2096ee378aa4SLai Jiangshan 		else
2097ee378aa4SLai Jiangshan 			worker->flags |= WORKER_UNBOUND;
2098ee378aa4SLai Jiangshan 
2099ee378aa4SLai Jiangshan 		ret = true;
2100ee378aa4SLai Jiangshan 	}
2101ee378aa4SLai Jiangshan 
210211ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2103e22bee78STejun Heo 
2104e22bee78STejun Heo 	/*
2105e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2106e22bee78STejun Heo 	 * on return.
2107e22bee78STejun Heo 	 */
210863d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
210963d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2110e22bee78STejun Heo 
2111552a37e9SLai Jiangshan 	pool->flags &= ~POOL_MANAGING_WORKERS;
2112b2eb83d1SLai Jiangshan 	mutex_unlock(&pool->assoc_mutex);
2113e22bee78STejun Heo 	return ret;
2114e22bee78STejun Heo }
2115e22bee78STejun Heo 
2116a62428c0STejun Heo /**
2117a62428c0STejun Heo  * process_one_work - process single work
2118c34056a3STejun Heo  * @worker: self
2119a62428c0STejun Heo  * @work: work to process
2120a62428c0STejun Heo  *
2121a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2122a62428c0STejun Heo  * process a single work including synchronization against and
2123a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2124a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2125a62428c0STejun Heo  * call this function to process a work.
2126a62428c0STejun Heo  *
2127a62428c0STejun Heo  * CONTEXT:
21288b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
2129a62428c0STejun Heo  */
2130c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
213106bd6ebfSNamhyung Kim __releases(&gcwq->lock)
213206bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
21331da177e4SLinus Torvalds {
21347e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2135bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2136bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
2137fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
213873f53c4aSTejun Heo 	int work_color;
21397e11629dSTejun Heo 	struct worker *collision;
21404e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21414e6045f1SJohannes Berg 	/*
2142a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2143a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2144a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2145a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2146a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21474e6045f1SJohannes Berg 	 */
21484d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21494d82a1deSPeter Zijlstra 
21504d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21514e6045f1SJohannes Berg #endif
21526fec10a1STejun Heo 	/*
21536fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21546fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
21556fec10a1STejun Heo 	 * unbound or a disassociated gcwq.
21566fec10a1STejun Heo 	 */
21575f7dabfdSLai Jiangshan 	WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
21586fec10a1STejun Heo 		     !(gcwq->flags & GCWQ_DISASSOCIATED) &&
215925511a47STejun Heo 		     raw_smp_processor_id() != gcwq->cpu);
216025511a47STejun Heo 
21617e11629dSTejun Heo 	/*
21627e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21637e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21647e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21657e11629dSTejun Heo 	 * currently executing one.
21667e11629dSTejun Heo 	 */
216742f8570fSSasha Levin 	collision = find_worker_executing_work(gcwq, work);
21687e11629dSTejun Heo 	if (unlikely(collision)) {
21697e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21707e11629dSTejun Heo 		return;
21717e11629dSTejun Heo 	}
21721da177e4SLinus Torvalds 
21738930cabaSTejun Heo 	/* claim and dequeue */
21741da177e4SLinus Torvalds 	debug_work_deactivate(work);
2175*023f27d3STejun Heo 	hash_add(gcwq->busy_hash, &worker->hentry, (unsigned long)work);
2176c34056a3STejun Heo 	worker->current_work = work;
2177a2c1c57bSTejun Heo 	worker->current_func = work->func;
21788cca0eeaSTejun Heo 	worker->current_cwq = cwq;
217973f53c4aSTejun Heo 	work_color = get_work_color(work);
21807a22ad75STejun Heo 
2181a62428c0STejun Heo 	list_del_init(&work->entry);
2182a62428c0STejun Heo 
2183649027d7STejun Heo 	/*
2184fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2185fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2186fb0e7bebSTejun Heo 	 */
2187fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2188fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2189fb0e7bebSTejun Heo 
2190974271c4STejun Heo 	/*
2191974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
2192974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2193974271c4STejun Heo 	 */
219463d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
219563d95a91STejun Heo 		wake_up_worker(pool);
2196974271c4STejun Heo 
21978930cabaSTejun Heo 	/*
219823657bb1STejun Heo 	 * Record the last CPU and clear PENDING which should be the last
219923657bb1STejun Heo 	 * update to @work.  Also, do this inside @gcwq->lock so that
220023657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
220123657bb1STejun Heo 	 * disabled.
22028930cabaSTejun Heo 	 */
22038930cabaSTejun Heo 	set_work_cpu_and_clear_pending(work, gcwq->cpu);
22041da177e4SLinus Torvalds 
22051da177e4SLinus Torvalds 	spin_unlock_irq(&gcwq->lock);
2206365970a1SDavid Howells 
2207e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
22083295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2209e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2210a2c1c57bSTejun Heo 	worker->current_func(work);
2211e36c886aSArjan van de Ven 	/*
2212e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2213e36c886aSArjan van de Ven 	 * point will only record its address.
2214e36c886aSArjan van de Ven 	 */
2215e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22163295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
22173295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
22181da177e4SLinus Torvalds 
2219d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2220044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2221044c782cSValentin Ilie 		       "     last function: %pf\n",
2222a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2223a2c1c57bSTejun Heo 		       worker->current_func);
2224d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2225d5abe669SPeter Zijlstra 		dump_stack();
2226d5abe669SPeter Zijlstra 	}
2227d5abe669SPeter Zijlstra 
22288b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2229a62428c0STejun Heo 
2230fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2231fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2232fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2233fb0e7bebSTejun Heo 
2234a62428c0STejun Heo 	/* we're done with it, release */
223542f8570fSSasha Levin 	hash_del(&worker->hentry);
2236c34056a3STejun Heo 	worker->current_work = NULL;
2237a2c1c57bSTejun Heo 	worker->current_func = NULL;
22388cca0eeaSTejun Heo 	worker->current_cwq = NULL;
2239b3f9f405SLai Jiangshan 	cwq_dec_nr_in_flight(cwq, work_color);
22401da177e4SLinus Torvalds }
22411da177e4SLinus Torvalds 
2242affee4b2STejun Heo /**
2243affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2244affee4b2STejun Heo  * @worker: self
2245affee4b2STejun Heo  *
2246affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2247affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2248affee4b2STejun Heo  * fetches a work from the top and executes it.
2249affee4b2STejun Heo  *
2250affee4b2STejun Heo  * CONTEXT:
22518b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2252affee4b2STejun Heo  * multiple times.
2253affee4b2STejun Heo  */
2254affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22551da177e4SLinus Torvalds {
2256affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2257affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2258a62428c0STejun Heo 						struct work_struct, entry);
2259c34056a3STejun Heo 		process_one_work(worker, work);
2260a62428c0STejun Heo 	}
22611da177e4SLinus Torvalds }
22621da177e4SLinus Torvalds 
22634690c4abSTejun Heo /**
22644690c4abSTejun Heo  * worker_thread - the worker thread function
2265c34056a3STejun Heo  * @__worker: self
22664690c4abSTejun Heo  *
2267e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2268e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2269e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2270e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2271e22bee78STejun Heo  * rescuer_thread().
22724690c4abSTejun Heo  */
2273c34056a3STejun Heo static int worker_thread(void *__worker)
22741da177e4SLinus Torvalds {
2275c34056a3STejun Heo 	struct worker *worker = __worker;
2276bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2277bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
22781da177e4SLinus Torvalds 
2279e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2280e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2281c8e55f36STejun Heo woke_up:
22828b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2283affee4b2STejun Heo 
22845f7dabfdSLai Jiangshan 	/* we are off idle list if destruction or rebind is requested */
22855f7dabfdSLai Jiangshan 	if (unlikely(list_empty(&worker->entry))) {
2286c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
228725511a47STejun Heo 
22885f7dabfdSLai Jiangshan 		/* if DIE is set, destruction is requested */
228925511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2290e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2291c8e55f36STejun Heo 			return 0;
2292c8e55f36STejun Heo 		}
2293c8e55f36STejun Heo 
22945f7dabfdSLai Jiangshan 		/* otherwise, rebind */
229525511a47STejun Heo 		idle_worker_rebind(worker);
229625511a47STejun Heo 		goto woke_up;
229725511a47STejun Heo 	}
229825511a47STejun Heo 
2299c8e55f36STejun Heo 	worker_leave_idle(worker);
2300db7bccf4STejun Heo recheck:
2301e22bee78STejun Heo 	/* no more worker necessary? */
230263d95a91STejun Heo 	if (!need_more_worker(pool))
2303e22bee78STejun Heo 		goto sleep;
2304e22bee78STejun Heo 
2305e22bee78STejun Heo 	/* do we need to manage? */
230663d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2307e22bee78STejun Heo 		goto recheck;
2308e22bee78STejun Heo 
2309c8e55f36STejun Heo 	/*
2310c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2311c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2312c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2313c8e55f36STejun Heo 	 */
2314c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2315c8e55f36STejun Heo 
2316e22bee78STejun Heo 	/*
2317e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2318e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2319e22bee78STejun Heo 	 * assumed the manager role.
2320e22bee78STejun Heo 	 */
2321e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2322e22bee78STejun Heo 
2323e22bee78STejun Heo 	do {
2324affee4b2STejun Heo 		struct work_struct *work =
2325bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2326affee4b2STejun Heo 					 struct work_struct, entry);
2327affee4b2STejun Heo 
2328c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2329affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2330affee4b2STejun Heo 			process_one_work(worker, work);
2331affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2332affee4b2STejun Heo 				process_scheduled_works(worker);
2333affee4b2STejun Heo 		} else {
2334c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2335affee4b2STejun Heo 			process_scheduled_works(worker);
2336affee4b2STejun Heo 		}
233763d95a91STejun Heo 	} while (keep_working(pool));
2338affee4b2STejun Heo 
2339e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2340d313dd85STejun Heo sleep:
234163d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2342e22bee78STejun Heo 		goto recheck;
2343d313dd85STejun Heo 
2344c8e55f36STejun Heo 	/*
2345e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2346e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2347e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2348e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2349e22bee78STejun Heo 	 * prevent losing any event.
2350c8e55f36STejun Heo 	 */
2351c8e55f36STejun Heo 	worker_enter_idle(worker);
2352c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
23538b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23541da177e4SLinus Torvalds 	schedule();
2355c8e55f36STejun Heo 	goto woke_up;
23561da177e4SLinus Torvalds }
23571da177e4SLinus Torvalds 
2358e22bee78STejun Heo /**
2359e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2360e22bee78STejun Heo  * @__wq: the associated workqueue
2361e22bee78STejun Heo  *
2362e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2363e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2364e22bee78STejun Heo  *
2365e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2366e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2367e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2368e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2369e22bee78STejun Heo  * the problem rescuer solves.
2370e22bee78STejun Heo  *
2371e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2372e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2373e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2374e22bee78STejun Heo  *
2375e22bee78STejun Heo  * This should happen rarely.
2376e22bee78STejun Heo  */
2377e22bee78STejun Heo static int rescuer_thread(void *__wq)
2378e22bee78STejun Heo {
2379e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2380e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2381e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2382f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2383e22bee78STejun Heo 	unsigned int cpu;
2384e22bee78STejun Heo 
2385e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2386e22bee78STejun Heo repeat:
2387e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
23881da177e4SLinus Torvalds 
2389412d32e6SMike Galbraith 	if (kthread_should_stop()) {
2390412d32e6SMike Galbraith 		__set_current_state(TASK_RUNNING);
2391e22bee78STejun Heo 		return 0;
2392412d32e6SMike Galbraith 	}
23931da177e4SLinus Torvalds 
2394f3421797STejun Heo 	/*
2395f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2396f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2397f3421797STejun Heo 	 */
2398f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2399f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2400f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2401bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2402bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2403e22bee78STejun Heo 		struct work_struct *work, *n;
2404e22bee78STejun Heo 
2405e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2406f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2407e22bee78STejun Heo 
2408e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2409bd7bdd43STejun Heo 		rescuer->pool = pool;
2410e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2411e22bee78STejun Heo 
2412e22bee78STejun Heo 		/*
2413e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2414e22bee78STejun Heo 		 * process'em.
2415e22bee78STejun Heo 		 */
2416e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2417bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2418e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2419e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2420e22bee78STejun Heo 
2421e22bee78STejun Heo 		process_scheduled_works(rescuer);
24227576958aSTejun Heo 
24237576958aSTejun Heo 		/*
24247576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
24257576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24267576958aSTejun Heo 		 * and stalling the execution.
24277576958aSTejun Heo 		 */
242863d95a91STejun Heo 		if (keep_working(pool))
242963d95a91STejun Heo 			wake_up_worker(pool);
24307576958aSTejun Heo 
2431e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
24321da177e4SLinus Torvalds 	}
24331da177e4SLinus Torvalds 
2434e22bee78STejun Heo 	schedule();
2435e22bee78STejun Heo 	goto repeat;
24361da177e4SLinus Torvalds }
24371da177e4SLinus Torvalds 
2438fc2e4d70SOleg Nesterov struct wq_barrier {
2439fc2e4d70SOleg Nesterov 	struct work_struct	work;
2440fc2e4d70SOleg Nesterov 	struct completion	done;
2441fc2e4d70SOleg Nesterov };
2442fc2e4d70SOleg Nesterov 
2443fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2444fc2e4d70SOleg Nesterov {
2445fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2446fc2e4d70SOleg Nesterov 	complete(&barr->done);
2447fc2e4d70SOleg Nesterov }
2448fc2e4d70SOleg Nesterov 
24494690c4abSTejun Heo /**
24504690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
24514690c4abSTejun Heo  * @cwq: cwq to insert barrier into
24524690c4abSTejun Heo  * @barr: wq_barrier to insert
2453affee4b2STejun Heo  * @target: target work to attach @barr to
2454affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24554690c4abSTejun Heo  *
2456affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2457affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2458affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2459affee4b2STejun Heo  * cpu.
2460affee4b2STejun Heo  *
2461affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2462affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2463affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2464affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2465affee4b2STejun Heo  * after a work with LINKED flag set.
2466affee4b2STejun Heo  *
2467affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2468affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
24694690c4abSTejun Heo  *
24704690c4abSTejun Heo  * CONTEXT:
24718b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
24724690c4abSTejun Heo  */
247383c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2474affee4b2STejun Heo 			      struct wq_barrier *barr,
2475affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2476fc2e4d70SOleg Nesterov {
2477affee4b2STejun Heo 	struct list_head *head;
2478affee4b2STejun Heo 	unsigned int linked = 0;
2479affee4b2STejun Heo 
2480dc186ad7SThomas Gleixner 	/*
24818b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2482dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2483dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2484dc186ad7SThomas Gleixner 	 * might deadlock.
2485dc186ad7SThomas Gleixner 	 */
2486ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
248722df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2488fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
248983c22520SOleg Nesterov 
2490affee4b2STejun Heo 	/*
2491affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2492affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2493affee4b2STejun Heo 	 */
2494affee4b2STejun Heo 	if (worker)
2495affee4b2STejun Heo 		head = worker->scheduled.next;
2496affee4b2STejun Heo 	else {
2497affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2498affee4b2STejun Heo 
2499affee4b2STejun Heo 		head = target->entry.next;
2500affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2501affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2502affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2503affee4b2STejun Heo 	}
2504affee4b2STejun Heo 
2505dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2506affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2507affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2508fc2e4d70SOleg Nesterov }
2509fc2e4d70SOleg Nesterov 
251073f53c4aSTejun Heo /**
251173f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
251273f53c4aSTejun Heo  * @wq: workqueue being flushed
251373f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
251473f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
251573f53c4aSTejun Heo  *
251673f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
251773f53c4aSTejun Heo  *
251873f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
251973f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
252073f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
252173f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
252273f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
252373f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
252473f53c4aSTejun Heo  *
252573f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
252673f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
252773f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
252873f53c4aSTejun Heo  * is returned.
252973f53c4aSTejun Heo  *
253073f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
253173f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
253273f53c4aSTejun Heo  * advanced to @work_color.
253373f53c4aSTejun Heo  *
253473f53c4aSTejun Heo  * CONTEXT:
253573f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
253673f53c4aSTejun Heo  *
253773f53c4aSTejun Heo  * RETURNS:
253873f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
253973f53c4aSTejun Heo  * otherwise.
254073f53c4aSTejun Heo  */
254173f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
254273f53c4aSTejun Heo 				      int flush_color, int work_color)
25431da177e4SLinus Torvalds {
254473f53c4aSTejun Heo 	bool wait = false;
254573f53c4aSTejun Heo 	unsigned int cpu;
25461da177e4SLinus Torvalds 
254773f53c4aSTejun Heo 	if (flush_color >= 0) {
254873f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
254973f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2550dc186ad7SThomas Gleixner 	}
255114441960SOleg Nesterov 
2552f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
255373f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2554bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
25551da177e4SLinus Torvalds 
25568b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
255773f53c4aSTejun Heo 
255873f53c4aSTejun Heo 		if (flush_color >= 0) {
255973f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
256073f53c4aSTejun Heo 
256173f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
256273f53c4aSTejun Heo 				cwq->flush_color = flush_color;
256373f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
256473f53c4aSTejun Heo 				wait = true;
25651da177e4SLinus Torvalds 			}
256673f53c4aSTejun Heo 		}
256773f53c4aSTejun Heo 
256873f53c4aSTejun Heo 		if (work_color >= 0) {
256973f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
257073f53c4aSTejun Heo 			cwq->work_color = work_color;
257173f53c4aSTejun Heo 		}
257273f53c4aSTejun Heo 
25738b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
25741da177e4SLinus Torvalds 	}
25751da177e4SLinus Torvalds 
257673f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
257773f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
257873f53c4aSTejun Heo 
257973f53c4aSTejun Heo 	return wait;
258083c22520SOleg Nesterov }
25811da177e4SLinus Torvalds 
25820fcb78c2SRolf Eike Beer /**
25831da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
25840fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
25851da177e4SLinus Torvalds  *
25861da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
25871da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
25881da177e4SLinus Torvalds  *
2589fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2590fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
25911da177e4SLinus Torvalds  */
25927ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
25931da177e4SLinus Torvalds {
259473f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
259573f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
259673f53c4aSTejun Heo 		.flush_color = -1,
259773f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
259873f53c4aSTejun Heo 	};
259973f53c4aSTejun Heo 	int next_color;
2600b1f4ec17SOleg Nesterov 
26013295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
26023295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
260373f53c4aSTejun Heo 
260473f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
260573f53c4aSTejun Heo 
260673f53c4aSTejun Heo 	/*
260773f53c4aSTejun Heo 	 * Start-to-wait phase
260873f53c4aSTejun Heo 	 */
260973f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
261073f53c4aSTejun Heo 
261173f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
261273f53c4aSTejun Heo 		/*
261373f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
261473f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
261573f53c4aSTejun Heo 		 * by one.
261673f53c4aSTejun Heo 		 */
261773f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
261873f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
261973f53c4aSTejun Heo 		wq->work_color = next_color;
262073f53c4aSTejun Heo 
262173f53c4aSTejun Heo 		if (!wq->first_flusher) {
262273f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
262373f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
262473f53c4aSTejun Heo 
262573f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
262673f53c4aSTejun Heo 
262773f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
262873f53c4aSTejun Heo 						       wq->work_color)) {
262973f53c4aSTejun Heo 				/* nothing to flush, done */
263073f53c4aSTejun Heo 				wq->flush_color = next_color;
263173f53c4aSTejun Heo 				wq->first_flusher = NULL;
263273f53c4aSTejun Heo 				goto out_unlock;
263373f53c4aSTejun Heo 			}
263473f53c4aSTejun Heo 		} else {
263573f53c4aSTejun Heo 			/* wait in queue */
263673f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
263773f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
263873f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
263973f53c4aSTejun Heo 		}
264073f53c4aSTejun Heo 	} else {
264173f53c4aSTejun Heo 		/*
264273f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
264373f53c4aSTejun Heo 		 * The next flush completion will assign us
264473f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
264573f53c4aSTejun Heo 		 */
264673f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
264773f53c4aSTejun Heo 	}
264873f53c4aSTejun Heo 
264973f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
265073f53c4aSTejun Heo 
265173f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
265273f53c4aSTejun Heo 
265373f53c4aSTejun Heo 	/*
265473f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
265573f53c4aSTejun Heo 	 *
265673f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
265773f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
265873f53c4aSTejun Heo 	 */
265973f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
266073f53c4aSTejun Heo 		return;
266173f53c4aSTejun Heo 
266273f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
266373f53c4aSTejun Heo 
26644ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26654ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26664ce48b37STejun Heo 		goto out_unlock;
26674ce48b37STejun Heo 
266873f53c4aSTejun Heo 	wq->first_flusher = NULL;
266973f53c4aSTejun Heo 
267073f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
267173f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
267273f53c4aSTejun Heo 
267373f53c4aSTejun Heo 	while (true) {
267473f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
267573f53c4aSTejun Heo 
267673f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
267773f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
267873f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
267973f53c4aSTejun Heo 				break;
268073f53c4aSTejun Heo 			list_del_init(&next->list);
268173f53c4aSTejun Heo 			complete(&next->done);
268273f53c4aSTejun Heo 		}
268373f53c4aSTejun Heo 
268473f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
268573f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
268673f53c4aSTejun Heo 
268773f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
268873f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
268973f53c4aSTejun Heo 
269073f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
269173f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
269273f53c4aSTejun Heo 			/*
269373f53c4aSTejun Heo 			 * Assign the same color to all overflowed
269473f53c4aSTejun Heo 			 * flushers, advance work_color and append to
269573f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
269673f53c4aSTejun Heo 			 * phase for these overflowed flushers.
269773f53c4aSTejun Heo 			 */
269873f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
269973f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
270073f53c4aSTejun Heo 
270173f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
270273f53c4aSTejun Heo 
270373f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
270473f53c4aSTejun Heo 					      &wq->flusher_queue);
270573f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
270673f53c4aSTejun Heo 		}
270773f53c4aSTejun Heo 
270873f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
270973f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
271073f53c4aSTejun Heo 			break;
271173f53c4aSTejun Heo 		}
271273f53c4aSTejun Heo 
271373f53c4aSTejun Heo 		/*
271473f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
271573f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
271673f53c4aSTejun Heo 		 */
271773f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
271873f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
271973f53c4aSTejun Heo 
272073f53c4aSTejun Heo 		list_del_init(&next->list);
272173f53c4aSTejun Heo 		wq->first_flusher = next;
272273f53c4aSTejun Heo 
272373f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
272473f53c4aSTejun Heo 			break;
272573f53c4aSTejun Heo 
272673f53c4aSTejun Heo 		/*
272773f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
272873f53c4aSTejun Heo 		 * flusher and repeat cascading.
272973f53c4aSTejun Heo 		 */
273073f53c4aSTejun Heo 		wq->first_flusher = NULL;
273173f53c4aSTejun Heo 	}
273273f53c4aSTejun Heo 
273373f53c4aSTejun Heo out_unlock:
273473f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
27351da177e4SLinus Torvalds }
2736ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27371da177e4SLinus Torvalds 
27389c5a2ba7STejun Heo /**
27399c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27409c5a2ba7STejun Heo  * @wq: workqueue to drain
27419c5a2ba7STejun Heo  *
27429c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27439c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27449c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27459c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27469c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27479c5a2ba7STejun Heo  * takes too long.
27489c5a2ba7STejun Heo  */
27499c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27509c5a2ba7STejun Heo {
27519c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
27529c5a2ba7STejun Heo 	unsigned int cpu;
27539c5a2ba7STejun Heo 
27549c5a2ba7STejun Heo 	/*
27559c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27569c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
27579c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
27589c5a2ba7STejun Heo 	 */
27599c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27609c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
27619c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
27629c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27639c5a2ba7STejun Heo reflush:
27649c5a2ba7STejun Heo 	flush_workqueue(wq);
27659c5a2ba7STejun Heo 
27669c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27679c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2768fa2563e4SThomas Tuttle 		bool drained;
27699c5a2ba7STejun Heo 
2770bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2771fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2772bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2773fa2563e4SThomas Tuttle 
2774fa2563e4SThomas Tuttle 		if (drained)
27759c5a2ba7STejun Heo 			continue;
27769c5a2ba7STejun Heo 
27779c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27789c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2779044c782cSValentin Ilie 			pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
27809c5a2ba7STejun Heo 				wq->name, flush_cnt);
27819c5a2ba7STejun Heo 		goto reflush;
27829c5a2ba7STejun Heo 	}
27839c5a2ba7STejun Heo 
27849c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27859c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
27869c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
27879c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27889c5a2ba7STejun Heo }
27899c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
27909c5a2ba7STejun Heo 
2791606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2792baf59022STejun Heo {
2793baf59022STejun Heo 	struct worker *worker = NULL;
2794baf59022STejun Heo 	struct global_cwq *gcwq;
2795baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2796baf59022STejun Heo 
2797baf59022STejun Heo 	might_sleep();
2798baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2799baf59022STejun Heo 	if (!gcwq)
2800baf59022STejun Heo 		return false;
2801baf59022STejun Heo 
2802baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2803baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2804baf59022STejun Heo 		/*
2805baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2806baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2807baf59022STejun Heo 		 * are not going to wait.
2808baf59022STejun Heo 		 */
2809baf59022STejun Heo 		smp_rmb();
2810baf59022STejun Heo 		cwq = get_work_cwq(work);
2811bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2812baf59022STejun Heo 			goto already_gone;
2813606a5020STejun Heo 	} else {
2814baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2815baf59022STejun Heo 		if (!worker)
2816baf59022STejun Heo 			goto already_gone;
2817baf59022STejun Heo 		cwq = worker->current_cwq;
2818606a5020STejun Heo 	}
2819baf59022STejun Heo 
2820baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2821baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2822baf59022STejun Heo 
2823e159489bSTejun Heo 	/*
2824e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2825e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2826e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2827e159489bSTejun Heo 	 * access.
2828e159489bSTejun Heo 	 */
2829e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2830baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2831e159489bSTejun Heo 	else
2832e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2833baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2834e159489bSTejun Heo 
2835baf59022STejun Heo 	return true;
2836baf59022STejun Heo already_gone:
2837baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2838baf59022STejun Heo 	return false;
2839baf59022STejun Heo }
2840baf59022STejun Heo 
2841db700897SOleg Nesterov /**
2842401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2843401a8d04STejun Heo  * @work: the work to flush
2844db700897SOleg Nesterov  *
2845606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2846606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2847401a8d04STejun Heo  *
2848401a8d04STejun Heo  * RETURNS:
2849401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2850401a8d04STejun Heo  * %false if it was already idle.
2851db700897SOleg Nesterov  */
2852401a8d04STejun Heo bool flush_work(struct work_struct *work)
2853db700897SOleg Nesterov {
2854db700897SOleg Nesterov 	struct wq_barrier barr;
2855db700897SOleg Nesterov 
28560976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28570976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28580976dfc1SStephen Boyd 
2859606a5020STejun Heo 	if (start_flush_work(work, &barr)) {
2860db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2861dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2862401a8d04STejun Heo 		return true;
2863606a5020STejun Heo 	} else {
2864401a8d04STejun Heo 		return false;
2865db700897SOleg Nesterov 	}
2866606a5020STejun Heo }
2867db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2868db700897SOleg Nesterov 
286936e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2870401a8d04STejun Heo {
2871bbb68dfaSTejun Heo 	unsigned long flags;
28721f1f642eSOleg Nesterov 	int ret;
28731f1f642eSOleg Nesterov 
28741f1f642eSOleg Nesterov 	do {
2875bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2876bbb68dfaSTejun Heo 		/*
2877bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2878bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2879bbb68dfaSTejun Heo 		 */
2880bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2881606a5020STejun Heo 			flush_work(work);
28821f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
28831f1f642eSOleg Nesterov 
2884bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2885bbb68dfaSTejun Heo 	mark_work_canceling(work);
2886bbb68dfaSTejun Heo 	local_irq_restore(flags);
2887bbb68dfaSTejun Heo 
2888606a5020STejun Heo 	flush_work(work);
28897a22ad75STejun Heo 	clear_work_data(work);
28901f1f642eSOleg Nesterov 	return ret;
28911f1f642eSOleg Nesterov }
28921f1f642eSOleg Nesterov 
28936e84d644SOleg Nesterov /**
2894401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2895401a8d04STejun Heo  * @work: the work to cancel
28966e84d644SOleg Nesterov  *
2897401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2898401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2899401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2900401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
29011f1f642eSOleg Nesterov  *
2902401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2903401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
29046e84d644SOleg Nesterov  *
2905401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
29066e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2907401a8d04STejun Heo  *
2908401a8d04STejun Heo  * RETURNS:
2909401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
29106e84d644SOleg Nesterov  */
2911401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29126e84d644SOleg Nesterov {
291336e227d2STejun Heo 	return __cancel_work_timer(work, false);
2914b89deed3SOleg Nesterov }
291528e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2916b89deed3SOleg Nesterov 
29176e84d644SOleg Nesterov /**
2918401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2919401a8d04STejun Heo  * @dwork: the delayed work to flush
29206e84d644SOleg Nesterov  *
2921401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2922401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2923401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29241f1f642eSOleg Nesterov  *
2925401a8d04STejun Heo  * RETURNS:
2926401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2927401a8d04STejun Heo  * %false if it was already idle.
29286e84d644SOleg Nesterov  */
2929401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2930401a8d04STejun Heo {
29318930cabaSTejun Heo 	local_irq_disable();
2932401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
29331265057fSTejun Heo 		__queue_work(dwork->cpu,
2934401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
29358930cabaSTejun Heo 	local_irq_enable();
2936401a8d04STejun Heo 	return flush_work(&dwork->work);
2937401a8d04STejun Heo }
2938401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2939401a8d04STejun Heo 
2940401a8d04STejun Heo /**
294157b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
294257b30ae7STejun Heo  * @dwork: delayed_work to cancel
294309383498STejun Heo  *
294457b30ae7STejun Heo  * Kill off a pending delayed_work.  Returns %true if @dwork was pending
294557b30ae7STejun Heo  * and canceled; %false if wasn't pending.  Note that the work callback
294657b30ae7STejun Heo  * function may still be running on return, unless it returns %true and the
294757b30ae7STejun Heo  * work doesn't re-arm itself.  Explicitly flush or use
294857b30ae7STejun Heo  * cancel_delayed_work_sync() to wait on it.
294909383498STejun Heo  *
295057b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
295109383498STejun Heo  */
295257b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
295309383498STejun Heo {
295457b30ae7STejun Heo 	unsigned long flags;
295557b30ae7STejun Heo 	int ret;
295657b30ae7STejun Heo 
295757b30ae7STejun Heo 	do {
295857b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
295957b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
296057b30ae7STejun Heo 
296157b30ae7STejun Heo 	if (unlikely(ret < 0))
296257b30ae7STejun Heo 		return false;
296357b30ae7STejun Heo 
296457b30ae7STejun Heo 	set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
296557b30ae7STejun Heo 	local_irq_restore(flags);
2966c0158ca6SDan Magenheimer 	return ret;
296709383498STejun Heo }
296857b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
296909383498STejun Heo 
297009383498STejun Heo /**
2971401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2972401a8d04STejun Heo  * @dwork: the delayed work cancel
2973401a8d04STejun Heo  *
2974401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2975401a8d04STejun Heo  *
2976401a8d04STejun Heo  * RETURNS:
2977401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2978401a8d04STejun Heo  */
2979401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
29806e84d644SOleg Nesterov {
298136e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
29826e84d644SOleg Nesterov }
2983f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
29841da177e4SLinus Torvalds 
29850fcb78c2SRolf Eike Beer /**
2986c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2987c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2988c1a220e7SZhang Rui  * @work: job to be done
2989c1a220e7SZhang Rui  *
2990c1a220e7SZhang Rui  * This puts a job on a specific cpu
2991c1a220e7SZhang Rui  */
2992d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work)
2993c1a220e7SZhang Rui {
2994d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2995c1a220e7SZhang Rui }
2996c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2997c1a220e7SZhang Rui 
29980fcb78c2SRolf Eike Beer /**
2999ae90dd5dSDave Jones  * schedule_work - put work task in global workqueue
30001da177e4SLinus Torvalds  * @work: job to be done
30011da177e4SLinus Torvalds  *
3002d4283e93STejun Heo  * Returns %false if @work was already on the kernel-global workqueue and
3003d4283e93STejun Heo  * %true otherwise.
300452bad64dSDavid Howells  *
30050fcb78c2SRolf Eike Beer  * This puts a job in the kernel-global workqueue if it was not already
30060fcb78c2SRolf Eike Beer  * queued and leaves it in the same position on the kernel-global
30070fcb78c2SRolf Eike Beer  * workqueue otherwise.
30081da177e4SLinus Torvalds  */
3009d4283e93STejun Heo bool schedule_work(struct work_struct *work)
30101da177e4SLinus Torvalds {
30110fcb78c2SRolf Eike Beer 	return queue_work(system_wq, work);
30121da177e4SLinus Torvalds }
30130fcb78c2SRolf Eike Beer EXPORT_SYMBOL(schedule_work);
30141da177e4SLinus Torvalds 
30150fcb78c2SRolf Eike Beer /**
30160fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
30170fcb78c2SRolf Eike Beer  * @cpu: cpu to use
30180fcb78c2SRolf Eike Beer  * @dwork: job to be done
30190fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
30200fcb78c2SRolf Eike Beer  *
30210fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
30220fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
30230fcb78c2SRolf Eike Beer  */
3024d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3025d4283e93STejun Heo 			      unsigned long delay)
30261da177e4SLinus Torvalds {
3027d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
30281da177e4SLinus Torvalds }
3029ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
30301da177e4SLinus Torvalds 
3031b6136773SAndrew Morton /**
30320a13c00eSTejun Heo  * schedule_delayed_work - put work task in global workqueue after delay
30330a13c00eSTejun Heo  * @dwork: job to be done
30340a13c00eSTejun Heo  * @delay: number of jiffies to wait or 0 for immediate execution
30350a13c00eSTejun Heo  *
30360a13c00eSTejun Heo  * After waiting for a given time this puts a job in the kernel-global
30370a13c00eSTejun Heo  * workqueue.
30380a13c00eSTejun Heo  */
3039d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
30400a13c00eSTejun Heo {
30410a13c00eSTejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
30420a13c00eSTejun Heo }
30430a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work);
30440a13c00eSTejun Heo 
30450a13c00eSTejun Heo /**
304631ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3047b6136773SAndrew Morton  * @func: the function to call
3048b6136773SAndrew Morton  *
304931ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
305031ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3051b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
305231ddd871STejun Heo  *
305331ddd871STejun Heo  * RETURNS:
305431ddd871STejun Heo  * 0 on success, -errno on failure.
3055b6136773SAndrew Morton  */
305665f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
305715316ba8SChristoph Lameter {
305815316ba8SChristoph Lameter 	int cpu;
305938f51568SNamhyung Kim 	struct work_struct __percpu *works;
306015316ba8SChristoph Lameter 
3061b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3062b6136773SAndrew Morton 	if (!works)
306315316ba8SChristoph Lameter 		return -ENOMEM;
3064b6136773SAndrew Morton 
306595402b38SGautham R Shenoy 	get_online_cpus();
306693981800STejun Heo 
306715316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
30689bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
30699bfb1839SIngo Molnar 
30709bfb1839SIngo Molnar 		INIT_WORK(work, func);
30718de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
307215316ba8SChristoph Lameter 	}
307393981800STejun Heo 
307493981800STejun Heo 	for_each_online_cpu(cpu)
30758616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
307693981800STejun Heo 
307795402b38SGautham R Shenoy 	put_online_cpus();
3078b6136773SAndrew Morton 	free_percpu(works);
307915316ba8SChristoph Lameter 	return 0;
308015316ba8SChristoph Lameter }
308115316ba8SChristoph Lameter 
3082eef6a7d5SAlan Stern /**
3083eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3084eef6a7d5SAlan Stern  *
3085eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3086eef6a7d5SAlan Stern  * completion.
3087eef6a7d5SAlan Stern  *
3088eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3089eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3090eef6a7d5SAlan Stern  * will lead to deadlock:
3091eef6a7d5SAlan Stern  *
3092eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3093eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3094eef6a7d5SAlan Stern  *
3095eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3096eef6a7d5SAlan Stern  *
3097eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3098eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3099eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3100eef6a7d5SAlan Stern  *
3101eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3102eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3103eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3104eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3105eef6a7d5SAlan Stern  */
31061da177e4SLinus Torvalds void flush_scheduled_work(void)
31071da177e4SLinus Torvalds {
3108d320c038STejun Heo 	flush_workqueue(system_wq);
31091da177e4SLinus Torvalds }
3110ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
31111da177e4SLinus Torvalds 
31121da177e4SLinus Torvalds /**
31131fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
31141fa44ecaSJames Bottomley  * @fn:		the function to execute
31151fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
31161fa44ecaSJames Bottomley  *		be available when the work executes)
31171fa44ecaSJames Bottomley  *
31181fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
31191fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
31201fa44ecaSJames Bottomley  *
31211fa44ecaSJames Bottomley  * Returns:	0 - function was executed
31221fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31231fa44ecaSJames Bottomley  */
312465f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31251fa44ecaSJames Bottomley {
31261fa44ecaSJames Bottomley 	if (!in_interrupt()) {
312765f27f38SDavid Howells 		fn(&ew->work);
31281fa44ecaSJames Bottomley 		return 0;
31291fa44ecaSJames Bottomley 	}
31301fa44ecaSJames Bottomley 
313165f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31321fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31331fa44ecaSJames Bottomley 
31341fa44ecaSJames Bottomley 	return 1;
31351fa44ecaSJames Bottomley }
31361fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31371fa44ecaSJames Bottomley 
31381da177e4SLinus Torvalds int keventd_up(void)
31391da177e4SLinus Torvalds {
3140d320c038STejun Heo 	return system_wq != NULL;
31411da177e4SLinus Torvalds }
31421da177e4SLinus Torvalds 
3143bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
31441da177e4SLinus Torvalds {
31453af24433SOleg Nesterov 	/*
31460f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
31470f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
31480f900049STejun Heo 	 * unsigned long long.
31493af24433SOleg Nesterov 	 */
31500f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
31510f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
31520f900049STejun Heo 				   __alignof__(unsigned long long));
31533af24433SOleg Nesterov 
3154e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3155f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3156931ac77eSTejun Heo 	else {
31570f900049STejun Heo 		void *ptr;
3158e1d8aa9fSFrederic Weisbecker 
31590f900049STejun Heo 		/*
3160f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3161f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3162f3421797STejun Heo 		 * allocated pointer which will be used for free.
31630f900049STejun Heo 		 */
3164bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3165bdbc5dd7STejun Heo 		if (ptr) {
3166bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3167bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3168bdbc5dd7STejun Heo 		}
31693af24433SOleg Nesterov 	}
31703af24433SOleg Nesterov 
31710415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3172bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3173bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
31740f900049STejun Heo }
31750f900049STejun Heo 
3176bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
317706ba38a9SOleg Nesterov {
3178e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3179bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3180f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3181f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3182f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
318306ba38a9SOleg Nesterov 	}
318406ba38a9SOleg Nesterov }
318506ba38a9SOleg Nesterov 
3186f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3187f3421797STejun Heo 			       const char *name)
3188b71ab8c2STejun Heo {
3189f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3190f3421797STejun Heo 
3191f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3192044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3193f3421797STejun Heo 			max_active, name, 1, lim);
3194b71ab8c2STejun Heo 
3195f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3196b71ab8c2STejun Heo }
3197b71ab8c2STejun Heo 
3198b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
319997e37d7bSTejun Heo 					       unsigned int flags,
32001e19ffc6STejun Heo 					       int max_active,
3201eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3202b196be89STejun Heo 					       const char *lock_name, ...)
32033af24433SOleg Nesterov {
3204b196be89STejun Heo 	va_list args, args1;
32053af24433SOleg Nesterov 	struct workqueue_struct *wq;
3206c34056a3STejun Heo 	unsigned int cpu;
3207b196be89STejun Heo 	size_t namelen;
3208b196be89STejun Heo 
3209b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3210b196be89STejun Heo 	va_start(args, lock_name);
3211b196be89STejun Heo 	va_copy(args1, args);
3212b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3213b196be89STejun Heo 
3214b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3215b196be89STejun Heo 	if (!wq)
3216b196be89STejun Heo 		goto err;
3217b196be89STejun Heo 
3218b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3219b196be89STejun Heo 	va_end(args);
3220b196be89STejun Heo 	va_end(args1);
32213af24433SOleg Nesterov 
3222f3421797STejun Heo 	/*
32236370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
32246370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
32256370a6adSTejun Heo 	 */
32266370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
32276370a6adSTejun Heo 		flags |= WQ_RESCUER;
32286370a6adSTejun Heo 
3229d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3230b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
32313af24433SOleg Nesterov 
3232b196be89STejun Heo 	/* init wq */
323397e37d7bSTejun Heo 	wq->flags = flags;
3234a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
323573f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
323673f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
323773f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
323873f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
32393af24433SOleg Nesterov 
3240eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3241cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
32423af24433SOleg Nesterov 
3243bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3244bdbc5dd7STejun Heo 		goto err;
3245bdbc5dd7STejun Heo 
3246f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
32471537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
32488b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
32493270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
32501537663fSTejun Heo 
32510f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
32523270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3253c34056a3STejun Heo 		cwq->wq = wq;
325473f53c4aSTejun Heo 		cwq->flush_color = -1;
32551e19ffc6STejun Heo 		cwq->max_active = max_active;
32561e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3257e22bee78STejun Heo 	}
32581537663fSTejun Heo 
3259e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3260e22bee78STejun Heo 		struct worker *rescuer;
3261e22bee78STejun Heo 
3262f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3263e22bee78STejun Heo 			goto err;
3264e22bee78STejun Heo 
3265e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3266e22bee78STejun Heo 		if (!rescuer)
3267e22bee78STejun Heo 			goto err;
3268e22bee78STejun Heo 
3269b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3270b196be89STejun Heo 					       wq->name);
3271e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3272e22bee78STejun Heo 			goto err;
3273e22bee78STejun Heo 
3274e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3275e22bee78STejun Heo 		wake_up_process(rescuer->task);
32763af24433SOleg Nesterov 	}
32771537663fSTejun Heo 
32783af24433SOleg Nesterov 	/*
3279a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3280a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3281a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
32823af24433SOleg Nesterov 	 */
32833af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3284a0a1a5fdSTejun Heo 
328558a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3286f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3287a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3288a0a1a5fdSTejun Heo 
32893af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3290a0a1a5fdSTejun Heo 
32913af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
32923af24433SOleg Nesterov 
32933af24433SOleg Nesterov 	return wq;
32944690c4abSTejun Heo err:
32954690c4abSTejun Heo 	if (wq) {
3296bdbc5dd7STejun Heo 		free_cwqs(wq);
3297f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3298e22bee78STejun Heo 		kfree(wq->rescuer);
32994690c4abSTejun Heo 		kfree(wq);
33003af24433SOleg Nesterov 	}
33014690c4abSTejun Heo 	return NULL;
33021da177e4SLinus Torvalds }
3303d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
33041da177e4SLinus Torvalds 
33053af24433SOleg Nesterov /**
33063af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
33073af24433SOleg Nesterov  * @wq: target workqueue
33083af24433SOleg Nesterov  *
33093af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
33103af24433SOleg Nesterov  */
33113af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
33123af24433SOleg Nesterov {
3313c8e55f36STejun Heo 	unsigned int cpu;
33143af24433SOleg Nesterov 
33159c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
33169c5a2ba7STejun Heo 	drain_workqueue(wq);
3317c8efcc25STejun Heo 
3318a0a1a5fdSTejun Heo 	/*
3319a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3320a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3321a0a1a5fdSTejun Heo 	 */
332295402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
33233af24433SOleg Nesterov 	list_del(&wq->list);
332495402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
33253af24433SOleg Nesterov 
3326e22bee78STejun Heo 	/* sanity check */
3327f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
332873f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
332973f53c4aSTejun Heo 		int i;
33303af24433SOleg Nesterov 
333173f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
333273f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
33331e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
33341e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
333573f53c4aSTejun Heo 	}
33361537663fSTejun Heo 
3337e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3338e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3339f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
33408d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3341e22bee78STejun Heo 	}
3342e22bee78STejun Heo 
3343bdbc5dd7STejun Heo 	free_cwqs(wq);
33443af24433SOleg Nesterov 	kfree(wq);
33453af24433SOleg Nesterov }
33463af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
33473af24433SOleg Nesterov 
3348dcd989cbSTejun Heo /**
33499f4bd4cdSLai Jiangshan  * cwq_set_max_active - adjust max_active of a cwq
33509f4bd4cdSLai Jiangshan  * @cwq: target cpu_workqueue_struct
33519f4bd4cdSLai Jiangshan  * @max_active: new max_active value.
33529f4bd4cdSLai Jiangshan  *
33539f4bd4cdSLai Jiangshan  * Set @cwq->max_active to @max_active and activate delayed works if
33549f4bd4cdSLai Jiangshan  * increased.
33559f4bd4cdSLai Jiangshan  *
33569f4bd4cdSLai Jiangshan  * CONTEXT:
33579f4bd4cdSLai Jiangshan  * spin_lock_irq(gcwq->lock).
33589f4bd4cdSLai Jiangshan  */
33599f4bd4cdSLai Jiangshan static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
33609f4bd4cdSLai Jiangshan {
33619f4bd4cdSLai Jiangshan 	cwq->max_active = max_active;
33629f4bd4cdSLai Jiangshan 
33639f4bd4cdSLai Jiangshan 	while (!list_empty(&cwq->delayed_works) &&
33649f4bd4cdSLai Jiangshan 	       cwq->nr_active < cwq->max_active)
33659f4bd4cdSLai Jiangshan 		cwq_activate_first_delayed(cwq);
33669f4bd4cdSLai Jiangshan }
33679f4bd4cdSLai Jiangshan 
33689f4bd4cdSLai Jiangshan /**
3369dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3370dcd989cbSTejun Heo  * @wq: target workqueue
3371dcd989cbSTejun Heo  * @max_active: new max_active value.
3372dcd989cbSTejun Heo  *
3373dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3374dcd989cbSTejun Heo  *
3375dcd989cbSTejun Heo  * CONTEXT:
3376dcd989cbSTejun Heo  * Don't call from IRQ context.
3377dcd989cbSTejun Heo  */
3378dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3379dcd989cbSTejun Heo {
3380dcd989cbSTejun Heo 	unsigned int cpu;
3381dcd989cbSTejun Heo 
3382f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3383dcd989cbSTejun Heo 
3384dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3385dcd989cbSTejun Heo 
3386dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3387dcd989cbSTejun Heo 
3388f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3389dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3390dcd989cbSTejun Heo 
3391dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3392dcd989cbSTejun Heo 
339358a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3394dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
339570369b11SLai Jiangshan 			cwq_set_max_active(get_cwq(gcwq->cpu, wq), max_active);
3396dcd989cbSTejun Heo 
3397dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3398dcd989cbSTejun Heo 	}
3399dcd989cbSTejun Heo 
3400dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3401dcd989cbSTejun Heo }
3402dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3403dcd989cbSTejun Heo 
3404dcd989cbSTejun Heo /**
3405dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3406dcd989cbSTejun Heo  * @cpu: CPU in question
3407dcd989cbSTejun Heo  * @wq: target workqueue
3408dcd989cbSTejun Heo  *
3409dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3410dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3411dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3412dcd989cbSTejun Heo  *
3413dcd989cbSTejun Heo  * RETURNS:
3414dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3415dcd989cbSTejun Heo  */
3416dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3417dcd989cbSTejun Heo {
3418dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3419dcd989cbSTejun Heo 
3420dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3421dcd989cbSTejun Heo }
3422dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3423dcd989cbSTejun Heo 
3424dcd989cbSTejun Heo /**
3425dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3426dcd989cbSTejun Heo  * @work: the work of interest
3427dcd989cbSTejun Heo  *
3428dcd989cbSTejun Heo  * RETURNS:
3429bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3430dcd989cbSTejun Heo  */
3431dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3432dcd989cbSTejun Heo {
3433dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3434dcd989cbSTejun Heo 
3435bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3436dcd989cbSTejun Heo }
3437dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3438dcd989cbSTejun Heo 
3439dcd989cbSTejun Heo /**
3440dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3441dcd989cbSTejun Heo  * @work: the work to be tested
3442dcd989cbSTejun Heo  *
3443dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3444dcd989cbSTejun Heo  * synchronization around this function and the test result is
3445dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3446dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3447dcd989cbSTejun Heo  * running state.
3448dcd989cbSTejun Heo  *
3449dcd989cbSTejun Heo  * RETURNS:
3450dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3451dcd989cbSTejun Heo  */
3452dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3453dcd989cbSTejun Heo {
3454dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3455dcd989cbSTejun Heo 	unsigned long flags;
3456dcd989cbSTejun Heo 	unsigned int ret = 0;
3457dcd989cbSTejun Heo 
3458dcd989cbSTejun Heo 	if (!gcwq)
3459999767beSJoonsoo Kim 		return 0;
3460dcd989cbSTejun Heo 
3461dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3462dcd989cbSTejun Heo 
3463dcd989cbSTejun Heo 	if (work_pending(work))
3464dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3465dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3466dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3467dcd989cbSTejun Heo 
3468dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3469dcd989cbSTejun Heo 
3470dcd989cbSTejun Heo 	return ret;
3471dcd989cbSTejun Heo }
3472dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3473dcd989cbSTejun Heo 
3474db7bccf4STejun Heo /*
3475db7bccf4STejun Heo  * CPU hotplug.
3476db7bccf4STejun Heo  *
3477e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3478e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3479e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3480e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3481e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3482e22bee78STejun Heo  * blocked draining impractical.
3483e22bee78STejun Heo  *
3484628c78e7STejun Heo  * This is solved by allowing a gcwq to be disassociated from the CPU
3485628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
3486628c78e7STejun Heo  * cpu comes back online.
3487db7bccf4STejun Heo  */
3488db7bccf4STejun Heo 
348960373152STejun Heo /* claim manager positions of all pools */
3490b2eb83d1SLai Jiangshan static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
349160373152STejun Heo {
349260373152STejun Heo 	struct worker_pool *pool;
349360373152STejun Heo 
349460373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3495b2eb83d1SLai Jiangshan 		mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
34968db25e78STejun Heo 	spin_lock_irq(&gcwq->lock);
349760373152STejun Heo }
349860373152STejun Heo 
349960373152STejun Heo /* release manager positions */
3500b2eb83d1SLai Jiangshan static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
350160373152STejun Heo {
350260373152STejun Heo 	struct worker_pool *pool;
350360373152STejun Heo 
35048db25e78STejun Heo 	spin_unlock_irq(&gcwq->lock);
350560373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3506b2eb83d1SLai Jiangshan 		mutex_unlock(&pool->assoc_mutex);
350760373152STejun Heo }
350860373152STejun Heo 
3509628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work)
3510db7bccf4STejun Heo {
3511628c78e7STejun Heo 	struct global_cwq *gcwq = get_gcwq(smp_processor_id());
35124ce62e9eSTejun Heo 	struct worker_pool *pool;
3513db7bccf4STejun Heo 	struct worker *worker;
3514db7bccf4STejun Heo 	struct hlist_node *pos;
3515db7bccf4STejun Heo 	int i;
3516db7bccf4STejun Heo 
3517db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3518db7bccf4STejun Heo 
3519b2eb83d1SLai Jiangshan 	gcwq_claim_assoc_and_lock(gcwq);
3520e22bee78STejun Heo 
3521f2d5a0eeSTejun Heo 	/*
3522f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3523f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3524f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3525f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3526f2d5a0eeSTejun Heo 	 */
352760373152STejun Heo 	for_each_worker_pool(pool, gcwq)
35284ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3529403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3530db7bccf4STejun Heo 
3531db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3532403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3533db7bccf4STejun Heo 
3534f2d5a0eeSTejun Heo 	gcwq->flags |= GCWQ_DISASSOCIATED;
3535f2d5a0eeSTejun Heo 
3536b2eb83d1SLai Jiangshan 	gcwq_release_assoc_and_unlock(gcwq);
3537e22bee78STejun Heo 
3538e22bee78STejun Heo 	/*
3539628c78e7STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3540628c78e7STejun Heo 	 * sched callbacks see the %WORKER_UNBOUND flag.  This is necessary
3541628c78e7STejun Heo 	 * as scheduler callbacks may be invoked from other cpus.
3542628c78e7STejun Heo 	 */
3543628c78e7STejun Heo 	schedule();
3544628c78e7STejun Heo 
3545628c78e7STejun Heo 	/*
3546628c78e7STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After this,
3547628c78e7STejun Heo 	 * nr_running stays zero and need_more_worker() and keep_working()
3548628c78e7STejun Heo 	 * are always true as long as the worklist is not empty.  @gcwq now
3549628c78e7STejun Heo 	 * behaves as unbound (in terms of concurrency management) gcwq
3550628c78e7STejun Heo 	 * which is served by workers tied to the CPU.
3551628c78e7STejun Heo 	 *
3552628c78e7STejun Heo 	 * On return from this function, the current worker would trigger
3553628c78e7STejun Heo 	 * unbound chain execution of pending work items if other workers
3554628c78e7STejun Heo 	 * didn't already.
3555e22bee78STejun Heo 	 */
35564ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35574ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3558db7bccf4STejun Heo }
3559db7bccf4STejun Heo 
35608db25e78STejun Heo /*
35618db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
35628db25e78STejun Heo  * This will be registered high priority CPU notifier.
35638db25e78STejun Heo  */
35649fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
35651da177e4SLinus Torvalds 					       unsigned long action,
35661da177e4SLinus Torvalds 					       void *hcpu)
35671da177e4SLinus Torvalds {
35683af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3569db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
35704ce62e9eSTejun Heo 	struct worker_pool *pool;
35711da177e4SLinus Torvalds 
35728db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
35733af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35744ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35753ce63377STejun Heo 			struct worker *worker;
35763ce63377STejun Heo 
35773ce63377STejun Heo 			if (pool->nr_workers)
35783ce63377STejun Heo 				continue;
35793ce63377STejun Heo 
35803ce63377STejun Heo 			worker = create_worker(pool);
35813ce63377STejun Heo 			if (!worker)
35823ce63377STejun Heo 				return NOTIFY_BAD;
35833ce63377STejun Heo 
35843ce63377STejun Heo 			spin_lock_irq(&gcwq->lock);
35853ce63377STejun Heo 			start_worker(worker);
35863ce63377STejun Heo 			spin_unlock_irq(&gcwq->lock);
35873af24433SOleg Nesterov 		}
35881da177e4SLinus Torvalds 		break;
35891da177e4SLinus Torvalds 
359065758202STejun Heo 	case CPU_DOWN_FAILED:
359165758202STejun Heo 	case CPU_ONLINE:
3592b2eb83d1SLai Jiangshan 		gcwq_claim_assoc_and_lock(gcwq);
35938db25e78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
35948db25e78STejun Heo 		rebind_workers(gcwq);
3595b2eb83d1SLai Jiangshan 		gcwq_release_assoc_and_unlock(gcwq);
35968db25e78STejun Heo 		break;
359765758202STejun Heo 	}
359865758202STejun Heo 	return NOTIFY_OK;
359965758202STejun Heo }
360065758202STejun Heo 
360165758202STejun Heo /*
360265758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
360365758202STejun Heo  * This will be registered as low priority CPU notifier.
360465758202STejun Heo  */
36059fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
360665758202STejun Heo 						 unsigned long action,
360765758202STejun Heo 						 void *hcpu)
360865758202STejun Heo {
36098db25e78STejun Heo 	unsigned int cpu = (unsigned long)hcpu;
36108db25e78STejun Heo 	struct work_struct unbind_work;
36118db25e78STejun Heo 
361265758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
361365758202STejun Heo 	case CPU_DOWN_PREPARE:
36148db25e78STejun Heo 		/* unbinding should happen on the local CPU */
36158db25e78STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
36167635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
36178db25e78STejun Heo 		flush_work(&unbind_work);
36188db25e78STejun Heo 		break;
361965758202STejun Heo 	}
362065758202STejun Heo 	return NOTIFY_OK;
362165758202STejun Heo }
362265758202STejun Heo 
36232d3854a3SRusty Russell #ifdef CONFIG_SMP
36248ccad40dSRusty Russell 
36252d3854a3SRusty Russell struct work_for_cpu {
3626ed48ece2STejun Heo 	struct work_struct work;
36272d3854a3SRusty Russell 	long (*fn)(void *);
36282d3854a3SRusty Russell 	void *arg;
36292d3854a3SRusty Russell 	long ret;
36302d3854a3SRusty Russell };
36312d3854a3SRusty Russell 
3632ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
36332d3854a3SRusty Russell {
3634ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3635ed48ece2STejun Heo 
36362d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36372d3854a3SRusty Russell }
36382d3854a3SRusty Russell 
36392d3854a3SRusty Russell /**
36402d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36412d3854a3SRusty Russell  * @cpu: the cpu to run on
36422d3854a3SRusty Russell  * @fn: the function to run
36432d3854a3SRusty Russell  * @arg: the function arg
36442d3854a3SRusty Russell  *
364531ad9081SRusty Russell  * This will return the value @fn returns.
364631ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36476b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36482d3854a3SRusty Russell  */
36492d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36502d3854a3SRusty Russell {
3651ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
36522d3854a3SRusty Russell 
3653ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3654ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
3655ed48ece2STejun Heo 	flush_work(&wfc.work);
36562d3854a3SRusty Russell 	return wfc.ret;
36572d3854a3SRusty Russell }
36582d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36592d3854a3SRusty Russell #endif /* CONFIG_SMP */
36602d3854a3SRusty Russell 
3661a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3662e7577c50SRusty Russell 
3663a0a1a5fdSTejun Heo /**
3664a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3665a0a1a5fdSTejun Heo  *
366658a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
366758a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
366858a69cb4STejun Heo  * gcwq->worklist.
3669a0a1a5fdSTejun Heo  *
3670a0a1a5fdSTejun Heo  * CONTEXT:
36718b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3672a0a1a5fdSTejun Heo  */
3673a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3674a0a1a5fdSTejun Heo {
3675a0a1a5fdSTejun Heo 	unsigned int cpu;
3676a0a1a5fdSTejun Heo 
3677a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3678a0a1a5fdSTejun Heo 
3679a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3680a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3681a0a1a5fdSTejun Heo 
3682f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
36838b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3684bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
36858b03ae3cSTejun Heo 
36868b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
36878b03ae3cSTejun Heo 
3688db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3689db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3690db7bccf4STejun Heo 
3691a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3692a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3693a0a1a5fdSTejun Heo 
369458a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3695a0a1a5fdSTejun Heo 				cwq->max_active = 0;
36961da177e4SLinus Torvalds 		}
36978b03ae3cSTejun Heo 
36988b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3699a0a1a5fdSTejun Heo 	}
3700a0a1a5fdSTejun Heo 
3701a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3702a0a1a5fdSTejun Heo }
3703a0a1a5fdSTejun Heo 
3704a0a1a5fdSTejun Heo /**
370558a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3706a0a1a5fdSTejun Heo  *
3707a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3708a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3709a0a1a5fdSTejun Heo  *
3710a0a1a5fdSTejun Heo  * CONTEXT:
3711a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3712a0a1a5fdSTejun Heo  *
3713a0a1a5fdSTejun Heo  * RETURNS:
371458a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
371558a69cb4STejun Heo  * is complete.
3716a0a1a5fdSTejun Heo  */
3717a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3718a0a1a5fdSTejun Heo {
3719a0a1a5fdSTejun Heo 	unsigned int cpu;
3720a0a1a5fdSTejun Heo 	bool busy = false;
3721a0a1a5fdSTejun Heo 
3722a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3723a0a1a5fdSTejun Heo 
3724a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3725a0a1a5fdSTejun Heo 
3726f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3727bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3728a0a1a5fdSTejun Heo 		/*
3729a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3730a0a1a5fdSTejun Heo 		 * to peek without lock.
3731a0a1a5fdSTejun Heo 		 */
3732a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3733a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3734a0a1a5fdSTejun Heo 
373558a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3736a0a1a5fdSTejun Heo 				continue;
3737a0a1a5fdSTejun Heo 
3738a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3739a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3740a0a1a5fdSTejun Heo 				busy = true;
3741a0a1a5fdSTejun Heo 				goto out_unlock;
3742a0a1a5fdSTejun Heo 			}
3743a0a1a5fdSTejun Heo 		}
3744a0a1a5fdSTejun Heo 	}
3745a0a1a5fdSTejun Heo out_unlock:
3746a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3747a0a1a5fdSTejun Heo 	return busy;
3748a0a1a5fdSTejun Heo }
3749a0a1a5fdSTejun Heo 
3750a0a1a5fdSTejun Heo /**
3751a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3752a0a1a5fdSTejun Heo  *
3753a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
37547e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3755a0a1a5fdSTejun Heo  *
3756a0a1a5fdSTejun Heo  * CONTEXT:
37578b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3758a0a1a5fdSTejun Heo  */
3759a0a1a5fdSTejun Heo void thaw_workqueues(void)
3760a0a1a5fdSTejun Heo {
3761a0a1a5fdSTejun Heo 	unsigned int cpu;
3762a0a1a5fdSTejun Heo 
3763a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3764a0a1a5fdSTejun Heo 
3765a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3766a0a1a5fdSTejun Heo 		goto out_unlock;
3767a0a1a5fdSTejun Heo 
3768f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37698b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
37704ce62e9eSTejun Heo 		struct worker_pool *pool;
3771bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37728b03ae3cSTejun Heo 
37738b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37748b03ae3cSTejun Heo 
3775db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3776db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3777db7bccf4STejun Heo 
3778a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3779a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3780a0a1a5fdSTejun Heo 
378158a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3782a0a1a5fdSTejun Heo 				continue;
3783a0a1a5fdSTejun Heo 
3784a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
37859f4bd4cdSLai Jiangshan 			cwq_set_max_active(cwq, wq->saved_max_active);
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;
3803c34056a3STejun Heo 
3804b5490077STejun Heo 	/* make sure we have enough bits for OFFQ CPU number */
3805b5490077STejun Heo 	BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3806b5490077STejun Heo 		     WORK_CPU_LAST);
3807b5490077STejun Heo 
380865758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3809a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
38108b03ae3cSTejun Heo 
38118b03ae3cSTejun Heo 	/* initialize gcwqs */
3812f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38138b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38144ce62e9eSTejun Heo 		struct worker_pool *pool;
38158b03ae3cSTejun Heo 
38168b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
38178b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3818f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
38198b03ae3cSTejun Heo 
382042f8570fSSasha Levin 		hash_init(gcwq->busy_hash);
3821c8e55f36STejun Heo 
38224ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38234ce62e9eSTejun Heo 			pool->gcwq = gcwq;
38244ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38254ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3826e22bee78STejun Heo 
38274ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38284ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38294ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3830e22bee78STejun Heo 
38314ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38324ce62e9eSTejun Heo 				    (unsigned long)pool);
38334ce62e9eSTejun Heo 
3834b2eb83d1SLai Jiangshan 			mutex_init(&pool->assoc_mutex);
38354ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38364ce62e9eSTejun Heo 		}
38378b03ae3cSTejun Heo 	}
38388b03ae3cSTejun Heo 
3839e22bee78STejun Heo 	/* create the initial worker */
3840f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3841e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38424ce62e9eSTejun Heo 		struct worker_pool *pool;
3843e22bee78STejun Heo 
3844477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3845477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
38464ce62e9eSTejun Heo 
38474ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38484ce62e9eSTejun Heo 			struct worker *worker;
38494ce62e9eSTejun Heo 
3850bc2ae0f5STejun Heo 			worker = create_worker(pool);
3851e22bee78STejun Heo 			BUG_ON(!worker);
3852e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3853e22bee78STejun Heo 			start_worker(worker);
3854e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3855e22bee78STejun Heo 		}
38564ce62e9eSTejun Heo 	}
3857e22bee78STejun Heo 
3858d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
38591aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
3860d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3861f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3862f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
386324d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
386424d51addSTejun Heo 					      WQ_FREEZABLE, 0);
38651aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
3866ae930e0fSTejun Heo 	       !system_unbound_wq || !system_freezable_wq);
38676ee0578bSSuresh Siddha 	return 0;
38681da177e4SLinus Torvalds }
38696ee0578bSSuresh Siddha early_initcall(init_workqueues);
3870