xref: /linux-6.15/kernel/workqueue.c (revision 42f8570f)
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>
44*42f8570fSSasha 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 */
1408cca0eeaSTejun Heo 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
141affee4b2STejun Heo 	struct list_head	scheduled;	/* L: scheduled works */
142c34056a3STejun Heo 	struct task_struct	*task;		/* I: worker task */
143bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
144e22bee78STejun Heo 	/* 64 bytes boundary on 64bit, 32 on 32bit */
145e22bee78STejun Heo 	unsigned long		last_active;	/* L: last active timestamp */
146e22bee78STejun Heo 	unsigned int		flags;		/* X: flags */
147c34056a3STejun Heo 	int			id;		/* I: worker id */
14825511a47STejun Heo 
14925511a47STejun Heo 	/* for rebinding worker to CPU */
15025511a47STejun Heo 	struct work_struct	rebind_work;	/* L: for busy worker */
151c34056a3STejun Heo };
152c34056a3STejun Heo 
153bd7bdd43STejun Heo struct worker_pool {
154bd7bdd43STejun Heo 	struct global_cwq	*gcwq;		/* I: the owning gcwq */
15511ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
156bd7bdd43STejun Heo 
157bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
158bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
159ea1abd61SLai Jiangshan 
160ea1abd61SLai Jiangshan 	/* nr_idle includes the ones off idle_list for rebinding */
161bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
162bd7bdd43STejun Heo 
163bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
164bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
165bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
166bd7bdd43STejun Heo 
167b2eb83d1SLai Jiangshan 	struct mutex		assoc_mutex;	/* protect GCWQ_DISASSOCIATED */
168bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
169bd7bdd43STejun Heo };
170bd7bdd43STejun Heo 
1714690c4abSTejun Heo /*
172e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
173e22bee78STejun Heo  * and all works are queued and processed here regardless of their
174e22bee78STejun Heo  * target workqueues.
1758b03ae3cSTejun Heo  */
1768b03ae3cSTejun Heo struct global_cwq {
1778b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1788b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
179db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
180c8e55f36STejun Heo 
181bd7bdd43STejun Heo 	/* workers are chained either in busy_hash or pool idle_list */
182*42f8570fSSasha Levin 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
183c8e55f36STejun Heo 						/* L: hash of busy workers */
184c8e55f36STejun Heo 
185330dad5bSJoonsoo Kim 	struct worker_pool	pools[NR_WORKER_POOLS];
186330dad5bSJoonsoo Kim 						/* normal and highpri pools */
1878b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1888b03ae3cSTejun Heo 
1898b03ae3cSTejun Heo /*
190502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1910f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1920f900049STejun Heo  * aligned at two's power of the number of flag bits.
1931da177e4SLinus Torvalds  */
1941da177e4SLinus Torvalds struct cpu_workqueue_struct {
195bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1964690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
19773f53c4aSTejun Heo 	int			work_color;	/* L: current color */
19873f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
19973f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
20073f53c4aSTejun Heo 						/* L: nr of in_flight works */
2011e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
202a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
2031e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
2040f900049STejun Heo };
2051da177e4SLinus Torvalds 
2061da177e4SLinus Torvalds /*
20773f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
20873f53c4aSTejun Heo  */
20973f53c4aSTejun Heo struct wq_flusher {
21073f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
21173f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
21273f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
21373f53c4aSTejun Heo };
2141da177e4SLinus Torvalds 
21573f53c4aSTejun Heo /*
216f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
217f2e005aaSTejun Heo  * used to determine whether there's something to be done.
218f2e005aaSTejun Heo  */
219f2e005aaSTejun Heo #ifdef CONFIG_SMP
220f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
221f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
222f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
223f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
224f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2259c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
226f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
227f2e005aaSTejun Heo #else
228f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
229f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
230f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
231f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
232f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
233f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
234f2e005aaSTejun Heo #endif
2351da177e4SLinus Torvalds 
2361da177e4SLinus Torvalds /*
2371da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2381da177e4SLinus Torvalds  * per-CPU workqueues:
2391da177e4SLinus Torvalds  */
2401da177e4SLinus Torvalds struct workqueue_struct {
2419c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
242bdbc5dd7STejun Heo 	union {
243bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
244bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
245bdbc5dd7STejun Heo 		unsigned long				v;
246bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2474690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
24873f53c4aSTejun Heo 
24973f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
25073f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
25173f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
25273f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
25373f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
25473f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
25573f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
25673f53c4aSTejun Heo 
257f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
258e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
259e22bee78STejun Heo 
2609c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
261dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2624e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2634e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2644e6045f1SJohannes Berg #endif
265b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2661da177e4SLinus Torvalds };
2671da177e4SLinus Torvalds 
268d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
269d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
270044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
2711aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
272044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
273d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
274044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
275f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
276044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
27724d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
278d320c038STejun Heo 
27997bd2347STejun Heo #define CREATE_TRACE_POINTS
28097bd2347STejun Heo #include <trace/events/workqueue.h>
28197bd2347STejun Heo 
2824ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
2833270476aSTejun Heo 	for ((pool) = &(gcwq)->pools[0];				\
2843270476aSTejun Heo 	     (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
2854ce62e9eSTejun Heo 
286db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
287*42f8570fSSasha Levin 	hash_for_each(gcwq->busy_hash, i, pos, worker, hentry)
288db7bccf4STejun Heo 
289f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
290f3421797STejun Heo 				  unsigned int sw)
291f3421797STejun Heo {
292f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
293f3421797STejun Heo 		if (sw & 1) {
294f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
295f3421797STejun Heo 			if (cpu < nr_cpu_ids)
296f3421797STejun Heo 				return cpu;
297f3421797STejun Heo 		}
298f3421797STejun Heo 		if (sw & 2)
299f3421797STejun Heo 			return WORK_CPU_UNBOUND;
300f3421797STejun Heo 	}
301f3421797STejun Heo 	return WORK_CPU_NONE;
302f3421797STejun Heo }
303f3421797STejun Heo 
304f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
305f3421797STejun Heo 				struct workqueue_struct *wq)
306f3421797STejun Heo {
307f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
308f3421797STejun Heo }
309f3421797STejun Heo 
31009884951STejun Heo /*
31109884951STejun Heo  * CPU iterators
31209884951STejun Heo  *
31309884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
31409884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
31509884951STejun Heo  * specific CPU.  The following iterators are similar to
31609884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
31709884951STejun Heo  *
31809884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
31909884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
32009884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
32109884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
32209884951STejun Heo  */
323f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
324f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
325f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
326f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
327f3421797STejun Heo 
328f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
329f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
330f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
331f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
332f3421797STejun Heo 
333f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
334f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
335f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
336f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
337f3421797STejun Heo 
338dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
339dc186ad7SThomas Gleixner 
340dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
341dc186ad7SThomas Gleixner 
34299777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
34399777288SStanislaw Gruszka {
34499777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
34599777288SStanislaw Gruszka }
34699777288SStanislaw Gruszka 
347dc186ad7SThomas Gleixner /*
348dc186ad7SThomas Gleixner  * fixup_init is called when:
349dc186ad7SThomas Gleixner  * - an active object is initialized
350dc186ad7SThomas Gleixner  */
351dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
352dc186ad7SThomas Gleixner {
353dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
354dc186ad7SThomas Gleixner 
355dc186ad7SThomas Gleixner 	switch (state) {
356dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
357dc186ad7SThomas Gleixner 		cancel_work_sync(work);
358dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
359dc186ad7SThomas Gleixner 		return 1;
360dc186ad7SThomas Gleixner 	default:
361dc186ad7SThomas Gleixner 		return 0;
362dc186ad7SThomas Gleixner 	}
363dc186ad7SThomas Gleixner }
364dc186ad7SThomas Gleixner 
365dc186ad7SThomas Gleixner /*
366dc186ad7SThomas Gleixner  * fixup_activate is called when:
367dc186ad7SThomas Gleixner  * - an active object is activated
368dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
369dc186ad7SThomas Gleixner  */
370dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
371dc186ad7SThomas Gleixner {
372dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
373dc186ad7SThomas Gleixner 
374dc186ad7SThomas Gleixner 	switch (state) {
375dc186ad7SThomas Gleixner 
376dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
377dc186ad7SThomas Gleixner 		/*
378dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
379dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
380dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
381dc186ad7SThomas Gleixner 		 */
38222df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
383dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
384dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
385dc186ad7SThomas Gleixner 			return 0;
386dc186ad7SThomas Gleixner 		}
387dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
388dc186ad7SThomas Gleixner 		return 0;
389dc186ad7SThomas Gleixner 
390dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
391dc186ad7SThomas Gleixner 		WARN_ON(1);
392dc186ad7SThomas Gleixner 
393dc186ad7SThomas Gleixner 	default:
394dc186ad7SThomas Gleixner 		return 0;
395dc186ad7SThomas Gleixner 	}
396dc186ad7SThomas Gleixner }
397dc186ad7SThomas Gleixner 
398dc186ad7SThomas Gleixner /*
399dc186ad7SThomas Gleixner  * fixup_free is called when:
400dc186ad7SThomas Gleixner  * - an active object is freed
401dc186ad7SThomas Gleixner  */
402dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
403dc186ad7SThomas Gleixner {
404dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
405dc186ad7SThomas Gleixner 
406dc186ad7SThomas Gleixner 	switch (state) {
407dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
408dc186ad7SThomas Gleixner 		cancel_work_sync(work);
409dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
410dc186ad7SThomas Gleixner 		return 1;
411dc186ad7SThomas Gleixner 	default:
412dc186ad7SThomas Gleixner 		return 0;
413dc186ad7SThomas Gleixner 	}
414dc186ad7SThomas Gleixner }
415dc186ad7SThomas Gleixner 
416dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
417dc186ad7SThomas Gleixner 	.name		= "work_struct",
41899777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
419dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
420dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
421dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
422dc186ad7SThomas Gleixner };
423dc186ad7SThomas Gleixner 
424dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
425dc186ad7SThomas Gleixner {
426dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
427dc186ad7SThomas Gleixner }
428dc186ad7SThomas Gleixner 
429dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
430dc186ad7SThomas Gleixner {
431dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
432dc186ad7SThomas Gleixner }
433dc186ad7SThomas Gleixner 
434dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
435dc186ad7SThomas Gleixner {
436dc186ad7SThomas Gleixner 	if (onstack)
437dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
438dc186ad7SThomas Gleixner 	else
439dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
440dc186ad7SThomas Gleixner }
441dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
442dc186ad7SThomas Gleixner 
443dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
444dc186ad7SThomas Gleixner {
445dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
446dc186ad7SThomas Gleixner }
447dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
448dc186ad7SThomas Gleixner 
449dc186ad7SThomas Gleixner #else
450dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
451dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
452dc186ad7SThomas Gleixner #endif
453dc186ad7SThomas Gleixner 
45495402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
45595402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4561da177e4SLinus Torvalds static LIST_HEAD(workqueues);
457a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4581da177e4SLinus Torvalds 
45914441960SOleg Nesterov /*
460e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
461e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
462e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
46314441960SOleg Nesterov  */
4648b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
4654ce62e9eSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
466f756d5e2SNathan Lynch 
467f3421797STejun Heo /*
468f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
469f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
470f3421797STejun Heo  * workers have WORKER_UNBOUND set.
471f3421797STejun Heo  */
472f3421797STejun Heo static struct global_cwq unbound_global_cwq;
4734ce62e9eSTejun Heo static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
4744ce62e9eSTejun Heo 	[0 ... NR_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4754ce62e9eSTejun Heo };
476f3421797STejun Heo 
477c34056a3STejun Heo static int worker_thread(void *__worker);
4781da177e4SLinus Torvalds 
4793270476aSTejun Heo static int worker_pool_pri(struct worker_pool *pool)
4803270476aSTejun Heo {
4813270476aSTejun Heo 	return pool - pool->gcwq->pools;
4823270476aSTejun Heo }
4833270476aSTejun Heo 
4848b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4851da177e4SLinus Torvalds {
486f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4878b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
488f3421797STejun Heo 	else
489f3421797STejun Heo 		return &unbound_global_cwq;
4901da177e4SLinus Torvalds }
4911da177e4SLinus Torvalds 
49263d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
493b1f4ec17SOleg Nesterov {
49463d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
4953270476aSTejun Heo 	int idx = worker_pool_pri(pool);
49663d95a91STejun Heo 
497f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4984ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
499f3421797STejun Heo 	else
5004ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
501b1f4ec17SOleg Nesterov }
502b1f4ec17SOleg Nesterov 
5034690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
5044690c4abSTejun Heo 					    struct workqueue_struct *wq)
505a848e3b6SOleg Nesterov {
506f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
507e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
508bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
509f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
510f3421797STejun Heo 		return wq->cpu_wq.single;
511f3421797STejun Heo 	return NULL;
512f3421797STejun Heo }
513a848e3b6SOleg Nesterov 
51473f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
51573f53c4aSTejun Heo {
51673f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
51773f53c4aSTejun Heo }
51873f53c4aSTejun Heo 
51973f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
52073f53c4aSTejun Heo {
52173f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
52273f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
52373f53c4aSTejun Heo }
52473f53c4aSTejun Heo 
52573f53c4aSTejun Heo static int work_next_color(int color)
52673f53c4aSTejun Heo {
52773f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5281da177e4SLinus Torvalds }
5291da177e4SLinus Torvalds 
5304594bf15SDavid Howells /*
531b5490077STejun Heo  * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
532b5490077STejun Heo  * contain the pointer to the queued cwq.  Once execution starts, the flag
533b5490077STejun Heo  * is cleared and the high bits contain OFFQ flags and CPU number.
5347a22ad75STejun Heo  *
535bbb68dfaSTejun Heo  * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
536bbb68dfaSTejun Heo  * and clear_work_data() can be used to set the cwq, cpu or clear
537bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
538bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5397a22ad75STejun Heo  *
540bbb68dfaSTejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
541bbb68dfaSTejun Heo  * a work.  gcwq is available once the work has been queued anywhere after
542bbb68dfaSTejun Heo  * initialization until it is sync canceled.  cwq is available only while
543bbb68dfaSTejun Heo  * the work item is queued.
544bbb68dfaSTejun Heo  *
545bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
546bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
547bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
548bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5494594bf15SDavid Howells  */
5507a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5517a22ad75STejun Heo 				 unsigned long flags)
5527a22ad75STejun Heo {
5537a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5547a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5557a22ad75STejun Heo }
5567a22ad75STejun Heo 
5577a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5584690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5594690c4abSTejun Heo 			 unsigned long extra_flags)
560365970a1SDavid Howells {
5617a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
562e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
563365970a1SDavid Howells }
564365970a1SDavid Howells 
5658930cabaSTejun Heo static void set_work_cpu_and_clear_pending(struct work_struct *work,
5668930cabaSTejun Heo 					   unsigned int cpu)
5674d707b9fSOleg Nesterov {
56823657bb1STejun Heo 	/*
56923657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
57023657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
57123657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
57223657bb1STejun Heo 	 * owner.
57323657bb1STejun Heo 	 */
57423657bb1STejun Heo 	smp_wmb();
575b5490077STejun Heo 	set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
5764d707b9fSOleg Nesterov }
5774d707b9fSOleg Nesterov 
5787a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
579365970a1SDavid Howells {
58023657bb1STejun Heo 	smp_wmb();	/* see set_work_cpu_and_clear_pending() */
5817a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5827a22ad75STejun Heo }
5837a22ad75STejun Heo 
5847a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5857a22ad75STejun Heo {
586e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5877a22ad75STejun Heo 
588e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
589e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
590e120153dSTejun Heo 	else
591e120153dSTejun Heo 		return NULL;
5927a22ad75STejun Heo }
5937a22ad75STejun Heo 
5947a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5957a22ad75STejun Heo {
596e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5977a22ad75STejun Heo 	unsigned int cpu;
5987a22ad75STejun Heo 
599e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
600e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
601bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
6027a22ad75STejun Heo 
603b5490077STejun Heo 	cpu = data >> WORK_OFFQ_CPU_SHIFT;
604bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
6057a22ad75STejun Heo 		return NULL;
6067a22ad75STejun Heo 
607f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
6087a22ad75STejun Heo 	return get_gcwq(cpu);
609365970a1SDavid Howells }
610365970a1SDavid Howells 
611bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
612bbb68dfaSTejun Heo {
613bbb68dfaSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
614bbb68dfaSTejun Heo 	unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
615bbb68dfaSTejun Heo 
616bbb68dfaSTejun Heo 	set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
617bbb68dfaSTejun Heo 		      WORK_STRUCT_PENDING);
618bbb68dfaSTejun Heo }
619bbb68dfaSTejun Heo 
620bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
621bbb68dfaSTejun Heo {
622bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
623bbb68dfaSTejun Heo 
624bbb68dfaSTejun Heo 	return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
625bbb68dfaSTejun Heo }
626bbb68dfaSTejun Heo 
627e22bee78STejun Heo /*
6283270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
6293270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
6303270476aSTejun Heo  * they're being called with gcwq->lock held.
631e22bee78STejun Heo  */
632e22bee78STejun Heo 
63363d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
634649027d7STejun Heo {
6353270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
636649027d7STejun Heo }
637649027d7STejun Heo 
638e22bee78STejun Heo /*
639e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
640e22bee78STejun Heo  * running workers.
641974271c4STejun Heo  *
642974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
643974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
644974271c4STejun Heo  * worklist isn't empty.
645e22bee78STejun Heo  */
64663d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
647e22bee78STejun Heo {
64863d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
649e22bee78STejun Heo }
650e22bee78STejun Heo 
651e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
65263d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
653e22bee78STejun Heo {
65463d95a91STejun Heo 	return pool->nr_idle;
655e22bee78STejun Heo }
656e22bee78STejun Heo 
657e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
65863d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
659e22bee78STejun Heo {
66063d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
661e22bee78STejun Heo 
6623270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
663e22bee78STejun Heo }
664e22bee78STejun Heo 
665e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
66663d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
667e22bee78STejun Heo {
66863d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
669e22bee78STejun Heo }
670e22bee78STejun Heo 
671e22bee78STejun Heo /* Do I need to be the manager? */
67263d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
673e22bee78STejun Heo {
67463d95a91STejun Heo 	return need_to_create_worker(pool) ||
67511ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
676e22bee78STejun Heo }
677e22bee78STejun Heo 
678e22bee78STejun Heo /* Do we have too many workers and should some go away? */
67963d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
680e22bee78STejun Heo {
681552a37e9SLai Jiangshan 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
68263d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
68363d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
684e22bee78STejun Heo 
685ea1abd61SLai Jiangshan 	/*
686ea1abd61SLai Jiangshan 	 * nr_idle and idle_list may disagree if idle rebinding is in
687ea1abd61SLai Jiangshan 	 * progress.  Never return %true if idle_list is empty.
688ea1abd61SLai Jiangshan 	 */
689ea1abd61SLai Jiangshan 	if (list_empty(&pool->idle_list))
690ea1abd61SLai Jiangshan 		return false;
691ea1abd61SLai Jiangshan 
692e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
693e22bee78STejun Heo }
694e22bee78STejun Heo 
695e22bee78STejun Heo /*
696e22bee78STejun Heo  * Wake up functions.
697e22bee78STejun Heo  */
698e22bee78STejun Heo 
6997e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
70063d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
7017e11629dSTejun Heo {
70263d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
7037e11629dSTejun Heo 		return NULL;
7047e11629dSTejun Heo 
70563d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
7067e11629dSTejun Heo }
7077e11629dSTejun Heo 
7087e11629dSTejun Heo /**
7097e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
71063d95a91STejun Heo  * @pool: worker pool to wake worker from
7117e11629dSTejun Heo  *
71263d95a91STejun Heo  * Wake up the first idle worker of @pool.
7137e11629dSTejun Heo  *
7147e11629dSTejun Heo  * CONTEXT:
7157e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
7167e11629dSTejun Heo  */
71763d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
7187e11629dSTejun Heo {
71963d95a91STejun Heo 	struct worker *worker = first_worker(pool);
7207e11629dSTejun Heo 
7217e11629dSTejun Heo 	if (likely(worker))
7227e11629dSTejun Heo 		wake_up_process(worker->task);
7237e11629dSTejun Heo }
7247e11629dSTejun Heo 
7254690c4abSTejun Heo /**
726e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
727e22bee78STejun Heo  * @task: task waking up
728e22bee78STejun Heo  * @cpu: CPU @task is waking up to
729e22bee78STejun Heo  *
730e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
731e22bee78STejun Heo  * being awoken.
732e22bee78STejun Heo  *
733e22bee78STejun Heo  * CONTEXT:
734e22bee78STejun Heo  * spin_lock_irq(rq->lock)
735e22bee78STejun Heo  */
736e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
737e22bee78STejun Heo {
738e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
739e22bee78STejun Heo 
74036576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
74136576000SJoonsoo Kim 		WARN_ON_ONCE(worker->pool->gcwq->cpu != cpu);
74263d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
743e22bee78STejun Heo 	}
74436576000SJoonsoo Kim }
745e22bee78STejun Heo 
746e22bee78STejun Heo /**
747e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
748e22bee78STejun Heo  * @task: task going to sleep
749e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
750e22bee78STejun Heo  *
751e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
752e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
753e22bee78STejun Heo  * returning pointer to its task.
754e22bee78STejun Heo  *
755e22bee78STejun Heo  * CONTEXT:
756e22bee78STejun Heo  * spin_lock_irq(rq->lock)
757e22bee78STejun Heo  *
758e22bee78STejun Heo  * RETURNS:
759e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
760e22bee78STejun Heo  */
761e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
762e22bee78STejun Heo 				       unsigned int cpu)
763e22bee78STejun Heo {
764e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
765bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
76663d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
767e22bee78STejun Heo 
7682d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
769e22bee78STejun Heo 		return NULL;
770e22bee78STejun Heo 
771e22bee78STejun Heo 	/* this can only happen on the local cpu */
772e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
773e22bee78STejun Heo 
774e22bee78STejun Heo 	/*
775e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
776e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
777e22bee78STejun Heo 	 * Please read comment there.
778e22bee78STejun Heo 	 *
779628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
780628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
781628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
782628c78e7STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without gcwq
783628c78e7STejun Heo 	 * lock is safe.
784e22bee78STejun Heo 	 */
785bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
78663d95a91STejun Heo 		to_wakeup = first_worker(pool);
787e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
788e22bee78STejun Heo }
789e22bee78STejun Heo 
790e22bee78STejun Heo /**
791e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
792cb444766STejun Heo  * @worker: self
793d302f017STejun Heo  * @flags: flags to set
794d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
795d302f017STejun Heo  *
796e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
797e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
798e22bee78STejun Heo  * woken up.
799d302f017STejun Heo  *
800cb444766STejun Heo  * CONTEXT:
801cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
802d302f017STejun Heo  */
803d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
804d302f017STejun Heo 				    bool wakeup)
805d302f017STejun Heo {
806bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
807e22bee78STejun Heo 
808cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
809cb444766STejun Heo 
810e22bee78STejun Heo 	/*
811e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
812e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
813e22bee78STejun Heo 	 * @wakeup.
814e22bee78STejun Heo 	 */
815e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
816e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
81763d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
818e22bee78STejun Heo 
819e22bee78STejun Heo 		if (wakeup) {
820e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
821bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
82263d95a91STejun Heo 				wake_up_worker(pool);
823e22bee78STejun Heo 		} else
824e22bee78STejun Heo 			atomic_dec(nr_running);
825e22bee78STejun Heo 	}
826e22bee78STejun Heo 
827d302f017STejun Heo 	worker->flags |= flags;
828d302f017STejun Heo }
829d302f017STejun Heo 
830d302f017STejun Heo /**
831e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
832cb444766STejun Heo  * @worker: self
833d302f017STejun Heo  * @flags: flags to clear
834d302f017STejun Heo  *
835e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
836d302f017STejun Heo  *
837cb444766STejun Heo  * CONTEXT:
838cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
839d302f017STejun Heo  */
840d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
841d302f017STejun Heo {
84263d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
843e22bee78STejun Heo 	unsigned int oflags = worker->flags;
844e22bee78STejun Heo 
845cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
846cb444766STejun Heo 
847d302f017STejun Heo 	worker->flags &= ~flags;
848e22bee78STejun Heo 
84942c025f3STejun Heo 	/*
85042c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
85142c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
85242c025f3STejun Heo 	 * of multiple flags, not a single flag.
85342c025f3STejun Heo 	 */
854e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
855e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
85663d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
857d302f017STejun Heo }
858d302f017STejun Heo 
859d302f017STejun Heo /**
8608cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8618cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8628cca0eeaSTejun Heo  * @work: work to find worker for
8638cca0eeaSTejun Heo  *
8648cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
8658cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
8668cca0eeaSTejun Heo  * function calculates @bwh itself.
8678cca0eeaSTejun Heo  *
8688cca0eeaSTejun Heo  * CONTEXT:
8698cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8708cca0eeaSTejun Heo  *
8718cca0eeaSTejun Heo  * RETURNS:
8728cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8738cca0eeaSTejun Heo  * otherwise.
8748cca0eeaSTejun Heo  */
8758cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8768cca0eeaSTejun Heo 						 struct work_struct *work)
8778cca0eeaSTejun Heo {
878*42f8570fSSasha Levin 	struct worker *worker;
879*42f8570fSSasha Levin 	struct hlist_node *tmp;
880*42f8570fSSasha Levin 
881*42f8570fSSasha Levin 	hash_for_each_possible(gcwq->busy_hash, worker, tmp, hentry, (unsigned long)work)
882*42f8570fSSasha Levin 		if (worker->current_work == work)
883*42f8570fSSasha Levin 			return worker;
884*42f8570fSSasha Levin 
885*42f8570fSSasha Levin 	return NULL;
8868cca0eeaSTejun Heo }
8878cca0eeaSTejun Heo 
8888cca0eeaSTejun Heo /**
889bf4ede01STejun Heo  * move_linked_works - move linked works to a list
890bf4ede01STejun Heo  * @work: start of series of works to be scheduled
891bf4ede01STejun Heo  * @head: target list to append @work to
892bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
893bf4ede01STejun Heo  *
894bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
895bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
896bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
897bf4ede01STejun Heo  *
898bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
899bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
900bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
901bf4ede01STejun Heo  *
902bf4ede01STejun Heo  * CONTEXT:
903bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
904bf4ede01STejun Heo  */
905bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
906bf4ede01STejun Heo 			      struct work_struct **nextp)
907bf4ede01STejun Heo {
908bf4ede01STejun Heo 	struct work_struct *n;
909bf4ede01STejun Heo 
910bf4ede01STejun Heo 	/*
911bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
912bf4ede01STejun Heo 	 * use NULL for list head.
913bf4ede01STejun Heo 	 */
914bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
915bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
916bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
917bf4ede01STejun Heo 			break;
918bf4ede01STejun Heo 	}
919bf4ede01STejun Heo 
920bf4ede01STejun Heo 	/*
921bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
922bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
923bf4ede01STejun Heo 	 * needs to be updated.
924bf4ede01STejun Heo 	 */
925bf4ede01STejun Heo 	if (nextp)
926bf4ede01STejun Heo 		*nextp = n;
927bf4ede01STejun Heo }
928bf4ede01STejun Heo 
9293aa62497SLai Jiangshan static void cwq_activate_delayed_work(struct work_struct *work)
930bf4ede01STejun Heo {
9313aa62497SLai Jiangshan 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
932bf4ede01STejun Heo 
933bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
934bf4ede01STejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
935bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
936bf4ede01STejun Heo 	cwq->nr_active++;
937bf4ede01STejun Heo }
938bf4ede01STejun Heo 
9393aa62497SLai Jiangshan static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
9403aa62497SLai Jiangshan {
9413aa62497SLai Jiangshan 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
9423aa62497SLai Jiangshan 						    struct work_struct, entry);
9433aa62497SLai Jiangshan 
9443aa62497SLai Jiangshan 	cwq_activate_delayed_work(work);
9453aa62497SLai Jiangshan }
9463aa62497SLai Jiangshan 
947bf4ede01STejun Heo /**
948bf4ede01STejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
949bf4ede01STejun Heo  * @cwq: cwq of interest
950bf4ede01STejun Heo  * @color: color of work which left the queue
951bf4ede01STejun Heo  *
952bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
953bf4ede01STejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
954bf4ede01STejun Heo  *
955bf4ede01STejun Heo  * CONTEXT:
956bf4ede01STejun Heo  * spin_lock_irq(gcwq->lock).
957bf4ede01STejun Heo  */
958b3f9f405SLai Jiangshan static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
959bf4ede01STejun Heo {
960bf4ede01STejun Heo 	/* ignore uncolored works */
961bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
962bf4ede01STejun Heo 		return;
963bf4ede01STejun Heo 
964bf4ede01STejun Heo 	cwq->nr_in_flight[color]--;
965bf4ede01STejun Heo 
966bf4ede01STejun Heo 	cwq->nr_active--;
967bf4ede01STejun Heo 	if (!list_empty(&cwq->delayed_works)) {
968bf4ede01STejun Heo 		/* one down, submit a delayed one */
969bf4ede01STejun Heo 		if (cwq->nr_active < cwq->max_active)
970bf4ede01STejun Heo 			cwq_activate_first_delayed(cwq);
971bf4ede01STejun Heo 	}
972bf4ede01STejun Heo 
973bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
974bf4ede01STejun Heo 	if (likely(cwq->flush_color != color))
975bf4ede01STejun Heo 		return;
976bf4ede01STejun Heo 
977bf4ede01STejun Heo 	/* are there still in-flight works? */
978bf4ede01STejun Heo 	if (cwq->nr_in_flight[color])
979bf4ede01STejun Heo 		return;
980bf4ede01STejun Heo 
981bf4ede01STejun Heo 	/* this cwq is done, clear flush_color */
982bf4ede01STejun Heo 	cwq->flush_color = -1;
983bf4ede01STejun Heo 
984bf4ede01STejun Heo 	/*
985bf4ede01STejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
986bf4ede01STejun Heo 	 * will handle the rest.
987bf4ede01STejun Heo 	 */
988bf4ede01STejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
989bf4ede01STejun Heo 		complete(&cwq->wq->first_flusher->done);
990bf4ede01STejun Heo }
991bf4ede01STejun Heo 
99236e227d2STejun Heo /**
993bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
99436e227d2STejun Heo  * @work: work item to steal
99536e227d2STejun Heo  * @is_dwork: @work is a delayed_work
996bbb68dfaSTejun Heo  * @flags: place to store irq state
99736e227d2STejun Heo  *
99836e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
99936e227d2STejun Heo  * stable state - idle, on timer or on worklist.  Return values are
100036e227d2STejun Heo  *
100136e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
100236e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
100336e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1004bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1005bbb68dfaSTejun Heo  *		for arbitrarily long
100636e227d2STejun Heo  *
1007bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1008e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1009e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1010e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1011bbb68dfaSTejun Heo  *
1012bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1013bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1014bbb68dfaSTejun Heo  *
1015e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1016bf4ede01STejun Heo  */
1017bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1018bbb68dfaSTejun Heo 			       unsigned long *flags)
1019bf4ede01STejun Heo {
1020bf4ede01STejun Heo 	struct global_cwq *gcwq;
1021bf4ede01STejun Heo 
1022bbb68dfaSTejun Heo 	local_irq_save(*flags);
1023bbb68dfaSTejun Heo 
102436e227d2STejun Heo 	/* try to steal the timer if it exists */
102536e227d2STejun Heo 	if (is_dwork) {
102636e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
102736e227d2STejun Heo 
1028e0aecdd8STejun Heo 		/*
1029e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1030e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1031e0aecdd8STejun Heo 		 * running on the local CPU.
1032e0aecdd8STejun Heo 		 */
103336e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
103436e227d2STejun Heo 			return 1;
103536e227d2STejun Heo 	}
103636e227d2STejun Heo 
103736e227d2STejun Heo 	/* try to claim PENDING the normal way */
1038bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1039bf4ede01STejun Heo 		return 0;
1040bf4ede01STejun Heo 
1041bf4ede01STejun Heo 	/*
1042bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1043bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1044bf4ede01STejun Heo 	 */
1045bf4ede01STejun Heo 	gcwq = get_work_gcwq(work);
1046bf4ede01STejun Heo 	if (!gcwq)
1047bbb68dfaSTejun Heo 		goto fail;
1048bf4ede01STejun Heo 
1049bbb68dfaSTejun Heo 	spin_lock(&gcwq->lock);
1050bf4ede01STejun Heo 	if (!list_empty(&work->entry)) {
1051bf4ede01STejun Heo 		/*
1052bf4ede01STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
1053bf4ede01STejun Heo 		 * In that case we must see the new value after rmb(), see
1054bf4ede01STejun Heo 		 * insert_work()->wmb().
1055bf4ede01STejun Heo 		 */
1056bf4ede01STejun Heo 		smp_rmb();
1057bf4ede01STejun Heo 		if (gcwq == get_work_gcwq(work)) {
1058bf4ede01STejun Heo 			debug_work_deactivate(work);
10593aa62497SLai Jiangshan 
10603aa62497SLai Jiangshan 			/*
10613aa62497SLai Jiangshan 			 * A delayed work item cannot be grabbed directly
10623aa62497SLai Jiangshan 			 * because it might have linked NO_COLOR work items
10633aa62497SLai Jiangshan 			 * which, if left on the delayed_list, will confuse
10643aa62497SLai Jiangshan 			 * cwq->nr_active management later on and cause
10653aa62497SLai Jiangshan 			 * stall.  Make sure the work item is activated
10663aa62497SLai Jiangshan 			 * before grabbing.
10673aa62497SLai Jiangshan 			 */
10683aa62497SLai Jiangshan 			if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
10693aa62497SLai Jiangshan 				cwq_activate_delayed_work(work);
10703aa62497SLai Jiangshan 
1071bf4ede01STejun Heo 			list_del_init(&work->entry);
1072bf4ede01STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
1073b3f9f405SLai Jiangshan 				get_work_color(work));
107436e227d2STejun Heo 
1075bbb68dfaSTejun Heo 			spin_unlock(&gcwq->lock);
107636e227d2STejun Heo 			return 1;
1077bf4ede01STejun Heo 		}
1078bf4ede01STejun Heo 	}
1079bbb68dfaSTejun Heo 	spin_unlock(&gcwq->lock);
1080bbb68dfaSTejun Heo fail:
1081bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1082bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1083bbb68dfaSTejun Heo 		return -ENOENT;
1084bbb68dfaSTejun Heo 	cpu_relax();
108536e227d2STejun Heo 	return -EAGAIN;
1086bf4ede01STejun Heo }
1087bf4ede01STejun Heo 
1088bf4ede01STejun Heo /**
10897e11629dSTejun Heo  * insert_work - insert a work into gcwq
10904690c4abSTejun Heo  * @cwq: cwq @work belongs to
10914690c4abSTejun Heo  * @work: work to insert
10924690c4abSTejun Heo  * @head: insertion point
10934690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
10944690c4abSTejun Heo  *
10957e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
10967e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
10974690c4abSTejun Heo  *
10984690c4abSTejun Heo  * CONTEXT:
10998b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
11001da177e4SLinus Torvalds  */
1101b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
11024690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
11034690c4abSTejun Heo 			unsigned int extra_flags)
1104b89deed3SOleg Nesterov {
110563d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
1106e1d8aa9fSFrederic Weisbecker 
11074690c4abSTejun Heo 	/* we own @work, set data and link */
11087a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
11094690c4abSTejun Heo 
11106e84d644SOleg Nesterov 	/*
11116e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
11126e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
11136e84d644SOleg Nesterov 	 */
11146e84d644SOleg Nesterov 	smp_wmb();
11154690c4abSTejun Heo 
11161a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
1117e22bee78STejun Heo 
1118e22bee78STejun Heo 	/*
1119e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
1120e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
1121e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
1122e22bee78STejun Heo 	 */
1123e22bee78STejun Heo 	smp_mb();
1124e22bee78STejun Heo 
112563d95a91STejun Heo 	if (__need_more_worker(pool))
112663d95a91STejun Heo 		wake_up_worker(pool);
1127b89deed3SOleg Nesterov }
1128b89deed3SOleg Nesterov 
1129c8efcc25STejun Heo /*
1130c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
1131c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
1132c8efcc25STejun Heo  * cold paths.
1133c8efcc25STejun Heo  */
1134c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1135c8efcc25STejun Heo {
1136c8efcc25STejun Heo 	unsigned long flags;
1137c8efcc25STejun Heo 	unsigned int cpu;
1138c8efcc25STejun Heo 
1139c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
1140c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
1141c8efcc25STejun Heo 		struct worker *worker;
1142c8efcc25STejun Heo 		struct hlist_node *pos;
1143c8efcc25STejun Heo 		int i;
1144c8efcc25STejun Heo 
1145c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1146c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
1147c8efcc25STejun Heo 			if (worker->task != current)
1148c8efcc25STejun Heo 				continue;
1149c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
1150c8efcc25STejun Heo 			/*
1151c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
1152c8efcc25STejun Heo 			 * is headed to the same workqueue.
1153c8efcc25STejun Heo 			 */
1154c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
1155c8efcc25STejun Heo 		}
1156c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
1157c8efcc25STejun Heo 	}
1158c8efcc25STejun Heo 	return false;
1159c8efcc25STejun Heo }
1160c8efcc25STejun Heo 
11614690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
11621da177e4SLinus Torvalds 			 struct work_struct *work)
11631da177e4SLinus Torvalds {
1164502ca9d8STejun Heo 	struct global_cwq *gcwq;
1165502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
11661e19ffc6STejun Heo 	struct list_head *worklist;
11678a2e8e5dSTejun Heo 	unsigned int work_flags;
1168b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
11698930cabaSTejun Heo 
11708930cabaSTejun Heo 	/*
11718930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
11728930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
11738930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
11748930cabaSTejun Heo 	 * happen with IRQ disabled.
11758930cabaSTejun Heo 	 */
11768930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
11771da177e4SLinus Torvalds 
1178dc186ad7SThomas Gleixner 	debug_work_activate(work);
11791e19ffc6STejun Heo 
1180c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
11819c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1182c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1183e41e704bSTejun Heo 		return;
1184e41e704bSTejun Heo 
1185c7fc77f7STejun Heo 	/* determine gcwq to use */
1186c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1187c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1188c7fc77f7STejun Heo 
118957469821STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
1190f3421797STejun Heo 			cpu = raw_smp_processor_id();
1191f3421797STejun Heo 
119218aa9effSTejun Heo 		/*
1193dbf2576eSTejun Heo 		 * It's multi cpu.  If @work was previously on a different
1194dbf2576eSTejun Heo 		 * cpu, it might still be running there, in which case the
1195dbf2576eSTejun Heo 		 * work needs to be queued on that cpu to guarantee
1196dbf2576eSTejun Heo 		 * non-reentrancy.
119718aa9effSTejun Heo 		 */
1198502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
1199dbf2576eSTejun Heo 		last_gcwq = get_work_gcwq(work);
1200dbf2576eSTejun Heo 
1201dbf2576eSTejun Heo 		if (last_gcwq && last_gcwq != gcwq) {
120218aa9effSTejun Heo 			struct worker *worker;
120318aa9effSTejun Heo 
12048930cabaSTejun Heo 			spin_lock(&last_gcwq->lock);
120518aa9effSTejun Heo 
120618aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
120718aa9effSTejun Heo 
120818aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
120918aa9effSTejun Heo 				gcwq = last_gcwq;
121018aa9effSTejun Heo 			else {
121118aa9effSTejun Heo 				/* meh... not running there, queue here */
12128930cabaSTejun Heo 				spin_unlock(&last_gcwq->lock);
12138930cabaSTejun Heo 				spin_lock(&gcwq->lock);
121418aa9effSTejun Heo 			}
12158930cabaSTejun Heo 		} else {
12168930cabaSTejun Heo 			spin_lock(&gcwq->lock);
12178930cabaSTejun Heo 		}
1218f3421797STejun Heo 	} else {
1219f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
12208930cabaSTejun Heo 		spin_lock(&gcwq->lock);
1221502ca9d8STejun Heo 	}
1222502ca9d8STejun Heo 
1223502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1224502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1225b75cac93SJoonsoo Kim 	trace_workqueue_queue_work(req_cpu, cwq, work);
1226502ca9d8STejun Heo 
1227f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
12288930cabaSTejun Heo 		spin_unlock(&gcwq->lock);
1229f5b2552bSDan Carpenter 		return;
1230f5b2552bSDan Carpenter 	}
12311e19ffc6STejun Heo 
123273f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
12338a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
12341e19ffc6STejun Heo 
12351e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1236cdadf009STejun Heo 		trace_workqueue_activate_work(work);
12371e19ffc6STejun Heo 		cwq->nr_active++;
12383270476aSTejun Heo 		worklist = &cwq->pool->worklist;
12398a2e8e5dSTejun Heo 	} else {
12408a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
12411e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
12428a2e8e5dSTejun Heo 	}
12431e19ffc6STejun Heo 
12448a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
12451e19ffc6STejun Heo 
12468930cabaSTejun Heo 	spin_unlock(&gcwq->lock);
12471da177e4SLinus Torvalds }
12481da177e4SLinus Torvalds 
12490fcb78c2SRolf Eike Beer /**
1250c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1251c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1252c1a220e7SZhang Rui  * @wq: workqueue to use
1253c1a220e7SZhang Rui  * @work: work to queue
1254c1a220e7SZhang Rui  *
1255d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
1256c1a220e7SZhang Rui  *
1257c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1258c1a220e7SZhang Rui  * can't go away.
1259c1a220e7SZhang Rui  */
1260d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1261d4283e93STejun Heo 		   struct work_struct *work)
1262c1a220e7SZhang Rui {
1263d4283e93STejun Heo 	bool ret = false;
12648930cabaSTejun Heo 	unsigned long flags;
12658930cabaSTejun Heo 
12668930cabaSTejun Heo 	local_irq_save(flags);
1267c1a220e7SZhang Rui 
126822df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
12694690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1270d4283e93STejun Heo 		ret = true;
1271c1a220e7SZhang Rui 	}
12728930cabaSTejun Heo 
12738930cabaSTejun Heo 	local_irq_restore(flags);
1274c1a220e7SZhang Rui 	return ret;
1275c1a220e7SZhang Rui }
1276c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1277c1a220e7SZhang Rui 
12780a13c00eSTejun Heo /**
12790a13c00eSTejun Heo  * queue_work - queue work on a workqueue
12800a13c00eSTejun Heo  * @wq: workqueue to use
12810a13c00eSTejun Heo  * @work: work to queue
12820a13c00eSTejun Heo  *
1283d4283e93STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.
12840a13c00eSTejun Heo  *
12850a13c00eSTejun Heo  * We queue the work to the CPU on which it was submitted, but if the CPU dies
12860a13c00eSTejun Heo  * it can be processed by another CPU.
12870a13c00eSTejun Heo  */
1288d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
12890a13c00eSTejun Heo {
129057469821STejun Heo 	return queue_work_on(WORK_CPU_UNBOUND, wq, work);
12910a13c00eSTejun Heo }
12920a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work);
12930a13c00eSTejun Heo 
1294d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
12951da177e4SLinus Torvalds {
129652bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
12977a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
12981da177e4SLinus Torvalds 
1299e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
13001265057fSTejun Heo 	__queue_work(dwork->cpu, cwq->wq, &dwork->work);
13011da177e4SLinus Torvalds }
1302d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
13031da177e4SLinus Torvalds 
13047beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
130552bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
13061da177e4SLinus Torvalds {
13077beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
13087beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
13097beb2edfSTejun Heo 	unsigned int lcpu;
13101da177e4SLinus Torvalds 
13117beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
13127beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
1313fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1314fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
13157beb2edfSTejun Heo 
13168852aac2STejun Heo 	/*
13178852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
13188852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
13198852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
13208852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
13218852aac2STejun Heo 	 */
13228852aac2STejun Heo 	if (!delay) {
13238852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
13248852aac2STejun Heo 		return;
13258852aac2STejun Heo 	}
13268852aac2STejun Heo 
13277beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
13287beb2edfSTejun Heo 
13297beb2edfSTejun Heo 	/*
13307beb2edfSTejun Heo 	 * This stores cwq for the moment, for the timer_fn.  Note that the
13317beb2edfSTejun Heo 	 * work's gcwq is preserved to allow reentrance detection for
13327beb2edfSTejun Heo 	 * delayed works.
13337beb2edfSTejun Heo 	 */
13347beb2edfSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
13357beb2edfSTejun Heo 		struct global_cwq *gcwq = get_work_gcwq(work);
13367beb2edfSTejun Heo 
1337e42986deSJoonsoo Kim 		/*
1338e42986deSJoonsoo Kim 		 * If we cannot get the last gcwq from @work directly,
1339e42986deSJoonsoo Kim 		 * select the last CPU such that it avoids unnecessarily
1340e42986deSJoonsoo Kim 		 * triggering non-reentrancy check in __queue_work().
1341e42986deSJoonsoo Kim 		 */
1342e42986deSJoonsoo Kim 		lcpu = cpu;
1343e42986deSJoonsoo Kim 		if (gcwq)
13447beb2edfSTejun Heo 			lcpu = gcwq->cpu;
1345e42986deSJoonsoo Kim 		if (lcpu == WORK_CPU_UNBOUND)
13467beb2edfSTejun Heo 			lcpu = raw_smp_processor_id();
13477beb2edfSTejun Heo 	} else {
13487beb2edfSTejun Heo 		lcpu = WORK_CPU_UNBOUND;
13491da177e4SLinus Torvalds 	}
13507beb2edfSTejun Heo 
13517beb2edfSTejun Heo 	set_work_cwq(work, get_cwq(lcpu, wq), 0);
13527beb2edfSTejun Heo 
13531265057fSTejun Heo 	dwork->cpu = cpu;
13547beb2edfSTejun Heo 	timer->expires = jiffies + delay;
13557beb2edfSTejun Heo 
13567beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
13577beb2edfSTejun Heo 		add_timer_on(timer, cpu);
13587beb2edfSTejun Heo 	else
13597beb2edfSTejun Heo 		add_timer(timer);
13607beb2edfSTejun Heo }
13611da177e4SLinus Torvalds 
13620fcb78c2SRolf Eike Beer /**
13630fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
13640fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
13650fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1366af9997e4SRandy Dunlap  * @dwork: work to queue
13670fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
13680fcb78c2SRolf Eike Beer  *
1369715f1300STejun Heo  * Returns %false if @work was already on a queue, %true otherwise.  If
1370715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1371715f1300STejun Heo  * execution.
13720fcb78c2SRolf Eike Beer  */
1373d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
137452bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
13757a6bc1cdSVenkatesh Pallipadi {
137652bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1377d4283e93STejun Heo 	bool ret = false;
13788930cabaSTejun Heo 	unsigned long flags;
13798930cabaSTejun Heo 
13808930cabaSTejun Heo 	/* read the comment in __queue_work() */
13818930cabaSTejun Heo 	local_irq_save(flags);
13827a6bc1cdSVenkatesh Pallipadi 
138322df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
13847beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1385d4283e93STejun Heo 		ret = true;
13867a6bc1cdSVenkatesh Pallipadi 	}
13878930cabaSTejun Heo 
13888930cabaSTejun Heo 	local_irq_restore(flags);
13897a6bc1cdSVenkatesh Pallipadi 	return ret;
13907a6bc1cdSVenkatesh Pallipadi }
1391ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
13921da177e4SLinus Torvalds 
1393c8e55f36STejun Heo /**
13940a13c00eSTejun Heo  * queue_delayed_work - queue work on a workqueue after delay
13950a13c00eSTejun Heo  * @wq: workqueue to use
13960a13c00eSTejun Heo  * @dwork: delayable work to queue
13970a13c00eSTejun Heo  * @delay: number of jiffies to wait before queueing
13980a13c00eSTejun Heo  *
1399715f1300STejun Heo  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
14000a13c00eSTejun Heo  */
1401d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq,
14020a13c00eSTejun Heo 			struct delayed_work *dwork, unsigned long delay)
14030a13c00eSTejun Heo {
140457469821STejun Heo 	return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14050a13c00eSTejun Heo }
14060a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work);
14070a13c00eSTejun Heo 
14080a13c00eSTejun Heo /**
14098376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
14108376fe22STejun Heo  * @cpu: CPU number to execute work on
14118376fe22STejun Heo  * @wq: workqueue to use
14128376fe22STejun Heo  * @dwork: work to queue
14138376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14148376fe22STejun Heo  *
14158376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
14168376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
14178376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
14188376fe22STejun Heo  * current state.
14198376fe22STejun Heo  *
14208376fe22STejun Heo  * Returns %false if @dwork was idle and queued, %true if @dwork was
14218376fe22STejun Heo  * pending and its timer was modified.
14228376fe22STejun Heo  *
1423e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
14248376fe22STejun Heo  * See try_to_grab_pending() for details.
14258376fe22STejun Heo  */
14268376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
14278376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
14288376fe22STejun Heo {
14298376fe22STejun Heo 	unsigned long flags;
14308376fe22STejun Heo 	int ret;
14318376fe22STejun Heo 
14328376fe22STejun Heo 	do {
14338376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
14348376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
14358376fe22STejun Heo 
14368376fe22STejun Heo 	if (likely(ret >= 0)) {
14378376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
14388376fe22STejun Heo 		local_irq_restore(flags);
14398376fe22STejun Heo 	}
14408376fe22STejun Heo 
14418376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
14428376fe22STejun Heo 	return ret;
14438376fe22STejun Heo }
14448376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
14458376fe22STejun Heo 
14468376fe22STejun Heo /**
14478376fe22STejun Heo  * mod_delayed_work - modify delay of or queue a delayed work
14488376fe22STejun Heo  * @wq: workqueue to use
14498376fe22STejun Heo  * @dwork: work to queue
14508376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14518376fe22STejun Heo  *
14528376fe22STejun Heo  * mod_delayed_work_on() on local CPU.
14538376fe22STejun Heo  */
14548376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
14558376fe22STejun Heo 		      unsigned long delay)
14568376fe22STejun Heo {
14578376fe22STejun Heo 	return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
14588376fe22STejun Heo }
14598376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work);
14608376fe22STejun Heo 
14618376fe22STejun Heo /**
1462c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1463c8e55f36STejun Heo  * @worker: worker which is entering idle state
1464c8e55f36STejun Heo  *
1465c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1466c8e55f36STejun Heo  * necessary.
1467c8e55f36STejun Heo  *
1468c8e55f36STejun Heo  * LOCKING:
1469c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1470c8e55f36STejun Heo  */
1471c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
14721da177e4SLinus Torvalds {
1473bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1474bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1475c8e55f36STejun Heo 
1476c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1477c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1478c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1479c8e55f36STejun Heo 
1480cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1481cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1482bd7bdd43STejun Heo 	pool->nr_idle++;
1483e22bee78STejun Heo 	worker->last_active = jiffies;
1484c8e55f36STejun Heo 
1485c8e55f36STejun Heo 	/* idle_list is LIFO */
1486bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1487db7bccf4STejun Heo 
148863d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1489628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1490cb444766STejun Heo 
1491544ecf31STejun Heo 	/*
1492628c78e7STejun Heo 	 * Sanity check nr_running.  Because gcwq_unbind_fn() releases
1493628c78e7STejun Heo 	 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1494628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1495628c78e7STejun Heo 	 * unbind is not in progress.
1496544ecf31STejun Heo 	 */
1497628c78e7STejun Heo 	WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
1498bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
149963d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1500c8e55f36STejun Heo }
1501c8e55f36STejun Heo 
1502c8e55f36STejun Heo /**
1503c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1504c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1505c8e55f36STejun Heo  *
1506c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1507c8e55f36STejun Heo  *
1508c8e55f36STejun Heo  * LOCKING:
1509c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1510c8e55f36STejun Heo  */
1511c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1512c8e55f36STejun Heo {
1513bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1514c8e55f36STejun Heo 
1515c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1516d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1517bd7bdd43STejun Heo 	pool->nr_idle--;
1518c8e55f36STejun Heo 	list_del_init(&worker->entry);
1519c8e55f36STejun Heo }
1520c8e55f36STejun Heo 
1521e22bee78STejun Heo /**
1522e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1523e22bee78STejun Heo  * @worker: self
1524e22bee78STejun Heo  *
1525e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1526e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1527e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1528e22bee78STejun Heo  * guaranteed to execute on the cpu.
1529e22bee78STejun Heo  *
1530e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1531e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1532e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1533e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1534e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1535e22bee78STejun Heo  * [dis]associated in the meantime.
1536e22bee78STejun Heo  *
1537f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1538f2d5a0eeSTejun Heo  * binding against %GCWQ_DISASSOCIATED which is set during
1539f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1540f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1541f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1542e22bee78STejun Heo  *
1543e22bee78STejun Heo  * CONTEXT:
1544e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1545e22bee78STejun Heo  * held.
1546e22bee78STejun Heo  *
1547e22bee78STejun Heo  * RETURNS:
1548e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1549e22bee78STejun Heo  * bound), %false if offline.
1550e22bee78STejun Heo  */
1551e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1552972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1553e22bee78STejun Heo {
1554bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1555e22bee78STejun Heo 	struct task_struct *task = worker->task;
1556e22bee78STejun Heo 
1557e22bee78STejun Heo 	while (true) {
1558e22bee78STejun Heo 		/*
1559e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1560e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1561e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1562e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1563e22bee78STejun Heo 		 */
1564f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1565e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1566e22bee78STejun Heo 
1567e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1568e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1569e22bee78STejun Heo 			return false;
1570e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1571e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1572e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1573e22bee78STejun Heo 			return true;
1574e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1575e22bee78STejun Heo 
15765035b20fSTejun Heo 		/*
15775035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
15785035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
15795035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
15805035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
15815035b20fSTejun Heo 		 */
1582e22bee78STejun Heo 		cpu_relax();
15835035b20fSTejun Heo 		cond_resched();
1584e22bee78STejun Heo 	}
1585e22bee78STejun Heo }
1586e22bee78STejun Heo 
1587e22bee78STejun Heo /*
1588ea1abd61SLai Jiangshan  * Rebind an idle @worker to its CPU.  worker_thread() will test
15895f7dabfdSLai Jiangshan  * list_empty(@worker->entry) before leaving idle and call this function.
159025511a47STejun Heo  */
159125511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
159225511a47STejun Heo {
159325511a47STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
159425511a47STejun Heo 
15955f7dabfdSLai Jiangshan 	/* CPU may go down again inbetween, clear UNBOUND only on success */
15965f7dabfdSLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
15975f7dabfdSLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
159825511a47STejun Heo 
1599ea1abd61SLai Jiangshan 	/* rebind complete, become available again */
1600ea1abd61SLai Jiangshan 	list_add(&worker->entry, &worker->pool->idle_list);
1601ea1abd61SLai Jiangshan 	spin_unlock_irq(&gcwq->lock);
160225511a47STejun Heo }
160325511a47STejun Heo 
160425511a47STejun Heo /*
160525511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1606403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1607403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1608403c821dSTejun Heo  * executed twice without intervening cpu down.
1609e22bee78STejun Heo  */
161025511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1611e22bee78STejun Heo {
1612e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1613bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1614e22bee78STejun Heo 
1615eab6d828SLai Jiangshan 	if (worker_maybe_bind_and_lock(worker))
1616eab6d828SLai Jiangshan 		worker_clr_flags(worker, WORKER_UNBOUND);
1617e22bee78STejun Heo 
1618e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1619e22bee78STejun Heo }
1620e22bee78STejun Heo 
162125511a47STejun Heo /**
162225511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
162325511a47STejun Heo  * @gcwq: gcwq of interest
162425511a47STejun Heo  *
162525511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
162625511a47STejun Heo  * is different for idle and busy ones.
162725511a47STejun Heo  *
1628ea1abd61SLai Jiangshan  * Idle ones will be removed from the idle_list and woken up.  They will
1629ea1abd61SLai Jiangshan  * add themselves back after completing rebind.  This ensures that the
1630ea1abd61SLai Jiangshan  * idle_list doesn't contain any unbound workers when re-bound busy workers
1631ea1abd61SLai Jiangshan  * try to perform local wake-ups for concurrency management.
163225511a47STejun Heo  *
1633ea1abd61SLai Jiangshan  * Busy workers can rebind after they finish their current work items.
1634ea1abd61SLai Jiangshan  * Queueing the rebind work item at the head of the scheduled list is
1635ea1abd61SLai Jiangshan  * enough.  Note that nr_running will be properly bumped as busy workers
1636ea1abd61SLai Jiangshan  * rebind.
163725511a47STejun Heo  *
1638ea1abd61SLai Jiangshan  * On return, all non-manager workers are scheduled for rebind - see
1639ea1abd61SLai Jiangshan  * manage_workers() for the manager special case.  Any idle worker
1640ea1abd61SLai Jiangshan  * including the manager will not appear on @idle_list until rebind is
1641ea1abd61SLai Jiangshan  * complete, making local wake-ups safe.
164225511a47STejun Heo  */
164325511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
164425511a47STejun Heo {
164525511a47STejun Heo 	struct worker_pool *pool;
1646ea1abd61SLai Jiangshan 	struct worker *worker, *n;
164725511a47STejun Heo 	struct hlist_node *pos;
164825511a47STejun Heo 	int i;
164925511a47STejun Heo 
165025511a47STejun Heo 	lockdep_assert_held(&gcwq->lock);
165125511a47STejun Heo 
165225511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
1653b2eb83d1SLai Jiangshan 		lockdep_assert_held(&pool->assoc_mutex);
165425511a47STejun Heo 
16555f7dabfdSLai Jiangshan 	/* dequeue and kick idle ones */
165625511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
1657ea1abd61SLai Jiangshan 		list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1658ea1abd61SLai Jiangshan 			/*
1659ea1abd61SLai Jiangshan 			 * idle workers should be off @pool->idle_list
1660ea1abd61SLai Jiangshan 			 * until rebind is complete to avoid receiving
1661ea1abd61SLai Jiangshan 			 * premature local wake-ups.
1662ea1abd61SLai Jiangshan 			 */
1663ea1abd61SLai Jiangshan 			list_del_init(&worker->entry);
166425511a47STejun Heo 
166525511a47STejun Heo 			/*
16665f7dabfdSLai Jiangshan 			 * worker_thread() will see the above dequeuing
16675f7dabfdSLai Jiangshan 			 * and call idle_worker_rebind().
166825511a47STejun Heo 			 */
166925511a47STejun Heo 			wake_up_process(worker->task);
167025511a47STejun Heo 		}
167125511a47STejun Heo 	}
167225511a47STejun Heo 
1673ea1abd61SLai Jiangshan 	/* rebind busy workers */
167425511a47STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
167525511a47STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
1676e2b6a6d5SJoonsoo Kim 		struct workqueue_struct *wq;
167725511a47STejun Heo 
167825511a47STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
167925511a47STejun Heo 				     work_data_bits(rebind_work)))
168025511a47STejun Heo 			continue;
168125511a47STejun Heo 
168225511a47STejun Heo 		debug_work_activate(rebind_work);
168390beca5dSTejun Heo 
168490beca5dSTejun Heo 		/*
1685e2b6a6d5SJoonsoo Kim 		 * wq doesn't really matter but let's keep @worker->pool
1686e2b6a6d5SJoonsoo Kim 		 * and @cwq->pool consistent for sanity.
168790beca5dSTejun Heo 		 */
1688e2b6a6d5SJoonsoo Kim 		if (worker_pool_pri(worker->pool))
1689e2b6a6d5SJoonsoo Kim 			wq = system_highpri_wq;
1690e2b6a6d5SJoonsoo Kim 		else
1691e2b6a6d5SJoonsoo Kim 			wq = system_wq;
1692ec58815aSTejun Heo 
1693e2b6a6d5SJoonsoo Kim 		insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
169425511a47STejun Heo 			worker->scheduled.next,
169525511a47STejun Heo 			work_color_to_flags(WORK_NO_COLOR));
1696ec58815aSTejun Heo 	}
169725511a47STejun Heo }
169825511a47STejun Heo 
1699c34056a3STejun Heo static struct worker *alloc_worker(void)
1700c34056a3STejun Heo {
1701c34056a3STejun Heo 	struct worker *worker;
1702c34056a3STejun Heo 
1703c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1704c8e55f36STejun Heo 	if (worker) {
1705c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1706affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
170725511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1708e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1709e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1710c8e55f36STejun Heo 	}
1711c34056a3STejun Heo 	return worker;
1712c34056a3STejun Heo }
1713c34056a3STejun Heo 
1714c34056a3STejun Heo /**
1715c34056a3STejun Heo  * create_worker - create a new workqueue worker
171663d95a91STejun Heo  * @pool: pool the new worker will belong to
1717c34056a3STejun Heo  *
171863d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1719c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1720c34056a3STejun Heo  * destroy_worker().
1721c34056a3STejun Heo  *
1722c34056a3STejun Heo  * CONTEXT:
1723c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1724c34056a3STejun Heo  *
1725c34056a3STejun Heo  * RETURNS:
1726c34056a3STejun Heo  * Pointer to the newly created worker.
1727c34056a3STejun Heo  */
1728bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1729c34056a3STejun Heo {
173063d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
17313270476aSTejun Heo 	const char *pri = worker_pool_pri(pool) ? "H" : "";
1732c34056a3STejun Heo 	struct worker *worker = NULL;
1733f3421797STejun Heo 	int id = -1;
1734c34056a3STejun Heo 
17358b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1736bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
17378b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1738bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1739c34056a3STejun Heo 			goto fail;
17408b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1741c34056a3STejun Heo 	}
17428b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1743c34056a3STejun Heo 
1744c34056a3STejun Heo 	worker = alloc_worker();
1745c34056a3STejun Heo 	if (!worker)
1746c34056a3STejun Heo 		goto fail;
1747c34056a3STejun Heo 
1748bd7bdd43STejun Heo 	worker->pool = pool;
1749c34056a3STejun Heo 	worker->id = id;
1750c34056a3STejun Heo 
1751bc2ae0f5STejun Heo 	if (gcwq->cpu != WORK_CPU_UNBOUND)
175294dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
17533270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
17543270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1755f3421797STejun Heo 	else
1756f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
17573270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1758c34056a3STejun Heo 	if (IS_ERR(worker->task))
1759c34056a3STejun Heo 		goto fail;
1760c34056a3STejun Heo 
17613270476aSTejun Heo 	if (worker_pool_pri(pool))
17623270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
17633270476aSTejun Heo 
1764db7bccf4STejun Heo 	/*
1765bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
1766bc2ae0f5STejun Heo 	 * %GCWQ_DISASSOCIATED.  The caller is responsible for ensuring the
1767bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1768bc2ae0f5STejun Heo 	 * above the flag definition for details.
1769bc2ae0f5STejun Heo 	 *
1770bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1771bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1772db7bccf4STejun Heo 	 */
1773bc2ae0f5STejun Heo 	if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
17748b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1775bc2ae0f5STejun Heo 	} else {
1776db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1777f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1778f3421797STejun Heo 	}
1779c34056a3STejun Heo 
1780c34056a3STejun Heo 	return worker;
1781c34056a3STejun Heo fail:
1782c34056a3STejun Heo 	if (id >= 0) {
17838b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1784bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
17858b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1786c34056a3STejun Heo 	}
1787c34056a3STejun Heo 	kfree(worker);
1788c34056a3STejun Heo 	return NULL;
1789c34056a3STejun Heo }
1790c34056a3STejun Heo 
1791c34056a3STejun Heo /**
1792c34056a3STejun Heo  * start_worker - start a newly created worker
1793c34056a3STejun Heo  * @worker: worker to start
1794c34056a3STejun Heo  *
1795c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1796c34056a3STejun Heo  *
1797c34056a3STejun Heo  * CONTEXT:
17988b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1799c34056a3STejun Heo  */
1800c34056a3STejun Heo static void start_worker(struct worker *worker)
1801c34056a3STejun Heo {
1802cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1803bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1804c8e55f36STejun Heo 	worker_enter_idle(worker);
1805c34056a3STejun Heo 	wake_up_process(worker->task);
1806c34056a3STejun Heo }
1807c34056a3STejun Heo 
1808c34056a3STejun Heo /**
1809c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1810c34056a3STejun Heo  * @worker: worker to be destroyed
1811c34056a3STejun Heo  *
1812c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1813c8e55f36STejun Heo  *
1814c8e55f36STejun Heo  * CONTEXT:
1815c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1816c34056a3STejun Heo  */
1817c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1818c34056a3STejun Heo {
1819bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1820bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1821c34056a3STejun Heo 	int id = worker->id;
1822c34056a3STejun Heo 
1823c34056a3STejun Heo 	/* sanity check frenzy */
1824c34056a3STejun Heo 	BUG_ON(worker->current_work);
1825affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1826c34056a3STejun Heo 
1827c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1828bd7bdd43STejun Heo 		pool->nr_workers--;
1829c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1830bd7bdd43STejun Heo 		pool->nr_idle--;
1831c8e55f36STejun Heo 
1832c8e55f36STejun Heo 	list_del_init(&worker->entry);
1833cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1834c8e55f36STejun Heo 
1835c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1836c8e55f36STejun Heo 
1837c34056a3STejun Heo 	kthread_stop(worker->task);
1838c34056a3STejun Heo 	kfree(worker);
1839c34056a3STejun Heo 
18408b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1841bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1842c34056a3STejun Heo }
1843c34056a3STejun Heo 
184463d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1845e22bee78STejun Heo {
184663d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
184763d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1848e22bee78STejun Heo 
1849e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1850e22bee78STejun Heo 
185163d95a91STejun Heo 	if (too_many_workers(pool)) {
1852e22bee78STejun Heo 		struct worker *worker;
1853e22bee78STejun Heo 		unsigned long expires;
1854e22bee78STejun Heo 
1855e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
185663d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1857e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1858e22bee78STejun Heo 
1859e22bee78STejun Heo 		if (time_before(jiffies, expires))
186063d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1861e22bee78STejun Heo 		else {
1862e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
186311ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
186463d95a91STejun Heo 			wake_up_worker(pool);
1865e22bee78STejun Heo 		}
1866e22bee78STejun Heo 	}
1867e22bee78STejun Heo 
1868e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1869e22bee78STejun Heo }
1870e22bee78STejun Heo 
1871e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1872e22bee78STejun Heo {
1873e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1874e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1875f3421797STejun Heo 	unsigned int cpu;
1876e22bee78STejun Heo 
1877e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1878e22bee78STejun Heo 		return false;
1879e22bee78STejun Heo 
1880e22bee78STejun Heo 	/* mayday mayday mayday */
1881bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1882f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1883f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1884f3421797STejun Heo 		cpu = 0;
1885f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1886e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1887e22bee78STejun Heo 	return true;
1888e22bee78STejun Heo }
1889e22bee78STejun Heo 
189063d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1891e22bee78STejun Heo {
189263d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
189363d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1894e22bee78STejun Heo 	struct work_struct *work;
1895e22bee78STejun Heo 
1896e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1897e22bee78STejun Heo 
189863d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1899e22bee78STejun Heo 		/*
1900e22bee78STejun Heo 		 * We've been trying to create a new worker but
1901e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1902e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1903e22bee78STejun Heo 		 * rescuers.
1904e22bee78STejun Heo 		 */
190563d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1906e22bee78STejun Heo 			send_mayday(work);
1907e22bee78STejun Heo 	}
1908e22bee78STejun Heo 
1909e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1910e22bee78STejun Heo 
191163d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1912e22bee78STejun Heo }
1913e22bee78STejun Heo 
1914e22bee78STejun Heo /**
1915e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
191663d95a91STejun Heo  * @pool: pool to create a new worker for
1917e22bee78STejun Heo  *
191863d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1919e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1920e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
192163d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1922e22bee78STejun Heo  * possible allocation deadlock.
1923e22bee78STejun Heo  *
1924e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1925e22bee78STejun Heo  * may_start_working() true.
1926e22bee78STejun Heo  *
1927e22bee78STejun Heo  * LOCKING:
1928e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1929e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1930e22bee78STejun Heo  * manager.
1931e22bee78STejun Heo  *
1932e22bee78STejun Heo  * RETURNS:
1933e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1934e22bee78STejun Heo  * otherwise.
1935e22bee78STejun Heo  */
193663d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
193706bd6ebfSNamhyung Kim __releases(&gcwq->lock)
193806bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1939e22bee78STejun Heo {
194063d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
194163d95a91STejun Heo 
194263d95a91STejun Heo 	if (!need_to_create_worker(pool))
1943e22bee78STejun Heo 		return false;
1944e22bee78STejun Heo restart:
19459f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
19469f9c2364STejun Heo 
1947e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
194863d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1949e22bee78STejun Heo 
1950e22bee78STejun Heo 	while (true) {
1951e22bee78STejun Heo 		struct worker *worker;
1952e22bee78STejun Heo 
1953bc2ae0f5STejun Heo 		worker = create_worker(pool);
1954e22bee78STejun Heo 		if (worker) {
195563d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1956e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1957e22bee78STejun Heo 			start_worker(worker);
195863d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1959e22bee78STejun Heo 			return true;
1960e22bee78STejun Heo 		}
1961e22bee78STejun Heo 
196263d95a91STejun Heo 		if (!need_to_create_worker(pool))
1963e22bee78STejun Heo 			break;
1964e22bee78STejun Heo 
1965e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1966e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
19679f9c2364STejun Heo 
196863d95a91STejun Heo 		if (!need_to_create_worker(pool))
1969e22bee78STejun Heo 			break;
1970e22bee78STejun Heo 	}
1971e22bee78STejun Heo 
197263d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1973e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
197463d95a91STejun Heo 	if (need_to_create_worker(pool))
1975e22bee78STejun Heo 		goto restart;
1976e22bee78STejun Heo 	return true;
1977e22bee78STejun Heo }
1978e22bee78STejun Heo 
1979e22bee78STejun Heo /**
1980e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
198163d95a91STejun Heo  * @pool: pool to destroy workers for
1982e22bee78STejun Heo  *
198363d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
1984e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1985e22bee78STejun Heo  *
1986e22bee78STejun Heo  * LOCKING:
1987e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1988e22bee78STejun Heo  * multiple times.  Called only from manager.
1989e22bee78STejun Heo  *
1990e22bee78STejun Heo  * RETURNS:
1991e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1992e22bee78STejun Heo  * otherwise.
1993e22bee78STejun Heo  */
199463d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
1995e22bee78STejun Heo {
1996e22bee78STejun Heo 	bool ret = false;
1997e22bee78STejun Heo 
199863d95a91STejun Heo 	while (too_many_workers(pool)) {
1999e22bee78STejun Heo 		struct worker *worker;
2000e22bee78STejun Heo 		unsigned long expires;
2001e22bee78STejun Heo 
200263d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2003e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2004e22bee78STejun Heo 
2005e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
200663d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2007e22bee78STejun Heo 			break;
2008e22bee78STejun Heo 		}
2009e22bee78STejun Heo 
2010e22bee78STejun Heo 		destroy_worker(worker);
2011e22bee78STejun Heo 		ret = true;
2012e22bee78STejun Heo 	}
2013e22bee78STejun Heo 
2014e22bee78STejun Heo 	return ret;
2015e22bee78STejun Heo }
2016e22bee78STejun Heo 
2017e22bee78STejun Heo /**
2018e22bee78STejun Heo  * manage_workers - manage worker pool
2019e22bee78STejun Heo  * @worker: self
2020e22bee78STejun Heo  *
2021e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
2022e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2023e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
2024e22bee78STejun Heo  *
2025e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2026e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2027e22bee78STejun Heo  * and may_start_working() is true.
2028e22bee78STejun Heo  *
2029e22bee78STejun Heo  * CONTEXT:
2030e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2031e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2032e22bee78STejun Heo  *
2033e22bee78STejun Heo  * RETURNS:
2034e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
2035e22bee78STejun Heo  * some action was taken.
2036e22bee78STejun Heo  */
2037e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2038e22bee78STejun Heo {
203963d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2040e22bee78STejun Heo 	bool ret = false;
2041e22bee78STejun Heo 
2042ee378aa4SLai Jiangshan 	if (pool->flags & POOL_MANAGING_WORKERS)
2043e22bee78STejun Heo 		return ret;
2044e22bee78STejun Heo 
2045552a37e9SLai Jiangshan 	pool->flags |= POOL_MANAGING_WORKERS;
2046ee378aa4SLai Jiangshan 
2047ee378aa4SLai Jiangshan 	/*
2048ee378aa4SLai Jiangshan 	 * To simplify both worker management and CPU hotplug, hold off
2049ee378aa4SLai Jiangshan 	 * management while hotplug is in progress.  CPU hotplug path can't
2050ee378aa4SLai Jiangshan 	 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2051ee378aa4SLai Jiangshan 	 * lead to idle worker depletion (all become busy thinking someone
2052ee378aa4SLai Jiangshan 	 * else is managing) which in turn can result in deadlock under
2053b2eb83d1SLai Jiangshan 	 * extreme circumstances.  Use @pool->assoc_mutex to synchronize
2054ee378aa4SLai Jiangshan 	 * manager against CPU hotplug.
2055ee378aa4SLai Jiangshan 	 *
2056b2eb83d1SLai Jiangshan 	 * assoc_mutex would always be free unless CPU hotplug is in
2057ee378aa4SLai Jiangshan 	 * progress.  trylock first without dropping @gcwq->lock.
2058ee378aa4SLai Jiangshan 	 */
2059b2eb83d1SLai Jiangshan 	if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
2060ee378aa4SLai Jiangshan 		spin_unlock_irq(&pool->gcwq->lock);
2061b2eb83d1SLai Jiangshan 		mutex_lock(&pool->assoc_mutex);
2062ee378aa4SLai Jiangshan 		/*
2063ee378aa4SLai Jiangshan 		 * CPU hotplug could have happened while we were waiting
2064b2eb83d1SLai Jiangshan 		 * for assoc_mutex.  Hotplug itself can't handle us
2065ee378aa4SLai Jiangshan 		 * because manager isn't either on idle or busy list, and
2066ee378aa4SLai Jiangshan 		 * @gcwq's state and ours could have deviated.
2067ee378aa4SLai Jiangshan 		 *
2068b2eb83d1SLai Jiangshan 		 * As hotplug is now excluded via assoc_mutex, we can
2069ee378aa4SLai Jiangshan 		 * simply try to bind.  It will succeed or fail depending
2070ee378aa4SLai Jiangshan 		 * on @gcwq's current state.  Try it and adjust
2071ee378aa4SLai Jiangshan 		 * %WORKER_UNBOUND accordingly.
2072ee378aa4SLai Jiangshan 		 */
2073ee378aa4SLai Jiangshan 		if (worker_maybe_bind_and_lock(worker))
2074ee378aa4SLai Jiangshan 			worker->flags &= ~WORKER_UNBOUND;
2075ee378aa4SLai Jiangshan 		else
2076ee378aa4SLai Jiangshan 			worker->flags |= WORKER_UNBOUND;
2077ee378aa4SLai Jiangshan 
2078ee378aa4SLai Jiangshan 		ret = true;
2079ee378aa4SLai Jiangshan 	}
2080ee378aa4SLai Jiangshan 
208111ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2082e22bee78STejun Heo 
2083e22bee78STejun Heo 	/*
2084e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2085e22bee78STejun Heo 	 * on return.
2086e22bee78STejun Heo 	 */
208763d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
208863d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2089e22bee78STejun Heo 
2090552a37e9SLai Jiangshan 	pool->flags &= ~POOL_MANAGING_WORKERS;
2091b2eb83d1SLai Jiangshan 	mutex_unlock(&pool->assoc_mutex);
2092e22bee78STejun Heo 	return ret;
2093e22bee78STejun Heo }
2094e22bee78STejun Heo 
2095a62428c0STejun Heo /**
2096a62428c0STejun Heo  * process_one_work - process single work
2097c34056a3STejun Heo  * @worker: self
2098a62428c0STejun Heo  * @work: work to process
2099a62428c0STejun Heo  *
2100a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2101a62428c0STejun Heo  * process a single work including synchronization against and
2102a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2103a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2104a62428c0STejun Heo  * call this function to process a work.
2105a62428c0STejun Heo  *
2106a62428c0STejun Heo  * CONTEXT:
21078b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
2108a62428c0STejun Heo  */
2109c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
211006bd6ebfSNamhyung Kim __releases(&gcwq->lock)
211106bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
21121da177e4SLinus Torvalds {
21137e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
2114bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2115bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
2116fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
21176bb49e59SDavid Howells 	work_func_t f = work->func;
211873f53c4aSTejun Heo 	int work_color;
21197e11629dSTejun Heo 	struct worker *collision;
21204e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21214e6045f1SJohannes Berg 	/*
2122a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2123a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2124a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2125a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2126a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21274e6045f1SJohannes Berg 	 */
21284d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21294d82a1deSPeter Zijlstra 
21304d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21314e6045f1SJohannes Berg #endif
21326fec10a1STejun Heo 	/*
21336fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21346fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
21356fec10a1STejun Heo 	 * unbound or a disassociated gcwq.
21366fec10a1STejun Heo 	 */
21375f7dabfdSLai Jiangshan 	WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
21386fec10a1STejun Heo 		     !(gcwq->flags & GCWQ_DISASSOCIATED) &&
213925511a47STejun Heo 		     raw_smp_processor_id() != gcwq->cpu);
214025511a47STejun Heo 
21417e11629dSTejun Heo 	/*
21427e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21437e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21447e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21457e11629dSTejun Heo 	 * currently executing one.
21467e11629dSTejun Heo 	 */
2147*42f8570fSSasha Levin 	collision = find_worker_executing_work(gcwq, work);
21487e11629dSTejun Heo 	if (unlikely(collision)) {
21497e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21507e11629dSTejun Heo 		return;
21517e11629dSTejun Heo 	}
21521da177e4SLinus Torvalds 
21538930cabaSTejun Heo 	/* claim and dequeue */
21541da177e4SLinus Torvalds 	debug_work_deactivate(work);
2155*42f8570fSSasha Levin 	hash_add(gcwq->busy_hash, &worker->hentry, (unsigned long)worker);
2156c34056a3STejun Heo 	worker->current_work = work;
21578cca0eeaSTejun Heo 	worker->current_cwq = cwq;
215873f53c4aSTejun Heo 	work_color = get_work_color(work);
21597a22ad75STejun Heo 
2160a62428c0STejun Heo 	list_del_init(&work->entry);
2161a62428c0STejun Heo 
2162649027d7STejun Heo 	/*
2163fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2164fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2165fb0e7bebSTejun Heo 	 */
2166fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2167fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2168fb0e7bebSTejun Heo 
2169974271c4STejun Heo 	/*
2170974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
2171974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2172974271c4STejun Heo 	 */
217363d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
217463d95a91STejun Heo 		wake_up_worker(pool);
2175974271c4STejun Heo 
21768930cabaSTejun Heo 	/*
217723657bb1STejun Heo 	 * Record the last CPU and clear PENDING which should be the last
217823657bb1STejun Heo 	 * update to @work.  Also, do this inside @gcwq->lock so that
217923657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
218023657bb1STejun Heo 	 * disabled.
21818930cabaSTejun Heo 	 */
21828930cabaSTejun Heo 	set_work_cpu_and_clear_pending(work, gcwq->cpu);
21831da177e4SLinus Torvalds 
21841da177e4SLinus Torvalds 	spin_unlock_irq(&gcwq->lock);
2185365970a1SDavid Howells 
2186e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
21873295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2188e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
218965f27f38SDavid Howells 	f(work);
2190e36c886aSArjan van de Ven 	/*
2191e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2192e36c886aSArjan van de Ven 	 * point will only record its address.
2193e36c886aSArjan van de Ven 	 */
2194e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
21953295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
21963295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
21971da177e4SLinus Torvalds 
2198d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2199044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2200044c782cSValentin Ilie 		       "     last function: %pf\n",
2201044c782cSValentin Ilie 		       current->comm, preempt_count(), task_pid_nr(current), f);
2202d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2203d5abe669SPeter Zijlstra 		dump_stack();
2204d5abe669SPeter Zijlstra 	}
2205d5abe669SPeter Zijlstra 
22068b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2207a62428c0STejun Heo 
2208fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2209fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2210fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2211fb0e7bebSTejun Heo 
2212a62428c0STejun Heo 	/* we're done with it, release */
2213*42f8570fSSasha Levin 	hash_del(&worker->hentry);
2214c34056a3STejun Heo 	worker->current_work = NULL;
22158cca0eeaSTejun Heo 	worker->current_cwq = NULL;
2216b3f9f405SLai Jiangshan 	cwq_dec_nr_in_flight(cwq, work_color);
22171da177e4SLinus Torvalds }
22181da177e4SLinus Torvalds 
2219affee4b2STejun Heo /**
2220affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2221affee4b2STejun Heo  * @worker: self
2222affee4b2STejun Heo  *
2223affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2224affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2225affee4b2STejun Heo  * fetches a work from the top and executes it.
2226affee4b2STejun Heo  *
2227affee4b2STejun Heo  * CONTEXT:
22288b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2229affee4b2STejun Heo  * multiple times.
2230affee4b2STejun Heo  */
2231affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22321da177e4SLinus Torvalds {
2233affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2234affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2235a62428c0STejun Heo 						struct work_struct, entry);
2236c34056a3STejun Heo 		process_one_work(worker, work);
2237a62428c0STejun Heo 	}
22381da177e4SLinus Torvalds }
22391da177e4SLinus Torvalds 
22404690c4abSTejun Heo /**
22414690c4abSTejun Heo  * worker_thread - the worker thread function
2242c34056a3STejun Heo  * @__worker: self
22434690c4abSTejun Heo  *
2244e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2245e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2246e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2247e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2248e22bee78STejun Heo  * rescuer_thread().
22494690c4abSTejun Heo  */
2250c34056a3STejun Heo static int worker_thread(void *__worker)
22511da177e4SLinus Torvalds {
2252c34056a3STejun Heo 	struct worker *worker = __worker;
2253bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2254bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
22551da177e4SLinus Torvalds 
2256e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2257e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2258c8e55f36STejun Heo woke_up:
22598b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2260affee4b2STejun Heo 
22615f7dabfdSLai Jiangshan 	/* we are off idle list if destruction or rebind is requested */
22625f7dabfdSLai Jiangshan 	if (unlikely(list_empty(&worker->entry))) {
2263c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
226425511a47STejun Heo 
22655f7dabfdSLai Jiangshan 		/* if DIE is set, destruction is requested */
226625511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2267e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2268c8e55f36STejun Heo 			return 0;
2269c8e55f36STejun Heo 		}
2270c8e55f36STejun Heo 
22715f7dabfdSLai Jiangshan 		/* otherwise, rebind */
227225511a47STejun Heo 		idle_worker_rebind(worker);
227325511a47STejun Heo 		goto woke_up;
227425511a47STejun Heo 	}
227525511a47STejun Heo 
2276c8e55f36STejun Heo 	worker_leave_idle(worker);
2277db7bccf4STejun Heo recheck:
2278e22bee78STejun Heo 	/* no more worker necessary? */
227963d95a91STejun Heo 	if (!need_more_worker(pool))
2280e22bee78STejun Heo 		goto sleep;
2281e22bee78STejun Heo 
2282e22bee78STejun Heo 	/* do we need to manage? */
228363d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2284e22bee78STejun Heo 		goto recheck;
2285e22bee78STejun Heo 
2286c8e55f36STejun Heo 	/*
2287c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2288c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2289c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2290c8e55f36STejun Heo 	 */
2291c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2292c8e55f36STejun Heo 
2293e22bee78STejun Heo 	/*
2294e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2295e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2296e22bee78STejun Heo 	 * assumed the manager role.
2297e22bee78STejun Heo 	 */
2298e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2299e22bee78STejun Heo 
2300e22bee78STejun Heo 	do {
2301affee4b2STejun Heo 		struct work_struct *work =
2302bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2303affee4b2STejun Heo 					 struct work_struct, entry);
2304affee4b2STejun Heo 
2305c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2306affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2307affee4b2STejun Heo 			process_one_work(worker, work);
2308affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2309affee4b2STejun Heo 				process_scheduled_works(worker);
2310affee4b2STejun Heo 		} else {
2311c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2312affee4b2STejun Heo 			process_scheduled_works(worker);
2313affee4b2STejun Heo 		}
231463d95a91STejun Heo 	} while (keep_working(pool));
2315affee4b2STejun Heo 
2316e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2317d313dd85STejun Heo sleep:
231863d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2319e22bee78STejun Heo 		goto recheck;
2320d313dd85STejun Heo 
2321c8e55f36STejun Heo 	/*
2322e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2323e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2324e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2325e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2326e22bee78STejun Heo 	 * prevent losing any event.
2327c8e55f36STejun Heo 	 */
2328c8e55f36STejun Heo 	worker_enter_idle(worker);
2329c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
23308b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23311da177e4SLinus Torvalds 	schedule();
2332c8e55f36STejun Heo 	goto woke_up;
23331da177e4SLinus Torvalds }
23341da177e4SLinus Torvalds 
2335e22bee78STejun Heo /**
2336e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2337e22bee78STejun Heo  * @__wq: the associated workqueue
2338e22bee78STejun Heo  *
2339e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2340e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2341e22bee78STejun Heo  *
2342e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2343e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2344e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2345e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2346e22bee78STejun Heo  * the problem rescuer solves.
2347e22bee78STejun Heo  *
2348e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2349e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2350e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2351e22bee78STejun Heo  *
2352e22bee78STejun Heo  * This should happen rarely.
2353e22bee78STejun Heo  */
2354e22bee78STejun Heo static int rescuer_thread(void *__wq)
2355e22bee78STejun Heo {
2356e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2357e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2358e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2359f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2360e22bee78STejun Heo 	unsigned int cpu;
2361e22bee78STejun Heo 
2362e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2363e22bee78STejun Heo repeat:
2364e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
23651da177e4SLinus Torvalds 
2366412d32e6SMike Galbraith 	if (kthread_should_stop()) {
2367412d32e6SMike Galbraith 		__set_current_state(TASK_RUNNING);
2368e22bee78STejun Heo 		return 0;
2369412d32e6SMike Galbraith 	}
23701da177e4SLinus Torvalds 
2371f3421797STejun Heo 	/*
2372f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2373f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2374f3421797STejun Heo 	 */
2375f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2376f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2377f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2378bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2379bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2380e22bee78STejun Heo 		struct work_struct *work, *n;
2381e22bee78STejun Heo 
2382e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2383f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2384e22bee78STejun Heo 
2385e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2386bd7bdd43STejun Heo 		rescuer->pool = pool;
2387e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2388e22bee78STejun Heo 
2389e22bee78STejun Heo 		/*
2390e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2391e22bee78STejun Heo 		 * process'em.
2392e22bee78STejun Heo 		 */
2393e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2394bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2395e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2396e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2397e22bee78STejun Heo 
2398e22bee78STejun Heo 		process_scheduled_works(rescuer);
23997576958aSTejun Heo 
24007576958aSTejun Heo 		/*
24017576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
24027576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24037576958aSTejun Heo 		 * and stalling the execution.
24047576958aSTejun Heo 		 */
240563d95a91STejun Heo 		if (keep_working(pool))
240663d95a91STejun Heo 			wake_up_worker(pool);
24077576958aSTejun Heo 
2408e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
24091da177e4SLinus Torvalds 	}
24101da177e4SLinus Torvalds 
2411e22bee78STejun Heo 	schedule();
2412e22bee78STejun Heo 	goto repeat;
24131da177e4SLinus Torvalds }
24141da177e4SLinus Torvalds 
2415fc2e4d70SOleg Nesterov struct wq_barrier {
2416fc2e4d70SOleg Nesterov 	struct work_struct	work;
2417fc2e4d70SOleg Nesterov 	struct completion	done;
2418fc2e4d70SOleg Nesterov };
2419fc2e4d70SOleg Nesterov 
2420fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2421fc2e4d70SOleg Nesterov {
2422fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2423fc2e4d70SOleg Nesterov 	complete(&barr->done);
2424fc2e4d70SOleg Nesterov }
2425fc2e4d70SOleg Nesterov 
24264690c4abSTejun Heo /**
24274690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
24284690c4abSTejun Heo  * @cwq: cwq to insert barrier into
24294690c4abSTejun Heo  * @barr: wq_barrier to insert
2430affee4b2STejun Heo  * @target: target work to attach @barr to
2431affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24324690c4abSTejun Heo  *
2433affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2434affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2435affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2436affee4b2STejun Heo  * cpu.
2437affee4b2STejun Heo  *
2438affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2439affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2440affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2441affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2442affee4b2STejun Heo  * after a work with LINKED flag set.
2443affee4b2STejun Heo  *
2444affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2445affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
24464690c4abSTejun Heo  *
24474690c4abSTejun Heo  * CONTEXT:
24488b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
24494690c4abSTejun Heo  */
245083c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2451affee4b2STejun Heo 			      struct wq_barrier *barr,
2452affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2453fc2e4d70SOleg Nesterov {
2454affee4b2STejun Heo 	struct list_head *head;
2455affee4b2STejun Heo 	unsigned int linked = 0;
2456affee4b2STejun Heo 
2457dc186ad7SThomas Gleixner 	/*
24588b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2459dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2460dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2461dc186ad7SThomas Gleixner 	 * might deadlock.
2462dc186ad7SThomas Gleixner 	 */
2463ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
246422df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2465fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
246683c22520SOleg Nesterov 
2467affee4b2STejun Heo 	/*
2468affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2469affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2470affee4b2STejun Heo 	 */
2471affee4b2STejun Heo 	if (worker)
2472affee4b2STejun Heo 		head = worker->scheduled.next;
2473affee4b2STejun Heo 	else {
2474affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2475affee4b2STejun Heo 
2476affee4b2STejun Heo 		head = target->entry.next;
2477affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2478affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2479affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2480affee4b2STejun Heo 	}
2481affee4b2STejun Heo 
2482dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2483affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2484affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2485fc2e4d70SOleg Nesterov }
2486fc2e4d70SOleg Nesterov 
248773f53c4aSTejun Heo /**
248873f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
248973f53c4aSTejun Heo  * @wq: workqueue being flushed
249073f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
249173f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
249273f53c4aSTejun Heo  *
249373f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
249473f53c4aSTejun Heo  *
249573f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
249673f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
249773f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
249873f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
249973f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
250073f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
250173f53c4aSTejun Heo  *
250273f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
250373f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
250473f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
250573f53c4aSTejun Heo  * is returned.
250673f53c4aSTejun Heo  *
250773f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
250873f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
250973f53c4aSTejun Heo  * advanced to @work_color.
251073f53c4aSTejun Heo  *
251173f53c4aSTejun Heo  * CONTEXT:
251273f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
251373f53c4aSTejun Heo  *
251473f53c4aSTejun Heo  * RETURNS:
251573f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
251673f53c4aSTejun Heo  * otherwise.
251773f53c4aSTejun Heo  */
251873f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
251973f53c4aSTejun Heo 				      int flush_color, int work_color)
25201da177e4SLinus Torvalds {
252173f53c4aSTejun Heo 	bool wait = false;
252273f53c4aSTejun Heo 	unsigned int cpu;
25231da177e4SLinus Torvalds 
252473f53c4aSTejun Heo 	if (flush_color >= 0) {
252573f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
252673f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2527dc186ad7SThomas Gleixner 	}
252814441960SOleg Nesterov 
2529f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
253073f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2531bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
25321da177e4SLinus Torvalds 
25338b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
253473f53c4aSTejun Heo 
253573f53c4aSTejun Heo 		if (flush_color >= 0) {
253673f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
253773f53c4aSTejun Heo 
253873f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
253973f53c4aSTejun Heo 				cwq->flush_color = flush_color;
254073f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
254173f53c4aSTejun Heo 				wait = true;
25421da177e4SLinus Torvalds 			}
254373f53c4aSTejun Heo 		}
254473f53c4aSTejun Heo 
254573f53c4aSTejun Heo 		if (work_color >= 0) {
254673f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
254773f53c4aSTejun Heo 			cwq->work_color = work_color;
254873f53c4aSTejun Heo 		}
254973f53c4aSTejun Heo 
25508b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
25511da177e4SLinus Torvalds 	}
25521da177e4SLinus Torvalds 
255373f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
255473f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
255573f53c4aSTejun Heo 
255673f53c4aSTejun Heo 	return wait;
255783c22520SOleg Nesterov }
25581da177e4SLinus Torvalds 
25590fcb78c2SRolf Eike Beer /**
25601da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
25610fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
25621da177e4SLinus Torvalds  *
25631da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
25641da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
25651da177e4SLinus Torvalds  *
2566fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2567fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
25681da177e4SLinus Torvalds  */
25697ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
25701da177e4SLinus Torvalds {
257173f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
257273f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
257373f53c4aSTejun Heo 		.flush_color = -1,
257473f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
257573f53c4aSTejun Heo 	};
257673f53c4aSTejun Heo 	int next_color;
2577b1f4ec17SOleg Nesterov 
25783295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
25793295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
258073f53c4aSTejun Heo 
258173f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
258273f53c4aSTejun Heo 
258373f53c4aSTejun Heo 	/*
258473f53c4aSTejun Heo 	 * Start-to-wait phase
258573f53c4aSTejun Heo 	 */
258673f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
258773f53c4aSTejun Heo 
258873f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
258973f53c4aSTejun Heo 		/*
259073f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
259173f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
259273f53c4aSTejun Heo 		 * by one.
259373f53c4aSTejun Heo 		 */
259473f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
259573f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
259673f53c4aSTejun Heo 		wq->work_color = next_color;
259773f53c4aSTejun Heo 
259873f53c4aSTejun Heo 		if (!wq->first_flusher) {
259973f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
260073f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
260173f53c4aSTejun Heo 
260273f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
260373f53c4aSTejun Heo 
260473f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
260573f53c4aSTejun Heo 						       wq->work_color)) {
260673f53c4aSTejun Heo 				/* nothing to flush, done */
260773f53c4aSTejun Heo 				wq->flush_color = next_color;
260873f53c4aSTejun Heo 				wq->first_flusher = NULL;
260973f53c4aSTejun Heo 				goto out_unlock;
261073f53c4aSTejun Heo 			}
261173f53c4aSTejun Heo 		} else {
261273f53c4aSTejun Heo 			/* wait in queue */
261373f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
261473f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
261573f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
261673f53c4aSTejun Heo 		}
261773f53c4aSTejun Heo 	} else {
261873f53c4aSTejun Heo 		/*
261973f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
262073f53c4aSTejun Heo 		 * The next flush completion will assign us
262173f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
262273f53c4aSTejun Heo 		 */
262373f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
262473f53c4aSTejun Heo 	}
262573f53c4aSTejun Heo 
262673f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
262773f53c4aSTejun Heo 
262873f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
262973f53c4aSTejun Heo 
263073f53c4aSTejun Heo 	/*
263173f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
263273f53c4aSTejun Heo 	 *
263373f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
263473f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
263573f53c4aSTejun Heo 	 */
263673f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
263773f53c4aSTejun Heo 		return;
263873f53c4aSTejun Heo 
263973f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
264073f53c4aSTejun Heo 
26414ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26424ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26434ce48b37STejun Heo 		goto out_unlock;
26444ce48b37STejun Heo 
264573f53c4aSTejun Heo 	wq->first_flusher = NULL;
264673f53c4aSTejun Heo 
264773f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
264873f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
264973f53c4aSTejun Heo 
265073f53c4aSTejun Heo 	while (true) {
265173f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
265273f53c4aSTejun Heo 
265373f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
265473f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
265573f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
265673f53c4aSTejun Heo 				break;
265773f53c4aSTejun Heo 			list_del_init(&next->list);
265873f53c4aSTejun Heo 			complete(&next->done);
265973f53c4aSTejun Heo 		}
266073f53c4aSTejun Heo 
266173f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
266273f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
266373f53c4aSTejun Heo 
266473f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
266573f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
266673f53c4aSTejun Heo 
266773f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
266873f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
266973f53c4aSTejun Heo 			/*
267073f53c4aSTejun Heo 			 * Assign the same color to all overflowed
267173f53c4aSTejun Heo 			 * flushers, advance work_color and append to
267273f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
267373f53c4aSTejun Heo 			 * phase for these overflowed flushers.
267473f53c4aSTejun Heo 			 */
267573f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
267673f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
267773f53c4aSTejun Heo 
267873f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
267973f53c4aSTejun Heo 
268073f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
268173f53c4aSTejun Heo 					      &wq->flusher_queue);
268273f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
268373f53c4aSTejun Heo 		}
268473f53c4aSTejun Heo 
268573f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
268673f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
268773f53c4aSTejun Heo 			break;
268873f53c4aSTejun Heo 		}
268973f53c4aSTejun Heo 
269073f53c4aSTejun Heo 		/*
269173f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
269273f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
269373f53c4aSTejun Heo 		 */
269473f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
269573f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
269673f53c4aSTejun Heo 
269773f53c4aSTejun Heo 		list_del_init(&next->list);
269873f53c4aSTejun Heo 		wq->first_flusher = next;
269973f53c4aSTejun Heo 
270073f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
270173f53c4aSTejun Heo 			break;
270273f53c4aSTejun Heo 
270373f53c4aSTejun Heo 		/*
270473f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
270573f53c4aSTejun Heo 		 * flusher and repeat cascading.
270673f53c4aSTejun Heo 		 */
270773f53c4aSTejun Heo 		wq->first_flusher = NULL;
270873f53c4aSTejun Heo 	}
270973f53c4aSTejun Heo 
271073f53c4aSTejun Heo out_unlock:
271173f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
27121da177e4SLinus Torvalds }
2713ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27141da177e4SLinus Torvalds 
27159c5a2ba7STejun Heo /**
27169c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27179c5a2ba7STejun Heo  * @wq: workqueue to drain
27189c5a2ba7STejun Heo  *
27199c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27209c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27219c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27229c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27239c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27249c5a2ba7STejun Heo  * takes too long.
27259c5a2ba7STejun Heo  */
27269c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27279c5a2ba7STejun Heo {
27289c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
27299c5a2ba7STejun Heo 	unsigned int cpu;
27309c5a2ba7STejun Heo 
27319c5a2ba7STejun Heo 	/*
27329c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27339c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
27349c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
27359c5a2ba7STejun Heo 	 */
27369c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27379c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
27389c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
27399c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27409c5a2ba7STejun Heo reflush:
27419c5a2ba7STejun Heo 	flush_workqueue(wq);
27429c5a2ba7STejun Heo 
27439c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27449c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2745fa2563e4SThomas Tuttle 		bool drained;
27469c5a2ba7STejun Heo 
2747bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2748fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2749bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2750fa2563e4SThomas Tuttle 
2751fa2563e4SThomas Tuttle 		if (drained)
27529c5a2ba7STejun Heo 			continue;
27539c5a2ba7STejun Heo 
27549c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27559c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2756044c782cSValentin Ilie 			pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
27579c5a2ba7STejun Heo 				wq->name, flush_cnt);
27589c5a2ba7STejun Heo 		goto reflush;
27599c5a2ba7STejun Heo 	}
27609c5a2ba7STejun Heo 
27619c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
27629c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
27639c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
27649c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
27659c5a2ba7STejun Heo }
27669c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
27679c5a2ba7STejun Heo 
2768606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2769baf59022STejun Heo {
2770baf59022STejun Heo 	struct worker *worker = NULL;
2771baf59022STejun Heo 	struct global_cwq *gcwq;
2772baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2773baf59022STejun Heo 
2774baf59022STejun Heo 	might_sleep();
2775baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2776baf59022STejun Heo 	if (!gcwq)
2777baf59022STejun Heo 		return false;
2778baf59022STejun Heo 
2779baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2780baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2781baf59022STejun Heo 		/*
2782baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2783baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2784baf59022STejun Heo 		 * are not going to wait.
2785baf59022STejun Heo 		 */
2786baf59022STejun Heo 		smp_rmb();
2787baf59022STejun Heo 		cwq = get_work_cwq(work);
2788bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2789baf59022STejun Heo 			goto already_gone;
2790606a5020STejun Heo 	} else {
2791baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2792baf59022STejun Heo 		if (!worker)
2793baf59022STejun Heo 			goto already_gone;
2794baf59022STejun Heo 		cwq = worker->current_cwq;
2795606a5020STejun Heo 	}
2796baf59022STejun Heo 
2797baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2798baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2799baf59022STejun Heo 
2800e159489bSTejun Heo 	/*
2801e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2802e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2803e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2804e159489bSTejun Heo 	 * access.
2805e159489bSTejun Heo 	 */
2806e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2807baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2808e159489bSTejun Heo 	else
2809e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2810baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2811e159489bSTejun Heo 
2812baf59022STejun Heo 	return true;
2813baf59022STejun Heo already_gone:
2814baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2815baf59022STejun Heo 	return false;
2816baf59022STejun Heo }
2817baf59022STejun Heo 
2818db700897SOleg Nesterov /**
2819401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2820401a8d04STejun Heo  * @work: the work to flush
2821db700897SOleg Nesterov  *
2822606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2823606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2824401a8d04STejun Heo  *
2825401a8d04STejun Heo  * RETURNS:
2826401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2827401a8d04STejun Heo  * %false if it was already idle.
2828db700897SOleg Nesterov  */
2829401a8d04STejun Heo bool flush_work(struct work_struct *work)
2830db700897SOleg Nesterov {
2831db700897SOleg Nesterov 	struct wq_barrier barr;
2832db700897SOleg Nesterov 
28330976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28340976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28350976dfc1SStephen Boyd 
2836606a5020STejun Heo 	if (start_flush_work(work, &barr)) {
2837db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2838dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2839401a8d04STejun Heo 		return true;
2840606a5020STejun Heo 	} else {
2841401a8d04STejun Heo 		return false;
2842db700897SOleg Nesterov 	}
2843606a5020STejun Heo }
2844db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2845db700897SOleg Nesterov 
284636e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2847401a8d04STejun Heo {
2848bbb68dfaSTejun Heo 	unsigned long flags;
28491f1f642eSOleg Nesterov 	int ret;
28501f1f642eSOleg Nesterov 
28511f1f642eSOleg Nesterov 	do {
2852bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2853bbb68dfaSTejun Heo 		/*
2854bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2855bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2856bbb68dfaSTejun Heo 		 */
2857bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2858606a5020STejun Heo 			flush_work(work);
28591f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
28601f1f642eSOleg Nesterov 
2861bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2862bbb68dfaSTejun Heo 	mark_work_canceling(work);
2863bbb68dfaSTejun Heo 	local_irq_restore(flags);
2864bbb68dfaSTejun Heo 
2865606a5020STejun Heo 	flush_work(work);
28667a22ad75STejun Heo 	clear_work_data(work);
28671f1f642eSOleg Nesterov 	return ret;
28681f1f642eSOleg Nesterov }
28691f1f642eSOleg Nesterov 
28706e84d644SOleg Nesterov /**
2871401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2872401a8d04STejun Heo  * @work: the work to cancel
28736e84d644SOleg Nesterov  *
2874401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2875401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2876401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2877401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
28781f1f642eSOleg Nesterov  *
2879401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2880401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
28816e84d644SOleg Nesterov  *
2882401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
28836e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2884401a8d04STejun Heo  *
2885401a8d04STejun Heo  * RETURNS:
2886401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
28876e84d644SOleg Nesterov  */
2888401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
28896e84d644SOleg Nesterov {
289036e227d2STejun Heo 	return __cancel_work_timer(work, false);
2891b89deed3SOleg Nesterov }
289228e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2893b89deed3SOleg Nesterov 
28946e84d644SOleg Nesterov /**
2895401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2896401a8d04STejun Heo  * @dwork: the delayed work to flush
28976e84d644SOleg Nesterov  *
2898401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2899401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2900401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29011f1f642eSOleg Nesterov  *
2902401a8d04STejun Heo  * RETURNS:
2903401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2904401a8d04STejun Heo  * %false if it was already idle.
29056e84d644SOleg Nesterov  */
2906401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2907401a8d04STejun Heo {
29088930cabaSTejun Heo 	local_irq_disable();
2909401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
29101265057fSTejun Heo 		__queue_work(dwork->cpu,
2911401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
29128930cabaSTejun Heo 	local_irq_enable();
2913401a8d04STejun Heo 	return flush_work(&dwork->work);
2914401a8d04STejun Heo }
2915401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2916401a8d04STejun Heo 
2917401a8d04STejun Heo /**
291857b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
291957b30ae7STejun Heo  * @dwork: delayed_work to cancel
292009383498STejun Heo  *
292157b30ae7STejun Heo  * Kill off a pending delayed_work.  Returns %true if @dwork was pending
292257b30ae7STejun Heo  * and canceled; %false if wasn't pending.  Note that the work callback
292357b30ae7STejun Heo  * function may still be running on return, unless it returns %true and the
292457b30ae7STejun Heo  * work doesn't re-arm itself.  Explicitly flush or use
292557b30ae7STejun Heo  * cancel_delayed_work_sync() to wait on it.
292609383498STejun Heo  *
292757b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
292809383498STejun Heo  */
292957b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
293009383498STejun Heo {
293157b30ae7STejun Heo 	unsigned long flags;
293257b30ae7STejun Heo 	int ret;
293357b30ae7STejun Heo 
293457b30ae7STejun Heo 	do {
293557b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
293657b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
293757b30ae7STejun Heo 
293857b30ae7STejun Heo 	if (unlikely(ret < 0))
293957b30ae7STejun Heo 		return false;
294057b30ae7STejun Heo 
294157b30ae7STejun Heo 	set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
294257b30ae7STejun Heo 	local_irq_restore(flags);
2943c0158ca6SDan Magenheimer 	return ret;
294409383498STejun Heo }
294557b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
294609383498STejun Heo 
294709383498STejun Heo /**
2948401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2949401a8d04STejun Heo  * @dwork: the delayed work cancel
2950401a8d04STejun Heo  *
2951401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2952401a8d04STejun Heo  *
2953401a8d04STejun Heo  * RETURNS:
2954401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2955401a8d04STejun Heo  */
2956401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
29576e84d644SOleg Nesterov {
295836e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
29596e84d644SOleg Nesterov }
2960f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
29611da177e4SLinus Torvalds 
29620fcb78c2SRolf Eike Beer /**
2963c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2964c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2965c1a220e7SZhang Rui  * @work: job to be done
2966c1a220e7SZhang Rui  *
2967c1a220e7SZhang Rui  * This puts a job on a specific cpu
2968c1a220e7SZhang Rui  */
2969d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work)
2970c1a220e7SZhang Rui {
2971d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2972c1a220e7SZhang Rui }
2973c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2974c1a220e7SZhang Rui 
29750fcb78c2SRolf Eike Beer /**
2976ae90dd5dSDave Jones  * schedule_work - put work task in global workqueue
29771da177e4SLinus Torvalds  * @work: job to be done
29781da177e4SLinus Torvalds  *
2979d4283e93STejun Heo  * Returns %false if @work was already on the kernel-global workqueue and
2980d4283e93STejun Heo  * %true otherwise.
298152bad64dSDavid Howells  *
29820fcb78c2SRolf Eike Beer  * This puts a job in the kernel-global workqueue if it was not already
29830fcb78c2SRolf Eike Beer  * queued and leaves it in the same position on the kernel-global
29840fcb78c2SRolf Eike Beer  * workqueue otherwise.
29851da177e4SLinus Torvalds  */
2986d4283e93STejun Heo bool schedule_work(struct work_struct *work)
29871da177e4SLinus Torvalds {
29880fcb78c2SRolf Eike Beer 	return queue_work(system_wq, work);
29891da177e4SLinus Torvalds }
29900fcb78c2SRolf Eike Beer EXPORT_SYMBOL(schedule_work);
29911da177e4SLinus Torvalds 
29920fcb78c2SRolf Eike Beer /**
29930fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
29940fcb78c2SRolf Eike Beer  * @cpu: cpu to use
29950fcb78c2SRolf Eike Beer  * @dwork: job to be done
29960fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
29970fcb78c2SRolf Eike Beer  *
29980fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
29990fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
30000fcb78c2SRolf Eike Beer  */
3001d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3002d4283e93STejun Heo 			      unsigned long delay)
30031da177e4SLinus Torvalds {
3004d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
30051da177e4SLinus Torvalds }
3006ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
30071da177e4SLinus Torvalds 
3008b6136773SAndrew Morton /**
30090a13c00eSTejun Heo  * schedule_delayed_work - put work task in global workqueue after delay
30100a13c00eSTejun Heo  * @dwork: job to be done
30110a13c00eSTejun Heo  * @delay: number of jiffies to wait or 0 for immediate execution
30120a13c00eSTejun Heo  *
30130a13c00eSTejun Heo  * After waiting for a given time this puts a job in the kernel-global
30140a13c00eSTejun Heo  * workqueue.
30150a13c00eSTejun Heo  */
3016d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
30170a13c00eSTejun Heo {
30180a13c00eSTejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
30190a13c00eSTejun Heo }
30200a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work);
30210a13c00eSTejun Heo 
30220a13c00eSTejun Heo /**
302331ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3024b6136773SAndrew Morton  * @func: the function to call
3025b6136773SAndrew Morton  *
302631ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
302731ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3028b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
302931ddd871STejun Heo  *
303031ddd871STejun Heo  * RETURNS:
303131ddd871STejun Heo  * 0 on success, -errno on failure.
3032b6136773SAndrew Morton  */
303365f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
303415316ba8SChristoph Lameter {
303515316ba8SChristoph Lameter 	int cpu;
303638f51568SNamhyung Kim 	struct work_struct __percpu *works;
303715316ba8SChristoph Lameter 
3038b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3039b6136773SAndrew Morton 	if (!works)
304015316ba8SChristoph Lameter 		return -ENOMEM;
3041b6136773SAndrew Morton 
304295402b38SGautham R Shenoy 	get_online_cpus();
304393981800STejun Heo 
304415316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
30459bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
30469bfb1839SIngo Molnar 
30479bfb1839SIngo Molnar 		INIT_WORK(work, func);
30488de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
304915316ba8SChristoph Lameter 	}
305093981800STejun Heo 
305193981800STejun Heo 	for_each_online_cpu(cpu)
30528616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
305393981800STejun Heo 
305495402b38SGautham R Shenoy 	put_online_cpus();
3055b6136773SAndrew Morton 	free_percpu(works);
305615316ba8SChristoph Lameter 	return 0;
305715316ba8SChristoph Lameter }
305815316ba8SChristoph Lameter 
3059eef6a7d5SAlan Stern /**
3060eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3061eef6a7d5SAlan Stern  *
3062eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3063eef6a7d5SAlan Stern  * completion.
3064eef6a7d5SAlan Stern  *
3065eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3066eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3067eef6a7d5SAlan Stern  * will lead to deadlock:
3068eef6a7d5SAlan Stern  *
3069eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3070eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3071eef6a7d5SAlan Stern  *
3072eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3073eef6a7d5SAlan Stern  *
3074eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3075eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3076eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3077eef6a7d5SAlan Stern  *
3078eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3079eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3080eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3081eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3082eef6a7d5SAlan Stern  */
30831da177e4SLinus Torvalds void flush_scheduled_work(void)
30841da177e4SLinus Torvalds {
3085d320c038STejun Heo 	flush_workqueue(system_wq);
30861da177e4SLinus Torvalds }
3087ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
30881da177e4SLinus Torvalds 
30891da177e4SLinus Torvalds /**
30901fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
30911fa44ecaSJames Bottomley  * @fn:		the function to execute
30921fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
30931fa44ecaSJames Bottomley  *		be available when the work executes)
30941fa44ecaSJames Bottomley  *
30951fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
30961fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
30971fa44ecaSJames Bottomley  *
30981fa44ecaSJames Bottomley  * Returns:	0 - function was executed
30991fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31001fa44ecaSJames Bottomley  */
310165f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31021fa44ecaSJames Bottomley {
31031fa44ecaSJames Bottomley 	if (!in_interrupt()) {
310465f27f38SDavid Howells 		fn(&ew->work);
31051fa44ecaSJames Bottomley 		return 0;
31061fa44ecaSJames Bottomley 	}
31071fa44ecaSJames Bottomley 
310865f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31091fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31101fa44ecaSJames Bottomley 
31111fa44ecaSJames Bottomley 	return 1;
31121fa44ecaSJames Bottomley }
31131fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31141fa44ecaSJames Bottomley 
31151da177e4SLinus Torvalds int keventd_up(void)
31161da177e4SLinus Torvalds {
3117d320c038STejun Heo 	return system_wq != NULL;
31181da177e4SLinus Torvalds }
31191da177e4SLinus Torvalds 
3120bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
31211da177e4SLinus Torvalds {
31223af24433SOleg Nesterov 	/*
31230f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
31240f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
31250f900049STejun Heo 	 * unsigned long long.
31263af24433SOleg Nesterov 	 */
31270f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
31280f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
31290f900049STejun Heo 				   __alignof__(unsigned long long));
31303af24433SOleg Nesterov 
3131e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3132f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3133931ac77eSTejun Heo 	else {
31340f900049STejun Heo 		void *ptr;
3135e1d8aa9fSFrederic Weisbecker 
31360f900049STejun Heo 		/*
3137f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3138f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3139f3421797STejun Heo 		 * allocated pointer which will be used for free.
31400f900049STejun Heo 		 */
3141bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3142bdbc5dd7STejun Heo 		if (ptr) {
3143bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3144bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3145bdbc5dd7STejun Heo 		}
31463af24433SOleg Nesterov 	}
31473af24433SOleg Nesterov 
31480415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3149bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3150bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
31510f900049STejun Heo }
31520f900049STejun Heo 
3153bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
315406ba38a9SOleg Nesterov {
3155e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3156bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3157f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3158f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3159f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
316006ba38a9SOleg Nesterov 	}
316106ba38a9SOleg Nesterov }
316206ba38a9SOleg Nesterov 
3163f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3164f3421797STejun Heo 			       const char *name)
3165b71ab8c2STejun Heo {
3166f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3167f3421797STejun Heo 
3168f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3169044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3170f3421797STejun Heo 			max_active, name, 1, lim);
3171b71ab8c2STejun Heo 
3172f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3173b71ab8c2STejun Heo }
3174b71ab8c2STejun Heo 
3175b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
317697e37d7bSTejun Heo 					       unsigned int flags,
31771e19ffc6STejun Heo 					       int max_active,
3178eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3179b196be89STejun Heo 					       const char *lock_name, ...)
31803af24433SOleg Nesterov {
3181b196be89STejun Heo 	va_list args, args1;
31823af24433SOleg Nesterov 	struct workqueue_struct *wq;
3183c34056a3STejun Heo 	unsigned int cpu;
3184b196be89STejun Heo 	size_t namelen;
3185b196be89STejun Heo 
3186b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3187b196be89STejun Heo 	va_start(args, lock_name);
3188b196be89STejun Heo 	va_copy(args1, args);
3189b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3190b196be89STejun Heo 
3191b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3192b196be89STejun Heo 	if (!wq)
3193b196be89STejun Heo 		goto err;
3194b196be89STejun Heo 
3195b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3196b196be89STejun Heo 	va_end(args);
3197b196be89STejun Heo 	va_end(args1);
31983af24433SOleg Nesterov 
3199f3421797STejun Heo 	/*
32006370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
32016370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
32026370a6adSTejun Heo 	 */
32036370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
32046370a6adSTejun Heo 		flags |= WQ_RESCUER;
32056370a6adSTejun Heo 
3206d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3207b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
32083af24433SOleg Nesterov 
3209b196be89STejun Heo 	/* init wq */
321097e37d7bSTejun Heo 	wq->flags = flags;
3211a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
321273f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
321373f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
321473f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
321573f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
32163af24433SOleg Nesterov 
3217eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3218cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
32193af24433SOleg Nesterov 
3220bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3221bdbc5dd7STejun Heo 		goto err;
3222bdbc5dd7STejun Heo 
3223f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
32241537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
32258b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
32263270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
32271537663fSTejun Heo 
32280f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
32293270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3230c34056a3STejun Heo 		cwq->wq = wq;
323173f53c4aSTejun Heo 		cwq->flush_color = -1;
32321e19ffc6STejun Heo 		cwq->max_active = max_active;
32331e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3234e22bee78STejun Heo 	}
32351537663fSTejun Heo 
3236e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3237e22bee78STejun Heo 		struct worker *rescuer;
3238e22bee78STejun Heo 
3239f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3240e22bee78STejun Heo 			goto err;
3241e22bee78STejun Heo 
3242e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3243e22bee78STejun Heo 		if (!rescuer)
3244e22bee78STejun Heo 			goto err;
3245e22bee78STejun Heo 
3246b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3247b196be89STejun Heo 					       wq->name);
3248e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3249e22bee78STejun Heo 			goto err;
3250e22bee78STejun Heo 
3251e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3252e22bee78STejun Heo 		wake_up_process(rescuer->task);
32533af24433SOleg Nesterov 	}
32541537663fSTejun Heo 
32553af24433SOleg Nesterov 	/*
3256a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3257a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3258a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
32593af24433SOleg Nesterov 	 */
32603af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3261a0a1a5fdSTejun Heo 
326258a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3263f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3264a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3265a0a1a5fdSTejun Heo 
32663af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3267a0a1a5fdSTejun Heo 
32683af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
32693af24433SOleg Nesterov 
32703af24433SOleg Nesterov 	return wq;
32714690c4abSTejun Heo err:
32724690c4abSTejun Heo 	if (wq) {
3273bdbc5dd7STejun Heo 		free_cwqs(wq);
3274f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3275e22bee78STejun Heo 		kfree(wq->rescuer);
32764690c4abSTejun Heo 		kfree(wq);
32773af24433SOleg Nesterov 	}
32784690c4abSTejun Heo 	return NULL;
32791da177e4SLinus Torvalds }
3280d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
32811da177e4SLinus Torvalds 
32823af24433SOleg Nesterov /**
32833af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
32843af24433SOleg Nesterov  * @wq: target workqueue
32853af24433SOleg Nesterov  *
32863af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
32873af24433SOleg Nesterov  */
32883af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
32893af24433SOleg Nesterov {
3290c8e55f36STejun Heo 	unsigned int cpu;
32913af24433SOleg Nesterov 
32929c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
32939c5a2ba7STejun Heo 	drain_workqueue(wq);
3294c8efcc25STejun Heo 
3295a0a1a5fdSTejun Heo 	/*
3296a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3297a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3298a0a1a5fdSTejun Heo 	 */
329995402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
33003af24433SOleg Nesterov 	list_del(&wq->list);
330195402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
33023af24433SOleg Nesterov 
3303e22bee78STejun Heo 	/* sanity check */
3304f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
330573f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
330673f53c4aSTejun Heo 		int i;
33073af24433SOleg Nesterov 
330873f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
330973f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
33101e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
33111e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
331273f53c4aSTejun Heo 	}
33131537663fSTejun Heo 
3314e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3315e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3316f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
33178d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3318e22bee78STejun Heo 	}
3319e22bee78STejun Heo 
3320bdbc5dd7STejun Heo 	free_cwqs(wq);
33213af24433SOleg Nesterov 	kfree(wq);
33223af24433SOleg Nesterov }
33233af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
33243af24433SOleg Nesterov 
3325dcd989cbSTejun Heo /**
33269f4bd4cdSLai Jiangshan  * cwq_set_max_active - adjust max_active of a cwq
33279f4bd4cdSLai Jiangshan  * @cwq: target cpu_workqueue_struct
33289f4bd4cdSLai Jiangshan  * @max_active: new max_active value.
33299f4bd4cdSLai Jiangshan  *
33309f4bd4cdSLai Jiangshan  * Set @cwq->max_active to @max_active and activate delayed works if
33319f4bd4cdSLai Jiangshan  * increased.
33329f4bd4cdSLai Jiangshan  *
33339f4bd4cdSLai Jiangshan  * CONTEXT:
33349f4bd4cdSLai Jiangshan  * spin_lock_irq(gcwq->lock).
33359f4bd4cdSLai Jiangshan  */
33369f4bd4cdSLai Jiangshan static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
33379f4bd4cdSLai Jiangshan {
33389f4bd4cdSLai Jiangshan 	cwq->max_active = max_active;
33399f4bd4cdSLai Jiangshan 
33409f4bd4cdSLai Jiangshan 	while (!list_empty(&cwq->delayed_works) &&
33419f4bd4cdSLai Jiangshan 	       cwq->nr_active < cwq->max_active)
33429f4bd4cdSLai Jiangshan 		cwq_activate_first_delayed(cwq);
33439f4bd4cdSLai Jiangshan }
33449f4bd4cdSLai Jiangshan 
33459f4bd4cdSLai Jiangshan /**
3346dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3347dcd989cbSTejun Heo  * @wq: target workqueue
3348dcd989cbSTejun Heo  * @max_active: new max_active value.
3349dcd989cbSTejun Heo  *
3350dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3351dcd989cbSTejun Heo  *
3352dcd989cbSTejun Heo  * CONTEXT:
3353dcd989cbSTejun Heo  * Don't call from IRQ context.
3354dcd989cbSTejun Heo  */
3355dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3356dcd989cbSTejun Heo {
3357dcd989cbSTejun Heo 	unsigned int cpu;
3358dcd989cbSTejun Heo 
3359f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3360dcd989cbSTejun Heo 
3361dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3362dcd989cbSTejun Heo 
3363dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3364dcd989cbSTejun Heo 
3365f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3366dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3367dcd989cbSTejun Heo 
3368dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3369dcd989cbSTejun Heo 
337058a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3371dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
337270369b11SLai Jiangshan 			cwq_set_max_active(get_cwq(gcwq->cpu, wq), max_active);
3373dcd989cbSTejun Heo 
3374dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3375dcd989cbSTejun Heo 	}
3376dcd989cbSTejun Heo 
3377dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3378dcd989cbSTejun Heo }
3379dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3380dcd989cbSTejun Heo 
3381dcd989cbSTejun Heo /**
3382dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3383dcd989cbSTejun Heo  * @cpu: CPU in question
3384dcd989cbSTejun Heo  * @wq: target workqueue
3385dcd989cbSTejun Heo  *
3386dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3387dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3388dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3389dcd989cbSTejun Heo  *
3390dcd989cbSTejun Heo  * RETURNS:
3391dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3392dcd989cbSTejun Heo  */
3393dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3394dcd989cbSTejun Heo {
3395dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3396dcd989cbSTejun Heo 
3397dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3398dcd989cbSTejun Heo }
3399dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3400dcd989cbSTejun Heo 
3401dcd989cbSTejun Heo /**
3402dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3403dcd989cbSTejun Heo  * @work: the work of interest
3404dcd989cbSTejun Heo  *
3405dcd989cbSTejun Heo  * RETURNS:
3406bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3407dcd989cbSTejun Heo  */
3408dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3409dcd989cbSTejun Heo {
3410dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3411dcd989cbSTejun Heo 
3412bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3413dcd989cbSTejun Heo }
3414dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3415dcd989cbSTejun Heo 
3416dcd989cbSTejun Heo /**
3417dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3418dcd989cbSTejun Heo  * @work: the work to be tested
3419dcd989cbSTejun Heo  *
3420dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3421dcd989cbSTejun Heo  * synchronization around this function and the test result is
3422dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3423dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3424dcd989cbSTejun Heo  * running state.
3425dcd989cbSTejun Heo  *
3426dcd989cbSTejun Heo  * RETURNS:
3427dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3428dcd989cbSTejun Heo  */
3429dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3430dcd989cbSTejun Heo {
3431dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3432dcd989cbSTejun Heo 	unsigned long flags;
3433dcd989cbSTejun Heo 	unsigned int ret = 0;
3434dcd989cbSTejun Heo 
3435dcd989cbSTejun Heo 	if (!gcwq)
3436999767beSJoonsoo Kim 		return 0;
3437dcd989cbSTejun Heo 
3438dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3439dcd989cbSTejun Heo 
3440dcd989cbSTejun Heo 	if (work_pending(work))
3441dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3442dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3443dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3444dcd989cbSTejun Heo 
3445dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3446dcd989cbSTejun Heo 
3447dcd989cbSTejun Heo 	return ret;
3448dcd989cbSTejun Heo }
3449dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3450dcd989cbSTejun Heo 
3451db7bccf4STejun Heo /*
3452db7bccf4STejun Heo  * CPU hotplug.
3453db7bccf4STejun Heo  *
3454e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3455e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3456e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3457e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3458e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3459e22bee78STejun Heo  * blocked draining impractical.
3460e22bee78STejun Heo  *
3461628c78e7STejun Heo  * This is solved by allowing a gcwq to be disassociated from the CPU
3462628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
3463628c78e7STejun Heo  * cpu comes back online.
3464db7bccf4STejun Heo  */
3465db7bccf4STejun Heo 
346660373152STejun Heo /* claim manager positions of all pools */
3467b2eb83d1SLai Jiangshan static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
346860373152STejun Heo {
346960373152STejun Heo 	struct worker_pool *pool;
347060373152STejun Heo 
347160373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3472b2eb83d1SLai Jiangshan 		mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
34738db25e78STejun Heo 	spin_lock_irq(&gcwq->lock);
347460373152STejun Heo }
347560373152STejun Heo 
347660373152STejun Heo /* release manager positions */
3477b2eb83d1SLai Jiangshan static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
347860373152STejun Heo {
347960373152STejun Heo 	struct worker_pool *pool;
348060373152STejun Heo 
34818db25e78STejun Heo 	spin_unlock_irq(&gcwq->lock);
348260373152STejun Heo 	for_each_worker_pool(pool, gcwq)
3483b2eb83d1SLai Jiangshan 		mutex_unlock(&pool->assoc_mutex);
348460373152STejun Heo }
348560373152STejun Heo 
3486628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work)
3487db7bccf4STejun Heo {
3488628c78e7STejun Heo 	struct global_cwq *gcwq = get_gcwq(smp_processor_id());
34894ce62e9eSTejun Heo 	struct worker_pool *pool;
3490db7bccf4STejun Heo 	struct worker *worker;
3491db7bccf4STejun Heo 	struct hlist_node *pos;
3492db7bccf4STejun Heo 	int i;
3493db7bccf4STejun Heo 
3494db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3495db7bccf4STejun Heo 
3496b2eb83d1SLai Jiangshan 	gcwq_claim_assoc_and_lock(gcwq);
3497e22bee78STejun Heo 
3498f2d5a0eeSTejun Heo 	/*
3499f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3500f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3501f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3502f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3503f2d5a0eeSTejun Heo 	 */
350460373152STejun Heo 	for_each_worker_pool(pool, gcwq)
35054ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3506403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3507db7bccf4STejun Heo 
3508db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3509403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3510db7bccf4STejun Heo 
3511f2d5a0eeSTejun Heo 	gcwq->flags |= GCWQ_DISASSOCIATED;
3512f2d5a0eeSTejun Heo 
3513b2eb83d1SLai Jiangshan 	gcwq_release_assoc_and_unlock(gcwq);
3514e22bee78STejun Heo 
3515e22bee78STejun Heo 	/*
3516628c78e7STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3517628c78e7STejun Heo 	 * sched callbacks see the %WORKER_UNBOUND flag.  This is necessary
3518628c78e7STejun Heo 	 * as scheduler callbacks may be invoked from other cpus.
3519628c78e7STejun Heo 	 */
3520628c78e7STejun Heo 	schedule();
3521628c78e7STejun Heo 
3522628c78e7STejun Heo 	/*
3523628c78e7STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After this,
3524628c78e7STejun Heo 	 * nr_running stays zero and need_more_worker() and keep_working()
3525628c78e7STejun Heo 	 * are always true as long as the worklist is not empty.  @gcwq now
3526628c78e7STejun Heo 	 * behaves as unbound (in terms of concurrency management) gcwq
3527628c78e7STejun Heo 	 * which is served by workers tied to the CPU.
3528628c78e7STejun Heo 	 *
3529628c78e7STejun Heo 	 * On return from this function, the current worker would trigger
3530628c78e7STejun Heo 	 * unbound chain execution of pending work items if other workers
3531628c78e7STejun Heo 	 * didn't already.
3532e22bee78STejun Heo 	 */
35334ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35344ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3535db7bccf4STejun Heo }
3536db7bccf4STejun Heo 
35378db25e78STejun Heo /*
35388db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
35398db25e78STejun Heo  * This will be registered high priority CPU notifier.
35408db25e78STejun Heo  */
35419fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
35421da177e4SLinus Torvalds 					       unsigned long action,
35431da177e4SLinus Torvalds 					       void *hcpu)
35441da177e4SLinus Torvalds {
35453af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3546db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
35474ce62e9eSTejun Heo 	struct worker_pool *pool;
35481da177e4SLinus Torvalds 
35498db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
35503af24433SOleg Nesterov 	case CPU_UP_PREPARE:
35514ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
35523ce63377STejun Heo 			struct worker *worker;
35533ce63377STejun Heo 
35543ce63377STejun Heo 			if (pool->nr_workers)
35553ce63377STejun Heo 				continue;
35563ce63377STejun Heo 
35573ce63377STejun Heo 			worker = create_worker(pool);
35583ce63377STejun Heo 			if (!worker)
35593ce63377STejun Heo 				return NOTIFY_BAD;
35603ce63377STejun Heo 
35613ce63377STejun Heo 			spin_lock_irq(&gcwq->lock);
35623ce63377STejun Heo 			start_worker(worker);
35633ce63377STejun Heo 			spin_unlock_irq(&gcwq->lock);
35643af24433SOleg Nesterov 		}
35651da177e4SLinus Torvalds 		break;
35661da177e4SLinus Torvalds 
356765758202STejun Heo 	case CPU_DOWN_FAILED:
356865758202STejun Heo 	case CPU_ONLINE:
3569b2eb83d1SLai Jiangshan 		gcwq_claim_assoc_and_lock(gcwq);
35708db25e78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
35718db25e78STejun Heo 		rebind_workers(gcwq);
3572b2eb83d1SLai Jiangshan 		gcwq_release_assoc_and_unlock(gcwq);
35738db25e78STejun Heo 		break;
357465758202STejun Heo 	}
357565758202STejun Heo 	return NOTIFY_OK;
357665758202STejun Heo }
357765758202STejun Heo 
357865758202STejun Heo /*
357965758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
358065758202STejun Heo  * This will be registered as low priority CPU notifier.
358165758202STejun Heo  */
35829fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
358365758202STejun Heo 						 unsigned long action,
358465758202STejun Heo 						 void *hcpu)
358565758202STejun Heo {
35868db25e78STejun Heo 	unsigned int cpu = (unsigned long)hcpu;
35878db25e78STejun Heo 	struct work_struct unbind_work;
35888db25e78STejun Heo 
358965758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
359065758202STejun Heo 	case CPU_DOWN_PREPARE:
35918db25e78STejun Heo 		/* unbinding should happen on the local CPU */
35928db25e78STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
35937635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
35948db25e78STejun Heo 		flush_work(&unbind_work);
35958db25e78STejun Heo 		break;
359665758202STejun Heo 	}
359765758202STejun Heo 	return NOTIFY_OK;
359865758202STejun Heo }
359965758202STejun Heo 
36002d3854a3SRusty Russell #ifdef CONFIG_SMP
36018ccad40dSRusty Russell 
36022d3854a3SRusty Russell struct work_for_cpu {
3603ed48ece2STejun Heo 	struct work_struct work;
36042d3854a3SRusty Russell 	long (*fn)(void *);
36052d3854a3SRusty Russell 	void *arg;
36062d3854a3SRusty Russell 	long ret;
36072d3854a3SRusty Russell };
36082d3854a3SRusty Russell 
3609ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
36102d3854a3SRusty Russell {
3611ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3612ed48ece2STejun Heo 
36132d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36142d3854a3SRusty Russell }
36152d3854a3SRusty Russell 
36162d3854a3SRusty Russell /**
36172d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36182d3854a3SRusty Russell  * @cpu: the cpu to run on
36192d3854a3SRusty Russell  * @fn: the function to run
36202d3854a3SRusty Russell  * @arg: the function arg
36212d3854a3SRusty Russell  *
362231ad9081SRusty Russell  * This will return the value @fn returns.
362331ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36246b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36252d3854a3SRusty Russell  */
36262d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36272d3854a3SRusty Russell {
3628ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
36292d3854a3SRusty Russell 
3630ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3631ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
3632ed48ece2STejun Heo 	flush_work(&wfc.work);
36332d3854a3SRusty Russell 	return wfc.ret;
36342d3854a3SRusty Russell }
36352d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36362d3854a3SRusty Russell #endif /* CONFIG_SMP */
36372d3854a3SRusty Russell 
3638a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3639e7577c50SRusty Russell 
3640a0a1a5fdSTejun Heo /**
3641a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3642a0a1a5fdSTejun Heo  *
364358a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
364458a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
364558a69cb4STejun Heo  * gcwq->worklist.
3646a0a1a5fdSTejun Heo  *
3647a0a1a5fdSTejun Heo  * CONTEXT:
36488b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3649a0a1a5fdSTejun Heo  */
3650a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3651a0a1a5fdSTejun Heo {
3652a0a1a5fdSTejun Heo 	unsigned int cpu;
3653a0a1a5fdSTejun Heo 
3654a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3655a0a1a5fdSTejun Heo 
3656a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3657a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3658a0a1a5fdSTejun Heo 
3659f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
36608b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3661bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
36628b03ae3cSTejun Heo 
36638b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
36648b03ae3cSTejun Heo 
3665db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3666db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3667db7bccf4STejun Heo 
3668a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3669a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3670a0a1a5fdSTejun Heo 
367158a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3672a0a1a5fdSTejun Heo 				cwq->max_active = 0;
36731da177e4SLinus Torvalds 		}
36748b03ae3cSTejun Heo 
36758b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3676a0a1a5fdSTejun Heo 	}
3677a0a1a5fdSTejun Heo 
3678a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3679a0a1a5fdSTejun Heo }
3680a0a1a5fdSTejun Heo 
3681a0a1a5fdSTejun Heo /**
368258a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3683a0a1a5fdSTejun Heo  *
3684a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3685a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3686a0a1a5fdSTejun Heo  *
3687a0a1a5fdSTejun Heo  * CONTEXT:
3688a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3689a0a1a5fdSTejun Heo  *
3690a0a1a5fdSTejun Heo  * RETURNS:
369158a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
369258a69cb4STejun Heo  * is complete.
3693a0a1a5fdSTejun Heo  */
3694a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3695a0a1a5fdSTejun Heo {
3696a0a1a5fdSTejun Heo 	unsigned int cpu;
3697a0a1a5fdSTejun Heo 	bool busy = false;
3698a0a1a5fdSTejun Heo 
3699a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3700a0a1a5fdSTejun Heo 
3701a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3702a0a1a5fdSTejun Heo 
3703f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3704bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3705a0a1a5fdSTejun Heo 		/*
3706a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3707a0a1a5fdSTejun Heo 		 * to peek without lock.
3708a0a1a5fdSTejun Heo 		 */
3709a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3710a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3711a0a1a5fdSTejun Heo 
371258a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3713a0a1a5fdSTejun Heo 				continue;
3714a0a1a5fdSTejun Heo 
3715a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3716a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3717a0a1a5fdSTejun Heo 				busy = true;
3718a0a1a5fdSTejun Heo 				goto out_unlock;
3719a0a1a5fdSTejun Heo 			}
3720a0a1a5fdSTejun Heo 		}
3721a0a1a5fdSTejun Heo 	}
3722a0a1a5fdSTejun Heo out_unlock:
3723a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3724a0a1a5fdSTejun Heo 	return busy;
3725a0a1a5fdSTejun Heo }
3726a0a1a5fdSTejun Heo 
3727a0a1a5fdSTejun Heo /**
3728a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3729a0a1a5fdSTejun Heo  *
3730a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
37317e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3732a0a1a5fdSTejun Heo  *
3733a0a1a5fdSTejun Heo  * CONTEXT:
37348b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3735a0a1a5fdSTejun Heo  */
3736a0a1a5fdSTejun Heo void thaw_workqueues(void)
3737a0a1a5fdSTejun Heo {
3738a0a1a5fdSTejun Heo 	unsigned int cpu;
3739a0a1a5fdSTejun Heo 
3740a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3741a0a1a5fdSTejun Heo 
3742a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3743a0a1a5fdSTejun Heo 		goto out_unlock;
3744a0a1a5fdSTejun Heo 
3745f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37468b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
37474ce62e9eSTejun Heo 		struct worker_pool *pool;
3748bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37498b03ae3cSTejun Heo 
37508b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37518b03ae3cSTejun Heo 
3752db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3753db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3754db7bccf4STejun Heo 
3755a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3756a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3757a0a1a5fdSTejun Heo 
375858a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3759a0a1a5fdSTejun Heo 				continue;
3760a0a1a5fdSTejun Heo 
3761a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
37629f4bd4cdSLai Jiangshan 			cwq_set_max_active(cwq, wq->saved_max_active);
3763a0a1a5fdSTejun Heo 		}
37648b03ae3cSTejun Heo 
37654ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
37664ce62e9eSTejun Heo 			wake_up_worker(pool);
3767e22bee78STejun Heo 
37688b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3769a0a1a5fdSTejun Heo 	}
3770a0a1a5fdSTejun Heo 
3771a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3772a0a1a5fdSTejun Heo out_unlock:
3773a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3774a0a1a5fdSTejun Heo }
3775a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3776a0a1a5fdSTejun Heo 
37776ee0578bSSuresh Siddha static int __init init_workqueues(void)
37781da177e4SLinus Torvalds {
3779c34056a3STejun Heo 	unsigned int cpu;
3780c34056a3STejun Heo 
3781b5490077STejun Heo 	/* make sure we have enough bits for OFFQ CPU number */
3782b5490077STejun Heo 	BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3783b5490077STejun Heo 		     WORK_CPU_LAST);
3784b5490077STejun Heo 
378565758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3786a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
37878b03ae3cSTejun Heo 
37888b03ae3cSTejun Heo 	/* initialize gcwqs */
3789f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37908b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
37914ce62e9eSTejun Heo 		struct worker_pool *pool;
37928b03ae3cSTejun Heo 
37938b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
37948b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3795f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
37968b03ae3cSTejun Heo 
3797*42f8570fSSasha Levin 		hash_init(gcwq->busy_hash);
3798c8e55f36STejun Heo 
37994ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38004ce62e9eSTejun Heo 			pool->gcwq = gcwq;
38014ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
38024ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
3803e22bee78STejun Heo 
38044ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
38054ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
38064ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
3807e22bee78STejun Heo 
38084ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
38094ce62e9eSTejun Heo 				    (unsigned long)pool);
38104ce62e9eSTejun Heo 
3811b2eb83d1SLai Jiangshan 			mutex_init(&pool->assoc_mutex);
38124ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
38134ce62e9eSTejun Heo 		}
38148b03ae3cSTejun Heo 	}
38158b03ae3cSTejun Heo 
3816e22bee78STejun Heo 	/* create the initial worker */
3817f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3818e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38194ce62e9eSTejun Heo 		struct worker_pool *pool;
3820e22bee78STejun Heo 
3821477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3822477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
38234ce62e9eSTejun Heo 
38244ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
38254ce62e9eSTejun Heo 			struct worker *worker;
38264ce62e9eSTejun Heo 
3827bc2ae0f5STejun Heo 			worker = create_worker(pool);
3828e22bee78STejun Heo 			BUG_ON(!worker);
3829e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3830e22bee78STejun Heo 			start_worker(worker);
3831e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3832e22bee78STejun Heo 		}
38334ce62e9eSTejun Heo 	}
3834e22bee78STejun Heo 
3835d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
38361aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
3837d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3838f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3839f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
384024d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
384124d51addSTejun Heo 					      WQ_FREEZABLE, 0);
38421aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
3843ae930e0fSTejun Heo 	       !system_unbound_wq || !system_freezable_wq);
38446ee0578bSSuresh Siddha 	return 0;
38451da177e4SLinus Torvalds }
38466ee0578bSSuresh Siddha early_initcall(init_workqueues);
3847