xref: /linux-6.15/kernel/workqueue.c (revision 346c09f8)
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
19b11895c4SLibin  * automatically managed.  There are two worker pools for each CPU (one for
20b11895c4SLibin  * normal work items and the other for high priority ones) and some extra
21b11895c4SLibin  * pools for workqueues which are not bound to any specific CPU - the
22b11895c4SLibin  * number of these backing pools is dynamic.
23c54fce6eSTejun Heo  *
24c54fce6eSTejun Heo  * Please read Documentation/workqueue.txt for details.
251da177e4SLinus Torvalds  */
261da177e4SLinus Torvalds 
279984de1aSPaul Gortmaker #include <linux/export.h>
281da177e4SLinus Torvalds #include <linux/kernel.h>
291da177e4SLinus Torvalds #include <linux/sched.h>
301da177e4SLinus Torvalds #include <linux/init.h>
311da177e4SLinus Torvalds #include <linux/signal.h>
321da177e4SLinus Torvalds #include <linux/completion.h>
331da177e4SLinus Torvalds #include <linux/workqueue.h>
341da177e4SLinus Torvalds #include <linux/slab.h>
351da177e4SLinus Torvalds #include <linux/cpu.h>
361da177e4SLinus Torvalds #include <linux/notifier.h>
371da177e4SLinus Torvalds #include <linux/kthread.h>
381fa44ecaSJames Bottomley #include <linux/hardirq.h>
3946934023SChristoph Lameter #include <linux/mempolicy.h>
40341a5958SRafael J. Wysocki #include <linux/freezer.h>
41d5abe669SPeter Zijlstra #include <linux/kallsyms.h>
42d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
434e6045f1SJohannes Berg #include <linux/lockdep.h>
44c34056a3STejun Heo #include <linux/idr.h>
4529c91e99STejun Heo #include <linux/jhash.h>
4642f8570fSSasha Levin #include <linux/hashtable.h>
4776af4d93STejun Heo #include <linux/rculist.h>
48bce90380STejun Heo #include <linux/nodemask.h>
494c16bd32STejun Heo #include <linux/moduleparam.h>
503d1cb205STejun Heo #include <linux/uaccess.h>
51e22bee78STejun Heo 
52ea138446STejun Heo #include "workqueue_internal.h"
531da177e4SLinus Torvalds 
54c8e55f36STejun Heo enum {
55bc2ae0f5STejun Heo 	/*
5624647570STejun Heo 	 * worker_pool flags
57bc2ae0f5STejun Heo 	 *
5824647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
59bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
60bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
61bc2ae0f5STejun Heo 	 * is in effect.
62bc2ae0f5STejun Heo 	 *
63bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
64bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
6524647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
66bc2ae0f5STejun Heo 	 *
67bc3a1afcSTejun Heo 	 * Note that DISASSOCIATED should be flipped only while holding
6892f9c5c4SLai Jiangshan 	 * attach_mutex to avoid changing binding state while
694736cbf7SLai Jiangshan 	 * worker_attach_to_pool() is in progress.
70bc2ae0f5STejun Heo 	 */
7124647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
72db7bccf4STejun Heo 
73c8e55f36STejun Heo 	/* worker flags */
74c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
75c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
76e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
77fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
78f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
79a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
80e22bee78STejun Heo 
81a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
82a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
83db7bccf4STejun Heo 
84e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
854ce62e9eSTejun Heo 
8629c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
87c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
88db7bccf4STejun Heo 
89e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
90e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
91e22bee78STejun Heo 
923233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
933233cdbdSTejun Heo 						/* call for help after 10ms
943233cdbdSTejun Heo 						   (min two ticks) */
95e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
96e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
971da177e4SLinus Torvalds 
981da177e4SLinus Torvalds 	/*
99e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
1008698a745SDongsheng Yang 	 * all cpus.  Give MIN_NICE.
101e22bee78STejun Heo 	 */
1028698a745SDongsheng Yang 	RESCUER_NICE_LEVEL	= MIN_NICE,
1038698a745SDongsheng Yang 	HIGHPRI_NICE_LEVEL	= MIN_NICE,
104ecf6881fSTejun Heo 
105ecf6881fSTejun Heo 	WQ_NAME_LEN		= 24,
106c8e55f36STejun Heo };
107c8e55f36STejun Heo 
1081da177e4SLinus Torvalds /*
1094690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1104690c4abSTejun Heo  *
111e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
112e41e704bSTejun Heo  *    everyone else.
1134690c4abSTejun Heo  *
114e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
115e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
116e22bee78STejun Heo  *
117d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1184690c4abSTejun Heo  *
119d565ed63STejun Heo  * X: During normal operation, modification requires pool->lock and should
120d565ed63STejun Heo  *    be done only from local cpu.  Either disabling preemption on local
121d565ed63STejun Heo  *    cpu or grabbing pool->lock is enough for read access.  If
122d565ed63STejun Heo  *    POOL_DISASSOCIATED is set, it's identical to L.
123e22bee78STejun Heo  *
12492f9c5c4SLai Jiangshan  * A: pool->attach_mutex protected.
125822d8405STejun Heo  *
12668e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
12776af4d93STejun Heo  *
12868e13a67SLai Jiangshan  * PR: wq_pool_mutex protected for writes.  Sched-RCU protected for reads.
1295bcab335STejun Heo  *
1305b95e1afSLai Jiangshan  * PW: wq_pool_mutex and wq->mutex protected for writes.  Either for reads.
1315b95e1afSLai Jiangshan  *
1325b95e1afSLai Jiangshan  * PWR: wq_pool_mutex and wq->mutex protected for writes.  Either or
1335b95e1afSLai Jiangshan  *      sched-RCU for reads.
1345b95e1afSLai Jiangshan  *
1353c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1363c25a55dSLai Jiangshan  *
137b5927605SLai Jiangshan  * WR: wq->mutex protected for writes.  Sched-RCU protected for reads.
1382e109a28STejun Heo  *
1392e109a28STejun Heo  * MD: wq_mayday_lock protected.
1404690c4abSTejun Heo  */
1414690c4abSTejun Heo 
1422eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
143c34056a3STejun Heo 
144bd7bdd43STejun Heo struct worker_pool {
145d565ed63STejun Heo 	spinlock_t		lock;		/* the pool lock */
146d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
147f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1489daf9e67STejun Heo 	int			id;		/* I: pool ID */
14911ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
150bd7bdd43STejun Heo 
15182607adcSTejun Heo 	unsigned long		watchdog_ts;	/* L: watchdog timestamp */
15282607adcSTejun Heo 
153bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
154bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
155ea1abd61SLai Jiangshan 
156ea1abd61SLai Jiangshan 	/* nr_idle includes the ones off idle_list for rebinding */
157bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
158bd7bdd43STejun Heo 
159bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
160bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
161bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
162bd7bdd43STejun Heo 
163c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
164c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
165c9e7cf27STejun Heo 						/* L: hash of busy workers */
166c9e7cf27STejun Heo 
167bc3a1afcSTejun Heo 	/* see manage_workers() for details on the two manager mutexes */
16834a06bd6STejun Heo 	struct mutex		manager_arb;	/* manager arbitration */
1692607d7a6STejun Heo 	struct worker		*manager;	/* L: purely informational */
17092f9c5c4SLai Jiangshan 	struct mutex		attach_mutex;	/* attach/detach exclusion */
17192f9c5c4SLai Jiangshan 	struct list_head	workers;	/* A: attached workers */
17260f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
173e19e397aSTejun Heo 
1747cda9aaeSLai Jiangshan 	struct ida		worker_ida;	/* worker IDs for task name */
175e19e397aSTejun Heo 
1767a4e344cSTejun Heo 	struct workqueue_attrs	*attrs;		/* I: worker attributes */
17768e13a67SLai Jiangshan 	struct hlist_node	hash_node;	/* PL: unbound_pool_hash node */
17868e13a67SLai Jiangshan 	int			refcnt;		/* PL: refcnt for unbound pools */
1797a4e344cSTejun Heo 
180e19e397aSTejun Heo 	/*
181e19e397aSTejun Heo 	 * The current concurrency level.  As it's likely to be accessed
182e19e397aSTejun Heo 	 * from other CPUs during try_to_wake_up(), put it in a separate
183e19e397aSTejun Heo 	 * cacheline.
184e19e397aSTejun Heo 	 */
185e19e397aSTejun Heo 	atomic_t		nr_running ____cacheline_aligned_in_smp;
18629c91e99STejun Heo 
18729c91e99STejun Heo 	/*
18829c91e99STejun Heo 	 * Destruction of pool is sched-RCU protected to allow dereferences
18929c91e99STejun Heo 	 * from get_work_pool().
19029c91e99STejun Heo 	 */
19129c91e99STejun Heo 	struct rcu_head		rcu;
1928b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1938b03ae3cSTejun Heo 
1948b03ae3cSTejun Heo /*
195112202d9STejun Heo  * The per-pool workqueue.  While queued, the lower WORK_STRUCT_FLAG_BITS
196112202d9STejun Heo  * of work_struct->data are used for flags and the remaining high bits
197112202d9STejun Heo  * point to the pwq; thus, pwqs need to be aligned at two's power of the
198112202d9STejun Heo  * number of flag bits.
1991da177e4SLinus Torvalds  */
200112202d9STejun Heo struct pool_workqueue {
201bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
2024690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
20373f53c4aSTejun Heo 	int			work_color;	/* L: current color */
20473f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
2058864b4e5STejun Heo 	int			refcnt;		/* L: reference count */
20673f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
20773f53c4aSTejun Heo 						/* L: nr of in_flight works */
2081e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
209a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
2101e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
2113c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2122e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2138864b4e5STejun Heo 
2148864b4e5STejun Heo 	/*
2158864b4e5STejun Heo 	 * Release of unbound pwq is punted to system_wq.  See put_pwq()
2168864b4e5STejun Heo 	 * and pwq_unbound_release_workfn() for details.  pool_workqueue
2178864b4e5STejun Heo 	 * itself is also sched-RCU protected so that the first pwq can be
218b09f4fd3SLai Jiangshan 	 * determined without grabbing wq->mutex.
2198864b4e5STejun Heo 	 */
2208864b4e5STejun Heo 	struct work_struct	unbound_release_work;
2218864b4e5STejun Heo 	struct rcu_head		rcu;
222e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS);
2231da177e4SLinus Torvalds 
2241da177e4SLinus Torvalds /*
22573f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
22673f53c4aSTejun Heo  */
22773f53c4aSTejun Heo struct wq_flusher {
2283c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
2293c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
23073f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
23173f53c4aSTejun Heo };
2321da177e4SLinus Torvalds 
233226223abSTejun Heo struct wq_device;
234226223abSTejun Heo 
23573f53c4aSTejun Heo /*
236c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
237c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
2381da177e4SLinus Torvalds  */
2391da177e4SLinus Torvalds struct workqueue_struct {
2403c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
241e2dca7adSTejun Heo 	struct list_head	list;		/* PR: list of all workqueues */
24273f53c4aSTejun Heo 
2433c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
2443c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
2453c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
246112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
2473c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
2483c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
2493c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
25073f53c4aSTejun Heo 
2512e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
252e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
253e22bee78STejun Heo 
25487fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
255a357fc03SLai Jiangshan 	int			saved_max_active; /* WQ: saved pwq max_active */
256226223abSTejun Heo 
2575b95e1afSLai Jiangshan 	struct workqueue_attrs	*unbound_attrs;	/* PW: only for unbound wqs */
2585b95e1afSLai Jiangshan 	struct pool_workqueue	*dfl_pwq;	/* PW: only for unbound wqs */
2596029a918STejun Heo 
260226223abSTejun Heo #ifdef CONFIG_SYSFS
261226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
262226223abSTejun Heo #endif
2634e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2644e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2654e6045f1SJohannes Berg #endif
266ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
2672728fd2fSTejun Heo 
268e2dca7adSTejun Heo 	/*
269e2dca7adSTejun Heo 	 * Destruction of workqueue_struct is sched-RCU protected to allow
270e2dca7adSTejun Heo 	 * walking the workqueues list without grabbing wq_pool_mutex.
271e2dca7adSTejun Heo 	 * This is used to dump all workqueues from sysrq.
272e2dca7adSTejun Heo 	 */
273e2dca7adSTejun Heo 	struct rcu_head		rcu;
274e2dca7adSTejun Heo 
2752728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
2762728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
2772728fd2fSTejun Heo 	struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
2785b95e1afSLai Jiangshan 	struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
2791da177e4SLinus Torvalds };
2801da177e4SLinus Torvalds 
281e904e6c2STejun Heo static struct kmem_cache *pwq_cache;
282e904e6c2STejun Heo 
283bce90380STejun Heo static cpumask_var_t *wq_numa_possible_cpumask;
284bce90380STejun Heo 					/* possible CPUs of each node */
285bce90380STejun Heo 
286d55262c4STejun Heo static bool wq_disable_numa;
287d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444);
288d55262c4STejun Heo 
289cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
290552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
291cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
292cee22a15SViresh Kumar 
293bce90380STejun Heo static bool wq_numa_enabled;		/* unbound NUMA affinity enabled */
294bce90380STejun Heo 
2954c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
2964c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
2974c16bd32STejun Heo 
29868e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
2992e109a28STejun Heo static DEFINE_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
3005bcab335STejun Heo 
301e2dca7adSTejun Heo static LIST_HEAD(workqueues);		/* PR: list of all workqueues */
30268e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
3037d19c5ceSTejun Heo 
304ef557180SMike Galbraith /* PL: allowable cpus for unbound wqs and work items */
305ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask;
306ef557180SMike Galbraith 
307ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */
308ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last);
309b05a7928SFrederic Weisbecker 
310f303fccbSTejun Heo /*
311f303fccbSTejun Heo  * Local execution of unbound work items is no longer guaranteed.  The
312f303fccbSTejun Heo  * following always forces round-robin CPU selection on unbound work items
313f303fccbSTejun Heo  * to uncover usages which depend on it.
314f303fccbSTejun Heo  */
315f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
316f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true;
317f303fccbSTejun Heo #else
318f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false;
319f303fccbSTejun Heo #endif
320f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
321f303fccbSTejun Heo 
3227d19c5ceSTejun Heo /* the per-cpu worker pools */
32325528213SPeter Zijlstra static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
3247d19c5ceSTejun Heo 
32568e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
3267d19c5ceSTejun Heo 
32768e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
32829c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
32929c91e99STejun Heo 
330c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
33129c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
33229c91e99STejun Heo 
3338a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
3348a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
3358a2b7538STejun Heo 
336d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
337ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
338044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
3391aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
340044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
341d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
342044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
343f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
344044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
34524d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
3460668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly;
3470668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
3480668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
3490668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
350d320c038STejun Heo 
3517d19c5ceSTejun Heo static int worker_thread(void *__worker);
3526ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
3537d19c5ceSTejun Heo 
35497bd2347STejun Heo #define CREATE_TRACE_POINTS
35597bd2347STejun Heo #include <trace/events/workqueue.h>
35697bd2347STejun Heo 
35768e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
358f78f5b90SPaul E. McKenney 	RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() &&			\
359f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
36068e13a67SLai Jiangshan 			 "sched RCU or wq_pool_mutex should be held")
3615bcab335STejun Heo 
362b09f4fd3SLai Jiangshan #define assert_rcu_or_wq_mutex(wq)					\
363f78f5b90SPaul E. McKenney 	RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() &&			\
364f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex),			\
365b09f4fd3SLai Jiangshan 			 "sched RCU or wq->mutex should be held")
36676af4d93STejun Heo 
3675b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)			\
368f78f5b90SPaul E. McKenney 	RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() &&			\
369f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex) &&		\
370f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
3715b95e1afSLai Jiangshan 			 "sched RCU, wq->mutex or wq_pool_mutex should be held")
3725b95e1afSLai Jiangshan 
373f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
374f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
375f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
3767a62c2c8STejun Heo 	     (pool)++)
3774ce62e9eSTejun Heo 
37849e3cf44STejun Heo /**
37917116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
38017116969STejun Heo  * @pool: iteration cursor
381611c92a0STejun Heo  * @pi: integer used for iteration
382fa1b54e6STejun Heo  *
38368e13a67SLai Jiangshan  * This must be called either with wq_pool_mutex held or sched RCU read
38468e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
38568e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
386fa1b54e6STejun Heo  *
387fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
388fa1b54e6STejun Heo  * ignored.
38917116969STejun Heo  */
390611c92a0STejun Heo #define for_each_pool(pool, pi)						\
391611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
39268e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
393fa1b54e6STejun Heo 		else
39417116969STejun Heo 
39517116969STejun Heo /**
396822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
397822d8405STejun Heo  * @worker: iteration cursor
398822d8405STejun Heo  * @pool: worker_pool to iterate workers of
399822d8405STejun Heo  *
40092f9c5c4SLai Jiangshan  * This must be called with @pool->attach_mutex.
401822d8405STejun Heo  *
402822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
403822d8405STejun Heo  * ignored.
404822d8405STejun Heo  */
405da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
406da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
40792f9c5c4SLai Jiangshan 		if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
408822d8405STejun Heo 		else
409822d8405STejun Heo 
410822d8405STejun Heo /**
41149e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
41249e3cf44STejun Heo  * @pwq: iteration cursor
41349e3cf44STejun Heo  * @wq: the target workqueue
41476af4d93STejun Heo  *
415b09f4fd3SLai Jiangshan  * This must be called either with wq->mutex held or sched RCU read locked.
416794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
417794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
41876af4d93STejun Heo  *
41976af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
42076af4d93STejun Heo  * ignored.
42149e3cf44STejun Heo  */
42249e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
42376af4d93STejun Heo 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node)		\
424b09f4fd3SLai Jiangshan 		if (({ assert_rcu_or_wq_mutex(wq); false; })) { }	\
42576af4d93STejun Heo 		else
426f3421797STejun Heo 
427dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
428dc186ad7SThomas Gleixner 
429dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
430dc186ad7SThomas Gleixner 
43199777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
43299777288SStanislaw Gruszka {
43399777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
43499777288SStanislaw Gruszka }
43599777288SStanislaw Gruszka 
436dc186ad7SThomas Gleixner /*
437dc186ad7SThomas Gleixner  * fixup_init is called when:
438dc186ad7SThomas Gleixner  * - an active object is initialized
439dc186ad7SThomas Gleixner  */
440dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
441dc186ad7SThomas Gleixner {
442dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
443dc186ad7SThomas Gleixner 
444dc186ad7SThomas Gleixner 	switch (state) {
445dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
446dc186ad7SThomas Gleixner 		cancel_work_sync(work);
447dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
448dc186ad7SThomas Gleixner 		return 1;
449dc186ad7SThomas Gleixner 	default:
450dc186ad7SThomas Gleixner 		return 0;
451dc186ad7SThomas Gleixner 	}
452dc186ad7SThomas Gleixner }
453dc186ad7SThomas Gleixner 
454dc186ad7SThomas Gleixner /*
455dc186ad7SThomas Gleixner  * fixup_activate is called when:
456dc186ad7SThomas Gleixner  * - an active object is activated
457dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
458dc186ad7SThomas Gleixner  */
459dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
460dc186ad7SThomas Gleixner {
461dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
462dc186ad7SThomas Gleixner 
463dc186ad7SThomas Gleixner 	switch (state) {
464dc186ad7SThomas Gleixner 
465dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
466dc186ad7SThomas Gleixner 		/*
467dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
468dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
469dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
470dc186ad7SThomas Gleixner 		 */
47122df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
472dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
473dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
474dc186ad7SThomas Gleixner 			return 0;
475dc186ad7SThomas Gleixner 		}
476dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
477dc186ad7SThomas Gleixner 		return 0;
478dc186ad7SThomas Gleixner 
479dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
480dc186ad7SThomas Gleixner 		WARN_ON(1);
481dc186ad7SThomas Gleixner 
482dc186ad7SThomas Gleixner 	default:
483dc186ad7SThomas Gleixner 		return 0;
484dc186ad7SThomas Gleixner 	}
485dc186ad7SThomas Gleixner }
486dc186ad7SThomas Gleixner 
487dc186ad7SThomas Gleixner /*
488dc186ad7SThomas Gleixner  * fixup_free is called when:
489dc186ad7SThomas Gleixner  * - an active object is freed
490dc186ad7SThomas Gleixner  */
491dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
492dc186ad7SThomas Gleixner {
493dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
494dc186ad7SThomas Gleixner 
495dc186ad7SThomas Gleixner 	switch (state) {
496dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
497dc186ad7SThomas Gleixner 		cancel_work_sync(work);
498dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
499dc186ad7SThomas Gleixner 		return 1;
500dc186ad7SThomas Gleixner 	default:
501dc186ad7SThomas Gleixner 		return 0;
502dc186ad7SThomas Gleixner 	}
503dc186ad7SThomas Gleixner }
504dc186ad7SThomas Gleixner 
505dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
506dc186ad7SThomas Gleixner 	.name		= "work_struct",
50799777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
508dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
509dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
510dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
511dc186ad7SThomas Gleixner };
512dc186ad7SThomas Gleixner 
513dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
514dc186ad7SThomas Gleixner {
515dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
516dc186ad7SThomas Gleixner }
517dc186ad7SThomas Gleixner 
518dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
519dc186ad7SThomas Gleixner {
520dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
521dc186ad7SThomas Gleixner }
522dc186ad7SThomas Gleixner 
523dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
524dc186ad7SThomas Gleixner {
525dc186ad7SThomas Gleixner 	if (onstack)
526dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
527dc186ad7SThomas Gleixner 	else
528dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
529dc186ad7SThomas Gleixner }
530dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
531dc186ad7SThomas Gleixner 
532dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
533dc186ad7SThomas Gleixner {
534dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
535dc186ad7SThomas Gleixner }
536dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
537dc186ad7SThomas Gleixner 
538ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
539ea2e64f2SThomas Gleixner {
540ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
541ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
542ea2e64f2SThomas Gleixner }
543ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
544ea2e64f2SThomas Gleixner 
545dc186ad7SThomas Gleixner #else
546dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
547dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
548dc186ad7SThomas Gleixner #endif
549dc186ad7SThomas Gleixner 
5504e8b22bdSLi Bin /**
5514e8b22bdSLi Bin  * worker_pool_assign_id - allocate ID and assing it to @pool
5524e8b22bdSLi Bin  * @pool: the pool pointer of interest
5534e8b22bdSLi Bin  *
5544e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
5554e8b22bdSLi Bin  * successfully, -errno on failure.
5564e8b22bdSLi Bin  */
5579daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
5589daf9e67STejun Heo {
5599daf9e67STejun Heo 	int ret;
5609daf9e67STejun Heo 
56168e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5625bcab335STejun Heo 
5634e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
5644e8b22bdSLi Bin 			GFP_KERNEL);
565229641a6STejun Heo 	if (ret >= 0) {
566e68035fbSTejun Heo 		pool->id = ret;
567229641a6STejun Heo 		return 0;
568229641a6STejun Heo 	}
5699daf9e67STejun Heo 	return ret;
5709daf9e67STejun Heo }
5719daf9e67STejun Heo 
57276af4d93STejun Heo /**
573df2d5ae4STejun Heo  * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
574df2d5ae4STejun Heo  * @wq: the target workqueue
575df2d5ae4STejun Heo  * @node: the node ID
576df2d5ae4STejun Heo  *
5775b95e1afSLai Jiangshan  * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
5785b95e1afSLai Jiangshan  * read locked.
579df2d5ae4STejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
580df2d5ae4STejun Heo  * responsible for guaranteeing that the pwq stays online.
581d185af30SYacine Belkadi  *
582d185af30SYacine Belkadi  * Return: The unbound pool_workqueue for @node.
583df2d5ae4STejun Heo  */
584df2d5ae4STejun Heo static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
585df2d5ae4STejun Heo 						  int node)
586df2d5ae4STejun Heo {
5875b95e1afSLai Jiangshan 	assert_rcu_or_wq_mutex_or_pool_mutex(wq);
588d6e022f1STejun Heo 
589d6e022f1STejun Heo 	/*
590d6e022f1STejun Heo 	 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
591d6e022f1STejun Heo 	 * delayed item is pending.  The plan is to keep CPU -> NODE
592d6e022f1STejun Heo 	 * mapping valid and stable across CPU on/offlines.  Once that
593d6e022f1STejun Heo 	 * happens, this workaround can be removed.
594d6e022f1STejun Heo 	 */
595d6e022f1STejun Heo 	if (unlikely(node == NUMA_NO_NODE))
596d6e022f1STejun Heo 		return wq->dfl_pwq;
597d6e022f1STejun Heo 
598df2d5ae4STejun Heo 	return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
599df2d5ae4STejun Heo }
600df2d5ae4STejun Heo 
60173f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
60273f53c4aSTejun Heo {
60373f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
60473f53c4aSTejun Heo }
60573f53c4aSTejun Heo 
60673f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
60773f53c4aSTejun Heo {
60873f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
60973f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
61073f53c4aSTejun Heo }
61173f53c4aSTejun Heo 
61273f53c4aSTejun Heo static int work_next_color(int color)
61373f53c4aSTejun Heo {
61473f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
615a848e3b6SOleg Nesterov }
616a848e3b6SOleg Nesterov 
6174594bf15SDavid Howells /*
618112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
619112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
6207c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
6217a22ad75STejun Heo  *
622112202d9STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
623112202d9STejun Heo  * and clear_work_data() can be used to set the pwq, pool or clear
624bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
625bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
6267a22ad75STejun Heo  *
627112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
6287c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
629112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
6307c3eed5cSTejun Heo  * available only while the work item is queued.
631bbb68dfaSTejun Heo  *
632bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
633bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
634bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
635bbb68dfaSTejun Heo  * try to steal the PENDING bit.
6364594bf15SDavid Howells  */
6377a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
6387a22ad75STejun Heo 				 unsigned long flags)
6397a22ad75STejun Heo {
6406183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
6417a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
6427a22ad75STejun Heo }
6437a22ad75STejun Heo 
644112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
6454690c4abSTejun Heo 			 unsigned long extra_flags)
646365970a1SDavid Howells {
647112202d9STejun Heo 	set_work_data(work, (unsigned long)pwq,
648112202d9STejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
649365970a1SDavid Howells }
650365970a1SDavid Howells 
6514468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
6524468a00fSLai Jiangshan 					   int pool_id)
6534468a00fSLai Jiangshan {
6544468a00fSLai Jiangshan 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
6554468a00fSLai Jiangshan 		      WORK_STRUCT_PENDING);
6564468a00fSLai Jiangshan }
6574468a00fSLai Jiangshan 
6587c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
6597c3eed5cSTejun Heo 					    int pool_id)
6604d707b9fSOleg Nesterov {
66123657bb1STejun Heo 	/*
66223657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
66323657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
66423657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
66523657bb1STejun Heo 	 * owner.
66623657bb1STejun Heo 	 */
66723657bb1STejun Heo 	smp_wmb();
6687c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
669*346c09f8SRoman Pen 	/*
670*346c09f8SRoman Pen 	 * The following mb guarantees that previous clear of a PENDING bit
671*346c09f8SRoman Pen 	 * will not be reordered with any speculative LOADS or STORES from
672*346c09f8SRoman Pen 	 * work->current_func, which is executed afterwards.  This possible
673*346c09f8SRoman Pen 	 * reordering can lead to a missed execution on attempt to qeueue
674*346c09f8SRoman Pen 	 * the same @work.  E.g. consider this case:
675*346c09f8SRoman Pen 	 *
676*346c09f8SRoman Pen 	 *   CPU#0                         CPU#1
677*346c09f8SRoman Pen 	 *   ----------------------------  --------------------------------
678*346c09f8SRoman Pen 	 *
679*346c09f8SRoman Pen 	 * 1  STORE event_indicated
680*346c09f8SRoman Pen 	 * 2  queue_work_on() {
681*346c09f8SRoman Pen 	 * 3    test_and_set_bit(PENDING)
682*346c09f8SRoman Pen 	 * 4 }                             set_..._and_clear_pending() {
683*346c09f8SRoman Pen 	 * 5                                 set_work_data() # clear bit
684*346c09f8SRoman Pen 	 * 6                                 smp_mb()
685*346c09f8SRoman Pen 	 * 7                               work->current_func() {
686*346c09f8SRoman Pen 	 * 8				      LOAD event_indicated
687*346c09f8SRoman Pen 	 *				   }
688*346c09f8SRoman Pen 	 *
689*346c09f8SRoman Pen 	 * Without an explicit full barrier speculative LOAD on line 8 can
690*346c09f8SRoman Pen 	 * be executed before CPU#0 does STORE on line 1.  If that happens,
691*346c09f8SRoman Pen 	 * CPU#0 observes the PENDING bit is still set and new execution of
692*346c09f8SRoman Pen 	 * a @work is not queued in a hope, that CPU#1 will eventually
693*346c09f8SRoman Pen 	 * finish the queued @work.  Meanwhile CPU#1 does not see
694*346c09f8SRoman Pen 	 * event_indicated is set, because speculative LOAD was executed
695*346c09f8SRoman Pen 	 * before actual STORE.
696*346c09f8SRoman Pen 	 */
697*346c09f8SRoman Pen 	smp_mb();
6984d707b9fSOleg Nesterov }
6994d707b9fSOleg Nesterov 
7007a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
701365970a1SDavid Howells {
7027c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
7037c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
7047a22ad75STejun Heo }
7057a22ad75STejun Heo 
706112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
7077a22ad75STejun Heo {
708e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
7097a22ad75STejun Heo 
710112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
711e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
712e120153dSTejun Heo 	else
713e120153dSTejun Heo 		return NULL;
7147a22ad75STejun Heo }
7157a22ad75STejun Heo 
7167c3eed5cSTejun Heo /**
7177c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
7187c3eed5cSTejun Heo  * @work: the work item of interest
7197c3eed5cSTejun Heo  *
72068e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
72168e13a67SLai Jiangshan  * access under sched-RCU read lock.  As such, this function should be
72268e13a67SLai Jiangshan  * called under wq_pool_mutex or with preemption disabled.
723fa1b54e6STejun Heo  *
724fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
725fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
726fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
727fa1b54e6STejun Heo  * returned pool is and stays online.
728d185af30SYacine Belkadi  *
729d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
7307c3eed5cSTejun Heo  */
7317c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
7327a22ad75STejun Heo {
733e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
7347c3eed5cSTejun Heo 	int pool_id;
7357a22ad75STejun Heo 
73668e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
737fa1b54e6STejun Heo 
738112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
739112202d9STejun Heo 		return ((struct pool_workqueue *)
7407c3eed5cSTejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool;
7417a22ad75STejun Heo 
7427c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
7437c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
7447a22ad75STejun Heo 		return NULL;
7457a22ad75STejun Heo 
746fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
7477c3eed5cSTejun Heo }
7487c3eed5cSTejun Heo 
7497c3eed5cSTejun Heo /**
7507c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
7517c3eed5cSTejun Heo  * @work: the work item of interest
7527c3eed5cSTejun Heo  *
753d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
7547c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
7557c3eed5cSTejun Heo  */
7567c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
7577c3eed5cSTejun Heo {
75854d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
7597c3eed5cSTejun Heo 
760112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
761112202d9STejun Heo 		return ((struct pool_workqueue *)
76254d5b7d0SLai Jiangshan 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
76354d5b7d0SLai Jiangshan 
76454d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
7657c3eed5cSTejun Heo }
7667c3eed5cSTejun Heo 
767bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
768bbb68dfaSTejun Heo {
7697c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
770bbb68dfaSTejun Heo 
7717c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
7727c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
773bbb68dfaSTejun Heo }
774bbb68dfaSTejun Heo 
775bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
776bbb68dfaSTejun Heo {
777bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
778bbb68dfaSTejun Heo 
779112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
780bbb68dfaSTejun Heo }
781bbb68dfaSTejun Heo 
782e22bee78STejun Heo /*
7833270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
7843270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
785d565ed63STejun Heo  * they're being called with pool->lock held.
786e22bee78STejun Heo  */
787e22bee78STejun Heo 
78863d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
789649027d7STejun Heo {
790e19e397aSTejun Heo 	return !atomic_read(&pool->nr_running);
791649027d7STejun Heo }
792649027d7STejun Heo 
793e22bee78STejun Heo /*
794e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
795e22bee78STejun Heo  * running workers.
796974271c4STejun Heo  *
797974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
798706026c2STejun Heo  * function will always return %true for unbound pools as long as the
799974271c4STejun Heo  * worklist isn't empty.
800e22bee78STejun Heo  */
80163d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
802e22bee78STejun Heo {
80363d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
804e22bee78STejun Heo }
805e22bee78STejun Heo 
806e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
80763d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
808e22bee78STejun Heo {
80963d95a91STejun Heo 	return pool->nr_idle;
810e22bee78STejun Heo }
811e22bee78STejun Heo 
812e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
81363d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
814e22bee78STejun Heo {
815e19e397aSTejun Heo 	return !list_empty(&pool->worklist) &&
816e19e397aSTejun Heo 		atomic_read(&pool->nr_running) <= 1;
817e22bee78STejun Heo }
818e22bee78STejun Heo 
819e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
82063d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
821e22bee78STejun Heo {
82263d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
823e22bee78STejun Heo }
824e22bee78STejun Heo 
825e22bee78STejun Heo /* Do we have too many workers and should some go away? */
82663d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
827e22bee78STejun Heo {
82834a06bd6STejun Heo 	bool managing = mutex_is_locked(&pool->manager_arb);
82963d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
83063d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
831e22bee78STejun Heo 
832e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
833e22bee78STejun Heo }
834e22bee78STejun Heo 
835e22bee78STejun Heo /*
836e22bee78STejun Heo  * Wake up functions.
837e22bee78STejun Heo  */
838e22bee78STejun Heo 
8391037de36SLai Jiangshan /* Return the first idle worker.  Safe with preemption disabled */
8401037de36SLai Jiangshan static struct worker *first_idle_worker(struct worker_pool *pool)
8417e11629dSTejun Heo {
84263d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
8437e11629dSTejun Heo 		return NULL;
8447e11629dSTejun Heo 
84563d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
8467e11629dSTejun Heo }
8477e11629dSTejun Heo 
8487e11629dSTejun Heo /**
8497e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
85063d95a91STejun Heo  * @pool: worker pool to wake worker from
8517e11629dSTejun Heo  *
85263d95a91STejun Heo  * Wake up the first idle worker of @pool.
8537e11629dSTejun Heo  *
8547e11629dSTejun Heo  * CONTEXT:
855d565ed63STejun Heo  * spin_lock_irq(pool->lock).
8567e11629dSTejun Heo  */
85763d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
8587e11629dSTejun Heo {
8591037de36SLai Jiangshan 	struct worker *worker = first_idle_worker(pool);
8607e11629dSTejun Heo 
8617e11629dSTejun Heo 	if (likely(worker))
8627e11629dSTejun Heo 		wake_up_process(worker->task);
8637e11629dSTejun Heo }
8647e11629dSTejun Heo 
8654690c4abSTejun Heo /**
866e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
867e22bee78STejun Heo  * @task: task waking up
868e22bee78STejun Heo  * @cpu: CPU @task is waking up to
869e22bee78STejun Heo  *
870e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
871e22bee78STejun Heo  * being awoken.
872e22bee78STejun Heo  *
873e22bee78STejun Heo  * CONTEXT:
874e22bee78STejun Heo  * spin_lock_irq(rq->lock)
875e22bee78STejun Heo  */
876d84ff051STejun Heo void wq_worker_waking_up(struct task_struct *task, int cpu)
877e22bee78STejun Heo {
878e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
879e22bee78STejun Heo 
88036576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
881ec22ca5eSTejun Heo 		WARN_ON_ONCE(worker->pool->cpu != cpu);
882e19e397aSTejun Heo 		atomic_inc(&worker->pool->nr_running);
883e22bee78STejun Heo 	}
88436576000SJoonsoo Kim }
885e22bee78STejun Heo 
886e22bee78STejun Heo /**
887e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
888e22bee78STejun Heo  * @task: task going to sleep
889e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
890e22bee78STejun Heo  *
891e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
892e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
893e22bee78STejun Heo  * returning pointer to its task.
894e22bee78STejun Heo  *
895e22bee78STejun Heo  * CONTEXT:
896e22bee78STejun Heo  * spin_lock_irq(rq->lock)
897e22bee78STejun Heo  *
898d185af30SYacine Belkadi  * Return:
899e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
900e22bee78STejun Heo  */
901d84ff051STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
902e22bee78STejun Heo {
903e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
904111c225aSTejun Heo 	struct worker_pool *pool;
905e22bee78STejun Heo 
906111c225aSTejun Heo 	/*
907111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
908111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
909111c225aSTejun Heo 	 * checking NOT_RUNNING.
910111c225aSTejun Heo 	 */
9112d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
912e22bee78STejun Heo 		return NULL;
913e22bee78STejun Heo 
914111c225aSTejun Heo 	pool = worker->pool;
915111c225aSTejun Heo 
916e22bee78STejun Heo 	/* this can only happen on the local cpu */
91792b69f50SLai Jiangshan 	if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
9186183c009STejun Heo 		return NULL;
919e22bee78STejun Heo 
920e22bee78STejun Heo 	/*
921e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
922e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
923e22bee78STejun Heo 	 * Please read comment there.
924e22bee78STejun Heo 	 *
925628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
926628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
927628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
928d565ed63STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without pool
929628c78e7STejun Heo 	 * lock is safe.
930e22bee78STejun Heo 	 */
931e19e397aSTejun Heo 	if (atomic_dec_and_test(&pool->nr_running) &&
932e19e397aSTejun Heo 	    !list_empty(&pool->worklist))
9331037de36SLai Jiangshan 		to_wakeup = first_idle_worker(pool);
934e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
935e22bee78STejun Heo }
936e22bee78STejun Heo 
937e22bee78STejun Heo /**
938e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
939cb444766STejun Heo  * @worker: self
940d302f017STejun Heo  * @flags: flags to set
941d302f017STejun Heo  *
942228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
943d302f017STejun Heo  *
944cb444766STejun Heo  * CONTEXT:
945d565ed63STejun Heo  * spin_lock_irq(pool->lock)
946d302f017STejun Heo  */
947228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
948d302f017STejun Heo {
949bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
950e22bee78STejun Heo 
951cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
952cb444766STejun Heo 
953228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
954e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
955e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
956e19e397aSTejun Heo 		atomic_dec(&pool->nr_running);
957e22bee78STejun Heo 	}
958e22bee78STejun Heo 
959d302f017STejun Heo 	worker->flags |= flags;
960d302f017STejun Heo }
961d302f017STejun Heo 
962d302f017STejun Heo /**
963e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
964cb444766STejun Heo  * @worker: self
965d302f017STejun Heo  * @flags: flags to clear
966d302f017STejun Heo  *
967e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
968d302f017STejun Heo  *
969cb444766STejun Heo  * CONTEXT:
970d565ed63STejun Heo  * spin_lock_irq(pool->lock)
971d302f017STejun Heo  */
972d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
973d302f017STejun Heo {
97463d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
975e22bee78STejun Heo 	unsigned int oflags = worker->flags;
976e22bee78STejun Heo 
977cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
978cb444766STejun Heo 
979d302f017STejun Heo 	worker->flags &= ~flags;
980e22bee78STejun Heo 
98142c025f3STejun Heo 	/*
98242c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
98342c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
98442c025f3STejun Heo 	 * of multiple flags, not a single flag.
98542c025f3STejun Heo 	 */
986e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
987e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
988e19e397aSTejun Heo 			atomic_inc(&pool->nr_running);
989d302f017STejun Heo }
990d302f017STejun Heo 
991d302f017STejun Heo /**
9928cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
993c9e7cf27STejun Heo  * @pool: pool of interest
9948cca0eeaSTejun Heo  * @work: work to find worker for
9958cca0eeaSTejun Heo  *
996c9e7cf27STejun Heo  * Find a worker which is executing @work on @pool by searching
997c9e7cf27STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
998a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
999a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
1000a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
1001a2c1c57bSTejun Heo  * being executed.
1002a2c1c57bSTejun Heo  *
1003a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
1004a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
1005a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
1006a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
1007a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
1008a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
1009a2c1c57bSTejun Heo  *
1010c5aa87bbSTejun Heo  * This function checks the work item address and work function to avoid
1011c5aa87bbSTejun Heo  * false positives.  Note that this isn't complete as one may construct a
1012c5aa87bbSTejun Heo  * work function which can introduce dependency onto itself through a
1013c5aa87bbSTejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
1014c5aa87bbSTejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
1015c5aa87bbSTejun Heo  * actually occurs, it should be easy to locate the culprit work function.
10168cca0eeaSTejun Heo  *
10178cca0eeaSTejun Heo  * CONTEXT:
1018d565ed63STejun Heo  * spin_lock_irq(pool->lock).
10198cca0eeaSTejun Heo  *
1020d185af30SYacine Belkadi  * Return:
1021d185af30SYacine Belkadi  * Pointer to worker which is executing @work if found, %NULL
10228cca0eeaSTejun Heo  * otherwise.
10238cca0eeaSTejun Heo  */
1024c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
10258cca0eeaSTejun Heo 						 struct work_struct *work)
10268cca0eeaSTejun Heo {
102742f8570fSSasha Levin 	struct worker *worker;
102842f8570fSSasha Levin 
1029b67bfe0dSSasha Levin 	hash_for_each_possible(pool->busy_hash, worker, hentry,
1030a2c1c57bSTejun Heo 			       (unsigned long)work)
1031a2c1c57bSTejun Heo 		if (worker->current_work == work &&
1032a2c1c57bSTejun Heo 		    worker->current_func == work->func)
103342f8570fSSasha Levin 			return worker;
103442f8570fSSasha Levin 
103542f8570fSSasha Levin 	return NULL;
10368cca0eeaSTejun Heo }
10378cca0eeaSTejun Heo 
10388cca0eeaSTejun Heo /**
1039bf4ede01STejun Heo  * move_linked_works - move linked works to a list
1040bf4ede01STejun Heo  * @work: start of series of works to be scheduled
1041bf4ede01STejun Heo  * @head: target list to append @work to
1042402dd89dSShailendra Verma  * @nextp: out parameter for nested worklist walking
1043bf4ede01STejun Heo  *
1044bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1045bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1046bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1047bf4ede01STejun Heo  *
1048bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1049bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1050bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
1051bf4ede01STejun Heo  *
1052bf4ede01STejun Heo  * CONTEXT:
1053d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1054bf4ede01STejun Heo  */
1055bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1056bf4ede01STejun Heo 			      struct work_struct **nextp)
1057bf4ede01STejun Heo {
1058bf4ede01STejun Heo 	struct work_struct *n;
1059bf4ede01STejun Heo 
1060bf4ede01STejun Heo 	/*
1061bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
1062bf4ede01STejun Heo 	 * use NULL for list head.
1063bf4ede01STejun Heo 	 */
1064bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1065bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
1066bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1067bf4ede01STejun Heo 			break;
1068bf4ede01STejun Heo 	}
1069bf4ede01STejun Heo 
1070bf4ede01STejun Heo 	/*
1071bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
1072bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
1073bf4ede01STejun Heo 	 * needs to be updated.
1074bf4ede01STejun Heo 	 */
1075bf4ede01STejun Heo 	if (nextp)
1076bf4ede01STejun Heo 		*nextp = n;
1077bf4ede01STejun Heo }
1078bf4ede01STejun Heo 
10798864b4e5STejun Heo /**
10808864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
10818864b4e5STejun Heo  * @pwq: pool_workqueue to get
10828864b4e5STejun Heo  *
10838864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
10848864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
10858864b4e5STejun Heo  */
10868864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
10878864b4e5STejun Heo {
10888864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
10898864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
10908864b4e5STejun Heo 	pwq->refcnt++;
10918864b4e5STejun Heo }
10928864b4e5STejun Heo 
10938864b4e5STejun Heo /**
10948864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
10958864b4e5STejun Heo  * @pwq: pool_workqueue to put
10968864b4e5STejun Heo  *
10978864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
10988864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
10998864b4e5STejun Heo  */
11008864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
11018864b4e5STejun Heo {
11028864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
11038864b4e5STejun Heo 	if (likely(--pwq->refcnt))
11048864b4e5STejun Heo 		return;
11058864b4e5STejun Heo 	if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
11068864b4e5STejun Heo 		return;
11078864b4e5STejun Heo 	/*
11088864b4e5STejun Heo 	 * @pwq can't be released under pool->lock, bounce to
11098864b4e5STejun Heo 	 * pwq_unbound_release_workfn().  This never recurses on the same
11108864b4e5STejun Heo 	 * pool->lock as this path is taken only for unbound workqueues and
11118864b4e5STejun Heo 	 * the release work item is scheduled on a per-cpu workqueue.  To
11128864b4e5STejun Heo 	 * avoid lockdep warning, unbound pool->locks are given lockdep
11138864b4e5STejun Heo 	 * subclass of 1 in get_unbound_pool().
11148864b4e5STejun Heo 	 */
11158864b4e5STejun Heo 	schedule_work(&pwq->unbound_release_work);
11168864b4e5STejun Heo }
11178864b4e5STejun Heo 
1118dce90d47STejun Heo /**
1119dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1120dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1121dce90d47STejun Heo  *
1122dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1123dce90d47STejun Heo  */
1124dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1125dce90d47STejun Heo {
1126dce90d47STejun Heo 	if (pwq) {
1127dce90d47STejun Heo 		/*
1128dce90d47STejun Heo 		 * As both pwqs and pools are sched-RCU protected, the
1129dce90d47STejun Heo 		 * following lock operations are safe.
1130dce90d47STejun Heo 		 */
1131dce90d47STejun Heo 		spin_lock_irq(&pwq->pool->lock);
1132dce90d47STejun Heo 		put_pwq(pwq);
1133dce90d47STejun Heo 		spin_unlock_irq(&pwq->pool->lock);
1134dce90d47STejun Heo 	}
1135dce90d47STejun Heo }
1136dce90d47STejun Heo 
1137112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work)
1138bf4ede01STejun Heo {
1139112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1140bf4ede01STejun Heo 
1141bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
114282607adcSTejun Heo 	if (list_empty(&pwq->pool->worklist))
114382607adcSTejun Heo 		pwq->pool->watchdog_ts = jiffies;
1144112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
1145bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1146112202d9STejun Heo 	pwq->nr_active++;
1147bf4ede01STejun Heo }
1148bf4ede01STejun Heo 
1149112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
11503aa62497SLai Jiangshan {
1151112202d9STejun Heo 	struct work_struct *work = list_first_entry(&pwq->delayed_works,
11523aa62497SLai Jiangshan 						    struct work_struct, entry);
11533aa62497SLai Jiangshan 
1154112202d9STejun Heo 	pwq_activate_delayed_work(work);
11553aa62497SLai Jiangshan }
11563aa62497SLai Jiangshan 
1157bf4ede01STejun Heo /**
1158112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1159112202d9STejun Heo  * @pwq: pwq of interest
1160bf4ede01STejun Heo  * @color: color of work which left the queue
1161bf4ede01STejun Heo  *
1162bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1163112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1164bf4ede01STejun Heo  *
1165bf4ede01STejun Heo  * CONTEXT:
1166d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1167bf4ede01STejun Heo  */
1168112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1169bf4ede01STejun Heo {
11708864b4e5STejun Heo 	/* uncolored work items don't participate in flushing or nr_active */
1171bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
11728864b4e5STejun Heo 		goto out_put;
1173bf4ede01STejun Heo 
1174112202d9STejun Heo 	pwq->nr_in_flight[color]--;
1175bf4ede01STejun Heo 
1176112202d9STejun Heo 	pwq->nr_active--;
1177112202d9STejun Heo 	if (!list_empty(&pwq->delayed_works)) {
1178bf4ede01STejun Heo 		/* one down, submit a delayed one */
1179112202d9STejun Heo 		if (pwq->nr_active < pwq->max_active)
1180112202d9STejun Heo 			pwq_activate_first_delayed(pwq);
1181bf4ede01STejun Heo 	}
1182bf4ede01STejun Heo 
1183bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1184112202d9STejun Heo 	if (likely(pwq->flush_color != color))
11858864b4e5STejun Heo 		goto out_put;
1186bf4ede01STejun Heo 
1187bf4ede01STejun Heo 	/* are there still in-flight works? */
1188112202d9STejun Heo 	if (pwq->nr_in_flight[color])
11898864b4e5STejun Heo 		goto out_put;
1190bf4ede01STejun Heo 
1191112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1192112202d9STejun Heo 	pwq->flush_color = -1;
1193bf4ede01STejun Heo 
1194bf4ede01STejun Heo 	/*
1195112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1196bf4ede01STejun Heo 	 * will handle the rest.
1197bf4ede01STejun Heo 	 */
1198112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1199112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
12008864b4e5STejun Heo out_put:
12018864b4e5STejun Heo 	put_pwq(pwq);
1202bf4ede01STejun Heo }
1203bf4ede01STejun Heo 
120436e227d2STejun Heo /**
1205bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
120636e227d2STejun Heo  * @work: work item to steal
120736e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1208bbb68dfaSTejun Heo  * @flags: place to store irq state
120936e227d2STejun Heo  *
121036e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
1211d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
121236e227d2STejun Heo  *
1213d185af30SYacine Belkadi  * Return:
121436e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
121536e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
121636e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1217bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1218bbb68dfaSTejun Heo  *		for arbitrarily long
121936e227d2STejun Heo  *
1220d185af30SYacine Belkadi  * Note:
1221bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1222e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1223e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1224e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1225bbb68dfaSTejun Heo  *
1226bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1227bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1228bbb68dfaSTejun Heo  *
1229e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1230bf4ede01STejun Heo  */
1231bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1232bbb68dfaSTejun Heo 			       unsigned long *flags)
1233bf4ede01STejun Heo {
1234d565ed63STejun Heo 	struct worker_pool *pool;
1235112202d9STejun Heo 	struct pool_workqueue *pwq;
1236bf4ede01STejun Heo 
1237bbb68dfaSTejun Heo 	local_irq_save(*flags);
1238bbb68dfaSTejun Heo 
123936e227d2STejun Heo 	/* try to steal the timer if it exists */
124036e227d2STejun Heo 	if (is_dwork) {
124136e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
124236e227d2STejun Heo 
1243e0aecdd8STejun Heo 		/*
1244e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1245e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1246e0aecdd8STejun Heo 		 * running on the local CPU.
1247e0aecdd8STejun Heo 		 */
124836e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
124936e227d2STejun Heo 			return 1;
125036e227d2STejun Heo 	}
125136e227d2STejun Heo 
125236e227d2STejun Heo 	/* try to claim PENDING the normal way */
1253bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1254bf4ede01STejun Heo 		return 0;
1255bf4ede01STejun Heo 
1256bf4ede01STejun Heo 	/*
1257bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1258bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1259bf4ede01STejun Heo 	 */
1260d565ed63STejun Heo 	pool = get_work_pool(work);
1261d565ed63STejun Heo 	if (!pool)
1262bbb68dfaSTejun Heo 		goto fail;
1263bf4ede01STejun Heo 
1264d565ed63STejun Heo 	spin_lock(&pool->lock);
1265bf4ede01STejun Heo 	/*
1266112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
1267112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
1268112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
1269112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
1270112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
12710b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
1272bf4ede01STejun Heo 	 */
1273112202d9STejun Heo 	pwq = get_work_pwq(work);
1274112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
1275bf4ede01STejun Heo 		debug_work_deactivate(work);
12763aa62497SLai Jiangshan 
12773aa62497SLai Jiangshan 		/*
127816062836STejun Heo 		 * A delayed work item cannot be grabbed directly because
127916062836STejun Heo 		 * it might have linked NO_COLOR work items which, if left
1280112202d9STejun Heo 		 * on the delayed_list, will confuse pwq->nr_active
128116062836STejun Heo 		 * management later on and cause stall.  Make sure the work
128216062836STejun Heo 		 * item is activated before grabbing.
12833aa62497SLai Jiangshan 		 */
12843aa62497SLai Jiangshan 		if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1285112202d9STejun Heo 			pwq_activate_delayed_work(work);
12863aa62497SLai Jiangshan 
1287bf4ede01STejun Heo 		list_del_init(&work->entry);
12889c34a704SLai Jiangshan 		pwq_dec_nr_in_flight(pwq, get_work_color(work));
128936e227d2STejun Heo 
1290112202d9STejun Heo 		/* work->data points to pwq iff queued, point to pool */
12914468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
12924468a00fSLai Jiangshan 
1293d565ed63STejun Heo 		spin_unlock(&pool->lock);
129436e227d2STejun Heo 		return 1;
1295bf4ede01STejun Heo 	}
1296d565ed63STejun Heo 	spin_unlock(&pool->lock);
1297bbb68dfaSTejun Heo fail:
1298bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1299bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1300bbb68dfaSTejun Heo 		return -ENOENT;
1301bbb68dfaSTejun Heo 	cpu_relax();
130236e227d2STejun Heo 	return -EAGAIN;
1303bf4ede01STejun Heo }
1304bf4ede01STejun Heo 
1305bf4ede01STejun Heo /**
1306706026c2STejun Heo  * insert_work - insert a work into a pool
1307112202d9STejun Heo  * @pwq: pwq @work belongs to
13084690c4abSTejun Heo  * @work: work to insert
13094690c4abSTejun Heo  * @head: insertion point
13104690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
13114690c4abSTejun Heo  *
1312112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
1313706026c2STejun Heo  * work_struct flags.
13144690c4abSTejun Heo  *
13154690c4abSTejun Heo  * CONTEXT:
1316d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1317365970a1SDavid Howells  */
1318112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1319112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
1320b89deed3SOleg Nesterov {
1321112202d9STejun Heo 	struct worker_pool *pool = pwq->pool;
1322e1d8aa9fSFrederic Weisbecker 
13234690c4abSTejun Heo 	/* we own @work, set data and link */
1324112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
13251a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
13268864b4e5STejun Heo 	get_pwq(pwq);
1327e22bee78STejun Heo 
1328e22bee78STejun Heo 	/*
1329c5aa87bbSTejun Heo 	 * Ensure either wq_worker_sleeping() sees the above
1330c5aa87bbSTejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers lying
1331c5aa87bbSTejun Heo 	 * around lazily while there are works to be processed.
1332e22bee78STejun Heo 	 */
1333e22bee78STejun Heo 	smp_mb();
1334e22bee78STejun Heo 
133563d95a91STejun Heo 	if (__need_more_worker(pool))
133663d95a91STejun Heo 		wake_up_worker(pool);
1337b89deed3SOleg Nesterov }
1338b89deed3SOleg Nesterov 
1339c8efcc25STejun Heo /*
1340c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
13418d03ecfeSTejun Heo  * same workqueue.
1342c8efcc25STejun Heo  */
1343c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1344c8efcc25STejun Heo {
1345c8efcc25STejun Heo 	struct worker *worker;
1346c8efcc25STejun Heo 
13478d03ecfeSTejun Heo 	worker = current_wq_worker();
1348c8efcc25STejun Heo 	/*
13498d03ecfeSTejun Heo 	 * Return %true iff I'm a worker execuing a work item on @wq.  If
13508d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
1351c8efcc25STejun Heo 	 */
1352112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
1353c8efcc25STejun Heo }
1354c8efcc25STejun Heo 
1355ef557180SMike Galbraith /*
1356ef557180SMike Galbraith  * When queueing an unbound work item to a wq, prefer local CPU if allowed
1357ef557180SMike Galbraith  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
1358ef557180SMike Galbraith  * avoid perturbing sensitive tasks.
1359ef557180SMike Galbraith  */
1360ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu)
1361ef557180SMike Galbraith {
1362f303fccbSTejun Heo 	static bool printed_dbg_warning;
1363ef557180SMike Galbraith 	int new_cpu;
1364ef557180SMike Galbraith 
1365f303fccbSTejun Heo 	if (likely(!wq_debug_force_rr_cpu)) {
1366ef557180SMike Galbraith 		if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1367ef557180SMike Galbraith 			return cpu;
1368f303fccbSTejun Heo 	} else if (!printed_dbg_warning) {
1369f303fccbSTejun Heo 		pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1370f303fccbSTejun Heo 		printed_dbg_warning = true;
1371f303fccbSTejun Heo 	}
1372f303fccbSTejun Heo 
1373ef557180SMike Galbraith 	if (cpumask_empty(wq_unbound_cpumask))
1374ef557180SMike Galbraith 		return cpu;
1375ef557180SMike Galbraith 
1376ef557180SMike Galbraith 	new_cpu = __this_cpu_read(wq_rr_cpu_last);
1377ef557180SMike Galbraith 	new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1378ef557180SMike Galbraith 	if (unlikely(new_cpu >= nr_cpu_ids)) {
1379ef557180SMike Galbraith 		new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1380ef557180SMike Galbraith 		if (unlikely(new_cpu >= nr_cpu_ids))
1381ef557180SMike Galbraith 			return cpu;
1382ef557180SMike Galbraith 	}
1383ef557180SMike Galbraith 	__this_cpu_write(wq_rr_cpu_last, new_cpu);
1384ef557180SMike Galbraith 
1385ef557180SMike Galbraith 	return new_cpu;
1386ef557180SMike Galbraith }
1387ef557180SMike Galbraith 
1388d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
13891da177e4SLinus Torvalds 			 struct work_struct *work)
13901da177e4SLinus Torvalds {
1391112202d9STejun Heo 	struct pool_workqueue *pwq;
1392c9178087STejun Heo 	struct worker_pool *last_pool;
13931e19ffc6STejun Heo 	struct list_head *worklist;
13948a2e8e5dSTejun Heo 	unsigned int work_flags;
1395b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
13968930cabaSTejun Heo 
13978930cabaSTejun Heo 	/*
13988930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
13998930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
14008930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
14018930cabaSTejun Heo 	 * happen with IRQ disabled.
14028930cabaSTejun Heo 	 */
14038930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
14041da177e4SLinus Torvalds 
1405dc186ad7SThomas Gleixner 	debug_work_activate(work);
14061e19ffc6STejun Heo 
14079ef28a73SLi Bin 	/* if draining, only works from the same workqueue are allowed */
1408618b01ebSTejun Heo 	if (unlikely(wq->flags & __WQ_DRAINING) &&
1409c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1410e41e704bSTejun Heo 		return;
14119e8cd2f5STejun Heo retry:
1412df2d5ae4STejun Heo 	if (req_cpu == WORK_CPU_UNBOUND)
1413ef557180SMike Galbraith 		cpu = wq_select_unbound_cpu(raw_smp_processor_id());
1414df2d5ae4STejun Heo 
1415df2d5ae4STejun Heo 	/* pwq which will be used unless @work is executing elsewhere */
1416df2d5ae4STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
1417c9178087STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1418df2d5ae4STejun Heo 	else
1419df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1420f3421797STejun Heo 
142118aa9effSTejun Heo 	/*
1422c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
1423c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
1424c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
142518aa9effSTejun Heo 	 */
1426c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
1427112202d9STejun Heo 	if (last_pool && last_pool != pwq->pool) {
142818aa9effSTejun Heo 		struct worker *worker;
142918aa9effSTejun Heo 
1430d565ed63STejun Heo 		spin_lock(&last_pool->lock);
143118aa9effSTejun Heo 
1432c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
143318aa9effSTejun Heo 
1434112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
1435c9178087STejun Heo 			pwq = worker->current_pwq;
14368594fadeSLai Jiangshan 		} else {
143718aa9effSTejun Heo 			/* meh... not running there, queue here */
1438d565ed63STejun Heo 			spin_unlock(&last_pool->lock);
1439112202d9STejun Heo 			spin_lock(&pwq->pool->lock);
144018aa9effSTejun Heo 		}
14418930cabaSTejun Heo 	} else {
1442112202d9STejun Heo 		spin_lock(&pwq->pool->lock);
14438930cabaSTejun Heo 	}
1444502ca9d8STejun Heo 
14459e8cd2f5STejun Heo 	/*
14469e8cd2f5STejun Heo 	 * pwq is determined and locked.  For unbound pools, we could have
14479e8cd2f5STejun Heo 	 * raced with pwq release and it could already be dead.  If its
14489e8cd2f5STejun Heo 	 * refcnt is zero, repeat pwq selection.  Note that pwqs never die
1449df2d5ae4STejun Heo 	 * without another pwq replacing it in the numa_pwq_tbl or while
1450df2d5ae4STejun Heo 	 * work items are executing on it, so the retrying is guaranteed to
14519e8cd2f5STejun Heo 	 * make forward-progress.
14529e8cd2f5STejun Heo 	 */
14539e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
14549e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
14559e8cd2f5STejun Heo 			spin_unlock(&pwq->pool->lock);
14569e8cd2f5STejun Heo 			cpu_relax();
14579e8cd2f5STejun Heo 			goto retry;
14589e8cd2f5STejun Heo 		}
14599e8cd2f5STejun Heo 		/* oops */
14609e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
14619e8cd2f5STejun Heo 			  wq->name, cpu);
14629e8cd2f5STejun Heo 	}
14639e8cd2f5STejun Heo 
1464112202d9STejun Heo 	/* pwq determined, queue */
1465112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
1466502ca9d8STejun Heo 
1467f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1468112202d9STejun Heo 		spin_unlock(&pwq->pool->lock);
1469f5b2552bSDan Carpenter 		return;
1470f5b2552bSDan Carpenter 	}
14711e19ffc6STejun Heo 
1472112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
1473112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
14741e19ffc6STejun Heo 
1475112202d9STejun Heo 	if (likely(pwq->nr_active < pwq->max_active)) {
1476cdadf009STejun Heo 		trace_workqueue_activate_work(work);
1477112202d9STejun Heo 		pwq->nr_active++;
1478112202d9STejun Heo 		worklist = &pwq->pool->worklist;
147982607adcSTejun Heo 		if (list_empty(worklist))
148082607adcSTejun Heo 			pwq->pool->watchdog_ts = jiffies;
14818a2e8e5dSTejun Heo 	} else {
14828a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
1483112202d9STejun Heo 		worklist = &pwq->delayed_works;
14848a2e8e5dSTejun Heo 	}
14851e19ffc6STejun Heo 
1486112202d9STejun Heo 	insert_work(pwq, work, worklist, work_flags);
14871e19ffc6STejun Heo 
1488112202d9STejun Heo 	spin_unlock(&pwq->pool->lock);
14891da177e4SLinus Torvalds }
14901da177e4SLinus Torvalds 
14910fcb78c2SRolf Eike Beer /**
1492c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1493c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1494c1a220e7SZhang Rui  * @wq: workqueue to use
1495c1a220e7SZhang Rui  * @work: work to queue
1496c1a220e7SZhang Rui  *
1497c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1498c1a220e7SZhang Rui  * can't go away.
1499d185af30SYacine Belkadi  *
1500d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
1501c1a220e7SZhang Rui  */
1502d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1503d4283e93STejun Heo 		   struct work_struct *work)
1504c1a220e7SZhang Rui {
1505d4283e93STejun Heo 	bool ret = false;
15068930cabaSTejun Heo 	unsigned long flags;
15078930cabaSTejun Heo 
15088930cabaSTejun Heo 	local_irq_save(flags);
1509c1a220e7SZhang Rui 
151022df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
15114690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1512d4283e93STejun Heo 		ret = true;
1513c1a220e7SZhang Rui 	}
15148930cabaSTejun Heo 
15158930cabaSTejun Heo 	local_irq_restore(flags);
1516c1a220e7SZhang Rui 	return ret;
1517c1a220e7SZhang Rui }
1518ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
1519c1a220e7SZhang Rui 
1520d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
15211da177e4SLinus Torvalds {
152252bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
15231da177e4SLinus Torvalds 
1524e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
152560c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
15261da177e4SLinus Torvalds }
15271438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
15281da177e4SLinus Torvalds 
15297beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
153052bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
15311da177e4SLinus Torvalds {
15327beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
15337beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
15341da177e4SLinus Torvalds 
15357beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
15367beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
1537fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1538fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
15397beb2edfSTejun Heo 
15408852aac2STejun Heo 	/*
15418852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
15428852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
15438852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
15448852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
15458852aac2STejun Heo 	 */
15468852aac2STejun Heo 	if (!delay) {
15478852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
15488852aac2STejun Heo 		return;
15498852aac2STejun Heo 	}
15508852aac2STejun Heo 
15517beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
15527beb2edfSTejun Heo 
155360c057bcSLai Jiangshan 	dwork->wq = wq;
15541265057fSTejun Heo 	dwork->cpu = cpu;
15557beb2edfSTejun Heo 	timer->expires = jiffies + delay;
15567beb2edfSTejun Heo 
1557041bd12eSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
15587beb2edfSTejun Heo 		add_timer_on(timer, cpu);
1559041bd12eSTejun Heo 	else
1560041bd12eSTejun Heo 		add_timer(timer);
15617beb2edfSTejun Heo }
15621da177e4SLinus Torvalds 
15630fcb78c2SRolf Eike Beer /**
15640fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
15650fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
15660fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1567af9997e4SRandy Dunlap  * @dwork: work to queue
15680fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
15690fcb78c2SRolf Eike Beer  *
1570d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
1571715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1572715f1300STejun Heo  * execution.
15730fcb78c2SRolf Eike Beer  */
1574d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
157552bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
15767a6bc1cdSVenkatesh Pallipadi {
157752bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1578d4283e93STejun Heo 	bool ret = false;
15798930cabaSTejun Heo 	unsigned long flags;
15808930cabaSTejun Heo 
15818930cabaSTejun Heo 	/* read the comment in __queue_work() */
15828930cabaSTejun Heo 	local_irq_save(flags);
15837a6bc1cdSVenkatesh Pallipadi 
158422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
15857beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1586d4283e93STejun Heo 		ret = true;
15877a6bc1cdSVenkatesh Pallipadi 	}
15888930cabaSTejun Heo 
15898930cabaSTejun Heo 	local_irq_restore(flags);
15907a6bc1cdSVenkatesh Pallipadi 	return ret;
15917a6bc1cdSVenkatesh Pallipadi }
1592ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
15931da177e4SLinus Torvalds 
1594c8e55f36STejun Heo /**
15958376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
15968376fe22STejun Heo  * @cpu: CPU number to execute work on
15978376fe22STejun Heo  * @wq: workqueue to use
15988376fe22STejun Heo  * @dwork: work to queue
15998376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
16008376fe22STejun Heo  *
16018376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
16028376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
16038376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
16048376fe22STejun Heo  * current state.
16058376fe22STejun Heo  *
1606d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
16078376fe22STejun Heo  * pending and its timer was modified.
16088376fe22STejun Heo  *
1609e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
16108376fe22STejun Heo  * See try_to_grab_pending() for details.
16118376fe22STejun Heo  */
16128376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
16138376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
16148376fe22STejun Heo {
16158376fe22STejun Heo 	unsigned long flags;
16168376fe22STejun Heo 	int ret;
16178376fe22STejun Heo 
16188376fe22STejun Heo 	do {
16198376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
16208376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
16218376fe22STejun Heo 
16228376fe22STejun Heo 	if (likely(ret >= 0)) {
16238376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
16248376fe22STejun Heo 		local_irq_restore(flags);
16258376fe22STejun Heo 	}
16268376fe22STejun Heo 
16278376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
16288376fe22STejun Heo 	return ret;
16298376fe22STejun Heo }
16308376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
16318376fe22STejun Heo 
16328376fe22STejun Heo /**
1633c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1634c8e55f36STejun Heo  * @worker: worker which is entering idle state
1635c8e55f36STejun Heo  *
1636c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1637c8e55f36STejun Heo  * necessary.
1638c8e55f36STejun Heo  *
1639c8e55f36STejun Heo  * LOCKING:
1640d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1641c8e55f36STejun Heo  */
1642c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
16431da177e4SLinus Torvalds {
1644bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1645c8e55f36STejun Heo 
16466183c009STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
16476183c009STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
16486183c009STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
16496183c009STejun Heo 		return;
1650c8e55f36STejun Heo 
1651051e1850SLai Jiangshan 	/* can't use worker_set_flags(), also called from create_worker() */
1652cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1653bd7bdd43STejun Heo 	pool->nr_idle++;
1654e22bee78STejun Heo 	worker->last_active = jiffies;
1655c8e55f36STejun Heo 
1656c8e55f36STejun Heo 	/* idle_list is LIFO */
1657bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1658db7bccf4STejun Heo 
165963d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1660628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1661cb444766STejun Heo 
1662544ecf31STejun Heo 	/*
1663706026c2STejun Heo 	 * Sanity check nr_running.  Because wq_unbind_fn() releases
1664d565ed63STejun Heo 	 * pool->lock between setting %WORKER_UNBOUND and zapping
1665628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1666628c78e7STejun Heo 	 * unbind is not in progress.
1667544ecf31STejun Heo 	 */
166824647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1669bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
1670e19e397aSTejun Heo 		     atomic_read(&pool->nr_running));
1671c8e55f36STejun Heo }
1672c8e55f36STejun Heo 
1673c8e55f36STejun Heo /**
1674c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1675c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1676c8e55f36STejun Heo  *
1677c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1678c8e55f36STejun Heo  *
1679c8e55f36STejun Heo  * LOCKING:
1680d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1681c8e55f36STejun Heo  */
1682c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1683c8e55f36STejun Heo {
1684bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1685c8e55f36STejun Heo 
16866183c009STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
16876183c009STejun Heo 		return;
1688d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1689bd7bdd43STejun Heo 	pool->nr_idle--;
1690c8e55f36STejun Heo 	list_del_init(&worker->entry);
1691c8e55f36STejun Heo }
1692c8e55f36STejun Heo 
1693f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
1694c34056a3STejun Heo {
1695c34056a3STejun Heo 	struct worker *worker;
1696c34056a3STejun Heo 
1697f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
1698c8e55f36STejun Heo 	if (worker) {
1699c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1700affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1701da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
1702e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1703e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1704c8e55f36STejun Heo 	}
1705c34056a3STejun Heo 	return worker;
1706c34056a3STejun Heo }
1707c34056a3STejun Heo 
1708c34056a3STejun Heo /**
17094736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
17104736cbf7SLai Jiangshan  * @worker: worker to be attached
17114736cbf7SLai Jiangshan  * @pool: the target pool
17124736cbf7SLai Jiangshan  *
17134736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
17144736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
17154736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
17164736cbf7SLai Jiangshan  */
17174736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
17184736cbf7SLai Jiangshan 				   struct worker_pool *pool)
17194736cbf7SLai Jiangshan {
17204736cbf7SLai Jiangshan 	mutex_lock(&pool->attach_mutex);
17214736cbf7SLai Jiangshan 
17224736cbf7SLai Jiangshan 	/*
17234736cbf7SLai Jiangshan 	 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
17244736cbf7SLai Jiangshan 	 * online CPUs.  It'll be re-applied when any of the CPUs come up.
17254736cbf7SLai Jiangshan 	 */
17264736cbf7SLai Jiangshan 	set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
17274736cbf7SLai Jiangshan 
17284736cbf7SLai Jiangshan 	/*
17294736cbf7SLai Jiangshan 	 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
17304736cbf7SLai Jiangshan 	 * stable across this function.  See the comments above the
17314736cbf7SLai Jiangshan 	 * flag definition for details.
17324736cbf7SLai Jiangshan 	 */
17334736cbf7SLai Jiangshan 	if (pool->flags & POOL_DISASSOCIATED)
17344736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
17354736cbf7SLai Jiangshan 
17364736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
17374736cbf7SLai Jiangshan 
17384736cbf7SLai Jiangshan 	mutex_unlock(&pool->attach_mutex);
17394736cbf7SLai Jiangshan }
17404736cbf7SLai Jiangshan 
17414736cbf7SLai Jiangshan /**
174260f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
174360f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
174460f5a4bcSLai Jiangshan  * @pool: the pool @worker is attached to
174560f5a4bcSLai Jiangshan  *
17464736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
17474736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
17484736cbf7SLai Jiangshan  * other reference to the pool.
174960f5a4bcSLai Jiangshan  */
175060f5a4bcSLai Jiangshan static void worker_detach_from_pool(struct worker *worker,
175160f5a4bcSLai Jiangshan 				    struct worker_pool *pool)
175260f5a4bcSLai Jiangshan {
175360f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
175460f5a4bcSLai Jiangshan 
175592f9c5c4SLai Jiangshan 	mutex_lock(&pool->attach_mutex);
1756da028469SLai Jiangshan 	list_del(&worker->node);
1757da028469SLai Jiangshan 	if (list_empty(&pool->workers))
175860f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
175992f9c5c4SLai Jiangshan 	mutex_unlock(&pool->attach_mutex);
176060f5a4bcSLai Jiangshan 
1761b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
1762b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1763b62c0751SLai Jiangshan 
176460f5a4bcSLai Jiangshan 	if (detach_completion)
176560f5a4bcSLai Jiangshan 		complete(detach_completion);
176660f5a4bcSLai Jiangshan }
176760f5a4bcSLai Jiangshan 
176860f5a4bcSLai Jiangshan /**
1769c34056a3STejun Heo  * create_worker - create a new workqueue worker
177063d95a91STejun Heo  * @pool: pool the new worker will belong to
1771c34056a3STejun Heo  *
1772051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
1773c34056a3STejun Heo  *
1774c34056a3STejun Heo  * CONTEXT:
1775c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1776c34056a3STejun Heo  *
1777d185af30SYacine Belkadi  * Return:
1778c34056a3STejun Heo  * Pointer to the newly created worker.
1779c34056a3STejun Heo  */
1780bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1781c34056a3STejun Heo {
1782c34056a3STejun Heo 	struct worker *worker = NULL;
1783f3421797STejun Heo 	int id = -1;
1784e3c916a4STejun Heo 	char id_buf[16];
1785c34056a3STejun Heo 
17867cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
17877cda9aaeSLai Jiangshan 	id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
1788822d8405STejun Heo 	if (id < 0)
1789c34056a3STejun Heo 		goto fail;
1790c34056a3STejun Heo 
1791f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
1792c34056a3STejun Heo 	if (!worker)
1793c34056a3STejun Heo 		goto fail;
1794c34056a3STejun Heo 
1795bd7bdd43STejun Heo 	worker->pool = pool;
1796c34056a3STejun Heo 	worker->id = id;
1797c34056a3STejun Heo 
179829c91e99STejun Heo 	if (pool->cpu >= 0)
1799e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1800e3c916a4STejun Heo 			 pool->attrs->nice < 0  ? "H" : "");
1801f3421797STejun Heo 	else
1802e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1803e3c916a4STejun Heo 
1804f3f90ad4STejun Heo 	worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1805e3c916a4STejun Heo 					      "kworker/%s", id_buf);
1806c34056a3STejun Heo 	if (IS_ERR(worker->task))
1807c34056a3STejun Heo 		goto fail;
1808c34056a3STejun Heo 
180991151228SOleg Nesterov 	set_user_nice(worker->task, pool->attrs->nice);
181025834c73SPeter Zijlstra 	kthread_bind_mask(worker->task, pool->attrs->cpumask);
181191151228SOleg Nesterov 
1812da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
18134736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
1814822d8405STejun Heo 
1815051e1850SLai Jiangshan 	/* start the newly created worker */
1816051e1850SLai Jiangshan 	spin_lock_irq(&pool->lock);
1817051e1850SLai Jiangshan 	worker->pool->nr_workers++;
1818051e1850SLai Jiangshan 	worker_enter_idle(worker);
1819051e1850SLai Jiangshan 	wake_up_process(worker->task);
1820051e1850SLai Jiangshan 	spin_unlock_irq(&pool->lock);
1821051e1850SLai Jiangshan 
1822c34056a3STejun Heo 	return worker;
1823822d8405STejun Heo 
1824c34056a3STejun Heo fail:
18259625ab17SLai Jiangshan 	if (id >= 0)
18267cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, id);
1827c34056a3STejun Heo 	kfree(worker);
1828c34056a3STejun Heo 	return NULL;
1829c34056a3STejun Heo }
1830c34056a3STejun Heo 
1831c34056a3STejun Heo /**
1832c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1833c34056a3STejun Heo  * @worker: worker to be destroyed
1834c34056a3STejun Heo  *
183573eb7fe7SLai Jiangshan  * Destroy @worker and adjust @pool stats accordingly.  The worker should
183673eb7fe7SLai Jiangshan  * be idle.
1837c8e55f36STejun Heo  *
1838c8e55f36STejun Heo  * CONTEXT:
183960f5a4bcSLai Jiangshan  * spin_lock_irq(pool->lock).
1840c34056a3STejun Heo  */
1841c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1842c34056a3STejun Heo {
1843bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1844c34056a3STejun Heo 
1845cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
1846cd549687STejun Heo 
1847c34056a3STejun Heo 	/* sanity check frenzy */
18486183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
184973eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
185073eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
18516183c009STejun Heo 		return;
1852c34056a3STejun Heo 
1853bd7bdd43STejun Heo 	pool->nr_workers--;
1854bd7bdd43STejun Heo 	pool->nr_idle--;
1855c8e55f36STejun Heo 
1856c8e55f36STejun Heo 	list_del_init(&worker->entry);
1857cb444766STejun Heo 	worker->flags |= WORKER_DIE;
185860f5a4bcSLai Jiangshan 	wake_up_process(worker->task);
1859c34056a3STejun Heo }
1860c34056a3STejun Heo 
186163d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1862e22bee78STejun Heo {
186363d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1864e22bee78STejun Heo 
1865d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1866e22bee78STejun Heo 
18673347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
1868e22bee78STejun Heo 		struct worker *worker;
1869e22bee78STejun Heo 		unsigned long expires;
1870e22bee78STejun Heo 
1871e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
187263d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1873e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1874e22bee78STejun Heo 
18753347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
187663d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
18773347fc9fSLai Jiangshan 			break;
1878e22bee78STejun Heo 		}
18793347fc9fSLai Jiangshan 
18803347fc9fSLai Jiangshan 		destroy_worker(worker);
1881e22bee78STejun Heo 	}
1882e22bee78STejun Heo 
1883d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
1884e22bee78STejun Heo }
1885e22bee78STejun Heo 
1886493a1724STejun Heo static void send_mayday(struct work_struct *work)
1887e22bee78STejun Heo {
1888112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1889112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
1890493a1724STejun Heo 
18912e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
1892e22bee78STejun Heo 
1893493008a8STejun Heo 	if (!wq->rescuer)
1894493a1724STejun Heo 		return;
1895e22bee78STejun Heo 
1896e22bee78STejun Heo 	/* mayday mayday mayday */
1897493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
189877668c8bSLai Jiangshan 		/*
189977668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
190077668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
190177668c8bSLai Jiangshan 		 * rescuer is done with it.
190277668c8bSLai Jiangshan 		 */
190377668c8bSLai Jiangshan 		get_pwq(pwq);
1904493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
1905e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1906493a1724STejun Heo 	}
1907e22bee78STejun Heo }
1908e22bee78STejun Heo 
1909706026c2STejun Heo static void pool_mayday_timeout(unsigned long __pool)
1910e22bee78STejun Heo {
191163d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1912e22bee78STejun Heo 	struct work_struct *work;
1913e22bee78STejun Heo 
1914b2d82909STejun Heo 	spin_lock_irq(&pool->lock);
1915b2d82909STejun Heo 	spin_lock(&wq_mayday_lock);		/* for wq->maydays */
1916e22bee78STejun Heo 
191763d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1918e22bee78STejun Heo 		/*
1919e22bee78STejun Heo 		 * We've been trying to create a new worker but
1920e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1921e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1922e22bee78STejun Heo 		 * rescuers.
1923e22bee78STejun Heo 		 */
192463d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1925e22bee78STejun Heo 			send_mayday(work);
1926e22bee78STejun Heo 	}
1927e22bee78STejun Heo 
1928b2d82909STejun Heo 	spin_unlock(&wq_mayday_lock);
1929b2d82909STejun Heo 	spin_unlock_irq(&pool->lock);
1930e22bee78STejun Heo 
193163d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1932e22bee78STejun Heo }
1933e22bee78STejun Heo 
1934e22bee78STejun Heo /**
1935e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
193663d95a91STejun Heo  * @pool: pool to create a new worker for
1937e22bee78STejun Heo  *
193863d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1939e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1940e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
194163d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1942e22bee78STejun Heo  * possible allocation deadlock.
1943e22bee78STejun Heo  *
1944c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
1945c5aa87bbSTejun Heo  * may_start_working() %true.
1946e22bee78STejun Heo  *
1947e22bee78STejun Heo  * LOCKING:
1948d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
1949e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1950e22bee78STejun Heo  * manager.
1951e22bee78STejun Heo  */
195229187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool)
1953d565ed63STejun Heo __releases(&pool->lock)
1954d565ed63STejun Heo __acquires(&pool->lock)
1955e22bee78STejun Heo {
1956e22bee78STejun Heo restart:
1957d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
19589f9c2364STejun Heo 
1959e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
196063d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1961e22bee78STejun Heo 
1962e22bee78STejun Heo 	while (true) {
1963051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
1964e22bee78STejun Heo 			break;
1965e22bee78STejun Heo 
1966e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
19679f9c2364STejun Heo 
196863d95a91STejun Heo 		if (!need_to_create_worker(pool))
1969e22bee78STejun Heo 			break;
1970e22bee78STejun Heo 	}
1971e22bee78STejun Heo 
197263d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1973d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1974051e1850SLai Jiangshan 	/*
1975051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
1976051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
1977051e1850SLai Jiangshan 	 * already become busy.
1978051e1850SLai Jiangshan 	 */
197963d95a91STejun Heo 	if (need_to_create_worker(pool))
1980e22bee78STejun Heo 		goto restart;
1981e22bee78STejun Heo }
1982e22bee78STejun Heo 
1983e22bee78STejun Heo /**
1984e22bee78STejun Heo  * manage_workers - manage worker pool
1985e22bee78STejun Heo  * @worker: self
1986e22bee78STejun Heo  *
1987706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
1988e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1989706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
1990e22bee78STejun Heo  *
1991e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
1992e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
1993e22bee78STejun Heo  * and may_start_working() is true.
1994e22bee78STejun Heo  *
1995e22bee78STejun Heo  * CONTEXT:
1996d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
1997e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
1998e22bee78STejun Heo  *
1999d185af30SYacine Belkadi  * Return:
200029187a9eSTejun Heo  * %false if the pool doesn't need management and the caller can safely
200129187a9eSTejun Heo  * start processing works, %true if management function was performed and
200229187a9eSTejun Heo  * the conditions that the caller verified before calling the function may
200329187a9eSTejun Heo  * no longer be true.
2004e22bee78STejun Heo  */
2005e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2006e22bee78STejun Heo {
200763d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2008e22bee78STejun Heo 
2009bc3a1afcSTejun Heo 	/*
2010bc3a1afcSTejun Heo 	 * Anyone who successfully grabs manager_arb wins the arbitration
2011bc3a1afcSTejun Heo 	 * and becomes the manager.  mutex_trylock() on pool->manager_arb
2012bc3a1afcSTejun Heo 	 * failure while holding pool->lock reliably indicates that someone
2013bc3a1afcSTejun Heo 	 * else is managing the pool and the worker which failed trylock
2014bc3a1afcSTejun Heo 	 * can proceed to executing work items.  This means that anyone
2015bc3a1afcSTejun Heo 	 * grabbing manager_arb is responsible for actually performing
2016bc3a1afcSTejun Heo 	 * manager duties.  If manager_arb is grabbed and released without
2017bc3a1afcSTejun Heo 	 * actual management, the pool may stall indefinitely.
2018bc3a1afcSTejun Heo 	 */
201934a06bd6STejun Heo 	if (!mutex_trylock(&pool->manager_arb))
202029187a9eSTejun Heo 		return false;
20212607d7a6STejun Heo 	pool->manager = worker;
2022e22bee78STejun Heo 
202329187a9eSTejun Heo 	maybe_create_worker(pool);
2024e22bee78STejun Heo 
20252607d7a6STejun Heo 	pool->manager = NULL;
202634a06bd6STejun Heo 	mutex_unlock(&pool->manager_arb);
202729187a9eSTejun Heo 	return true;
2028e22bee78STejun Heo }
2029e22bee78STejun Heo 
2030a62428c0STejun Heo /**
2031a62428c0STejun Heo  * process_one_work - process single work
2032c34056a3STejun Heo  * @worker: self
2033a62428c0STejun Heo  * @work: work to process
2034a62428c0STejun Heo  *
2035a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2036a62428c0STejun Heo  * process a single work including synchronization against and
2037a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2038a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2039a62428c0STejun Heo  * call this function to process a work.
2040a62428c0STejun Heo  *
2041a62428c0STejun Heo  * CONTEXT:
2042d565ed63STejun Heo  * spin_lock_irq(pool->lock) which is released and regrabbed.
2043a62428c0STejun Heo  */
2044c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
2045d565ed63STejun Heo __releases(&pool->lock)
2046d565ed63STejun Heo __acquires(&pool->lock)
20471da177e4SLinus Torvalds {
2048112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2049bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2050112202d9STejun Heo 	bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
205173f53c4aSTejun Heo 	int work_color;
20527e11629dSTejun Heo 	struct worker *collision;
20534e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
20544e6045f1SJohannes Berg 	/*
2055a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2056a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2057a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2058a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2059a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
20604e6045f1SJohannes Berg 	 */
20614d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
20624d82a1deSPeter Zijlstra 
20634d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
20644e6045f1SJohannes Berg #endif
2065807407c0SLai Jiangshan 	/* ensure we're on the correct CPU */
206685327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
2067ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
206825511a47STejun Heo 
20697e11629dSTejun Heo 	/*
20707e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
20717e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
20727e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
20737e11629dSTejun Heo 	 * currently executing one.
20747e11629dSTejun Heo 	 */
2075c9e7cf27STejun Heo 	collision = find_worker_executing_work(pool, work);
20767e11629dSTejun Heo 	if (unlikely(collision)) {
20777e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
20787e11629dSTejun Heo 		return;
20797e11629dSTejun Heo 	}
20801da177e4SLinus Torvalds 
20818930cabaSTejun Heo 	/* claim and dequeue */
20821da177e4SLinus Torvalds 	debug_work_deactivate(work);
2083c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2084c34056a3STejun Heo 	worker->current_work = work;
2085a2c1c57bSTejun Heo 	worker->current_func = work->func;
2086112202d9STejun Heo 	worker->current_pwq = pwq;
208773f53c4aSTejun Heo 	work_color = get_work_color(work);
20887a22ad75STejun Heo 
2089a62428c0STejun Heo 	list_del_init(&work->entry);
2090a62428c0STejun Heo 
2091649027d7STejun Heo 	/*
2092228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
2093228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
2094228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
2095228f1d00SLai Jiangshan 	 * execution of the pending work items.
2096fb0e7bebSTejun Heo 	 */
2097fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2098228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
2099fb0e7bebSTejun Heo 
2100974271c4STejun Heo 	/*
2101a489a03eSLai Jiangshan 	 * Wake up another worker if necessary.  The condition is always
2102a489a03eSLai Jiangshan 	 * false for normal per-cpu workers since nr_running would always
2103a489a03eSLai Jiangshan 	 * be >= 1 at this point.  This is used to chain execution of the
2104a489a03eSLai Jiangshan 	 * pending work items for WORKER_NOT_RUNNING workers such as the
2105228f1d00SLai Jiangshan 	 * UNBOUND and CPU_INTENSIVE ones.
2106974271c4STejun Heo 	 */
2107a489a03eSLai Jiangshan 	if (need_more_worker(pool))
210863d95a91STejun Heo 		wake_up_worker(pool);
2109974271c4STejun Heo 
21108930cabaSTejun Heo 	/*
21117c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
2112d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
211323657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
211423657bb1STejun Heo 	 * disabled.
21158930cabaSTejun Heo 	 */
21167c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
21171da177e4SLinus Torvalds 
2118d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2119365970a1SDavid Howells 
2120112202d9STejun Heo 	lock_map_acquire_read(&pwq->wq->lockdep_map);
21213295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2122e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2123a2c1c57bSTejun Heo 	worker->current_func(work);
2124e36c886aSArjan van de Ven 	/*
2125e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2126e36c886aSArjan van de Ven 	 * point will only record its address.
2127e36c886aSArjan van de Ven 	 */
2128e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
21293295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
2130112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
21311da177e4SLinus Torvalds 
2132d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2133044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2134044c782cSValentin Ilie 		       "     last function: %pf\n",
2135a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2136a2c1c57bSTejun Heo 		       worker->current_func);
2137d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2138d5abe669SPeter Zijlstra 		dump_stack();
2139d5abe669SPeter Zijlstra 	}
2140d5abe669SPeter Zijlstra 
2141b22ce278STejun Heo 	/*
2142b22ce278STejun Heo 	 * The following prevents a kworker from hogging CPU on !PREEMPT
2143b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
2144b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
2145b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
2146789cbbecSJoe Lawrence 	 * stop_machine. At the same time, report a quiescent RCU state so
2147789cbbecSJoe Lawrence 	 * the same condition doesn't freeze RCU.
2148b22ce278STejun Heo 	 */
21493e28e377SJoe Lawrence 	cond_resched_rcu_qs();
2150b22ce278STejun Heo 
2151d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2152a62428c0STejun Heo 
2153fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2154fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2155fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2156fb0e7bebSTejun Heo 
2157a62428c0STejun Heo 	/* we're done with it, release */
215842f8570fSSasha Levin 	hash_del(&worker->hentry);
2159c34056a3STejun Heo 	worker->current_work = NULL;
2160a2c1c57bSTejun Heo 	worker->current_func = NULL;
2161112202d9STejun Heo 	worker->current_pwq = NULL;
21623d1cb205STejun Heo 	worker->desc_valid = false;
2163112202d9STejun Heo 	pwq_dec_nr_in_flight(pwq, work_color);
21641da177e4SLinus Torvalds }
21651da177e4SLinus Torvalds 
2166affee4b2STejun Heo /**
2167affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2168affee4b2STejun Heo  * @worker: self
2169affee4b2STejun Heo  *
2170affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2171affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2172affee4b2STejun Heo  * fetches a work from the top and executes it.
2173affee4b2STejun Heo  *
2174affee4b2STejun Heo  * CONTEXT:
2175d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2176affee4b2STejun Heo  * multiple times.
2177affee4b2STejun Heo  */
2178affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
21791da177e4SLinus Torvalds {
2180affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2181affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2182a62428c0STejun Heo 						struct work_struct, entry);
2183c34056a3STejun Heo 		process_one_work(worker, work);
2184a62428c0STejun Heo 	}
21851da177e4SLinus Torvalds }
21861da177e4SLinus Torvalds 
21874690c4abSTejun Heo /**
21884690c4abSTejun Heo  * worker_thread - the worker thread function
2189c34056a3STejun Heo  * @__worker: self
21904690c4abSTejun Heo  *
2191c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
2192c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
2193c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
2194c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
2195c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
2196d185af30SYacine Belkadi  *
2197d185af30SYacine Belkadi  * Return: 0
21984690c4abSTejun Heo  */
2199c34056a3STejun Heo static int worker_thread(void *__worker)
22001da177e4SLinus Torvalds {
2201c34056a3STejun Heo 	struct worker *worker = __worker;
2202bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
22031da177e4SLinus Torvalds 
2204e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2205e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2206c8e55f36STejun Heo woke_up:
2207d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2208affee4b2STejun Heo 
2209a9ab775bSTejun Heo 	/* am I supposed to die? */
2210a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
2211d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
2212a9ab775bSTejun Heo 		WARN_ON_ONCE(!list_empty(&worker->entry));
2213e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
221460f5a4bcSLai Jiangshan 
221560f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
22167cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, worker->id);
221760f5a4bcSLai Jiangshan 		worker_detach_from_pool(worker, pool);
221860f5a4bcSLai Jiangshan 		kfree(worker);
2219c8e55f36STejun Heo 		return 0;
2220c8e55f36STejun Heo 	}
2221c8e55f36STejun Heo 
2222c8e55f36STejun Heo 	worker_leave_idle(worker);
2223db7bccf4STejun Heo recheck:
2224e22bee78STejun Heo 	/* no more worker necessary? */
222563d95a91STejun Heo 	if (!need_more_worker(pool))
2226e22bee78STejun Heo 		goto sleep;
2227e22bee78STejun Heo 
2228e22bee78STejun Heo 	/* do we need to manage? */
222963d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2230e22bee78STejun Heo 		goto recheck;
2231e22bee78STejun Heo 
2232c8e55f36STejun Heo 	/*
2233c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2234c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2235c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2236c8e55f36STejun Heo 	 */
22376183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
2238c8e55f36STejun Heo 
2239e22bee78STejun Heo 	/*
2240a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
2241a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
2242a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
2243a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
2244a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
2245e22bee78STejun Heo 	 */
2246a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2247e22bee78STejun Heo 
2248e22bee78STejun Heo 	do {
2249affee4b2STejun Heo 		struct work_struct *work =
2250bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2251affee4b2STejun Heo 					 struct work_struct, entry);
2252affee4b2STejun Heo 
225382607adcSTejun Heo 		pool->watchdog_ts = jiffies;
225482607adcSTejun Heo 
2255c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2256affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2257affee4b2STejun Heo 			process_one_work(worker, work);
2258affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2259affee4b2STejun Heo 				process_scheduled_works(worker);
2260affee4b2STejun Heo 		} else {
2261c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2262affee4b2STejun Heo 			process_scheduled_works(worker);
2263affee4b2STejun Heo 		}
226463d95a91STejun Heo 	} while (keep_working(pool));
2265affee4b2STejun Heo 
2266228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
2267d313dd85STejun Heo sleep:
2268c8e55f36STejun Heo 	/*
2269d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
2270d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
2271d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
2272d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
2273d565ed63STejun Heo 	 * event.
2274c8e55f36STejun Heo 	 */
2275c8e55f36STejun Heo 	worker_enter_idle(worker);
2276c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
2277d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
22781da177e4SLinus Torvalds 	schedule();
2279c8e55f36STejun Heo 	goto woke_up;
22801da177e4SLinus Torvalds }
22811da177e4SLinus Torvalds 
2282e22bee78STejun Heo /**
2283e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2284111c225aSTejun Heo  * @__rescuer: self
2285e22bee78STejun Heo  *
2286e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2287493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
2288e22bee78STejun Heo  *
2289706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
2290e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2291e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2292e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2293e22bee78STejun Heo  * the problem rescuer solves.
2294e22bee78STejun Heo  *
2295706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
2296706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
2297e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2298e22bee78STejun Heo  *
2299e22bee78STejun Heo  * This should happen rarely.
2300d185af30SYacine Belkadi  *
2301d185af30SYacine Belkadi  * Return: 0
2302e22bee78STejun Heo  */
2303111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2304e22bee78STejun Heo {
2305111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2306111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2307e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
23084d595b86SLai Jiangshan 	bool should_stop;
2309e22bee78STejun Heo 
2310e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2311111c225aSTejun Heo 
2312111c225aSTejun Heo 	/*
2313111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2314111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2315111c225aSTejun Heo 	 */
2316111c225aSTejun Heo 	rescuer->task->flags |= PF_WQ_WORKER;
2317e22bee78STejun Heo repeat:
2318e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
23191da177e4SLinus Torvalds 
23204d595b86SLai Jiangshan 	/*
23214d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
23224d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
23234d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
23244d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
23254d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
23264d595b86SLai Jiangshan 	 * list is always empty on exit.
23274d595b86SLai Jiangshan 	 */
23284d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
23291da177e4SLinus Torvalds 
2330493a1724STejun Heo 	/* see whether any pwq is asking for help */
23312e109a28STejun Heo 	spin_lock_irq(&wq_mayday_lock);
2332493a1724STejun Heo 
2333493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
2334493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2335493a1724STejun Heo 					struct pool_workqueue, mayday_node);
2336112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
2337e22bee78STejun Heo 		struct work_struct *work, *n;
233882607adcSTejun Heo 		bool first = true;
2339e22bee78STejun Heo 
2340e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2341493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
2342493a1724STejun Heo 
23432e109a28STejun Heo 		spin_unlock_irq(&wq_mayday_lock);
2344e22bee78STejun Heo 
234551697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
234651697d39SLai Jiangshan 
234751697d39SLai Jiangshan 		spin_lock_irq(&pool->lock);
2348b3104104SLai Jiangshan 		rescuer->pool = pool;
2349e22bee78STejun Heo 
2350e22bee78STejun Heo 		/*
2351e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2352e22bee78STejun Heo 		 * process'em.
2353e22bee78STejun Heo 		 */
23540479c8c5STejun Heo 		WARN_ON_ONCE(!list_empty(scheduled));
235582607adcSTejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry) {
235682607adcSTejun Heo 			if (get_work_pwq(work) == pwq) {
235782607adcSTejun Heo 				if (first)
235882607adcSTejun Heo 					pool->watchdog_ts = jiffies;
2359e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
236082607adcSTejun Heo 			}
236182607adcSTejun Heo 			first = false;
236282607adcSTejun Heo 		}
2363e22bee78STejun Heo 
2364008847f6SNeilBrown 		if (!list_empty(scheduled)) {
2365e22bee78STejun Heo 			process_scheduled_works(rescuer);
23667576958aSTejun Heo 
23677576958aSTejun Heo 			/*
2368008847f6SNeilBrown 			 * The above execution of rescued work items could
2369008847f6SNeilBrown 			 * have created more to rescue through
2370008847f6SNeilBrown 			 * pwq_activate_first_delayed() or chained
2371008847f6SNeilBrown 			 * queueing.  Let's put @pwq back on mayday list so
2372008847f6SNeilBrown 			 * that such back-to-back work items, which may be
2373008847f6SNeilBrown 			 * being used to relieve memory pressure, don't
2374008847f6SNeilBrown 			 * incur MAYDAY_INTERVAL delay inbetween.
2375008847f6SNeilBrown 			 */
2376008847f6SNeilBrown 			if (need_to_create_worker(pool)) {
2377008847f6SNeilBrown 				spin_lock(&wq_mayday_lock);
2378008847f6SNeilBrown 				get_pwq(pwq);
2379008847f6SNeilBrown 				list_move_tail(&pwq->mayday_node, &wq->maydays);
2380008847f6SNeilBrown 				spin_unlock(&wq_mayday_lock);
2381008847f6SNeilBrown 			}
2382008847f6SNeilBrown 		}
2383008847f6SNeilBrown 
2384008847f6SNeilBrown 		/*
238577668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
238613b1d625SLai Jiangshan 		 * go away while we're still attached to it.
238777668c8bSLai Jiangshan 		 */
238877668c8bSLai Jiangshan 		put_pwq(pwq);
238977668c8bSLai Jiangshan 
239077668c8bSLai Jiangshan 		/*
2391d8ca83e6SLai Jiangshan 		 * Leave this pool.  If need_more_worker() is %true, notify a
23927576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
23937576958aSTejun Heo 		 * and stalling the execution.
23947576958aSTejun Heo 		 */
2395d8ca83e6SLai Jiangshan 		if (need_more_worker(pool))
239663d95a91STejun Heo 			wake_up_worker(pool);
23977576958aSTejun Heo 
2398b3104104SLai Jiangshan 		rescuer->pool = NULL;
239913b1d625SLai Jiangshan 		spin_unlock_irq(&pool->lock);
240013b1d625SLai Jiangshan 
240113b1d625SLai Jiangshan 		worker_detach_from_pool(rescuer, pool);
240213b1d625SLai Jiangshan 
240313b1d625SLai Jiangshan 		spin_lock_irq(&wq_mayday_lock);
24041da177e4SLinus Torvalds 	}
24051da177e4SLinus Torvalds 
24062e109a28STejun Heo 	spin_unlock_irq(&wq_mayday_lock);
2407493a1724STejun Heo 
24084d595b86SLai Jiangshan 	if (should_stop) {
24094d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
24104d595b86SLai Jiangshan 		rescuer->task->flags &= ~PF_WQ_WORKER;
24114d595b86SLai Jiangshan 		return 0;
24124d595b86SLai Jiangshan 	}
24134d595b86SLai Jiangshan 
2414111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2415111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2416e22bee78STejun Heo 	schedule();
2417e22bee78STejun Heo 	goto repeat;
24181da177e4SLinus Torvalds }
24191da177e4SLinus Torvalds 
2420fca839c0STejun Heo /**
2421fca839c0STejun Heo  * check_flush_dependency - check for flush dependency sanity
2422fca839c0STejun Heo  * @target_wq: workqueue being flushed
2423fca839c0STejun Heo  * @target_work: work item being flushed (NULL for workqueue flushes)
2424fca839c0STejun Heo  *
2425fca839c0STejun Heo  * %current is trying to flush the whole @target_wq or @target_work on it.
2426fca839c0STejun Heo  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2427fca839c0STejun Heo  * reclaiming memory or running on a workqueue which doesn't have
2428fca839c0STejun Heo  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2429fca839c0STejun Heo  * a deadlock.
2430fca839c0STejun Heo  */
2431fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq,
2432fca839c0STejun Heo 				   struct work_struct *target_work)
2433fca839c0STejun Heo {
2434fca839c0STejun Heo 	work_func_t target_func = target_work ? target_work->func : NULL;
2435fca839c0STejun Heo 	struct worker *worker;
2436fca839c0STejun Heo 
2437fca839c0STejun Heo 	if (target_wq->flags & WQ_MEM_RECLAIM)
2438fca839c0STejun Heo 		return;
2439fca839c0STejun Heo 
2440fca839c0STejun Heo 	worker = current_wq_worker();
2441fca839c0STejun Heo 
2442fca839c0STejun Heo 	WARN_ONCE(current->flags & PF_MEMALLOC,
2443fca839c0STejun Heo 		  "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2444fca839c0STejun Heo 		  current->pid, current->comm, target_wq->name, target_func);
244523d11a58STejun Heo 	WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
244623d11a58STejun Heo 			      (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
2447fca839c0STejun Heo 		  "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2448fca839c0STejun Heo 		  worker->current_pwq->wq->name, worker->current_func,
2449fca839c0STejun Heo 		  target_wq->name, target_func);
2450fca839c0STejun Heo }
2451fca839c0STejun Heo 
2452fc2e4d70SOleg Nesterov struct wq_barrier {
2453fc2e4d70SOleg Nesterov 	struct work_struct	work;
2454fc2e4d70SOleg Nesterov 	struct completion	done;
24552607d7a6STejun Heo 	struct task_struct	*task;	/* purely informational */
2456fc2e4d70SOleg Nesterov };
2457fc2e4d70SOleg Nesterov 
2458fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2459fc2e4d70SOleg Nesterov {
2460fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2461fc2e4d70SOleg Nesterov 	complete(&barr->done);
2462fc2e4d70SOleg Nesterov }
2463fc2e4d70SOleg Nesterov 
24644690c4abSTejun Heo /**
24654690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
2466112202d9STejun Heo  * @pwq: pwq to insert barrier into
24674690c4abSTejun Heo  * @barr: wq_barrier to insert
2468affee4b2STejun Heo  * @target: target work to attach @barr to
2469affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24704690c4abSTejun Heo  *
2471affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2472affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2473affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2474affee4b2STejun Heo  * cpu.
2475affee4b2STejun Heo  *
2476affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2477affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2478affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2479affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2480affee4b2STejun Heo  * after a work with LINKED flag set.
2481affee4b2STejun Heo  *
2482affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2483112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
24844690c4abSTejun Heo  *
24854690c4abSTejun Heo  * CONTEXT:
2486d565ed63STejun Heo  * spin_lock_irq(pool->lock).
24874690c4abSTejun Heo  */
2488112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
2489affee4b2STejun Heo 			      struct wq_barrier *barr,
2490affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2491fc2e4d70SOleg Nesterov {
2492affee4b2STejun Heo 	struct list_head *head;
2493affee4b2STejun Heo 	unsigned int linked = 0;
2494affee4b2STejun Heo 
2495dc186ad7SThomas Gleixner 	/*
2496d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
2497dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2498dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2499dc186ad7SThomas Gleixner 	 * might deadlock.
2500dc186ad7SThomas Gleixner 	 */
2501ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
250222df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2503fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
25042607d7a6STejun Heo 	barr->task = current;
250583c22520SOleg Nesterov 
2506affee4b2STejun Heo 	/*
2507affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2508affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2509affee4b2STejun Heo 	 */
2510affee4b2STejun Heo 	if (worker)
2511affee4b2STejun Heo 		head = worker->scheduled.next;
2512affee4b2STejun Heo 	else {
2513affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2514affee4b2STejun Heo 
2515affee4b2STejun Heo 		head = target->entry.next;
2516affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2517affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2518affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2519affee4b2STejun Heo 	}
2520affee4b2STejun Heo 
2521dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2522112202d9STejun Heo 	insert_work(pwq, &barr->work, head,
2523affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2524fc2e4d70SOleg Nesterov }
2525fc2e4d70SOleg Nesterov 
252673f53c4aSTejun Heo /**
2527112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
252873f53c4aSTejun Heo  * @wq: workqueue being flushed
252973f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
253073f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
253173f53c4aSTejun Heo  *
2532112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
253373f53c4aSTejun Heo  *
2534112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
2535112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
2536112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
2537112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
2538112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
253973f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
254073f53c4aSTejun Heo  *
254173f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
254273f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
254373f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
254473f53c4aSTejun Heo  * is returned.
254573f53c4aSTejun Heo  *
2546112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
254773f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
254873f53c4aSTejun Heo  * advanced to @work_color.
254973f53c4aSTejun Heo  *
255073f53c4aSTejun Heo  * CONTEXT:
25513c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
255273f53c4aSTejun Heo  *
2553d185af30SYacine Belkadi  * Return:
255473f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
255573f53c4aSTejun Heo  * otherwise.
255673f53c4aSTejun Heo  */
2557112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
255873f53c4aSTejun Heo 				      int flush_color, int work_color)
25591da177e4SLinus Torvalds {
256073f53c4aSTejun Heo 	bool wait = false;
256149e3cf44STejun Heo 	struct pool_workqueue *pwq;
25621da177e4SLinus Torvalds 
256373f53c4aSTejun Heo 	if (flush_color >= 0) {
25646183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2565112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
2566dc186ad7SThomas Gleixner 	}
256714441960SOleg Nesterov 
256849e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2569112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
25701da177e4SLinus Torvalds 
2571b09f4fd3SLai Jiangshan 		spin_lock_irq(&pool->lock);
257273f53c4aSTejun Heo 
257373f53c4aSTejun Heo 		if (flush_color >= 0) {
25746183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
257573f53c4aSTejun Heo 
2576112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
2577112202d9STejun Heo 				pwq->flush_color = flush_color;
2578112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
257973f53c4aSTejun Heo 				wait = true;
25801da177e4SLinus Torvalds 			}
258173f53c4aSTejun Heo 		}
258273f53c4aSTejun Heo 
258373f53c4aSTejun Heo 		if (work_color >= 0) {
25846183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2585112202d9STejun Heo 			pwq->work_color = work_color;
258673f53c4aSTejun Heo 		}
258773f53c4aSTejun Heo 
2588b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pool->lock);
25891da177e4SLinus Torvalds 	}
25901da177e4SLinus Torvalds 
2591112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
259273f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
259373f53c4aSTejun Heo 
259473f53c4aSTejun Heo 	return wait;
259583c22520SOleg Nesterov }
25961da177e4SLinus Torvalds 
25970fcb78c2SRolf Eike Beer /**
25981da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
25990fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
26001da177e4SLinus Torvalds  *
2601c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
2602c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
26031da177e4SLinus Torvalds  */
26047ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
26051da177e4SLinus Torvalds {
260673f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
260773f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
260873f53c4aSTejun Heo 		.flush_color = -1,
260973f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
261073f53c4aSTejun Heo 	};
261173f53c4aSTejun Heo 	int next_color;
2612b1f4ec17SOleg Nesterov 
26133295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
26143295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
261573f53c4aSTejun Heo 
26163c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
261773f53c4aSTejun Heo 
261873f53c4aSTejun Heo 	/*
261973f53c4aSTejun Heo 	 * Start-to-wait phase
262073f53c4aSTejun Heo 	 */
262173f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
262273f53c4aSTejun Heo 
262373f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
262473f53c4aSTejun Heo 		/*
262573f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
262673f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
262773f53c4aSTejun Heo 		 * by one.
262873f53c4aSTejun Heo 		 */
26296183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
263073f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
263173f53c4aSTejun Heo 		wq->work_color = next_color;
263273f53c4aSTejun Heo 
263373f53c4aSTejun Heo 		if (!wq->first_flusher) {
263473f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
26356183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
263673f53c4aSTejun Heo 
263773f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
263873f53c4aSTejun Heo 
2639112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
264073f53c4aSTejun Heo 						       wq->work_color)) {
264173f53c4aSTejun Heo 				/* nothing to flush, done */
264273f53c4aSTejun Heo 				wq->flush_color = next_color;
264373f53c4aSTejun Heo 				wq->first_flusher = NULL;
264473f53c4aSTejun Heo 				goto out_unlock;
264573f53c4aSTejun Heo 			}
264673f53c4aSTejun Heo 		} else {
264773f53c4aSTejun Heo 			/* wait in queue */
26486183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
264973f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
2650112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
265173f53c4aSTejun Heo 		}
265273f53c4aSTejun Heo 	} else {
265373f53c4aSTejun Heo 		/*
265473f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
265573f53c4aSTejun Heo 		 * The next flush completion will assign us
265673f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
265773f53c4aSTejun Heo 		 */
265873f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
265973f53c4aSTejun Heo 	}
266073f53c4aSTejun Heo 
2661fca839c0STejun Heo 	check_flush_dependency(wq, NULL);
2662fca839c0STejun Heo 
26633c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
266473f53c4aSTejun Heo 
266573f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
266673f53c4aSTejun Heo 
266773f53c4aSTejun Heo 	/*
266873f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
266973f53c4aSTejun Heo 	 *
267073f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
267173f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
267273f53c4aSTejun Heo 	 */
267373f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
267473f53c4aSTejun Heo 		return;
267573f53c4aSTejun Heo 
26763c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
267773f53c4aSTejun Heo 
26784ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26794ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26804ce48b37STejun Heo 		goto out_unlock;
26814ce48b37STejun Heo 
268273f53c4aSTejun Heo 	wq->first_flusher = NULL;
268373f53c4aSTejun Heo 
26846183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
26856183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
268673f53c4aSTejun Heo 
268773f53c4aSTejun Heo 	while (true) {
268873f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
268973f53c4aSTejun Heo 
269073f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
269173f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
269273f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
269373f53c4aSTejun Heo 				break;
269473f53c4aSTejun Heo 			list_del_init(&next->list);
269573f53c4aSTejun Heo 			complete(&next->done);
269673f53c4aSTejun Heo 		}
269773f53c4aSTejun Heo 
26986183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
269973f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
270073f53c4aSTejun Heo 
270173f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
270273f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
270373f53c4aSTejun Heo 
270473f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
270573f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
270673f53c4aSTejun Heo 			/*
270773f53c4aSTejun Heo 			 * Assign the same color to all overflowed
270873f53c4aSTejun Heo 			 * flushers, advance work_color and append to
270973f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
271073f53c4aSTejun Heo 			 * phase for these overflowed flushers.
271173f53c4aSTejun Heo 			 */
271273f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
271373f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
271473f53c4aSTejun Heo 
271573f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
271673f53c4aSTejun Heo 
271773f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
271873f53c4aSTejun Heo 					      &wq->flusher_queue);
2719112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
272073f53c4aSTejun Heo 		}
272173f53c4aSTejun Heo 
272273f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
27236183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
272473f53c4aSTejun Heo 			break;
272573f53c4aSTejun Heo 		}
272673f53c4aSTejun Heo 
272773f53c4aSTejun Heo 		/*
272873f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
2729112202d9STejun Heo 		 * the new first flusher and arm pwqs.
273073f53c4aSTejun Heo 		 */
27316183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
27326183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
273373f53c4aSTejun Heo 
273473f53c4aSTejun Heo 		list_del_init(&next->list);
273573f53c4aSTejun Heo 		wq->first_flusher = next;
273673f53c4aSTejun Heo 
2737112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
273873f53c4aSTejun Heo 			break;
273973f53c4aSTejun Heo 
274073f53c4aSTejun Heo 		/*
274173f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
274273f53c4aSTejun Heo 		 * flusher and repeat cascading.
274373f53c4aSTejun Heo 		 */
274473f53c4aSTejun Heo 		wq->first_flusher = NULL;
274573f53c4aSTejun Heo 	}
274673f53c4aSTejun Heo 
274773f53c4aSTejun Heo out_unlock:
27483c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
27491da177e4SLinus Torvalds }
27501dadafa8STim Gardner EXPORT_SYMBOL(flush_workqueue);
27511da177e4SLinus Torvalds 
27529c5a2ba7STejun Heo /**
27539c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27549c5a2ba7STejun Heo  * @wq: workqueue to drain
27559c5a2ba7STejun Heo  *
27569c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27579c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27589c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
2759b749b1b6SChen Hanxiao  * repeatedly until it becomes empty.  The number of flushing is determined
27609c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27619c5a2ba7STejun Heo  * takes too long.
27629c5a2ba7STejun Heo  */
27639c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27649c5a2ba7STejun Heo {
27659c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
276649e3cf44STejun Heo 	struct pool_workqueue *pwq;
27679c5a2ba7STejun Heo 
27689c5a2ba7STejun Heo 	/*
27699c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27709c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
2771618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
27729c5a2ba7STejun Heo 	 */
277387fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
27749c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
2775618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
277687fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
27779c5a2ba7STejun Heo reflush:
27789c5a2ba7STejun Heo 	flush_workqueue(wq);
27799c5a2ba7STejun Heo 
2780b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
278176af4d93STejun Heo 
278249e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2783fa2563e4SThomas Tuttle 		bool drained;
27849c5a2ba7STejun Heo 
2785b09f4fd3SLai Jiangshan 		spin_lock_irq(&pwq->pool->lock);
2786112202d9STejun Heo 		drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2787b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pwq->pool->lock);
2788fa2563e4SThomas Tuttle 
2789fa2563e4SThomas Tuttle 		if (drained)
27909c5a2ba7STejun Heo 			continue;
27919c5a2ba7STejun Heo 
27929c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27939c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2794c5aa87bbSTejun Heo 			pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
27959c5a2ba7STejun Heo 				wq->name, flush_cnt);
279676af4d93STejun Heo 
2797b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
27989c5a2ba7STejun Heo 		goto reflush;
27999c5a2ba7STejun Heo 	}
28009c5a2ba7STejun Heo 
28019c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
2802618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
280387fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
28049c5a2ba7STejun Heo }
28059c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
28069c5a2ba7STejun Heo 
2807606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2808baf59022STejun Heo {
2809baf59022STejun Heo 	struct worker *worker = NULL;
2810c9e7cf27STejun Heo 	struct worker_pool *pool;
2811112202d9STejun Heo 	struct pool_workqueue *pwq;
2812baf59022STejun Heo 
2813baf59022STejun Heo 	might_sleep();
2814baf59022STejun Heo 
2815fa1b54e6STejun Heo 	local_irq_disable();
2816fa1b54e6STejun Heo 	pool = get_work_pool(work);
2817fa1b54e6STejun Heo 	if (!pool) {
2818fa1b54e6STejun Heo 		local_irq_enable();
2819fa1b54e6STejun Heo 		return false;
2820fa1b54e6STejun Heo 	}
2821fa1b54e6STejun Heo 
2822fa1b54e6STejun Heo 	spin_lock(&pool->lock);
28230b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
2824112202d9STejun Heo 	pwq = get_work_pwq(work);
2825112202d9STejun Heo 	if (pwq) {
2826112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
2827baf59022STejun Heo 			goto already_gone;
2828606a5020STejun Heo 	} else {
2829c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
2830baf59022STejun Heo 		if (!worker)
2831baf59022STejun Heo 			goto already_gone;
2832112202d9STejun Heo 		pwq = worker->current_pwq;
2833606a5020STejun Heo 	}
2834baf59022STejun Heo 
2835fca839c0STejun Heo 	check_flush_dependency(pwq->wq, work);
2836fca839c0STejun Heo 
2837112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
2838d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2839baf59022STejun Heo 
2840e159489bSTejun Heo 	/*
2841e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2842e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2843e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2844e159489bSTejun Heo 	 * access.
2845e159489bSTejun Heo 	 */
2846493008a8STejun Heo 	if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
2847112202d9STejun Heo 		lock_map_acquire(&pwq->wq->lockdep_map);
2848e159489bSTejun Heo 	else
2849112202d9STejun Heo 		lock_map_acquire_read(&pwq->wq->lockdep_map);
2850112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
2851e159489bSTejun Heo 
2852baf59022STejun Heo 	return true;
2853baf59022STejun Heo already_gone:
2854d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2855baf59022STejun Heo 	return false;
2856baf59022STejun Heo }
2857baf59022STejun Heo 
2858db700897SOleg Nesterov /**
2859401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2860401a8d04STejun Heo  * @work: the work to flush
2861db700897SOleg Nesterov  *
2862606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2863606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2864401a8d04STejun Heo  *
2865d185af30SYacine Belkadi  * Return:
2866401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2867401a8d04STejun Heo  * %false if it was already idle.
2868db700897SOleg Nesterov  */
2869401a8d04STejun Heo bool flush_work(struct work_struct *work)
2870db700897SOleg Nesterov {
287112997d1aSBjorn Helgaas 	struct wq_barrier barr;
287212997d1aSBjorn Helgaas 
28730976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28740976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28750976dfc1SStephen Boyd 
287612997d1aSBjorn Helgaas 	if (start_flush_work(work, &barr)) {
287712997d1aSBjorn Helgaas 		wait_for_completion(&barr.done);
287812997d1aSBjorn Helgaas 		destroy_work_on_stack(&barr.work);
287912997d1aSBjorn Helgaas 		return true;
288012997d1aSBjorn Helgaas 	} else {
288112997d1aSBjorn Helgaas 		return false;
288212997d1aSBjorn Helgaas 	}
2883606a5020STejun Heo }
2884db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2885db700897SOleg Nesterov 
28868603e1b3STejun Heo struct cwt_wait {
28878603e1b3STejun Heo 	wait_queue_t		wait;
28888603e1b3STejun Heo 	struct work_struct	*work;
28898603e1b3STejun Heo };
28908603e1b3STejun Heo 
28918603e1b3STejun Heo static int cwt_wakefn(wait_queue_t *wait, unsigned mode, int sync, void *key)
28928603e1b3STejun Heo {
28938603e1b3STejun Heo 	struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
28948603e1b3STejun Heo 
28958603e1b3STejun Heo 	if (cwait->work != key)
28968603e1b3STejun Heo 		return 0;
28978603e1b3STejun Heo 	return autoremove_wake_function(wait, mode, sync, key);
28988603e1b3STejun Heo }
28998603e1b3STejun Heo 
290036e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2901401a8d04STejun Heo {
29028603e1b3STejun Heo 	static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
2903bbb68dfaSTejun Heo 	unsigned long flags;
29041f1f642eSOleg Nesterov 	int ret;
29051f1f642eSOleg Nesterov 
29061f1f642eSOleg Nesterov 	do {
2907bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2908bbb68dfaSTejun Heo 		/*
29098603e1b3STejun Heo 		 * If someone else is already canceling, wait for it to
29108603e1b3STejun Heo 		 * finish.  flush_work() doesn't work for PREEMPT_NONE
29118603e1b3STejun Heo 		 * because we may get scheduled between @work's completion
29128603e1b3STejun Heo 		 * and the other canceling task resuming and clearing
29138603e1b3STejun Heo 		 * CANCELING - flush_work() will return false immediately
29148603e1b3STejun Heo 		 * as @work is no longer busy, try_to_grab_pending() will
29158603e1b3STejun Heo 		 * return -ENOENT as @work is still being canceled and the
29168603e1b3STejun Heo 		 * other canceling task won't be able to clear CANCELING as
29178603e1b3STejun Heo 		 * we're hogging the CPU.
29188603e1b3STejun Heo 		 *
29198603e1b3STejun Heo 		 * Let's wait for completion using a waitqueue.  As this
29208603e1b3STejun Heo 		 * may lead to the thundering herd problem, use a custom
29218603e1b3STejun Heo 		 * wake function which matches @work along with exclusive
29228603e1b3STejun Heo 		 * wait and wakeup.
2923bbb68dfaSTejun Heo 		 */
29248603e1b3STejun Heo 		if (unlikely(ret == -ENOENT)) {
29258603e1b3STejun Heo 			struct cwt_wait cwait;
29268603e1b3STejun Heo 
29278603e1b3STejun Heo 			init_wait(&cwait.wait);
29288603e1b3STejun Heo 			cwait.wait.func = cwt_wakefn;
29298603e1b3STejun Heo 			cwait.work = work;
29308603e1b3STejun Heo 
29318603e1b3STejun Heo 			prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
29328603e1b3STejun Heo 						  TASK_UNINTERRUPTIBLE);
29338603e1b3STejun Heo 			if (work_is_canceling(work))
29348603e1b3STejun Heo 				schedule();
29358603e1b3STejun Heo 			finish_wait(&cancel_waitq, &cwait.wait);
29368603e1b3STejun Heo 		}
29371f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
29381f1f642eSOleg Nesterov 
2939bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2940bbb68dfaSTejun Heo 	mark_work_canceling(work);
2941bbb68dfaSTejun Heo 	local_irq_restore(flags);
2942bbb68dfaSTejun Heo 
2943606a5020STejun Heo 	flush_work(work);
29447a22ad75STejun Heo 	clear_work_data(work);
29458603e1b3STejun Heo 
29468603e1b3STejun Heo 	/*
29478603e1b3STejun Heo 	 * Paired with prepare_to_wait() above so that either
29488603e1b3STejun Heo 	 * waitqueue_active() is visible here or !work_is_canceling() is
29498603e1b3STejun Heo 	 * visible there.
29508603e1b3STejun Heo 	 */
29518603e1b3STejun Heo 	smp_mb();
29528603e1b3STejun Heo 	if (waitqueue_active(&cancel_waitq))
29538603e1b3STejun Heo 		__wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
29548603e1b3STejun Heo 
29551f1f642eSOleg Nesterov 	return ret;
29561f1f642eSOleg Nesterov }
29571f1f642eSOleg Nesterov 
29586e84d644SOleg Nesterov /**
2959401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2960401a8d04STejun Heo  * @work: the work to cancel
29616e84d644SOleg Nesterov  *
2962401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2963401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2964401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2965401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
29661f1f642eSOleg Nesterov  *
2967401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2968401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
29696e84d644SOleg Nesterov  *
2970401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
29716e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2972401a8d04STejun Heo  *
2973d185af30SYacine Belkadi  * Return:
2974401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
29756e84d644SOleg Nesterov  */
2976401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29776e84d644SOleg Nesterov {
297836e227d2STejun Heo 	return __cancel_work_timer(work, false);
2979b89deed3SOleg Nesterov }
298028e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2981b89deed3SOleg Nesterov 
29826e84d644SOleg Nesterov /**
2983401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2984401a8d04STejun Heo  * @dwork: the delayed work to flush
29856e84d644SOleg Nesterov  *
2986401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2987401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2988401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29891f1f642eSOleg Nesterov  *
2990d185af30SYacine Belkadi  * Return:
2991401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2992401a8d04STejun Heo  * %false if it was already idle.
29936e84d644SOleg Nesterov  */
2994401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2995401a8d04STejun Heo {
29968930cabaSTejun Heo 	local_irq_disable();
2997401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
299860c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
29998930cabaSTejun Heo 	local_irq_enable();
3000401a8d04STejun Heo 	return flush_work(&dwork->work);
3001401a8d04STejun Heo }
3002401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
3003401a8d04STejun Heo 
3004401a8d04STejun Heo /**
300557b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
300657b30ae7STejun Heo  * @dwork: delayed_work to cancel
300709383498STejun Heo  *
3008d185af30SYacine Belkadi  * Kill off a pending delayed_work.
3009d185af30SYacine Belkadi  *
3010d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
3011d185af30SYacine Belkadi  * pending.
3012d185af30SYacine Belkadi  *
3013d185af30SYacine Belkadi  * Note:
3014d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
3015d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
3016d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
301709383498STejun Heo  *
301857b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
301909383498STejun Heo  */
302057b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
302109383498STejun Heo {
302257b30ae7STejun Heo 	unsigned long flags;
302357b30ae7STejun Heo 	int ret;
302457b30ae7STejun Heo 
302557b30ae7STejun Heo 	do {
302657b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
302757b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
302857b30ae7STejun Heo 
302957b30ae7STejun Heo 	if (unlikely(ret < 0))
303057b30ae7STejun Heo 		return false;
303157b30ae7STejun Heo 
30327c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(&dwork->work,
30337c3eed5cSTejun Heo 					get_work_pool_id(&dwork->work));
303457b30ae7STejun Heo 	local_irq_restore(flags);
3035c0158ca6SDan Magenheimer 	return ret;
303609383498STejun Heo }
303757b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
303809383498STejun Heo 
303909383498STejun Heo /**
3040401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3041401a8d04STejun Heo  * @dwork: the delayed work cancel
3042401a8d04STejun Heo  *
3043401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
3044401a8d04STejun Heo  *
3045d185af30SYacine Belkadi  * Return:
3046401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
3047401a8d04STejun Heo  */
3048401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
30496e84d644SOleg Nesterov {
305036e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
30516e84d644SOleg Nesterov }
3052f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
30531da177e4SLinus Torvalds 
30540fcb78c2SRolf Eike Beer /**
305531ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3056b6136773SAndrew Morton  * @func: the function to call
3057b6136773SAndrew Morton  *
305831ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
305931ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3060b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
306131ddd871STejun Heo  *
3062d185af30SYacine Belkadi  * Return:
306331ddd871STejun Heo  * 0 on success, -errno on failure.
3064b6136773SAndrew Morton  */
306565f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
306615316ba8SChristoph Lameter {
306715316ba8SChristoph Lameter 	int cpu;
306838f51568SNamhyung Kim 	struct work_struct __percpu *works;
306915316ba8SChristoph Lameter 
3070b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3071b6136773SAndrew Morton 	if (!works)
307215316ba8SChristoph Lameter 		return -ENOMEM;
3073b6136773SAndrew Morton 
307495402b38SGautham R Shenoy 	get_online_cpus();
307593981800STejun Heo 
307615316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
30779bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
30789bfb1839SIngo Molnar 
30799bfb1839SIngo Molnar 		INIT_WORK(work, func);
30808de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
308115316ba8SChristoph Lameter 	}
308293981800STejun Heo 
308393981800STejun Heo 	for_each_online_cpu(cpu)
30848616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
308593981800STejun Heo 
308695402b38SGautham R Shenoy 	put_online_cpus();
3087b6136773SAndrew Morton 	free_percpu(works);
308815316ba8SChristoph Lameter 	return 0;
308915316ba8SChristoph Lameter }
309015316ba8SChristoph Lameter 
3091eef6a7d5SAlan Stern /**
30921fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
30931fa44ecaSJames Bottomley  * @fn:		the function to execute
30941fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
30951fa44ecaSJames Bottomley  *		be available when the work executes)
30961fa44ecaSJames Bottomley  *
30971fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
30981fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
30991fa44ecaSJames Bottomley  *
3100d185af30SYacine Belkadi  * Return:	0 - function was executed
31011fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31021fa44ecaSJames Bottomley  */
310365f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31041fa44ecaSJames Bottomley {
31051fa44ecaSJames Bottomley 	if (!in_interrupt()) {
310665f27f38SDavid Howells 		fn(&ew->work);
31071fa44ecaSJames Bottomley 		return 0;
31081fa44ecaSJames Bottomley 	}
31091fa44ecaSJames Bottomley 
311065f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31111fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31121fa44ecaSJames Bottomley 
31131fa44ecaSJames Bottomley 	return 1;
31141fa44ecaSJames Bottomley }
31151fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31161fa44ecaSJames Bottomley 
31177a4e344cSTejun Heo /**
31187a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
31197a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
31207a4e344cSTejun Heo  *
31217a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
31227a4e344cSTejun Heo  */
31237a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs)
31247a4e344cSTejun Heo {
31257a4e344cSTejun Heo 	if (attrs) {
31267a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
31277a4e344cSTejun Heo 		kfree(attrs);
31287a4e344cSTejun Heo 	}
31297a4e344cSTejun Heo }
31307a4e344cSTejun Heo 
31317a4e344cSTejun Heo /**
31327a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
31337a4e344cSTejun Heo  * @gfp_mask: allocation mask to use
31347a4e344cSTejun Heo  *
31357a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
3136d185af30SYacine Belkadi  * return it.
3137d185af30SYacine Belkadi  *
3138d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
31397a4e344cSTejun Heo  */
31407a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
31417a4e344cSTejun Heo {
31427a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
31437a4e344cSTejun Heo 
31447a4e344cSTejun Heo 	attrs = kzalloc(sizeof(*attrs), gfp_mask);
31457a4e344cSTejun Heo 	if (!attrs)
31467a4e344cSTejun Heo 		goto fail;
31477a4e344cSTejun Heo 	if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
31487a4e344cSTejun Heo 		goto fail;
31497a4e344cSTejun Heo 
315013e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
31517a4e344cSTejun Heo 	return attrs;
31527a4e344cSTejun Heo fail:
31537a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
31547a4e344cSTejun Heo 	return NULL;
31557a4e344cSTejun Heo }
31567a4e344cSTejun Heo 
315729c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
315829c91e99STejun Heo 				 const struct workqueue_attrs *from)
315929c91e99STejun Heo {
316029c91e99STejun Heo 	to->nice = from->nice;
316129c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
31622865a8fbSShaohua Li 	/*
31632865a8fbSShaohua Li 	 * Unlike hash and equality test, this function doesn't ignore
31642865a8fbSShaohua Li 	 * ->no_numa as it is used for both pool and wq attrs.  Instead,
31652865a8fbSShaohua Li 	 * get_unbound_pool() explicitly clears ->no_numa after copying.
31662865a8fbSShaohua Li 	 */
31672865a8fbSShaohua Li 	to->no_numa = from->no_numa;
316829c91e99STejun Heo }
316929c91e99STejun Heo 
317029c91e99STejun Heo /* hash value of the content of @attr */
317129c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
317229c91e99STejun Heo {
317329c91e99STejun Heo 	u32 hash = 0;
317429c91e99STejun Heo 
317529c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
317613e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
317713e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
317829c91e99STejun Heo 	return hash;
317929c91e99STejun Heo }
318029c91e99STejun Heo 
318129c91e99STejun Heo /* content equality test */
318229c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
318329c91e99STejun Heo 			  const struct workqueue_attrs *b)
318429c91e99STejun Heo {
318529c91e99STejun Heo 	if (a->nice != b->nice)
318629c91e99STejun Heo 		return false;
318729c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
318829c91e99STejun Heo 		return false;
318929c91e99STejun Heo 	return true;
319029c91e99STejun Heo }
319129c91e99STejun Heo 
31927a4e344cSTejun Heo /**
31937a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
31947a4e344cSTejun Heo  * @pool: worker_pool to initialize
31957a4e344cSTejun Heo  *
3196402dd89dSShailendra Verma  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
3197d185af30SYacine Belkadi  *
3198d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
319929c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
320029c91e99STejun Heo  * on @pool safely to release it.
32017a4e344cSTejun Heo  */
32027a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
32034e1a1f9aSTejun Heo {
32044e1a1f9aSTejun Heo 	spin_lock_init(&pool->lock);
320529c91e99STejun Heo 	pool->id = -1;
320629c91e99STejun Heo 	pool->cpu = -1;
3207f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
32084e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
320982607adcSTejun Heo 	pool->watchdog_ts = jiffies;
32104e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
32114e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
32124e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
32134e1a1f9aSTejun Heo 
32144e1a1f9aSTejun Heo 	init_timer_deferrable(&pool->idle_timer);
32154e1a1f9aSTejun Heo 	pool->idle_timer.function = idle_worker_timeout;
32164e1a1f9aSTejun Heo 	pool->idle_timer.data = (unsigned long)pool;
32174e1a1f9aSTejun Heo 
32184e1a1f9aSTejun Heo 	setup_timer(&pool->mayday_timer, pool_mayday_timeout,
32194e1a1f9aSTejun Heo 		    (unsigned long)pool);
32204e1a1f9aSTejun Heo 
32214e1a1f9aSTejun Heo 	mutex_init(&pool->manager_arb);
322292f9c5c4SLai Jiangshan 	mutex_init(&pool->attach_mutex);
3223da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
32247a4e344cSTejun Heo 
32257cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
322629c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
322729c91e99STejun Heo 	pool->refcnt = 1;
322829c91e99STejun Heo 
322929c91e99STejun Heo 	/* shouldn't fail above this point */
32307a4e344cSTejun Heo 	pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
32317a4e344cSTejun Heo 	if (!pool->attrs)
32327a4e344cSTejun Heo 		return -ENOMEM;
32337a4e344cSTejun Heo 	return 0;
32344e1a1f9aSTejun Heo }
32354e1a1f9aSTejun Heo 
3236e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu)
3237e2dca7adSTejun Heo {
3238e2dca7adSTejun Heo 	struct workqueue_struct *wq =
3239e2dca7adSTejun Heo 		container_of(rcu, struct workqueue_struct, rcu);
3240e2dca7adSTejun Heo 
3241e2dca7adSTejun Heo 	if (!(wq->flags & WQ_UNBOUND))
3242e2dca7adSTejun Heo 		free_percpu(wq->cpu_pwqs);
3243e2dca7adSTejun Heo 	else
3244e2dca7adSTejun Heo 		free_workqueue_attrs(wq->unbound_attrs);
3245e2dca7adSTejun Heo 
3246e2dca7adSTejun Heo 	kfree(wq->rescuer);
3247e2dca7adSTejun Heo 	kfree(wq);
3248e2dca7adSTejun Heo }
3249e2dca7adSTejun Heo 
325029c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
325129c91e99STejun Heo {
325229c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
325329c91e99STejun Heo 
32547cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
325529c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
325629c91e99STejun Heo 	kfree(pool);
325729c91e99STejun Heo }
325829c91e99STejun Heo 
325929c91e99STejun Heo /**
326029c91e99STejun Heo  * put_unbound_pool - put a worker_pool
326129c91e99STejun Heo  * @pool: worker_pool to put
326229c91e99STejun Heo  *
326329c91e99STejun Heo  * Put @pool.  If its refcnt reaches zero, it gets destroyed in sched-RCU
3264c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
3265c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
3266c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
3267a892caccSTejun Heo  *
3268a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
326929c91e99STejun Heo  */
327029c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
327129c91e99STejun Heo {
327260f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
327329c91e99STejun Heo 	struct worker *worker;
327429c91e99STejun Heo 
3275a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3276a892caccSTejun Heo 
3277a892caccSTejun Heo 	if (--pool->refcnt)
327829c91e99STejun Heo 		return;
327929c91e99STejun Heo 
328029c91e99STejun Heo 	/* sanity checks */
328161d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
3282a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
328329c91e99STejun Heo 		return;
328429c91e99STejun Heo 
328529c91e99STejun Heo 	/* release id and unhash */
328629c91e99STejun Heo 	if (pool->id >= 0)
328729c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
328829c91e99STejun Heo 	hash_del(&pool->hash_node);
328929c91e99STejun Heo 
3290c5aa87bbSTejun Heo 	/*
3291c5aa87bbSTejun Heo 	 * Become the manager and destroy all workers.  Grabbing
3292c5aa87bbSTejun Heo 	 * manager_arb prevents @pool's workers from blocking on
329392f9c5c4SLai Jiangshan 	 * attach_mutex.
3294c5aa87bbSTejun Heo 	 */
329529c91e99STejun Heo 	mutex_lock(&pool->manager_arb);
329629c91e99STejun Heo 
329760f5a4bcSLai Jiangshan 	spin_lock_irq(&pool->lock);
32981037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
329929c91e99STejun Heo 		destroy_worker(worker);
330029c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
330129c91e99STejun Heo 	spin_unlock_irq(&pool->lock);
330260f5a4bcSLai Jiangshan 
330392f9c5c4SLai Jiangshan 	mutex_lock(&pool->attach_mutex);
3304da028469SLai Jiangshan 	if (!list_empty(&pool->workers))
330560f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
330692f9c5c4SLai Jiangshan 	mutex_unlock(&pool->attach_mutex);
330760f5a4bcSLai Jiangshan 
330860f5a4bcSLai Jiangshan 	if (pool->detach_completion)
330960f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
331060f5a4bcSLai Jiangshan 
331129c91e99STejun Heo 	mutex_unlock(&pool->manager_arb);
331229c91e99STejun Heo 
331329c91e99STejun Heo 	/* shut down the timers */
331429c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
331529c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
331629c91e99STejun Heo 
331729c91e99STejun Heo 	/* sched-RCU protected to allow dereferences from get_work_pool() */
331829c91e99STejun Heo 	call_rcu_sched(&pool->rcu, rcu_free_pool);
331929c91e99STejun Heo }
332029c91e99STejun Heo 
332129c91e99STejun Heo /**
332229c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
332329c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
332429c91e99STejun Heo  *
332529c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
332629c91e99STejun Heo  * reference count and return it.  If there already is a matching
332729c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
3328d185af30SYacine Belkadi  * create a new one.
3329a892caccSTejun Heo  *
3330a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
3331d185af30SYacine Belkadi  *
3332d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
3333d185af30SYacine Belkadi  * On failure, %NULL.
333429c91e99STejun Heo  */
333529c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
333629c91e99STejun Heo {
333729c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
333829c91e99STejun Heo 	struct worker_pool *pool;
3339f3f90ad4STejun Heo 	int node;
3340e2273584SXunlei Pang 	int target_node = NUMA_NO_NODE;
334129c91e99STejun Heo 
3342a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
334329c91e99STejun Heo 
334429c91e99STejun Heo 	/* do we already have a matching pool? */
334529c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
334629c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
334729c91e99STejun Heo 			pool->refcnt++;
33483fb1823cSLai Jiangshan 			return pool;
334929c91e99STejun Heo 		}
335029c91e99STejun Heo 	}
335129c91e99STejun Heo 
3352e2273584SXunlei Pang 	/* if cpumask is contained inside a NUMA node, we belong to that node */
3353e2273584SXunlei Pang 	if (wq_numa_enabled) {
3354e2273584SXunlei Pang 		for_each_node(node) {
3355e2273584SXunlei Pang 			if (cpumask_subset(attrs->cpumask,
3356e2273584SXunlei Pang 					   wq_numa_possible_cpumask[node])) {
3357e2273584SXunlei Pang 				target_node = node;
3358e2273584SXunlei Pang 				break;
3359e2273584SXunlei Pang 			}
3360e2273584SXunlei Pang 		}
3361e2273584SXunlei Pang 	}
3362e2273584SXunlei Pang 
336329c91e99STejun Heo 	/* nope, create a new one */
3364e2273584SXunlei Pang 	pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
336529c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
336629c91e99STejun Heo 		goto fail;
336729c91e99STejun Heo 
33688864b4e5STejun Heo 	lockdep_set_subclass(&pool->lock, 1);	/* see put_pwq() */
336929c91e99STejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
3370e2273584SXunlei Pang 	pool->node = target_node;
337129c91e99STejun Heo 
33722865a8fbSShaohua Li 	/*
33732865a8fbSShaohua Li 	 * no_numa isn't a worker_pool attribute, always clear it.  See
33742865a8fbSShaohua Li 	 * 'struct workqueue_attrs' comments for detail.
33752865a8fbSShaohua Li 	 */
33762865a8fbSShaohua Li 	pool->attrs->no_numa = false;
33772865a8fbSShaohua Li 
337829c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
337929c91e99STejun Heo 		goto fail;
338029c91e99STejun Heo 
338129c91e99STejun Heo 	/* create and start the initial worker */
3382051e1850SLai Jiangshan 	if (!create_worker(pool))
338329c91e99STejun Heo 		goto fail;
338429c91e99STejun Heo 
338529c91e99STejun Heo 	/* install */
338629c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
33873fb1823cSLai Jiangshan 
338829c91e99STejun Heo 	return pool;
338929c91e99STejun Heo fail:
339029c91e99STejun Heo 	if (pool)
339129c91e99STejun Heo 		put_unbound_pool(pool);
339229c91e99STejun Heo 	return NULL;
339329c91e99STejun Heo }
339429c91e99STejun Heo 
33958864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
33968864b4e5STejun Heo {
33978864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
33988864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
33998864b4e5STejun Heo }
34008864b4e5STejun Heo 
34018864b4e5STejun Heo /*
34028864b4e5STejun Heo  * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
34038864b4e5STejun Heo  * and needs to be destroyed.
34048864b4e5STejun Heo  */
34058864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work)
34068864b4e5STejun Heo {
34078864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
34088864b4e5STejun Heo 						  unbound_release_work);
34098864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
34108864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
3411bc0caf09STejun Heo 	bool is_last;
34128864b4e5STejun Heo 
34138864b4e5STejun Heo 	if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
34148864b4e5STejun Heo 		return;
34158864b4e5STejun Heo 
34163c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
34178864b4e5STejun Heo 	list_del_rcu(&pwq->pwqs_node);
3418bc0caf09STejun Heo 	is_last = list_empty(&wq->pwqs);
34193c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
34208864b4e5STejun Heo 
3421a892caccSTejun Heo 	mutex_lock(&wq_pool_mutex);
34228864b4e5STejun Heo 	put_unbound_pool(pool);
3423a892caccSTejun Heo 	mutex_unlock(&wq_pool_mutex);
3424a892caccSTejun Heo 
34258864b4e5STejun Heo 	call_rcu_sched(&pwq->rcu, rcu_free_pwq);
34268864b4e5STejun Heo 
34278864b4e5STejun Heo 	/*
34288864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
3429e2dca7adSTejun Heo 	 * is gonna access it anymore.  Schedule RCU free.
34308864b4e5STejun Heo 	 */
3431e2dca7adSTejun Heo 	if (is_last)
3432e2dca7adSTejun Heo 		call_rcu_sched(&wq->rcu, rcu_free_wq);
34336029a918STejun Heo }
34348864b4e5STejun Heo 
34350fbd95aaSTejun Heo /**
3436699ce097STejun Heo  * pwq_adjust_max_active - update a pwq's max_active to the current setting
34370fbd95aaSTejun Heo  * @pwq: target pool_workqueue
34380fbd95aaSTejun Heo  *
3439699ce097STejun Heo  * If @pwq isn't freezing, set @pwq->max_active to the associated
3440699ce097STejun Heo  * workqueue's saved_max_active and activate delayed work items
3441699ce097STejun Heo  * accordingly.  If @pwq is freezing, clear @pwq->max_active to zero.
34420fbd95aaSTejun Heo  */
3443699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq)
34440fbd95aaSTejun Heo {
3445699ce097STejun Heo 	struct workqueue_struct *wq = pwq->wq;
3446699ce097STejun Heo 	bool freezable = wq->flags & WQ_FREEZABLE;
3447699ce097STejun Heo 
3448699ce097STejun Heo 	/* for @wq->saved_max_active */
3449a357fc03SLai Jiangshan 	lockdep_assert_held(&wq->mutex);
3450699ce097STejun Heo 
3451699ce097STejun Heo 	/* fast exit for non-freezable wqs */
3452699ce097STejun Heo 	if (!freezable && pwq->max_active == wq->saved_max_active)
3453699ce097STejun Heo 		return;
3454699ce097STejun Heo 
3455a357fc03SLai Jiangshan 	spin_lock_irq(&pwq->pool->lock);
3456699ce097STejun Heo 
345774b414eaSLai Jiangshan 	/*
345874b414eaSLai Jiangshan 	 * During [un]freezing, the caller is responsible for ensuring that
345974b414eaSLai Jiangshan 	 * this function is called at least once after @workqueue_freezing
346074b414eaSLai Jiangshan 	 * is updated and visible.
346174b414eaSLai Jiangshan 	 */
346274b414eaSLai Jiangshan 	if (!freezable || !workqueue_freezing) {
3463699ce097STejun Heo 		pwq->max_active = wq->saved_max_active;
34640fbd95aaSTejun Heo 
34650fbd95aaSTejun Heo 		while (!list_empty(&pwq->delayed_works) &&
34660fbd95aaSTejun Heo 		       pwq->nr_active < pwq->max_active)
34670fbd95aaSTejun Heo 			pwq_activate_first_delayed(pwq);
3468951a078aSLai Jiangshan 
3469951a078aSLai Jiangshan 		/*
3470951a078aSLai Jiangshan 		 * Need to kick a worker after thawed or an unbound wq's
3471951a078aSLai Jiangshan 		 * max_active is bumped.  It's a slow path.  Do it always.
3472951a078aSLai Jiangshan 		 */
3473951a078aSLai Jiangshan 		wake_up_worker(pwq->pool);
3474699ce097STejun Heo 	} else {
3475699ce097STejun Heo 		pwq->max_active = 0;
3476699ce097STejun Heo 	}
3477699ce097STejun Heo 
3478a357fc03SLai Jiangshan 	spin_unlock_irq(&pwq->pool->lock);
34790fbd95aaSTejun Heo }
34800fbd95aaSTejun Heo 
3481e50aba9aSTejun Heo /* initialize newly alloced @pwq which is associated with @wq and @pool */
3482f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3483f147f29eSTejun Heo 		     struct worker_pool *pool)
3484d2c1d404STejun Heo {
3485d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3486d2c1d404STejun Heo 
3487e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
3488e50aba9aSTejun Heo 
3489d2c1d404STejun Heo 	pwq->pool = pool;
3490d2c1d404STejun Heo 	pwq->wq = wq;
3491d2c1d404STejun Heo 	pwq->flush_color = -1;
34928864b4e5STejun Heo 	pwq->refcnt = 1;
3493d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->delayed_works);
34941befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
3495d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
34968864b4e5STejun Heo 	INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3497f147f29eSTejun Heo }
3498d2c1d404STejun Heo 
3499f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
35001befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
3501f147f29eSTejun Heo {
3502f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
3503f147f29eSTejun Heo 
3504f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
350575ccf595STejun Heo 
35061befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
35071befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
35081befcf30STejun Heo 		return;
35091befcf30STejun Heo 
351029b1cb41SLai Jiangshan 	/* set the matching work_color */
351175ccf595STejun Heo 	pwq->work_color = wq->work_color;
3512983ca25eSTejun Heo 
3513983ca25eSTejun Heo 	/* sync max_active to the current setting */
3514983ca25eSTejun Heo 	pwq_adjust_max_active(pwq);
3515983ca25eSTejun Heo 
3516983ca25eSTejun Heo 	/* link in @pwq */
35179e8cd2f5STejun Heo 	list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3518df2d5ae4STejun Heo }
35196029a918STejun Heo 
3520f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3521f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3522f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
3523f147f29eSTejun Heo {
3524f147f29eSTejun Heo 	struct worker_pool *pool;
3525f147f29eSTejun Heo 	struct pool_workqueue *pwq;
3526f147f29eSTejun Heo 
3527f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3528f147f29eSTejun Heo 
3529f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
3530f147f29eSTejun Heo 	if (!pool)
3531f147f29eSTejun Heo 		return NULL;
3532f147f29eSTejun Heo 
3533e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3534f147f29eSTejun Heo 	if (!pwq) {
3535f147f29eSTejun Heo 		put_unbound_pool(pool);
3536f147f29eSTejun Heo 		return NULL;
3537f147f29eSTejun Heo 	}
3538f147f29eSTejun Heo 
3539f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
3540f147f29eSTejun Heo 	return pwq;
3541d2c1d404STejun Heo }
3542d2c1d404STejun Heo 
35434c16bd32STejun Heo /**
354430186c6fSGong Zhaogang  * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
3545042f7df1SLai Jiangshan  * @attrs: the wq_attrs of the default pwq of the target workqueue
35464c16bd32STejun Heo  * @node: the target NUMA node
35474c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
35484c16bd32STejun Heo  * @cpumask: outarg, the resulting cpumask
35494c16bd32STejun Heo  *
35504c16bd32STejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @node.  If
35514c16bd32STejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during
3552d185af30SYacine Belkadi  * calculation.  The result is stored in @cpumask.
35534c16bd32STejun Heo  *
35544c16bd32STejun Heo  * If NUMA affinity is not enabled, @attrs->cpumask is always used.  If
35554c16bd32STejun Heo  * enabled and @node has online CPUs requested by @attrs, the returned
35564c16bd32STejun Heo  * cpumask is the intersection of the possible CPUs of @node and
35574c16bd32STejun Heo  * @attrs->cpumask.
35584c16bd32STejun Heo  *
35594c16bd32STejun Heo  * The caller is responsible for ensuring that the cpumask of @node stays
35604c16bd32STejun Heo  * stable.
3561d185af30SYacine Belkadi  *
3562d185af30SYacine Belkadi  * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3563d185af30SYacine Belkadi  * %false if equal.
35644c16bd32STejun Heo  */
35654c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
35664c16bd32STejun Heo 				 int cpu_going_down, cpumask_t *cpumask)
35674c16bd32STejun Heo {
3568d55262c4STejun Heo 	if (!wq_numa_enabled || attrs->no_numa)
35694c16bd32STejun Heo 		goto use_dfl;
35704c16bd32STejun Heo 
35714c16bd32STejun Heo 	/* does @node have any online CPUs @attrs wants? */
35724c16bd32STejun Heo 	cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
35734c16bd32STejun Heo 	if (cpu_going_down >= 0)
35744c16bd32STejun Heo 		cpumask_clear_cpu(cpu_going_down, cpumask);
35754c16bd32STejun Heo 
35764c16bd32STejun Heo 	if (cpumask_empty(cpumask))
35774c16bd32STejun Heo 		goto use_dfl;
35784c16bd32STejun Heo 
35794c16bd32STejun Heo 	/* yeap, return possible CPUs in @node that @attrs wants */
35804c16bd32STejun Heo 	cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
35814c16bd32STejun Heo 	return !cpumask_equal(cpumask, attrs->cpumask);
35824c16bd32STejun Heo 
35834c16bd32STejun Heo use_dfl:
35844c16bd32STejun Heo 	cpumask_copy(cpumask, attrs->cpumask);
35854c16bd32STejun Heo 	return false;
35864c16bd32STejun Heo }
35874c16bd32STejun Heo 
35881befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
35891befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
35901befcf30STejun Heo 						   int node,
35911befcf30STejun Heo 						   struct pool_workqueue *pwq)
35921befcf30STejun Heo {
35931befcf30STejun Heo 	struct pool_workqueue *old_pwq;
35941befcf30STejun Heo 
35955b95e1afSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
35961befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
35971befcf30STejun Heo 
35981befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
35991befcf30STejun Heo 	link_pwq(pwq);
36001befcf30STejun Heo 
36011befcf30STejun Heo 	old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
36021befcf30STejun Heo 	rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
36031befcf30STejun Heo 	return old_pwq;
36041befcf30STejun Heo }
36051befcf30STejun Heo 
36062d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */
36072d5f0764SLai Jiangshan struct apply_wqattrs_ctx {
36082d5f0764SLai Jiangshan 	struct workqueue_struct	*wq;		/* target workqueue */
36092d5f0764SLai Jiangshan 	struct workqueue_attrs	*attrs;		/* attrs to apply */
3610042f7df1SLai Jiangshan 	struct list_head	list;		/* queued for batching commit */
36112d5f0764SLai Jiangshan 	struct pool_workqueue	*dfl_pwq;
36122d5f0764SLai Jiangshan 	struct pool_workqueue	*pwq_tbl[];
36132d5f0764SLai Jiangshan };
36142d5f0764SLai Jiangshan 
36152d5f0764SLai Jiangshan /* free the resources after success or abort */
36162d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
36172d5f0764SLai Jiangshan {
36182d5f0764SLai Jiangshan 	if (ctx) {
36192d5f0764SLai Jiangshan 		int node;
36202d5f0764SLai Jiangshan 
36212d5f0764SLai Jiangshan 		for_each_node(node)
36222d5f0764SLai Jiangshan 			put_pwq_unlocked(ctx->pwq_tbl[node]);
36232d5f0764SLai Jiangshan 		put_pwq_unlocked(ctx->dfl_pwq);
36242d5f0764SLai Jiangshan 
36252d5f0764SLai Jiangshan 		free_workqueue_attrs(ctx->attrs);
36262d5f0764SLai Jiangshan 
36272d5f0764SLai Jiangshan 		kfree(ctx);
36282d5f0764SLai Jiangshan 	}
36292d5f0764SLai Jiangshan }
36302d5f0764SLai Jiangshan 
36312d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */
36322d5f0764SLai Jiangshan static struct apply_wqattrs_ctx *
36332d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq,
36342d5f0764SLai Jiangshan 		      const struct workqueue_attrs *attrs)
36352d5f0764SLai Jiangshan {
36362d5f0764SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
36372d5f0764SLai Jiangshan 	struct workqueue_attrs *new_attrs, *tmp_attrs;
36382d5f0764SLai Jiangshan 	int node;
36392d5f0764SLai Jiangshan 
36402d5f0764SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
36412d5f0764SLai Jiangshan 
36422d5f0764SLai Jiangshan 	ctx = kzalloc(sizeof(*ctx) + nr_node_ids * sizeof(ctx->pwq_tbl[0]),
36432d5f0764SLai Jiangshan 		      GFP_KERNEL);
36442d5f0764SLai Jiangshan 
36452d5f0764SLai Jiangshan 	new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
36462d5f0764SLai Jiangshan 	tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
36472d5f0764SLai Jiangshan 	if (!ctx || !new_attrs || !tmp_attrs)
36482d5f0764SLai Jiangshan 		goto out_free;
36492d5f0764SLai Jiangshan 
3650042f7df1SLai Jiangshan 	/*
3651042f7df1SLai Jiangshan 	 * Calculate the attrs of the default pwq.
3652042f7df1SLai Jiangshan 	 * If the user configured cpumask doesn't overlap with the
3653042f7df1SLai Jiangshan 	 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3654042f7df1SLai Jiangshan 	 */
36552d5f0764SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
3656b05a7928SFrederic Weisbecker 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
3657042f7df1SLai Jiangshan 	if (unlikely(cpumask_empty(new_attrs->cpumask)))
3658042f7df1SLai Jiangshan 		cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
36592d5f0764SLai Jiangshan 
36602d5f0764SLai Jiangshan 	/*
36612d5f0764SLai Jiangshan 	 * We may create multiple pwqs with differing cpumasks.  Make a
36622d5f0764SLai Jiangshan 	 * copy of @new_attrs which will be modified and used to obtain
36632d5f0764SLai Jiangshan 	 * pools.
36642d5f0764SLai Jiangshan 	 */
36652d5f0764SLai Jiangshan 	copy_workqueue_attrs(tmp_attrs, new_attrs);
36662d5f0764SLai Jiangshan 
36672d5f0764SLai Jiangshan 	/*
36682d5f0764SLai Jiangshan 	 * If something goes wrong during CPU up/down, we'll fall back to
36692d5f0764SLai Jiangshan 	 * the default pwq covering whole @attrs->cpumask.  Always create
36702d5f0764SLai Jiangshan 	 * it even if we don't use it immediately.
36712d5f0764SLai Jiangshan 	 */
36722d5f0764SLai Jiangshan 	ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
36732d5f0764SLai Jiangshan 	if (!ctx->dfl_pwq)
36742d5f0764SLai Jiangshan 		goto out_free;
36752d5f0764SLai Jiangshan 
36762d5f0764SLai Jiangshan 	for_each_node(node) {
3677042f7df1SLai Jiangshan 		if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
36782d5f0764SLai Jiangshan 			ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
36792d5f0764SLai Jiangshan 			if (!ctx->pwq_tbl[node])
36802d5f0764SLai Jiangshan 				goto out_free;
36812d5f0764SLai Jiangshan 		} else {
36822d5f0764SLai Jiangshan 			ctx->dfl_pwq->refcnt++;
36832d5f0764SLai Jiangshan 			ctx->pwq_tbl[node] = ctx->dfl_pwq;
36842d5f0764SLai Jiangshan 		}
36852d5f0764SLai Jiangshan 	}
36862d5f0764SLai Jiangshan 
3687042f7df1SLai Jiangshan 	/* save the user configured attrs and sanitize it. */
3688042f7df1SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
3689042f7df1SLai Jiangshan 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
36902d5f0764SLai Jiangshan 	ctx->attrs = new_attrs;
3691042f7df1SLai Jiangshan 
36922d5f0764SLai Jiangshan 	ctx->wq = wq;
36932d5f0764SLai Jiangshan 	free_workqueue_attrs(tmp_attrs);
36942d5f0764SLai Jiangshan 	return ctx;
36952d5f0764SLai Jiangshan 
36962d5f0764SLai Jiangshan out_free:
36972d5f0764SLai Jiangshan 	free_workqueue_attrs(tmp_attrs);
36982d5f0764SLai Jiangshan 	free_workqueue_attrs(new_attrs);
36992d5f0764SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
37002d5f0764SLai Jiangshan 	return NULL;
37012d5f0764SLai Jiangshan }
37022d5f0764SLai Jiangshan 
37032d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
37042d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
37052d5f0764SLai Jiangshan {
37062d5f0764SLai Jiangshan 	int node;
37072d5f0764SLai Jiangshan 
37082d5f0764SLai Jiangshan 	/* all pwqs have been created successfully, let's install'em */
37092d5f0764SLai Jiangshan 	mutex_lock(&ctx->wq->mutex);
37102d5f0764SLai Jiangshan 
37112d5f0764SLai Jiangshan 	copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
37122d5f0764SLai Jiangshan 
37132d5f0764SLai Jiangshan 	/* save the previous pwq and install the new one */
37142d5f0764SLai Jiangshan 	for_each_node(node)
37152d5f0764SLai Jiangshan 		ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
37162d5f0764SLai Jiangshan 							  ctx->pwq_tbl[node]);
37172d5f0764SLai Jiangshan 
37182d5f0764SLai Jiangshan 	/* @dfl_pwq might not have been used, ensure it's linked */
37192d5f0764SLai Jiangshan 	link_pwq(ctx->dfl_pwq);
37202d5f0764SLai Jiangshan 	swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
37212d5f0764SLai Jiangshan 
37222d5f0764SLai Jiangshan 	mutex_unlock(&ctx->wq->mutex);
37232d5f0764SLai Jiangshan }
37242d5f0764SLai Jiangshan 
3725a0111cf6SLai Jiangshan static void apply_wqattrs_lock(void)
3726a0111cf6SLai Jiangshan {
3727a0111cf6SLai Jiangshan 	/* CPUs should stay stable across pwq creations and installations */
3728a0111cf6SLai Jiangshan 	get_online_cpus();
3729a0111cf6SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
3730a0111cf6SLai Jiangshan }
3731a0111cf6SLai Jiangshan 
3732a0111cf6SLai Jiangshan static void apply_wqattrs_unlock(void)
3733a0111cf6SLai Jiangshan {
3734a0111cf6SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
3735a0111cf6SLai Jiangshan 	put_online_cpus();
3736a0111cf6SLai Jiangshan }
3737a0111cf6SLai Jiangshan 
3738a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3739a0111cf6SLai Jiangshan 					const struct workqueue_attrs *attrs)
3740a0111cf6SLai Jiangshan {
3741a0111cf6SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
3742a0111cf6SLai Jiangshan 
3743a0111cf6SLai Jiangshan 	/* only unbound workqueues can change attributes */
3744a0111cf6SLai Jiangshan 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3745a0111cf6SLai Jiangshan 		return -EINVAL;
3746a0111cf6SLai Jiangshan 
3747a0111cf6SLai Jiangshan 	/* creating multiple pwqs breaks ordering guarantee */
3748a0111cf6SLai Jiangshan 	if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3749a0111cf6SLai Jiangshan 		return -EINVAL;
3750a0111cf6SLai Jiangshan 
3751a0111cf6SLai Jiangshan 	ctx = apply_wqattrs_prepare(wq, attrs);
37526201171eSwanghaibin 	if (!ctx)
37536201171eSwanghaibin 		return -ENOMEM;
3754a0111cf6SLai Jiangshan 
3755a0111cf6SLai Jiangshan 	/* the ctx has been prepared successfully, let's commit it */
3756a0111cf6SLai Jiangshan 	apply_wqattrs_commit(ctx);
3757a0111cf6SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
3758a0111cf6SLai Jiangshan 
37596201171eSwanghaibin 	return 0;
3760a0111cf6SLai Jiangshan }
3761a0111cf6SLai Jiangshan 
37629e8cd2f5STejun Heo /**
37639e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
37649e8cd2f5STejun Heo  * @wq: the target workqueue
37659e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
37669e8cd2f5STejun Heo  *
37674c16bd32STejun Heo  * Apply @attrs to an unbound workqueue @wq.  Unless disabled, on NUMA
37684c16bd32STejun Heo  * machines, this function maps a separate pwq to each NUMA node with
37694c16bd32STejun Heo  * possibles CPUs in @attrs->cpumask so that work items are affine to the
37704c16bd32STejun Heo  * NUMA node it was issued on.  Older pwqs are released as in-flight work
37714c16bd32STejun Heo  * items finish.  Note that a work item which repeatedly requeues itself
37724c16bd32STejun Heo  * back-to-back will stay on its current pwq.
37739e8cd2f5STejun Heo  *
3774d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
3775d185af30SYacine Belkadi  *
3776d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
37779e8cd2f5STejun Heo  */
37789e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq,
37799e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
37809e8cd2f5STejun Heo {
3781a0111cf6SLai Jiangshan 	int ret;
37829e8cd2f5STejun Heo 
3783a0111cf6SLai Jiangshan 	apply_wqattrs_lock();
3784a0111cf6SLai Jiangshan 	ret = apply_workqueue_attrs_locked(wq, attrs);
3785a0111cf6SLai Jiangshan 	apply_wqattrs_unlock();
37862d5f0764SLai Jiangshan 
37872d5f0764SLai Jiangshan 	return ret;
37889e8cd2f5STejun Heo }
37899e8cd2f5STejun Heo 
37904c16bd32STejun Heo /**
37914c16bd32STejun Heo  * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
37924c16bd32STejun Heo  * @wq: the target workqueue
37934c16bd32STejun Heo  * @cpu: the CPU coming up or going down
37944c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
37954c16bd32STejun Heo  *
37964c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
37974c16bd32STejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update NUMA affinity of
37984c16bd32STejun Heo  * @wq accordingly.
37994c16bd32STejun Heo  *
38004c16bd32STejun Heo  * If NUMA affinity can't be adjusted due to memory allocation failure, it
38014c16bd32STejun Heo  * falls back to @wq->dfl_pwq which may not be optimal but is always
38024c16bd32STejun Heo  * correct.
38034c16bd32STejun Heo  *
38044c16bd32STejun Heo  * Note that when the last allowed CPU of a NUMA node goes offline for a
38054c16bd32STejun Heo  * workqueue with a cpumask spanning multiple nodes, the workers which were
38064c16bd32STejun Heo  * already executing the work items for the workqueue will lose their CPU
38074c16bd32STejun Heo  * affinity and may execute on any CPU.  This is similar to how per-cpu
38084c16bd32STejun Heo  * workqueues behave on CPU_DOWN.  If a workqueue user wants strict
38094c16bd32STejun Heo  * affinity, it's the user's responsibility to flush the work item from
38104c16bd32STejun Heo  * CPU_DOWN_PREPARE.
38114c16bd32STejun Heo  */
38124c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
38134c16bd32STejun Heo 				   bool online)
38144c16bd32STejun Heo {
38154c16bd32STejun Heo 	int node = cpu_to_node(cpu);
38164c16bd32STejun Heo 	int cpu_off = online ? -1 : cpu;
38174c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
38184c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
38194c16bd32STejun Heo 	cpumask_t *cpumask;
38204c16bd32STejun Heo 
38214c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
38224c16bd32STejun Heo 
3823f7142ed4SLai Jiangshan 	if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
3824f7142ed4SLai Jiangshan 	    wq->unbound_attrs->no_numa)
38254c16bd32STejun Heo 		return;
38264c16bd32STejun Heo 
38274c16bd32STejun Heo 	/*
38284c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
38294c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
38304c16bd32STejun Heo 	 * CPU hotplug exclusion.
38314c16bd32STejun Heo 	 */
38324c16bd32STejun Heo 	target_attrs = wq_update_unbound_numa_attrs_buf;
38334c16bd32STejun Heo 	cpumask = target_attrs->cpumask;
38344c16bd32STejun Heo 
38354c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
38364c16bd32STejun Heo 	pwq = unbound_pwq_by_node(wq, node);
38374c16bd32STejun Heo 
38384c16bd32STejun Heo 	/*
38394c16bd32STejun Heo 	 * Let's determine what needs to be done.  If the target cpumask is
3840042f7df1SLai Jiangshan 	 * different from the default pwq's, we need to compare it to @pwq's
3841042f7df1SLai Jiangshan 	 * and create a new one if they don't match.  If the target cpumask
3842042f7df1SLai Jiangshan 	 * equals the default pwq's, the default pwq should be used.
38434c16bd32STejun Heo 	 */
3844042f7df1SLai Jiangshan 	if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
38454c16bd32STejun Heo 		if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
3846f7142ed4SLai Jiangshan 			return;
38474c16bd32STejun Heo 	} else {
38484c16bd32STejun Heo 		goto use_dfl_pwq;
38494c16bd32STejun Heo 	}
38504c16bd32STejun Heo 
38514c16bd32STejun Heo 	/* create a new pwq */
38524c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
38534c16bd32STejun Heo 	if (!pwq) {
38542d916033SFabian Frederick 		pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
38554c16bd32STejun Heo 			wq->name);
385677f300b1SDaeseok Youn 		goto use_dfl_pwq;
38574c16bd32STejun Heo 	}
38584c16bd32STejun Heo 
3859f7142ed4SLai Jiangshan 	/* Install the new pwq. */
38604c16bd32STejun Heo 	mutex_lock(&wq->mutex);
38614c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, pwq);
38624c16bd32STejun Heo 	goto out_unlock;
38634c16bd32STejun Heo 
38644c16bd32STejun Heo use_dfl_pwq:
3865f7142ed4SLai Jiangshan 	mutex_lock(&wq->mutex);
38664c16bd32STejun Heo 	spin_lock_irq(&wq->dfl_pwq->pool->lock);
38674c16bd32STejun Heo 	get_pwq(wq->dfl_pwq);
38684c16bd32STejun Heo 	spin_unlock_irq(&wq->dfl_pwq->pool->lock);
38694c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
38704c16bd32STejun Heo out_unlock:
38714c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
38724c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
38734c16bd32STejun Heo }
38744c16bd32STejun Heo 
387530cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
38761da177e4SLinus Torvalds {
387749e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
38788a2b7538STejun Heo 	int cpu, ret;
3879e1d8aa9fSFrederic Weisbecker 
388030cdf249STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
3881420c0ddbSTejun Heo 		wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3882420c0ddbSTejun Heo 		if (!wq->cpu_pwqs)
388330cdf249STejun Heo 			return -ENOMEM;
388430cdf249STejun Heo 
388530cdf249STejun Heo 		for_each_possible_cpu(cpu) {
38867fb98ea7STejun Heo 			struct pool_workqueue *pwq =
38877fb98ea7STejun Heo 				per_cpu_ptr(wq->cpu_pwqs, cpu);
38887a62c2c8STejun Heo 			struct worker_pool *cpu_pools =
3889f02ae73aSTejun Heo 				per_cpu(cpu_worker_pools, cpu);
389030cdf249STejun Heo 
3891f147f29eSTejun Heo 			init_pwq(pwq, wq, &cpu_pools[highpri]);
3892f147f29eSTejun Heo 
3893f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
38941befcf30STejun Heo 			link_pwq(pwq);
3895f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
389630cdf249STejun Heo 		}
389730cdf249STejun Heo 		return 0;
38988a2b7538STejun Heo 	} else if (wq->flags & __WQ_ORDERED) {
38998a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
39008a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
39018a2b7538STejun Heo 		WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
39028a2b7538STejun Heo 			      wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
39038a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
39048a2b7538STejun Heo 		return ret;
39059e8cd2f5STejun Heo 	} else {
39069e8cd2f5STejun Heo 		return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
39079e8cd2f5STejun Heo 	}
39080f900049STejun Heo }
39090f900049STejun Heo 
3910f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3911f3421797STejun Heo 			       const char *name)
3912b71ab8c2STejun Heo {
3913f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3914f3421797STejun Heo 
3915f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3916044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3917f3421797STejun Heo 			max_active, name, 1, lim);
3918b71ab8c2STejun Heo 
3919f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3920b71ab8c2STejun Heo }
3921b71ab8c2STejun Heo 
3922b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
392397e37d7bSTejun Heo 					       unsigned int flags,
39241e19ffc6STejun Heo 					       int max_active,
3925eb13ba87SJohannes Berg 					       struct lock_class_key *key,
3926b196be89STejun Heo 					       const char *lock_name, ...)
39273af24433SOleg Nesterov {
3928df2d5ae4STejun Heo 	size_t tbl_size = 0;
3929ecf6881fSTejun Heo 	va_list args;
39303af24433SOleg Nesterov 	struct workqueue_struct *wq;
393149e3cf44STejun Heo 	struct pool_workqueue *pwq;
3932b196be89STejun Heo 
3933cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
3934cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
3935cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
3936cee22a15SViresh Kumar 
3937ecf6881fSTejun Heo 	/* allocate wq and format name */
3938df2d5ae4STejun Heo 	if (flags & WQ_UNBOUND)
3939ddcb57e2SLai Jiangshan 		tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
3940df2d5ae4STejun Heo 
3941df2d5ae4STejun Heo 	wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
3942b196be89STejun Heo 	if (!wq)
3943d2c1d404STejun Heo 		return NULL;
3944b196be89STejun Heo 
39456029a918STejun Heo 	if (flags & WQ_UNBOUND) {
39466029a918STejun Heo 		wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
39476029a918STejun Heo 		if (!wq->unbound_attrs)
39486029a918STejun Heo 			goto err_free_wq;
39496029a918STejun Heo 	}
39506029a918STejun Heo 
3951ecf6881fSTejun Heo 	va_start(args, lock_name);
3952ecf6881fSTejun Heo 	vsnprintf(wq->name, sizeof(wq->name), fmt, args);
3953b196be89STejun Heo 	va_end(args);
39543af24433SOleg Nesterov 
3955d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
3956b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
39573af24433SOleg Nesterov 
3958b196be89STejun Heo 	/* init wq */
395997e37d7bSTejun Heo 	wq->flags = flags;
3960a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
39613c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
3962112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
396330cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
396473f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
396573f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
3966493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
39673af24433SOleg Nesterov 
3968eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
3969cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
39703af24433SOleg Nesterov 
397130cdf249STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
3972d2c1d404STejun Heo 		goto err_free_wq;
39731537663fSTejun Heo 
3974493008a8STejun Heo 	/*
3975493008a8STejun Heo 	 * Workqueues which may be used during memory reclaim should
3976493008a8STejun Heo 	 * have a rescuer to guarantee forward progress.
3977493008a8STejun Heo 	 */
3978493008a8STejun Heo 	if (flags & WQ_MEM_RECLAIM) {
3979e22bee78STejun Heo 		struct worker *rescuer;
3980e22bee78STejun Heo 
3981f7537df5SLai Jiangshan 		rescuer = alloc_worker(NUMA_NO_NODE);
3982e22bee78STejun Heo 		if (!rescuer)
3983d2c1d404STejun Heo 			goto err_destroy;
3984e22bee78STejun Heo 
3985111c225aSTejun Heo 		rescuer->rescue_wq = wq;
3986111c225aSTejun Heo 		rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
3987b196be89STejun Heo 					       wq->name);
3988d2c1d404STejun Heo 		if (IS_ERR(rescuer->task)) {
3989d2c1d404STejun Heo 			kfree(rescuer);
3990d2c1d404STejun Heo 			goto err_destroy;
3991d2c1d404STejun Heo 		}
3992e22bee78STejun Heo 
3993d2c1d404STejun Heo 		wq->rescuer = rescuer;
399425834c73SPeter Zijlstra 		kthread_bind_mask(rescuer->task, cpu_possible_mask);
3995e22bee78STejun Heo 		wake_up_process(rescuer->task);
39963af24433SOleg Nesterov 	}
39971537663fSTejun Heo 
3998226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3999226223abSTejun Heo 		goto err_destroy;
4000226223abSTejun Heo 
40013af24433SOleg Nesterov 	/*
400268e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
400368e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
400468e13a67SLai Jiangshan 	 * list.
40053af24433SOleg Nesterov 	 */
400668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4007a0a1a5fdSTejun Heo 
4008a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
400949e3cf44STejun Heo 	for_each_pwq(pwq, wq)
4010699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4011a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4012a0a1a5fdSTejun Heo 
4013e2dca7adSTejun Heo 	list_add_tail_rcu(&wq->list, &workqueues);
4014a0a1a5fdSTejun Heo 
401568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
40163af24433SOleg Nesterov 
40173af24433SOleg Nesterov 	return wq;
4018d2c1d404STejun Heo 
4019d2c1d404STejun Heo err_free_wq:
40206029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
40214690c4abSTejun Heo 	kfree(wq);
4022d2c1d404STejun Heo 	return NULL;
4023d2c1d404STejun Heo err_destroy:
4024d2c1d404STejun Heo 	destroy_workqueue(wq);
40254690c4abSTejun Heo 	return NULL;
40261da177e4SLinus Torvalds }
4027d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
40281da177e4SLinus Torvalds 
40293af24433SOleg Nesterov /**
40303af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
40313af24433SOleg Nesterov  * @wq: target workqueue
40323af24433SOleg Nesterov  *
40333af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
40343af24433SOleg Nesterov  */
40353af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
40363af24433SOleg Nesterov {
403749e3cf44STejun Heo 	struct pool_workqueue *pwq;
40384c16bd32STejun Heo 	int node;
40393af24433SOleg Nesterov 
40409c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
40419c5a2ba7STejun Heo 	drain_workqueue(wq);
4042c8efcc25STejun Heo 
40436183c009STejun Heo 	/* sanity checks */
4044b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
404549e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
40466183c009STejun Heo 		int i;
40476183c009STejun Heo 
404876af4d93STejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++) {
404976af4d93STejun Heo 			if (WARN_ON(pwq->nr_in_flight[i])) {
4050b09f4fd3SLai Jiangshan 				mutex_unlock(&wq->mutex);
40516183c009STejun Heo 				return;
405276af4d93STejun Heo 			}
405376af4d93STejun Heo 		}
405476af4d93STejun Heo 
40555c529597SLai Jiangshan 		if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
40568864b4e5STejun Heo 		    WARN_ON(pwq->nr_active) ||
405776af4d93STejun Heo 		    WARN_ON(!list_empty(&pwq->delayed_works))) {
4058b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
40596183c009STejun Heo 			return;
40606183c009STejun Heo 		}
406176af4d93STejun Heo 	}
4062b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
40636183c009STejun Heo 
4064a0a1a5fdSTejun Heo 	/*
4065a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
4066a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
4067a0a1a5fdSTejun Heo 	 */
406868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4069e2dca7adSTejun Heo 	list_del_rcu(&wq->list);
407068e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
40713af24433SOleg Nesterov 
4072226223abSTejun Heo 	workqueue_sysfs_unregister(wq);
4073226223abSTejun Heo 
4074e2dca7adSTejun Heo 	if (wq->rescuer)
4075e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
4076e22bee78STejun Heo 
40778864b4e5STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
407829c91e99STejun Heo 		/*
40798864b4e5STejun Heo 		 * The base ref is never dropped on per-cpu pwqs.  Directly
4080e2dca7adSTejun Heo 		 * schedule RCU free.
408129c91e99STejun Heo 		 */
4082e2dca7adSTejun Heo 		call_rcu_sched(&wq->rcu, rcu_free_wq);
40838864b4e5STejun Heo 	} else {
40848864b4e5STejun Heo 		/*
40858864b4e5STejun Heo 		 * We're the sole accessor of @wq at this point.  Directly
40864c16bd32STejun Heo 		 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
40874c16bd32STejun Heo 		 * @wq will be freed when the last pwq is released.
40888864b4e5STejun Heo 		 */
40894c16bd32STejun Heo 		for_each_node(node) {
40904c16bd32STejun Heo 			pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
40914c16bd32STejun Heo 			RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
40924c16bd32STejun Heo 			put_pwq_unlocked(pwq);
40934c16bd32STejun Heo 		}
40944c16bd32STejun Heo 
40954c16bd32STejun Heo 		/*
40964c16bd32STejun Heo 		 * Put dfl_pwq.  @wq may be freed any time after dfl_pwq is
40974c16bd32STejun Heo 		 * put.  Don't access it afterwards.
40984c16bd32STejun Heo 		 */
40994c16bd32STejun Heo 		pwq = wq->dfl_pwq;
41004c16bd32STejun Heo 		wq->dfl_pwq = NULL;
4101dce90d47STejun Heo 		put_pwq_unlocked(pwq);
410229c91e99STejun Heo 	}
41033af24433SOleg Nesterov }
41043af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
41053af24433SOleg Nesterov 
4106dcd989cbSTejun Heo /**
4107dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
4108dcd989cbSTejun Heo  * @wq: target workqueue
4109dcd989cbSTejun Heo  * @max_active: new max_active value.
4110dcd989cbSTejun Heo  *
4111dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
4112dcd989cbSTejun Heo  *
4113dcd989cbSTejun Heo  * CONTEXT:
4114dcd989cbSTejun Heo  * Don't call from IRQ context.
4115dcd989cbSTejun Heo  */
4116dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4117dcd989cbSTejun Heo {
411849e3cf44STejun Heo 	struct pool_workqueue *pwq;
4119dcd989cbSTejun Heo 
41208719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
41218719dceaSTejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
41228719dceaSTejun Heo 		return;
41238719dceaSTejun Heo 
4124f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4125dcd989cbSTejun Heo 
4126a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
4127dcd989cbSTejun Heo 
4128dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
4129dcd989cbSTejun Heo 
4130699ce097STejun Heo 	for_each_pwq(pwq, wq)
4131699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4132dcd989cbSTejun Heo 
4133a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4134dcd989cbSTejun Heo }
4135dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4136dcd989cbSTejun Heo 
4137dcd989cbSTejun Heo /**
4138e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
4139e6267616STejun Heo  *
4140e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
4141e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
4142d185af30SYacine Belkadi  *
4143d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
4144e6267616STejun Heo  */
4145e6267616STejun Heo bool current_is_workqueue_rescuer(void)
4146e6267616STejun Heo {
4147e6267616STejun Heo 	struct worker *worker = current_wq_worker();
4148e6267616STejun Heo 
41496a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
4150e6267616STejun Heo }
4151e6267616STejun Heo 
4152e6267616STejun Heo /**
4153dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
4154dcd989cbSTejun Heo  * @cpu: CPU in question
4155dcd989cbSTejun Heo  * @wq: target workqueue
4156dcd989cbSTejun Heo  *
4157dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
4158dcd989cbSTejun Heo  * no synchronization around this function and the test result is
4159dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4160dcd989cbSTejun Heo  *
4161d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4162d3251859STejun Heo  * Note that both per-cpu and unbound workqueues may be associated with
4163d3251859STejun Heo  * multiple pool_workqueues which have separate congested states.  A
4164d3251859STejun Heo  * workqueue being congested on one CPU doesn't mean the workqueue is also
4165d3251859STejun Heo  * contested on other CPUs / NUMA nodes.
4166d3251859STejun Heo  *
4167d185af30SYacine Belkadi  * Return:
4168dcd989cbSTejun Heo  * %true if congested, %false otherwise.
4169dcd989cbSTejun Heo  */
4170d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4171dcd989cbSTejun Heo {
41727fb98ea7STejun Heo 	struct pool_workqueue *pwq;
417376af4d93STejun Heo 	bool ret;
417476af4d93STejun Heo 
417588109453SLai Jiangshan 	rcu_read_lock_sched();
41767fb98ea7STejun Heo 
4177d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
4178d3251859STejun Heo 		cpu = smp_processor_id();
4179d3251859STejun Heo 
41807fb98ea7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
41817fb98ea7STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
41827fb98ea7STejun Heo 	else
4183df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4184dcd989cbSTejun Heo 
418576af4d93STejun Heo 	ret = !list_empty(&pwq->delayed_works);
418688109453SLai Jiangshan 	rcu_read_unlock_sched();
418776af4d93STejun Heo 
418876af4d93STejun Heo 	return ret;
4189dcd989cbSTejun Heo }
4190dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
4191dcd989cbSTejun Heo 
4192dcd989cbSTejun Heo /**
4193dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
4194dcd989cbSTejun Heo  * @work: the work to be tested
4195dcd989cbSTejun Heo  *
4196dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
4197dcd989cbSTejun Heo  * synchronization around this function and the test result is
4198dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4199dcd989cbSTejun Heo  *
4200d185af30SYacine Belkadi  * Return:
4201dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
4202dcd989cbSTejun Heo  */
4203dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
4204dcd989cbSTejun Heo {
4205fa1b54e6STejun Heo 	struct worker_pool *pool;
4206dcd989cbSTejun Heo 	unsigned long flags;
4207dcd989cbSTejun Heo 	unsigned int ret = 0;
4208dcd989cbSTejun Heo 
4209dcd989cbSTejun Heo 	if (work_pending(work))
4210dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
4211038366c5SLai Jiangshan 
4212fa1b54e6STejun Heo 	local_irq_save(flags);
4213fa1b54e6STejun Heo 	pool = get_work_pool(work);
4214038366c5SLai Jiangshan 	if (pool) {
4215fa1b54e6STejun Heo 		spin_lock(&pool->lock);
4216c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
4217dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
4218fa1b54e6STejun Heo 		spin_unlock(&pool->lock);
4219038366c5SLai Jiangshan 	}
4220fa1b54e6STejun Heo 	local_irq_restore(flags);
4221dcd989cbSTejun Heo 
4222dcd989cbSTejun Heo 	return ret;
4223dcd989cbSTejun Heo }
4224dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
4225dcd989cbSTejun Heo 
42263d1cb205STejun Heo /**
42273d1cb205STejun Heo  * set_worker_desc - set description for the current work item
42283d1cb205STejun Heo  * @fmt: printf-style format string
42293d1cb205STejun Heo  * @...: arguments for the format string
42303d1cb205STejun Heo  *
42313d1cb205STejun Heo  * This function can be called by a running work function to describe what
42323d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
42333d1cb205STejun Heo  * information will be printed out together to help debugging.  The
42343d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
42353d1cb205STejun Heo  */
42363d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
42373d1cb205STejun Heo {
42383d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
42393d1cb205STejun Heo 	va_list args;
42403d1cb205STejun Heo 
42413d1cb205STejun Heo 	if (worker) {
42423d1cb205STejun Heo 		va_start(args, fmt);
42433d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
42443d1cb205STejun Heo 		va_end(args);
42453d1cb205STejun Heo 		worker->desc_valid = true;
42463d1cb205STejun Heo 	}
42473d1cb205STejun Heo }
42483d1cb205STejun Heo 
42493d1cb205STejun Heo /**
42503d1cb205STejun Heo  * print_worker_info - print out worker information and description
42513d1cb205STejun Heo  * @log_lvl: the log level to use when printing
42523d1cb205STejun Heo  * @task: target task
42533d1cb205STejun Heo  *
42543d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
42553d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
42563d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
42573d1cb205STejun Heo  *
42583d1cb205STejun Heo  * This function can be safely called on any task as long as the
42593d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
42603d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
42613d1cb205STejun Heo  */
42623d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
42633d1cb205STejun Heo {
42643d1cb205STejun Heo 	work_func_t *fn = NULL;
42653d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
42663d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
42673d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
42683d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
42693d1cb205STejun Heo 	bool desc_valid = false;
42703d1cb205STejun Heo 	struct worker *worker;
42713d1cb205STejun Heo 
42723d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
42733d1cb205STejun Heo 		return;
42743d1cb205STejun Heo 
42753d1cb205STejun Heo 	/*
42763d1cb205STejun Heo 	 * This function is called without any synchronization and @task
42773d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
42783d1cb205STejun Heo 	 */
42793d1cb205STejun Heo 	worker = probe_kthread_data(task);
42803d1cb205STejun Heo 
42813d1cb205STejun Heo 	/*
42823d1cb205STejun Heo 	 * Carefully copy the associated workqueue's workfn and name.  Keep
42833d1cb205STejun Heo 	 * the original last '\0' in case the original contains garbage.
42843d1cb205STejun Heo 	 */
42853d1cb205STejun Heo 	probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
42863d1cb205STejun Heo 	probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
42873d1cb205STejun Heo 	probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
42883d1cb205STejun Heo 	probe_kernel_read(name, wq->name, sizeof(name) - 1);
42893d1cb205STejun Heo 
42903d1cb205STejun Heo 	/* copy worker description */
42913d1cb205STejun Heo 	probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
42923d1cb205STejun Heo 	if (desc_valid)
42933d1cb205STejun Heo 		probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
42943d1cb205STejun Heo 
42953d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
42963d1cb205STejun Heo 		printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
42973d1cb205STejun Heo 		if (desc[0])
42983d1cb205STejun Heo 			pr_cont(" (%s)", desc);
42993d1cb205STejun Heo 		pr_cont("\n");
43003d1cb205STejun Heo 	}
43013d1cb205STejun Heo }
43023d1cb205STejun Heo 
43033494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool)
43043494fc30STejun Heo {
43053494fc30STejun Heo 	pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
43063494fc30STejun Heo 	if (pool->node != NUMA_NO_NODE)
43073494fc30STejun Heo 		pr_cont(" node=%d", pool->node);
43083494fc30STejun Heo 	pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
43093494fc30STejun Heo }
43103494fc30STejun Heo 
43113494fc30STejun Heo static void pr_cont_work(bool comma, struct work_struct *work)
43123494fc30STejun Heo {
43133494fc30STejun Heo 	if (work->func == wq_barrier_func) {
43143494fc30STejun Heo 		struct wq_barrier *barr;
43153494fc30STejun Heo 
43163494fc30STejun Heo 		barr = container_of(work, struct wq_barrier, work);
43173494fc30STejun Heo 
43183494fc30STejun Heo 		pr_cont("%s BAR(%d)", comma ? "," : "",
43193494fc30STejun Heo 			task_pid_nr(barr->task));
43203494fc30STejun Heo 	} else {
43213494fc30STejun Heo 		pr_cont("%s %pf", comma ? "," : "", work->func);
43223494fc30STejun Heo 	}
43233494fc30STejun Heo }
43243494fc30STejun Heo 
43253494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq)
43263494fc30STejun Heo {
43273494fc30STejun Heo 	struct worker_pool *pool = pwq->pool;
43283494fc30STejun Heo 	struct work_struct *work;
43293494fc30STejun Heo 	struct worker *worker;
43303494fc30STejun Heo 	bool has_in_flight = false, has_pending = false;
43313494fc30STejun Heo 	int bkt;
43323494fc30STejun Heo 
43333494fc30STejun Heo 	pr_info("  pwq %d:", pool->id);
43343494fc30STejun Heo 	pr_cont_pool_info(pool);
43353494fc30STejun Heo 
43363494fc30STejun Heo 	pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
43373494fc30STejun Heo 		!list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
43383494fc30STejun Heo 
43393494fc30STejun Heo 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
43403494fc30STejun Heo 		if (worker->current_pwq == pwq) {
43413494fc30STejun Heo 			has_in_flight = true;
43423494fc30STejun Heo 			break;
43433494fc30STejun Heo 		}
43443494fc30STejun Heo 	}
43453494fc30STejun Heo 	if (has_in_flight) {
43463494fc30STejun Heo 		bool comma = false;
43473494fc30STejun Heo 
43483494fc30STejun Heo 		pr_info("    in-flight:");
43493494fc30STejun Heo 		hash_for_each(pool->busy_hash, bkt, worker, hentry) {
43503494fc30STejun Heo 			if (worker->current_pwq != pwq)
43513494fc30STejun Heo 				continue;
43523494fc30STejun Heo 
43533494fc30STejun Heo 			pr_cont("%s %d%s:%pf", comma ? "," : "",
43543494fc30STejun Heo 				task_pid_nr(worker->task),
43553494fc30STejun Heo 				worker == pwq->wq->rescuer ? "(RESCUER)" : "",
43563494fc30STejun Heo 				worker->current_func);
43573494fc30STejun Heo 			list_for_each_entry(work, &worker->scheduled, entry)
43583494fc30STejun Heo 				pr_cont_work(false, work);
43593494fc30STejun Heo 			comma = true;
43603494fc30STejun Heo 		}
43613494fc30STejun Heo 		pr_cont("\n");
43623494fc30STejun Heo 	}
43633494fc30STejun Heo 
43643494fc30STejun Heo 	list_for_each_entry(work, &pool->worklist, entry) {
43653494fc30STejun Heo 		if (get_work_pwq(work) == pwq) {
43663494fc30STejun Heo 			has_pending = true;
43673494fc30STejun Heo 			break;
43683494fc30STejun Heo 		}
43693494fc30STejun Heo 	}
43703494fc30STejun Heo 	if (has_pending) {
43713494fc30STejun Heo 		bool comma = false;
43723494fc30STejun Heo 
43733494fc30STejun Heo 		pr_info("    pending:");
43743494fc30STejun Heo 		list_for_each_entry(work, &pool->worklist, entry) {
43753494fc30STejun Heo 			if (get_work_pwq(work) != pwq)
43763494fc30STejun Heo 				continue;
43773494fc30STejun Heo 
43783494fc30STejun Heo 			pr_cont_work(comma, work);
43793494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
43803494fc30STejun Heo 		}
43813494fc30STejun Heo 		pr_cont("\n");
43823494fc30STejun Heo 	}
43833494fc30STejun Heo 
43843494fc30STejun Heo 	if (!list_empty(&pwq->delayed_works)) {
43853494fc30STejun Heo 		bool comma = false;
43863494fc30STejun Heo 
43873494fc30STejun Heo 		pr_info("    delayed:");
43883494fc30STejun Heo 		list_for_each_entry(work, &pwq->delayed_works, entry) {
43893494fc30STejun Heo 			pr_cont_work(comma, work);
43903494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
43913494fc30STejun Heo 		}
43923494fc30STejun Heo 		pr_cont("\n");
43933494fc30STejun Heo 	}
43943494fc30STejun Heo }
43953494fc30STejun Heo 
43963494fc30STejun Heo /**
43973494fc30STejun Heo  * show_workqueue_state - dump workqueue state
43983494fc30STejun Heo  *
43993494fc30STejun Heo  * Called from a sysrq handler and prints out all busy workqueues and
44003494fc30STejun Heo  * pools.
44013494fc30STejun Heo  */
44023494fc30STejun Heo void show_workqueue_state(void)
44033494fc30STejun Heo {
44043494fc30STejun Heo 	struct workqueue_struct *wq;
44053494fc30STejun Heo 	struct worker_pool *pool;
44063494fc30STejun Heo 	unsigned long flags;
44073494fc30STejun Heo 	int pi;
44083494fc30STejun Heo 
44093494fc30STejun Heo 	rcu_read_lock_sched();
44103494fc30STejun Heo 
44113494fc30STejun Heo 	pr_info("Showing busy workqueues and worker pools:\n");
44123494fc30STejun Heo 
44133494fc30STejun Heo 	list_for_each_entry_rcu(wq, &workqueues, list) {
44143494fc30STejun Heo 		struct pool_workqueue *pwq;
44153494fc30STejun Heo 		bool idle = true;
44163494fc30STejun Heo 
44173494fc30STejun Heo 		for_each_pwq(pwq, wq) {
44183494fc30STejun Heo 			if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
44193494fc30STejun Heo 				idle = false;
44203494fc30STejun Heo 				break;
44213494fc30STejun Heo 			}
44223494fc30STejun Heo 		}
44233494fc30STejun Heo 		if (idle)
44243494fc30STejun Heo 			continue;
44253494fc30STejun Heo 
44263494fc30STejun Heo 		pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
44273494fc30STejun Heo 
44283494fc30STejun Heo 		for_each_pwq(pwq, wq) {
44293494fc30STejun Heo 			spin_lock_irqsave(&pwq->pool->lock, flags);
44303494fc30STejun Heo 			if (pwq->nr_active || !list_empty(&pwq->delayed_works))
44313494fc30STejun Heo 				show_pwq(pwq);
44323494fc30STejun Heo 			spin_unlock_irqrestore(&pwq->pool->lock, flags);
44333494fc30STejun Heo 		}
44343494fc30STejun Heo 	}
44353494fc30STejun Heo 
44363494fc30STejun Heo 	for_each_pool(pool, pi) {
44373494fc30STejun Heo 		struct worker *worker;
44383494fc30STejun Heo 		bool first = true;
44393494fc30STejun Heo 
44403494fc30STejun Heo 		spin_lock_irqsave(&pool->lock, flags);
44413494fc30STejun Heo 		if (pool->nr_workers == pool->nr_idle)
44423494fc30STejun Heo 			goto next_pool;
44433494fc30STejun Heo 
44443494fc30STejun Heo 		pr_info("pool %d:", pool->id);
44453494fc30STejun Heo 		pr_cont_pool_info(pool);
444682607adcSTejun Heo 		pr_cont(" hung=%us workers=%d",
444782607adcSTejun Heo 			jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
444882607adcSTejun Heo 			pool->nr_workers);
44493494fc30STejun Heo 		if (pool->manager)
44503494fc30STejun Heo 			pr_cont(" manager: %d",
44513494fc30STejun Heo 				task_pid_nr(pool->manager->task));
44523494fc30STejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry) {
44533494fc30STejun Heo 			pr_cont(" %s%d", first ? "idle: " : "",
44543494fc30STejun Heo 				task_pid_nr(worker->task));
44553494fc30STejun Heo 			first = false;
44563494fc30STejun Heo 		}
44573494fc30STejun Heo 		pr_cont("\n");
44583494fc30STejun Heo 	next_pool:
44593494fc30STejun Heo 		spin_unlock_irqrestore(&pool->lock, flags);
44603494fc30STejun Heo 	}
44613494fc30STejun Heo 
44623494fc30STejun Heo 	rcu_read_unlock_sched();
44633494fc30STejun Heo }
44643494fc30STejun Heo 
4465db7bccf4STejun Heo /*
4466db7bccf4STejun Heo  * CPU hotplug.
4467db7bccf4STejun Heo  *
4468e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
4469112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
4470706026c2STejun Heo  * pool which make migrating pending and scheduled works very
4471e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
447294cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
4473e22bee78STejun Heo  * blocked draining impractical.
4474e22bee78STejun Heo  *
447524647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
4476628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
4477628c78e7STejun Heo  * cpu comes back online.
4478db7bccf4STejun Heo  */
4479db7bccf4STejun Heo 
4480706026c2STejun Heo static void wq_unbind_fn(struct work_struct *work)
4481db7bccf4STejun Heo {
448238db41d9STejun Heo 	int cpu = smp_processor_id();
44834ce62e9eSTejun Heo 	struct worker_pool *pool;
4484db7bccf4STejun Heo 	struct worker *worker;
4485db7bccf4STejun Heo 
4486f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
448792f9c5c4SLai Jiangshan 		mutex_lock(&pool->attach_mutex);
448894cf58bbSTejun Heo 		spin_lock_irq(&pool->lock);
4489e22bee78STejun Heo 
4490f2d5a0eeSTejun Heo 		/*
449192f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
449294cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
449394cf58bbSTejun Heo 		 * except for the ones which are still executing works from
449494cf58bbSTejun Heo 		 * before the last CPU down must be on the cpu.  After
449594cf58bbSTejun Heo 		 * this, they may become diasporas.
4496f2d5a0eeSTejun Heo 		 */
4497da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
4498403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
4499db7bccf4STejun Heo 
450024647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
4501f2d5a0eeSTejun Heo 
450294cf58bbSTejun Heo 		spin_unlock_irq(&pool->lock);
450392f9c5c4SLai Jiangshan 		mutex_unlock(&pool->attach_mutex);
4504e22bee78STejun Heo 
4505e22bee78STejun Heo 		/*
4506eb283428SLai Jiangshan 		 * Call schedule() so that we cross rq->lock and thus can
4507eb283428SLai Jiangshan 		 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4508eb283428SLai Jiangshan 		 * This is necessary as scheduler callbacks may be invoked
4509eb283428SLai Jiangshan 		 * from other cpus.
4510628c78e7STejun Heo 		 */
4511628c78e7STejun Heo 		schedule();
4512628c78e7STejun Heo 
4513628c78e7STejun Heo 		/*
4514eb283428SLai Jiangshan 		 * Sched callbacks are disabled now.  Zap nr_running.
4515eb283428SLai Jiangshan 		 * After this, nr_running stays zero and need_more_worker()
4516eb283428SLai Jiangshan 		 * and keep_working() are always true as long as the
4517eb283428SLai Jiangshan 		 * worklist is not empty.  This pool now behaves as an
4518eb283428SLai Jiangshan 		 * unbound (in terms of concurrency management) pool which
4519eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
4520e22bee78STejun Heo 		 */
4521e19e397aSTejun Heo 		atomic_set(&pool->nr_running, 0);
4522eb283428SLai Jiangshan 
4523eb283428SLai Jiangshan 		/*
4524eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
4525eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
4526eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
4527eb283428SLai Jiangshan 		 */
4528eb283428SLai Jiangshan 		spin_lock_irq(&pool->lock);
4529eb283428SLai Jiangshan 		wake_up_worker(pool);
4530eb283428SLai Jiangshan 		spin_unlock_irq(&pool->lock);
4531eb283428SLai Jiangshan 	}
4532db7bccf4STejun Heo }
4533db7bccf4STejun Heo 
4534bd7c089eSTejun Heo /**
4535bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
4536bd7c089eSTejun Heo  * @pool: pool of interest
4537bd7c089eSTejun Heo  *
4538a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
4539bd7c089eSTejun Heo  */
4540bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
4541bd7c089eSTejun Heo {
4542a9ab775bSTejun Heo 	struct worker *worker;
4543bd7c089eSTejun Heo 
454492f9c5c4SLai Jiangshan 	lockdep_assert_held(&pool->attach_mutex);
4545bd7c089eSTejun Heo 
4546bd7c089eSTejun Heo 	/*
4547a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
4548a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
4549402dd89dSShailendra Verma 	 * wake-ups for concurrency management happen, restore CPU affinity
4550a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
4551a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
4552bd7c089eSTejun Heo 	 */
4553da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
4554a9ab775bSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4555a9ab775bSTejun Heo 						  pool->attrs->cpumask) < 0);
4556a9ab775bSTejun Heo 
4557a9ab775bSTejun Heo 	spin_lock_irq(&pool->lock);
45583de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
4559a9ab775bSTejun Heo 
4560da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
4561a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
4562a9ab775bSTejun Heo 
4563a9ab775bSTejun Heo 		/*
4564a9ab775bSTejun Heo 		 * A bound idle worker should actually be on the runqueue
4565a9ab775bSTejun Heo 		 * of the associated CPU for local wake-ups targeting it to
4566a9ab775bSTejun Heo 		 * work.  Kick all idle workers so that they migrate to the
4567a9ab775bSTejun Heo 		 * associated CPU.  Doing this in the same loop as
4568a9ab775bSTejun Heo 		 * replacing UNBOUND with REBOUND is safe as no worker will
4569a9ab775bSTejun Heo 		 * be bound before @pool->lock is released.
4570a9ab775bSTejun Heo 		 */
4571a9ab775bSTejun Heo 		if (worker_flags & WORKER_IDLE)
4572bd7c089eSTejun Heo 			wake_up_process(worker->task);
4573bd7c089eSTejun Heo 
4574bd7c089eSTejun Heo 		/*
4575a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
4576a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
4577a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4578a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
4579a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
4580a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
4581a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
4582a9ab775bSTejun Heo 		 *
4583a9ab775bSTejun Heo 		 * ACCESS_ONCE() is necessary because @worker->flags may be
4584a9ab775bSTejun Heo 		 * tested without holding any lock in
4585a9ab775bSTejun Heo 		 * wq_worker_waking_up().  Without it, NOT_RUNNING test may
4586a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
4587a9ab775bSTejun Heo 		 * management operations.
4588bd7c089eSTejun Heo 		 */
4589a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4590a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
4591a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
4592a9ab775bSTejun Heo 		ACCESS_ONCE(worker->flags) = worker_flags;
4593bd7c089eSTejun Heo 	}
4594a9ab775bSTejun Heo 
4595a9ab775bSTejun Heo 	spin_unlock_irq(&pool->lock);
4596bd7c089eSTejun Heo }
4597bd7c089eSTejun Heo 
45987dbc725eSTejun Heo /**
45997dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
46007dbc725eSTejun Heo  * @pool: unbound pool of interest
46017dbc725eSTejun Heo  * @cpu: the CPU which is coming up
46027dbc725eSTejun Heo  *
46037dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
46047dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
46057dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
46067dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
46077dbc725eSTejun Heo  */
46087dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
46097dbc725eSTejun Heo {
46107dbc725eSTejun Heo 	static cpumask_t cpumask;
46117dbc725eSTejun Heo 	struct worker *worker;
46127dbc725eSTejun Heo 
461392f9c5c4SLai Jiangshan 	lockdep_assert_held(&pool->attach_mutex);
46147dbc725eSTejun Heo 
46157dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
46167dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
46177dbc725eSTejun Heo 		return;
46187dbc725eSTejun Heo 
46197dbc725eSTejun Heo 	/* is @cpu the only online CPU? */
46207dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
46217dbc725eSTejun Heo 	if (cpumask_weight(&cpumask) != 1)
46227dbc725eSTejun Heo 		return;
46237dbc725eSTejun Heo 
46247dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
4625da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
46267dbc725eSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
46277dbc725eSTejun Heo 						  pool->attrs->cpumask) < 0);
46287dbc725eSTejun Heo }
46297dbc725eSTejun Heo 
46308db25e78STejun Heo /*
46318db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
46328db25e78STejun Heo  * This will be registered high priority CPU notifier.
46338db25e78STejun Heo  */
46340db0628dSPaul Gortmaker static int workqueue_cpu_up_callback(struct notifier_block *nfb,
46351da177e4SLinus Torvalds 					       unsigned long action,
46361da177e4SLinus Torvalds 					       void *hcpu)
46371da177e4SLinus Torvalds {
4638d84ff051STejun Heo 	int cpu = (unsigned long)hcpu;
46394ce62e9eSTejun Heo 	struct worker_pool *pool;
46404c16bd32STejun Heo 	struct workqueue_struct *wq;
46417dbc725eSTejun Heo 	int pi;
46421da177e4SLinus Torvalds 
46438db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
46443af24433SOleg Nesterov 	case CPU_UP_PREPARE:
4645f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
46463ce63377STejun Heo 			if (pool->nr_workers)
46473ce63377STejun Heo 				continue;
4648051e1850SLai Jiangshan 			if (!create_worker(pool))
46493ce63377STejun Heo 				return NOTIFY_BAD;
46503af24433SOleg Nesterov 		}
46511da177e4SLinus Torvalds 		break;
46521da177e4SLinus Torvalds 
465365758202STejun Heo 	case CPU_DOWN_FAILED:
465465758202STejun Heo 	case CPU_ONLINE:
465568e13a67SLai Jiangshan 		mutex_lock(&wq_pool_mutex);
46567dbc725eSTejun Heo 
46577dbc725eSTejun Heo 		for_each_pool(pool, pi) {
465892f9c5c4SLai Jiangshan 			mutex_lock(&pool->attach_mutex);
465994cf58bbSTejun Heo 
4660f05b558dSLai Jiangshan 			if (pool->cpu == cpu)
466194cf58bbSTejun Heo 				rebind_workers(pool);
4662f05b558dSLai Jiangshan 			else if (pool->cpu < 0)
46637dbc725eSTejun Heo 				restore_unbound_workers_cpumask(pool, cpu);
466494cf58bbSTejun Heo 
466592f9c5c4SLai Jiangshan 			mutex_unlock(&pool->attach_mutex);
466694cf58bbSTejun Heo 		}
46677dbc725eSTejun Heo 
46684c16bd32STejun Heo 		/* update NUMA affinity of unbound workqueues */
46694c16bd32STejun Heo 		list_for_each_entry(wq, &workqueues, list)
46704c16bd32STejun Heo 			wq_update_unbound_numa(wq, cpu, true);
46714c16bd32STejun Heo 
467268e13a67SLai Jiangshan 		mutex_unlock(&wq_pool_mutex);
46738db25e78STejun Heo 		break;
467465758202STejun Heo 	}
467565758202STejun Heo 	return NOTIFY_OK;
467665758202STejun Heo }
467765758202STejun Heo 
467865758202STejun Heo /*
467965758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
468065758202STejun Heo  * This will be registered as low priority CPU notifier.
468165758202STejun Heo  */
46820db0628dSPaul Gortmaker static int workqueue_cpu_down_callback(struct notifier_block *nfb,
468365758202STejun Heo 						 unsigned long action,
468465758202STejun Heo 						 void *hcpu)
468565758202STejun Heo {
4686d84ff051STejun Heo 	int cpu = (unsigned long)hcpu;
46878db25e78STejun Heo 	struct work_struct unbind_work;
46884c16bd32STejun Heo 	struct workqueue_struct *wq;
46898db25e78STejun Heo 
469065758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
469165758202STejun Heo 	case CPU_DOWN_PREPARE:
46924c16bd32STejun Heo 		/* unbinding per-cpu workers should happen on the local CPU */
4693706026c2STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
46947635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
46954c16bd32STejun Heo 
46964c16bd32STejun Heo 		/* update NUMA affinity of unbound workqueues */
46974c16bd32STejun Heo 		mutex_lock(&wq_pool_mutex);
46984c16bd32STejun Heo 		list_for_each_entry(wq, &workqueues, list)
46994c16bd32STejun Heo 			wq_update_unbound_numa(wq, cpu, false);
47004c16bd32STejun Heo 		mutex_unlock(&wq_pool_mutex);
47014c16bd32STejun Heo 
47024c16bd32STejun Heo 		/* wait for per-cpu unbinding to finish */
47038db25e78STejun Heo 		flush_work(&unbind_work);
4704440a1136SChuansheng Liu 		destroy_work_on_stack(&unbind_work);
47058db25e78STejun Heo 		break;
470665758202STejun Heo 	}
470765758202STejun Heo 	return NOTIFY_OK;
470865758202STejun Heo }
470965758202STejun Heo 
47102d3854a3SRusty Russell #ifdef CONFIG_SMP
47118ccad40dSRusty Russell 
47122d3854a3SRusty Russell struct work_for_cpu {
4713ed48ece2STejun Heo 	struct work_struct work;
47142d3854a3SRusty Russell 	long (*fn)(void *);
47152d3854a3SRusty Russell 	void *arg;
47162d3854a3SRusty Russell 	long ret;
47172d3854a3SRusty Russell };
47182d3854a3SRusty Russell 
4719ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
47202d3854a3SRusty Russell {
4721ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4722ed48ece2STejun Heo 
47232d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
47242d3854a3SRusty Russell }
47252d3854a3SRusty Russell 
47262d3854a3SRusty Russell /**
47272d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
47282d3854a3SRusty Russell  * @cpu: the cpu to run on
47292d3854a3SRusty Russell  * @fn: the function to run
47302d3854a3SRusty Russell  * @arg: the function arg
47312d3854a3SRusty Russell  *
473231ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
47336b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
4734d185af30SYacine Belkadi  *
4735d185af30SYacine Belkadi  * Return: The value @fn returns.
47362d3854a3SRusty Russell  */
4737d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
47382d3854a3SRusty Russell {
4739ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
47402d3854a3SRusty Russell 
4741ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4742ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
474312997d1aSBjorn Helgaas 	flush_work(&wfc.work);
4744440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
47452d3854a3SRusty Russell 	return wfc.ret;
47462d3854a3SRusty Russell }
47472d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
47482d3854a3SRusty Russell #endif /* CONFIG_SMP */
47492d3854a3SRusty Russell 
4750a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
4751e7577c50SRusty Russell 
4752a0a1a5fdSTejun Heo /**
4753a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
4754a0a1a5fdSTejun Heo  *
475558a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
4756c5aa87bbSTejun Heo  * workqueues will queue new works to their delayed_works list instead of
4757706026c2STejun Heo  * pool->worklist.
4758a0a1a5fdSTejun Heo  *
4759a0a1a5fdSTejun Heo  * CONTEXT:
4760a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4761a0a1a5fdSTejun Heo  */
4762a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
4763a0a1a5fdSTejun Heo {
476424b8a847STejun Heo 	struct workqueue_struct *wq;
476524b8a847STejun Heo 	struct pool_workqueue *pwq;
4766a0a1a5fdSTejun Heo 
476768e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4768a0a1a5fdSTejun Heo 
47696183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
4770a0a1a5fdSTejun Heo 	workqueue_freezing = true;
4771a0a1a5fdSTejun Heo 
477224b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
4773a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
4774699ce097STejun Heo 		for_each_pwq(pwq, wq)
4775699ce097STejun Heo 			pwq_adjust_max_active(pwq);
4776a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
4777a1056305STejun Heo 	}
47785bcab335STejun Heo 
477968e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4780a0a1a5fdSTejun Heo }
4781a0a1a5fdSTejun Heo 
4782a0a1a5fdSTejun Heo /**
478358a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
4784a0a1a5fdSTejun Heo  *
4785a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
4786a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
4787a0a1a5fdSTejun Heo  *
4788a0a1a5fdSTejun Heo  * CONTEXT:
478968e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
4790a0a1a5fdSTejun Heo  *
4791d185af30SYacine Belkadi  * Return:
479258a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
479358a69cb4STejun Heo  * is complete.
4794a0a1a5fdSTejun Heo  */
4795a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
4796a0a1a5fdSTejun Heo {
4797a0a1a5fdSTejun Heo 	bool busy = false;
479824b8a847STejun Heo 	struct workqueue_struct *wq;
479924b8a847STejun Heo 	struct pool_workqueue *pwq;
4800a0a1a5fdSTejun Heo 
480168e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4802a0a1a5fdSTejun Heo 
48036183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
4804a0a1a5fdSTejun Heo 
480524b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
480624b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
480724b8a847STejun Heo 			continue;
4808a0a1a5fdSTejun Heo 		/*
4809a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
4810a0a1a5fdSTejun Heo 		 * to peek without lock.
4811a0a1a5fdSTejun Heo 		 */
481288109453SLai Jiangshan 		rcu_read_lock_sched();
481324b8a847STejun Heo 		for_each_pwq(pwq, wq) {
48146183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
4815112202d9STejun Heo 			if (pwq->nr_active) {
4816a0a1a5fdSTejun Heo 				busy = true;
481788109453SLai Jiangshan 				rcu_read_unlock_sched();
4818a0a1a5fdSTejun Heo 				goto out_unlock;
4819a0a1a5fdSTejun Heo 			}
4820a0a1a5fdSTejun Heo 		}
482188109453SLai Jiangshan 		rcu_read_unlock_sched();
4822a0a1a5fdSTejun Heo 	}
4823a0a1a5fdSTejun Heo out_unlock:
482468e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4825a0a1a5fdSTejun Heo 	return busy;
4826a0a1a5fdSTejun Heo }
4827a0a1a5fdSTejun Heo 
4828a0a1a5fdSTejun Heo /**
4829a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
4830a0a1a5fdSTejun Heo  *
4831a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
4832706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
4833a0a1a5fdSTejun Heo  *
4834a0a1a5fdSTejun Heo  * CONTEXT:
4835a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4836a0a1a5fdSTejun Heo  */
4837a0a1a5fdSTejun Heo void thaw_workqueues(void)
4838a0a1a5fdSTejun Heo {
483924b8a847STejun Heo 	struct workqueue_struct *wq;
484024b8a847STejun Heo 	struct pool_workqueue *pwq;
4841a0a1a5fdSTejun Heo 
484268e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4843a0a1a5fdSTejun Heo 
4844a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
4845a0a1a5fdSTejun Heo 		goto out_unlock;
4846a0a1a5fdSTejun Heo 
484774b414eaSLai Jiangshan 	workqueue_freezing = false;
484824b8a847STejun Heo 
484924b8a847STejun Heo 	/* restore max_active and repopulate worklist */
485024b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
4851a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
4852699ce097STejun Heo 		for_each_pwq(pwq, wq)
4853699ce097STejun Heo 			pwq_adjust_max_active(pwq);
4854a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
485524b8a847STejun Heo 	}
485624b8a847STejun Heo 
4857a0a1a5fdSTejun Heo out_unlock:
485868e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4859a0a1a5fdSTejun Heo }
4860a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
4861a0a1a5fdSTejun Heo 
4862042f7df1SLai Jiangshan static int workqueue_apply_unbound_cpumask(void)
4863042f7df1SLai Jiangshan {
4864042f7df1SLai Jiangshan 	LIST_HEAD(ctxs);
4865042f7df1SLai Jiangshan 	int ret = 0;
4866042f7df1SLai Jiangshan 	struct workqueue_struct *wq;
4867042f7df1SLai Jiangshan 	struct apply_wqattrs_ctx *ctx, *n;
4868042f7df1SLai Jiangshan 
4869042f7df1SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
4870042f7df1SLai Jiangshan 
4871042f7df1SLai Jiangshan 	list_for_each_entry(wq, &workqueues, list) {
4872042f7df1SLai Jiangshan 		if (!(wq->flags & WQ_UNBOUND))
4873042f7df1SLai Jiangshan 			continue;
4874042f7df1SLai Jiangshan 		/* creating multiple pwqs breaks ordering guarantee */
4875042f7df1SLai Jiangshan 		if (wq->flags & __WQ_ORDERED)
4876042f7df1SLai Jiangshan 			continue;
4877042f7df1SLai Jiangshan 
4878042f7df1SLai Jiangshan 		ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
4879042f7df1SLai Jiangshan 		if (!ctx) {
4880042f7df1SLai Jiangshan 			ret = -ENOMEM;
4881042f7df1SLai Jiangshan 			break;
4882042f7df1SLai Jiangshan 		}
4883042f7df1SLai Jiangshan 
4884042f7df1SLai Jiangshan 		list_add_tail(&ctx->list, &ctxs);
4885042f7df1SLai Jiangshan 	}
4886042f7df1SLai Jiangshan 
4887042f7df1SLai Jiangshan 	list_for_each_entry_safe(ctx, n, &ctxs, list) {
4888042f7df1SLai Jiangshan 		if (!ret)
4889042f7df1SLai Jiangshan 			apply_wqattrs_commit(ctx);
4890042f7df1SLai Jiangshan 		apply_wqattrs_cleanup(ctx);
4891042f7df1SLai Jiangshan 	}
4892042f7df1SLai Jiangshan 
4893042f7df1SLai Jiangshan 	return ret;
4894042f7df1SLai Jiangshan }
4895042f7df1SLai Jiangshan 
4896042f7df1SLai Jiangshan /**
4897042f7df1SLai Jiangshan  *  workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
4898042f7df1SLai Jiangshan  *  @cpumask: the cpumask to set
4899042f7df1SLai Jiangshan  *
4900042f7df1SLai Jiangshan  *  The low-level workqueues cpumask is a global cpumask that limits
4901042f7df1SLai Jiangshan  *  the affinity of all unbound workqueues.  This function check the @cpumask
4902042f7df1SLai Jiangshan  *  and apply it to all unbound workqueues and updates all pwqs of them.
4903042f7df1SLai Jiangshan  *
4904042f7df1SLai Jiangshan  *  Retun:	0	- Success
4905042f7df1SLai Jiangshan  *  		-EINVAL	- Invalid @cpumask
4906042f7df1SLai Jiangshan  *  		-ENOMEM	- Failed to allocate memory for attrs or pwqs.
4907042f7df1SLai Jiangshan  */
4908042f7df1SLai Jiangshan int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
4909042f7df1SLai Jiangshan {
4910042f7df1SLai Jiangshan 	int ret = -EINVAL;
4911042f7df1SLai Jiangshan 	cpumask_var_t saved_cpumask;
4912042f7df1SLai Jiangshan 
4913042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
4914042f7df1SLai Jiangshan 		return -ENOMEM;
4915042f7df1SLai Jiangshan 
4916042f7df1SLai Jiangshan 	cpumask_and(cpumask, cpumask, cpu_possible_mask);
4917042f7df1SLai Jiangshan 	if (!cpumask_empty(cpumask)) {
4918a0111cf6SLai Jiangshan 		apply_wqattrs_lock();
4919042f7df1SLai Jiangshan 
4920042f7df1SLai Jiangshan 		/* save the old wq_unbound_cpumask. */
4921042f7df1SLai Jiangshan 		cpumask_copy(saved_cpumask, wq_unbound_cpumask);
4922042f7df1SLai Jiangshan 
4923042f7df1SLai Jiangshan 		/* update wq_unbound_cpumask at first and apply it to wqs. */
4924042f7df1SLai Jiangshan 		cpumask_copy(wq_unbound_cpumask, cpumask);
4925042f7df1SLai Jiangshan 		ret = workqueue_apply_unbound_cpumask();
4926042f7df1SLai Jiangshan 
4927042f7df1SLai Jiangshan 		/* restore the wq_unbound_cpumask when failed. */
4928042f7df1SLai Jiangshan 		if (ret < 0)
4929042f7df1SLai Jiangshan 			cpumask_copy(wq_unbound_cpumask, saved_cpumask);
4930042f7df1SLai Jiangshan 
4931a0111cf6SLai Jiangshan 		apply_wqattrs_unlock();
4932042f7df1SLai Jiangshan 	}
4933042f7df1SLai Jiangshan 
4934042f7df1SLai Jiangshan 	free_cpumask_var(saved_cpumask);
4935042f7df1SLai Jiangshan 	return ret;
4936042f7df1SLai Jiangshan }
4937042f7df1SLai Jiangshan 
49386ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS
49396ba94429SFrederic Weisbecker /*
49406ba94429SFrederic Weisbecker  * Workqueues with WQ_SYSFS flag set is visible to userland via
49416ba94429SFrederic Weisbecker  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
49426ba94429SFrederic Weisbecker  * following attributes.
49436ba94429SFrederic Weisbecker  *
49446ba94429SFrederic Weisbecker  *  per_cpu	RO bool	: whether the workqueue is per-cpu or unbound
49456ba94429SFrederic Weisbecker  *  max_active	RW int	: maximum number of in-flight work items
49466ba94429SFrederic Weisbecker  *
49476ba94429SFrederic Weisbecker  * Unbound workqueues have the following extra attributes.
49486ba94429SFrederic Weisbecker  *
49496ba94429SFrederic Weisbecker  *  id		RO int	: the associated pool ID
49506ba94429SFrederic Weisbecker  *  nice	RW int	: nice value of the workers
49516ba94429SFrederic Weisbecker  *  cpumask	RW mask	: bitmask of allowed CPUs for the workers
49526ba94429SFrederic Weisbecker  */
49536ba94429SFrederic Weisbecker struct wq_device {
49546ba94429SFrederic Weisbecker 	struct workqueue_struct		*wq;
49556ba94429SFrederic Weisbecker 	struct device			dev;
49566ba94429SFrederic Weisbecker };
49576ba94429SFrederic Weisbecker 
49586ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev)
49596ba94429SFrederic Weisbecker {
49606ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
49616ba94429SFrederic Weisbecker 
49626ba94429SFrederic Weisbecker 	return wq_dev->wq;
49636ba94429SFrederic Weisbecker }
49646ba94429SFrederic Weisbecker 
49656ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
49666ba94429SFrederic Weisbecker 			    char *buf)
49676ba94429SFrederic Weisbecker {
49686ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
49696ba94429SFrederic Weisbecker 
49706ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
49716ba94429SFrederic Weisbecker }
49726ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu);
49736ba94429SFrederic Weisbecker 
49746ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev,
49756ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
49766ba94429SFrederic Weisbecker {
49776ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
49786ba94429SFrederic Weisbecker 
49796ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
49806ba94429SFrederic Weisbecker }
49816ba94429SFrederic Weisbecker 
49826ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev,
49836ba94429SFrederic Weisbecker 				struct device_attribute *attr, const char *buf,
49846ba94429SFrederic Weisbecker 				size_t count)
49856ba94429SFrederic Weisbecker {
49866ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
49876ba94429SFrederic Weisbecker 	int val;
49886ba94429SFrederic Weisbecker 
49896ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
49906ba94429SFrederic Weisbecker 		return -EINVAL;
49916ba94429SFrederic Weisbecker 
49926ba94429SFrederic Weisbecker 	workqueue_set_max_active(wq, val);
49936ba94429SFrederic Weisbecker 	return count;
49946ba94429SFrederic Weisbecker }
49956ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active);
49966ba94429SFrederic Weisbecker 
49976ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = {
49986ba94429SFrederic Weisbecker 	&dev_attr_per_cpu.attr,
49996ba94429SFrederic Weisbecker 	&dev_attr_max_active.attr,
50006ba94429SFrederic Weisbecker 	NULL,
50016ba94429SFrederic Weisbecker };
50026ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs);
50036ba94429SFrederic Weisbecker 
50046ba94429SFrederic Weisbecker static ssize_t wq_pool_ids_show(struct device *dev,
50056ba94429SFrederic Weisbecker 				struct device_attribute *attr, char *buf)
50066ba94429SFrederic Weisbecker {
50076ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
50086ba94429SFrederic Weisbecker 	const char *delim = "";
50096ba94429SFrederic Weisbecker 	int node, written = 0;
50106ba94429SFrederic Weisbecker 
50116ba94429SFrederic Weisbecker 	rcu_read_lock_sched();
50126ba94429SFrederic Weisbecker 	for_each_node(node) {
50136ba94429SFrederic Weisbecker 		written += scnprintf(buf + written, PAGE_SIZE - written,
50146ba94429SFrederic Weisbecker 				     "%s%d:%d", delim, node,
50156ba94429SFrederic Weisbecker 				     unbound_pwq_by_node(wq, node)->pool->id);
50166ba94429SFrederic Weisbecker 		delim = " ";
50176ba94429SFrederic Weisbecker 	}
50186ba94429SFrederic Weisbecker 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
50196ba94429SFrederic Weisbecker 	rcu_read_unlock_sched();
50206ba94429SFrederic Weisbecker 
50216ba94429SFrederic Weisbecker 	return written;
50226ba94429SFrederic Weisbecker }
50236ba94429SFrederic Weisbecker 
50246ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
50256ba94429SFrederic Weisbecker 			    char *buf)
50266ba94429SFrederic Weisbecker {
50276ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
50286ba94429SFrederic Weisbecker 	int written;
50296ba94429SFrederic Weisbecker 
50306ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
50316ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
50326ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
50336ba94429SFrederic Weisbecker 
50346ba94429SFrederic Weisbecker 	return written;
50356ba94429SFrederic Weisbecker }
50366ba94429SFrederic Weisbecker 
50376ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */
50386ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
50396ba94429SFrederic Weisbecker {
50406ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
50416ba94429SFrederic Weisbecker 
5042899a94feSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5043899a94feSLai Jiangshan 
50446ba94429SFrederic Weisbecker 	attrs = alloc_workqueue_attrs(GFP_KERNEL);
50456ba94429SFrederic Weisbecker 	if (!attrs)
50466ba94429SFrederic Weisbecker 		return NULL;
50476ba94429SFrederic Weisbecker 
50486ba94429SFrederic Weisbecker 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
50496ba94429SFrederic Weisbecker 	return attrs;
50506ba94429SFrederic Weisbecker }
50516ba94429SFrederic Weisbecker 
50526ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
50536ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
50546ba94429SFrederic Weisbecker {
50556ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
50566ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5057d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
5058d4d3e257SLai Jiangshan 
5059d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
50606ba94429SFrederic Weisbecker 
50616ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
50626ba94429SFrederic Weisbecker 	if (!attrs)
5063d4d3e257SLai Jiangshan 		goto out_unlock;
50646ba94429SFrederic Weisbecker 
50656ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
50666ba94429SFrederic Weisbecker 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
5067d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
50686ba94429SFrederic Weisbecker 	else
50696ba94429SFrederic Weisbecker 		ret = -EINVAL;
50706ba94429SFrederic Weisbecker 
5071d4d3e257SLai Jiangshan out_unlock:
5072d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
50736ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
50746ba94429SFrederic Weisbecker 	return ret ?: count;
50756ba94429SFrederic Weisbecker }
50766ba94429SFrederic Weisbecker 
50776ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev,
50786ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
50796ba94429SFrederic Weisbecker {
50806ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
50816ba94429SFrederic Weisbecker 	int written;
50826ba94429SFrederic Weisbecker 
50836ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
50846ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
50856ba94429SFrederic Weisbecker 			    cpumask_pr_args(wq->unbound_attrs->cpumask));
50866ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
50876ba94429SFrederic Weisbecker 	return written;
50886ba94429SFrederic Weisbecker }
50896ba94429SFrederic Weisbecker 
50906ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev,
50916ba94429SFrederic Weisbecker 				struct device_attribute *attr,
50926ba94429SFrederic Weisbecker 				const char *buf, size_t count)
50936ba94429SFrederic Weisbecker {
50946ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
50956ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5096d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
5097d4d3e257SLai Jiangshan 
5098d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
50996ba94429SFrederic Weisbecker 
51006ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
51016ba94429SFrederic Weisbecker 	if (!attrs)
5102d4d3e257SLai Jiangshan 		goto out_unlock;
51036ba94429SFrederic Weisbecker 
51046ba94429SFrederic Weisbecker 	ret = cpumask_parse(buf, attrs->cpumask);
51056ba94429SFrederic Weisbecker 	if (!ret)
5106d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
51076ba94429SFrederic Weisbecker 
5108d4d3e257SLai Jiangshan out_unlock:
5109d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
51106ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
51116ba94429SFrederic Weisbecker 	return ret ?: count;
51126ba94429SFrederic Weisbecker }
51136ba94429SFrederic Weisbecker 
51146ba94429SFrederic Weisbecker static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
51156ba94429SFrederic Weisbecker 			    char *buf)
51166ba94429SFrederic Weisbecker {
51176ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
51186ba94429SFrederic Weisbecker 	int written;
51196ba94429SFrederic Weisbecker 
51206ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
51216ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n",
51226ba94429SFrederic Weisbecker 			    !wq->unbound_attrs->no_numa);
51236ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
51246ba94429SFrederic Weisbecker 
51256ba94429SFrederic Weisbecker 	return written;
51266ba94429SFrederic Weisbecker }
51276ba94429SFrederic Weisbecker 
51286ba94429SFrederic Weisbecker static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
51296ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
51306ba94429SFrederic Weisbecker {
51316ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
51326ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5133d4d3e257SLai Jiangshan 	int v, ret = -ENOMEM;
5134d4d3e257SLai Jiangshan 
5135d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
51366ba94429SFrederic Weisbecker 
51376ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
51386ba94429SFrederic Weisbecker 	if (!attrs)
5139d4d3e257SLai Jiangshan 		goto out_unlock;
51406ba94429SFrederic Weisbecker 
51416ba94429SFrederic Weisbecker 	ret = -EINVAL;
51426ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &v) == 1) {
51436ba94429SFrederic Weisbecker 		attrs->no_numa = !v;
5144d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
51456ba94429SFrederic Weisbecker 	}
51466ba94429SFrederic Weisbecker 
5147d4d3e257SLai Jiangshan out_unlock:
5148d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
51496ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
51506ba94429SFrederic Weisbecker 	return ret ?: count;
51516ba94429SFrederic Weisbecker }
51526ba94429SFrederic Weisbecker 
51536ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = {
51546ba94429SFrederic Weisbecker 	__ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
51556ba94429SFrederic Weisbecker 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
51566ba94429SFrederic Weisbecker 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
51576ba94429SFrederic Weisbecker 	__ATTR(numa, 0644, wq_numa_show, wq_numa_store),
51586ba94429SFrederic Weisbecker 	__ATTR_NULL,
51596ba94429SFrederic Weisbecker };
51606ba94429SFrederic Weisbecker 
51616ba94429SFrederic Weisbecker static struct bus_type wq_subsys = {
51626ba94429SFrederic Weisbecker 	.name				= "workqueue",
51636ba94429SFrederic Weisbecker 	.dev_groups			= wq_sysfs_groups,
51646ba94429SFrederic Weisbecker };
51656ba94429SFrederic Weisbecker 
5166b05a7928SFrederic Weisbecker static ssize_t wq_unbound_cpumask_show(struct device *dev,
5167b05a7928SFrederic Weisbecker 		struct device_attribute *attr, char *buf)
5168b05a7928SFrederic Weisbecker {
5169b05a7928SFrederic Weisbecker 	int written;
5170b05a7928SFrederic Weisbecker 
5171042f7df1SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5172b05a7928SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5173b05a7928SFrederic Weisbecker 			    cpumask_pr_args(wq_unbound_cpumask));
5174042f7df1SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5175b05a7928SFrederic Weisbecker 
5176b05a7928SFrederic Weisbecker 	return written;
5177b05a7928SFrederic Weisbecker }
5178b05a7928SFrederic Weisbecker 
5179042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev,
5180042f7df1SLai Jiangshan 		struct device_attribute *attr, const char *buf, size_t count)
5181042f7df1SLai Jiangshan {
5182042f7df1SLai Jiangshan 	cpumask_var_t cpumask;
5183042f7df1SLai Jiangshan 	int ret;
5184042f7df1SLai Jiangshan 
5185042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5186042f7df1SLai Jiangshan 		return -ENOMEM;
5187042f7df1SLai Jiangshan 
5188042f7df1SLai Jiangshan 	ret = cpumask_parse(buf, cpumask);
5189042f7df1SLai Jiangshan 	if (!ret)
5190042f7df1SLai Jiangshan 		ret = workqueue_set_unbound_cpumask(cpumask);
5191042f7df1SLai Jiangshan 
5192042f7df1SLai Jiangshan 	free_cpumask_var(cpumask);
5193042f7df1SLai Jiangshan 	return ret ? ret : count;
5194042f7df1SLai Jiangshan }
5195042f7df1SLai Jiangshan 
5196b05a7928SFrederic Weisbecker static struct device_attribute wq_sysfs_cpumask_attr =
5197042f7df1SLai Jiangshan 	__ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5198042f7df1SLai Jiangshan 	       wq_unbound_cpumask_store);
5199b05a7928SFrederic Weisbecker 
52006ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void)
52016ba94429SFrederic Weisbecker {
5202b05a7928SFrederic Weisbecker 	int err;
5203b05a7928SFrederic Weisbecker 
5204b05a7928SFrederic Weisbecker 	err = subsys_virtual_register(&wq_subsys, NULL);
5205b05a7928SFrederic Weisbecker 	if (err)
5206b05a7928SFrederic Weisbecker 		return err;
5207b05a7928SFrederic Weisbecker 
5208b05a7928SFrederic Weisbecker 	return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
52096ba94429SFrederic Weisbecker }
52106ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init);
52116ba94429SFrederic Weisbecker 
52126ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev)
52136ba94429SFrederic Weisbecker {
52146ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
52156ba94429SFrederic Weisbecker 
52166ba94429SFrederic Weisbecker 	kfree(wq_dev);
52176ba94429SFrederic Weisbecker }
52186ba94429SFrederic Weisbecker 
52196ba94429SFrederic Weisbecker /**
52206ba94429SFrederic Weisbecker  * workqueue_sysfs_register - make a workqueue visible in sysfs
52216ba94429SFrederic Weisbecker  * @wq: the workqueue to register
52226ba94429SFrederic Weisbecker  *
52236ba94429SFrederic Weisbecker  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
52246ba94429SFrederic Weisbecker  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
52256ba94429SFrederic Weisbecker  * which is the preferred method.
52266ba94429SFrederic Weisbecker  *
52276ba94429SFrederic Weisbecker  * Workqueue user should use this function directly iff it wants to apply
52286ba94429SFrederic Weisbecker  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
52296ba94429SFrederic Weisbecker  * apply_workqueue_attrs() may race against userland updating the
52306ba94429SFrederic Weisbecker  * attributes.
52316ba94429SFrederic Weisbecker  *
52326ba94429SFrederic Weisbecker  * Return: 0 on success, -errno on failure.
52336ba94429SFrederic Weisbecker  */
52346ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq)
52356ba94429SFrederic Weisbecker {
52366ba94429SFrederic Weisbecker 	struct wq_device *wq_dev;
52376ba94429SFrederic Weisbecker 	int ret;
52386ba94429SFrederic Weisbecker 
52396ba94429SFrederic Weisbecker 	/*
5240402dd89dSShailendra Verma 	 * Adjusting max_active or creating new pwqs by applying
52416ba94429SFrederic Weisbecker 	 * attributes breaks ordering guarantee.  Disallow exposing ordered
52426ba94429SFrederic Weisbecker 	 * workqueues.
52436ba94429SFrederic Weisbecker 	 */
52446ba94429SFrederic Weisbecker 	if (WARN_ON(wq->flags & __WQ_ORDERED))
52456ba94429SFrederic Weisbecker 		return -EINVAL;
52466ba94429SFrederic Weisbecker 
52476ba94429SFrederic Weisbecker 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
52486ba94429SFrederic Weisbecker 	if (!wq_dev)
52496ba94429SFrederic Weisbecker 		return -ENOMEM;
52506ba94429SFrederic Weisbecker 
52516ba94429SFrederic Weisbecker 	wq_dev->wq = wq;
52526ba94429SFrederic Weisbecker 	wq_dev->dev.bus = &wq_subsys;
52536ba94429SFrederic Weisbecker 	wq_dev->dev.init_name = wq->name;
52546ba94429SFrederic Weisbecker 	wq_dev->dev.release = wq_device_release;
52556ba94429SFrederic Weisbecker 
52566ba94429SFrederic Weisbecker 	/*
52576ba94429SFrederic Weisbecker 	 * unbound_attrs are created separately.  Suppress uevent until
52586ba94429SFrederic Weisbecker 	 * everything is ready.
52596ba94429SFrederic Weisbecker 	 */
52606ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, true);
52616ba94429SFrederic Weisbecker 
52626ba94429SFrederic Weisbecker 	ret = device_register(&wq_dev->dev);
52636ba94429SFrederic Weisbecker 	if (ret) {
52646ba94429SFrederic Weisbecker 		kfree(wq_dev);
52656ba94429SFrederic Weisbecker 		wq->wq_dev = NULL;
52666ba94429SFrederic Weisbecker 		return ret;
52676ba94429SFrederic Weisbecker 	}
52686ba94429SFrederic Weisbecker 
52696ba94429SFrederic Weisbecker 	if (wq->flags & WQ_UNBOUND) {
52706ba94429SFrederic Weisbecker 		struct device_attribute *attr;
52716ba94429SFrederic Weisbecker 
52726ba94429SFrederic Weisbecker 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
52736ba94429SFrederic Weisbecker 			ret = device_create_file(&wq_dev->dev, attr);
52746ba94429SFrederic Weisbecker 			if (ret) {
52756ba94429SFrederic Weisbecker 				device_unregister(&wq_dev->dev);
52766ba94429SFrederic Weisbecker 				wq->wq_dev = NULL;
52776ba94429SFrederic Weisbecker 				return ret;
52786ba94429SFrederic Weisbecker 			}
52796ba94429SFrederic Weisbecker 		}
52806ba94429SFrederic Weisbecker 	}
52816ba94429SFrederic Weisbecker 
52826ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, false);
52836ba94429SFrederic Weisbecker 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
52846ba94429SFrederic Weisbecker 	return 0;
52856ba94429SFrederic Weisbecker }
52866ba94429SFrederic Weisbecker 
52876ba94429SFrederic Weisbecker /**
52886ba94429SFrederic Weisbecker  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
52896ba94429SFrederic Weisbecker  * @wq: the workqueue to unregister
52906ba94429SFrederic Weisbecker  *
52916ba94429SFrederic Weisbecker  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
52926ba94429SFrederic Weisbecker  */
52936ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
52946ba94429SFrederic Weisbecker {
52956ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = wq->wq_dev;
52966ba94429SFrederic Weisbecker 
52976ba94429SFrederic Weisbecker 	if (!wq->wq_dev)
52986ba94429SFrederic Weisbecker 		return;
52996ba94429SFrederic Weisbecker 
53006ba94429SFrederic Weisbecker 	wq->wq_dev = NULL;
53016ba94429SFrederic Weisbecker 	device_unregister(&wq_dev->dev);
53026ba94429SFrederic Weisbecker }
53036ba94429SFrederic Weisbecker #else	/* CONFIG_SYSFS */
53046ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
53056ba94429SFrederic Weisbecker #endif	/* CONFIG_SYSFS */
53066ba94429SFrederic Weisbecker 
530782607adcSTejun Heo /*
530882607adcSTejun Heo  * Workqueue watchdog.
530982607adcSTejun Heo  *
531082607adcSTejun Heo  * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
531182607adcSTejun Heo  * flush dependency, a concurrency managed work item which stays RUNNING
531282607adcSTejun Heo  * indefinitely.  Workqueue stalls can be very difficult to debug as the
531382607adcSTejun Heo  * usual warning mechanisms don't trigger and internal workqueue state is
531482607adcSTejun Heo  * largely opaque.
531582607adcSTejun Heo  *
531682607adcSTejun Heo  * Workqueue watchdog monitors all worker pools periodically and dumps
531782607adcSTejun Heo  * state if some pools failed to make forward progress for a while where
531882607adcSTejun Heo  * forward progress is defined as the first item on ->worklist changing.
531982607adcSTejun Heo  *
532082607adcSTejun Heo  * This mechanism is controlled through the kernel parameter
532182607adcSTejun Heo  * "workqueue.watchdog_thresh" which can be updated at runtime through the
532282607adcSTejun Heo  * corresponding sysfs parameter file.
532382607adcSTejun Heo  */
532482607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG
532582607adcSTejun Heo 
532682607adcSTejun Heo static void wq_watchdog_timer_fn(unsigned long data);
532782607adcSTejun Heo 
532882607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30;
532982607adcSTejun Heo static struct timer_list wq_watchdog_timer =
533082607adcSTejun Heo 	TIMER_DEFERRED_INITIALIZER(wq_watchdog_timer_fn, 0, 0);
533182607adcSTejun Heo 
533282607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
533382607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
533482607adcSTejun Heo 
533582607adcSTejun Heo static void wq_watchdog_reset_touched(void)
533682607adcSTejun Heo {
533782607adcSTejun Heo 	int cpu;
533882607adcSTejun Heo 
533982607adcSTejun Heo 	wq_watchdog_touched = jiffies;
534082607adcSTejun Heo 	for_each_possible_cpu(cpu)
534182607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
534282607adcSTejun Heo }
534382607adcSTejun Heo 
534482607adcSTejun Heo static void wq_watchdog_timer_fn(unsigned long data)
534582607adcSTejun Heo {
534682607adcSTejun Heo 	unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
534782607adcSTejun Heo 	bool lockup_detected = false;
534882607adcSTejun Heo 	struct worker_pool *pool;
534982607adcSTejun Heo 	int pi;
535082607adcSTejun Heo 
535182607adcSTejun Heo 	if (!thresh)
535282607adcSTejun Heo 		return;
535382607adcSTejun Heo 
535482607adcSTejun Heo 	rcu_read_lock();
535582607adcSTejun Heo 
535682607adcSTejun Heo 	for_each_pool(pool, pi) {
535782607adcSTejun Heo 		unsigned long pool_ts, touched, ts;
535882607adcSTejun Heo 
535982607adcSTejun Heo 		if (list_empty(&pool->worklist))
536082607adcSTejun Heo 			continue;
536182607adcSTejun Heo 
536282607adcSTejun Heo 		/* get the latest of pool and touched timestamps */
536382607adcSTejun Heo 		pool_ts = READ_ONCE(pool->watchdog_ts);
536482607adcSTejun Heo 		touched = READ_ONCE(wq_watchdog_touched);
536582607adcSTejun Heo 
536682607adcSTejun Heo 		if (time_after(pool_ts, touched))
536782607adcSTejun Heo 			ts = pool_ts;
536882607adcSTejun Heo 		else
536982607adcSTejun Heo 			ts = touched;
537082607adcSTejun Heo 
537182607adcSTejun Heo 		if (pool->cpu >= 0) {
537282607adcSTejun Heo 			unsigned long cpu_touched =
537382607adcSTejun Heo 				READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
537482607adcSTejun Heo 						  pool->cpu));
537582607adcSTejun Heo 			if (time_after(cpu_touched, ts))
537682607adcSTejun Heo 				ts = cpu_touched;
537782607adcSTejun Heo 		}
537882607adcSTejun Heo 
537982607adcSTejun Heo 		/* did we stall? */
538082607adcSTejun Heo 		if (time_after(jiffies, ts + thresh)) {
538182607adcSTejun Heo 			lockup_detected = true;
538282607adcSTejun Heo 			pr_emerg("BUG: workqueue lockup - pool");
538382607adcSTejun Heo 			pr_cont_pool_info(pool);
538482607adcSTejun Heo 			pr_cont(" stuck for %us!\n",
538582607adcSTejun Heo 				jiffies_to_msecs(jiffies - pool_ts) / 1000);
538682607adcSTejun Heo 		}
538782607adcSTejun Heo 	}
538882607adcSTejun Heo 
538982607adcSTejun Heo 	rcu_read_unlock();
539082607adcSTejun Heo 
539182607adcSTejun Heo 	if (lockup_detected)
539282607adcSTejun Heo 		show_workqueue_state();
539382607adcSTejun Heo 
539482607adcSTejun Heo 	wq_watchdog_reset_touched();
539582607adcSTejun Heo 	mod_timer(&wq_watchdog_timer, jiffies + thresh);
539682607adcSTejun Heo }
539782607adcSTejun Heo 
539882607adcSTejun Heo void wq_watchdog_touch(int cpu)
539982607adcSTejun Heo {
540082607adcSTejun Heo 	if (cpu >= 0)
540182607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
540282607adcSTejun Heo 	else
540382607adcSTejun Heo 		wq_watchdog_touched = jiffies;
540482607adcSTejun Heo }
540582607adcSTejun Heo 
540682607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh)
540782607adcSTejun Heo {
540882607adcSTejun Heo 	wq_watchdog_thresh = 0;
540982607adcSTejun Heo 	del_timer_sync(&wq_watchdog_timer);
541082607adcSTejun Heo 
541182607adcSTejun Heo 	if (thresh) {
541282607adcSTejun Heo 		wq_watchdog_thresh = thresh;
541382607adcSTejun Heo 		wq_watchdog_reset_touched();
541482607adcSTejun Heo 		mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
541582607adcSTejun Heo 	}
541682607adcSTejun Heo }
541782607adcSTejun Heo 
541882607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val,
541982607adcSTejun Heo 					const struct kernel_param *kp)
542082607adcSTejun Heo {
542182607adcSTejun Heo 	unsigned long thresh;
542282607adcSTejun Heo 	int ret;
542382607adcSTejun Heo 
542482607adcSTejun Heo 	ret = kstrtoul(val, 0, &thresh);
542582607adcSTejun Heo 	if (ret)
542682607adcSTejun Heo 		return ret;
542782607adcSTejun Heo 
542882607adcSTejun Heo 	if (system_wq)
542982607adcSTejun Heo 		wq_watchdog_set_thresh(thresh);
543082607adcSTejun Heo 	else
543182607adcSTejun Heo 		wq_watchdog_thresh = thresh;
543282607adcSTejun Heo 
543382607adcSTejun Heo 	return 0;
543482607adcSTejun Heo }
543582607adcSTejun Heo 
543682607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = {
543782607adcSTejun Heo 	.set	= wq_watchdog_param_set_thresh,
543882607adcSTejun Heo 	.get	= param_get_ulong,
543982607adcSTejun Heo };
544082607adcSTejun Heo 
544182607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
544282607adcSTejun Heo 		0644);
544382607adcSTejun Heo 
544482607adcSTejun Heo static void wq_watchdog_init(void)
544582607adcSTejun Heo {
544682607adcSTejun Heo 	wq_watchdog_set_thresh(wq_watchdog_thresh);
544782607adcSTejun Heo }
544882607adcSTejun Heo 
544982607adcSTejun Heo #else	/* CONFIG_WQ_WATCHDOG */
545082607adcSTejun Heo 
545182607adcSTejun Heo static inline void wq_watchdog_init(void) { }
545282607adcSTejun Heo 
545382607adcSTejun Heo #endif	/* CONFIG_WQ_WATCHDOG */
545482607adcSTejun Heo 
5455bce90380STejun Heo static void __init wq_numa_init(void)
5456bce90380STejun Heo {
5457bce90380STejun Heo 	cpumask_var_t *tbl;
5458bce90380STejun Heo 	int node, cpu;
5459bce90380STejun Heo 
5460bce90380STejun Heo 	if (num_possible_nodes() <= 1)
5461bce90380STejun Heo 		return;
5462bce90380STejun Heo 
5463d55262c4STejun Heo 	if (wq_disable_numa) {
5464d55262c4STejun Heo 		pr_info("workqueue: NUMA affinity support disabled\n");
5465d55262c4STejun Heo 		return;
5466d55262c4STejun Heo 	}
5467d55262c4STejun Heo 
54684c16bd32STejun Heo 	wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
54694c16bd32STejun Heo 	BUG_ON(!wq_update_unbound_numa_attrs_buf);
54704c16bd32STejun Heo 
5471bce90380STejun Heo 	/*
5472bce90380STejun Heo 	 * We want masks of possible CPUs of each node which isn't readily
5473bce90380STejun Heo 	 * available.  Build one from cpu_to_node() which should have been
5474bce90380STejun Heo 	 * fully initialized by now.
5475bce90380STejun Heo 	 */
5476ddcb57e2SLai Jiangshan 	tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
5477bce90380STejun Heo 	BUG_ON(!tbl);
5478bce90380STejun Heo 
5479bce90380STejun Heo 	for_each_node(node)
54805a6024f1SYasuaki Ishimatsu 		BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
54811be0c25dSTejun Heo 				node_online(node) ? node : NUMA_NO_NODE));
5482bce90380STejun Heo 
5483bce90380STejun Heo 	for_each_possible_cpu(cpu) {
5484bce90380STejun Heo 		node = cpu_to_node(cpu);
5485bce90380STejun Heo 		if (WARN_ON(node == NUMA_NO_NODE)) {
5486bce90380STejun Heo 			pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5487bce90380STejun Heo 			/* happens iff arch is bonkers, let's just proceed */
5488bce90380STejun Heo 			return;
5489bce90380STejun Heo 		}
5490bce90380STejun Heo 		cpumask_set_cpu(cpu, tbl[node]);
5491bce90380STejun Heo 	}
5492bce90380STejun Heo 
5493bce90380STejun Heo 	wq_numa_possible_cpumask = tbl;
5494bce90380STejun Heo 	wq_numa_enabled = true;
5495bce90380STejun Heo }
5496bce90380STejun Heo 
54976ee0578bSSuresh Siddha static int __init init_workqueues(void)
54981da177e4SLinus Torvalds {
54997a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
55007a4e344cSTejun Heo 	int i, cpu;
5501c34056a3STejun Heo 
5502e904e6c2STejun Heo 	WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5503e904e6c2STejun Heo 
5504b05a7928SFrederic Weisbecker 	BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
5505b05a7928SFrederic Weisbecker 	cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
5506b05a7928SFrederic Weisbecker 
5507e904e6c2STejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5508e904e6c2STejun Heo 
550965758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
5510a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
55118b03ae3cSTejun Heo 
5512bce90380STejun Heo 	wq_numa_init();
5513bce90380STejun Heo 
5514706026c2STejun Heo 	/* initialize CPU pools */
551529c91e99STejun Heo 	for_each_possible_cpu(cpu) {
55164ce62e9eSTejun Heo 		struct worker_pool *pool;
55178b03ae3cSTejun Heo 
55187a4e344cSTejun Heo 		i = 0;
5519f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
55207a4e344cSTejun Heo 			BUG_ON(init_worker_pool(pool));
5521ec22ca5eSTejun Heo 			pool->cpu = cpu;
55227a4e344cSTejun Heo 			cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
55237a4e344cSTejun Heo 			pool->attrs->nice = std_nice[i++];
5524f3f90ad4STejun Heo 			pool->node = cpu_to_node(cpu);
55257a4e344cSTejun Heo 
55269daf9e67STejun Heo 			/* alloc pool ID */
552768e13a67SLai Jiangshan 			mutex_lock(&wq_pool_mutex);
55289daf9e67STejun Heo 			BUG_ON(worker_pool_assign_id(pool));
552968e13a67SLai Jiangshan 			mutex_unlock(&wq_pool_mutex);
55304ce62e9eSTejun Heo 		}
55318b03ae3cSTejun Heo 	}
55328b03ae3cSTejun Heo 
5533e22bee78STejun Heo 	/* create the initial worker */
553429c91e99STejun Heo 	for_each_online_cpu(cpu) {
55354ce62e9eSTejun Heo 		struct worker_pool *pool;
5536e22bee78STejun Heo 
5537f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
553824647570STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
5539051e1850SLai Jiangshan 			BUG_ON(!create_worker(pool));
5540e22bee78STejun Heo 		}
55414ce62e9eSTejun Heo 	}
5542e22bee78STejun Heo 
55438a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
554429c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
554529c91e99STejun Heo 		struct workqueue_attrs *attrs;
554629c91e99STejun Heo 
554729c91e99STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
554829c91e99STejun Heo 		attrs->nice = std_nice[i];
554929c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
55508a2b7538STejun Heo 
55518a2b7538STejun Heo 		/*
55528a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
55538a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
55548a2b7538STejun Heo 		 * Turn off NUMA so that dfl_pwq is used for all nodes.
55558a2b7538STejun Heo 		 */
55568a2b7538STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
55578a2b7538STejun Heo 		attrs->nice = std_nice[i];
55588a2b7538STejun Heo 		attrs->no_numa = true;
55598a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
556029c91e99STejun Heo 	}
556129c91e99STejun Heo 
5562d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
55631aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
5564d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
5565f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5566f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
556724d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
556824d51addSTejun Heo 					      WQ_FREEZABLE, 0);
55690668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
55700668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
55710668106cSViresh Kumar 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
55720668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
55730668106cSViresh Kumar 					      0);
55741aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
55750668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
55760668106cSViresh Kumar 	       !system_power_efficient_wq ||
55770668106cSViresh Kumar 	       !system_freezable_power_efficient_wq);
557882607adcSTejun Heo 
557982607adcSTejun Heo 	wq_watchdog_init();
558082607adcSTejun Heo 
55816ee0578bSSuresh Siddha 	return 0;
55821da177e4SLinus Torvalds }
55836ee0578bSSuresh Siddha early_initcall(init_workqueues);
5584