xref: /linux-6.15/kernel/workqueue.c (revision f2e005aa)
11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds  * linux/kernel/workqueue.c
31da177e4SLinus Torvalds  *
41da177e4SLinus Torvalds  * Generic mechanism for defining kernel helper threads for running
51da177e4SLinus Torvalds  * arbitrary tasks in process context.
61da177e4SLinus Torvalds  *
71da177e4SLinus Torvalds  * Started by Ingo Molnar, Copyright (C) 2002
81da177e4SLinus Torvalds  *
91da177e4SLinus Torvalds  * Derived from the taskqueue/keventd code by:
101da177e4SLinus Torvalds  *
111da177e4SLinus Torvalds  *   David Woodhouse <[email protected]>
12e1f8e874SFrancois Cami  *   Andrew Morton
131da177e4SLinus Torvalds  *   Kai Petzke <[email protected]>
141da177e4SLinus Torvalds  *   Theodore Ts'o <[email protected]>
1589ada679SChristoph Lameter  *
16cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
171da177e4SLinus Torvalds  */
181da177e4SLinus Torvalds 
191da177e4SLinus Torvalds #include <linux/module.h>
201da177e4SLinus Torvalds #include <linux/kernel.h>
211da177e4SLinus Torvalds #include <linux/sched.h>
221da177e4SLinus Torvalds #include <linux/init.h>
231da177e4SLinus Torvalds #include <linux/signal.h>
241da177e4SLinus Torvalds #include <linux/completion.h>
251da177e4SLinus Torvalds #include <linux/workqueue.h>
261da177e4SLinus Torvalds #include <linux/slab.h>
271da177e4SLinus Torvalds #include <linux/cpu.h>
281da177e4SLinus Torvalds #include <linux/notifier.h>
291da177e4SLinus Torvalds #include <linux/kthread.h>
301fa44ecaSJames Bottomley #include <linux/hardirq.h>
3146934023SChristoph Lameter #include <linux/mempolicy.h>
32341a5958SRafael J. Wysocki #include <linux/freezer.h>
33d5abe669SPeter Zijlstra #include <linux/kallsyms.h>
34d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
354e6045f1SJohannes Berg #include <linux/lockdep.h>
36c34056a3STejun Heo #include <linux/idr.h>
37e22bee78STejun Heo 
38e22bee78STejun Heo #include "workqueue_sched.h"
391da177e4SLinus Torvalds 
40c8e55f36STejun Heo enum {
41db7bccf4STejun Heo 	/* global_cwq flags */
42e22bee78STejun Heo 	GCWQ_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
43e22bee78STejun Heo 	GCWQ_MANAGING_WORKERS	= 1 << 1,	/* managing workers */
44e22bee78STejun Heo 	GCWQ_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
45db7bccf4STejun Heo 	GCWQ_FREEZING		= 1 << 3,	/* freeze in progress */
46649027d7STejun Heo 	GCWQ_HIGHPRI_PENDING	= 1 << 4,	/* highpri works on queue */
47db7bccf4STejun Heo 
48c8e55f36STejun Heo 	/* worker flags */
49c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
50c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
51c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
52e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
53db7bccf4STejun Heo 	WORKER_ROGUE		= 1 << 4,	/* not bound to any cpu */
54e22bee78STejun Heo 	WORKER_REBIND		= 1 << 5,	/* mom is home, come back */
55fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
56f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
57e22bee78STejun Heo 
58fb0e7bebSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
59f3421797STejun Heo 				  WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
60db7bccf4STejun Heo 
61db7bccf4STejun Heo 	/* gcwq->trustee_state */
62db7bccf4STejun Heo 	TRUSTEE_START		= 0,		/* start */
63db7bccf4STejun Heo 	TRUSTEE_IN_CHARGE	= 1,		/* trustee in charge of gcwq */
64db7bccf4STejun Heo 	TRUSTEE_BUTCHER		= 2,		/* butcher workers */
65db7bccf4STejun Heo 	TRUSTEE_RELEASE		= 3,		/* release workers */
66db7bccf4STejun Heo 	TRUSTEE_DONE		= 4,		/* trustee is done */
67c8e55f36STejun Heo 
68c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
69c8e55f36STejun Heo 	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
70c8e55f36STejun Heo 	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
71db7bccf4STejun Heo 
72e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
73e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
74e22bee78STejun Heo 
75e22bee78STejun Heo 	MAYDAY_INITIAL_TIMEOUT	= HZ / 100,	/* call for help after 10ms */
76e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
77e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
78db7bccf4STejun Heo 	TRUSTEE_COOLDOWN	= HZ / 10,	/* for trustee draining */
79e22bee78STejun Heo 
80e22bee78STejun Heo 	/*
81e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
82e22bee78STejun Heo 	 * all cpus.  Give -20.
83e22bee78STejun Heo 	 */
84e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
85c8e55f36STejun Heo };
86c8e55f36STejun Heo 
871da177e4SLinus Torvalds /*
884690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
894690c4abSTejun Heo  *
904690c4abSTejun Heo  * I: Set during initialization and read-only afterwards.
914690c4abSTejun Heo  *
92e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
93e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
94e22bee78STejun Heo  *
958b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
964690c4abSTejun Heo  *
97e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
98e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
99e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
100f3421797STejun Heo  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
101e22bee78STejun Heo  *
10273f53c4aSTejun Heo  * F: wq->flush_mutex protected.
10373f53c4aSTejun Heo  *
1044690c4abSTejun Heo  * W: workqueue_lock protected.
1054690c4abSTejun Heo  */
1064690c4abSTejun Heo 
1078b03ae3cSTejun Heo struct global_cwq;
108c34056a3STejun Heo 
109e22bee78STejun Heo /*
110e22bee78STejun Heo  * The poor guys doing the actual heavy lifting.  All on-duty workers
111e22bee78STejun Heo  * are either serving the manager role, on idle list or on busy hash.
112e22bee78STejun Heo  */
113c34056a3STejun Heo struct worker {
114c8e55f36STejun Heo 	/* on idle list while idle, on busy hash table while busy */
115c8e55f36STejun Heo 	union {
116c8e55f36STejun Heo 		struct list_head	entry;	/* L: while idle */
117c8e55f36STejun Heo 		struct hlist_node	hentry;	/* L: while busy */
118c8e55f36STejun Heo 	};
119c8e55f36STejun Heo 
120c34056a3STejun Heo 	struct work_struct	*current_work;	/* L: work being processed */
1218cca0eeaSTejun Heo 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
122affee4b2STejun Heo 	struct list_head	scheduled;	/* L: scheduled works */
123c34056a3STejun Heo 	struct task_struct	*task;		/* I: worker task */
1248b03ae3cSTejun Heo 	struct global_cwq	*gcwq;		/* I: the associated gcwq */
125e22bee78STejun Heo 	/* 64 bytes boundary on 64bit, 32 on 32bit */
126e22bee78STejun Heo 	unsigned long		last_active;	/* L: last active timestamp */
127e22bee78STejun Heo 	unsigned int		flags;		/* X: flags */
128c34056a3STejun Heo 	int			id;		/* I: worker id */
129e22bee78STejun Heo 	struct work_struct	rebind_work;	/* L: rebind worker to cpu */
130c34056a3STejun Heo };
131c34056a3STejun Heo 
1324690c4abSTejun Heo /*
133e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
134e22bee78STejun Heo  * and all works are queued and processed here regardless of their
135e22bee78STejun Heo  * target workqueues.
1368b03ae3cSTejun Heo  */
1378b03ae3cSTejun Heo struct global_cwq {
1388b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1397e11629dSTejun Heo 	struct list_head	worklist;	/* L: list of pending works */
1408b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
141db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
142c8e55f36STejun Heo 
143c8e55f36STejun Heo 	int			nr_workers;	/* L: total number of workers */
144c8e55f36STejun Heo 	int			nr_idle;	/* L: currently idle ones */
145c8e55f36STejun Heo 
146c8e55f36STejun Heo 	/* workers are chained either in the idle_list or busy_hash */
147e22bee78STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
148c8e55f36STejun Heo 	struct hlist_head	busy_hash[BUSY_WORKER_HASH_SIZE];
149c8e55f36STejun Heo 						/* L: hash of busy workers */
150c8e55f36STejun Heo 
151e22bee78STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
152e22bee78STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for dworkers */
153e22bee78STejun Heo 
1548b03ae3cSTejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
155db7bccf4STejun Heo 
156db7bccf4STejun Heo 	struct task_struct	*trustee;	/* L: for gcwq shutdown */
157db7bccf4STejun Heo 	unsigned int		trustee_state;	/* L: trustee state */
158db7bccf4STejun Heo 	wait_queue_head_t	trustee_wait;	/* trustee wait */
159e22bee78STejun Heo 	struct worker		*first_idle;	/* L: first idle worker */
1608b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1618b03ae3cSTejun Heo 
1628b03ae3cSTejun Heo /*
163502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
1640f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
1650f900049STejun Heo  * aligned at two's power of the number of flag bits.
1661da177e4SLinus Torvalds  */
1671da177e4SLinus Torvalds struct cpu_workqueue_struct {
1688b03ae3cSTejun Heo 	struct global_cwq	*gcwq;		/* I: the associated gcwq */
1694690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
17073f53c4aSTejun Heo 	int			work_color;	/* L: current color */
17173f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
17273f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
17373f53c4aSTejun Heo 						/* L: nr of in_flight works */
1741e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
175a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
1761e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
1770f900049STejun Heo };
1781da177e4SLinus Torvalds 
1791da177e4SLinus Torvalds /*
18073f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
18173f53c4aSTejun Heo  */
18273f53c4aSTejun Heo struct wq_flusher {
18373f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
18473f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
18573f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
18673f53c4aSTejun Heo };
18773f53c4aSTejun Heo 
18873f53c4aSTejun Heo /*
189*f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
190*f2e005aaSTejun Heo  * used to determine whether there's something to be done.
191*f2e005aaSTejun Heo  */
192*f2e005aaSTejun Heo #ifdef CONFIG_SMP
193*f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
194*f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
195*f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
196*f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
197*f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
198*f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		alloc_cpumask_var((maskp), (gfp))
199*f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
200*f2e005aaSTejun Heo #else
201*f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
202*f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
203*f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
204*f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
205*f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
206*f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
207*f2e005aaSTejun Heo #endif
208*f2e005aaSTejun Heo 
209*f2e005aaSTejun Heo /*
2101da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2111da177e4SLinus Torvalds  * per-CPU workqueues:
2121da177e4SLinus Torvalds  */
2131da177e4SLinus Torvalds struct workqueue_struct {
21497e37d7bSTejun Heo 	unsigned int		flags;		/* I: WQ_* flags */
215bdbc5dd7STejun Heo 	union {
216bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
217bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
218bdbc5dd7STejun Heo 		unsigned long				v;
219bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2204690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
22173f53c4aSTejun Heo 
22273f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
22373f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
22473f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
22573f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
22673f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
22773f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
22873f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
22973f53c4aSTejun Heo 
230*f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
231e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
232e22bee78STejun Heo 
233dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2344690c4abSTejun Heo 	const char		*name;		/* I: workqueue name */
2354e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2364e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2374e6045f1SJohannes Berg #endif
2381da177e4SLinus Torvalds };
2391da177e4SLinus Torvalds 
240d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
241d320c038STejun Heo struct workqueue_struct *system_long_wq __read_mostly;
242d320c038STejun Heo struct workqueue_struct *system_nrt_wq __read_mostly;
243f3421797STejun Heo struct workqueue_struct *system_unbound_wq __read_mostly;
244d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
245d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
246d320c038STejun Heo EXPORT_SYMBOL_GPL(system_nrt_wq);
247f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
248d320c038STejun Heo 
249db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
250db7bccf4STejun Heo 	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
251db7bccf4STejun Heo 		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
252db7bccf4STejun Heo 
253f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
254f3421797STejun Heo 				  unsigned int sw)
255f3421797STejun Heo {
256f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
257f3421797STejun Heo 		if (sw & 1) {
258f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
259f3421797STejun Heo 			if (cpu < nr_cpu_ids)
260f3421797STejun Heo 				return cpu;
261f3421797STejun Heo 		}
262f3421797STejun Heo 		if (sw & 2)
263f3421797STejun Heo 			return WORK_CPU_UNBOUND;
264f3421797STejun Heo 	}
265f3421797STejun Heo 	return WORK_CPU_NONE;
266f3421797STejun Heo }
267f3421797STejun Heo 
268f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
269f3421797STejun Heo 				struct workqueue_struct *wq)
270f3421797STejun Heo {
271f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
272f3421797STejun Heo }
273f3421797STejun Heo 
274f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
275f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
276f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
277f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
278f3421797STejun Heo 
279f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
280f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
281f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
282f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
283f3421797STejun Heo 
284f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
285f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
286f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
287f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
288f3421797STejun Heo 
289dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
290dc186ad7SThomas Gleixner 
291dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
292dc186ad7SThomas Gleixner 
293dc186ad7SThomas Gleixner /*
294dc186ad7SThomas Gleixner  * fixup_init is called when:
295dc186ad7SThomas Gleixner  * - an active object is initialized
296dc186ad7SThomas Gleixner  */
297dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
298dc186ad7SThomas Gleixner {
299dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
300dc186ad7SThomas Gleixner 
301dc186ad7SThomas Gleixner 	switch (state) {
302dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
303dc186ad7SThomas Gleixner 		cancel_work_sync(work);
304dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
305dc186ad7SThomas Gleixner 		return 1;
306dc186ad7SThomas Gleixner 	default:
307dc186ad7SThomas Gleixner 		return 0;
308dc186ad7SThomas Gleixner 	}
309dc186ad7SThomas Gleixner }
310dc186ad7SThomas Gleixner 
311dc186ad7SThomas Gleixner /*
312dc186ad7SThomas Gleixner  * fixup_activate is called when:
313dc186ad7SThomas Gleixner  * - an active object is activated
314dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
315dc186ad7SThomas Gleixner  */
316dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
317dc186ad7SThomas Gleixner {
318dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
319dc186ad7SThomas Gleixner 
320dc186ad7SThomas Gleixner 	switch (state) {
321dc186ad7SThomas Gleixner 
322dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
323dc186ad7SThomas Gleixner 		/*
324dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
325dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
326dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
327dc186ad7SThomas Gleixner 		 */
32822df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
329dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
330dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
331dc186ad7SThomas Gleixner 			return 0;
332dc186ad7SThomas Gleixner 		}
333dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
334dc186ad7SThomas Gleixner 		return 0;
335dc186ad7SThomas Gleixner 
336dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
337dc186ad7SThomas Gleixner 		WARN_ON(1);
338dc186ad7SThomas Gleixner 
339dc186ad7SThomas Gleixner 	default:
340dc186ad7SThomas Gleixner 		return 0;
341dc186ad7SThomas Gleixner 	}
342dc186ad7SThomas Gleixner }
343dc186ad7SThomas Gleixner 
344dc186ad7SThomas Gleixner /*
345dc186ad7SThomas Gleixner  * fixup_free is called when:
346dc186ad7SThomas Gleixner  * - an active object is freed
347dc186ad7SThomas Gleixner  */
348dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
349dc186ad7SThomas Gleixner {
350dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
351dc186ad7SThomas Gleixner 
352dc186ad7SThomas Gleixner 	switch (state) {
353dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
354dc186ad7SThomas Gleixner 		cancel_work_sync(work);
355dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
356dc186ad7SThomas Gleixner 		return 1;
357dc186ad7SThomas Gleixner 	default:
358dc186ad7SThomas Gleixner 		return 0;
359dc186ad7SThomas Gleixner 	}
360dc186ad7SThomas Gleixner }
361dc186ad7SThomas Gleixner 
362dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
363dc186ad7SThomas Gleixner 	.name		= "work_struct",
364dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
365dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
366dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
367dc186ad7SThomas Gleixner };
368dc186ad7SThomas Gleixner 
369dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
370dc186ad7SThomas Gleixner {
371dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
372dc186ad7SThomas Gleixner }
373dc186ad7SThomas Gleixner 
374dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
375dc186ad7SThomas Gleixner {
376dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
377dc186ad7SThomas Gleixner }
378dc186ad7SThomas Gleixner 
379dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
380dc186ad7SThomas Gleixner {
381dc186ad7SThomas Gleixner 	if (onstack)
382dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
383dc186ad7SThomas Gleixner 	else
384dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
385dc186ad7SThomas Gleixner }
386dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
387dc186ad7SThomas Gleixner 
388dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
389dc186ad7SThomas Gleixner {
390dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
391dc186ad7SThomas Gleixner }
392dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
393dc186ad7SThomas Gleixner 
394dc186ad7SThomas Gleixner #else
395dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
396dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
397dc186ad7SThomas Gleixner #endif
398dc186ad7SThomas Gleixner 
39995402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
40095402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4011da177e4SLinus Torvalds static LIST_HEAD(workqueues);
402a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
403c34056a3STejun Heo 
404e22bee78STejun Heo /*
405e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
406e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
407e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
408e22bee78STejun Heo  */
4098b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
410e22bee78STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
4118b03ae3cSTejun Heo 
412f3421797STejun Heo /*
413f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
414f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
415f3421797STejun Heo  * workers have WORKER_UNBOUND set.
416f3421797STejun Heo  */
417f3421797STejun Heo static struct global_cwq unbound_global_cwq;
418f3421797STejun Heo static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0);	/* always 0 */
419f3421797STejun Heo 
420c34056a3STejun Heo static int worker_thread(void *__worker);
4211da177e4SLinus Torvalds 
4228b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
4238b03ae3cSTejun Heo {
424f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
4258b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
426f3421797STejun Heo 	else
427f3421797STejun Heo 		return &unbound_global_cwq;
4288b03ae3cSTejun Heo }
4298b03ae3cSTejun Heo 
430e22bee78STejun Heo static atomic_t *get_gcwq_nr_running(unsigned int cpu)
431e22bee78STejun Heo {
432f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
433e22bee78STejun Heo 		return &per_cpu(gcwq_nr_running, cpu);
434f3421797STejun Heo 	else
435f3421797STejun Heo 		return &unbound_gcwq_nr_running;
436e22bee78STejun Heo }
437e22bee78STejun Heo 
4384690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
4394690c4abSTejun Heo 					    struct workqueue_struct *wq)
440a848e3b6SOleg Nesterov {
441f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
442f3421797STejun Heo 		if (likely(cpu < nr_cpu_ids)) {
443f3421797STejun Heo #ifdef CONFIG_SMP
444bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
445f3421797STejun Heo #else
446f3421797STejun Heo 			return wq->cpu_wq.single;
447bdbc5dd7STejun Heo #endif
448a848e3b6SOleg Nesterov 		}
449f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
450f3421797STejun Heo 		return wq->cpu_wq.single;
451f3421797STejun Heo 	return NULL;
452f3421797STejun Heo }
453a848e3b6SOleg Nesterov 
45473f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
45573f53c4aSTejun Heo {
45673f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
45773f53c4aSTejun Heo }
45873f53c4aSTejun Heo 
45973f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
46073f53c4aSTejun Heo {
46173f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
46273f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
46373f53c4aSTejun Heo }
46473f53c4aSTejun Heo 
46573f53c4aSTejun Heo static int work_next_color(int color)
46673f53c4aSTejun Heo {
46773f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
46873f53c4aSTejun Heo }
46973f53c4aSTejun Heo 
4704594bf15SDavid Howells /*
4717a22ad75STejun Heo  * Work data points to the cwq while a work is on queue.  Once
4727a22ad75STejun Heo  * execution starts, it points to the cpu the work was last on.  This
4737a22ad75STejun Heo  * can be distinguished by comparing the data value against
4747a22ad75STejun Heo  * PAGE_OFFSET.
4757a22ad75STejun Heo  *
4767a22ad75STejun Heo  * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
4777a22ad75STejun Heo  * cwq, cpu or clear work->data.  These functions should only be
4787a22ad75STejun Heo  * called while the work is owned - ie. while the PENDING bit is set.
4797a22ad75STejun Heo  *
4807a22ad75STejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq
4817a22ad75STejun Heo  * corresponding to a work.  gcwq is available once the work has been
4827a22ad75STejun Heo  * queued anywhere after initialization.  cwq is available only from
4837a22ad75STejun Heo  * queueing until execution starts.
4844594bf15SDavid Howells  */
4857a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
4867a22ad75STejun Heo 				 unsigned long flags)
4877a22ad75STejun Heo {
4887a22ad75STejun Heo 	BUG_ON(!work_pending(work));
4897a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
4907a22ad75STejun Heo }
4917a22ad75STejun Heo 
4927a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
4934690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
4944690c4abSTejun Heo 			 unsigned long extra_flags)
495365970a1SDavid Howells {
4967a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
49722df02bbSTejun Heo 		      WORK_STRUCT_PENDING | extra_flags);
498365970a1SDavid Howells }
499365970a1SDavid Howells 
5007a22ad75STejun Heo static void set_work_cpu(struct work_struct *work, unsigned int cpu)
5014d707b9fSOleg Nesterov {
5027a22ad75STejun Heo 	set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
5034d707b9fSOleg Nesterov }
5044d707b9fSOleg Nesterov 
5057a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
506365970a1SDavid Howells {
5077a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5087a22ad75STejun Heo }
5097a22ad75STejun Heo 
5107a22ad75STejun Heo static inline unsigned long get_work_data(struct work_struct *work)
5117a22ad75STejun Heo {
5127a22ad75STejun Heo 	return atomic_long_read(&work->data) & WORK_STRUCT_WQ_DATA_MASK;
5137a22ad75STejun Heo }
5147a22ad75STejun Heo 
5157a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5167a22ad75STejun Heo {
5177a22ad75STejun Heo 	unsigned long data = get_work_data(work);
5187a22ad75STejun Heo 
5197a22ad75STejun Heo 	return data >= PAGE_OFFSET ? (void *)data : NULL;
5207a22ad75STejun Heo }
5217a22ad75STejun Heo 
5227a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5237a22ad75STejun Heo {
5247a22ad75STejun Heo 	unsigned long data = get_work_data(work);
5257a22ad75STejun Heo 	unsigned int cpu;
5267a22ad75STejun Heo 
5277a22ad75STejun Heo 	if (data >= PAGE_OFFSET)
5287a22ad75STejun Heo 		return ((struct cpu_workqueue_struct *)data)->gcwq;
5297a22ad75STejun Heo 
5307a22ad75STejun Heo 	cpu = data >> WORK_STRUCT_FLAG_BITS;
531bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
5327a22ad75STejun Heo 		return NULL;
5337a22ad75STejun Heo 
534f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
5357a22ad75STejun Heo 	return get_gcwq(cpu);
536365970a1SDavid Howells }
537365970a1SDavid Howells 
538e22bee78STejun Heo /*
539e22bee78STejun Heo  * Policy functions.  These define the policies on how the global
540e22bee78STejun Heo  * worker pool is managed.  Unless noted otherwise, these functions
541e22bee78STejun Heo  * assume that they're being called with gcwq->lock held.
542e22bee78STejun Heo  */
543e22bee78STejun Heo 
544649027d7STejun Heo static bool __need_more_worker(struct global_cwq *gcwq)
545649027d7STejun Heo {
546649027d7STejun Heo 	return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
547649027d7STejun Heo 		gcwq->flags & GCWQ_HIGHPRI_PENDING;
548649027d7STejun Heo }
549649027d7STejun Heo 
550e22bee78STejun Heo /*
551e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
552e22bee78STejun Heo  * running workers.
553e22bee78STejun Heo  */
554e22bee78STejun Heo static bool need_more_worker(struct global_cwq *gcwq)
555e22bee78STejun Heo {
556649027d7STejun Heo 	return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
557e22bee78STejun Heo }
558e22bee78STejun Heo 
559e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
560e22bee78STejun Heo static bool may_start_working(struct global_cwq *gcwq)
561e22bee78STejun Heo {
562e22bee78STejun Heo 	return gcwq->nr_idle;
563e22bee78STejun Heo }
564e22bee78STejun Heo 
565e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
566e22bee78STejun Heo static bool keep_working(struct global_cwq *gcwq)
567e22bee78STejun Heo {
568e22bee78STejun Heo 	atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
569e22bee78STejun Heo 
570e22bee78STejun Heo 	return !list_empty(&gcwq->worklist) && atomic_read(nr_running) <= 1;
571e22bee78STejun Heo }
572e22bee78STejun Heo 
573e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
574e22bee78STejun Heo static bool need_to_create_worker(struct global_cwq *gcwq)
575e22bee78STejun Heo {
576e22bee78STejun Heo 	return need_more_worker(gcwq) && !may_start_working(gcwq);
577e22bee78STejun Heo }
578e22bee78STejun Heo 
579e22bee78STejun Heo /* Do I need to be the manager? */
580e22bee78STejun Heo static bool need_to_manage_workers(struct global_cwq *gcwq)
581e22bee78STejun Heo {
582e22bee78STejun Heo 	return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
583e22bee78STejun Heo }
584e22bee78STejun Heo 
585e22bee78STejun Heo /* Do we have too many workers and should some go away? */
586e22bee78STejun Heo static bool too_many_workers(struct global_cwq *gcwq)
587e22bee78STejun Heo {
588e22bee78STejun Heo 	bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
589e22bee78STejun Heo 	int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
590e22bee78STejun Heo 	int nr_busy = gcwq->nr_workers - nr_idle;
591e22bee78STejun Heo 
592e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
593e22bee78STejun Heo }
594e22bee78STejun Heo 
595e22bee78STejun Heo /*
596e22bee78STejun Heo  * Wake up functions.
597e22bee78STejun Heo  */
598e22bee78STejun Heo 
5997e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
6007e11629dSTejun Heo static struct worker *first_worker(struct global_cwq *gcwq)
6017e11629dSTejun Heo {
6027e11629dSTejun Heo 	if (unlikely(list_empty(&gcwq->idle_list)))
6037e11629dSTejun Heo 		return NULL;
6047e11629dSTejun Heo 
6057e11629dSTejun Heo 	return list_first_entry(&gcwq->idle_list, struct worker, entry);
6067e11629dSTejun Heo }
6077e11629dSTejun Heo 
6087e11629dSTejun Heo /**
6097e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
6107e11629dSTejun Heo  * @gcwq: gcwq to wake worker for
6117e11629dSTejun Heo  *
6127e11629dSTejun Heo  * Wake up the first idle worker of @gcwq.
6137e11629dSTejun Heo  *
6147e11629dSTejun Heo  * CONTEXT:
6157e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
6167e11629dSTejun Heo  */
6177e11629dSTejun Heo static void wake_up_worker(struct global_cwq *gcwq)
6187e11629dSTejun Heo {
6197e11629dSTejun Heo 	struct worker *worker = first_worker(gcwq);
6207e11629dSTejun Heo 
6217e11629dSTejun Heo 	if (likely(worker))
6227e11629dSTejun Heo 		wake_up_process(worker->task);
6237e11629dSTejun Heo }
6247e11629dSTejun Heo 
6254690c4abSTejun Heo /**
626e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
627e22bee78STejun Heo  * @task: task waking up
628e22bee78STejun Heo  * @cpu: CPU @task is waking up to
629e22bee78STejun Heo  *
630e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
631e22bee78STejun Heo  * being awoken.
632e22bee78STejun Heo  *
633e22bee78STejun Heo  * CONTEXT:
634e22bee78STejun Heo  * spin_lock_irq(rq->lock)
635e22bee78STejun Heo  */
636e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
637e22bee78STejun Heo {
638e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
639e22bee78STejun Heo 
640e22bee78STejun Heo 	if (likely(!(worker->flags & WORKER_NOT_RUNNING)))
641e22bee78STejun Heo 		atomic_inc(get_gcwq_nr_running(cpu));
642e22bee78STejun Heo }
643e22bee78STejun Heo 
644e22bee78STejun Heo /**
645e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
646e22bee78STejun Heo  * @task: task going to sleep
647e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
648e22bee78STejun Heo  *
649e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
650e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
651e22bee78STejun Heo  * returning pointer to its task.
652e22bee78STejun Heo  *
653e22bee78STejun Heo  * CONTEXT:
654e22bee78STejun Heo  * spin_lock_irq(rq->lock)
655e22bee78STejun Heo  *
656e22bee78STejun Heo  * RETURNS:
657e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
658e22bee78STejun Heo  */
659e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
660e22bee78STejun Heo 				       unsigned int cpu)
661e22bee78STejun Heo {
662e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
663e22bee78STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
664e22bee78STejun Heo 	atomic_t *nr_running = get_gcwq_nr_running(cpu);
665e22bee78STejun Heo 
666e22bee78STejun Heo 	if (unlikely(worker->flags & WORKER_NOT_RUNNING))
667e22bee78STejun Heo 		return NULL;
668e22bee78STejun Heo 
669e22bee78STejun Heo 	/* this can only happen on the local cpu */
670e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
671e22bee78STejun Heo 
672e22bee78STejun Heo 	/*
673e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
674e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
675e22bee78STejun Heo 	 * Please read comment there.
676e22bee78STejun Heo 	 *
677e22bee78STejun Heo 	 * NOT_RUNNING is clear.  This means that trustee is not in
678e22bee78STejun Heo 	 * charge and we're running on the local cpu w/ rq lock held
679e22bee78STejun Heo 	 * and preemption disabled, which in turn means that none else
680e22bee78STejun Heo 	 * could be manipulating idle_list, so dereferencing idle_list
681e22bee78STejun Heo 	 * without gcwq lock is safe.
682e22bee78STejun Heo 	 */
683e22bee78STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
684e22bee78STejun Heo 		to_wakeup = first_worker(gcwq);
685e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
686e22bee78STejun Heo }
687e22bee78STejun Heo 
688e22bee78STejun Heo /**
689e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
690cb444766STejun Heo  * @worker: self
691d302f017STejun Heo  * @flags: flags to set
692d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
693d302f017STejun Heo  *
694e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
695e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
696e22bee78STejun Heo  * woken up.
697d302f017STejun Heo  *
698cb444766STejun Heo  * CONTEXT:
699cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
700d302f017STejun Heo  */
701d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
702d302f017STejun Heo 				    bool wakeup)
703d302f017STejun Heo {
704e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
705e22bee78STejun Heo 
706cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
707cb444766STejun Heo 
708e22bee78STejun Heo 	/*
709e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
710e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
711e22bee78STejun Heo 	 * @wakeup.
712e22bee78STejun Heo 	 */
713e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
714e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
715e22bee78STejun Heo 		atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
716e22bee78STejun Heo 
717e22bee78STejun Heo 		if (wakeup) {
718e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
719e22bee78STejun Heo 			    !list_empty(&gcwq->worklist))
720e22bee78STejun Heo 				wake_up_worker(gcwq);
721e22bee78STejun Heo 		} else
722e22bee78STejun Heo 			atomic_dec(nr_running);
723e22bee78STejun Heo 	}
724e22bee78STejun Heo 
725d302f017STejun Heo 	worker->flags |= flags;
726d302f017STejun Heo }
727d302f017STejun Heo 
728d302f017STejun Heo /**
729e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
730cb444766STejun Heo  * @worker: self
731d302f017STejun Heo  * @flags: flags to clear
732d302f017STejun Heo  *
733e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
734d302f017STejun Heo  *
735cb444766STejun Heo  * CONTEXT:
736cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
737d302f017STejun Heo  */
738d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
739d302f017STejun Heo {
740e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
741e22bee78STejun Heo 	unsigned int oflags = worker->flags;
742e22bee78STejun Heo 
743cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
744cb444766STejun Heo 
745d302f017STejun Heo 	worker->flags &= ~flags;
746e22bee78STejun Heo 
747e22bee78STejun Heo 	/* if transitioning out of NOT_RUNNING, increment nr_running */
748e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
749e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
750e22bee78STejun Heo 			atomic_inc(get_gcwq_nr_running(gcwq->cpu));
751d302f017STejun Heo }
752d302f017STejun Heo 
753d302f017STejun Heo /**
754c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
755c8e55f36STejun Heo  * @gcwq: gcwq of interest
756c8e55f36STejun Heo  * @work: work to be hashed
757c8e55f36STejun Heo  *
758c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
759c8e55f36STejun Heo  *
760c8e55f36STejun Heo  * CONTEXT:
761c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
762c8e55f36STejun Heo  *
763c8e55f36STejun Heo  * RETURNS:
764c8e55f36STejun Heo  * Pointer to the hash head.
765c8e55f36STejun Heo  */
766c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
767c8e55f36STejun Heo 					   struct work_struct *work)
768c8e55f36STejun Heo {
769c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
770c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
771c8e55f36STejun Heo 
772c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
773c8e55f36STejun Heo 	v >>= base_shift;
774c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
775c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
776c8e55f36STejun Heo 
777c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
778c8e55f36STejun Heo }
779c8e55f36STejun Heo 
780c8e55f36STejun Heo /**
7818cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
7828cca0eeaSTejun Heo  * @gcwq: gcwq of interest
7838cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
7848cca0eeaSTejun Heo  * @work: work to find worker for
7858cca0eeaSTejun Heo  *
7868cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
7878cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
7888cca0eeaSTejun Heo  * work.
7898cca0eeaSTejun Heo  *
7908cca0eeaSTejun Heo  * CONTEXT:
7918cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
7928cca0eeaSTejun Heo  *
7938cca0eeaSTejun Heo  * RETURNS:
7948cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
7958cca0eeaSTejun Heo  * otherwise.
7968cca0eeaSTejun Heo  */
7978cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
7988cca0eeaSTejun Heo 						   struct hlist_head *bwh,
7998cca0eeaSTejun Heo 						   struct work_struct *work)
8008cca0eeaSTejun Heo {
8018cca0eeaSTejun Heo 	struct worker *worker;
8028cca0eeaSTejun Heo 	struct hlist_node *tmp;
8038cca0eeaSTejun Heo 
8048cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
8058cca0eeaSTejun Heo 		if (worker->current_work == work)
8068cca0eeaSTejun Heo 			return worker;
8078cca0eeaSTejun Heo 	return NULL;
8088cca0eeaSTejun Heo }
8098cca0eeaSTejun Heo 
8108cca0eeaSTejun Heo /**
8118cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8128cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8138cca0eeaSTejun Heo  * @work: work to find worker for
8148cca0eeaSTejun Heo  *
8158cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
8168cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
8178cca0eeaSTejun Heo  * function calculates @bwh itself.
8188cca0eeaSTejun Heo  *
8198cca0eeaSTejun Heo  * CONTEXT:
8208cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8218cca0eeaSTejun Heo  *
8228cca0eeaSTejun Heo  * RETURNS:
8238cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8248cca0eeaSTejun Heo  * otherwise.
8258cca0eeaSTejun Heo  */
8268cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
8278cca0eeaSTejun Heo 						 struct work_struct *work)
8288cca0eeaSTejun Heo {
8298cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
8308cca0eeaSTejun Heo 					    work);
8318cca0eeaSTejun Heo }
8328cca0eeaSTejun Heo 
8338cca0eeaSTejun Heo /**
834649027d7STejun Heo  * gcwq_determine_ins_pos - find insertion position
835649027d7STejun Heo  * @gcwq: gcwq of interest
836649027d7STejun Heo  * @cwq: cwq a work is being queued for
837649027d7STejun Heo  *
838649027d7STejun Heo  * A work for @cwq is about to be queued on @gcwq, determine insertion
839649027d7STejun Heo  * position for the work.  If @cwq is for HIGHPRI wq, the work is
840649027d7STejun Heo  * queued at the head of the queue but in FIFO order with respect to
841649027d7STejun Heo  * other HIGHPRI works; otherwise, at the end of the queue.  This
842649027d7STejun Heo  * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
843649027d7STejun Heo  * there are HIGHPRI works pending.
844649027d7STejun Heo  *
845649027d7STejun Heo  * CONTEXT:
846649027d7STejun Heo  * spin_lock_irq(gcwq->lock).
847649027d7STejun Heo  *
848649027d7STejun Heo  * RETURNS:
849649027d7STejun Heo  * Pointer to inserstion position.
850649027d7STejun Heo  */
851649027d7STejun Heo static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
852649027d7STejun Heo 					       struct cpu_workqueue_struct *cwq)
853649027d7STejun Heo {
854649027d7STejun Heo 	struct work_struct *twork;
855649027d7STejun Heo 
856649027d7STejun Heo 	if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
857649027d7STejun Heo 		return &gcwq->worklist;
858649027d7STejun Heo 
859649027d7STejun Heo 	list_for_each_entry(twork, &gcwq->worklist, entry) {
860649027d7STejun Heo 		struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
861649027d7STejun Heo 
862649027d7STejun Heo 		if (!(tcwq->wq->flags & WQ_HIGHPRI))
863649027d7STejun Heo 			break;
864649027d7STejun Heo 	}
865649027d7STejun Heo 
866649027d7STejun Heo 	gcwq->flags |= GCWQ_HIGHPRI_PENDING;
867649027d7STejun Heo 	return &twork->entry;
868649027d7STejun Heo }
869649027d7STejun Heo 
870649027d7STejun Heo /**
8717e11629dSTejun Heo  * insert_work - insert a work into gcwq
8724690c4abSTejun Heo  * @cwq: cwq @work belongs to
8734690c4abSTejun Heo  * @work: work to insert
8744690c4abSTejun Heo  * @head: insertion point
8754690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
8764690c4abSTejun Heo  *
8777e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
8787e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
8794690c4abSTejun Heo  *
8804690c4abSTejun Heo  * CONTEXT:
8818b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
8824690c4abSTejun Heo  */
883b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
8844690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
8854690c4abSTejun Heo 			unsigned int extra_flags)
886b89deed3SOleg Nesterov {
887e22bee78STejun Heo 	struct global_cwq *gcwq = cwq->gcwq;
888e22bee78STejun Heo 
8894690c4abSTejun Heo 	/* we own @work, set data and link */
8907a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
8914690c4abSTejun Heo 
8926e84d644SOleg Nesterov 	/*
8936e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
8946e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
8956e84d644SOleg Nesterov 	 */
8966e84d644SOleg Nesterov 	smp_wmb();
8974690c4abSTejun Heo 
8981a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
899e22bee78STejun Heo 
900e22bee78STejun Heo 	/*
901e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
902e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
903e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
904e22bee78STejun Heo 	 */
905e22bee78STejun Heo 	smp_mb();
906e22bee78STejun Heo 
907649027d7STejun Heo 	if (__need_more_worker(gcwq))
908e22bee78STejun Heo 		wake_up_worker(gcwq);
909b89deed3SOleg Nesterov }
910b89deed3SOleg Nesterov 
9114690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
9121da177e4SLinus Torvalds 			 struct work_struct *work)
9131da177e4SLinus Torvalds {
914502ca9d8STejun Heo 	struct global_cwq *gcwq;
915502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
9161e19ffc6STejun Heo 	struct list_head *worklist;
9171da177e4SLinus Torvalds 	unsigned long flags;
9181da177e4SLinus Torvalds 
919dc186ad7SThomas Gleixner 	debug_work_activate(work);
9201e19ffc6STejun Heo 
921c7fc77f7STejun Heo 	/* determine gcwq to use */
922c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
923c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
924c7fc77f7STejun Heo 
925f3421797STejun Heo 		if (unlikely(cpu == WORK_CPU_UNBOUND))
926f3421797STejun Heo 			cpu = raw_smp_processor_id();
927f3421797STejun Heo 
92818aa9effSTejun Heo 		/*
92918aa9effSTejun Heo 		 * It's multi cpu.  If @wq is non-reentrant and @work
93018aa9effSTejun Heo 		 * was previously on a different cpu, it might still
93118aa9effSTejun Heo 		 * be running there, in which case the work needs to
93218aa9effSTejun Heo 		 * be queued on that cpu to guarantee non-reentrance.
93318aa9effSTejun Heo 		 */
934502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
93518aa9effSTejun Heo 		if (wq->flags & WQ_NON_REENTRANT &&
93618aa9effSTejun Heo 		    (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
93718aa9effSTejun Heo 			struct worker *worker;
93818aa9effSTejun Heo 
93918aa9effSTejun Heo 			spin_lock_irqsave(&last_gcwq->lock, flags);
94018aa9effSTejun Heo 
94118aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
94218aa9effSTejun Heo 
94318aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
94418aa9effSTejun Heo 				gcwq = last_gcwq;
94518aa9effSTejun Heo 			else {
94618aa9effSTejun Heo 				/* meh... not running there, queue here */
94718aa9effSTejun Heo 				spin_unlock_irqrestore(&last_gcwq->lock, flags);
94818aa9effSTejun Heo 				spin_lock_irqsave(&gcwq->lock, flags);
94918aa9effSTejun Heo 			}
95018aa9effSTejun Heo 		} else
9518b03ae3cSTejun Heo 			spin_lock_irqsave(&gcwq->lock, flags);
952f3421797STejun Heo 	} else {
953f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
954f3421797STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
955502ca9d8STejun Heo 	}
956502ca9d8STejun Heo 
957502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
958502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
959502ca9d8STejun Heo 
9604690c4abSTejun Heo 	BUG_ON(!list_empty(&work->entry));
9611e19ffc6STejun Heo 
96273f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
9631e19ffc6STejun Heo 
9641e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
9651e19ffc6STejun Heo 		cwq->nr_active++;
966649027d7STejun Heo 		worklist = gcwq_determine_ins_pos(gcwq, cwq);
9671e19ffc6STejun Heo 	} else
9681e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
9691e19ffc6STejun Heo 
9701e19ffc6STejun Heo 	insert_work(cwq, work, worklist, work_color_to_flags(cwq->work_color));
9711e19ffc6STejun Heo 
9728b03ae3cSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
9731da177e4SLinus Torvalds }
9741da177e4SLinus Torvalds 
9750fcb78c2SRolf Eike Beer /**
9760fcb78c2SRolf Eike Beer  * queue_work - queue work on a workqueue
9770fcb78c2SRolf Eike Beer  * @wq: workqueue to use
9780fcb78c2SRolf Eike Beer  * @work: work to queue
9790fcb78c2SRolf Eike Beer  *
980057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
9811da177e4SLinus Torvalds  *
98200dfcaf7SOleg Nesterov  * We queue the work to the CPU on which it was submitted, but if the CPU dies
98300dfcaf7SOleg Nesterov  * it can be processed by another CPU.
9841da177e4SLinus Torvalds  */
9857ad5b3a5SHarvey Harrison int queue_work(struct workqueue_struct *wq, struct work_struct *work)
9861da177e4SLinus Torvalds {
987ef1ca236SOleg Nesterov 	int ret;
9881da177e4SLinus Torvalds 
989ef1ca236SOleg Nesterov 	ret = queue_work_on(get_cpu(), wq, work);
990a848e3b6SOleg Nesterov 	put_cpu();
991ef1ca236SOleg Nesterov 
9921da177e4SLinus Torvalds 	return ret;
9931da177e4SLinus Torvalds }
994ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_work);
9951da177e4SLinus Torvalds 
996c1a220e7SZhang Rui /**
997c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
998c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
999c1a220e7SZhang Rui  * @wq: workqueue to use
1000c1a220e7SZhang Rui  * @work: work to queue
1001c1a220e7SZhang Rui  *
1002c1a220e7SZhang Rui  * Returns 0 if @work was already on a queue, non-zero otherwise.
1003c1a220e7SZhang Rui  *
1004c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1005c1a220e7SZhang Rui  * can't go away.
1006c1a220e7SZhang Rui  */
1007c1a220e7SZhang Rui int
1008c1a220e7SZhang Rui queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1009c1a220e7SZhang Rui {
1010c1a220e7SZhang Rui 	int ret = 0;
1011c1a220e7SZhang Rui 
101222df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
10134690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1014c1a220e7SZhang Rui 		ret = 1;
1015c1a220e7SZhang Rui 	}
1016c1a220e7SZhang Rui 	return ret;
1017c1a220e7SZhang Rui }
1018c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1019c1a220e7SZhang Rui 
10206d141c3fSLi Zefan static void delayed_work_timer_fn(unsigned long __data)
10211da177e4SLinus Torvalds {
102252bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
10237a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
10241da177e4SLinus Torvalds 
10254690c4abSTejun Heo 	__queue_work(smp_processor_id(), cwq->wq, &dwork->work);
10261da177e4SLinus Torvalds }
10271da177e4SLinus Torvalds 
10280fcb78c2SRolf Eike Beer /**
10290fcb78c2SRolf Eike Beer  * queue_delayed_work - queue work on a workqueue after delay
10300fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1031af9997e4SRandy Dunlap  * @dwork: delayable work to queue
10320fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
10330fcb78c2SRolf Eike Beer  *
1034057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
10350fcb78c2SRolf Eike Beer  */
10367ad5b3a5SHarvey Harrison int queue_delayed_work(struct workqueue_struct *wq,
103752bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
10381da177e4SLinus Torvalds {
103952bad64dSDavid Howells 	if (delay == 0)
104063bc0362SOleg Nesterov 		return queue_work(wq, &dwork->work);
10411da177e4SLinus Torvalds 
104263bc0362SOleg Nesterov 	return queue_delayed_work_on(-1, wq, dwork, delay);
10431da177e4SLinus Torvalds }
1044ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work);
10451da177e4SLinus Torvalds 
10460fcb78c2SRolf Eike Beer /**
10470fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
10480fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
10490fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1050af9997e4SRandy Dunlap  * @dwork: work to queue
10510fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
10520fcb78c2SRolf Eike Beer  *
1053057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
10540fcb78c2SRolf Eike Beer  */
10557a6bc1cdSVenkatesh Pallipadi int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
105652bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
10577a6bc1cdSVenkatesh Pallipadi {
10587a6bc1cdSVenkatesh Pallipadi 	int ret = 0;
105952bad64dSDavid Howells 	struct timer_list *timer = &dwork->timer;
106052bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
10617a6bc1cdSVenkatesh Pallipadi 
106222df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1063c7fc77f7STejun Heo 		unsigned int lcpu;
10647a22ad75STejun Heo 
10657a6bc1cdSVenkatesh Pallipadi 		BUG_ON(timer_pending(timer));
10667a6bc1cdSVenkatesh Pallipadi 		BUG_ON(!list_empty(&work->entry));
10677a6bc1cdSVenkatesh Pallipadi 
10688a3e77ccSAndrew Liu 		timer_stats_timer_set_start_info(&dwork->timer);
1069c7fc77f7STejun Heo 
10707a22ad75STejun Heo 		/*
10717a22ad75STejun Heo 		 * This stores cwq for the moment, for the timer_fn.
10727a22ad75STejun Heo 		 * Note that the work's gcwq is preserved to allow
10737a22ad75STejun Heo 		 * reentrance detection for delayed works.
10747a22ad75STejun Heo 		 */
1075c7fc77f7STejun Heo 		if (!(wq->flags & WQ_UNBOUND)) {
1076c7fc77f7STejun Heo 			struct global_cwq *gcwq = get_work_gcwq(work);
1077c7fc77f7STejun Heo 
1078c7fc77f7STejun Heo 			if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1079c7fc77f7STejun Heo 				lcpu = gcwq->cpu;
1080c7fc77f7STejun Heo 			else
1081c7fc77f7STejun Heo 				lcpu = raw_smp_processor_id();
1082c7fc77f7STejun Heo 		} else
1083c7fc77f7STejun Heo 			lcpu = WORK_CPU_UNBOUND;
1084c7fc77f7STejun Heo 
10857a22ad75STejun Heo 		set_work_cwq(work, get_cwq(lcpu, wq), 0);
1086c7fc77f7STejun Heo 
10877a6bc1cdSVenkatesh Pallipadi 		timer->expires = jiffies + delay;
108852bad64dSDavid Howells 		timer->data = (unsigned long)dwork;
10897a6bc1cdSVenkatesh Pallipadi 		timer->function = delayed_work_timer_fn;
109063bc0362SOleg Nesterov 
109163bc0362SOleg Nesterov 		if (unlikely(cpu >= 0))
10927a6bc1cdSVenkatesh Pallipadi 			add_timer_on(timer, cpu);
109363bc0362SOleg Nesterov 		else
109463bc0362SOleg Nesterov 			add_timer(timer);
10957a6bc1cdSVenkatesh Pallipadi 		ret = 1;
10967a6bc1cdSVenkatesh Pallipadi 	}
10977a6bc1cdSVenkatesh Pallipadi 	return ret;
10987a6bc1cdSVenkatesh Pallipadi }
1099ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
11001da177e4SLinus Torvalds 
1101c8e55f36STejun Heo /**
1102c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1103c8e55f36STejun Heo  * @worker: worker which is entering idle state
1104c8e55f36STejun Heo  *
1105c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1106c8e55f36STejun Heo  * necessary.
1107c8e55f36STejun Heo  *
1108c8e55f36STejun Heo  * LOCKING:
1109c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1110c8e55f36STejun Heo  */
1111c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
1112c8e55f36STejun Heo {
1113c8e55f36STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1114c8e55f36STejun Heo 
1115c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1116c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1117c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1118c8e55f36STejun Heo 
1119cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1120cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1121c8e55f36STejun Heo 	gcwq->nr_idle++;
1122e22bee78STejun Heo 	worker->last_active = jiffies;
1123c8e55f36STejun Heo 
1124c8e55f36STejun Heo 	/* idle_list is LIFO */
1125c8e55f36STejun Heo 	list_add(&worker->entry, &gcwq->idle_list);
1126db7bccf4STejun Heo 
1127e22bee78STejun Heo 	if (likely(!(worker->flags & WORKER_ROGUE))) {
1128e22bee78STejun Heo 		if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1129e22bee78STejun Heo 			mod_timer(&gcwq->idle_timer,
1130e22bee78STejun Heo 				  jiffies + IDLE_WORKER_TIMEOUT);
1131e22bee78STejun Heo 	} else
1132db7bccf4STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1133cb444766STejun Heo 
1134cb444766STejun Heo 	/* sanity check nr_running */
1135cb444766STejun Heo 	WARN_ON_ONCE(gcwq->nr_workers == gcwq->nr_idle &&
1136cb444766STejun Heo 		     atomic_read(get_gcwq_nr_running(gcwq->cpu)));
1137c8e55f36STejun Heo }
1138c8e55f36STejun Heo 
1139c8e55f36STejun Heo /**
1140c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1141c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1142c8e55f36STejun Heo  *
1143c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1144c8e55f36STejun Heo  *
1145c8e55f36STejun Heo  * LOCKING:
1146c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1147c8e55f36STejun Heo  */
1148c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1149c8e55f36STejun Heo {
1150c8e55f36STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1151c8e55f36STejun Heo 
1152c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1153d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1154c8e55f36STejun Heo 	gcwq->nr_idle--;
1155c8e55f36STejun Heo 	list_del_init(&worker->entry);
1156c8e55f36STejun Heo }
1157c8e55f36STejun Heo 
1158e22bee78STejun Heo /**
1159e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1160e22bee78STejun Heo  * @worker: self
1161e22bee78STejun Heo  *
1162e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1163e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1164e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1165e22bee78STejun Heo  * guaranteed to execute on the cpu.
1166e22bee78STejun Heo  *
1167e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1168e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1169e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1170e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1171e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1172e22bee78STejun Heo  * [dis]associated in the meantime.
1173e22bee78STejun Heo  *
1174e22bee78STejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies
1175e22bee78STejun Heo  * the binding against GCWQ_DISASSOCIATED which is set during
1176e22bee78STejun Heo  * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1177e22bee78STejun Heo  * idle state or fetches works without dropping lock, it can guarantee
1178e22bee78STejun Heo  * the scheduling requirement described in the first paragraph.
1179e22bee78STejun Heo  *
1180e22bee78STejun Heo  * CONTEXT:
1181e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1182e22bee78STejun Heo  * held.
1183e22bee78STejun Heo  *
1184e22bee78STejun Heo  * RETURNS:
1185e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1186e22bee78STejun Heo  * bound), %false if offline.
1187e22bee78STejun Heo  */
1188e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1189e22bee78STejun Heo {
1190e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1191e22bee78STejun Heo 	struct task_struct *task = worker->task;
1192e22bee78STejun Heo 
1193e22bee78STejun Heo 	while (true) {
1194e22bee78STejun Heo 		/*
1195e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1196e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1197e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1198e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1199e22bee78STejun Heo 		 */
1200f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1201e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1202e22bee78STejun Heo 
1203e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1204e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1205e22bee78STejun Heo 			return false;
1206e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1207e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1208e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1209e22bee78STejun Heo 			return true;
1210e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1211e22bee78STejun Heo 
1212e22bee78STejun Heo 		/* CPU has come up inbetween, retry migration */
1213e22bee78STejun Heo 		cpu_relax();
1214e22bee78STejun Heo 	}
1215e22bee78STejun Heo }
1216e22bee78STejun Heo 
1217e22bee78STejun Heo /*
1218e22bee78STejun Heo  * Function for worker->rebind_work used to rebind rogue busy workers
1219e22bee78STejun Heo  * to the associated cpu which is coming back online.  This is
1220e22bee78STejun Heo  * scheduled by cpu up but can race with other cpu hotplug operations
1221e22bee78STejun Heo  * and may be executed twice without intervening cpu down.
1222e22bee78STejun Heo  */
1223e22bee78STejun Heo static void worker_rebind_fn(struct work_struct *work)
1224e22bee78STejun Heo {
1225e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1226e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1227e22bee78STejun Heo 
1228e22bee78STejun Heo 	if (worker_maybe_bind_and_lock(worker))
1229e22bee78STejun Heo 		worker_clr_flags(worker, WORKER_REBIND);
1230e22bee78STejun Heo 
1231e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1232e22bee78STejun Heo }
1233e22bee78STejun Heo 
1234c34056a3STejun Heo static struct worker *alloc_worker(void)
1235c34056a3STejun Heo {
1236c34056a3STejun Heo 	struct worker *worker;
1237c34056a3STejun Heo 
1238c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1239c8e55f36STejun Heo 	if (worker) {
1240c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1241affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1242e22bee78STejun Heo 		INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1243e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1244e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1245c8e55f36STejun Heo 	}
1246c34056a3STejun Heo 	return worker;
1247c34056a3STejun Heo }
1248c34056a3STejun Heo 
1249c34056a3STejun Heo /**
1250c34056a3STejun Heo  * create_worker - create a new workqueue worker
12517e11629dSTejun Heo  * @gcwq: gcwq the new worker will belong to
1252c34056a3STejun Heo  * @bind: whether to set affinity to @cpu or not
1253c34056a3STejun Heo  *
12547e11629dSTejun Heo  * Create a new worker which is bound to @gcwq.  The returned worker
1255c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1256c34056a3STejun Heo  * destroy_worker().
1257c34056a3STejun Heo  *
1258c34056a3STejun Heo  * CONTEXT:
1259c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1260c34056a3STejun Heo  *
1261c34056a3STejun Heo  * RETURNS:
1262c34056a3STejun Heo  * Pointer to the newly created worker.
1263c34056a3STejun Heo  */
12647e11629dSTejun Heo static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
1265c34056a3STejun Heo {
1266f3421797STejun Heo 	bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
1267c34056a3STejun Heo 	struct worker *worker = NULL;
1268f3421797STejun Heo 	int id = -1;
1269c34056a3STejun Heo 
12708b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
12718b03ae3cSTejun Heo 	while (ida_get_new(&gcwq->worker_ida, &id)) {
12728b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
12738b03ae3cSTejun Heo 		if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
1274c34056a3STejun Heo 			goto fail;
12758b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1276c34056a3STejun Heo 	}
12778b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1278c34056a3STejun Heo 
1279c34056a3STejun Heo 	worker = alloc_worker();
1280c34056a3STejun Heo 	if (!worker)
1281c34056a3STejun Heo 		goto fail;
1282c34056a3STejun Heo 
12838b03ae3cSTejun Heo 	worker->gcwq = gcwq;
1284c34056a3STejun Heo 	worker->id = id;
1285c34056a3STejun Heo 
1286f3421797STejun Heo 	if (!on_unbound_cpu)
1287f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
1288f3421797STejun Heo 					      "kworker/%u:%d", gcwq->cpu, id);
1289f3421797STejun Heo 	else
1290f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
1291f3421797STejun Heo 					      "kworker/u:%d", id);
1292c34056a3STejun Heo 	if (IS_ERR(worker->task))
1293c34056a3STejun Heo 		goto fail;
1294c34056a3STejun Heo 
1295db7bccf4STejun Heo 	/*
1296db7bccf4STejun Heo 	 * A rogue worker will become a regular one if CPU comes
1297db7bccf4STejun Heo 	 * online later on.  Make sure every worker has
1298db7bccf4STejun Heo 	 * PF_THREAD_BOUND set.
1299db7bccf4STejun Heo 	 */
1300f3421797STejun Heo 	if (bind && !on_unbound_cpu)
13018b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1302f3421797STejun Heo 	else {
1303db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1304f3421797STejun Heo 		if (on_unbound_cpu)
1305f3421797STejun Heo 			worker->flags |= WORKER_UNBOUND;
1306f3421797STejun Heo 	}
1307c34056a3STejun Heo 
1308c34056a3STejun Heo 	return worker;
1309c34056a3STejun Heo fail:
1310c34056a3STejun Heo 	if (id >= 0) {
13118b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
13128b03ae3cSTejun Heo 		ida_remove(&gcwq->worker_ida, id);
13138b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1314c34056a3STejun Heo 	}
1315c34056a3STejun Heo 	kfree(worker);
1316c34056a3STejun Heo 	return NULL;
1317c34056a3STejun Heo }
1318c34056a3STejun Heo 
1319c34056a3STejun Heo /**
1320c34056a3STejun Heo  * start_worker - start a newly created worker
1321c34056a3STejun Heo  * @worker: worker to start
1322c34056a3STejun Heo  *
1323c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1324c34056a3STejun Heo  *
1325c34056a3STejun Heo  * CONTEXT:
13268b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1327c34056a3STejun Heo  */
1328c34056a3STejun Heo static void start_worker(struct worker *worker)
1329c34056a3STejun Heo {
1330cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1331c8e55f36STejun Heo 	worker->gcwq->nr_workers++;
1332c8e55f36STejun Heo 	worker_enter_idle(worker);
1333c34056a3STejun Heo 	wake_up_process(worker->task);
1334c34056a3STejun Heo }
1335c34056a3STejun Heo 
1336c34056a3STejun Heo /**
1337c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1338c34056a3STejun Heo  * @worker: worker to be destroyed
1339c34056a3STejun Heo  *
1340c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1341c8e55f36STejun Heo  *
1342c8e55f36STejun Heo  * CONTEXT:
1343c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1344c34056a3STejun Heo  */
1345c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1346c34056a3STejun Heo {
13478b03ae3cSTejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1348c34056a3STejun Heo 	int id = worker->id;
1349c34056a3STejun Heo 
1350c34056a3STejun Heo 	/* sanity check frenzy */
1351c34056a3STejun Heo 	BUG_ON(worker->current_work);
1352affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1353c34056a3STejun Heo 
1354c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1355c8e55f36STejun Heo 		gcwq->nr_workers--;
1356c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1357c8e55f36STejun Heo 		gcwq->nr_idle--;
1358c8e55f36STejun Heo 
1359c8e55f36STejun Heo 	list_del_init(&worker->entry);
1360cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1361c8e55f36STejun Heo 
1362c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1363c8e55f36STejun Heo 
1364c34056a3STejun Heo 	kthread_stop(worker->task);
1365c34056a3STejun Heo 	kfree(worker);
1366c34056a3STejun Heo 
13678b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
13688b03ae3cSTejun Heo 	ida_remove(&gcwq->worker_ida, id);
1369c34056a3STejun Heo }
1370c34056a3STejun Heo 
1371e22bee78STejun Heo static void idle_worker_timeout(unsigned long __gcwq)
1372e22bee78STejun Heo {
1373e22bee78STejun Heo 	struct global_cwq *gcwq = (void *)__gcwq;
1374e22bee78STejun Heo 
1375e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1376e22bee78STejun Heo 
1377e22bee78STejun Heo 	if (too_many_workers(gcwq)) {
1378e22bee78STejun Heo 		struct worker *worker;
1379e22bee78STejun Heo 		unsigned long expires;
1380e22bee78STejun Heo 
1381e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
1382e22bee78STejun Heo 		worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1383e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1384e22bee78STejun Heo 
1385e22bee78STejun Heo 		if (time_before(jiffies, expires))
1386e22bee78STejun Heo 			mod_timer(&gcwq->idle_timer, expires);
1387e22bee78STejun Heo 		else {
1388e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
1389e22bee78STejun Heo 			gcwq->flags |= GCWQ_MANAGE_WORKERS;
1390e22bee78STejun Heo 			wake_up_worker(gcwq);
1391e22bee78STejun Heo 		}
1392e22bee78STejun Heo 	}
1393e22bee78STejun Heo 
1394e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1395e22bee78STejun Heo }
1396e22bee78STejun Heo 
1397e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1398e22bee78STejun Heo {
1399e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1400e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1401f3421797STejun Heo 	unsigned int cpu;
1402e22bee78STejun Heo 
1403e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1404e22bee78STejun Heo 		return false;
1405e22bee78STejun Heo 
1406e22bee78STejun Heo 	/* mayday mayday mayday */
1407f3421797STejun Heo 	cpu = cwq->gcwq->cpu;
1408f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1409f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1410f3421797STejun Heo 		cpu = 0;
1411*f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1412e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1413e22bee78STejun Heo 	return true;
1414e22bee78STejun Heo }
1415e22bee78STejun Heo 
1416e22bee78STejun Heo static void gcwq_mayday_timeout(unsigned long __gcwq)
1417e22bee78STejun Heo {
1418e22bee78STejun Heo 	struct global_cwq *gcwq = (void *)__gcwq;
1419e22bee78STejun Heo 	struct work_struct *work;
1420e22bee78STejun Heo 
1421e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1422e22bee78STejun Heo 
1423e22bee78STejun Heo 	if (need_to_create_worker(gcwq)) {
1424e22bee78STejun Heo 		/*
1425e22bee78STejun Heo 		 * We've been trying to create a new worker but
1426e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1427e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1428e22bee78STejun Heo 		 * rescuers.
1429e22bee78STejun Heo 		 */
1430e22bee78STejun Heo 		list_for_each_entry(work, &gcwq->worklist, entry)
1431e22bee78STejun Heo 			send_mayday(work);
1432e22bee78STejun Heo 	}
1433e22bee78STejun Heo 
1434e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1435e22bee78STejun Heo 
1436e22bee78STejun Heo 	mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1437e22bee78STejun Heo }
1438e22bee78STejun Heo 
1439e22bee78STejun Heo /**
1440e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
1441e22bee78STejun Heo  * @gcwq: gcwq to create a new worker for
1442e22bee78STejun Heo  *
1443e22bee78STejun Heo  * Create a new worker for @gcwq if necessary.  @gcwq is guaranteed to
1444e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1445e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1446e22bee78STejun Heo  * sent to all rescuers with works scheduled on @gcwq to resolve
1447e22bee78STejun Heo  * possible allocation deadlock.
1448e22bee78STejun Heo  *
1449e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1450e22bee78STejun Heo  * may_start_working() true.
1451e22bee78STejun Heo  *
1452e22bee78STejun Heo  * LOCKING:
1453e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1454e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1455e22bee78STejun Heo  * manager.
1456e22bee78STejun Heo  *
1457e22bee78STejun Heo  * RETURNS:
1458e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1459e22bee78STejun Heo  * otherwise.
1460e22bee78STejun Heo  */
1461e22bee78STejun Heo static bool maybe_create_worker(struct global_cwq *gcwq)
1462e22bee78STejun Heo {
1463e22bee78STejun Heo 	if (!need_to_create_worker(gcwq))
1464e22bee78STejun Heo 		return false;
1465e22bee78STejun Heo restart:
14669f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
14679f9c2364STejun Heo 
1468e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1469e22bee78STejun Heo 	mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1470e22bee78STejun Heo 
1471e22bee78STejun Heo 	while (true) {
1472e22bee78STejun Heo 		struct worker *worker;
1473e22bee78STejun Heo 
1474e22bee78STejun Heo 		worker = create_worker(gcwq, true);
1475e22bee78STejun Heo 		if (worker) {
1476e22bee78STejun Heo 			del_timer_sync(&gcwq->mayday_timer);
1477e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1478e22bee78STejun Heo 			start_worker(worker);
1479e22bee78STejun Heo 			BUG_ON(need_to_create_worker(gcwq));
1480e22bee78STejun Heo 			return true;
1481e22bee78STejun Heo 		}
1482e22bee78STejun Heo 
1483e22bee78STejun Heo 		if (!need_to_create_worker(gcwq))
1484e22bee78STejun Heo 			break;
1485e22bee78STejun Heo 
1486e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1487e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
14889f9c2364STejun Heo 
1489e22bee78STejun Heo 		if (!need_to_create_worker(gcwq))
1490e22bee78STejun Heo 			break;
1491e22bee78STejun Heo 	}
1492e22bee78STejun Heo 
1493e22bee78STejun Heo 	del_timer_sync(&gcwq->mayday_timer);
1494e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1495e22bee78STejun Heo 	if (need_to_create_worker(gcwq))
1496e22bee78STejun Heo 		goto restart;
1497e22bee78STejun Heo 	return true;
1498e22bee78STejun Heo }
1499e22bee78STejun Heo 
1500e22bee78STejun Heo /**
1501e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
1502e22bee78STejun Heo  * @gcwq: gcwq to destroy workers for
1503e22bee78STejun Heo  *
1504e22bee78STejun Heo  * Destroy @gcwq workers which have been idle for longer than
1505e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1506e22bee78STejun Heo  *
1507e22bee78STejun Heo  * LOCKING:
1508e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1509e22bee78STejun Heo  * multiple times.  Called only from manager.
1510e22bee78STejun Heo  *
1511e22bee78STejun Heo  * RETURNS:
1512e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1513e22bee78STejun Heo  * otherwise.
1514e22bee78STejun Heo  */
1515e22bee78STejun Heo static bool maybe_destroy_workers(struct global_cwq *gcwq)
1516e22bee78STejun Heo {
1517e22bee78STejun Heo 	bool ret = false;
1518e22bee78STejun Heo 
1519e22bee78STejun Heo 	while (too_many_workers(gcwq)) {
1520e22bee78STejun Heo 		struct worker *worker;
1521e22bee78STejun Heo 		unsigned long expires;
1522e22bee78STejun Heo 
1523e22bee78STejun Heo 		worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1524e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1525e22bee78STejun Heo 
1526e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
1527e22bee78STejun Heo 			mod_timer(&gcwq->idle_timer, expires);
1528e22bee78STejun Heo 			break;
1529e22bee78STejun Heo 		}
1530e22bee78STejun Heo 
1531e22bee78STejun Heo 		destroy_worker(worker);
1532e22bee78STejun Heo 		ret = true;
1533e22bee78STejun Heo 	}
1534e22bee78STejun Heo 
1535e22bee78STejun Heo 	return ret;
1536e22bee78STejun Heo }
1537e22bee78STejun Heo 
1538e22bee78STejun Heo /**
1539e22bee78STejun Heo  * manage_workers - manage worker pool
1540e22bee78STejun Heo  * @worker: self
1541e22bee78STejun Heo  *
1542e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
1543e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1544e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
1545e22bee78STejun Heo  *
1546e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
1547e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
1548e22bee78STejun Heo  * and may_start_working() is true.
1549e22bee78STejun Heo  *
1550e22bee78STejun Heo  * CONTEXT:
1551e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1552e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
1553e22bee78STejun Heo  *
1554e22bee78STejun Heo  * RETURNS:
1555e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
1556e22bee78STejun Heo  * some action was taken.
1557e22bee78STejun Heo  */
1558e22bee78STejun Heo static bool manage_workers(struct worker *worker)
1559e22bee78STejun Heo {
1560e22bee78STejun Heo 	struct global_cwq *gcwq = worker->gcwq;
1561e22bee78STejun Heo 	bool ret = false;
1562e22bee78STejun Heo 
1563e22bee78STejun Heo 	if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1564e22bee78STejun Heo 		return ret;
1565e22bee78STejun Heo 
1566e22bee78STejun Heo 	gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1567e22bee78STejun Heo 	gcwq->flags |= GCWQ_MANAGING_WORKERS;
1568e22bee78STejun Heo 
1569e22bee78STejun Heo 	/*
1570e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
1571e22bee78STejun Heo 	 * on return.
1572e22bee78STejun Heo 	 */
1573e22bee78STejun Heo 	ret |= maybe_destroy_workers(gcwq);
1574e22bee78STejun Heo 	ret |= maybe_create_worker(gcwq);
1575e22bee78STejun Heo 
1576e22bee78STejun Heo 	gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1577e22bee78STejun Heo 
1578e22bee78STejun Heo 	/*
1579e22bee78STejun Heo 	 * The trustee might be waiting to take over the manager
1580e22bee78STejun Heo 	 * position, tell it we're done.
1581e22bee78STejun Heo 	 */
1582e22bee78STejun Heo 	if (unlikely(gcwq->trustee))
1583e22bee78STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1584e22bee78STejun Heo 
1585e22bee78STejun Heo 	return ret;
1586e22bee78STejun Heo }
1587e22bee78STejun Heo 
1588a62428c0STejun Heo /**
1589affee4b2STejun Heo  * move_linked_works - move linked works to a list
1590affee4b2STejun Heo  * @work: start of series of works to be scheduled
1591affee4b2STejun Heo  * @head: target list to append @work to
1592affee4b2STejun Heo  * @nextp: out paramter for nested worklist walking
1593affee4b2STejun Heo  *
1594affee4b2STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1595affee4b2STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1596affee4b2STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1597affee4b2STejun Heo  *
1598affee4b2STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1599affee4b2STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1600affee4b2STejun Heo  * nested inside outer list_for_each_entry_safe().
1601affee4b2STejun Heo  *
1602affee4b2STejun Heo  * CONTEXT:
16038b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1604affee4b2STejun Heo  */
1605affee4b2STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1606affee4b2STejun Heo 			      struct work_struct **nextp)
1607affee4b2STejun Heo {
1608affee4b2STejun Heo 	struct work_struct *n;
1609affee4b2STejun Heo 
1610affee4b2STejun Heo 	/*
1611affee4b2STejun Heo 	 * Linked worklist will always end before the end of the list,
1612affee4b2STejun Heo 	 * use NULL for list head.
1613affee4b2STejun Heo 	 */
1614affee4b2STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1615affee4b2STejun Heo 		list_move_tail(&work->entry, head);
1616affee4b2STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1617affee4b2STejun Heo 			break;
1618affee4b2STejun Heo 	}
1619affee4b2STejun Heo 
1620affee4b2STejun Heo 	/*
1621affee4b2STejun Heo 	 * If we're already inside safe list traversal and have moved
1622affee4b2STejun Heo 	 * multiple works to the scheduled queue, the next position
1623affee4b2STejun Heo 	 * needs to be updated.
1624affee4b2STejun Heo 	 */
1625affee4b2STejun Heo 	if (nextp)
1626affee4b2STejun Heo 		*nextp = n;
1627affee4b2STejun Heo }
1628affee4b2STejun Heo 
16291e19ffc6STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
16301e19ffc6STejun Heo {
16311e19ffc6STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
16321e19ffc6STejun Heo 						    struct work_struct, entry);
1633649027d7STejun Heo 	struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
16341e19ffc6STejun Heo 
1635649027d7STejun Heo 	move_linked_works(work, pos, NULL);
16361e19ffc6STejun Heo 	cwq->nr_active++;
16371e19ffc6STejun Heo }
16381e19ffc6STejun Heo 
1639affee4b2STejun Heo /**
164073f53c4aSTejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
164173f53c4aSTejun Heo  * @cwq: cwq of interest
164273f53c4aSTejun Heo  * @color: color of work which left the queue
164373f53c4aSTejun Heo  *
164473f53c4aSTejun Heo  * A work either has completed or is removed from pending queue,
164573f53c4aSTejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
164673f53c4aSTejun Heo  *
164773f53c4aSTejun Heo  * CONTEXT:
16488b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
164973f53c4aSTejun Heo  */
165073f53c4aSTejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
165173f53c4aSTejun Heo {
165273f53c4aSTejun Heo 	/* ignore uncolored works */
165373f53c4aSTejun Heo 	if (color == WORK_NO_COLOR)
165473f53c4aSTejun Heo 		return;
165573f53c4aSTejun Heo 
165673f53c4aSTejun Heo 	cwq->nr_in_flight[color]--;
16571e19ffc6STejun Heo 	cwq->nr_active--;
16581e19ffc6STejun Heo 
1659502ca9d8STejun Heo 	if (!list_empty(&cwq->delayed_works)) {
16601e19ffc6STejun Heo 		/* one down, submit a delayed one */
1661502ca9d8STejun Heo 		if (cwq->nr_active < cwq->max_active)
16621e19ffc6STejun Heo 			cwq_activate_first_delayed(cwq);
1663502ca9d8STejun Heo 	}
166473f53c4aSTejun Heo 
166573f53c4aSTejun Heo 	/* is flush in progress and are we at the flushing tip? */
166673f53c4aSTejun Heo 	if (likely(cwq->flush_color != color))
166773f53c4aSTejun Heo 		return;
166873f53c4aSTejun Heo 
166973f53c4aSTejun Heo 	/* are there still in-flight works? */
167073f53c4aSTejun Heo 	if (cwq->nr_in_flight[color])
167173f53c4aSTejun Heo 		return;
167273f53c4aSTejun Heo 
167373f53c4aSTejun Heo 	/* this cwq is done, clear flush_color */
167473f53c4aSTejun Heo 	cwq->flush_color = -1;
167573f53c4aSTejun Heo 
167673f53c4aSTejun Heo 	/*
167773f53c4aSTejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
167873f53c4aSTejun Heo 	 * will handle the rest.
167973f53c4aSTejun Heo 	 */
168073f53c4aSTejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
168173f53c4aSTejun Heo 		complete(&cwq->wq->first_flusher->done);
168273f53c4aSTejun Heo }
168373f53c4aSTejun Heo 
168473f53c4aSTejun Heo /**
1685a62428c0STejun Heo  * process_one_work - process single work
1686c34056a3STejun Heo  * @worker: self
1687a62428c0STejun Heo  * @work: work to process
1688a62428c0STejun Heo  *
1689a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
1690a62428c0STejun Heo  * process a single work including synchronization against and
1691a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
1692a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
1693a62428c0STejun Heo  * call this function to process a work.
1694a62428c0STejun Heo  *
1695a62428c0STejun Heo  * CONTEXT:
16968b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1697a62428c0STejun Heo  */
1698c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
16991da177e4SLinus Torvalds {
17007e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
17018b03ae3cSTejun Heo 	struct global_cwq *gcwq = cwq->gcwq;
1702c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
1703fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
17046bb49e59SDavid Howells 	work_func_t f = work->func;
170573f53c4aSTejun Heo 	int work_color;
17067e11629dSTejun Heo 	struct worker *collision;
17074e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
17084e6045f1SJohannes Berg 	/*
1709a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
1710a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
1711a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
1712a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
1713a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
17144e6045f1SJohannes Berg 	 */
17154e6045f1SJohannes Berg 	struct lockdep_map lockdep_map = work->lockdep_map;
17164e6045f1SJohannes Berg #endif
17177e11629dSTejun Heo 	/*
17187e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
17197e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
17207e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
17217e11629dSTejun Heo 	 * currently executing one.
17227e11629dSTejun Heo 	 */
17237e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
17247e11629dSTejun Heo 	if (unlikely(collision)) {
17257e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
17267e11629dSTejun Heo 		return;
17277e11629dSTejun Heo 	}
17287e11629dSTejun Heo 
1729a62428c0STejun Heo 	/* claim and process */
1730dc186ad7SThomas Gleixner 	debug_work_deactivate(work);
1731c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
1732c34056a3STejun Heo 	worker->current_work = work;
17338cca0eeaSTejun Heo 	worker->current_cwq = cwq;
173473f53c4aSTejun Heo 	work_color = get_work_color(work);
17357a22ad75STejun Heo 
17367a22ad75STejun Heo 	/* record the current cpu number in the work data and dequeue */
17377a22ad75STejun Heo 	set_work_cpu(work, gcwq->cpu);
1738a62428c0STejun Heo 	list_del_init(&work->entry);
1739a62428c0STejun Heo 
1740649027d7STejun Heo 	/*
1741649027d7STejun Heo 	 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1742649027d7STejun Heo 	 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1743649027d7STejun Heo 	 */
1744649027d7STejun Heo 	if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1745649027d7STejun Heo 		struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1746649027d7STejun Heo 						struct work_struct, entry);
1747649027d7STejun Heo 
1748649027d7STejun Heo 		if (!list_empty(&gcwq->worklist) &&
1749649027d7STejun Heo 		    get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1750649027d7STejun Heo 			wake_up_worker(gcwq);
1751649027d7STejun Heo 		else
1752649027d7STejun Heo 			gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1753649027d7STejun Heo 	}
1754649027d7STejun Heo 
1755fb0e7bebSTejun Heo 	/*
1756fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
1757fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
1758fb0e7bebSTejun Heo 	 */
1759fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1760fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1761fb0e7bebSTejun Heo 
17628b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
17631da177e4SLinus Torvalds 
176423b2e599SOleg Nesterov 	work_clear_pending(work);
17653295f0efSIngo Molnar 	lock_map_acquire(&cwq->wq->lockdep_map);
17663295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
176765f27f38SDavid Howells 	f(work);
17683295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
17693295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
17701da177e4SLinus Torvalds 
1771d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1772d5abe669SPeter Zijlstra 		printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1773d5abe669SPeter Zijlstra 		       "%s/0x%08x/%d\n",
1774a62428c0STejun Heo 		       current->comm, preempt_count(), task_pid_nr(current));
1775d5abe669SPeter Zijlstra 		printk(KERN_ERR "    last function: ");
1776d5abe669SPeter Zijlstra 		print_symbol("%s\n", (unsigned long)f);
1777d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
1778d5abe669SPeter Zijlstra 		dump_stack();
1779d5abe669SPeter Zijlstra 	}
1780d5abe669SPeter Zijlstra 
17818b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1782a62428c0STejun Heo 
1783fb0e7bebSTejun Heo 	/* clear cpu intensive status */
1784fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1785fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1786fb0e7bebSTejun Heo 
1787a62428c0STejun Heo 	/* we're done with it, release */
1788c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
1789c34056a3STejun Heo 	worker->current_work = NULL;
17908cca0eeaSTejun Heo 	worker->current_cwq = NULL;
179173f53c4aSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color);
17921da177e4SLinus Torvalds }
1793a62428c0STejun Heo 
1794affee4b2STejun Heo /**
1795affee4b2STejun Heo  * process_scheduled_works - process scheduled works
1796affee4b2STejun Heo  * @worker: self
1797affee4b2STejun Heo  *
1798affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
1799affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
1800affee4b2STejun Heo  * fetches a work from the top and executes it.
1801affee4b2STejun Heo  *
1802affee4b2STejun Heo  * CONTEXT:
18038b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1804affee4b2STejun Heo  * multiple times.
1805affee4b2STejun Heo  */
1806affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
1807a62428c0STejun Heo {
1808affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
1809affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
1810a62428c0STejun Heo 						struct work_struct, entry);
1811c34056a3STejun Heo 		process_one_work(worker, work);
1812a62428c0STejun Heo 	}
18131da177e4SLinus Torvalds }
18141da177e4SLinus Torvalds 
18154690c4abSTejun Heo /**
18164690c4abSTejun Heo  * worker_thread - the worker thread function
1817c34056a3STejun Heo  * @__worker: self
18184690c4abSTejun Heo  *
1819e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
1820e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
1821e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
1822e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
1823e22bee78STejun Heo  * rescuer_thread().
18244690c4abSTejun Heo  */
1825c34056a3STejun Heo static int worker_thread(void *__worker)
18261da177e4SLinus Torvalds {
1827c34056a3STejun Heo 	struct worker *worker = __worker;
18288b03ae3cSTejun Heo 	struct global_cwq *gcwq = worker->gcwq;
18291da177e4SLinus Torvalds 
1830e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
1831e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
1832c8e55f36STejun Heo woke_up:
18338b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1834affee4b2STejun Heo 
1835c8e55f36STejun Heo 	/* DIE can be set only while we're idle, checking here is enough */
1836c8e55f36STejun Heo 	if (worker->flags & WORKER_DIE) {
1837c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
1838e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
1839c8e55f36STejun Heo 		return 0;
1840c8e55f36STejun Heo 	}
1841c8e55f36STejun Heo 
1842c8e55f36STejun Heo 	worker_leave_idle(worker);
1843db7bccf4STejun Heo recheck:
1844e22bee78STejun Heo 	/* no more worker necessary? */
1845e22bee78STejun Heo 	if (!need_more_worker(gcwq))
1846e22bee78STejun Heo 		goto sleep;
1847e22bee78STejun Heo 
1848e22bee78STejun Heo 	/* do we need to manage? */
1849e22bee78STejun Heo 	if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1850e22bee78STejun Heo 		goto recheck;
1851e22bee78STejun Heo 
1852c8e55f36STejun Heo 	/*
1853c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
1854c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
1855c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
1856c8e55f36STejun Heo 	 */
1857c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1858c8e55f36STejun Heo 
1859e22bee78STejun Heo 	/*
1860e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
1861e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
1862e22bee78STejun Heo 	 * assumed the manager role.
1863e22bee78STejun Heo 	 */
1864e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
1865e22bee78STejun Heo 
1866e22bee78STejun Heo 	do {
1867affee4b2STejun Heo 		struct work_struct *work =
18687e11629dSTejun Heo 			list_first_entry(&gcwq->worklist,
1869affee4b2STejun Heo 					 struct work_struct, entry);
1870affee4b2STejun Heo 
1871c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1872affee4b2STejun Heo 			/* optimization path, not strictly necessary */
1873affee4b2STejun Heo 			process_one_work(worker, work);
1874affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
1875affee4b2STejun Heo 				process_scheduled_works(worker);
1876affee4b2STejun Heo 		} else {
1877c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
1878affee4b2STejun Heo 			process_scheduled_works(worker);
1879affee4b2STejun Heo 		}
1880e22bee78STejun Heo 	} while (keep_working(gcwq));
1881affee4b2STejun Heo 
1882e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
1883d313dd85STejun Heo sleep:
1884e22bee78STejun Heo 	if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
1885e22bee78STejun Heo 		goto recheck;
1886d313dd85STejun Heo 
1887c8e55f36STejun Heo 	/*
1888e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
1889e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
1890e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
1891e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
1892e22bee78STejun Heo 	 * prevent losing any event.
1893c8e55f36STejun Heo 	 */
1894c8e55f36STejun Heo 	worker_enter_idle(worker);
1895c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
18968b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1897c8e55f36STejun Heo 	schedule();
1898c8e55f36STejun Heo 	goto woke_up;
18991da177e4SLinus Torvalds }
19001da177e4SLinus Torvalds 
1901e22bee78STejun Heo /**
1902e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
1903e22bee78STejun Heo  * @__wq: the associated workqueue
1904e22bee78STejun Heo  *
1905e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
1906e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
1907e22bee78STejun Heo  *
1908e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
1909e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
1910e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
1911e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
1912e22bee78STejun Heo  * the problem rescuer solves.
1913e22bee78STejun Heo  *
1914e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
1915e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
1916e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
1917e22bee78STejun Heo  *
1918e22bee78STejun Heo  * This should happen rarely.
1919e22bee78STejun Heo  */
1920e22bee78STejun Heo static int rescuer_thread(void *__wq)
1921e22bee78STejun Heo {
1922e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
1923e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
1924e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
1925f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
1926e22bee78STejun Heo 	unsigned int cpu;
1927e22bee78STejun Heo 
1928e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
1929e22bee78STejun Heo repeat:
1930e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
1931e22bee78STejun Heo 
1932e22bee78STejun Heo 	if (kthread_should_stop())
1933e22bee78STejun Heo 		return 0;
1934e22bee78STejun Heo 
1935f3421797STejun Heo 	/*
1936f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
1937f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
1938f3421797STejun Heo 	 */
1939*f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
1940f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
1941f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
1942e22bee78STejun Heo 		struct global_cwq *gcwq = cwq->gcwq;
1943e22bee78STejun Heo 		struct work_struct *work, *n;
1944e22bee78STejun Heo 
1945e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
1946*f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
1947e22bee78STejun Heo 
1948e22bee78STejun Heo 		/* migrate to the target cpu if possible */
1949e22bee78STejun Heo 		rescuer->gcwq = gcwq;
1950e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
1951e22bee78STejun Heo 
1952e22bee78STejun Heo 		/*
1953e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
1954e22bee78STejun Heo 		 * process'em.
1955e22bee78STejun Heo 		 */
1956e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
1957e22bee78STejun Heo 		list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
1958e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
1959e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
1960e22bee78STejun Heo 
1961e22bee78STejun Heo 		process_scheduled_works(rescuer);
1962e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1963e22bee78STejun Heo 	}
1964e22bee78STejun Heo 
1965e22bee78STejun Heo 	schedule();
1966e22bee78STejun Heo 	goto repeat;
1967e22bee78STejun Heo }
1968e22bee78STejun Heo 
1969fc2e4d70SOleg Nesterov struct wq_barrier {
1970fc2e4d70SOleg Nesterov 	struct work_struct	work;
1971fc2e4d70SOleg Nesterov 	struct completion	done;
1972fc2e4d70SOleg Nesterov };
1973fc2e4d70SOleg Nesterov 
1974fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
1975fc2e4d70SOleg Nesterov {
1976fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
1977fc2e4d70SOleg Nesterov 	complete(&barr->done);
1978fc2e4d70SOleg Nesterov }
1979fc2e4d70SOleg Nesterov 
19804690c4abSTejun Heo /**
19814690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
19824690c4abSTejun Heo  * @cwq: cwq to insert barrier into
19834690c4abSTejun Heo  * @barr: wq_barrier to insert
1984affee4b2STejun Heo  * @target: target work to attach @barr to
1985affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
19864690c4abSTejun Heo  *
1987affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
1988affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
1989affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
1990affee4b2STejun Heo  * cpu.
1991affee4b2STejun Heo  *
1992affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
1993affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
1994affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
1995affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
1996affee4b2STejun Heo  * after a work with LINKED flag set.
1997affee4b2STejun Heo  *
1998affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
1999affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
20004690c4abSTejun Heo  *
20014690c4abSTejun Heo  * CONTEXT:
20028b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
20034690c4abSTejun Heo  */
200483c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2005affee4b2STejun Heo 			      struct wq_barrier *barr,
2006affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2007fc2e4d70SOleg Nesterov {
2008affee4b2STejun Heo 	struct list_head *head;
2009affee4b2STejun Heo 	unsigned int linked = 0;
2010affee4b2STejun Heo 
2011dc186ad7SThomas Gleixner 	/*
20128b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2013dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2014dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2015dc186ad7SThomas Gleixner 	 * might deadlock.
2016dc186ad7SThomas Gleixner 	 */
2017dc186ad7SThomas Gleixner 	INIT_WORK_ON_STACK(&barr->work, wq_barrier_func);
201822df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2019fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
202083c22520SOleg Nesterov 
2021affee4b2STejun Heo 	/*
2022affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2023affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2024affee4b2STejun Heo 	 */
2025affee4b2STejun Heo 	if (worker)
2026affee4b2STejun Heo 		head = worker->scheduled.next;
2027affee4b2STejun Heo 	else {
2028affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2029affee4b2STejun Heo 
2030affee4b2STejun Heo 		head = target->entry.next;
2031affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2032affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2033affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2034affee4b2STejun Heo 	}
2035affee4b2STejun Heo 
2036dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2037affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2038affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2039fc2e4d70SOleg Nesterov }
2040fc2e4d70SOleg Nesterov 
204173f53c4aSTejun Heo /**
204273f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
204373f53c4aSTejun Heo  * @wq: workqueue being flushed
204473f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
204573f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
204673f53c4aSTejun Heo  *
204773f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
204873f53c4aSTejun Heo  *
204973f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
205073f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
205173f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
205273f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
205373f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
205473f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
205573f53c4aSTejun Heo  *
205673f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
205773f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
205873f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
205973f53c4aSTejun Heo  * is returned.
206073f53c4aSTejun Heo  *
206173f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
206273f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
206373f53c4aSTejun Heo  * advanced to @work_color.
206473f53c4aSTejun Heo  *
206573f53c4aSTejun Heo  * CONTEXT:
206673f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
206773f53c4aSTejun Heo  *
206873f53c4aSTejun Heo  * RETURNS:
206973f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
207073f53c4aSTejun Heo  * otherwise.
207173f53c4aSTejun Heo  */
207273f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
207373f53c4aSTejun Heo 				      int flush_color, int work_color)
20741da177e4SLinus Torvalds {
207573f53c4aSTejun Heo 	bool wait = false;
207673f53c4aSTejun Heo 	unsigned int cpu;
20771da177e4SLinus Torvalds 
207873f53c4aSTejun Heo 	if (flush_color >= 0) {
207973f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
208073f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
208173f53c4aSTejun Heo 	}
208273f53c4aSTejun Heo 
2083f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
208473f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
20858b03ae3cSTejun Heo 		struct global_cwq *gcwq = cwq->gcwq;
20862355b70fSLai Jiangshan 
20878b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
208873f53c4aSTejun Heo 
208973f53c4aSTejun Heo 		if (flush_color >= 0) {
209073f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
209173f53c4aSTejun Heo 
209273f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
209373f53c4aSTejun Heo 				cwq->flush_color = flush_color;
209473f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
209573f53c4aSTejun Heo 				wait = true;
209683c22520SOleg Nesterov 			}
209773f53c4aSTejun Heo 		}
209873f53c4aSTejun Heo 
209973f53c4aSTejun Heo 		if (work_color >= 0) {
210073f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
210173f53c4aSTejun Heo 			cwq->work_color = work_color;
210273f53c4aSTejun Heo 		}
210373f53c4aSTejun Heo 
21048b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
2105dc186ad7SThomas Gleixner 	}
210614441960SOleg Nesterov 
210773f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
210873f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
210973f53c4aSTejun Heo 
211073f53c4aSTejun Heo 	return wait;
211183c22520SOleg Nesterov }
21121da177e4SLinus Torvalds 
21130fcb78c2SRolf Eike Beer /**
21141da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
21150fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
21161da177e4SLinus Torvalds  *
21171da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
21181da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
21191da177e4SLinus Torvalds  *
2120fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2121fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
21221da177e4SLinus Torvalds  */
21237ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
21241da177e4SLinus Torvalds {
212573f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
212673f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
212773f53c4aSTejun Heo 		.flush_color = -1,
212873f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
212973f53c4aSTejun Heo 	};
213073f53c4aSTejun Heo 	int next_color;
2131b1f4ec17SOleg Nesterov 
21323295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
21333295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
213473f53c4aSTejun Heo 
213573f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
213673f53c4aSTejun Heo 
213773f53c4aSTejun Heo 	/*
213873f53c4aSTejun Heo 	 * Start-to-wait phase
213973f53c4aSTejun Heo 	 */
214073f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
214173f53c4aSTejun Heo 
214273f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
214373f53c4aSTejun Heo 		/*
214473f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
214573f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
214673f53c4aSTejun Heo 		 * by one.
214773f53c4aSTejun Heo 		 */
214873f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
214973f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
215073f53c4aSTejun Heo 		wq->work_color = next_color;
215173f53c4aSTejun Heo 
215273f53c4aSTejun Heo 		if (!wq->first_flusher) {
215373f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
215473f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
215573f53c4aSTejun Heo 
215673f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
215773f53c4aSTejun Heo 
215873f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
215973f53c4aSTejun Heo 						       wq->work_color)) {
216073f53c4aSTejun Heo 				/* nothing to flush, done */
216173f53c4aSTejun Heo 				wq->flush_color = next_color;
216273f53c4aSTejun Heo 				wq->first_flusher = NULL;
216373f53c4aSTejun Heo 				goto out_unlock;
216473f53c4aSTejun Heo 			}
216573f53c4aSTejun Heo 		} else {
216673f53c4aSTejun Heo 			/* wait in queue */
216773f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
216873f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
216973f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
217073f53c4aSTejun Heo 		}
217173f53c4aSTejun Heo 	} else {
217273f53c4aSTejun Heo 		/*
217373f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
217473f53c4aSTejun Heo 		 * The next flush completion will assign us
217573f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
217673f53c4aSTejun Heo 		 */
217773f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
217873f53c4aSTejun Heo 	}
217973f53c4aSTejun Heo 
218073f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
218173f53c4aSTejun Heo 
218273f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
218373f53c4aSTejun Heo 
218473f53c4aSTejun Heo 	/*
218573f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
218673f53c4aSTejun Heo 	 *
218773f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
218873f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
218973f53c4aSTejun Heo 	 */
219073f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
219173f53c4aSTejun Heo 		return;
219273f53c4aSTejun Heo 
219373f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
219473f53c4aSTejun Heo 
21954ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
21964ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
21974ce48b37STejun Heo 		goto out_unlock;
21984ce48b37STejun Heo 
219973f53c4aSTejun Heo 	wq->first_flusher = NULL;
220073f53c4aSTejun Heo 
220173f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
220273f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
220373f53c4aSTejun Heo 
220473f53c4aSTejun Heo 	while (true) {
220573f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
220673f53c4aSTejun Heo 
220773f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
220873f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
220973f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
221073f53c4aSTejun Heo 				break;
221173f53c4aSTejun Heo 			list_del_init(&next->list);
221273f53c4aSTejun Heo 			complete(&next->done);
221373f53c4aSTejun Heo 		}
221473f53c4aSTejun Heo 
221573f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
221673f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
221773f53c4aSTejun Heo 
221873f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
221973f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
222073f53c4aSTejun Heo 
222173f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
222273f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
222373f53c4aSTejun Heo 			/*
222473f53c4aSTejun Heo 			 * Assign the same color to all overflowed
222573f53c4aSTejun Heo 			 * flushers, advance work_color and append to
222673f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
222773f53c4aSTejun Heo 			 * phase for these overflowed flushers.
222873f53c4aSTejun Heo 			 */
222973f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
223073f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
223173f53c4aSTejun Heo 
223273f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
223373f53c4aSTejun Heo 
223473f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
223573f53c4aSTejun Heo 					      &wq->flusher_queue);
223673f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
223773f53c4aSTejun Heo 		}
223873f53c4aSTejun Heo 
223973f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
224073f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
224173f53c4aSTejun Heo 			break;
224273f53c4aSTejun Heo 		}
224373f53c4aSTejun Heo 
224473f53c4aSTejun Heo 		/*
224573f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
224673f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
224773f53c4aSTejun Heo 		 */
224873f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
224973f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
225073f53c4aSTejun Heo 
225173f53c4aSTejun Heo 		list_del_init(&next->list);
225273f53c4aSTejun Heo 		wq->first_flusher = next;
225373f53c4aSTejun Heo 
225473f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
225573f53c4aSTejun Heo 			break;
225673f53c4aSTejun Heo 
225773f53c4aSTejun Heo 		/*
225873f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
225973f53c4aSTejun Heo 		 * flusher and repeat cascading.
226073f53c4aSTejun Heo 		 */
226173f53c4aSTejun Heo 		wq->first_flusher = NULL;
226273f53c4aSTejun Heo 	}
226373f53c4aSTejun Heo 
226473f53c4aSTejun Heo out_unlock:
226573f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
22661da177e4SLinus Torvalds }
2267ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
22681da177e4SLinus Torvalds 
2269db700897SOleg Nesterov /**
2270db700897SOleg Nesterov  * flush_work - block until a work_struct's callback has terminated
2271db700897SOleg Nesterov  * @work: the work which is to be flushed
2272db700897SOleg Nesterov  *
2273a67da70dSOleg Nesterov  * Returns false if @work has already terminated.
2274a67da70dSOleg Nesterov  *
2275db700897SOleg Nesterov  * It is expected that, prior to calling flush_work(), the caller has
2276db700897SOleg Nesterov  * arranged for the work to not be requeued, otherwise it doesn't make
2277db700897SOleg Nesterov  * sense to use this function.
2278db700897SOleg Nesterov  */
2279db700897SOleg Nesterov int flush_work(struct work_struct *work)
2280db700897SOleg Nesterov {
2281affee4b2STejun Heo 	struct worker *worker = NULL;
22828b03ae3cSTejun Heo 	struct global_cwq *gcwq;
22837a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq;
2284db700897SOleg Nesterov 	struct wq_barrier barr;
2285db700897SOleg Nesterov 
2286db700897SOleg Nesterov 	might_sleep();
22877a22ad75STejun Heo 	gcwq = get_work_gcwq(work);
22887a22ad75STejun Heo 	if (!gcwq)
2289db700897SOleg Nesterov 		return 0;
2290a67da70dSOleg Nesterov 
22918b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2292db700897SOleg Nesterov 	if (!list_empty(&work->entry)) {
2293db700897SOleg Nesterov 		/*
2294db700897SOleg Nesterov 		 * See the comment near try_to_grab_pending()->smp_rmb().
22957a22ad75STejun Heo 		 * If it was re-queued to a different gcwq under us, we
22967a22ad75STejun Heo 		 * are not going to wait.
2297db700897SOleg Nesterov 		 */
2298db700897SOleg Nesterov 		smp_rmb();
22997a22ad75STejun Heo 		cwq = get_work_cwq(work);
23007a22ad75STejun Heo 		if (unlikely(!cwq || gcwq != cwq->gcwq))
23014690c4abSTejun Heo 			goto already_gone;
2302db700897SOleg Nesterov 	} else {
23037a22ad75STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2304affee4b2STejun Heo 		if (!worker)
23054690c4abSTejun Heo 			goto already_gone;
23067a22ad75STejun Heo 		cwq = worker->current_cwq;
2307db700897SOleg Nesterov 	}
2308db700897SOleg Nesterov 
2309affee4b2STejun Heo 	insert_wq_barrier(cwq, &barr, work, worker);
23108b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23117a22ad75STejun Heo 
23127a22ad75STejun Heo 	lock_map_acquire(&cwq->wq->lockdep_map);
23137a22ad75STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
23147a22ad75STejun Heo 
2315db700897SOleg Nesterov 	wait_for_completion(&barr.done);
2316dc186ad7SThomas Gleixner 	destroy_work_on_stack(&barr.work);
2317db700897SOleg Nesterov 	return 1;
23184690c4abSTejun Heo already_gone:
23198b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23204690c4abSTejun Heo 	return 0;
2321db700897SOleg Nesterov }
2322db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2323db700897SOleg Nesterov 
23246e84d644SOleg Nesterov /*
23251f1f642eSOleg Nesterov  * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
23266e84d644SOleg Nesterov  * so this work can't be re-armed in any way.
23276e84d644SOleg Nesterov  */
23286e84d644SOleg Nesterov static int try_to_grab_pending(struct work_struct *work)
23296e84d644SOleg Nesterov {
23308b03ae3cSTejun Heo 	struct global_cwq *gcwq;
23311f1f642eSOleg Nesterov 	int ret = -1;
23326e84d644SOleg Nesterov 
233322df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
23341f1f642eSOleg Nesterov 		return 0;
23356e84d644SOleg Nesterov 
23366e84d644SOleg Nesterov 	/*
23376e84d644SOleg Nesterov 	 * The queueing is in progress, or it is already queued. Try to
23386e84d644SOleg Nesterov 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
23396e84d644SOleg Nesterov 	 */
23407a22ad75STejun Heo 	gcwq = get_work_gcwq(work);
23417a22ad75STejun Heo 	if (!gcwq)
23426e84d644SOleg Nesterov 		return ret;
23436e84d644SOleg Nesterov 
23448b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
23456e84d644SOleg Nesterov 	if (!list_empty(&work->entry)) {
23466e84d644SOleg Nesterov 		/*
23477a22ad75STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
23486e84d644SOleg Nesterov 		 * In that case we must see the new value after rmb(), see
23496e84d644SOleg Nesterov 		 * insert_work()->wmb().
23506e84d644SOleg Nesterov 		 */
23516e84d644SOleg Nesterov 		smp_rmb();
23527a22ad75STejun Heo 		if (gcwq == get_work_gcwq(work)) {
2353dc186ad7SThomas Gleixner 			debug_work_deactivate(work);
23546e84d644SOleg Nesterov 			list_del_init(&work->entry);
23557a22ad75STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
23567a22ad75STejun Heo 					     get_work_color(work));
23576e84d644SOleg Nesterov 			ret = 1;
23586e84d644SOleg Nesterov 		}
23596e84d644SOleg Nesterov 	}
23608b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
23616e84d644SOleg Nesterov 
23626e84d644SOleg Nesterov 	return ret;
23636e84d644SOleg Nesterov }
23646e84d644SOleg Nesterov 
23657a22ad75STejun Heo static void wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2366b89deed3SOleg Nesterov {
2367b89deed3SOleg Nesterov 	struct wq_barrier barr;
2368affee4b2STejun Heo 	struct worker *worker;
2369b89deed3SOleg Nesterov 
23708b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2371affee4b2STejun Heo 
23727a22ad75STejun Heo 	worker = find_worker_executing_work(gcwq, work);
23737a22ad75STejun Heo 	if (unlikely(worker))
23747a22ad75STejun Heo 		insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2375affee4b2STejun Heo 
23768b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
2377b89deed3SOleg Nesterov 
2378affee4b2STejun Heo 	if (unlikely(worker)) {
2379b89deed3SOleg Nesterov 		wait_for_completion(&barr.done);
2380dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2381dc186ad7SThomas Gleixner 	}
2382b89deed3SOleg Nesterov }
2383b89deed3SOleg Nesterov 
23846e84d644SOleg Nesterov static void wait_on_work(struct work_struct *work)
2385b89deed3SOleg Nesterov {
2386b1f4ec17SOleg Nesterov 	int cpu;
2387b89deed3SOleg Nesterov 
2388f293ea92SOleg Nesterov 	might_sleep();
2389f293ea92SOleg Nesterov 
23903295f0efSIngo Molnar 	lock_map_acquire(&work->lockdep_map);
23913295f0efSIngo Molnar 	lock_map_release(&work->lockdep_map);
23924e6045f1SJohannes Berg 
2393f3421797STejun Heo 	for_each_gcwq_cpu(cpu)
23947a22ad75STejun Heo 		wait_on_cpu_work(get_gcwq(cpu), work);
23956e84d644SOleg Nesterov }
23966e84d644SOleg Nesterov 
23971f1f642eSOleg Nesterov static int __cancel_work_timer(struct work_struct *work,
23981f1f642eSOleg Nesterov 				struct timer_list* timer)
23991f1f642eSOleg Nesterov {
24001f1f642eSOleg Nesterov 	int ret;
24011f1f642eSOleg Nesterov 
24021f1f642eSOleg Nesterov 	do {
24031f1f642eSOleg Nesterov 		ret = (timer && likely(del_timer(timer)));
24041f1f642eSOleg Nesterov 		if (!ret)
24051f1f642eSOleg Nesterov 			ret = try_to_grab_pending(work);
24061f1f642eSOleg Nesterov 		wait_on_work(work);
24071f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
24081f1f642eSOleg Nesterov 
24097a22ad75STejun Heo 	clear_work_data(work);
24101f1f642eSOleg Nesterov 	return ret;
24111f1f642eSOleg Nesterov }
24121f1f642eSOleg Nesterov 
24136e84d644SOleg Nesterov /**
24146e84d644SOleg Nesterov  * cancel_work_sync - block until a work_struct's callback has terminated
24156e84d644SOleg Nesterov  * @work: the work which is to be flushed
24166e84d644SOleg Nesterov  *
24171f1f642eSOleg Nesterov  * Returns true if @work was pending.
24181f1f642eSOleg Nesterov  *
24196e84d644SOleg Nesterov  * cancel_work_sync() will cancel the work if it is queued. If the work's
24206e84d644SOleg Nesterov  * callback appears to be running, cancel_work_sync() will block until it
24216e84d644SOleg Nesterov  * has completed.
24226e84d644SOleg Nesterov  *
24236e84d644SOleg Nesterov  * It is possible to use this function if the work re-queues itself. It can
24246e84d644SOleg Nesterov  * cancel the work even if it migrates to another workqueue, however in that
24256e84d644SOleg Nesterov  * case it only guarantees that work->func() has completed on the last queued
24266e84d644SOleg Nesterov  * workqueue.
24276e84d644SOleg Nesterov  *
24286e84d644SOleg Nesterov  * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
24296e84d644SOleg Nesterov  * pending, otherwise it goes into a busy-wait loop until the timer expires.
24306e84d644SOleg Nesterov  *
24316e84d644SOleg Nesterov  * The caller must ensure that workqueue_struct on which this work was last
24326e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
24336e84d644SOleg Nesterov  */
24341f1f642eSOleg Nesterov int cancel_work_sync(struct work_struct *work)
24356e84d644SOleg Nesterov {
24361f1f642eSOleg Nesterov 	return __cancel_work_timer(work, NULL);
2437b89deed3SOleg Nesterov }
243828e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2439b89deed3SOleg Nesterov 
24406e84d644SOleg Nesterov /**
2441f5a421a4SOleg Nesterov  * cancel_delayed_work_sync - reliably kill off a delayed work.
24426e84d644SOleg Nesterov  * @dwork: the delayed work struct
24436e84d644SOleg Nesterov  *
24441f1f642eSOleg Nesterov  * Returns true if @dwork was pending.
24451f1f642eSOleg Nesterov  *
24466e84d644SOleg Nesterov  * It is possible to use this function if @dwork rearms itself via queue_work()
24476e84d644SOleg Nesterov  * or queue_delayed_work(). See also the comment for cancel_work_sync().
24486e84d644SOleg Nesterov  */
24491f1f642eSOleg Nesterov int cancel_delayed_work_sync(struct delayed_work *dwork)
24506e84d644SOleg Nesterov {
24511f1f642eSOleg Nesterov 	return __cancel_work_timer(&dwork->work, &dwork->timer);
24526e84d644SOleg Nesterov }
2453f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
24541da177e4SLinus Torvalds 
24550fcb78c2SRolf Eike Beer /**
24560fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
24570fcb78c2SRolf Eike Beer  * @work: job to be done
24580fcb78c2SRolf Eike Beer  *
24595b0f437dSBart Van Assche  * Returns zero if @work was already on the kernel-global workqueue and
24605b0f437dSBart Van Assche  * non-zero otherwise.
24615b0f437dSBart Van Assche  *
24625b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
24635b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
24645b0f437dSBart Van Assche  * workqueue otherwise.
24650fcb78c2SRolf Eike Beer  */
24667ad5b3a5SHarvey Harrison int schedule_work(struct work_struct *work)
24671da177e4SLinus Torvalds {
2468d320c038STejun Heo 	return queue_work(system_wq, work);
24691da177e4SLinus Torvalds }
2470ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
24711da177e4SLinus Torvalds 
2472c1a220e7SZhang Rui /*
2473c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2474c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2475c1a220e7SZhang Rui  * @work: job to be done
2476c1a220e7SZhang Rui  *
2477c1a220e7SZhang Rui  * This puts a job on a specific cpu
2478c1a220e7SZhang Rui  */
2479c1a220e7SZhang Rui int schedule_work_on(int cpu, struct work_struct *work)
2480c1a220e7SZhang Rui {
2481d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2482c1a220e7SZhang Rui }
2483c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2484c1a220e7SZhang Rui 
24850fcb78c2SRolf Eike Beer /**
24860fcb78c2SRolf Eike Beer  * schedule_delayed_work - put work task in global workqueue after delay
248752bad64dSDavid Howells  * @dwork: job to be done
248852bad64dSDavid Howells  * @delay: number of jiffies to wait or 0 for immediate execution
24890fcb78c2SRolf Eike Beer  *
24900fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
24910fcb78c2SRolf Eike Beer  * workqueue.
24920fcb78c2SRolf Eike Beer  */
24937ad5b3a5SHarvey Harrison int schedule_delayed_work(struct delayed_work *dwork,
249482f67cd9SIngo Molnar 					unsigned long delay)
24951da177e4SLinus Torvalds {
2496d320c038STejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
24971da177e4SLinus Torvalds }
2498ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work);
24991da177e4SLinus Torvalds 
25000fcb78c2SRolf Eike Beer /**
25018c53e463SLinus Torvalds  * flush_delayed_work - block until a dwork_struct's callback has terminated
25028c53e463SLinus Torvalds  * @dwork: the delayed work which is to be flushed
25038c53e463SLinus Torvalds  *
25048c53e463SLinus Torvalds  * Any timeout is cancelled, and any pending work is run immediately.
25058c53e463SLinus Torvalds  */
25068c53e463SLinus Torvalds void flush_delayed_work(struct delayed_work *dwork)
25078c53e463SLinus Torvalds {
25088c53e463SLinus Torvalds 	if (del_timer_sync(&dwork->timer)) {
25097a22ad75STejun Heo 		__queue_work(get_cpu(), get_work_cwq(&dwork->work)->wq,
25104690c4abSTejun Heo 			     &dwork->work);
25118c53e463SLinus Torvalds 		put_cpu();
25128c53e463SLinus Torvalds 	}
25138c53e463SLinus Torvalds 	flush_work(&dwork->work);
25148c53e463SLinus Torvalds }
25158c53e463SLinus Torvalds EXPORT_SYMBOL(flush_delayed_work);
25168c53e463SLinus Torvalds 
25178c53e463SLinus Torvalds /**
25180fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
25190fcb78c2SRolf Eike Beer  * @cpu: cpu to use
252052bad64dSDavid Howells  * @dwork: job to be done
25210fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
25220fcb78c2SRolf Eike Beer  *
25230fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
25240fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
25250fcb78c2SRolf Eike Beer  */
25261da177e4SLinus Torvalds int schedule_delayed_work_on(int cpu,
252752bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
25281da177e4SLinus Torvalds {
2529d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
25301da177e4SLinus Torvalds }
2531ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
25321da177e4SLinus Torvalds 
2533b6136773SAndrew Morton /**
2534b6136773SAndrew Morton  * schedule_on_each_cpu - call a function on each online CPU from keventd
2535b6136773SAndrew Morton  * @func: the function to call
2536b6136773SAndrew Morton  *
2537b6136773SAndrew Morton  * Returns zero on success.
2538b6136773SAndrew Morton  * Returns -ve errno on failure.
2539b6136773SAndrew Morton  *
2540b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
2541b6136773SAndrew Morton  */
254265f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
254315316ba8SChristoph Lameter {
254415316ba8SChristoph Lameter 	int cpu;
2545b6136773SAndrew Morton 	struct work_struct *works;
254615316ba8SChristoph Lameter 
2547b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
2548b6136773SAndrew Morton 	if (!works)
254915316ba8SChristoph Lameter 		return -ENOMEM;
2550b6136773SAndrew Morton 
255195402b38SGautham R Shenoy 	get_online_cpus();
255293981800STejun Heo 
255315316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
25549bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
25559bfb1839SIngo Molnar 
25569bfb1839SIngo Molnar 		INIT_WORK(work, func);
25578de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
255815316ba8SChristoph Lameter 	}
255993981800STejun Heo 
256093981800STejun Heo 	for_each_online_cpu(cpu)
25618616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
256293981800STejun Heo 
256395402b38SGautham R Shenoy 	put_online_cpus();
2564b6136773SAndrew Morton 	free_percpu(works);
256515316ba8SChristoph Lameter 	return 0;
256615316ba8SChristoph Lameter }
256715316ba8SChristoph Lameter 
2568eef6a7d5SAlan Stern /**
2569eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
2570eef6a7d5SAlan Stern  *
2571eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
2572eef6a7d5SAlan Stern  * completion.
2573eef6a7d5SAlan Stern  *
2574eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
2575eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
2576eef6a7d5SAlan Stern  * will lead to deadlock:
2577eef6a7d5SAlan Stern  *
2578eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
2579eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
2580eef6a7d5SAlan Stern  *
2581eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
2582eef6a7d5SAlan Stern  *
2583eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
2584eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
2585eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
2586eef6a7d5SAlan Stern  *
2587eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
2588eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
2589eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
2590eef6a7d5SAlan Stern  * cancel_work_sync() instead.
2591eef6a7d5SAlan Stern  */
25921da177e4SLinus Torvalds void flush_scheduled_work(void)
25931da177e4SLinus Torvalds {
2594d320c038STejun Heo 	flush_workqueue(system_wq);
25951da177e4SLinus Torvalds }
2596ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
25971da177e4SLinus Torvalds 
25981da177e4SLinus Torvalds /**
25991fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
26001fa44ecaSJames Bottomley  * @fn:		the function to execute
26011fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
26021fa44ecaSJames Bottomley  *		be available when the work executes)
26031fa44ecaSJames Bottomley  *
26041fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
26051fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
26061fa44ecaSJames Bottomley  *
26071fa44ecaSJames Bottomley  * Returns:	0 - function was executed
26081fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
26091fa44ecaSJames Bottomley  */
261065f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
26111fa44ecaSJames Bottomley {
26121fa44ecaSJames Bottomley 	if (!in_interrupt()) {
261365f27f38SDavid Howells 		fn(&ew->work);
26141fa44ecaSJames Bottomley 		return 0;
26151fa44ecaSJames Bottomley 	}
26161fa44ecaSJames Bottomley 
261765f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
26181fa44ecaSJames Bottomley 	schedule_work(&ew->work);
26191fa44ecaSJames Bottomley 
26201fa44ecaSJames Bottomley 	return 1;
26211fa44ecaSJames Bottomley }
26221fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
26231fa44ecaSJames Bottomley 
26241da177e4SLinus Torvalds int keventd_up(void)
26251da177e4SLinus Torvalds {
2626d320c038STejun Heo 	return system_wq != NULL;
26271da177e4SLinus Torvalds }
26281da177e4SLinus Torvalds 
2629bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
26300f900049STejun Heo {
26310f900049STejun Heo 	/*
26320f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
26330f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
26340f900049STejun Heo 	 * unsigned long long.
26350f900049STejun Heo 	 */
26360f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
26370f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
26380f900049STejun Heo 				   __alignof__(unsigned long long));
2639931ac77eSTejun Heo #ifdef CONFIG_SMP
2640931ac77eSTejun Heo 	bool percpu = !(wq->flags & WQ_UNBOUND);
2641931ac77eSTejun Heo #else
2642931ac77eSTejun Heo 	bool percpu = false;
2643931ac77eSTejun Heo #endif
2644f3421797STejun Heo 
2645931ac77eSTejun Heo 	if (percpu)
2646f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
2647931ac77eSTejun Heo 	else {
26480f900049STejun Heo 		void *ptr;
26490f900049STejun Heo 
26500f900049STejun Heo 		/*
2651f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
2652f3421797STejun Heo 		 * pointer at the end pointing back to the originally
2653f3421797STejun Heo 		 * allocated pointer which will be used for free.
26540f900049STejun Heo 		 */
2655bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2656bdbc5dd7STejun Heo 		if (ptr) {
2657bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2658bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
2659bdbc5dd7STejun Heo 		}
2660f3421797STejun Heo 	}
2661f3421797STejun Heo 
26620f900049STejun Heo 	/* just in case, make sure it's actually aligned */
2663bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2664bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
26650f900049STejun Heo }
26660f900049STejun Heo 
2667bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
26680f900049STejun Heo {
2669931ac77eSTejun Heo #ifdef CONFIG_SMP
2670931ac77eSTejun Heo 	bool percpu = !(wq->flags & WQ_UNBOUND);
2671931ac77eSTejun Heo #else
2672931ac77eSTejun Heo 	bool percpu = false;
2673931ac77eSTejun Heo #endif
2674931ac77eSTejun Heo 
2675931ac77eSTejun Heo 	if (percpu)
2676bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
2677f3421797STejun Heo 	else if (wq->cpu_wq.single) {
2678f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
2679f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
2680f3421797STejun Heo 	}
26810f900049STejun Heo }
26820f900049STejun Heo 
2683f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
2684f3421797STejun Heo 			       const char *name)
2685b71ab8c2STejun Heo {
2686f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2687f3421797STejun Heo 
2688f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
2689b71ab8c2STejun Heo 		printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2690b71ab8c2STejun Heo 		       "is out of range, clamping between %d and %d\n",
2691f3421797STejun Heo 		       max_active, name, 1, lim);
2692b71ab8c2STejun Heo 
2693f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
2694b71ab8c2STejun Heo }
2695b71ab8c2STejun Heo 
2696d320c038STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *name,
269797e37d7bSTejun Heo 					       unsigned int flags,
26981e19ffc6STejun Heo 					       int max_active,
2699eb13ba87SJohannes Berg 					       struct lock_class_key *key,
2700eb13ba87SJohannes Berg 					       const char *lock_name)
27013af24433SOleg Nesterov {
27023af24433SOleg Nesterov 	struct workqueue_struct *wq;
2703c34056a3STejun Heo 	unsigned int cpu;
27043af24433SOleg Nesterov 
2705f3421797STejun Heo 	/*
2706f3421797STejun Heo 	 * Unbound workqueues aren't concurrency managed and should be
2707f3421797STejun Heo 	 * dispatched to workers immediately.
2708f3421797STejun Heo 	 */
2709f3421797STejun Heo 	if (flags & WQ_UNBOUND)
2710f3421797STejun Heo 		flags |= WQ_HIGHPRI;
2711f3421797STejun Heo 
2712d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
2713f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, name);
27141e19ffc6STejun Heo 
27153af24433SOleg Nesterov 	wq = kzalloc(sizeof(*wq), GFP_KERNEL);
27163af24433SOleg Nesterov 	if (!wq)
27174690c4abSTejun Heo 		goto err;
27183af24433SOleg Nesterov 
271997e37d7bSTejun Heo 	wq->flags = flags;
2720a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
272173f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
272273f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
272373f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
272473f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
2725502ca9d8STejun Heo 
27263af24433SOleg Nesterov 	wq->name = name;
2727eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
2728cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
27293af24433SOleg Nesterov 
2730bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
2731bdbc5dd7STejun Heo 		goto err;
2732bdbc5dd7STejun Heo 
2733f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
27341537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
27358b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
27361537663fSTejun Heo 
27370f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
27388b03ae3cSTejun Heo 		cwq->gcwq = gcwq;
2739c34056a3STejun Heo 		cwq->wq = wq;
274073f53c4aSTejun Heo 		cwq->flush_color = -1;
27411e19ffc6STejun Heo 		cwq->max_active = max_active;
27421e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
2743e22bee78STejun Heo 	}
27441537663fSTejun Heo 
2745e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
2746e22bee78STejun Heo 		struct worker *rescuer;
2747e22bee78STejun Heo 
2748*f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
2749e22bee78STejun Heo 			goto err;
2750e22bee78STejun Heo 
2751e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
2752e22bee78STejun Heo 		if (!rescuer)
2753e22bee78STejun Heo 			goto err;
2754e22bee78STejun Heo 
2755e22bee78STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s", name);
2756e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
2757e22bee78STejun Heo 			goto err;
2758e22bee78STejun Heo 
2759e22bee78STejun Heo 		wq->rescuer = rescuer;
2760e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
2761e22bee78STejun Heo 		wake_up_process(rescuer->task);
27623af24433SOleg Nesterov 	}
27631537663fSTejun Heo 
2764a0a1a5fdSTejun Heo 	/*
2765a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
2766a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
2767a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
2768a0a1a5fdSTejun Heo 	 */
27691537663fSTejun Heo 	spin_lock(&workqueue_lock);
2770a0a1a5fdSTejun Heo 
2771a0a1a5fdSTejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZEABLE)
2772f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
2773a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
2774a0a1a5fdSTejun Heo 
27751537663fSTejun Heo 	list_add(&wq->list, &workqueues);
2776a0a1a5fdSTejun Heo 
27771537663fSTejun Heo 	spin_unlock(&workqueue_lock);
27781537663fSTejun Heo 
27793af24433SOleg Nesterov 	return wq;
27804690c4abSTejun Heo err:
27814690c4abSTejun Heo 	if (wq) {
2782bdbc5dd7STejun Heo 		free_cwqs(wq);
2783*f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
2784e22bee78STejun Heo 		kfree(wq->rescuer);
27854690c4abSTejun Heo 		kfree(wq);
27864690c4abSTejun Heo 	}
27874690c4abSTejun Heo 	return NULL;
27883af24433SOleg Nesterov }
2789d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
27903af24433SOleg Nesterov 
27913af24433SOleg Nesterov /**
27923af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
27933af24433SOleg Nesterov  * @wq: target workqueue
27943af24433SOleg Nesterov  *
27953af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
27963af24433SOleg Nesterov  */
27973af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
27983af24433SOleg Nesterov {
2799c8e55f36STejun Heo 	unsigned int cpu;
28003af24433SOleg Nesterov 
2801a0a1a5fdSTejun Heo 	flush_workqueue(wq);
2802a0a1a5fdSTejun Heo 
2803a0a1a5fdSTejun Heo 	/*
2804a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
2805a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
2806a0a1a5fdSTejun Heo 	 */
280795402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
28083af24433SOleg Nesterov 	list_del(&wq->list);
280995402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
28103af24433SOleg Nesterov 
2811e22bee78STejun Heo 	/* sanity check */
2812f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
281373f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
281473f53c4aSTejun Heo 		int i;
281573f53c4aSTejun Heo 
281673f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
281773f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
28181e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
28191e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
282073f53c4aSTejun Heo 	}
28211537663fSTejun Heo 
2822e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
2823e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
2824*f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
2825e22bee78STejun Heo 	}
2826e22bee78STejun Heo 
2827bdbc5dd7STejun Heo 	free_cwqs(wq);
28283af24433SOleg Nesterov 	kfree(wq);
28293af24433SOleg Nesterov }
28303af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
28313af24433SOleg Nesterov 
2832dcd989cbSTejun Heo /**
2833dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
2834dcd989cbSTejun Heo  * @wq: target workqueue
2835dcd989cbSTejun Heo  * @max_active: new max_active value.
2836dcd989cbSTejun Heo  *
2837dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
2838dcd989cbSTejun Heo  *
2839dcd989cbSTejun Heo  * CONTEXT:
2840dcd989cbSTejun Heo  * Don't call from IRQ context.
2841dcd989cbSTejun Heo  */
2842dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
2843dcd989cbSTejun Heo {
2844dcd989cbSTejun Heo 	unsigned int cpu;
2845dcd989cbSTejun Heo 
2846f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
2847dcd989cbSTejun Heo 
2848dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
2849dcd989cbSTejun Heo 
2850dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
2851dcd989cbSTejun Heo 
2852f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
2853dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
2854dcd989cbSTejun Heo 
2855dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
2856dcd989cbSTejun Heo 
2857dcd989cbSTejun Heo 		if (!(wq->flags & WQ_FREEZEABLE) ||
2858dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
2859dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
2860dcd989cbSTejun Heo 
2861dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
2862dcd989cbSTejun Heo 	}
2863dcd989cbSTejun Heo 
2864dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
2865dcd989cbSTejun Heo }
2866dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
2867dcd989cbSTejun Heo 
2868dcd989cbSTejun Heo /**
2869dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
2870dcd989cbSTejun Heo  * @cpu: CPU in question
2871dcd989cbSTejun Heo  * @wq: target workqueue
2872dcd989cbSTejun Heo  *
2873dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
2874dcd989cbSTejun Heo  * no synchronization around this function and the test result is
2875dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
2876dcd989cbSTejun Heo  *
2877dcd989cbSTejun Heo  * RETURNS:
2878dcd989cbSTejun Heo  * %true if congested, %false otherwise.
2879dcd989cbSTejun Heo  */
2880dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
2881dcd989cbSTejun Heo {
2882dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2883dcd989cbSTejun Heo 
2884dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
2885dcd989cbSTejun Heo }
2886dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
2887dcd989cbSTejun Heo 
2888dcd989cbSTejun Heo /**
2889dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
2890dcd989cbSTejun Heo  * @work: the work of interest
2891dcd989cbSTejun Heo  *
2892dcd989cbSTejun Heo  * RETURNS:
2893bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
2894dcd989cbSTejun Heo  */
2895dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
2896dcd989cbSTejun Heo {
2897dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
2898dcd989cbSTejun Heo 
2899bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
2900dcd989cbSTejun Heo }
2901dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
2902dcd989cbSTejun Heo 
2903dcd989cbSTejun Heo /**
2904dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
2905dcd989cbSTejun Heo  * @work: the work to be tested
2906dcd989cbSTejun Heo  *
2907dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
2908dcd989cbSTejun Heo  * synchronization around this function and the test result is
2909dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
2910dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
2911dcd989cbSTejun Heo  * running state.
2912dcd989cbSTejun Heo  *
2913dcd989cbSTejun Heo  * RETURNS:
2914dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
2915dcd989cbSTejun Heo  */
2916dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
2917dcd989cbSTejun Heo {
2918dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
2919dcd989cbSTejun Heo 	unsigned long flags;
2920dcd989cbSTejun Heo 	unsigned int ret = 0;
2921dcd989cbSTejun Heo 
2922dcd989cbSTejun Heo 	if (!gcwq)
2923dcd989cbSTejun Heo 		return false;
2924dcd989cbSTejun Heo 
2925dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
2926dcd989cbSTejun Heo 
2927dcd989cbSTejun Heo 	if (work_pending(work))
2928dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
2929dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
2930dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
2931dcd989cbSTejun Heo 
2932dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
2933dcd989cbSTejun Heo 
2934dcd989cbSTejun Heo 	return ret;
2935dcd989cbSTejun Heo }
2936dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
2937dcd989cbSTejun Heo 
2938db7bccf4STejun Heo /*
2939db7bccf4STejun Heo  * CPU hotplug.
2940db7bccf4STejun Heo  *
2941e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
2942e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
2943e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
2944e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
2945e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
2946e22bee78STejun Heo  * blocked draining impractical.
2947e22bee78STejun Heo  *
2948e22bee78STejun Heo  * This is solved by allowing a gcwq to be detached from CPU, running
2949e22bee78STejun Heo  * it with unbound (rogue) workers and allowing it to be reattached
2950e22bee78STejun Heo  * later if the cpu comes back online.  A separate thread is created
2951e22bee78STejun Heo  * to govern a gcwq in such state and is called the trustee of the
2952e22bee78STejun Heo  * gcwq.
2953db7bccf4STejun Heo  *
2954db7bccf4STejun Heo  * Trustee states and their descriptions.
2955db7bccf4STejun Heo  *
2956db7bccf4STejun Heo  * START	Command state used on startup.  On CPU_DOWN_PREPARE, a
2957db7bccf4STejun Heo  *		new trustee is started with this state.
2958db7bccf4STejun Heo  *
2959db7bccf4STejun Heo  * IN_CHARGE	Once started, trustee will enter this state after
2960e22bee78STejun Heo  *		assuming the manager role and making all existing
2961e22bee78STejun Heo  *		workers rogue.  DOWN_PREPARE waits for trustee to
2962e22bee78STejun Heo  *		enter this state.  After reaching IN_CHARGE, trustee
2963e22bee78STejun Heo  *		tries to execute the pending worklist until it's empty
2964e22bee78STejun Heo  *		and the state is set to BUTCHER, or the state is set
2965e22bee78STejun Heo  *		to RELEASE.
2966db7bccf4STejun Heo  *
2967db7bccf4STejun Heo  * BUTCHER	Command state which is set by the cpu callback after
2968db7bccf4STejun Heo  *		the cpu has went down.  Once this state is set trustee
2969db7bccf4STejun Heo  *		knows that there will be no new works on the worklist
2970db7bccf4STejun Heo  *		and once the worklist is empty it can proceed to
2971db7bccf4STejun Heo  *		killing idle workers.
2972db7bccf4STejun Heo  *
2973db7bccf4STejun Heo  * RELEASE	Command state which is set by the cpu callback if the
2974db7bccf4STejun Heo  *		cpu down has been canceled or it has come online
2975db7bccf4STejun Heo  *		again.  After recognizing this state, trustee stops
2976e22bee78STejun Heo  *		trying to drain or butcher and clears ROGUE, rebinds
2977e22bee78STejun Heo  *		all remaining workers back to the cpu and releases
2978e22bee78STejun Heo  *		manager role.
2979db7bccf4STejun Heo  *
2980db7bccf4STejun Heo  * DONE		Trustee will enter this state after BUTCHER or RELEASE
2981db7bccf4STejun Heo  *		is complete.
2982db7bccf4STejun Heo  *
2983db7bccf4STejun Heo  *          trustee                 CPU                draining
2984db7bccf4STejun Heo  *         took over                down               complete
2985db7bccf4STejun Heo  * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
2986db7bccf4STejun Heo  *                        |                     |                  ^
2987db7bccf4STejun Heo  *                        | CPU is back online  v   return workers |
2988db7bccf4STejun Heo  *                         ----------------> RELEASE --------------
2989db7bccf4STejun Heo  */
2990db7bccf4STejun Heo 
2991db7bccf4STejun Heo /**
2992db7bccf4STejun Heo  * trustee_wait_event_timeout - timed event wait for trustee
2993db7bccf4STejun Heo  * @cond: condition to wait for
2994db7bccf4STejun Heo  * @timeout: timeout in jiffies
2995db7bccf4STejun Heo  *
2996db7bccf4STejun Heo  * wait_event_timeout() for trustee to use.  Handles locking and
2997db7bccf4STejun Heo  * checks for RELEASE request.
2998db7bccf4STejun Heo  *
2999db7bccf4STejun Heo  * CONTEXT:
3000db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3001db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3002db7bccf4STejun Heo  *
3003db7bccf4STejun Heo  * RETURNS:
3004db7bccf4STejun Heo  * Positive indicating left time if @cond is satisfied, 0 if timed
3005db7bccf4STejun Heo  * out, -1 if canceled.
3006db7bccf4STejun Heo  */
3007db7bccf4STejun Heo #define trustee_wait_event_timeout(cond, timeout) ({			\
3008db7bccf4STejun Heo 	long __ret = (timeout);						\
3009db7bccf4STejun Heo 	while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) &&	\
3010db7bccf4STejun Heo 	       __ret) {							\
3011db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);				\
3012db7bccf4STejun Heo 		__wait_event_timeout(gcwq->trustee_wait, (cond) ||	\
3013db7bccf4STejun Heo 			(gcwq->trustee_state == TRUSTEE_RELEASE),	\
3014db7bccf4STejun Heo 			__ret);						\
3015db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);				\
3016db7bccf4STejun Heo 	}								\
3017db7bccf4STejun Heo 	gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret);		\
3018db7bccf4STejun Heo })
3019db7bccf4STejun Heo 
3020db7bccf4STejun Heo /**
3021db7bccf4STejun Heo  * trustee_wait_event - event wait for trustee
3022db7bccf4STejun Heo  * @cond: condition to wait for
3023db7bccf4STejun Heo  *
3024db7bccf4STejun Heo  * wait_event() for trustee to use.  Automatically handles locking and
3025db7bccf4STejun Heo  * checks for CANCEL request.
3026db7bccf4STejun Heo  *
3027db7bccf4STejun Heo  * CONTEXT:
3028db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3029db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3030db7bccf4STejun Heo  *
3031db7bccf4STejun Heo  * RETURNS:
3032db7bccf4STejun Heo  * 0 if @cond is satisfied, -1 if canceled.
3033db7bccf4STejun Heo  */
3034db7bccf4STejun Heo #define trustee_wait_event(cond) ({					\
3035db7bccf4STejun Heo 	long __ret1;							\
3036db7bccf4STejun Heo 	__ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3037db7bccf4STejun Heo 	__ret1 < 0 ? -1 : 0;						\
3038db7bccf4STejun Heo })
3039db7bccf4STejun Heo 
3040db7bccf4STejun Heo static int __cpuinit trustee_thread(void *__gcwq)
3041db7bccf4STejun Heo {
3042db7bccf4STejun Heo 	struct global_cwq *gcwq = __gcwq;
3043db7bccf4STejun Heo 	struct worker *worker;
3044e22bee78STejun Heo 	struct work_struct *work;
3045db7bccf4STejun Heo 	struct hlist_node *pos;
3046e22bee78STejun Heo 	long rc;
3047db7bccf4STejun Heo 	int i;
3048db7bccf4STejun Heo 
3049db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3050db7bccf4STejun Heo 
3051db7bccf4STejun Heo 	spin_lock_irq(&gcwq->lock);
3052db7bccf4STejun Heo 	/*
3053e22bee78STejun Heo 	 * Claim the manager position and make all workers rogue.
3054e22bee78STejun Heo 	 * Trustee must be bound to the target cpu and can't be
3055e22bee78STejun Heo 	 * cancelled.
3056db7bccf4STejun Heo 	 */
3057db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3058e22bee78STejun Heo 	rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3059e22bee78STejun Heo 	BUG_ON(rc < 0);
3060e22bee78STejun Heo 
3061e22bee78STejun Heo 	gcwq->flags |= GCWQ_MANAGING_WORKERS;
3062db7bccf4STejun Heo 
3063db7bccf4STejun Heo 	list_for_each_entry(worker, &gcwq->idle_list, entry)
3064cb444766STejun Heo 		worker->flags |= WORKER_ROGUE;
3065db7bccf4STejun Heo 
3066db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3067cb444766STejun Heo 		worker->flags |= WORKER_ROGUE;
3068db7bccf4STejun Heo 
3069db7bccf4STejun Heo 	/*
3070e22bee78STejun Heo 	 * Call schedule() so that we cross rq->lock and thus can
3071e22bee78STejun Heo 	 * guarantee sched callbacks see the rogue flag.  This is
3072e22bee78STejun Heo 	 * necessary as scheduler callbacks may be invoked from other
3073e22bee78STejun Heo 	 * cpus.
3074e22bee78STejun Heo 	 */
3075e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3076e22bee78STejun Heo 	schedule();
3077e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3078e22bee78STejun Heo 
3079e22bee78STejun Heo 	/*
3080cb444766STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After
3081cb444766STejun Heo 	 * this, nr_running stays zero and need_more_worker() and
3082cb444766STejun Heo 	 * keep_working() are always true as long as the worklist is
3083cb444766STejun Heo 	 * not empty.
3084e22bee78STejun Heo 	 */
3085cb444766STejun Heo 	atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
3086e22bee78STejun Heo 
3087e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3088e22bee78STejun Heo 	del_timer_sync(&gcwq->idle_timer);
3089e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3090e22bee78STejun Heo 
3091e22bee78STejun Heo 	/*
3092db7bccf4STejun Heo 	 * We're now in charge.  Notify and proceed to drain.  We need
3093db7bccf4STejun Heo 	 * to keep the gcwq running during the whole CPU down
3094db7bccf4STejun Heo 	 * procedure as other cpu hotunplug callbacks may need to
3095db7bccf4STejun Heo 	 * flush currently running tasks.
3096db7bccf4STejun Heo 	 */
3097db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3098db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3099db7bccf4STejun Heo 
3100db7bccf4STejun Heo 	/*
3101db7bccf4STejun Heo 	 * The original cpu is in the process of dying and may go away
3102db7bccf4STejun Heo 	 * anytime now.  When that happens, we and all workers would
3103e22bee78STejun Heo 	 * be migrated to other cpus.  Try draining any left work.  We
3104e22bee78STejun Heo 	 * want to get it over with ASAP - spam rescuers, wake up as
3105e22bee78STejun Heo 	 * many idlers as necessary and create new ones till the
3106e22bee78STejun Heo 	 * worklist is empty.  Note that if the gcwq is frozen, there
3107e22bee78STejun Heo 	 * may be frozen works in freezeable cwqs.  Don't declare
3108e22bee78STejun Heo 	 * completion while frozen.
3109db7bccf4STejun Heo 	 */
3110db7bccf4STejun Heo 	while (gcwq->nr_workers != gcwq->nr_idle ||
3111db7bccf4STejun Heo 	       gcwq->flags & GCWQ_FREEZING ||
3112db7bccf4STejun Heo 	       gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
3113e22bee78STejun Heo 		int nr_works = 0;
3114e22bee78STejun Heo 
3115e22bee78STejun Heo 		list_for_each_entry(work, &gcwq->worklist, entry) {
3116e22bee78STejun Heo 			send_mayday(work);
3117e22bee78STejun Heo 			nr_works++;
3118e22bee78STejun Heo 		}
3119e22bee78STejun Heo 
3120e22bee78STejun Heo 		list_for_each_entry(worker, &gcwq->idle_list, entry) {
3121e22bee78STejun Heo 			if (!nr_works--)
3122e22bee78STejun Heo 				break;
3123e22bee78STejun Heo 			wake_up_process(worker->task);
3124e22bee78STejun Heo 		}
3125e22bee78STejun Heo 
3126e22bee78STejun Heo 		if (need_to_create_worker(gcwq)) {
3127e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
3128e22bee78STejun Heo 			worker = create_worker(gcwq, false);
3129e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
3130e22bee78STejun Heo 			if (worker) {
3131cb444766STejun Heo 				worker->flags |= WORKER_ROGUE;
3132e22bee78STejun Heo 				start_worker(worker);
3133e22bee78STejun Heo 			}
3134e22bee78STejun Heo 		}
3135e22bee78STejun Heo 
3136db7bccf4STejun Heo 		/* give a breather */
3137db7bccf4STejun Heo 		if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3138db7bccf4STejun Heo 			break;
3139db7bccf4STejun Heo 	}
3140db7bccf4STejun Heo 
3141e22bee78STejun Heo 	/*
3142e22bee78STejun Heo 	 * Either all works have been scheduled and cpu is down, or
3143e22bee78STejun Heo 	 * cpu down has already been canceled.  Wait for and butcher
3144e22bee78STejun Heo 	 * all workers till we're canceled.
3145e22bee78STejun Heo 	 */
3146e22bee78STejun Heo 	do {
3147e22bee78STejun Heo 		rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3148e22bee78STejun Heo 		while (!list_empty(&gcwq->idle_list))
3149e22bee78STejun Heo 			destroy_worker(list_first_entry(&gcwq->idle_list,
3150e22bee78STejun Heo 							struct worker, entry));
3151e22bee78STejun Heo 	} while (gcwq->nr_workers && rc >= 0);
3152e22bee78STejun Heo 
3153e22bee78STejun Heo 	/*
3154e22bee78STejun Heo 	 * At this point, either draining has completed and no worker
3155e22bee78STejun Heo 	 * is left, or cpu down has been canceled or the cpu is being
3156e22bee78STejun Heo 	 * brought back up.  There shouldn't be any idle one left.
3157e22bee78STejun Heo 	 * Tell the remaining busy ones to rebind once it finishes the
3158e22bee78STejun Heo 	 * currently scheduled works by scheduling the rebind_work.
3159e22bee78STejun Heo 	 */
3160e22bee78STejun Heo 	WARN_ON(!list_empty(&gcwq->idle_list));
3161e22bee78STejun Heo 
3162e22bee78STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
3163e22bee78STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
3164e22bee78STejun Heo 
3165e22bee78STejun Heo 		/*
3166e22bee78STejun Heo 		 * Rebind_work may race with future cpu hotplug
3167e22bee78STejun Heo 		 * operations.  Use a separate flag to mark that
3168e22bee78STejun Heo 		 * rebinding is scheduled.
3169e22bee78STejun Heo 		 */
3170cb444766STejun Heo 		worker->flags |= WORKER_REBIND;
3171cb444766STejun Heo 		worker->flags &= ~WORKER_ROGUE;
3172e22bee78STejun Heo 
3173e22bee78STejun Heo 		/* queue rebind_work, wq doesn't matter, use the default one */
3174e22bee78STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3175e22bee78STejun Heo 				     work_data_bits(rebind_work)))
3176e22bee78STejun Heo 			continue;
3177e22bee78STejun Heo 
3178e22bee78STejun Heo 		debug_work_activate(rebind_work);
3179d320c038STejun Heo 		insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
3180e22bee78STejun Heo 			    worker->scheduled.next,
3181e22bee78STejun Heo 			    work_color_to_flags(WORK_NO_COLOR));
3182e22bee78STejun Heo 	}
3183e22bee78STejun Heo 
3184e22bee78STejun Heo 	/* relinquish manager role */
3185e22bee78STejun Heo 	gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3186e22bee78STejun Heo 
3187db7bccf4STejun Heo 	/* notify completion */
3188db7bccf4STejun Heo 	gcwq->trustee = NULL;
3189db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_DONE;
3190db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3191db7bccf4STejun Heo 	spin_unlock_irq(&gcwq->lock);
3192db7bccf4STejun Heo 	return 0;
3193db7bccf4STejun Heo }
3194db7bccf4STejun Heo 
3195db7bccf4STejun Heo /**
3196db7bccf4STejun Heo  * wait_trustee_state - wait for trustee to enter the specified state
3197db7bccf4STejun Heo  * @gcwq: gcwq the trustee of interest belongs to
3198db7bccf4STejun Heo  * @state: target state to wait for
3199db7bccf4STejun Heo  *
3200db7bccf4STejun Heo  * Wait for the trustee to reach @state.  DONE is already matched.
3201db7bccf4STejun Heo  *
3202db7bccf4STejun Heo  * CONTEXT:
3203db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3204db7bccf4STejun Heo  * multiple times.  To be used by cpu_callback.
3205db7bccf4STejun Heo  */
3206db7bccf4STejun Heo static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
3207db7bccf4STejun Heo {
3208db7bccf4STejun Heo 	if (!(gcwq->trustee_state == state ||
3209db7bccf4STejun Heo 	      gcwq->trustee_state == TRUSTEE_DONE)) {
3210db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);
3211db7bccf4STejun Heo 		__wait_event(gcwq->trustee_wait,
3212db7bccf4STejun Heo 			     gcwq->trustee_state == state ||
3213db7bccf4STejun Heo 			     gcwq->trustee_state == TRUSTEE_DONE);
3214db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);
3215db7bccf4STejun Heo 	}
3216db7bccf4STejun Heo }
3217db7bccf4STejun Heo 
32189c7b216dSChandra Seetharaman static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
32191da177e4SLinus Torvalds 						unsigned long action,
32201da177e4SLinus Torvalds 						void *hcpu)
32211da177e4SLinus Torvalds {
32223af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3223db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
3224db7bccf4STejun Heo 	struct task_struct *new_trustee = NULL;
3225e22bee78STejun Heo 	struct worker *uninitialized_var(new_worker);
3226db7bccf4STejun Heo 	unsigned long flags;
32271da177e4SLinus Torvalds 
32288bb78442SRafael J. Wysocki 	action &= ~CPU_TASKS_FROZEN;
32298bb78442SRafael J. Wysocki 
3230db7bccf4STejun Heo 	switch (action) {
3231db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3232db7bccf4STejun Heo 		new_trustee = kthread_create(trustee_thread, gcwq,
3233db7bccf4STejun Heo 					     "workqueue_trustee/%d\n", cpu);
3234db7bccf4STejun Heo 		if (IS_ERR(new_trustee))
3235db7bccf4STejun Heo 			return notifier_from_errno(PTR_ERR(new_trustee));
3236db7bccf4STejun Heo 		kthread_bind(new_trustee, cpu);
3237e22bee78STejun Heo 		/* fall through */
3238e22bee78STejun Heo 	case CPU_UP_PREPARE:
3239e22bee78STejun Heo 		BUG_ON(gcwq->first_idle);
3240e22bee78STejun Heo 		new_worker = create_worker(gcwq, false);
3241e22bee78STejun Heo 		if (!new_worker) {
3242e22bee78STejun Heo 			if (new_trustee)
3243e22bee78STejun Heo 				kthread_stop(new_trustee);
3244e22bee78STejun Heo 			return NOTIFY_BAD;
3245e22bee78STejun Heo 		}
3246db7bccf4STejun Heo 	}
32471537663fSTejun Heo 
3248db7bccf4STejun Heo 	/* some are called w/ irq disabled, don't disturb irq status */
3249db7bccf4STejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
32503af24433SOleg Nesterov 
32513af24433SOleg Nesterov 	switch (action) {
3252db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3253db7bccf4STejun Heo 		/* initialize trustee and tell it to acquire the gcwq */
3254db7bccf4STejun Heo 		BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3255db7bccf4STejun Heo 		gcwq->trustee = new_trustee;
3256db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_START;
3257db7bccf4STejun Heo 		wake_up_process(gcwq->trustee);
3258db7bccf4STejun Heo 		wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3259e22bee78STejun Heo 		/* fall through */
3260e22bee78STejun Heo 	case CPU_UP_PREPARE:
3261e22bee78STejun Heo 		BUG_ON(gcwq->first_idle);
3262e22bee78STejun Heo 		gcwq->first_idle = new_worker;
3263e22bee78STejun Heo 		break;
3264e22bee78STejun Heo 
3265e22bee78STejun Heo 	case CPU_DYING:
3266e22bee78STejun Heo 		/*
3267e22bee78STejun Heo 		 * Before this, the trustee and all workers except for
3268e22bee78STejun Heo 		 * the ones which are still executing works from
3269e22bee78STejun Heo 		 * before the last CPU down must be on the cpu.  After
3270e22bee78STejun Heo 		 * this, they'll all be diasporas.
3271e22bee78STejun Heo 		 */
3272e22bee78STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
3273db7bccf4STejun Heo 		break;
3274db7bccf4STejun Heo 
32753da1c84cSOleg Nesterov 	case CPU_POST_DEAD:
3276db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_BUTCHER;
3277e22bee78STejun Heo 		/* fall through */
3278e22bee78STejun Heo 	case CPU_UP_CANCELED:
3279e22bee78STejun Heo 		destroy_worker(gcwq->first_idle);
3280e22bee78STejun Heo 		gcwq->first_idle = NULL;
3281db7bccf4STejun Heo 		break;
3282db7bccf4STejun Heo 
3283db7bccf4STejun Heo 	case CPU_DOWN_FAILED:
3284db7bccf4STejun Heo 	case CPU_ONLINE:
3285e22bee78STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
3286db7bccf4STejun Heo 		if (gcwq->trustee_state != TRUSTEE_DONE) {
3287db7bccf4STejun Heo 			gcwq->trustee_state = TRUSTEE_RELEASE;
3288db7bccf4STejun Heo 			wake_up_process(gcwq->trustee);
3289db7bccf4STejun Heo 			wait_trustee_state(gcwq, TRUSTEE_DONE);
3290db7bccf4STejun Heo 		}
3291db7bccf4STejun Heo 
3292e22bee78STejun Heo 		/*
3293e22bee78STejun Heo 		 * Trustee is done and there might be no worker left.
3294e22bee78STejun Heo 		 * Put the first_idle in and request a real manager to
3295e22bee78STejun Heo 		 * take a look.
3296e22bee78STejun Heo 		 */
3297e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
3298e22bee78STejun Heo 		kthread_bind(gcwq->first_idle->task, cpu);
3299e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
3300e22bee78STejun Heo 		gcwq->flags |= GCWQ_MANAGE_WORKERS;
3301e22bee78STejun Heo 		start_worker(gcwq->first_idle);
3302e22bee78STejun Heo 		gcwq->first_idle = NULL;
33031da177e4SLinus Torvalds 		break;
33041da177e4SLinus Torvalds 	}
3305db7bccf4STejun Heo 
3306db7bccf4STejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
33071da177e4SLinus Torvalds 
33081537663fSTejun Heo 	return notifier_from_errno(0);
33091da177e4SLinus Torvalds }
33101da177e4SLinus Torvalds 
33112d3854a3SRusty Russell #ifdef CONFIG_SMP
33128ccad40dSRusty Russell 
33132d3854a3SRusty Russell struct work_for_cpu {
33146b44003eSAndrew Morton 	struct completion completion;
33152d3854a3SRusty Russell 	long (*fn)(void *);
33162d3854a3SRusty Russell 	void *arg;
33172d3854a3SRusty Russell 	long ret;
33182d3854a3SRusty Russell };
33192d3854a3SRusty Russell 
33206b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
33212d3854a3SRusty Russell {
33226b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
33232d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
33246b44003eSAndrew Morton 	complete(&wfc->completion);
33256b44003eSAndrew Morton 	return 0;
33262d3854a3SRusty Russell }
33272d3854a3SRusty Russell 
33282d3854a3SRusty Russell /**
33292d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
33302d3854a3SRusty Russell  * @cpu: the cpu to run on
33312d3854a3SRusty Russell  * @fn: the function to run
33322d3854a3SRusty Russell  * @arg: the function arg
33332d3854a3SRusty Russell  *
333431ad9081SRusty Russell  * This will return the value @fn returns.
333531ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
33366b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
33372d3854a3SRusty Russell  */
33382d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
33392d3854a3SRusty Russell {
33406b44003eSAndrew Morton 	struct task_struct *sub_thread;
33416b44003eSAndrew Morton 	struct work_for_cpu wfc = {
33426b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
33436b44003eSAndrew Morton 		.fn = fn,
33446b44003eSAndrew Morton 		.arg = arg,
33456b44003eSAndrew Morton 	};
33462d3854a3SRusty Russell 
33476b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
33486b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
33496b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
33506b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
33516b44003eSAndrew Morton 	wake_up_process(sub_thread);
33526b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
33532d3854a3SRusty Russell 	return wfc.ret;
33542d3854a3SRusty Russell }
33552d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
33562d3854a3SRusty Russell #endif /* CONFIG_SMP */
33572d3854a3SRusty Russell 
3358a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3359a0a1a5fdSTejun Heo 
3360a0a1a5fdSTejun Heo /**
3361a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3362a0a1a5fdSTejun Heo  *
3363a0a1a5fdSTejun Heo  * Start freezing workqueues.  After this function returns, all
3364a0a1a5fdSTejun Heo  * freezeable workqueues will queue new works to their frozen_works
33657e11629dSTejun Heo  * list instead of gcwq->worklist.
3366a0a1a5fdSTejun Heo  *
3367a0a1a5fdSTejun Heo  * CONTEXT:
33688b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3369a0a1a5fdSTejun Heo  */
3370a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3371a0a1a5fdSTejun Heo {
3372a0a1a5fdSTejun Heo 	unsigned int cpu;
3373a0a1a5fdSTejun Heo 
3374a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3375a0a1a5fdSTejun Heo 
3376a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3377a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3378a0a1a5fdSTejun Heo 
3379f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
33808b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3381bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
33828b03ae3cSTejun Heo 
33838b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
33848b03ae3cSTejun Heo 
3385db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3386db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3387db7bccf4STejun Heo 
3388a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3389a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3390a0a1a5fdSTejun Heo 
3391f3421797STejun Heo 			if (cwq && wq->flags & WQ_FREEZEABLE)
3392a0a1a5fdSTejun Heo 				cwq->max_active = 0;
3393a0a1a5fdSTejun Heo 		}
33948b03ae3cSTejun Heo 
33958b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3396a0a1a5fdSTejun Heo 	}
3397a0a1a5fdSTejun Heo 
3398a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3399a0a1a5fdSTejun Heo }
3400a0a1a5fdSTejun Heo 
3401a0a1a5fdSTejun Heo /**
3402a0a1a5fdSTejun Heo  * freeze_workqueues_busy - are freezeable workqueues still busy?
3403a0a1a5fdSTejun Heo  *
3404a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3405a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3406a0a1a5fdSTejun Heo  *
3407a0a1a5fdSTejun Heo  * CONTEXT:
3408a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3409a0a1a5fdSTejun Heo  *
3410a0a1a5fdSTejun Heo  * RETURNS:
3411a0a1a5fdSTejun Heo  * %true if some freezeable workqueues are still busy.  %false if
3412a0a1a5fdSTejun Heo  * freezing is complete.
3413a0a1a5fdSTejun Heo  */
3414a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3415a0a1a5fdSTejun Heo {
3416a0a1a5fdSTejun Heo 	unsigned int cpu;
3417a0a1a5fdSTejun Heo 	bool busy = false;
3418a0a1a5fdSTejun Heo 
3419a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3420a0a1a5fdSTejun Heo 
3421a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3422a0a1a5fdSTejun Heo 
3423f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3424bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3425a0a1a5fdSTejun Heo 		/*
3426a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3427a0a1a5fdSTejun Heo 		 * to peek without lock.
3428a0a1a5fdSTejun Heo 		 */
3429a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3430a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3431a0a1a5fdSTejun Heo 
3432f3421797STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZEABLE))
3433a0a1a5fdSTejun Heo 				continue;
3434a0a1a5fdSTejun Heo 
3435a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3436a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3437a0a1a5fdSTejun Heo 				busy = true;
3438a0a1a5fdSTejun Heo 				goto out_unlock;
3439a0a1a5fdSTejun Heo 			}
3440a0a1a5fdSTejun Heo 		}
3441a0a1a5fdSTejun Heo 	}
3442a0a1a5fdSTejun Heo out_unlock:
3443a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3444a0a1a5fdSTejun Heo 	return busy;
3445a0a1a5fdSTejun Heo }
3446a0a1a5fdSTejun Heo 
3447a0a1a5fdSTejun Heo /**
3448a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3449a0a1a5fdSTejun Heo  *
3450a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
34517e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3452a0a1a5fdSTejun Heo  *
3453a0a1a5fdSTejun Heo  * CONTEXT:
34548b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3455a0a1a5fdSTejun Heo  */
3456a0a1a5fdSTejun Heo void thaw_workqueues(void)
3457a0a1a5fdSTejun Heo {
3458a0a1a5fdSTejun Heo 	unsigned int cpu;
3459a0a1a5fdSTejun Heo 
3460a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3461a0a1a5fdSTejun Heo 
3462a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3463a0a1a5fdSTejun Heo 		goto out_unlock;
3464a0a1a5fdSTejun Heo 
3465f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
34668b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3467bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
34688b03ae3cSTejun Heo 
34698b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
34708b03ae3cSTejun Heo 
3471db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3472db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3473db7bccf4STejun Heo 
3474a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3475a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3476a0a1a5fdSTejun Heo 
3477f3421797STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZEABLE))
3478a0a1a5fdSTejun Heo 				continue;
3479a0a1a5fdSTejun Heo 
3480a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3481a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3482a0a1a5fdSTejun Heo 
3483a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3484a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3485a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3486a0a1a5fdSTejun Heo 		}
34878b03ae3cSTejun Heo 
3488e22bee78STejun Heo 		wake_up_worker(gcwq);
3489e22bee78STejun Heo 
34908b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3491a0a1a5fdSTejun Heo 	}
3492a0a1a5fdSTejun Heo 
3493a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3494a0a1a5fdSTejun Heo out_unlock:
3495a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3496a0a1a5fdSTejun Heo }
3497a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3498a0a1a5fdSTejun Heo 
3499c12920d1SOleg Nesterov void __init init_workqueues(void)
35001da177e4SLinus Torvalds {
3501c34056a3STejun Heo 	unsigned int cpu;
3502c8e55f36STejun Heo 	int i;
3503c34056a3STejun Heo 
35047a22ad75STejun Heo 	/*
35057a22ad75STejun Heo 	 * The pointer part of work->data is either pointing to the
35067a22ad75STejun Heo 	 * cwq or contains the cpu number the work ran last on.  Make
35077a22ad75STejun Heo 	 * sure cpu number won't overflow into kernel pointer area so
35087a22ad75STejun Heo 	 * that they can be distinguished.
35097a22ad75STejun Heo 	 */
3510bdbc5dd7STejun Heo 	BUILD_BUG_ON(WORK_CPU_LAST << WORK_STRUCT_FLAG_BITS >= PAGE_OFFSET);
35117a22ad75STejun Heo 
3512db7bccf4STejun Heo 	hotcpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
35138b03ae3cSTejun Heo 
35148b03ae3cSTejun Heo 	/* initialize gcwqs */
3515f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
35168b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
35178b03ae3cSTejun Heo 
35188b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
35197e11629dSTejun Heo 		INIT_LIST_HEAD(&gcwq->worklist);
35208b03ae3cSTejun Heo 		gcwq->cpu = cpu;
3521f3421797STejun Heo 		if (cpu == WORK_CPU_UNBOUND)
3522f3421797STejun Heo 			gcwq->flags |= GCWQ_DISASSOCIATED;
35238b03ae3cSTejun Heo 
3524c8e55f36STejun Heo 		INIT_LIST_HEAD(&gcwq->idle_list);
3525c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3526c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3527c8e55f36STejun Heo 
3528e22bee78STejun Heo 		init_timer_deferrable(&gcwq->idle_timer);
3529e22bee78STejun Heo 		gcwq->idle_timer.function = idle_worker_timeout;
3530e22bee78STejun Heo 		gcwq->idle_timer.data = (unsigned long)gcwq;
3531e22bee78STejun Heo 
3532e22bee78STejun Heo 		setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3533e22bee78STejun Heo 			    (unsigned long)gcwq);
3534e22bee78STejun Heo 
35358b03ae3cSTejun Heo 		ida_init(&gcwq->worker_ida);
3536db7bccf4STejun Heo 
3537db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_DONE;
3538db7bccf4STejun Heo 		init_waitqueue_head(&gcwq->trustee_wait);
35398b03ae3cSTejun Heo 	}
35408b03ae3cSTejun Heo 
3541e22bee78STejun Heo 	/* create the initial worker */
3542f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
3543e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3544e22bee78STejun Heo 		struct worker *worker;
3545e22bee78STejun Heo 
3546e22bee78STejun Heo 		worker = create_worker(gcwq, true);
3547e22bee78STejun Heo 		BUG_ON(!worker);
3548e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
3549e22bee78STejun Heo 		start_worker(worker);
3550e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
3551e22bee78STejun Heo 	}
3552e22bee78STejun Heo 
3553d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
3554d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
3555d320c038STejun Heo 	system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
3556f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3557f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
3558d320c038STejun Heo 	BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq);
35591da177e4SLinus Torvalds }
3560