xref: /linux-6.15/kernel/workqueue.c (revision 25511a47)
11da177e4SLinus Torvalds /*
2c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
31da177e4SLinus Torvalds  *
4c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
51da177e4SLinus Torvalds  *
61da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
71da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
8e1f8e874SFrancois Cami  *     Andrew Morton
91da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
101da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1189ada679SChristoph Lameter  *
12cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
13c54fce6eSTejun Heo  *
14c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
15c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
16c54fce6eSTejun Heo  *
17c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
18c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
19c54fce6eSTejun Heo  * automatically managed.  There is one worker pool for each CPU and
20c54fce6eSTejun Heo  * one extra for works which are better served by workers which are
21c54fce6eSTejun Heo  * not bound to any specific CPU.
22c54fce6eSTejun Heo  *
23c54fce6eSTejun Heo  * Please read Documentation/workqueue.txt for details.
241da177e4SLinus Torvalds  */
251da177e4SLinus Torvalds 
269984de1aSPaul Gortmaker #include <linux/export.h>
271da177e4SLinus Torvalds #include <linux/kernel.h>
281da177e4SLinus Torvalds #include <linux/sched.h>
291da177e4SLinus Torvalds #include <linux/init.h>
301da177e4SLinus Torvalds #include <linux/signal.h>
311da177e4SLinus Torvalds #include <linux/completion.h>
321da177e4SLinus Torvalds #include <linux/workqueue.h>
331da177e4SLinus Torvalds #include <linux/slab.h>
341da177e4SLinus Torvalds #include <linux/cpu.h>
351da177e4SLinus Torvalds #include <linux/notifier.h>
361da177e4SLinus Torvalds #include <linux/kthread.h>
371fa44ecaSJames Bottomley #include <linux/hardirq.h>
3846934023SChristoph Lameter #include <linux/mempolicy.h>
39341a5958SRafael J. Wysocki #include <linux/freezer.h>
40d5abe669SPeter Zijlstra #include <linux/kallsyms.h>
41d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
424e6045f1SJohannes Berg #include <linux/lockdep.h>
43c34056a3STejun Heo #include <linux/idr.h>
44e22bee78STejun Heo 
45e22bee78STejun Heo #include "workqueue_sched.h"
461da177e4SLinus Torvalds 
47c8e55f36STejun Heo enum {
48bc2ae0f5STejun Heo 	/*
49bc2ae0f5STejun Heo 	 * global_cwq flags
50bc2ae0f5STejun Heo 	 *
51bc2ae0f5STejun Heo 	 * A bound gcwq is either associated or disassociated with its CPU.
52bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
53bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
54bc2ae0f5STejun Heo 	 * is in effect.
55bc2ae0f5STejun Heo 	 *
56bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
57bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
58bc2ae0f5STejun Heo 	 * be executing on any CPU.  The gcwq behaves as an unbound one.
59bc2ae0f5STejun Heo 	 *
60bc2ae0f5STejun Heo 	 * Note that DISASSOCIATED can be flipped only while holding
61bc2ae0f5STejun Heo 	 * managership of all pools on the gcwq to avoid changing binding
62bc2ae0f5STejun Heo 	 * state while create_worker() is in progress.
63bc2ae0f5STejun Heo 	 */
6411ebea50STejun Heo 	GCWQ_DISASSOCIATED	= 1 << 0,	/* cpu can't serve workers */
6511ebea50STejun Heo 	GCWQ_FREEZING		= 1 << 1,	/* freeze in progress */
6611ebea50STejun Heo 
6711ebea50STejun Heo 	/* pool flags */
6811ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
69db7bccf4STejun Heo 
70c8e55f36STejun Heo 	/* worker flags */
71c8e55f36STejun Heo 	WORKER_STARTED		= 1 << 0,	/* started */
72c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
73c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
74e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
75e22bee78STejun Heo 	WORKER_REBIND		= 1 << 5,	/* mom is home, come back */
76fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
77f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
78e22bee78STejun Heo 
79403c821dSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_REBIND | WORKER_UNBOUND |
80403c821dSTejun Heo 				  WORKER_CPU_INTENSIVE,
81db7bccf4STejun Heo 
82db7bccf4STejun Heo 	/* gcwq->trustee_state */
83db7bccf4STejun Heo 	TRUSTEE_START		= 0,		/* start */
84db7bccf4STejun Heo 	TRUSTEE_IN_CHARGE	= 1,		/* trustee in charge of gcwq */
85db7bccf4STejun Heo 	TRUSTEE_BUTCHER		= 2,		/* butcher workers */
86db7bccf4STejun Heo 	TRUSTEE_RELEASE		= 3,		/* release workers */
87db7bccf4STejun Heo 	TRUSTEE_DONE		= 4,		/* trustee is done */
88c8e55f36STejun Heo 
893270476aSTejun Heo 	NR_WORKER_POOLS		= 2,		/* # worker pools per gcwq */
904ce62e9eSTejun Heo 
91c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
92c8e55f36STejun Heo 	BUSY_WORKER_HASH_SIZE	= 1 << BUSY_WORKER_HASH_ORDER,
93c8e55f36STejun Heo 	BUSY_WORKER_HASH_MASK	= BUSY_WORKER_HASH_SIZE - 1,
94db7bccf4STejun Heo 
95e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
96e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
97e22bee78STejun Heo 
983233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
993233cdbdSTejun Heo 						/* call for help after 10ms
1003233cdbdSTejun Heo 						   (min two ticks) */
101e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
102e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
103db7bccf4STejun Heo 	TRUSTEE_COOLDOWN	= HZ / 10,	/* for trustee draining */
1041da177e4SLinus Torvalds 
1051da177e4SLinus Torvalds 	/*
106e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
107e22bee78STejun Heo 	 * all cpus.  Give -20.
108e22bee78STejun Heo 	 */
109e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
1103270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
111c8e55f36STejun Heo };
112c8e55f36STejun Heo 
1131da177e4SLinus Torvalds /*
1144690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1154690c4abSTejun Heo  *
116e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
117e41e704bSTejun Heo  *    everyone else.
1184690c4abSTejun Heo  *
119e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
120e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
121e22bee78STejun Heo  *
1228b03ae3cSTejun Heo  * L: gcwq->lock protected.  Access with gcwq->lock held.
1234690c4abSTejun Heo  *
124e22bee78STejun Heo  * X: During normal operation, modification requires gcwq->lock and
125e22bee78STejun Heo  *    should be done only from local cpu.  Either disabling preemption
126e22bee78STejun Heo  *    on local cpu or grabbing gcwq->lock is enough for read access.
127f3421797STejun Heo  *    If GCWQ_DISASSOCIATED is set, it's identical to L.
128e22bee78STejun Heo  *
12973f53c4aSTejun Heo  * F: wq->flush_mutex protected.
13073f53c4aSTejun Heo  *
1314690c4abSTejun Heo  * W: workqueue_lock protected.
1324690c4abSTejun Heo  */
1334690c4abSTejun Heo 
1348b03ae3cSTejun Heo struct global_cwq;
135bd7bdd43STejun Heo struct worker_pool;
136*25511a47STejun Heo struct idle_rebind;
137c34056a3STejun Heo 
138e22bee78STejun Heo /*
139e22bee78STejun Heo  * The poor guys doing the actual heavy lifting.  All on-duty workers
140e22bee78STejun Heo  * are either serving the manager role, on idle list or on busy hash.
141e22bee78STejun Heo  */
142c34056a3STejun Heo struct worker {
143c8e55f36STejun Heo 	/* on idle list while idle, on busy hash table while busy */
144c8e55f36STejun Heo 	union {
145c8e55f36STejun Heo 		struct list_head	entry;	/* L: while idle */
146c8e55f36STejun Heo 		struct hlist_node	hentry;	/* L: while busy */
147c8e55f36STejun Heo 	};
148c8e55f36STejun Heo 
149c34056a3STejun Heo 	struct work_struct	*current_work;	/* L: work being processed */
1508cca0eeaSTejun Heo 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
151affee4b2STejun Heo 	struct list_head	scheduled;	/* L: scheduled works */
152c34056a3STejun Heo 	struct task_struct	*task;		/* I: worker task */
153bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
154e22bee78STejun Heo 	/* 64 bytes boundary on 64bit, 32 on 32bit */
155e22bee78STejun Heo 	unsigned long		last_active;	/* L: last active timestamp */
156e22bee78STejun Heo 	unsigned int		flags;		/* X: flags */
157c34056a3STejun Heo 	int			id;		/* I: worker id */
158*25511a47STejun Heo 
159*25511a47STejun Heo 	/* for rebinding worker to CPU */
160*25511a47STejun Heo 	struct idle_rebind	*idle_rebind;	/* L: for idle worker */
161*25511a47STejun Heo 	struct work_struct	rebind_work;	/* L: for busy worker */
162c34056a3STejun Heo };
163c34056a3STejun Heo 
164bd7bdd43STejun Heo struct worker_pool {
165bd7bdd43STejun Heo 	struct global_cwq	*gcwq;		/* I: the owning gcwq */
16611ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
167bd7bdd43STejun Heo 
168bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
169bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
170bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
171bd7bdd43STejun Heo 
172bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
173bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
174bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
175bd7bdd43STejun Heo 
17660373152STejun Heo 	struct mutex		manager_mutex;	/* mutex manager should hold */
177bd7bdd43STejun Heo 	struct ida		worker_ida;	/* L: for worker IDs */
178bd7bdd43STejun Heo 	struct worker		*first_idle;	/* L: first idle worker */
179bd7bdd43STejun Heo };
180bd7bdd43STejun Heo 
1814690c4abSTejun Heo /*
182e22bee78STejun Heo  * Global per-cpu workqueue.  There's one and only one for each cpu
183e22bee78STejun Heo  * and all works are queued and processed here regardless of their
184e22bee78STejun Heo  * target workqueues.
1858b03ae3cSTejun Heo  */
1868b03ae3cSTejun Heo struct global_cwq {
1878b03ae3cSTejun Heo 	spinlock_t		lock;		/* the gcwq lock */
1888b03ae3cSTejun Heo 	unsigned int		cpu;		/* I: the associated cpu */
189db7bccf4STejun Heo 	unsigned int		flags;		/* L: GCWQ_* flags */
190c8e55f36STejun Heo 
191bd7bdd43STejun Heo 	/* workers are chained either in busy_hash or pool idle_list */
192c8e55f36STejun Heo 	struct hlist_head	busy_hash[BUSY_WORKER_HASH_SIZE];
193c8e55f36STejun Heo 						/* L: hash of busy workers */
194c8e55f36STejun Heo 
1953270476aSTejun Heo 	struct worker_pool	pools[2];	/* normal and highpri pools */
196db7bccf4STejun Heo 
197*25511a47STejun Heo 	wait_queue_head_t	rebind_hold;	/* rebind hold wait */
198*25511a47STejun Heo 
199db7bccf4STejun Heo 	struct task_struct	*trustee;	/* L: for gcwq shutdown */
200db7bccf4STejun Heo 	unsigned int		trustee_state;	/* L: trustee state */
201db7bccf4STejun Heo 	wait_queue_head_t	trustee_wait;	/* trustee wait */
2028b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
2038b03ae3cSTejun Heo 
2048b03ae3cSTejun Heo /*
205502ca9d8STejun Heo  * The per-CPU workqueue.  The lower WORK_STRUCT_FLAG_BITS of
2060f900049STejun Heo  * work_struct->data are used for flags and thus cwqs need to be
2070f900049STejun Heo  * aligned at two's power of the number of flag bits.
2081da177e4SLinus Torvalds  */
2091da177e4SLinus Torvalds struct cpu_workqueue_struct {
210bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
2114690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
21273f53c4aSTejun Heo 	int			work_color;	/* L: current color */
21373f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
21473f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
21573f53c4aSTejun Heo 						/* L: nr of in_flight works */
2161e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
217a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
2181e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
2190f900049STejun Heo };
2201da177e4SLinus Torvalds 
2211da177e4SLinus Torvalds /*
22273f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
22373f53c4aSTejun Heo  */
22473f53c4aSTejun Heo struct wq_flusher {
22573f53c4aSTejun Heo 	struct list_head	list;		/* F: list of flushers */
22673f53c4aSTejun Heo 	int			flush_color;	/* F: flush color waiting for */
22773f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
22873f53c4aSTejun Heo };
2291da177e4SLinus Torvalds 
23073f53c4aSTejun Heo /*
231f2e005aaSTejun Heo  * All cpumasks are assumed to be always set on UP and thus can't be
232f2e005aaSTejun Heo  * used to determine whether there's something to be done.
233f2e005aaSTejun Heo  */
234f2e005aaSTejun Heo #ifdef CONFIG_SMP
235f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t;
236f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	\
237f2e005aaSTejun Heo 	cpumask_test_and_set_cpu((cpu), (mask))
238f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		cpumask_clear_cpu((cpu), (mask))
239f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		for_each_cpu((cpu), (mask))
2409c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp)		zalloc_cpumask_var((maskp), (gfp))
241f2e005aaSTejun Heo #define free_mayday_mask(mask)			free_cpumask_var((mask))
242f2e005aaSTejun Heo #else
243f2e005aaSTejun Heo typedef unsigned long mayday_mask_t;
244f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask)	test_and_set_bit(0, &(mask))
245f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask)		clear_bit(0, &(mask))
246f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask)		if ((cpu) = 0, (mask))
247f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp)		true
248f2e005aaSTejun Heo #define free_mayday_mask(mask)			do { } while (0)
249f2e005aaSTejun Heo #endif
2501da177e4SLinus Torvalds 
2511da177e4SLinus Torvalds /*
2521da177e4SLinus Torvalds  * The externally visible workqueue abstraction is an array of
2531da177e4SLinus Torvalds  * per-CPU workqueues:
2541da177e4SLinus Torvalds  */
2551da177e4SLinus Torvalds struct workqueue_struct {
2569c5a2ba7STejun Heo 	unsigned int		flags;		/* W: WQ_* flags */
257bdbc5dd7STejun Heo 	union {
258bdbc5dd7STejun Heo 		struct cpu_workqueue_struct __percpu	*pcpu;
259bdbc5dd7STejun Heo 		struct cpu_workqueue_struct		*single;
260bdbc5dd7STejun Heo 		unsigned long				v;
261bdbc5dd7STejun Heo 	} cpu_wq;				/* I: cwq's */
2624690c4abSTejun Heo 	struct list_head	list;		/* W: list of all workqueues */
26373f53c4aSTejun Heo 
26473f53c4aSTejun Heo 	struct mutex		flush_mutex;	/* protects wq flushing */
26573f53c4aSTejun Heo 	int			work_color;	/* F: current work color */
26673f53c4aSTejun Heo 	int			flush_color;	/* F: current flush color */
26773f53c4aSTejun Heo 	atomic_t		nr_cwqs_to_flush; /* flush in progress */
26873f53c4aSTejun Heo 	struct wq_flusher	*first_flusher;	/* F: first flusher */
26973f53c4aSTejun Heo 	struct list_head	flusher_queue;	/* F: flush waiters */
27073f53c4aSTejun Heo 	struct list_head	flusher_overflow; /* F: flush overflow list */
27173f53c4aSTejun Heo 
272f2e005aaSTejun Heo 	mayday_mask_t		mayday_mask;	/* cpus requesting rescue */
273e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
274e22bee78STejun Heo 
2759c5a2ba7STejun Heo 	int			nr_drainers;	/* W: drain in progress */
276dcd989cbSTejun Heo 	int			saved_max_active; /* W: saved cwq max_active */
2774e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2784e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2794e6045f1SJohannes Berg #endif
280b196be89STejun Heo 	char			name[];		/* I: workqueue name */
2811da177e4SLinus Torvalds };
2821da177e4SLinus Torvalds 
283d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
284d320c038STejun Heo struct workqueue_struct *system_long_wq __read_mostly;
285d320c038STejun Heo struct workqueue_struct *system_nrt_wq __read_mostly;
286f3421797STejun Heo struct workqueue_struct *system_unbound_wq __read_mostly;
28724d51addSTejun Heo struct workqueue_struct *system_freezable_wq __read_mostly;
28862d3c543SAlan Stern struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
289d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq);
290d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
291d320c038STejun Heo EXPORT_SYMBOL_GPL(system_nrt_wq);
292f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
29324d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
29462d3c543SAlan Stern EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
295d320c038STejun Heo 
29697bd2347STejun Heo #define CREATE_TRACE_POINTS
29797bd2347STejun Heo #include <trace/events/workqueue.h>
29897bd2347STejun Heo 
2994ce62e9eSTejun Heo #define for_each_worker_pool(pool, gcwq)				\
3003270476aSTejun Heo 	for ((pool) = &(gcwq)->pools[0];				\
3013270476aSTejun Heo 	     (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
3024ce62e9eSTejun Heo 
303db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq)			\
304db7bccf4STejun Heo 	for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)			\
305db7bccf4STejun Heo 		hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
306db7bccf4STejun Heo 
307f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
308f3421797STejun Heo 				  unsigned int sw)
309f3421797STejun Heo {
310f3421797STejun Heo 	if (cpu < nr_cpu_ids) {
311f3421797STejun Heo 		if (sw & 1) {
312f3421797STejun Heo 			cpu = cpumask_next(cpu, mask);
313f3421797STejun Heo 			if (cpu < nr_cpu_ids)
314f3421797STejun Heo 				return cpu;
315f3421797STejun Heo 		}
316f3421797STejun Heo 		if (sw & 2)
317f3421797STejun Heo 			return WORK_CPU_UNBOUND;
318f3421797STejun Heo 	}
319f3421797STejun Heo 	return WORK_CPU_NONE;
320f3421797STejun Heo }
321f3421797STejun Heo 
322f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
323f3421797STejun Heo 				struct workqueue_struct *wq)
324f3421797STejun Heo {
325f3421797STejun Heo 	return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
326f3421797STejun Heo }
327f3421797STejun Heo 
32809884951STejun Heo /*
32909884951STejun Heo  * CPU iterators
33009884951STejun Heo  *
33109884951STejun Heo  * An extra gcwq is defined for an invalid cpu number
33209884951STejun Heo  * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
33309884951STejun Heo  * specific CPU.  The following iterators are similar to
33409884951STejun Heo  * for_each_*_cpu() iterators but also considers the unbound gcwq.
33509884951STejun Heo  *
33609884951STejun Heo  * for_each_gcwq_cpu()		: possible CPUs + WORK_CPU_UNBOUND
33709884951STejun Heo  * for_each_online_gcwq_cpu()	: online CPUs + WORK_CPU_UNBOUND
33809884951STejun Heo  * for_each_cwq_cpu()		: possible CPUs for bound workqueues,
33909884951STejun Heo  *				  WORK_CPU_UNBOUND for unbound workqueues
34009884951STejun Heo  */
341f3421797STejun Heo #define for_each_gcwq_cpu(cpu)						\
342f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3);		\
343f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
344f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
345f3421797STejun Heo 
346f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu)					\
347f3421797STejun Heo 	for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3);		\
348f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
349f3421797STejun Heo 	     (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
350f3421797STejun Heo 
351f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq)					\
352f3421797STejun Heo 	for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq));	\
353f3421797STejun Heo 	     (cpu) < WORK_CPU_NONE;					\
354f3421797STejun Heo 	     (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
355f3421797STejun Heo 
356dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
357dc186ad7SThomas Gleixner 
358dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
359dc186ad7SThomas Gleixner 
36099777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
36199777288SStanislaw Gruszka {
36299777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
36399777288SStanislaw Gruszka }
36499777288SStanislaw Gruszka 
365dc186ad7SThomas Gleixner /*
366dc186ad7SThomas Gleixner  * fixup_init is called when:
367dc186ad7SThomas Gleixner  * - an active object is initialized
368dc186ad7SThomas Gleixner  */
369dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
370dc186ad7SThomas Gleixner {
371dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
372dc186ad7SThomas Gleixner 
373dc186ad7SThomas Gleixner 	switch (state) {
374dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
375dc186ad7SThomas Gleixner 		cancel_work_sync(work);
376dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
377dc186ad7SThomas Gleixner 		return 1;
378dc186ad7SThomas Gleixner 	default:
379dc186ad7SThomas Gleixner 		return 0;
380dc186ad7SThomas Gleixner 	}
381dc186ad7SThomas Gleixner }
382dc186ad7SThomas Gleixner 
383dc186ad7SThomas Gleixner /*
384dc186ad7SThomas Gleixner  * fixup_activate is called when:
385dc186ad7SThomas Gleixner  * - an active object is activated
386dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
387dc186ad7SThomas Gleixner  */
388dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
389dc186ad7SThomas Gleixner {
390dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
391dc186ad7SThomas Gleixner 
392dc186ad7SThomas Gleixner 	switch (state) {
393dc186ad7SThomas Gleixner 
394dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
395dc186ad7SThomas Gleixner 		/*
396dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
397dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
398dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
399dc186ad7SThomas Gleixner 		 */
40022df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
401dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
402dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
403dc186ad7SThomas Gleixner 			return 0;
404dc186ad7SThomas Gleixner 		}
405dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
406dc186ad7SThomas Gleixner 		return 0;
407dc186ad7SThomas Gleixner 
408dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
409dc186ad7SThomas Gleixner 		WARN_ON(1);
410dc186ad7SThomas Gleixner 
411dc186ad7SThomas Gleixner 	default:
412dc186ad7SThomas Gleixner 		return 0;
413dc186ad7SThomas Gleixner 	}
414dc186ad7SThomas Gleixner }
415dc186ad7SThomas Gleixner 
416dc186ad7SThomas Gleixner /*
417dc186ad7SThomas Gleixner  * fixup_free is called when:
418dc186ad7SThomas Gleixner  * - an active object is freed
419dc186ad7SThomas Gleixner  */
420dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
421dc186ad7SThomas Gleixner {
422dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
423dc186ad7SThomas Gleixner 
424dc186ad7SThomas Gleixner 	switch (state) {
425dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
426dc186ad7SThomas Gleixner 		cancel_work_sync(work);
427dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
428dc186ad7SThomas Gleixner 		return 1;
429dc186ad7SThomas Gleixner 	default:
430dc186ad7SThomas Gleixner 		return 0;
431dc186ad7SThomas Gleixner 	}
432dc186ad7SThomas Gleixner }
433dc186ad7SThomas Gleixner 
434dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
435dc186ad7SThomas Gleixner 	.name		= "work_struct",
43699777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
437dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
438dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
439dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
440dc186ad7SThomas Gleixner };
441dc186ad7SThomas Gleixner 
442dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
443dc186ad7SThomas Gleixner {
444dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
445dc186ad7SThomas Gleixner }
446dc186ad7SThomas Gleixner 
447dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
448dc186ad7SThomas Gleixner {
449dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
450dc186ad7SThomas Gleixner }
451dc186ad7SThomas Gleixner 
452dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
453dc186ad7SThomas Gleixner {
454dc186ad7SThomas Gleixner 	if (onstack)
455dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
456dc186ad7SThomas Gleixner 	else
457dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
458dc186ad7SThomas Gleixner }
459dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
460dc186ad7SThomas Gleixner 
461dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
462dc186ad7SThomas Gleixner {
463dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
464dc186ad7SThomas Gleixner }
465dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
466dc186ad7SThomas Gleixner 
467dc186ad7SThomas Gleixner #else
468dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
469dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
470dc186ad7SThomas Gleixner #endif
471dc186ad7SThomas Gleixner 
47295402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */
47395402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock);
4741da177e4SLinus Torvalds static LIST_HEAD(workqueues);
475a0a1a5fdSTejun Heo static bool workqueue_freezing;		/* W: have wqs started freezing? */
4761da177e4SLinus Torvalds 
47714441960SOleg Nesterov /*
478e22bee78STejun Heo  * The almighty global cpu workqueues.  nr_running is the only field
479e22bee78STejun Heo  * which is expected to be used frequently by other cpus via
480e22bee78STejun Heo  * try_to_wake_up().  Put it in a separate cacheline.
48114441960SOleg Nesterov  */
4828b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq);
4834ce62e9eSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
484f756d5e2SNathan Lynch 
485f3421797STejun Heo /*
486f3421797STejun Heo  * Global cpu workqueue and nr_running counter for unbound gcwq.  The
487f3421797STejun Heo  * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
488f3421797STejun Heo  * workers have WORKER_UNBOUND set.
489f3421797STejun Heo  */
490f3421797STejun Heo static struct global_cwq unbound_global_cwq;
4914ce62e9eSTejun Heo static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
4924ce62e9eSTejun Heo 	[0 ... NR_WORKER_POOLS - 1]	= ATOMIC_INIT(0),	/* always 0 */
4934ce62e9eSTejun Heo };
494f3421797STejun Heo 
495c34056a3STejun Heo static int worker_thread(void *__worker);
4961da177e4SLinus Torvalds 
4973270476aSTejun Heo static int worker_pool_pri(struct worker_pool *pool)
4983270476aSTejun Heo {
4993270476aSTejun Heo 	return pool - pool->gcwq->pools;
5003270476aSTejun Heo }
5013270476aSTejun Heo 
5028b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu)
5031da177e4SLinus Torvalds {
504f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
5058b03ae3cSTejun Heo 		return &per_cpu(global_cwq, cpu);
506f3421797STejun Heo 	else
507f3421797STejun Heo 		return &unbound_global_cwq;
5081da177e4SLinus Torvalds }
5091da177e4SLinus Torvalds 
51063d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool)
511b1f4ec17SOleg Nesterov {
51263d95a91STejun Heo 	int cpu = pool->gcwq->cpu;
5133270476aSTejun Heo 	int idx = worker_pool_pri(pool);
51463d95a91STejun Heo 
515f3421797STejun Heo 	if (cpu != WORK_CPU_UNBOUND)
5164ce62e9eSTejun Heo 		return &per_cpu(pool_nr_running, cpu)[idx];
517f3421797STejun Heo 	else
5184ce62e9eSTejun Heo 		return &unbound_pool_nr_running[idx];
519b1f4ec17SOleg Nesterov }
520b1f4ec17SOleg Nesterov 
5214690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
5224690c4abSTejun Heo 					    struct workqueue_struct *wq)
523a848e3b6SOleg Nesterov {
524f3421797STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
525e06ffa1eSLai Jiangshan 		if (likely(cpu < nr_cpu_ids))
526bdbc5dd7STejun Heo 			return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
527f3421797STejun Heo 	} else if (likely(cpu == WORK_CPU_UNBOUND))
528f3421797STejun Heo 		return wq->cpu_wq.single;
529f3421797STejun Heo 	return NULL;
530f3421797STejun Heo }
531a848e3b6SOleg Nesterov 
53273f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
53373f53c4aSTejun Heo {
53473f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
53573f53c4aSTejun Heo }
53673f53c4aSTejun Heo 
53773f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
53873f53c4aSTejun Heo {
53973f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
54073f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
54173f53c4aSTejun Heo }
54273f53c4aSTejun Heo 
54373f53c4aSTejun Heo static int work_next_color(int color)
54473f53c4aSTejun Heo {
54573f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
5461da177e4SLinus Torvalds }
5471da177e4SLinus Torvalds 
5484594bf15SDavid Howells /*
549e120153dSTejun Heo  * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
550e120153dSTejun Heo  * work is on queue.  Once execution starts, WORK_STRUCT_CWQ is
551e120153dSTejun Heo  * cleared and the work data contains the cpu number it was last on.
5527a22ad75STejun Heo  *
5537a22ad75STejun Heo  * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
5547a22ad75STejun Heo  * cwq, cpu or clear work->data.  These functions should only be
5557a22ad75STejun Heo  * called while the work is owned - ie. while the PENDING bit is set.
5567a22ad75STejun Heo  *
5577a22ad75STejun Heo  * get_work_[g]cwq() can be used to obtain the gcwq or cwq
5587a22ad75STejun Heo  * corresponding to a work.  gcwq is available once the work has been
5597a22ad75STejun Heo  * queued anywhere after initialization.  cwq is available only from
5607a22ad75STejun Heo  * queueing until execution starts.
5614594bf15SDavid Howells  */
5627a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5637a22ad75STejun Heo 				 unsigned long flags)
5647a22ad75STejun Heo {
5657a22ad75STejun Heo 	BUG_ON(!work_pending(work));
5667a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5677a22ad75STejun Heo }
5687a22ad75STejun Heo 
5697a22ad75STejun Heo static void set_work_cwq(struct work_struct *work,
5704690c4abSTejun Heo 			 struct cpu_workqueue_struct *cwq,
5714690c4abSTejun Heo 			 unsigned long extra_flags)
572365970a1SDavid Howells {
5737a22ad75STejun Heo 	set_work_data(work, (unsigned long)cwq,
574e120153dSTejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
575365970a1SDavid Howells }
576365970a1SDavid Howells 
5777a22ad75STejun Heo static void set_work_cpu(struct work_struct *work, unsigned int cpu)
5784d707b9fSOleg Nesterov {
5797a22ad75STejun Heo 	set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
5804d707b9fSOleg Nesterov }
5814d707b9fSOleg Nesterov 
5827a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
583365970a1SDavid Howells {
5847a22ad75STejun Heo 	set_work_data(work, WORK_STRUCT_NO_CPU, 0);
5857a22ad75STejun Heo }
5867a22ad75STejun Heo 
5877a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
5887a22ad75STejun Heo {
589e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
5907a22ad75STejun Heo 
591e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
592e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
593e120153dSTejun Heo 	else
594e120153dSTejun Heo 		return NULL;
5957a22ad75STejun Heo }
5967a22ad75STejun Heo 
5977a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work)
5987a22ad75STejun Heo {
599e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
6007a22ad75STejun Heo 	unsigned int cpu;
6017a22ad75STejun Heo 
602e120153dSTejun Heo 	if (data & WORK_STRUCT_CWQ)
603e120153dSTejun Heo 		return ((struct cpu_workqueue_struct *)
604bd7bdd43STejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
6057a22ad75STejun Heo 
6067a22ad75STejun Heo 	cpu = data >> WORK_STRUCT_FLAG_BITS;
607bdbc5dd7STejun Heo 	if (cpu == WORK_CPU_NONE)
6087a22ad75STejun Heo 		return NULL;
6097a22ad75STejun Heo 
610f3421797STejun Heo 	BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
6117a22ad75STejun Heo 	return get_gcwq(cpu);
612365970a1SDavid Howells }
613365970a1SDavid Howells 
614e22bee78STejun Heo /*
6153270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
6163270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
6173270476aSTejun Heo  * they're being called with gcwq->lock held.
618e22bee78STejun Heo  */
619e22bee78STejun Heo 
62063d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
621649027d7STejun Heo {
6223270476aSTejun Heo 	return !atomic_read(get_pool_nr_running(pool));
623649027d7STejun Heo }
624649027d7STejun Heo 
625e22bee78STejun Heo /*
626e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
627e22bee78STejun Heo  * running workers.
628974271c4STejun Heo  *
629974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
630974271c4STejun Heo  * function will always return %true for unbound gcwq as long as the
631974271c4STejun Heo  * worklist isn't empty.
632e22bee78STejun Heo  */
63363d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
634e22bee78STejun Heo {
63563d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
636e22bee78STejun Heo }
637e22bee78STejun Heo 
638e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
63963d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
640e22bee78STejun Heo {
64163d95a91STejun Heo 	return pool->nr_idle;
642e22bee78STejun Heo }
643e22bee78STejun Heo 
644e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
64563d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
646e22bee78STejun Heo {
64763d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
648e22bee78STejun Heo 
6493270476aSTejun Heo 	return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
650e22bee78STejun Heo }
651e22bee78STejun Heo 
652e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
65363d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
654e22bee78STejun Heo {
65563d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
656e22bee78STejun Heo }
657e22bee78STejun Heo 
658e22bee78STejun Heo /* Do I need to be the manager? */
65963d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
660e22bee78STejun Heo {
66163d95a91STejun Heo 	return need_to_create_worker(pool) ||
66211ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
663e22bee78STejun Heo }
664e22bee78STejun Heo 
665e22bee78STejun Heo /* Do we have too many workers and should some go away? */
66663d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
667e22bee78STejun Heo {
66860373152STejun Heo 	bool managing = mutex_is_locked(&pool->manager_mutex);
66963d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
67063d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
671e22bee78STejun Heo 
672e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
673e22bee78STejun Heo }
674e22bee78STejun Heo 
675e22bee78STejun Heo /*
676e22bee78STejun Heo  * Wake up functions.
677e22bee78STejun Heo  */
678e22bee78STejun Heo 
6797e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
68063d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
6817e11629dSTejun Heo {
68263d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
6837e11629dSTejun Heo 		return NULL;
6847e11629dSTejun Heo 
68563d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
6867e11629dSTejun Heo }
6877e11629dSTejun Heo 
6887e11629dSTejun Heo /**
6897e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
69063d95a91STejun Heo  * @pool: worker pool to wake worker from
6917e11629dSTejun Heo  *
69263d95a91STejun Heo  * Wake up the first idle worker of @pool.
6937e11629dSTejun Heo  *
6947e11629dSTejun Heo  * CONTEXT:
6957e11629dSTejun Heo  * spin_lock_irq(gcwq->lock).
6967e11629dSTejun Heo  */
69763d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
6987e11629dSTejun Heo {
69963d95a91STejun Heo 	struct worker *worker = first_worker(pool);
7007e11629dSTejun Heo 
7017e11629dSTejun Heo 	if (likely(worker))
7027e11629dSTejun Heo 		wake_up_process(worker->task);
7037e11629dSTejun Heo }
7047e11629dSTejun Heo 
7054690c4abSTejun Heo /**
706e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
707e22bee78STejun Heo  * @task: task waking up
708e22bee78STejun Heo  * @cpu: CPU @task is waking up to
709e22bee78STejun Heo  *
710e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
711e22bee78STejun Heo  * being awoken.
712e22bee78STejun Heo  *
713e22bee78STejun Heo  * CONTEXT:
714e22bee78STejun Heo  * spin_lock_irq(rq->lock)
715e22bee78STejun Heo  */
716e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
717e22bee78STejun Heo {
718e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
719e22bee78STejun Heo 
7202d64672eSSteven Rostedt 	if (!(worker->flags & WORKER_NOT_RUNNING))
72163d95a91STejun Heo 		atomic_inc(get_pool_nr_running(worker->pool));
722e22bee78STejun Heo }
723e22bee78STejun Heo 
724e22bee78STejun Heo /**
725e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
726e22bee78STejun Heo  * @task: task going to sleep
727e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
728e22bee78STejun Heo  *
729e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
730e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
731e22bee78STejun Heo  * returning pointer to its task.
732e22bee78STejun Heo  *
733e22bee78STejun Heo  * CONTEXT:
734e22bee78STejun Heo  * spin_lock_irq(rq->lock)
735e22bee78STejun Heo  *
736e22bee78STejun Heo  * RETURNS:
737e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
738e22bee78STejun Heo  */
739e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task,
740e22bee78STejun Heo 				       unsigned int cpu)
741e22bee78STejun Heo {
742e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
743bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
74463d95a91STejun Heo 	atomic_t *nr_running = get_pool_nr_running(pool);
745e22bee78STejun Heo 
7462d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
747e22bee78STejun Heo 		return NULL;
748e22bee78STejun Heo 
749e22bee78STejun Heo 	/* this can only happen on the local cpu */
750e22bee78STejun Heo 	BUG_ON(cpu != raw_smp_processor_id());
751e22bee78STejun Heo 
752e22bee78STejun Heo 	/*
753e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
754e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
755e22bee78STejun Heo 	 * Please read comment there.
756e22bee78STejun Heo 	 *
757e22bee78STejun Heo 	 * NOT_RUNNING is clear.  This means that trustee is not in
758e22bee78STejun Heo 	 * charge and we're running on the local cpu w/ rq lock held
759e22bee78STejun Heo 	 * and preemption disabled, which in turn means that none else
760e22bee78STejun Heo 	 * could be manipulating idle_list, so dereferencing idle_list
761e22bee78STejun Heo 	 * without gcwq lock is safe.
762e22bee78STejun Heo 	 */
763bd7bdd43STejun Heo 	if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
76463d95a91STejun Heo 		to_wakeup = first_worker(pool);
765e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
766e22bee78STejun Heo }
767e22bee78STejun Heo 
768e22bee78STejun Heo /**
769e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
770cb444766STejun Heo  * @worker: self
771d302f017STejun Heo  * @flags: flags to set
772d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
773d302f017STejun Heo  *
774e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
775e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
776e22bee78STejun Heo  * woken up.
777d302f017STejun Heo  *
778cb444766STejun Heo  * CONTEXT:
779cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
780d302f017STejun Heo  */
781d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
782d302f017STejun Heo 				    bool wakeup)
783d302f017STejun Heo {
784bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
785e22bee78STejun Heo 
786cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
787cb444766STejun Heo 
788e22bee78STejun Heo 	/*
789e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
790e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
791e22bee78STejun Heo 	 * @wakeup.
792e22bee78STejun Heo 	 */
793e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
794e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
79563d95a91STejun Heo 		atomic_t *nr_running = get_pool_nr_running(pool);
796e22bee78STejun Heo 
797e22bee78STejun Heo 		if (wakeup) {
798e22bee78STejun Heo 			if (atomic_dec_and_test(nr_running) &&
799bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
80063d95a91STejun Heo 				wake_up_worker(pool);
801e22bee78STejun Heo 		} else
802e22bee78STejun Heo 			atomic_dec(nr_running);
803e22bee78STejun Heo 	}
804e22bee78STejun Heo 
805d302f017STejun Heo 	worker->flags |= flags;
806d302f017STejun Heo }
807d302f017STejun Heo 
808d302f017STejun Heo /**
809e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
810cb444766STejun Heo  * @worker: self
811d302f017STejun Heo  * @flags: flags to clear
812d302f017STejun Heo  *
813e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
814d302f017STejun Heo  *
815cb444766STejun Heo  * CONTEXT:
816cb444766STejun Heo  * spin_lock_irq(gcwq->lock)
817d302f017STejun Heo  */
818d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
819d302f017STejun Heo {
82063d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
821e22bee78STejun Heo 	unsigned int oflags = worker->flags;
822e22bee78STejun Heo 
823cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
824cb444766STejun Heo 
825d302f017STejun Heo 	worker->flags &= ~flags;
826e22bee78STejun Heo 
82742c025f3STejun Heo 	/*
82842c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
82942c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
83042c025f3STejun Heo 	 * of multiple flags, not a single flag.
83142c025f3STejun Heo 	 */
832e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
833e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
83463d95a91STejun Heo 			atomic_inc(get_pool_nr_running(pool));
835d302f017STejun Heo }
836d302f017STejun Heo 
837d302f017STejun Heo /**
838c8e55f36STejun Heo  * busy_worker_head - return the busy hash head for a work
839c8e55f36STejun Heo  * @gcwq: gcwq of interest
840c8e55f36STejun Heo  * @work: work to be hashed
841c8e55f36STejun Heo  *
842c8e55f36STejun Heo  * Return hash head of @gcwq for @work.
843c8e55f36STejun Heo  *
844c8e55f36STejun Heo  * CONTEXT:
845c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
846c8e55f36STejun Heo  *
847c8e55f36STejun Heo  * RETURNS:
848c8e55f36STejun Heo  * Pointer to the hash head.
849c8e55f36STejun Heo  */
850c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
851c8e55f36STejun Heo 					   struct work_struct *work)
852c8e55f36STejun Heo {
853c8e55f36STejun Heo 	const int base_shift = ilog2(sizeof(struct work_struct));
854c8e55f36STejun Heo 	unsigned long v = (unsigned long)work;
855c8e55f36STejun Heo 
856c8e55f36STejun Heo 	/* simple shift and fold hash, do we need something better? */
857c8e55f36STejun Heo 	v >>= base_shift;
858c8e55f36STejun Heo 	v += v >> BUSY_WORKER_HASH_ORDER;
859c8e55f36STejun Heo 	v &= BUSY_WORKER_HASH_MASK;
860c8e55f36STejun Heo 
861c8e55f36STejun Heo 	return &gcwq->busy_hash[v];
862c8e55f36STejun Heo }
863c8e55f36STejun Heo 
864c8e55f36STejun Heo /**
8658cca0eeaSTejun Heo  * __find_worker_executing_work - find worker which is executing a work
8668cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8678cca0eeaSTejun Heo  * @bwh: hash head as returned by busy_worker_head()
8688cca0eeaSTejun Heo  * @work: work to find worker for
8698cca0eeaSTejun Heo  *
8708cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  @bwh should be
8718cca0eeaSTejun Heo  * the hash head obtained by calling busy_worker_head() with the same
8728cca0eeaSTejun Heo  * work.
8738cca0eeaSTejun Heo  *
8748cca0eeaSTejun Heo  * CONTEXT:
8758cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
8768cca0eeaSTejun Heo  *
8778cca0eeaSTejun Heo  * RETURNS:
8788cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
8798cca0eeaSTejun Heo  * otherwise.
8808cca0eeaSTejun Heo  */
8818cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
8828cca0eeaSTejun Heo 						   struct hlist_head *bwh,
8838cca0eeaSTejun Heo 						   struct work_struct *work)
8848cca0eeaSTejun Heo {
8858cca0eeaSTejun Heo 	struct worker *worker;
8868cca0eeaSTejun Heo 	struct hlist_node *tmp;
8878cca0eeaSTejun Heo 
8888cca0eeaSTejun Heo 	hlist_for_each_entry(worker, tmp, bwh, hentry)
8898cca0eeaSTejun Heo 		if (worker->current_work == work)
8908cca0eeaSTejun Heo 			return worker;
8918cca0eeaSTejun Heo 	return NULL;
8928cca0eeaSTejun Heo }
8938cca0eeaSTejun Heo 
8948cca0eeaSTejun Heo /**
8958cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
8968cca0eeaSTejun Heo  * @gcwq: gcwq of interest
8978cca0eeaSTejun Heo  * @work: work to find worker for
8988cca0eeaSTejun Heo  *
8998cca0eeaSTejun Heo  * Find a worker which is executing @work on @gcwq.  This function is
9008cca0eeaSTejun Heo  * identical to __find_worker_executing_work() except that this
9018cca0eeaSTejun Heo  * function calculates @bwh itself.
9028cca0eeaSTejun Heo  *
9038cca0eeaSTejun Heo  * CONTEXT:
9048cca0eeaSTejun Heo  * spin_lock_irq(gcwq->lock).
9058cca0eeaSTejun Heo  *
9068cca0eeaSTejun Heo  * RETURNS:
9078cca0eeaSTejun Heo  * Pointer to worker which is executing @work if found, NULL
9088cca0eeaSTejun Heo  * otherwise.
9098cca0eeaSTejun Heo  */
9108cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
9118cca0eeaSTejun Heo 						 struct work_struct *work)
9128cca0eeaSTejun Heo {
9138cca0eeaSTejun Heo 	return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
9148cca0eeaSTejun Heo 					    work);
9158cca0eeaSTejun Heo }
9168cca0eeaSTejun Heo 
9178cca0eeaSTejun Heo /**
9187e11629dSTejun Heo  * insert_work - insert a work into gcwq
9194690c4abSTejun Heo  * @cwq: cwq @work belongs to
9204690c4abSTejun Heo  * @work: work to insert
9214690c4abSTejun Heo  * @head: insertion point
9224690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
9234690c4abSTejun Heo  *
9247e11629dSTejun Heo  * Insert @work which belongs to @cwq into @gcwq after @head.
9257e11629dSTejun Heo  * @extra_flags is or'd to work_struct flags.
9264690c4abSTejun Heo  *
9274690c4abSTejun Heo  * CONTEXT:
9288b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
9291da177e4SLinus Torvalds  */
930b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq,
9314690c4abSTejun Heo 			struct work_struct *work, struct list_head *head,
9324690c4abSTejun Heo 			unsigned int extra_flags)
933b89deed3SOleg Nesterov {
93463d95a91STejun Heo 	struct worker_pool *pool = cwq->pool;
935e1d8aa9fSFrederic Weisbecker 
9364690c4abSTejun Heo 	/* we own @work, set data and link */
9377a22ad75STejun Heo 	set_work_cwq(work, cwq, extra_flags);
9384690c4abSTejun Heo 
9396e84d644SOleg Nesterov 	/*
9406e84d644SOleg Nesterov 	 * Ensure that we get the right work->data if we see the
9416e84d644SOleg Nesterov 	 * result of list_add() below, see try_to_grab_pending().
9426e84d644SOleg Nesterov 	 */
9436e84d644SOleg Nesterov 	smp_wmb();
9444690c4abSTejun Heo 
9451a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
946e22bee78STejun Heo 
947e22bee78STejun Heo 	/*
948e22bee78STejun Heo 	 * Ensure either worker_sched_deactivated() sees the above
949e22bee78STejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers
950e22bee78STejun Heo 	 * lying around lazily while there are works to be processed.
951e22bee78STejun Heo 	 */
952e22bee78STejun Heo 	smp_mb();
953e22bee78STejun Heo 
95463d95a91STejun Heo 	if (__need_more_worker(pool))
95563d95a91STejun Heo 		wake_up_worker(pool);
956b89deed3SOleg Nesterov }
957b89deed3SOleg Nesterov 
958c8efcc25STejun Heo /*
959c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
960c8efcc25STejun Heo  * same workqueue.  This is rather expensive and should only be used from
961c8efcc25STejun Heo  * cold paths.
962c8efcc25STejun Heo  */
963c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
964c8efcc25STejun Heo {
965c8efcc25STejun Heo 	unsigned long flags;
966c8efcc25STejun Heo 	unsigned int cpu;
967c8efcc25STejun Heo 
968c8efcc25STejun Heo 	for_each_gcwq_cpu(cpu) {
969c8efcc25STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
970c8efcc25STejun Heo 		struct worker *worker;
971c8efcc25STejun Heo 		struct hlist_node *pos;
972c8efcc25STejun Heo 		int i;
973c8efcc25STejun Heo 
974c8efcc25STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
975c8efcc25STejun Heo 		for_each_busy_worker(worker, i, pos, gcwq) {
976c8efcc25STejun Heo 			if (worker->task != current)
977c8efcc25STejun Heo 				continue;
978c8efcc25STejun Heo 			spin_unlock_irqrestore(&gcwq->lock, flags);
979c8efcc25STejun Heo 			/*
980c8efcc25STejun Heo 			 * I'm @worker, no locking necessary.  See if @work
981c8efcc25STejun Heo 			 * is headed to the same workqueue.
982c8efcc25STejun Heo 			 */
983c8efcc25STejun Heo 			return worker->current_cwq->wq == wq;
984c8efcc25STejun Heo 		}
985c8efcc25STejun Heo 		spin_unlock_irqrestore(&gcwq->lock, flags);
986c8efcc25STejun Heo 	}
987c8efcc25STejun Heo 	return false;
988c8efcc25STejun Heo }
989c8efcc25STejun Heo 
9904690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
9911da177e4SLinus Torvalds 			 struct work_struct *work)
9921da177e4SLinus Torvalds {
993502ca9d8STejun Heo 	struct global_cwq *gcwq;
994502ca9d8STejun Heo 	struct cpu_workqueue_struct *cwq;
9951e19ffc6STejun Heo 	struct list_head *worklist;
9968a2e8e5dSTejun Heo 	unsigned int work_flags;
9971da177e4SLinus Torvalds 	unsigned long flags;
9981da177e4SLinus Torvalds 
999dc186ad7SThomas Gleixner 	debug_work_activate(work);
10001e19ffc6STejun Heo 
1001c8efcc25STejun Heo 	/* if dying, only works from the same workqueue are allowed */
10029c5a2ba7STejun Heo 	if (unlikely(wq->flags & WQ_DRAINING) &&
1003c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1004e41e704bSTejun Heo 		return;
1005e41e704bSTejun Heo 
1006c7fc77f7STejun Heo 	/* determine gcwq to use */
1007c7fc77f7STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
1008c7fc77f7STejun Heo 		struct global_cwq *last_gcwq;
1009c7fc77f7STejun Heo 
1010f3421797STejun Heo 		if (unlikely(cpu == WORK_CPU_UNBOUND))
1011f3421797STejun Heo 			cpu = raw_smp_processor_id();
1012f3421797STejun Heo 
101318aa9effSTejun Heo 		/*
101418aa9effSTejun Heo 		 * It's multi cpu.  If @wq is non-reentrant and @work
101518aa9effSTejun Heo 		 * was previously on a different cpu, it might still
101618aa9effSTejun Heo 		 * be running there, in which case the work needs to
101718aa9effSTejun Heo 		 * be queued on that cpu to guarantee non-reentrance.
101818aa9effSTejun Heo 		 */
1019502ca9d8STejun Heo 		gcwq = get_gcwq(cpu);
102018aa9effSTejun Heo 		if (wq->flags & WQ_NON_REENTRANT &&
102118aa9effSTejun Heo 		    (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
102218aa9effSTejun Heo 			struct worker *worker;
102318aa9effSTejun Heo 
102418aa9effSTejun Heo 			spin_lock_irqsave(&last_gcwq->lock, flags);
102518aa9effSTejun Heo 
102618aa9effSTejun Heo 			worker = find_worker_executing_work(last_gcwq, work);
102718aa9effSTejun Heo 
102818aa9effSTejun Heo 			if (worker && worker->current_cwq->wq == wq)
102918aa9effSTejun Heo 				gcwq = last_gcwq;
103018aa9effSTejun Heo 			else {
103118aa9effSTejun Heo 				/* meh... not running there, queue here */
103218aa9effSTejun Heo 				spin_unlock_irqrestore(&last_gcwq->lock, flags);
103318aa9effSTejun Heo 				spin_lock_irqsave(&gcwq->lock, flags);
103418aa9effSTejun Heo 			}
103518aa9effSTejun Heo 		} else
10368b03ae3cSTejun Heo 			spin_lock_irqsave(&gcwq->lock, flags);
1037f3421797STejun Heo 	} else {
1038f3421797STejun Heo 		gcwq = get_gcwq(WORK_CPU_UNBOUND);
1039f3421797STejun Heo 		spin_lock_irqsave(&gcwq->lock, flags);
1040502ca9d8STejun Heo 	}
1041502ca9d8STejun Heo 
1042502ca9d8STejun Heo 	/* gcwq determined, get cwq and queue */
1043502ca9d8STejun Heo 	cwq = get_cwq(gcwq->cpu, wq);
1044cdadf009STejun Heo 	trace_workqueue_queue_work(cpu, cwq, work);
1045502ca9d8STejun Heo 
1046f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1047f5b2552bSDan Carpenter 		spin_unlock_irqrestore(&gcwq->lock, flags);
1048f5b2552bSDan Carpenter 		return;
1049f5b2552bSDan Carpenter 	}
10501e19ffc6STejun Heo 
105173f53c4aSTejun Heo 	cwq->nr_in_flight[cwq->work_color]++;
10528a2e8e5dSTejun Heo 	work_flags = work_color_to_flags(cwq->work_color);
10531e19ffc6STejun Heo 
10541e19ffc6STejun Heo 	if (likely(cwq->nr_active < cwq->max_active)) {
1055cdadf009STejun Heo 		trace_workqueue_activate_work(work);
10561e19ffc6STejun Heo 		cwq->nr_active++;
10573270476aSTejun Heo 		worklist = &cwq->pool->worklist;
10588a2e8e5dSTejun Heo 	} else {
10598a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
10601e19ffc6STejun Heo 		worklist = &cwq->delayed_works;
10618a2e8e5dSTejun Heo 	}
10621e19ffc6STejun Heo 
10638a2e8e5dSTejun Heo 	insert_work(cwq, work, worklist, work_flags);
10641e19ffc6STejun Heo 
10658b03ae3cSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
10661da177e4SLinus Torvalds }
10671da177e4SLinus Torvalds 
10680fcb78c2SRolf Eike Beer /**
10690fcb78c2SRolf Eike Beer  * queue_work - queue work on a workqueue
10700fcb78c2SRolf Eike Beer  * @wq: workqueue to use
10710fcb78c2SRolf Eike Beer  * @work: work to queue
10720fcb78c2SRolf Eike Beer  *
1073057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
10741da177e4SLinus Torvalds  *
107500dfcaf7SOleg Nesterov  * We queue the work to the CPU on which it was submitted, but if the CPU dies
107600dfcaf7SOleg Nesterov  * it can be processed by another CPU.
10771da177e4SLinus Torvalds  */
10787ad5b3a5SHarvey Harrison int queue_work(struct workqueue_struct *wq, struct work_struct *work)
10791da177e4SLinus Torvalds {
1080ef1ca236SOleg Nesterov 	int ret;
10811da177e4SLinus Torvalds 
1082ef1ca236SOleg Nesterov 	ret = queue_work_on(get_cpu(), wq, work);
1083a848e3b6SOleg Nesterov 	put_cpu();
1084ef1ca236SOleg Nesterov 
10851da177e4SLinus Torvalds 	return ret;
10861da177e4SLinus Torvalds }
1087ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_work);
10881da177e4SLinus Torvalds 
1089c1a220e7SZhang Rui /**
1090c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1091c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1092c1a220e7SZhang Rui  * @wq: workqueue to use
1093c1a220e7SZhang Rui  * @work: work to queue
1094c1a220e7SZhang Rui  *
1095c1a220e7SZhang Rui  * Returns 0 if @work was already on a queue, non-zero otherwise.
1096c1a220e7SZhang Rui  *
1097c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1098c1a220e7SZhang Rui  * can't go away.
1099c1a220e7SZhang Rui  */
1100c1a220e7SZhang Rui int
1101c1a220e7SZhang Rui queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1102c1a220e7SZhang Rui {
1103c1a220e7SZhang Rui 	int ret = 0;
1104c1a220e7SZhang Rui 
110522df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
11064690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1107c1a220e7SZhang Rui 		ret = 1;
1108c1a220e7SZhang Rui 	}
1109c1a220e7SZhang Rui 	return ret;
1110c1a220e7SZhang Rui }
1111c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on);
1112c1a220e7SZhang Rui 
11136d141c3fSLi Zefan static void delayed_work_timer_fn(unsigned long __data)
11141da177e4SLinus Torvalds {
111552bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
11167a22ad75STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
11171da177e4SLinus Torvalds 
11184690c4abSTejun Heo 	__queue_work(smp_processor_id(), cwq->wq, &dwork->work);
11191da177e4SLinus Torvalds }
11201da177e4SLinus Torvalds 
11210fcb78c2SRolf Eike Beer /**
11220fcb78c2SRolf Eike Beer  * queue_delayed_work - queue work on a workqueue after delay
11230fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1124af9997e4SRandy Dunlap  * @dwork: delayable work to queue
11250fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11260fcb78c2SRolf Eike Beer  *
1127057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11280fcb78c2SRolf Eike Beer  */
11297ad5b3a5SHarvey Harrison int queue_delayed_work(struct workqueue_struct *wq,
113052bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11311da177e4SLinus Torvalds {
113252bad64dSDavid Howells 	if (delay == 0)
113363bc0362SOleg Nesterov 		return queue_work(wq, &dwork->work);
11341da177e4SLinus Torvalds 
113563bc0362SOleg Nesterov 	return queue_delayed_work_on(-1, wq, dwork, delay);
11361da177e4SLinus Torvalds }
1137ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work);
11381da177e4SLinus Torvalds 
11390fcb78c2SRolf Eike Beer /**
11400fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
11410fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
11420fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1143af9997e4SRandy Dunlap  * @dwork: work to queue
11440fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
11450fcb78c2SRolf Eike Beer  *
1146057647fcSAlan Stern  * Returns 0 if @work was already on a queue, non-zero otherwise.
11470fcb78c2SRolf Eike Beer  */
11487a6bc1cdSVenkatesh Pallipadi int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
114952bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
11507a6bc1cdSVenkatesh Pallipadi {
11517a6bc1cdSVenkatesh Pallipadi 	int ret = 0;
115252bad64dSDavid Howells 	struct timer_list *timer = &dwork->timer;
115352bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
11547a6bc1cdSVenkatesh Pallipadi 
115522df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1156c7fc77f7STejun Heo 		unsigned int lcpu;
11577a22ad75STejun Heo 
11587a6bc1cdSVenkatesh Pallipadi 		BUG_ON(timer_pending(timer));
11597a6bc1cdSVenkatesh Pallipadi 		BUG_ON(!list_empty(&work->entry));
11607a6bc1cdSVenkatesh Pallipadi 
11618a3e77ccSAndrew Liu 		timer_stats_timer_set_start_info(&dwork->timer);
11628a3e77ccSAndrew Liu 
11637a22ad75STejun Heo 		/*
11647a22ad75STejun Heo 		 * This stores cwq for the moment, for the timer_fn.
11657a22ad75STejun Heo 		 * Note that the work's gcwq is preserved to allow
11667a22ad75STejun Heo 		 * reentrance detection for delayed works.
11677a22ad75STejun Heo 		 */
1168c7fc77f7STejun Heo 		if (!(wq->flags & WQ_UNBOUND)) {
1169c7fc77f7STejun Heo 			struct global_cwq *gcwq = get_work_gcwq(work);
1170c7fc77f7STejun Heo 
1171c7fc77f7STejun Heo 			if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1172c7fc77f7STejun Heo 				lcpu = gcwq->cpu;
1173c7fc77f7STejun Heo 			else
1174c7fc77f7STejun Heo 				lcpu = raw_smp_processor_id();
1175c7fc77f7STejun Heo 		} else
1176c7fc77f7STejun Heo 			lcpu = WORK_CPU_UNBOUND;
1177c7fc77f7STejun Heo 
11787a22ad75STejun Heo 		set_work_cwq(work, get_cwq(lcpu, wq), 0);
1179c7fc77f7STejun Heo 
11807a6bc1cdSVenkatesh Pallipadi 		timer->expires = jiffies + delay;
118152bad64dSDavid Howells 		timer->data = (unsigned long)dwork;
11827a6bc1cdSVenkatesh Pallipadi 		timer->function = delayed_work_timer_fn;
118363bc0362SOleg Nesterov 
118463bc0362SOleg Nesterov 		if (unlikely(cpu >= 0))
11857a6bc1cdSVenkatesh Pallipadi 			add_timer_on(timer, cpu);
118663bc0362SOleg Nesterov 		else
118763bc0362SOleg Nesterov 			add_timer(timer);
11887a6bc1cdSVenkatesh Pallipadi 		ret = 1;
11897a6bc1cdSVenkatesh Pallipadi 	}
11907a6bc1cdSVenkatesh Pallipadi 	return ret;
11917a6bc1cdSVenkatesh Pallipadi }
1192ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on);
11931da177e4SLinus Torvalds 
1194c8e55f36STejun Heo /**
1195c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1196c8e55f36STejun Heo  * @worker: worker which is entering idle state
1197c8e55f36STejun Heo  *
1198c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1199c8e55f36STejun Heo  * necessary.
1200c8e55f36STejun Heo  *
1201c8e55f36STejun Heo  * LOCKING:
1202c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1203c8e55f36STejun Heo  */
1204c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
12051da177e4SLinus Torvalds {
1206bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1207bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1208c8e55f36STejun Heo 
1209c8e55f36STejun Heo 	BUG_ON(worker->flags & WORKER_IDLE);
1210c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->entry) &&
1211c8e55f36STejun Heo 	       (worker->hentry.next || worker->hentry.pprev));
1212c8e55f36STejun Heo 
1213cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1214cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1215bd7bdd43STejun Heo 	pool->nr_idle++;
1216e22bee78STejun Heo 	worker->last_active = jiffies;
1217c8e55f36STejun Heo 
1218c8e55f36STejun Heo 	/* idle_list is LIFO */
1219bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1220db7bccf4STejun Heo 
1221403c821dSTejun Heo 	if (likely(gcwq->trustee_state != TRUSTEE_DONE)) {
122263d95a91STejun Heo 		if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1223bd7bdd43STejun Heo 			mod_timer(&pool->idle_timer,
1224e22bee78STejun Heo 				  jiffies + IDLE_WORKER_TIMEOUT);
1225e22bee78STejun Heo 	} else
1226db7bccf4STejun Heo 		wake_up_all(&gcwq->trustee_wait);
1227cb444766STejun Heo 
1228544ecf31STejun Heo 	/*
1229544ecf31STejun Heo 	 * Sanity check nr_running.  Because trustee releases gcwq->lock
1230403c821dSTejun Heo 	 * between setting %WORKER_UNBOUND and zapping nr_running, the
1231544ecf31STejun Heo 	 * warning may trigger spuriously.  Check iff trustee is idle.
1232544ecf31STejun Heo 	 */
1233544ecf31STejun Heo 	WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
1234bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
123563d95a91STejun Heo 		     atomic_read(get_pool_nr_running(pool)));
1236c8e55f36STejun Heo }
1237c8e55f36STejun Heo 
1238c8e55f36STejun Heo /**
1239c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1240c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1241c8e55f36STejun Heo  *
1242c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1243c8e55f36STejun Heo  *
1244c8e55f36STejun Heo  * LOCKING:
1245c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock).
1246c8e55f36STejun Heo  */
1247c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1248c8e55f36STejun Heo {
1249bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1250c8e55f36STejun Heo 
1251c8e55f36STejun Heo 	BUG_ON(!(worker->flags & WORKER_IDLE));
1252d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1253bd7bdd43STejun Heo 	pool->nr_idle--;
1254c8e55f36STejun Heo 	list_del_init(&worker->entry);
1255c8e55f36STejun Heo }
1256c8e55f36STejun Heo 
1257e22bee78STejun Heo /**
1258e22bee78STejun Heo  * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1259e22bee78STejun Heo  * @worker: self
1260e22bee78STejun Heo  *
1261e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1262e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1263e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1264e22bee78STejun Heo  * guaranteed to execute on the cpu.
1265e22bee78STejun Heo  *
1266e22bee78STejun Heo  * This function is to be used by rogue workers and rescuers to bind
1267e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1268e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1269e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1270e22bee78STejun Heo  * verbatim as it's best effort and blocking and gcwq may be
1271e22bee78STejun Heo  * [dis]associated in the meantime.
1272e22bee78STejun Heo  *
1273f2d5a0eeSTejun Heo  * This function tries set_cpus_allowed() and locks gcwq and verifies the
1274f2d5a0eeSTejun Heo  * binding against %GCWQ_DISASSOCIATED which is set during
1275f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1276f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1277f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1278e22bee78STejun Heo  *
1279e22bee78STejun Heo  * CONTEXT:
1280e22bee78STejun Heo  * Might sleep.  Called without any lock but returns with gcwq->lock
1281e22bee78STejun Heo  * held.
1282e22bee78STejun Heo  *
1283e22bee78STejun Heo  * RETURNS:
1284e22bee78STejun Heo  * %true if the associated gcwq is online (@worker is successfully
1285e22bee78STejun Heo  * bound), %false if offline.
1286e22bee78STejun Heo  */
1287e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker)
1288972fa1c5SNamhyung Kim __acquires(&gcwq->lock)
1289e22bee78STejun Heo {
1290bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1291e22bee78STejun Heo 	struct task_struct *task = worker->task;
1292e22bee78STejun Heo 
1293e22bee78STejun Heo 	while (true) {
1294e22bee78STejun Heo 		/*
1295e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1296e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1297e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
1298e22bee78STejun Heo 		 * against GCWQ_DISASSOCIATED.
1299e22bee78STejun Heo 		 */
1300f3421797STejun Heo 		if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1301e22bee78STejun Heo 			set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
1302e22bee78STejun Heo 
1303e22bee78STejun Heo 		spin_lock_irq(&gcwq->lock);
1304e22bee78STejun Heo 		if (gcwq->flags & GCWQ_DISASSOCIATED)
1305e22bee78STejun Heo 			return false;
1306e22bee78STejun Heo 		if (task_cpu(task) == gcwq->cpu &&
1307e22bee78STejun Heo 		    cpumask_equal(&current->cpus_allowed,
1308e22bee78STejun Heo 				  get_cpu_mask(gcwq->cpu)))
1309e22bee78STejun Heo 			return true;
1310e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
1311e22bee78STejun Heo 
13125035b20fSTejun Heo 		/*
13135035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
13145035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
13155035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
13165035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
13175035b20fSTejun Heo 		 */
1318e22bee78STejun Heo 		cpu_relax();
13195035b20fSTejun Heo 		cond_resched();
1320e22bee78STejun Heo 	}
1321e22bee78STejun Heo }
1322e22bee78STejun Heo 
1323*25511a47STejun Heo struct idle_rebind {
1324*25511a47STejun Heo 	int			cnt;		/* # workers to be rebound */
1325*25511a47STejun Heo 	struct completion	done;		/* all workers rebound */
1326*25511a47STejun Heo };
1327*25511a47STejun Heo 
1328e22bee78STejun Heo /*
1329*25511a47STejun Heo  * Rebind an idle @worker to its CPU.  During CPU onlining, this has to
1330*25511a47STejun Heo  * happen synchronously for idle workers.  worker_thread() will test
1331*25511a47STejun Heo  * %WORKER_REBIND before leaving idle and call this function.
1332*25511a47STejun Heo  */
1333*25511a47STejun Heo static void idle_worker_rebind(struct worker *worker)
1334*25511a47STejun Heo {
1335*25511a47STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1336*25511a47STejun Heo 
1337*25511a47STejun Heo 	/* CPU must be online at this point */
1338*25511a47STejun Heo 	WARN_ON(!worker_maybe_bind_and_lock(worker));
1339*25511a47STejun Heo 	if (!--worker->idle_rebind->cnt)
1340*25511a47STejun Heo 		complete(&worker->idle_rebind->done);
1341*25511a47STejun Heo 	spin_unlock_irq(&worker->pool->gcwq->lock);
1342*25511a47STejun Heo 
1343*25511a47STejun Heo 	/* we did our part, wait for rebind_workers() to finish up */
1344*25511a47STejun Heo 	wait_event(gcwq->rebind_hold, !(worker->flags & WORKER_REBIND));
1345*25511a47STejun Heo }
1346*25511a47STejun Heo 
1347*25511a47STejun Heo /*
1348*25511a47STejun Heo  * Function for @worker->rebind.work used to rebind unbound busy workers to
1349403c821dSTejun Heo  * the associated cpu which is coming back online.  This is scheduled by
1350403c821dSTejun Heo  * cpu up but can race with other cpu hotplug operations and may be
1351403c821dSTejun Heo  * executed twice without intervening cpu down.
1352e22bee78STejun Heo  */
1353*25511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work)
1354e22bee78STejun Heo {
1355e22bee78STejun Heo 	struct worker *worker = container_of(work, struct worker, rebind_work);
1356bd7bdd43STejun Heo 	struct global_cwq *gcwq = worker->pool->gcwq;
1357e22bee78STejun Heo 
1358e22bee78STejun Heo 	if (worker_maybe_bind_and_lock(worker))
1359e22bee78STejun Heo 		worker_clr_flags(worker, WORKER_REBIND);
1360e22bee78STejun Heo 
1361e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1362e22bee78STejun Heo }
1363e22bee78STejun Heo 
1364*25511a47STejun Heo /**
1365*25511a47STejun Heo  * rebind_workers - rebind all workers of a gcwq to the associated CPU
1366*25511a47STejun Heo  * @gcwq: gcwq of interest
1367*25511a47STejun Heo  *
1368*25511a47STejun Heo  * @gcwq->cpu is coming online.  Rebind all workers to the CPU.  Rebinding
1369*25511a47STejun Heo  * is different for idle and busy ones.
1370*25511a47STejun Heo  *
1371*25511a47STejun Heo  * The idle ones should be rebound synchronously and idle rebinding should
1372*25511a47STejun Heo  * be complete before any worker starts executing work items with
1373*25511a47STejun Heo  * concurrency management enabled; otherwise, scheduler may oops trying to
1374*25511a47STejun Heo  * wake up non-local idle worker from wq_worker_sleeping().
1375*25511a47STejun Heo  *
1376*25511a47STejun Heo  * This is achieved by repeatedly requesting rebinding until all idle
1377*25511a47STejun Heo  * workers are known to have been rebound under @gcwq->lock and holding all
1378*25511a47STejun Heo  * idle workers from becoming busy until idle rebinding is complete.
1379*25511a47STejun Heo  *
1380*25511a47STejun Heo  * Once idle workers are rebound, busy workers can be rebound as they
1381*25511a47STejun Heo  * finish executing their current work items.  Queueing the rebind work at
1382*25511a47STejun Heo  * the head of their scheduled lists is enough.  Note that nr_running will
1383*25511a47STejun Heo  * be properbly bumped as busy workers rebind.
1384*25511a47STejun Heo  *
1385*25511a47STejun Heo  * On return, all workers are guaranteed to either be bound or have rebind
1386*25511a47STejun Heo  * work item scheduled.
1387*25511a47STejun Heo  */
1388*25511a47STejun Heo static void rebind_workers(struct global_cwq *gcwq)
1389*25511a47STejun Heo 	__releases(&gcwq->lock) __acquires(&gcwq->lock)
1390*25511a47STejun Heo {
1391*25511a47STejun Heo 	struct idle_rebind idle_rebind;
1392*25511a47STejun Heo 	struct worker_pool *pool;
1393*25511a47STejun Heo 	struct worker *worker;
1394*25511a47STejun Heo 	struct hlist_node *pos;
1395*25511a47STejun Heo 	int i;
1396*25511a47STejun Heo 
1397*25511a47STejun Heo 	lockdep_assert_held(&gcwq->lock);
1398*25511a47STejun Heo 
1399*25511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
1400*25511a47STejun Heo 		lockdep_assert_held(&pool->manager_mutex);
1401*25511a47STejun Heo 
1402*25511a47STejun Heo 	/*
1403*25511a47STejun Heo 	 * Rebind idle workers.  Interlocked both ways.  We wait for
1404*25511a47STejun Heo 	 * workers to rebind via @idle_rebind.done.  Workers will wait for
1405*25511a47STejun Heo 	 * us to finish up by watching %WORKER_REBIND.
1406*25511a47STejun Heo 	 */
1407*25511a47STejun Heo 	init_completion(&idle_rebind.done);
1408*25511a47STejun Heo retry:
1409*25511a47STejun Heo 	idle_rebind.cnt = 1;
1410*25511a47STejun Heo 	INIT_COMPLETION(idle_rebind.done);
1411*25511a47STejun Heo 
1412*25511a47STejun Heo 	/* set REBIND and kick idle ones, we'll wait for these later */
1413*25511a47STejun Heo 	for_each_worker_pool(pool, gcwq) {
1414*25511a47STejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry) {
1415*25511a47STejun Heo 			if (worker->flags & WORKER_REBIND)
1416*25511a47STejun Heo 				continue;
1417*25511a47STejun Heo 
1418*25511a47STejun Heo 			/* morph UNBOUND to REBIND */
1419*25511a47STejun Heo 			worker->flags &= ~WORKER_UNBOUND;
1420*25511a47STejun Heo 			worker->flags |= WORKER_REBIND;
1421*25511a47STejun Heo 
1422*25511a47STejun Heo 			idle_rebind.cnt++;
1423*25511a47STejun Heo 			worker->idle_rebind = &idle_rebind;
1424*25511a47STejun Heo 
1425*25511a47STejun Heo 			/* worker_thread() will call idle_worker_rebind() */
1426*25511a47STejun Heo 			wake_up_process(worker->task);
1427*25511a47STejun Heo 		}
1428*25511a47STejun Heo 	}
1429*25511a47STejun Heo 
1430*25511a47STejun Heo 	if (--idle_rebind.cnt) {
1431*25511a47STejun Heo 		spin_unlock_irq(&gcwq->lock);
1432*25511a47STejun Heo 		wait_for_completion(&idle_rebind.done);
1433*25511a47STejun Heo 		spin_lock_irq(&gcwq->lock);
1434*25511a47STejun Heo 		/* busy ones might have become idle while waiting, retry */
1435*25511a47STejun Heo 		goto retry;
1436*25511a47STejun Heo 	}
1437*25511a47STejun Heo 
1438*25511a47STejun Heo 	/*
1439*25511a47STejun Heo 	 * All idle workers are rebound and waiting for %WORKER_REBIND to
1440*25511a47STejun Heo 	 * be cleared inside idle_worker_rebind().  Clear and release.
1441*25511a47STejun Heo 	 * Clearing %WORKER_REBIND from this foreign context is safe
1442*25511a47STejun Heo 	 * because these workers are still guaranteed to be idle.
1443*25511a47STejun Heo 	 */
1444*25511a47STejun Heo 	for_each_worker_pool(pool, gcwq)
1445*25511a47STejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
1446*25511a47STejun Heo 			worker->flags &= ~WORKER_REBIND;
1447*25511a47STejun Heo 
1448*25511a47STejun Heo 	wake_up_all(&gcwq->rebind_hold);
1449*25511a47STejun Heo 
1450*25511a47STejun Heo 	/* rebind busy workers */
1451*25511a47STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq) {
1452*25511a47STejun Heo 		struct work_struct *rebind_work = &worker->rebind_work;
1453*25511a47STejun Heo 
1454*25511a47STejun Heo 		/* morph UNBOUND to REBIND */
1455*25511a47STejun Heo 		worker->flags &= ~WORKER_UNBOUND;
1456*25511a47STejun Heo 		worker->flags |= WORKER_REBIND;
1457*25511a47STejun Heo 
1458*25511a47STejun Heo 		if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1459*25511a47STejun Heo 				     work_data_bits(rebind_work)))
1460*25511a47STejun Heo 			continue;
1461*25511a47STejun Heo 
1462*25511a47STejun Heo 		/* wq doesn't matter, use the default one */
1463*25511a47STejun Heo 		debug_work_activate(rebind_work);
1464*25511a47STejun Heo 		insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
1465*25511a47STejun Heo 			    worker->scheduled.next,
1466*25511a47STejun Heo 			    work_color_to_flags(WORK_NO_COLOR));
1467*25511a47STejun Heo 	}
1468*25511a47STejun Heo }
1469*25511a47STejun Heo 
1470c34056a3STejun Heo static struct worker *alloc_worker(void)
1471c34056a3STejun Heo {
1472c34056a3STejun Heo 	struct worker *worker;
1473c34056a3STejun Heo 
1474c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1475c8e55f36STejun Heo 	if (worker) {
1476c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1477affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1478*25511a47STejun Heo 		INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
1479e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1480e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1481c8e55f36STejun Heo 	}
1482c34056a3STejun Heo 	return worker;
1483c34056a3STejun Heo }
1484c34056a3STejun Heo 
1485c34056a3STejun Heo /**
1486c34056a3STejun Heo  * create_worker - create a new workqueue worker
148763d95a91STejun Heo  * @pool: pool the new worker will belong to
1488c34056a3STejun Heo  *
148963d95a91STejun Heo  * Create a new worker which is bound to @pool.  The returned worker
1490c34056a3STejun Heo  * can be started by calling start_worker() or destroyed using
1491c34056a3STejun Heo  * destroy_worker().
1492c34056a3STejun Heo  *
1493c34056a3STejun Heo  * CONTEXT:
1494c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1495c34056a3STejun Heo  *
1496c34056a3STejun Heo  * RETURNS:
1497c34056a3STejun Heo  * Pointer to the newly created worker.
1498c34056a3STejun Heo  */
1499bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1500c34056a3STejun Heo {
150163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
15023270476aSTejun Heo 	const char *pri = worker_pool_pri(pool) ? "H" : "";
1503c34056a3STejun Heo 	struct worker *worker = NULL;
1504f3421797STejun Heo 	int id = -1;
1505c34056a3STejun Heo 
15068b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1507bd7bdd43STejun Heo 	while (ida_get_new(&pool->worker_ida, &id)) {
15088b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1509bd7bdd43STejun Heo 		if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
1510c34056a3STejun Heo 			goto fail;
15118b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1512c34056a3STejun Heo 	}
15138b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
1514c34056a3STejun Heo 
1515c34056a3STejun Heo 	worker = alloc_worker();
1516c34056a3STejun Heo 	if (!worker)
1517c34056a3STejun Heo 		goto fail;
1518c34056a3STejun Heo 
1519bd7bdd43STejun Heo 	worker->pool = pool;
1520c34056a3STejun Heo 	worker->id = id;
1521c34056a3STejun Heo 
1522bc2ae0f5STejun Heo 	if (gcwq->cpu != WORK_CPU_UNBOUND)
152394dcf29aSEric Dumazet 		worker->task = kthread_create_on_node(worker_thread,
15243270476aSTejun Heo 					worker, cpu_to_node(gcwq->cpu),
15253270476aSTejun Heo 					"kworker/%u:%d%s", gcwq->cpu, id, pri);
1526f3421797STejun Heo 	else
1527f3421797STejun Heo 		worker->task = kthread_create(worker_thread, worker,
15283270476aSTejun Heo 					      "kworker/u:%d%s", id, pri);
1529c34056a3STejun Heo 	if (IS_ERR(worker->task))
1530c34056a3STejun Heo 		goto fail;
1531c34056a3STejun Heo 
15323270476aSTejun Heo 	if (worker_pool_pri(pool))
15333270476aSTejun Heo 		set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
15343270476aSTejun Heo 
1535db7bccf4STejun Heo 	/*
1536bc2ae0f5STejun Heo 	 * Determine CPU binding of the new worker depending on
1537bc2ae0f5STejun Heo 	 * %GCWQ_DISASSOCIATED.  The caller is responsible for ensuring the
1538bc2ae0f5STejun Heo 	 * flag remains stable across this function.  See the comments
1539bc2ae0f5STejun Heo 	 * above the flag definition for details.
1540bc2ae0f5STejun Heo 	 *
1541bc2ae0f5STejun Heo 	 * As an unbound worker may later become a regular one if CPU comes
1542bc2ae0f5STejun Heo 	 * online, make sure every worker has %PF_THREAD_BOUND set.
1543db7bccf4STejun Heo 	 */
1544bc2ae0f5STejun Heo 	if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
15458b03ae3cSTejun Heo 		kthread_bind(worker->task, gcwq->cpu);
1546bc2ae0f5STejun Heo 	} else {
1547db7bccf4STejun Heo 		worker->task->flags |= PF_THREAD_BOUND;
1548f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1549f3421797STejun Heo 	}
1550c34056a3STejun Heo 
1551c34056a3STejun Heo 	return worker;
1552c34056a3STejun Heo fail:
1553c34056a3STejun Heo 	if (id >= 0) {
15548b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
1555bd7bdd43STejun Heo 		ida_remove(&pool->worker_ida, id);
15568b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
1557c34056a3STejun Heo 	}
1558c34056a3STejun Heo 	kfree(worker);
1559c34056a3STejun Heo 	return NULL;
1560c34056a3STejun Heo }
1561c34056a3STejun Heo 
1562c34056a3STejun Heo /**
1563c34056a3STejun Heo  * start_worker - start a newly created worker
1564c34056a3STejun Heo  * @worker: worker to start
1565c34056a3STejun Heo  *
1566c8e55f36STejun Heo  * Make the gcwq aware of @worker and start it.
1567c34056a3STejun Heo  *
1568c34056a3STejun Heo  * CONTEXT:
15698b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1570c34056a3STejun Heo  */
1571c34056a3STejun Heo static void start_worker(struct worker *worker)
1572c34056a3STejun Heo {
1573cb444766STejun Heo 	worker->flags |= WORKER_STARTED;
1574bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1575c8e55f36STejun Heo 	worker_enter_idle(worker);
1576c34056a3STejun Heo 	wake_up_process(worker->task);
1577c34056a3STejun Heo }
1578c34056a3STejun Heo 
1579c34056a3STejun Heo /**
1580c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1581c34056a3STejun Heo  * @worker: worker to be destroyed
1582c34056a3STejun Heo  *
1583c8e55f36STejun Heo  * Destroy @worker and adjust @gcwq stats accordingly.
1584c8e55f36STejun Heo  *
1585c8e55f36STejun Heo  * CONTEXT:
1586c8e55f36STejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1587c34056a3STejun Heo  */
1588c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1589c34056a3STejun Heo {
1590bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1591bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1592c34056a3STejun Heo 	int id = worker->id;
1593c34056a3STejun Heo 
1594c34056a3STejun Heo 	/* sanity check frenzy */
1595c34056a3STejun Heo 	BUG_ON(worker->current_work);
1596affee4b2STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
1597c34056a3STejun Heo 
1598c8e55f36STejun Heo 	if (worker->flags & WORKER_STARTED)
1599bd7bdd43STejun Heo 		pool->nr_workers--;
1600c8e55f36STejun Heo 	if (worker->flags & WORKER_IDLE)
1601bd7bdd43STejun Heo 		pool->nr_idle--;
1602c8e55f36STejun Heo 
1603c8e55f36STejun Heo 	list_del_init(&worker->entry);
1604cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1605c8e55f36STejun Heo 
1606c8e55f36STejun Heo 	spin_unlock_irq(&gcwq->lock);
1607c8e55f36STejun Heo 
1608c34056a3STejun Heo 	kthread_stop(worker->task);
1609c34056a3STejun Heo 	kfree(worker);
1610c34056a3STejun Heo 
16118b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
1612bd7bdd43STejun Heo 	ida_remove(&pool->worker_ida, id);
1613c34056a3STejun Heo }
1614c34056a3STejun Heo 
161563d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1616e22bee78STejun Heo {
161763d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
161863d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1619e22bee78STejun Heo 
1620e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1621e22bee78STejun Heo 
162263d95a91STejun Heo 	if (too_many_workers(pool)) {
1623e22bee78STejun Heo 		struct worker *worker;
1624e22bee78STejun Heo 		unsigned long expires;
1625e22bee78STejun Heo 
1626e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
162763d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1628e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1629e22bee78STejun Heo 
1630e22bee78STejun Heo 		if (time_before(jiffies, expires))
163163d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1632e22bee78STejun Heo 		else {
1633e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
163411ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
163563d95a91STejun Heo 			wake_up_worker(pool);
1636e22bee78STejun Heo 		}
1637e22bee78STejun Heo 	}
1638e22bee78STejun Heo 
1639e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1640e22bee78STejun Heo }
1641e22bee78STejun Heo 
1642e22bee78STejun Heo static bool send_mayday(struct work_struct *work)
1643e22bee78STejun Heo {
1644e22bee78STejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1645e22bee78STejun Heo 	struct workqueue_struct *wq = cwq->wq;
1646f3421797STejun Heo 	unsigned int cpu;
1647e22bee78STejun Heo 
1648e22bee78STejun Heo 	if (!(wq->flags & WQ_RESCUER))
1649e22bee78STejun Heo 		return false;
1650e22bee78STejun Heo 
1651e22bee78STejun Heo 	/* mayday mayday mayday */
1652bd7bdd43STejun Heo 	cpu = cwq->pool->gcwq->cpu;
1653f3421797STejun Heo 	/* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1654f3421797STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
1655f3421797STejun Heo 		cpu = 0;
1656f2e005aaSTejun Heo 	if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
1657e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1658e22bee78STejun Heo 	return true;
1659e22bee78STejun Heo }
1660e22bee78STejun Heo 
166163d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool)
1662e22bee78STejun Heo {
166363d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
166463d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1665e22bee78STejun Heo 	struct work_struct *work;
1666e22bee78STejun Heo 
1667e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
1668e22bee78STejun Heo 
166963d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1670e22bee78STejun Heo 		/*
1671e22bee78STejun Heo 		 * We've been trying to create a new worker but
1672e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1673e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1674e22bee78STejun Heo 		 * rescuers.
1675e22bee78STejun Heo 		 */
167663d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1677e22bee78STejun Heo 			send_mayday(work);
1678e22bee78STejun Heo 	}
1679e22bee78STejun Heo 
1680e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
1681e22bee78STejun Heo 
168263d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1683e22bee78STejun Heo }
1684e22bee78STejun Heo 
1685e22bee78STejun Heo /**
1686e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
168763d95a91STejun Heo  * @pool: pool to create a new worker for
1688e22bee78STejun Heo  *
168963d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1690e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1691e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
169263d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1693e22bee78STejun Heo  * possible allocation deadlock.
1694e22bee78STejun Heo  *
1695e22bee78STejun Heo  * On return, need_to_create_worker() is guaranteed to be false and
1696e22bee78STejun Heo  * may_start_working() true.
1697e22bee78STejun Heo  *
1698e22bee78STejun Heo  * LOCKING:
1699e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1700e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1701e22bee78STejun Heo  * manager.
1702e22bee78STejun Heo  *
1703e22bee78STejun Heo  * RETURNS:
1704e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1705e22bee78STejun Heo  * otherwise.
1706e22bee78STejun Heo  */
170763d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
170806bd6ebfSNamhyung Kim __releases(&gcwq->lock)
170906bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
1710e22bee78STejun Heo {
171163d95a91STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
171263d95a91STejun Heo 
171363d95a91STejun Heo 	if (!need_to_create_worker(pool))
1714e22bee78STejun Heo 		return false;
1715e22bee78STejun Heo restart:
17169f9c2364STejun Heo 	spin_unlock_irq(&gcwq->lock);
17179f9c2364STejun Heo 
1718e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
171963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1720e22bee78STejun Heo 
1721e22bee78STejun Heo 	while (true) {
1722e22bee78STejun Heo 		struct worker *worker;
1723e22bee78STejun Heo 
1724bc2ae0f5STejun Heo 		worker = create_worker(pool);
1725e22bee78STejun Heo 		if (worker) {
172663d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1727e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
1728e22bee78STejun Heo 			start_worker(worker);
172963d95a91STejun Heo 			BUG_ON(need_to_create_worker(pool));
1730e22bee78STejun Heo 			return true;
1731e22bee78STejun Heo 		}
1732e22bee78STejun Heo 
173363d95a91STejun Heo 		if (!need_to_create_worker(pool))
1734e22bee78STejun Heo 			break;
1735e22bee78STejun Heo 
1736e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1737e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
17389f9c2364STejun Heo 
173963d95a91STejun Heo 		if (!need_to_create_worker(pool))
1740e22bee78STejun Heo 			break;
1741e22bee78STejun Heo 	}
1742e22bee78STejun Heo 
174363d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1744e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
174563d95a91STejun Heo 	if (need_to_create_worker(pool))
1746e22bee78STejun Heo 		goto restart;
1747e22bee78STejun Heo 	return true;
1748e22bee78STejun Heo }
1749e22bee78STejun Heo 
1750e22bee78STejun Heo /**
1751e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
175263d95a91STejun Heo  * @pool: pool to destroy workers for
1753e22bee78STejun Heo  *
175463d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
1755e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
1756e22bee78STejun Heo  *
1757e22bee78STejun Heo  * LOCKING:
1758e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1759e22bee78STejun Heo  * multiple times.  Called only from manager.
1760e22bee78STejun Heo  *
1761e22bee78STejun Heo  * RETURNS:
1762e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true
1763e22bee78STejun Heo  * otherwise.
1764e22bee78STejun Heo  */
176563d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
1766e22bee78STejun Heo {
1767e22bee78STejun Heo 	bool ret = false;
1768e22bee78STejun Heo 
176963d95a91STejun Heo 	while (too_many_workers(pool)) {
1770e22bee78STejun Heo 		struct worker *worker;
1771e22bee78STejun Heo 		unsigned long expires;
1772e22bee78STejun Heo 
177363d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1774e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1775e22bee78STejun Heo 
1776e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
177763d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1778e22bee78STejun Heo 			break;
1779e22bee78STejun Heo 		}
1780e22bee78STejun Heo 
1781e22bee78STejun Heo 		destroy_worker(worker);
1782e22bee78STejun Heo 		ret = true;
1783e22bee78STejun Heo 	}
1784e22bee78STejun Heo 
1785e22bee78STejun Heo 	return ret;
1786e22bee78STejun Heo }
1787e22bee78STejun Heo 
1788e22bee78STejun Heo /**
1789e22bee78STejun Heo  * manage_workers - manage worker pool
1790e22bee78STejun Heo  * @worker: self
1791e22bee78STejun Heo  *
1792e22bee78STejun Heo  * Assume the manager role and manage gcwq worker pool @worker belongs
1793e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1794e22bee78STejun Heo  * gcwq.  The exclusion is handled automatically by this function.
1795e22bee78STejun Heo  *
1796e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
1797e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
1798e22bee78STejun Heo  * and may_start_working() is true.
1799e22bee78STejun Heo  *
1800e22bee78STejun Heo  * CONTEXT:
1801e22bee78STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1802e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
1803e22bee78STejun Heo  *
1804e22bee78STejun Heo  * RETURNS:
1805e22bee78STejun Heo  * false if no action was taken and gcwq->lock stayed locked, true if
1806e22bee78STejun Heo  * some action was taken.
1807e22bee78STejun Heo  */
1808e22bee78STejun Heo static bool manage_workers(struct worker *worker)
1809e22bee78STejun Heo {
181063d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
1811e22bee78STejun Heo 	bool ret = false;
1812e22bee78STejun Heo 
181360373152STejun Heo 	if (!mutex_trylock(&pool->manager_mutex))
1814e22bee78STejun Heo 		return ret;
1815e22bee78STejun Heo 
181611ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
1817e22bee78STejun Heo 
1818e22bee78STejun Heo 	/*
1819e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
1820e22bee78STejun Heo 	 * on return.
1821e22bee78STejun Heo 	 */
182263d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
182363d95a91STejun Heo 	ret |= maybe_create_worker(pool);
1824e22bee78STejun Heo 
182560373152STejun Heo 	mutex_unlock(&pool->manager_mutex);
1826e22bee78STejun Heo 	return ret;
1827e22bee78STejun Heo }
1828e22bee78STejun Heo 
1829a62428c0STejun Heo /**
1830affee4b2STejun Heo  * move_linked_works - move linked works to a list
1831affee4b2STejun Heo  * @work: start of series of works to be scheduled
1832affee4b2STejun Heo  * @head: target list to append @work to
1833affee4b2STejun Heo  * @nextp: out paramter for nested worklist walking
1834affee4b2STejun Heo  *
1835affee4b2STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1836affee4b2STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1837affee4b2STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1838affee4b2STejun Heo  *
1839affee4b2STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1840affee4b2STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1841affee4b2STejun Heo  * nested inside outer list_for_each_entry_safe().
1842affee4b2STejun Heo  *
1843affee4b2STejun Heo  * CONTEXT:
18448b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
1845affee4b2STejun Heo  */
1846affee4b2STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1847affee4b2STejun Heo 			      struct work_struct **nextp)
1848affee4b2STejun Heo {
1849affee4b2STejun Heo 	struct work_struct *n;
1850affee4b2STejun Heo 
1851affee4b2STejun Heo 	/*
1852affee4b2STejun Heo 	 * Linked worklist will always end before the end of the list,
1853affee4b2STejun Heo 	 * use NULL for list head.
1854affee4b2STejun Heo 	 */
1855affee4b2STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1856affee4b2STejun Heo 		list_move_tail(&work->entry, head);
1857affee4b2STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1858affee4b2STejun Heo 			break;
1859affee4b2STejun Heo 	}
1860affee4b2STejun Heo 
1861affee4b2STejun Heo 	/*
1862affee4b2STejun Heo 	 * If we're already inside safe list traversal and have moved
1863affee4b2STejun Heo 	 * multiple works to the scheduled queue, the next position
1864affee4b2STejun Heo 	 * needs to be updated.
1865affee4b2STejun Heo 	 */
1866affee4b2STejun Heo 	if (nextp)
1867affee4b2STejun Heo 		*nextp = n;
1868affee4b2STejun Heo }
1869affee4b2STejun Heo 
18701e19ffc6STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
18711e19ffc6STejun Heo {
18721e19ffc6STejun Heo 	struct work_struct *work = list_first_entry(&cwq->delayed_works,
18731da177e4SLinus Torvalds 						    struct work_struct, entry);
18741e19ffc6STejun Heo 
1875cdadf009STejun Heo 	trace_workqueue_activate_work(work);
18763270476aSTejun Heo 	move_linked_works(work, &cwq->pool->worklist, NULL);
18778a2e8e5dSTejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
18781e19ffc6STejun Heo 	cwq->nr_active++;
18791e19ffc6STejun Heo }
18801e19ffc6STejun Heo 
1881affee4b2STejun Heo /**
188273f53c4aSTejun Heo  * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
188373f53c4aSTejun Heo  * @cwq: cwq of interest
188473f53c4aSTejun Heo  * @color: color of work which left the queue
18858a2e8e5dSTejun Heo  * @delayed: for a delayed work
188673f53c4aSTejun Heo  *
188773f53c4aSTejun Heo  * A work either has completed or is removed from pending queue,
188873f53c4aSTejun Heo  * decrement nr_in_flight of its cwq and handle workqueue flushing.
188973f53c4aSTejun Heo  *
189073f53c4aSTejun Heo  * CONTEXT:
18918b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
189273f53c4aSTejun Heo  */
18938a2e8e5dSTejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
18948a2e8e5dSTejun Heo 				 bool delayed)
189573f53c4aSTejun Heo {
189673f53c4aSTejun Heo 	/* ignore uncolored works */
189773f53c4aSTejun Heo 	if (color == WORK_NO_COLOR)
189873f53c4aSTejun Heo 		return;
189973f53c4aSTejun Heo 
190073f53c4aSTejun Heo 	cwq->nr_in_flight[color]--;
19011e19ffc6STejun Heo 
19028a2e8e5dSTejun Heo 	if (!delayed) {
19038a2e8e5dSTejun Heo 		cwq->nr_active--;
1904502ca9d8STejun Heo 		if (!list_empty(&cwq->delayed_works)) {
19051e19ffc6STejun Heo 			/* one down, submit a delayed one */
1906502ca9d8STejun Heo 			if (cwq->nr_active < cwq->max_active)
19071e19ffc6STejun Heo 				cwq_activate_first_delayed(cwq);
1908502ca9d8STejun Heo 		}
19098a2e8e5dSTejun Heo 	}
191073f53c4aSTejun Heo 
191173f53c4aSTejun Heo 	/* is flush in progress and are we at the flushing tip? */
191273f53c4aSTejun Heo 	if (likely(cwq->flush_color != color))
191373f53c4aSTejun Heo 		return;
191473f53c4aSTejun Heo 
191573f53c4aSTejun Heo 	/* are there still in-flight works? */
191673f53c4aSTejun Heo 	if (cwq->nr_in_flight[color])
191773f53c4aSTejun Heo 		return;
191873f53c4aSTejun Heo 
191973f53c4aSTejun Heo 	/* this cwq is done, clear flush_color */
192073f53c4aSTejun Heo 	cwq->flush_color = -1;
192173f53c4aSTejun Heo 
192273f53c4aSTejun Heo 	/*
192373f53c4aSTejun Heo 	 * If this was the last cwq, wake up the first flusher.  It
192473f53c4aSTejun Heo 	 * will handle the rest.
192573f53c4aSTejun Heo 	 */
192673f53c4aSTejun Heo 	if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
192773f53c4aSTejun Heo 		complete(&cwq->wq->first_flusher->done);
192873f53c4aSTejun Heo }
192973f53c4aSTejun Heo 
193073f53c4aSTejun Heo /**
1931a62428c0STejun Heo  * process_one_work - process single work
1932c34056a3STejun Heo  * @worker: self
1933a62428c0STejun Heo  * @work: work to process
1934a62428c0STejun Heo  *
1935a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
1936a62428c0STejun Heo  * process a single work including synchronization against and
1937a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
1938a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
1939a62428c0STejun Heo  * call this function to process a work.
1940a62428c0STejun Heo  *
1941a62428c0STejun Heo  * CONTEXT:
19428b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which is released and regrabbed.
1943a62428c0STejun Heo  */
1944c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
194506bd6ebfSNamhyung Kim __releases(&gcwq->lock)
194606bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
19471da177e4SLinus Torvalds {
19487e11629dSTejun Heo 	struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1949bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1950bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
1951c8e55f36STejun Heo 	struct hlist_head *bwh = busy_worker_head(gcwq, work);
1952fb0e7bebSTejun Heo 	bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
19536bb49e59SDavid Howells 	work_func_t f = work->func;
195473f53c4aSTejun Heo 	int work_color;
19557e11629dSTejun Heo 	struct worker *collision;
19564e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
19574e6045f1SJohannes Berg 	/*
1958a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
1959a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
1960a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
1961a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
1962a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
19634e6045f1SJohannes Berg 	 */
19644d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
19654d82a1deSPeter Zijlstra 
19664d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
19674e6045f1SJohannes Berg #endif
1968*25511a47STejun Heo 	WARN_ON_ONCE(!(worker->flags & (WORKER_UNBOUND | WORKER_REBIND)) &&
1969*25511a47STejun Heo 		     raw_smp_processor_id() != gcwq->cpu);
1970*25511a47STejun Heo 
19717e11629dSTejun Heo 	/*
19727e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
19737e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
19747e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
19757e11629dSTejun Heo 	 * currently executing one.
19767e11629dSTejun Heo 	 */
19777e11629dSTejun Heo 	collision = __find_worker_executing_work(gcwq, bwh, work);
19787e11629dSTejun Heo 	if (unlikely(collision)) {
19797e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
19807e11629dSTejun Heo 		return;
19817e11629dSTejun Heo 	}
19821da177e4SLinus Torvalds 
1983a62428c0STejun Heo 	/* claim and process */
19841da177e4SLinus Torvalds 	debug_work_deactivate(work);
1985c8e55f36STejun Heo 	hlist_add_head(&worker->hentry, bwh);
1986c34056a3STejun Heo 	worker->current_work = work;
19878cca0eeaSTejun Heo 	worker->current_cwq = cwq;
198873f53c4aSTejun Heo 	work_color = get_work_color(work);
19897a22ad75STejun Heo 
19907a22ad75STejun Heo 	/* record the current cpu number in the work data and dequeue */
19917a22ad75STejun Heo 	set_work_cpu(work, gcwq->cpu);
1992a62428c0STejun Heo 	list_del_init(&work->entry);
1993a62428c0STejun Heo 
1994649027d7STejun Heo 	/*
1995fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
1996fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
1997fb0e7bebSTejun Heo 	 */
1998fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1999fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2000fb0e7bebSTejun Heo 
2001974271c4STejun Heo 	/*
2002974271c4STejun Heo 	 * Unbound gcwq isn't concurrency managed and work items should be
2003974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2004974271c4STejun Heo 	 */
200563d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
200663d95a91STejun Heo 		wake_up_worker(pool);
2007974271c4STejun Heo 
20088b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
20091da177e4SLinus Torvalds 
201023b2e599SOleg Nesterov 	work_clear_pending(work);
2011e159489bSTejun Heo 	lock_map_acquire_read(&cwq->wq->lockdep_map);
20123295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2013e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
201465f27f38SDavid Howells 	f(work);
2015e36c886aSArjan van de Ven 	/*
2016e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2017e36c886aSArjan van de Ven 	 * point will only record its address.
2018e36c886aSArjan van de Ven 	 */
2019e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
20203295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
20213295f0efSIngo Molnar 	lock_map_release(&cwq->wq->lockdep_map);
20221da177e4SLinus Torvalds 
2023d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2024d5abe669SPeter Zijlstra 		printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
2025d5abe669SPeter Zijlstra 		       "%s/0x%08x/%d\n",
2026a62428c0STejun Heo 		       current->comm, preempt_count(), task_pid_nr(current));
2027d5abe669SPeter Zijlstra 		printk(KERN_ERR "    last function: ");
2028d5abe669SPeter Zijlstra 		print_symbol("%s\n", (unsigned long)f);
2029d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2030d5abe669SPeter Zijlstra 		dump_stack();
2031d5abe669SPeter Zijlstra 	}
2032d5abe669SPeter Zijlstra 
20338b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2034a62428c0STejun Heo 
2035fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2036fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2037fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2038fb0e7bebSTejun Heo 
2039a62428c0STejun Heo 	/* we're done with it, release */
2040c8e55f36STejun Heo 	hlist_del_init(&worker->hentry);
2041c34056a3STejun Heo 	worker->current_work = NULL;
20428cca0eeaSTejun Heo 	worker->current_cwq = NULL;
20438a2e8e5dSTejun Heo 	cwq_dec_nr_in_flight(cwq, work_color, false);
20441da177e4SLinus Torvalds }
20451da177e4SLinus Torvalds 
2046affee4b2STejun Heo /**
2047affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2048affee4b2STejun Heo  * @worker: self
2049affee4b2STejun Heo  *
2050affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2051affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2052affee4b2STejun Heo  * fetches a work from the top and executes it.
2053affee4b2STejun Heo  *
2054affee4b2STejun Heo  * CONTEXT:
20558b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2056affee4b2STejun Heo  * multiple times.
2057affee4b2STejun Heo  */
2058affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
20591da177e4SLinus Torvalds {
2060affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2061affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2062a62428c0STejun Heo 						struct work_struct, entry);
2063c34056a3STejun Heo 		process_one_work(worker, work);
2064a62428c0STejun Heo 	}
20651da177e4SLinus Torvalds }
20661da177e4SLinus Torvalds 
20674690c4abSTejun Heo /**
20684690c4abSTejun Heo  * worker_thread - the worker thread function
2069c34056a3STejun Heo  * @__worker: self
20704690c4abSTejun Heo  *
2071e22bee78STejun Heo  * The gcwq worker thread function.  There's a single dynamic pool of
2072e22bee78STejun Heo  * these per each cpu.  These workers process all works regardless of
2073e22bee78STejun Heo  * their specific target workqueue.  The only exception is works which
2074e22bee78STejun Heo  * belong to workqueues with a rescuer which will be explained in
2075e22bee78STejun Heo  * rescuer_thread().
20764690c4abSTejun Heo  */
2077c34056a3STejun Heo static int worker_thread(void *__worker)
20781da177e4SLinus Torvalds {
2079c34056a3STejun Heo 	struct worker *worker = __worker;
2080bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2081bd7bdd43STejun Heo 	struct global_cwq *gcwq = pool->gcwq;
20821da177e4SLinus Torvalds 
2083e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2084e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2085c8e55f36STejun Heo woke_up:
20868b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
2087affee4b2STejun Heo 
2088*25511a47STejun Heo 	/*
2089*25511a47STejun Heo 	 * DIE can be set only while idle and REBIND set while busy has
2090*25511a47STejun Heo 	 * @worker->rebind_work scheduled.  Checking here is enough.
2091*25511a47STejun Heo 	 */
2092*25511a47STejun Heo 	if (unlikely(worker->flags & (WORKER_REBIND | WORKER_DIE))) {
2093c8e55f36STejun Heo 		spin_unlock_irq(&gcwq->lock);
2094*25511a47STejun Heo 
2095*25511a47STejun Heo 		if (worker->flags & WORKER_DIE) {
2096e22bee78STejun Heo 			worker->task->flags &= ~PF_WQ_WORKER;
2097c8e55f36STejun Heo 			return 0;
2098c8e55f36STejun Heo 		}
2099c8e55f36STejun Heo 
2100*25511a47STejun Heo 		idle_worker_rebind(worker);
2101*25511a47STejun Heo 		goto woke_up;
2102*25511a47STejun Heo 	}
2103*25511a47STejun Heo 
2104c8e55f36STejun Heo 	worker_leave_idle(worker);
2105db7bccf4STejun Heo recheck:
2106e22bee78STejun Heo 	/* no more worker necessary? */
210763d95a91STejun Heo 	if (!need_more_worker(pool))
2108e22bee78STejun Heo 		goto sleep;
2109e22bee78STejun Heo 
2110e22bee78STejun Heo 	/* do we need to manage? */
211163d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2112e22bee78STejun Heo 		goto recheck;
2113e22bee78STejun Heo 
2114c8e55f36STejun Heo 	/*
2115c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2116c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2117c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2118c8e55f36STejun Heo 	 */
2119c8e55f36STejun Heo 	BUG_ON(!list_empty(&worker->scheduled));
2120c8e55f36STejun Heo 
2121e22bee78STejun Heo 	/*
2122e22bee78STejun Heo 	 * When control reaches this point, we're guaranteed to have
2123e22bee78STejun Heo 	 * at least one idle worker or that someone else has already
2124e22bee78STejun Heo 	 * assumed the manager role.
2125e22bee78STejun Heo 	 */
2126e22bee78STejun Heo 	worker_clr_flags(worker, WORKER_PREP);
2127e22bee78STejun Heo 
2128e22bee78STejun Heo 	do {
2129affee4b2STejun Heo 		struct work_struct *work =
2130bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2131affee4b2STejun Heo 					 struct work_struct, entry);
2132affee4b2STejun Heo 
2133c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2134affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2135affee4b2STejun Heo 			process_one_work(worker, work);
2136affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2137affee4b2STejun Heo 				process_scheduled_works(worker);
2138affee4b2STejun Heo 		} else {
2139c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2140affee4b2STejun Heo 			process_scheduled_works(worker);
2141affee4b2STejun Heo 		}
214263d95a91STejun Heo 	} while (keep_working(pool));
2143affee4b2STejun Heo 
2144e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2145d313dd85STejun Heo sleep:
214663d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2147e22bee78STejun Heo 		goto recheck;
2148d313dd85STejun Heo 
2149c8e55f36STejun Heo 	/*
2150e22bee78STejun Heo 	 * gcwq->lock is held and there's no work to process and no
2151e22bee78STejun Heo 	 * need to manage, sleep.  Workers are woken up only while
2152e22bee78STejun Heo 	 * holding gcwq->lock or from local cpu, so setting the
2153e22bee78STejun Heo 	 * current state before releasing gcwq->lock is enough to
2154e22bee78STejun Heo 	 * prevent losing any event.
2155c8e55f36STejun Heo 	 */
2156c8e55f36STejun Heo 	worker_enter_idle(worker);
2157c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
21588b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
21591da177e4SLinus Torvalds 	schedule();
2160c8e55f36STejun Heo 	goto woke_up;
21611da177e4SLinus Torvalds }
21621da177e4SLinus Torvalds 
2163e22bee78STejun Heo /**
2164e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2165e22bee78STejun Heo  * @__wq: the associated workqueue
2166e22bee78STejun Heo  *
2167e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2168e22bee78STejun Heo  * workqueue which has WQ_RESCUER set.
2169e22bee78STejun Heo  *
2170e22bee78STejun Heo  * Regular work processing on a gcwq may block trying to create a new
2171e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2172e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2173e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2174e22bee78STejun Heo  * the problem rescuer solves.
2175e22bee78STejun Heo  *
2176e22bee78STejun Heo  * When such condition is possible, the gcwq summons rescuers of all
2177e22bee78STejun Heo  * workqueues which have works queued on the gcwq and let them process
2178e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2179e22bee78STejun Heo  *
2180e22bee78STejun Heo  * This should happen rarely.
2181e22bee78STejun Heo  */
2182e22bee78STejun Heo static int rescuer_thread(void *__wq)
2183e22bee78STejun Heo {
2184e22bee78STejun Heo 	struct workqueue_struct *wq = __wq;
2185e22bee78STejun Heo 	struct worker *rescuer = wq->rescuer;
2186e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
2187f3421797STejun Heo 	bool is_unbound = wq->flags & WQ_UNBOUND;
2188e22bee78STejun Heo 	unsigned int cpu;
2189e22bee78STejun Heo 
2190e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2191e22bee78STejun Heo repeat:
2192e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
21931da177e4SLinus Torvalds 
21941da177e4SLinus Torvalds 	if (kthread_should_stop())
2195e22bee78STejun Heo 		return 0;
21961da177e4SLinus Torvalds 
2197f3421797STejun Heo 	/*
2198f3421797STejun Heo 	 * See whether any cpu is asking for help.  Unbounded
2199f3421797STejun Heo 	 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2200f3421797STejun Heo 	 */
2201f2e005aaSTejun Heo 	for_each_mayday_cpu(cpu, wq->mayday_mask) {
2202f3421797STejun Heo 		unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2203f3421797STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
2204bd7bdd43STejun Heo 		struct worker_pool *pool = cwq->pool;
2205bd7bdd43STejun Heo 		struct global_cwq *gcwq = pool->gcwq;
2206e22bee78STejun Heo 		struct work_struct *work, *n;
2207e22bee78STejun Heo 
2208e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2209f2e005aaSTejun Heo 		mayday_clear_cpu(cpu, wq->mayday_mask);
2210e22bee78STejun Heo 
2211e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2212bd7bdd43STejun Heo 		rescuer->pool = pool;
2213e22bee78STejun Heo 		worker_maybe_bind_and_lock(rescuer);
2214e22bee78STejun Heo 
2215e22bee78STejun Heo 		/*
2216e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2217e22bee78STejun Heo 		 * process'em.
2218e22bee78STejun Heo 		 */
2219e22bee78STejun Heo 		BUG_ON(!list_empty(&rescuer->scheduled));
2220bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2221e22bee78STejun Heo 			if (get_work_cwq(work) == cwq)
2222e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2223e22bee78STejun Heo 
2224e22bee78STejun Heo 		process_scheduled_works(rescuer);
22257576958aSTejun Heo 
22267576958aSTejun Heo 		/*
22277576958aSTejun Heo 		 * Leave this gcwq.  If keep_working() is %true, notify a
22287576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
22297576958aSTejun Heo 		 * and stalling the execution.
22307576958aSTejun Heo 		 */
223163d95a91STejun Heo 		if (keep_working(pool))
223263d95a91STejun Heo 			wake_up_worker(pool);
22337576958aSTejun Heo 
2234e22bee78STejun Heo 		spin_unlock_irq(&gcwq->lock);
22351da177e4SLinus Torvalds 	}
22361da177e4SLinus Torvalds 
2237e22bee78STejun Heo 	schedule();
2238e22bee78STejun Heo 	goto repeat;
22391da177e4SLinus Torvalds }
22401da177e4SLinus Torvalds 
2241fc2e4d70SOleg Nesterov struct wq_barrier {
2242fc2e4d70SOleg Nesterov 	struct work_struct	work;
2243fc2e4d70SOleg Nesterov 	struct completion	done;
2244fc2e4d70SOleg Nesterov };
2245fc2e4d70SOleg Nesterov 
2246fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2247fc2e4d70SOleg Nesterov {
2248fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2249fc2e4d70SOleg Nesterov 	complete(&barr->done);
2250fc2e4d70SOleg Nesterov }
2251fc2e4d70SOleg Nesterov 
22524690c4abSTejun Heo /**
22534690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
22544690c4abSTejun Heo  * @cwq: cwq to insert barrier into
22554690c4abSTejun Heo  * @barr: wq_barrier to insert
2256affee4b2STejun Heo  * @target: target work to attach @barr to
2257affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
22584690c4abSTejun Heo  *
2259affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2260affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2261affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2262affee4b2STejun Heo  * cpu.
2263affee4b2STejun Heo  *
2264affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2265affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2266affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2267affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2268affee4b2STejun Heo  * after a work with LINKED flag set.
2269affee4b2STejun Heo  *
2270affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2271affee4b2STejun Heo  * underneath us, so we can't reliably determine cwq from @target.
22724690c4abSTejun Heo  *
22734690c4abSTejun Heo  * CONTEXT:
22748b03ae3cSTejun Heo  * spin_lock_irq(gcwq->lock).
22754690c4abSTejun Heo  */
227683c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
2277affee4b2STejun Heo 			      struct wq_barrier *barr,
2278affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2279fc2e4d70SOleg Nesterov {
2280affee4b2STejun Heo 	struct list_head *head;
2281affee4b2STejun Heo 	unsigned int linked = 0;
2282affee4b2STejun Heo 
2283dc186ad7SThomas Gleixner 	/*
22848b03ae3cSTejun Heo 	 * debugobject calls are safe here even with gcwq->lock locked
2285dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2286dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2287dc186ad7SThomas Gleixner 	 * might deadlock.
2288dc186ad7SThomas Gleixner 	 */
2289ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
229022df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2291fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
229283c22520SOleg Nesterov 
2293affee4b2STejun Heo 	/*
2294affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2295affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2296affee4b2STejun Heo 	 */
2297affee4b2STejun Heo 	if (worker)
2298affee4b2STejun Heo 		head = worker->scheduled.next;
2299affee4b2STejun Heo 	else {
2300affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2301affee4b2STejun Heo 
2302affee4b2STejun Heo 		head = target->entry.next;
2303affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2304affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2305affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2306affee4b2STejun Heo 	}
2307affee4b2STejun Heo 
2308dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2309affee4b2STejun Heo 	insert_work(cwq, &barr->work, head,
2310affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2311fc2e4d70SOleg Nesterov }
2312fc2e4d70SOleg Nesterov 
231373f53c4aSTejun Heo /**
231473f53c4aSTejun Heo  * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
231573f53c4aSTejun Heo  * @wq: workqueue being flushed
231673f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
231773f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
231873f53c4aSTejun Heo  *
231973f53c4aSTejun Heo  * Prepare cwqs for workqueue flushing.
232073f53c4aSTejun Heo  *
232173f53c4aSTejun Heo  * If @flush_color is non-negative, flush_color on all cwqs should be
232273f53c4aSTejun Heo  * -1.  If no cwq has in-flight commands at the specified color, all
232373f53c4aSTejun Heo  * cwq->flush_color's stay at -1 and %false is returned.  If any cwq
232473f53c4aSTejun Heo  * has in flight commands, its cwq->flush_color is set to
232573f53c4aSTejun Heo  * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
232673f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
232773f53c4aSTejun Heo  *
232873f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
232973f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
233073f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
233173f53c4aSTejun Heo  * is returned.
233273f53c4aSTejun Heo  *
233373f53c4aSTejun Heo  * If @work_color is non-negative, all cwqs should have the same
233473f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
233573f53c4aSTejun Heo  * advanced to @work_color.
233673f53c4aSTejun Heo  *
233773f53c4aSTejun Heo  * CONTEXT:
233873f53c4aSTejun Heo  * mutex_lock(wq->flush_mutex).
233973f53c4aSTejun Heo  *
234073f53c4aSTejun Heo  * RETURNS:
234173f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
234273f53c4aSTejun Heo  * otherwise.
234373f53c4aSTejun Heo  */
234473f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
234573f53c4aSTejun Heo 				      int flush_color, int work_color)
23461da177e4SLinus Torvalds {
234773f53c4aSTejun Heo 	bool wait = false;
234873f53c4aSTejun Heo 	unsigned int cpu;
23491da177e4SLinus Torvalds 
235073f53c4aSTejun Heo 	if (flush_color >= 0) {
235173f53c4aSTejun Heo 		BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
235273f53c4aSTejun Heo 		atomic_set(&wq->nr_cwqs_to_flush, 1);
2353dc186ad7SThomas Gleixner 	}
235414441960SOleg Nesterov 
2355f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
235673f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2357bd7bdd43STejun Heo 		struct global_cwq *gcwq = cwq->pool->gcwq;
23581da177e4SLinus Torvalds 
23598b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
236073f53c4aSTejun Heo 
236173f53c4aSTejun Heo 		if (flush_color >= 0) {
236273f53c4aSTejun Heo 			BUG_ON(cwq->flush_color != -1);
236373f53c4aSTejun Heo 
236473f53c4aSTejun Heo 			if (cwq->nr_in_flight[flush_color]) {
236573f53c4aSTejun Heo 				cwq->flush_color = flush_color;
236673f53c4aSTejun Heo 				atomic_inc(&wq->nr_cwqs_to_flush);
236773f53c4aSTejun Heo 				wait = true;
23681da177e4SLinus Torvalds 			}
236973f53c4aSTejun Heo 		}
237073f53c4aSTejun Heo 
237173f53c4aSTejun Heo 		if (work_color >= 0) {
237273f53c4aSTejun Heo 			BUG_ON(work_color != work_next_color(cwq->work_color));
237373f53c4aSTejun Heo 			cwq->work_color = work_color;
237473f53c4aSTejun Heo 		}
237573f53c4aSTejun Heo 
23768b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
23771da177e4SLinus Torvalds 	}
23781da177e4SLinus Torvalds 
237973f53c4aSTejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
238073f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
238173f53c4aSTejun Heo 
238273f53c4aSTejun Heo 	return wait;
238383c22520SOleg Nesterov }
23841da177e4SLinus Torvalds 
23850fcb78c2SRolf Eike Beer /**
23861da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
23870fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
23881da177e4SLinus Torvalds  *
23891da177e4SLinus Torvalds  * Forces execution of the workqueue and blocks until its completion.
23901da177e4SLinus Torvalds  * This is typically used in driver shutdown handlers.
23911da177e4SLinus Torvalds  *
2392fc2e4d70SOleg Nesterov  * We sleep until all works which were queued on entry have been handled,
2393fc2e4d70SOleg Nesterov  * but we are not livelocked by new incoming ones.
23941da177e4SLinus Torvalds  */
23957ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
23961da177e4SLinus Torvalds {
239773f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
239873f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
239973f53c4aSTejun Heo 		.flush_color = -1,
240073f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
240173f53c4aSTejun Heo 	};
240273f53c4aSTejun Heo 	int next_color;
2403b1f4ec17SOleg Nesterov 
24043295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
24053295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
240673f53c4aSTejun Heo 
240773f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
240873f53c4aSTejun Heo 
240973f53c4aSTejun Heo 	/*
241073f53c4aSTejun Heo 	 * Start-to-wait phase
241173f53c4aSTejun Heo 	 */
241273f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
241373f53c4aSTejun Heo 
241473f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
241573f53c4aSTejun Heo 		/*
241673f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
241773f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
241873f53c4aSTejun Heo 		 * by one.
241973f53c4aSTejun Heo 		 */
242073f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow));
242173f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
242273f53c4aSTejun Heo 		wq->work_color = next_color;
242373f53c4aSTejun Heo 
242473f53c4aSTejun Heo 		if (!wq->first_flusher) {
242573f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
242673f53c4aSTejun Heo 			BUG_ON(wq->flush_color != this_flusher.flush_color);
242773f53c4aSTejun Heo 
242873f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
242973f53c4aSTejun Heo 
243073f53c4aSTejun Heo 			if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
243173f53c4aSTejun Heo 						       wq->work_color)) {
243273f53c4aSTejun Heo 				/* nothing to flush, done */
243373f53c4aSTejun Heo 				wq->flush_color = next_color;
243473f53c4aSTejun Heo 				wq->first_flusher = NULL;
243573f53c4aSTejun Heo 				goto out_unlock;
243673f53c4aSTejun Heo 			}
243773f53c4aSTejun Heo 		} else {
243873f53c4aSTejun Heo 			/* wait in queue */
243973f53c4aSTejun Heo 			BUG_ON(wq->flush_color == this_flusher.flush_color);
244073f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
244173f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
244273f53c4aSTejun Heo 		}
244373f53c4aSTejun Heo 	} else {
244473f53c4aSTejun Heo 		/*
244573f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
244673f53c4aSTejun Heo 		 * The next flush completion will assign us
244773f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
244873f53c4aSTejun Heo 		 */
244973f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
245073f53c4aSTejun Heo 	}
245173f53c4aSTejun Heo 
245273f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
245373f53c4aSTejun Heo 
245473f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
245573f53c4aSTejun Heo 
245673f53c4aSTejun Heo 	/*
245773f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
245873f53c4aSTejun Heo 	 *
245973f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
246073f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
246173f53c4aSTejun Heo 	 */
246273f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
246373f53c4aSTejun Heo 		return;
246473f53c4aSTejun Heo 
246573f53c4aSTejun Heo 	mutex_lock(&wq->flush_mutex);
246673f53c4aSTejun Heo 
24674ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
24684ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
24694ce48b37STejun Heo 		goto out_unlock;
24704ce48b37STejun Heo 
247173f53c4aSTejun Heo 	wq->first_flusher = NULL;
247273f53c4aSTejun Heo 
247373f53c4aSTejun Heo 	BUG_ON(!list_empty(&this_flusher.list));
247473f53c4aSTejun Heo 	BUG_ON(wq->flush_color != this_flusher.flush_color);
247573f53c4aSTejun Heo 
247673f53c4aSTejun Heo 	while (true) {
247773f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
247873f53c4aSTejun Heo 
247973f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
248073f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
248173f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
248273f53c4aSTejun Heo 				break;
248373f53c4aSTejun Heo 			list_del_init(&next->list);
248473f53c4aSTejun Heo 			complete(&next->done);
248573f53c4aSTejun Heo 		}
248673f53c4aSTejun Heo 
248773f53c4aSTejun Heo 		BUG_ON(!list_empty(&wq->flusher_overflow) &&
248873f53c4aSTejun Heo 		       wq->flush_color != work_next_color(wq->work_color));
248973f53c4aSTejun Heo 
249073f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
249173f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
249273f53c4aSTejun Heo 
249373f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
249473f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
249573f53c4aSTejun Heo 			/*
249673f53c4aSTejun Heo 			 * Assign the same color to all overflowed
249773f53c4aSTejun Heo 			 * flushers, advance work_color and append to
249873f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
249973f53c4aSTejun Heo 			 * phase for these overflowed flushers.
250073f53c4aSTejun Heo 			 */
250173f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
250273f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
250373f53c4aSTejun Heo 
250473f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
250573f53c4aSTejun Heo 
250673f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
250773f53c4aSTejun Heo 					      &wq->flusher_queue);
250873f53c4aSTejun Heo 			flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
250973f53c4aSTejun Heo 		}
251073f53c4aSTejun Heo 
251173f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
251273f53c4aSTejun Heo 			BUG_ON(wq->flush_color != wq->work_color);
251373f53c4aSTejun Heo 			break;
251473f53c4aSTejun Heo 		}
251573f53c4aSTejun Heo 
251673f53c4aSTejun Heo 		/*
251773f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
251873f53c4aSTejun Heo 		 * the new first flusher and arm cwqs.
251973f53c4aSTejun Heo 		 */
252073f53c4aSTejun Heo 		BUG_ON(wq->flush_color == wq->work_color);
252173f53c4aSTejun Heo 		BUG_ON(wq->flush_color != next->flush_color);
252273f53c4aSTejun Heo 
252373f53c4aSTejun Heo 		list_del_init(&next->list);
252473f53c4aSTejun Heo 		wq->first_flusher = next;
252573f53c4aSTejun Heo 
252673f53c4aSTejun Heo 		if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
252773f53c4aSTejun Heo 			break;
252873f53c4aSTejun Heo 
252973f53c4aSTejun Heo 		/*
253073f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
253173f53c4aSTejun Heo 		 * flusher and repeat cascading.
253273f53c4aSTejun Heo 		 */
253373f53c4aSTejun Heo 		wq->first_flusher = NULL;
253473f53c4aSTejun Heo 	}
253573f53c4aSTejun Heo 
253673f53c4aSTejun Heo out_unlock:
253773f53c4aSTejun Heo 	mutex_unlock(&wq->flush_mutex);
25381da177e4SLinus Torvalds }
2539ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
25401da177e4SLinus Torvalds 
25419c5a2ba7STejun Heo /**
25429c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
25439c5a2ba7STejun Heo  * @wq: workqueue to drain
25449c5a2ba7STejun Heo  *
25459c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
25469c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
25479c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
25489c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
25499c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
25509c5a2ba7STejun Heo  * takes too long.
25519c5a2ba7STejun Heo  */
25529c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
25539c5a2ba7STejun Heo {
25549c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
25559c5a2ba7STejun Heo 	unsigned int cpu;
25569c5a2ba7STejun Heo 
25579c5a2ba7STejun Heo 	/*
25589c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
25599c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
25609c5a2ba7STejun Heo 	 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
25619c5a2ba7STejun Heo 	 */
25629c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
25639c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
25649c5a2ba7STejun Heo 		wq->flags |= WQ_DRAINING;
25659c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
25669c5a2ba7STejun Heo reflush:
25679c5a2ba7STejun Heo 	flush_workqueue(wq);
25689c5a2ba7STejun Heo 
25699c5a2ba7STejun Heo 	for_each_cwq_cpu(cpu, wq) {
25709c5a2ba7STejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2571fa2563e4SThomas Tuttle 		bool drained;
25729c5a2ba7STejun Heo 
2573bd7bdd43STejun Heo 		spin_lock_irq(&cwq->pool->gcwq->lock);
2574fa2563e4SThomas Tuttle 		drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2575bd7bdd43STejun Heo 		spin_unlock_irq(&cwq->pool->gcwq->lock);
2576fa2563e4SThomas Tuttle 
2577fa2563e4SThomas Tuttle 		if (drained)
25789c5a2ba7STejun Heo 			continue;
25799c5a2ba7STejun Heo 
25809c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
25819c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
25829c5a2ba7STejun Heo 			pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
25839c5a2ba7STejun Heo 				   wq->name, flush_cnt);
25849c5a2ba7STejun Heo 		goto reflush;
25859c5a2ba7STejun Heo 	}
25869c5a2ba7STejun Heo 
25879c5a2ba7STejun Heo 	spin_lock(&workqueue_lock);
25889c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
25899c5a2ba7STejun Heo 		wq->flags &= ~WQ_DRAINING;
25909c5a2ba7STejun Heo 	spin_unlock(&workqueue_lock);
25919c5a2ba7STejun Heo }
25929c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
25939c5a2ba7STejun Heo 
2594baf59022STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2595baf59022STejun Heo 			     bool wait_executing)
2596baf59022STejun Heo {
2597baf59022STejun Heo 	struct worker *worker = NULL;
2598baf59022STejun Heo 	struct global_cwq *gcwq;
2599baf59022STejun Heo 	struct cpu_workqueue_struct *cwq;
2600baf59022STejun Heo 
2601baf59022STejun Heo 	might_sleep();
2602baf59022STejun Heo 	gcwq = get_work_gcwq(work);
2603baf59022STejun Heo 	if (!gcwq)
2604baf59022STejun Heo 		return false;
2605baf59022STejun Heo 
2606baf59022STejun Heo 	spin_lock_irq(&gcwq->lock);
2607baf59022STejun Heo 	if (!list_empty(&work->entry)) {
2608baf59022STejun Heo 		/*
2609baf59022STejun Heo 		 * See the comment near try_to_grab_pending()->smp_rmb().
2610baf59022STejun Heo 		 * If it was re-queued to a different gcwq under us, we
2611baf59022STejun Heo 		 * are not going to wait.
2612baf59022STejun Heo 		 */
2613baf59022STejun Heo 		smp_rmb();
2614baf59022STejun Heo 		cwq = get_work_cwq(work);
2615bd7bdd43STejun Heo 		if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
2616baf59022STejun Heo 			goto already_gone;
2617baf59022STejun Heo 	} else if (wait_executing) {
2618baf59022STejun Heo 		worker = find_worker_executing_work(gcwq, work);
2619baf59022STejun Heo 		if (!worker)
2620baf59022STejun Heo 			goto already_gone;
2621baf59022STejun Heo 		cwq = worker->current_cwq;
2622baf59022STejun Heo 	} else
2623baf59022STejun Heo 		goto already_gone;
2624baf59022STejun Heo 
2625baf59022STejun Heo 	insert_wq_barrier(cwq, barr, work, worker);
2626baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2627baf59022STejun Heo 
2628e159489bSTejun Heo 	/*
2629e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2630e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2631e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2632e159489bSTejun Heo 	 * access.
2633e159489bSTejun Heo 	 */
2634e159489bSTejun Heo 	if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2635baf59022STejun Heo 		lock_map_acquire(&cwq->wq->lockdep_map);
2636e159489bSTejun Heo 	else
2637e159489bSTejun Heo 		lock_map_acquire_read(&cwq->wq->lockdep_map);
2638baf59022STejun Heo 	lock_map_release(&cwq->wq->lockdep_map);
2639e159489bSTejun Heo 
2640baf59022STejun Heo 	return true;
2641baf59022STejun Heo already_gone:
2642baf59022STejun Heo 	spin_unlock_irq(&gcwq->lock);
2643baf59022STejun Heo 	return false;
2644baf59022STejun Heo }
2645baf59022STejun Heo 
2646db700897SOleg Nesterov /**
2647401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2648401a8d04STejun Heo  * @work: the work to flush
2649db700897SOleg Nesterov  *
2650401a8d04STejun Heo  * Wait until @work has finished execution.  This function considers
2651401a8d04STejun Heo  * only the last queueing instance of @work.  If @work has been
2652401a8d04STejun Heo  * enqueued across different CPUs on a non-reentrant workqueue or on
2653401a8d04STejun Heo  * multiple workqueues, @work might still be executing on return on
2654401a8d04STejun Heo  * some of the CPUs from earlier queueing.
2655a67da70dSOleg Nesterov  *
2656401a8d04STejun Heo  * If @work was queued only on a non-reentrant, ordered or unbound
2657401a8d04STejun Heo  * workqueue, @work is guaranteed to be idle on return if it hasn't
2658401a8d04STejun Heo  * been requeued since flush started.
2659401a8d04STejun Heo  *
2660401a8d04STejun Heo  * RETURNS:
2661401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2662401a8d04STejun Heo  * %false if it was already idle.
2663db700897SOleg Nesterov  */
2664401a8d04STejun Heo bool flush_work(struct work_struct *work)
2665db700897SOleg Nesterov {
2666db700897SOleg Nesterov 	struct wq_barrier barr;
2667db700897SOleg Nesterov 
26680976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
26690976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
26700976dfc1SStephen Boyd 
2671baf59022STejun Heo 	if (start_flush_work(work, &barr, true)) {
2672db700897SOleg Nesterov 		wait_for_completion(&barr.done);
2673dc186ad7SThomas Gleixner 		destroy_work_on_stack(&barr.work);
2674401a8d04STejun Heo 		return true;
2675baf59022STejun Heo 	} else
2676401a8d04STejun Heo 		return false;
2677db700897SOleg Nesterov }
2678db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2679db700897SOleg Nesterov 
2680401a8d04STejun Heo static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2681401a8d04STejun Heo {
2682401a8d04STejun Heo 	struct wq_barrier barr;
2683401a8d04STejun Heo 	struct worker *worker;
2684401a8d04STejun Heo 
2685401a8d04STejun Heo 	spin_lock_irq(&gcwq->lock);
2686401a8d04STejun Heo 
2687401a8d04STejun Heo 	worker = find_worker_executing_work(gcwq, work);
2688401a8d04STejun Heo 	if (unlikely(worker))
2689401a8d04STejun Heo 		insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2690401a8d04STejun Heo 
2691401a8d04STejun Heo 	spin_unlock_irq(&gcwq->lock);
2692401a8d04STejun Heo 
2693401a8d04STejun Heo 	if (unlikely(worker)) {
2694401a8d04STejun Heo 		wait_for_completion(&barr.done);
2695401a8d04STejun Heo 		destroy_work_on_stack(&barr.work);
2696401a8d04STejun Heo 		return true;
2697401a8d04STejun Heo 	} else
2698401a8d04STejun Heo 		return false;
2699401a8d04STejun Heo }
2700401a8d04STejun Heo 
2701401a8d04STejun Heo static bool wait_on_work(struct work_struct *work)
2702401a8d04STejun Heo {
2703401a8d04STejun Heo 	bool ret = false;
2704401a8d04STejun Heo 	int cpu;
2705401a8d04STejun Heo 
2706401a8d04STejun Heo 	might_sleep();
2707401a8d04STejun Heo 
2708401a8d04STejun Heo 	lock_map_acquire(&work->lockdep_map);
2709401a8d04STejun Heo 	lock_map_release(&work->lockdep_map);
2710401a8d04STejun Heo 
2711401a8d04STejun Heo 	for_each_gcwq_cpu(cpu)
2712401a8d04STejun Heo 		ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2713401a8d04STejun Heo 	return ret;
2714401a8d04STejun Heo }
2715401a8d04STejun Heo 
271609383498STejun Heo /**
271709383498STejun Heo  * flush_work_sync - wait until a work has finished execution
271809383498STejun Heo  * @work: the work to flush
271909383498STejun Heo  *
272009383498STejun Heo  * Wait until @work has finished execution.  On return, it's
272109383498STejun Heo  * guaranteed that all queueing instances of @work which happened
272209383498STejun Heo  * before this function is called are finished.  In other words, if
272309383498STejun Heo  * @work hasn't been requeued since this function was called, @work is
272409383498STejun Heo  * guaranteed to be idle on return.
272509383498STejun Heo  *
272609383498STejun Heo  * RETURNS:
272709383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
272809383498STejun Heo  * %false if it was already idle.
272909383498STejun Heo  */
273009383498STejun Heo bool flush_work_sync(struct work_struct *work)
273109383498STejun Heo {
273209383498STejun Heo 	struct wq_barrier barr;
273309383498STejun Heo 	bool pending, waited;
273409383498STejun Heo 
273509383498STejun Heo 	/* we'll wait for executions separately, queue barr only if pending */
273609383498STejun Heo 	pending = start_flush_work(work, &barr, false);
273709383498STejun Heo 
273809383498STejun Heo 	/* wait for executions to finish */
273909383498STejun Heo 	waited = wait_on_work(work);
274009383498STejun Heo 
274109383498STejun Heo 	/* wait for the pending one */
274209383498STejun Heo 	if (pending) {
274309383498STejun Heo 		wait_for_completion(&barr.done);
274409383498STejun Heo 		destroy_work_on_stack(&barr.work);
274509383498STejun Heo 	}
274609383498STejun Heo 
274709383498STejun Heo 	return pending || waited;
274809383498STejun Heo }
274909383498STejun Heo EXPORT_SYMBOL_GPL(flush_work_sync);
275009383498STejun Heo 
27516e84d644SOleg Nesterov /*
27521f1f642eSOleg Nesterov  * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
27536e84d644SOleg Nesterov  * so this work can't be re-armed in any way.
27546e84d644SOleg Nesterov  */
27556e84d644SOleg Nesterov static int try_to_grab_pending(struct work_struct *work)
27566e84d644SOleg Nesterov {
27578b03ae3cSTejun Heo 	struct global_cwq *gcwq;
27581f1f642eSOleg Nesterov 	int ret = -1;
27596e84d644SOleg Nesterov 
276022df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
27611f1f642eSOleg Nesterov 		return 0;
27626e84d644SOleg Nesterov 
27636e84d644SOleg Nesterov 	/*
27646e84d644SOleg Nesterov 	 * The queueing is in progress, or it is already queued. Try to
27656e84d644SOleg Nesterov 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
27666e84d644SOleg Nesterov 	 */
27677a22ad75STejun Heo 	gcwq = get_work_gcwq(work);
27687a22ad75STejun Heo 	if (!gcwq)
27696e84d644SOleg Nesterov 		return ret;
27706e84d644SOleg Nesterov 
27718b03ae3cSTejun Heo 	spin_lock_irq(&gcwq->lock);
27726e84d644SOleg Nesterov 	if (!list_empty(&work->entry)) {
27736e84d644SOleg Nesterov 		/*
27747a22ad75STejun Heo 		 * This work is queued, but perhaps we locked the wrong gcwq.
27756e84d644SOleg Nesterov 		 * In that case we must see the new value after rmb(), see
27766e84d644SOleg Nesterov 		 * insert_work()->wmb().
27776e84d644SOleg Nesterov 		 */
27786e84d644SOleg Nesterov 		smp_rmb();
27797a22ad75STejun Heo 		if (gcwq == get_work_gcwq(work)) {
2780dc186ad7SThomas Gleixner 			debug_work_deactivate(work);
27816e84d644SOleg Nesterov 			list_del_init(&work->entry);
27827a22ad75STejun Heo 			cwq_dec_nr_in_flight(get_work_cwq(work),
27838a2e8e5dSTejun Heo 				get_work_color(work),
27848a2e8e5dSTejun Heo 				*work_data_bits(work) & WORK_STRUCT_DELAYED);
27856e84d644SOleg Nesterov 			ret = 1;
27866e84d644SOleg Nesterov 		}
27876e84d644SOleg Nesterov 	}
27888b03ae3cSTejun Heo 	spin_unlock_irq(&gcwq->lock);
27896e84d644SOleg Nesterov 
27906e84d644SOleg Nesterov 	return ret;
27916e84d644SOleg Nesterov }
27926e84d644SOleg Nesterov 
2793401a8d04STejun Heo static bool __cancel_work_timer(struct work_struct *work,
27941f1f642eSOleg Nesterov 				struct timer_list* timer)
27951f1f642eSOleg Nesterov {
27961f1f642eSOleg Nesterov 	int ret;
27971f1f642eSOleg Nesterov 
27981f1f642eSOleg Nesterov 	do {
27991f1f642eSOleg Nesterov 		ret = (timer && likely(del_timer(timer)));
28001f1f642eSOleg Nesterov 		if (!ret)
28011f1f642eSOleg Nesterov 			ret = try_to_grab_pending(work);
28021f1f642eSOleg Nesterov 		wait_on_work(work);
28031f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
28041f1f642eSOleg Nesterov 
28057a22ad75STejun Heo 	clear_work_data(work);
28061f1f642eSOleg Nesterov 	return ret;
28071f1f642eSOleg Nesterov }
28081f1f642eSOleg Nesterov 
28096e84d644SOleg Nesterov /**
2810401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2811401a8d04STejun Heo  * @work: the work to cancel
28126e84d644SOleg Nesterov  *
2813401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2814401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2815401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2816401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
28171f1f642eSOleg Nesterov  *
2818401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2819401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
28206e84d644SOleg Nesterov  *
2821401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
28226e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2823401a8d04STejun Heo  *
2824401a8d04STejun Heo  * RETURNS:
2825401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
28266e84d644SOleg Nesterov  */
2827401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
28286e84d644SOleg Nesterov {
28291f1f642eSOleg Nesterov 	return __cancel_work_timer(work, NULL);
2830b89deed3SOleg Nesterov }
283128e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2832b89deed3SOleg Nesterov 
28336e84d644SOleg Nesterov /**
2834401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2835401a8d04STejun Heo  * @dwork: the delayed work to flush
28366e84d644SOleg Nesterov  *
2837401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2838401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2839401a8d04STejun Heo  * considers the last queueing instance of @dwork.
28401f1f642eSOleg Nesterov  *
2841401a8d04STejun Heo  * RETURNS:
2842401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2843401a8d04STejun Heo  * %false if it was already idle.
28446e84d644SOleg Nesterov  */
2845401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2846401a8d04STejun Heo {
2847401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
2848401a8d04STejun Heo 		__queue_work(raw_smp_processor_id(),
2849401a8d04STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
2850401a8d04STejun Heo 	return flush_work(&dwork->work);
2851401a8d04STejun Heo }
2852401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2853401a8d04STejun Heo 
2854401a8d04STejun Heo /**
285509383498STejun Heo  * flush_delayed_work_sync - wait for a dwork to finish
285609383498STejun Heo  * @dwork: the delayed work to flush
285709383498STejun Heo  *
285809383498STejun Heo  * Delayed timer is cancelled and the pending work is queued for
285909383498STejun Heo  * execution immediately.  Other than timer handling, its behavior
286009383498STejun Heo  * is identical to flush_work_sync().
286109383498STejun Heo  *
286209383498STejun Heo  * RETURNS:
286309383498STejun Heo  * %true if flush_work_sync() waited for the work to finish execution,
286409383498STejun Heo  * %false if it was already idle.
286509383498STejun Heo  */
286609383498STejun Heo bool flush_delayed_work_sync(struct delayed_work *dwork)
286709383498STejun Heo {
286809383498STejun Heo 	if (del_timer_sync(&dwork->timer))
286909383498STejun Heo 		__queue_work(raw_smp_processor_id(),
287009383498STejun Heo 			     get_work_cwq(&dwork->work)->wq, &dwork->work);
287109383498STejun Heo 	return flush_work_sync(&dwork->work);
287209383498STejun Heo }
287309383498STejun Heo EXPORT_SYMBOL(flush_delayed_work_sync);
287409383498STejun Heo 
287509383498STejun Heo /**
2876401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2877401a8d04STejun Heo  * @dwork: the delayed work cancel
2878401a8d04STejun Heo  *
2879401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2880401a8d04STejun Heo  *
2881401a8d04STejun Heo  * RETURNS:
2882401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2883401a8d04STejun Heo  */
2884401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
28856e84d644SOleg Nesterov {
28861f1f642eSOleg Nesterov 	return __cancel_work_timer(&dwork->work, &dwork->timer);
28876e84d644SOleg Nesterov }
2888f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
28891da177e4SLinus Torvalds 
28900fcb78c2SRolf Eike Beer /**
28910fcb78c2SRolf Eike Beer  * schedule_work - put work task in global workqueue
28920fcb78c2SRolf Eike Beer  * @work: job to be done
28930fcb78c2SRolf Eike Beer  *
28945b0f437dSBart Van Assche  * Returns zero if @work was already on the kernel-global workqueue and
28955b0f437dSBart Van Assche  * non-zero otherwise.
28965b0f437dSBart Van Assche  *
28975b0f437dSBart Van Assche  * This puts a job in the kernel-global workqueue if it was not already
28985b0f437dSBart Van Assche  * queued and leaves it in the same position on the kernel-global
28995b0f437dSBart Van Assche  * workqueue otherwise.
29000fcb78c2SRolf Eike Beer  */
29017ad5b3a5SHarvey Harrison int schedule_work(struct work_struct *work)
29021da177e4SLinus Torvalds {
2903d320c038STejun Heo 	return queue_work(system_wq, work);
29041da177e4SLinus Torvalds }
2905ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work);
29061da177e4SLinus Torvalds 
2907c1a220e7SZhang Rui /*
2908c1a220e7SZhang Rui  * schedule_work_on - put work task on a specific cpu
2909c1a220e7SZhang Rui  * @cpu: cpu to put the work task on
2910c1a220e7SZhang Rui  * @work: job to be done
2911c1a220e7SZhang Rui  *
2912c1a220e7SZhang Rui  * This puts a job on a specific cpu
2913c1a220e7SZhang Rui  */
2914c1a220e7SZhang Rui int schedule_work_on(int cpu, struct work_struct *work)
2915c1a220e7SZhang Rui {
2916d320c038STejun Heo 	return queue_work_on(cpu, system_wq, work);
2917c1a220e7SZhang Rui }
2918c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on);
2919c1a220e7SZhang Rui 
29200fcb78c2SRolf Eike Beer /**
29210fcb78c2SRolf Eike Beer  * schedule_delayed_work - put work task in global workqueue after delay
292252bad64dSDavid Howells  * @dwork: job to be done
292352bad64dSDavid Howells  * @delay: number of jiffies to wait or 0 for immediate execution
29240fcb78c2SRolf Eike Beer  *
29250fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
29260fcb78c2SRolf Eike Beer  * workqueue.
29270fcb78c2SRolf Eike Beer  */
29287ad5b3a5SHarvey Harrison int schedule_delayed_work(struct delayed_work *dwork,
292982f67cd9SIngo Molnar 					unsigned long delay)
29301da177e4SLinus Torvalds {
2931d320c038STejun Heo 	return queue_delayed_work(system_wq, dwork, delay);
29321da177e4SLinus Torvalds }
2933ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work);
29341da177e4SLinus Torvalds 
29350fcb78c2SRolf Eike Beer /**
29360fcb78c2SRolf Eike Beer  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
29370fcb78c2SRolf Eike Beer  * @cpu: cpu to use
293852bad64dSDavid Howells  * @dwork: job to be done
29390fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait
29400fcb78c2SRolf Eike Beer  *
29410fcb78c2SRolf Eike Beer  * After waiting for a given time this puts a job in the kernel-global
29420fcb78c2SRolf Eike Beer  * workqueue on the specified CPU.
29430fcb78c2SRolf Eike Beer  */
29441da177e4SLinus Torvalds int schedule_delayed_work_on(int cpu,
294552bad64dSDavid Howells 			struct delayed_work *dwork, unsigned long delay)
29461da177e4SLinus Torvalds {
2947d320c038STejun Heo 	return queue_delayed_work_on(cpu, system_wq, dwork, delay);
29481da177e4SLinus Torvalds }
2949ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on);
29501da177e4SLinus Torvalds 
2951b6136773SAndrew Morton /**
295231ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
2953b6136773SAndrew Morton  * @func: the function to call
2954b6136773SAndrew Morton  *
295531ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
295631ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
2957b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
295831ddd871STejun Heo  *
295931ddd871STejun Heo  * RETURNS:
296031ddd871STejun Heo  * 0 on success, -errno on failure.
2961b6136773SAndrew Morton  */
296265f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
296315316ba8SChristoph Lameter {
296415316ba8SChristoph Lameter 	int cpu;
296538f51568SNamhyung Kim 	struct work_struct __percpu *works;
296615316ba8SChristoph Lameter 
2967b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
2968b6136773SAndrew Morton 	if (!works)
296915316ba8SChristoph Lameter 		return -ENOMEM;
2970b6136773SAndrew Morton 
297195402b38SGautham R Shenoy 	get_online_cpus();
297293981800STejun Heo 
297315316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
29749bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
29759bfb1839SIngo Molnar 
29769bfb1839SIngo Molnar 		INIT_WORK(work, func);
29778de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
297815316ba8SChristoph Lameter 	}
297993981800STejun Heo 
298093981800STejun Heo 	for_each_online_cpu(cpu)
29818616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
298293981800STejun Heo 
298395402b38SGautham R Shenoy 	put_online_cpus();
2984b6136773SAndrew Morton 	free_percpu(works);
298515316ba8SChristoph Lameter 	return 0;
298615316ba8SChristoph Lameter }
298715316ba8SChristoph Lameter 
2988eef6a7d5SAlan Stern /**
2989eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
2990eef6a7d5SAlan Stern  *
2991eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
2992eef6a7d5SAlan Stern  * completion.
2993eef6a7d5SAlan Stern  *
2994eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
2995eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
2996eef6a7d5SAlan Stern  * will lead to deadlock:
2997eef6a7d5SAlan Stern  *
2998eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
2999eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3000eef6a7d5SAlan Stern  *
3001eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3002eef6a7d5SAlan Stern  *
3003eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3004eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3005eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3006eef6a7d5SAlan Stern  *
3007eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3008eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3009eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3010eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3011eef6a7d5SAlan Stern  */
30121da177e4SLinus Torvalds void flush_scheduled_work(void)
30131da177e4SLinus Torvalds {
3014d320c038STejun Heo 	flush_workqueue(system_wq);
30151da177e4SLinus Torvalds }
3016ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
30171da177e4SLinus Torvalds 
30181da177e4SLinus Torvalds /**
30191fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
30201fa44ecaSJames Bottomley  * @fn:		the function to execute
30211fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
30221fa44ecaSJames Bottomley  *		be available when the work executes)
30231fa44ecaSJames Bottomley  *
30241fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
30251fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
30261fa44ecaSJames Bottomley  *
30271fa44ecaSJames Bottomley  * Returns:	0 - function was executed
30281fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
30291fa44ecaSJames Bottomley  */
303065f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
30311fa44ecaSJames Bottomley {
30321fa44ecaSJames Bottomley 	if (!in_interrupt()) {
303365f27f38SDavid Howells 		fn(&ew->work);
30341fa44ecaSJames Bottomley 		return 0;
30351fa44ecaSJames Bottomley 	}
30361fa44ecaSJames Bottomley 
303765f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
30381fa44ecaSJames Bottomley 	schedule_work(&ew->work);
30391fa44ecaSJames Bottomley 
30401fa44ecaSJames Bottomley 	return 1;
30411fa44ecaSJames Bottomley }
30421fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
30431fa44ecaSJames Bottomley 
30441da177e4SLinus Torvalds int keventd_up(void)
30451da177e4SLinus Torvalds {
3046d320c038STejun Heo 	return system_wq != NULL;
30471da177e4SLinus Torvalds }
30481da177e4SLinus Torvalds 
3049bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq)
30501da177e4SLinus Torvalds {
30513af24433SOleg Nesterov 	/*
30520f900049STejun Heo 	 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
30530f900049STejun Heo 	 * Make sure that the alignment isn't lower than that of
30540f900049STejun Heo 	 * unsigned long long.
30553af24433SOleg Nesterov 	 */
30560f900049STejun Heo 	const size_t size = sizeof(struct cpu_workqueue_struct);
30570f900049STejun Heo 	const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
30580f900049STejun Heo 				   __alignof__(unsigned long long));
30593af24433SOleg Nesterov 
3060e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3061f3421797STejun Heo 		wq->cpu_wq.pcpu = __alloc_percpu(size, align);
3062931ac77eSTejun Heo 	else {
30630f900049STejun Heo 		void *ptr;
3064e1d8aa9fSFrederic Weisbecker 
30650f900049STejun Heo 		/*
3066f3421797STejun Heo 		 * Allocate enough room to align cwq and put an extra
3067f3421797STejun Heo 		 * pointer at the end pointing back to the originally
3068f3421797STejun Heo 		 * allocated pointer which will be used for free.
30690f900049STejun Heo 		 */
3070bdbc5dd7STejun Heo 		ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3071bdbc5dd7STejun Heo 		if (ptr) {
3072bdbc5dd7STejun Heo 			wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3073bdbc5dd7STejun Heo 			*(void **)(wq->cpu_wq.single + 1) = ptr;
3074bdbc5dd7STejun Heo 		}
30753af24433SOleg Nesterov 	}
30763af24433SOleg Nesterov 
30770415b00dSTejun Heo 	/* just in case, make sure it's actually aligned */
3078bdbc5dd7STejun Heo 	BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3079bdbc5dd7STejun Heo 	return wq->cpu_wq.v ? 0 : -ENOMEM;
30800f900049STejun Heo }
30810f900049STejun Heo 
3082bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq)
308306ba38a9SOleg Nesterov {
3084e06ffa1eSLai Jiangshan 	if (!(wq->flags & WQ_UNBOUND))
3085bdbc5dd7STejun Heo 		free_percpu(wq->cpu_wq.pcpu);
3086f3421797STejun Heo 	else if (wq->cpu_wq.single) {
3087f3421797STejun Heo 		/* the pointer to free is stored right after the cwq */
3088f3421797STejun Heo 		kfree(*(void **)(wq->cpu_wq.single + 1));
308906ba38a9SOleg Nesterov 	}
309006ba38a9SOleg Nesterov }
309106ba38a9SOleg Nesterov 
3092f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3093f3421797STejun Heo 			       const char *name)
3094b71ab8c2STejun Heo {
3095f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3096f3421797STejun Heo 
3097f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3098b71ab8c2STejun Heo 		printk(KERN_WARNING "workqueue: max_active %d requested for %s "
3099b71ab8c2STejun Heo 		       "is out of range, clamping between %d and %d\n",
3100f3421797STejun Heo 		       max_active, name, 1, lim);
3101b71ab8c2STejun Heo 
3102f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3103b71ab8c2STejun Heo }
3104b71ab8c2STejun Heo 
3105b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
310697e37d7bSTejun Heo 					       unsigned int flags,
31071e19ffc6STejun Heo 					       int max_active,
3108eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3109b196be89STejun Heo 					       const char *lock_name, ...)
31103af24433SOleg Nesterov {
3111b196be89STejun Heo 	va_list args, args1;
31123af24433SOleg Nesterov 	struct workqueue_struct *wq;
3113c34056a3STejun Heo 	unsigned int cpu;
3114b196be89STejun Heo 	size_t namelen;
3115b196be89STejun Heo 
3116b196be89STejun Heo 	/* determine namelen, allocate wq and format name */
3117b196be89STejun Heo 	va_start(args, lock_name);
3118b196be89STejun Heo 	va_copy(args1, args);
3119b196be89STejun Heo 	namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3120b196be89STejun Heo 
3121b196be89STejun Heo 	wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3122b196be89STejun Heo 	if (!wq)
3123b196be89STejun Heo 		goto err;
3124b196be89STejun Heo 
3125b196be89STejun Heo 	vsnprintf(wq->name, namelen, fmt, args1);
3126b196be89STejun Heo 	va_end(args);
3127b196be89STejun Heo 	va_end(args1);
31283af24433SOleg Nesterov 
3129f3421797STejun Heo 	/*
31306370a6adSTejun Heo 	 * Workqueues which may be used during memory reclaim should
31316370a6adSTejun Heo 	 * have a rescuer to guarantee forward progress.
31326370a6adSTejun Heo 	 */
31336370a6adSTejun Heo 	if (flags & WQ_MEM_RECLAIM)
31346370a6adSTejun Heo 		flags |= WQ_RESCUER;
31356370a6adSTejun Heo 
3136d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3137b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
31383af24433SOleg Nesterov 
3139b196be89STejun Heo 	/* init wq */
314097e37d7bSTejun Heo 	wq->flags = flags;
3141a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
314273f53c4aSTejun Heo 	mutex_init(&wq->flush_mutex);
314373f53c4aSTejun Heo 	atomic_set(&wq->nr_cwqs_to_flush, 0);
314473f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
314573f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
31463af24433SOleg Nesterov 
3147eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3148cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
31493af24433SOleg Nesterov 
3150bdbc5dd7STejun Heo 	if (alloc_cwqs(wq) < 0)
3151bdbc5dd7STejun Heo 		goto err;
3152bdbc5dd7STejun Heo 
3153f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
31541537663fSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
31558b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
31563270476aSTejun Heo 		int pool_idx = (bool)(flags & WQ_HIGHPRI);
31571537663fSTejun Heo 
31580f900049STejun Heo 		BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
31593270476aSTejun Heo 		cwq->pool = &gcwq->pools[pool_idx];
3160c34056a3STejun Heo 		cwq->wq = wq;
316173f53c4aSTejun Heo 		cwq->flush_color = -1;
31621e19ffc6STejun Heo 		cwq->max_active = max_active;
31631e19ffc6STejun Heo 		INIT_LIST_HEAD(&cwq->delayed_works);
3164e22bee78STejun Heo 	}
31651537663fSTejun Heo 
3166e22bee78STejun Heo 	if (flags & WQ_RESCUER) {
3167e22bee78STejun Heo 		struct worker *rescuer;
3168e22bee78STejun Heo 
3169f2e005aaSTejun Heo 		if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
3170e22bee78STejun Heo 			goto err;
3171e22bee78STejun Heo 
3172e22bee78STejun Heo 		wq->rescuer = rescuer = alloc_worker();
3173e22bee78STejun Heo 		if (!rescuer)
3174e22bee78STejun Heo 			goto err;
3175e22bee78STejun Heo 
3176b196be89STejun Heo 		rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3177b196be89STejun Heo 					       wq->name);
3178e22bee78STejun Heo 		if (IS_ERR(rescuer->task))
3179e22bee78STejun Heo 			goto err;
3180e22bee78STejun Heo 
3181e22bee78STejun Heo 		rescuer->task->flags |= PF_THREAD_BOUND;
3182e22bee78STejun Heo 		wake_up_process(rescuer->task);
31833af24433SOleg Nesterov 	}
31841537663fSTejun Heo 
31853af24433SOleg Nesterov 	/*
3186a0a1a5fdSTejun Heo 	 * workqueue_lock protects global freeze state and workqueues
3187a0a1a5fdSTejun Heo 	 * list.  Grab it, set max_active accordingly and add the new
3188a0a1a5fdSTejun Heo 	 * workqueue to workqueues list.
31893af24433SOleg Nesterov 	 */
31903af24433SOleg Nesterov 	spin_lock(&workqueue_lock);
3191a0a1a5fdSTejun Heo 
319258a69cb4STejun Heo 	if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
3193f3421797STejun Heo 		for_each_cwq_cpu(cpu, wq)
3194a0a1a5fdSTejun Heo 			get_cwq(cpu, wq)->max_active = 0;
3195a0a1a5fdSTejun Heo 
31963af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
3197a0a1a5fdSTejun Heo 
31983af24433SOleg Nesterov 	spin_unlock(&workqueue_lock);
31993af24433SOleg Nesterov 
32003af24433SOleg Nesterov 	return wq;
32014690c4abSTejun Heo err:
32024690c4abSTejun Heo 	if (wq) {
3203bdbc5dd7STejun Heo 		free_cwqs(wq);
3204f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
3205e22bee78STejun Heo 		kfree(wq->rescuer);
32064690c4abSTejun Heo 		kfree(wq);
32073af24433SOleg Nesterov 	}
32084690c4abSTejun Heo 	return NULL;
32091da177e4SLinus Torvalds }
3210d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
32111da177e4SLinus Torvalds 
32123af24433SOleg Nesterov /**
32133af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
32143af24433SOleg Nesterov  * @wq: target workqueue
32153af24433SOleg Nesterov  *
32163af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
32173af24433SOleg Nesterov  */
32183af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
32193af24433SOleg Nesterov {
3220c8e55f36STejun Heo 	unsigned int cpu;
32213af24433SOleg Nesterov 
32229c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
32239c5a2ba7STejun Heo 	drain_workqueue(wq);
3224c8efcc25STejun Heo 
3225a0a1a5fdSTejun Heo 	/*
3226a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
3227a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
3228a0a1a5fdSTejun Heo 	 */
322995402b38SGautham R Shenoy 	spin_lock(&workqueue_lock);
32303af24433SOleg Nesterov 	list_del(&wq->list);
323195402b38SGautham R Shenoy 	spin_unlock(&workqueue_lock);
32323af24433SOleg Nesterov 
3233e22bee78STejun Heo 	/* sanity check */
3234f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
323573f53c4aSTejun Heo 		struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
323673f53c4aSTejun Heo 		int i;
32373af24433SOleg Nesterov 
323873f53c4aSTejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++)
323973f53c4aSTejun Heo 			BUG_ON(cwq->nr_in_flight[i]);
32401e19ffc6STejun Heo 		BUG_ON(cwq->nr_active);
32411e19ffc6STejun Heo 		BUG_ON(!list_empty(&cwq->delayed_works));
324273f53c4aSTejun Heo 	}
32431537663fSTejun Heo 
3244e22bee78STejun Heo 	if (wq->flags & WQ_RESCUER) {
3245e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
3246f2e005aaSTejun Heo 		free_mayday_mask(wq->mayday_mask);
32478d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
3248e22bee78STejun Heo 	}
3249e22bee78STejun Heo 
3250bdbc5dd7STejun Heo 	free_cwqs(wq);
32513af24433SOleg Nesterov 	kfree(wq);
32523af24433SOleg Nesterov }
32533af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
32543af24433SOleg Nesterov 
3255dcd989cbSTejun Heo /**
3256dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
3257dcd989cbSTejun Heo  * @wq: target workqueue
3258dcd989cbSTejun Heo  * @max_active: new max_active value.
3259dcd989cbSTejun Heo  *
3260dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
3261dcd989cbSTejun Heo  *
3262dcd989cbSTejun Heo  * CONTEXT:
3263dcd989cbSTejun Heo  * Don't call from IRQ context.
3264dcd989cbSTejun Heo  */
3265dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3266dcd989cbSTejun Heo {
3267dcd989cbSTejun Heo 	unsigned int cpu;
3268dcd989cbSTejun Heo 
3269f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
3270dcd989cbSTejun Heo 
3271dcd989cbSTejun Heo 	spin_lock(&workqueue_lock);
3272dcd989cbSTejun Heo 
3273dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
3274dcd989cbSTejun Heo 
3275f3421797STejun Heo 	for_each_cwq_cpu(cpu, wq) {
3276dcd989cbSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3277dcd989cbSTejun Heo 
3278dcd989cbSTejun Heo 		spin_lock_irq(&gcwq->lock);
3279dcd989cbSTejun Heo 
328058a69cb4STejun Heo 		if (!(wq->flags & WQ_FREEZABLE) ||
3281dcd989cbSTejun Heo 		    !(gcwq->flags & GCWQ_FREEZING))
3282dcd989cbSTejun Heo 			get_cwq(gcwq->cpu, wq)->max_active = max_active;
3283dcd989cbSTejun Heo 
3284dcd989cbSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3285dcd989cbSTejun Heo 	}
3286dcd989cbSTejun Heo 
3287dcd989cbSTejun Heo 	spin_unlock(&workqueue_lock);
3288dcd989cbSTejun Heo }
3289dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3290dcd989cbSTejun Heo 
3291dcd989cbSTejun Heo /**
3292dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
3293dcd989cbSTejun Heo  * @cpu: CPU in question
3294dcd989cbSTejun Heo  * @wq: target workqueue
3295dcd989cbSTejun Heo  *
3296dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
3297dcd989cbSTejun Heo  * no synchronization around this function and the test result is
3298dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3299dcd989cbSTejun Heo  *
3300dcd989cbSTejun Heo  * RETURNS:
3301dcd989cbSTejun Heo  * %true if congested, %false otherwise.
3302dcd989cbSTejun Heo  */
3303dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3304dcd989cbSTejun Heo {
3305dcd989cbSTejun Heo 	struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3306dcd989cbSTejun Heo 
3307dcd989cbSTejun Heo 	return !list_empty(&cwq->delayed_works);
3308dcd989cbSTejun Heo }
3309dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
3310dcd989cbSTejun Heo 
3311dcd989cbSTejun Heo /**
3312dcd989cbSTejun Heo  * work_cpu - return the last known associated cpu for @work
3313dcd989cbSTejun Heo  * @work: the work of interest
3314dcd989cbSTejun Heo  *
3315dcd989cbSTejun Heo  * RETURNS:
3316bdbc5dd7STejun Heo  * CPU number if @work was ever queued.  WORK_CPU_NONE otherwise.
3317dcd989cbSTejun Heo  */
3318dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work)
3319dcd989cbSTejun Heo {
3320dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3321dcd989cbSTejun Heo 
3322bdbc5dd7STejun Heo 	return gcwq ? gcwq->cpu : WORK_CPU_NONE;
3323dcd989cbSTejun Heo }
3324dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu);
3325dcd989cbSTejun Heo 
3326dcd989cbSTejun Heo /**
3327dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
3328dcd989cbSTejun Heo  * @work: the work to be tested
3329dcd989cbSTejun Heo  *
3330dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
3331dcd989cbSTejun Heo  * synchronization around this function and the test result is
3332dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
3333dcd989cbSTejun Heo  * Especially for reentrant wqs, the pending state might hide the
3334dcd989cbSTejun Heo  * running state.
3335dcd989cbSTejun Heo  *
3336dcd989cbSTejun Heo  * RETURNS:
3337dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
3338dcd989cbSTejun Heo  */
3339dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
3340dcd989cbSTejun Heo {
3341dcd989cbSTejun Heo 	struct global_cwq *gcwq = get_work_gcwq(work);
3342dcd989cbSTejun Heo 	unsigned long flags;
3343dcd989cbSTejun Heo 	unsigned int ret = 0;
3344dcd989cbSTejun Heo 
3345dcd989cbSTejun Heo 	if (!gcwq)
3346dcd989cbSTejun Heo 		return false;
3347dcd989cbSTejun Heo 
3348dcd989cbSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
3349dcd989cbSTejun Heo 
3350dcd989cbSTejun Heo 	if (work_pending(work))
3351dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
3352dcd989cbSTejun Heo 	if (find_worker_executing_work(gcwq, work))
3353dcd989cbSTejun Heo 		ret |= WORK_BUSY_RUNNING;
3354dcd989cbSTejun Heo 
3355dcd989cbSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
3356dcd989cbSTejun Heo 
3357dcd989cbSTejun Heo 	return ret;
3358dcd989cbSTejun Heo }
3359dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
3360dcd989cbSTejun Heo 
3361db7bccf4STejun Heo /*
3362db7bccf4STejun Heo  * CPU hotplug.
3363db7bccf4STejun Heo  *
3364e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
3365e22bee78STejun Heo  * are a lot of assumptions on strong associations among work, cwq and
3366e22bee78STejun Heo  * gcwq which make migrating pending and scheduled works very
3367e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
3368e22bee78STejun Heo  * gcwqs serve mix of short, long and very long running works making
3369e22bee78STejun Heo  * blocked draining impractical.
3370e22bee78STejun Heo  *
3371403c821dSTejun Heo  * This is solved by allowing a gcwq to be detached from CPU, running it
3372403c821dSTejun Heo  * with unbound workers and allowing it to be reattached later if the cpu
3373403c821dSTejun Heo  * comes back online.  A separate thread is created to govern a gcwq in
3374403c821dSTejun Heo  * such state and is called the trustee of the gcwq.
3375db7bccf4STejun Heo  *
3376db7bccf4STejun Heo  * Trustee states and their descriptions.
3377db7bccf4STejun Heo  *
3378db7bccf4STejun Heo  * START	Command state used on startup.  On CPU_DOWN_PREPARE, a
3379db7bccf4STejun Heo  *		new trustee is started with this state.
3380db7bccf4STejun Heo  *
3381db7bccf4STejun Heo  * IN_CHARGE	Once started, trustee will enter this state after
3382e22bee78STejun Heo  *		assuming the manager role and making all existing
3383e22bee78STejun Heo  *		workers rogue.  DOWN_PREPARE waits for trustee to
3384e22bee78STejun Heo  *		enter this state.  After reaching IN_CHARGE, trustee
3385e22bee78STejun Heo  *		tries to execute the pending worklist until it's empty
3386e22bee78STejun Heo  *		and the state is set to BUTCHER, or the state is set
3387e22bee78STejun Heo  *		to RELEASE.
3388db7bccf4STejun Heo  *
3389db7bccf4STejun Heo  * BUTCHER	Command state which is set by the cpu callback after
3390db7bccf4STejun Heo  *		the cpu has went down.  Once this state is set trustee
3391db7bccf4STejun Heo  *		knows that there will be no new works on the worklist
3392db7bccf4STejun Heo  *		and once the worklist is empty it can proceed to
3393db7bccf4STejun Heo  *		killing idle workers.
3394db7bccf4STejun Heo  *
3395db7bccf4STejun Heo  * RELEASE	Command state which is set by the cpu callback if the
3396db7bccf4STejun Heo  *		cpu down has been canceled or it has come online
3397db7bccf4STejun Heo  *		again.  After recognizing this state, trustee stops
3398e22bee78STejun Heo  *		trying to drain or butcher and clears ROGUE, rebinds
3399e22bee78STejun Heo  *		all remaining workers back to the cpu and releases
3400e22bee78STejun Heo  *		manager role.
3401db7bccf4STejun Heo  *
3402db7bccf4STejun Heo  * DONE		Trustee will enter this state after BUTCHER or RELEASE
3403db7bccf4STejun Heo  *		is complete.
3404db7bccf4STejun Heo  *
3405db7bccf4STejun Heo  *          trustee                 CPU                draining
3406db7bccf4STejun Heo  *         took over                down               complete
3407db7bccf4STejun Heo  * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3408db7bccf4STejun Heo  *                        |                     |                  ^
3409db7bccf4STejun Heo  *                        | CPU is back online  v   return workers |
3410db7bccf4STejun Heo  *                         ----------------> RELEASE --------------
3411db7bccf4STejun Heo  */
3412db7bccf4STejun Heo 
341360373152STejun Heo /* claim manager positions of all pools */
341460373152STejun Heo static void gcwq_claim_management(struct global_cwq *gcwq)
341560373152STejun Heo {
341660373152STejun Heo 	struct worker_pool *pool;
341760373152STejun Heo 
341860373152STejun Heo 	for_each_worker_pool(pool, gcwq)
341960373152STejun Heo 		mutex_lock_nested(&pool->manager_mutex, pool - gcwq->pools);
342060373152STejun Heo }
342160373152STejun Heo 
342260373152STejun Heo /* release manager positions */
342360373152STejun Heo static void gcwq_release_management(struct global_cwq *gcwq)
342460373152STejun Heo {
342560373152STejun Heo 	struct worker_pool *pool;
342660373152STejun Heo 
342760373152STejun Heo 	for_each_worker_pool(pool, gcwq)
342860373152STejun Heo 		mutex_unlock(&pool->manager_mutex);
342960373152STejun Heo }
343060373152STejun Heo 
3431db7bccf4STejun Heo /**
3432db7bccf4STejun Heo  * trustee_wait_event_timeout - timed event wait for trustee
3433db7bccf4STejun Heo  * @cond: condition to wait for
3434db7bccf4STejun Heo  * @timeout: timeout in jiffies
3435db7bccf4STejun Heo  *
3436db7bccf4STejun Heo  * wait_event_timeout() for trustee to use.  Handles locking and
3437db7bccf4STejun Heo  * checks for RELEASE request.
3438db7bccf4STejun Heo  *
3439db7bccf4STejun Heo  * CONTEXT:
3440db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3441db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3442db7bccf4STejun Heo  *
3443db7bccf4STejun Heo  * RETURNS:
3444db7bccf4STejun Heo  * Positive indicating left time if @cond is satisfied, 0 if timed
3445db7bccf4STejun Heo  * out, -1 if canceled.
3446db7bccf4STejun Heo  */
3447db7bccf4STejun Heo #define trustee_wait_event_timeout(cond, timeout) ({			\
3448db7bccf4STejun Heo 	long __ret = (timeout);						\
3449db7bccf4STejun Heo 	while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) &&	\
3450db7bccf4STejun Heo 	       __ret) {							\
3451db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);				\
3452db7bccf4STejun Heo 		__wait_event_timeout(gcwq->trustee_wait, (cond) ||	\
3453db7bccf4STejun Heo 			(gcwq->trustee_state == TRUSTEE_RELEASE),	\
3454db7bccf4STejun Heo 			__ret);						\
3455db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);				\
3456db7bccf4STejun Heo 	}								\
3457db7bccf4STejun Heo 	gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret);		\
3458db7bccf4STejun Heo })
3459db7bccf4STejun Heo 
3460db7bccf4STejun Heo /**
3461db7bccf4STejun Heo  * trustee_wait_event - event wait for trustee
3462db7bccf4STejun Heo  * @cond: condition to wait for
3463db7bccf4STejun Heo  *
3464db7bccf4STejun Heo  * wait_event() for trustee to use.  Automatically handles locking and
3465db7bccf4STejun Heo  * checks for CANCEL request.
3466db7bccf4STejun Heo  *
3467db7bccf4STejun Heo  * CONTEXT:
3468db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3469db7bccf4STejun Heo  * multiple times.  To be used by trustee.
3470db7bccf4STejun Heo  *
3471db7bccf4STejun Heo  * RETURNS:
3472db7bccf4STejun Heo  * 0 if @cond is satisfied, -1 if canceled.
3473db7bccf4STejun Heo  */
3474db7bccf4STejun Heo #define trustee_wait_event(cond) ({					\
3475db7bccf4STejun Heo 	long __ret1;							\
3476db7bccf4STejun Heo 	__ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3477db7bccf4STejun Heo 	__ret1 < 0 ? -1 : 0;						\
3478db7bccf4STejun Heo })
3479db7bccf4STejun Heo 
34804ce62e9eSTejun Heo static bool gcwq_has_idle_workers(struct global_cwq *gcwq)
34814ce62e9eSTejun Heo {
34824ce62e9eSTejun Heo 	struct worker_pool *pool;
34834ce62e9eSTejun Heo 
34844ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
34854ce62e9eSTejun Heo 		if (!list_empty(&pool->idle_list))
34864ce62e9eSTejun Heo 			return true;
34874ce62e9eSTejun Heo 	return false;
34884ce62e9eSTejun Heo }
34894ce62e9eSTejun Heo 
3490db7bccf4STejun Heo static int __cpuinit trustee_thread(void *__gcwq)
3491db7bccf4STejun Heo {
3492db7bccf4STejun Heo 	struct global_cwq *gcwq = __gcwq;
34934ce62e9eSTejun Heo 	struct worker_pool *pool;
3494db7bccf4STejun Heo 	struct worker *worker;
3495e22bee78STejun Heo 	struct work_struct *work;
3496db7bccf4STejun Heo 	struct hlist_node *pos;
3497e22bee78STejun Heo 	long rc;
3498db7bccf4STejun Heo 	int i;
3499db7bccf4STejun Heo 
3500db7bccf4STejun Heo 	BUG_ON(gcwq->cpu != smp_processor_id());
3501db7bccf4STejun Heo 
350260373152STejun Heo 	gcwq_claim_management(gcwq);
3503db7bccf4STejun Heo 	spin_lock_irq(&gcwq->lock);
3504e22bee78STejun Heo 
3505f2d5a0eeSTejun Heo 	/*
3506f2d5a0eeSTejun Heo 	 * We've claimed all manager positions.  Make all workers unbound
3507f2d5a0eeSTejun Heo 	 * and set DISASSOCIATED.  Before this, all workers except for the
3508f2d5a0eeSTejun Heo 	 * ones which are still executing works from before the last CPU
3509f2d5a0eeSTejun Heo 	 * down must be on the cpu.  After this, they may become diasporas.
3510f2d5a0eeSTejun Heo 	 */
351160373152STejun Heo 	for_each_worker_pool(pool, gcwq)
35124ce62e9eSTejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry)
3513403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
3514db7bccf4STejun Heo 
3515db7bccf4STejun Heo 	for_each_busy_worker(worker, i, pos, gcwq)
3516403c821dSTejun Heo 		worker->flags |= WORKER_UNBOUND;
3517db7bccf4STejun Heo 
3518f2d5a0eeSTejun Heo 	gcwq->flags |= GCWQ_DISASSOCIATED;
3519f2d5a0eeSTejun Heo 
3520db7bccf4STejun Heo 	/*
3521403c821dSTejun Heo 	 * Call schedule() so that we cross rq->lock and thus can guarantee
3522403c821dSTejun Heo 	 * sched callbacks see the unbound flag.  This is necessary as
3523403c821dSTejun Heo 	 * scheduler callbacks may be invoked from other cpus.
3524e22bee78STejun Heo 	 */
3525e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
3526e22bee78STejun Heo 	schedule();
3527e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3528e22bee78STejun Heo 
3529e22bee78STejun Heo 	/*
3530cb444766STejun Heo 	 * Sched callbacks are disabled now.  Zap nr_running.  After
3531cb444766STejun Heo 	 * this, nr_running stays zero and need_more_worker() and
3532cb444766STejun Heo 	 * keep_working() are always true as long as the worklist is
3533cb444766STejun Heo 	 * not empty.
3534e22bee78STejun Heo 	 */
35354ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35364ce62e9eSTejun Heo 		atomic_set(get_pool_nr_running(pool), 0);
3537e22bee78STejun Heo 
3538e22bee78STejun Heo 	spin_unlock_irq(&gcwq->lock);
35394ce62e9eSTejun Heo 	for_each_worker_pool(pool, gcwq)
35404ce62e9eSTejun Heo 		del_timer_sync(&pool->idle_timer);
3541e22bee78STejun Heo 	spin_lock_irq(&gcwq->lock);
3542e22bee78STejun Heo 
3543e22bee78STejun Heo 	/*
3544db7bccf4STejun Heo 	 * We're now in charge.  Notify and proceed to drain.  We need
3545db7bccf4STejun Heo 	 * to keep the gcwq running during the whole CPU down
3546db7bccf4STejun Heo 	 * procedure as other cpu hotunplug callbacks may need to
3547db7bccf4STejun Heo 	 * flush currently running tasks.
3548db7bccf4STejun Heo 	 */
3549db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3550db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3551db7bccf4STejun Heo 
3552db7bccf4STejun Heo 	/*
3553db7bccf4STejun Heo 	 * The original cpu is in the process of dying and may go away
3554db7bccf4STejun Heo 	 * anytime now.  When that happens, we and all workers would
3555e22bee78STejun Heo 	 * be migrated to other cpus.  Try draining any left work.  We
3556e22bee78STejun Heo 	 * want to get it over with ASAP - spam rescuers, wake up as
3557e22bee78STejun Heo 	 * many idlers as necessary and create new ones till the
3558e22bee78STejun Heo 	 * worklist is empty.  Note that if the gcwq is frozen, there
355958a69cb4STejun Heo 	 * may be frozen works in freezable cwqs.  Don't declare
3560e22bee78STejun Heo 	 * completion while frozen.
3561db7bccf4STejun Heo 	 */
35624ce62e9eSTejun Heo 	while (true) {
35634ce62e9eSTejun Heo 		bool busy = false;
35644ce62e9eSTejun Heo 
35654ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
35664ce62e9eSTejun Heo 			busy |= pool->nr_workers != pool->nr_idle;
35674ce62e9eSTejun Heo 
35684ce62e9eSTejun Heo 		if (!busy && !(gcwq->flags & GCWQ_FREEZING) &&
35694ce62e9eSTejun Heo 		    gcwq->trustee_state != TRUSTEE_IN_CHARGE)
35704ce62e9eSTejun Heo 			break;
35714ce62e9eSTejun Heo 
35724ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3573e22bee78STejun Heo 			int nr_works = 0;
3574e22bee78STejun Heo 
35754ce62e9eSTejun Heo 			list_for_each_entry(work, &pool->worklist, entry) {
3576e22bee78STejun Heo 				send_mayday(work);
3577e22bee78STejun Heo 				nr_works++;
3578e22bee78STejun Heo 			}
3579e22bee78STejun Heo 
35804ce62e9eSTejun Heo 			list_for_each_entry(worker, &pool->idle_list, entry) {
3581e22bee78STejun Heo 				if (!nr_works--)
3582e22bee78STejun Heo 					break;
3583e22bee78STejun Heo 				wake_up_process(worker->task);
3584e22bee78STejun Heo 			}
3585e22bee78STejun Heo 
35864ce62e9eSTejun Heo 			if (need_to_create_worker(pool)) {
3587e22bee78STejun Heo 				spin_unlock_irq(&gcwq->lock);
3588bc2ae0f5STejun Heo 				worker = create_worker(pool);
3589e22bee78STejun Heo 				spin_lock_irq(&gcwq->lock);
3590bc2ae0f5STejun Heo 				if (worker)
3591e22bee78STejun Heo 					start_worker(worker);
3592e22bee78STejun Heo 			}
3593e22bee78STejun Heo 		}
3594e22bee78STejun Heo 
3595db7bccf4STejun Heo 		/* give a breather */
3596db7bccf4STejun Heo 		if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3597db7bccf4STejun Heo 			break;
3598db7bccf4STejun Heo 	}
3599db7bccf4STejun Heo 
3600e22bee78STejun Heo 	/*
3601e22bee78STejun Heo 	 * Either all works have been scheduled and cpu is down, or
3602e22bee78STejun Heo 	 * cpu down has already been canceled.  Wait for and butcher
3603e22bee78STejun Heo 	 * all workers till we're canceled.
3604e22bee78STejun Heo 	 */
3605e22bee78STejun Heo 	do {
36064ce62e9eSTejun Heo 		rc = trustee_wait_event(gcwq_has_idle_workers(gcwq));
36074ce62e9eSTejun Heo 
36084ce62e9eSTejun Heo 		i = 0;
36094ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
36104ce62e9eSTejun Heo 			while (!list_empty(&pool->idle_list)) {
36114ce62e9eSTejun Heo 				worker = list_first_entry(&pool->idle_list,
36124ce62e9eSTejun Heo 							  struct worker, entry);
36134ce62e9eSTejun Heo 				destroy_worker(worker);
36144ce62e9eSTejun Heo 			}
36154ce62e9eSTejun Heo 			i |= pool->nr_workers;
36164ce62e9eSTejun Heo 		}
36174ce62e9eSTejun Heo 	} while (i && rc >= 0);
3618e22bee78STejun Heo 
361960373152STejun Heo 	gcwq_release_management(gcwq);
3620e22bee78STejun Heo 
3621db7bccf4STejun Heo 	/* notify completion */
3622db7bccf4STejun Heo 	gcwq->trustee = NULL;
3623db7bccf4STejun Heo 	gcwq->trustee_state = TRUSTEE_DONE;
3624db7bccf4STejun Heo 	wake_up_all(&gcwq->trustee_wait);
3625db7bccf4STejun Heo 	spin_unlock_irq(&gcwq->lock);
3626db7bccf4STejun Heo 	return 0;
3627db7bccf4STejun Heo }
3628db7bccf4STejun Heo 
3629db7bccf4STejun Heo /**
3630db7bccf4STejun Heo  * wait_trustee_state - wait for trustee to enter the specified state
3631db7bccf4STejun Heo  * @gcwq: gcwq the trustee of interest belongs to
3632db7bccf4STejun Heo  * @state: target state to wait for
3633db7bccf4STejun Heo  *
3634db7bccf4STejun Heo  * Wait for the trustee to reach @state.  DONE is already matched.
3635db7bccf4STejun Heo  *
3636db7bccf4STejun Heo  * CONTEXT:
3637db7bccf4STejun Heo  * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3638db7bccf4STejun Heo  * multiple times.  To be used by cpu_callback.
3639db7bccf4STejun Heo  */
3640db7bccf4STejun Heo static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
364106bd6ebfSNamhyung Kim __releases(&gcwq->lock)
364206bd6ebfSNamhyung Kim __acquires(&gcwq->lock)
3643db7bccf4STejun Heo {
3644db7bccf4STejun Heo 	if (!(gcwq->trustee_state == state ||
3645db7bccf4STejun Heo 	      gcwq->trustee_state == TRUSTEE_DONE)) {
3646db7bccf4STejun Heo 		spin_unlock_irq(&gcwq->lock);
3647db7bccf4STejun Heo 		__wait_event(gcwq->trustee_wait,
3648db7bccf4STejun Heo 			     gcwq->trustee_state == state ||
3649db7bccf4STejun Heo 			     gcwq->trustee_state == TRUSTEE_DONE);
3650db7bccf4STejun Heo 		spin_lock_irq(&gcwq->lock);
3651db7bccf4STejun Heo 	}
3652db7bccf4STejun Heo }
3653db7bccf4STejun Heo 
36549c7b216dSChandra Seetharaman static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
36551da177e4SLinus Torvalds 						unsigned long action,
36561da177e4SLinus Torvalds 						void *hcpu)
36571da177e4SLinus Torvalds {
36583af24433SOleg Nesterov 	unsigned int cpu = (unsigned long)hcpu;
3659db7bccf4STejun Heo 	struct global_cwq *gcwq = get_gcwq(cpu);
3660db7bccf4STejun Heo 	struct task_struct *new_trustee = NULL;
36614ce62e9eSTejun Heo 	struct worker *new_workers[NR_WORKER_POOLS] = { };
36624ce62e9eSTejun Heo 	struct worker_pool *pool;
3663db7bccf4STejun Heo 	unsigned long flags;
36644ce62e9eSTejun Heo 	int i;
36651da177e4SLinus Torvalds 
36668bb78442SRafael J. Wysocki 	action &= ~CPU_TASKS_FROZEN;
36678bb78442SRafael J. Wysocki 
36681da177e4SLinus Torvalds 	switch (action) {
3669db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3670db7bccf4STejun Heo 		new_trustee = kthread_create(trustee_thread, gcwq,
3671db7bccf4STejun Heo 					     "workqueue_trustee/%d\n", cpu);
3672db7bccf4STejun Heo 		if (IS_ERR(new_trustee))
3673db7bccf4STejun Heo 			return notifier_from_errno(PTR_ERR(new_trustee));
3674db7bccf4STejun Heo 		kthread_bind(new_trustee, cpu);
3675e22bee78STejun Heo 		/* fall through */
36763af24433SOleg Nesterov 	case CPU_UP_PREPARE:
36774ce62e9eSTejun Heo 		i = 0;
36784ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
36794ce62e9eSTejun Heo 			BUG_ON(pool->first_idle);
3680bc2ae0f5STejun Heo 			new_workers[i] = create_worker(pool);
36814ce62e9eSTejun Heo 			if (!new_workers[i++])
36824ce62e9eSTejun Heo 				goto err_destroy;
36833af24433SOleg Nesterov 		}
3684db7bccf4STejun Heo 	}
36851537663fSTejun Heo 
3686db7bccf4STejun Heo 	/* some are called w/ irq disabled, don't disturb irq status */
3687db7bccf4STejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
36883af24433SOleg Nesterov 
36893af24433SOleg Nesterov 	switch (action) {
3690db7bccf4STejun Heo 	case CPU_DOWN_PREPARE:
3691db7bccf4STejun Heo 		/* initialize trustee and tell it to acquire the gcwq */
3692db7bccf4STejun Heo 		BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3693db7bccf4STejun Heo 		gcwq->trustee = new_trustee;
3694db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_START;
3695db7bccf4STejun Heo 		wake_up_process(gcwq->trustee);
3696db7bccf4STejun Heo 		wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
3697e22bee78STejun Heo 		/* fall through */
36983af24433SOleg Nesterov 	case CPU_UP_PREPARE:
36994ce62e9eSTejun Heo 		i = 0;
37004ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
37014ce62e9eSTejun Heo 			BUG_ON(pool->first_idle);
37024ce62e9eSTejun Heo 			pool->first_idle = new_workers[i++];
37034ce62e9eSTejun Heo 		}
37041da177e4SLinus Torvalds 		break;
37051da177e4SLinus Torvalds 
37063da1c84cSOleg Nesterov 	case CPU_POST_DEAD:
3707db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_BUTCHER;
3708e22bee78STejun Heo 		/* fall through */
3709e22bee78STejun Heo 	case CPU_UP_CANCELED:
37104ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
37114ce62e9eSTejun Heo 			destroy_worker(pool->first_idle);
37124ce62e9eSTejun Heo 			pool->first_idle = NULL;
37134ce62e9eSTejun Heo 		}
3714db7bccf4STejun Heo 		break;
3715db7bccf4STejun Heo 
3716db7bccf4STejun Heo 	case CPU_DOWN_FAILED:
37171da177e4SLinus Torvalds 	case CPU_ONLINE:
3718db7bccf4STejun Heo 		if (gcwq->trustee_state != TRUSTEE_DONE) {
3719db7bccf4STejun Heo 			gcwq->trustee_state = TRUSTEE_RELEASE;
3720db7bccf4STejun Heo 			wake_up_process(gcwq->trustee);
3721db7bccf4STejun Heo 			wait_trustee_state(gcwq, TRUSTEE_DONE);
3722db7bccf4STejun Heo 		}
37231da177e4SLinus Torvalds 
3724*25511a47STejun Heo 		spin_unlock_irq(&gcwq->lock);
3725*25511a47STejun Heo 		gcwq_claim_management(gcwq);
3726*25511a47STejun Heo 		spin_lock_irq(&gcwq->lock);
3727*25511a47STejun Heo 
3728bc2ae0f5STejun Heo 		gcwq->flags &= ~GCWQ_DISASSOCIATED;
3729bc2ae0f5STejun Heo 
3730*25511a47STejun Heo 		rebind_workers(gcwq);
3731*25511a47STejun Heo 
3732*25511a47STejun Heo 		gcwq_release_management(gcwq);
3733*25511a47STejun Heo 
3734bc2ae0f5STejun Heo 		/*
3735e22bee78STejun Heo 		 * Trustee is done and there might be no worker left.
3736e22bee78STejun Heo 		 * Put the first_idle in and request a real manager to
3737e22bee78STejun Heo 		 * take a look.
3738e22bee78STejun Heo 		 */
37394ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
3740e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
37414ce62e9eSTejun Heo 			kthread_bind(pool->first_idle->task, cpu);
3742e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
37434ce62e9eSTejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
3744bc2ae0f5STejun Heo 			pool->first_idle->flags &= ~WORKER_UNBOUND;
37454ce62e9eSTejun Heo 			start_worker(pool->first_idle);
37464ce62e9eSTejun Heo 			pool->first_idle = NULL;
37474ce62e9eSTejun Heo 		}
37481da177e4SLinus Torvalds 		break;
37491da177e4SLinus Torvalds 	}
37501da177e4SLinus Torvalds 
3751db7bccf4STejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
375200dfcaf7SOleg Nesterov 
37531537663fSTejun Heo 	return notifier_from_errno(0);
37544ce62e9eSTejun Heo 
37554ce62e9eSTejun Heo err_destroy:
37564ce62e9eSTejun Heo 	if (new_trustee)
37574ce62e9eSTejun Heo 		kthread_stop(new_trustee);
37584ce62e9eSTejun Heo 
37594ce62e9eSTejun Heo 	spin_lock_irqsave(&gcwq->lock, flags);
37604ce62e9eSTejun Heo 	for (i = 0; i < NR_WORKER_POOLS; i++)
37614ce62e9eSTejun Heo 		if (new_workers[i])
37624ce62e9eSTejun Heo 			destroy_worker(new_workers[i]);
37634ce62e9eSTejun Heo 	spin_unlock_irqrestore(&gcwq->lock, flags);
37644ce62e9eSTejun Heo 
37654ce62e9eSTejun Heo 	return NOTIFY_BAD;
37661da177e4SLinus Torvalds }
37671da177e4SLinus Torvalds 
376865758202STejun Heo /*
376965758202STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
377065758202STejun Heo  * This will be registered high priority CPU notifier.
377165758202STejun Heo  */
377265758202STejun Heo static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
377365758202STejun Heo 					       unsigned long action,
377465758202STejun Heo 					       void *hcpu)
377565758202STejun Heo {
377665758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
377765758202STejun Heo 	case CPU_UP_PREPARE:
377865758202STejun Heo 	case CPU_UP_CANCELED:
377965758202STejun Heo 	case CPU_DOWN_FAILED:
378065758202STejun Heo 	case CPU_ONLINE:
378165758202STejun Heo 		return workqueue_cpu_callback(nfb, action, hcpu);
378265758202STejun Heo 	}
378365758202STejun Heo 	return NOTIFY_OK;
378465758202STejun Heo }
378565758202STejun Heo 
378665758202STejun Heo /*
378765758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
378865758202STejun Heo  * This will be registered as low priority CPU notifier.
378965758202STejun Heo  */
379065758202STejun Heo static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
379165758202STejun Heo 						 unsigned long action,
379265758202STejun Heo 						 void *hcpu)
379365758202STejun Heo {
379465758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
379565758202STejun Heo 	case CPU_DOWN_PREPARE:
379665758202STejun Heo 	case CPU_POST_DEAD:
379765758202STejun Heo 		return workqueue_cpu_callback(nfb, action, hcpu);
379865758202STejun Heo 	}
379965758202STejun Heo 	return NOTIFY_OK;
380065758202STejun Heo }
380165758202STejun Heo 
38022d3854a3SRusty Russell #ifdef CONFIG_SMP
38038ccad40dSRusty Russell 
38042d3854a3SRusty Russell struct work_for_cpu {
38056b44003eSAndrew Morton 	struct completion completion;
38062d3854a3SRusty Russell 	long (*fn)(void *);
38072d3854a3SRusty Russell 	void *arg;
38082d3854a3SRusty Russell 	long ret;
38092d3854a3SRusty Russell };
38102d3854a3SRusty Russell 
38116b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc)
38122d3854a3SRusty Russell {
38136b44003eSAndrew Morton 	struct work_for_cpu *wfc = _wfc;
38142d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
38156b44003eSAndrew Morton 	complete(&wfc->completion);
38166b44003eSAndrew Morton 	return 0;
38172d3854a3SRusty Russell }
38182d3854a3SRusty Russell 
38192d3854a3SRusty Russell /**
38202d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
38212d3854a3SRusty Russell  * @cpu: the cpu to run on
38222d3854a3SRusty Russell  * @fn: the function to run
38232d3854a3SRusty Russell  * @arg: the function arg
38242d3854a3SRusty Russell  *
382531ad9081SRusty Russell  * This will return the value @fn returns.
382631ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
38276b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
38282d3854a3SRusty Russell  */
38292d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
38302d3854a3SRusty Russell {
38316b44003eSAndrew Morton 	struct task_struct *sub_thread;
38326b44003eSAndrew Morton 	struct work_for_cpu wfc = {
38336b44003eSAndrew Morton 		.completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
38346b44003eSAndrew Morton 		.fn = fn,
38356b44003eSAndrew Morton 		.arg = arg,
38366b44003eSAndrew Morton 	};
38372d3854a3SRusty Russell 
38386b44003eSAndrew Morton 	sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
38396b44003eSAndrew Morton 	if (IS_ERR(sub_thread))
38406b44003eSAndrew Morton 		return PTR_ERR(sub_thread);
38416b44003eSAndrew Morton 	kthread_bind(sub_thread, cpu);
38426b44003eSAndrew Morton 	wake_up_process(sub_thread);
38436b44003eSAndrew Morton 	wait_for_completion(&wfc.completion);
38442d3854a3SRusty Russell 	return wfc.ret;
38452d3854a3SRusty Russell }
38462d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
38472d3854a3SRusty Russell #endif /* CONFIG_SMP */
38482d3854a3SRusty Russell 
3849a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
3850e7577c50SRusty Russell 
3851a0a1a5fdSTejun Heo /**
3852a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
3853a0a1a5fdSTejun Heo  *
385458a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
385558a69cb4STejun Heo  * workqueues will queue new works to their frozen_works list instead of
385658a69cb4STejun Heo  * gcwq->worklist.
3857a0a1a5fdSTejun Heo  *
3858a0a1a5fdSTejun Heo  * CONTEXT:
38598b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3860a0a1a5fdSTejun Heo  */
3861a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
3862a0a1a5fdSTejun Heo {
3863a0a1a5fdSTejun Heo 	unsigned int cpu;
3864a0a1a5fdSTejun Heo 
3865a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3866a0a1a5fdSTejun Heo 
3867a0a1a5fdSTejun Heo 	BUG_ON(workqueue_freezing);
3868a0a1a5fdSTejun Heo 	workqueue_freezing = true;
3869a0a1a5fdSTejun Heo 
3870f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
38718b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
3872bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
38738b03ae3cSTejun Heo 
38748b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
38758b03ae3cSTejun Heo 
3876db7bccf4STejun Heo 		BUG_ON(gcwq->flags & GCWQ_FREEZING);
3877db7bccf4STejun Heo 		gcwq->flags |= GCWQ_FREEZING;
3878db7bccf4STejun Heo 
3879a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3880a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3881a0a1a5fdSTejun Heo 
388258a69cb4STejun Heo 			if (cwq && wq->flags & WQ_FREEZABLE)
3883a0a1a5fdSTejun Heo 				cwq->max_active = 0;
38841da177e4SLinus Torvalds 		}
38858b03ae3cSTejun Heo 
38868b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3887a0a1a5fdSTejun Heo 	}
3888a0a1a5fdSTejun Heo 
3889a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3890a0a1a5fdSTejun Heo }
3891a0a1a5fdSTejun Heo 
3892a0a1a5fdSTejun Heo /**
389358a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
3894a0a1a5fdSTejun Heo  *
3895a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
3896a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
3897a0a1a5fdSTejun Heo  *
3898a0a1a5fdSTejun Heo  * CONTEXT:
3899a0a1a5fdSTejun Heo  * Grabs and releases workqueue_lock.
3900a0a1a5fdSTejun Heo  *
3901a0a1a5fdSTejun Heo  * RETURNS:
390258a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
390358a69cb4STejun Heo  * is complete.
3904a0a1a5fdSTejun Heo  */
3905a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
3906a0a1a5fdSTejun Heo {
3907a0a1a5fdSTejun Heo 	unsigned int cpu;
3908a0a1a5fdSTejun Heo 	bool busy = false;
3909a0a1a5fdSTejun Heo 
3910a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3911a0a1a5fdSTejun Heo 
3912a0a1a5fdSTejun Heo 	BUG_ON(!workqueue_freezing);
3913a0a1a5fdSTejun Heo 
3914f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
3915bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
3916a0a1a5fdSTejun Heo 		/*
3917a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
3918a0a1a5fdSTejun Heo 		 * to peek without lock.
3919a0a1a5fdSTejun Heo 		 */
3920a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3921a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3922a0a1a5fdSTejun Heo 
392358a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3924a0a1a5fdSTejun Heo 				continue;
3925a0a1a5fdSTejun Heo 
3926a0a1a5fdSTejun Heo 			BUG_ON(cwq->nr_active < 0);
3927a0a1a5fdSTejun Heo 			if (cwq->nr_active) {
3928a0a1a5fdSTejun Heo 				busy = true;
3929a0a1a5fdSTejun Heo 				goto out_unlock;
3930a0a1a5fdSTejun Heo 			}
3931a0a1a5fdSTejun Heo 		}
3932a0a1a5fdSTejun Heo 	}
3933a0a1a5fdSTejun Heo out_unlock:
3934a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3935a0a1a5fdSTejun Heo 	return busy;
3936a0a1a5fdSTejun Heo }
3937a0a1a5fdSTejun Heo 
3938a0a1a5fdSTejun Heo /**
3939a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
3940a0a1a5fdSTejun Heo  *
3941a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
39427e11629dSTejun Heo  * frozen works are transferred to their respective gcwq worklists.
3943a0a1a5fdSTejun Heo  *
3944a0a1a5fdSTejun Heo  * CONTEXT:
39458b03ae3cSTejun Heo  * Grabs and releases workqueue_lock and gcwq->lock's.
3946a0a1a5fdSTejun Heo  */
3947a0a1a5fdSTejun Heo void thaw_workqueues(void)
3948a0a1a5fdSTejun Heo {
3949a0a1a5fdSTejun Heo 	unsigned int cpu;
3950a0a1a5fdSTejun Heo 
3951a0a1a5fdSTejun Heo 	spin_lock(&workqueue_lock);
3952a0a1a5fdSTejun Heo 
3953a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
3954a0a1a5fdSTejun Heo 		goto out_unlock;
3955a0a1a5fdSTejun Heo 
3956f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
39578b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
39584ce62e9eSTejun Heo 		struct worker_pool *pool;
3959bdbc5dd7STejun Heo 		struct workqueue_struct *wq;
39608b03ae3cSTejun Heo 
39618b03ae3cSTejun Heo 		spin_lock_irq(&gcwq->lock);
39628b03ae3cSTejun Heo 
3963db7bccf4STejun Heo 		BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3964db7bccf4STejun Heo 		gcwq->flags &= ~GCWQ_FREEZING;
3965db7bccf4STejun Heo 
3966a0a1a5fdSTejun Heo 		list_for_each_entry(wq, &workqueues, list) {
3967a0a1a5fdSTejun Heo 			struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3968a0a1a5fdSTejun Heo 
396958a69cb4STejun Heo 			if (!cwq || !(wq->flags & WQ_FREEZABLE))
3970a0a1a5fdSTejun Heo 				continue;
3971a0a1a5fdSTejun Heo 
3972a0a1a5fdSTejun Heo 			/* restore max_active and repopulate worklist */
3973a0a1a5fdSTejun Heo 			cwq->max_active = wq->saved_max_active;
3974a0a1a5fdSTejun Heo 
3975a0a1a5fdSTejun Heo 			while (!list_empty(&cwq->delayed_works) &&
3976a0a1a5fdSTejun Heo 			       cwq->nr_active < cwq->max_active)
3977a0a1a5fdSTejun Heo 				cwq_activate_first_delayed(cwq);
3978a0a1a5fdSTejun Heo 		}
39798b03ae3cSTejun Heo 
39804ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq)
39814ce62e9eSTejun Heo 			wake_up_worker(pool);
3982e22bee78STejun Heo 
39838b03ae3cSTejun Heo 		spin_unlock_irq(&gcwq->lock);
3984a0a1a5fdSTejun Heo 	}
3985a0a1a5fdSTejun Heo 
3986a0a1a5fdSTejun Heo 	workqueue_freezing = false;
3987a0a1a5fdSTejun Heo out_unlock:
3988a0a1a5fdSTejun Heo 	spin_unlock(&workqueue_lock);
3989a0a1a5fdSTejun Heo }
3990a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
3991a0a1a5fdSTejun Heo 
39926ee0578bSSuresh Siddha static int __init init_workqueues(void)
39931da177e4SLinus Torvalds {
3994c34056a3STejun Heo 	unsigned int cpu;
3995c8e55f36STejun Heo 	int i;
3996c34056a3STejun Heo 
399765758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
399865758202STejun Heo 	cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
39998b03ae3cSTejun Heo 
40008b03ae3cSTejun Heo 	/* initialize gcwqs */
4001f3421797STejun Heo 	for_each_gcwq_cpu(cpu) {
40028b03ae3cSTejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
40034ce62e9eSTejun Heo 		struct worker_pool *pool;
40048b03ae3cSTejun Heo 
40058b03ae3cSTejun Heo 		spin_lock_init(&gcwq->lock);
40068b03ae3cSTejun Heo 		gcwq->cpu = cpu;
4007f3421797STejun Heo 		gcwq->flags |= GCWQ_DISASSOCIATED;
40088b03ae3cSTejun Heo 
4009c8e55f36STejun Heo 		for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
4010c8e55f36STejun Heo 			INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
4011c8e55f36STejun Heo 
40124ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
40134ce62e9eSTejun Heo 			pool->gcwq = gcwq;
40144ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->worklist);
40154ce62e9eSTejun Heo 			INIT_LIST_HEAD(&pool->idle_list);
4016e22bee78STejun Heo 
40174ce62e9eSTejun Heo 			init_timer_deferrable(&pool->idle_timer);
40184ce62e9eSTejun Heo 			pool->idle_timer.function = idle_worker_timeout;
40194ce62e9eSTejun Heo 			pool->idle_timer.data = (unsigned long)pool;
4020e22bee78STejun Heo 
40214ce62e9eSTejun Heo 			setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
40224ce62e9eSTejun Heo 				    (unsigned long)pool);
40234ce62e9eSTejun Heo 
402460373152STejun Heo 			mutex_init(&pool->manager_mutex);
40254ce62e9eSTejun Heo 			ida_init(&pool->worker_ida);
40264ce62e9eSTejun Heo 		}
4027db7bccf4STejun Heo 
4028*25511a47STejun Heo 		init_waitqueue_head(&gcwq->rebind_hold);
4029*25511a47STejun Heo 
4030db7bccf4STejun Heo 		gcwq->trustee_state = TRUSTEE_DONE;
4031db7bccf4STejun Heo 		init_waitqueue_head(&gcwq->trustee_wait);
40328b03ae3cSTejun Heo 	}
40338b03ae3cSTejun Heo 
4034e22bee78STejun Heo 	/* create the initial worker */
4035f3421797STejun Heo 	for_each_online_gcwq_cpu(cpu) {
4036e22bee78STejun Heo 		struct global_cwq *gcwq = get_gcwq(cpu);
40374ce62e9eSTejun Heo 		struct worker_pool *pool;
4038e22bee78STejun Heo 
4039477a3c33STejun Heo 		if (cpu != WORK_CPU_UNBOUND)
4040477a3c33STejun Heo 			gcwq->flags &= ~GCWQ_DISASSOCIATED;
40414ce62e9eSTejun Heo 
40424ce62e9eSTejun Heo 		for_each_worker_pool(pool, gcwq) {
40434ce62e9eSTejun Heo 			struct worker *worker;
40444ce62e9eSTejun Heo 
4045bc2ae0f5STejun Heo 			worker = create_worker(pool);
4046e22bee78STejun Heo 			BUG_ON(!worker);
4047e22bee78STejun Heo 			spin_lock_irq(&gcwq->lock);
4048e22bee78STejun Heo 			start_worker(worker);
4049e22bee78STejun Heo 			spin_unlock_irq(&gcwq->lock);
4050e22bee78STejun Heo 		}
40514ce62e9eSTejun Heo 	}
4052e22bee78STejun Heo 
4053d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
4054d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
4055d320c038STejun Heo 	system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
4056f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
4057f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
405824d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
405924d51addSTejun Heo 					      WQ_FREEZABLE, 0);
406062d3c543SAlan Stern 	system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
406162d3c543SAlan Stern 			WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
4062e5cba24eSHitoshi Mitake 	BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
406362d3c543SAlan Stern 	       !system_unbound_wq || !system_freezable_wq ||
406462d3c543SAlan Stern 		!system_nrt_freezable_wq);
40656ee0578bSSuresh Siddha 	return 0;
40661da177e4SLinus Torvalds }
40676ee0578bSSuresh Siddha early_initcall(init_workqueues);
4068