xref: /linux-6.15/kernel/workqueue.c (revision 974271c4)
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 */
49e22bee78STejun Heo 	GCWQ_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
50e22bee78STejun Heo 	GCWQ_MANAGING_WORKERS	= 1 << 1,	/* managing workers */
51e22bee78STejun Heo 	GCWQ_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
52db7bccf4STejun Heo 	GCWQ_FREEZING		= 1 << 3,	/* freeze in progress */
53649027d7STejun Heo 	GCWQ_HIGHPRI_PENDING	= 1 << 4,	/* highpri works on queue */
54db7bccf4STejun Heo 
55c8e55f36STejun Heo 	/* worker flags */
56c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
57c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
58c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
59e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
60db7bccf4STejun Heo 	WORKER_ROGUE		= 1 << 4,	/* not bound to any cpu */
61e22bee78STejun Heo 	WORKER_REBIND		= 1 << 5,	/* mom is home, come back */
62fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
63f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
64e22bee78STejun Heo 
65fb0e7bebSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
66f3421797STejun Heo 				  WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
67db7bccf4STejun Heo 
68db7bccf4STejun Heo 	/* gcwq->trustee_state */
69db7bccf4STejun Heo 	TRUSTEE_START		= 0,		/* start */
70db7bccf4STejun Heo 	TRUSTEE_IN_CHARGE	= 1,		/* trustee in charge of gcwq */
71db7bccf4STejun Heo 	TRUSTEE_BUTCHER		= 2,		/* butcher workers */
72db7bccf4STejun Heo 	TRUSTEE_RELEASE		= 3,		/* release workers */
73db7bccf4STejun Heo 	TRUSTEE_DONE		= 4,		/* trustee is done */
74c8e55f36STejun Heo 
75c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
76c8e55f36STejun Heo 	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
77c8e55f36STejun Heo 	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
78db7bccf4STejun Heo 
79e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
80e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
81e22bee78STejun Heo 
823233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
833233cdbdSTejun Heo 						/* call for help after 10ms
843233cdbdSTejun Heo 						   (min two ticks) */
85e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
86e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
87db7bccf4STejun Heo 	TRUSTEE_COOLDOWN	= HZ / 10,	/* for trustee draining */
881da177e4SLinus Torvalds 
891da177e4SLinus Torvalds 	/*
90e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
91e22bee78STejun Heo 	 * all cpus.  Give -20.
92e22bee78STejun Heo 	 */
93e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
94c8e55f36STejun Heo };
95c8e55f36STejun Heo 
961da177e4SLinus Torvalds /*
974690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
984690c4abSTejun Heo  *
99e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
100e41e704bSTejun Heo  *    everyone else.
1014690c4abSTejun Heo  *
102e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
103e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
104e22bee78STejun Heo  *
1058b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1064690c4abSTejun Heo  *
107e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
108e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
109e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
110f3421797STejun Heo  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
111e22bee78STejun Heo  *
11273f53c4aSTejun Heo  * F: wq->flush_mutex protected.
11373f53c4aSTejun Heo  *
1144690c4abSTejun Heo  * W: workqueue_lock protected.
1154690c4abSTejun Heo  */
1164690c4abSTejun Heo 
1178b03ae3cSTejun Heo struct global_cwq;
118c34056a3STejun Heo 
119e22bee78STejun Heo /*
120e22bee78STejun Heo  * The poor guys doing the actual heavy lifting.  All on-duty workers
121e22bee78STejun Heo  * are either serving the manager role, on idle list or on busy hash.
122e22bee78STejun Heo  */
123c34056a3STejun Heo struct worker {
124c8e55f36STejun Heo 	/* on idle list while idle, on busy hash table while busy */
125c8e55f36STejun Heo 	union {
126c8e55f36STejun Heo 		struct list_head	entry;	/* L: while idle */
127c8e55f36STejun Heo 		struct hlist_node	hentry;	/* L: while busy */
128c8e55f36STejun Heo 	};
129c8e55f36STejun Heo 
130c34056a3STejun Heo 	struct work_struct	*current_work;	/* L: work being processed */
1318cca0eeaSTejun Heo 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
132affee4b2STejun Heo 	struct list_head	scheduled;	/* L: scheduled works */
133c34056a3STejun Heo 	struct task_struct	*task;		/* I: worker task */
1348b03ae3cSTejun Heo 	struct global_cwq	*gcwq;		/* I: the associated gcwq */
135e22bee78STejun Heo 	/* 64 bytes boundary on 64bit, 32 on 32bit */
136e22bee78STejun Heo 	unsigned long		last_active;	/* L: last active timestamp */
137e22bee78STejun Heo 	unsigned int		flags;		/* X: flags */
138c34056a3STejun Heo 	int			id;		/* I: worker id */
139e22bee78STejun Heo 	struct work_struct	rebind_work;	/* L: rebind worker to cpu */
140c34056a3STejun Heo };
141c34056a3STejun Heo 
1424690c4abSTejun Heo /*
143e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
144e22bee78STejun Heo  * and all works are queued and processed here regardless of their
145e22bee78STejun Heo  * target workqueues.
1468b03ae3cSTejun Heo  */
1478b03ae3cSTejun Heo struct global_cwq {
1488b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1497e11629dSTejun Heo 	struct list_head	worklist;	/* L: list of pending works */
1508b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
151db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
152c8e55f36STejun Heo 
153c8e55f36STejun Heo 	int			nr_workers;	/* L: total number of workers */
154c8e55f36STejun Heo 	int			nr_idle;	/* L: currently idle ones */
155c8e55f36STejun Heo 
156c8e55f36STejun Heo 	/* workers are chained either in the idle_list or busy_hash */
157e22bee78STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
158c8e55f36STejun Heo 	struct hlist_head	busy_hash[BUSY_WORKER_HASH_SIZE];
159c8e55f36STejun Heo 						/* L: hash of busy workers */
160c8e55f36STejun Heo 
161e22bee78STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
162e22bee78STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for dworkers */
163e22bee78STejun Heo 
1648b03ae3cSTejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
165db7bccf4STejun Heo 
166db7bccf4STejun Heo 	struct task_struct	*trustee;	/* L: for gcwq shutdown */
167db7bccf4STejun Heo 	unsigned int		trustee_state;	/* L: trustee state */
168db7bccf4STejun Heo 	wait_queue_head_t	trustee_wait;	/* trustee wait */
169e22bee78STejun Heo 	struct worker		*first_idle;	/* L: first idle worker */
1708b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1718b03ae3cSTejun Heo 
1728b03ae3cSTejun Heo /*
173502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1740f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1750f900049STejun Heo  * aligned at two's power of the number of flag bits.
1761da177e4SLinus Torvalds  */
1771da177e4SLinus Torvalds struct cpu_workqueue_struct {
1788b03ae3cSTejun Heo 	struct global_cwq	*gcwq;		/* I: the associated gcwq */
1794690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
18073f53c4aSTejun Heo 	int			work_color;	/* L: current color */
18173f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
18273f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
18373f53c4aSTejun Heo 						/* L: nr of in_flight works */
1841e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
185a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
1861e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
1870f900049STejun Heo };
1881da177e4SLinus Torvalds 
1891da177e4SLinus Torvalds /*
19073f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
19173f53c4aSTejun Heo  */
19273f53c4aSTejun Heo struct wq_flusher {
19373f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
19473f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
19573f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
19673f53c4aSTejun Heo };
1971da177e4SLinus Torvalds 
19873f53c4aSTejun Heo /*
199f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
200f2e005aaSTejun Heo  * used to determine whether there's something to be done.
201f2e005aaSTejun Heo  */
202f2e005aaSTejun Heo #ifdef CONFIG_SMP
203f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
204f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
205f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
206f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
207f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2089c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
209f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
210f2e005aaSTejun Heo #else
211f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
212f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
213f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
214f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
215f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
216f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
217f2e005aaSTejun Heo #endif
2181da177e4SLinus Torvalds 
2191da177e4SLinus Torvalds /*
2201da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2211da177e4SLinus Torvalds  * per-CPU workqueues:
2221da177e4SLinus Torvalds  */
2231da177e4SLinus Torvalds struct workqueue_struct {
2249c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
225bdbc5dd7STejun Heo 	union {
226bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
227bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
228bdbc5dd7STejun Heo 		unsigned long				v;
229bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2304690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
23173f53c4aSTejun Heo 
23273f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
23373f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
23473f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
23573f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
23673f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
23773f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
23873f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
23973f53c4aSTejun Heo 
240f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
241e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
242e22bee78STejun Heo 
2439c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
244dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2454e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2464e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2474e6045f1SJohannes Berg #endif
248b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2491da177e4SLinus Torvalds };
2501da177e4SLinus Torvalds 
251d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
252d320c038STejun Heo struct workqueue_struct *system_long_wq __read_mostly;
253d320c038STejun Heo struct workqueue_struct *system_nrt_wq __read_mostly;
254f3421797STejun Heo struct workqueue_struct *system_unbound_wq __read_mostly;
25524d51addSTejun Heo struct workqueue_struct *system_freezable_wq __read_mostly;
25662d3c543SAlan Stern struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
257d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
258d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
259d320c038STejun Heo EXPORT_SYMBOL_GPL(system_nrt_wq);
260f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
26124d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
26262d3c543SAlan Stern EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
263d320c038STejun Heo 
26497bd2347STejun Heo #define CREATE_TRACE_POINTS
26597bd2347STejun Heo #include <trace/events/workqueue.h>
26697bd2347STejun Heo 
267db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
268db7bccf4STejun Heo 	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
269db7bccf4STejun Heo 		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
270db7bccf4STejun Heo 
271f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
272f3421797STejun Heo 				  unsigned int sw)
273f3421797STejun Heo {
274f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
275f3421797STejun Heo 		if (sw & 1) {
276f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
277f3421797STejun Heo 			if (cpu < nr_cpu_ids)
278f3421797STejun Heo 				return cpu;
279f3421797STejun Heo 		}
280f3421797STejun Heo 		if (sw & 2)
281f3421797STejun Heo 			return WORK_CPU_UNBOUND;
282f3421797STejun Heo 	}
283f3421797STejun Heo 	return WORK_CPU_NONE;
284f3421797STejun Heo }
285f3421797STejun Heo 
286f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
287f3421797STejun Heo 				struct workqueue_struct *wq)
288f3421797STejun Heo {
289f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
290f3421797STejun Heo }
291f3421797STejun Heo 
29209884951STejun Heo /*
29309884951STejun Heo  * CPU iterators
29409884951STejun Heo  *
29509884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
29609884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
29709884951STejun Heo  * specific CPU.  The following iterators are similar to
29809884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
29909884951STejun Heo  *
30009884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
30109884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
30209884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
30309884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
30409884951STejun Heo  */
305f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
306f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
307f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
308f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
309f3421797STejun Heo 
310f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
311f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
312f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
313f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
314f3421797STejun Heo 
315f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
316f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
317f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
318f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
319f3421797STejun Heo 
320dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
321dc186ad7SThomas Gleixner 
322dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
323dc186ad7SThomas Gleixner 
32499777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
32599777288SStanislaw Gruszka {
32699777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
32799777288SStanislaw Gruszka }
32899777288SStanislaw Gruszka 
329dc186ad7SThomas Gleixner /*
330dc186ad7SThomas Gleixner  * fixup_init is called when:
331dc186ad7SThomas Gleixner  * - an active object is initialized
332dc186ad7SThomas Gleixner  */
333dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
334dc186ad7SThomas Gleixner {
335dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
336dc186ad7SThomas Gleixner 
337dc186ad7SThomas Gleixner 	switch (state) {
338dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
339dc186ad7SThomas Gleixner 		cancel_work_sync(work);
340dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
341dc186ad7SThomas Gleixner 		return 1;
342dc186ad7SThomas Gleixner 	default:
343dc186ad7SThomas Gleixner 		return 0;
344dc186ad7SThomas Gleixner 	}
345dc186ad7SThomas Gleixner }
346dc186ad7SThomas Gleixner 
347dc186ad7SThomas Gleixner /*
348dc186ad7SThomas Gleixner  * fixup_activate is called when:
349dc186ad7SThomas Gleixner  * - an active object is activated
350dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
351dc186ad7SThomas Gleixner  */
352dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
353dc186ad7SThomas Gleixner {
354dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
355dc186ad7SThomas Gleixner 
356dc186ad7SThomas Gleixner 	switch (state) {
357dc186ad7SThomas Gleixner 
358dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
359dc186ad7SThomas Gleixner 		/*
360dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
361dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
362dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
363dc186ad7SThomas Gleixner 		 */
36422df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
365dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
366dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
367dc186ad7SThomas Gleixner 			return 0;
368dc186ad7SThomas Gleixner 		}
369dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
370dc186ad7SThomas Gleixner 		return 0;
371dc186ad7SThomas Gleixner 
372dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
373dc186ad7SThomas Gleixner 		WARN_ON(1);
374dc186ad7SThomas Gleixner 
375dc186ad7SThomas Gleixner 	default:
376dc186ad7SThomas Gleixner 		return 0;
377dc186ad7SThomas Gleixner 	}
378dc186ad7SThomas Gleixner }
379dc186ad7SThomas Gleixner 
380dc186ad7SThomas Gleixner /*
381dc186ad7SThomas Gleixner  * fixup_free is called when:
382dc186ad7SThomas Gleixner  * - an active object is freed
383dc186ad7SThomas Gleixner  */
384dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
385dc186ad7SThomas Gleixner {
386dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
387dc186ad7SThomas Gleixner 
388dc186ad7SThomas Gleixner 	switch (state) {
389dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
390dc186ad7SThomas Gleixner 		cancel_work_sync(work);
391dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
392dc186ad7SThomas Gleixner 		return 1;
393dc186ad7SThomas Gleixner 	default:
394dc186ad7SThomas Gleixner 		return 0;
395dc186ad7SThomas Gleixner 	}
396dc186ad7SThomas Gleixner }
397dc186ad7SThomas Gleixner 
398dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
399dc186ad7SThomas Gleixner 	.name		= "work_struct",
40099777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
401dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
402dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
403dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
404dc186ad7SThomas Gleixner };
405dc186ad7SThomas Gleixner 
406dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
407dc186ad7SThomas Gleixner {
408dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
409dc186ad7SThomas Gleixner }
410dc186ad7SThomas Gleixner 
411dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
412dc186ad7SThomas Gleixner {
413dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
414dc186ad7SThomas Gleixner }
415dc186ad7SThomas Gleixner 
416dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
417dc186ad7SThomas Gleixner {
418dc186ad7SThomas Gleixner 	if (onstack)
419dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
420dc186ad7SThomas Gleixner 	else
421dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
422dc186ad7SThomas Gleixner }
423dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
424dc186ad7SThomas Gleixner 
425dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
426dc186ad7SThomas Gleixner {
427dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
428dc186ad7SThomas Gleixner }
429dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
430dc186ad7SThomas Gleixner 
431dc186ad7SThomas Gleixner #else
432dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
433dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
434dc186ad7SThomas Gleixner #endif
435dc186ad7SThomas Gleixner 
43695402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
43795402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4381da177e4SLinus Torvalds static LIST_HEAD(workqueues);
439a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4401da177e4SLinus Torvalds 
44114441960SOleg Nesterov /*
442e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
443e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
444e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
44514441960SOleg Nesterov  */
4468b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
447e22bee78STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
448f756d5e2SNathan Lynch 
449f3421797STejun Heo /*
450f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
451f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
452f3421797STejun Heo  * workers have WORKER_UNBOUND set.
453f3421797STejun Heo  */
454f3421797STejun Heo static struct global_cwq unbound_global_cwq;
455f3421797STejun Heo static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0);	/* always 0 */
456f3421797STejun Heo 
457c34056a3STejun Heo static int worker_thread(void *__worker);
4581da177e4SLinus Torvalds 
4598b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4601da177e4SLinus Torvalds {
461f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4628b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
463f3421797STejun Heo 	else
464f3421797STejun Heo 		return &unbound_global_cwq;
4651da177e4SLinus Torvalds }
4661da177e4SLinus Torvalds 
467e22bee78STejun Heo static atomic_t *get_gcwq_nr_running(unsigned int cpu)
468b1f4ec17SOleg Nesterov {
469f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
470e22bee78STejun Heo 		return &per_cpu(gcwq_nr_running, cpu);
471f3421797STejun Heo 	else
472f3421797STejun Heo 		return &unbound_gcwq_nr_running;
473b1f4ec17SOleg Nesterov }
474b1f4ec17SOleg Nesterov 
4754690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
4764690c4abSTejun Heo 					    struct workqueue_struct *wq)
477a848e3b6SOleg Nesterov {
478f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
479e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
480bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
481f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
482f3421797STejun Heo 		return wq->cpu_wq.single;
483f3421797STejun Heo 	return NULL;
484f3421797STejun Heo }
485a848e3b6SOleg Nesterov 
48673f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
48773f53c4aSTejun Heo {
48873f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
48973f53c4aSTejun Heo }
49073f53c4aSTejun Heo 
49173f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
49273f53c4aSTejun Heo {
49373f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
49473f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
49573f53c4aSTejun Heo }
49673f53c4aSTejun Heo 
49773f53c4aSTejun Heo static int work_next_color(int color)
49873f53c4aSTejun Heo {
49973f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5001da177e4SLinus Torvalds }
5011da177e4SLinus Torvalds 
5024594bf15SDavid Howells /*
503e120153dSTejun Heo  * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
504e120153dSTejun Heo  * work is on queue.  Once execution starts, WORK_STRUCT_CWQ is
505e120153dSTejun Heo  * cleared and the work data contains the cpu number it was last on.
5067a22ad75STejun Heo  *
5077a22ad75STejun Heo  * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
5087a22ad75STejun Heo  * cwq, cpu or clear work->data.  These functions should only be
5097a22ad75STejun Heo  * called while the work is owned - ie. while the PENDING bit is set.
5107a22ad75STejun Heo  *
5117a22ad75STejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq
5127a22ad75STejun Heo  * corresponding to a work.  gcwq is available once the work has been
5137a22ad75STejun Heo  * queued anywhere after initialization.  cwq is available only from
5147a22ad75STejun Heo  * queueing until execution starts.
5154594bf15SDavid Howells  */
5167a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5177a22ad75STejun Heo 				 unsigned long flags)
5187a22ad75STejun Heo {
5197a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5207a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5217a22ad75STejun Heo }
5227a22ad75STejun Heo 
5237a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5244690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5254690c4abSTejun Heo 			 unsigned long extra_flags)
526365970a1SDavid Howells {
5277a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
528e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
529365970a1SDavid Howells }
530365970a1SDavid Howells 
5317a22ad75STejun Heo static void set_work_cpu(struct work_struct *work, unsigned int cpu)
5324d707b9fSOleg Nesterov {
5337a22ad75STejun Heo 	set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
5344d707b9fSOleg Nesterov }
5354d707b9fSOleg Nesterov 
5367a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
537365970a1SDavid Howells {
5387a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5397a22ad75STejun Heo }
5407a22ad75STejun Heo 
5417a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5427a22ad75STejun Heo {
543e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5447a22ad75STejun Heo 
545e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
546e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
547e120153dSTejun Heo 	else
548e120153dSTejun Heo 		return NULL;
5497a22ad75STejun Heo }
5507a22ad75STejun Heo 
5517a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5527a22ad75STejun Heo {
553e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5547a22ad75STejun Heo 	unsigned int cpu;
5557a22ad75STejun Heo 
556e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
557e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
558e120153dSTejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
5597a22ad75STejun Heo 
5607a22ad75STejun Heo 	cpu = data >> WORK_STRUCT_FLAG_BITS;
561bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
5627a22ad75STejun Heo 		return NULL;
5637a22ad75STejun Heo 
564f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
5657a22ad75STejun Heo 	return get_gcwq(cpu);
566365970a1SDavid Howells }
567365970a1SDavid Howells 
568e22bee78STejun Heo /*
569e22bee78STejun Heo  * Policy functions.  These define the policies on how the global
570e22bee78STejun Heo  * worker pool is managed.  Unless noted otherwise, these functions
571e22bee78STejun Heo  * assume that they're being called with gcwq->lock held.
572e22bee78STejun Heo  */
573e22bee78STejun Heo 
574649027d7STejun Heo static bool __need_more_worker(struct global_cwq *gcwq)
575649027d7STejun Heo {
576649027d7STejun Heo 	return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
577649027d7STejun Heo 		gcwq->flags & GCWQ_HIGHPRI_PENDING;
578649027d7STejun Heo }
579649027d7STejun Heo 
580e22bee78STejun Heo /*
581e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
582e22bee78STejun Heo  * running workers.
583*974271c4STejun Heo  *
584*974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
585*974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
586*974271c4STejun Heo  * worklist isn't empty.
587e22bee78STejun Heo  */
588e22bee78STejun Heo static bool need_more_worker(struct global_cwq *gcwq)
589e22bee78STejun Heo {
590649027d7STejun Heo 	return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
591e22bee78STejun Heo }
592e22bee78STejun Heo 
593e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
594e22bee78STejun Heo static bool may_start_working(struct global_cwq *gcwq)
595e22bee78STejun Heo {
596e22bee78STejun Heo 	return gcwq->nr_idle;
597e22bee78STejun Heo }
598e22bee78STejun Heo 
599e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
600e22bee78STejun Heo static bool keep_working(struct global_cwq *gcwq)
601e22bee78STejun Heo {
602e22bee78STejun Heo 	atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
603e22bee78STejun Heo 
60430310045STejun Heo 	return !list_empty(&gcwq->worklist) &&
60530310045STejun Heo 		(atomic_read(nr_running) <= 1 ||
60630310045STejun Heo 		 gcwq->flags & GCWQ_HIGHPRI_PENDING);
607e22bee78STejun Heo }
608e22bee78STejun Heo 
609e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
610e22bee78STejun Heo static bool need_to_create_worker(struct global_cwq *gcwq)
611e22bee78STejun Heo {
612e22bee78STejun Heo 	return need_more_worker(gcwq) && !may_start_working(gcwq);
613e22bee78STejun Heo }
614e22bee78STejun Heo 
615e22bee78STejun Heo /* Do I need to be the manager? */
616e22bee78STejun Heo static bool need_to_manage_workers(struct global_cwq *gcwq)
617e22bee78STejun Heo {
618e22bee78STejun Heo 	return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
619e22bee78STejun Heo }
620e22bee78STejun Heo 
621e22bee78STejun Heo /* Do we have too many workers and should some go away? */
622e22bee78STejun Heo static bool too_many_workers(struct global_cwq *gcwq)
623e22bee78STejun Heo {
624e22bee78STejun Heo 	bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
625e22bee78STejun Heo 	int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
626e22bee78STejun Heo 	int nr_busy = gcwq->nr_workers - nr_idle;
627e22bee78STejun Heo 
628e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
629e22bee78STejun Heo }
630e22bee78STejun Heo 
631e22bee78STejun Heo /*
632e22bee78STejun Heo  * Wake up functions.
633e22bee78STejun Heo  */
634e22bee78STejun Heo 
6357e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
6367e11629dSTejun Heo static struct worker *first_worker(struct global_cwq *gcwq)
6377e11629dSTejun Heo {
6387e11629dSTejun Heo 	if (unlikely(list_empty(&gcwq->idle_list)))
6397e11629dSTejun Heo 		return NULL;
6407e11629dSTejun Heo 
6417e11629dSTejun Heo 	return list_first_entry(&gcwq->idle_list, struct worker, entry);
6427e11629dSTejun Heo }
6437e11629dSTejun Heo 
6447e11629dSTejun Heo /**
6457e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
6467e11629dSTejun Heo  * @gcwq: gcwq to wake worker for
6477e11629dSTejun Heo  *
6487e11629dSTejun Heo  * Wake up the first idle worker of @gcwq.
6497e11629dSTejun Heo  *
6507e11629dSTejun Heo  * CONTEXT:
6517e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
6527e11629dSTejun Heo  */
6537e11629dSTejun Heo static void wake_up_worker(struct global_cwq *gcwq)
6547e11629dSTejun Heo {
6557e11629dSTejun Heo 	struct worker *worker = first_worker(gcwq);
6567e11629dSTejun Heo 
6577e11629dSTejun Heo 	if (likely(worker))
6587e11629dSTejun Heo 		wake_up_process(worker->task);
6597e11629dSTejun Heo }
6607e11629dSTejun Heo 
6614690c4abSTejun Heo /**
662e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
663e22bee78STejun Heo  * @task: task waking up
664e22bee78STejun Heo  * @cpu: CPU @task is waking up to
665e22bee78STejun Heo  *
666e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
667e22bee78STejun Heo  * being awoken.
668e22bee78STejun Heo  *
669e22bee78STejun Heo  * CONTEXT:
670e22bee78STejun Heo  * spin_lock_irq(rq->lock)
671e22bee78STejun Heo  */
672e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
673e22bee78STejun Heo {
674e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
675e22bee78STejun Heo 
6762d64672eSSteven Rostedt 	if (!(worker->flags & WORKER_NOT_RUNNING))
677e22bee78STejun Heo 		atomic_inc(get_gcwq_nr_running(cpu));
678e22bee78STejun Heo }
679e22bee78STejun Heo 
680e22bee78STejun Heo /**
681e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
682e22bee78STejun Heo  * @task: task going to sleep
683e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
684e22bee78STejun Heo  *
685e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
686e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
687e22bee78STejun Heo  * returning pointer to its task.
688e22bee78STejun Heo  *
689e22bee78STejun Heo  * CONTEXT:
690e22bee78STejun Heo  * spin_lock_irq(rq->lock)
691e22bee78STejun Heo  *
692e22bee78STejun Heo  * RETURNS:
693e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
694e22bee78STejun Heo  */
695e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
696e22bee78STejun Heo 				       unsigned int cpu)
697e22bee78STejun Heo {
698e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
699e22bee78STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
700e22bee78STejun Heo 	atomic_t *nr_running = get_gcwq_nr_running(cpu);
701e22bee78STejun Heo 
7022d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
703e22bee78STejun Heo 		return NULL;
704e22bee78STejun Heo 
705e22bee78STejun Heo 	/* this can only happen on the local cpu */
706e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
707e22bee78STejun Heo 
708e22bee78STejun Heo 	/*
709e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
710e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
711e22bee78STejun Heo 	 * Please read comment there.
712e22bee78STejun Heo 	 *
713e22bee78STejun Heo 	 * NOT_RUNNING is clear.  This means that trustee is not in
714e22bee78STejun Heo 	 * charge and we're running on the local cpu w/ rq lock held
715e22bee78STejun Heo 	 * and preemption disabled, which in turn means that none else
716e22bee78STejun Heo 	 * could be manipulating idle_list, so dereferencing idle_list
717e22bee78STejun Heo 	 * without gcwq lock is safe.
718e22bee78STejun Heo 	 */
719e22bee78STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
720e22bee78STejun Heo 		to_wakeup = first_worker(gcwq);
721e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
722e22bee78STejun Heo }
723e22bee78STejun Heo 
724e22bee78STejun Heo /**
725e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
726cb444766STejun Heo  * @worker: self
727d302f017STejun Heo  * @flags: flags to set
728d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
729d302f017STejun Heo  *
730e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
731e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
732e22bee78STejun Heo  * woken up.
733d302f017STejun Heo  *
734cb444766STejun Heo  * CONTEXT:
735cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
736d302f017STejun Heo  */
737d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
738d302f017STejun Heo 				    bool wakeup)
739d302f017STejun Heo {
740e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
741e22bee78STejun Heo 
742cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
743cb444766STejun Heo 
744e22bee78STejun Heo 	/*
745e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
746e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
747e22bee78STejun Heo 	 * @wakeup.
748e22bee78STejun Heo 	 */
749e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
750e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
751e22bee78STejun Heo 		atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
752e22bee78STejun Heo 
753e22bee78STejun Heo 		if (wakeup) {
754e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
755e22bee78STejun Heo 			    !list_empty(&gcwq->worklist))
756e22bee78STejun Heo 				wake_up_worker(gcwq);
757e22bee78STejun Heo 		} else
758e22bee78STejun Heo 			atomic_dec(nr_running);
759e22bee78STejun Heo 	}
760e22bee78STejun Heo 
761d302f017STejun Heo 	worker->flags |= flags;
762d302f017STejun Heo }
763d302f017STejun Heo 
764d302f017STejun Heo /**
765e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
766cb444766STejun Heo  * @worker: self
767d302f017STejun Heo  * @flags: flags to clear
768d302f017STejun Heo  *
769e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
770d302f017STejun Heo  *
771cb444766STejun Heo  * CONTEXT:
772cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
773d302f017STejun Heo  */
774d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
775d302f017STejun Heo {
776e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
777e22bee78STejun Heo 	unsigned int oflags = worker->flags;
778e22bee78STejun Heo 
779cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
780cb444766STejun Heo 
781d302f017STejun Heo 	worker->flags &= ~flags;
782e22bee78STejun Heo 
78342c025f3STejun Heo 	/*
78442c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
78542c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
78642c025f3STejun Heo 	 * of multiple flags, not a single flag.
78742c025f3STejun Heo 	 */
788e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
789e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
790e22bee78STejun Heo 			atomic_inc(get_gcwq_nr_running(gcwq->cpu));
791d302f017STejun Heo }
792d302f017STejun Heo 
793d302f017STejun Heo /**
794c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
795c8e55f36STejun Heo  * @gcwq: gcwq of interest
796c8e55f36STejun Heo  * @work: work to be hashed
797c8e55f36STejun Heo  *
798c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
799c8e55f36STejun Heo  *
800c8e55f36STejun Heo  * CONTEXT:
801c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
802c8e55f36STejun Heo  *
803c8e55f36STejun Heo  * RETURNS:
804c8e55f36STejun Heo  * Pointer to the hash head.
805c8e55f36STejun Heo  */
806c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
807c8e55f36STejun Heo 					   struct work_struct *work)
808c8e55f36STejun Heo {
809c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
810c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
811c8e55f36STejun Heo 
812c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
813c8e55f36STejun Heo 	v >>= base_shift;
814c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
815c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
816c8e55f36STejun Heo 
817c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
818c8e55f36STejun Heo }
819c8e55f36STejun Heo 
820c8e55f36STejun Heo /**
8218cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
8228cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8238cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
8248cca0eeaSTejun Heo  * @work: work to find worker for
8258cca0eeaSTejun Heo  *
8268cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
8278cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
8288cca0eeaSTejun Heo  * work.
8298cca0eeaSTejun Heo  *
8308cca0eeaSTejun Heo  * CONTEXT:
8318cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8328cca0eeaSTejun Heo  *
8338cca0eeaSTejun Heo  * RETURNS:
8348cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8358cca0eeaSTejun Heo  * otherwise.
8368cca0eeaSTejun Heo  */
8378cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
8388cca0eeaSTejun Heo 						   struct hlist_head *bwh,
8398cca0eeaSTejun Heo 						   struct work_struct *work)
8408cca0eeaSTejun Heo {
8418cca0eeaSTejun Heo 	struct worker *worker;
8428cca0eeaSTejun Heo 	struct hlist_node *tmp;
8438cca0eeaSTejun Heo 
8448cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
8458cca0eeaSTejun Heo 		if (worker->current_work == work)
8468cca0eeaSTejun Heo 			return worker;
8478cca0eeaSTejun Heo 	return NULL;
8488cca0eeaSTejun Heo }
8498cca0eeaSTejun Heo 
8508cca0eeaSTejun Heo /**
8518cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8528cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8538cca0eeaSTejun Heo  * @work: work to find worker for
8548cca0eeaSTejun Heo  *
8558cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
8568cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
8578cca0eeaSTejun Heo  * function calculates @bwh itself.
8588cca0eeaSTejun Heo  *
8598cca0eeaSTejun Heo  * CONTEXT:
8608cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8618cca0eeaSTejun Heo  *
8628cca0eeaSTejun Heo  * RETURNS:
8638cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8648cca0eeaSTejun Heo  * otherwise.
8658cca0eeaSTejun Heo  */
8668cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8678cca0eeaSTejun Heo 						 struct work_struct *work)
8688cca0eeaSTejun Heo {
8698cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
8708cca0eeaSTejun Heo 					    work);
8718cca0eeaSTejun Heo }
8728cca0eeaSTejun Heo 
8738cca0eeaSTejun Heo /**
874649027d7STejun Heo  * gcwq_determine_ins_pos - find insertion position
875649027d7STejun Heo  * @gcwq: gcwq of interest
876649027d7STejun Heo  * @cwq: cwq a work is being queued for
877649027d7STejun Heo  *
878649027d7STejun Heo  * A work for @cwq is about to be queued on @gcwq, determine insertion
879649027d7STejun Heo  * position for the work.  If @cwq is for HIGHPRI wq, the work is
880649027d7STejun Heo  * queued at the head of the queue but in FIFO order with respect to
881649027d7STejun Heo  * other HIGHPRI works; otherwise, at the end of the queue.  This
882649027d7STejun Heo  * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
883649027d7STejun Heo  * there are HIGHPRI works pending.
884649027d7STejun Heo  *
885649027d7STejun Heo  * CONTEXT:
886649027d7STejun Heo  * spin_lock_irq(gcwq->lock).
887649027d7STejun Heo  *
888649027d7STejun Heo  * RETURNS:
889649027d7STejun Heo  * Pointer to inserstion position.
890649027d7STejun Heo  */
891649027d7STejun Heo static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
8921da177e4SLinus Torvalds 					       struct cpu_workqueue_struct *cwq)
8931da177e4SLinus Torvalds {
894649027d7STejun Heo 	struct work_struct *twork;
8951da177e4SLinus Torvalds 
896649027d7STejun Heo 	if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
897649027d7STejun Heo 		return &gcwq->worklist;
8981da177e4SLinus Torvalds 
899649027d7STejun Heo 	list_for_each_entry(twork, &gcwq->worklist, entry) {
900649027d7STejun Heo 		struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
901649027d7STejun Heo 
902649027d7STejun Heo 		if (!(tcwq->wq->flags & WQ_HIGHPRI))
903649027d7STejun Heo 			break;
9041da177e4SLinus Torvalds 	}
9051da177e4SLinus Torvalds 
906649027d7STejun Heo 	gcwq->flags |= GCWQ_HIGHPRI_PENDING;
907649027d7STejun Heo 	return &twork->entry;
908649027d7STejun Heo }
909649027d7STejun Heo 
910649027d7STejun Heo /**
9117e11629dSTejun Heo  * insert_work - insert a work into gcwq
9124690c4abSTejun Heo  * @cwq: cwq @work belongs to
9134690c4abSTejun Heo  * @work: work to insert
9144690c4abSTejun Heo  * @head: insertion point
9154690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
9164690c4abSTejun Heo  *
9177e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
9187e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
9194690c4abSTejun Heo  *
9204690c4abSTejun Heo  * CONTEXT:
9218b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
9221da177e4SLinus Torvalds  */
923b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
9244690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
9254690c4abSTejun Heo 			unsigned int extra_flags)
926b89deed3SOleg Nesterov {
927e22bee78STejun Heo 	struct global_cwq *gcwq = cwq->gcwq;
928e1d8aa9fSFrederic Weisbecker 
9294690c4abSTejun Heo 	/* we own @work, set data and link */
9307a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
9314690c4abSTejun Heo 
9326e84d644SOleg Nesterov 	/*
9336e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
9346e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
9356e84d644SOleg Nesterov 	 */
9366e84d644SOleg Nesterov 	smp_wmb();
9374690c4abSTejun Heo 
9381a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
939e22bee78STejun Heo 
940e22bee78STejun Heo 	/*
941e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
942e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
943e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
944e22bee78STejun Heo 	 */
945e22bee78STejun Heo 	smp_mb();
946e22bee78STejun Heo 
947649027d7STejun Heo 	if (__need_more_worker(gcwq))
948e22bee78STejun Heo 		wake_up_worker(gcwq);
949b89deed3SOleg Nesterov }
950b89deed3SOleg Nesterov 
951c8efcc25STejun Heo /*
952c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
953c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
954c8efcc25STejun Heo  * cold paths.
955c8efcc25STejun Heo  */
956c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
957c8efcc25STejun Heo {
958c8efcc25STejun Heo 	unsigned long flags;
959c8efcc25STejun Heo 	unsigned int cpu;
960c8efcc25STejun Heo 
961c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
962c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
963c8efcc25STejun Heo 		struct worker *worker;
964c8efcc25STejun Heo 		struct hlist_node *pos;
965c8efcc25STejun Heo 		int i;
966c8efcc25STejun Heo 
967c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
968c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
969c8efcc25STejun Heo 			if (worker->task != current)
970c8efcc25STejun Heo 				continue;
971c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
972c8efcc25STejun Heo 			/*
973c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
974c8efcc25STejun Heo 			 * is headed to the same workqueue.
975c8efcc25STejun Heo 			 */
976c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
977c8efcc25STejun Heo 		}
978c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
979c8efcc25STejun Heo 	}
980c8efcc25STejun Heo 	return false;
981c8efcc25STejun Heo }
982c8efcc25STejun Heo 
9834690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
9841da177e4SLinus Torvalds 			 struct work_struct *work)
9851da177e4SLinus Torvalds {
986502ca9d8STejun Heo 	struct global_cwq *gcwq;
987502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
9881e19ffc6STejun Heo 	struct list_head *worklist;
9898a2e8e5dSTejun Heo 	unsigned int work_flags;
9901da177e4SLinus Torvalds 	unsigned long flags;
9911da177e4SLinus Torvalds 
992dc186ad7SThomas Gleixner 	debug_work_activate(work);
9931e19ffc6STejun Heo 
994c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
9959c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
996c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
997e41e704bSTejun Heo 		return;
998e41e704bSTejun Heo 
999c7fc77f7STejun Heo 	/* determine gcwq to use */
1000c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1001c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1002c7fc77f7STejun Heo 
1003f3421797STejun Heo 		if (unlikely(cpu == WORK_CPU_UNBOUND))
1004f3421797STejun Heo 			cpu = raw_smp_processor_id();
1005f3421797STejun Heo 
100618aa9effSTejun Heo 		/*
100718aa9effSTejun Heo 		 * It's multi cpu.  If @wq is non-reentrant and @work
100818aa9effSTejun Heo 		 * was previously on a different cpu, it might still
100918aa9effSTejun Heo 		 * be running there, in which case the work needs to
101018aa9effSTejun Heo 		 * be queued on that cpu to guarantee non-reentrance.
101118aa9effSTejun Heo 		 */
1012502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
101318aa9effSTejun Heo 		if (wq->flags & WQ_NON_REENTRANT &&
101418aa9effSTejun Heo 		    (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
101518aa9effSTejun Heo 			struct worker *worker;
101618aa9effSTejun Heo 
101718aa9effSTejun Heo 			spin_lock_irqsave(&last_gcwq->lock, flags);
101818aa9effSTejun Heo 
101918aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
102018aa9effSTejun Heo 
102118aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
102218aa9effSTejun Heo 				gcwq = last_gcwq;
102318aa9effSTejun Heo 			else {
102418aa9effSTejun Heo 				/* meh... not running there, queue here */
102518aa9effSTejun Heo 				spin_unlock_irqrestore(&last_gcwq->lock, flags);
102618aa9effSTejun Heo 				spin_lock_irqsave(&gcwq->lock, flags);
102718aa9effSTejun Heo 			}
102818aa9effSTejun Heo 		} else
10298b03ae3cSTejun Heo 			spin_lock_irqsave(&gcwq->lock, flags);
1030f3421797STejun Heo 	} else {
1031f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
1032f3421797STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1033502ca9d8STejun Heo 	}
1034502ca9d8STejun Heo 
1035502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1036502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1037cdadf009STejun Heo 	trace_workqueue_queue_work(cpu, cwq, work);
1038502ca9d8STejun Heo 
1039f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1040f5b2552bSDan Carpenter 		spin_unlock_irqrestore(&gcwq->lock, flags);
1041f5b2552bSDan Carpenter 		return;
1042f5b2552bSDan Carpenter 	}
10431e19ffc6STejun Heo 
104473f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
10458a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
10461e19ffc6STejun Heo 
10471e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1048cdadf009STejun Heo 		trace_workqueue_activate_work(work);
10491e19ffc6STejun Heo 		cwq->nr_active++;
1050649027d7STejun Heo 		worklist = gcwq_determine_ins_pos(gcwq, cwq);
10518a2e8e5dSTejun Heo 	} else {
10528a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
10531e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
10548a2e8e5dSTejun Heo 	}
10551e19ffc6STejun Heo 
10568a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
10571e19ffc6STejun Heo 
10588b03ae3cSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
10591da177e4SLinus Torvalds }
10601da177e4SLinus Torvalds 
10610fcb78c2SRolf Eike Beer /**
10620fcb78c2SRolf Eike Beer  * queue_work - queue work on a workqueue
10630fcb78c2SRolf Eike Beer  * @wq: workqueue to use
10640fcb78c2SRolf Eike Beer  * @work: work to queue
10650fcb78c2SRolf Eike Beer  *
1066057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
10671da177e4SLinus Torvalds  *
106800dfcaf7SOleg Nesterov  * We queue the work to the CPU on which it was submitted, but if the CPU dies
106900dfcaf7SOleg Nesterov  * it can be processed by another CPU.
10701da177e4SLinus Torvalds  */
10717ad5b3a5SHarvey Harrison int queue_work(struct workqueue_struct *wq, struct work_struct *work)
10721da177e4SLinus Torvalds {
1073ef1ca236SOleg Nesterov 	int ret;
10741da177e4SLinus Torvalds 
1075ef1ca236SOleg Nesterov 	ret = queue_work_on(get_cpu(), wq, work);
1076a848e3b6SOleg Nesterov 	put_cpu();
1077ef1ca236SOleg Nesterov 
10781da177e4SLinus Torvalds 	return ret;
10791da177e4SLinus Torvalds }
1080ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_work);
10811da177e4SLinus Torvalds 
1082c1a220e7SZhang Rui /**
1083c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1084c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1085c1a220e7SZhang Rui  * @wq: workqueue to use
1086c1a220e7SZhang Rui  * @work: work to queue
1087c1a220e7SZhang Rui  *
1088c1a220e7SZhang Rui  * Returns 0 if @work was already on a queue, non-zero otherwise.
1089c1a220e7SZhang Rui  *
1090c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1091c1a220e7SZhang Rui  * can't go away.
1092c1a220e7SZhang Rui  */
1093c1a220e7SZhang Rui int
1094c1a220e7SZhang Rui queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1095c1a220e7SZhang Rui {
1096c1a220e7SZhang Rui 	int ret = 0;
1097c1a220e7SZhang Rui 
109822df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
10994690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1100c1a220e7SZhang Rui 		ret = 1;
1101c1a220e7SZhang Rui 	}
1102c1a220e7SZhang Rui 	return ret;
1103c1a220e7SZhang Rui }
1104c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1105c1a220e7SZhang Rui 
11066d141c3fSLi Zefan static void delayed_work_timer_fn(unsigned long __data)
11071da177e4SLinus Torvalds {
110852bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
11097a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
11101da177e4SLinus Torvalds 
11114690c4abSTejun Heo 	__queue_work(smp_processor_id(), cwq->wq, &dwork->work);
11121da177e4SLinus Torvalds }
11131da177e4SLinus Torvalds 
11140fcb78c2SRolf Eike Beer /**
11150fcb78c2SRolf Eike Beer  * queue_delayed_work - queue work on a workqueue after delay
11160fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1117af9997e4SRandy Dunlap  * @dwork: delayable work to queue
11180fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11190fcb78c2SRolf Eike Beer  *
1120057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11210fcb78c2SRolf Eike Beer  */
11227ad5b3a5SHarvey Harrison int queue_delayed_work(struct workqueue_struct *wq,
112352bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11241da177e4SLinus Torvalds {
112552bad64dSDavid Howells 	if (delay == 0)
112663bc0362SOleg Nesterov 		return queue_work(wq, &dwork->work);
11271da177e4SLinus Torvalds 
112863bc0362SOleg Nesterov 	return queue_delayed_work_on(-1, wq, dwork, delay);
11291da177e4SLinus Torvalds }
1130ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work);
11311da177e4SLinus Torvalds 
11320fcb78c2SRolf Eike Beer /**
11330fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
11340fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
11350fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1136af9997e4SRandy Dunlap  * @dwork: work to queue
11370fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11380fcb78c2SRolf Eike Beer  *
1139057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11400fcb78c2SRolf Eike Beer  */
11417a6bc1cdSVenkatesh Pallipadi int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
114252bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11437a6bc1cdSVenkatesh Pallipadi {
11447a6bc1cdSVenkatesh Pallipadi 	int ret = 0;
114552bad64dSDavid Howells 	struct timer_list *timer = &dwork->timer;
114652bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
11477a6bc1cdSVenkatesh Pallipadi 
114822df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1149c7fc77f7STejun Heo 		unsigned int lcpu;
11507a22ad75STejun Heo 
11517a6bc1cdSVenkatesh Pallipadi 		BUG_ON(timer_pending(timer));
11527a6bc1cdSVenkatesh Pallipadi 		BUG_ON(!list_empty(&work->entry));
11537a6bc1cdSVenkatesh Pallipadi 
11548a3e77ccSAndrew Liu 		timer_stats_timer_set_start_info(&dwork->timer);
11558a3e77ccSAndrew Liu 
11567a22ad75STejun Heo 		/*
11577a22ad75STejun Heo 		 * This stores cwq for the moment, for the timer_fn.
11587a22ad75STejun Heo 		 * Note that the work's gcwq is preserved to allow
11597a22ad75STejun Heo 		 * reentrance detection for delayed works.
11607a22ad75STejun Heo 		 */
1161c7fc77f7STejun Heo 		if (!(wq->flags & WQ_UNBOUND)) {
1162c7fc77f7STejun Heo 			struct global_cwq *gcwq = get_work_gcwq(work);
1163c7fc77f7STejun Heo 
1164c7fc77f7STejun Heo 			if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1165c7fc77f7STejun Heo 				lcpu = gcwq->cpu;
1166c7fc77f7STejun Heo 			else
1167c7fc77f7STejun Heo 				lcpu = raw_smp_processor_id();
1168c7fc77f7STejun Heo 		} else
1169c7fc77f7STejun Heo 			lcpu = WORK_CPU_UNBOUND;
1170c7fc77f7STejun Heo 
11717a22ad75STejun Heo 		set_work_cwq(work, get_cwq(lcpu, wq), 0);
1172c7fc77f7STejun Heo 
11737a6bc1cdSVenkatesh Pallipadi 		timer->expires = jiffies + delay;
117452bad64dSDavid Howells 		timer->data = (unsigned long)dwork;
11757a6bc1cdSVenkatesh Pallipadi 		timer->function = delayed_work_timer_fn;
117663bc0362SOleg Nesterov 
117763bc0362SOleg Nesterov 		if (unlikely(cpu >= 0))
11787a6bc1cdSVenkatesh Pallipadi 			add_timer_on(timer, cpu);
117963bc0362SOleg Nesterov 		else
118063bc0362SOleg Nesterov 			add_timer(timer);
11817a6bc1cdSVenkatesh Pallipadi 		ret = 1;
11827a6bc1cdSVenkatesh Pallipadi 	}
11837a6bc1cdSVenkatesh Pallipadi 	return ret;
11847a6bc1cdSVenkatesh Pallipadi }
1185ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
11861da177e4SLinus Torvalds 
1187c8e55f36STejun Heo /**
1188c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1189c8e55f36STejun Heo  * @worker: worker which is entering idle state
1190c8e55f36STejun Heo  *
1191c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1192c8e55f36STejun Heo  * necessary.
1193c8e55f36STejun Heo  *
1194c8e55f36STejun Heo  * LOCKING:
1195c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1196c8e55f36STejun Heo  */
1197c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
11981da177e4SLinus Torvalds {
1199c8e55f36STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1200c8e55f36STejun Heo 
1201c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1202c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1203c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1204c8e55f36STejun Heo 
1205cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1206cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1207c8e55f36STejun Heo 	gcwq->nr_idle++;
1208e22bee78STejun Heo 	worker->last_active = jiffies;
1209c8e55f36STejun Heo 
1210c8e55f36STejun Heo 	/* idle_list is LIFO */
1211c8e55f36STejun Heo 	list_add(&worker->entry, &gcwq->idle_list);
1212db7bccf4STejun Heo 
1213e22bee78STejun Heo 	if (likely(!(worker->flags & WORKER_ROGUE))) {
1214e22bee78STejun Heo 		if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1215e22bee78STejun Heo 			mod_timer(&gcwq->idle_timer,
1216e22bee78STejun Heo 				  jiffies + IDLE_WORKER_TIMEOUT);
1217e22bee78STejun Heo 	} else
1218db7bccf4STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1219cb444766STejun Heo 
1220544ecf31STejun Heo 	/*
1221544ecf31STejun Heo 	 * Sanity check nr_running.  Because trustee releases gcwq->lock
1222544ecf31STejun Heo 	 * between setting %WORKER_ROGUE and zapping nr_running, the
1223544ecf31STejun Heo 	 * warning may trigger spuriously.  Check iff trustee is idle.
1224544ecf31STejun Heo 	 */
1225544ecf31STejun Heo 	WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
1226544ecf31STejun Heo 		     gcwq->nr_workers == gcwq->nr_idle &&
1227cb444766STejun Heo 		     atomic_read(get_gcwq_nr_running(gcwq->cpu)));
1228c8e55f36STejun Heo }
1229c8e55f36STejun Heo 
1230c8e55f36STejun Heo /**
1231c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1232c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1233c8e55f36STejun Heo  *
1234c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1235c8e55f36STejun Heo  *
1236c8e55f36STejun Heo  * LOCKING:
1237c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1238c8e55f36STejun Heo  */
1239c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1240c8e55f36STejun Heo {
1241c8e55f36STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1242c8e55f36STejun Heo 
1243c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1244d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1245c8e55f36STejun Heo 	gcwq->nr_idle--;
1246c8e55f36STejun Heo 	list_del_init(&worker->entry);
1247c8e55f36STejun Heo }
1248c8e55f36STejun Heo 
1249e22bee78STejun Heo /**
1250e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1251e22bee78STejun Heo  * @worker: self
1252e22bee78STejun Heo  *
1253e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1254e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1255e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1256e22bee78STejun Heo  * guaranteed to execute on the cpu.
1257e22bee78STejun Heo  *
1258e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1259e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1260e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1261e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1262e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1263e22bee78STejun Heo  * [dis]associated in the meantime.
1264e22bee78STejun Heo  *
1265e22bee78STejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies
1266e22bee78STejun Heo  * the binding against GCWQ_DISASSOCIATED which is set during
1267e22bee78STejun Heo  * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1268e22bee78STejun Heo  * idle state or fetches works without dropping lock, it can guarantee
1269e22bee78STejun Heo  * the scheduling requirement described in the first paragraph.
1270e22bee78STejun Heo  *
1271e22bee78STejun Heo  * CONTEXT:
1272e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1273e22bee78STejun Heo  * held.
1274e22bee78STejun Heo  *
1275e22bee78STejun Heo  * RETURNS:
1276e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1277e22bee78STejun Heo  * bound), %false if offline.
1278e22bee78STejun Heo  */
1279e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1280972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1281e22bee78STejun Heo {
1282e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1283e22bee78STejun Heo 	struct task_struct *task = worker->task;
1284e22bee78STejun Heo 
1285e22bee78STejun Heo 	while (true) {
1286e22bee78STejun Heo 		/*
1287e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1288e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1289e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1290e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1291e22bee78STejun Heo 		 */
1292f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1293e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1294e22bee78STejun Heo 
1295e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1296e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1297e22bee78STejun Heo 			return false;
1298e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1299e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1300e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1301e22bee78STejun Heo 			return true;
1302e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1303e22bee78STejun Heo 
13045035b20fSTejun Heo 		/*
13055035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
13065035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
13075035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
13085035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
13095035b20fSTejun Heo 		 */
1310e22bee78STejun Heo 		cpu_relax();
13115035b20fSTejun Heo 		cond_resched();
1312e22bee78STejun Heo 	}
1313e22bee78STejun Heo }
1314e22bee78STejun Heo 
1315e22bee78STejun Heo /*
1316e22bee78STejun Heo  * Function for worker->rebind_work used to rebind rogue busy workers
1317e22bee78STejun Heo  * to the associated cpu which is coming back online.  This is
1318e22bee78STejun Heo  * scheduled by cpu up but can race with other cpu hotplug operations
1319e22bee78STejun Heo  * and may be executed twice without intervening cpu down.
1320e22bee78STejun Heo  */
1321e22bee78STejun Heo static void worker_rebind_fn(struct work_struct *work)
1322e22bee78STejun Heo {
1323e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1324e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1325e22bee78STejun Heo 
1326e22bee78STejun Heo 	if (worker_maybe_bind_and_lock(worker))
1327e22bee78STejun Heo 		worker_clr_flags(worker, WORKER_REBIND);
1328e22bee78STejun Heo 
1329e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1330e22bee78STejun Heo }
1331e22bee78STejun Heo 
1332c34056a3STejun Heo static struct worker *alloc_worker(void)
1333c34056a3STejun Heo {
1334c34056a3STejun Heo 	struct worker *worker;
1335c34056a3STejun Heo 
1336c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1337c8e55f36STejun Heo 	if (worker) {
1338c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1339affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1340e22bee78STejun Heo 		INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1341e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1342e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1343c8e55f36STejun Heo 	}
1344c34056a3STejun Heo 	return worker;
1345c34056a3STejun Heo }
1346c34056a3STejun Heo 
1347c34056a3STejun Heo /**
1348c34056a3STejun Heo  * create_worker - create a new workqueue worker
13497e11629dSTejun Heo  * @gcwq: gcwq the new worker will belong to
1350c34056a3STejun Heo  * @bind: whether to set affinity to @cpu or not
1351c34056a3STejun Heo  *
13527e11629dSTejun Heo  * Create a new worker which is bound to @gcwq.  The returned worker
1353c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1354c34056a3STejun Heo  * destroy_worker().
1355c34056a3STejun Heo  *
1356c34056a3STejun Heo  * CONTEXT:
1357c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1358c34056a3STejun Heo  *
1359c34056a3STejun Heo  * RETURNS:
1360c34056a3STejun Heo  * Pointer to the newly created worker.
1361c34056a3STejun Heo  */
13627e11629dSTejun Heo static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
1363c34056a3STejun Heo {
1364f3421797STejun Heo 	bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
1365c34056a3STejun Heo 	struct worker *worker = NULL;
1366f3421797STejun Heo 	int id = -1;
1367c34056a3STejun Heo 
13688b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
13698b03ae3cSTejun Heo 	while (ida_get_new(&gcwq->worker_ida, &id)) {
13708b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
13718b03ae3cSTejun Heo 		if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
1372c34056a3STejun Heo 			goto fail;
13738b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1374c34056a3STejun Heo 	}
13758b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1376c34056a3STejun Heo 
1377c34056a3STejun Heo 	worker = alloc_worker();
1378c34056a3STejun Heo 	if (!worker)
1379c34056a3STejun Heo 		goto fail;
1380c34056a3STejun Heo 
13818b03ae3cSTejun Heo 	worker->gcwq = gcwq;
1382c34056a3STejun Heo 	worker->id = id;
1383c34056a3STejun Heo 
1384f3421797STejun Heo 	if (!on_unbound_cpu)
138594dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
138694dcf29aSEric Dumazet 						      worker,
138794dcf29aSEric Dumazet 						      cpu_to_node(gcwq->cpu),
1388f3421797STejun Heo 						      "kworker/%u:%d", gcwq->cpu, id);
1389f3421797STejun Heo 	else
1390f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
1391f3421797STejun Heo 					      "kworker/u:%d", id);
1392c34056a3STejun Heo 	if (IS_ERR(worker->task))
1393c34056a3STejun Heo 		goto fail;
1394c34056a3STejun Heo 
1395db7bccf4STejun Heo 	/*
1396db7bccf4STejun Heo 	 * A rogue worker will become a regular one if CPU comes
1397db7bccf4STejun Heo 	 * online later on.  Make sure every worker has
1398db7bccf4STejun Heo 	 * PF_THREAD_BOUND set.
1399db7bccf4STejun Heo 	 */
1400f3421797STejun Heo 	if (bind && !on_unbound_cpu)
14018b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1402f3421797STejun Heo 	else {
1403db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1404f3421797STejun Heo 		if (on_unbound_cpu)
1405f3421797STejun Heo 			worker->flags |= WORKER_UNBOUND;
1406f3421797STejun Heo 	}
1407c34056a3STejun Heo 
1408c34056a3STejun Heo 	return worker;
1409c34056a3STejun Heo fail:
1410c34056a3STejun Heo 	if (id >= 0) {
14118b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
14128b03ae3cSTejun Heo 		ida_remove(&gcwq->worker_ida, id);
14138b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1414c34056a3STejun Heo 	}
1415c34056a3STejun Heo 	kfree(worker);
1416c34056a3STejun Heo 	return NULL;
1417c34056a3STejun Heo }
1418c34056a3STejun Heo 
1419c34056a3STejun Heo /**
1420c34056a3STejun Heo  * start_worker - start a newly created worker
1421c34056a3STejun Heo  * @worker: worker to start
1422c34056a3STejun Heo  *
1423c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1424c34056a3STejun Heo  *
1425c34056a3STejun Heo  * CONTEXT:
14268b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1427c34056a3STejun Heo  */
1428c34056a3STejun Heo static void start_worker(struct worker *worker)
1429c34056a3STejun Heo {
1430cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1431c8e55f36STejun Heo 	worker->gcwq->nr_workers++;
1432c8e55f36STejun Heo 	worker_enter_idle(worker);
1433c34056a3STejun Heo 	wake_up_process(worker->task);
1434c34056a3STejun Heo }
1435c34056a3STejun Heo 
1436c34056a3STejun Heo /**
1437c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1438c34056a3STejun Heo  * @worker: worker to be destroyed
1439c34056a3STejun Heo  *
1440c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1441c8e55f36STejun Heo  *
1442c8e55f36STejun Heo  * CONTEXT:
1443c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1444c34056a3STejun Heo  */
1445c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1446c34056a3STejun Heo {
14478b03ae3cSTejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1448c34056a3STejun Heo 	int id = worker->id;
1449c34056a3STejun Heo 
1450c34056a3STejun Heo 	/* sanity check frenzy */
1451c34056a3STejun Heo 	BUG_ON(worker->current_work);
1452affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1453c34056a3STejun Heo 
1454c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1455c8e55f36STejun Heo 		gcwq->nr_workers--;
1456c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1457c8e55f36STejun Heo 		gcwq->nr_idle--;
1458c8e55f36STejun Heo 
1459c8e55f36STejun Heo 	list_del_init(&worker->entry);
1460cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1461c8e55f36STejun Heo 
1462c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1463c8e55f36STejun Heo 
1464c34056a3STejun Heo 	kthread_stop(worker->task);
1465c34056a3STejun Heo 	kfree(worker);
1466c34056a3STejun Heo 
14678b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
14688b03ae3cSTejun Heo 	ida_remove(&gcwq->worker_ida, id);
1469c34056a3STejun Heo }
1470c34056a3STejun Heo 
1471e22bee78STejun Heo static void idle_worker_timeout(unsigned long __gcwq)
1472e22bee78STejun Heo {
1473e22bee78STejun Heo 	struct global_cwq *gcwq = (void *)__gcwq;
1474e22bee78STejun Heo 
1475e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1476e22bee78STejun Heo 
1477e22bee78STejun Heo 	if (too_many_workers(gcwq)) {
1478e22bee78STejun Heo 		struct worker *worker;
1479e22bee78STejun Heo 		unsigned long expires;
1480e22bee78STejun Heo 
1481e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
1482e22bee78STejun Heo 		worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1483e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1484e22bee78STejun Heo 
1485e22bee78STejun Heo 		if (time_before(jiffies, expires))
1486e22bee78STejun Heo 			mod_timer(&gcwq->idle_timer, expires);
1487e22bee78STejun Heo 		else {
1488e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
1489e22bee78STejun Heo 			gcwq->flags |= GCWQ_MANAGE_WORKERS;
1490e22bee78STejun Heo 			wake_up_worker(gcwq);
1491e22bee78STejun Heo 		}
1492e22bee78STejun Heo 	}
1493e22bee78STejun Heo 
1494e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1495e22bee78STejun Heo }
1496e22bee78STejun Heo 
1497e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1498e22bee78STejun Heo {
1499e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1500e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1501f3421797STejun Heo 	unsigned int cpu;
1502e22bee78STejun Heo 
1503e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1504e22bee78STejun Heo 		return false;
1505e22bee78STejun Heo 
1506e22bee78STejun Heo 	/* mayday mayday mayday */
1507f3421797STejun Heo 	cpu = cwq->gcwq->cpu;
1508f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1509f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1510f3421797STejun Heo 		cpu = 0;
1511f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1512e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1513e22bee78STejun Heo 	return true;
1514e22bee78STejun Heo }
1515e22bee78STejun Heo 
1516e22bee78STejun Heo static void gcwq_mayday_timeout(unsigned long __gcwq)
1517e22bee78STejun Heo {
1518e22bee78STejun Heo 	struct global_cwq *gcwq = (void *)__gcwq;
1519e22bee78STejun Heo 	struct work_struct *work;
1520e22bee78STejun Heo 
1521e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1522e22bee78STejun Heo 
1523e22bee78STejun Heo 	if (need_to_create_worker(gcwq)) {
1524e22bee78STejun Heo 		/*
1525e22bee78STejun Heo 		 * We've been trying to create a new worker but
1526e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1527e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1528e22bee78STejun Heo 		 * rescuers.
1529e22bee78STejun Heo 		 */
1530e22bee78STejun Heo 		list_for_each_entry(work, &gcwq->worklist, entry)
1531e22bee78STejun Heo 			send_mayday(work);
1532e22bee78STejun Heo 	}
1533e22bee78STejun Heo 
1534e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1535e22bee78STejun Heo 
1536e22bee78STejun Heo 	mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1537e22bee78STejun Heo }
1538e22bee78STejun Heo 
1539e22bee78STejun Heo /**
1540e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
1541e22bee78STejun Heo  * @gcwq: gcwq to create a new worker for
1542e22bee78STejun Heo  *
1543e22bee78STejun Heo  * Create a new worker for @gcwq if necessary.  @gcwq is guaranteed to
1544e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1545e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1546e22bee78STejun Heo  * sent to all rescuers with works scheduled on @gcwq to resolve
1547e22bee78STejun Heo  * possible allocation deadlock.
1548e22bee78STejun Heo  *
1549e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1550e22bee78STejun Heo  * may_start_working() true.
1551e22bee78STejun Heo  *
1552e22bee78STejun Heo  * LOCKING:
1553e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1554e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1555e22bee78STejun Heo  * manager.
1556e22bee78STejun Heo  *
1557e22bee78STejun Heo  * RETURNS:
1558e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1559e22bee78STejun Heo  * otherwise.
1560e22bee78STejun Heo  */
1561e22bee78STejun Heo static bool maybe_create_worker(struct global_cwq *gcwq)
156206bd6ebfSNamhyung Kim __releases(&gcwq->lock)
156306bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1564e22bee78STejun Heo {
1565e22bee78STejun Heo 	if (!need_to_create_worker(gcwq))
1566e22bee78STejun Heo 		return false;
1567e22bee78STejun Heo restart:
15689f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
15699f9c2364STejun Heo 
1570e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1571e22bee78STejun Heo 	mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1572e22bee78STejun Heo 
1573e22bee78STejun Heo 	while (true) {
1574e22bee78STejun Heo 		struct worker *worker;
1575e22bee78STejun Heo 
1576e22bee78STejun Heo 		worker = create_worker(gcwq, true);
1577e22bee78STejun Heo 		if (worker) {
1578e22bee78STejun Heo 			del_timer_sync(&gcwq->mayday_timer);
1579e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1580e22bee78STejun Heo 			start_worker(worker);
1581e22bee78STejun Heo 			BUG_ON(need_to_create_worker(gcwq));
1582e22bee78STejun Heo 			return true;
1583e22bee78STejun Heo 		}
1584e22bee78STejun Heo 
1585e22bee78STejun Heo 		if (!need_to_create_worker(gcwq))
1586e22bee78STejun Heo 			break;
1587e22bee78STejun Heo 
1588e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1589e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
15909f9c2364STejun Heo 
1591e22bee78STejun Heo 		if (!need_to_create_worker(gcwq))
1592e22bee78STejun Heo 			break;
1593e22bee78STejun Heo 	}
1594e22bee78STejun Heo 
1595e22bee78STejun Heo 	del_timer_sync(&gcwq->mayday_timer);
1596e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1597e22bee78STejun Heo 	if (need_to_create_worker(gcwq))
1598e22bee78STejun Heo 		goto restart;
1599e22bee78STejun Heo 	return true;
1600e22bee78STejun Heo }
1601e22bee78STejun Heo 
1602e22bee78STejun Heo /**
1603e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
1604e22bee78STejun Heo  * @gcwq: gcwq to destroy workers for
1605e22bee78STejun Heo  *
1606e22bee78STejun Heo  * Destroy @gcwq workers which have been idle for longer than
1607e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1608e22bee78STejun Heo  *
1609e22bee78STejun Heo  * LOCKING:
1610e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1611e22bee78STejun Heo  * multiple times.  Called only from manager.
1612e22bee78STejun Heo  *
1613e22bee78STejun Heo  * RETURNS:
1614e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1615e22bee78STejun Heo  * otherwise.
1616e22bee78STejun Heo  */
1617e22bee78STejun Heo static bool maybe_destroy_workers(struct global_cwq *gcwq)
1618e22bee78STejun Heo {
1619e22bee78STejun Heo 	bool ret = false;
1620e22bee78STejun Heo 
1621e22bee78STejun Heo 	while (too_many_workers(gcwq)) {
1622e22bee78STejun Heo 		struct worker *worker;
1623e22bee78STejun Heo 		unsigned long expires;
1624e22bee78STejun Heo 
1625e22bee78STejun Heo 		worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1626e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1627e22bee78STejun Heo 
1628e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
1629e22bee78STejun Heo 			mod_timer(&gcwq->idle_timer, expires);
1630e22bee78STejun Heo 			break;
1631e22bee78STejun Heo 		}
1632e22bee78STejun Heo 
1633e22bee78STejun Heo 		destroy_worker(worker);
1634e22bee78STejun Heo 		ret = true;
1635e22bee78STejun Heo 	}
1636e22bee78STejun Heo 
1637e22bee78STejun Heo 	return ret;
1638e22bee78STejun Heo }
1639e22bee78STejun Heo 
1640e22bee78STejun Heo /**
1641e22bee78STejun Heo  * manage_workers - manage worker pool
1642e22bee78STejun Heo  * @worker: self
1643e22bee78STejun Heo  *
1644e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
1645e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1646e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
1647e22bee78STejun Heo  *
1648e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
1649e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
1650e22bee78STejun Heo  * and may_start_working() is true.
1651e22bee78STejun Heo  *
1652e22bee78STejun Heo  * CONTEXT:
1653e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1654e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
1655e22bee78STejun Heo  *
1656e22bee78STejun Heo  * RETURNS:
1657e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
1658e22bee78STejun Heo  * some action was taken.
1659e22bee78STejun Heo  */
1660e22bee78STejun Heo static bool manage_workers(struct worker *worker)
1661e22bee78STejun Heo {
1662e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1663e22bee78STejun Heo 	bool ret = false;
1664e22bee78STejun Heo 
1665e22bee78STejun Heo 	if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1666e22bee78STejun Heo 		return ret;
1667e22bee78STejun Heo 
1668e22bee78STejun Heo 	gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1669e22bee78STejun Heo 	gcwq->flags |= GCWQ_MANAGING_WORKERS;
1670e22bee78STejun Heo 
1671e22bee78STejun Heo 	/*
1672e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
1673e22bee78STejun Heo 	 * on return.
1674e22bee78STejun Heo 	 */
1675e22bee78STejun Heo 	ret |= maybe_destroy_workers(gcwq);
1676e22bee78STejun Heo 	ret |= maybe_create_worker(gcwq);
1677e22bee78STejun Heo 
1678e22bee78STejun Heo 	gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1679e22bee78STejun Heo 
1680e22bee78STejun Heo 	/*
1681e22bee78STejun Heo 	 * The trustee might be waiting to take over the manager
1682e22bee78STejun Heo 	 * position, tell it we're done.
1683e22bee78STejun Heo 	 */
1684e22bee78STejun Heo 	if (unlikely(gcwq->trustee))
1685e22bee78STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1686e22bee78STejun Heo 
1687e22bee78STejun Heo 	return ret;
1688e22bee78STejun Heo }
1689e22bee78STejun Heo 
1690a62428c0STejun Heo /**
1691affee4b2STejun Heo  * move_linked_works - move linked works to a list
1692affee4b2STejun Heo  * @work: start of series of works to be scheduled
1693affee4b2STejun Heo  * @head: target list to append @work to
1694affee4b2STejun Heo  * @nextp: out paramter for nested worklist walking
1695affee4b2STejun Heo  *
1696affee4b2STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1697affee4b2STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1698affee4b2STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1699affee4b2STejun Heo  *
1700affee4b2STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1701affee4b2STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1702affee4b2STejun Heo  * nested inside outer list_for_each_entry_safe().
1703affee4b2STejun Heo  *
1704affee4b2STejun Heo  * CONTEXT:
17058b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1706affee4b2STejun Heo  */
1707affee4b2STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1708affee4b2STejun Heo 			      struct work_struct **nextp)
1709affee4b2STejun Heo {
1710affee4b2STejun Heo 	struct work_struct *n;
1711affee4b2STejun Heo 
1712affee4b2STejun Heo 	/*
1713affee4b2STejun Heo 	 * Linked worklist will always end before the end of the list,
1714affee4b2STejun Heo 	 * use NULL for list head.
1715affee4b2STejun Heo 	 */
1716affee4b2STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1717affee4b2STejun Heo 		list_move_tail(&work->entry, head);
1718affee4b2STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1719affee4b2STejun Heo 			break;
1720affee4b2STejun Heo 	}
1721affee4b2STejun Heo 
1722affee4b2STejun Heo 	/*
1723affee4b2STejun Heo 	 * If we're already inside safe list traversal and have moved
1724affee4b2STejun Heo 	 * multiple works to the scheduled queue, the next position
1725affee4b2STejun Heo 	 * needs to be updated.
1726affee4b2STejun Heo 	 */
1727affee4b2STejun Heo 	if (nextp)
1728affee4b2STejun Heo 		*nextp = n;
1729affee4b2STejun Heo }
1730affee4b2STejun Heo 
17311e19ffc6STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
17321e19ffc6STejun Heo {
17331e19ffc6STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
17341da177e4SLinus Torvalds 						    struct work_struct, entry);
1735649027d7STejun Heo 	struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
17361e19ffc6STejun Heo 
1737cdadf009STejun Heo 	trace_workqueue_activate_work(work);
1738649027d7STejun Heo 	move_linked_works(work, pos, NULL);
17398a2e8e5dSTejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
17401e19ffc6STejun Heo 	cwq->nr_active++;
17411e19ffc6STejun Heo }
17421e19ffc6STejun Heo 
1743affee4b2STejun Heo /**
174473f53c4aSTejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
174573f53c4aSTejun Heo  * @cwq: cwq of interest
174673f53c4aSTejun Heo  * @color: color of work which left the queue
17478a2e8e5dSTejun Heo  * @delayed: for a delayed work
174873f53c4aSTejun Heo  *
174973f53c4aSTejun Heo  * A work either has completed or is removed from pending queue,
175073f53c4aSTejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
175173f53c4aSTejun Heo  *
175273f53c4aSTejun Heo  * CONTEXT:
17538b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
175473f53c4aSTejun Heo  */
17558a2e8e5dSTejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
17568a2e8e5dSTejun Heo 				 bool delayed)
175773f53c4aSTejun Heo {
175873f53c4aSTejun Heo 	/* ignore uncolored works */
175973f53c4aSTejun Heo 	if (color == WORK_NO_COLOR)
176073f53c4aSTejun Heo 		return;
176173f53c4aSTejun Heo 
176273f53c4aSTejun Heo 	cwq->nr_in_flight[color]--;
17631e19ffc6STejun Heo 
17648a2e8e5dSTejun Heo 	if (!delayed) {
17658a2e8e5dSTejun Heo 		cwq->nr_active--;
1766502ca9d8STejun Heo 		if (!list_empty(&cwq->delayed_works)) {
17671e19ffc6STejun Heo 			/* one down, submit a delayed one */
1768502ca9d8STejun Heo 			if (cwq->nr_active < cwq->max_active)
17691e19ffc6STejun Heo 				cwq_activate_first_delayed(cwq);
1770502ca9d8STejun Heo 		}
17718a2e8e5dSTejun Heo 	}
177273f53c4aSTejun Heo 
177373f53c4aSTejun Heo 	/* is flush in progress and are we at the flushing tip? */
177473f53c4aSTejun Heo 	if (likely(cwq->flush_color != color))
177573f53c4aSTejun Heo 		return;
177673f53c4aSTejun Heo 
177773f53c4aSTejun Heo 	/* are there still in-flight works? */
177873f53c4aSTejun Heo 	if (cwq->nr_in_flight[color])
177973f53c4aSTejun Heo 		return;
178073f53c4aSTejun Heo 
178173f53c4aSTejun Heo 	/* this cwq is done, clear flush_color */
178273f53c4aSTejun Heo 	cwq->flush_color = -1;
178373f53c4aSTejun Heo 
178473f53c4aSTejun Heo 	/*
178573f53c4aSTejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
178673f53c4aSTejun Heo 	 * will handle the rest.
178773f53c4aSTejun Heo 	 */
178873f53c4aSTejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
178973f53c4aSTejun Heo 		complete(&cwq->wq->first_flusher->done);
179073f53c4aSTejun Heo }
179173f53c4aSTejun Heo 
179273f53c4aSTejun Heo /**
1793a62428c0STejun Heo  * process_one_work - process single work
1794c34056a3STejun Heo  * @worker: self
1795a62428c0STejun Heo  * @work: work to process
1796a62428c0STejun Heo  *
1797a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
1798a62428c0STejun Heo  * process a single work including synchronization against and
1799a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
1800a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
1801a62428c0STejun Heo  * call this function to process a work.
1802a62428c0STejun Heo  *
1803a62428c0STejun Heo  * CONTEXT:
18048b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1805a62428c0STejun Heo  */
1806c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
180706bd6ebfSNamhyung Kim __releases(&gcwq->lock)
180806bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
18091da177e4SLinus Torvalds {
18107e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
18118b03ae3cSTejun Heo 	struct global_cwq *gcwq = cwq->gcwq;
1812c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
1813fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
18146bb49e59SDavid Howells 	work_func_t f = work->func;
181573f53c4aSTejun Heo 	int work_color;
18167e11629dSTejun Heo 	struct worker *collision;
18174e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
18184e6045f1SJohannes Berg 	/*
1819a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
1820a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
1821a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
1822a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
1823a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
18244e6045f1SJohannes Berg 	 */
18254d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
18264d82a1deSPeter Zijlstra 
18274d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
18284e6045f1SJohannes Berg #endif
18297e11629dSTejun Heo 	/*
18307e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
18317e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
18327e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
18337e11629dSTejun Heo 	 * currently executing one.
18347e11629dSTejun Heo 	 */
18357e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
18367e11629dSTejun Heo 	if (unlikely(collision)) {
18377e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
18387e11629dSTejun Heo 		return;
18397e11629dSTejun Heo 	}
18401da177e4SLinus Torvalds 
1841a62428c0STejun Heo 	/* claim and process */
18421da177e4SLinus Torvalds 	debug_work_deactivate(work);
1843c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
1844c34056a3STejun Heo 	worker->current_work = work;
18458cca0eeaSTejun Heo 	worker->current_cwq = cwq;
184673f53c4aSTejun Heo 	work_color = get_work_color(work);
18477a22ad75STejun Heo 
18487a22ad75STejun Heo 	/* record the current cpu number in the work data and dequeue */
18497a22ad75STejun Heo 	set_work_cpu(work, gcwq->cpu);
1850a62428c0STejun Heo 	list_del_init(&work->entry);
1851a62428c0STejun Heo 
1852649027d7STejun Heo 	/*
1853649027d7STejun Heo 	 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1854649027d7STejun Heo 	 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1855649027d7STejun Heo 	 */
1856649027d7STejun Heo 	if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1857649027d7STejun Heo 		struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1858649027d7STejun Heo 						struct work_struct, entry);
1859649027d7STejun Heo 
1860649027d7STejun Heo 		if (!list_empty(&gcwq->worklist) &&
1861649027d7STejun Heo 		    get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1862649027d7STejun Heo 			wake_up_worker(gcwq);
1863649027d7STejun Heo 		else
1864649027d7STejun Heo 			gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1865649027d7STejun Heo 	}
1866649027d7STejun Heo 
1867fb0e7bebSTejun Heo 	/*
1868fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
1869fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
1870fb0e7bebSTejun Heo 	 */
1871fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1872fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1873fb0e7bebSTejun Heo 
1874*974271c4STejun Heo 	/*
1875*974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
1876*974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
1877*974271c4STejun Heo 	 */
1878*974271c4STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(gcwq))
1879*974271c4STejun Heo 		wake_up_worker(gcwq);
1880*974271c4STejun Heo 
18818b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
18821da177e4SLinus Torvalds 
188323b2e599SOleg Nesterov 	work_clear_pending(work);
1884e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
18853295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
1886e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
188765f27f38SDavid Howells 	f(work);
1888e36c886aSArjan van de Ven 	/*
1889e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
1890e36c886aSArjan van de Ven 	 * point will only record its address.
1891e36c886aSArjan van de Ven 	 */
1892e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
18933295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
18943295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
18951da177e4SLinus Torvalds 
1896d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1897d5abe669SPeter Zijlstra 		printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1898d5abe669SPeter Zijlstra 		       "%s/0x%08x/%d\n",
1899a62428c0STejun Heo 		       current->comm, preempt_count(), task_pid_nr(current));
1900d5abe669SPeter Zijlstra 		printk(KERN_ERR "    last function: ");
1901d5abe669SPeter Zijlstra 		print_symbol("%s\n", (unsigned long)f);
1902d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
1903d5abe669SPeter Zijlstra 		dump_stack();
1904d5abe669SPeter Zijlstra 	}
1905d5abe669SPeter Zijlstra 
19068b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1907a62428c0STejun Heo 
1908fb0e7bebSTejun Heo 	/* clear cpu intensive status */
1909fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1910fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1911fb0e7bebSTejun Heo 
1912a62428c0STejun Heo 	/* we're done with it, release */
1913c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
1914c34056a3STejun Heo 	worker->current_work = NULL;
19158cca0eeaSTejun Heo 	worker->current_cwq = NULL;
19168a2e8e5dSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color, false);
19171da177e4SLinus Torvalds }
19181da177e4SLinus Torvalds 
1919affee4b2STejun Heo /**
1920affee4b2STejun Heo  * process_scheduled_works - process scheduled works
1921affee4b2STejun Heo  * @worker: self
1922affee4b2STejun Heo  *
1923affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
1924affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
1925affee4b2STejun Heo  * fetches a work from the top and executes it.
1926affee4b2STejun Heo  *
1927affee4b2STejun Heo  * CONTEXT:
19288b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1929affee4b2STejun Heo  * multiple times.
1930affee4b2STejun Heo  */
1931affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
19321da177e4SLinus Torvalds {
1933affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
1934affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
1935a62428c0STejun Heo 						struct work_struct, entry);
1936c34056a3STejun Heo 		process_one_work(worker, work);
1937a62428c0STejun Heo 	}
19381da177e4SLinus Torvalds }
19391da177e4SLinus Torvalds 
19404690c4abSTejun Heo /**
19414690c4abSTejun Heo  * worker_thread - the worker thread function
1942c34056a3STejun Heo  * @__worker: self
19434690c4abSTejun Heo  *
1944e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
1945e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
1946e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
1947e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
1948e22bee78STejun Heo  * rescuer_thread().
19494690c4abSTejun Heo  */
1950c34056a3STejun Heo static int worker_thread(void *__worker)
19511da177e4SLinus Torvalds {
1952c34056a3STejun Heo 	struct worker *worker = __worker;
19538b03ae3cSTejun Heo 	struct global_cwq *gcwq = worker->gcwq;
19541da177e4SLinus Torvalds 
1955e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
1956e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
1957c8e55f36STejun Heo woke_up:
19588b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1959affee4b2STejun Heo 
1960c8e55f36STejun Heo 	/* DIE can be set only while we're idle, checking here is enough */
1961c8e55f36STejun Heo 	if (worker->flags & WORKER_DIE) {
1962c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
1963e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
1964c8e55f36STejun Heo 		return 0;
1965c8e55f36STejun Heo 	}
1966c8e55f36STejun Heo 
1967c8e55f36STejun Heo 	worker_leave_idle(worker);
1968db7bccf4STejun Heo recheck:
1969e22bee78STejun Heo 	/* no more worker necessary? */
1970e22bee78STejun Heo 	if (!need_more_worker(gcwq))
1971e22bee78STejun Heo 		goto sleep;
1972e22bee78STejun Heo 
1973e22bee78STejun Heo 	/* do we need to manage? */
1974e22bee78STejun Heo 	if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1975e22bee78STejun Heo 		goto recheck;
1976e22bee78STejun Heo 
1977c8e55f36STejun Heo 	/*
1978c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
1979c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
1980c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
1981c8e55f36STejun Heo 	 */
1982c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1983c8e55f36STejun Heo 
1984e22bee78STejun Heo 	/*
1985e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
1986e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
1987e22bee78STejun Heo 	 * assumed the manager role.
1988e22bee78STejun Heo 	 */
1989e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
1990e22bee78STejun Heo 
1991e22bee78STejun Heo 	do {
1992affee4b2STejun Heo 		struct work_struct *work =
19937e11629dSTejun Heo 			list_first_entry(&gcwq->worklist,
1994affee4b2STejun Heo 					 struct work_struct, entry);
1995affee4b2STejun Heo 
1996c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1997affee4b2STejun Heo 			/* optimization path, not strictly necessary */
1998affee4b2STejun Heo 			process_one_work(worker, work);
1999affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2000affee4b2STejun Heo 				process_scheduled_works(worker);
2001affee4b2STejun Heo 		} else {
2002c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2003affee4b2STejun Heo 			process_scheduled_works(worker);
2004affee4b2STejun Heo 		}
2005e22bee78STejun Heo 	} while (keep_working(gcwq));
2006affee4b2STejun Heo 
2007e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2008d313dd85STejun Heo sleep:
2009e22bee78STejun Heo 	if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
2010e22bee78STejun Heo 		goto recheck;
2011d313dd85STejun Heo 
2012c8e55f36STejun Heo 	/*
2013e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2014e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2015e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2016e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2017e22bee78STejun Heo 	 * prevent losing any event.
2018c8e55f36STejun Heo 	 */
2019c8e55f36STejun Heo 	worker_enter_idle(worker);
2020c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
20218b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
20221da177e4SLinus Torvalds 	schedule();
2023c8e55f36STejun Heo 	goto woke_up;
20241da177e4SLinus Torvalds }
20251da177e4SLinus Torvalds 
2026e22bee78STejun Heo /**
2027e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2028e22bee78STejun Heo  * @__wq: the associated workqueue
2029e22bee78STejun Heo  *
2030e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2031e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2032e22bee78STejun Heo  *
2033e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2034e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2035e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2036e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2037e22bee78STejun Heo  * the problem rescuer solves.
2038e22bee78STejun Heo  *
2039e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2040e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2041e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2042e22bee78STejun Heo  *
2043e22bee78STejun Heo  * This should happen rarely.
2044e22bee78STejun Heo  */
2045e22bee78STejun Heo static int rescuer_thread(void *__wq)
2046e22bee78STejun Heo {
2047e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2048e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2049e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2050f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2051e22bee78STejun Heo 	unsigned int cpu;
2052e22bee78STejun Heo 
2053e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2054e22bee78STejun Heo repeat:
2055e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
20561da177e4SLinus Torvalds 
20571da177e4SLinus Torvalds 	if (kthread_should_stop())
2058e22bee78STejun Heo 		return 0;
20591da177e4SLinus Torvalds 
2060f3421797STejun Heo 	/*
2061f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2062f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2063f3421797STejun Heo 	 */
2064f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2065f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2066f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2067e22bee78STejun Heo 		struct global_cwq *gcwq = cwq->gcwq;
2068e22bee78STejun Heo 		struct work_struct *work, *n;
2069e22bee78STejun Heo 
2070e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2071f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2072e22bee78STejun Heo 
2073e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2074e22bee78STejun Heo 		rescuer->gcwq = gcwq;
2075e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2076e22bee78STejun Heo 
2077e22bee78STejun Heo 		/*
2078e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2079e22bee78STejun Heo 		 * process'em.
2080e22bee78STejun Heo 		 */
2081e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2082e22bee78STejun Heo 		list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
2083e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2084e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2085e22bee78STejun Heo 
2086e22bee78STejun Heo 		process_scheduled_works(rescuer);
20877576958aSTejun Heo 
20887576958aSTejun Heo 		/*
20897576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
20907576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
20917576958aSTejun Heo 		 * and stalling the execution.
20927576958aSTejun Heo 		 */
20937576958aSTejun Heo 		if (keep_working(gcwq))
20947576958aSTejun Heo 			wake_up_worker(gcwq);
20957576958aSTejun Heo 
2096e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
20971da177e4SLinus Torvalds 	}
20981da177e4SLinus Torvalds 
2099e22bee78STejun Heo 	schedule();
2100e22bee78STejun Heo 	goto repeat;
21011da177e4SLinus Torvalds }
21021da177e4SLinus Torvalds 
2103fc2e4d70SOleg Nesterov struct wq_barrier {
2104fc2e4d70SOleg Nesterov 	struct work_struct	work;
2105fc2e4d70SOleg Nesterov 	struct completion	done;
2106fc2e4d70SOleg Nesterov };
2107fc2e4d70SOleg Nesterov 
2108fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2109fc2e4d70SOleg Nesterov {
2110fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2111fc2e4d70SOleg Nesterov 	complete(&barr->done);
2112fc2e4d70SOleg Nesterov }
2113fc2e4d70SOleg Nesterov 
21144690c4abSTejun Heo /**
21154690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
21164690c4abSTejun Heo  * @cwq: cwq to insert barrier into
21174690c4abSTejun Heo  * @barr: wq_barrier to insert
2118affee4b2STejun Heo  * @target: target work to attach @barr to
2119affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
21204690c4abSTejun Heo  *
2121affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2122affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2123affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2124affee4b2STejun Heo  * cpu.
2125affee4b2STejun Heo  *
2126affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2127affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2128affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2129affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2130affee4b2STejun Heo  * after a work with LINKED flag set.
2131affee4b2STejun Heo  *
2132affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2133affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
21344690c4abSTejun Heo  *
21354690c4abSTejun Heo  * CONTEXT:
21368b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
21374690c4abSTejun Heo  */
213883c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2139affee4b2STejun Heo 			      struct wq_barrier *barr,
2140affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2141fc2e4d70SOleg Nesterov {
2142affee4b2STejun Heo 	struct list_head *head;
2143affee4b2STejun Heo 	unsigned int linked = 0;
2144affee4b2STejun Heo 
2145dc186ad7SThomas Gleixner 	/*
21468b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2147dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2148dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2149dc186ad7SThomas Gleixner 	 * might deadlock.
2150dc186ad7SThomas Gleixner 	 */
2151ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
215222df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2153fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
215483c22520SOleg Nesterov 
2155affee4b2STejun Heo 	/*
2156affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2157affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2158affee4b2STejun Heo 	 */
2159affee4b2STejun Heo 	if (worker)
2160affee4b2STejun Heo 		head = worker->scheduled.next;
2161affee4b2STejun Heo 	else {
2162affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2163affee4b2STejun Heo 
2164affee4b2STejun Heo 		head = target->entry.next;
2165affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2166affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2167affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2168affee4b2STejun Heo 	}
2169affee4b2STejun Heo 
2170dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2171affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2172affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2173fc2e4d70SOleg Nesterov }
2174fc2e4d70SOleg Nesterov 
217573f53c4aSTejun Heo /**
217673f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
217773f53c4aSTejun Heo  * @wq: workqueue being flushed
217873f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
217973f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
218073f53c4aSTejun Heo  *
218173f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
218273f53c4aSTejun Heo  *
218373f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
218473f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
218573f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
218673f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
218773f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
218873f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
218973f53c4aSTejun Heo  *
219073f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
219173f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
219273f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
219373f53c4aSTejun Heo  * is returned.
219473f53c4aSTejun Heo  *
219573f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
219673f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
219773f53c4aSTejun Heo  * advanced to @work_color.
219873f53c4aSTejun Heo  *
219973f53c4aSTejun Heo  * CONTEXT:
220073f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
220173f53c4aSTejun Heo  *
220273f53c4aSTejun Heo  * RETURNS:
220373f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
220473f53c4aSTejun Heo  * otherwise.
220573f53c4aSTejun Heo  */
220673f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
220773f53c4aSTejun Heo 				      int flush_color, int work_color)
22081da177e4SLinus Torvalds {
220973f53c4aSTejun Heo 	bool wait = false;
221073f53c4aSTejun Heo 	unsigned int cpu;
22111da177e4SLinus Torvalds 
221273f53c4aSTejun Heo 	if (flush_color >= 0) {
221373f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
221473f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2215dc186ad7SThomas Gleixner 	}
221614441960SOleg Nesterov 
2217f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
221873f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
22198b03ae3cSTejun Heo 		struct global_cwq *gcwq = cwq->gcwq;
22201da177e4SLinus Torvalds 
22218b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
222273f53c4aSTejun Heo 
222373f53c4aSTejun Heo 		if (flush_color >= 0) {
222473f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
222573f53c4aSTejun Heo 
222673f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
222773f53c4aSTejun Heo 				cwq->flush_color = flush_color;
222873f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
222973f53c4aSTejun Heo 				wait = true;
22301da177e4SLinus Torvalds 			}
223173f53c4aSTejun Heo 		}
223273f53c4aSTejun Heo 
223373f53c4aSTejun Heo 		if (work_color >= 0) {
223473f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
223573f53c4aSTejun Heo 			cwq->work_color = work_color;
223673f53c4aSTejun Heo 		}
223773f53c4aSTejun Heo 
22388b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
22391da177e4SLinus Torvalds 	}
22401da177e4SLinus Torvalds 
224173f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
224273f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
224373f53c4aSTejun Heo 
224473f53c4aSTejun Heo 	return wait;
224583c22520SOleg Nesterov }
22461da177e4SLinus Torvalds 
22470fcb78c2SRolf Eike Beer /**
22481da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
22490fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
22501da177e4SLinus Torvalds  *
22511da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
22521da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
22531da177e4SLinus Torvalds  *
2254fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2255fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
22561da177e4SLinus Torvalds  */
22577ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
22581da177e4SLinus Torvalds {
225973f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
226073f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
226173f53c4aSTejun Heo 		.flush_color = -1,
226273f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
226373f53c4aSTejun Heo 	};
226473f53c4aSTejun Heo 	int next_color;
2265b1f4ec17SOleg Nesterov 
22663295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
22673295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
226873f53c4aSTejun Heo 
226973f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
227073f53c4aSTejun Heo 
227173f53c4aSTejun Heo 	/*
227273f53c4aSTejun Heo 	 * Start-to-wait phase
227373f53c4aSTejun Heo 	 */
227473f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
227573f53c4aSTejun Heo 
227673f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
227773f53c4aSTejun Heo 		/*
227873f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
227973f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
228073f53c4aSTejun Heo 		 * by one.
228173f53c4aSTejun Heo 		 */
228273f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
228373f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
228473f53c4aSTejun Heo 		wq->work_color = next_color;
228573f53c4aSTejun Heo 
228673f53c4aSTejun Heo 		if (!wq->first_flusher) {
228773f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
228873f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
228973f53c4aSTejun Heo 
229073f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
229173f53c4aSTejun Heo 
229273f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
229373f53c4aSTejun Heo 						       wq->work_color)) {
229473f53c4aSTejun Heo 				/* nothing to flush, done */
229573f53c4aSTejun Heo 				wq->flush_color = next_color;
229673f53c4aSTejun Heo 				wq->first_flusher = NULL;
229773f53c4aSTejun Heo 				goto out_unlock;
229873f53c4aSTejun Heo 			}
229973f53c4aSTejun Heo 		} else {
230073f53c4aSTejun Heo 			/* wait in queue */
230173f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
230273f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
230373f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
230473f53c4aSTejun Heo 		}
230573f53c4aSTejun Heo 	} else {
230673f53c4aSTejun Heo 		/*
230773f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
230873f53c4aSTejun Heo 		 * The next flush completion will assign us
230973f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
231073f53c4aSTejun Heo 		 */
231173f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
231273f53c4aSTejun Heo 	}
231373f53c4aSTejun Heo 
231473f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
231573f53c4aSTejun Heo 
231673f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
231773f53c4aSTejun Heo 
231873f53c4aSTejun Heo 	/*
231973f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
232073f53c4aSTejun Heo 	 *
232173f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
232273f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
232373f53c4aSTejun Heo 	 */
232473f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
232573f53c4aSTejun Heo 		return;
232673f53c4aSTejun Heo 
232773f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
232873f53c4aSTejun Heo 
23294ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
23304ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
23314ce48b37STejun Heo 		goto out_unlock;
23324ce48b37STejun Heo 
233373f53c4aSTejun Heo 	wq->first_flusher = NULL;
233473f53c4aSTejun Heo 
233573f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
233673f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
233773f53c4aSTejun Heo 
233873f53c4aSTejun Heo 	while (true) {
233973f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
234073f53c4aSTejun Heo 
234173f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
234273f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
234373f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
234473f53c4aSTejun Heo 				break;
234573f53c4aSTejun Heo 			list_del_init(&next->list);
234673f53c4aSTejun Heo 			complete(&next->done);
234773f53c4aSTejun Heo 		}
234873f53c4aSTejun Heo 
234973f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
235073f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
235173f53c4aSTejun Heo 
235273f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
235373f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
235473f53c4aSTejun Heo 
235573f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
235673f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
235773f53c4aSTejun Heo 			/*
235873f53c4aSTejun Heo 			 * Assign the same color to all overflowed
235973f53c4aSTejun Heo 			 * flushers, advance work_color and append to
236073f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
236173f53c4aSTejun Heo 			 * phase for these overflowed flushers.
236273f53c4aSTejun Heo 			 */
236373f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
236473f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
236573f53c4aSTejun Heo 
236673f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
236773f53c4aSTejun Heo 
236873f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
236973f53c4aSTejun Heo 					      &wq->flusher_queue);
237073f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
237173f53c4aSTejun Heo 		}
237273f53c4aSTejun Heo 
237373f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
237473f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
237573f53c4aSTejun Heo 			break;
237673f53c4aSTejun Heo 		}
237773f53c4aSTejun Heo 
237873f53c4aSTejun Heo 		/*
237973f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
238073f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
238173f53c4aSTejun Heo 		 */
238273f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
238373f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
238473f53c4aSTejun Heo 
238573f53c4aSTejun Heo 		list_del_init(&next->list);
238673f53c4aSTejun Heo 		wq->first_flusher = next;
238773f53c4aSTejun Heo 
238873f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
238973f53c4aSTejun Heo 			break;
239073f53c4aSTejun Heo 
239173f53c4aSTejun Heo 		/*
239273f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
239373f53c4aSTejun Heo 		 * flusher and repeat cascading.
239473f53c4aSTejun Heo 		 */
239573f53c4aSTejun Heo 		wq->first_flusher = NULL;
239673f53c4aSTejun Heo 	}
239773f53c4aSTejun Heo 
239873f53c4aSTejun Heo out_unlock:
239973f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
24001da177e4SLinus Torvalds }
2401ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
24021da177e4SLinus Torvalds 
24039c5a2ba7STejun Heo /**
24049c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
24059c5a2ba7STejun Heo  * @wq: workqueue to drain
24069c5a2ba7STejun Heo  *
24079c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
24089c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
24099c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
24109c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
24119c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
24129c5a2ba7STejun Heo  * takes too long.
24139c5a2ba7STejun Heo  */
24149c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
24159c5a2ba7STejun Heo {
24169c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
24179c5a2ba7STejun Heo 	unsigned int cpu;
24189c5a2ba7STejun Heo 
24199c5a2ba7STejun Heo 	/*
24209c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
24219c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
24229c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
24239c5a2ba7STejun Heo 	 */
24249c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24259c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
24269c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
24279c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24289c5a2ba7STejun Heo reflush:
24299c5a2ba7STejun Heo 	flush_workqueue(wq);
24309c5a2ba7STejun Heo 
24319c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
24329c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2433fa2563e4SThomas Tuttle 		bool drained;
24349c5a2ba7STejun Heo 
2435fa2563e4SThomas Tuttle 		spin_lock_irq(&cwq->gcwq->lock);
2436fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2437fa2563e4SThomas Tuttle 		spin_unlock_irq(&cwq->gcwq->lock);
2438fa2563e4SThomas Tuttle 
2439fa2563e4SThomas Tuttle 		if (drained)
24409c5a2ba7STejun Heo 			continue;
24419c5a2ba7STejun Heo 
24429c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
24439c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
24449c5a2ba7STejun Heo 			pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
24459c5a2ba7STejun Heo 				   wq->name, flush_cnt);
24469c5a2ba7STejun Heo 		goto reflush;
24479c5a2ba7STejun Heo 	}
24489c5a2ba7STejun Heo 
24499c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
24509c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
24519c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
24529c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
24539c5a2ba7STejun Heo }
24549c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
24559c5a2ba7STejun Heo 
2456baf59022STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2457baf59022STejun Heo 			     bool wait_executing)
2458baf59022STejun Heo {
2459baf59022STejun Heo 	struct worker *worker = NULL;
2460baf59022STejun Heo 	struct global_cwq *gcwq;
2461baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2462baf59022STejun Heo 
2463baf59022STejun Heo 	might_sleep();
2464baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2465baf59022STejun Heo 	if (!gcwq)
2466baf59022STejun Heo 		return false;
2467baf59022STejun Heo 
2468baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2469baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2470baf59022STejun Heo 		/*
2471baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2472baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2473baf59022STejun Heo 		 * are not going to wait.
2474baf59022STejun Heo 		 */
2475baf59022STejun Heo 		smp_rmb();
2476baf59022STejun Heo 		cwq = get_work_cwq(work);
2477baf59022STejun Heo 		if (unlikely(!cwq || gcwq != cwq->gcwq))
2478baf59022STejun Heo 			goto already_gone;
2479baf59022STejun Heo 	} else if (wait_executing) {
2480baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2481baf59022STejun Heo 		if (!worker)
2482baf59022STejun Heo 			goto already_gone;
2483baf59022STejun Heo 		cwq = worker->current_cwq;
2484baf59022STejun Heo 	} else
2485baf59022STejun Heo 		goto already_gone;
2486baf59022STejun Heo 
2487baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2488baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2489baf59022STejun Heo 
2490e159489bSTejun Heo 	/*
2491e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2492e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2493e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2494e159489bSTejun Heo 	 * access.
2495e159489bSTejun Heo 	 */
2496e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2497baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2498e159489bSTejun Heo 	else
2499e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2500baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2501e159489bSTejun Heo 
2502baf59022STejun Heo 	return true;
2503baf59022STejun Heo already_gone:
2504baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2505baf59022STejun Heo 	return false;
2506baf59022STejun Heo }
2507baf59022STejun Heo 
2508db700897SOleg Nesterov /**
2509401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2510401a8d04STejun Heo  * @work: the work to flush
2511db700897SOleg Nesterov  *
2512401a8d04STejun Heo  * Wait until @work has finished execution.  This function considers
2513401a8d04STejun Heo  * only the last queueing instance of @work.  If @work has been
2514401a8d04STejun Heo  * enqueued across different CPUs on a non-reentrant workqueue or on
2515401a8d04STejun Heo  * multiple workqueues, @work might still be executing on return on
2516401a8d04STejun Heo  * some of the CPUs from earlier queueing.
2517a67da70dSOleg Nesterov  *
2518401a8d04STejun Heo  * If @work was queued only on a non-reentrant, ordered or unbound
2519401a8d04STejun Heo  * workqueue, @work is guaranteed to be idle on return if it hasn't
2520401a8d04STejun Heo  * been requeued since flush started.
2521401a8d04STejun Heo  *
2522401a8d04STejun Heo  * RETURNS:
2523401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2524401a8d04STejun Heo  * %false if it was already idle.
2525db700897SOleg Nesterov  */
2526401a8d04STejun Heo bool flush_work(struct work_struct *work)
2527db700897SOleg Nesterov {
2528db700897SOleg Nesterov 	struct wq_barrier barr;
2529db700897SOleg Nesterov 
25300976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
25310976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
25320976dfc1SStephen Boyd 
2533baf59022STejun Heo 	if (start_flush_work(work, &barr, true)) {
2534db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2535dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2536401a8d04STejun Heo 		return true;
2537baf59022STejun Heo 	} else
2538401a8d04STejun Heo 		return false;
2539db700897SOleg Nesterov }
2540db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2541db700897SOleg Nesterov 
2542401a8d04STejun Heo static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2543401a8d04STejun Heo {
2544401a8d04STejun Heo 	struct wq_barrier barr;
2545401a8d04STejun Heo 	struct worker *worker;
2546401a8d04STejun Heo 
2547401a8d04STejun Heo 	spin_lock_irq(&gcwq->lock);
2548401a8d04STejun Heo 
2549401a8d04STejun Heo 	worker = find_worker_executing_work(gcwq, work);
2550401a8d04STejun Heo 	if (unlikely(worker))
2551401a8d04STejun Heo 		insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2552401a8d04STejun Heo 
2553401a8d04STejun Heo 	spin_unlock_irq(&gcwq->lock);
2554401a8d04STejun Heo 
2555401a8d04STejun Heo 	if (unlikely(worker)) {
2556401a8d04STejun Heo 		wait_for_completion(&barr.done);
2557401a8d04STejun Heo 		destroy_work_on_stack(&barr.work);
2558401a8d04STejun Heo 		return true;
2559401a8d04STejun Heo 	} else
2560401a8d04STejun Heo 		return false;
2561401a8d04STejun Heo }
2562401a8d04STejun Heo 
2563401a8d04STejun Heo static bool wait_on_work(struct work_struct *work)
2564401a8d04STejun Heo {
2565401a8d04STejun Heo 	bool ret = false;
2566401a8d04STejun Heo 	int cpu;
2567401a8d04STejun Heo 
2568401a8d04STejun Heo 	might_sleep();
2569401a8d04STejun Heo 
2570401a8d04STejun Heo 	lock_map_acquire(&work->lockdep_map);
2571401a8d04STejun Heo 	lock_map_release(&work->lockdep_map);
2572401a8d04STejun Heo 
2573401a8d04STejun Heo 	for_each_gcwq_cpu(cpu)
2574401a8d04STejun Heo 		ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2575401a8d04STejun Heo 	return ret;
2576401a8d04STejun Heo }
2577401a8d04STejun Heo 
257809383498STejun Heo /**
257909383498STejun Heo  * flush_work_sync - wait until a work has finished execution
258009383498STejun Heo  * @work: the work to flush
258109383498STejun Heo  *
258209383498STejun Heo  * Wait until @work has finished execution.  On return, it's
258309383498STejun Heo  * guaranteed that all queueing instances of @work which happened
258409383498STejun Heo  * before this function is called are finished.  In other words, if
258509383498STejun Heo  * @work hasn't been requeued since this function was called, @work is
258609383498STejun Heo  * guaranteed to be idle on return.
258709383498STejun Heo  *
258809383498STejun Heo  * RETURNS:
258909383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
259009383498STejun Heo  * %false if it was already idle.
259109383498STejun Heo  */
259209383498STejun Heo bool flush_work_sync(struct work_struct *work)
259309383498STejun Heo {
259409383498STejun Heo 	struct wq_barrier barr;
259509383498STejun Heo 	bool pending, waited;
259609383498STejun Heo 
259709383498STejun Heo 	/* we'll wait for executions separately, queue barr only if pending */
259809383498STejun Heo 	pending = start_flush_work(work, &barr, false);
259909383498STejun Heo 
260009383498STejun Heo 	/* wait for executions to finish */
260109383498STejun Heo 	waited = wait_on_work(work);
260209383498STejun Heo 
260309383498STejun Heo 	/* wait for the pending one */
260409383498STejun Heo 	if (pending) {
260509383498STejun Heo 		wait_for_completion(&barr.done);
260609383498STejun Heo 		destroy_work_on_stack(&barr.work);
260709383498STejun Heo 	}
260809383498STejun Heo 
260909383498STejun Heo 	return pending || waited;
261009383498STejun Heo }
261109383498STejun Heo EXPORT_SYMBOL_GPL(flush_work_sync);
261209383498STejun Heo 
26136e84d644SOleg Nesterov /*
26141f1f642eSOleg Nesterov  * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
26156e84d644SOleg Nesterov  * so this work can't be re-armed in any way.
26166e84d644SOleg Nesterov  */
26176e84d644SOleg Nesterov static int try_to_grab_pending(struct work_struct *work)
26186e84d644SOleg Nesterov {
26198b03ae3cSTejun Heo 	struct global_cwq *gcwq;
26201f1f642eSOleg Nesterov 	int ret = -1;
26216e84d644SOleg Nesterov 
262222df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
26231f1f642eSOleg Nesterov 		return 0;
26246e84d644SOleg Nesterov 
26256e84d644SOleg Nesterov 	/*
26266e84d644SOleg Nesterov 	 * The queueing is in progress, or it is already queued. Try to
26276e84d644SOleg Nesterov 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
26286e84d644SOleg Nesterov 	 */
26297a22ad75STejun Heo 	gcwq = get_work_gcwq(work);
26307a22ad75STejun Heo 	if (!gcwq)
26316e84d644SOleg Nesterov 		return ret;
26326e84d644SOleg Nesterov 
26338b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
26346e84d644SOleg Nesterov 	if (!list_empty(&work->entry)) {
26356e84d644SOleg Nesterov 		/*
26367a22ad75STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
26376e84d644SOleg Nesterov 		 * In that case we must see the new value after rmb(), see
26386e84d644SOleg Nesterov 		 * insert_work()->wmb().
26396e84d644SOleg Nesterov 		 */
26406e84d644SOleg Nesterov 		smp_rmb();
26417a22ad75STejun Heo 		if (gcwq == get_work_gcwq(work)) {
2642dc186ad7SThomas Gleixner 			debug_work_deactivate(work);
26436e84d644SOleg Nesterov 			list_del_init(&work->entry);
26447a22ad75STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
26458a2e8e5dSTejun Heo 				get_work_color(work),
26468a2e8e5dSTejun Heo 				*work_data_bits(work) & WORK_STRUCT_DELAYED);
26476e84d644SOleg Nesterov 			ret = 1;
26486e84d644SOleg Nesterov 		}
26496e84d644SOleg Nesterov 	}
26508b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
26516e84d644SOleg Nesterov 
26526e84d644SOleg Nesterov 	return ret;
26536e84d644SOleg Nesterov }
26546e84d644SOleg Nesterov 
2655401a8d04STejun Heo static bool __cancel_work_timer(struct work_struct *work,
26561f1f642eSOleg Nesterov 				struct timer_list* timer)
26571f1f642eSOleg Nesterov {
26581f1f642eSOleg Nesterov 	int ret;
26591f1f642eSOleg Nesterov 
26601f1f642eSOleg Nesterov 	do {
26611f1f642eSOleg Nesterov 		ret = (timer && likely(del_timer(timer)));
26621f1f642eSOleg Nesterov 		if (!ret)
26631f1f642eSOleg Nesterov 			ret = try_to_grab_pending(work);
26641f1f642eSOleg Nesterov 		wait_on_work(work);
26651f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
26661f1f642eSOleg Nesterov 
26677a22ad75STejun Heo 	clear_work_data(work);
26681f1f642eSOleg Nesterov 	return ret;
26691f1f642eSOleg Nesterov }
26701f1f642eSOleg Nesterov 
26716e84d644SOleg Nesterov /**
2672401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2673401a8d04STejun Heo  * @work: the work to cancel
26746e84d644SOleg Nesterov  *
2675401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2676401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2677401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2678401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
26791f1f642eSOleg Nesterov  *
2680401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2681401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
26826e84d644SOleg Nesterov  *
2683401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
26846e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2685401a8d04STejun Heo  *
2686401a8d04STejun Heo  * RETURNS:
2687401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
26886e84d644SOleg Nesterov  */
2689401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
26906e84d644SOleg Nesterov {
26911f1f642eSOleg Nesterov 	return __cancel_work_timer(work, NULL);
2692b89deed3SOleg Nesterov }
269328e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2694b89deed3SOleg Nesterov 
26956e84d644SOleg Nesterov /**
2696401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2697401a8d04STejun Heo  * @dwork: the delayed work to flush
26986e84d644SOleg Nesterov  *
2699401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2700401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2701401a8d04STejun Heo  * considers the last queueing instance of @dwork.
27021f1f642eSOleg Nesterov  *
2703401a8d04STejun Heo  * RETURNS:
2704401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2705401a8d04STejun Heo  * %false if it was already idle.
27066e84d644SOleg Nesterov  */
2707401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2708401a8d04STejun Heo {
2709401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
2710401a8d04STejun Heo 		__queue_work(raw_smp_processor_id(),
2711401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
2712401a8d04STejun Heo 	return flush_work(&dwork->work);
2713401a8d04STejun Heo }
2714401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2715401a8d04STejun Heo 
2716401a8d04STejun Heo /**
271709383498STejun Heo  * flush_delayed_work_sync - wait for a dwork to finish
271809383498STejun Heo  * @dwork: the delayed work to flush
271909383498STejun Heo  *
272009383498STejun Heo  * Delayed timer is cancelled and the pending work is queued for
272109383498STejun Heo  * execution immediately.  Other than timer handling, its behavior
272209383498STejun Heo  * is identical to flush_work_sync().
272309383498STejun Heo  *
272409383498STejun Heo  * RETURNS:
272509383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
272609383498STejun Heo  * %false if it was already idle.
272709383498STejun Heo  */
272809383498STejun Heo bool flush_delayed_work_sync(struct delayed_work *dwork)
272909383498STejun Heo {
273009383498STejun Heo 	if (del_timer_sync(&dwork->timer))
273109383498STejun Heo 		__queue_work(raw_smp_processor_id(),
273209383498STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
273309383498STejun Heo 	return flush_work_sync(&dwork->work);
273409383498STejun Heo }
273509383498STejun Heo EXPORT_SYMBOL(flush_delayed_work_sync);
273609383498STejun Heo 
273709383498STejun Heo /**
2738401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2739401a8d04STejun Heo  * @dwork: the delayed work cancel
2740401a8d04STejun Heo  *
2741401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2742401a8d04STejun Heo  *
2743401a8d04STejun Heo  * RETURNS:
2744401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2745401a8d04STejun Heo  */
2746401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
27476e84d644SOleg Nesterov {
27481f1f642eSOleg Nesterov 	return __cancel_work_timer(&dwork->work, &dwork->timer);
27496e84d644SOleg Nesterov }
2750f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
27511da177e4SLinus Torvalds 
27520fcb78c2SRolf Eike Beer /**
27530fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
27540fcb78c2SRolf Eike Beer  * @work: job to be done
27550fcb78c2SRolf Eike Beer  *
27565b0f437dSBart Van Assche  * Returns zero if @work was already on the kernel-global workqueue and
27575b0f437dSBart Van Assche  * non-zero otherwise.
27585b0f437dSBart Van Assche  *
27595b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
27605b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
27615b0f437dSBart Van Assche  * workqueue otherwise.
27620fcb78c2SRolf Eike Beer  */
27637ad5b3a5SHarvey Harrison int schedule_work(struct work_struct *work)
27641da177e4SLinus Torvalds {
2765d320c038STejun Heo 	return queue_work(system_wq, work);
27661da177e4SLinus Torvalds }
2767ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
27681da177e4SLinus Torvalds 
2769c1a220e7SZhang Rui /*
2770c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2771c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2772c1a220e7SZhang Rui  * @work: job to be done
2773c1a220e7SZhang Rui  *
2774c1a220e7SZhang Rui  * This puts a job on a specific cpu
2775c1a220e7SZhang Rui  */
2776c1a220e7SZhang Rui int schedule_work_on(int cpu, struct work_struct *work)
2777c1a220e7SZhang Rui {
2778d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2779c1a220e7SZhang Rui }
2780c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2781c1a220e7SZhang Rui 
27820fcb78c2SRolf Eike Beer /**
27830fcb78c2SRolf Eike Beer  * schedule_delayed_work - put work task in global workqueue after delay
278452bad64dSDavid Howells  * @dwork: job to be done
278552bad64dSDavid Howells  * @delay: number of jiffies to wait or 0 for immediate execution
27860fcb78c2SRolf Eike Beer  *
27870fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
27880fcb78c2SRolf Eike Beer  * workqueue.
27890fcb78c2SRolf Eike Beer  */
27907ad5b3a5SHarvey Harrison int schedule_delayed_work(struct delayed_work *dwork,
279182f67cd9SIngo Molnar 					unsigned long delay)
27921da177e4SLinus Torvalds {
2793d320c038STejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
27941da177e4SLinus Torvalds }
2795ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work);
27961da177e4SLinus Torvalds 
27970fcb78c2SRolf Eike Beer /**
27980fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
27990fcb78c2SRolf Eike Beer  * @cpu: cpu to use
280052bad64dSDavid Howells  * @dwork: job to be done
28010fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
28020fcb78c2SRolf Eike Beer  *
28030fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
28040fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
28050fcb78c2SRolf Eike Beer  */
28061da177e4SLinus Torvalds int schedule_delayed_work_on(int cpu,
280752bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
28081da177e4SLinus Torvalds {
2809d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
28101da177e4SLinus Torvalds }
2811ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
28121da177e4SLinus Torvalds 
2813b6136773SAndrew Morton /**
281431ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
2815b6136773SAndrew Morton  * @func: the function to call
2816b6136773SAndrew Morton  *
281731ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
281831ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
2819b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
282031ddd871STejun Heo  *
282131ddd871STejun Heo  * RETURNS:
282231ddd871STejun Heo  * 0 on success, -errno on failure.
2823b6136773SAndrew Morton  */
282465f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
282515316ba8SChristoph Lameter {
282615316ba8SChristoph Lameter 	int cpu;
282738f51568SNamhyung Kim 	struct work_struct __percpu *works;
282815316ba8SChristoph Lameter 
2829b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
2830b6136773SAndrew Morton 	if (!works)
283115316ba8SChristoph Lameter 		return -ENOMEM;
2832b6136773SAndrew Morton 
283395402b38SGautham R Shenoy 	get_online_cpus();
283493981800STejun Heo 
283515316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
28369bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
28379bfb1839SIngo Molnar 
28389bfb1839SIngo Molnar 		INIT_WORK(work, func);
28398de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
284015316ba8SChristoph Lameter 	}
284193981800STejun Heo 
284293981800STejun Heo 	for_each_online_cpu(cpu)
28438616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
284493981800STejun Heo 
284595402b38SGautham R Shenoy 	put_online_cpus();
2846b6136773SAndrew Morton 	free_percpu(works);
284715316ba8SChristoph Lameter 	return 0;
284815316ba8SChristoph Lameter }
284915316ba8SChristoph Lameter 
2850eef6a7d5SAlan Stern /**
2851eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
2852eef6a7d5SAlan Stern  *
2853eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
2854eef6a7d5SAlan Stern  * completion.
2855eef6a7d5SAlan Stern  *
2856eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
2857eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
2858eef6a7d5SAlan Stern  * will lead to deadlock:
2859eef6a7d5SAlan Stern  *
2860eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
2861eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
2862eef6a7d5SAlan Stern  *
2863eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
2864eef6a7d5SAlan Stern  *
2865eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
2866eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
2867eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
2868eef6a7d5SAlan Stern  *
2869eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
2870eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
2871eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
2872eef6a7d5SAlan Stern  * cancel_work_sync() instead.
2873eef6a7d5SAlan Stern  */
28741da177e4SLinus Torvalds void flush_scheduled_work(void)
28751da177e4SLinus Torvalds {
2876d320c038STejun Heo 	flush_workqueue(system_wq);
28771da177e4SLinus Torvalds }
2878ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
28791da177e4SLinus Torvalds 
28801da177e4SLinus Torvalds /**
28811fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
28821fa44ecaSJames Bottomley  * @fn:		the function to execute
28831fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
28841fa44ecaSJames Bottomley  *		be available when the work executes)
28851fa44ecaSJames Bottomley  *
28861fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
28871fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
28881fa44ecaSJames Bottomley  *
28891fa44ecaSJames Bottomley  * Returns:	0 - function was executed
28901fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
28911fa44ecaSJames Bottomley  */
289265f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
28931fa44ecaSJames Bottomley {
28941fa44ecaSJames Bottomley 	if (!in_interrupt()) {
289565f27f38SDavid Howells 		fn(&ew->work);
28961fa44ecaSJames Bottomley 		return 0;
28971fa44ecaSJames Bottomley 	}
28981fa44ecaSJames Bottomley 
289965f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
29001fa44ecaSJames Bottomley 	schedule_work(&ew->work);
29011fa44ecaSJames Bottomley 
29021fa44ecaSJames Bottomley 	return 1;
29031fa44ecaSJames Bottomley }
29041fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
29051fa44ecaSJames Bottomley 
29061da177e4SLinus Torvalds int keventd_up(void)
29071da177e4SLinus Torvalds {
2908d320c038STejun Heo 	return system_wq != NULL;
29091da177e4SLinus Torvalds }
29101da177e4SLinus Torvalds 
2911bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
29121da177e4SLinus Torvalds {
29133af24433SOleg Nesterov 	/*
29140f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
29150f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
29160f900049STejun Heo 	 * unsigned long long.
29173af24433SOleg Nesterov 	 */
29180f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
29190f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
29200f900049STejun Heo 				   __alignof__(unsigned long long));
29213af24433SOleg Nesterov 
2922e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2923f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2924931ac77eSTejun Heo 	else {
29250f900049STejun Heo 		void *ptr;
2926e1d8aa9fSFrederic Weisbecker 
29270f900049STejun Heo 		/*
2928f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
2929f3421797STejun Heo 		 * pointer at the end pointing back to the originally
2930f3421797STejun Heo 		 * allocated pointer which will be used for free.
29310f900049STejun Heo 		 */
2932bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2933bdbc5dd7STejun Heo 		if (ptr) {
2934bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2935bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
2936bdbc5dd7STejun Heo 		}
29373af24433SOleg Nesterov 	}
29383af24433SOleg Nesterov 
29390415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
2940bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2941bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
29420f900049STejun Heo }
29430f900049STejun Heo 
2944bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
294506ba38a9SOleg Nesterov {
2946e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
2947bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
2948f3421797STejun Heo 	else if (wq->cpu_wq.single) {
2949f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
2950f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
295106ba38a9SOleg Nesterov 	}
295206ba38a9SOleg Nesterov }
295306ba38a9SOleg Nesterov 
2954f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
2955f3421797STejun Heo 			       const char *name)
2956b71ab8c2STejun Heo {
2957f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2958f3421797STejun Heo 
2959f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
2960b71ab8c2STejun Heo 		printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2961b71ab8c2STejun Heo 		       "is out of range, clamping between %d and %d\n",
2962f3421797STejun Heo 		       max_active, name, 1, lim);
2963b71ab8c2STejun Heo 
2964f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
2965b71ab8c2STejun Heo }
2966b71ab8c2STejun Heo 
2967b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
296897e37d7bSTejun Heo 					       unsigned int flags,
29691e19ffc6STejun Heo 					       int max_active,
2970eb13ba87SJohannes Berg 					       struct lock_class_key *key,
2971b196be89STejun Heo 					       const char *lock_name, ...)
29723af24433SOleg Nesterov {
2973b196be89STejun Heo 	va_list args, args1;
29743af24433SOleg Nesterov 	struct workqueue_struct *wq;
2975c34056a3STejun Heo 	unsigned int cpu;
2976b196be89STejun Heo 	size_t namelen;
2977b196be89STejun Heo 
2978b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
2979b196be89STejun Heo 	va_start(args, lock_name);
2980b196be89STejun Heo 	va_copy(args1, args);
2981b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
2982b196be89STejun Heo 
2983b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
2984b196be89STejun Heo 	if (!wq)
2985b196be89STejun Heo 		goto err;
2986b196be89STejun Heo 
2987b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
2988b196be89STejun Heo 	va_end(args);
2989b196be89STejun Heo 	va_end(args1);
29903af24433SOleg Nesterov 
2991f3421797STejun Heo 	/*
29926370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
29936370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
29946370a6adSTejun Heo 	 */
29956370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
29966370a6adSTejun Heo 		flags |= WQ_RESCUER;
29976370a6adSTejun Heo 
2998d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
2999b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
30003af24433SOleg Nesterov 
3001b196be89STejun Heo 	/* init wq */
300297e37d7bSTejun Heo 	wq->flags = flags;
3003a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
300473f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
300573f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
300673f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
300773f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
30083af24433SOleg Nesterov 
3009eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3010cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
30113af24433SOleg Nesterov 
3012bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3013bdbc5dd7STejun Heo 		goto err;
3014bdbc5dd7STejun Heo 
3015f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
30161537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
30178b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
30181537663fSTejun Heo 
30190f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
30208b03ae3cSTejun Heo 		cwq->gcwq = gcwq;
3021c34056a3STejun Heo 		cwq->wq = wq;
302273f53c4aSTejun Heo 		cwq->flush_color = -1;
30231e19ffc6STejun Heo 		cwq->max_active = max_active;
30241e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3025e22bee78STejun Heo 	}
30261537663fSTejun Heo 
3027e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3028e22bee78STejun Heo 		struct worker *rescuer;
3029e22bee78STejun Heo 
3030f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3031e22bee78STejun Heo 			goto err;
3032e22bee78STejun Heo 
3033e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3034e22bee78STejun Heo 		if (!rescuer)
3035e22bee78STejun Heo 			goto err;
3036e22bee78STejun Heo 
3037b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3038b196be89STejun Heo 					       wq->name);
3039e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3040e22bee78STejun Heo 			goto err;
3041e22bee78STejun Heo 
3042e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3043e22bee78STejun Heo 		wake_up_process(rescuer->task);
30443af24433SOleg Nesterov 	}
30451537663fSTejun Heo 
30463af24433SOleg Nesterov 	/*
3047a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3048a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3049a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
30503af24433SOleg Nesterov 	 */
30513af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3052a0a1a5fdSTejun Heo 
305358a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3054f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3055a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3056a0a1a5fdSTejun Heo 
30573af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3058a0a1a5fdSTejun Heo 
30593af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
30603af24433SOleg Nesterov 
30613af24433SOleg Nesterov 	return wq;
30624690c4abSTejun Heo err:
30634690c4abSTejun Heo 	if (wq) {
3064bdbc5dd7STejun Heo 		free_cwqs(wq);
3065f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3066e22bee78STejun Heo 		kfree(wq->rescuer);
30674690c4abSTejun Heo 		kfree(wq);
30683af24433SOleg Nesterov 	}
30694690c4abSTejun Heo 	return NULL;
30701da177e4SLinus Torvalds }
3071d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
30721da177e4SLinus Torvalds 
30733af24433SOleg Nesterov /**
30743af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
30753af24433SOleg Nesterov  * @wq: target workqueue
30763af24433SOleg Nesterov  *
30773af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
30783af24433SOleg Nesterov  */
30793af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
30803af24433SOleg Nesterov {
3081c8e55f36STejun Heo 	unsigned int cpu;
30823af24433SOleg Nesterov 
30839c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
30849c5a2ba7STejun Heo 	drain_workqueue(wq);
3085c8efcc25STejun Heo 
3086a0a1a5fdSTejun Heo 	/*
3087a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3088a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3089a0a1a5fdSTejun Heo 	 */
309095402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
30913af24433SOleg Nesterov 	list_del(&wq->list);
309295402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
30933af24433SOleg Nesterov 
3094e22bee78STejun Heo 	/* sanity check */
3095f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
309673f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
309773f53c4aSTejun Heo 		int i;
30983af24433SOleg Nesterov 
309973f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
310073f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
31011e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
31021e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
310373f53c4aSTejun Heo 	}
31041537663fSTejun Heo 
3105e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3106e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3107f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
31088d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3109e22bee78STejun Heo 	}
3110e22bee78STejun Heo 
3111bdbc5dd7STejun Heo 	free_cwqs(wq);
31123af24433SOleg Nesterov 	kfree(wq);
31133af24433SOleg Nesterov }
31143af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
31153af24433SOleg Nesterov 
3116dcd989cbSTejun Heo /**
3117dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3118dcd989cbSTejun Heo  * @wq: target workqueue
3119dcd989cbSTejun Heo  * @max_active: new max_active value.
3120dcd989cbSTejun Heo  *
3121dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3122dcd989cbSTejun Heo  *
3123dcd989cbSTejun Heo  * CONTEXT:
3124dcd989cbSTejun Heo  * Don't call from IRQ context.
3125dcd989cbSTejun Heo  */
3126dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3127dcd989cbSTejun Heo {
3128dcd989cbSTejun Heo 	unsigned int cpu;
3129dcd989cbSTejun Heo 
3130f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3131dcd989cbSTejun Heo 
3132dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3133dcd989cbSTejun Heo 
3134dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3135dcd989cbSTejun Heo 
3136f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3137dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3138dcd989cbSTejun Heo 
3139dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3140dcd989cbSTejun Heo 
314158a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3142dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3143dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3144dcd989cbSTejun Heo 
3145dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3146dcd989cbSTejun Heo 	}
3147dcd989cbSTejun Heo 
3148dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3149dcd989cbSTejun Heo }
3150dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3151dcd989cbSTejun Heo 
3152dcd989cbSTejun Heo /**
3153dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3154dcd989cbSTejun Heo  * @cpu: CPU in question
3155dcd989cbSTejun Heo  * @wq: target workqueue
3156dcd989cbSTejun Heo  *
3157dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3158dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3159dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3160dcd989cbSTejun Heo  *
3161dcd989cbSTejun Heo  * RETURNS:
3162dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3163dcd989cbSTejun Heo  */
3164dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3165dcd989cbSTejun Heo {
3166dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3167dcd989cbSTejun Heo 
3168dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3169dcd989cbSTejun Heo }
3170dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3171dcd989cbSTejun Heo 
3172dcd989cbSTejun Heo /**
3173dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3174dcd989cbSTejun Heo  * @work: the work of interest
3175dcd989cbSTejun Heo  *
3176dcd989cbSTejun Heo  * RETURNS:
3177bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3178dcd989cbSTejun Heo  */
3179dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3180dcd989cbSTejun Heo {
3181dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3182dcd989cbSTejun Heo 
3183bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3184dcd989cbSTejun Heo }
3185dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3186dcd989cbSTejun Heo 
3187dcd989cbSTejun Heo /**
3188dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3189dcd989cbSTejun Heo  * @work: the work to be tested
3190dcd989cbSTejun Heo  *
3191dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3192dcd989cbSTejun Heo  * synchronization around this function and the test result is
3193dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3194dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3195dcd989cbSTejun Heo  * running state.
3196dcd989cbSTejun Heo  *
3197dcd989cbSTejun Heo  * RETURNS:
3198dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3199dcd989cbSTejun Heo  */
3200dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3201dcd989cbSTejun Heo {
3202dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3203dcd989cbSTejun Heo 	unsigned long flags;
3204dcd989cbSTejun Heo 	unsigned int ret = 0;
3205dcd989cbSTejun Heo 
3206dcd989cbSTejun Heo 	if (!gcwq)
3207dcd989cbSTejun Heo 		return false;
3208dcd989cbSTejun Heo 
3209dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3210dcd989cbSTejun Heo 
3211dcd989cbSTejun Heo 	if (work_pending(work))
3212dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3213dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3214dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3215dcd989cbSTejun Heo 
3216dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3217dcd989cbSTejun Heo 
3218dcd989cbSTejun Heo 	return ret;
3219dcd989cbSTejun Heo }
3220dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3221dcd989cbSTejun Heo 
3222db7bccf4STejun Heo /*
3223db7bccf4STejun Heo  * CPU hotplug.
3224db7bccf4STejun Heo  *
3225e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3226e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3227e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3228e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3229e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3230e22bee78STejun Heo  * blocked draining impractical.
3231e22bee78STejun Heo  *
3232e22bee78STejun Heo  * This is solved by allowing a gcwq to be detached from CPU, running
3233e22bee78STejun Heo  * it with unbound (rogue) workers and allowing it to be reattached
3234e22bee78STejun Heo  * later if the cpu comes back online.  A separate thread is created
3235e22bee78STejun Heo  * to govern a gcwq in such state and is called the trustee of the
3236e22bee78STejun Heo  * gcwq.
3237db7bccf4STejun Heo  *
3238db7bccf4STejun Heo  * Trustee states and their descriptions.
3239db7bccf4STejun Heo  *
3240db7bccf4STejun Heo  * START	Command state used on startup.  On CPU_DOWN_PREPARE, a
3241db7bccf4STejun Heo  *		new trustee is started with this state.
3242db7bccf4STejun Heo  *
3243db7bccf4STejun Heo  * IN_CHARGE	Once started, trustee will enter this state after
3244e22bee78STejun Heo  *		assuming the manager role and making all existing
3245e22bee78STejun Heo  *		workers rogue.  DOWN_PREPARE waits for trustee to
3246e22bee78STejun Heo  *		enter this state.  After reaching IN_CHARGE, trustee
3247e22bee78STejun Heo  *		tries to execute the pending worklist until it's empty
3248e22bee78STejun Heo  *		and the state is set to BUTCHER, or the state is set
3249e22bee78STejun Heo  *		to RELEASE.
3250db7bccf4STejun Heo  *
3251db7bccf4STejun Heo  * BUTCHER	Command state which is set by the cpu callback after
3252db7bccf4STejun Heo  *		the cpu has went down.  Once this state is set trustee
3253db7bccf4STejun Heo  *		knows that there will be no new works on the worklist
3254db7bccf4STejun Heo  *		and once the worklist is empty it can proceed to
3255db7bccf4STejun Heo  *		killing idle workers.
3256db7bccf4STejun Heo  *
3257db7bccf4STejun Heo  * RELEASE	Command state which is set by the cpu callback if the
3258db7bccf4STejun Heo  *		cpu down has been canceled or it has come online
3259db7bccf4STejun Heo  *		again.  After recognizing this state, trustee stops
3260e22bee78STejun Heo  *		trying to drain or butcher and clears ROGUE, rebinds
3261e22bee78STejun Heo  *		all remaining workers back to the cpu and releases
3262e22bee78STejun Heo  *		manager role.
3263db7bccf4STejun Heo  *
3264db7bccf4STejun Heo  * DONE		Trustee will enter this state after BUTCHER or RELEASE
3265db7bccf4STejun Heo  *		is complete.
3266db7bccf4STejun Heo  *
3267db7bccf4STejun Heo  *          trustee                 CPU                draining
3268db7bccf4STejun Heo  *         took over                down               complete
3269db7bccf4STejun Heo  * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3270db7bccf4STejun Heo  *                        |                     |                  ^
3271db7bccf4STejun Heo  *                        | CPU is back online  v   return workers |
3272db7bccf4STejun Heo  *                         ----------------> RELEASE --------------
3273db7bccf4STejun Heo  */
3274db7bccf4STejun Heo 
3275db7bccf4STejun Heo /**
3276db7bccf4STejun Heo  * trustee_wait_event_timeout - timed event wait for trustee
3277db7bccf4STejun Heo  * @cond: condition to wait for
3278db7bccf4STejun Heo  * @timeout: timeout in jiffies
3279db7bccf4STejun Heo  *
3280db7bccf4STejun Heo  * wait_event_timeout() for trustee to use.  Handles locking and
3281db7bccf4STejun Heo  * checks for RELEASE request.
3282db7bccf4STejun Heo  *
3283db7bccf4STejun Heo  * CONTEXT:
3284db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3285db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3286db7bccf4STejun Heo  *
3287db7bccf4STejun Heo  * RETURNS:
3288db7bccf4STejun Heo  * Positive indicating left time if @cond is satisfied, 0 if timed
3289db7bccf4STejun Heo  * out, -1 if canceled.
3290db7bccf4STejun Heo  */
3291db7bccf4STejun Heo #define trustee_wait_event_timeout(cond, timeout) ({			\
3292db7bccf4STejun Heo 	long __ret = (timeout);						\
3293db7bccf4STejun Heo 	while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) &&	\
3294db7bccf4STejun Heo 	       __ret) {							\
3295db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);				\
3296db7bccf4STejun Heo 		__wait_event_timeout(gcwq->trustee_wait, (cond) ||	\
3297db7bccf4STejun Heo 			(gcwq->trustee_state == TRUSTEE_RELEASE),	\
3298db7bccf4STejun Heo 			__ret);						\
3299db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);				\
3300db7bccf4STejun Heo 	}								\
3301db7bccf4STejun Heo 	gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret);		\
3302db7bccf4STejun Heo })
3303db7bccf4STejun Heo 
3304db7bccf4STejun Heo /**
3305db7bccf4STejun Heo  * trustee_wait_event - event wait for trustee
3306db7bccf4STejun Heo  * @cond: condition to wait for
3307db7bccf4STejun Heo  *
3308db7bccf4STejun Heo  * wait_event() for trustee to use.  Automatically handles locking and
3309db7bccf4STejun Heo  * checks for CANCEL request.
3310db7bccf4STejun Heo  *
3311db7bccf4STejun Heo  * CONTEXT:
3312db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3313db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3314db7bccf4STejun Heo  *
3315db7bccf4STejun Heo  * RETURNS:
3316db7bccf4STejun Heo  * 0 if @cond is satisfied, -1 if canceled.
3317db7bccf4STejun Heo  */
3318db7bccf4STejun Heo #define trustee_wait_event(cond) ({					\
3319db7bccf4STejun Heo 	long __ret1;							\
3320db7bccf4STejun Heo 	__ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3321db7bccf4STejun Heo 	__ret1 < 0 ? -1 : 0;						\
3322db7bccf4STejun Heo })
3323db7bccf4STejun Heo 
3324db7bccf4STejun Heo static int __cpuinit trustee_thread(void *__gcwq)
3325db7bccf4STejun Heo {
3326db7bccf4STejun Heo 	struct global_cwq *gcwq = __gcwq;
3327db7bccf4STejun Heo 	struct worker *worker;
3328e22bee78STejun Heo 	struct work_struct *work;
3329db7bccf4STejun Heo 	struct hlist_node *pos;
3330e22bee78STejun Heo 	long rc;
3331db7bccf4STejun Heo 	int i;
3332db7bccf4STejun Heo 
3333db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3334db7bccf4STejun Heo 
3335db7bccf4STejun Heo 	spin_lock_irq(&gcwq->lock);
3336db7bccf4STejun Heo 	/*
3337e22bee78STejun Heo 	 * Claim the manager position and make all workers rogue.
3338e22bee78STejun Heo 	 * Trustee must be bound to the target cpu and can't be
3339e22bee78STejun Heo 	 * cancelled.
3340db7bccf4STejun Heo 	 */
3341db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3342e22bee78STejun Heo 	rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3343e22bee78STejun Heo 	BUG_ON(rc < 0);
3344e22bee78STejun Heo 
3345e22bee78STejun Heo 	gcwq->flags |= GCWQ_MANAGING_WORKERS;
3346db7bccf4STejun Heo 
3347db7bccf4STejun Heo 	list_for_each_entry(worker, &gcwq->idle_list, entry)
3348cb444766STejun Heo 		worker->flags |= WORKER_ROGUE;
3349db7bccf4STejun Heo 
3350db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3351cb444766STejun Heo 		worker->flags |= WORKER_ROGUE;
3352db7bccf4STejun Heo 
3353db7bccf4STejun Heo 	/*
3354e22bee78STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can
3355e22bee78STejun Heo 	 * guarantee sched callbacks see the rogue flag.  This is
3356e22bee78STejun Heo 	 * necessary as scheduler callbacks may be invoked from other
3357e22bee78STejun Heo 	 * cpus.
3358e22bee78STejun Heo 	 */
3359e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3360e22bee78STejun Heo 	schedule();
3361e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3362e22bee78STejun Heo 
3363e22bee78STejun Heo 	/*
3364cb444766STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After
3365cb444766STejun Heo 	 * this, nr_running stays zero and need_more_worker() and
3366cb444766STejun Heo 	 * keep_working() are always true as long as the worklist is
3367cb444766STejun Heo 	 * not empty.
3368e22bee78STejun Heo 	 */
3369cb444766STejun Heo 	atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
3370e22bee78STejun Heo 
3371e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3372e22bee78STejun Heo 	del_timer_sync(&gcwq->idle_timer);
3373e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3374e22bee78STejun Heo 
3375e22bee78STejun Heo 	/*
3376db7bccf4STejun Heo 	 * We're now in charge.  Notify and proceed to drain.  We need
3377db7bccf4STejun Heo 	 * to keep the gcwq running during the whole CPU down
3378db7bccf4STejun Heo 	 * procedure as other cpu hotunplug callbacks may need to
3379db7bccf4STejun Heo 	 * flush currently running tasks.
3380db7bccf4STejun Heo 	 */
3381db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3382db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3383db7bccf4STejun Heo 
3384db7bccf4STejun Heo 	/*
3385db7bccf4STejun Heo 	 * The original cpu is in the process of dying and may go away
3386db7bccf4STejun Heo 	 * anytime now.  When that happens, we and all workers would
3387e22bee78STejun Heo 	 * be migrated to other cpus.  Try draining any left work.  We
3388e22bee78STejun Heo 	 * want to get it over with ASAP - spam rescuers, wake up as
3389e22bee78STejun Heo 	 * many idlers as necessary and create new ones till the
3390e22bee78STejun Heo 	 * worklist is empty.  Note that if the gcwq is frozen, there
339158a69cb4STejun Heo 	 * may be frozen works in freezable cwqs.  Don't declare
3392e22bee78STejun Heo 	 * completion while frozen.
3393db7bccf4STejun Heo 	 */
3394db7bccf4STejun Heo 	while (gcwq->nr_workers != gcwq->nr_idle ||
3395db7bccf4STejun Heo 	       gcwq->flags & GCWQ_FREEZING ||
3396db7bccf4STejun Heo 	       gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
3397e22bee78STejun Heo 		int nr_works = 0;
3398e22bee78STejun Heo 
3399e22bee78STejun Heo 		list_for_each_entry(work, &gcwq->worklist, entry) {
3400e22bee78STejun Heo 			send_mayday(work);
3401e22bee78STejun Heo 			nr_works++;
3402e22bee78STejun Heo 		}
3403e22bee78STejun Heo 
3404e22bee78STejun Heo 		list_for_each_entry(worker, &gcwq->idle_list, entry) {
3405e22bee78STejun Heo 			if (!nr_works--)
3406e22bee78STejun Heo 				break;
3407e22bee78STejun Heo 			wake_up_process(worker->task);
3408e22bee78STejun Heo 		}
3409e22bee78STejun Heo 
3410e22bee78STejun Heo 		if (need_to_create_worker(gcwq)) {
3411e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3412e22bee78STejun Heo 			worker = create_worker(gcwq, false);
3413e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3414e22bee78STejun Heo 			if (worker) {
3415cb444766STejun Heo 				worker->flags |= WORKER_ROGUE;
3416e22bee78STejun Heo 				start_worker(worker);
3417e22bee78STejun Heo 			}
3418e22bee78STejun Heo 		}
3419e22bee78STejun Heo 
3420db7bccf4STejun Heo 		/* give a breather */
3421db7bccf4STejun Heo 		if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3422db7bccf4STejun Heo 			break;
3423db7bccf4STejun Heo 	}
3424db7bccf4STejun Heo 
3425e22bee78STejun Heo 	/*
3426e22bee78STejun Heo 	 * Either all works have been scheduled and cpu is down, or
3427e22bee78STejun Heo 	 * cpu down has already been canceled.  Wait for and butcher
3428e22bee78STejun Heo 	 * all workers till we're canceled.
3429e22bee78STejun Heo 	 */
3430e22bee78STejun Heo 	do {
3431e22bee78STejun Heo 		rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3432e22bee78STejun Heo 		while (!list_empty(&gcwq->idle_list))
3433e22bee78STejun Heo 			destroy_worker(list_first_entry(&gcwq->idle_list,
3434e22bee78STejun Heo 							struct worker, entry));
3435e22bee78STejun Heo 	} while (gcwq->nr_workers && rc >= 0);
3436e22bee78STejun Heo 
3437e22bee78STejun Heo 	/*
3438e22bee78STejun Heo 	 * At this point, either draining has completed and no worker
3439e22bee78STejun Heo 	 * is left, or cpu down has been canceled or the cpu is being
3440e22bee78STejun Heo 	 * brought back up.  There shouldn't be any idle one left.
3441e22bee78STejun Heo 	 * Tell the remaining busy ones to rebind once it finishes the
3442e22bee78STejun Heo 	 * currently scheduled works by scheduling the rebind_work.
3443e22bee78STejun Heo 	 */
3444e22bee78STejun Heo 	WARN_ON(!list_empty(&gcwq->idle_list));
3445e22bee78STejun Heo 
3446e22bee78STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
3447e22bee78STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
3448e22bee78STejun Heo 
3449e22bee78STejun Heo 		/*
3450e22bee78STejun Heo 		 * Rebind_work may race with future cpu hotplug
3451e22bee78STejun Heo 		 * operations.  Use a separate flag to mark that
3452e22bee78STejun Heo 		 * rebinding is scheduled.
3453e22bee78STejun Heo 		 */
3454cb444766STejun Heo 		worker->flags |= WORKER_REBIND;
3455cb444766STejun Heo 		worker->flags &= ~WORKER_ROGUE;
3456e22bee78STejun Heo 
3457e22bee78STejun Heo 		/* queue rebind_work, wq doesn't matter, use the default one */
3458e22bee78STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3459e22bee78STejun Heo 				     work_data_bits(rebind_work)))
3460e22bee78STejun Heo 			continue;
3461e22bee78STejun Heo 
3462e22bee78STejun Heo 		debug_work_activate(rebind_work);
3463d320c038STejun Heo 		insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3464e22bee78STejun Heo 			    worker->scheduled.next,
3465e22bee78STejun Heo 			    work_color_to_flags(WORK_NO_COLOR));
3466e22bee78STejun Heo 	}
3467e22bee78STejun Heo 
3468e22bee78STejun Heo 	/* relinquish manager role */
3469e22bee78STejun Heo 	gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3470e22bee78STejun Heo 
3471db7bccf4STejun Heo 	/* notify completion */
3472db7bccf4STejun Heo 	gcwq->trustee = NULL;
3473db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_DONE;
3474db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3475db7bccf4STejun Heo 	spin_unlock_irq(&gcwq->lock);
3476db7bccf4STejun Heo 	return 0;
3477db7bccf4STejun Heo }
3478db7bccf4STejun Heo 
3479db7bccf4STejun Heo /**
3480db7bccf4STejun Heo  * wait_trustee_state - wait for trustee to enter the specified state
3481db7bccf4STejun Heo  * @gcwq: gcwq the trustee of interest belongs to
3482db7bccf4STejun Heo  * @state: target state to wait for
3483db7bccf4STejun Heo  *
3484db7bccf4STejun Heo  * Wait for the trustee to reach @state.  DONE is already matched.
3485db7bccf4STejun Heo  *
3486db7bccf4STejun Heo  * CONTEXT:
3487db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3488db7bccf4STejun Heo  * multiple times.  To be used by cpu_callback.
3489db7bccf4STejun Heo  */
3490db7bccf4STejun Heo static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
349106bd6ebfSNamhyung Kim __releases(&gcwq->lock)
349206bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
3493db7bccf4STejun Heo {
3494db7bccf4STejun Heo 	if (!(gcwq->trustee_state == state ||
3495db7bccf4STejun Heo 	      gcwq->trustee_state == TRUSTEE_DONE)) {
3496db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);
3497db7bccf4STejun Heo 		__wait_event(gcwq->trustee_wait,
3498db7bccf4STejun Heo 			     gcwq->trustee_state == state ||
3499db7bccf4STejun Heo 			     gcwq->trustee_state == TRUSTEE_DONE);
3500db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);
3501db7bccf4STejun Heo 	}
3502db7bccf4STejun Heo }
3503db7bccf4STejun Heo 
35049c7b216dSChandra Seetharaman static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
35051da177e4SLinus Torvalds 						unsigned long action,
35061da177e4SLinus Torvalds 						void *hcpu)
35071da177e4SLinus Torvalds {
35083af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3509db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
3510db7bccf4STejun Heo 	struct task_struct *new_trustee = NULL;
3511e22bee78STejun Heo 	struct worker *uninitialized_var(new_worker);
3512db7bccf4STejun Heo 	unsigned long flags;
35131da177e4SLinus Torvalds 
35148bb78442SRafael J. Wysocki 	action &= ~CPU_TASKS_FROZEN;
35158bb78442SRafael J. Wysocki 
35161da177e4SLinus Torvalds 	switch (action) {
3517db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3518db7bccf4STejun Heo 		new_trustee = kthread_create(trustee_thread, gcwq,
3519db7bccf4STejun Heo 					     "workqueue_trustee/%d\n", cpu);
3520db7bccf4STejun Heo 		if (IS_ERR(new_trustee))
3521db7bccf4STejun Heo 			return notifier_from_errno(PTR_ERR(new_trustee));
3522db7bccf4STejun Heo 		kthread_bind(new_trustee, cpu);
3523e22bee78STejun Heo 		/* fall through */
35243af24433SOleg Nesterov 	case CPU_UP_PREPARE:
3525e22bee78STejun Heo 		BUG_ON(gcwq->first_idle);
3526e22bee78STejun Heo 		new_worker = create_worker(gcwq, false);
3527e22bee78STejun Heo 		if (!new_worker) {
3528e22bee78STejun Heo 			if (new_trustee)
3529e22bee78STejun Heo 				kthread_stop(new_trustee);
3530e22bee78STejun Heo 			return NOTIFY_BAD;
35313af24433SOleg Nesterov 		}
3532db7bccf4STejun Heo 	}
35331537663fSTejun Heo 
3534db7bccf4STejun Heo 	/* some are called w/ irq disabled, don't disturb irq status */
3535db7bccf4STejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
35363af24433SOleg Nesterov 
35373af24433SOleg Nesterov 	switch (action) {
3538db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3539db7bccf4STejun Heo 		/* initialize trustee and tell it to acquire the gcwq */
3540db7bccf4STejun Heo 		BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3541db7bccf4STejun Heo 		gcwq->trustee = new_trustee;
3542db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_START;
3543db7bccf4STejun Heo 		wake_up_process(gcwq->trustee);
3544db7bccf4STejun Heo 		wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3545e22bee78STejun Heo 		/* fall through */
35463af24433SOleg Nesterov 	case CPU_UP_PREPARE:
3547e22bee78STejun Heo 		BUG_ON(gcwq->first_idle);
3548e22bee78STejun Heo 		gcwq->first_idle = new_worker;
35491da177e4SLinus Torvalds 		break;
35501da177e4SLinus Torvalds 
3551e22bee78STejun Heo 	case CPU_DYING:
3552e22bee78STejun Heo 		/*
3553e22bee78STejun Heo 		 * Before this, the trustee and all workers except for
3554e22bee78STejun Heo 		 * the ones which are still executing works from
3555e22bee78STejun Heo 		 * before the last CPU down must be on the cpu.  After
3556e22bee78STejun Heo 		 * this, they'll all be diasporas.
3557e22bee78STejun Heo 		 */
3558e22bee78STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
3559db7bccf4STejun Heo 		break;
3560db7bccf4STejun Heo 
35613da1c84cSOleg Nesterov 	case CPU_POST_DEAD:
3562db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_BUTCHER;
3563e22bee78STejun Heo 		/* fall through */
3564e22bee78STejun Heo 	case CPU_UP_CANCELED:
3565e22bee78STejun Heo 		destroy_worker(gcwq->first_idle);
3566e22bee78STejun Heo 		gcwq->first_idle = NULL;
3567db7bccf4STejun Heo 		break;
3568db7bccf4STejun Heo 
3569db7bccf4STejun Heo 	case CPU_DOWN_FAILED:
35701da177e4SLinus Torvalds 	case CPU_ONLINE:
3571e22bee78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
3572db7bccf4STejun Heo 		if (gcwq->trustee_state != TRUSTEE_DONE) {
3573db7bccf4STejun Heo 			gcwq->trustee_state = TRUSTEE_RELEASE;
3574db7bccf4STejun Heo 			wake_up_process(gcwq->trustee);
3575db7bccf4STejun Heo 			wait_trustee_state(gcwq, TRUSTEE_DONE);
3576db7bccf4STejun Heo 		}
35771da177e4SLinus Torvalds 
3578e22bee78STejun Heo 		/*
3579e22bee78STejun Heo 		 * Trustee is done and there might be no worker left.
3580e22bee78STejun Heo 		 * Put the first_idle in and request a real manager to
3581e22bee78STejun Heo 		 * take a look.
3582e22bee78STejun Heo 		 */
3583e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
3584e22bee78STejun Heo 		kthread_bind(gcwq->first_idle->task, cpu);
3585e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
3586e22bee78STejun Heo 		gcwq->flags |= GCWQ_MANAGE_WORKERS;
3587e22bee78STejun Heo 		start_worker(gcwq->first_idle);
3588e22bee78STejun Heo 		gcwq->first_idle = NULL;
35891da177e4SLinus Torvalds 		break;
35901da177e4SLinus Torvalds 	}
35911da177e4SLinus Torvalds 
3592db7bccf4STejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
359300dfcaf7SOleg Nesterov 
35941537663fSTejun Heo 	return notifier_from_errno(0);
35951da177e4SLinus Torvalds }
35961da177e4SLinus Torvalds 
35972d3854a3SRusty Russell #ifdef CONFIG_SMP
35988ccad40dSRusty Russell 
35992d3854a3SRusty Russell struct work_for_cpu {
36006b44003eSAndrew Morton 	struct completion completion;
36012d3854a3SRusty Russell 	long (*fn)(void *);
36022d3854a3SRusty Russell 	void *arg;
36032d3854a3SRusty Russell 	long ret;
36042d3854a3SRusty Russell };
36052d3854a3SRusty Russell 
36066b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
36072d3854a3SRusty Russell {
36086b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
36092d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
36106b44003eSAndrew Morton 	complete(&wfc->completion);
36116b44003eSAndrew Morton 	return 0;
36122d3854a3SRusty Russell }
36132d3854a3SRusty Russell 
36142d3854a3SRusty Russell /**
36152d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
36162d3854a3SRusty Russell  * @cpu: the cpu to run on
36172d3854a3SRusty Russell  * @fn: the function to run
36182d3854a3SRusty Russell  * @arg: the function arg
36192d3854a3SRusty Russell  *
362031ad9081SRusty Russell  * This will return the value @fn returns.
362131ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
36226b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
36232d3854a3SRusty Russell  */
36242d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
36252d3854a3SRusty Russell {
36266b44003eSAndrew Morton 	struct task_struct *sub_thread;
36276b44003eSAndrew Morton 	struct work_for_cpu wfc = {
36286b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
36296b44003eSAndrew Morton 		.fn = fn,
36306b44003eSAndrew Morton 		.arg = arg,
36316b44003eSAndrew Morton 	};
36322d3854a3SRusty Russell 
36336b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
36346b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
36356b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
36366b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
36376b44003eSAndrew Morton 	wake_up_process(sub_thread);
36386b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
36392d3854a3SRusty Russell 	return wfc.ret;
36402d3854a3SRusty Russell }
36412d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
36422d3854a3SRusty Russell #endif /* CONFIG_SMP */
36432d3854a3SRusty Russell 
3644a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3645e7577c50SRusty Russell 
3646a0a1a5fdSTejun Heo /**
3647a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3648a0a1a5fdSTejun Heo  *
364958a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
365058a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
365158a69cb4STejun Heo  * gcwq->worklist.
3652a0a1a5fdSTejun Heo  *
3653a0a1a5fdSTejun Heo  * CONTEXT:
36548b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3655a0a1a5fdSTejun Heo  */
3656a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3657a0a1a5fdSTejun Heo {
3658a0a1a5fdSTejun Heo 	unsigned int cpu;
3659a0a1a5fdSTejun Heo 
3660a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3661a0a1a5fdSTejun Heo 
3662a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3663a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3664a0a1a5fdSTejun Heo 
3665f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
36668b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3667bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
36688b03ae3cSTejun Heo 
36698b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
36708b03ae3cSTejun Heo 
3671db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3672db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3673db7bccf4STejun Heo 
3674a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3675a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3676a0a1a5fdSTejun Heo 
367758a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3678a0a1a5fdSTejun Heo 				cwq->max_active = 0;
36791da177e4SLinus Torvalds 		}
36808b03ae3cSTejun Heo 
36818b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3682a0a1a5fdSTejun Heo 	}
3683a0a1a5fdSTejun Heo 
3684a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3685a0a1a5fdSTejun Heo }
3686a0a1a5fdSTejun Heo 
3687a0a1a5fdSTejun Heo /**
368858a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3689a0a1a5fdSTejun Heo  *
3690a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3691a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3692a0a1a5fdSTejun Heo  *
3693a0a1a5fdSTejun Heo  * CONTEXT:
3694a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3695a0a1a5fdSTejun Heo  *
3696a0a1a5fdSTejun Heo  * RETURNS:
369758a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
369858a69cb4STejun Heo  * is complete.
3699a0a1a5fdSTejun Heo  */
3700a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3701a0a1a5fdSTejun Heo {
3702a0a1a5fdSTejun Heo 	unsigned int cpu;
3703a0a1a5fdSTejun Heo 	bool busy = false;
3704a0a1a5fdSTejun Heo 
3705a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3706a0a1a5fdSTejun Heo 
3707a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3708a0a1a5fdSTejun Heo 
3709f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3710bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3711a0a1a5fdSTejun Heo 		/*
3712a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3713a0a1a5fdSTejun Heo 		 * to peek without lock.
3714a0a1a5fdSTejun Heo 		 */
3715a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3716a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3717a0a1a5fdSTejun Heo 
371858a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3719a0a1a5fdSTejun Heo 				continue;
3720a0a1a5fdSTejun Heo 
3721a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3722a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3723a0a1a5fdSTejun Heo 				busy = true;
3724a0a1a5fdSTejun Heo 				goto out_unlock;
3725a0a1a5fdSTejun Heo 			}
3726a0a1a5fdSTejun Heo 		}
3727a0a1a5fdSTejun Heo 	}
3728a0a1a5fdSTejun Heo out_unlock:
3729a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3730a0a1a5fdSTejun Heo 	return busy;
3731a0a1a5fdSTejun Heo }
3732a0a1a5fdSTejun Heo 
3733a0a1a5fdSTejun Heo /**
3734a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3735a0a1a5fdSTejun Heo  *
3736a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
37377e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3738a0a1a5fdSTejun Heo  *
3739a0a1a5fdSTejun Heo  * CONTEXT:
37408b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3741a0a1a5fdSTejun Heo  */
3742a0a1a5fdSTejun Heo void thaw_workqueues(void)
3743a0a1a5fdSTejun Heo {
3744a0a1a5fdSTejun Heo 	unsigned int cpu;
3745a0a1a5fdSTejun Heo 
3746a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3747a0a1a5fdSTejun Heo 
3748a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3749a0a1a5fdSTejun Heo 		goto out_unlock;
3750a0a1a5fdSTejun Heo 
3751f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37528b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3753bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
37548b03ae3cSTejun Heo 
37558b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
37568b03ae3cSTejun Heo 
3757db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3758db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3759db7bccf4STejun Heo 
3760a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3761a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3762a0a1a5fdSTejun Heo 
376358a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3764a0a1a5fdSTejun Heo 				continue;
3765a0a1a5fdSTejun Heo 
3766a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3767a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3768a0a1a5fdSTejun Heo 
3769a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3770a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3771a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3772a0a1a5fdSTejun Heo 		}
37738b03ae3cSTejun Heo 
3774e22bee78STejun Heo 		wake_up_worker(gcwq);
3775e22bee78STejun Heo 
37768b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3777a0a1a5fdSTejun Heo 	}
3778a0a1a5fdSTejun Heo 
3779a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3780a0a1a5fdSTejun Heo out_unlock:
3781a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3782a0a1a5fdSTejun Heo }
3783a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3784a0a1a5fdSTejun Heo 
37856ee0578bSSuresh Siddha static int __init init_workqueues(void)
37861da177e4SLinus Torvalds {
3787c34056a3STejun Heo 	unsigned int cpu;
3788c8e55f36STejun Heo 	int i;
3789c34056a3STejun Heo 
3790f6500947STejun Heo 	cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
37918b03ae3cSTejun Heo 
37928b03ae3cSTejun Heo 	/* initialize gcwqs */
3793f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
37948b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
37958b03ae3cSTejun Heo 
37968b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
37977e11629dSTejun Heo 		INIT_LIST_HEAD(&gcwq->worklist);
37988b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3799f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
38008b03ae3cSTejun Heo 
3801c8e55f36STejun Heo 		INIT_LIST_HEAD(&gcwq->idle_list);
3802c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3803c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3804c8e55f36STejun Heo 
3805e22bee78STejun Heo 		init_timer_deferrable(&gcwq->idle_timer);
3806e22bee78STejun Heo 		gcwq->idle_timer.function = idle_worker_timeout;
3807e22bee78STejun Heo 		gcwq->idle_timer.data = (unsigned long)gcwq;
3808e22bee78STejun Heo 
3809e22bee78STejun Heo 		setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3810e22bee78STejun Heo 			    (unsigned long)gcwq);
3811e22bee78STejun Heo 
38128b03ae3cSTejun Heo 		ida_init(&gcwq->worker_ida);
3813db7bccf4STejun Heo 
3814db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_DONE;
3815db7bccf4STejun Heo 		init_waitqueue_head(&gcwq->trustee_wait);
38168b03ae3cSTejun Heo 	}
38178b03ae3cSTejun Heo 
3818e22bee78STejun Heo 	/* create the initial worker */
3819f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3820e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3821e22bee78STejun Heo 		struct worker *worker;
3822e22bee78STejun Heo 
3823477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
3824477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
3825e22bee78STejun Heo 		worker = create_worker(gcwq, true);
3826e22bee78STejun Heo 		BUG_ON(!worker);
3827e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
3828e22bee78STejun Heo 		start_worker(worker);
3829e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
3830e22bee78STejun Heo 	}
3831e22bee78STejun Heo 
3832d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
3833d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3834d320c038STejun Heo 	system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3835f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3836f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
383724d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
383824d51addSTejun Heo 					      WQ_FREEZABLE, 0);
383962d3c543SAlan Stern 	system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
384062d3c543SAlan Stern 			WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
3841e5cba24eSHitoshi Mitake 	BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
384262d3c543SAlan Stern 	       !system_unbound_wq || !system_freezable_wq ||
384362d3c543SAlan Stern 		!system_nrt_freezable_wq);
38446ee0578bSSuresh Siddha 	return 0;
38451da177e4SLinus Torvalds }
38466ee0578bSSuresh Siddha early_initcall(init_workqueues);
3847