xref: /linux-6.15/kernel/workqueue.c (revision 11ebea50)
11da177e4SLinus Torvalds /*
2c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
31da177e4SLinus Torvalds  *
4c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
51da177e4SLinus Torvalds  *
61da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
71da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
8e1f8e874SFrancois Cami  *     Andrew Morton
91da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
101da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1189ada679SChristoph Lameter  *
12cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
13c54fce6eSTejun Heo  *
14c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
15c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
16c54fce6eSTejun Heo  *
17c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
18c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
19c54fce6eSTejun Heo  * automatically managed.  There is one worker pool for each CPU and
20c54fce6eSTejun Heo  * one extra for works which are better served by workers which are
21c54fce6eSTejun Heo  * not bound to any specific CPU.
22c54fce6eSTejun Heo  *
23c54fce6eSTejun Heo  * Please read Documentation/workqueue.txt for details.
241da177e4SLinus Torvalds  */
251da177e4SLinus Torvalds 
269984de1aSPaul Gortmaker #include <linux/export.h>
271da177e4SLinus Torvalds #include <linux/kernel.h>
281da177e4SLinus Torvalds #include <linux/sched.h>
291da177e4SLinus Torvalds #include <linux/init.h>
301da177e4SLinus Torvalds #include <linux/signal.h>
311da177e4SLinus Torvalds #include <linux/completion.h>
321da177e4SLinus Torvalds #include <linux/workqueue.h>
331da177e4SLinus Torvalds #include <linux/slab.h>
341da177e4SLinus Torvalds #include <linux/cpu.h>
351da177e4SLinus Torvalds #include <linux/notifier.h>
361da177e4SLinus Torvalds #include <linux/kthread.h>
371fa44ecaSJames Bottomley #include <linux/hardirq.h>
3846934023SChristoph Lameter #include <linux/mempolicy.h>
39341a5958SRafael J. Wysocki #include <linux/freezer.h>
40d5abe669SPeter Zijlstra #include <linux/kallsyms.h>
41d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
424e6045f1SJohannes Berg #include <linux/lockdep.h>
43c34056a3STejun Heo #include <linux/idr.h>
44e22bee78STejun Heo 
45e22bee78STejun Heo #include "workqueue_sched.h"
461da177e4SLinus Torvalds 
47c8e55f36STejun Heo enum {
48db7bccf4STejun Heo 	/* global_cwq flags */
49*11ebea50STejun Heo 	GCWQ_DISASSOCIATED	= 1 << 0,	/* cpu can't serve workers */
50*11ebea50STejun Heo 	GCWQ_FREEZING		= 1 << 1,	/* freeze in progress */
51*11ebea50STejun Heo 
52*11ebea50STejun Heo 	/* pool flags */
53*11ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
54*11ebea50STejun Heo 	POOL_MANAGING_WORKERS	= 1 << 1,	/* managing workers */
55*11ebea50STejun Heo 	POOL_HIGHPRI_PENDING	= 1 << 2,	/* highpri works on queue */
56db7bccf4STejun Heo 
57c8e55f36STejun Heo 	/* worker flags */
58c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
59c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
60c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
61e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
62db7bccf4STejun Heo 	WORKER_ROGUE		= 1 << 4,	/* not bound to any cpu */
63e22bee78STejun Heo 	WORKER_REBIND		= 1 << 5,	/* mom is home, come back */
64fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
65f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
66e22bee78STejun Heo 
67fb0e7bebSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
68f3421797STejun Heo 				  WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
69db7bccf4STejun Heo 
70db7bccf4STejun Heo 	/* gcwq->trustee_state */
71db7bccf4STejun Heo 	TRUSTEE_START		= 0,		/* start */
72db7bccf4STejun Heo 	TRUSTEE_IN_CHARGE	= 1,		/* trustee in charge of gcwq */
73db7bccf4STejun Heo 	TRUSTEE_BUTCHER		= 2,		/* butcher workers */
74db7bccf4STejun Heo 	TRUSTEE_RELEASE		= 3,		/* release workers */
75db7bccf4STejun Heo 	TRUSTEE_DONE		= 4,		/* trustee is done */
76c8e55f36STejun Heo 
77c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
78c8e55f36STejun Heo 	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
79c8e55f36STejun Heo 	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
80db7bccf4STejun Heo 
81e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
82e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
83e22bee78STejun Heo 
843233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
853233cdbdSTejun Heo 						/* call for help after 10ms
863233cdbdSTejun Heo 						   (min two ticks) */
87e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
88e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
89db7bccf4STejun Heo 	TRUSTEE_COOLDOWN	= HZ / 10,	/* for trustee draining */
901da177e4SLinus Torvalds 
911da177e4SLinus Torvalds 	/*
92e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
93e22bee78STejun Heo 	 * all cpus.  Give -20.
94e22bee78STejun Heo 	 */
95e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
96c8e55f36STejun Heo };
97c8e55f36STejun Heo 
981da177e4SLinus Torvalds /*
994690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1004690c4abSTejun Heo  *
101e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
102e41e704bSTejun Heo  *    everyone else.
1034690c4abSTejun Heo  *
104e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
105e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
106e22bee78STejun Heo  *
1078b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1084690c4abSTejun Heo  *
109e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
110e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
111e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
112f3421797STejun Heo  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
113e22bee78STejun Heo  *
11473f53c4aSTejun Heo  * F: wq->flush_mutex protected.
11573f53c4aSTejun Heo  *
1164690c4abSTejun Heo  * W: workqueue_lock protected.
1174690c4abSTejun Heo  */
1184690c4abSTejun Heo 
1198b03ae3cSTejun Heo struct global_cwq;
120bd7bdd43STejun Heo struct worker_pool;
121c34056a3STejun Heo 
122e22bee78STejun Heo /*
123e22bee78STejun Heo  * The poor guys doing the actual heavy lifting.  All on-duty workers
124e22bee78STejun Heo  * are either serving the manager role, on idle list or on busy hash.
125e22bee78STejun Heo  */
126c34056a3STejun Heo struct worker {
127c8e55f36STejun Heo 	/* on idle list while idle, on busy hash table while busy */
128c8e55f36STejun Heo 	union {
129c8e55f36STejun Heo 		struct list_head	entry;	/* L: while idle */
130c8e55f36STejun Heo 		struct hlist_node	hentry;	/* L: while busy */
131c8e55f36STejun Heo 	};
132c8e55f36STejun Heo 
133c34056a3STejun Heo 	struct work_struct	*current_work;	/* L: work being processed */
1348cca0eeaSTejun Heo 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
135affee4b2STejun Heo 	struct list_head	scheduled;	/* L: scheduled works */
136c34056a3STejun Heo 	struct task_struct	*task;		/* I: worker task */
137bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
138e22bee78STejun Heo 	/* 64 bytes boundary on 64bit, 32 on 32bit */
139e22bee78STejun Heo 	unsigned long		last_active;	/* L: last active timestamp */
140e22bee78STejun Heo 	unsigned int		flags;		/* X: flags */
141c34056a3STejun Heo 	int			id;		/* I: worker id */
142e22bee78STejun Heo 	struct work_struct	rebind_work;	/* L: rebind worker to cpu */
143c34056a3STejun Heo };
144c34056a3STejun Heo 
145bd7bdd43STejun Heo struct worker_pool {
146bd7bdd43STejun Heo 	struct global_cwq	*gcwq;		/* I: the owning gcwq */
147*11ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
148bd7bdd43STejun Heo 
149bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
150bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
151bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
152bd7bdd43STejun Heo 
153bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
154bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
155bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
156bd7bdd43STejun Heo 
157bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
158bd7bdd43STejun Heo 	struct worker		*first_idle;	/* L: first idle worker */
159bd7bdd43STejun Heo };
160bd7bdd43STejun Heo 
1614690c4abSTejun Heo /*
162e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
163e22bee78STejun Heo  * and all works are queued and processed here regardless of their
164e22bee78STejun Heo  * target workqueues.
1658b03ae3cSTejun Heo  */
1668b03ae3cSTejun Heo struct global_cwq {
1678b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1688b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
169db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
170c8e55f36STejun Heo 
171bd7bdd43STejun Heo 	/* workers are chained either in busy_hash or pool idle_list */
172c8e55f36STejun Heo 	struct hlist_head	busy_hash[BUSY_WORKER_HASH_SIZE];
173c8e55f36STejun Heo 						/* L: hash of busy workers */
174c8e55f36STejun Heo 
175bd7bdd43STejun Heo 	struct worker_pool	pool;		/* the worker pools */
176db7bccf4STejun Heo 
177db7bccf4STejun Heo 	struct task_struct	*trustee;	/* L: for gcwq shutdown */
178db7bccf4STejun Heo 	unsigned int		trustee_state;	/* L: trustee state */
179db7bccf4STejun Heo 	wait_queue_head_t	trustee_wait;	/* trustee wait */
1808b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1818b03ae3cSTejun Heo 
1828b03ae3cSTejun Heo /*
183502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1840f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1850f900049STejun Heo  * aligned at two's power of the number of flag bits.
1861da177e4SLinus Torvalds  */
1871da177e4SLinus Torvalds struct cpu_workqueue_struct {
188bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1894690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
19073f53c4aSTejun Heo 	int			work_color;	/* L: current color */
19173f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
19273f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
19373f53c4aSTejun Heo 						/* L: nr of in_flight works */
1941e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
195a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
1961e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
1970f900049STejun Heo };
1981da177e4SLinus Torvalds 
1991da177e4SLinus Torvalds /*
20073f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
20173f53c4aSTejun Heo  */
20273f53c4aSTejun Heo struct wq_flusher {
20373f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
20473f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
20573f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
20673f53c4aSTejun Heo };
2071da177e4SLinus Torvalds 
20873f53c4aSTejun Heo /*
209f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
210f2e005aaSTejun Heo  * used to determine whether there's something to be done.
211f2e005aaSTejun Heo  */
212f2e005aaSTejun Heo #ifdef CONFIG_SMP
213f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
214f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
215f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
216f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
217f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2189c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
219f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
220f2e005aaSTejun Heo #else
221f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
222f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
223f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
224f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
225f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
226f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
227f2e005aaSTejun Heo #endif
2281da177e4SLinus Torvalds 
2291da177e4SLinus Torvalds /*
2301da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2311da177e4SLinus Torvalds  * per-CPU workqueues:
2321da177e4SLinus Torvalds  */
2331da177e4SLinus Torvalds struct workqueue_struct {
2349c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
235bdbc5dd7STejun Heo 	union {
236bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
237bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
238bdbc5dd7STejun Heo 		unsigned long				v;
239bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2404690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
24173f53c4aSTejun Heo 
24273f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
24373f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
24473f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
24573f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
24673f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
24773f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
24873f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
24973f53c4aSTejun Heo 
250f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
251e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
252e22bee78STejun Heo 
2539c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
254dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2554e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2564e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2574e6045f1SJohannes Berg #endif
258b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2591da177e4SLinus Torvalds };
2601da177e4SLinus Torvalds 
261d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
262d320c038STejun Heo struct workqueue_struct *system_long_wq __read_mostly;
263d320c038STejun Heo struct workqueue_struct *system_nrt_wq __read_mostly;
264f3421797STejun Heo struct workqueue_struct *system_unbound_wq __read_mostly;
26524d51addSTejun Heo struct workqueue_struct *system_freezable_wq __read_mostly;
26662d3c543SAlan Stern struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
267d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
268d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
269d320c038STejun Heo EXPORT_SYMBOL_GPL(system_nrt_wq);
270f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
27124d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
27262d3c543SAlan Stern EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
273d320c038STejun Heo 
27497bd2347STejun Heo #define CREATE_TRACE_POINTS
27597bd2347STejun Heo #include <trace/events/workqueue.h>
27697bd2347STejun Heo 
277db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
278db7bccf4STejun Heo 	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
279db7bccf4STejun Heo 		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
280db7bccf4STejun Heo 
281f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
282f3421797STejun Heo 				  unsigned int sw)
283f3421797STejun Heo {
284f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
285f3421797STejun Heo 		if (sw & 1) {
286f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
287f3421797STejun Heo 			if (cpu < nr_cpu_ids)
288f3421797STejun Heo 				return cpu;
289f3421797STejun Heo 		}
290f3421797STejun Heo 		if (sw & 2)
291f3421797STejun Heo 			return WORK_CPU_UNBOUND;
292f3421797STejun Heo 	}
293f3421797STejun Heo 	return WORK_CPU_NONE;
294f3421797STejun Heo }
295f3421797STejun Heo 
296f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
297f3421797STejun Heo 				struct workqueue_struct *wq)
298f3421797STejun Heo {
299f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
300f3421797STejun Heo }
301f3421797STejun Heo 
30209884951STejun Heo /*
30309884951STejun Heo  * CPU iterators
30409884951STejun Heo  *
30509884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
30609884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
30709884951STejun Heo  * specific CPU.  The following iterators are similar to
30809884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
30909884951STejun Heo  *
31009884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
31109884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
31209884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
31309884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
31409884951STejun Heo  */
315f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
316f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
317f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
318f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
319f3421797STejun Heo 
320f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
321f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
322f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
323f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
324f3421797STejun Heo 
325f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
326f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
327f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
328f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
329f3421797STejun Heo 
330dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
331dc186ad7SThomas Gleixner 
332dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
333dc186ad7SThomas Gleixner 
33499777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
33599777288SStanislaw Gruszka {
33699777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
33799777288SStanislaw Gruszka }
33899777288SStanislaw Gruszka 
339dc186ad7SThomas Gleixner /*
340dc186ad7SThomas Gleixner  * fixup_init is called when:
341dc186ad7SThomas Gleixner  * - an active object is initialized
342dc186ad7SThomas Gleixner  */
343dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
344dc186ad7SThomas Gleixner {
345dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
346dc186ad7SThomas Gleixner 
347dc186ad7SThomas Gleixner 	switch (state) {
348dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
349dc186ad7SThomas Gleixner 		cancel_work_sync(work);
350dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
351dc186ad7SThomas Gleixner 		return 1;
352dc186ad7SThomas Gleixner 	default:
353dc186ad7SThomas Gleixner 		return 0;
354dc186ad7SThomas Gleixner 	}
355dc186ad7SThomas Gleixner }
356dc186ad7SThomas Gleixner 
357dc186ad7SThomas Gleixner /*
358dc186ad7SThomas Gleixner  * fixup_activate is called when:
359dc186ad7SThomas Gleixner  * - an active object is activated
360dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
361dc186ad7SThomas Gleixner  */
362dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
363dc186ad7SThomas Gleixner {
364dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
365dc186ad7SThomas Gleixner 
366dc186ad7SThomas Gleixner 	switch (state) {
367dc186ad7SThomas Gleixner 
368dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
369dc186ad7SThomas Gleixner 		/*
370dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
371dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
372dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
373dc186ad7SThomas Gleixner 		 */
37422df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
375dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
376dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
377dc186ad7SThomas Gleixner 			return 0;
378dc186ad7SThomas Gleixner 		}
379dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
380dc186ad7SThomas Gleixner 		return 0;
381dc186ad7SThomas Gleixner 
382dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
383dc186ad7SThomas Gleixner 		WARN_ON(1);
384dc186ad7SThomas Gleixner 
385dc186ad7SThomas Gleixner 	default:
386dc186ad7SThomas Gleixner 		return 0;
387dc186ad7SThomas Gleixner 	}
388dc186ad7SThomas Gleixner }
389dc186ad7SThomas Gleixner 
390dc186ad7SThomas Gleixner /*
391dc186ad7SThomas Gleixner  * fixup_free is called when:
392dc186ad7SThomas Gleixner  * - an active object is freed
393dc186ad7SThomas Gleixner  */
394dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
395dc186ad7SThomas Gleixner {
396dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
397dc186ad7SThomas Gleixner 
398dc186ad7SThomas Gleixner 	switch (state) {
399dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
400dc186ad7SThomas Gleixner 		cancel_work_sync(work);
401dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
402dc186ad7SThomas Gleixner 		return 1;
403dc186ad7SThomas Gleixner 	default:
404dc186ad7SThomas Gleixner 		return 0;
405dc186ad7SThomas Gleixner 	}
406dc186ad7SThomas Gleixner }
407dc186ad7SThomas Gleixner 
408dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
409dc186ad7SThomas Gleixner 	.name		= "work_struct",
41099777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
411dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
412dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
413dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
414dc186ad7SThomas Gleixner };
415dc186ad7SThomas Gleixner 
416dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
417dc186ad7SThomas Gleixner {
418dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
419dc186ad7SThomas Gleixner }
420dc186ad7SThomas Gleixner 
421dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
422dc186ad7SThomas Gleixner {
423dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
424dc186ad7SThomas Gleixner }
425dc186ad7SThomas Gleixner 
426dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
427dc186ad7SThomas Gleixner {
428dc186ad7SThomas Gleixner 	if (onstack)
429dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
430dc186ad7SThomas Gleixner 	else
431dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
432dc186ad7SThomas Gleixner }
433dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
434dc186ad7SThomas Gleixner 
435dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
436dc186ad7SThomas Gleixner {
437dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
438dc186ad7SThomas Gleixner }
439dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
440dc186ad7SThomas Gleixner 
441dc186ad7SThomas Gleixner #else
442dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
443dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
444dc186ad7SThomas Gleixner #endif
445dc186ad7SThomas Gleixner 
44695402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
44795402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4481da177e4SLinus Torvalds static LIST_HEAD(workqueues);
449a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4501da177e4SLinus Torvalds 
45114441960SOleg Nesterov /*
452e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
453e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
454e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
45514441960SOleg Nesterov  */
4568b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
457e22bee78STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
458f756d5e2SNathan Lynch 
459f3421797STejun Heo /*
460f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
461f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
462f3421797STejun Heo  * workers have WORKER_UNBOUND set.
463f3421797STejun Heo  */
464f3421797STejun Heo static struct global_cwq unbound_global_cwq;
465f3421797STejun Heo static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0);	/* always 0 */
466f3421797STejun Heo 
467c34056a3STejun Heo static int worker_thread(void *__worker);
4681da177e4SLinus Torvalds 
4698b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4701da177e4SLinus Torvalds {
471f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4728b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
473f3421797STejun Heo 	else
474f3421797STejun Heo 		return &unbound_global_cwq;
4751da177e4SLinus Torvalds }
4761da177e4SLinus Torvalds 
47763d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
478b1f4ec17SOleg Nesterov {
47963d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
48063d95a91STejun Heo 
481f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
482e22bee78STejun Heo 		return &per_cpu(gcwq_nr_running, cpu);
483f3421797STejun Heo 	else
484f3421797STejun Heo 		return &unbound_gcwq_nr_running;
485b1f4ec17SOleg Nesterov }
486b1f4ec17SOleg Nesterov 
4874690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
4884690c4abSTejun Heo 					    struct workqueue_struct *wq)
489a848e3b6SOleg Nesterov {
490f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
491e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
492bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
493f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
494f3421797STejun Heo 		return wq->cpu_wq.single;
495f3421797STejun Heo 	return NULL;
496f3421797STejun Heo }
497a848e3b6SOleg Nesterov 
49873f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
49973f53c4aSTejun Heo {
50073f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
50173f53c4aSTejun Heo }
50273f53c4aSTejun Heo 
50373f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
50473f53c4aSTejun Heo {
50573f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
50673f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
50773f53c4aSTejun Heo }
50873f53c4aSTejun Heo 
50973f53c4aSTejun Heo static int work_next_color(int color)
51073f53c4aSTejun Heo {
51173f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5121da177e4SLinus Torvalds }
5131da177e4SLinus Torvalds 
5144594bf15SDavid Howells /*
515e120153dSTejun Heo  * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
516e120153dSTejun Heo  * work is on queue.  Once execution starts, WORK_STRUCT_CWQ is
517e120153dSTejun Heo  * cleared and the work data contains the cpu number it was last on.
5187a22ad75STejun Heo  *
5197a22ad75STejun Heo  * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
5207a22ad75STejun Heo  * cwq, cpu or clear work->data.  These functions should only be
5217a22ad75STejun Heo  * called while the work is owned - ie. while the PENDING bit is set.
5227a22ad75STejun Heo  *
5237a22ad75STejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq
5247a22ad75STejun Heo  * corresponding to a work.  gcwq is available once the work has been
5257a22ad75STejun Heo  * queued anywhere after initialization.  cwq is available only from
5267a22ad75STejun Heo  * queueing until execution starts.
5274594bf15SDavid Howells  */
5287a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5297a22ad75STejun Heo 				 unsigned long flags)
5307a22ad75STejun Heo {
5317a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5327a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5337a22ad75STejun Heo }
5347a22ad75STejun Heo 
5357a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5364690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5374690c4abSTejun Heo 			 unsigned long extra_flags)
538365970a1SDavid Howells {
5397a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
540e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
541365970a1SDavid Howells }
542365970a1SDavid Howells 
5437a22ad75STejun Heo static void set_work_cpu(struct work_struct *work, unsigned int cpu)
5444d707b9fSOleg Nesterov {
5457a22ad75STejun Heo 	set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
5464d707b9fSOleg Nesterov }
5474d707b9fSOleg Nesterov 
5487a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
549365970a1SDavid Howells {
5507a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5517a22ad75STejun Heo }
5527a22ad75STejun Heo 
5537a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5547a22ad75STejun Heo {
555e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5567a22ad75STejun Heo 
557e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
558e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
559e120153dSTejun Heo 	else
560e120153dSTejun Heo 		return NULL;
5617a22ad75STejun Heo }
5627a22ad75STejun Heo 
5637a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5647a22ad75STejun Heo {
565e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5667a22ad75STejun Heo 	unsigned int cpu;
5677a22ad75STejun Heo 
568e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
569e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
570bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
5717a22ad75STejun Heo 
5727a22ad75STejun Heo 	cpu = data >> WORK_STRUCT_FLAG_BITS;
573bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
5747a22ad75STejun Heo 		return NULL;
5757a22ad75STejun Heo 
576f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
5777a22ad75STejun Heo 	return get_gcwq(cpu);
578365970a1SDavid Howells }
579365970a1SDavid Howells 
580e22bee78STejun Heo /*
581e22bee78STejun Heo  * Policy functions.  These define the policies on how the global
582e22bee78STejun Heo  * worker pool is managed.  Unless noted otherwise, these functions
583e22bee78STejun Heo  * assume that they're being called with gcwq->lock held.
584e22bee78STejun Heo  */
585e22bee78STejun Heo 
58663d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
587649027d7STejun Heo {
58863d95a91STejun Heo 	return !atomic_read(get_pool_nr_running(pool)) ||
589*11ebea50STejun Heo 		(pool->flags & POOL_HIGHPRI_PENDING);
590649027d7STejun Heo }
591649027d7STejun Heo 
592e22bee78STejun Heo /*
593e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
594e22bee78STejun Heo  * running workers.
595974271c4STejun Heo  *
596974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
597974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
598974271c4STejun Heo  * worklist isn't empty.
599e22bee78STejun Heo  */
60063d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
601e22bee78STejun Heo {
60263d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
603e22bee78STejun Heo }
604e22bee78STejun Heo 
605e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
60663d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
607e22bee78STejun Heo {
60863d95a91STejun Heo 	return pool->nr_idle;
609e22bee78STejun Heo }
610e22bee78STejun Heo 
611e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
61263d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
613e22bee78STejun Heo {
61463d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
615e22bee78STejun Heo 
61663d95a91STejun Heo 	return !list_empty(&pool->worklist) &&
61730310045STejun Heo 		(atomic_read(nr_running) <= 1 ||
618*11ebea50STejun Heo 		 (pool->flags & POOL_HIGHPRI_PENDING));
619e22bee78STejun Heo }
620e22bee78STejun Heo 
621e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
62263d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
623e22bee78STejun Heo {
62463d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
625e22bee78STejun Heo }
626e22bee78STejun Heo 
627e22bee78STejun Heo /* Do I need to be the manager? */
62863d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
629e22bee78STejun Heo {
63063d95a91STejun Heo 	return need_to_create_worker(pool) ||
631*11ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
632e22bee78STejun Heo }
633e22bee78STejun Heo 
634e22bee78STejun Heo /* Do we have too many workers and should some go away? */
63563d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
636e22bee78STejun Heo {
637*11ebea50STejun Heo 	bool managing = pool->flags & POOL_MANAGING_WORKERS;
63863d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
63963d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
640e22bee78STejun Heo 
641e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
642e22bee78STejun Heo }
643e22bee78STejun Heo 
644e22bee78STejun Heo /*
645e22bee78STejun Heo  * Wake up functions.
646e22bee78STejun Heo  */
647e22bee78STejun Heo 
6487e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
64963d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
6507e11629dSTejun Heo {
65163d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
6527e11629dSTejun Heo 		return NULL;
6537e11629dSTejun Heo 
65463d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
6557e11629dSTejun Heo }
6567e11629dSTejun Heo 
6577e11629dSTejun Heo /**
6587e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
65963d95a91STejun Heo  * @pool: worker pool to wake worker from
6607e11629dSTejun Heo  *
66163d95a91STejun Heo  * Wake up the first idle worker of @pool.
6627e11629dSTejun Heo  *
6637e11629dSTejun Heo  * CONTEXT:
6647e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
6657e11629dSTejun Heo  */
66663d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
6677e11629dSTejun Heo {
66863d95a91STejun Heo 	struct worker *worker = first_worker(pool);
6697e11629dSTejun Heo 
6707e11629dSTejun Heo 	if (likely(worker))
6717e11629dSTejun Heo 		wake_up_process(worker->task);
6727e11629dSTejun Heo }
6737e11629dSTejun Heo 
6744690c4abSTejun Heo /**
675e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
676e22bee78STejun Heo  * @task: task waking up
677e22bee78STejun Heo  * @cpu: CPU @task is waking up to
678e22bee78STejun Heo  *
679e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
680e22bee78STejun Heo  * being awoken.
681e22bee78STejun Heo  *
682e22bee78STejun Heo  * CONTEXT:
683e22bee78STejun Heo  * spin_lock_irq(rq->lock)
684e22bee78STejun Heo  */
685e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
686e22bee78STejun Heo {
687e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
688e22bee78STejun Heo 
6892d64672eSSteven Rostedt 	if (!(worker->flags & WORKER_NOT_RUNNING))
69063d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
691e22bee78STejun Heo }
692e22bee78STejun Heo 
693e22bee78STejun Heo /**
694e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
695e22bee78STejun Heo  * @task: task going to sleep
696e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
697e22bee78STejun Heo  *
698e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
699e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
700e22bee78STejun Heo  * returning pointer to its task.
701e22bee78STejun Heo  *
702e22bee78STejun Heo  * CONTEXT:
703e22bee78STejun Heo  * spin_lock_irq(rq->lock)
704e22bee78STejun Heo  *
705e22bee78STejun Heo  * RETURNS:
706e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
707e22bee78STejun Heo  */
708e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
709e22bee78STejun Heo 				       unsigned int cpu)
710e22bee78STejun Heo {
711e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
712bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
71363d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
714e22bee78STejun Heo 
7152d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
716e22bee78STejun Heo 		return NULL;
717e22bee78STejun Heo 
718e22bee78STejun Heo 	/* this can only happen on the local cpu */
719e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
720e22bee78STejun Heo 
721e22bee78STejun Heo 	/*
722e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
723e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
724e22bee78STejun Heo 	 * Please read comment there.
725e22bee78STejun Heo 	 *
726e22bee78STejun Heo 	 * NOT_RUNNING is clear.  This means that trustee is not in
727e22bee78STejun Heo 	 * charge and we're running on the local cpu w/ rq lock held
728e22bee78STejun Heo 	 * and preemption disabled, which in turn means that none else
729e22bee78STejun Heo 	 * could be manipulating idle_list, so dereferencing idle_list
730e22bee78STejun Heo 	 * without gcwq lock is safe.
731e22bee78STejun Heo 	 */
732bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
73363d95a91STejun Heo 		to_wakeup = first_worker(pool);
734e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
735e22bee78STejun Heo }
736e22bee78STejun Heo 
737e22bee78STejun Heo /**
738e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
739cb444766STejun Heo  * @worker: self
740d302f017STejun Heo  * @flags: flags to set
741d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
742d302f017STejun Heo  *
743e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
744e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
745e22bee78STejun Heo  * woken up.
746d302f017STejun Heo  *
747cb444766STejun Heo  * CONTEXT:
748cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
749d302f017STejun Heo  */
750d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
751d302f017STejun Heo 				    bool wakeup)
752d302f017STejun Heo {
753bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
754e22bee78STejun Heo 
755cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
756cb444766STejun Heo 
757e22bee78STejun Heo 	/*
758e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
759e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
760e22bee78STejun Heo 	 * @wakeup.
761e22bee78STejun Heo 	 */
762e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
763e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
76463d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
765e22bee78STejun Heo 
766e22bee78STejun Heo 		if (wakeup) {
767e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
768bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
76963d95a91STejun Heo 				wake_up_worker(pool);
770e22bee78STejun Heo 		} else
771e22bee78STejun Heo 			atomic_dec(nr_running);
772e22bee78STejun Heo 	}
773e22bee78STejun Heo 
774d302f017STejun Heo 	worker->flags |= flags;
775d302f017STejun Heo }
776d302f017STejun Heo 
777d302f017STejun Heo /**
778e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
779cb444766STejun Heo  * @worker: self
780d302f017STejun Heo  * @flags: flags to clear
781d302f017STejun Heo  *
782e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
783d302f017STejun Heo  *
784cb444766STejun Heo  * CONTEXT:
785cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
786d302f017STejun Heo  */
787d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
788d302f017STejun Heo {
78963d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
790e22bee78STejun Heo 	unsigned int oflags = worker->flags;
791e22bee78STejun Heo 
792cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
793cb444766STejun Heo 
794d302f017STejun Heo 	worker->flags &= ~flags;
795e22bee78STejun Heo 
79642c025f3STejun Heo 	/*
79742c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
79842c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
79942c025f3STejun Heo 	 * of multiple flags, not a single flag.
80042c025f3STejun Heo 	 */
801e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
802e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
80363d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
804d302f017STejun Heo }
805d302f017STejun Heo 
806d302f017STejun Heo /**
807c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
808c8e55f36STejun Heo  * @gcwq: gcwq of interest
809c8e55f36STejun Heo  * @work: work to be hashed
810c8e55f36STejun Heo  *
811c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
812c8e55f36STejun Heo  *
813c8e55f36STejun Heo  * CONTEXT:
814c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
815c8e55f36STejun Heo  *
816c8e55f36STejun Heo  * RETURNS:
817c8e55f36STejun Heo  * Pointer to the hash head.
818c8e55f36STejun Heo  */
819c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
820c8e55f36STejun Heo 					   struct work_struct *work)
821c8e55f36STejun Heo {
822c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
823c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
824c8e55f36STejun Heo 
825c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
826c8e55f36STejun Heo 	v >>= base_shift;
827c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
828c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
829c8e55f36STejun Heo 
830c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
831c8e55f36STejun Heo }
832c8e55f36STejun Heo 
833c8e55f36STejun Heo /**
8348cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
8358cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8368cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
8378cca0eeaSTejun Heo  * @work: work to find worker for
8388cca0eeaSTejun Heo  *
8398cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
8408cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
8418cca0eeaSTejun Heo  * work.
8428cca0eeaSTejun Heo  *
8438cca0eeaSTejun Heo  * CONTEXT:
8448cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8458cca0eeaSTejun Heo  *
8468cca0eeaSTejun Heo  * RETURNS:
8478cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8488cca0eeaSTejun Heo  * otherwise.
8498cca0eeaSTejun Heo  */
8508cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
8518cca0eeaSTejun Heo 						   struct hlist_head *bwh,
8528cca0eeaSTejun Heo 						   struct work_struct *work)
8538cca0eeaSTejun Heo {
8548cca0eeaSTejun Heo 	struct worker *worker;
8558cca0eeaSTejun Heo 	struct hlist_node *tmp;
8568cca0eeaSTejun Heo 
8578cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
8588cca0eeaSTejun Heo 		if (worker->current_work == work)
8598cca0eeaSTejun Heo 			return worker;
8608cca0eeaSTejun Heo 	return NULL;
8618cca0eeaSTejun Heo }
8628cca0eeaSTejun Heo 
8638cca0eeaSTejun Heo /**
8648cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8658cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8668cca0eeaSTejun Heo  * @work: work to find worker for
8678cca0eeaSTejun Heo  *
8688cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
8698cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
8708cca0eeaSTejun Heo  * function calculates @bwh itself.
8718cca0eeaSTejun Heo  *
8728cca0eeaSTejun Heo  * CONTEXT:
8738cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8748cca0eeaSTejun Heo  *
8758cca0eeaSTejun Heo  * RETURNS:
8768cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8778cca0eeaSTejun Heo  * otherwise.
8788cca0eeaSTejun Heo  */
8798cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8808cca0eeaSTejun Heo 						 struct work_struct *work)
8818cca0eeaSTejun Heo {
8828cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
8838cca0eeaSTejun Heo 					    work);
8848cca0eeaSTejun Heo }
8858cca0eeaSTejun Heo 
8868cca0eeaSTejun Heo /**
88763d95a91STejun Heo  * pool_determine_ins_pos - find insertion position
88863d95a91STejun Heo  * @pool: pool of interest
889649027d7STejun Heo  * @cwq: cwq a work is being queued for
890649027d7STejun Heo  *
89163d95a91STejun Heo  * A work for @cwq is about to be queued on @pool, determine insertion
892649027d7STejun Heo  * position for the work.  If @cwq is for HIGHPRI wq, the work is
893649027d7STejun Heo  * queued at the head of the queue but in FIFO order with respect to
894649027d7STejun Heo  * other HIGHPRI works; otherwise, at the end of the queue.  This
895*11ebea50STejun Heo  * function also sets POOL_HIGHPRI_PENDING flag to hint @pool that
896649027d7STejun Heo  * there are HIGHPRI works pending.
897649027d7STejun Heo  *
898649027d7STejun Heo  * CONTEXT:
899649027d7STejun Heo  * spin_lock_irq(gcwq->lock).
900649027d7STejun Heo  *
901649027d7STejun Heo  * RETURNS:
902649027d7STejun Heo  * Pointer to inserstion position.
903649027d7STejun Heo  */
90463d95a91STejun Heo static inline struct list_head *pool_determine_ins_pos(struct worker_pool *pool,
9051da177e4SLinus Torvalds 					       struct cpu_workqueue_struct *cwq)
9061da177e4SLinus Torvalds {
907649027d7STejun Heo 	struct work_struct *twork;
9081da177e4SLinus Torvalds 
909649027d7STejun Heo 	if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
91063d95a91STejun Heo 		return &pool->worklist;
9111da177e4SLinus Torvalds 
91263d95a91STejun Heo 	list_for_each_entry(twork, &pool->worklist, entry) {
913649027d7STejun Heo 		struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
914649027d7STejun Heo 
915649027d7STejun Heo 		if (!(tcwq->wq->flags & WQ_HIGHPRI))
916649027d7STejun Heo 			break;
9171da177e4SLinus Torvalds 	}
9181da177e4SLinus Torvalds 
919*11ebea50STejun Heo 	pool->flags |= POOL_HIGHPRI_PENDING;
920649027d7STejun Heo 	return &twork->entry;
921649027d7STejun Heo }
922649027d7STejun Heo 
923649027d7STejun Heo /**
9247e11629dSTejun Heo  * insert_work - insert a work into gcwq
9254690c4abSTejun Heo  * @cwq: cwq @work belongs to
9264690c4abSTejun Heo  * @work: work to insert
9274690c4abSTejun Heo  * @head: insertion point
9284690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
9294690c4abSTejun Heo  *
9307e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
9317e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
9324690c4abSTejun Heo  *
9334690c4abSTejun Heo  * CONTEXT:
9348b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
9351da177e4SLinus Torvalds  */
936b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
9374690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
9384690c4abSTejun Heo 			unsigned int extra_flags)
939b89deed3SOleg Nesterov {
94063d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
941e1d8aa9fSFrederic Weisbecker 
9424690c4abSTejun Heo 	/* we own @work, set data and link */
9437a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
9444690c4abSTejun Heo 
9456e84d644SOleg Nesterov 	/*
9466e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
9476e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
9486e84d644SOleg Nesterov 	 */
9496e84d644SOleg Nesterov 	smp_wmb();
9504690c4abSTejun Heo 
9511a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
952e22bee78STejun Heo 
953e22bee78STejun Heo 	/*
954e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
955e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
956e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
957e22bee78STejun Heo 	 */
958e22bee78STejun Heo 	smp_mb();
959e22bee78STejun Heo 
96063d95a91STejun Heo 	if (__need_more_worker(pool))
96163d95a91STejun Heo 		wake_up_worker(pool);
962b89deed3SOleg Nesterov }
963b89deed3SOleg Nesterov 
964c8efcc25STejun Heo /*
965c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
966c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
967c8efcc25STejun Heo  * cold paths.
968c8efcc25STejun Heo  */
969c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
970c8efcc25STejun Heo {
971c8efcc25STejun Heo 	unsigned long flags;
972c8efcc25STejun Heo 	unsigned int cpu;
973c8efcc25STejun Heo 
974c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
975c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
976c8efcc25STejun Heo 		struct worker *worker;
977c8efcc25STejun Heo 		struct hlist_node *pos;
978c8efcc25STejun Heo 		int i;
979c8efcc25STejun Heo 
980c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
981c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
982c8efcc25STejun Heo 			if (worker->task != current)
983c8efcc25STejun Heo 				continue;
984c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
985c8efcc25STejun Heo 			/*
986c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
987c8efcc25STejun Heo 			 * is headed to the same workqueue.
988c8efcc25STejun Heo 			 */
989c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
990c8efcc25STejun Heo 		}
991c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
992c8efcc25STejun Heo 	}
993c8efcc25STejun Heo 	return false;
994c8efcc25STejun Heo }
995c8efcc25STejun Heo 
9964690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
9971da177e4SLinus Torvalds 			 struct work_struct *work)
9981da177e4SLinus Torvalds {
999502ca9d8STejun Heo 	struct global_cwq *gcwq;
1000502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
10011e19ffc6STejun Heo 	struct list_head *worklist;
10028a2e8e5dSTejun Heo 	unsigned int work_flags;
10031da177e4SLinus Torvalds 	unsigned long flags;
10041da177e4SLinus Torvalds 
1005dc186ad7SThomas Gleixner 	debug_work_activate(work);
10061e19ffc6STejun Heo 
1007c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
10089c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1009c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1010e41e704bSTejun Heo 		return;
1011e41e704bSTejun Heo 
1012c7fc77f7STejun Heo 	/* determine gcwq to use */
1013c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1014c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1015c7fc77f7STejun Heo 
1016f3421797STejun Heo 		if (unlikely(cpu == WORK_CPU_UNBOUND))
1017f3421797STejun Heo 			cpu = raw_smp_processor_id();
1018f3421797STejun Heo 
101918aa9effSTejun Heo 		/*
102018aa9effSTejun Heo 		 * It's multi cpu.  If @wq is non-reentrant and @work
102118aa9effSTejun Heo 		 * was previously on a different cpu, it might still
102218aa9effSTejun Heo 		 * be running there, in which case the work needs to
102318aa9effSTejun Heo 		 * be queued on that cpu to guarantee non-reentrance.
102418aa9effSTejun Heo 		 */
1025502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
102618aa9effSTejun Heo 		if (wq->flags & WQ_NON_REENTRANT &&
102718aa9effSTejun Heo 		    (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
102818aa9effSTejun Heo 			struct worker *worker;
102918aa9effSTejun Heo 
103018aa9effSTejun Heo 			spin_lock_irqsave(&last_gcwq->lock, flags);
103118aa9effSTejun Heo 
103218aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
103318aa9effSTejun Heo 
103418aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
103518aa9effSTejun Heo 				gcwq = last_gcwq;
103618aa9effSTejun Heo 			else {
103718aa9effSTejun Heo 				/* meh... not running there, queue here */
103818aa9effSTejun Heo 				spin_unlock_irqrestore(&last_gcwq->lock, flags);
103918aa9effSTejun Heo 				spin_lock_irqsave(&gcwq->lock, flags);
104018aa9effSTejun Heo 			}
104118aa9effSTejun Heo 		} else
10428b03ae3cSTejun Heo 			spin_lock_irqsave(&gcwq->lock, flags);
1043f3421797STejun Heo 	} else {
1044f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
1045f3421797STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1046502ca9d8STejun Heo 	}
1047502ca9d8STejun Heo 
1048502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1049502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1050cdadf009STejun Heo 	trace_workqueue_queue_work(cpu, cwq, work);
1051502ca9d8STejun Heo 
1052f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1053f5b2552bSDan Carpenter 		spin_unlock_irqrestore(&gcwq->lock, flags);
1054f5b2552bSDan Carpenter 		return;
1055f5b2552bSDan Carpenter 	}
10561e19ffc6STejun Heo 
105773f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
10588a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
10591e19ffc6STejun Heo 
10601e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1061cdadf009STejun Heo 		trace_workqueue_activate_work(work);
10621e19ffc6STejun Heo 		cwq->nr_active++;
106363d95a91STejun Heo 		worklist = pool_determine_ins_pos(cwq->pool, cwq);
10648a2e8e5dSTejun Heo 	} else {
10658a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
10661e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
10678a2e8e5dSTejun Heo 	}
10681e19ffc6STejun Heo 
10698a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
10701e19ffc6STejun Heo 
10718b03ae3cSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
10721da177e4SLinus Torvalds }
10731da177e4SLinus Torvalds 
10740fcb78c2SRolf Eike Beer /**
10750fcb78c2SRolf Eike Beer  * queue_work - queue work on a workqueue
10760fcb78c2SRolf Eike Beer  * @wq: workqueue to use
10770fcb78c2SRolf Eike Beer  * @work: work to queue
10780fcb78c2SRolf Eike Beer  *
1079057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
10801da177e4SLinus Torvalds  *
108100dfcaf7SOleg Nesterov  * We queue the work to the CPU on which it was submitted, but if the CPU dies
108200dfcaf7SOleg Nesterov  * it can be processed by another CPU.
10831da177e4SLinus Torvalds  */
10847ad5b3a5SHarvey Harrison int queue_work(struct workqueue_struct *wq, struct work_struct *work)
10851da177e4SLinus Torvalds {
1086ef1ca236SOleg Nesterov 	int ret;
10871da177e4SLinus Torvalds 
1088ef1ca236SOleg Nesterov 	ret = queue_work_on(get_cpu(), wq, work);
1089a848e3b6SOleg Nesterov 	put_cpu();
1090ef1ca236SOleg Nesterov 
10911da177e4SLinus Torvalds 	return ret;
10921da177e4SLinus Torvalds }
1093ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_work);
10941da177e4SLinus Torvalds 
1095c1a220e7SZhang Rui /**
1096c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1097c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1098c1a220e7SZhang Rui  * @wq: workqueue to use
1099c1a220e7SZhang Rui  * @work: work to queue
1100c1a220e7SZhang Rui  *
1101c1a220e7SZhang Rui  * Returns 0 if @work was already on a queue, non-zero otherwise.
1102c1a220e7SZhang Rui  *
1103c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1104c1a220e7SZhang Rui  * can't go away.
1105c1a220e7SZhang Rui  */
1106c1a220e7SZhang Rui int
1107c1a220e7SZhang Rui queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1108c1a220e7SZhang Rui {
1109c1a220e7SZhang Rui 	int ret = 0;
1110c1a220e7SZhang Rui 
111122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
11124690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1113c1a220e7SZhang Rui 		ret = 1;
1114c1a220e7SZhang Rui 	}
1115c1a220e7SZhang Rui 	return ret;
1116c1a220e7SZhang Rui }
1117c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1118c1a220e7SZhang Rui 
11196d141c3fSLi Zefan static void delayed_work_timer_fn(unsigned long __data)
11201da177e4SLinus Torvalds {
112152bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
11227a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
11231da177e4SLinus Torvalds 
11244690c4abSTejun Heo 	__queue_work(smp_processor_id(), cwq->wq, &dwork->work);
11251da177e4SLinus Torvalds }
11261da177e4SLinus Torvalds 
11270fcb78c2SRolf Eike Beer /**
11280fcb78c2SRolf Eike Beer  * queue_delayed_work - queue work on a workqueue after delay
11290fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1130af9997e4SRandy Dunlap  * @dwork: delayable work to queue
11310fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11320fcb78c2SRolf Eike Beer  *
1133057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11340fcb78c2SRolf Eike Beer  */
11357ad5b3a5SHarvey Harrison int queue_delayed_work(struct workqueue_struct *wq,
113652bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11371da177e4SLinus Torvalds {
113852bad64dSDavid Howells 	if (delay == 0)
113963bc0362SOleg Nesterov 		return queue_work(wq, &dwork->work);
11401da177e4SLinus Torvalds 
114163bc0362SOleg Nesterov 	return queue_delayed_work_on(-1, wq, dwork, delay);
11421da177e4SLinus Torvalds }
1143ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work);
11441da177e4SLinus Torvalds 
11450fcb78c2SRolf Eike Beer /**
11460fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
11470fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
11480fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1149af9997e4SRandy Dunlap  * @dwork: work to queue
11500fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11510fcb78c2SRolf Eike Beer  *
1152057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11530fcb78c2SRolf Eike Beer  */
11547a6bc1cdSVenkatesh Pallipadi int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
115552bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11567a6bc1cdSVenkatesh Pallipadi {
11577a6bc1cdSVenkatesh Pallipadi 	int ret = 0;
115852bad64dSDavid Howells 	struct timer_list *timer = &dwork->timer;
115952bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
11607a6bc1cdSVenkatesh Pallipadi 
116122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1162c7fc77f7STejun Heo 		unsigned int lcpu;
11637a22ad75STejun Heo 
11647a6bc1cdSVenkatesh Pallipadi 		BUG_ON(timer_pending(timer));
11657a6bc1cdSVenkatesh Pallipadi 		BUG_ON(!list_empty(&work->entry));
11667a6bc1cdSVenkatesh Pallipadi 
11678a3e77ccSAndrew Liu 		timer_stats_timer_set_start_info(&dwork->timer);
11688a3e77ccSAndrew Liu 
11697a22ad75STejun Heo 		/*
11707a22ad75STejun Heo 		 * This stores cwq for the moment, for the timer_fn.
11717a22ad75STejun Heo 		 * Note that the work's gcwq is preserved to allow
11727a22ad75STejun Heo 		 * reentrance detection for delayed works.
11737a22ad75STejun Heo 		 */
1174c7fc77f7STejun Heo 		if (!(wq->flags & WQ_UNBOUND)) {
1175c7fc77f7STejun Heo 			struct global_cwq *gcwq = get_work_gcwq(work);
1176c7fc77f7STejun Heo 
1177c7fc77f7STejun Heo 			if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1178c7fc77f7STejun Heo 				lcpu = gcwq->cpu;
1179c7fc77f7STejun Heo 			else
1180c7fc77f7STejun Heo 				lcpu = raw_smp_processor_id();
1181c7fc77f7STejun Heo 		} else
1182c7fc77f7STejun Heo 			lcpu = WORK_CPU_UNBOUND;
1183c7fc77f7STejun Heo 
11847a22ad75STejun Heo 		set_work_cwq(work, get_cwq(lcpu, wq), 0);
1185c7fc77f7STejun Heo 
11867a6bc1cdSVenkatesh Pallipadi 		timer->expires = jiffies + delay;
118752bad64dSDavid Howells 		timer->data = (unsigned long)dwork;
11887a6bc1cdSVenkatesh Pallipadi 		timer->function = delayed_work_timer_fn;
118963bc0362SOleg Nesterov 
119063bc0362SOleg Nesterov 		if (unlikely(cpu >= 0))
11917a6bc1cdSVenkatesh Pallipadi 			add_timer_on(timer, cpu);
119263bc0362SOleg Nesterov 		else
119363bc0362SOleg Nesterov 			add_timer(timer);
11947a6bc1cdSVenkatesh Pallipadi 		ret = 1;
11957a6bc1cdSVenkatesh Pallipadi 	}
11967a6bc1cdSVenkatesh Pallipadi 	return ret;
11977a6bc1cdSVenkatesh Pallipadi }
1198ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
11991da177e4SLinus Torvalds 
1200c8e55f36STejun Heo /**
1201c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1202c8e55f36STejun Heo  * @worker: worker which is entering idle state
1203c8e55f36STejun Heo  *
1204c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1205c8e55f36STejun Heo  * necessary.
1206c8e55f36STejun Heo  *
1207c8e55f36STejun Heo  * LOCKING:
1208c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1209c8e55f36STejun Heo  */
1210c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
12111da177e4SLinus Torvalds {
1212bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1213bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1214c8e55f36STejun Heo 
1215c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1216c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1217c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1218c8e55f36STejun Heo 
1219cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1220cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1221bd7bdd43STejun Heo 	pool->nr_idle++;
1222e22bee78STejun Heo 	worker->last_active = jiffies;
1223c8e55f36STejun Heo 
1224c8e55f36STejun Heo 	/* idle_list is LIFO */
1225bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1226db7bccf4STejun Heo 
1227e22bee78STejun Heo 	if (likely(!(worker->flags & WORKER_ROGUE))) {
122863d95a91STejun Heo 		if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1229bd7bdd43STejun Heo 			mod_timer(&pool->idle_timer,
1230e22bee78STejun Heo 				  jiffies + IDLE_WORKER_TIMEOUT);
1231e22bee78STejun Heo 	} else
1232db7bccf4STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1233cb444766STejun Heo 
1234544ecf31STejun Heo 	/*
1235544ecf31STejun Heo 	 * Sanity check nr_running.  Because trustee releases gcwq->lock
1236544ecf31STejun Heo 	 * between setting %WORKER_ROGUE and zapping nr_running, the
1237544ecf31STejun Heo 	 * warning may trigger spuriously.  Check iff trustee is idle.
1238544ecf31STejun Heo 	 */
1239544ecf31STejun Heo 	WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
1240bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
124163d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1242c8e55f36STejun Heo }
1243c8e55f36STejun Heo 
1244c8e55f36STejun Heo /**
1245c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1246c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1247c8e55f36STejun Heo  *
1248c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1249c8e55f36STejun Heo  *
1250c8e55f36STejun Heo  * LOCKING:
1251c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1252c8e55f36STejun Heo  */
1253c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1254c8e55f36STejun Heo {
1255bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1256c8e55f36STejun Heo 
1257c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1258d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1259bd7bdd43STejun Heo 	pool->nr_idle--;
1260c8e55f36STejun Heo 	list_del_init(&worker->entry);
1261c8e55f36STejun Heo }
1262c8e55f36STejun Heo 
1263e22bee78STejun Heo /**
1264e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1265e22bee78STejun Heo  * @worker: self
1266e22bee78STejun Heo  *
1267e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1268e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1269e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1270e22bee78STejun Heo  * guaranteed to execute on the cpu.
1271e22bee78STejun Heo  *
1272e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1273e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1274e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1275e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1276e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1277e22bee78STejun Heo  * [dis]associated in the meantime.
1278e22bee78STejun Heo  *
1279e22bee78STejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies
1280e22bee78STejun Heo  * the binding against GCWQ_DISASSOCIATED which is set during
1281e22bee78STejun Heo  * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1282e22bee78STejun Heo  * idle state or fetches works without dropping lock, it can guarantee
1283e22bee78STejun Heo  * the scheduling requirement described in the first paragraph.
1284e22bee78STejun Heo  *
1285e22bee78STejun Heo  * CONTEXT:
1286e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1287e22bee78STejun Heo  * held.
1288e22bee78STejun Heo  *
1289e22bee78STejun Heo  * RETURNS:
1290e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1291e22bee78STejun Heo  * bound), %false if offline.
1292e22bee78STejun Heo  */
1293e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1294972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1295e22bee78STejun Heo {
1296bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1297e22bee78STejun Heo 	struct task_struct *task = worker->task;
1298e22bee78STejun Heo 
1299e22bee78STejun Heo 	while (true) {
1300e22bee78STejun Heo 		/*
1301e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1302e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1303e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1304e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1305e22bee78STejun Heo 		 */
1306f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1307e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1308e22bee78STejun Heo 
1309e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1310e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1311e22bee78STejun Heo 			return false;
1312e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1313e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1314e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1315e22bee78STejun Heo 			return true;
1316e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1317e22bee78STejun Heo 
13185035b20fSTejun Heo 		/*
13195035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
13205035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
13215035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
13225035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
13235035b20fSTejun Heo 		 */
1324e22bee78STejun Heo 		cpu_relax();
13255035b20fSTejun Heo 		cond_resched();
1326e22bee78STejun Heo 	}
1327e22bee78STejun Heo }
1328e22bee78STejun Heo 
1329e22bee78STejun Heo /*
1330e22bee78STejun Heo  * Function for worker->rebind_work used to rebind rogue busy workers
1331e22bee78STejun Heo  * to the associated cpu which is coming back online.  This is
1332e22bee78STejun Heo  * scheduled by cpu up but can race with other cpu hotplug operations
1333e22bee78STejun Heo  * and may be executed twice without intervening cpu down.
1334e22bee78STejun Heo  */
1335e22bee78STejun Heo static void worker_rebind_fn(struct work_struct *work)
1336e22bee78STejun Heo {
1337e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1338bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1339e22bee78STejun Heo 
1340e22bee78STejun Heo 	if (worker_maybe_bind_and_lock(worker))
1341e22bee78STejun Heo 		worker_clr_flags(worker, WORKER_REBIND);
1342e22bee78STejun Heo 
1343e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1344e22bee78STejun Heo }
1345e22bee78STejun Heo 
1346c34056a3STejun Heo static struct worker *alloc_worker(void)
1347c34056a3STejun Heo {
1348c34056a3STejun Heo 	struct worker *worker;
1349c34056a3STejun Heo 
1350c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1351c8e55f36STejun Heo 	if (worker) {
1352c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1353affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1354e22bee78STejun Heo 		INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1355e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1356e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1357c8e55f36STejun Heo 	}
1358c34056a3STejun Heo 	return worker;
1359c34056a3STejun Heo }
1360c34056a3STejun Heo 
1361c34056a3STejun Heo /**
1362c34056a3STejun Heo  * create_worker - create a new workqueue worker
136363d95a91STejun Heo  * @pool: pool the new worker will belong to
1364c34056a3STejun Heo  * @bind: whether to set affinity to @cpu or not
1365c34056a3STejun Heo  *
136663d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1367c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1368c34056a3STejun Heo  * destroy_worker().
1369c34056a3STejun Heo  *
1370c34056a3STejun Heo  * CONTEXT:
1371c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1372c34056a3STejun Heo  *
1373c34056a3STejun Heo  * RETURNS:
1374c34056a3STejun Heo  * Pointer to the newly created worker.
1375c34056a3STejun Heo  */
137663d95a91STejun Heo static struct worker *create_worker(struct worker_pool *pool, bool bind)
1377c34056a3STejun Heo {
137863d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1379f3421797STejun Heo 	bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
1380c34056a3STejun Heo 	struct worker *worker = NULL;
1381f3421797STejun Heo 	int id = -1;
1382c34056a3STejun Heo 
13838b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1384bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
13858b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1386bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1387c34056a3STejun Heo 			goto fail;
13888b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1389c34056a3STejun Heo 	}
13908b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1391c34056a3STejun Heo 
1392c34056a3STejun Heo 	worker = alloc_worker();
1393c34056a3STejun Heo 	if (!worker)
1394c34056a3STejun Heo 		goto fail;
1395c34056a3STejun Heo 
1396bd7bdd43STejun Heo 	worker->pool = pool;
1397c34056a3STejun Heo 	worker->id = id;
1398c34056a3STejun Heo 
1399f3421797STejun Heo 	if (!on_unbound_cpu)
140094dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
140194dcf29aSEric Dumazet 						      worker,
140294dcf29aSEric Dumazet 						      cpu_to_node(gcwq->cpu),
1403f3421797STejun Heo 						      "kworker/%u:%d", gcwq->cpu, id);
1404f3421797STejun Heo 	else
1405f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
1406f3421797STejun Heo 					      "kworker/u:%d", id);
1407c34056a3STejun Heo 	if (IS_ERR(worker->task))
1408c34056a3STejun Heo 		goto fail;
1409c34056a3STejun Heo 
1410db7bccf4STejun Heo 	/*
1411db7bccf4STejun Heo 	 * A rogue worker will become a regular one if CPU comes
1412db7bccf4STejun Heo 	 * online later on.  Make sure every worker has
1413db7bccf4STejun Heo 	 * PF_THREAD_BOUND set.
1414db7bccf4STejun Heo 	 */
1415f3421797STejun Heo 	if (bind && !on_unbound_cpu)
14168b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1417f3421797STejun Heo 	else {
1418db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1419f3421797STejun Heo 		if (on_unbound_cpu)
1420f3421797STejun Heo 			worker->flags |= WORKER_UNBOUND;
1421f3421797STejun Heo 	}
1422c34056a3STejun Heo 
1423c34056a3STejun Heo 	return worker;
1424c34056a3STejun Heo fail:
1425c34056a3STejun Heo 	if (id >= 0) {
14268b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1427bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
14288b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1429c34056a3STejun Heo 	}
1430c34056a3STejun Heo 	kfree(worker);
1431c34056a3STejun Heo 	return NULL;
1432c34056a3STejun Heo }
1433c34056a3STejun Heo 
1434c34056a3STejun Heo /**
1435c34056a3STejun Heo  * start_worker - start a newly created worker
1436c34056a3STejun Heo  * @worker: worker to start
1437c34056a3STejun Heo  *
1438c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1439c34056a3STejun Heo  *
1440c34056a3STejun Heo  * CONTEXT:
14418b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1442c34056a3STejun Heo  */
1443c34056a3STejun Heo static void start_worker(struct worker *worker)
1444c34056a3STejun Heo {
1445cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1446bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1447c8e55f36STejun Heo 	worker_enter_idle(worker);
1448c34056a3STejun Heo 	wake_up_process(worker->task);
1449c34056a3STejun Heo }
1450c34056a3STejun Heo 
1451c34056a3STejun Heo /**
1452c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1453c34056a3STejun Heo  * @worker: worker to be destroyed
1454c34056a3STejun Heo  *
1455c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1456c8e55f36STejun Heo  *
1457c8e55f36STejun Heo  * CONTEXT:
1458c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1459c34056a3STejun Heo  */
1460c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1461c34056a3STejun Heo {
1462bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1463bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1464c34056a3STejun Heo 	int id = worker->id;
1465c34056a3STejun Heo 
1466c34056a3STejun Heo 	/* sanity check frenzy */
1467c34056a3STejun Heo 	BUG_ON(worker->current_work);
1468affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1469c34056a3STejun Heo 
1470c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1471bd7bdd43STejun Heo 		pool->nr_workers--;
1472c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1473bd7bdd43STejun Heo 		pool->nr_idle--;
1474c8e55f36STejun Heo 
1475c8e55f36STejun Heo 	list_del_init(&worker->entry);
1476cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1477c8e55f36STejun Heo 
1478c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1479c8e55f36STejun Heo 
1480c34056a3STejun Heo 	kthread_stop(worker->task);
1481c34056a3STejun Heo 	kfree(worker);
1482c34056a3STejun Heo 
14838b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1484bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1485c34056a3STejun Heo }
1486c34056a3STejun Heo 
148763d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1488e22bee78STejun Heo {
148963d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
149063d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1491e22bee78STejun Heo 
1492e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1493e22bee78STejun Heo 
149463d95a91STejun Heo 	if (too_many_workers(pool)) {
1495e22bee78STejun Heo 		struct worker *worker;
1496e22bee78STejun Heo 		unsigned long expires;
1497e22bee78STejun Heo 
1498e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
149963d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1500e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1501e22bee78STejun Heo 
1502e22bee78STejun Heo 		if (time_before(jiffies, expires))
150363d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1504e22bee78STejun Heo 		else {
1505e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
1506*11ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
150763d95a91STejun Heo 			wake_up_worker(pool);
1508e22bee78STejun Heo 		}
1509e22bee78STejun Heo 	}
1510e22bee78STejun Heo 
1511e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1512e22bee78STejun Heo }
1513e22bee78STejun Heo 
1514e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1515e22bee78STejun Heo {
1516e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1517e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1518f3421797STejun Heo 	unsigned int cpu;
1519e22bee78STejun Heo 
1520e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1521e22bee78STejun Heo 		return false;
1522e22bee78STejun Heo 
1523e22bee78STejun Heo 	/* mayday mayday mayday */
1524bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1525f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1526f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1527f3421797STejun Heo 		cpu = 0;
1528f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1529e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1530e22bee78STejun Heo 	return true;
1531e22bee78STejun Heo }
1532e22bee78STejun Heo 
153363d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1534e22bee78STejun Heo {
153563d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
153663d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1537e22bee78STejun Heo 	struct work_struct *work;
1538e22bee78STejun Heo 
1539e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1540e22bee78STejun Heo 
154163d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1542e22bee78STejun Heo 		/*
1543e22bee78STejun Heo 		 * We've been trying to create a new worker but
1544e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1545e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1546e22bee78STejun Heo 		 * rescuers.
1547e22bee78STejun Heo 		 */
154863d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1549e22bee78STejun Heo 			send_mayday(work);
1550e22bee78STejun Heo 	}
1551e22bee78STejun Heo 
1552e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1553e22bee78STejun Heo 
155463d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1555e22bee78STejun Heo }
1556e22bee78STejun Heo 
1557e22bee78STejun Heo /**
1558e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
155963d95a91STejun Heo  * @pool: pool to create a new worker for
1560e22bee78STejun Heo  *
156163d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1562e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1563e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
156463d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1565e22bee78STejun Heo  * possible allocation deadlock.
1566e22bee78STejun Heo  *
1567e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1568e22bee78STejun Heo  * may_start_working() true.
1569e22bee78STejun Heo  *
1570e22bee78STejun Heo  * LOCKING:
1571e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1572e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1573e22bee78STejun Heo  * manager.
1574e22bee78STejun Heo  *
1575e22bee78STejun Heo  * RETURNS:
1576e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1577e22bee78STejun Heo  * otherwise.
1578e22bee78STejun Heo  */
157963d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
158006bd6ebfSNamhyung Kim __releases(&gcwq->lock)
158106bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1582e22bee78STejun Heo {
158363d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
158463d95a91STejun Heo 
158563d95a91STejun Heo 	if (!need_to_create_worker(pool))
1586e22bee78STejun Heo 		return false;
1587e22bee78STejun Heo restart:
15889f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
15899f9c2364STejun Heo 
1590e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
159163d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1592e22bee78STejun Heo 
1593e22bee78STejun Heo 	while (true) {
1594e22bee78STejun Heo 		struct worker *worker;
1595e22bee78STejun Heo 
159663d95a91STejun Heo 		worker = create_worker(pool, true);
1597e22bee78STejun Heo 		if (worker) {
159863d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1599e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1600e22bee78STejun Heo 			start_worker(worker);
160163d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1602e22bee78STejun Heo 			return true;
1603e22bee78STejun Heo 		}
1604e22bee78STejun Heo 
160563d95a91STejun Heo 		if (!need_to_create_worker(pool))
1606e22bee78STejun Heo 			break;
1607e22bee78STejun Heo 
1608e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1609e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
16109f9c2364STejun Heo 
161163d95a91STejun Heo 		if (!need_to_create_worker(pool))
1612e22bee78STejun Heo 			break;
1613e22bee78STejun Heo 	}
1614e22bee78STejun Heo 
161563d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1616e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
161763d95a91STejun Heo 	if (need_to_create_worker(pool))
1618e22bee78STejun Heo 		goto restart;
1619e22bee78STejun Heo 	return true;
1620e22bee78STejun Heo }
1621e22bee78STejun Heo 
1622e22bee78STejun Heo /**
1623e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
162463d95a91STejun Heo  * @pool: pool to destroy workers for
1625e22bee78STejun Heo  *
162663d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
1627e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1628e22bee78STejun Heo  *
1629e22bee78STejun Heo  * LOCKING:
1630e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1631e22bee78STejun Heo  * multiple times.  Called only from manager.
1632e22bee78STejun Heo  *
1633e22bee78STejun Heo  * RETURNS:
1634e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1635e22bee78STejun Heo  * otherwise.
1636e22bee78STejun Heo  */
163763d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
1638e22bee78STejun Heo {
1639e22bee78STejun Heo 	bool ret = false;
1640e22bee78STejun Heo 
164163d95a91STejun Heo 	while (too_many_workers(pool)) {
1642e22bee78STejun Heo 		struct worker *worker;
1643e22bee78STejun Heo 		unsigned long expires;
1644e22bee78STejun Heo 
164563d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1646e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1647e22bee78STejun Heo 
1648e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
164963d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1650e22bee78STejun Heo 			break;
1651e22bee78STejun Heo 		}
1652e22bee78STejun Heo 
1653e22bee78STejun Heo 		destroy_worker(worker);
1654e22bee78STejun Heo 		ret = true;
1655e22bee78STejun Heo 	}
1656e22bee78STejun Heo 
1657e22bee78STejun Heo 	return ret;
1658e22bee78STejun Heo }
1659e22bee78STejun Heo 
1660e22bee78STejun Heo /**
1661e22bee78STejun Heo  * manage_workers - manage worker pool
1662e22bee78STejun Heo  * @worker: self
1663e22bee78STejun Heo  *
1664e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
1665e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1666e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
1667e22bee78STejun Heo  *
1668e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
1669e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
1670e22bee78STejun Heo  * and may_start_working() is true.
1671e22bee78STejun Heo  *
1672e22bee78STejun Heo  * CONTEXT:
1673e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1674e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
1675e22bee78STejun Heo  *
1676e22bee78STejun Heo  * RETURNS:
1677e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
1678e22bee78STejun Heo  * some action was taken.
1679e22bee78STejun Heo  */
1680e22bee78STejun Heo static bool manage_workers(struct worker *worker)
1681e22bee78STejun Heo {
168263d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
168363d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1684e22bee78STejun Heo 	bool ret = false;
1685e22bee78STejun Heo 
1686*11ebea50STejun Heo 	if (pool->flags & POOL_MANAGING_WORKERS)
1687e22bee78STejun Heo 		return ret;
1688e22bee78STejun Heo 
1689*11ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
1690*11ebea50STejun Heo 	pool->flags |= POOL_MANAGING_WORKERS;
1691e22bee78STejun Heo 
1692e22bee78STejun Heo 	/*
1693e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
1694e22bee78STejun Heo 	 * on return.
1695e22bee78STejun Heo 	 */
169663d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
169763d95a91STejun Heo 	ret |= maybe_create_worker(pool);
1698e22bee78STejun Heo 
1699*11ebea50STejun Heo 	pool->flags &= ~POOL_MANAGING_WORKERS;
1700e22bee78STejun Heo 
1701e22bee78STejun Heo 	/*
1702e22bee78STejun Heo 	 * The trustee might be waiting to take over the manager
1703e22bee78STejun Heo 	 * position, tell it we're done.
1704e22bee78STejun Heo 	 */
1705e22bee78STejun Heo 	if (unlikely(gcwq->trustee))
1706e22bee78STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1707e22bee78STejun Heo 
1708e22bee78STejun Heo 	return ret;
1709e22bee78STejun Heo }
1710e22bee78STejun Heo 
1711a62428c0STejun Heo /**
1712affee4b2STejun Heo  * move_linked_works - move linked works to a list
1713affee4b2STejun Heo  * @work: start of series of works to be scheduled
1714affee4b2STejun Heo  * @head: target list to append @work to
1715affee4b2STejun Heo  * @nextp: out paramter for nested worklist walking
1716affee4b2STejun Heo  *
1717affee4b2STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1718affee4b2STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1719affee4b2STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1720affee4b2STejun Heo  *
1721affee4b2STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1722affee4b2STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1723affee4b2STejun Heo  * nested inside outer list_for_each_entry_safe().
1724affee4b2STejun Heo  *
1725affee4b2STejun Heo  * CONTEXT:
17268b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1727affee4b2STejun Heo  */
1728affee4b2STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1729affee4b2STejun Heo 			      struct work_struct **nextp)
1730affee4b2STejun Heo {
1731affee4b2STejun Heo 	struct work_struct *n;
1732affee4b2STejun Heo 
1733affee4b2STejun Heo 	/*
1734affee4b2STejun Heo 	 * Linked worklist will always end before the end of the list,
1735affee4b2STejun Heo 	 * use NULL for list head.
1736affee4b2STejun Heo 	 */
1737affee4b2STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1738affee4b2STejun Heo 		list_move_tail(&work->entry, head);
1739affee4b2STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1740affee4b2STejun Heo 			break;
1741affee4b2STejun Heo 	}
1742affee4b2STejun Heo 
1743affee4b2STejun Heo 	/*
1744affee4b2STejun Heo 	 * If we're already inside safe list traversal and have moved
1745affee4b2STejun Heo 	 * multiple works to the scheduled queue, the next position
1746affee4b2STejun Heo 	 * needs to be updated.
1747affee4b2STejun Heo 	 */
1748affee4b2STejun Heo 	if (nextp)
1749affee4b2STejun Heo 		*nextp = n;
1750affee4b2STejun Heo }
1751affee4b2STejun Heo 
17521e19ffc6STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
17531e19ffc6STejun Heo {
17541e19ffc6STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
17551da177e4SLinus Torvalds 						    struct work_struct, entry);
175663d95a91STejun Heo 	struct list_head *pos = pool_determine_ins_pos(cwq->pool, cwq);
17571e19ffc6STejun Heo 
1758cdadf009STejun Heo 	trace_workqueue_activate_work(work);
1759649027d7STejun Heo 	move_linked_works(work, pos, NULL);
17608a2e8e5dSTejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
17611e19ffc6STejun Heo 	cwq->nr_active++;
17621e19ffc6STejun Heo }
17631e19ffc6STejun Heo 
1764affee4b2STejun Heo /**
176573f53c4aSTejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
176673f53c4aSTejun Heo  * @cwq: cwq of interest
176773f53c4aSTejun Heo  * @color: color of work which left the queue
17688a2e8e5dSTejun Heo  * @delayed: for a delayed work
176973f53c4aSTejun Heo  *
177073f53c4aSTejun Heo  * A work either has completed or is removed from pending queue,
177173f53c4aSTejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
177273f53c4aSTejun Heo  *
177373f53c4aSTejun Heo  * CONTEXT:
17748b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
177573f53c4aSTejun Heo  */
17768a2e8e5dSTejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
17778a2e8e5dSTejun Heo 				 bool delayed)
177873f53c4aSTejun Heo {
177973f53c4aSTejun Heo 	/* ignore uncolored works */
178073f53c4aSTejun Heo 	if (color == WORK_NO_COLOR)
178173f53c4aSTejun Heo 		return;
178273f53c4aSTejun Heo 
178373f53c4aSTejun Heo 	cwq->nr_in_flight[color]--;
17841e19ffc6STejun Heo 
17858a2e8e5dSTejun Heo 	if (!delayed) {
17868a2e8e5dSTejun Heo 		cwq->nr_active--;
1787502ca9d8STejun Heo 		if (!list_empty(&cwq->delayed_works)) {
17881e19ffc6STejun Heo 			/* one down, submit a delayed one */
1789502ca9d8STejun Heo 			if (cwq->nr_active < cwq->max_active)
17901e19ffc6STejun Heo 				cwq_activate_first_delayed(cwq);
1791502ca9d8STejun Heo 		}
17928a2e8e5dSTejun Heo 	}
179373f53c4aSTejun Heo 
179473f53c4aSTejun Heo 	/* is flush in progress and are we at the flushing tip? */
179573f53c4aSTejun Heo 	if (likely(cwq->flush_color != color))
179673f53c4aSTejun Heo 		return;
179773f53c4aSTejun Heo 
179873f53c4aSTejun Heo 	/* are there still in-flight works? */
179973f53c4aSTejun Heo 	if (cwq->nr_in_flight[color])
180073f53c4aSTejun Heo 		return;
180173f53c4aSTejun Heo 
180273f53c4aSTejun Heo 	/* this cwq is done, clear flush_color */
180373f53c4aSTejun Heo 	cwq->flush_color = -1;
180473f53c4aSTejun Heo 
180573f53c4aSTejun Heo 	/*
180673f53c4aSTejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
180773f53c4aSTejun Heo 	 * will handle the rest.
180873f53c4aSTejun Heo 	 */
180973f53c4aSTejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
181073f53c4aSTejun Heo 		complete(&cwq->wq->first_flusher->done);
181173f53c4aSTejun Heo }
181273f53c4aSTejun Heo 
181373f53c4aSTejun Heo /**
1814a62428c0STejun Heo  * process_one_work - process single work
1815c34056a3STejun Heo  * @worker: self
1816a62428c0STejun Heo  * @work: work to process
1817a62428c0STejun Heo  *
1818a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
1819a62428c0STejun Heo  * process a single work including synchronization against and
1820a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
1821a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
1822a62428c0STejun Heo  * call this function to process a work.
1823a62428c0STejun Heo  *
1824a62428c0STejun Heo  * CONTEXT:
18258b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1826a62428c0STejun Heo  */
1827c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
182806bd6ebfSNamhyung Kim __releases(&gcwq->lock)
182906bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
18301da177e4SLinus Torvalds {
18317e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1832bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1833bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1834c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
1835fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
18366bb49e59SDavid Howells 	work_func_t f = work->func;
183773f53c4aSTejun Heo 	int work_color;
18387e11629dSTejun Heo 	struct worker *collision;
18394e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
18404e6045f1SJohannes Berg 	/*
1841a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
1842a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
1843a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
1844a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
1845a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
18464e6045f1SJohannes Berg 	 */
18474d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
18484d82a1deSPeter Zijlstra 
18494d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
18504e6045f1SJohannes Berg #endif
18517e11629dSTejun Heo 	/*
18527e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
18537e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
18547e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
18557e11629dSTejun Heo 	 * currently executing one.
18567e11629dSTejun Heo 	 */
18577e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
18587e11629dSTejun Heo 	if (unlikely(collision)) {
18597e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
18607e11629dSTejun Heo 		return;
18617e11629dSTejun Heo 	}
18621da177e4SLinus Torvalds 
1863a62428c0STejun Heo 	/* claim and process */
18641da177e4SLinus Torvalds 	debug_work_deactivate(work);
1865c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
1866c34056a3STejun Heo 	worker->current_work = work;
18678cca0eeaSTejun Heo 	worker->current_cwq = cwq;
186873f53c4aSTejun Heo 	work_color = get_work_color(work);
18697a22ad75STejun Heo 
18707a22ad75STejun Heo 	/* record the current cpu number in the work data and dequeue */
18717a22ad75STejun Heo 	set_work_cpu(work, gcwq->cpu);
1872a62428c0STejun Heo 	list_del_init(&work->entry);
1873a62428c0STejun Heo 
1874649027d7STejun Heo 	/*
1875649027d7STejun Heo 	 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1876649027d7STejun Heo 	 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1877649027d7STejun Heo 	 */
1878*11ebea50STejun Heo 	if (unlikely(pool->flags & POOL_HIGHPRI_PENDING)) {
1879bd7bdd43STejun Heo 		struct work_struct *nwork = list_first_entry(&pool->worklist,
1880649027d7STejun Heo 					 struct work_struct, entry);
1881649027d7STejun Heo 
1882bd7bdd43STejun Heo 		if (!list_empty(&pool->worklist) &&
1883649027d7STejun Heo 		    get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
188463d95a91STejun Heo 			wake_up_worker(pool);
1885649027d7STejun Heo 		else
1886*11ebea50STejun Heo 			pool->flags &= ~POOL_HIGHPRI_PENDING;
1887649027d7STejun Heo 	}
1888649027d7STejun Heo 
1889fb0e7bebSTejun Heo 	/*
1890fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
1891fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
1892fb0e7bebSTejun Heo 	 */
1893fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1894fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1895fb0e7bebSTejun Heo 
1896974271c4STejun Heo 	/*
1897974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
1898974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
1899974271c4STejun Heo 	 */
190063d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
190163d95a91STejun Heo 		wake_up_worker(pool);
1902974271c4STejun Heo 
19038b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
19041da177e4SLinus Torvalds 
190523b2e599SOleg Nesterov 	work_clear_pending(work);
1906e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
19073295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
1908e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
190965f27f38SDavid Howells 	f(work);
1910e36c886aSArjan van de Ven 	/*
1911e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
1912e36c886aSArjan van de Ven 	 * point will only record its address.
1913e36c886aSArjan van de Ven 	 */
1914e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
19153295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
19163295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
19171da177e4SLinus Torvalds 
1918d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1919d5abe669SPeter Zijlstra 		printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1920d5abe669SPeter Zijlstra 		       "%s/0x%08x/%d\n",
1921a62428c0STejun Heo 		       current->comm, preempt_count(), task_pid_nr(current));
1922d5abe669SPeter Zijlstra 		printk(KERN_ERR "    last function: ");
1923d5abe669SPeter Zijlstra 		print_symbol("%s\n", (unsigned long)f);
1924d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
1925d5abe669SPeter Zijlstra 		dump_stack();
1926d5abe669SPeter Zijlstra 	}
1927d5abe669SPeter Zijlstra 
19288b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1929a62428c0STejun Heo 
1930fb0e7bebSTejun Heo 	/* clear cpu intensive status */
1931fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1932fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1933fb0e7bebSTejun Heo 
1934a62428c0STejun Heo 	/* we're done with it, release */
1935c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
1936c34056a3STejun Heo 	worker->current_work = NULL;
19378cca0eeaSTejun Heo 	worker->current_cwq = NULL;
19388a2e8e5dSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color, false);
19391da177e4SLinus Torvalds }
19401da177e4SLinus Torvalds 
1941affee4b2STejun Heo /**
1942affee4b2STejun Heo  * process_scheduled_works - process scheduled works
1943affee4b2STejun Heo  * @worker: self
1944affee4b2STejun Heo  *
1945affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
1946affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
1947affee4b2STejun Heo  * fetches a work from the top and executes it.
1948affee4b2STejun Heo  *
1949affee4b2STejun Heo  * CONTEXT:
19508b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1951affee4b2STejun Heo  * multiple times.
1952affee4b2STejun Heo  */
1953affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
19541da177e4SLinus Torvalds {
1955affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
1956affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
1957a62428c0STejun Heo 						struct work_struct, entry);
1958c34056a3STejun Heo 		process_one_work(worker, work);
1959a62428c0STejun Heo 	}
19601da177e4SLinus Torvalds }
19611da177e4SLinus Torvalds 
19624690c4abSTejun Heo /**
19634690c4abSTejun Heo  * worker_thread - the worker thread function
1964c34056a3STejun Heo  * @__worker: self
19654690c4abSTejun Heo  *
1966e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
1967e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
1968e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
1969e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
1970e22bee78STejun Heo  * rescuer_thread().
19714690c4abSTejun Heo  */
1972c34056a3STejun Heo static int worker_thread(void *__worker)
19731da177e4SLinus Torvalds {
1974c34056a3STejun Heo 	struct worker *worker = __worker;
1975bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1976bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
19771da177e4SLinus Torvalds 
1978e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
1979e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
1980c8e55f36STejun Heo woke_up:
19818b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1982affee4b2STejun Heo 
1983c8e55f36STejun Heo 	/* DIE can be set only while we're idle, checking here is enough */
1984c8e55f36STejun Heo 	if (worker->flags & WORKER_DIE) {
1985c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
1986e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
1987c8e55f36STejun Heo 		return 0;
1988c8e55f36STejun Heo 	}
1989c8e55f36STejun Heo 
1990c8e55f36STejun Heo 	worker_leave_idle(worker);
1991db7bccf4STejun Heo recheck:
1992e22bee78STejun Heo 	/* no more worker necessary? */
199363d95a91STejun Heo 	if (!need_more_worker(pool))
1994e22bee78STejun Heo 		goto sleep;
1995e22bee78STejun Heo 
1996e22bee78STejun Heo 	/* do we need to manage? */
199763d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
1998e22bee78STejun Heo 		goto recheck;
1999e22bee78STejun Heo 
2000c8e55f36STejun Heo 	/*
2001c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2002c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2003c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2004c8e55f36STejun Heo 	 */
2005c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2006c8e55f36STejun Heo 
2007e22bee78STejun Heo 	/*
2008e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2009e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2010e22bee78STejun Heo 	 * assumed the manager role.
2011e22bee78STejun Heo 	 */
2012e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2013e22bee78STejun Heo 
2014e22bee78STejun Heo 	do {
2015affee4b2STejun Heo 		struct work_struct *work =
2016bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2017affee4b2STejun Heo 					 struct work_struct, entry);
2018affee4b2STejun Heo 
2019c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2020affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2021affee4b2STejun Heo 			process_one_work(worker, work);
2022affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2023affee4b2STejun Heo 				process_scheduled_works(worker);
2024affee4b2STejun Heo 		} else {
2025c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2026affee4b2STejun Heo 			process_scheduled_works(worker);
2027affee4b2STejun Heo 		}
202863d95a91STejun Heo 	} while (keep_working(pool));
2029affee4b2STejun Heo 
2030e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2031d313dd85STejun Heo sleep:
203263d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2033e22bee78STejun Heo 		goto recheck;
2034d313dd85STejun Heo 
2035c8e55f36STejun Heo 	/*
2036e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2037e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2038e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2039e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2040e22bee78STejun Heo 	 * prevent losing any event.
2041c8e55f36STejun Heo 	 */
2042c8e55f36STejun Heo 	worker_enter_idle(worker);
2043c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
20448b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
20451da177e4SLinus Torvalds 	schedule();
2046c8e55f36STejun Heo 	goto woke_up;
20471da177e4SLinus Torvalds }
20481da177e4SLinus Torvalds 
2049e22bee78STejun Heo /**
2050e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2051e22bee78STejun Heo  * @__wq: the associated workqueue
2052e22bee78STejun Heo  *
2053e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2054e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2055e22bee78STejun Heo  *
2056e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2057e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2058e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2059e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2060e22bee78STejun Heo  * the problem rescuer solves.
2061e22bee78STejun Heo  *
2062e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2063e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2064e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2065e22bee78STejun Heo  *
2066e22bee78STejun Heo  * This should happen rarely.
2067e22bee78STejun Heo  */
2068e22bee78STejun Heo static int rescuer_thread(void *__wq)
2069e22bee78STejun Heo {
2070e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2071e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2072e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2073f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2074e22bee78STejun Heo 	unsigned int cpu;
2075e22bee78STejun Heo 
2076e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2077e22bee78STejun Heo repeat:
2078e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
20791da177e4SLinus Torvalds 
20801da177e4SLinus Torvalds 	if (kthread_should_stop())
2081e22bee78STejun Heo 		return 0;
20821da177e4SLinus Torvalds 
2083f3421797STejun Heo 	/*
2084f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2085f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2086f3421797STejun Heo 	 */
2087f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2088f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2089f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2090bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2091bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2092e22bee78STejun Heo 		struct work_struct *work, *n;
2093e22bee78STejun Heo 
2094e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2095f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2096e22bee78STejun Heo 
2097e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2098bd7bdd43STejun Heo 		rescuer->pool = pool;
2099e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2100e22bee78STejun Heo 
2101e22bee78STejun Heo 		/*
2102e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2103e22bee78STejun Heo 		 * process'em.
2104e22bee78STejun Heo 		 */
2105e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2106bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2107e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2108e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2109e22bee78STejun Heo 
2110e22bee78STejun Heo 		process_scheduled_works(rescuer);
21117576958aSTejun Heo 
21127576958aSTejun Heo 		/*
21137576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
21147576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
21157576958aSTejun Heo 		 * and stalling the execution.
21167576958aSTejun Heo 		 */
211763d95a91STejun Heo 		if (keep_working(pool))
211863d95a91STejun Heo 			wake_up_worker(pool);
21197576958aSTejun Heo 
2120e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
21211da177e4SLinus Torvalds 	}
21221da177e4SLinus Torvalds 
2123e22bee78STejun Heo 	schedule();
2124e22bee78STejun Heo 	goto repeat;
21251da177e4SLinus Torvalds }
21261da177e4SLinus Torvalds 
2127fc2e4d70SOleg Nesterov struct wq_barrier {
2128fc2e4d70SOleg Nesterov 	struct work_struct	work;
2129fc2e4d70SOleg Nesterov 	struct completion	done;
2130fc2e4d70SOleg Nesterov };
2131fc2e4d70SOleg Nesterov 
2132fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2133fc2e4d70SOleg Nesterov {
2134fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2135fc2e4d70SOleg Nesterov 	complete(&barr->done);
2136fc2e4d70SOleg Nesterov }
2137fc2e4d70SOleg Nesterov 
21384690c4abSTejun Heo /**
21394690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
21404690c4abSTejun Heo  * @cwq: cwq to insert barrier into
21414690c4abSTejun Heo  * @barr: wq_barrier to insert
2142affee4b2STejun Heo  * @target: target work to attach @barr to
2143affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
21444690c4abSTejun Heo  *
2145affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2146affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2147affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2148affee4b2STejun Heo  * cpu.
2149affee4b2STejun Heo  *
2150affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2151affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2152affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2153affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2154affee4b2STejun Heo  * after a work with LINKED flag set.
2155affee4b2STejun Heo  *
2156affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2157affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
21584690c4abSTejun Heo  *
21594690c4abSTejun Heo  * CONTEXT:
21608b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
21614690c4abSTejun Heo  */
216283c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2163affee4b2STejun Heo 			      struct wq_barrier *barr,
2164affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2165fc2e4d70SOleg Nesterov {
2166affee4b2STejun Heo 	struct list_head *head;
2167affee4b2STejun Heo 	unsigned int linked = 0;
2168affee4b2STejun Heo 
2169dc186ad7SThomas Gleixner 	/*
21708b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2171dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2172dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2173dc186ad7SThomas Gleixner 	 * might deadlock.
2174dc186ad7SThomas Gleixner 	 */
2175ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
217622df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2177fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
217883c22520SOleg Nesterov 
2179affee4b2STejun Heo 	/*
2180affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2181affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2182affee4b2STejun Heo 	 */
2183affee4b2STejun Heo 	if (worker)
2184affee4b2STejun Heo 		head = worker->scheduled.next;
2185affee4b2STejun Heo 	else {
2186affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2187affee4b2STejun Heo 
2188affee4b2STejun Heo 		head = target->entry.next;
2189affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2190affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2191affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2192affee4b2STejun Heo 	}
2193affee4b2STejun Heo 
2194dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2195affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2196affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2197fc2e4d70SOleg Nesterov }
2198fc2e4d70SOleg Nesterov 
219973f53c4aSTejun Heo /**
220073f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
220173f53c4aSTejun Heo  * @wq: workqueue being flushed
220273f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
220373f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
220473f53c4aSTejun Heo  *
220573f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
220673f53c4aSTejun Heo  *
220773f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
220873f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
220973f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
221073f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
221173f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
221273f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
221373f53c4aSTejun Heo  *
221473f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
221573f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
221673f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
221773f53c4aSTejun Heo  * is returned.
221873f53c4aSTejun Heo  *
221973f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
222073f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
222173f53c4aSTejun Heo  * advanced to @work_color.
222273f53c4aSTejun Heo  *
222373f53c4aSTejun Heo  * CONTEXT:
222473f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
222573f53c4aSTejun Heo  *
222673f53c4aSTejun Heo  * RETURNS:
222773f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
222873f53c4aSTejun Heo  * otherwise.
222973f53c4aSTejun Heo  */
223073f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
223173f53c4aSTejun Heo 				      int flush_color, int work_color)
22321da177e4SLinus Torvalds {
223373f53c4aSTejun Heo 	bool wait = false;
223473f53c4aSTejun Heo 	unsigned int cpu;
22351da177e4SLinus Torvalds 
223673f53c4aSTejun Heo 	if (flush_color >= 0) {
223773f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
223873f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2239dc186ad7SThomas Gleixner 	}
224014441960SOleg Nesterov 
2241f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
224273f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2243bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
22441da177e4SLinus Torvalds 
22458b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
224673f53c4aSTejun Heo 
224773f53c4aSTejun Heo 		if (flush_color >= 0) {
224873f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
224973f53c4aSTejun Heo 
225073f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
225173f53c4aSTejun Heo 				cwq->flush_color = flush_color;
225273f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
225373f53c4aSTejun Heo 				wait = true;
22541da177e4SLinus Torvalds 			}
225573f53c4aSTejun Heo 		}
225673f53c4aSTejun Heo 
225773f53c4aSTejun Heo 		if (work_color >= 0) {
225873f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
225973f53c4aSTejun Heo 			cwq->work_color = work_color;
226073f53c4aSTejun Heo 		}
226173f53c4aSTejun Heo 
22628b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
22631da177e4SLinus Torvalds 	}
22641da177e4SLinus Torvalds 
226573f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
226673f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
226773f53c4aSTejun Heo 
226873f53c4aSTejun Heo 	return wait;
226983c22520SOleg Nesterov }
22701da177e4SLinus Torvalds 
22710fcb78c2SRolf Eike Beer /**
22721da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
22730fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
22741da177e4SLinus Torvalds  *
22751da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
22761da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
22771da177e4SLinus Torvalds  *
2278fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2279fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
22801da177e4SLinus Torvalds  */
22817ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
22821da177e4SLinus Torvalds {
228373f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
228473f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
228573f53c4aSTejun Heo 		.flush_color = -1,
228673f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
228773f53c4aSTejun Heo 	};
228873f53c4aSTejun Heo 	int next_color;
2289b1f4ec17SOleg Nesterov 
22903295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
22913295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
229273f53c4aSTejun Heo 
229373f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
229473f53c4aSTejun Heo 
229573f53c4aSTejun Heo 	/*
229673f53c4aSTejun Heo 	 * Start-to-wait phase
229773f53c4aSTejun Heo 	 */
229873f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
229973f53c4aSTejun Heo 
230073f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
230173f53c4aSTejun Heo 		/*
230273f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
230373f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
230473f53c4aSTejun Heo 		 * by one.
230573f53c4aSTejun Heo 		 */
230673f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
230773f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
230873f53c4aSTejun Heo 		wq->work_color = next_color;
230973f53c4aSTejun Heo 
231073f53c4aSTejun Heo 		if (!wq->first_flusher) {
231173f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
231273f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
231373f53c4aSTejun Heo 
231473f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
231573f53c4aSTejun Heo 
231673f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
231773f53c4aSTejun Heo 						       wq->work_color)) {
231873f53c4aSTejun Heo 				/* nothing to flush, done */
231973f53c4aSTejun Heo 				wq->flush_color = next_color;
232073f53c4aSTejun Heo 				wq->first_flusher = NULL;
232173f53c4aSTejun Heo 				goto out_unlock;
232273f53c4aSTejun Heo 			}
232373f53c4aSTejun Heo 		} else {
232473f53c4aSTejun Heo 			/* wait in queue */
232573f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
232673f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
232773f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
232873f53c4aSTejun Heo 		}
232973f53c4aSTejun Heo 	} else {
233073f53c4aSTejun Heo 		/*
233173f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
233273f53c4aSTejun Heo 		 * The next flush completion will assign us
233373f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
233473f53c4aSTejun Heo 		 */
233573f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
233673f53c4aSTejun Heo 	}
233773f53c4aSTejun Heo 
233873f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
233973f53c4aSTejun Heo 
234073f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
234173f53c4aSTejun Heo 
234273f53c4aSTejun Heo 	/*
234373f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
234473f53c4aSTejun Heo 	 *
234573f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
234673f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
234773f53c4aSTejun Heo 	 */
234873f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
234973f53c4aSTejun Heo 		return;
235073f53c4aSTejun Heo 
235173f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
235273f53c4aSTejun Heo 
23534ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
23544ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
23554ce48b37STejun Heo 		goto out_unlock;
23564ce48b37STejun Heo 
235773f53c4aSTejun Heo 	wq->first_flusher = NULL;
235873f53c4aSTejun Heo 
235973f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
236073f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
236173f53c4aSTejun Heo 
236273f53c4aSTejun Heo 	while (true) {
236373f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
236473f53c4aSTejun Heo 
236573f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
236673f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
236773f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
236873f53c4aSTejun Heo 				break;
236973f53c4aSTejun Heo 			list_del_init(&next->list);
237073f53c4aSTejun Heo 			complete(&next->done);
237173f53c4aSTejun Heo 		}
237273f53c4aSTejun Heo 
237373f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
237473f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
237573f53c4aSTejun Heo 
237673f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
237773f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
237873f53c4aSTejun Heo 
237973f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
238073f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
238173f53c4aSTejun Heo 			/*
238273f53c4aSTejun Heo 			 * Assign the same color to all overflowed
238373f53c4aSTejun Heo 			 * flushers, advance work_color and append to
238473f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
238573f53c4aSTejun Heo 			 * phase for these overflowed flushers.
238673f53c4aSTejun Heo 			 */
238773f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
238873f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
238973f53c4aSTejun Heo 
239073f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
239173f53c4aSTejun Heo 
239273f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
239373f53c4aSTejun Heo 					      &wq->flusher_queue);
239473f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
239573f53c4aSTejun Heo 		}
239673f53c4aSTejun Heo 
239773f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
239873f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
239973f53c4aSTejun Heo 			break;
240073f53c4aSTejun Heo 		}
240173f53c4aSTejun Heo 
240273f53c4aSTejun Heo 		/*
240373f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
240473f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
240573f53c4aSTejun Heo 		 */
240673f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
240773f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
240873f53c4aSTejun Heo 
240973f53c4aSTejun Heo 		list_del_init(&next->list);
241073f53c4aSTejun Heo 		wq->first_flusher = next;
241173f53c4aSTejun Heo 
241273f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
241373f53c4aSTejun Heo 			break;
241473f53c4aSTejun Heo 
241573f53c4aSTejun Heo 		/*
241673f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
241773f53c4aSTejun Heo 		 * flusher and repeat cascading.
241873f53c4aSTejun Heo 		 */
241973f53c4aSTejun Heo 		wq->first_flusher = NULL;
242073f53c4aSTejun Heo 	}
242173f53c4aSTejun Heo 
242273f53c4aSTejun Heo out_unlock:
242373f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
24241da177e4SLinus Torvalds }
2425ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
24261da177e4SLinus Torvalds 
24279c5a2ba7STejun Heo /**
24289c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
24299c5a2ba7STejun Heo  * @wq: workqueue to drain
24309c5a2ba7STejun Heo  *
24319c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
24329c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
24339c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
24349c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
24359c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
24369c5a2ba7STejun Heo  * takes too long.
24379c5a2ba7STejun Heo  */
24389c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
24399c5a2ba7STejun Heo {
24409c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
24419c5a2ba7STejun Heo 	unsigned int cpu;
24429c5a2ba7STejun Heo 
24439c5a2ba7STejun Heo 	/*
24449c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
24459c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
24469c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
24479c5a2ba7STejun Heo 	 */
24489c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24499c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
24509c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
24519c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24529c5a2ba7STejun Heo reflush:
24539c5a2ba7STejun Heo 	flush_workqueue(wq);
24549c5a2ba7STejun Heo 
24559c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
24569c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2457fa2563e4SThomas Tuttle 		bool drained;
24589c5a2ba7STejun Heo 
2459bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2460fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2461bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2462fa2563e4SThomas Tuttle 
2463fa2563e4SThomas Tuttle 		if (drained)
24649c5a2ba7STejun Heo 			continue;
24659c5a2ba7STejun Heo 
24669c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
24679c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
24689c5a2ba7STejun Heo 			pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
24699c5a2ba7STejun Heo 				   wq->name, flush_cnt);
24709c5a2ba7STejun Heo 		goto reflush;
24719c5a2ba7STejun Heo 	}
24729c5a2ba7STejun Heo 
24739c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24749c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
24759c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
24769c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24779c5a2ba7STejun Heo }
24789c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
24799c5a2ba7STejun Heo 
2480baf59022STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2481baf59022STejun Heo 			     bool wait_executing)
2482baf59022STejun Heo {
2483baf59022STejun Heo 	struct worker *worker = NULL;
2484baf59022STejun Heo 	struct global_cwq *gcwq;
2485baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2486baf59022STejun Heo 
2487baf59022STejun Heo 	might_sleep();
2488baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2489baf59022STejun Heo 	if (!gcwq)
2490baf59022STejun Heo 		return false;
2491baf59022STejun Heo 
2492baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2493baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2494baf59022STejun Heo 		/*
2495baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2496baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2497baf59022STejun Heo 		 * are not going to wait.
2498baf59022STejun Heo 		 */
2499baf59022STejun Heo 		smp_rmb();
2500baf59022STejun Heo 		cwq = get_work_cwq(work);
2501bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2502baf59022STejun Heo 			goto already_gone;
2503baf59022STejun Heo 	} else if (wait_executing) {
2504baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2505baf59022STejun Heo 		if (!worker)
2506baf59022STejun Heo 			goto already_gone;
2507baf59022STejun Heo 		cwq = worker->current_cwq;
2508baf59022STejun Heo 	} else
2509baf59022STejun Heo 		goto already_gone;
2510baf59022STejun Heo 
2511baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2512baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2513baf59022STejun Heo 
2514e159489bSTejun Heo 	/*
2515e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2516e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2517e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2518e159489bSTejun Heo 	 * access.
2519e159489bSTejun Heo 	 */
2520e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2521baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2522e159489bSTejun Heo 	else
2523e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2524baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2525e159489bSTejun Heo 
2526baf59022STejun Heo 	return true;
2527baf59022STejun Heo already_gone:
2528baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2529baf59022STejun Heo 	return false;
2530baf59022STejun Heo }
2531baf59022STejun Heo 
2532db700897SOleg Nesterov /**
2533401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2534401a8d04STejun Heo  * @work: the work to flush
2535db700897SOleg Nesterov  *
2536401a8d04STejun Heo  * Wait until @work has finished execution.  This function considers
2537401a8d04STejun Heo  * only the last queueing instance of @work.  If @work has been
2538401a8d04STejun Heo  * enqueued across different CPUs on a non-reentrant workqueue or on
2539401a8d04STejun Heo  * multiple workqueues, @work might still be executing on return on
2540401a8d04STejun Heo  * some of the CPUs from earlier queueing.
2541a67da70dSOleg Nesterov  *
2542401a8d04STejun Heo  * If @work was queued only on a non-reentrant, ordered or unbound
2543401a8d04STejun Heo  * workqueue, @work is guaranteed to be idle on return if it hasn't
2544401a8d04STejun Heo  * been requeued since flush started.
2545401a8d04STejun Heo  *
2546401a8d04STejun Heo  * RETURNS:
2547401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2548401a8d04STejun Heo  * %false if it was already idle.
2549db700897SOleg Nesterov  */
2550401a8d04STejun Heo bool flush_work(struct work_struct *work)
2551db700897SOleg Nesterov {
2552db700897SOleg Nesterov 	struct wq_barrier barr;
2553db700897SOleg Nesterov 
25540976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
25550976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
25560976dfc1SStephen Boyd 
2557baf59022STejun Heo 	if (start_flush_work(work, &barr, true)) {
2558db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2559dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2560401a8d04STejun Heo 		return true;
2561baf59022STejun Heo 	} else
2562401a8d04STejun Heo 		return false;
2563db700897SOleg Nesterov }
2564db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2565db700897SOleg Nesterov 
2566401a8d04STejun Heo static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2567401a8d04STejun Heo {
2568401a8d04STejun Heo 	struct wq_barrier barr;
2569401a8d04STejun Heo 	struct worker *worker;
2570401a8d04STejun Heo 
2571401a8d04STejun Heo 	spin_lock_irq(&gcwq->lock);
2572401a8d04STejun Heo 
2573401a8d04STejun Heo 	worker = find_worker_executing_work(gcwq, work);
2574401a8d04STejun Heo 	if (unlikely(worker))
2575401a8d04STejun Heo 		insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2576401a8d04STejun Heo 
2577401a8d04STejun Heo 	spin_unlock_irq(&gcwq->lock);
2578401a8d04STejun Heo 
2579401a8d04STejun Heo 	if (unlikely(worker)) {
2580401a8d04STejun Heo 		wait_for_completion(&barr.done);
2581401a8d04STejun Heo 		destroy_work_on_stack(&barr.work);
2582401a8d04STejun Heo 		return true;
2583401a8d04STejun Heo 	} else
2584401a8d04STejun Heo 		return false;
2585401a8d04STejun Heo }
2586401a8d04STejun Heo 
2587401a8d04STejun Heo static bool wait_on_work(struct work_struct *work)
2588401a8d04STejun Heo {
2589401a8d04STejun Heo 	bool ret = false;
2590401a8d04STejun Heo 	int cpu;
2591401a8d04STejun Heo 
2592401a8d04STejun Heo 	might_sleep();
2593401a8d04STejun Heo 
2594401a8d04STejun Heo 	lock_map_acquire(&work->lockdep_map);
2595401a8d04STejun Heo 	lock_map_release(&work->lockdep_map);
2596401a8d04STejun Heo 
2597401a8d04STejun Heo 	for_each_gcwq_cpu(cpu)
2598401a8d04STejun Heo 		ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2599401a8d04STejun Heo 	return ret;
2600401a8d04STejun Heo }
2601401a8d04STejun Heo 
260209383498STejun Heo /**
260309383498STejun Heo  * flush_work_sync - wait until a work has finished execution
260409383498STejun Heo  * @work: the work to flush
260509383498STejun Heo  *
260609383498STejun Heo  * Wait until @work has finished execution.  On return, it's
260709383498STejun Heo  * guaranteed that all queueing instances of @work which happened
260809383498STejun Heo  * before this function is called are finished.  In other words, if
260909383498STejun Heo  * @work hasn't been requeued since this function was called, @work is
261009383498STejun Heo  * guaranteed to be idle on return.
261109383498STejun Heo  *
261209383498STejun Heo  * RETURNS:
261309383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
261409383498STejun Heo  * %false if it was already idle.
261509383498STejun Heo  */
261609383498STejun Heo bool flush_work_sync(struct work_struct *work)
261709383498STejun Heo {
261809383498STejun Heo 	struct wq_barrier barr;
261909383498STejun Heo 	bool pending, waited;
262009383498STejun Heo 
262109383498STejun Heo 	/* we'll wait for executions separately, queue barr only if pending */
262209383498STejun Heo 	pending = start_flush_work(work, &barr, false);
262309383498STejun Heo 
262409383498STejun Heo 	/* wait for executions to finish */
262509383498STejun Heo 	waited = wait_on_work(work);
262609383498STejun Heo 
262709383498STejun Heo 	/* wait for the pending one */
262809383498STejun Heo 	if (pending) {
262909383498STejun Heo 		wait_for_completion(&barr.done);
263009383498STejun Heo 		destroy_work_on_stack(&barr.work);
263109383498STejun Heo 	}
263209383498STejun Heo 
263309383498STejun Heo 	return pending || waited;
263409383498STejun Heo }
263509383498STejun Heo EXPORT_SYMBOL_GPL(flush_work_sync);
263609383498STejun Heo 
26376e84d644SOleg Nesterov /*
26381f1f642eSOleg Nesterov  * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
26396e84d644SOleg Nesterov  * so this work can't be re-armed in any way.
26406e84d644SOleg Nesterov  */
26416e84d644SOleg Nesterov static int try_to_grab_pending(struct work_struct *work)
26426e84d644SOleg Nesterov {
26438b03ae3cSTejun Heo 	struct global_cwq *gcwq;
26441f1f642eSOleg Nesterov 	int ret = -1;
26456e84d644SOleg Nesterov 
264622df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
26471f1f642eSOleg Nesterov 		return 0;
26486e84d644SOleg Nesterov 
26496e84d644SOleg Nesterov 	/*
26506e84d644SOleg Nesterov 	 * The queueing is in progress, or it is already queued. Try to
26516e84d644SOleg Nesterov 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
26526e84d644SOleg Nesterov 	 */
26537a22ad75STejun Heo 	gcwq = get_work_gcwq(work);
26547a22ad75STejun Heo 	if (!gcwq)
26556e84d644SOleg Nesterov 		return ret;
26566e84d644SOleg Nesterov 
26578b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
26586e84d644SOleg Nesterov 	if (!list_empty(&work->entry)) {
26596e84d644SOleg Nesterov 		/*
26607a22ad75STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
26616e84d644SOleg Nesterov 		 * In that case we must see the new value after rmb(), see
26626e84d644SOleg Nesterov 		 * insert_work()->wmb().
26636e84d644SOleg Nesterov 		 */
26646e84d644SOleg Nesterov 		smp_rmb();
26657a22ad75STejun Heo 		if (gcwq == get_work_gcwq(work)) {
2666dc186ad7SThomas Gleixner 			debug_work_deactivate(work);
26676e84d644SOleg Nesterov 			list_del_init(&work->entry);
26687a22ad75STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
26698a2e8e5dSTejun Heo 				get_work_color(work),
26708a2e8e5dSTejun Heo 				*work_data_bits(work) & WORK_STRUCT_DELAYED);
26716e84d644SOleg Nesterov 			ret = 1;
26726e84d644SOleg Nesterov 		}
26736e84d644SOleg Nesterov 	}
26748b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
26756e84d644SOleg Nesterov 
26766e84d644SOleg Nesterov 	return ret;
26776e84d644SOleg Nesterov }
26786e84d644SOleg Nesterov 
2679401a8d04STejun Heo static bool __cancel_work_timer(struct work_struct *work,
26801f1f642eSOleg Nesterov 				struct timer_list* timer)
26811f1f642eSOleg Nesterov {
26821f1f642eSOleg Nesterov 	int ret;
26831f1f642eSOleg Nesterov 
26841f1f642eSOleg Nesterov 	do {
26851f1f642eSOleg Nesterov 		ret = (timer && likely(del_timer(timer)));
26861f1f642eSOleg Nesterov 		if (!ret)
26871f1f642eSOleg Nesterov 			ret = try_to_grab_pending(work);
26881f1f642eSOleg Nesterov 		wait_on_work(work);
26891f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
26901f1f642eSOleg Nesterov 
26917a22ad75STejun Heo 	clear_work_data(work);
26921f1f642eSOleg Nesterov 	return ret;
26931f1f642eSOleg Nesterov }
26941f1f642eSOleg Nesterov 
26956e84d644SOleg Nesterov /**
2696401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2697401a8d04STejun Heo  * @work: the work to cancel
26986e84d644SOleg Nesterov  *
2699401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2700401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2701401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2702401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
27031f1f642eSOleg Nesterov  *
2704401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2705401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
27066e84d644SOleg Nesterov  *
2707401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
27086e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2709401a8d04STejun Heo  *
2710401a8d04STejun Heo  * RETURNS:
2711401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
27126e84d644SOleg Nesterov  */
2713401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
27146e84d644SOleg Nesterov {
27151f1f642eSOleg Nesterov 	return __cancel_work_timer(work, NULL);
2716b89deed3SOleg Nesterov }
271728e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2718b89deed3SOleg Nesterov 
27196e84d644SOleg Nesterov /**
2720401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2721401a8d04STejun Heo  * @dwork: the delayed work to flush
27226e84d644SOleg Nesterov  *
2723401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2724401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2725401a8d04STejun Heo  * considers the last queueing instance of @dwork.
27261f1f642eSOleg Nesterov  *
2727401a8d04STejun Heo  * RETURNS:
2728401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2729401a8d04STejun Heo  * %false if it was already idle.
27306e84d644SOleg Nesterov  */
2731401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2732401a8d04STejun Heo {
2733401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
2734401a8d04STejun Heo 		__queue_work(raw_smp_processor_id(),
2735401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
2736401a8d04STejun Heo 	return flush_work(&dwork->work);
2737401a8d04STejun Heo }
2738401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2739401a8d04STejun Heo 
2740401a8d04STejun Heo /**
274109383498STejun Heo  * flush_delayed_work_sync - wait for a dwork to finish
274209383498STejun Heo  * @dwork: the delayed work to flush
274309383498STejun Heo  *
274409383498STejun Heo  * Delayed timer is cancelled and the pending work is queued for
274509383498STejun Heo  * execution immediately.  Other than timer handling, its behavior
274609383498STejun Heo  * is identical to flush_work_sync().
274709383498STejun Heo  *
274809383498STejun Heo  * RETURNS:
274909383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
275009383498STejun Heo  * %false if it was already idle.
275109383498STejun Heo  */
275209383498STejun Heo bool flush_delayed_work_sync(struct delayed_work *dwork)
275309383498STejun Heo {
275409383498STejun Heo 	if (del_timer_sync(&dwork->timer))
275509383498STejun Heo 		__queue_work(raw_smp_processor_id(),
275609383498STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
275709383498STejun Heo 	return flush_work_sync(&dwork->work);
275809383498STejun Heo }
275909383498STejun Heo EXPORT_SYMBOL(flush_delayed_work_sync);
276009383498STejun Heo 
276109383498STejun Heo /**
2762401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2763401a8d04STejun Heo  * @dwork: the delayed work cancel
2764401a8d04STejun Heo  *
2765401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2766401a8d04STejun Heo  *
2767401a8d04STejun Heo  * RETURNS:
2768401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2769401a8d04STejun Heo  */
2770401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
27716e84d644SOleg Nesterov {
27721f1f642eSOleg Nesterov 	return __cancel_work_timer(&dwork->work, &dwork->timer);
27736e84d644SOleg Nesterov }
2774f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
27751da177e4SLinus Torvalds 
27760fcb78c2SRolf Eike Beer /**
27770fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
27780fcb78c2SRolf Eike Beer  * @work: job to be done
27790fcb78c2SRolf Eike Beer  *
27805b0f437dSBart Van Assche  * Returns zero if @work was already on the kernel-global workqueue and
27815b0f437dSBart Van Assche  * non-zero otherwise.
27825b0f437dSBart Van Assche  *
27835b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
27845b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
27855b0f437dSBart Van Assche  * workqueue otherwise.
27860fcb78c2SRolf Eike Beer  */
27877ad5b3a5SHarvey Harrison int schedule_work(struct work_struct *work)
27881da177e4SLinus Torvalds {
2789d320c038STejun Heo 	return queue_work(system_wq, work);
27901da177e4SLinus Torvalds }
2791ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
27921da177e4SLinus Torvalds 
2793c1a220e7SZhang Rui /*
2794c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2795c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2796c1a220e7SZhang Rui  * @work: job to be done
2797c1a220e7SZhang Rui  *
2798c1a220e7SZhang Rui  * This puts a job on a specific cpu
2799c1a220e7SZhang Rui  */
2800c1a220e7SZhang Rui int schedule_work_on(int cpu, struct work_struct *work)
2801c1a220e7SZhang Rui {
2802d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2803c1a220e7SZhang Rui }
2804c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2805c1a220e7SZhang Rui 
28060fcb78c2SRolf Eike Beer /**
28070fcb78c2SRolf Eike Beer  * schedule_delayed_work - put work task in global workqueue after delay
280852bad64dSDavid Howells  * @dwork: job to be done
280952bad64dSDavid Howells  * @delay: number of jiffies to wait or 0 for immediate execution
28100fcb78c2SRolf Eike Beer  *
28110fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
28120fcb78c2SRolf Eike Beer  * workqueue.
28130fcb78c2SRolf Eike Beer  */
28147ad5b3a5SHarvey Harrison int schedule_delayed_work(struct delayed_work *dwork,
281582f67cd9SIngo Molnar 					unsigned long delay)
28161da177e4SLinus Torvalds {
2817d320c038STejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
28181da177e4SLinus Torvalds }
2819ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work);
28201da177e4SLinus Torvalds 
28210fcb78c2SRolf Eike Beer /**
28220fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
28230fcb78c2SRolf Eike Beer  * @cpu: cpu to use
282452bad64dSDavid Howells  * @dwork: job to be done
28250fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
28260fcb78c2SRolf Eike Beer  *
28270fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
28280fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
28290fcb78c2SRolf Eike Beer  */
28301da177e4SLinus Torvalds int schedule_delayed_work_on(int cpu,
283152bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
28321da177e4SLinus Torvalds {
2833d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
28341da177e4SLinus Torvalds }
2835ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
28361da177e4SLinus Torvalds 
2837b6136773SAndrew Morton /**
283831ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
2839b6136773SAndrew Morton  * @func: the function to call
2840b6136773SAndrew Morton  *
284131ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
284231ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
2843b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
284431ddd871STejun Heo  *
284531ddd871STejun Heo  * RETURNS:
284631ddd871STejun Heo  * 0 on success, -errno on failure.
2847b6136773SAndrew Morton  */
284865f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
284915316ba8SChristoph Lameter {
285015316ba8SChristoph Lameter 	int cpu;
285138f51568SNamhyung Kim 	struct work_struct __percpu *works;
285215316ba8SChristoph Lameter 
2853b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
2854b6136773SAndrew Morton 	if (!works)
285515316ba8SChristoph Lameter 		return -ENOMEM;
2856b6136773SAndrew Morton 
285795402b38SGautham R Shenoy 	get_online_cpus();
285893981800STejun Heo 
285915316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
28609bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
28619bfb1839SIngo Molnar 
28629bfb1839SIngo Molnar 		INIT_WORK(work, func);
28638de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
286415316ba8SChristoph Lameter 	}
286593981800STejun Heo 
286693981800STejun Heo 	for_each_online_cpu(cpu)
28678616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
286893981800STejun Heo 
286995402b38SGautham R Shenoy 	put_online_cpus();
2870b6136773SAndrew Morton 	free_percpu(works);
287115316ba8SChristoph Lameter 	return 0;
287215316ba8SChristoph Lameter }
287315316ba8SChristoph Lameter 
2874eef6a7d5SAlan Stern /**
2875eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
2876eef6a7d5SAlan Stern  *
2877eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
2878eef6a7d5SAlan Stern  * completion.
2879eef6a7d5SAlan Stern  *
2880eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
2881eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
2882eef6a7d5SAlan Stern  * will lead to deadlock:
2883eef6a7d5SAlan Stern  *
2884eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
2885eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
2886eef6a7d5SAlan Stern  *
2887eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
2888eef6a7d5SAlan Stern  *
2889eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
2890eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
2891eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
2892eef6a7d5SAlan Stern  *
2893eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
2894eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
2895eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
2896eef6a7d5SAlan Stern  * cancel_work_sync() instead.
2897eef6a7d5SAlan Stern  */
28981da177e4SLinus Torvalds void flush_scheduled_work(void)
28991da177e4SLinus Torvalds {
2900d320c038STejun Heo 	flush_workqueue(system_wq);
29011da177e4SLinus Torvalds }
2902ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
29031da177e4SLinus Torvalds 
29041da177e4SLinus Torvalds /**
29051fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
29061fa44ecaSJames Bottomley  * @fn:		the function to execute
29071fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
29081fa44ecaSJames Bottomley  *		be available when the work executes)
29091fa44ecaSJames Bottomley  *
29101fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
29111fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
29121fa44ecaSJames Bottomley  *
29131fa44ecaSJames Bottomley  * Returns:	0 - function was executed
29141fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
29151fa44ecaSJames Bottomley  */
291665f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
29171fa44ecaSJames Bottomley {
29181fa44ecaSJames Bottomley 	if (!in_interrupt()) {
291965f27f38SDavid Howells 		fn(&ew->work);
29201fa44ecaSJames Bottomley 		return 0;
29211fa44ecaSJames Bottomley 	}
29221fa44ecaSJames Bottomley 
292365f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
29241fa44ecaSJames Bottomley 	schedule_work(&ew->work);
29251fa44ecaSJames Bottomley 
29261fa44ecaSJames Bottomley 	return 1;
29271fa44ecaSJames Bottomley }
29281fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
29291fa44ecaSJames Bottomley 
29301da177e4SLinus Torvalds int keventd_up(void)
29311da177e4SLinus Torvalds {
2932d320c038STejun Heo 	return system_wq != NULL;
29331da177e4SLinus Torvalds }
29341da177e4SLinus Torvalds 
2935bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
29361da177e4SLinus Torvalds {
29373af24433SOleg Nesterov 	/*
29380f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
29390f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
29400f900049STejun Heo 	 * unsigned long long.
29413af24433SOleg Nesterov 	 */
29420f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
29430f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
29440f900049STejun Heo 				   __alignof__(unsigned long long));
29453af24433SOleg Nesterov 
2946e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2947f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2948931ac77eSTejun Heo 	else {
29490f900049STejun Heo 		void *ptr;
2950e1d8aa9fSFrederic Weisbecker 
29510f900049STejun Heo 		/*
2952f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
2953f3421797STejun Heo 		 * pointer at the end pointing back to the originally
2954f3421797STejun Heo 		 * allocated pointer which will be used for free.
29550f900049STejun Heo 		 */
2956bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2957bdbc5dd7STejun Heo 		if (ptr) {
2958bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2959bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
2960bdbc5dd7STejun Heo 		}
29613af24433SOleg Nesterov 	}
29623af24433SOleg Nesterov 
29630415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
2964bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2965bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
29660f900049STejun Heo }
29670f900049STejun Heo 
2968bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
296906ba38a9SOleg Nesterov {
2970e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2971bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
2972f3421797STejun Heo 	else if (wq->cpu_wq.single) {
2973f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
2974f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
297506ba38a9SOleg Nesterov 	}
297606ba38a9SOleg Nesterov }
297706ba38a9SOleg Nesterov 
2978f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
2979f3421797STejun Heo 			       const char *name)
2980b71ab8c2STejun Heo {
2981f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2982f3421797STejun Heo 
2983f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
2984b71ab8c2STejun Heo 		printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2985b71ab8c2STejun Heo 		       "is out of range, clamping between %d and %d\n",
2986f3421797STejun Heo 		       max_active, name, 1, lim);
2987b71ab8c2STejun Heo 
2988f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
2989b71ab8c2STejun Heo }
2990b71ab8c2STejun Heo 
2991b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
299297e37d7bSTejun Heo 					       unsigned int flags,
29931e19ffc6STejun Heo 					       int max_active,
2994eb13ba87SJohannes Berg 					       struct lock_class_key *key,
2995b196be89STejun Heo 					       const char *lock_name, ...)
29963af24433SOleg Nesterov {
2997b196be89STejun Heo 	va_list args, args1;
29983af24433SOleg Nesterov 	struct workqueue_struct *wq;
2999c34056a3STejun Heo 	unsigned int cpu;
3000b196be89STejun Heo 	size_t namelen;
3001b196be89STejun Heo 
3002b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3003b196be89STejun Heo 	va_start(args, lock_name);
3004b196be89STejun Heo 	va_copy(args1, args);
3005b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3006b196be89STejun Heo 
3007b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3008b196be89STejun Heo 	if (!wq)
3009b196be89STejun Heo 		goto err;
3010b196be89STejun Heo 
3011b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3012b196be89STejun Heo 	va_end(args);
3013b196be89STejun Heo 	va_end(args1);
30143af24433SOleg Nesterov 
3015f3421797STejun Heo 	/*
30166370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
30176370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
30186370a6adSTejun Heo 	 */
30196370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
30206370a6adSTejun Heo 		flags |= WQ_RESCUER;
30216370a6adSTejun Heo 
3022d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3023b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
30243af24433SOleg Nesterov 
3025b196be89STejun Heo 	/* init wq */
302697e37d7bSTejun Heo 	wq->flags = flags;
3027a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
302873f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
302973f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
303073f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
303173f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
30323af24433SOleg Nesterov 
3033eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3034cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
30353af24433SOleg Nesterov 
3036bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3037bdbc5dd7STejun Heo 		goto err;
3038bdbc5dd7STejun Heo 
3039f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
30401537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
30418b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
30421537663fSTejun Heo 
30430f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
3044bd7bdd43STejun Heo 		cwq->pool = &gcwq->pool;
3045c34056a3STejun Heo 		cwq->wq = wq;
304673f53c4aSTejun Heo 		cwq->flush_color = -1;
30471e19ffc6STejun Heo 		cwq->max_active = max_active;
30481e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3049e22bee78STejun Heo 	}
30501537663fSTejun Heo 
3051e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3052e22bee78STejun Heo 		struct worker *rescuer;
3053e22bee78STejun Heo 
3054f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3055e22bee78STejun Heo 			goto err;
3056e22bee78STejun Heo 
3057e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3058e22bee78STejun Heo 		if (!rescuer)
3059e22bee78STejun Heo 			goto err;
3060e22bee78STejun Heo 
3061b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3062b196be89STejun Heo 					       wq->name);
3063e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3064e22bee78STejun Heo 			goto err;
3065e22bee78STejun Heo 
3066e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3067e22bee78STejun Heo 		wake_up_process(rescuer->task);
30683af24433SOleg Nesterov 	}
30691537663fSTejun Heo 
30703af24433SOleg Nesterov 	/*
3071a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3072a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3073a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
30743af24433SOleg Nesterov 	 */
30753af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3076a0a1a5fdSTejun Heo 
307758a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3078f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3079a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3080a0a1a5fdSTejun Heo 
30813af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3082a0a1a5fdSTejun Heo 
30833af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
30843af24433SOleg Nesterov 
30853af24433SOleg Nesterov 	return wq;
30864690c4abSTejun Heo err:
30874690c4abSTejun Heo 	if (wq) {
3088bdbc5dd7STejun Heo 		free_cwqs(wq);
3089f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3090e22bee78STejun Heo 		kfree(wq->rescuer);
30914690c4abSTejun Heo 		kfree(wq);
30923af24433SOleg Nesterov 	}
30934690c4abSTejun Heo 	return NULL;
30941da177e4SLinus Torvalds }
3095d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
30961da177e4SLinus Torvalds 
30973af24433SOleg Nesterov /**
30983af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
30993af24433SOleg Nesterov  * @wq: target workqueue
31003af24433SOleg Nesterov  *
31013af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
31023af24433SOleg Nesterov  */
31033af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
31043af24433SOleg Nesterov {
3105c8e55f36STejun Heo 	unsigned int cpu;
31063af24433SOleg Nesterov 
31079c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
31089c5a2ba7STejun Heo 	drain_workqueue(wq);
3109c8efcc25STejun Heo 
3110a0a1a5fdSTejun Heo 	/*
3111a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3112a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3113a0a1a5fdSTejun Heo 	 */
311495402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
31153af24433SOleg Nesterov 	list_del(&wq->list);
311695402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
31173af24433SOleg Nesterov 
3118e22bee78STejun Heo 	/* sanity check */
3119f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
312073f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
312173f53c4aSTejun Heo 		int i;
31223af24433SOleg Nesterov 
312373f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
312473f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
31251e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
31261e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
312773f53c4aSTejun Heo 	}
31281537663fSTejun Heo 
3129e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3130e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3131f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
31328d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3133e22bee78STejun Heo 	}
3134e22bee78STejun Heo 
3135bdbc5dd7STejun Heo 	free_cwqs(wq);
31363af24433SOleg Nesterov 	kfree(wq);
31373af24433SOleg Nesterov }
31383af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
31393af24433SOleg Nesterov 
3140dcd989cbSTejun Heo /**
3141dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3142dcd989cbSTejun Heo  * @wq: target workqueue
3143dcd989cbSTejun Heo  * @max_active: new max_active value.
3144dcd989cbSTejun Heo  *
3145dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3146dcd989cbSTejun Heo  *
3147dcd989cbSTejun Heo  * CONTEXT:
3148dcd989cbSTejun Heo  * Don't call from IRQ context.
3149dcd989cbSTejun Heo  */
3150dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3151dcd989cbSTejun Heo {
3152dcd989cbSTejun Heo 	unsigned int cpu;
3153dcd989cbSTejun Heo 
3154f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3155dcd989cbSTejun Heo 
3156dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3157dcd989cbSTejun Heo 
3158dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3159dcd989cbSTejun Heo 
3160f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3161dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3162dcd989cbSTejun Heo 
3163dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3164dcd989cbSTejun Heo 
316558a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3166dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3167dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3168dcd989cbSTejun Heo 
3169dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3170dcd989cbSTejun Heo 	}
3171dcd989cbSTejun Heo 
3172dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3173dcd989cbSTejun Heo }
3174dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3175dcd989cbSTejun Heo 
3176dcd989cbSTejun Heo /**
3177dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3178dcd989cbSTejun Heo  * @cpu: CPU in question
3179dcd989cbSTejun Heo  * @wq: target workqueue
3180dcd989cbSTejun Heo  *
3181dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3182dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3183dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3184dcd989cbSTejun Heo  *
3185dcd989cbSTejun Heo  * RETURNS:
3186dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3187dcd989cbSTejun Heo  */
3188dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3189dcd989cbSTejun Heo {
3190dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3191dcd989cbSTejun Heo 
3192dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3193dcd989cbSTejun Heo }
3194dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3195dcd989cbSTejun Heo 
3196dcd989cbSTejun Heo /**
3197dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3198dcd989cbSTejun Heo  * @work: the work of interest
3199dcd989cbSTejun Heo  *
3200dcd989cbSTejun Heo  * RETURNS:
3201bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3202dcd989cbSTejun Heo  */
3203dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3204dcd989cbSTejun Heo {
3205dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3206dcd989cbSTejun Heo 
3207bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3208dcd989cbSTejun Heo }
3209dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3210dcd989cbSTejun Heo 
3211dcd989cbSTejun Heo /**
3212dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3213dcd989cbSTejun Heo  * @work: the work to be tested
3214dcd989cbSTejun Heo  *
3215dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3216dcd989cbSTejun Heo  * synchronization around this function and the test result is
3217dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3218dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3219dcd989cbSTejun Heo  * running state.
3220dcd989cbSTejun Heo  *
3221dcd989cbSTejun Heo  * RETURNS:
3222dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3223dcd989cbSTejun Heo  */
3224dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3225dcd989cbSTejun Heo {
3226dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3227dcd989cbSTejun Heo 	unsigned long flags;
3228dcd989cbSTejun Heo 	unsigned int ret = 0;
3229dcd989cbSTejun Heo 
3230dcd989cbSTejun Heo 	if (!gcwq)
3231dcd989cbSTejun Heo 		return false;
3232dcd989cbSTejun Heo 
3233dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3234dcd989cbSTejun Heo 
3235dcd989cbSTejun Heo 	if (work_pending(work))
3236dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3237dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3238dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3239dcd989cbSTejun Heo 
3240dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3241dcd989cbSTejun Heo 
3242dcd989cbSTejun Heo 	return ret;
3243dcd989cbSTejun Heo }
3244dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3245dcd989cbSTejun Heo 
3246db7bccf4STejun Heo /*
3247db7bccf4STejun Heo  * CPU hotplug.
3248db7bccf4STejun Heo  *
3249e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3250e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3251e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3252e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3253e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3254e22bee78STejun Heo  * blocked draining impractical.
3255e22bee78STejun Heo  *
3256e22bee78STejun Heo  * This is solved by allowing a gcwq to be detached from CPU, running
3257e22bee78STejun Heo  * it with unbound (rogue) workers and allowing it to be reattached
3258e22bee78STejun Heo  * later if the cpu comes back online.  A separate thread is created
3259e22bee78STejun Heo  * to govern a gcwq in such state and is called the trustee of the
3260e22bee78STejun Heo  * gcwq.
3261db7bccf4STejun Heo  *
3262db7bccf4STejun Heo  * Trustee states and their descriptions.
3263db7bccf4STejun Heo  *
3264db7bccf4STejun Heo  * START	Command state used on startup.  On CPU_DOWN_PREPARE, a
3265db7bccf4STejun Heo  *		new trustee is started with this state.
3266db7bccf4STejun Heo  *
3267db7bccf4STejun Heo  * IN_CHARGE	Once started, trustee will enter this state after
3268e22bee78STejun Heo  *		assuming the manager role and making all existing
3269e22bee78STejun Heo  *		workers rogue.  DOWN_PREPARE waits for trustee to
3270e22bee78STejun Heo  *		enter this state.  After reaching IN_CHARGE, trustee
3271e22bee78STejun Heo  *		tries to execute the pending worklist until it's empty
3272e22bee78STejun Heo  *		and the state is set to BUTCHER, or the state is set
3273e22bee78STejun Heo  *		to RELEASE.
3274db7bccf4STejun Heo  *
3275db7bccf4STejun Heo  * BUTCHER	Command state which is set by the cpu callback after
3276db7bccf4STejun Heo  *		the cpu has went down.  Once this state is set trustee
3277db7bccf4STejun Heo  *		knows that there will be no new works on the worklist
3278db7bccf4STejun Heo  *		and once the worklist is empty it can proceed to
3279db7bccf4STejun Heo  *		killing idle workers.
3280db7bccf4STejun Heo  *
3281db7bccf4STejun Heo  * RELEASE	Command state which is set by the cpu callback if the
3282db7bccf4STejun Heo  *		cpu down has been canceled or it has come online
3283db7bccf4STejun Heo  *		again.  After recognizing this state, trustee stops
3284e22bee78STejun Heo  *		trying to drain or butcher and clears ROGUE, rebinds
3285e22bee78STejun Heo  *		all remaining workers back to the cpu and releases
3286e22bee78STejun Heo  *		manager role.
3287db7bccf4STejun Heo  *
3288db7bccf4STejun Heo  * DONE		Trustee will enter this state after BUTCHER or RELEASE
3289db7bccf4STejun Heo  *		is complete.
3290db7bccf4STejun Heo  *
3291db7bccf4STejun Heo  *          trustee                 CPU                draining
3292db7bccf4STejun Heo  *         took over                down               complete
3293db7bccf4STejun Heo  * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3294db7bccf4STejun Heo  *                        |                     |                  ^
3295db7bccf4STejun Heo  *                        | CPU is back online  v   return workers |
3296db7bccf4STejun Heo  *                         ----------------> RELEASE --------------
3297db7bccf4STejun Heo  */
3298db7bccf4STejun Heo 
3299db7bccf4STejun Heo /**
3300db7bccf4STejun Heo  * trustee_wait_event_timeout - timed event wait for trustee
3301db7bccf4STejun Heo  * @cond: condition to wait for
3302db7bccf4STejun Heo  * @timeout: timeout in jiffies
3303db7bccf4STejun Heo  *
3304db7bccf4STejun Heo  * wait_event_timeout() for trustee to use.  Handles locking and
3305db7bccf4STejun Heo  * checks for RELEASE request.
3306db7bccf4STejun Heo  *
3307db7bccf4STejun Heo  * CONTEXT:
3308db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3309db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3310db7bccf4STejun Heo  *
3311db7bccf4STejun Heo  * RETURNS:
3312db7bccf4STejun Heo  * Positive indicating left time if @cond is satisfied, 0 if timed
3313db7bccf4STejun Heo  * out, -1 if canceled.
3314db7bccf4STejun Heo  */
3315db7bccf4STejun Heo #define trustee_wait_event_timeout(cond, timeout) ({			\
3316db7bccf4STejun Heo 	long __ret = (timeout);						\
3317db7bccf4STejun Heo 	while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) &&	\
3318db7bccf4STejun Heo 	       __ret) {							\
3319db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);				\
3320db7bccf4STejun Heo 		__wait_event_timeout(gcwq->trustee_wait, (cond) ||	\
3321db7bccf4STejun Heo 			(gcwq->trustee_state == TRUSTEE_RELEASE),	\
3322db7bccf4STejun Heo 			__ret);						\
3323db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);				\
3324db7bccf4STejun Heo 	}								\
3325db7bccf4STejun Heo 	gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret);		\
3326db7bccf4STejun Heo })
3327db7bccf4STejun Heo 
3328db7bccf4STejun Heo /**
3329db7bccf4STejun Heo  * trustee_wait_event - event wait for trustee
3330db7bccf4STejun Heo  * @cond: condition to wait for
3331db7bccf4STejun Heo  *
3332db7bccf4STejun Heo  * wait_event() for trustee to use.  Automatically handles locking and
3333db7bccf4STejun Heo  * checks for CANCEL request.
3334db7bccf4STejun Heo  *
3335db7bccf4STejun Heo  * CONTEXT:
3336db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3337db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3338db7bccf4STejun Heo  *
3339db7bccf4STejun Heo  * RETURNS:
3340db7bccf4STejun Heo  * 0 if @cond is satisfied, -1 if canceled.
3341db7bccf4STejun Heo  */
3342db7bccf4STejun Heo #define trustee_wait_event(cond) ({					\
3343db7bccf4STejun Heo 	long __ret1;							\
3344db7bccf4STejun Heo 	__ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3345db7bccf4STejun Heo 	__ret1 < 0 ? -1 : 0;						\
3346db7bccf4STejun Heo })
3347db7bccf4STejun Heo 
3348db7bccf4STejun Heo static int __cpuinit trustee_thread(void *__gcwq)
3349db7bccf4STejun Heo {
3350db7bccf4STejun Heo 	struct global_cwq *gcwq = __gcwq;
3351db7bccf4STejun Heo 	struct worker *worker;
3352e22bee78STejun Heo 	struct work_struct *work;
3353db7bccf4STejun Heo 	struct hlist_node *pos;
3354e22bee78STejun Heo 	long rc;
3355db7bccf4STejun Heo 	int i;
3356db7bccf4STejun Heo 
3357db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3358db7bccf4STejun Heo 
3359db7bccf4STejun Heo 	spin_lock_irq(&gcwq->lock);
3360db7bccf4STejun Heo 	/*
3361e22bee78STejun Heo 	 * Claim the manager position and make all workers rogue.
3362e22bee78STejun Heo 	 * Trustee must be bound to the target cpu and can't be
3363e22bee78STejun Heo 	 * cancelled.
3364db7bccf4STejun Heo 	 */
3365db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3366*11ebea50STejun Heo 	rc = trustee_wait_event(!(gcwq->pool.flags & POOL_MANAGING_WORKERS));
3367e22bee78STejun Heo 	BUG_ON(rc < 0);
3368e22bee78STejun Heo 
3369*11ebea50STejun Heo 	gcwq->pool.flags |= POOL_MANAGING_WORKERS;
3370db7bccf4STejun Heo 
3371bd7bdd43STejun Heo 	list_for_each_entry(worker, &gcwq->pool.idle_list, entry)
3372cb444766STejun Heo 		worker->flags |= WORKER_ROGUE;
3373db7bccf4STejun Heo 
3374db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3375cb444766STejun Heo 		worker->flags |= WORKER_ROGUE;
3376db7bccf4STejun Heo 
3377db7bccf4STejun Heo 	/*
3378e22bee78STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can
3379e22bee78STejun Heo 	 * guarantee sched callbacks see the rogue flag.  This is
3380e22bee78STejun Heo 	 * necessary as scheduler callbacks may be invoked from other
3381e22bee78STejun Heo 	 * cpus.
3382e22bee78STejun Heo 	 */
3383e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3384e22bee78STejun Heo 	schedule();
3385e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3386e22bee78STejun Heo 
3387e22bee78STejun Heo 	/*
3388cb444766STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After
3389cb444766STejun Heo 	 * this, nr_running stays zero and need_more_worker() and
3390cb444766STejun Heo 	 * keep_working() are always true as long as the worklist is
3391cb444766STejun Heo 	 * not empty.
3392e22bee78STejun Heo 	 */
339363d95a91STejun Heo 	atomic_set(get_pool_nr_running(&gcwq->pool), 0);
3394e22bee78STejun Heo 
3395e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3396bd7bdd43STejun Heo 	del_timer_sync(&gcwq->pool.idle_timer);
3397e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3398e22bee78STejun Heo 
3399e22bee78STejun Heo 	/*
3400db7bccf4STejun Heo 	 * We're now in charge.  Notify and proceed to drain.  We need
3401db7bccf4STejun Heo 	 * to keep the gcwq running during the whole CPU down
3402db7bccf4STejun Heo 	 * procedure as other cpu hotunplug callbacks may need to
3403db7bccf4STejun Heo 	 * flush currently running tasks.
3404db7bccf4STejun Heo 	 */
3405db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3406db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3407db7bccf4STejun Heo 
3408db7bccf4STejun Heo 	/*
3409db7bccf4STejun Heo 	 * The original cpu is in the process of dying and may go away
3410db7bccf4STejun Heo 	 * anytime now.  When that happens, we and all workers would
3411e22bee78STejun Heo 	 * be migrated to other cpus.  Try draining any left work.  We
3412e22bee78STejun Heo 	 * want to get it over with ASAP - spam rescuers, wake up as
3413e22bee78STejun Heo 	 * many idlers as necessary and create new ones till the
3414e22bee78STejun Heo 	 * worklist is empty.  Note that if the gcwq is frozen, there
341558a69cb4STejun Heo 	 * may be frozen works in freezable cwqs.  Don't declare
3416e22bee78STejun Heo 	 * completion while frozen.
3417db7bccf4STejun Heo 	 */
3418bd7bdd43STejun Heo 	while (gcwq->pool.nr_workers != gcwq->pool.nr_idle ||
3419db7bccf4STejun Heo 	       gcwq->flags & GCWQ_FREEZING ||
3420db7bccf4STejun Heo 	       gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
3421e22bee78STejun Heo 		int nr_works = 0;
3422e22bee78STejun Heo 
3423bd7bdd43STejun Heo 		list_for_each_entry(work, &gcwq->pool.worklist, entry) {
3424e22bee78STejun Heo 			send_mayday(work);
3425e22bee78STejun Heo 			nr_works++;
3426e22bee78STejun Heo 		}
3427e22bee78STejun Heo 
3428bd7bdd43STejun Heo 		list_for_each_entry(worker, &gcwq->pool.idle_list, entry) {
3429e22bee78STejun Heo 			if (!nr_works--)
3430e22bee78STejun Heo 				break;
3431e22bee78STejun Heo 			wake_up_process(worker->task);
3432e22bee78STejun Heo 		}
3433e22bee78STejun Heo 
343463d95a91STejun Heo 		if (need_to_create_worker(&gcwq->pool)) {
3435e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
343663d95a91STejun Heo 			worker = create_worker(&gcwq->pool, false);
3437e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3438e22bee78STejun Heo 			if (worker) {
3439cb444766STejun Heo 				worker->flags |= WORKER_ROGUE;
3440e22bee78STejun Heo 				start_worker(worker);
3441e22bee78STejun Heo 			}
3442e22bee78STejun Heo 		}
3443e22bee78STejun Heo 
3444db7bccf4STejun Heo 		/* give a breather */
3445db7bccf4STejun Heo 		if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3446db7bccf4STejun Heo 			break;
3447db7bccf4STejun Heo 	}
3448db7bccf4STejun Heo 
3449e22bee78STejun Heo 	/*
3450e22bee78STejun Heo 	 * Either all works have been scheduled and cpu is down, or
3451e22bee78STejun Heo 	 * cpu down has already been canceled.  Wait for and butcher
3452e22bee78STejun Heo 	 * all workers till we're canceled.
3453e22bee78STejun Heo 	 */
3454e22bee78STejun Heo 	do {
3455bd7bdd43STejun Heo 		rc = trustee_wait_event(!list_empty(&gcwq->pool.idle_list));
3456bd7bdd43STejun Heo 		while (!list_empty(&gcwq->pool.idle_list))
3457bd7bdd43STejun Heo 			destroy_worker(list_first_entry(&gcwq->pool.idle_list,
3458e22bee78STejun Heo 							struct worker, entry));
3459bd7bdd43STejun Heo 	} while (gcwq->pool.nr_workers && rc >= 0);
3460e22bee78STejun Heo 
3461e22bee78STejun Heo 	/*
3462e22bee78STejun Heo 	 * At this point, either draining has completed and no worker
3463e22bee78STejun Heo 	 * is left, or cpu down has been canceled or the cpu is being
3464e22bee78STejun Heo 	 * brought back up.  There shouldn't be any idle one left.
3465e22bee78STejun Heo 	 * Tell the remaining busy ones to rebind once it finishes the
3466e22bee78STejun Heo 	 * currently scheduled works by scheduling the rebind_work.
3467e22bee78STejun Heo 	 */
3468bd7bdd43STejun Heo 	WARN_ON(!list_empty(&gcwq->pool.idle_list));
3469e22bee78STejun Heo 
3470e22bee78STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
3471e22bee78STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
3472e22bee78STejun Heo 
3473e22bee78STejun Heo 		/*
3474e22bee78STejun Heo 		 * Rebind_work may race with future cpu hotplug
3475e22bee78STejun Heo 		 * operations.  Use a separate flag to mark that
3476e22bee78STejun Heo 		 * rebinding is scheduled.
3477e22bee78STejun Heo 		 */
3478cb444766STejun Heo 		worker->flags |= WORKER_REBIND;
3479cb444766STejun Heo 		worker->flags &= ~WORKER_ROGUE;
3480e22bee78STejun Heo 
3481e22bee78STejun Heo 		/* queue rebind_work, wq doesn't matter, use the default one */
3482e22bee78STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3483e22bee78STejun Heo 				     work_data_bits(rebind_work)))
3484e22bee78STejun Heo 			continue;
3485e22bee78STejun Heo 
3486e22bee78STejun Heo 		debug_work_activate(rebind_work);
3487d320c038STejun Heo 		insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3488e22bee78STejun Heo 			    worker->scheduled.next,
3489e22bee78STejun Heo 			    work_color_to_flags(WORK_NO_COLOR));
3490e22bee78STejun Heo 	}
3491e22bee78STejun Heo 
3492e22bee78STejun Heo 	/* relinquish manager role */
3493*11ebea50STejun Heo 	gcwq->pool.flags &= ~POOL_MANAGING_WORKERS;
3494e22bee78STejun Heo 
3495db7bccf4STejun Heo 	/* notify completion */
3496db7bccf4STejun Heo 	gcwq->trustee = NULL;
3497db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_DONE;
3498db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3499db7bccf4STejun Heo 	spin_unlock_irq(&gcwq->lock);
3500db7bccf4STejun Heo 	return 0;
3501db7bccf4STejun Heo }
3502db7bccf4STejun Heo 
3503db7bccf4STejun Heo /**
3504db7bccf4STejun Heo  * wait_trustee_state - wait for trustee to enter the specified state
3505db7bccf4STejun Heo  * @gcwq: gcwq the trustee of interest belongs to
3506db7bccf4STejun Heo  * @state: target state to wait for
3507db7bccf4STejun Heo  *
3508db7bccf4STejun Heo  * Wait for the trustee to reach @state.  DONE is already matched.
3509db7bccf4STejun Heo  *
3510db7bccf4STejun Heo  * CONTEXT:
3511db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3512db7bccf4STejun Heo  * multiple times.  To be used by cpu_callback.
3513db7bccf4STejun Heo  */
3514db7bccf4STejun Heo static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
351506bd6ebfSNamhyung Kim __releases(&gcwq->lock)
351606bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
3517db7bccf4STejun Heo {
3518db7bccf4STejun Heo 	if (!(gcwq->trustee_state == state ||
3519db7bccf4STejun Heo 	      gcwq->trustee_state == TRUSTEE_DONE)) {
3520db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);
3521db7bccf4STejun Heo 		__wait_event(gcwq->trustee_wait,
3522db7bccf4STejun Heo 			     gcwq->trustee_state == state ||
3523db7bccf4STejun Heo 			     gcwq->trustee_state == TRUSTEE_DONE);
3524db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);
3525db7bccf4STejun Heo 	}
3526db7bccf4STejun Heo }
3527db7bccf4STejun Heo 
35289c7b216dSChandra Seetharaman static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
35291da177e4SLinus Torvalds 						unsigned long action,
35301da177e4SLinus Torvalds 						void *hcpu)
35311da177e4SLinus Torvalds {
35323af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3533db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
3534db7bccf4STejun Heo 	struct task_struct *new_trustee = NULL;
3535e22bee78STejun Heo 	struct worker *uninitialized_var(new_worker);
3536db7bccf4STejun Heo 	unsigned long flags;
35371da177e4SLinus Torvalds 
35388bb78442SRafael J. Wysocki 	action &= ~CPU_TASKS_FROZEN;
35398bb78442SRafael J. Wysocki 
35401da177e4SLinus Torvalds 	switch (action) {
3541db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3542db7bccf4STejun Heo 		new_trustee = kthread_create(trustee_thread, gcwq,
3543db7bccf4STejun Heo 					     "workqueue_trustee/%d\n", cpu);
3544db7bccf4STejun Heo 		if (IS_ERR(new_trustee))
3545db7bccf4STejun Heo 			return notifier_from_errno(PTR_ERR(new_trustee));
3546db7bccf4STejun Heo 		kthread_bind(new_trustee, cpu);
3547e22bee78STejun Heo 		/* fall through */
35483af24433SOleg Nesterov 	case CPU_UP_PREPARE:
3549bd7bdd43STejun Heo 		BUG_ON(gcwq->pool.first_idle);
355063d95a91STejun Heo 		new_worker = create_worker(&gcwq->pool, false);
3551e22bee78STejun Heo 		if (!new_worker) {
3552e22bee78STejun Heo 			if (new_trustee)
3553e22bee78STejun Heo 				kthread_stop(new_trustee);
3554e22bee78STejun Heo 			return NOTIFY_BAD;
35553af24433SOleg Nesterov 		}
3556db7bccf4STejun Heo 	}
35571537663fSTejun Heo 
3558db7bccf4STejun Heo 	/* some are called w/ irq disabled, don't disturb irq status */
3559db7bccf4STejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
35603af24433SOleg Nesterov 
35613af24433SOleg Nesterov 	switch (action) {
3562db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3563db7bccf4STejun Heo 		/* initialize trustee and tell it to acquire the gcwq */
3564db7bccf4STejun Heo 		BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3565db7bccf4STejun Heo 		gcwq->trustee = new_trustee;
3566db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_START;
3567db7bccf4STejun Heo 		wake_up_process(gcwq->trustee);
3568db7bccf4STejun Heo 		wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3569e22bee78STejun Heo 		/* fall through */
35703af24433SOleg Nesterov 	case CPU_UP_PREPARE:
3571bd7bdd43STejun Heo 		BUG_ON(gcwq->pool.first_idle);
3572bd7bdd43STejun Heo 		gcwq->pool.first_idle = new_worker;
35731da177e4SLinus Torvalds 		break;
35741da177e4SLinus Torvalds 
3575e22bee78STejun Heo 	case CPU_DYING:
3576e22bee78STejun Heo 		/*
3577e22bee78STejun Heo 		 * Before this, the trustee and all workers except for
3578e22bee78STejun Heo 		 * the ones which are still executing works from
3579e22bee78STejun Heo 		 * before the last CPU down must be on the cpu.  After
3580e22bee78STejun Heo 		 * this, they'll all be diasporas.
3581e22bee78STejun Heo 		 */
3582e22bee78STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
3583db7bccf4STejun Heo 		break;
3584db7bccf4STejun Heo 
35853da1c84cSOleg Nesterov 	case CPU_POST_DEAD:
3586db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_BUTCHER;
3587e22bee78STejun Heo 		/* fall through */
3588e22bee78STejun Heo 	case CPU_UP_CANCELED:
3589bd7bdd43STejun Heo 		destroy_worker(gcwq->pool.first_idle);
3590bd7bdd43STejun Heo 		gcwq->pool.first_idle = NULL;
3591db7bccf4STejun Heo 		break;
3592db7bccf4STejun Heo 
3593db7bccf4STejun Heo 	case CPU_DOWN_FAILED:
35941da177e4SLinus Torvalds 	case CPU_ONLINE:
3595e22bee78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
3596db7bccf4STejun Heo 		if (gcwq->trustee_state != TRUSTEE_DONE) {
3597db7bccf4STejun Heo 			gcwq->trustee_state = TRUSTEE_RELEASE;
3598db7bccf4STejun Heo 			wake_up_process(gcwq->trustee);
3599db7bccf4STejun Heo 			wait_trustee_state(gcwq, TRUSTEE_DONE);
3600db7bccf4STejun Heo 		}
36011da177e4SLinus Torvalds 
3602e22bee78STejun Heo 		/*
3603e22bee78STejun Heo 		 * Trustee is done and there might be no worker left.
3604e22bee78STejun Heo 		 * Put the first_idle in and request a real manager to
3605e22bee78STejun Heo 		 * take a look.
3606e22bee78STejun Heo 		 */
3607e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
3608bd7bdd43STejun Heo 		kthread_bind(gcwq->pool.first_idle->task, cpu);
3609e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
3610*11ebea50STejun Heo 		gcwq->pool.flags |= POOL_MANAGE_WORKERS;
3611bd7bdd43STejun Heo 		start_worker(gcwq->pool.first_idle);
3612bd7bdd43STejun Heo 		gcwq->pool.first_idle = NULL;
36131da177e4SLinus Torvalds 		break;
36141da177e4SLinus Torvalds 	}
36151da177e4SLinus Torvalds 
3616db7bccf4STejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
361700dfcaf7SOleg Nesterov 
36181537663fSTejun Heo 	return notifier_from_errno(0);
36191da177e4SLinus Torvalds }
36201da177e4SLinus Torvalds 
36212d3854a3SRusty Russell #ifdef CONFIG_SMP
36228ccad40dSRusty Russell 
36232d3854a3SRusty Russell struct work_for_cpu {
36246b44003eSAndrew Morton 	struct completion completion;
36252d3854a3SRusty Russell 	long (*fn)(void *);
36262d3854a3SRusty Russell 	void *arg;
36272d3854a3SRusty Russell 	long ret;
36282d3854a3SRusty Russell };
36292d3854a3SRusty Russell 
36306b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
36312d3854a3SRusty Russell {
36326b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
36332d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36346b44003eSAndrew Morton 	complete(&wfc->completion);
36356b44003eSAndrew Morton 	return 0;
36362d3854a3SRusty Russell }
36372d3854a3SRusty Russell 
36382d3854a3SRusty Russell /**
36392d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36402d3854a3SRusty Russell  * @cpu: the cpu to run on
36412d3854a3SRusty Russell  * @fn: the function to run
36422d3854a3SRusty Russell  * @arg: the function arg
36432d3854a3SRusty Russell  *
364431ad9081SRusty Russell  * This will return the value @fn returns.
364531ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36466b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36472d3854a3SRusty Russell  */
36482d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36492d3854a3SRusty Russell {
36506b44003eSAndrew Morton 	struct task_struct *sub_thread;
36516b44003eSAndrew Morton 	struct work_for_cpu wfc = {
36526b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
36536b44003eSAndrew Morton 		.fn = fn,
36546b44003eSAndrew Morton 		.arg = arg,
36556b44003eSAndrew Morton 	};
36562d3854a3SRusty Russell 
36576b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
36586b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
36596b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
36606b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
36616b44003eSAndrew Morton 	wake_up_process(sub_thread);
36626b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
36632d3854a3SRusty Russell 	return wfc.ret;
36642d3854a3SRusty Russell }
36652d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36662d3854a3SRusty Russell #endif /* CONFIG_SMP */
36672d3854a3SRusty Russell 
3668a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3669e7577c50SRusty Russell 
3670a0a1a5fdSTejun Heo /**
3671a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3672a0a1a5fdSTejun Heo  *
367358a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
367458a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
367558a69cb4STejun Heo  * gcwq->worklist.
3676a0a1a5fdSTejun Heo  *
3677a0a1a5fdSTejun Heo  * CONTEXT:
36788b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3679a0a1a5fdSTejun Heo  */
3680a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3681a0a1a5fdSTejun Heo {
3682a0a1a5fdSTejun Heo 	unsigned int cpu;
3683a0a1a5fdSTejun Heo 
3684a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3685a0a1a5fdSTejun Heo 
3686a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3687a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3688a0a1a5fdSTejun Heo 
3689f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
36908b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3691bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
36928b03ae3cSTejun Heo 
36938b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
36948b03ae3cSTejun Heo 
3695db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3696db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3697db7bccf4STejun Heo 
3698a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3699a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3700a0a1a5fdSTejun Heo 
370158a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3702a0a1a5fdSTejun Heo 				cwq->max_active = 0;
37031da177e4SLinus Torvalds 		}
37048b03ae3cSTejun Heo 
37058b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3706a0a1a5fdSTejun Heo 	}
3707a0a1a5fdSTejun Heo 
3708a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3709a0a1a5fdSTejun Heo }
3710a0a1a5fdSTejun Heo 
3711a0a1a5fdSTejun Heo /**
371258a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3713a0a1a5fdSTejun Heo  *
3714a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3715a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3716a0a1a5fdSTejun Heo  *
3717a0a1a5fdSTejun Heo  * CONTEXT:
3718a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3719a0a1a5fdSTejun Heo  *
3720a0a1a5fdSTejun Heo  * RETURNS:
372158a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
372258a69cb4STejun Heo  * is complete.
3723a0a1a5fdSTejun Heo  */
3724a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3725a0a1a5fdSTejun Heo {
3726a0a1a5fdSTejun Heo 	unsigned int cpu;
3727a0a1a5fdSTejun Heo 	bool busy = false;
3728a0a1a5fdSTejun Heo 
3729a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3730a0a1a5fdSTejun Heo 
3731a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3732a0a1a5fdSTejun Heo 
3733f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3734bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3735a0a1a5fdSTejun Heo 		/*
3736a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3737a0a1a5fdSTejun Heo 		 * to peek without lock.
3738a0a1a5fdSTejun Heo 		 */
3739a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3740a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3741a0a1a5fdSTejun Heo 
374258a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3743a0a1a5fdSTejun Heo 				continue;
3744a0a1a5fdSTejun Heo 
3745a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3746a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3747a0a1a5fdSTejun Heo 				busy = true;
3748a0a1a5fdSTejun Heo 				goto out_unlock;
3749a0a1a5fdSTejun Heo 			}
3750a0a1a5fdSTejun Heo 		}
3751a0a1a5fdSTejun Heo 	}
3752a0a1a5fdSTejun Heo out_unlock:
3753a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3754a0a1a5fdSTejun Heo 	return busy;
3755a0a1a5fdSTejun Heo }
3756a0a1a5fdSTejun Heo 
3757a0a1a5fdSTejun Heo /**
3758a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3759a0a1a5fdSTejun Heo  *
3760a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
37617e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3762a0a1a5fdSTejun Heo  *
3763a0a1a5fdSTejun Heo  * CONTEXT:
37648b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3765a0a1a5fdSTejun Heo  */
3766a0a1a5fdSTejun Heo void thaw_workqueues(void)
3767a0a1a5fdSTejun Heo {
3768a0a1a5fdSTejun Heo 	unsigned int cpu;
3769a0a1a5fdSTejun Heo 
3770a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3771a0a1a5fdSTejun Heo 
3772a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3773a0a1a5fdSTejun Heo 		goto out_unlock;
3774a0a1a5fdSTejun Heo 
3775f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37768b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3777bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37788b03ae3cSTejun Heo 
37798b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37808b03ae3cSTejun Heo 
3781db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3782db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3783db7bccf4STejun Heo 
3784a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3785a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3786a0a1a5fdSTejun Heo 
378758a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3788a0a1a5fdSTejun Heo 				continue;
3789a0a1a5fdSTejun Heo 
3790a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3791a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3792a0a1a5fdSTejun Heo 
3793a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3794a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3795a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3796a0a1a5fdSTejun Heo 		}
37978b03ae3cSTejun Heo 
379863d95a91STejun Heo 		wake_up_worker(&gcwq->pool);
3799e22bee78STejun Heo 
38008b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3801a0a1a5fdSTejun Heo 	}
3802a0a1a5fdSTejun Heo 
3803a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3804a0a1a5fdSTejun Heo out_unlock:
3805a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3806a0a1a5fdSTejun Heo }
3807a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3808a0a1a5fdSTejun Heo 
38096ee0578bSSuresh Siddha static int __init init_workqueues(void)
38101da177e4SLinus Torvalds {
3811c34056a3STejun Heo 	unsigned int cpu;
3812c8e55f36STejun Heo 	int i;
3813c34056a3STejun Heo 
3814f6500947STejun Heo 	cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
38158b03ae3cSTejun Heo 
38168b03ae3cSTejun Heo 	/* initialize gcwqs */
3817f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38188b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
38198b03ae3cSTejun Heo 
38208b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
3821bd7bdd43STejun Heo 		gcwq->pool.gcwq = gcwq;
3822bd7bdd43STejun Heo 		INIT_LIST_HEAD(&gcwq->pool.worklist);
38238b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3824f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
38258b03ae3cSTejun Heo 
3826bd7bdd43STejun Heo 		INIT_LIST_HEAD(&gcwq->pool.idle_list);
3827c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3828c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3829c8e55f36STejun Heo 
3830bd7bdd43STejun Heo 		init_timer_deferrable(&gcwq->pool.idle_timer);
3831bd7bdd43STejun Heo 		gcwq->pool.idle_timer.function = idle_worker_timeout;
383263d95a91STejun Heo 		gcwq->pool.idle_timer.data = (unsigned long)&gcwq->pool;
3833e22bee78STejun Heo 
3834bd7bdd43STejun Heo 		setup_timer(&gcwq->pool.mayday_timer, gcwq_mayday_timeout,
383563d95a91STejun Heo 			    (unsigned long)&gcwq->pool);
3836e22bee78STejun Heo 
3837bd7bdd43STejun Heo 		ida_init(&gcwq->pool.worker_ida);
3838db7bccf4STejun Heo 
3839db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_DONE;
3840db7bccf4STejun Heo 		init_waitqueue_head(&gcwq->trustee_wait);
38418b03ae3cSTejun Heo 	}
38428b03ae3cSTejun Heo 
3843e22bee78STejun Heo 	/* create the initial worker */
3844f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3845e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3846e22bee78STejun Heo 		struct worker *worker;
3847e22bee78STejun Heo 
3848477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3849477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
385063d95a91STejun Heo 		worker = create_worker(&gcwq->pool, true);
3851e22bee78STejun Heo 		BUG_ON(!worker);
3852e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
3853e22bee78STejun Heo 		start_worker(worker);
3854e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
3855e22bee78STejun Heo 	}
3856e22bee78STejun Heo 
3857d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
3858d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3859d320c038STejun Heo 	system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3860f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3861f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
386224d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
386324d51addSTejun Heo 					      WQ_FREEZABLE, 0);
386462d3c543SAlan Stern 	system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
386562d3c543SAlan Stern 			WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
3866e5cba24eSHitoshi Mitake 	BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
386762d3c543SAlan Stern 	       !system_unbound_wq || !system_freezable_wq ||
386862d3c543SAlan Stern 		!system_nrt_freezable_wq);
38696ee0578bSSuresh Siddha 	return 0;
38701da177e4SLinus Torvalds }
38716ee0578bSSuresh Siddha early_initcall(init_workqueues);
3872