xref: /linux-6.15/kernel/workqueue.c (revision 45c753f5)
1457c8996SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
21da177e4SLinus Torvalds /*
3c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
41da177e4SLinus Torvalds  *
5c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
61da177e4SLinus Torvalds  *
71da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
81da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
9e1f8e874SFrancois Cami  *     Andrew Morton
101da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
111da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1289ada679SChristoph Lameter  *
13cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
14c54fce6eSTejun Heo  *
15c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
16c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
17c54fce6eSTejun Heo  *
18c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
19c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
20b11895c4SLibin  * automatically managed.  There are two worker pools for each CPU (one for
21b11895c4SLibin  * normal work items and the other for high priority ones) and some extra
22b11895c4SLibin  * pools for workqueues which are not bound to any specific CPU - the
23b11895c4SLibin  * number of these backing pools is dynamic.
24c54fce6eSTejun Heo  *
259a261491SBenjamin Peterson  * Please read Documentation/core-api/workqueue.rst for details.
261da177e4SLinus Torvalds  */
271da177e4SLinus Torvalds 
289984de1aSPaul Gortmaker #include <linux/export.h>
291da177e4SLinus Torvalds #include <linux/kernel.h>
301da177e4SLinus Torvalds #include <linux/sched.h>
311da177e4SLinus Torvalds #include <linux/init.h>
321da177e4SLinus Torvalds #include <linux/signal.h>
331da177e4SLinus Torvalds #include <linux/completion.h>
341da177e4SLinus Torvalds #include <linux/workqueue.h>
351da177e4SLinus Torvalds #include <linux/slab.h>
361da177e4SLinus Torvalds #include <linux/cpu.h>
371da177e4SLinus Torvalds #include <linux/notifier.h>
381da177e4SLinus Torvalds #include <linux/kthread.h>
391fa44ecaSJames Bottomley #include <linux/hardirq.h>
4046934023SChristoph Lameter #include <linux/mempolicy.h>
41341a5958SRafael J. Wysocki #include <linux/freezer.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>
51c98a9805STal Shorer #include <linux/sched/isolation.h>
5262635ea8SSergey Senozhatsky #include <linux/nmi.h>
53940d71c6SSergey Senozhatsky #include <linux/kvm_para.h>
54e22bee78STejun Heo 
55ea138446STejun Heo #include "workqueue_internal.h"
561da177e4SLinus Torvalds 
57c8e55f36STejun Heo enum {
58bc2ae0f5STejun Heo 	/*
5924647570STejun Heo 	 * worker_pool flags
60bc2ae0f5STejun Heo 	 *
6124647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
62bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
63bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
64bc2ae0f5STejun Heo 	 * is in effect.
65bc2ae0f5STejun Heo 	 *
66bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
67bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
6824647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
69bc2ae0f5STejun Heo 	 *
70bc3a1afcSTejun Heo 	 * Note that DISASSOCIATED should be flipped only while holding
711258fae7STejun Heo 	 * wq_pool_attach_mutex to avoid changing binding state while
724736cbf7SLai Jiangshan 	 * worker_attach_to_pool() is in progress.
73bc2ae0f5STejun Heo 	 */
74692b4825STejun Heo 	POOL_MANAGER_ACTIVE	= 1 << 0,	/* being managed */
7524647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
76db7bccf4STejun Heo 
77c8e55f36STejun Heo 	/* worker flags */
78c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
79c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
80e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
81fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
82f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
83a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
84e22bee78STejun Heo 
85a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
86a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
87db7bccf4STejun Heo 
88e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
894ce62e9eSTejun Heo 
9029c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
91c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
92db7bccf4STejun Heo 
93e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
94e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
95e22bee78STejun Heo 
963233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
973233cdbdSTejun Heo 						/* call for help after 10ms
983233cdbdSTejun Heo 						   (min two ticks) */
99e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
100e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
1011da177e4SLinus Torvalds 
1021da177e4SLinus Torvalds 	/*
103e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
1048698a745SDongsheng Yang 	 * all cpus.  Give MIN_NICE.
105e22bee78STejun Heo 	 */
1068698a745SDongsheng Yang 	RESCUER_NICE_LEVEL	= MIN_NICE,
1078698a745SDongsheng Yang 	HIGHPRI_NICE_LEVEL	= MIN_NICE,
108ecf6881fSTejun Heo 
109ecf6881fSTejun Heo 	WQ_NAME_LEN		= 24,
110c8e55f36STejun Heo };
111c8e55f36STejun Heo 
1121da177e4SLinus Torvalds /*
1134690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1144690c4abSTejun Heo  *
115e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
116e41e704bSTejun Heo  *    everyone else.
1174690c4abSTejun Heo  *
118e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
119e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
120e22bee78STejun Heo  *
121d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1224690c4abSTejun Heo  *
123d565ed63STejun Heo  * X: During normal operation, modification requires pool->lock and should
124d565ed63STejun Heo  *    be done only from local cpu.  Either disabling preemption on local
125d565ed63STejun Heo  *    cpu or grabbing pool->lock is enough for read access.  If
126d565ed63STejun Heo  *    POOL_DISASSOCIATED is set, it's identical to L.
127e22bee78STejun Heo  *
1281258fae7STejun Heo  * A: wq_pool_attach_mutex protected.
129822d8405STejun Heo  *
13068e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
13176af4d93STejun Heo  *
13224acfb71SThomas Gleixner  * PR: wq_pool_mutex protected for writes.  RCU protected for reads.
1335bcab335STejun Heo  *
1345b95e1afSLai Jiangshan  * PW: wq_pool_mutex and wq->mutex protected for writes.  Either for reads.
1355b95e1afSLai Jiangshan  *
1365b95e1afSLai Jiangshan  * PWR: wq_pool_mutex and wq->mutex protected for writes.  Either or
13724acfb71SThomas Gleixner  *      RCU for reads.
1385b95e1afSLai Jiangshan  *
1393c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1403c25a55dSLai Jiangshan  *
14124acfb71SThomas Gleixner  * WR: wq->mutex protected for writes.  RCU protected for reads.
1422e109a28STejun Heo  *
1432e109a28STejun Heo  * MD: wq_mayday_lock protected.
1444690c4abSTejun Heo  */
1454690c4abSTejun Heo 
1462eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
147c34056a3STejun Heo 
148bd7bdd43STejun Heo struct worker_pool {
149a9b8a985SSebastian Andrzej Siewior 	raw_spinlock_t		lock;		/* the pool lock */
150d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
151f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1529daf9e67STejun Heo 	int			id;		/* I: pool ID */
15311ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
154bd7bdd43STejun Heo 
15582607adcSTejun Heo 	unsigned long		watchdog_ts;	/* L: watchdog timestamp */
15682607adcSTejun Heo 
157bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
158ea1abd61SLai Jiangshan 
1595826cc8fSLai Jiangshan 	int			nr_workers;	/* L: total number of workers */
1605826cc8fSLai Jiangshan 	int			nr_idle;	/* L: currently idle workers */
161bd7bdd43STejun Heo 
162bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
163bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
164bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
165bd7bdd43STejun Heo 
166c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
167c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
168c9e7cf27STejun Heo 						/* L: hash of busy workers */
169c9e7cf27STejun Heo 
1702607d7a6STejun Heo 	struct worker		*manager;	/* L: purely informational */
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 	/*
18824acfb71SThomas Gleixner 	 * Destruction of pool is 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 */
208018f3a13SLai Jiangshan 
209018f3a13SLai Jiangshan 	/*
210018f3a13SLai Jiangshan 	 * nr_active management and WORK_STRUCT_INACTIVE:
211018f3a13SLai Jiangshan 	 *
212018f3a13SLai Jiangshan 	 * When pwq->nr_active >= max_active, new work item is queued to
213018f3a13SLai Jiangshan 	 * pwq->inactive_works instead of pool->worklist and marked with
214018f3a13SLai Jiangshan 	 * WORK_STRUCT_INACTIVE.
215018f3a13SLai Jiangshan 	 *
216018f3a13SLai Jiangshan 	 * All work items marked with WORK_STRUCT_INACTIVE do not participate
217018f3a13SLai Jiangshan 	 * in pwq->nr_active and all work items in pwq->inactive_works are
218018f3a13SLai Jiangshan 	 * marked with WORK_STRUCT_INACTIVE.  But not all WORK_STRUCT_INACTIVE
219018f3a13SLai Jiangshan 	 * work items are in pwq->inactive_works.  Some of them are ready to
220018f3a13SLai Jiangshan 	 * run in pool->worklist or worker->scheduled.  Those work itmes are
221018f3a13SLai Jiangshan 	 * only struct wq_barrier which is used for flush_work() and should
222018f3a13SLai Jiangshan 	 * not participate in pwq->nr_active.  For non-barrier work item, it
223018f3a13SLai Jiangshan 	 * is marked with WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works.
224018f3a13SLai Jiangshan 	 */
2251e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
226a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
227f97a4a1aSLai Jiangshan 	struct list_head	inactive_works;	/* L: inactive works */
2283c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2292e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2308864b4e5STejun Heo 
2318864b4e5STejun Heo 	/*
2328864b4e5STejun Heo 	 * Release of unbound pwq is punted to system_wq.  See put_pwq()
2338864b4e5STejun Heo 	 * and pwq_unbound_release_workfn() for details.  pool_workqueue
23424acfb71SThomas Gleixner 	 * itself is also RCU protected so that the first pwq can be
235b09f4fd3SLai Jiangshan 	 * determined without grabbing wq->mutex.
2368864b4e5STejun Heo 	 */
2378864b4e5STejun Heo 	struct work_struct	unbound_release_work;
2388864b4e5STejun Heo 	struct rcu_head		rcu;
239e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS);
2401da177e4SLinus Torvalds 
2411da177e4SLinus Torvalds /*
24273f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
24373f53c4aSTejun Heo  */
24473f53c4aSTejun Heo struct wq_flusher {
2453c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
2463c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
24773f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
24873f53c4aSTejun Heo };
2491da177e4SLinus Torvalds 
250226223abSTejun Heo struct wq_device;
251226223abSTejun Heo 
25273f53c4aSTejun Heo /*
253c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
254c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
2551da177e4SLinus Torvalds  */
2561da177e4SLinus Torvalds struct workqueue_struct {
2573c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
258e2dca7adSTejun Heo 	struct list_head	list;		/* PR: list of all workqueues */
25973f53c4aSTejun Heo 
2603c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
2613c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
2623c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
263112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
2643c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
2653c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
2663c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
26773f53c4aSTejun Heo 
2682e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
26930ae2fc0STejun Heo 	struct worker		*rescuer;	/* MD: rescue worker */
270e22bee78STejun Heo 
27187fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
272a357fc03SLai Jiangshan 	int			saved_max_active; /* WQ: saved pwq max_active */
273226223abSTejun Heo 
2745b95e1afSLai Jiangshan 	struct workqueue_attrs	*unbound_attrs;	/* PW: only for unbound wqs */
2755b95e1afSLai Jiangshan 	struct pool_workqueue	*dfl_pwq;	/* PW: only for unbound wqs */
2766029a918STejun Heo 
277226223abSTejun Heo #ifdef CONFIG_SYSFS
278226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
279226223abSTejun Heo #endif
2804e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
281669de8bdSBart Van Assche 	char			*lock_name;
282669de8bdSBart Van Assche 	struct lock_class_key	key;
2834e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2844e6045f1SJohannes Berg #endif
285ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
2862728fd2fSTejun Heo 
287e2dca7adSTejun Heo 	/*
28824acfb71SThomas Gleixner 	 * Destruction of workqueue_struct is RCU protected to allow walking
28924acfb71SThomas Gleixner 	 * the workqueues list without grabbing wq_pool_mutex.
290e2dca7adSTejun Heo 	 * This is used to dump all workqueues from sysrq.
291e2dca7adSTejun Heo 	 */
292e2dca7adSTejun Heo 	struct rcu_head		rcu;
293e2dca7adSTejun Heo 
2942728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
2952728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
2962728fd2fSTejun Heo 	struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
2975b95e1afSLai Jiangshan 	struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
2981da177e4SLinus Torvalds };
2991da177e4SLinus Torvalds 
300e904e6c2STejun Heo static struct kmem_cache *pwq_cache;
301e904e6c2STejun Heo 
302bce90380STejun Heo static cpumask_var_t *wq_numa_possible_cpumask;
303bce90380STejun Heo 					/* possible CPUs of each node */
304bce90380STejun Heo 
305d55262c4STejun Heo static bool wq_disable_numa;
306d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444);
307d55262c4STejun Heo 
308cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
309552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
310cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
311cee22a15SViresh Kumar 
312863b710bSTejun Heo static bool wq_online;			/* can kworkers be created yet? */
3133347fa09STejun Heo 
314bce90380STejun Heo static bool wq_numa_enabled;		/* unbound NUMA affinity enabled */
315bce90380STejun Heo 
3164c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
3174c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
3184c16bd32STejun Heo 
31968e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
3201258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
321a9b8a985SSebastian Andrzej Siewior static DEFINE_RAW_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
322d8bb65abSSebastian Andrzej Siewior /* wait for manager to go away */
323d8bb65abSSebastian Andrzej Siewior static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
3245bcab335STejun Heo 
325e2dca7adSTejun Heo static LIST_HEAD(workqueues);		/* PR: list of all workqueues */
32668e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
3277d19c5ceSTejun Heo 
328ef557180SMike Galbraith /* PL: allowable cpus for unbound wqs and work items */
329ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask;
330ef557180SMike Galbraith 
331ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */
332ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last);
333b05a7928SFrederic Weisbecker 
334f303fccbSTejun Heo /*
335f303fccbSTejun Heo  * Local execution of unbound work items is no longer guaranteed.  The
336f303fccbSTejun Heo  * following always forces round-robin CPU selection on unbound work items
337f303fccbSTejun Heo  * to uncover usages which depend on it.
338f303fccbSTejun Heo  */
339f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
340f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true;
341f303fccbSTejun Heo #else
342f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false;
343f303fccbSTejun Heo #endif
344f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
345f303fccbSTejun Heo 
3467d19c5ceSTejun Heo /* the per-cpu worker pools */
34725528213SPeter Zijlstra static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
3487d19c5ceSTejun Heo 
34968e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
3507d19c5ceSTejun Heo 
35168e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
35229c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
35329c91e99STejun Heo 
354c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
35529c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
35629c91e99STejun Heo 
3578a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
3588a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
3598a2b7538STejun Heo 
360d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
361ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
362044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
3631aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
364044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
365d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
366044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
367f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
368044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
36924d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
3700668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly;
3710668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
3720668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
3730668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
374d320c038STejun Heo 
3757d19c5ceSTejun Heo static int worker_thread(void *__worker);
3766ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
377c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq);
37855df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool);
3797d19c5ceSTejun Heo 
38097bd2347STejun Heo #define CREATE_TRACE_POINTS
38197bd2347STejun Heo #include <trace/events/workqueue.h>
38297bd2347STejun Heo 
38368e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
38424acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
385f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
38624acfb71SThomas Gleixner 			 "RCU or wq_pool_mutex should be held")
3875bcab335STejun Heo 
3885b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)			\
38924acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
390f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex) &&		\
391f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
39224acfb71SThomas Gleixner 			 "RCU, wq->mutex or wq_pool_mutex should be held")
3935b95e1afSLai Jiangshan 
394f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
395f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
396f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
3977a62c2c8STejun Heo 	     (pool)++)
3984ce62e9eSTejun Heo 
39949e3cf44STejun Heo /**
40017116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
40117116969STejun Heo  * @pool: iteration cursor
402611c92a0STejun Heo  * @pi: integer used for iteration
403fa1b54e6STejun Heo  *
40424acfb71SThomas Gleixner  * This must be called either with wq_pool_mutex held or RCU read
40568e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
40668e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
407fa1b54e6STejun Heo  *
408fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
409fa1b54e6STejun Heo  * ignored.
41017116969STejun Heo  */
411611c92a0STejun Heo #define for_each_pool(pool, pi)						\
412611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
41368e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
414fa1b54e6STejun Heo 		else
41517116969STejun Heo 
41617116969STejun Heo /**
417822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
418822d8405STejun Heo  * @worker: iteration cursor
419822d8405STejun Heo  * @pool: worker_pool to iterate workers of
420822d8405STejun Heo  *
4211258fae7STejun Heo  * This must be called with wq_pool_attach_mutex.
422822d8405STejun Heo  *
423822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
424822d8405STejun Heo  * ignored.
425822d8405STejun Heo  */
426da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
427da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
4281258fae7STejun Heo 		if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
429822d8405STejun Heo 		else
430822d8405STejun Heo 
431822d8405STejun Heo /**
43249e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
43349e3cf44STejun Heo  * @pwq: iteration cursor
43449e3cf44STejun Heo  * @wq: the target workqueue
43576af4d93STejun Heo  *
43624acfb71SThomas Gleixner  * This must be called either with wq->mutex held or RCU read locked.
437794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
438794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
43976af4d93STejun Heo  *
44076af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
44176af4d93STejun Heo  * ignored.
44249e3cf44STejun Heo  */
44349e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
44449e9d1a9SSebastian Andrzej Siewior 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node,		\
4455a644662SJoel Fernandes (Google) 				 lockdep_is_held(&(wq->mutex)))
446f3421797STejun Heo 
447dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
448dc186ad7SThomas Gleixner 
449f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr;
450dc186ad7SThomas Gleixner 
45199777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
45299777288SStanislaw Gruszka {
45399777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
45499777288SStanislaw Gruszka }
45599777288SStanislaw Gruszka 
456b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr)
457b9fdac7fSDu, Changbin {
458b9fdac7fSDu, Changbin 	struct work_struct *work = addr;
459b9fdac7fSDu, Changbin 
460b9fdac7fSDu, Changbin 	return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
461b9fdac7fSDu, Changbin }
462b9fdac7fSDu, Changbin 
463dc186ad7SThomas Gleixner /*
464dc186ad7SThomas Gleixner  * fixup_init is called when:
465dc186ad7SThomas Gleixner  * - an active object is initialized
466dc186ad7SThomas Gleixner  */
46702a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state)
468dc186ad7SThomas Gleixner {
469dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
470dc186ad7SThomas Gleixner 
471dc186ad7SThomas Gleixner 	switch (state) {
472dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
473dc186ad7SThomas Gleixner 		cancel_work_sync(work);
474dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
47502a982a6SDu, Changbin 		return true;
476dc186ad7SThomas Gleixner 	default:
47702a982a6SDu, Changbin 		return false;
478dc186ad7SThomas Gleixner 	}
479dc186ad7SThomas Gleixner }
480dc186ad7SThomas Gleixner 
481dc186ad7SThomas Gleixner /*
482dc186ad7SThomas Gleixner  * fixup_free is called when:
483dc186ad7SThomas Gleixner  * - an active object is freed
484dc186ad7SThomas Gleixner  */
48502a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state)
486dc186ad7SThomas Gleixner {
487dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
488dc186ad7SThomas Gleixner 
489dc186ad7SThomas Gleixner 	switch (state) {
490dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
491dc186ad7SThomas Gleixner 		cancel_work_sync(work);
492dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
49302a982a6SDu, Changbin 		return true;
494dc186ad7SThomas Gleixner 	default:
49502a982a6SDu, Changbin 		return false;
496dc186ad7SThomas Gleixner 	}
497dc186ad7SThomas Gleixner }
498dc186ad7SThomas Gleixner 
499f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = {
500dc186ad7SThomas Gleixner 	.name		= "work_struct",
50199777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
502b9fdac7fSDu, Changbin 	.is_static_object = work_is_static_object,
503dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
504dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
505dc186ad7SThomas Gleixner };
506dc186ad7SThomas Gleixner 
507dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
508dc186ad7SThomas Gleixner {
509dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
510dc186ad7SThomas Gleixner }
511dc186ad7SThomas Gleixner 
512dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
513dc186ad7SThomas Gleixner {
514dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
515dc186ad7SThomas Gleixner }
516dc186ad7SThomas Gleixner 
517dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
518dc186ad7SThomas Gleixner {
519dc186ad7SThomas Gleixner 	if (onstack)
520dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
521dc186ad7SThomas Gleixner 	else
522dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
523dc186ad7SThomas Gleixner }
524dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
525dc186ad7SThomas Gleixner 
526dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
527dc186ad7SThomas Gleixner {
528dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
529dc186ad7SThomas Gleixner }
530dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
531dc186ad7SThomas Gleixner 
532ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
533ea2e64f2SThomas Gleixner {
534ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
535ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
536ea2e64f2SThomas Gleixner }
537ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
538ea2e64f2SThomas Gleixner 
539dc186ad7SThomas Gleixner #else
540dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
541dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
542dc186ad7SThomas Gleixner #endif
543dc186ad7SThomas Gleixner 
5444e8b22bdSLi Bin /**
54567dc8325SCai Huoqing  * worker_pool_assign_id - allocate ID and assign it to @pool
5464e8b22bdSLi Bin  * @pool: the pool pointer of interest
5474e8b22bdSLi Bin  *
5484e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
5494e8b22bdSLi Bin  * successfully, -errno on failure.
5504e8b22bdSLi Bin  */
5519daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
5529daf9e67STejun Heo {
5539daf9e67STejun Heo 	int ret;
5549daf9e67STejun Heo 
55568e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5565bcab335STejun Heo 
5574e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
5584e8b22bdSLi Bin 			GFP_KERNEL);
559229641a6STejun Heo 	if (ret >= 0) {
560e68035fbSTejun Heo 		pool->id = ret;
561229641a6STejun Heo 		return 0;
562229641a6STejun Heo 	}
5639daf9e67STejun Heo 	return ret;
5649daf9e67STejun Heo }
5659daf9e67STejun Heo 
56676af4d93STejun Heo /**
567df2d5ae4STejun Heo  * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
568df2d5ae4STejun Heo  * @wq: the target workqueue
569df2d5ae4STejun Heo  * @node: the node ID
570df2d5ae4STejun Heo  *
57124acfb71SThomas Gleixner  * This must be called with any of wq_pool_mutex, wq->mutex or RCU
5725b95e1afSLai Jiangshan  * read locked.
573df2d5ae4STejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
574df2d5ae4STejun Heo  * responsible for guaranteeing that the pwq stays online.
575d185af30SYacine Belkadi  *
576d185af30SYacine Belkadi  * Return: The unbound pool_workqueue for @node.
577df2d5ae4STejun Heo  */
578df2d5ae4STejun Heo static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
579df2d5ae4STejun Heo 						  int node)
580df2d5ae4STejun Heo {
5815b95e1afSLai Jiangshan 	assert_rcu_or_wq_mutex_or_pool_mutex(wq);
582d6e022f1STejun Heo 
583d6e022f1STejun Heo 	/*
584d6e022f1STejun Heo 	 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
585d6e022f1STejun Heo 	 * delayed item is pending.  The plan is to keep CPU -> NODE
586d6e022f1STejun Heo 	 * mapping valid and stable across CPU on/offlines.  Once that
587d6e022f1STejun Heo 	 * happens, this workaround can be removed.
588d6e022f1STejun Heo 	 */
589d6e022f1STejun Heo 	if (unlikely(node == NUMA_NO_NODE))
590d6e022f1STejun Heo 		return wq->dfl_pwq;
591d6e022f1STejun Heo 
592df2d5ae4STejun Heo 	return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
593df2d5ae4STejun Heo }
594df2d5ae4STejun Heo 
59573f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
59673f53c4aSTejun Heo {
59773f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
59873f53c4aSTejun Heo }
59973f53c4aSTejun Heo 
600c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data)
60173f53c4aSTejun Heo {
602c4560c2cSLai Jiangshan 	return (work_data >> WORK_STRUCT_COLOR_SHIFT) &
60373f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
60473f53c4aSTejun Heo }
60573f53c4aSTejun Heo 
60673f53c4aSTejun Heo static int work_next_color(int color)
60773f53c4aSTejun Heo {
60873f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
609a848e3b6SOleg Nesterov }
610a848e3b6SOleg Nesterov 
6114594bf15SDavid Howells /*
612112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
613112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
6147c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
6157a22ad75STejun Heo  *
616112202d9STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
617112202d9STejun Heo  * and clear_work_data() can be used to set the pwq, pool or clear
618bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
619bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
6207a22ad75STejun Heo  *
621112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
6227c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
623112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
6247c3eed5cSTejun Heo  * available only while the work item is queued.
625bbb68dfaSTejun Heo  *
626bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
627bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
628bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
629bbb68dfaSTejun Heo  * try to steal the PENDING bit.
6304594bf15SDavid Howells  */
6317a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
6327a22ad75STejun Heo 				 unsigned long flags)
6337a22ad75STejun Heo {
6346183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
6357a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
6367a22ad75STejun Heo }
6377a22ad75STejun Heo 
638112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
6394690c4abSTejun Heo 			 unsigned long extra_flags)
640365970a1SDavid Howells {
641112202d9STejun Heo 	set_work_data(work, (unsigned long)pwq,
642112202d9STejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
643365970a1SDavid Howells }
644365970a1SDavid Howells 
6454468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
6464468a00fSLai Jiangshan 					   int pool_id)
6474468a00fSLai Jiangshan {
6484468a00fSLai Jiangshan 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
6494468a00fSLai Jiangshan 		      WORK_STRUCT_PENDING);
6504468a00fSLai Jiangshan }
6514468a00fSLai Jiangshan 
6527c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
6537c3eed5cSTejun Heo 					    int pool_id)
6544d707b9fSOleg Nesterov {
65523657bb1STejun Heo 	/*
65623657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
65723657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
65823657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
65923657bb1STejun Heo 	 * owner.
66023657bb1STejun Heo 	 */
66123657bb1STejun Heo 	smp_wmb();
6627c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
663346c09f8SRoman Pen 	/*
664346c09f8SRoman Pen 	 * The following mb guarantees that previous clear of a PENDING bit
665346c09f8SRoman Pen 	 * will not be reordered with any speculative LOADS or STORES from
666346c09f8SRoman Pen 	 * work->current_func, which is executed afterwards.  This possible
6678bdc6201SLiu Song 	 * reordering can lead to a missed execution on attempt to queue
668346c09f8SRoman Pen 	 * the same @work.  E.g. consider this case:
669346c09f8SRoman Pen 	 *
670346c09f8SRoman Pen 	 *   CPU#0                         CPU#1
671346c09f8SRoman Pen 	 *   ----------------------------  --------------------------------
672346c09f8SRoman Pen 	 *
673346c09f8SRoman Pen 	 * 1  STORE event_indicated
674346c09f8SRoman Pen 	 * 2  queue_work_on() {
675346c09f8SRoman Pen 	 * 3    test_and_set_bit(PENDING)
676346c09f8SRoman Pen 	 * 4 }                             set_..._and_clear_pending() {
677346c09f8SRoman Pen 	 * 5                                 set_work_data() # clear bit
678346c09f8SRoman Pen 	 * 6                                 smp_mb()
679346c09f8SRoman Pen 	 * 7                               work->current_func() {
680346c09f8SRoman Pen 	 * 8				      LOAD event_indicated
681346c09f8SRoman Pen 	 *				   }
682346c09f8SRoman Pen 	 *
683346c09f8SRoman Pen 	 * Without an explicit full barrier speculative LOAD on line 8 can
684346c09f8SRoman Pen 	 * be executed before CPU#0 does STORE on line 1.  If that happens,
685346c09f8SRoman Pen 	 * CPU#0 observes the PENDING bit is still set and new execution of
686346c09f8SRoman Pen 	 * a @work is not queued in a hope, that CPU#1 will eventually
687346c09f8SRoman Pen 	 * finish the queued @work.  Meanwhile CPU#1 does not see
688346c09f8SRoman Pen 	 * event_indicated is set, because speculative LOAD was executed
689346c09f8SRoman Pen 	 * before actual STORE.
690346c09f8SRoman Pen 	 */
691346c09f8SRoman Pen 	smp_mb();
6924d707b9fSOleg Nesterov }
6934d707b9fSOleg Nesterov 
6947a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
695365970a1SDavid Howells {
6967c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
6977c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
6987a22ad75STejun Heo }
6997a22ad75STejun Heo 
700112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
7017a22ad75STejun Heo {
702e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
7037a22ad75STejun Heo 
704112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
705e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
706e120153dSTejun Heo 	else
707e120153dSTejun Heo 		return NULL;
7087a22ad75STejun Heo }
7097a22ad75STejun Heo 
7107c3eed5cSTejun Heo /**
7117c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
7127c3eed5cSTejun Heo  * @work: the work item of interest
7137c3eed5cSTejun Heo  *
71468e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
71524acfb71SThomas Gleixner  * access under RCU read lock.  As such, this function should be
71624acfb71SThomas Gleixner  * called under wq_pool_mutex or inside of a rcu_read_lock() region.
717fa1b54e6STejun Heo  *
718fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
719fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
720fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
721fa1b54e6STejun Heo  * returned pool is and stays online.
722d185af30SYacine Belkadi  *
723d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
7247c3eed5cSTejun Heo  */
7257c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
7267a22ad75STejun Heo {
727e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
7287c3eed5cSTejun Heo 	int pool_id;
7297a22ad75STejun Heo 
73068e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
731fa1b54e6STejun Heo 
732112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
733112202d9STejun Heo 		return ((struct pool_workqueue *)
7347c3eed5cSTejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool;
7357a22ad75STejun Heo 
7367c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
7377c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
7387a22ad75STejun Heo 		return NULL;
7397a22ad75STejun Heo 
740fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
7417c3eed5cSTejun Heo }
7427c3eed5cSTejun Heo 
7437c3eed5cSTejun Heo /**
7447c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
7457c3eed5cSTejun Heo  * @work: the work item of interest
7467c3eed5cSTejun Heo  *
747d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
7487c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
7497c3eed5cSTejun Heo  */
7507c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
7517c3eed5cSTejun Heo {
75254d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
7537c3eed5cSTejun Heo 
754112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
755112202d9STejun Heo 		return ((struct pool_workqueue *)
75654d5b7d0SLai Jiangshan 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
75754d5b7d0SLai Jiangshan 
75854d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
7597c3eed5cSTejun Heo }
7607c3eed5cSTejun Heo 
761bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
762bbb68dfaSTejun Heo {
7637c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
764bbb68dfaSTejun Heo 
7657c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
7667c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
767bbb68dfaSTejun Heo }
768bbb68dfaSTejun Heo 
769bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
770bbb68dfaSTejun Heo {
771bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
772bbb68dfaSTejun Heo 
773112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
774bbb68dfaSTejun Heo }
775bbb68dfaSTejun Heo 
776e22bee78STejun Heo /*
7773270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
7783270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
779d565ed63STejun Heo  * they're being called with pool->lock held.
780e22bee78STejun Heo  */
781e22bee78STejun Heo 
78263d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
783649027d7STejun Heo {
784e19e397aSTejun Heo 	return !atomic_read(&pool->nr_running);
785649027d7STejun Heo }
786649027d7STejun Heo 
787e22bee78STejun Heo /*
788e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
789e22bee78STejun Heo  * running workers.
790974271c4STejun Heo  *
791974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
792706026c2STejun Heo  * function will always return %true for unbound pools as long as the
793974271c4STejun Heo  * worklist isn't empty.
794e22bee78STejun Heo  */
79563d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
796e22bee78STejun Heo {
79763d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
798e22bee78STejun Heo }
799e22bee78STejun Heo 
800e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
80163d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
802e22bee78STejun Heo {
80363d95a91STejun Heo 	return pool->nr_idle;
804e22bee78STejun Heo }
805e22bee78STejun Heo 
806e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
80763d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
808e22bee78STejun Heo {
809e19e397aSTejun Heo 	return !list_empty(&pool->worklist) &&
810e19e397aSTejun Heo 		atomic_read(&pool->nr_running) <= 1;
811e22bee78STejun Heo }
812e22bee78STejun Heo 
813e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
81463d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
815e22bee78STejun Heo {
81663d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
817e22bee78STejun Heo }
818e22bee78STejun Heo 
819e22bee78STejun Heo /* Do we have too many workers and should some go away? */
82063d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
821e22bee78STejun Heo {
822692b4825STejun Heo 	bool managing = pool->flags & POOL_MANAGER_ACTIVE;
82363d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
82463d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
825e22bee78STejun Heo 
826e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
827e22bee78STejun Heo }
828e22bee78STejun Heo 
829e22bee78STejun Heo /*
830e22bee78STejun Heo  * Wake up functions.
831e22bee78STejun Heo  */
832e22bee78STejun Heo 
8331037de36SLai Jiangshan /* Return the first idle worker.  Safe with preemption disabled */
8341037de36SLai Jiangshan static struct worker *first_idle_worker(struct worker_pool *pool)
8357e11629dSTejun Heo {
83663d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
8377e11629dSTejun Heo 		return NULL;
8387e11629dSTejun Heo 
83963d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
8407e11629dSTejun Heo }
8417e11629dSTejun Heo 
8427e11629dSTejun Heo /**
8437e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
84463d95a91STejun Heo  * @pool: worker pool to wake worker from
8457e11629dSTejun Heo  *
84663d95a91STejun Heo  * Wake up the first idle worker of @pool.
8477e11629dSTejun Heo  *
8487e11629dSTejun Heo  * CONTEXT:
849a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
8507e11629dSTejun Heo  */
85163d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
8527e11629dSTejun Heo {
8531037de36SLai Jiangshan 	struct worker *worker = first_idle_worker(pool);
8547e11629dSTejun Heo 
8557e11629dSTejun Heo 	if (likely(worker))
8567e11629dSTejun Heo 		wake_up_process(worker->task);
8577e11629dSTejun Heo }
8587e11629dSTejun Heo 
8594690c4abSTejun Heo /**
8606d25be57SThomas Gleixner  * wq_worker_running - a worker is running again
861e22bee78STejun Heo  * @task: task waking up
862e22bee78STejun Heo  *
8636d25be57SThomas Gleixner  * This function is called when a worker returns from schedule()
864e22bee78STejun Heo  */
8656d25be57SThomas Gleixner void wq_worker_running(struct task_struct *task)
866e22bee78STejun Heo {
867e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
868e22bee78STejun Heo 
8696d25be57SThomas Gleixner 	if (!worker->sleeping)
8706d25be57SThomas Gleixner 		return;
87107edfeceSFrederic Weisbecker 
87207edfeceSFrederic Weisbecker 	/*
87307edfeceSFrederic Weisbecker 	 * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check
87407edfeceSFrederic Weisbecker 	 * and the nr_running increment below, we may ruin the nr_running reset
87507edfeceSFrederic Weisbecker 	 * and leave with an unexpected pool->nr_running == 1 on the newly unbound
87607edfeceSFrederic Weisbecker 	 * pool. Protect against such race.
87707edfeceSFrederic Weisbecker 	 */
87807edfeceSFrederic Weisbecker 	preempt_disable();
8796d25be57SThomas Gleixner 	if (!(worker->flags & WORKER_NOT_RUNNING))
880e19e397aSTejun Heo 		atomic_inc(&worker->pool->nr_running);
88107edfeceSFrederic Weisbecker 	preempt_enable();
8826d25be57SThomas Gleixner 	worker->sleeping = 0;
88336576000SJoonsoo Kim }
884e22bee78STejun Heo 
885e22bee78STejun Heo /**
886e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
887e22bee78STejun Heo  * @task: task going to sleep
888e22bee78STejun Heo  *
8896d25be57SThomas Gleixner  * This function is called from schedule() when a busy worker is
89062849a96SSebastian Andrzej Siewior  * going to sleep. Preemption needs to be disabled to protect ->sleeping
89162849a96SSebastian Andrzej Siewior  * assignment.
892e22bee78STejun Heo  */
8936d25be57SThomas Gleixner void wq_worker_sleeping(struct task_struct *task)
894e22bee78STejun Heo {
8956d25be57SThomas Gleixner 	struct worker *next, *worker = kthread_data(task);
896111c225aSTejun Heo 	struct worker_pool *pool;
897e22bee78STejun Heo 
898111c225aSTejun Heo 	/*
899111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
900111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
901111c225aSTejun Heo 	 * checking NOT_RUNNING.
902111c225aSTejun Heo 	 */
9032d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
9046d25be57SThomas Gleixner 		return;
905e22bee78STejun Heo 
906111c225aSTejun Heo 	pool = worker->pool;
907111c225aSTejun Heo 
90862849a96SSebastian Andrzej Siewior 	/* Return if preempted before wq_worker_running() was reached */
90962849a96SSebastian Andrzej Siewior 	if (worker->sleeping)
9106d25be57SThomas Gleixner 		return;
9116d25be57SThomas Gleixner 
9126d25be57SThomas Gleixner 	worker->sleeping = 1;
913a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
914e22bee78STejun Heo 
915e22bee78STejun Heo 	/*
916*45c753f5SFrederic Weisbecker 	 * Recheck in case unbind_workers() preempted us. We don't
917*45c753f5SFrederic Weisbecker 	 * want to decrement nr_running after the worker is unbound
918*45c753f5SFrederic Weisbecker 	 * and nr_running has been reset.
919*45c753f5SFrederic Weisbecker 	 */
920*45c753f5SFrederic Weisbecker 	if (worker->flags & WORKER_NOT_RUNNING) {
921*45c753f5SFrederic Weisbecker 		raw_spin_unlock_irq(&pool->lock);
922*45c753f5SFrederic Weisbecker 		return;
923*45c753f5SFrederic Weisbecker 	}
924*45c753f5SFrederic Weisbecker 
925*45c753f5SFrederic Weisbecker 	/*
926e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
927e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
928e22bee78STejun Heo 	 * Please read comment there.
929e22bee78STejun Heo 	 *
930628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
931628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
932628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
933d565ed63STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without pool
934628c78e7STejun Heo 	 * lock is safe.
935e22bee78STejun Heo 	 */
936e19e397aSTejun Heo 	if (atomic_dec_and_test(&pool->nr_running) &&
9376d25be57SThomas Gleixner 	    !list_empty(&pool->worklist)) {
9386d25be57SThomas Gleixner 		next = first_idle_worker(pool);
9396d25be57SThomas Gleixner 		if (next)
9406d25be57SThomas Gleixner 			wake_up_process(next->task);
9416d25be57SThomas Gleixner 	}
942a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
943e22bee78STejun Heo }
944e22bee78STejun Heo 
945e22bee78STejun Heo /**
9461b69ac6bSJohannes Weiner  * wq_worker_last_func - retrieve worker's last work function
9478194fe94SBart Van Assche  * @task: Task to retrieve last work function of.
9481b69ac6bSJohannes Weiner  *
9491b69ac6bSJohannes Weiner  * Determine the last function a worker executed. This is called from
9501b69ac6bSJohannes Weiner  * the scheduler to get a worker's last known identity.
9511b69ac6bSJohannes Weiner  *
9521b69ac6bSJohannes Weiner  * CONTEXT:
953a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(rq->lock)
9541b69ac6bSJohannes Weiner  *
9554b047002SJohannes Weiner  * This function is called during schedule() when a kworker is going
9564b047002SJohannes Weiner  * to sleep. It's used by psi to identify aggregation workers during
9574b047002SJohannes Weiner  * dequeuing, to allow periodic aggregation to shut-off when that
9584b047002SJohannes Weiner  * worker is the last task in the system or cgroup to go to sleep.
9594b047002SJohannes Weiner  *
9604b047002SJohannes Weiner  * As this function doesn't involve any workqueue-related locking, it
9614b047002SJohannes Weiner  * only returns stable values when called from inside the scheduler's
9624b047002SJohannes Weiner  * queuing and dequeuing paths, when @task, which must be a kworker,
9634b047002SJohannes Weiner  * is guaranteed to not be processing any works.
9644b047002SJohannes Weiner  *
9651b69ac6bSJohannes Weiner  * Return:
9661b69ac6bSJohannes Weiner  * The last work function %current executed as a worker, NULL if it
9671b69ac6bSJohannes Weiner  * hasn't executed any work yet.
9681b69ac6bSJohannes Weiner  */
9691b69ac6bSJohannes Weiner work_func_t wq_worker_last_func(struct task_struct *task)
9701b69ac6bSJohannes Weiner {
9711b69ac6bSJohannes Weiner 	struct worker *worker = kthread_data(task);
9721b69ac6bSJohannes Weiner 
9731b69ac6bSJohannes Weiner 	return worker->last_func;
9741b69ac6bSJohannes Weiner }
9751b69ac6bSJohannes Weiner 
9761b69ac6bSJohannes Weiner /**
977e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
978cb444766STejun Heo  * @worker: self
979d302f017STejun Heo  * @flags: flags to set
980d302f017STejun Heo  *
981228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
982d302f017STejun Heo  *
983cb444766STejun Heo  * CONTEXT:
984a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock)
985d302f017STejun Heo  */
986228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
987d302f017STejun Heo {
988bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
989e22bee78STejun Heo 
990cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
991cb444766STejun Heo 
992228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
993e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
994e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
995e19e397aSTejun Heo 		atomic_dec(&pool->nr_running);
996e22bee78STejun Heo 	}
997e22bee78STejun Heo 
998d302f017STejun Heo 	worker->flags |= flags;
999d302f017STejun Heo }
1000d302f017STejun Heo 
1001d302f017STejun Heo /**
1002e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
1003cb444766STejun Heo  * @worker: self
1004d302f017STejun Heo  * @flags: flags to clear
1005d302f017STejun Heo  *
1006e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
1007d302f017STejun Heo  *
1008cb444766STejun Heo  * CONTEXT:
1009a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock)
1010d302f017STejun Heo  */
1011d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
1012d302f017STejun Heo {
101363d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
1014e22bee78STejun Heo 	unsigned int oflags = worker->flags;
1015e22bee78STejun Heo 
1016cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
1017cb444766STejun Heo 
1018d302f017STejun Heo 	worker->flags &= ~flags;
1019e22bee78STejun Heo 
102042c025f3STejun Heo 	/*
102142c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
102242c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
102342c025f3STejun Heo 	 * of multiple flags, not a single flag.
102442c025f3STejun Heo 	 */
1025e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
1026e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
1027e19e397aSTejun Heo 			atomic_inc(&pool->nr_running);
1028d302f017STejun Heo }
1029d302f017STejun Heo 
1030d302f017STejun Heo /**
10318cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
1032c9e7cf27STejun Heo  * @pool: pool of interest
10338cca0eeaSTejun Heo  * @work: work to find worker for
10348cca0eeaSTejun Heo  *
1035c9e7cf27STejun Heo  * Find a worker which is executing @work on @pool by searching
1036c9e7cf27STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
1037a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
1038a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
1039a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
1040a2c1c57bSTejun Heo  * being executed.
1041a2c1c57bSTejun Heo  *
1042a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
1043a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
1044a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
1045a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
1046a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
1047a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
1048a2c1c57bSTejun Heo  *
1049c5aa87bbSTejun Heo  * This function checks the work item address and work function to avoid
1050c5aa87bbSTejun Heo  * false positives.  Note that this isn't complete as one may construct a
1051c5aa87bbSTejun Heo  * work function which can introduce dependency onto itself through a
1052c5aa87bbSTejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
1053c5aa87bbSTejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
1054c5aa87bbSTejun Heo  * actually occurs, it should be easy to locate the culprit work function.
10558cca0eeaSTejun Heo  *
10568cca0eeaSTejun Heo  * CONTEXT:
1057a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
10588cca0eeaSTejun Heo  *
1059d185af30SYacine Belkadi  * Return:
1060d185af30SYacine Belkadi  * Pointer to worker which is executing @work if found, %NULL
10618cca0eeaSTejun Heo  * otherwise.
10628cca0eeaSTejun Heo  */
1063c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
10648cca0eeaSTejun Heo 						 struct work_struct *work)
10658cca0eeaSTejun Heo {
106642f8570fSSasha Levin 	struct worker *worker;
106742f8570fSSasha Levin 
1068b67bfe0dSSasha Levin 	hash_for_each_possible(pool->busy_hash, worker, hentry,
1069a2c1c57bSTejun Heo 			       (unsigned long)work)
1070a2c1c57bSTejun Heo 		if (worker->current_work == work &&
1071a2c1c57bSTejun Heo 		    worker->current_func == work->func)
107242f8570fSSasha Levin 			return worker;
107342f8570fSSasha Levin 
107442f8570fSSasha Levin 	return NULL;
10758cca0eeaSTejun Heo }
10768cca0eeaSTejun Heo 
10778cca0eeaSTejun Heo /**
1078bf4ede01STejun Heo  * move_linked_works - move linked works to a list
1079bf4ede01STejun Heo  * @work: start of series of works to be scheduled
1080bf4ede01STejun Heo  * @head: target list to append @work to
1081402dd89dSShailendra Verma  * @nextp: out parameter for nested worklist walking
1082bf4ede01STejun Heo  *
1083bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1084bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1085bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1086bf4ede01STejun Heo  *
1087bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1088bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1089bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
1090bf4ede01STejun Heo  *
1091bf4ede01STejun Heo  * CONTEXT:
1092a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1093bf4ede01STejun Heo  */
1094bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1095bf4ede01STejun Heo 			      struct work_struct **nextp)
1096bf4ede01STejun Heo {
1097bf4ede01STejun Heo 	struct work_struct *n;
1098bf4ede01STejun Heo 
1099bf4ede01STejun Heo 	/*
1100bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
1101bf4ede01STejun Heo 	 * use NULL for list head.
1102bf4ede01STejun Heo 	 */
1103bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1104bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
1105bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1106bf4ede01STejun Heo 			break;
1107bf4ede01STejun Heo 	}
1108bf4ede01STejun Heo 
1109bf4ede01STejun Heo 	/*
1110bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
1111bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
1112bf4ede01STejun Heo 	 * needs to be updated.
1113bf4ede01STejun Heo 	 */
1114bf4ede01STejun Heo 	if (nextp)
1115bf4ede01STejun Heo 		*nextp = n;
1116bf4ede01STejun Heo }
1117bf4ede01STejun Heo 
11188864b4e5STejun Heo /**
11198864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
11208864b4e5STejun Heo  * @pwq: pool_workqueue to get
11218864b4e5STejun Heo  *
11228864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
11238864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
11248864b4e5STejun Heo  */
11258864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
11268864b4e5STejun Heo {
11278864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
11288864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
11298864b4e5STejun Heo 	pwq->refcnt++;
11308864b4e5STejun Heo }
11318864b4e5STejun Heo 
11328864b4e5STejun Heo /**
11338864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
11348864b4e5STejun Heo  * @pwq: pool_workqueue to put
11358864b4e5STejun Heo  *
11368864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
11378864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
11388864b4e5STejun Heo  */
11398864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
11408864b4e5STejun Heo {
11418864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
11428864b4e5STejun Heo 	if (likely(--pwq->refcnt))
11438864b4e5STejun Heo 		return;
11448864b4e5STejun Heo 	if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
11458864b4e5STejun Heo 		return;
11468864b4e5STejun Heo 	/*
11478864b4e5STejun Heo 	 * @pwq can't be released under pool->lock, bounce to
11488864b4e5STejun Heo 	 * pwq_unbound_release_workfn().  This never recurses on the same
11498864b4e5STejun Heo 	 * pool->lock as this path is taken only for unbound workqueues and
11508864b4e5STejun Heo 	 * the release work item is scheduled on a per-cpu workqueue.  To
11518864b4e5STejun Heo 	 * avoid lockdep warning, unbound pool->locks are given lockdep
11528864b4e5STejun Heo 	 * subclass of 1 in get_unbound_pool().
11538864b4e5STejun Heo 	 */
11548864b4e5STejun Heo 	schedule_work(&pwq->unbound_release_work);
11558864b4e5STejun Heo }
11568864b4e5STejun Heo 
1157dce90d47STejun Heo /**
1158dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1159dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1160dce90d47STejun Heo  *
1161dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1162dce90d47STejun Heo  */
1163dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1164dce90d47STejun Heo {
1165dce90d47STejun Heo 	if (pwq) {
1166dce90d47STejun Heo 		/*
116724acfb71SThomas Gleixner 		 * As both pwqs and pools are RCU protected, the
1168dce90d47STejun Heo 		 * following lock operations are safe.
1169dce90d47STejun Heo 		 */
1170a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
1171dce90d47STejun Heo 		put_pwq(pwq);
1172a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
1173dce90d47STejun Heo 	}
1174dce90d47STejun Heo }
1175dce90d47STejun Heo 
1176f97a4a1aSLai Jiangshan static void pwq_activate_inactive_work(struct work_struct *work)
1177bf4ede01STejun Heo {
1178112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1179bf4ede01STejun Heo 
1180bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
118182607adcSTejun Heo 	if (list_empty(&pwq->pool->worklist))
118282607adcSTejun Heo 		pwq->pool->watchdog_ts = jiffies;
1183112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
1184f97a4a1aSLai Jiangshan 	__clear_bit(WORK_STRUCT_INACTIVE_BIT, work_data_bits(work));
1185112202d9STejun Heo 	pwq->nr_active++;
1186bf4ede01STejun Heo }
1187bf4ede01STejun Heo 
1188f97a4a1aSLai Jiangshan static void pwq_activate_first_inactive(struct pool_workqueue *pwq)
11893aa62497SLai Jiangshan {
1190f97a4a1aSLai Jiangshan 	struct work_struct *work = list_first_entry(&pwq->inactive_works,
11913aa62497SLai Jiangshan 						    struct work_struct, entry);
11923aa62497SLai Jiangshan 
1193f97a4a1aSLai Jiangshan 	pwq_activate_inactive_work(work);
11943aa62497SLai Jiangshan }
11953aa62497SLai Jiangshan 
1196bf4ede01STejun Heo /**
1197112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1198112202d9STejun Heo  * @pwq: pwq of interest
1199c4560c2cSLai Jiangshan  * @work_data: work_data of work which left the queue
1200bf4ede01STejun Heo  *
1201bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1202112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1203bf4ede01STejun Heo  *
1204bf4ede01STejun Heo  * CONTEXT:
1205a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1206bf4ede01STejun Heo  */
1207c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data)
1208bf4ede01STejun Heo {
1209c4560c2cSLai Jiangshan 	int color = get_work_color(work_data);
1210c4560c2cSLai Jiangshan 
1211018f3a13SLai Jiangshan 	if (!(work_data & WORK_STRUCT_INACTIVE)) {
1212112202d9STejun Heo 		pwq->nr_active--;
1213f97a4a1aSLai Jiangshan 		if (!list_empty(&pwq->inactive_works)) {
1214f97a4a1aSLai Jiangshan 			/* one down, submit an inactive one */
1215112202d9STejun Heo 			if (pwq->nr_active < pwq->max_active)
1216f97a4a1aSLai Jiangshan 				pwq_activate_first_inactive(pwq);
1217bf4ede01STejun Heo 		}
1218018f3a13SLai Jiangshan 	}
1219018f3a13SLai Jiangshan 
1220018f3a13SLai Jiangshan 	pwq->nr_in_flight[color]--;
1221bf4ede01STejun Heo 
1222bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1223112202d9STejun Heo 	if (likely(pwq->flush_color != color))
12248864b4e5STejun Heo 		goto out_put;
1225bf4ede01STejun Heo 
1226bf4ede01STejun Heo 	/* are there still in-flight works? */
1227112202d9STejun Heo 	if (pwq->nr_in_flight[color])
12288864b4e5STejun Heo 		goto out_put;
1229bf4ede01STejun Heo 
1230112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1231112202d9STejun Heo 	pwq->flush_color = -1;
1232bf4ede01STejun Heo 
1233bf4ede01STejun Heo 	/*
1234112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1235bf4ede01STejun Heo 	 * will handle the rest.
1236bf4ede01STejun Heo 	 */
1237112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1238112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
12398864b4e5STejun Heo out_put:
12408864b4e5STejun Heo 	put_pwq(pwq);
1241bf4ede01STejun Heo }
1242bf4ede01STejun Heo 
124336e227d2STejun Heo /**
1244bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
124536e227d2STejun Heo  * @work: work item to steal
124636e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1247bbb68dfaSTejun Heo  * @flags: place to store irq state
124836e227d2STejun Heo  *
124936e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
1250d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
125136e227d2STejun Heo  *
1252d185af30SYacine Belkadi  * Return:
12533eb6b31bSMauro Carvalho Chehab  *
12543eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
125536e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
125636e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
125736e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1258bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1259bbb68dfaSTejun Heo  *		for arbitrarily long
12603eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
126136e227d2STejun Heo  *
1262d185af30SYacine Belkadi  * Note:
1263bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1264e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1265e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1266e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1267bbb68dfaSTejun Heo  *
1268bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1269bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1270bbb68dfaSTejun Heo  *
1271e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1272bf4ede01STejun Heo  */
1273bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1274bbb68dfaSTejun Heo 			       unsigned long *flags)
1275bf4ede01STejun Heo {
1276d565ed63STejun Heo 	struct worker_pool *pool;
1277112202d9STejun Heo 	struct pool_workqueue *pwq;
1278bf4ede01STejun Heo 
1279bbb68dfaSTejun Heo 	local_irq_save(*flags);
1280bbb68dfaSTejun Heo 
128136e227d2STejun Heo 	/* try to steal the timer if it exists */
128236e227d2STejun Heo 	if (is_dwork) {
128336e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
128436e227d2STejun Heo 
1285e0aecdd8STejun Heo 		/*
1286e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1287e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1288e0aecdd8STejun Heo 		 * running on the local CPU.
1289e0aecdd8STejun Heo 		 */
129036e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
129136e227d2STejun Heo 			return 1;
129236e227d2STejun Heo 	}
129336e227d2STejun Heo 
129436e227d2STejun Heo 	/* try to claim PENDING the normal way */
1295bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1296bf4ede01STejun Heo 		return 0;
1297bf4ede01STejun Heo 
129824acfb71SThomas Gleixner 	rcu_read_lock();
1299bf4ede01STejun Heo 	/*
1300bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1301bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1302bf4ede01STejun Heo 	 */
1303d565ed63STejun Heo 	pool = get_work_pool(work);
1304d565ed63STejun Heo 	if (!pool)
1305bbb68dfaSTejun Heo 		goto fail;
1306bf4ede01STejun Heo 
1307a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&pool->lock);
1308bf4ede01STejun Heo 	/*
1309112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
1310112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
1311112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
1312112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
1313112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
13140b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
1315bf4ede01STejun Heo 	 */
1316112202d9STejun Heo 	pwq = get_work_pwq(work);
1317112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
1318bf4ede01STejun Heo 		debug_work_deactivate(work);
13193aa62497SLai Jiangshan 
13203aa62497SLai Jiangshan 		/*
1321018f3a13SLai Jiangshan 		 * A cancelable inactive work item must be in the
1322018f3a13SLai Jiangshan 		 * pwq->inactive_works since a queued barrier can't be
1323018f3a13SLai Jiangshan 		 * canceled (see the comments in insert_wq_barrier()).
1324018f3a13SLai Jiangshan 		 *
1325f97a4a1aSLai Jiangshan 		 * An inactive work item cannot be grabbed directly because
1326d812796eSLai Jiangshan 		 * it might have linked barrier work items which, if left
1327f97a4a1aSLai Jiangshan 		 * on the inactive_works list, will confuse pwq->nr_active
132816062836STejun Heo 		 * management later on and cause stall.  Make sure the work
132916062836STejun Heo 		 * item is activated before grabbing.
13303aa62497SLai Jiangshan 		 */
1331f97a4a1aSLai Jiangshan 		if (*work_data_bits(work) & WORK_STRUCT_INACTIVE)
1332f97a4a1aSLai Jiangshan 			pwq_activate_inactive_work(work);
13333aa62497SLai Jiangshan 
1334bf4ede01STejun Heo 		list_del_init(&work->entry);
1335c4560c2cSLai Jiangshan 		pwq_dec_nr_in_flight(pwq, *work_data_bits(work));
133636e227d2STejun Heo 
1337112202d9STejun Heo 		/* work->data points to pwq iff queued, point to pool */
13384468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
13394468a00fSLai Jiangshan 
1340a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock(&pool->lock);
134124acfb71SThomas Gleixner 		rcu_read_unlock();
134236e227d2STejun Heo 		return 1;
1343bf4ede01STejun Heo 	}
1344a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&pool->lock);
1345bbb68dfaSTejun Heo fail:
134624acfb71SThomas Gleixner 	rcu_read_unlock();
1347bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1348bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1349bbb68dfaSTejun Heo 		return -ENOENT;
1350bbb68dfaSTejun Heo 	cpu_relax();
135136e227d2STejun Heo 	return -EAGAIN;
1352bf4ede01STejun Heo }
1353bf4ede01STejun Heo 
1354bf4ede01STejun Heo /**
1355706026c2STejun Heo  * insert_work - insert a work into a pool
1356112202d9STejun Heo  * @pwq: pwq @work belongs to
13574690c4abSTejun Heo  * @work: work to insert
13584690c4abSTejun Heo  * @head: insertion point
13594690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
13604690c4abSTejun Heo  *
1361112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
1362706026c2STejun Heo  * work_struct flags.
13634690c4abSTejun Heo  *
13644690c4abSTejun Heo  * CONTEXT:
1365a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1366365970a1SDavid Howells  */
1367112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1368112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
1369b89deed3SOleg Nesterov {
1370112202d9STejun Heo 	struct worker_pool *pool = pwq->pool;
1371e1d8aa9fSFrederic Weisbecker 
1372e89a85d6SWalter Wu 	/* record the work call stack in order to print it in KASAN reports */
1373f70da745SMarco Elver 	kasan_record_aux_stack_noalloc(work);
1374e89a85d6SWalter Wu 
13754690c4abSTejun Heo 	/* we own @work, set data and link */
1376112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
13771a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
13788864b4e5STejun Heo 	get_pwq(pwq);
1379e22bee78STejun Heo 
1380e22bee78STejun Heo 	/*
1381c5aa87bbSTejun Heo 	 * Ensure either wq_worker_sleeping() sees the above
1382c5aa87bbSTejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers lying
1383c5aa87bbSTejun Heo 	 * around lazily while there are works to be processed.
1384e22bee78STejun Heo 	 */
1385e22bee78STejun Heo 	smp_mb();
1386e22bee78STejun Heo 
138763d95a91STejun Heo 	if (__need_more_worker(pool))
138863d95a91STejun Heo 		wake_up_worker(pool);
1389b89deed3SOleg Nesterov }
1390b89deed3SOleg Nesterov 
1391c8efcc25STejun Heo /*
1392c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
13938d03ecfeSTejun Heo  * same workqueue.
1394c8efcc25STejun Heo  */
1395c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1396c8efcc25STejun Heo {
1397c8efcc25STejun Heo 	struct worker *worker;
1398c8efcc25STejun Heo 
13998d03ecfeSTejun Heo 	worker = current_wq_worker();
1400c8efcc25STejun Heo 	/*
1401bf393fd4SBart Van Assche 	 * Return %true iff I'm a worker executing a work item on @wq.  If
14028d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
1403c8efcc25STejun Heo 	 */
1404112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
1405c8efcc25STejun Heo }
1406c8efcc25STejun Heo 
1407ef557180SMike Galbraith /*
1408ef557180SMike Galbraith  * When queueing an unbound work item to a wq, prefer local CPU if allowed
1409ef557180SMike Galbraith  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
1410ef557180SMike Galbraith  * avoid perturbing sensitive tasks.
1411ef557180SMike Galbraith  */
1412ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu)
1413ef557180SMike Galbraith {
1414f303fccbSTejun Heo 	static bool printed_dbg_warning;
1415ef557180SMike Galbraith 	int new_cpu;
1416ef557180SMike Galbraith 
1417f303fccbSTejun Heo 	if (likely(!wq_debug_force_rr_cpu)) {
1418ef557180SMike Galbraith 		if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1419ef557180SMike Galbraith 			return cpu;
1420f303fccbSTejun Heo 	} else if (!printed_dbg_warning) {
1421f303fccbSTejun Heo 		pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1422f303fccbSTejun Heo 		printed_dbg_warning = true;
1423f303fccbSTejun Heo 	}
1424f303fccbSTejun Heo 
1425ef557180SMike Galbraith 	if (cpumask_empty(wq_unbound_cpumask))
1426ef557180SMike Galbraith 		return cpu;
1427ef557180SMike Galbraith 
1428ef557180SMike Galbraith 	new_cpu = __this_cpu_read(wq_rr_cpu_last);
1429ef557180SMike Galbraith 	new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1430ef557180SMike Galbraith 	if (unlikely(new_cpu >= nr_cpu_ids)) {
1431ef557180SMike Galbraith 		new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1432ef557180SMike Galbraith 		if (unlikely(new_cpu >= nr_cpu_ids))
1433ef557180SMike Galbraith 			return cpu;
1434ef557180SMike Galbraith 	}
1435ef557180SMike Galbraith 	__this_cpu_write(wq_rr_cpu_last, new_cpu);
1436ef557180SMike Galbraith 
1437ef557180SMike Galbraith 	return new_cpu;
1438ef557180SMike Galbraith }
1439ef557180SMike Galbraith 
1440d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
14411da177e4SLinus Torvalds 			 struct work_struct *work)
14421da177e4SLinus Torvalds {
1443112202d9STejun Heo 	struct pool_workqueue *pwq;
1444c9178087STejun Heo 	struct worker_pool *last_pool;
14451e19ffc6STejun Heo 	struct list_head *worklist;
14468a2e8e5dSTejun Heo 	unsigned int work_flags;
1447b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
14488930cabaSTejun Heo 
14498930cabaSTejun Heo 	/*
14508930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
14518930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
14528930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
14538930cabaSTejun Heo 	 * happen with IRQ disabled.
14548930cabaSTejun Heo 	 */
14558e8eb730SFrederic Weisbecker 	lockdep_assert_irqs_disabled();
14561da177e4SLinus Torvalds 
14571e19ffc6STejun Heo 
14589ef28a73SLi Bin 	/* if draining, only works from the same workqueue are allowed */
1459618b01ebSTejun Heo 	if (unlikely(wq->flags & __WQ_DRAINING) &&
1460c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1461e41e704bSTejun Heo 		return;
146224acfb71SThomas Gleixner 	rcu_read_lock();
14639e8cd2f5STejun Heo retry:
1464aa202f1fSHillf Danton 	/* pwq which will be used unless @work is executing elsewhere */
1465aa202f1fSHillf Danton 	if (wq->flags & WQ_UNBOUND) {
1466df2d5ae4STejun Heo 		if (req_cpu == WORK_CPU_UNBOUND)
1467ef557180SMike Galbraith 			cpu = wq_select_unbound_cpu(raw_smp_processor_id());
1468df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1469aa202f1fSHillf Danton 	} else {
1470aa202f1fSHillf Danton 		if (req_cpu == WORK_CPU_UNBOUND)
1471aa202f1fSHillf Danton 			cpu = raw_smp_processor_id();
1472aa202f1fSHillf Danton 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1473aa202f1fSHillf Danton 	}
1474f3421797STejun Heo 
147518aa9effSTejun Heo 	/*
1476c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
1477c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
1478c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
147918aa9effSTejun Heo 	 */
1480c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
1481112202d9STejun Heo 	if (last_pool && last_pool != pwq->pool) {
148218aa9effSTejun Heo 		struct worker *worker;
148318aa9effSTejun Heo 
1484a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock(&last_pool->lock);
148518aa9effSTejun Heo 
1486c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
148718aa9effSTejun Heo 
1488112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
1489c9178087STejun Heo 			pwq = worker->current_pwq;
14908594fadeSLai Jiangshan 		} else {
149118aa9effSTejun Heo 			/* meh... not running there, queue here */
1492a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock(&last_pool->lock);
1493a9b8a985SSebastian Andrzej Siewior 			raw_spin_lock(&pwq->pool->lock);
149418aa9effSTejun Heo 		}
14958930cabaSTejun Heo 	} else {
1496a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock(&pwq->pool->lock);
14978930cabaSTejun Heo 	}
1498502ca9d8STejun Heo 
14999e8cd2f5STejun Heo 	/*
15009e8cd2f5STejun Heo 	 * pwq is determined and locked.  For unbound pools, we could have
15019e8cd2f5STejun Heo 	 * raced with pwq release and it could already be dead.  If its
15029e8cd2f5STejun Heo 	 * refcnt is zero, repeat pwq selection.  Note that pwqs never die
1503df2d5ae4STejun Heo 	 * without another pwq replacing it in the numa_pwq_tbl or while
1504df2d5ae4STejun Heo 	 * work items are executing on it, so the retrying is guaranteed to
15059e8cd2f5STejun Heo 	 * make forward-progress.
15069e8cd2f5STejun Heo 	 */
15079e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
15089e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
1509a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock(&pwq->pool->lock);
15109e8cd2f5STejun Heo 			cpu_relax();
15119e8cd2f5STejun Heo 			goto retry;
15129e8cd2f5STejun Heo 		}
15139e8cd2f5STejun Heo 		/* oops */
15149e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
15159e8cd2f5STejun Heo 			  wq->name, cpu);
15169e8cd2f5STejun Heo 	}
15179e8cd2f5STejun Heo 
1518112202d9STejun Heo 	/* pwq determined, queue */
1519112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
1520502ca9d8STejun Heo 
152124acfb71SThomas Gleixner 	if (WARN_ON(!list_empty(&work->entry)))
152224acfb71SThomas Gleixner 		goto out;
15231e19ffc6STejun Heo 
1524112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
1525112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
15261e19ffc6STejun Heo 
1527112202d9STejun Heo 	if (likely(pwq->nr_active < pwq->max_active)) {
1528cdadf009STejun Heo 		trace_workqueue_activate_work(work);
1529112202d9STejun Heo 		pwq->nr_active++;
1530112202d9STejun Heo 		worklist = &pwq->pool->worklist;
153182607adcSTejun Heo 		if (list_empty(worklist))
153282607adcSTejun Heo 			pwq->pool->watchdog_ts = jiffies;
15338a2e8e5dSTejun Heo 	} else {
1534f97a4a1aSLai Jiangshan 		work_flags |= WORK_STRUCT_INACTIVE;
1535f97a4a1aSLai Jiangshan 		worklist = &pwq->inactive_works;
15368a2e8e5dSTejun Heo 	}
15371e19ffc6STejun Heo 
15380687c66bSZqiang 	debug_work_activate(work);
1539112202d9STejun Heo 	insert_work(pwq, work, worklist, work_flags);
15401e19ffc6STejun Heo 
154124acfb71SThomas Gleixner out:
1542a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&pwq->pool->lock);
154324acfb71SThomas Gleixner 	rcu_read_unlock();
15441da177e4SLinus Torvalds }
15451da177e4SLinus Torvalds 
15460fcb78c2SRolf Eike Beer /**
1547c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1548c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1549c1a220e7SZhang Rui  * @wq: workqueue to use
1550c1a220e7SZhang Rui  * @work: work to queue
1551c1a220e7SZhang Rui  *
1552c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1553443378f0SPaul E. McKenney  * can't go away.  Callers that fail to ensure that the specified
1554443378f0SPaul E. McKenney  * CPU cannot go away will execute on a randomly chosen CPU.
1555d185af30SYacine Belkadi  *
1556d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
1557c1a220e7SZhang Rui  */
1558d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1559d4283e93STejun Heo 		   struct work_struct *work)
1560c1a220e7SZhang Rui {
1561d4283e93STejun Heo 	bool ret = false;
15628930cabaSTejun Heo 	unsigned long flags;
15638930cabaSTejun Heo 
15648930cabaSTejun Heo 	local_irq_save(flags);
1565c1a220e7SZhang Rui 
156622df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
15674690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1568d4283e93STejun Heo 		ret = true;
1569c1a220e7SZhang Rui 	}
15708930cabaSTejun Heo 
15718930cabaSTejun Heo 	local_irq_restore(flags);
1572c1a220e7SZhang Rui 	return ret;
1573c1a220e7SZhang Rui }
1574ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
1575c1a220e7SZhang Rui 
15768204e0c1SAlexander Duyck /**
15778204e0c1SAlexander Duyck  * workqueue_select_cpu_near - Select a CPU based on NUMA node
15788204e0c1SAlexander Duyck  * @node: NUMA node ID that we want to select a CPU from
15798204e0c1SAlexander Duyck  *
15808204e0c1SAlexander Duyck  * This function will attempt to find a "random" cpu available on a given
15818204e0c1SAlexander Duyck  * node. If there are no CPUs available on the given node it will return
15828204e0c1SAlexander Duyck  * WORK_CPU_UNBOUND indicating that we should just schedule to any
15838204e0c1SAlexander Duyck  * available CPU if we need to schedule this work.
15848204e0c1SAlexander Duyck  */
15858204e0c1SAlexander Duyck static int workqueue_select_cpu_near(int node)
15868204e0c1SAlexander Duyck {
15878204e0c1SAlexander Duyck 	int cpu;
15888204e0c1SAlexander Duyck 
15898204e0c1SAlexander Duyck 	/* No point in doing this if NUMA isn't enabled for workqueues */
15908204e0c1SAlexander Duyck 	if (!wq_numa_enabled)
15918204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
15928204e0c1SAlexander Duyck 
15938204e0c1SAlexander Duyck 	/* Delay binding to CPU if node is not valid or online */
15948204e0c1SAlexander Duyck 	if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
15958204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
15968204e0c1SAlexander Duyck 
15978204e0c1SAlexander Duyck 	/* Use local node/cpu if we are already there */
15988204e0c1SAlexander Duyck 	cpu = raw_smp_processor_id();
15998204e0c1SAlexander Duyck 	if (node == cpu_to_node(cpu))
16008204e0c1SAlexander Duyck 		return cpu;
16018204e0c1SAlexander Duyck 
16028204e0c1SAlexander Duyck 	/* Use "random" otherwise know as "first" online CPU of node */
16038204e0c1SAlexander Duyck 	cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
16048204e0c1SAlexander Duyck 
16058204e0c1SAlexander Duyck 	/* If CPU is valid return that, otherwise just defer */
16068204e0c1SAlexander Duyck 	return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
16078204e0c1SAlexander Duyck }
16088204e0c1SAlexander Duyck 
16098204e0c1SAlexander Duyck /**
16108204e0c1SAlexander Duyck  * queue_work_node - queue work on a "random" cpu for a given NUMA node
16118204e0c1SAlexander Duyck  * @node: NUMA node that we are targeting the work for
16128204e0c1SAlexander Duyck  * @wq: workqueue to use
16138204e0c1SAlexander Duyck  * @work: work to queue
16148204e0c1SAlexander Duyck  *
16158204e0c1SAlexander Duyck  * We queue the work to a "random" CPU within a given NUMA node. The basic
16168204e0c1SAlexander Duyck  * idea here is to provide a way to somehow associate work with a given
16178204e0c1SAlexander Duyck  * NUMA node.
16188204e0c1SAlexander Duyck  *
16198204e0c1SAlexander Duyck  * This function will only make a best effort attempt at getting this onto
16208204e0c1SAlexander Duyck  * the right NUMA node. If no node is requested or the requested node is
16218204e0c1SAlexander Duyck  * offline then we just fall back to standard queue_work behavior.
16228204e0c1SAlexander Duyck  *
16238204e0c1SAlexander Duyck  * Currently the "random" CPU ends up being the first available CPU in the
16248204e0c1SAlexander Duyck  * intersection of cpu_online_mask and the cpumask of the node, unless we
16258204e0c1SAlexander Duyck  * are running on the node. In that case we just use the current CPU.
16268204e0c1SAlexander Duyck  *
16278204e0c1SAlexander Duyck  * Return: %false if @work was already on a queue, %true otherwise.
16288204e0c1SAlexander Duyck  */
16298204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq,
16308204e0c1SAlexander Duyck 		     struct work_struct *work)
16318204e0c1SAlexander Duyck {
16328204e0c1SAlexander Duyck 	unsigned long flags;
16338204e0c1SAlexander Duyck 	bool ret = false;
16348204e0c1SAlexander Duyck 
16358204e0c1SAlexander Duyck 	/*
16368204e0c1SAlexander Duyck 	 * This current implementation is specific to unbound workqueues.
16378204e0c1SAlexander Duyck 	 * Specifically we only return the first available CPU for a given
16388204e0c1SAlexander Duyck 	 * node instead of cycling through individual CPUs within the node.
16398204e0c1SAlexander Duyck 	 *
16408204e0c1SAlexander Duyck 	 * If this is used with a per-cpu workqueue then the logic in
16418204e0c1SAlexander Duyck 	 * workqueue_select_cpu_near would need to be updated to allow for
16428204e0c1SAlexander Duyck 	 * some round robin type logic.
16438204e0c1SAlexander Duyck 	 */
16448204e0c1SAlexander Duyck 	WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
16458204e0c1SAlexander Duyck 
16468204e0c1SAlexander Duyck 	local_irq_save(flags);
16478204e0c1SAlexander Duyck 
16488204e0c1SAlexander Duyck 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
16498204e0c1SAlexander Duyck 		int cpu = workqueue_select_cpu_near(node);
16508204e0c1SAlexander Duyck 
16518204e0c1SAlexander Duyck 		__queue_work(cpu, wq, work);
16528204e0c1SAlexander Duyck 		ret = true;
16538204e0c1SAlexander Duyck 	}
16548204e0c1SAlexander Duyck 
16558204e0c1SAlexander Duyck 	local_irq_restore(flags);
16568204e0c1SAlexander Duyck 	return ret;
16578204e0c1SAlexander Duyck }
16588204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node);
16598204e0c1SAlexander Duyck 
16608c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t)
16611da177e4SLinus Torvalds {
16628c20feb6SKees Cook 	struct delayed_work *dwork = from_timer(dwork, t, timer);
16631da177e4SLinus Torvalds 
1664e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
166560c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
16661da177e4SLinus Torvalds }
16671438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
16681da177e4SLinus Torvalds 
16697beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
167052bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
16711da177e4SLinus Torvalds {
16727beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
16737beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
16741da177e4SLinus Torvalds 
1675637fdbaeSTejun Heo 	WARN_ON_ONCE(!wq);
167698173112SSami Tolvanen 	WARN_ON_FUNCTION_MISMATCH(timer->function, delayed_work_timer_fn);
1677fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1678fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
16797beb2edfSTejun Heo 
16808852aac2STejun Heo 	/*
16818852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
16828852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
16838852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
16848852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
16858852aac2STejun Heo 	 */
16868852aac2STejun Heo 	if (!delay) {
16878852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
16888852aac2STejun Heo 		return;
16898852aac2STejun Heo 	}
16908852aac2STejun Heo 
169160c057bcSLai Jiangshan 	dwork->wq = wq;
16921265057fSTejun Heo 	dwork->cpu = cpu;
16937beb2edfSTejun Heo 	timer->expires = jiffies + delay;
16947beb2edfSTejun Heo 
1695041bd12eSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
16967beb2edfSTejun Heo 		add_timer_on(timer, cpu);
1697041bd12eSTejun Heo 	else
1698041bd12eSTejun Heo 		add_timer(timer);
16997beb2edfSTejun Heo }
17001da177e4SLinus Torvalds 
17010fcb78c2SRolf Eike Beer /**
17020fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
17030fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
17040fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1705af9997e4SRandy Dunlap  * @dwork: work to queue
17060fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
17070fcb78c2SRolf Eike Beer  *
1708d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
1709715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1710715f1300STejun Heo  * execution.
17110fcb78c2SRolf Eike Beer  */
1712d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
171352bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
17147a6bc1cdSVenkatesh Pallipadi {
171552bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1716d4283e93STejun Heo 	bool ret = false;
17178930cabaSTejun Heo 	unsigned long flags;
17188930cabaSTejun Heo 
17198930cabaSTejun Heo 	/* read the comment in __queue_work() */
17208930cabaSTejun Heo 	local_irq_save(flags);
17217a6bc1cdSVenkatesh Pallipadi 
172222df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
17237beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1724d4283e93STejun Heo 		ret = true;
17257a6bc1cdSVenkatesh Pallipadi 	}
17268930cabaSTejun Heo 
17278930cabaSTejun Heo 	local_irq_restore(flags);
17287a6bc1cdSVenkatesh Pallipadi 	return ret;
17297a6bc1cdSVenkatesh Pallipadi }
1730ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
17311da177e4SLinus Torvalds 
1732c8e55f36STejun Heo /**
17338376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
17348376fe22STejun Heo  * @cpu: CPU number to execute work on
17358376fe22STejun Heo  * @wq: workqueue to use
17368376fe22STejun Heo  * @dwork: work to queue
17378376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
17388376fe22STejun Heo  *
17398376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
17408376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
17418376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
17428376fe22STejun Heo  * current state.
17438376fe22STejun Heo  *
1744d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
17458376fe22STejun Heo  * pending and its timer was modified.
17468376fe22STejun Heo  *
1747e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
17488376fe22STejun Heo  * See try_to_grab_pending() for details.
17498376fe22STejun Heo  */
17508376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
17518376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
17528376fe22STejun Heo {
17538376fe22STejun Heo 	unsigned long flags;
17548376fe22STejun Heo 	int ret;
17558376fe22STejun Heo 
17568376fe22STejun Heo 	do {
17578376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
17588376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
17598376fe22STejun Heo 
17608376fe22STejun Heo 	if (likely(ret >= 0)) {
17618376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
17628376fe22STejun Heo 		local_irq_restore(flags);
17638376fe22STejun Heo 	}
17648376fe22STejun Heo 
17658376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
17668376fe22STejun Heo 	return ret;
17678376fe22STejun Heo }
17688376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
17698376fe22STejun Heo 
177005f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu)
177105f0fe6bSTejun Heo {
177205f0fe6bSTejun Heo 	struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
177305f0fe6bSTejun Heo 
177405f0fe6bSTejun Heo 	/* read the comment in __queue_work() */
177505f0fe6bSTejun Heo 	local_irq_disable();
177605f0fe6bSTejun Heo 	__queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
177705f0fe6bSTejun Heo 	local_irq_enable();
177805f0fe6bSTejun Heo }
177905f0fe6bSTejun Heo 
178005f0fe6bSTejun Heo /**
178105f0fe6bSTejun Heo  * queue_rcu_work - queue work after a RCU grace period
178205f0fe6bSTejun Heo  * @wq: workqueue to use
178305f0fe6bSTejun Heo  * @rwork: work to queue
178405f0fe6bSTejun Heo  *
178505f0fe6bSTejun Heo  * Return: %false if @rwork was already pending, %true otherwise.  Note
178605f0fe6bSTejun Heo  * that a full RCU grace period is guaranteed only after a %true return.
1787bf393fd4SBart Van Assche  * While @rwork is guaranteed to be executed after a %false return, the
178805f0fe6bSTejun Heo  * execution may happen before a full RCU grace period has passed.
178905f0fe6bSTejun Heo  */
179005f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
179105f0fe6bSTejun Heo {
179205f0fe6bSTejun Heo 	struct work_struct *work = &rwork->work;
179305f0fe6bSTejun Heo 
179405f0fe6bSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
179505f0fe6bSTejun Heo 		rwork->wq = wq;
179605f0fe6bSTejun Heo 		call_rcu(&rwork->rcu, rcu_work_rcufn);
179705f0fe6bSTejun Heo 		return true;
179805f0fe6bSTejun Heo 	}
179905f0fe6bSTejun Heo 
180005f0fe6bSTejun Heo 	return false;
180105f0fe6bSTejun Heo }
180205f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work);
180305f0fe6bSTejun Heo 
18048376fe22STejun Heo /**
1805c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1806c8e55f36STejun Heo  * @worker: worker which is entering idle state
1807c8e55f36STejun Heo  *
1808c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1809c8e55f36STejun Heo  * necessary.
1810c8e55f36STejun Heo  *
1811c8e55f36STejun Heo  * LOCKING:
1812a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1813c8e55f36STejun Heo  */
1814c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
18151da177e4SLinus Torvalds {
1816bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1817c8e55f36STejun Heo 
18186183c009STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
18196183c009STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
18206183c009STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
18216183c009STejun Heo 		return;
1822c8e55f36STejun Heo 
1823051e1850SLai Jiangshan 	/* can't use worker_set_flags(), also called from create_worker() */
1824cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1825bd7bdd43STejun Heo 	pool->nr_idle++;
1826e22bee78STejun Heo 	worker->last_active = jiffies;
1827c8e55f36STejun Heo 
1828c8e55f36STejun Heo 	/* idle_list is LIFO */
1829bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1830db7bccf4STejun Heo 
183163d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1832628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1833cb444766STejun Heo 
1834544ecf31STejun Heo 	/*
1835e8b3f8dbSLai Jiangshan 	 * Sanity check nr_running.  Because unbind_workers() releases
1836d565ed63STejun Heo 	 * pool->lock between setting %WORKER_UNBOUND and zapping
1837628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1838628c78e7STejun Heo 	 * unbind is not in progress.
1839544ecf31STejun Heo 	 */
184024647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1841bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
1842e19e397aSTejun Heo 		     atomic_read(&pool->nr_running));
1843c8e55f36STejun Heo }
1844c8e55f36STejun Heo 
1845c8e55f36STejun Heo /**
1846c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1847c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1848c8e55f36STejun Heo  *
1849c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1850c8e55f36STejun Heo  *
1851c8e55f36STejun Heo  * LOCKING:
1852a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1853c8e55f36STejun Heo  */
1854c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1855c8e55f36STejun Heo {
1856bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1857c8e55f36STejun Heo 
18586183c009STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
18596183c009STejun Heo 		return;
1860d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1861bd7bdd43STejun Heo 	pool->nr_idle--;
1862c8e55f36STejun Heo 	list_del_init(&worker->entry);
1863c8e55f36STejun Heo }
1864c8e55f36STejun Heo 
1865f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
1866c34056a3STejun Heo {
1867c34056a3STejun Heo 	struct worker *worker;
1868c34056a3STejun Heo 
1869f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
1870c8e55f36STejun Heo 	if (worker) {
1871c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1872affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1873da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
1874e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1875e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1876c8e55f36STejun Heo 	}
1877c34056a3STejun Heo 	return worker;
1878c34056a3STejun Heo }
1879c34056a3STejun Heo 
1880c34056a3STejun Heo /**
18814736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
18824736cbf7SLai Jiangshan  * @worker: worker to be attached
18834736cbf7SLai Jiangshan  * @pool: the target pool
18844736cbf7SLai Jiangshan  *
18854736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
18864736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
18874736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
18884736cbf7SLai Jiangshan  */
18894736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
18904736cbf7SLai Jiangshan 				   struct worker_pool *pool)
18914736cbf7SLai Jiangshan {
18921258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
18934736cbf7SLai Jiangshan 
18944736cbf7SLai Jiangshan 	/*
18951258fae7STejun Heo 	 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
18961258fae7STejun Heo 	 * stable across this function.  See the comments above the flag
18971258fae7STejun Heo 	 * definition for details.
18984736cbf7SLai Jiangshan 	 */
18994736cbf7SLai Jiangshan 	if (pool->flags & POOL_DISASSOCIATED)
19004736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
19015c25b5ffSPeter Zijlstra 	else
19025c25b5ffSPeter Zijlstra 		kthread_set_per_cpu(worker->task, pool->cpu);
19034736cbf7SLai Jiangshan 
1904640f17c8SPeter Zijlstra 	if (worker->rescue_wq)
1905640f17c8SPeter Zijlstra 		set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1906640f17c8SPeter Zijlstra 
19074736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
1908a2d812a2STejun Heo 	worker->pool = pool;
19094736cbf7SLai Jiangshan 
19101258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
19114736cbf7SLai Jiangshan }
19124736cbf7SLai Jiangshan 
19134736cbf7SLai Jiangshan /**
191460f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
191560f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
191660f5a4bcSLai Jiangshan  *
19174736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
19184736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
19194736cbf7SLai Jiangshan  * other reference to the pool.
192060f5a4bcSLai Jiangshan  */
1921a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker)
192260f5a4bcSLai Jiangshan {
1923a2d812a2STejun Heo 	struct worker_pool *pool = worker->pool;
192460f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
192560f5a4bcSLai Jiangshan 
19261258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
1927a2d812a2STejun Heo 
19285c25b5ffSPeter Zijlstra 	kthread_set_per_cpu(worker->task, -1);
1929da028469SLai Jiangshan 	list_del(&worker->node);
1930a2d812a2STejun Heo 	worker->pool = NULL;
1931a2d812a2STejun Heo 
1932da028469SLai Jiangshan 	if (list_empty(&pool->workers))
193360f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
19341258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
193560f5a4bcSLai Jiangshan 
1936b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
1937b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1938b62c0751SLai Jiangshan 
193960f5a4bcSLai Jiangshan 	if (detach_completion)
194060f5a4bcSLai Jiangshan 		complete(detach_completion);
194160f5a4bcSLai Jiangshan }
194260f5a4bcSLai Jiangshan 
194360f5a4bcSLai Jiangshan /**
1944c34056a3STejun Heo  * create_worker - create a new workqueue worker
194563d95a91STejun Heo  * @pool: pool the new worker will belong to
1946c34056a3STejun Heo  *
1947051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
1948c34056a3STejun Heo  *
1949c34056a3STejun Heo  * CONTEXT:
1950c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1951c34056a3STejun Heo  *
1952d185af30SYacine Belkadi  * Return:
1953c34056a3STejun Heo  * Pointer to the newly created worker.
1954c34056a3STejun Heo  */
1955bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1956c34056a3STejun Heo {
1957e441b56fSZhen Lei 	struct worker *worker;
1958e441b56fSZhen Lei 	int id;
1959e3c916a4STejun Heo 	char id_buf[16];
1960c34056a3STejun Heo 
19617cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
1962e441b56fSZhen Lei 	id = ida_alloc(&pool->worker_ida, GFP_KERNEL);
1963822d8405STejun Heo 	if (id < 0)
1964e441b56fSZhen Lei 		return NULL;
1965c34056a3STejun Heo 
1966f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
1967c34056a3STejun Heo 	if (!worker)
1968c34056a3STejun Heo 		goto fail;
1969c34056a3STejun Heo 
1970c34056a3STejun Heo 	worker->id = id;
1971c34056a3STejun Heo 
197229c91e99STejun Heo 	if (pool->cpu >= 0)
1973e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1974e3c916a4STejun Heo 			 pool->attrs->nice < 0  ? "H" : "");
1975f3421797STejun Heo 	else
1976e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1977e3c916a4STejun Heo 
1978f3f90ad4STejun Heo 	worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1979e3c916a4STejun Heo 					      "kworker/%s", id_buf);
1980c34056a3STejun Heo 	if (IS_ERR(worker->task))
1981c34056a3STejun Heo 		goto fail;
1982c34056a3STejun Heo 
198391151228SOleg Nesterov 	set_user_nice(worker->task, pool->attrs->nice);
198425834c73SPeter Zijlstra 	kthread_bind_mask(worker->task, pool->attrs->cpumask);
198591151228SOleg Nesterov 
1986da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
19874736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
1988822d8405STejun Heo 
1989051e1850SLai Jiangshan 	/* start the newly created worker */
1990a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
1991051e1850SLai Jiangshan 	worker->pool->nr_workers++;
1992051e1850SLai Jiangshan 	worker_enter_idle(worker);
1993051e1850SLai Jiangshan 	wake_up_process(worker->task);
1994a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
1995051e1850SLai Jiangshan 
1996c34056a3STejun Heo 	return worker;
1997822d8405STejun Heo 
1998c34056a3STejun Heo fail:
1999e441b56fSZhen Lei 	ida_free(&pool->worker_ida, id);
2000c34056a3STejun Heo 	kfree(worker);
2001c34056a3STejun Heo 	return NULL;
2002c34056a3STejun Heo }
2003c34056a3STejun Heo 
2004c34056a3STejun Heo /**
2005c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
2006c34056a3STejun Heo  * @worker: worker to be destroyed
2007c34056a3STejun Heo  *
200873eb7fe7SLai Jiangshan  * Destroy @worker and adjust @pool stats accordingly.  The worker should
200973eb7fe7SLai Jiangshan  * be idle.
2010c8e55f36STejun Heo  *
2011c8e55f36STejun Heo  * CONTEXT:
2012a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2013c34056a3STejun Heo  */
2014c34056a3STejun Heo static void destroy_worker(struct worker *worker)
2015c34056a3STejun Heo {
2016bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2017c34056a3STejun Heo 
2018cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
2019cd549687STejun Heo 
2020c34056a3STejun Heo 	/* sanity check frenzy */
20216183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
202273eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
202373eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
20246183c009STejun Heo 		return;
2025c34056a3STejun Heo 
2026bd7bdd43STejun Heo 	pool->nr_workers--;
2027bd7bdd43STejun Heo 	pool->nr_idle--;
2028c8e55f36STejun Heo 
2029c8e55f36STejun Heo 	list_del_init(&worker->entry);
2030cb444766STejun Heo 	worker->flags |= WORKER_DIE;
203160f5a4bcSLai Jiangshan 	wake_up_process(worker->task);
2032c34056a3STejun Heo }
2033c34056a3STejun Heo 
203432a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t)
2035e22bee78STejun Heo {
203632a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, idle_timer);
2037e22bee78STejun Heo 
2038a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2039e22bee78STejun Heo 
20403347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
2041e22bee78STejun Heo 		struct worker *worker;
2042e22bee78STejun Heo 		unsigned long expires;
2043e22bee78STejun Heo 
2044e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
204563d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2046e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2047e22bee78STejun Heo 
20483347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
204963d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
20503347fc9fSLai Jiangshan 			break;
2051e22bee78STejun Heo 		}
20523347fc9fSLai Jiangshan 
20533347fc9fSLai Jiangshan 		destroy_worker(worker);
2054e22bee78STejun Heo 	}
2055e22bee78STejun Heo 
2056a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2057e22bee78STejun Heo }
2058e22bee78STejun Heo 
2059493a1724STejun Heo static void send_mayday(struct work_struct *work)
2060e22bee78STejun Heo {
2061112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2062112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
2063493a1724STejun Heo 
20642e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
2065e22bee78STejun Heo 
2066493008a8STejun Heo 	if (!wq->rescuer)
2067493a1724STejun Heo 		return;
2068e22bee78STejun Heo 
2069e22bee78STejun Heo 	/* mayday mayday mayday */
2070493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
207177668c8bSLai Jiangshan 		/*
207277668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
207377668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
207477668c8bSLai Jiangshan 		 * rescuer is done with it.
207577668c8bSLai Jiangshan 		 */
207677668c8bSLai Jiangshan 		get_pwq(pwq);
2077493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
2078e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
2079493a1724STejun Heo 	}
2080e22bee78STejun Heo }
2081e22bee78STejun Heo 
208232a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t)
2083e22bee78STejun Heo {
208432a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, mayday_timer);
2085e22bee78STejun Heo 	struct work_struct *work;
2086e22bee78STejun Heo 
2087a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2088a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&wq_mayday_lock);		/* for wq->maydays */
2089e22bee78STejun Heo 
209063d95a91STejun Heo 	if (need_to_create_worker(pool)) {
2091e22bee78STejun Heo 		/*
2092e22bee78STejun Heo 		 * We've been trying to create a new worker but
2093e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
2094e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
2095e22bee78STejun Heo 		 * rescuers.
2096e22bee78STejun Heo 		 */
209763d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
2098e22bee78STejun Heo 			send_mayday(work);
2099e22bee78STejun Heo 	}
2100e22bee78STejun Heo 
2101a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&wq_mayday_lock);
2102a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2103e22bee78STejun Heo 
210463d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
2105e22bee78STejun Heo }
2106e22bee78STejun Heo 
2107e22bee78STejun Heo /**
2108e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
210963d95a91STejun Heo  * @pool: pool to create a new worker for
2110e22bee78STejun Heo  *
211163d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
2112e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
2113e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
211463d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
2115e22bee78STejun Heo  * possible allocation deadlock.
2116e22bee78STejun Heo  *
2117c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
2118c5aa87bbSTejun Heo  * may_start_working() %true.
2119e22bee78STejun Heo  *
2120e22bee78STejun Heo  * LOCKING:
2121a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2122e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
2123e22bee78STejun Heo  * manager.
2124e22bee78STejun Heo  */
212529187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool)
2126d565ed63STejun Heo __releases(&pool->lock)
2127d565ed63STejun Heo __acquires(&pool->lock)
2128e22bee78STejun Heo {
2129e22bee78STejun Heo restart:
2130a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
21319f9c2364STejun Heo 
2132e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
213363d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2134e22bee78STejun Heo 
2135e22bee78STejun Heo 	while (true) {
2136051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
2137e22bee78STejun Heo 			break;
2138e22bee78STejun Heo 
2139e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
21409f9c2364STejun Heo 
214163d95a91STejun Heo 		if (!need_to_create_worker(pool))
2142e22bee78STejun Heo 			break;
2143e22bee78STejun Heo 	}
2144e22bee78STejun Heo 
214563d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2146a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2147051e1850SLai Jiangshan 	/*
2148051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
2149051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
2150051e1850SLai Jiangshan 	 * already become busy.
2151051e1850SLai Jiangshan 	 */
215263d95a91STejun Heo 	if (need_to_create_worker(pool))
2153e22bee78STejun Heo 		goto restart;
2154e22bee78STejun Heo }
2155e22bee78STejun Heo 
2156e22bee78STejun Heo /**
2157e22bee78STejun Heo  * manage_workers - manage worker pool
2158e22bee78STejun Heo  * @worker: self
2159e22bee78STejun Heo  *
2160706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
2161e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2162706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
2163e22bee78STejun Heo  *
2164e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2165e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2166e22bee78STejun Heo  * and may_start_working() is true.
2167e22bee78STejun Heo  *
2168e22bee78STejun Heo  * CONTEXT:
2169a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2170e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2171e22bee78STejun Heo  *
2172d185af30SYacine Belkadi  * Return:
217329187a9eSTejun Heo  * %false if the pool doesn't need management and the caller can safely
217429187a9eSTejun Heo  * start processing works, %true if management function was performed and
217529187a9eSTejun Heo  * the conditions that the caller verified before calling the function may
217629187a9eSTejun Heo  * no longer be true.
2177e22bee78STejun Heo  */
2178e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2179e22bee78STejun Heo {
218063d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2181e22bee78STejun Heo 
2182692b4825STejun Heo 	if (pool->flags & POOL_MANAGER_ACTIVE)
218329187a9eSTejun Heo 		return false;
2184692b4825STejun Heo 
2185692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
21862607d7a6STejun Heo 	pool->manager = worker;
2187e22bee78STejun Heo 
218829187a9eSTejun Heo 	maybe_create_worker(pool);
2189e22bee78STejun Heo 
21902607d7a6STejun Heo 	pool->manager = NULL;
2191692b4825STejun Heo 	pool->flags &= ~POOL_MANAGER_ACTIVE;
2192d8bb65abSSebastian Andrzej Siewior 	rcuwait_wake_up(&manager_wait);
219329187a9eSTejun Heo 	return true;
2194e22bee78STejun Heo }
2195e22bee78STejun Heo 
2196a62428c0STejun Heo /**
2197a62428c0STejun Heo  * process_one_work - process single work
2198c34056a3STejun Heo  * @worker: self
2199a62428c0STejun Heo  * @work: work to process
2200a62428c0STejun Heo  *
2201a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2202a62428c0STejun Heo  * process a single work including synchronization against and
2203a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2204a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2205a62428c0STejun Heo  * call this function to process a work.
2206a62428c0STejun Heo  *
2207a62428c0STejun Heo  * CONTEXT:
2208a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
2209a62428c0STejun Heo  */
2210c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
2211d565ed63STejun Heo __releases(&pool->lock)
2212d565ed63STejun Heo __acquires(&pool->lock)
22131da177e4SLinus Torvalds {
2214112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2215bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2216112202d9STejun Heo 	bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
2217c4560c2cSLai Jiangshan 	unsigned long work_data;
22187e11629dSTejun Heo 	struct worker *collision;
22194e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
22204e6045f1SJohannes Berg 	/*
2221a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2222a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2223a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2224a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2225a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
22264e6045f1SJohannes Berg 	 */
22274d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
22284d82a1deSPeter Zijlstra 
22294d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
22304e6045f1SJohannes Berg #endif
2231807407c0SLai Jiangshan 	/* ensure we're on the correct CPU */
223285327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
2233ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
223425511a47STejun Heo 
22357e11629dSTejun Heo 	/*
22367e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
22377e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
22387e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
22397e11629dSTejun Heo 	 * currently executing one.
22407e11629dSTejun Heo 	 */
2241c9e7cf27STejun Heo 	collision = find_worker_executing_work(pool, work);
22427e11629dSTejun Heo 	if (unlikely(collision)) {
22437e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
22447e11629dSTejun Heo 		return;
22457e11629dSTejun Heo 	}
22461da177e4SLinus Torvalds 
22478930cabaSTejun Heo 	/* claim and dequeue */
22481da177e4SLinus Torvalds 	debug_work_deactivate(work);
2249c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2250c34056a3STejun Heo 	worker->current_work = work;
2251a2c1c57bSTejun Heo 	worker->current_func = work->func;
2252112202d9STejun Heo 	worker->current_pwq = pwq;
2253c4560c2cSLai Jiangshan 	work_data = *work_data_bits(work);
2254d812796eSLai Jiangshan 	worker->current_color = get_work_color(work_data);
22557a22ad75STejun Heo 
22568bf89593STejun Heo 	/*
22578bf89593STejun Heo 	 * Record wq name for cmdline and debug reporting, may get
22588bf89593STejun Heo 	 * overridden through set_worker_desc().
22598bf89593STejun Heo 	 */
22608bf89593STejun Heo 	strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
22618bf89593STejun Heo 
2262a62428c0STejun Heo 	list_del_init(&work->entry);
2263a62428c0STejun Heo 
2264649027d7STejun Heo 	/*
2265228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
2266228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
2267228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
2268228f1d00SLai Jiangshan 	 * execution of the pending work items.
2269fb0e7bebSTejun Heo 	 */
2270fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2271228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
2272fb0e7bebSTejun Heo 
2273974271c4STejun Heo 	/*
2274a489a03eSLai Jiangshan 	 * Wake up another worker if necessary.  The condition is always
2275a489a03eSLai Jiangshan 	 * false for normal per-cpu workers since nr_running would always
2276a489a03eSLai Jiangshan 	 * be >= 1 at this point.  This is used to chain execution of the
2277a489a03eSLai Jiangshan 	 * pending work items for WORKER_NOT_RUNNING workers such as the
2278228f1d00SLai Jiangshan 	 * UNBOUND and CPU_INTENSIVE ones.
2279974271c4STejun Heo 	 */
2280a489a03eSLai Jiangshan 	if (need_more_worker(pool))
228163d95a91STejun Heo 		wake_up_worker(pool);
2282974271c4STejun Heo 
22838930cabaSTejun Heo 	/*
22847c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
2285d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
228623657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
228723657bb1STejun Heo 	 * disabled.
22888930cabaSTejun Heo 	 */
22897c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
22901da177e4SLinus Torvalds 
2291a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2292365970a1SDavid Howells 
2293a1d14934SPeter Zijlstra 	lock_map_acquire(&pwq->wq->lockdep_map);
22943295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2295e6f3faa7SPeter Zijlstra 	/*
2296f52be570SPeter Zijlstra 	 * Strictly speaking we should mark the invariant state without holding
2297f52be570SPeter Zijlstra 	 * any locks, that is, before these two lock_map_acquire()'s.
2298e6f3faa7SPeter Zijlstra 	 *
2299e6f3faa7SPeter Zijlstra 	 * However, that would result in:
2300e6f3faa7SPeter Zijlstra 	 *
2301e6f3faa7SPeter Zijlstra 	 *   A(W1)
2302e6f3faa7SPeter Zijlstra 	 *   WFC(C)
2303e6f3faa7SPeter Zijlstra 	 *		A(W1)
2304e6f3faa7SPeter Zijlstra 	 *		C(C)
2305e6f3faa7SPeter Zijlstra 	 *
2306e6f3faa7SPeter Zijlstra 	 * Which would create W1->C->W1 dependencies, even though there is no
2307e6f3faa7SPeter Zijlstra 	 * actual deadlock possible. There are two solutions, using a
2308e6f3faa7SPeter Zijlstra 	 * read-recursive acquire on the work(queue) 'locks', but this will then
2309f52be570SPeter Zijlstra 	 * hit the lockdep limitation on recursive locks, or simply discard
2310e6f3faa7SPeter Zijlstra 	 * these locks.
2311e6f3faa7SPeter Zijlstra 	 *
2312e6f3faa7SPeter Zijlstra 	 * AFAICT there is no possible deadlock scenario between the
2313e6f3faa7SPeter Zijlstra 	 * flush_work() and complete() primitives (except for single-threaded
2314e6f3faa7SPeter Zijlstra 	 * workqueues), so hiding them isn't a problem.
2315e6f3faa7SPeter Zijlstra 	 */
2316f52be570SPeter Zijlstra 	lockdep_invariant_state(true);
2317e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2318a2c1c57bSTejun Heo 	worker->current_func(work);
2319e36c886aSArjan van de Ven 	/*
2320e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2321e36c886aSArjan van de Ven 	 * point will only record its address.
2322e36c886aSArjan van de Ven 	 */
23231c5da0ecSDaniel Jordan 	trace_workqueue_execute_end(work, worker->current_func);
23243295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
2325112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
23261da177e4SLinus Torvalds 
2327d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2328044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2329d75f773cSSakari Ailus 		       "     last function: %ps\n",
2330a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2331a2c1c57bSTejun Heo 		       worker->current_func);
2332d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2333d5abe669SPeter Zijlstra 		dump_stack();
2334d5abe669SPeter Zijlstra 	}
2335d5abe669SPeter Zijlstra 
2336b22ce278STejun Heo 	/*
2337025f50f3SSebastian Andrzej Siewior 	 * The following prevents a kworker from hogging CPU on !PREEMPTION
2338b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
2339b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
2340b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
2341789cbbecSJoe Lawrence 	 * stop_machine. At the same time, report a quiescent RCU state so
2342789cbbecSJoe Lawrence 	 * the same condition doesn't freeze RCU.
2343b22ce278STejun Heo 	 */
2344a7e6425eSPaul E. McKenney 	cond_resched();
2345b22ce278STejun Heo 
2346a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2347a62428c0STejun Heo 
2348fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2349fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2350fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2351fb0e7bebSTejun Heo 
23521b69ac6bSJohannes Weiner 	/* tag the worker for identification in schedule() */
23531b69ac6bSJohannes Weiner 	worker->last_func = worker->current_func;
23541b69ac6bSJohannes Weiner 
2355a62428c0STejun Heo 	/* we're done with it, release */
235642f8570fSSasha Levin 	hash_del(&worker->hentry);
2357c34056a3STejun Heo 	worker->current_work = NULL;
2358a2c1c57bSTejun Heo 	worker->current_func = NULL;
2359112202d9STejun Heo 	worker->current_pwq = NULL;
2360d812796eSLai Jiangshan 	worker->current_color = INT_MAX;
2361c4560c2cSLai Jiangshan 	pwq_dec_nr_in_flight(pwq, work_data);
23621da177e4SLinus Torvalds }
23631da177e4SLinus Torvalds 
2364affee4b2STejun Heo /**
2365affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2366affee4b2STejun Heo  * @worker: self
2367affee4b2STejun Heo  *
2368affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2369affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2370affee4b2STejun Heo  * fetches a work from the top and executes it.
2371affee4b2STejun Heo  *
2372affee4b2STejun Heo  * CONTEXT:
2373a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2374affee4b2STejun Heo  * multiple times.
2375affee4b2STejun Heo  */
2376affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
23771da177e4SLinus Torvalds {
2378affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2379affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2380a62428c0STejun Heo 						struct work_struct, entry);
2381c34056a3STejun Heo 		process_one_work(worker, work);
2382a62428c0STejun Heo 	}
23831da177e4SLinus Torvalds }
23841da177e4SLinus Torvalds 
2385197f6accSTejun Heo static void set_pf_worker(bool val)
2386197f6accSTejun Heo {
2387197f6accSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
2388197f6accSTejun Heo 	if (val)
2389197f6accSTejun Heo 		current->flags |= PF_WQ_WORKER;
2390197f6accSTejun Heo 	else
2391197f6accSTejun Heo 		current->flags &= ~PF_WQ_WORKER;
2392197f6accSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
2393197f6accSTejun Heo }
2394197f6accSTejun Heo 
23954690c4abSTejun Heo /**
23964690c4abSTejun Heo  * worker_thread - the worker thread function
2397c34056a3STejun Heo  * @__worker: self
23984690c4abSTejun Heo  *
2399c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
2400c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
2401c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
2402c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
2403c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
2404d185af30SYacine Belkadi  *
2405d185af30SYacine Belkadi  * Return: 0
24064690c4abSTejun Heo  */
2407c34056a3STejun Heo static int worker_thread(void *__worker)
24081da177e4SLinus Torvalds {
2409c34056a3STejun Heo 	struct worker *worker = __worker;
2410bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
24111da177e4SLinus Torvalds 
2412e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2413197f6accSTejun Heo 	set_pf_worker(true);
2414c8e55f36STejun Heo woke_up:
2415a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2416affee4b2STejun Heo 
2417a9ab775bSTejun Heo 	/* am I supposed to die? */
2418a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
2419a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
2420a9ab775bSTejun Heo 		WARN_ON_ONCE(!list_empty(&worker->entry));
2421197f6accSTejun Heo 		set_pf_worker(false);
242260f5a4bcSLai Jiangshan 
242360f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
2424e441b56fSZhen Lei 		ida_free(&pool->worker_ida, worker->id);
2425a2d812a2STejun Heo 		worker_detach_from_pool(worker);
242660f5a4bcSLai Jiangshan 		kfree(worker);
2427c8e55f36STejun Heo 		return 0;
2428c8e55f36STejun Heo 	}
2429c8e55f36STejun Heo 
2430c8e55f36STejun Heo 	worker_leave_idle(worker);
2431db7bccf4STejun Heo recheck:
2432e22bee78STejun Heo 	/* no more worker necessary? */
243363d95a91STejun Heo 	if (!need_more_worker(pool))
2434e22bee78STejun Heo 		goto sleep;
2435e22bee78STejun Heo 
2436e22bee78STejun Heo 	/* do we need to manage? */
243763d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2438e22bee78STejun Heo 		goto recheck;
2439e22bee78STejun Heo 
2440c8e55f36STejun Heo 	/*
2441c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2442c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2443c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2444c8e55f36STejun Heo 	 */
24456183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
2446c8e55f36STejun Heo 
2447e22bee78STejun Heo 	/*
2448a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
2449a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
2450a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
2451a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
2452a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
2453e22bee78STejun Heo 	 */
2454a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2455e22bee78STejun Heo 
2456e22bee78STejun Heo 	do {
2457affee4b2STejun Heo 		struct work_struct *work =
2458bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2459affee4b2STejun Heo 					 struct work_struct, entry);
2460affee4b2STejun Heo 
246182607adcSTejun Heo 		pool->watchdog_ts = jiffies;
246282607adcSTejun Heo 
2463c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2464affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2465affee4b2STejun Heo 			process_one_work(worker, work);
2466affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2467affee4b2STejun Heo 				process_scheduled_works(worker);
2468affee4b2STejun Heo 		} else {
2469c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2470affee4b2STejun Heo 			process_scheduled_works(worker);
2471affee4b2STejun Heo 		}
247263d95a91STejun Heo 	} while (keep_working(pool));
2473affee4b2STejun Heo 
2474228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
2475d313dd85STejun Heo sleep:
2476c8e55f36STejun Heo 	/*
2477d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
2478d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
2479d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
2480d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
2481d565ed63STejun Heo 	 * event.
2482c8e55f36STejun Heo 	 */
2483c8e55f36STejun Heo 	worker_enter_idle(worker);
2484c5a94a61SPeter Zijlstra 	__set_current_state(TASK_IDLE);
2485a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
24861da177e4SLinus Torvalds 	schedule();
2487c8e55f36STejun Heo 	goto woke_up;
24881da177e4SLinus Torvalds }
24891da177e4SLinus Torvalds 
2490e22bee78STejun Heo /**
2491e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2492111c225aSTejun Heo  * @__rescuer: self
2493e22bee78STejun Heo  *
2494e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2495493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
2496e22bee78STejun Heo  *
2497706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
2498e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2499e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2500e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2501e22bee78STejun Heo  * the problem rescuer solves.
2502e22bee78STejun Heo  *
2503706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
2504706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
2505e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2506e22bee78STejun Heo  *
2507e22bee78STejun Heo  * This should happen rarely.
2508d185af30SYacine Belkadi  *
2509d185af30SYacine Belkadi  * Return: 0
2510e22bee78STejun Heo  */
2511111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2512e22bee78STejun Heo {
2513111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2514111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2515e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
25164d595b86SLai Jiangshan 	bool should_stop;
2517e22bee78STejun Heo 
2518e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2519111c225aSTejun Heo 
2520111c225aSTejun Heo 	/*
2521111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2522111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2523111c225aSTejun Heo 	 */
2524197f6accSTejun Heo 	set_pf_worker(true);
2525e22bee78STejun Heo repeat:
2526c5a94a61SPeter Zijlstra 	set_current_state(TASK_IDLE);
25271da177e4SLinus Torvalds 
25284d595b86SLai Jiangshan 	/*
25294d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
25304d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
25314d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
25324d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
25334d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
25344d595b86SLai Jiangshan 	 * list is always empty on exit.
25354d595b86SLai Jiangshan 	 */
25364d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
25371da177e4SLinus Torvalds 
2538493a1724STejun Heo 	/* see whether any pwq is asking for help */
2539a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&wq_mayday_lock);
2540493a1724STejun Heo 
2541493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
2542493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2543493a1724STejun Heo 					struct pool_workqueue, mayday_node);
2544112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
2545e22bee78STejun Heo 		struct work_struct *work, *n;
254682607adcSTejun Heo 		bool first = true;
2547e22bee78STejun Heo 
2548e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2549493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
2550493a1724STejun Heo 
2551a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
2552e22bee78STejun Heo 
255351697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
255451697d39SLai Jiangshan 
2555a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
2556e22bee78STejun Heo 
2557e22bee78STejun Heo 		/*
2558e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2559e22bee78STejun Heo 		 * process'em.
2560e22bee78STejun Heo 		 */
25610479c8c5STejun Heo 		WARN_ON_ONCE(!list_empty(scheduled));
256282607adcSTejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry) {
256382607adcSTejun Heo 			if (get_work_pwq(work) == pwq) {
256482607adcSTejun Heo 				if (first)
256582607adcSTejun Heo 					pool->watchdog_ts = jiffies;
2566e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
256782607adcSTejun Heo 			}
256882607adcSTejun Heo 			first = false;
256982607adcSTejun Heo 		}
2570e22bee78STejun Heo 
2571008847f6SNeilBrown 		if (!list_empty(scheduled)) {
2572e22bee78STejun Heo 			process_scheduled_works(rescuer);
25737576958aSTejun Heo 
25747576958aSTejun Heo 			/*
2575008847f6SNeilBrown 			 * The above execution of rescued work items could
2576008847f6SNeilBrown 			 * have created more to rescue through
2577f97a4a1aSLai Jiangshan 			 * pwq_activate_first_inactive() or chained
2578008847f6SNeilBrown 			 * queueing.  Let's put @pwq back on mayday list so
2579008847f6SNeilBrown 			 * that such back-to-back work items, which may be
2580008847f6SNeilBrown 			 * being used to relieve memory pressure, don't
2581008847f6SNeilBrown 			 * incur MAYDAY_INTERVAL delay inbetween.
2582008847f6SNeilBrown 			 */
25834f3f4cf3SLai Jiangshan 			if (pwq->nr_active && need_to_create_worker(pool)) {
2584a9b8a985SSebastian Andrzej Siewior 				raw_spin_lock(&wq_mayday_lock);
2585e66b39afSTejun Heo 				/*
2586e66b39afSTejun Heo 				 * Queue iff we aren't racing destruction
2587e66b39afSTejun Heo 				 * and somebody else hasn't queued it already.
2588e66b39afSTejun Heo 				 */
2589e66b39afSTejun Heo 				if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2590008847f6SNeilBrown 					get_pwq(pwq);
2591e66b39afSTejun Heo 					list_add_tail(&pwq->mayday_node, &wq->maydays);
2592e66b39afSTejun Heo 				}
2593a9b8a985SSebastian Andrzej Siewior 				raw_spin_unlock(&wq_mayday_lock);
2594008847f6SNeilBrown 			}
2595008847f6SNeilBrown 		}
2596008847f6SNeilBrown 
2597008847f6SNeilBrown 		/*
259877668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
259913b1d625SLai Jiangshan 		 * go away while we're still attached to it.
260077668c8bSLai Jiangshan 		 */
260177668c8bSLai Jiangshan 		put_pwq(pwq);
260277668c8bSLai Jiangshan 
260377668c8bSLai Jiangshan 		/*
2604d8ca83e6SLai Jiangshan 		 * Leave this pool.  If need_more_worker() is %true, notify a
26057576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
26067576958aSTejun Heo 		 * and stalling the execution.
26077576958aSTejun Heo 		 */
2608d8ca83e6SLai Jiangshan 		if (need_more_worker(pool))
260963d95a91STejun Heo 			wake_up_worker(pool);
26107576958aSTejun Heo 
2611a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
261213b1d625SLai Jiangshan 
2613a2d812a2STejun Heo 		worker_detach_from_pool(rescuer);
261413b1d625SLai Jiangshan 
2615a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
26161da177e4SLinus Torvalds 	}
26171da177e4SLinus Torvalds 
2618a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&wq_mayday_lock);
2619493a1724STejun Heo 
26204d595b86SLai Jiangshan 	if (should_stop) {
26214d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
2622197f6accSTejun Heo 		set_pf_worker(false);
26234d595b86SLai Jiangshan 		return 0;
26244d595b86SLai Jiangshan 	}
26254d595b86SLai Jiangshan 
2626111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2627111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2628e22bee78STejun Heo 	schedule();
2629e22bee78STejun Heo 	goto repeat;
26301da177e4SLinus Torvalds }
26311da177e4SLinus Torvalds 
2632fca839c0STejun Heo /**
2633fca839c0STejun Heo  * check_flush_dependency - check for flush dependency sanity
2634fca839c0STejun Heo  * @target_wq: workqueue being flushed
2635fca839c0STejun Heo  * @target_work: work item being flushed (NULL for workqueue flushes)
2636fca839c0STejun Heo  *
2637fca839c0STejun Heo  * %current is trying to flush the whole @target_wq or @target_work on it.
2638fca839c0STejun Heo  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2639fca839c0STejun Heo  * reclaiming memory or running on a workqueue which doesn't have
2640fca839c0STejun Heo  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2641fca839c0STejun Heo  * a deadlock.
2642fca839c0STejun Heo  */
2643fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq,
2644fca839c0STejun Heo 				   struct work_struct *target_work)
2645fca839c0STejun Heo {
2646fca839c0STejun Heo 	work_func_t target_func = target_work ? target_work->func : NULL;
2647fca839c0STejun Heo 	struct worker *worker;
2648fca839c0STejun Heo 
2649fca839c0STejun Heo 	if (target_wq->flags & WQ_MEM_RECLAIM)
2650fca839c0STejun Heo 		return;
2651fca839c0STejun Heo 
2652fca839c0STejun Heo 	worker = current_wq_worker();
2653fca839c0STejun Heo 
2654fca839c0STejun Heo 	WARN_ONCE(current->flags & PF_MEMALLOC,
2655d75f773cSSakari Ailus 		  "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
2656fca839c0STejun Heo 		  current->pid, current->comm, target_wq->name, target_func);
265723d11a58STejun Heo 	WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
265823d11a58STejun Heo 			      (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
2659d75f773cSSakari Ailus 		  "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
2660fca839c0STejun Heo 		  worker->current_pwq->wq->name, worker->current_func,
2661fca839c0STejun Heo 		  target_wq->name, target_func);
2662fca839c0STejun Heo }
2663fca839c0STejun Heo 
2664fc2e4d70SOleg Nesterov struct wq_barrier {
2665fc2e4d70SOleg Nesterov 	struct work_struct	work;
2666fc2e4d70SOleg Nesterov 	struct completion	done;
26672607d7a6STejun Heo 	struct task_struct	*task;	/* purely informational */
2668fc2e4d70SOleg Nesterov };
2669fc2e4d70SOleg Nesterov 
2670fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2671fc2e4d70SOleg Nesterov {
2672fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2673fc2e4d70SOleg Nesterov 	complete(&barr->done);
2674fc2e4d70SOleg Nesterov }
2675fc2e4d70SOleg Nesterov 
26764690c4abSTejun Heo /**
26774690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
2678112202d9STejun Heo  * @pwq: pwq to insert barrier into
26794690c4abSTejun Heo  * @barr: wq_barrier to insert
2680affee4b2STejun Heo  * @target: target work to attach @barr to
2681affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
26824690c4abSTejun Heo  *
2683affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2684affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2685affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2686affee4b2STejun Heo  * cpu.
2687affee4b2STejun Heo  *
2688affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2689affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2690affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2691affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2692affee4b2STejun Heo  * after a work with LINKED flag set.
2693affee4b2STejun Heo  *
2694affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2695112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
26964690c4abSTejun Heo  *
26974690c4abSTejun Heo  * CONTEXT:
2698a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
26994690c4abSTejun Heo  */
2700112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
2701affee4b2STejun Heo 			      struct wq_barrier *barr,
2702affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2703fc2e4d70SOleg Nesterov {
2704d812796eSLai Jiangshan 	unsigned int work_flags = 0;
2705d812796eSLai Jiangshan 	unsigned int work_color;
2706affee4b2STejun Heo 	struct list_head *head;
2707affee4b2STejun Heo 
2708dc186ad7SThomas Gleixner 	/*
2709d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
2710dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2711dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2712dc186ad7SThomas Gleixner 	 * might deadlock.
2713dc186ad7SThomas Gleixner 	 */
2714ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
271522df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
271652fa5bc5SBoqun Feng 
2717fd1a5b04SByungchul Park 	init_completion_map(&barr->done, &target->lockdep_map);
2718fd1a5b04SByungchul Park 
27192607d7a6STejun Heo 	barr->task = current;
272083c22520SOleg Nesterov 
2721018f3a13SLai Jiangshan 	/* The barrier work item does not participate in pwq->nr_active. */
2722018f3a13SLai Jiangshan 	work_flags |= WORK_STRUCT_INACTIVE;
2723018f3a13SLai Jiangshan 
2724affee4b2STejun Heo 	/*
2725affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2726affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2727affee4b2STejun Heo 	 */
2728d812796eSLai Jiangshan 	if (worker) {
2729affee4b2STejun Heo 		head = worker->scheduled.next;
2730d812796eSLai Jiangshan 		work_color = worker->current_color;
2731d812796eSLai Jiangshan 	} else {
2732affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2733affee4b2STejun Heo 
2734affee4b2STejun Heo 		head = target->entry.next;
2735affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2736d21cece0SLai Jiangshan 		work_flags |= *bits & WORK_STRUCT_LINKED;
2737d812796eSLai Jiangshan 		work_color = get_work_color(*bits);
2738affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2739affee4b2STejun Heo 	}
2740affee4b2STejun Heo 
2741d812796eSLai Jiangshan 	pwq->nr_in_flight[work_color]++;
2742d812796eSLai Jiangshan 	work_flags |= work_color_to_flags(work_color);
2743d812796eSLai Jiangshan 
2744dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2745d21cece0SLai Jiangshan 	insert_work(pwq, &barr->work, head, work_flags);
2746fc2e4d70SOleg Nesterov }
2747fc2e4d70SOleg Nesterov 
274873f53c4aSTejun Heo /**
2749112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
275073f53c4aSTejun Heo  * @wq: workqueue being flushed
275173f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
275273f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
275373f53c4aSTejun Heo  *
2754112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
275573f53c4aSTejun Heo  *
2756112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
2757112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
2758112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
2759112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
2760112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
276173f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
276273f53c4aSTejun Heo  *
276373f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
276473f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
276573f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
276673f53c4aSTejun Heo  * is returned.
276773f53c4aSTejun Heo  *
2768112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
276973f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
277073f53c4aSTejun Heo  * advanced to @work_color.
277173f53c4aSTejun Heo  *
277273f53c4aSTejun Heo  * CONTEXT:
27733c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
277473f53c4aSTejun Heo  *
2775d185af30SYacine Belkadi  * Return:
277673f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
277773f53c4aSTejun Heo  * otherwise.
277873f53c4aSTejun Heo  */
2779112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
278073f53c4aSTejun Heo 				      int flush_color, int work_color)
27811da177e4SLinus Torvalds {
278273f53c4aSTejun Heo 	bool wait = false;
278349e3cf44STejun Heo 	struct pool_workqueue *pwq;
27841da177e4SLinus Torvalds 
278573f53c4aSTejun Heo 	if (flush_color >= 0) {
27866183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2787112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
2788dc186ad7SThomas Gleixner 	}
278914441960SOleg Nesterov 
279049e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2791112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
27921da177e4SLinus Torvalds 
2793a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
279473f53c4aSTejun Heo 
279573f53c4aSTejun Heo 		if (flush_color >= 0) {
27966183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
279773f53c4aSTejun Heo 
2798112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
2799112202d9STejun Heo 				pwq->flush_color = flush_color;
2800112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
280173f53c4aSTejun Heo 				wait = true;
28021da177e4SLinus Torvalds 			}
280373f53c4aSTejun Heo 		}
280473f53c4aSTejun Heo 
280573f53c4aSTejun Heo 		if (work_color >= 0) {
28066183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2807112202d9STejun Heo 			pwq->work_color = work_color;
280873f53c4aSTejun Heo 		}
280973f53c4aSTejun Heo 
2810a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
28111da177e4SLinus Torvalds 	}
28121da177e4SLinus Torvalds 
2813112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
281473f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
281573f53c4aSTejun Heo 
281673f53c4aSTejun Heo 	return wait;
281783c22520SOleg Nesterov }
28181da177e4SLinus Torvalds 
28190fcb78c2SRolf Eike Beer /**
28201da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
28210fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
28221da177e4SLinus Torvalds  *
2823c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
2824c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
28251da177e4SLinus Torvalds  */
28267ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
28271da177e4SLinus Torvalds {
282873f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
282973f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
283073f53c4aSTejun Heo 		.flush_color = -1,
2831fd1a5b04SByungchul Park 		.done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
283273f53c4aSTejun Heo 	};
283373f53c4aSTejun Heo 	int next_color;
2834b1f4ec17SOleg Nesterov 
28353347fa09STejun Heo 	if (WARN_ON(!wq_online))
28363347fa09STejun Heo 		return;
28373347fa09STejun Heo 
283887915adcSJohannes Berg 	lock_map_acquire(&wq->lockdep_map);
283987915adcSJohannes Berg 	lock_map_release(&wq->lockdep_map);
284087915adcSJohannes Berg 
28413c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
284273f53c4aSTejun Heo 
284373f53c4aSTejun Heo 	/*
284473f53c4aSTejun Heo 	 * Start-to-wait phase
284573f53c4aSTejun Heo 	 */
284673f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
284773f53c4aSTejun Heo 
284873f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
284973f53c4aSTejun Heo 		/*
285073f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
285173f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
285273f53c4aSTejun Heo 		 * by one.
285373f53c4aSTejun Heo 		 */
28546183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
285573f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
285673f53c4aSTejun Heo 		wq->work_color = next_color;
285773f53c4aSTejun Heo 
285873f53c4aSTejun Heo 		if (!wq->first_flusher) {
285973f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
28606183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
286173f53c4aSTejun Heo 
286273f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
286373f53c4aSTejun Heo 
2864112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
286573f53c4aSTejun Heo 						       wq->work_color)) {
286673f53c4aSTejun Heo 				/* nothing to flush, done */
286773f53c4aSTejun Heo 				wq->flush_color = next_color;
286873f53c4aSTejun Heo 				wq->first_flusher = NULL;
286973f53c4aSTejun Heo 				goto out_unlock;
287073f53c4aSTejun Heo 			}
287173f53c4aSTejun Heo 		} else {
287273f53c4aSTejun Heo 			/* wait in queue */
28736183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
287473f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
2875112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
287673f53c4aSTejun Heo 		}
287773f53c4aSTejun Heo 	} else {
287873f53c4aSTejun Heo 		/*
287973f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
288073f53c4aSTejun Heo 		 * The next flush completion will assign us
288173f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
288273f53c4aSTejun Heo 		 */
288373f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
288473f53c4aSTejun Heo 	}
288573f53c4aSTejun Heo 
2886fca839c0STejun Heo 	check_flush_dependency(wq, NULL);
2887fca839c0STejun Heo 
28883c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
288973f53c4aSTejun Heo 
289073f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
289173f53c4aSTejun Heo 
289273f53c4aSTejun Heo 	/*
289373f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
289473f53c4aSTejun Heo 	 *
289573f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
289673f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
289773f53c4aSTejun Heo 	 */
289800d5d15bSChris Wilson 	if (READ_ONCE(wq->first_flusher) != &this_flusher)
289973f53c4aSTejun Heo 		return;
290073f53c4aSTejun Heo 
29013c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
290273f53c4aSTejun Heo 
29034ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
29044ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
29054ce48b37STejun Heo 		goto out_unlock;
29064ce48b37STejun Heo 
290700d5d15bSChris Wilson 	WRITE_ONCE(wq->first_flusher, NULL);
290873f53c4aSTejun Heo 
29096183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
29106183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
291173f53c4aSTejun Heo 
291273f53c4aSTejun Heo 	while (true) {
291373f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
291473f53c4aSTejun Heo 
291573f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
291673f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
291773f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
291873f53c4aSTejun Heo 				break;
291973f53c4aSTejun Heo 			list_del_init(&next->list);
292073f53c4aSTejun Heo 			complete(&next->done);
292173f53c4aSTejun Heo 		}
292273f53c4aSTejun Heo 
29236183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
292473f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
292573f53c4aSTejun Heo 
292673f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
292773f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
292873f53c4aSTejun Heo 
292973f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
293073f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
293173f53c4aSTejun Heo 			/*
293273f53c4aSTejun Heo 			 * Assign the same color to all overflowed
293373f53c4aSTejun Heo 			 * flushers, advance work_color and append to
293473f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
293573f53c4aSTejun Heo 			 * phase for these overflowed flushers.
293673f53c4aSTejun Heo 			 */
293773f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
293873f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
293973f53c4aSTejun Heo 
294073f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
294173f53c4aSTejun Heo 
294273f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
294373f53c4aSTejun Heo 					      &wq->flusher_queue);
2944112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
294573f53c4aSTejun Heo 		}
294673f53c4aSTejun Heo 
294773f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
29486183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
294973f53c4aSTejun Heo 			break;
295073f53c4aSTejun Heo 		}
295173f53c4aSTejun Heo 
295273f53c4aSTejun Heo 		/*
295373f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
2954112202d9STejun Heo 		 * the new first flusher and arm pwqs.
295573f53c4aSTejun Heo 		 */
29566183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
29576183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
295873f53c4aSTejun Heo 
295973f53c4aSTejun Heo 		list_del_init(&next->list);
296073f53c4aSTejun Heo 		wq->first_flusher = next;
296173f53c4aSTejun Heo 
2962112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
296373f53c4aSTejun Heo 			break;
296473f53c4aSTejun Heo 
296573f53c4aSTejun Heo 		/*
296673f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
296773f53c4aSTejun Heo 		 * flusher and repeat cascading.
296873f53c4aSTejun Heo 		 */
296973f53c4aSTejun Heo 		wq->first_flusher = NULL;
297073f53c4aSTejun Heo 	}
297173f53c4aSTejun Heo 
297273f53c4aSTejun Heo out_unlock:
29733c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
29741da177e4SLinus Torvalds }
29751dadafa8STim Gardner EXPORT_SYMBOL(flush_workqueue);
29761da177e4SLinus Torvalds 
29779c5a2ba7STejun Heo /**
29789c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
29799c5a2ba7STejun Heo  * @wq: workqueue to drain
29809c5a2ba7STejun Heo  *
29819c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
29829c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
29839c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
2984b749b1b6SChen Hanxiao  * repeatedly until it becomes empty.  The number of flushing is determined
29859c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
29869c5a2ba7STejun Heo  * takes too long.
29879c5a2ba7STejun Heo  */
29889c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
29899c5a2ba7STejun Heo {
29909c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
299149e3cf44STejun Heo 	struct pool_workqueue *pwq;
29929c5a2ba7STejun Heo 
29939c5a2ba7STejun Heo 	/*
29949c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
29959c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
2996618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
29979c5a2ba7STejun Heo 	 */
299887fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
29999c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
3000618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
300187fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
30029c5a2ba7STejun Heo reflush:
30039c5a2ba7STejun Heo 	flush_workqueue(wq);
30049c5a2ba7STejun Heo 
3005b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
300676af4d93STejun Heo 
300749e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3008fa2563e4SThomas Tuttle 		bool drained;
30099c5a2ba7STejun Heo 
3010a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
3011f97a4a1aSLai Jiangshan 		drained = !pwq->nr_active && list_empty(&pwq->inactive_works);
3012a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
3013fa2563e4SThomas Tuttle 
3014fa2563e4SThomas Tuttle 		if (drained)
30159c5a2ba7STejun Heo 			continue;
30169c5a2ba7STejun Heo 
30179c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
30189c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
3019e9ad2eb3SStephen Zhang 			pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
3020e9ad2eb3SStephen Zhang 				wq->name, __func__, flush_cnt);
302176af4d93STejun Heo 
3022b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
30239c5a2ba7STejun Heo 		goto reflush;
30249c5a2ba7STejun Heo 	}
30259c5a2ba7STejun Heo 
30269c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
3027618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
302887fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
30299c5a2ba7STejun Heo }
30309c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
30319c5a2ba7STejun Heo 
3032d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
3033d6e89786SJohannes Berg 			     bool from_cancel)
3034baf59022STejun Heo {
3035baf59022STejun Heo 	struct worker *worker = NULL;
3036c9e7cf27STejun Heo 	struct worker_pool *pool;
3037112202d9STejun Heo 	struct pool_workqueue *pwq;
3038baf59022STejun Heo 
3039baf59022STejun Heo 	might_sleep();
3040baf59022STejun Heo 
304124acfb71SThomas Gleixner 	rcu_read_lock();
3042fa1b54e6STejun Heo 	pool = get_work_pool(work);
3043fa1b54e6STejun Heo 	if (!pool) {
304424acfb71SThomas Gleixner 		rcu_read_unlock();
3045fa1b54e6STejun Heo 		return false;
3046fa1b54e6STejun Heo 	}
3047fa1b54e6STejun Heo 
3048a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
30490b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
3050112202d9STejun Heo 	pwq = get_work_pwq(work);
3051112202d9STejun Heo 	if (pwq) {
3052112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
3053baf59022STejun Heo 			goto already_gone;
3054606a5020STejun Heo 	} else {
3055c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
3056baf59022STejun Heo 		if (!worker)
3057baf59022STejun Heo 			goto already_gone;
3058112202d9STejun Heo 		pwq = worker->current_pwq;
3059606a5020STejun Heo 	}
3060baf59022STejun Heo 
3061fca839c0STejun Heo 	check_flush_dependency(pwq->wq, work);
3062fca839c0STejun Heo 
3063112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
3064a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
3065baf59022STejun Heo 
3066e159489bSTejun Heo 	/*
3067a1d14934SPeter Zijlstra 	 * Force a lock recursion deadlock when using flush_work() inside a
3068a1d14934SPeter Zijlstra 	 * single-threaded or rescuer equipped workqueue.
3069a1d14934SPeter Zijlstra 	 *
3070a1d14934SPeter Zijlstra 	 * For single threaded workqueues the deadlock happens when the work
3071a1d14934SPeter Zijlstra 	 * is after the work issuing the flush_work(). For rescuer equipped
3072a1d14934SPeter Zijlstra 	 * workqueues the deadlock happens when the rescuer stalls, blocking
3073a1d14934SPeter Zijlstra 	 * forward progress.
3074e159489bSTejun Heo 	 */
3075d6e89786SJohannes Berg 	if (!from_cancel &&
3076d6e89786SJohannes Berg 	    (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
3077112202d9STejun Heo 		lock_map_acquire(&pwq->wq->lockdep_map);
3078112202d9STejun Heo 		lock_map_release(&pwq->wq->lockdep_map);
3079a1d14934SPeter Zijlstra 	}
308024acfb71SThomas Gleixner 	rcu_read_unlock();
3081baf59022STejun Heo 	return true;
3082baf59022STejun Heo already_gone:
3083a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
308424acfb71SThomas Gleixner 	rcu_read_unlock();
3085baf59022STejun Heo 	return false;
3086baf59022STejun Heo }
3087baf59022STejun Heo 
3088d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel)
3089d6e89786SJohannes Berg {
3090d6e89786SJohannes Berg 	struct wq_barrier barr;
3091d6e89786SJohannes Berg 
3092d6e89786SJohannes Berg 	if (WARN_ON(!wq_online))
3093d6e89786SJohannes Berg 		return false;
3094d6e89786SJohannes Berg 
30954d43d395STetsuo Handa 	if (WARN_ON(!work->func))
30964d43d395STetsuo Handa 		return false;
30974d43d395STetsuo Handa 
309887915adcSJohannes Berg 	if (!from_cancel) {
309987915adcSJohannes Berg 		lock_map_acquire(&work->lockdep_map);
310087915adcSJohannes Berg 		lock_map_release(&work->lockdep_map);
310187915adcSJohannes Berg 	}
310287915adcSJohannes Berg 
3103d6e89786SJohannes Berg 	if (start_flush_work(work, &barr, from_cancel)) {
3104d6e89786SJohannes Berg 		wait_for_completion(&barr.done);
3105d6e89786SJohannes Berg 		destroy_work_on_stack(&barr.work);
3106d6e89786SJohannes Berg 		return true;
3107d6e89786SJohannes Berg 	} else {
3108d6e89786SJohannes Berg 		return false;
3109d6e89786SJohannes Berg 	}
3110d6e89786SJohannes Berg }
3111d6e89786SJohannes Berg 
3112db700897SOleg Nesterov /**
3113401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
3114401a8d04STejun Heo  * @work: the work to flush
3115db700897SOleg Nesterov  *
3116606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
3117606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
3118401a8d04STejun Heo  *
3119d185af30SYacine Belkadi  * Return:
3120401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3121401a8d04STejun Heo  * %false if it was already idle.
3122db700897SOleg Nesterov  */
3123401a8d04STejun Heo bool flush_work(struct work_struct *work)
3124db700897SOleg Nesterov {
3125d6e89786SJohannes Berg 	return __flush_work(work, false);
3126606a5020STejun Heo }
3127db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
3128db700897SOleg Nesterov 
31298603e1b3STejun Heo struct cwt_wait {
3130ac6424b9SIngo Molnar 	wait_queue_entry_t		wait;
31318603e1b3STejun Heo 	struct work_struct	*work;
31328603e1b3STejun Heo };
31338603e1b3STejun Heo 
3134ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
31358603e1b3STejun Heo {
31368603e1b3STejun Heo 	struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
31378603e1b3STejun Heo 
31388603e1b3STejun Heo 	if (cwait->work != key)
31398603e1b3STejun Heo 		return 0;
31408603e1b3STejun Heo 	return autoremove_wake_function(wait, mode, sync, key);
31418603e1b3STejun Heo }
31428603e1b3STejun Heo 
314336e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
3144401a8d04STejun Heo {
31458603e1b3STejun Heo 	static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
3146bbb68dfaSTejun Heo 	unsigned long flags;
31471f1f642eSOleg Nesterov 	int ret;
31481f1f642eSOleg Nesterov 
31491f1f642eSOleg Nesterov 	do {
3150bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
3151bbb68dfaSTejun Heo 		/*
31528603e1b3STejun Heo 		 * If someone else is already canceling, wait for it to
31538603e1b3STejun Heo 		 * finish.  flush_work() doesn't work for PREEMPT_NONE
31548603e1b3STejun Heo 		 * because we may get scheduled between @work's completion
31558603e1b3STejun Heo 		 * and the other canceling task resuming and clearing
31568603e1b3STejun Heo 		 * CANCELING - flush_work() will return false immediately
31578603e1b3STejun Heo 		 * as @work is no longer busy, try_to_grab_pending() will
31588603e1b3STejun Heo 		 * return -ENOENT as @work is still being canceled and the
31598603e1b3STejun Heo 		 * other canceling task won't be able to clear CANCELING as
31608603e1b3STejun Heo 		 * we're hogging the CPU.
31618603e1b3STejun Heo 		 *
31628603e1b3STejun Heo 		 * Let's wait for completion using a waitqueue.  As this
31638603e1b3STejun Heo 		 * may lead to the thundering herd problem, use a custom
31648603e1b3STejun Heo 		 * wake function which matches @work along with exclusive
31658603e1b3STejun Heo 		 * wait and wakeup.
3166bbb68dfaSTejun Heo 		 */
31678603e1b3STejun Heo 		if (unlikely(ret == -ENOENT)) {
31688603e1b3STejun Heo 			struct cwt_wait cwait;
31698603e1b3STejun Heo 
31708603e1b3STejun Heo 			init_wait(&cwait.wait);
31718603e1b3STejun Heo 			cwait.wait.func = cwt_wakefn;
31728603e1b3STejun Heo 			cwait.work = work;
31738603e1b3STejun Heo 
31748603e1b3STejun Heo 			prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
31758603e1b3STejun Heo 						  TASK_UNINTERRUPTIBLE);
31768603e1b3STejun Heo 			if (work_is_canceling(work))
31778603e1b3STejun Heo 				schedule();
31788603e1b3STejun Heo 			finish_wait(&cancel_waitq, &cwait.wait);
31798603e1b3STejun Heo 		}
31801f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
31811f1f642eSOleg Nesterov 
3182bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
3183bbb68dfaSTejun Heo 	mark_work_canceling(work);
3184bbb68dfaSTejun Heo 	local_irq_restore(flags);
3185bbb68dfaSTejun Heo 
31863347fa09STejun Heo 	/*
31873347fa09STejun Heo 	 * This allows canceling during early boot.  We know that @work
31883347fa09STejun Heo 	 * isn't executing.
31893347fa09STejun Heo 	 */
31903347fa09STejun Heo 	if (wq_online)
3191d6e89786SJohannes Berg 		__flush_work(work, true);
31923347fa09STejun Heo 
31937a22ad75STejun Heo 	clear_work_data(work);
31948603e1b3STejun Heo 
31958603e1b3STejun Heo 	/*
31968603e1b3STejun Heo 	 * Paired with prepare_to_wait() above so that either
31978603e1b3STejun Heo 	 * waitqueue_active() is visible here or !work_is_canceling() is
31988603e1b3STejun Heo 	 * visible there.
31998603e1b3STejun Heo 	 */
32008603e1b3STejun Heo 	smp_mb();
32018603e1b3STejun Heo 	if (waitqueue_active(&cancel_waitq))
32028603e1b3STejun Heo 		__wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
32038603e1b3STejun Heo 
32041f1f642eSOleg Nesterov 	return ret;
32051f1f642eSOleg Nesterov }
32061f1f642eSOleg Nesterov 
32076e84d644SOleg Nesterov /**
3208401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
3209401a8d04STejun Heo  * @work: the work to cancel
32106e84d644SOleg Nesterov  *
3211401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
3212401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
3213401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
3214401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
32151f1f642eSOleg Nesterov  *
3216401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
3217401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
32186e84d644SOleg Nesterov  *
3219401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
32206e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
3221401a8d04STejun Heo  *
3222d185af30SYacine Belkadi  * Return:
3223401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
32246e84d644SOleg Nesterov  */
3225401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
32266e84d644SOleg Nesterov {
322736e227d2STejun Heo 	return __cancel_work_timer(work, false);
3228b89deed3SOleg Nesterov }
322928e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
3230b89deed3SOleg Nesterov 
32316e84d644SOleg Nesterov /**
3232401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
3233401a8d04STejun Heo  * @dwork: the delayed work to flush
32346e84d644SOleg Nesterov  *
3235401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
3236401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
3237401a8d04STejun Heo  * considers the last queueing instance of @dwork.
32381f1f642eSOleg Nesterov  *
3239d185af30SYacine Belkadi  * Return:
3240401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3241401a8d04STejun Heo  * %false if it was already idle.
32426e84d644SOleg Nesterov  */
3243401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
3244401a8d04STejun Heo {
32458930cabaSTejun Heo 	local_irq_disable();
3246401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
324760c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
32488930cabaSTejun Heo 	local_irq_enable();
3249401a8d04STejun Heo 	return flush_work(&dwork->work);
3250401a8d04STejun Heo }
3251401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
3252401a8d04STejun Heo 
325305f0fe6bSTejun Heo /**
325405f0fe6bSTejun Heo  * flush_rcu_work - wait for a rwork to finish executing the last queueing
325505f0fe6bSTejun Heo  * @rwork: the rcu work to flush
325605f0fe6bSTejun Heo  *
325705f0fe6bSTejun Heo  * Return:
325805f0fe6bSTejun Heo  * %true if flush_rcu_work() waited for the work to finish execution,
325905f0fe6bSTejun Heo  * %false if it was already idle.
326005f0fe6bSTejun Heo  */
326105f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork)
326205f0fe6bSTejun Heo {
326305f0fe6bSTejun Heo 	if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
326405f0fe6bSTejun Heo 		rcu_barrier();
326505f0fe6bSTejun Heo 		flush_work(&rwork->work);
326605f0fe6bSTejun Heo 		return true;
326705f0fe6bSTejun Heo 	} else {
326805f0fe6bSTejun Heo 		return flush_work(&rwork->work);
326905f0fe6bSTejun Heo 	}
327005f0fe6bSTejun Heo }
327105f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work);
327205f0fe6bSTejun Heo 
3273f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork)
3274f72b8792SJens Axboe {
3275f72b8792SJens Axboe 	unsigned long flags;
3276f72b8792SJens Axboe 	int ret;
3277f72b8792SJens Axboe 
3278f72b8792SJens Axboe 	do {
3279f72b8792SJens Axboe 		ret = try_to_grab_pending(work, is_dwork, &flags);
3280f72b8792SJens Axboe 	} while (unlikely(ret == -EAGAIN));
3281f72b8792SJens Axboe 
3282f72b8792SJens Axboe 	if (unlikely(ret < 0))
3283f72b8792SJens Axboe 		return false;
3284f72b8792SJens Axboe 
3285f72b8792SJens Axboe 	set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3286f72b8792SJens Axboe 	local_irq_restore(flags);
3287f72b8792SJens Axboe 	return ret;
3288f72b8792SJens Axboe }
3289f72b8792SJens Axboe 
3290401a8d04STejun Heo /**
329157b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
329257b30ae7STejun Heo  * @dwork: delayed_work to cancel
329309383498STejun Heo  *
3294d185af30SYacine Belkadi  * Kill off a pending delayed_work.
3295d185af30SYacine Belkadi  *
3296d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
3297d185af30SYacine Belkadi  * pending.
3298d185af30SYacine Belkadi  *
3299d185af30SYacine Belkadi  * Note:
3300d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
3301d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
3302d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
330309383498STejun Heo  *
330457b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
330509383498STejun Heo  */
330657b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
330709383498STejun Heo {
3308f72b8792SJens Axboe 	return __cancel_work(&dwork->work, true);
330909383498STejun Heo }
331057b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
331109383498STejun Heo 
331209383498STejun Heo /**
3313401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3314401a8d04STejun Heo  * @dwork: the delayed work cancel
3315401a8d04STejun Heo  *
3316401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
3317401a8d04STejun Heo  *
3318d185af30SYacine Belkadi  * Return:
3319401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
3320401a8d04STejun Heo  */
3321401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
33226e84d644SOleg Nesterov {
332336e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
33246e84d644SOleg Nesterov }
3325f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
33261da177e4SLinus Torvalds 
33270fcb78c2SRolf Eike Beer /**
332831ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3329b6136773SAndrew Morton  * @func: the function to call
3330b6136773SAndrew Morton  *
333131ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
333231ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3333b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
333431ddd871STejun Heo  *
3335d185af30SYacine Belkadi  * Return:
333631ddd871STejun Heo  * 0 on success, -errno on failure.
3337b6136773SAndrew Morton  */
333865f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
333915316ba8SChristoph Lameter {
334015316ba8SChristoph Lameter 	int cpu;
334138f51568SNamhyung Kim 	struct work_struct __percpu *works;
334215316ba8SChristoph Lameter 
3343b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3344b6136773SAndrew Morton 	if (!works)
334515316ba8SChristoph Lameter 		return -ENOMEM;
3346b6136773SAndrew Morton 
3347ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
334893981800STejun Heo 
334915316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
33509bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
33519bfb1839SIngo Molnar 
33529bfb1839SIngo Molnar 		INIT_WORK(work, func);
33538de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
335415316ba8SChristoph Lameter 	}
335593981800STejun Heo 
335693981800STejun Heo 	for_each_online_cpu(cpu)
33578616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
335893981800STejun Heo 
3359ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
3360b6136773SAndrew Morton 	free_percpu(works);
336115316ba8SChristoph Lameter 	return 0;
336215316ba8SChristoph Lameter }
336315316ba8SChristoph Lameter 
3364eef6a7d5SAlan Stern /**
33651fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
33661fa44ecaSJames Bottomley  * @fn:		the function to execute
33671fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
33681fa44ecaSJames Bottomley  *		be available when the work executes)
33691fa44ecaSJames Bottomley  *
33701fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
33711fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
33721fa44ecaSJames Bottomley  *
3373d185af30SYacine Belkadi  * Return:	0 - function was executed
33741fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
33751fa44ecaSJames Bottomley  */
337665f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
33771fa44ecaSJames Bottomley {
33781fa44ecaSJames Bottomley 	if (!in_interrupt()) {
337965f27f38SDavid Howells 		fn(&ew->work);
33801fa44ecaSJames Bottomley 		return 0;
33811fa44ecaSJames Bottomley 	}
33821fa44ecaSJames Bottomley 
338365f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
33841fa44ecaSJames Bottomley 	schedule_work(&ew->work);
33851fa44ecaSJames Bottomley 
33861fa44ecaSJames Bottomley 	return 1;
33871fa44ecaSJames Bottomley }
33881fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
33891fa44ecaSJames Bottomley 
33907a4e344cSTejun Heo /**
33917a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
33927a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
33937a4e344cSTejun Heo  *
33947a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
33957a4e344cSTejun Heo  */
3396513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs)
33977a4e344cSTejun Heo {
33987a4e344cSTejun Heo 	if (attrs) {
33997a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
34007a4e344cSTejun Heo 		kfree(attrs);
34017a4e344cSTejun Heo 	}
34027a4e344cSTejun Heo }
34037a4e344cSTejun Heo 
34047a4e344cSTejun Heo /**
34057a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
34067a4e344cSTejun Heo  *
34077a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
3408d185af30SYacine Belkadi  * return it.
3409d185af30SYacine Belkadi  *
3410d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
34117a4e344cSTejun Heo  */
3412513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void)
34137a4e344cSTejun Heo {
34147a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
34157a4e344cSTejun Heo 
3416be69d00dSThomas Gleixner 	attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
34177a4e344cSTejun Heo 	if (!attrs)
34187a4e344cSTejun Heo 		goto fail;
3419be69d00dSThomas Gleixner 	if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
34207a4e344cSTejun Heo 		goto fail;
34217a4e344cSTejun Heo 
342213e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
34237a4e344cSTejun Heo 	return attrs;
34247a4e344cSTejun Heo fail:
34257a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
34267a4e344cSTejun Heo 	return NULL;
34277a4e344cSTejun Heo }
34287a4e344cSTejun Heo 
342929c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
343029c91e99STejun Heo 				 const struct workqueue_attrs *from)
343129c91e99STejun Heo {
343229c91e99STejun Heo 	to->nice = from->nice;
343329c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
34342865a8fbSShaohua Li 	/*
34352865a8fbSShaohua Li 	 * Unlike hash and equality test, this function doesn't ignore
34362865a8fbSShaohua Li 	 * ->no_numa as it is used for both pool and wq attrs.  Instead,
34372865a8fbSShaohua Li 	 * get_unbound_pool() explicitly clears ->no_numa after copying.
34382865a8fbSShaohua Li 	 */
34392865a8fbSShaohua Li 	to->no_numa = from->no_numa;
344029c91e99STejun Heo }
344129c91e99STejun Heo 
344229c91e99STejun Heo /* hash value of the content of @attr */
344329c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
344429c91e99STejun Heo {
344529c91e99STejun Heo 	u32 hash = 0;
344629c91e99STejun Heo 
344729c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
344813e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
344913e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
345029c91e99STejun Heo 	return hash;
345129c91e99STejun Heo }
345229c91e99STejun Heo 
345329c91e99STejun Heo /* content equality test */
345429c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
345529c91e99STejun Heo 			  const struct workqueue_attrs *b)
345629c91e99STejun Heo {
345729c91e99STejun Heo 	if (a->nice != b->nice)
345829c91e99STejun Heo 		return false;
345929c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
346029c91e99STejun Heo 		return false;
346129c91e99STejun Heo 	return true;
346229c91e99STejun Heo }
346329c91e99STejun Heo 
34647a4e344cSTejun Heo /**
34657a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
34667a4e344cSTejun Heo  * @pool: worker_pool to initialize
34677a4e344cSTejun Heo  *
3468402dd89dSShailendra Verma  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
3469d185af30SYacine Belkadi  *
3470d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
347129c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
347229c91e99STejun Heo  * on @pool safely to release it.
34737a4e344cSTejun Heo  */
34747a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
34754e1a1f9aSTejun Heo {
3476a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_init(&pool->lock);
347729c91e99STejun Heo 	pool->id = -1;
347829c91e99STejun Heo 	pool->cpu = -1;
3479f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
34804e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
348182607adcSTejun Heo 	pool->watchdog_ts = jiffies;
34824e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
34834e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
34844e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
34854e1a1f9aSTejun Heo 
348632a6c723SKees Cook 	timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
34874e1a1f9aSTejun Heo 
348832a6c723SKees Cook 	timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
34894e1a1f9aSTejun Heo 
3490da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
34917a4e344cSTejun Heo 
34927cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
349329c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
349429c91e99STejun Heo 	pool->refcnt = 1;
349529c91e99STejun Heo 
349629c91e99STejun Heo 	/* shouldn't fail above this point */
3497be69d00dSThomas Gleixner 	pool->attrs = alloc_workqueue_attrs();
34987a4e344cSTejun Heo 	if (!pool->attrs)
34997a4e344cSTejun Heo 		return -ENOMEM;
35007a4e344cSTejun Heo 	return 0;
35014e1a1f9aSTejun Heo }
35024e1a1f9aSTejun Heo 
3503669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP
3504669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
3505669de8bdSBart Van Assche {
3506669de8bdSBart Van Assche 	char *lock_name;
3507669de8bdSBart Van Assche 
3508669de8bdSBart Van Assche 	lockdep_register_key(&wq->key);
3509669de8bdSBart Van Assche 	lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3510669de8bdSBart Van Assche 	if (!lock_name)
3511669de8bdSBart Van Assche 		lock_name = wq->name;
351269a106c0SQian Cai 
351369a106c0SQian Cai 	wq->lock_name = lock_name;
3514669de8bdSBart Van Assche 	lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3515669de8bdSBart Van Assche }
3516669de8bdSBart Van Assche 
3517669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
3518669de8bdSBart Van Assche {
3519669de8bdSBart Van Assche 	lockdep_unregister_key(&wq->key);
3520669de8bdSBart Van Assche }
3521669de8bdSBart Van Assche 
3522669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
3523669de8bdSBart Van Assche {
3524669de8bdSBart Van Assche 	if (wq->lock_name != wq->name)
3525669de8bdSBart Van Assche 		kfree(wq->lock_name);
3526669de8bdSBart Van Assche }
3527669de8bdSBart Van Assche #else
3528669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
3529669de8bdSBart Van Assche {
3530669de8bdSBart Van Assche }
3531669de8bdSBart Van Assche 
3532669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
3533669de8bdSBart Van Assche {
3534669de8bdSBart Van Assche }
3535669de8bdSBart Van Assche 
3536669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
3537669de8bdSBart Van Assche {
3538669de8bdSBart Van Assche }
3539669de8bdSBart Van Assche #endif
3540669de8bdSBart Van Assche 
3541e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu)
3542e2dca7adSTejun Heo {
3543e2dca7adSTejun Heo 	struct workqueue_struct *wq =
3544e2dca7adSTejun Heo 		container_of(rcu, struct workqueue_struct, rcu);
3545e2dca7adSTejun Heo 
3546669de8bdSBart Van Assche 	wq_free_lockdep(wq);
3547669de8bdSBart Van Assche 
3548e2dca7adSTejun Heo 	if (!(wq->flags & WQ_UNBOUND))
3549e2dca7adSTejun Heo 		free_percpu(wq->cpu_pwqs);
3550e2dca7adSTejun Heo 	else
3551e2dca7adSTejun Heo 		free_workqueue_attrs(wq->unbound_attrs);
3552e2dca7adSTejun Heo 
3553e2dca7adSTejun Heo 	kfree(wq);
3554e2dca7adSTejun Heo }
3555e2dca7adSTejun Heo 
355629c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
355729c91e99STejun Heo {
355829c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
355929c91e99STejun Heo 
35607cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
356129c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
356229c91e99STejun Heo 	kfree(pool);
356329c91e99STejun Heo }
356429c91e99STejun Heo 
3565d8bb65abSSebastian Andrzej Siewior /* This returns with the lock held on success (pool manager is inactive). */
3566d8bb65abSSebastian Andrzej Siewior static bool wq_manager_inactive(struct worker_pool *pool)
3567d8bb65abSSebastian Andrzej Siewior {
3568a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3569d8bb65abSSebastian Andrzej Siewior 
3570d8bb65abSSebastian Andrzej Siewior 	if (pool->flags & POOL_MANAGER_ACTIVE) {
3571a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
3572d8bb65abSSebastian Andrzej Siewior 		return false;
3573d8bb65abSSebastian Andrzej Siewior 	}
3574d8bb65abSSebastian Andrzej Siewior 	return true;
3575d8bb65abSSebastian Andrzej Siewior }
3576d8bb65abSSebastian Andrzej Siewior 
357729c91e99STejun Heo /**
357829c91e99STejun Heo  * put_unbound_pool - put a worker_pool
357929c91e99STejun Heo  * @pool: worker_pool to put
358029c91e99STejun Heo  *
358124acfb71SThomas Gleixner  * Put @pool.  If its refcnt reaches zero, it gets destroyed in RCU
3582c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
3583c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
3584c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
3585a892caccSTejun Heo  *
3586a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
358729c91e99STejun Heo  */
358829c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
358929c91e99STejun Heo {
359060f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
359129c91e99STejun Heo 	struct worker *worker;
359229c91e99STejun Heo 
3593a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3594a892caccSTejun Heo 
3595a892caccSTejun Heo 	if (--pool->refcnt)
359629c91e99STejun Heo 		return;
359729c91e99STejun Heo 
359829c91e99STejun Heo 	/* sanity checks */
359961d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
3600a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
360129c91e99STejun Heo 		return;
360229c91e99STejun Heo 
360329c91e99STejun Heo 	/* release id and unhash */
360429c91e99STejun Heo 	if (pool->id >= 0)
360529c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
360629c91e99STejun Heo 	hash_del(&pool->hash_node);
360729c91e99STejun Heo 
3608c5aa87bbSTejun Heo 	/*
3609692b4825STejun Heo 	 * Become the manager and destroy all workers.  This prevents
3610692b4825STejun Heo 	 * @pool's workers from blocking on attach_mutex.  We're the last
3611692b4825STejun Heo 	 * manager and @pool gets freed with the flag set.
3612d8bb65abSSebastian Andrzej Siewior 	 * Because of how wq_manager_inactive() works, we will hold the
3613d8bb65abSSebastian Andrzej Siewior 	 * spinlock after a successful wait.
3614c5aa87bbSTejun Heo 	 */
3615d8bb65abSSebastian Andrzej Siewior 	rcuwait_wait_event(&manager_wait, wq_manager_inactive(pool),
3616d8bb65abSSebastian Andrzej Siewior 			   TASK_UNINTERRUPTIBLE);
3617692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
3618692b4825STejun Heo 
36191037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
362029c91e99STejun Heo 		destroy_worker(worker);
362129c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
3622a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
362360f5a4bcSLai Jiangshan 
36241258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
3625da028469SLai Jiangshan 	if (!list_empty(&pool->workers))
362660f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
36271258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
362860f5a4bcSLai Jiangshan 
362960f5a4bcSLai Jiangshan 	if (pool->detach_completion)
363060f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
363160f5a4bcSLai Jiangshan 
363229c91e99STejun Heo 	/* shut down the timers */
363329c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
363429c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
363529c91e99STejun Heo 
363624acfb71SThomas Gleixner 	/* RCU protected to allow dereferences from get_work_pool() */
363725b00775SPaul E. McKenney 	call_rcu(&pool->rcu, rcu_free_pool);
363829c91e99STejun Heo }
363929c91e99STejun Heo 
364029c91e99STejun Heo /**
364129c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
364229c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
364329c91e99STejun Heo  *
364429c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
364529c91e99STejun Heo  * reference count and return it.  If there already is a matching
364629c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
3647d185af30SYacine Belkadi  * create a new one.
3648a892caccSTejun Heo  *
3649a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
3650d185af30SYacine Belkadi  *
3651d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
3652d185af30SYacine Belkadi  * On failure, %NULL.
365329c91e99STejun Heo  */
365429c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
365529c91e99STejun Heo {
365629c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
365729c91e99STejun Heo 	struct worker_pool *pool;
3658f3f90ad4STejun Heo 	int node;
3659e2273584SXunlei Pang 	int target_node = NUMA_NO_NODE;
366029c91e99STejun Heo 
3661a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
366229c91e99STejun Heo 
366329c91e99STejun Heo 	/* do we already have a matching pool? */
366429c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
366529c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
366629c91e99STejun Heo 			pool->refcnt++;
36673fb1823cSLai Jiangshan 			return pool;
366829c91e99STejun Heo 		}
366929c91e99STejun Heo 	}
367029c91e99STejun Heo 
3671e2273584SXunlei Pang 	/* if cpumask is contained inside a NUMA node, we belong to that node */
3672e2273584SXunlei Pang 	if (wq_numa_enabled) {
3673e2273584SXunlei Pang 		for_each_node(node) {
3674e2273584SXunlei Pang 			if (cpumask_subset(attrs->cpumask,
3675e2273584SXunlei Pang 					   wq_numa_possible_cpumask[node])) {
3676e2273584SXunlei Pang 				target_node = node;
3677e2273584SXunlei Pang 				break;
3678e2273584SXunlei Pang 			}
3679e2273584SXunlei Pang 		}
3680e2273584SXunlei Pang 	}
3681e2273584SXunlei Pang 
368229c91e99STejun Heo 	/* nope, create a new one */
3683e2273584SXunlei Pang 	pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
368429c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
368529c91e99STejun Heo 		goto fail;
368629c91e99STejun Heo 
36878864b4e5STejun Heo 	lockdep_set_subclass(&pool->lock, 1);	/* see put_pwq() */
368829c91e99STejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
3689e2273584SXunlei Pang 	pool->node = target_node;
369029c91e99STejun Heo 
36912865a8fbSShaohua Li 	/*
36922865a8fbSShaohua Li 	 * no_numa isn't a worker_pool attribute, always clear it.  See
36932865a8fbSShaohua Li 	 * 'struct workqueue_attrs' comments for detail.
36942865a8fbSShaohua Li 	 */
36952865a8fbSShaohua Li 	pool->attrs->no_numa = false;
36962865a8fbSShaohua Li 
369729c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
369829c91e99STejun Heo 		goto fail;
369929c91e99STejun Heo 
370029c91e99STejun Heo 	/* create and start the initial worker */
37013347fa09STejun Heo 	if (wq_online && !create_worker(pool))
370229c91e99STejun Heo 		goto fail;
370329c91e99STejun Heo 
370429c91e99STejun Heo 	/* install */
370529c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
37063fb1823cSLai Jiangshan 
370729c91e99STejun Heo 	return pool;
370829c91e99STejun Heo fail:
370929c91e99STejun Heo 	if (pool)
371029c91e99STejun Heo 		put_unbound_pool(pool);
371129c91e99STejun Heo 	return NULL;
371229c91e99STejun Heo }
371329c91e99STejun Heo 
37148864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
37158864b4e5STejun Heo {
37168864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
37178864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
37188864b4e5STejun Heo }
37198864b4e5STejun Heo 
37208864b4e5STejun Heo /*
37218864b4e5STejun Heo  * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
37228864b4e5STejun Heo  * and needs to be destroyed.
37238864b4e5STejun Heo  */
37248864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work)
37258864b4e5STejun Heo {
37268864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
37278864b4e5STejun Heo 						  unbound_release_work);
37288864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
37298864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
3730b42b0bddSYang Yingliang 	bool is_last = false;
37318864b4e5STejun Heo 
3732b42b0bddSYang Yingliang 	/*
3733b42b0bddSYang Yingliang 	 * when @pwq is not linked, it doesn't hold any reference to the
3734b42b0bddSYang Yingliang 	 * @wq, and @wq is invalid to access.
3735b42b0bddSYang Yingliang 	 */
3736b42b0bddSYang Yingliang 	if (!list_empty(&pwq->pwqs_node)) {
37378864b4e5STejun Heo 		if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
37388864b4e5STejun Heo 			return;
37398864b4e5STejun Heo 
37403c25a55dSLai Jiangshan 		mutex_lock(&wq->mutex);
37418864b4e5STejun Heo 		list_del_rcu(&pwq->pwqs_node);
3742bc0caf09STejun Heo 		is_last = list_empty(&wq->pwqs);
37433c25a55dSLai Jiangshan 		mutex_unlock(&wq->mutex);
3744b42b0bddSYang Yingliang 	}
37458864b4e5STejun Heo 
3746a892caccSTejun Heo 	mutex_lock(&wq_pool_mutex);
37478864b4e5STejun Heo 	put_unbound_pool(pool);
3748a892caccSTejun Heo 	mutex_unlock(&wq_pool_mutex);
3749a892caccSTejun Heo 
375025b00775SPaul E. McKenney 	call_rcu(&pwq->rcu, rcu_free_pwq);
37518864b4e5STejun Heo 
37528864b4e5STejun Heo 	/*
37538864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
3754e2dca7adSTejun Heo 	 * is gonna access it anymore.  Schedule RCU free.
37558864b4e5STejun Heo 	 */
3756669de8bdSBart Van Assche 	if (is_last) {
3757669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
375825b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
37596029a918STejun Heo 	}
3760669de8bdSBart Van Assche }
37618864b4e5STejun Heo 
37620fbd95aaSTejun Heo /**
3763699ce097STejun Heo  * pwq_adjust_max_active - update a pwq's max_active to the current setting
37640fbd95aaSTejun Heo  * @pwq: target pool_workqueue
37650fbd95aaSTejun Heo  *
3766699ce097STejun Heo  * If @pwq isn't freezing, set @pwq->max_active to the associated
3767f97a4a1aSLai Jiangshan  * workqueue's saved_max_active and activate inactive work items
3768699ce097STejun Heo  * accordingly.  If @pwq is freezing, clear @pwq->max_active to zero.
37690fbd95aaSTejun Heo  */
3770699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq)
37710fbd95aaSTejun Heo {
3772699ce097STejun Heo 	struct workqueue_struct *wq = pwq->wq;
3773699ce097STejun Heo 	bool freezable = wq->flags & WQ_FREEZABLE;
37743347fa09STejun Heo 	unsigned long flags;
3775699ce097STejun Heo 
3776699ce097STejun Heo 	/* for @wq->saved_max_active */
3777a357fc03SLai Jiangshan 	lockdep_assert_held(&wq->mutex);
3778699ce097STejun Heo 
3779699ce097STejun Heo 	/* fast exit for non-freezable wqs */
3780699ce097STejun Heo 	if (!freezable && pwq->max_active == wq->saved_max_active)
3781699ce097STejun Heo 		return;
3782699ce097STejun Heo 
37833347fa09STejun Heo 	/* this function can be called during early boot w/ irq disabled */
3784a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irqsave(&pwq->pool->lock, flags);
3785699ce097STejun Heo 
378674b414eaSLai Jiangshan 	/*
378774b414eaSLai Jiangshan 	 * During [un]freezing, the caller is responsible for ensuring that
378874b414eaSLai Jiangshan 	 * this function is called at least once after @workqueue_freezing
378974b414eaSLai Jiangshan 	 * is updated and visible.
379074b414eaSLai Jiangshan 	 */
379174b414eaSLai Jiangshan 	if (!freezable || !workqueue_freezing) {
379201341fbdSYunfeng Ye 		bool kick = false;
379301341fbdSYunfeng Ye 
3794699ce097STejun Heo 		pwq->max_active = wq->saved_max_active;
37950fbd95aaSTejun Heo 
3796f97a4a1aSLai Jiangshan 		while (!list_empty(&pwq->inactive_works) &&
379701341fbdSYunfeng Ye 		       pwq->nr_active < pwq->max_active) {
3798f97a4a1aSLai Jiangshan 			pwq_activate_first_inactive(pwq);
379901341fbdSYunfeng Ye 			kick = true;
380001341fbdSYunfeng Ye 		}
3801951a078aSLai Jiangshan 
3802951a078aSLai Jiangshan 		/*
3803951a078aSLai Jiangshan 		 * Need to kick a worker after thawed or an unbound wq's
380401341fbdSYunfeng Ye 		 * max_active is bumped. In realtime scenarios, always kicking a
380501341fbdSYunfeng Ye 		 * worker will cause interference on the isolated cpu cores, so
380601341fbdSYunfeng Ye 		 * let's kick iff work items were activated.
3807951a078aSLai Jiangshan 		 */
380801341fbdSYunfeng Ye 		if (kick)
3809951a078aSLai Jiangshan 			wake_up_worker(pwq->pool);
3810699ce097STejun Heo 	} else {
3811699ce097STejun Heo 		pwq->max_active = 0;
3812699ce097STejun Heo 	}
3813699ce097STejun Heo 
3814a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
38150fbd95aaSTejun Heo }
38160fbd95aaSTejun Heo 
381767dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */
3818f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3819f147f29eSTejun Heo 		     struct worker_pool *pool)
3820d2c1d404STejun Heo {
3821d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3822d2c1d404STejun Heo 
3823e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
3824e50aba9aSTejun Heo 
3825d2c1d404STejun Heo 	pwq->pool = pool;
3826d2c1d404STejun Heo 	pwq->wq = wq;
3827d2c1d404STejun Heo 	pwq->flush_color = -1;
38288864b4e5STejun Heo 	pwq->refcnt = 1;
3829f97a4a1aSLai Jiangshan 	INIT_LIST_HEAD(&pwq->inactive_works);
38301befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
3831d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
38328864b4e5STejun Heo 	INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3833f147f29eSTejun Heo }
3834d2c1d404STejun Heo 
3835f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
38361befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
3837f147f29eSTejun Heo {
3838f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
3839f147f29eSTejun Heo 
3840f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
384175ccf595STejun Heo 
38421befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
38431befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
38441befcf30STejun Heo 		return;
38451befcf30STejun Heo 
384629b1cb41SLai Jiangshan 	/* set the matching work_color */
384775ccf595STejun Heo 	pwq->work_color = wq->work_color;
3848983ca25eSTejun Heo 
3849983ca25eSTejun Heo 	/* sync max_active to the current setting */
3850983ca25eSTejun Heo 	pwq_adjust_max_active(pwq);
3851983ca25eSTejun Heo 
3852983ca25eSTejun Heo 	/* link in @pwq */
38539e8cd2f5STejun Heo 	list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3854df2d5ae4STejun Heo }
38556029a918STejun Heo 
3856f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3857f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3858f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
3859f147f29eSTejun Heo {
3860f147f29eSTejun Heo 	struct worker_pool *pool;
3861f147f29eSTejun Heo 	struct pool_workqueue *pwq;
3862f147f29eSTejun Heo 
3863f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3864f147f29eSTejun Heo 
3865f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
3866f147f29eSTejun Heo 	if (!pool)
3867f147f29eSTejun Heo 		return NULL;
3868f147f29eSTejun Heo 
3869e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3870f147f29eSTejun Heo 	if (!pwq) {
3871f147f29eSTejun Heo 		put_unbound_pool(pool);
3872f147f29eSTejun Heo 		return NULL;
3873f147f29eSTejun Heo 	}
3874f147f29eSTejun Heo 
3875f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
3876f147f29eSTejun Heo 	return pwq;
3877d2c1d404STejun Heo }
3878d2c1d404STejun Heo 
38794c16bd32STejun Heo /**
388030186c6fSGong Zhaogang  * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
3881042f7df1SLai Jiangshan  * @attrs: the wq_attrs of the default pwq of the target workqueue
38824c16bd32STejun Heo  * @node: the target NUMA node
38834c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
38844c16bd32STejun Heo  * @cpumask: outarg, the resulting cpumask
38854c16bd32STejun Heo  *
38864c16bd32STejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @node.  If
38874c16bd32STejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during
3888d185af30SYacine Belkadi  * calculation.  The result is stored in @cpumask.
38894c16bd32STejun Heo  *
38904c16bd32STejun Heo  * If NUMA affinity is not enabled, @attrs->cpumask is always used.  If
38914c16bd32STejun Heo  * enabled and @node has online CPUs requested by @attrs, the returned
38924c16bd32STejun Heo  * cpumask is the intersection of the possible CPUs of @node and
38934c16bd32STejun Heo  * @attrs->cpumask.
38944c16bd32STejun Heo  *
38954c16bd32STejun Heo  * The caller is responsible for ensuring that the cpumask of @node stays
38964c16bd32STejun Heo  * stable.
3897d185af30SYacine Belkadi  *
3898d185af30SYacine Belkadi  * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3899d185af30SYacine Belkadi  * %false if equal.
39004c16bd32STejun Heo  */
39014c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
39024c16bd32STejun Heo 				 int cpu_going_down, cpumask_t *cpumask)
39034c16bd32STejun Heo {
3904d55262c4STejun Heo 	if (!wq_numa_enabled || attrs->no_numa)
39054c16bd32STejun Heo 		goto use_dfl;
39064c16bd32STejun Heo 
39074c16bd32STejun Heo 	/* does @node have any online CPUs @attrs wants? */
39084c16bd32STejun Heo 	cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
39094c16bd32STejun Heo 	if (cpu_going_down >= 0)
39104c16bd32STejun Heo 		cpumask_clear_cpu(cpu_going_down, cpumask);
39114c16bd32STejun Heo 
39124c16bd32STejun Heo 	if (cpumask_empty(cpumask))
39134c16bd32STejun Heo 		goto use_dfl;
39144c16bd32STejun Heo 
39154c16bd32STejun Heo 	/* yeap, return possible CPUs in @node that @attrs wants */
39164c16bd32STejun Heo 	cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
39171ad0f0a7SMichael Bringmann 
39181ad0f0a7SMichael Bringmann 	if (cpumask_empty(cpumask)) {
39191ad0f0a7SMichael Bringmann 		pr_warn_once("WARNING: workqueue cpumask: online intersect > "
39201ad0f0a7SMichael Bringmann 				"possible intersect\n");
39211ad0f0a7SMichael Bringmann 		return false;
39221ad0f0a7SMichael Bringmann 	}
39231ad0f0a7SMichael Bringmann 
39244c16bd32STejun Heo 	return !cpumask_equal(cpumask, attrs->cpumask);
39254c16bd32STejun Heo 
39264c16bd32STejun Heo use_dfl:
39274c16bd32STejun Heo 	cpumask_copy(cpumask, attrs->cpumask);
39284c16bd32STejun Heo 	return false;
39294c16bd32STejun Heo }
39304c16bd32STejun Heo 
39311befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
39321befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
39331befcf30STejun Heo 						   int node,
39341befcf30STejun Heo 						   struct pool_workqueue *pwq)
39351befcf30STejun Heo {
39361befcf30STejun Heo 	struct pool_workqueue *old_pwq;
39371befcf30STejun Heo 
39385b95e1afSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
39391befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
39401befcf30STejun Heo 
39411befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
39421befcf30STejun Heo 	link_pwq(pwq);
39431befcf30STejun Heo 
39441befcf30STejun Heo 	old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
39451befcf30STejun Heo 	rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
39461befcf30STejun Heo 	return old_pwq;
39471befcf30STejun Heo }
39481befcf30STejun Heo 
39492d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */
39502d5f0764SLai Jiangshan struct apply_wqattrs_ctx {
39512d5f0764SLai Jiangshan 	struct workqueue_struct	*wq;		/* target workqueue */
39522d5f0764SLai Jiangshan 	struct workqueue_attrs	*attrs;		/* attrs to apply */
3953042f7df1SLai Jiangshan 	struct list_head	list;		/* queued for batching commit */
39542d5f0764SLai Jiangshan 	struct pool_workqueue	*dfl_pwq;
39552d5f0764SLai Jiangshan 	struct pool_workqueue	*pwq_tbl[];
39562d5f0764SLai Jiangshan };
39572d5f0764SLai Jiangshan 
39582d5f0764SLai Jiangshan /* free the resources after success or abort */
39592d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
39602d5f0764SLai Jiangshan {
39612d5f0764SLai Jiangshan 	if (ctx) {
39622d5f0764SLai Jiangshan 		int node;
39632d5f0764SLai Jiangshan 
39642d5f0764SLai Jiangshan 		for_each_node(node)
39652d5f0764SLai Jiangshan 			put_pwq_unlocked(ctx->pwq_tbl[node]);
39662d5f0764SLai Jiangshan 		put_pwq_unlocked(ctx->dfl_pwq);
39672d5f0764SLai Jiangshan 
39682d5f0764SLai Jiangshan 		free_workqueue_attrs(ctx->attrs);
39692d5f0764SLai Jiangshan 
39702d5f0764SLai Jiangshan 		kfree(ctx);
39712d5f0764SLai Jiangshan 	}
39722d5f0764SLai Jiangshan }
39732d5f0764SLai Jiangshan 
39742d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */
39752d5f0764SLai Jiangshan static struct apply_wqattrs_ctx *
39762d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq,
39772d5f0764SLai Jiangshan 		      const struct workqueue_attrs *attrs)
39782d5f0764SLai Jiangshan {
39792d5f0764SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
39802d5f0764SLai Jiangshan 	struct workqueue_attrs *new_attrs, *tmp_attrs;
39812d5f0764SLai Jiangshan 	int node;
39822d5f0764SLai Jiangshan 
39832d5f0764SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
39842d5f0764SLai Jiangshan 
3985acafe7e3SKees Cook 	ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
39862d5f0764SLai Jiangshan 
3987be69d00dSThomas Gleixner 	new_attrs = alloc_workqueue_attrs();
3988be69d00dSThomas Gleixner 	tmp_attrs = alloc_workqueue_attrs();
39892d5f0764SLai Jiangshan 	if (!ctx || !new_attrs || !tmp_attrs)
39902d5f0764SLai Jiangshan 		goto out_free;
39912d5f0764SLai Jiangshan 
3992042f7df1SLai Jiangshan 	/*
3993042f7df1SLai Jiangshan 	 * Calculate the attrs of the default pwq.
3994042f7df1SLai Jiangshan 	 * If the user configured cpumask doesn't overlap with the
3995042f7df1SLai Jiangshan 	 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3996042f7df1SLai Jiangshan 	 */
39972d5f0764SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
3998b05a7928SFrederic Weisbecker 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
3999042f7df1SLai Jiangshan 	if (unlikely(cpumask_empty(new_attrs->cpumask)))
4000042f7df1SLai Jiangshan 		cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
40012d5f0764SLai Jiangshan 
40022d5f0764SLai Jiangshan 	/*
40032d5f0764SLai Jiangshan 	 * We may create multiple pwqs with differing cpumasks.  Make a
40042d5f0764SLai Jiangshan 	 * copy of @new_attrs which will be modified and used to obtain
40052d5f0764SLai Jiangshan 	 * pools.
40062d5f0764SLai Jiangshan 	 */
40072d5f0764SLai Jiangshan 	copy_workqueue_attrs(tmp_attrs, new_attrs);
40082d5f0764SLai Jiangshan 
40092d5f0764SLai Jiangshan 	/*
40102d5f0764SLai Jiangshan 	 * If something goes wrong during CPU up/down, we'll fall back to
40112d5f0764SLai Jiangshan 	 * the default pwq covering whole @attrs->cpumask.  Always create
40122d5f0764SLai Jiangshan 	 * it even if we don't use it immediately.
40132d5f0764SLai Jiangshan 	 */
40142d5f0764SLai Jiangshan 	ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
40152d5f0764SLai Jiangshan 	if (!ctx->dfl_pwq)
40162d5f0764SLai Jiangshan 		goto out_free;
40172d5f0764SLai Jiangshan 
40182d5f0764SLai Jiangshan 	for_each_node(node) {
4019042f7df1SLai Jiangshan 		if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
40202d5f0764SLai Jiangshan 			ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
40212d5f0764SLai Jiangshan 			if (!ctx->pwq_tbl[node])
40222d5f0764SLai Jiangshan 				goto out_free;
40232d5f0764SLai Jiangshan 		} else {
40242d5f0764SLai Jiangshan 			ctx->dfl_pwq->refcnt++;
40252d5f0764SLai Jiangshan 			ctx->pwq_tbl[node] = ctx->dfl_pwq;
40262d5f0764SLai Jiangshan 		}
40272d5f0764SLai Jiangshan 	}
40282d5f0764SLai Jiangshan 
4029042f7df1SLai Jiangshan 	/* save the user configured attrs and sanitize it. */
4030042f7df1SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
4031042f7df1SLai Jiangshan 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
40322d5f0764SLai Jiangshan 	ctx->attrs = new_attrs;
4033042f7df1SLai Jiangshan 
40342d5f0764SLai Jiangshan 	ctx->wq = wq;
40352d5f0764SLai Jiangshan 	free_workqueue_attrs(tmp_attrs);
40362d5f0764SLai Jiangshan 	return ctx;
40372d5f0764SLai Jiangshan 
40382d5f0764SLai Jiangshan out_free:
40392d5f0764SLai Jiangshan 	free_workqueue_attrs(tmp_attrs);
40402d5f0764SLai Jiangshan 	free_workqueue_attrs(new_attrs);
40412d5f0764SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
40422d5f0764SLai Jiangshan 	return NULL;
40432d5f0764SLai Jiangshan }
40442d5f0764SLai Jiangshan 
40452d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
40462d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
40472d5f0764SLai Jiangshan {
40482d5f0764SLai Jiangshan 	int node;
40492d5f0764SLai Jiangshan 
40502d5f0764SLai Jiangshan 	/* all pwqs have been created successfully, let's install'em */
40512d5f0764SLai Jiangshan 	mutex_lock(&ctx->wq->mutex);
40522d5f0764SLai Jiangshan 
40532d5f0764SLai Jiangshan 	copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
40542d5f0764SLai Jiangshan 
40552d5f0764SLai Jiangshan 	/* save the previous pwq and install the new one */
40562d5f0764SLai Jiangshan 	for_each_node(node)
40572d5f0764SLai Jiangshan 		ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
40582d5f0764SLai Jiangshan 							  ctx->pwq_tbl[node]);
40592d5f0764SLai Jiangshan 
40602d5f0764SLai Jiangshan 	/* @dfl_pwq might not have been used, ensure it's linked */
40612d5f0764SLai Jiangshan 	link_pwq(ctx->dfl_pwq);
40622d5f0764SLai Jiangshan 	swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
40632d5f0764SLai Jiangshan 
40642d5f0764SLai Jiangshan 	mutex_unlock(&ctx->wq->mutex);
40652d5f0764SLai Jiangshan }
40662d5f0764SLai Jiangshan 
4067a0111cf6SLai Jiangshan static void apply_wqattrs_lock(void)
4068a0111cf6SLai Jiangshan {
4069a0111cf6SLai Jiangshan 	/* CPUs should stay stable across pwq creations and installations */
4070ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
4071a0111cf6SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4072a0111cf6SLai Jiangshan }
4073a0111cf6SLai Jiangshan 
4074a0111cf6SLai Jiangshan static void apply_wqattrs_unlock(void)
4075a0111cf6SLai Jiangshan {
4076a0111cf6SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4077ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
4078a0111cf6SLai Jiangshan }
4079a0111cf6SLai Jiangshan 
4080a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4081a0111cf6SLai Jiangshan 					const struct workqueue_attrs *attrs)
4082a0111cf6SLai Jiangshan {
4083a0111cf6SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
4084a0111cf6SLai Jiangshan 
4085a0111cf6SLai Jiangshan 	/* only unbound workqueues can change attributes */
4086a0111cf6SLai Jiangshan 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4087a0111cf6SLai Jiangshan 		return -EINVAL;
4088a0111cf6SLai Jiangshan 
4089a0111cf6SLai Jiangshan 	/* creating multiple pwqs breaks ordering guarantee */
40900a94efb5STejun Heo 	if (!list_empty(&wq->pwqs)) {
40910a94efb5STejun Heo 		if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4092a0111cf6SLai Jiangshan 			return -EINVAL;
4093a0111cf6SLai Jiangshan 
40940a94efb5STejun Heo 		wq->flags &= ~__WQ_ORDERED;
40950a94efb5STejun Heo 	}
40960a94efb5STejun Heo 
4097a0111cf6SLai Jiangshan 	ctx = apply_wqattrs_prepare(wq, attrs);
40986201171eSwanghaibin 	if (!ctx)
40996201171eSwanghaibin 		return -ENOMEM;
4100a0111cf6SLai Jiangshan 
4101a0111cf6SLai Jiangshan 	/* the ctx has been prepared successfully, let's commit it */
4102a0111cf6SLai Jiangshan 	apply_wqattrs_commit(ctx);
4103a0111cf6SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
4104a0111cf6SLai Jiangshan 
41056201171eSwanghaibin 	return 0;
4106a0111cf6SLai Jiangshan }
4107a0111cf6SLai Jiangshan 
41089e8cd2f5STejun Heo /**
41099e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
41109e8cd2f5STejun Heo  * @wq: the target workqueue
41119e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
41129e8cd2f5STejun Heo  *
41134c16bd32STejun Heo  * Apply @attrs to an unbound workqueue @wq.  Unless disabled, on NUMA
41144c16bd32STejun Heo  * machines, this function maps a separate pwq to each NUMA node with
41154c16bd32STejun Heo  * possibles CPUs in @attrs->cpumask so that work items are affine to the
41164c16bd32STejun Heo  * NUMA node it was issued on.  Older pwqs are released as in-flight work
41174c16bd32STejun Heo  * items finish.  Note that a work item which repeatedly requeues itself
41184c16bd32STejun Heo  * back-to-back will stay on its current pwq.
41199e8cd2f5STejun Heo  *
4120d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
4121d185af30SYacine Belkadi  *
4122ffd8bea8SSebastian Andrzej Siewior  * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock().
4123509b3204SDaniel Jordan  *
4124d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
41259e8cd2f5STejun Heo  */
4126513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq,
41279e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
41289e8cd2f5STejun Heo {
4129a0111cf6SLai Jiangshan 	int ret;
41309e8cd2f5STejun Heo 
4131509b3204SDaniel Jordan 	lockdep_assert_cpus_held();
4132509b3204SDaniel Jordan 
4133509b3204SDaniel Jordan 	mutex_lock(&wq_pool_mutex);
4134a0111cf6SLai Jiangshan 	ret = apply_workqueue_attrs_locked(wq, attrs);
4135509b3204SDaniel Jordan 	mutex_unlock(&wq_pool_mutex);
41362d5f0764SLai Jiangshan 
41372d5f0764SLai Jiangshan 	return ret;
41389e8cd2f5STejun Heo }
41399e8cd2f5STejun Heo 
41404c16bd32STejun Heo /**
41414c16bd32STejun Heo  * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
41424c16bd32STejun Heo  * @wq: the target workqueue
41434c16bd32STejun Heo  * @cpu: the CPU coming up or going down
41444c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
41454c16bd32STejun Heo  *
41464c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
41474c16bd32STejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update NUMA affinity of
41484c16bd32STejun Heo  * @wq accordingly.
41494c16bd32STejun Heo  *
41504c16bd32STejun Heo  * If NUMA affinity can't be adjusted due to memory allocation failure, it
41514c16bd32STejun Heo  * falls back to @wq->dfl_pwq which may not be optimal but is always
41524c16bd32STejun Heo  * correct.
41534c16bd32STejun Heo  *
41544c16bd32STejun Heo  * Note that when the last allowed CPU of a NUMA node goes offline for a
41554c16bd32STejun Heo  * workqueue with a cpumask spanning multiple nodes, the workers which were
41564c16bd32STejun Heo  * already executing the work items for the workqueue will lose their CPU
41574c16bd32STejun Heo  * affinity and may execute on any CPU.  This is similar to how per-cpu
41584c16bd32STejun Heo  * workqueues behave on CPU_DOWN.  If a workqueue user wants strict
41594c16bd32STejun Heo  * affinity, it's the user's responsibility to flush the work item from
41604c16bd32STejun Heo  * CPU_DOWN_PREPARE.
41614c16bd32STejun Heo  */
41624c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
41634c16bd32STejun Heo 				   bool online)
41644c16bd32STejun Heo {
41654c16bd32STejun Heo 	int node = cpu_to_node(cpu);
41664c16bd32STejun Heo 	int cpu_off = online ? -1 : cpu;
41674c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
41684c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
41694c16bd32STejun Heo 	cpumask_t *cpumask;
41704c16bd32STejun Heo 
41714c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
41724c16bd32STejun Heo 
4173f7142ed4SLai Jiangshan 	if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4174f7142ed4SLai Jiangshan 	    wq->unbound_attrs->no_numa)
41754c16bd32STejun Heo 		return;
41764c16bd32STejun Heo 
41774c16bd32STejun Heo 	/*
41784c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
41794c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
41804c16bd32STejun Heo 	 * CPU hotplug exclusion.
41814c16bd32STejun Heo 	 */
41824c16bd32STejun Heo 	target_attrs = wq_update_unbound_numa_attrs_buf;
41834c16bd32STejun Heo 	cpumask = target_attrs->cpumask;
41844c16bd32STejun Heo 
41854c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
41864c16bd32STejun Heo 	pwq = unbound_pwq_by_node(wq, node);
41874c16bd32STejun Heo 
41884c16bd32STejun Heo 	/*
41894c16bd32STejun Heo 	 * Let's determine what needs to be done.  If the target cpumask is
4190042f7df1SLai Jiangshan 	 * different from the default pwq's, we need to compare it to @pwq's
4191042f7df1SLai Jiangshan 	 * and create a new one if they don't match.  If the target cpumask
4192042f7df1SLai Jiangshan 	 * equals the default pwq's, the default pwq should be used.
41934c16bd32STejun Heo 	 */
4194042f7df1SLai Jiangshan 	if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
41954c16bd32STejun Heo 		if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
4196f7142ed4SLai Jiangshan 			return;
41974c16bd32STejun Heo 	} else {
41984c16bd32STejun Heo 		goto use_dfl_pwq;
41994c16bd32STejun Heo 	}
42004c16bd32STejun Heo 
42014c16bd32STejun Heo 	/* create a new pwq */
42024c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
42034c16bd32STejun Heo 	if (!pwq) {
42042d916033SFabian Frederick 		pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
42054c16bd32STejun Heo 			wq->name);
420677f300b1SDaeseok Youn 		goto use_dfl_pwq;
42074c16bd32STejun Heo 	}
42084c16bd32STejun Heo 
4209f7142ed4SLai Jiangshan 	/* Install the new pwq. */
42104c16bd32STejun Heo 	mutex_lock(&wq->mutex);
42114c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, pwq);
42124c16bd32STejun Heo 	goto out_unlock;
42134c16bd32STejun Heo 
42144c16bd32STejun Heo use_dfl_pwq:
4215f7142ed4SLai Jiangshan 	mutex_lock(&wq->mutex);
4216a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&wq->dfl_pwq->pool->lock);
42174c16bd32STejun Heo 	get_pwq(wq->dfl_pwq);
4218a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock);
42194c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
42204c16bd32STejun Heo out_unlock:
42214c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
42224c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
42234c16bd32STejun Heo }
42244c16bd32STejun Heo 
422530cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
42261da177e4SLinus Torvalds {
422749e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
42288a2b7538STejun Heo 	int cpu, ret;
4229e1d8aa9fSFrederic Weisbecker 
423030cdf249STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
4231420c0ddbSTejun Heo 		wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4232420c0ddbSTejun Heo 		if (!wq->cpu_pwqs)
423330cdf249STejun Heo 			return -ENOMEM;
423430cdf249STejun Heo 
423530cdf249STejun Heo 		for_each_possible_cpu(cpu) {
42367fb98ea7STejun Heo 			struct pool_workqueue *pwq =
42377fb98ea7STejun Heo 				per_cpu_ptr(wq->cpu_pwqs, cpu);
42387a62c2c8STejun Heo 			struct worker_pool *cpu_pools =
4239f02ae73aSTejun Heo 				per_cpu(cpu_worker_pools, cpu);
424030cdf249STejun Heo 
4241f147f29eSTejun Heo 			init_pwq(pwq, wq, &cpu_pools[highpri]);
4242f147f29eSTejun Heo 
4243f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
42441befcf30STejun Heo 			link_pwq(pwq);
4245f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
424630cdf249STejun Heo 		}
424730cdf249STejun Heo 		return 0;
4248509b3204SDaniel Jordan 	}
4249509b3204SDaniel Jordan 
4250ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
4251509b3204SDaniel Jordan 	if (wq->flags & __WQ_ORDERED) {
42528a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
42538a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
42548a2b7538STejun Heo 		WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
42558a2b7538STejun Heo 			      wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
42568a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
42579e8cd2f5STejun Heo 	} else {
4258509b3204SDaniel Jordan 		ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
42599e8cd2f5STejun Heo 	}
4260ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
4261509b3204SDaniel Jordan 
4262509b3204SDaniel Jordan 	return ret;
42630f900049STejun Heo }
42640f900049STejun Heo 
4265f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
4266f3421797STejun Heo 			       const char *name)
4267b71ab8c2STejun Heo {
4268f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4269f3421797STejun Heo 
4270f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
4271044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4272f3421797STejun Heo 			max_active, name, 1, lim);
4273b71ab8c2STejun Heo 
4274f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
4275b71ab8c2STejun Heo }
4276b71ab8c2STejun Heo 
4277983c7515STejun Heo /*
4278983c7515STejun Heo  * Workqueues which may be used during memory reclaim should have a rescuer
4279983c7515STejun Heo  * to guarantee forward progress.
4280983c7515STejun Heo  */
4281983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq)
4282983c7515STejun Heo {
4283983c7515STejun Heo 	struct worker *rescuer;
4284b92b36eaSDan Carpenter 	int ret;
4285983c7515STejun Heo 
4286983c7515STejun Heo 	if (!(wq->flags & WQ_MEM_RECLAIM))
4287983c7515STejun Heo 		return 0;
4288983c7515STejun Heo 
4289983c7515STejun Heo 	rescuer = alloc_worker(NUMA_NO_NODE);
4290983c7515STejun Heo 	if (!rescuer)
4291983c7515STejun Heo 		return -ENOMEM;
4292983c7515STejun Heo 
4293983c7515STejun Heo 	rescuer->rescue_wq = wq;
4294983c7515STejun Heo 	rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4295f187b697SSean Fu 	if (IS_ERR(rescuer->task)) {
4296b92b36eaSDan Carpenter 		ret = PTR_ERR(rescuer->task);
4297983c7515STejun Heo 		kfree(rescuer);
4298b92b36eaSDan Carpenter 		return ret;
4299983c7515STejun Heo 	}
4300983c7515STejun Heo 
4301983c7515STejun Heo 	wq->rescuer = rescuer;
4302983c7515STejun Heo 	kthread_bind_mask(rescuer->task, cpu_possible_mask);
4303983c7515STejun Heo 	wake_up_process(rescuer->task);
4304983c7515STejun Heo 
4305983c7515STejun Heo 	return 0;
4306983c7515STejun Heo }
4307983c7515STejun Heo 
4308a2775bbcSMathieu Malaterre __printf(1, 4)
4309669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt,
431097e37d7bSTejun Heo 					 unsigned int flags,
4311669de8bdSBart Van Assche 					 int max_active, ...)
43123af24433SOleg Nesterov {
4313df2d5ae4STejun Heo 	size_t tbl_size = 0;
4314ecf6881fSTejun Heo 	va_list args;
43153af24433SOleg Nesterov 	struct workqueue_struct *wq;
431649e3cf44STejun Heo 	struct pool_workqueue *pwq;
4317b196be89STejun Heo 
43185c0338c6STejun Heo 	/*
43195c0338c6STejun Heo 	 * Unbound && max_active == 1 used to imply ordered, which is no
43205c0338c6STejun Heo 	 * longer the case on NUMA machines due to per-node pools.  While
43215c0338c6STejun Heo 	 * alloc_ordered_workqueue() is the right way to create an ordered
43225c0338c6STejun Heo 	 * workqueue, keep the previous behavior to avoid subtle breakages
43235c0338c6STejun Heo 	 * on NUMA.
43245c0338c6STejun Heo 	 */
43255c0338c6STejun Heo 	if ((flags & WQ_UNBOUND) && max_active == 1)
43265c0338c6STejun Heo 		flags |= __WQ_ORDERED;
43275c0338c6STejun Heo 
4328cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
4329cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4330cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
4331cee22a15SViresh Kumar 
4332ecf6881fSTejun Heo 	/* allocate wq and format name */
4333df2d5ae4STejun Heo 	if (flags & WQ_UNBOUND)
4334ddcb57e2SLai Jiangshan 		tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
4335df2d5ae4STejun Heo 
4336df2d5ae4STejun Heo 	wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
4337b196be89STejun Heo 	if (!wq)
4338d2c1d404STejun Heo 		return NULL;
4339b196be89STejun Heo 
43406029a918STejun Heo 	if (flags & WQ_UNBOUND) {
4341be69d00dSThomas Gleixner 		wq->unbound_attrs = alloc_workqueue_attrs();
43426029a918STejun Heo 		if (!wq->unbound_attrs)
43436029a918STejun Heo 			goto err_free_wq;
43446029a918STejun Heo 	}
43456029a918STejun Heo 
4346669de8bdSBart Van Assche 	va_start(args, max_active);
4347ecf6881fSTejun Heo 	vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4348b196be89STejun Heo 	va_end(args);
43493af24433SOleg Nesterov 
4350d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
4351b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
43523af24433SOleg Nesterov 
4353b196be89STejun Heo 	/* init wq */
435497e37d7bSTejun Heo 	wq->flags = flags;
4355a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
43563c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
4357112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
435830cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
435973f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
436073f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
4361493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
43623af24433SOleg Nesterov 
4363669de8bdSBart Van Assche 	wq_init_lockdep(wq);
4364cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
43653af24433SOleg Nesterov 
436630cdf249STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
436782efcab3SBart Van Assche 		goto err_unreg_lockdep;
43681537663fSTejun Heo 
436940c17f75STejun Heo 	if (wq_online && init_rescuer(wq) < 0)
4370d2c1d404STejun Heo 		goto err_destroy;
4371e22bee78STejun Heo 
4372226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4373226223abSTejun Heo 		goto err_destroy;
4374226223abSTejun Heo 
43756af8bf3dSOleg Nesterov 	/*
437668e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
437768e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
437868e13a67SLai Jiangshan 	 * list.
43796af8bf3dSOleg Nesterov 	 */
438068e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4381a0a1a5fdSTejun Heo 
4382a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
438349e3cf44STejun Heo 	for_each_pwq(pwq, wq)
4384699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4385a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4386a0a1a5fdSTejun Heo 
4387e2dca7adSTejun Heo 	list_add_tail_rcu(&wq->list, &workqueues);
4388a0a1a5fdSTejun Heo 
438968e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
43903af24433SOleg Nesterov 
43913af24433SOleg Nesterov 	return wq;
4392d2c1d404STejun Heo 
439382efcab3SBart Van Assche err_unreg_lockdep:
4394009bb421SBart Van Assche 	wq_unregister_lockdep(wq);
4395009bb421SBart Van Assche 	wq_free_lockdep(wq);
439682efcab3SBart Van Assche err_free_wq:
43976029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
43984690c4abSTejun Heo 	kfree(wq);
4399d2c1d404STejun Heo 	return NULL;
4400d2c1d404STejun Heo err_destroy:
4401d2c1d404STejun Heo 	destroy_workqueue(wq);
44024690c4abSTejun Heo 	return NULL;
44031da177e4SLinus Torvalds }
4404669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue);
44051da177e4SLinus Torvalds 
4406c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq)
4407c29eb853STejun Heo {
4408c29eb853STejun Heo 	int i;
4409c29eb853STejun Heo 
4410c29eb853STejun Heo 	for (i = 0; i < WORK_NR_COLORS; i++)
4411c29eb853STejun Heo 		if (pwq->nr_in_flight[i])
4412c29eb853STejun Heo 			return true;
4413c29eb853STejun Heo 
4414c29eb853STejun Heo 	if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4415c29eb853STejun Heo 		return true;
4416f97a4a1aSLai Jiangshan 	if (pwq->nr_active || !list_empty(&pwq->inactive_works))
4417c29eb853STejun Heo 		return true;
4418c29eb853STejun Heo 
4419c29eb853STejun Heo 	return false;
4420c29eb853STejun Heo }
4421c29eb853STejun Heo 
44223af24433SOleg Nesterov /**
44233af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
44243af24433SOleg Nesterov  * @wq: target workqueue
44253af24433SOleg Nesterov  *
44263af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
44273af24433SOleg Nesterov  */
44283af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
44293af24433SOleg Nesterov {
443049e3cf44STejun Heo 	struct pool_workqueue *pwq;
44314c16bd32STejun Heo 	int node;
44323af24433SOleg Nesterov 
4433def98c84STejun Heo 	/*
4434def98c84STejun Heo 	 * Remove it from sysfs first so that sanity check failure doesn't
4435def98c84STejun Heo 	 * lead to sysfs name conflicts.
4436def98c84STejun Heo 	 */
4437def98c84STejun Heo 	workqueue_sysfs_unregister(wq);
4438def98c84STejun Heo 
44399c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
44409c5a2ba7STejun Heo 	drain_workqueue(wq);
4441c8efcc25STejun Heo 
4442def98c84STejun Heo 	/* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4443def98c84STejun Heo 	if (wq->rescuer) {
4444def98c84STejun Heo 		struct worker *rescuer = wq->rescuer;
4445def98c84STejun Heo 
4446def98c84STejun Heo 		/* this prevents new queueing */
4447a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
4448def98c84STejun Heo 		wq->rescuer = NULL;
4449a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
4450def98c84STejun Heo 
4451def98c84STejun Heo 		/* rescuer will empty maydays list before exiting */
4452def98c84STejun Heo 		kthread_stop(rescuer->task);
44538efe1223STejun Heo 		kfree(rescuer);
4454def98c84STejun Heo 	}
4455def98c84STejun Heo 
4456c29eb853STejun Heo 	/*
4457c29eb853STejun Heo 	 * Sanity checks - grab all the locks so that we wait for all
4458c29eb853STejun Heo 	 * in-flight operations which may do put_pwq().
4459c29eb853STejun Heo 	 */
4460c29eb853STejun Heo 	mutex_lock(&wq_pool_mutex);
4461b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
446249e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
4463a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
4464c29eb853STejun Heo 		if (WARN_ON(pwq_busy(pwq))) {
44651d9a6159SKefeng Wang 			pr_warn("%s: %s has the following busy pwq\n",
4466e66b39afSTejun Heo 				__func__, wq->name);
4467c29eb853STejun Heo 			show_pwq(pwq);
4468a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pwq->pool->lock);
4469b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
4470c29eb853STejun Heo 			mutex_unlock(&wq_pool_mutex);
447155df0933SImran Khan 			show_one_workqueue(wq);
44726183c009STejun Heo 			return;
447376af4d93STejun Heo 		}
4474a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
447576af4d93STejun Heo 	}
4476b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
44776183c009STejun Heo 
4478a0a1a5fdSTejun Heo 	/*
4479a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
4480a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
4481a0a1a5fdSTejun Heo 	 */
4482e2dca7adSTejun Heo 	list_del_rcu(&wq->list);
448368e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
44843af24433SOleg Nesterov 
44858864b4e5STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
4486669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
448729c91e99STejun Heo 		/*
44888864b4e5STejun Heo 		 * The base ref is never dropped on per-cpu pwqs.  Directly
4489e2dca7adSTejun Heo 		 * schedule RCU free.
449029c91e99STejun Heo 		 */
449125b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
44928864b4e5STejun Heo 	} else {
44938864b4e5STejun Heo 		/*
44948864b4e5STejun Heo 		 * We're the sole accessor of @wq at this point.  Directly
44954c16bd32STejun Heo 		 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
44964c16bd32STejun Heo 		 * @wq will be freed when the last pwq is released.
44978864b4e5STejun Heo 		 */
44984c16bd32STejun Heo 		for_each_node(node) {
44994c16bd32STejun Heo 			pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
45004c16bd32STejun Heo 			RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
45014c16bd32STejun Heo 			put_pwq_unlocked(pwq);
45024c16bd32STejun Heo 		}
45034c16bd32STejun Heo 
45044c16bd32STejun Heo 		/*
45054c16bd32STejun Heo 		 * Put dfl_pwq.  @wq may be freed any time after dfl_pwq is
45064c16bd32STejun Heo 		 * put.  Don't access it afterwards.
45074c16bd32STejun Heo 		 */
45084c16bd32STejun Heo 		pwq = wq->dfl_pwq;
45094c16bd32STejun Heo 		wq->dfl_pwq = NULL;
4510dce90d47STejun Heo 		put_pwq_unlocked(pwq);
451129c91e99STejun Heo 	}
45123af24433SOleg Nesterov }
45133af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
45143af24433SOleg Nesterov 
4515dcd989cbSTejun Heo /**
4516dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
4517dcd989cbSTejun Heo  * @wq: target workqueue
4518dcd989cbSTejun Heo  * @max_active: new max_active value.
4519dcd989cbSTejun Heo  *
4520dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
4521dcd989cbSTejun Heo  *
4522dcd989cbSTejun Heo  * CONTEXT:
4523dcd989cbSTejun Heo  * Don't call from IRQ context.
4524dcd989cbSTejun Heo  */
4525dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4526dcd989cbSTejun Heo {
452749e3cf44STejun Heo 	struct pool_workqueue *pwq;
4528dcd989cbSTejun Heo 
45298719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
45300a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
45318719dceaSTejun Heo 		return;
45328719dceaSTejun Heo 
4533f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4534dcd989cbSTejun Heo 
4535a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
4536dcd989cbSTejun Heo 
45370a94efb5STejun Heo 	wq->flags &= ~__WQ_ORDERED;
4538dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
4539dcd989cbSTejun Heo 
4540699ce097STejun Heo 	for_each_pwq(pwq, wq)
4541699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4542dcd989cbSTejun Heo 
4543a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4544dcd989cbSTejun Heo }
4545dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4546dcd989cbSTejun Heo 
4547dcd989cbSTejun Heo /**
454827d4ee03SLukas Wunner  * current_work - retrieve %current task's work struct
454927d4ee03SLukas Wunner  *
455027d4ee03SLukas Wunner  * Determine if %current task is a workqueue worker and what it's working on.
455127d4ee03SLukas Wunner  * Useful to find out the context that the %current task is running in.
455227d4ee03SLukas Wunner  *
455327d4ee03SLukas Wunner  * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
455427d4ee03SLukas Wunner  */
455527d4ee03SLukas Wunner struct work_struct *current_work(void)
455627d4ee03SLukas Wunner {
455727d4ee03SLukas Wunner 	struct worker *worker = current_wq_worker();
455827d4ee03SLukas Wunner 
455927d4ee03SLukas Wunner 	return worker ? worker->current_work : NULL;
456027d4ee03SLukas Wunner }
456127d4ee03SLukas Wunner EXPORT_SYMBOL(current_work);
456227d4ee03SLukas Wunner 
456327d4ee03SLukas Wunner /**
4564e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
4565e6267616STejun Heo  *
4566e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
4567e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
4568d185af30SYacine Belkadi  *
4569d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
4570e6267616STejun Heo  */
4571e6267616STejun Heo bool current_is_workqueue_rescuer(void)
4572e6267616STejun Heo {
4573e6267616STejun Heo 	struct worker *worker = current_wq_worker();
4574e6267616STejun Heo 
45756a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
4576e6267616STejun Heo }
4577e6267616STejun Heo 
4578e6267616STejun Heo /**
4579dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
4580dcd989cbSTejun Heo  * @cpu: CPU in question
4581dcd989cbSTejun Heo  * @wq: target workqueue
4582dcd989cbSTejun Heo  *
4583dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
4584dcd989cbSTejun Heo  * no synchronization around this function and the test result is
4585dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4586dcd989cbSTejun Heo  *
4587d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4588d3251859STejun Heo  * Note that both per-cpu and unbound workqueues may be associated with
4589d3251859STejun Heo  * multiple pool_workqueues which have separate congested states.  A
4590d3251859STejun Heo  * workqueue being congested on one CPU doesn't mean the workqueue is also
4591d3251859STejun Heo  * contested on other CPUs / NUMA nodes.
4592d3251859STejun Heo  *
4593d185af30SYacine Belkadi  * Return:
4594dcd989cbSTejun Heo  * %true if congested, %false otherwise.
4595dcd989cbSTejun Heo  */
4596d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4597dcd989cbSTejun Heo {
45987fb98ea7STejun Heo 	struct pool_workqueue *pwq;
459976af4d93STejun Heo 	bool ret;
460076af4d93STejun Heo 
460124acfb71SThomas Gleixner 	rcu_read_lock();
460224acfb71SThomas Gleixner 	preempt_disable();
46037fb98ea7STejun Heo 
4604d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
4605d3251859STejun Heo 		cpu = smp_processor_id();
4606d3251859STejun Heo 
46077fb98ea7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
46087fb98ea7STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
46097fb98ea7STejun Heo 	else
4610df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4611dcd989cbSTejun Heo 
4612f97a4a1aSLai Jiangshan 	ret = !list_empty(&pwq->inactive_works);
461324acfb71SThomas Gleixner 	preempt_enable();
461424acfb71SThomas Gleixner 	rcu_read_unlock();
461576af4d93STejun Heo 
461676af4d93STejun Heo 	return ret;
4617dcd989cbSTejun Heo }
4618dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
4619dcd989cbSTejun Heo 
4620dcd989cbSTejun Heo /**
4621dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
4622dcd989cbSTejun Heo  * @work: the work to be tested
4623dcd989cbSTejun Heo  *
4624dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
4625dcd989cbSTejun Heo  * synchronization around this function and the test result is
4626dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4627dcd989cbSTejun Heo  *
4628d185af30SYacine Belkadi  * Return:
4629dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
4630dcd989cbSTejun Heo  */
4631dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
4632dcd989cbSTejun Heo {
4633fa1b54e6STejun Heo 	struct worker_pool *pool;
4634dcd989cbSTejun Heo 	unsigned long flags;
4635dcd989cbSTejun Heo 	unsigned int ret = 0;
4636dcd989cbSTejun Heo 
4637dcd989cbSTejun Heo 	if (work_pending(work))
4638dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
4639038366c5SLai Jiangshan 
464024acfb71SThomas Gleixner 	rcu_read_lock();
4641fa1b54e6STejun Heo 	pool = get_work_pool(work);
4642038366c5SLai Jiangshan 	if (pool) {
4643a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irqsave(&pool->lock, flags);
4644c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
4645dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
4646a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irqrestore(&pool->lock, flags);
4647038366c5SLai Jiangshan 	}
464824acfb71SThomas Gleixner 	rcu_read_unlock();
4649dcd989cbSTejun Heo 
4650dcd989cbSTejun Heo 	return ret;
4651dcd989cbSTejun Heo }
4652dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
4653dcd989cbSTejun Heo 
46543d1cb205STejun Heo /**
46553d1cb205STejun Heo  * set_worker_desc - set description for the current work item
46563d1cb205STejun Heo  * @fmt: printf-style format string
46573d1cb205STejun Heo  * @...: arguments for the format string
46583d1cb205STejun Heo  *
46593d1cb205STejun Heo  * This function can be called by a running work function to describe what
46603d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
46613d1cb205STejun Heo  * information will be printed out together to help debugging.  The
46623d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
46633d1cb205STejun Heo  */
46643d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
46653d1cb205STejun Heo {
46663d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
46673d1cb205STejun Heo 	va_list args;
46683d1cb205STejun Heo 
46693d1cb205STejun Heo 	if (worker) {
46703d1cb205STejun Heo 		va_start(args, fmt);
46713d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
46723d1cb205STejun Heo 		va_end(args);
46733d1cb205STejun Heo 	}
46743d1cb205STejun Heo }
46755c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc);
46763d1cb205STejun Heo 
46773d1cb205STejun Heo /**
46783d1cb205STejun Heo  * print_worker_info - print out worker information and description
46793d1cb205STejun Heo  * @log_lvl: the log level to use when printing
46803d1cb205STejun Heo  * @task: target task
46813d1cb205STejun Heo  *
46823d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
46833d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
46843d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
46853d1cb205STejun Heo  *
46863d1cb205STejun Heo  * This function can be safely called on any task as long as the
46873d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
46883d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
46893d1cb205STejun Heo  */
46903d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
46913d1cb205STejun Heo {
46923d1cb205STejun Heo 	work_func_t *fn = NULL;
46933d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
46943d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
46953d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
46963d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
46973d1cb205STejun Heo 	struct worker *worker;
46983d1cb205STejun Heo 
46993d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
47003d1cb205STejun Heo 		return;
47013d1cb205STejun Heo 
47023d1cb205STejun Heo 	/*
47033d1cb205STejun Heo 	 * This function is called without any synchronization and @task
47043d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
47053d1cb205STejun Heo 	 */
4706e700591aSPetr Mladek 	worker = kthread_probe_data(task);
47073d1cb205STejun Heo 
47083d1cb205STejun Heo 	/*
47098bf89593STejun Heo 	 * Carefully copy the associated workqueue's workfn, name and desc.
47108bf89593STejun Heo 	 * Keep the original last '\0' in case the original is garbage.
47113d1cb205STejun Heo 	 */
4712fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
4713fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
4714fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
4715fe557319SChristoph Hellwig 	copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
4716fe557319SChristoph Hellwig 	copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
47173d1cb205STejun Heo 
47183d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
4719d75f773cSSakari Ailus 		printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
47208bf89593STejun Heo 		if (strcmp(name, desc))
47213d1cb205STejun Heo 			pr_cont(" (%s)", desc);
47223d1cb205STejun Heo 		pr_cont("\n");
47233d1cb205STejun Heo 	}
47243d1cb205STejun Heo }
47253d1cb205STejun Heo 
47263494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool)
47273494fc30STejun Heo {
47283494fc30STejun Heo 	pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
47293494fc30STejun Heo 	if (pool->node != NUMA_NO_NODE)
47303494fc30STejun Heo 		pr_cont(" node=%d", pool->node);
47313494fc30STejun Heo 	pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
47323494fc30STejun Heo }
47333494fc30STejun Heo 
47343494fc30STejun Heo static void pr_cont_work(bool comma, struct work_struct *work)
47353494fc30STejun Heo {
47363494fc30STejun Heo 	if (work->func == wq_barrier_func) {
47373494fc30STejun Heo 		struct wq_barrier *barr;
47383494fc30STejun Heo 
47393494fc30STejun Heo 		barr = container_of(work, struct wq_barrier, work);
47403494fc30STejun Heo 
47413494fc30STejun Heo 		pr_cont("%s BAR(%d)", comma ? "," : "",
47423494fc30STejun Heo 			task_pid_nr(barr->task));
47433494fc30STejun Heo 	} else {
4744d75f773cSSakari Ailus 		pr_cont("%s %ps", comma ? "," : "", work->func);
47453494fc30STejun Heo 	}
47463494fc30STejun Heo }
47473494fc30STejun Heo 
47483494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq)
47493494fc30STejun Heo {
47503494fc30STejun Heo 	struct worker_pool *pool = pwq->pool;
47513494fc30STejun Heo 	struct work_struct *work;
47523494fc30STejun Heo 	struct worker *worker;
47533494fc30STejun Heo 	bool has_in_flight = false, has_pending = false;
47543494fc30STejun Heo 	int bkt;
47553494fc30STejun Heo 
47563494fc30STejun Heo 	pr_info("  pwq %d:", pool->id);
47573494fc30STejun Heo 	pr_cont_pool_info(pool);
47583494fc30STejun Heo 
4759e66b39afSTejun Heo 	pr_cont(" active=%d/%d refcnt=%d%s\n",
4760e66b39afSTejun Heo 		pwq->nr_active, pwq->max_active, pwq->refcnt,
47613494fc30STejun Heo 		!list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
47623494fc30STejun Heo 
47633494fc30STejun Heo 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
47643494fc30STejun Heo 		if (worker->current_pwq == pwq) {
47653494fc30STejun Heo 			has_in_flight = true;
47663494fc30STejun Heo 			break;
47673494fc30STejun Heo 		}
47683494fc30STejun Heo 	}
47693494fc30STejun Heo 	if (has_in_flight) {
47703494fc30STejun Heo 		bool comma = false;
47713494fc30STejun Heo 
47723494fc30STejun Heo 		pr_info("    in-flight:");
47733494fc30STejun Heo 		hash_for_each(pool->busy_hash, bkt, worker, hentry) {
47743494fc30STejun Heo 			if (worker->current_pwq != pwq)
47753494fc30STejun Heo 				continue;
47763494fc30STejun Heo 
4777d75f773cSSakari Ailus 			pr_cont("%s %d%s:%ps", comma ? "," : "",
47783494fc30STejun Heo 				task_pid_nr(worker->task),
477930ae2fc0STejun Heo 				worker->rescue_wq ? "(RESCUER)" : "",
47803494fc30STejun Heo 				worker->current_func);
47813494fc30STejun Heo 			list_for_each_entry(work, &worker->scheduled, entry)
47823494fc30STejun Heo 				pr_cont_work(false, work);
47833494fc30STejun Heo 			comma = true;
47843494fc30STejun Heo 		}
47853494fc30STejun Heo 		pr_cont("\n");
47863494fc30STejun Heo 	}
47873494fc30STejun Heo 
47883494fc30STejun Heo 	list_for_each_entry(work, &pool->worklist, entry) {
47893494fc30STejun Heo 		if (get_work_pwq(work) == pwq) {
47903494fc30STejun Heo 			has_pending = true;
47913494fc30STejun Heo 			break;
47923494fc30STejun Heo 		}
47933494fc30STejun Heo 	}
47943494fc30STejun Heo 	if (has_pending) {
47953494fc30STejun Heo 		bool comma = false;
47963494fc30STejun Heo 
47973494fc30STejun Heo 		pr_info("    pending:");
47983494fc30STejun Heo 		list_for_each_entry(work, &pool->worklist, entry) {
47993494fc30STejun Heo 			if (get_work_pwq(work) != pwq)
48003494fc30STejun Heo 				continue;
48013494fc30STejun Heo 
48023494fc30STejun Heo 			pr_cont_work(comma, work);
48033494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
48043494fc30STejun Heo 		}
48053494fc30STejun Heo 		pr_cont("\n");
48063494fc30STejun Heo 	}
48073494fc30STejun Heo 
4808f97a4a1aSLai Jiangshan 	if (!list_empty(&pwq->inactive_works)) {
48093494fc30STejun Heo 		bool comma = false;
48103494fc30STejun Heo 
4811f97a4a1aSLai Jiangshan 		pr_info("    inactive:");
4812f97a4a1aSLai Jiangshan 		list_for_each_entry(work, &pwq->inactive_works, entry) {
48133494fc30STejun Heo 			pr_cont_work(comma, work);
48143494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
48153494fc30STejun Heo 		}
48163494fc30STejun Heo 		pr_cont("\n");
48173494fc30STejun Heo 	}
48183494fc30STejun Heo }
48193494fc30STejun Heo 
48203494fc30STejun Heo /**
482155df0933SImran Khan  * show_one_workqueue - dump state of specified workqueue
482255df0933SImran Khan  * @wq: workqueue whose state will be printed
48233494fc30STejun Heo  */
482455df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq)
48253494fc30STejun Heo {
48263494fc30STejun Heo 	struct pool_workqueue *pwq;
48273494fc30STejun Heo 	bool idle = true;
482855df0933SImran Khan 	unsigned long flags;
48293494fc30STejun Heo 
48303494fc30STejun Heo 	for_each_pwq(pwq, wq) {
4831f97a4a1aSLai Jiangshan 		if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
48323494fc30STejun Heo 			idle = false;
48333494fc30STejun Heo 			break;
48343494fc30STejun Heo 		}
48353494fc30STejun Heo 	}
483655df0933SImran Khan 	if (idle) /* Nothing to print for idle workqueue */
483755df0933SImran Khan 		return;
48383494fc30STejun Heo 
48393494fc30STejun Heo 	pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
48403494fc30STejun Heo 
48413494fc30STejun Heo 	for_each_pwq(pwq, wq) {
4842a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irqsave(&pwq->pool->lock, flags);
484357116ce1SJohan Hovold 		if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
484457116ce1SJohan Hovold 			/*
484557116ce1SJohan Hovold 			 * Defer printing to avoid deadlocks in console
484657116ce1SJohan Hovold 			 * drivers that queue work while holding locks
484757116ce1SJohan Hovold 			 * also taken in their write paths.
484857116ce1SJohan Hovold 			 */
484957116ce1SJohan Hovold 			printk_deferred_enter();
48503494fc30STejun Heo 			show_pwq(pwq);
485157116ce1SJohan Hovold 			printk_deferred_exit();
485257116ce1SJohan Hovold 		}
4853a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
485462635ea8SSergey Senozhatsky 		/*
485562635ea8SSergey Senozhatsky 		 * We could be printing a lot from atomic context, e.g.
485655df0933SImran Khan 		 * sysrq-t -> show_all_workqueues(). Avoid triggering
485762635ea8SSergey Senozhatsky 		 * hard lockup.
485862635ea8SSergey Senozhatsky 		 */
485962635ea8SSergey Senozhatsky 		touch_nmi_watchdog();
48603494fc30STejun Heo 	}
486155df0933SImran Khan 
48623494fc30STejun Heo }
48633494fc30STejun Heo 
486455df0933SImran Khan /**
486555df0933SImran Khan  * show_one_worker_pool - dump state of specified worker pool
486655df0933SImran Khan  * @pool: worker pool whose state will be printed
486755df0933SImran Khan  */
486855df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool)
486955df0933SImran Khan {
48703494fc30STejun Heo 	struct worker *worker;
48713494fc30STejun Heo 	bool first = true;
487255df0933SImran Khan 	unsigned long flags;
48733494fc30STejun Heo 
4874a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irqsave(&pool->lock, flags);
48753494fc30STejun Heo 	if (pool->nr_workers == pool->nr_idle)
48763494fc30STejun Heo 		goto next_pool;
487757116ce1SJohan Hovold 	/*
487857116ce1SJohan Hovold 	 * Defer printing to avoid deadlocks in console drivers that
487957116ce1SJohan Hovold 	 * queue work while holding locks also taken in their write
488057116ce1SJohan Hovold 	 * paths.
488157116ce1SJohan Hovold 	 */
488257116ce1SJohan Hovold 	printk_deferred_enter();
48833494fc30STejun Heo 	pr_info("pool %d:", pool->id);
48843494fc30STejun Heo 	pr_cont_pool_info(pool);
488582607adcSTejun Heo 	pr_cont(" hung=%us workers=%d",
488682607adcSTejun Heo 		jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
488782607adcSTejun Heo 		pool->nr_workers);
48883494fc30STejun Heo 	if (pool->manager)
48893494fc30STejun Heo 		pr_cont(" manager: %d",
48903494fc30STejun Heo 			task_pid_nr(pool->manager->task));
48913494fc30STejun Heo 	list_for_each_entry(worker, &pool->idle_list, entry) {
48923494fc30STejun Heo 		pr_cont(" %s%d", first ? "idle: " : "",
48933494fc30STejun Heo 			task_pid_nr(worker->task));
48943494fc30STejun Heo 		first = false;
48953494fc30STejun Heo 	}
48963494fc30STejun Heo 	pr_cont("\n");
489757116ce1SJohan Hovold 	printk_deferred_exit();
48983494fc30STejun Heo next_pool:
4899a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irqrestore(&pool->lock, flags);
490062635ea8SSergey Senozhatsky 	/*
490162635ea8SSergey Senozhatsky 	 * We could be printing a lot from atomic context, e.g.
490255df0933SImran Khan 	 * sysrq-t -> show_all_workqueues(). Avoid triggering
490362635ea8SSergey Senozhatsky 	 * hard lockup.
490462635ea8SSergey Senozhatsky 	 */
490562635ea8SSergey Senozhatsky 	touch_nmi_watchdog();
490655df0933SImran Khan 
49073494fc30STejun Heo }
49083494fc30STejun Heo 
490955df0933SImran Khan /**
491055df0933SImran Khan  * show_all_workqueues - dump workqueue state
491155df0933SImran Khan  *
491255df0933SImran Khan  * Called from a sysrq handler or try_to_freeze_tasks() and prints out
491355df0933SImran Khan  * all busy workqueues and pools.
491455df0933SImran Khan  */
491555df0933SImran Khan void show_all_workqueues(void)
491655df0933SImran Khan {
491755df0933SImran Khan 	struct workqueue_struct *wq;
491855df0933SImran Khan 	struct worker_pool *pool;
491955df0933SImran Khan 	int pi;
492055df0933SImran Khan 
492155df0933SImran Khan 	rcu_read_lock();
492255df0933SImran Khan 
492355df0933SImran Khan 	pr_info("Showing busy workqueues and worker pools:\n");
492455df0933SImran Khan 
492555df0933SImran Khan 	list_for_each_entry_rcu(wq, &workqueues, list)
492655df0933SImran Khan 		show_one_workqueue(wq);
492755df0933SImran Khan 
492855df0933SImran Khan 	for_each_pool(pool, pi)
492955df0933SImran Khan 		show_one_worker_pool(pool);
493055df0933SImran Khan 
493124acfb71SThomas Gleixner 	rcu_read_unlock();
49323494fc30STejun Heo }
49333494fc30STejun Heo 
49346b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */
49356b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
49366b59808bSTejun Heo {
49376b59808bSTejun Heo 	int off;
49386b59808bSTejun Heo 
49396b59808bSTejun Heo 	/* always show the actual comm */
49406b59808bSTejun Heo 	off = strscpy(buf, task->comm, size);
49416b59808bSTejun Heo 	if (off < 0)
49426b59808bSTejun Heo 		return;
49436b59808bSTejun Heo 
4944197f6accSTejun Heo 	/* stabilize PF_WQ_WORKER and worker pool association */
49456b59808bSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
49466b59808bSTejun Heo 
4947197f6accSTejun Heo 	if (task->flags & PF_WQ_WORKER) {
4948197f6accSTejun Heo 		struct worker *worker = kthread_data(task);
4949197f6accSTejun Heo 		struct worker_pool *pool = worker->pool;
49506b59808bSTejun Heo 
49516b59808bSTejun Heo 		if (pool) {
4952a9b8a985SSebastian Andrzej Siewior 			raw_spin_lock_irq(&pool->lock);
49536b59808bSTejun Heo 			/*
4954197f6accSTejun Heo 			 * ->desc tracks information (wq name or
4955197f6accSTejun Heo 			 * set_worker_desc()) for the latest execution.  If
4956197f6accSTejun Heo 			 * current, prepend '+', otherwise '-'.
49576b59808bSTejun Heo 			 */
49586b59808bSTejun Heo 			if (worker->desc[0] != '\0') {
49596b59808bSTejun Heo 				if (worker->current_work)
49606b59808bSTejun Heo 					scnprintf(buf + off, size - off, "+%s",
49616b59808bSTejun Heo 						  worker->desc);
49626b59808bSTejun Heo 				else
49636b59808bSTejun Heo 					scnprintf(buf + off, size - off, "-%s",
49646b59808bSTejun Heo 						  worker->desc);
49656b59808bSTejun Heo 			}
4966a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pool->lock);
49676b59808bSTejun Heo 		}
4968197f6accSTejun Heo 	}
49696b59808bSTejun Heo 
49706b59808bSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
49716b59808bSTejun Heo }
49726b59808bSTejun Heo 
497366448bc2SMathieu Malaterre #ifdef CONFIG_SMP
497466448bc2SMathieu Malaterre 
4975db7bccf4STejun Heo /*
4976db7bccf4STejun Heo  * CPU hotplug.
4977db7bccf4STejun Heo  *
4978e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
4979112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
4980706026c2STejun Heo  * pool which make migrating pending and scheduled works very
4981e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
498294cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
4983e22bee78STejun Heo  * blocked draining impractical.
4984e22bee78STejun Heo  *
498524647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
4986628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
4987628c78e7STejun Heo  * cpu comes back online.
4988db7bccf4STejun Heo  */
4989db7bccf4STejun Heo 
4990e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu)
4991db7bccf4STejun Heo {
49924ce62e9eSTejun Heo 	struct worker_pool *pool;
4993db7bccf4STejun Heo 	struct worker *worker;
4994db7bccf4STejun Heo 
4995f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
49961258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
4997a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
4998e22bee78STejun Heo 
4999f2d5a0eeSTejun Heo 		/*
500092f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
500194cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
500294cf58bbSTejun Heo 		 * except for the ones which are still executing works from
500394cf58bbSTejun Heo 		 * before the last CPU down must be on the cpu.  After
500494cf58bbSTejun Heo 		 * this, they may become diasporas.
5005f2d5a0eeSTejun Heo 		 */
5006da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
5007403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
5008db7bccf4STejun Heo 
500924647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
5010f2d5a0eeSTejun Heo 
5011a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
501206249738SPeter Zijlstra 
50135c25b5ffSPeter Zijlstra 		for_each_pool_worker(worker, pool) {
50145c25b5ffSPeter Zijlstra 			kthread_set_per_cpu(worker->task, -1);
5015547a77d0SLai Jiangshan 			WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
50165c25b5ffSPeter Zijlstra 		}
501706249738SPeter Zijlstra 
50181258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
5019e22bee78STejun Heo 
5020e22bee78STejun Heo 		/*
5021eb283428SLai Jiangshan 		 * Call schedule() so that we cross rq->lock and thus can
5022eb283428SLai Jiangshan 		 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
5023eb283428SLai Jiangshan 		 * This is necessary as scheduler callbacks may be invoked
5024eb283428SLai Jiangshan 		 * from other cpus.
5025628c78e7STejun Heo 		 */
5026628c78e7STejun Heo 		schedule();
5027628c78e7STejun Heo 
5028628c78e7STejun Heo 		/*
5029eb283428SLai Jiangshan 		 * Sched callbacks are disabled now.  Zap nr_running.
5030eb283428SLai Jiangshan 		 * After this, nr_running stays zero and need_more_worker()
5031eb283428SLai Jiangshan 		 * and keep_working() are always true as long as the
5032eb283428SLai Jiangshan 		 * worklist is not empty.  This pool now behaves as an
5033eb283428SLai Jiangshan 		 * unbound (in terms of concurrency management) pool which
5034eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
5035e22bee78STejun Heo 		 */
5036e19e397aSTejun Heo 		atomic_set(&pool->nr_running, 0);
5037eb283428SLai Jiangshan 
5038eb283428SLai Jiangshan 		/*
5039eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
5040eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
5041eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
5042eb283428SLai Jiangshan 		 */
5043a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
5044eb283428SLai Jiangshan 		wake_up_worker(pool);
5045a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
5046eb283428SLai Jiangshan 	}
5047db7bccf4STejun Heo }
5048db7bccf4STejun Heo 
5049bd7c089eSTejun Heo /**
5050bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
5051bd7c089eSTejun Heo  * @pool: pool of interest
5052bd7c089eSTejun Heo  *
5053a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
5054bd7c089eSTejun Heo  */
5055bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
5056bd7c089eSTejun Heo {
5057a9ab775bSTejun Heo 	struct worker *worker;
5058bd7c089eSTejun Heo 
50591258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
5060bd7c089eSTejun Heo 
5061bd7c089eSTejun Heo 	/*
5062a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
5063a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
5064402dd89dSShailendra Verma 	 * wake-ups for concurrency management happen, restore CPU affinity
5065a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
5066a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
5067bd7c089eSTejun Heo 	 */
50685c25b5ffSPeter Zijlstra 	for_each_pool_worker(worker, pool) {
50695c25b5ffSPeter Zijlstra 		kthread_set_per_cpu(worker->task, pool->cpu);
5070a9ab775bSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
5071a9ab775bSTejun Heo 						  pool->attrs->cpumask) < 0);
50725c25b5ffSPeter Zijlstra 	}
5073a9ab775bSTejun Heo 
5074a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
5075f7c17d26SWanpeng Li 
50763de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
5077a9ab775bSTejun Heo 
5078da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
5079a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
5080a9ab775bSTejun Heo 
5081a9ab775bSTejun Heo 		/*
5082a9ab775bSTejun Heo 		 * A bound idle worker should actually be on the runqueue
5083a9ab775bSTejun Heo 		 * of the associated CPU for local wake-ups targeting it to
5084a9ab775bSTejun Heo 		 * work.  Kick all idle workers so that they migrate to the
5085a9ab775bSTejun Heo 		 * associated CPU.  Doing this in the same loop as
5086a9ab775bSTejun Heo 		 * replacing UNBOUND with REBOUND is safe as no worker will
5087a9ab775bSTejun Heo 		 * be bound before @pool->lock is released.
5088a9ab775bSTejun Heo 		 */
5089a9ab775bSTejun Heo 		if (worker_flags & WORKER_IDLE)
5090bd7c089eSTejun Heo 			wake_up_process(worker->task);
5091bd7c089eSTejun Heo 
5092bd7c089eSTejun Heo 		/*
5093a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
5094a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
5095a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
5096a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
5097a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
5098a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
5099a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
5100a9ab775bSTejun Heo 		 *
5101c95491edSMark Rutland 		 * WRITE_ONCE() is necessary because @worker->flags may be
5102a9ab775bSTejun Heo 		 * tested without holding any lock in
51036d25be57SThomas Gleixner 		 * wq_worker_running().  Without it, NOT_RUNNING test may
5104a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
5105a9ab775bSTejun Heo 		 * management operations.
5106bd7c089eSTejun Heo 		 */
5107a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
5108a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
5109a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
5110c95491edSMark Rutland 		WRITE_ONCE(worker->flags, worker_flags);
5111bd7c089eSTejun Heo 	}
5112a9ab775bSTejun Heo 
5113a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
5114bd7c089eSTejun Heo }
5115bd7c089eSTejun Heo 
51167dbc725eSTejun Heo /**
51177dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
51187dbc725eSTejun Heo  * @pool: unbound pool of interest
51197dbc725eSTejun Heo  * @cpu: the CPU which is coming up
51207dbc725eSTejun Heo  *
51217dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
51227dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
51237dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
51247dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
51257dbc725eSTejun Heo  */
51267dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
51277dbc725eSTejun Heo {
51287dbc725eSTejun Heo 	static cpumask_t cpumask;
51297dbc725eSTejun Heo 	struct worker *worker;
51307dbc725eSTejun Heo 
51311258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
51327dbc725eSTejun Heo 
51337dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
51347dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
51357dbc725eSTejun Heo 		return;
51367dbc725eSTejun Heo 
51377dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
51387dbc725eSTejun Heo 
51397dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
5140da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
5141d945b5e9SPeter Zijlstra 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
51427dbc725eSTejun Heo }
51437dbc725eSTejun Heo 
51447ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu)
51451da177e4SLinus Torvalds {
51464ce62e9eSTejun Heo 	struct worker_pool *pool;
51471da177e4SLinus Torvalds 
5148f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
51493ce63377STejun Heo 		if (pool->nr_workers)
51503ce63377STejun Heo 			continue;
5151051e1850SLai Jiangshan 		if (!create_worker(pool))
51527ee681b2SThomas Gleixner 			return -ENOMEM;
51533af24433SOleg Nesterov 	}
51547ee681b2SThomas Gleixner 	return 0;
51557ee681b2SThomas Gleixner }
51561da177e4SLinus Torvalds 
51577ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu)
51587ee681b2SThomas Gleixner {
51597ee681b2SThomas Gleixner 	struct worker_pool *pool;
51607ee681b2SThomas Gleixner 	struct workqueue_struct *wq;
51617ee681b2SThomas Gleixner 	int pi;
51627ee681b2SThomas Gleixner 
516368e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
51647dbc725eSTejun Heo 
51657dbc725eSTejun Heo 	for_each_pool(pool, pi) {
51661258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
516794cf58bbSTejun Heo 
5168f05b558dSLai Jiangshan 		if (pool->cpu == cpu)
516994cf58bbSTejun Heo 			rebind_workers(pool);
5170f05b558dSLai Jiangshan 		else if (pool->cpu < 0)
51717dbc725eSTejun Heo 			restore_unbound_workers_cpumask(pool, cpu);
517294cf58bbSTejun Heo 
51731258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
517494cf58bbSTejun Heo 	}
51757dbc725eSTejun Heo 
51764c16bd32STejun Heo 	/* update NUMA affinity of unbound workqueues */
51774c16bd32STejun Heo 	list_for_each_entry(wq, &workqueues, list)
51784c16bd32STejun Heo 		wq_update_unbound_numa(wq, cpu, true);
51794c16bd32STejun Heo 
518068e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
51817ee681b2SThomas Gleixner 	return 0;
518265758202STejun Heo }
518365758202STejun Heo 
51847ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu)
518565758202STejun Heo {
51864c16bd32STejun Heo 	struct workqueue_struct *wq;
51878db25e78STejun Heo 
51884c16bd32STejun Heo 	/* unbinding per-cpu workers should happen on the local CPU */
5189e8b3f8dbSLai Jiangshan 	if (WARN_ON(cpu != smp_processor_id()))
5190e8b3f8dbSLai Jiangshan 		return -1;
5191e8b3f8dbSLai Jiangshan 
5192e8b3f8dbSLai Jiangshan 	unbind_workers(cpu);
51934c16bd32STejun Heo 
51944c16bd32STejun Heo 	/* update NUMA affinity of unbound workqueues */
51954c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
51964c16bd32STejun Heo 	list_for_each_entry(wq, &workqueues, list)
51974c16bd32STejun Heo 		wq_update_unbound_numa(wq, cpu, false);
51984c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
51994c16bd32STejun Heo 
52007ee681b2SThomas Gleixner 	return 0;
520165758202STejun Heo }
520265758202STejun Heo 
52032d3854a3SRusty Russell struct work_for_cpu {
5204ed48ece2STejun Heo 	struct work_struct work;
52052d3854a3SRusty Russell 	long (*fn)(void *);
52062d3854a3SRusty Russell 	void *arg;
52072d3854a3SRusty Russell 	long ret;
52082d3854a3SRusty Russell };
52092d3854a3SRusty Russell 
5210ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
52112d3854a3SRusty Russell {
5212ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5213ed48ece2STejun Heo 
52142d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
52152d3854a3SRusty Russell }
52162d3854a3SRusty Russell 
52172d3854a3SRusty Russell /**
521822aceb31SAnna-Maria Gleixner  * work_on_cpu - run a function in thread context on a particular cpu
52192d3854a3SRusty Russell  * @cpu: the cpu to run on
52202d3854a3SRusty Russell  * @fn: the function to run
52212d3854a3SRusty Russell  * @arg: the function arg
52222d3854a3SRusty Russell  *
522331ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
52246b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
5225d185af30SYacine Belkadi  *
5226d185af30SYacine Belkadi  * Return: The value @fn returns.
52272d3854a3SRusty Russell  */
5228d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
52292d3854a3SRusty Russell {
5230ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
52312d3854a3SRusty Russell 
5232ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5233ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
523412997d1aSBjorn Helgaas 	flush_work(&wfc.work);
5235440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
52362d3854a3SRusty Russell 	return wfc.ret;
52372d3854a3SRusty Russell }
52382d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
52390e8d6a93SThomas Gleixner 
52400e8d6a93SThomas Gleixner /**
52410e8d6a93SThomas Gleixner  * work_on_cpu_safe - run a function in thread context on a particular cpu
52420e8d6a93SThomas Gleixner  * @cpu: the cpu to run on
52430e8d6a93SThomas Gleixner  * @fn:  the function to run
52440e8d6a93SThomas Gleixner  * @arg: the function argument
52450e8d6a93SThomas Gleixner  *
52460e8d6a93SThomas Gleixner  * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
52470e8d6a93SThomas Gleixner  * any locks which would prevent @fn from completing.
52480e8d6a93SThomas Gleixner  *
52490e8d6a93SThomas Gleixner  * Return: The value @fn returns.
52500e8d6a93SThomas Gleixner  */
52510e8d6a93SThomas Gleixner long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
52520e8d6a93SThomas Gleixner {
52530e8d6a93SThomas Gleixner 	long ret = -ENODEV;
52540e8d6a93SThomas Gleixner 
5255ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
52560e8d6a93SThomas Gleixner 	if (cpu_online(cpu))
52570e8d6a93SThomas Gleixner 		ret = work_on_cpu(cpu, fn, arg);
5258ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
52590e8d6a93SThomas Gleixner 	return ret;
52600e8d6a93SThomas Gleixner }
52610e8d6a93SThomas Gleixner EXPORT_SYMBOL_GPL(work_on_cpu_safe);
52622d3854a3SRusty Russell #endif /* CONFIG_SMP */
52632d3854a3SRusty Russell 
5264a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
5265e7577c50SRusty Russell 
5266a0a1a5fdSTejun Heo /**
5267a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
5268a0a1a5fdSTejun Heo  *
526958a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
5270f97a4a1aSLai Jiangshan  * workqueues will queue new works to their inactive_works list instead of
5271706026c2STejun Heo  * pool->worklist.
5272a0a1a5fdSTejun Heo  *
5273a0a1a5fdSTejun Heo  * CONTEXT:
5274a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5275a0a1a5fdSTejun Heo  */
5276a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
5277a0a1a5fdSTejun Heo {
527824b8a847STejun Heo 	struct workqueue_struct *wq;
527924b8a847STejun Heo 	struct pool_workqueue *pwq;
5280a0a1a5fdSTejun Heo 
528168e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5282a0a1a5fdSTejun Heo 
52836183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
5284a0a1a5fdSTejun Heo 	workqueue_freezing = true;
5285a0a1a5fdSTejun Heo 
528624b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
5287a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
5288699ce097STejun Heo 		for_each_pwq(pwq, wq)
5289699ce097STejun Heo 			pwq_adjust_max_active(pwq);
5290a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
5291a1056305STejun Heo 	}
52925bcab335STejun Heo 
529368e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5294a0a1a5fdSTejun Heo }
5295a0a1a5fdSTejun Heo 
5296a0a1a5fdSTejun Heo /**
529758a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
5298a0a1a5fdSTejun Heo  *
5299a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
5300a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
5301a0a1a5fdSTejun Heo  *
5302a0a1a5fdSTejun Heo  * CONTEXT:
530368e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
5304a0a1a5fdSTejun Heo  *
5305d185af30SYacine Belkadi  * Return:
530658a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
530758a69cb4STejun Heo  * is complete.
5308a0a1a5fdSTejun Heo  */
5309a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
5310a0a1a5fdSTejun Heo {
5311a0a1a5fdSTejun Heo 	bool busy = false;
531224b8a847STejun Heo 	struct workqueue_struct *wq;
531324b8a847STejun Heo 	struct pool_workqueue *pwq;
5314a0a1a5fdSTejun Heo 
531568e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5316a0a1a5fdSTejun Heo 
53176183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
5318a0a1a5fdSTejun Heo 
531924b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
532024b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
532124b8a847STejun Heo 			continue;
5322a0a1a5fdSTejun Heo 		/*
5323a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
5324a0a1a5fdSTejun Heo 		 * to peek without lock.
5325a0a1a5fdSTejun Heo 		 */
532624acfb71SThomas Gleixner 		rcu_read_lock();
532724b8a847STejun Heo 		for_each_pwq(pwq, wq) {
53286183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
5329112202d9STejun Heo 			if (pwq->nr_active) {
5330a0a1a5fdSTejun Heo 				busy = true;
533124acfb71SThomas Gleixner 				rcu_read_unlock();
5332a0a1a5fdSTejun Heo 				goto out_unlock;
5333a0a1a5fdSTejun Heo 			}
5334a0a1a5fdSTejun Heo 		}
533524acfb71SThomas Gleixner 		rcu_read_unlock();
5336a0a1a5fdSTejun Heo 	}
5337a0a1a5fdSTejun Heo out_unlock:
533868e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5339a0a1a5fdSTejun Heo 	return busy;
5340a0a1a5fdSTejun Heo }
5341a0a1a5fdSTejun Heo 
5342a0a1a5fdSTejun Heo /**
5343a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
5344a0a1a5fdSTejun Heo  *
5345a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
5346706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
5347a0a1a5fdSTejun Heo  *
5348a0a1a5fdSTejun Heo  * CONTEXT:
5349a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5350a0a1a5fdSTejun Heo  */
5351a0a1a5fdSTejun Heo void thaw_workqueues(void)
5352a0a1a5fdSTejun Heo {
535324b8a847STejun Heo 	struct workqueue_struct *wq;
535424b8a847STejun Heo 	struct pool_workqueue *pwq;
5355a0a1a5fdSTejun Heo 
535668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5357a0a1a5fdSTejun Heo 
5358a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
5359a0a1a5fdSTejun Heo 		goto out_unlock;
5360a0a1a5fdSTejun Heo 
536174b414eaSLai Jiangshan 	workqueue_freezing = false;
536224b8a847STejun Heo 
536324b8a847STejun Heo 	/* restore max_active and repopulate worklist */
536424b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
5365a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
5366699ce097STejun Heo 		for_each_pwq(pwq, wq)
5367699ce097STejun Heo 			pwq_adjust_max_active(pwq);
5368a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
536924b8a847STejun Heo 	}
537024b8a847STejun Heo 
5371a0a1a5fdSTejun Heo out_unlock:
537268e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5373a0a1a5fdSTejun Heo }
5374a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
5375a0a1a5fdSTejun Heo 
5376042f7df1SLai Jiangshan static int workqueue_apply_unbound_cpumask(void)
5377042f7df1SLai Jiangshan {
5378042f7df1SLai Jiangshan 	LIST_HEAD(ctxs);
5379042f7df1SLai Jiangshan 	int ret = 0;
5380042f7df1SLai Jiangshan 	struct workqueue_struct *wq;
5381042f7df1SLai Jiangshan 	struct apply_wqattrs_ctx *ctx, *n;
5382042f7df1SLai Jiangshan 
5383042f7df1SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5384042f7df1SLai Jiangshan 
5385042f7df1SLai Jiangshan 	list_for_each_entry(wq, &workqueues, list) {
5386042f7df1SLai Jiangshan 		if (!(wq->flags & WQ_UNBOUND))
5387042f7df1SLai Jiangshan 			continue;
5388042f7df1SLai Jiangshan 		/* creating multiple pwqs breaks ordering guarantee */
5389042f7df1SLai Jiangshan 		if (wq->flags & __WQ_ORDERED)
5390042f7df1SLai Jiangshan 			continue;
5391042f7df1SLai Jiangshan 
5392042f7df1SLai Jiangshan 		ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5393042f7df1SLai Jiangshan 		if (!ctx) {
5394042f7df1SLai Jiangshan 			ret = -ENOMEM;
5395042f7df1SLai Jiangshan 			break;
5396042f7df1SLai Jiangshan 		}
5397042f7df1SLai Jiangshan 
5398042f7df1SLai Jiangshan 		list_add_tail(&ctx->list, &ctxs);
5399042f7df1SLai Jiangshan 	}
5400042f7df1SLai Jiangshan 
5401042f7df1SLai Jiangshan 	list_for_each_entry_safe(ctx, n, &ctxs, list) {
5402042f7df1SLai Jiangshan 		if (!ret)
5403042f7df1SLai Jiangshan 			apply_wqattrs_commit(ctx);
5404042f7df1SLai Jiangshan 		apply_wqattrs_cleanup(ctx);
5405042f7df1SLai Jiangshan 	}
5406042f7df1SLai Jiangshan 
5407042f7df1SLai Jiangshan 	return ret;
5408042f7df1SLai Jiangshan }
5409042f7df1SLai Jiangshan 
5410042f7df1SLai Jiangshan /**
5411042f7df1SLai Jiangshan  *  workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5412042f7df1SLai Jiangshan  *  @cpumask: the cpumask to set
5413042f7df1SLai Jiangshan  *
5414042f7df1SLai Jiangshan  *  The low-level workqueues cpumask is a global cpumask that limits
5415042f7df1SLai Jiangshan  *  the affinity of all unbound workqueues.  This function check the @cpumask
5416042f7df1SLai Jiangshan  *  and apply it to all unbound workqueues and updates all pwqs of them.
5417042f7df1SLai Jiangshan  *
541867dc8325SCai Huoqing  *  Return:	0	- Success
5419042f7df1SLai Jiangshan  *  		-EINVAL	- Invalid @cpumask
5420042f7df1SLai Jiangshan  *  		-ENOMEM	- Failed to allocate memory for attrs or pwqs.
5421042f7df1SLai Jiangshan  */
5422042f7df1SLai Jiangshan int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5423042f7df1SLai Jiangshan {
5424042f7df1SLai Jiangshan 	int ret = -EINVAL;
5425042f7df1SLai Jiangshan 	cpumask_var_t saved_cpumask;
5426042f7df1SLai Jiangshan 
5427c98a9805STal Shorer 	/*
5428c98a9805STal Shorer 	 * Not excluding isolated cpus on purpose.
5429c98a9805STal Shorer 	 * If the user wishes to include them, we allow that.
5430c98a9805STal Shorer 	 */
5431042f7df1SLai Jiangshan 	cpumask_and(cpumask, cpumask, cpu_possible_mask);
5432042f7df1SLai Jiangshan 	if (!cpumask_empty(cpumask)) {
5433a0111cf6SLai Jiangshan 		apply_wqattrs_lock();
5434d25302e4SMenglong Dong 		if (cpumask_equal(cpumask, wq_unbound_cpumask)) {
5435d25302e4SMenglong Dong 			ret = 0;
5436d25302e4SMenglong Dong 			goto out_unlock;
5437d25302e4SMenglong Dong 		}
5438d25302e4SMenglong Dong 
5439d25302e4SMenglong Dong 		if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL)) {
5440d25302e4SMenglong Dong 			ret = -ENOMEM;
5441d25302e4SMenglong Dong 			goto out_unlock;
5442d25302e4SMenglong Dong 		}
5443042f7df1SLai Jiangshan 
5444042f7df1SLai Jiangshan 		/* save the old wq_unbound_cpumask. */
5445042f7df1SLai Jiangshan 		cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5446042f7df1SLai Jiangshan 
5447042f7df1SLai Jiangshan 		/* update wq_unbound_cpumask at first and apply it to wqs. */
5448042f7df1SLai Jiangshan 		cpumask_copy(wq_unbound_cpumask, cpumask);
5449042f7df1SLai Jiangshan 		ret = workqueue_apply_unbound_cpumask();
5450042f7df1SLai Jiangshan 
5451042f7df1SLai Jiangshan 		/* restore the wq_unbound_cpumask when failed. */
5452042f7df1SLai Jiangshan 		if (ret < 0)
5453042f7df1SLai Jiangshan 			cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5454042f7df1SLai Jiangshan 
5455d25302e4SMenglong Dong 		free_cpumask_var(saved_cpumask);
5456d25302e4SMenglong Dong out_unlock:
5457a0111cf6SLai Jiangshan 		apply_wqattrs_unlock();
5458042f7df1SLai Jiangshan 	}
5459042f7df1SLai Jiangshan 
5460042f7df1SLai Jiangshan 	return ret;
5461042f7df1SLai Jiangshan }
5462042f7df1SLai Jiangshan 
54636ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS
54646ba94429SFrederic Weisbecker /*
54656ba94429SFrederic Weisbecker  * Workqueues with WQ_SYSFS flag set is visible to userland via
54666ba94429SFrederic Weisbecker  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
54676ba94429SFrederic Weisbecker  * following attributes.
54686ba94429SFrederic Weisbecker  *
54696ba94429SFrederic Weisbecker  *  per_cpu	RO bool	: whether the workqueue is per-cpu or unbound
54706ba94429SFrederic Weisbecker  *  max_active	RW int	: maximum number of in-flight work items
54716ba94429SFrederic Weisbecker  *
54726ba94429SFrederic Weisbecker  * Unbound workqueues have the following extra attributes.
54736ba94429SFrederic Weisbecker  *
54749a19b463SWang Long  *  pool_ids	RO int	: the associated pool IDs for each node
54756ba94429SFrederic Weisbecker  *  nice	RW int	: nice value of the workers
54766ba94429SFrederic Weisbecker  *  cpumask	RW mask	: bitmask of allowed CPUs for the workers
54779a19b463SWang Long  *  numa	RW bool	: whether enable NUMA affinity
54786ba94429SFrederic Weisbecker  */
54796ba94429SFrederic Weisbecker struct wq_device {
54806ba94429SFrederic Weisbecker 	struct workqueue_struct		*wq;
54816ba94429SFrederic Weisbecker 	struct device			dev;
54826ba94429SFrederic Weisbecker };
54836ba94429SFrederic Weisbecker 
54846ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev)
54856ba94429SFrederic Weisbecker {
54866ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
54876ba94429SFrederic Weisbecker 
54886ba94429SFrederic Weisbecker 	return wq_dev->wq;
54896ba94429SFrederic Weisbecker }
54906ba94429SFrederic Weisbecker 
54916ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
54926ba94429SFrederic Weisbecker 			    char *buf)
54936ba94429SFrederic Weisbecker {
54946ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54956ba94429SFrederic Weisbecker 
54966ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
54976ba94429SFrederic Weisbecker }
54986ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu);
54996ba94429SFrederic Weisbecker 
55006ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev,
55016ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
55026ba94429SFrederic Weisbecker {
55036ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
55046ba94429SFrederic Weisbecker 
55056ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
55066ba94429SFrederic Weisbecker }
55076ba94429SFrederic Weisbecker 
55086ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev,
55096ba94429SFrederic Weisbecker 				struct device_attribute *attr, const char *buf,
55106ba94429SFrederic Weisbecker 				size_t count)
55116ba94429SFrederic Weisbecker {
55126ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
55136ba94429SFrederic Weisbecker 	int val;
55146ba94429SFrederic Weisbecker 
55156ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
55166ba94429SFrederic Weisbecker 		return -EINVAL;
55176ba94429SFrederic Weisbecker 
55186ba94429SFrederic Weisbecker 	workqueue_set_max_active(wq, val);
55196ba94429SFrederic Weisbecker 	return count;
55206ba94429SFrederic Weisbecker }
55216ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active);
55226ba94429SFrederic Weisbecker 
55236ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = {
55246ba94429SFrederic Weisbecker 	&dev_attr_per_cpu.attr,
55256ba94429SFrederic Weisbecker 	&dev_attr_max_active.attr,
55266ba94429SFrederic Weisbecker 	NULL,
55276ba94429SFrederic Weisbecker };
55286ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs);
55296ba94429SFrederic Weisbecker 
55306ba94429SFrederic Weisbecker static ssize_t wq_pool_ids_show(struct device *dev,
55316ba94429SFrederic Weisbecker 				struct device_attribute *attr, char *buf)
55326ba94429SFrederic Weisbecker {
55336ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
55346ba94429SFrederic Weisbecker 	const char *delim = "";
55356ba94429SFrederic Weisbecker 	int node, written = 0;
55366ba94429SFrederic Weisbecker 
5537ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
553824acfb71SThomas Gleixner 	rcu_read_lock();
55396ba94429SFrederic Weisbecker 	for_each_node(node) {
55406ba94429SFrederic Weisbecker 		written += scnprintf(buf + written, PAGE_SIZE - written,
55416ba94429SFrederic Weisbecker 				     "%s%d:%d", delim, node,
55426ba94429SFrederic Weisbecker 				     unbound_pwq_by_node(wq, node)->pool->id);
55436ba94429SFrederic Weisbecker 		delim = " ";
55446ba94429SFrederic Weisbecker 	}
55456ba94429SFrederic Weisbecker 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
554624acfb71SThomas Gleixner 	rcu_read_unlock();
5547ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
55486ba94429SFrederic Weisbecker 
55496ba94429SFrederic Weisbecker 	return written;
55506ba94429SFrederic Weisbecker }
55516ba94429SFrederic Weisbecker 
55526ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
55536ba94429SFrederic Weisbecker 			    char *buf)
55546ba94429SFrederic Weisbecker {
55556ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
55566ba94429SFrederic Weisbecker 	int written;
55576ba94429SFrederic Weisbecker 
55586ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
55596ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
55606ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
55616ba94429SFrederic Weisbecker 
55626ba94429SFrederic Weisbecker 	return written;
55636ba94429SFrederic Weisbecker }
55646ba94429SFrederic Weisbecker 
55656ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */
55666ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
55676ba94429SFrederic Weisbecker {
55686ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
55696ba94429SFrederic Weisbecker 
5570899a94feSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5571899a94feSLai Jiangshan 
5572be69d00dSThomas Gleixner 	attrs = alloc_workqueue_attrs();
55736ba94429SFrederic Weisbecker 	if (!attrs)
55746ba94429SFrederic Weisbecker 		return NULL;
55756ba94429SFrederic Weisbecker 
55766ba94429SFrederic Weisbecker 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
55776ba94429SFrederic Weisbecker 	return attrs;
55786ba94429SFrederic Weisbecker }
55796ba94429SFrederic Weisbecker 
55806ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
55816ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
55826ba94429SFrederic Weisbecker {
55836ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
55846ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5585d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
5586d4d3e257SLai Jiangshan 
5587d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
55886ba94429SFrederic Weisbecker 
55896ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
55906ba94429SFrederic Weisbecker 	if (!attrs)
5591d4d3e257SLai Jiangshan 		goto out_unlock;
55926ba94429SFrederic Weisbecker 
55936ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
55946ba94429SFrederic Weisbecker 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
5595d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
55966ba94429SFrederic Weisbecker 	else
55976ba94429SFrederic Weisbecker 		ret = -EINVAL;
55986ba94429SFrederic Weisbecker 
5599d4d3e257SLai Jiangshan out_unlock:
5600d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
56016ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
56026ba94429SFrederic Weisbecker 	return ret ?: count;
56036ba94429SFrederic Weisbecker }
56046ba94429SFrederic Weisbecker 
56056ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev,
56066ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
56076ba94429SFrederic Weisbecker {
56086ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
56096ba94429SFrederic Weisbecker 	int written;
56106ba94429SFrederic Weisbecker 
56116ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
56126ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
56136ba94429SFrederic Weisbecker 			    cpumask_pr_args(wq->unbound_attrs->cpumask));
56146ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
56156ba94429SFrederic Weisbecker 	return written;
56166ba94429SFrederic Weisbecker }
56176ba94429SFrederic Weisbecker 
56186ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev,
56196ba94429SFrederic Weisbecker 				struct device_attribute *attr,
56206ba94429SFrederic Weisbecker 				const char *buf, size_t count)
56216ba94429SFrederic Weisbecker {
56226ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
56236ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5624d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
5625d4d3e257SLai Jiangshan 
5626d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
56276ba94429SFrederic Weisbecker 
56286ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
56296ba94429SFrederic Weisbecker 	if (!attrs)
5630d4d3e257SLai Jiangshan 		goto out_unlock;
56316ba94429SFrederic Weisbecker 
56326ba94429SFrederic Weisbecker 	ret = cpumask_parse(buf, attrs->cpumask);
56336ba94429SFrederic Weisbecker 	if (!ret)
5634d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
56356ba94429SFrederic Weisbecker 
5636d4d3e257SLai Jiangshan out_unlock:
5637d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
56386ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
56396ba94429SFrederic Weisbecker 	return ret ?: count;
56406ba94429SFrederic Weisbecker }
56416ba94429SFrederic Weisbecker 
56426ba94429SFrederic Weisbecker static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
56436ba94429SFrederic Weisbecker 			    char *buf)
56446ba94429SFrederic Weisbecker {
56456ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
56466ba94429SFrederic Weisbecker 	int written;
56476ba94429SFrederic Weisbecker 
56486ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
56496ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n",
56506ba94429SFrederic Weisbecker 			    !wq->unbound_attrs->no_numa);
56516ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
56526ba94429SFrederic Weisbecker 
56536ba94429SFrederic Weisbecker 	return written;
56546ba94429SFrederic Weisbecker }
56556ba94429SFrederic Weisbecker 
56566ba94429SFrederic Weisbecker static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
56576ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
56586ba94429SFrederic Weisbecker {
56596ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
56606ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5661d4d3e257SLai Jiangshan 	int v, ret = -ENOMEM;
5662d4d3e257SLai Jiangshan 
5663d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
56646ba94429SFrederic Weisbecker 
56656ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
56666ba94429SFrederic Weisbecker 	if (!attrs)
5667d4d3e257SLai Jiangshan 		goto out_unlock;
56686ba94429SFrederic Weisbecker 
56696ba94429SFrederic Weisbecker 	ret = -EINVAL;
56706ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &v) == 1) {
56716ba94429SFrederic Weisbecker 		attrs->no_numa = !v;
5672d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
56736ba94429SFrederic Weisbecker 	}
56746ba94429SFrederic Weisbecker 
5675d4d3e257SLai Jiangshan out_unlock:
5676d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
56776ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
56786ba94429SFrederic Weisbecker 	return ret ?: count;
56796ba94429SFrederic Weisbecker }
56806ba94429SFrederic Weisbecker 
56816ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = {
56826ba94429SFrederic Weisbecker 	__ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
56836ba94429SFrederic Weisbecker 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
56846ba94429SFrederic Weisbecker 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
56856ba94429SFrederic Weisbecker 	__ATTR(numa, 0644, wq_numa_show, wq_numa_store),
56866ba94429SFrederic Weisbecker 	__ATTR_NULL,
56876ba94429SFrederic Weisbecker };
56886ba94429SFrederic Weisbecker 
56896ba94429SFrederic Weisbecker static struct bus_type wq_subsys = {
56906ba94429SFrederic Weisbecker 	.name				= "workqueue",
56916ba94429SFrederic Weisbecker 	.dev_groups			= wq_sysfs_groups,
56926ba94429SFrederic Weisbecker };
56936ba94429SFrederic Weisbecker 
5694b05a7928SFrederic Weisbecker static ssize_t wq_unbound_cpumask_show(struct device *dev,
5695b05a7928SFrederic Weisbecker 		struct device_attribute *attr, char *buf)
5696b05a7928SFrederic Weisbecker {
5697b05a7928SFrederic Weisbecker 	int written;
5698b05a7928SFrederic Weisbecker 
5699042f7df1SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5700b05a7928SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5701b05a7928SFrederic Weisbecker 			    cpumask_pr_args(wq_unbound_cpumask));
5702042f7df1SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5703b05a7928SFrederic Weisbecker 
5704b05a7928SFrederic Weisbecker 	return written;
5705b05a7928SFrederic Weisbecker }
5706b05a7928SFrederic Weisbecker 
5707042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev,
5708042f7df1SLai Jiangshan 		struct device_attribute *attr, const char *buf, size_t count)
5709042f7df1SLai Jiangshan {
5710042f7df1SLai Jiangshan 	cpumask_var_t cpumask;
5711042f7df1SLai Jiangshan 	int ret;
5712042f7df1SLai Jiangshan 
5713042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5714042f7df1SLai Jiangshan 		return -ENOMEM;
5715042f7df1SLai Jiangshan 
5716042f7df1SLai Jiangshan 	ret = cpumask_parse(buf, cpumask);
5717042f7df1SLai Jiangshan 	if (!ret)
5718042f7df1SLai Jiangshan 		ret = workqueue_set_unbound_cpumask(cpumask);
5719042f7df1SLai Jiangshan 
5720042f7df1SLai Jiangshan 	free_cpumask_var(cpumask);
5721042f7df1SLai Jiangshan 	return ret ? ret : count;
5722042f7df1SLai Jiangshan }
5723042f7df1SLai Jiangshan 
5724b05a7928SFrederic Weisbecker static struct device_attribute wq_sysfs_cpumask_attr =
5725042f7df1SLai Jiangshan 	__ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5726042f7df1SLai Jiangshan 	       wq_unbound_cpumask_store);
5727b05a7928SFrederic Weisbecker 
57286ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void)
57296ba94429SFrederic Weisbecker {
5730b05a7928SFrederic Weisbecker 	int err;
5731b05a7928SFrederic Weisbecker 
5732b05a7928SFrederic Weisbecker 	err = subsys_virtual_register(&wq_subsys, NULL);
5733b05a7928SFrederic Weisbecker 	if (err)
5734b05a7928SFrederic Weisbecker 		return err;
5735b05a7928SFrederic Weisbecker 
5736b05a7928SFrederic Weisbecker 	return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
57376ba94429SFrederic Weisbecker }
57386ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init);
57396ba94429SFrederic Weisbecker 
57406ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev)
57416ba94429SFrederic Weisbecker {
57426ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
57436ba94429SFrederic Weisbecker 
57446ba94429SFrederic Weisbecker 	kfree(wq_dev);
57456ba94429SFrederic Weisbecker }
57466ba94429SFrederic Weisbecker 
57476ba94429SFrederic Weisbecker /**
57486ba94429SFrederic Weisbecker  * workqueue_sysfs_register - make a workqueue visible in sysfs
57496ba94429SFrederic Weisbecker  * @wq: the workqueue to register
57506ba94429SFrederic Weisbecker  *
57516ba94429SFrederic Weisbecker  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
57526ba94429SFrederic Weisbecker  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
57536ba94429SFrederic Weisbecker  * which is the preferred method.
57546ba94429SFrederic Weisbecker  *
57556ba94429SFrederic Weisbecker  * Workqueue user should use this function directly iff it wants to apply
57566ba94429SFrederic Weisbecker  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
57576ba94429SFrederic Weisbecker  * apply_workqueue_attrs() may race against userland updating the
57586ba94429SFrederic Weisbecker  * attributes.
57596ba94429SFrederic Weisbecker  *
57606ba94429SFrederic Weisbecker  * Return: 0 on success, -errno on failure.
57616ba94429SFrederic Weisbecker  */
57626ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq)
57636ba94429SFrederic Weisbecker {
57646ba94429SFrederic Weisbecker 	struct wq_device *wq_dev;
57656ba94429SFrederic Weisbecker 	int ret;
57666ba94429SFrederic Weisbecker 
57676ba94429SFrederic Weisbecker 	/*
5768402dd89dSShailendra Verma 	 * Adjusting max_active or creating new pwqs by applying
57696ba94429SFrederic Weisbecker 	 * attributes breaks ordering guarantee.  Disallow exposing ordered
57706ba94429SFrederic Weisbecker 	 * workqueues.
57716ba94429SFrederic Weisbecker 	 */
57720a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
57736ba94429SFrederic Weisbecker 		return -EINVAL;
57746ba94429SFrederic Weisbecker 
57756ba94429SFrederic Weisbecker 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
57766ba94429SFrederic Weisbecker 	if (!wq_dev)
57776ba94429SFrederic Weisbecker 		return -ENOMEM;
57786ba94429SFrederic Weisbecker 
57796ba94429SFrederic Weisbecker 	wq_dev->wq = wq;
57806ba94429SFrederic Weisbecker 	wq_dev->dev.bus = &wq_subsys;
57816ba94429SFrederic Weisbecker 	wq_dev->dev.release = wq_device_release;
578223217b44SLars-Peter Clausen 	dev_set_name(&wq_dev->dev, "%s", wq->name);
57836ba94429SFrederic Weisbecker 
57846ba94429SFrederic Weisbecker 	/*
57856ba94429SFrederic Weisbecker 	 * unbound_attrs are created separately.  Suppress uevent until
57866ba94429SFrederic Weisbecker 	 * everything is ready.
57876ba94429SFrederic Weisbecker 	 */
57886ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, true);
57896ba94429SFrederic Weisbecker 
57906ba94429SFrederic Weisbecker 	ret = device_register(&wq_dev->dev);
57916ba94429SFrederic Weisbecker 	if (ret) {
5792537f4146SArvind Yadav 		put_device(&wq_dev->dev);
57936ba94429SFrederic Weisbecker 		wq->wq_dev = NULL;
57946ba94429SFrederic Weisbecker 		return ret;
57956ba94429SFrederic Weisbecker 	}
57966ba94429SFrederic Weisbecker 
57976ba94429SFrederic Weisbecker 	if (wq->flags & WQ_UNBOUND) {
57986ba94429SFrederic Weisbecker 		struct device_attribute *attr;
57996ba94429SFrederic Weisbecker 
58006ba94429SFrederic Weisbecker 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
58016ba94429SFrederic Weisbecker 			ret = device_create_file(&wq_dev->dev, attr);
58026ba94429SFrederic Weisbecker 			if (ret) {
58036ba94429SFrederic Weisbecker 				device_unregister(&wq_dev->dev);
58046ba94429SFrederic Weisbecker 				wq->wq_dev = NULL;
58056ba94429SFrederic Weisbecker 				return ret;
58066ba94429SFrederic Weisbecker 			}
58076ba94429SFrederic Weisbecker 		}
58086ba94429SFrederic Weisbecker 	}
58096ba94429SFrederic Weisbecker 
58106ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, false);
58116ba94429SFrederic Weisbecker 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
58126ba94429SFrederic Weisbecker 	return 0;
58136ba94429SFrederic Weisbecker }
58146ba94429SFrederic Weisbecker 
58156ba94429SFrederic Weisbecker /**
58166ba94429SFrederic Weisbecker  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
58176ba94429SFrederic Weisbecker  * @wq: the workqueue to unregister
58186ba94429SFrederic Weisbecker  *
58196ba94429SFrederic Weisbecker  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
58206ba94429SFrederic Weisbecker  */
58216ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
58226ba94429SFrederic Weisbecker {
58236ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = wq->wq_dev;
58246ba94429SFrederic Weisbecker 
58256ba94429SFrederic Weisbecker 	if (!wq->wq_dev)
58266ba94429SFrederic Weisbecker 		return;
58276ba94429SFrederic Weisbecker 
58286ba94429SFrederic Weisbecker 	wq->wq_dev = NULL;
58296ba94429SFrederic Weisbecker 	device_unregister(&wq_dev->dev);
58306ba94429SFrederic Weisbecker }
58316ba94429SFrederic Weisbecker #else	/* CONFIG_SYSFS */
58326ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
58336ba94429SFrederic Weisbecker #endif	/* CONFIG_SYSFS */
58346ba94429SFrederic Weisbecker 
583582607adcSTejun Heo /*
583682607adcSTejun Heo  * Workqueue watchdog.
583782607adcSTejun Heo  *
583882607adcSTejun Heo  * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
583982607adcSTejun Heo  * flush dependency, a concurrency managed work item which stays RUNNING
584082607adcSTejun Heo  * indefinitely.  Workqueue stalls can be very difficult to debug as the
584182607adcSTejun Heo  * usual warning mechanisms don't trigger and internal workqueue state is
584282607adcSTejun Heo  * largely opaque.
584382607adcSTejun Heo  *
584482607adcSTejun Heo  * Workqueue watchdog monitors all worker pools periodically and dumps
584582607adcSTejun Heo  * state if some pools failed to make forward progress for a while where
584682607adcSTejun Heo  * forward progress is defined as the first item on ->worklist changing.
584782607adcSTejun Heo  *
584882607adcSTejun Heo  * This mechanism is controlled through the kernel parameter
584982607adcSTejun Heo  * "workqueue.watchdog_thresh" which can be updated at runtime through the
585082607adcSTejun Heo  * corresponding sysfs parameter file.
585182607adcSTejun Heo  */
585282607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG
585382607adcSTejun Heo 
585482607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30;
58555cd79d6aSKees Cook static struct timer_list wq_watchdog_timer;
585682607adcSTejun Heo 
585782607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
585882607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
585982607adcSTejun Heo 
586082607adcSTejun Heo static void wq_watchdog_reset_touched(void)
586182607adcSTejun Heo {
586282607adcSTejun Heo 	int cpu;
586382607adcSTejun Heo 
586482607adcSTejun Heo 	wq_watchdog_touched = jiffies;
586582607adcSTejun Heo 	for_each_possible_cpu(cpu)
586682607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
586782607adcSTejun Heo }
586882607adcSTejun Heo 
58695cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused)
587082607adcSTejun Heo {
587182607adcSTejun Heo 	unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
587282607adcSTejun Heo 	bool lockup_detected = false;
5873940d71c6SSergey Senozhatsky 	unsigned long now = jiffies;
587482607adcSTejun Heo 	struct worker_pool *pool;
587582607adcSTejun Heo 	int pi;
587682607adcSTejun Heo 
587782607adcSTejun Heo 	if (!thresh)
587882607adcSTejun Heo 		return;
587982607adcSTejun Heo 
588082607adcSTejun Heo 	rcu_read_lock();
588182607adcSTejun Heo 
588282607adcSTejun Heo 	for_each_pool(pool, pi) {
588382607adcSTejun Heo 		unsigned long pool_ts, touched, ts;
588482607adcSTejun Heo 
588582607adcSTejun Heo 		if (list_empty(&pool->worklist))
588682607adcSTejun Heo 			continue;
588782607adcSTejun Heo 
5888940d71c6SSergey Senozhatsky 		/*
5889940d71c6SSergey Senozhatsky 		 * If a virtual machine is stopped by the host it can look to
5890940d71c6SSergey Senozhatsky 		 * the watchdog like a stall.
5891940d71c6SSergey Senozhatsky 		 */
5892940d71c6SSergey Senozhatsky 		kvm_check_and_clear_guest_paused();
5893940d71c6SSergey Senozhatsky 
589482607adcSTejun Heo 		/* get the latest of pool and touched timestamps */
589589e28ce6SWang Qing 		if (pool->cpu >= 0)
589689e28ce6SWang Qing 			touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
589789e28ce6SWang Qing 		else
589882607adcSTejun Heo 			touched = READ_ONCE(wq_watchdog_touched);
589989e28ce6SWang Qing 		pool_ts = READ_ONCE(pool->watchdog_ts);
590082607adcSTejun Heo 
590182607adcSTejun Heo 		if (time_after(pool_ts, touched))
590282607adcSTejun Heo 			ts = pool_ts;
590382607adcSTejun Heo 		else
590482607adcSTejun Heo 			ts = touched;
590582607adcSTejun Heo 
590682607adcSTejun Heo 		/* did we stall? */
5907940d71c6SSergey Senozhatsky 		if (time_after(now, ts + thresh)) {
590882607adcSTejun Heo 			lockup_detected = true;
590982607adcSTejun Heo 			pr_emerg("BUG: workqueue lockup - pool");
591082607adcSTejun Heo 			pr_cont_pool_info(pool);
591182607adcSTejun Heo 			pr_cont(" stuck for %us!\n",
5912940d71c6SSergey Senozhatsky 				jiffies_to_msecs(now - pool_ts) / 1000);
591382607adcSTejun Heo 		}
591482607adcSTejun Heo 	}
591582607adcSTejun Heo 
591682607adcSTejun Heo 	rcu_read_unlock();
591782607adcSTejun Heo 
591882607adcSTejun Heo 	if (lockup_detected)
591955df0933SImran Khan 		show_all_workqueues();
592082607adcSTejun Heo 
592182607adcSTejun Heo 	wq_watchdog_reset_touched();
592282607adcSTejun Heo 	mod_timer(&wq_watchdog_timer, jiffies + thresh);
592382607adcSTejun Heo }
592482607adcSTejun Heo 
5925cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu)
592682607adcSTejun Heo {
592782607adcSTejun Heo 	if (cpu >= 0)
592882607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
592989e28ce6SWang Qing 
593082607adcSTejun Heo 	wq_watchdog_touched = jiffies;
593182607adcSTejun Heo }
593282607adcSTejun Heo 
593382607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh)
593482607adcSTejun Heo {
593582607adcSTejun Heo 	wq_watchdog_thresh = 0;
593682607adcSTejun Heo 	del_timer_sync(&wq_watchdog_timer);
593782607adcSTejun Heo 
593882607adcSTejun Heo 	if (thresh) {
593982607adcSTejun Heo 		wq_watchdog_thresh = thresh;
594082607adcSTejun Heo 		wq_watchdog_reset_touched();
594182607adcSTejun Heo 		mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
594282607adcSTejun Heo 	}
594382607adcSTejun Heo }
594482607adcSTejun Heo 
594582607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val,
594682607adcSTejun Heo 					const struct kernel_param *kp)
594782607adcSTejun Heo {
594882607adcSTejun Heo 	unsigned long thresh;
594982607adcSTejun Heo 	int ret;
595082607adcSTejun Heo 
595182607adcSTejun Heo 	ret = kstrtoul(val, 0, &thresh);
595282607adcSTejun Heo 	if (ret)
595382607adcSTejun Heo 		return ret;
595482607adcSTejun Heo 
595582607adcSTejun Heo 	if (system_wq)
595682607adcSTejun Heo 		wq_watchdog_set_thresh(thresh);
595782607adcSTejun Heo 	else
595882607adcSTejun Heo 		wq_watchdog_thresh = thresh;
595982607adcSTejun Heo 
596082607adcSTejun Heo 	return 0;
596182607adcSTejun Heo }
596282607adcSTejun Heo 
596382607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = {
596482607adcSTejun Heo 	.set	= wq_watchdog_param_set_thresh,
596582607adcSTejun Heo 	.get	= param_get_ulong,
596682607adcSTejun Heo };
596782607adcSTejun Heo 
596882607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
596982607adcSTejun Heo 		0644);
597082607adcSTejun Heo 
597182607adcSTejun Heo static void wq_watchdog_init(void)
597282607adcSTejun Heo {
59735cd79d6aSKees Cook 	timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
597482607adcSTejun Heo 	wq_watchdog_set_thresh(wq_watchdog_thresh);
597582607adcSTejun Heo }
597682607adcSTejun Heo 
597782607adcSTejun Heo #else	/* CONFIG_WQ_WATCHDOG */
597882607adcSTejun Heo 
597982607adcSTejun Heo static inline void wq_watchdog_init(void) { }
598082607adcSTejun Heo 
598182607adcSTejun Heo #endif	/* CONFIG_WQ_WATCHDOG */
598282607adcSTejun Heo 
5983bce90380STejun Heo static void __init wq_numa_init(void)
5984bce90380STejun Heo {
5985bce90380STejun Heo 	cpumask_var_t *tbl;
5986bce90380STejun Heo 	int node, cpu;
5987bce90380STejun Heo 
5988bce90380STejun Heo 	if (num_possible_nodes() <= 1)
5989bce90380STejun Heo 		return;
5990bce90380STejun Heo 
5991d55262c4STejun Heo 	if (wq_disable_numa) {
5992d55262c4STejun Heo 		pr_info("workqueue: NUMA affinity support disabled\n");
5993d55262c4STejun Heo 		return;
5994d55262c4STejun Heo 	}
5995d55262c4STejun Heo 
5996f728c4a9SZhen Lei 	for_each_possible_cpu(cpu) {
5997f728c4a9SZhen Lei 		if (WARN_ON(cpu_to_node(cpu) == NUMA_NO_NODE)) {
5998f728c4a9SZhen Lei 			pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5999f728c4a9SZhen Lei 			return;
6000f728c4a9SZhen Lei 		}
6001f728c4a9SZhen Lei 	}
6002f728c4a9SZhen Lei 
6003be69d00dSThomas Gleixner 	wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs();
60044c16bd32STejun Heo 	BUG_ON(!wq_update_unbound_numa_attrs_buf);
60054c16bd32STejun Heo 
6006bce90380STejun Heo 	/*
6007bce90380STejun Heo 	 * We want masks of possible CPUs of each node which isn't readily
6008bce90380STejun Heo 	 * available.  Build one from cpu_to_node() which should have been
6009bce90380STejun Heo 	 * fully initialized by now.
6010bce90380STejun Heo 	 */
60116396bb22SKees Cook 	tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
6012bce90380STejun Heo 	BUG_ON(!tbl);
6013bce90380STejun Heo 
6014bce90380STejun Heo 	for_each_node(node)
60155a6024f1SYasuaki Ishimatsu 		BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
60161be0c25dSTejun Heo 				node_online(node) ? node : NUMA_NO_NODE));
6017bce90380STejun Heo 
6018bce90380STejun Heo 	for_each_possible_cpu(cpu) {
6019bce90380STejun Heo 		node = cpu_to_node(cpu);
6020bce90380STejun Heo 		cpumask_set_cpu(cpu, tbl[node]);
6021bce90380STejun Heo 	}
6022bce90380STejun Heo 
6023bce90380STejun Heo 	wq_numa_possible_cpumask = tbl;
6024bce90380STejun Heo 	wq_numa_enabled = true;
6025bce90380STejun Heo }
6026bce90380STejun Heo 
60273347fa09STejun Heo /**
60283347fa09STejun Heo  * workqueue_init_early - early init for workqueue subsystem
60293347fa09STejun Heo  *
60303347fa09STejun Heo  * This is the first half of two-staged workqueue subsystem initialization
60313347fa09STejun Heo  * and invoked as soon as the bare basics - memory allocation, cpumasks and
60323347fa09STejun Heo  * idr are up.  It sets up all the data structures and system workqueues
60333347fa09STejun Heo  * and allows early boot code to create workqueues and queue/cancel work
60343347fa09STejun Heo  * items.  Actual work item execution starts only after kthreads can be
60353347fa09STejun Heo  * created and scheduled right before early initcalls.
60363347fa09STejun Heo  */
60372333e829SYu Chen void __init workqueue_init_early(void)
60381da177e4SLinus Torvalds {
60397a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
60401bda3f80SFrederic Weisbecker 	int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
60417a4e344cSTejun Heo 	int i, cpu;
6042c34056a3STejun Heo 
604310cdb157SLai Jiangshan 	BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
6044e904e6c2STejun Heo 
6045b05a7928SFrederic Weisbecker 	BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
60461bda3f80SFrederic Weisbecker 	cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
6047b05a7928SFrederic Weisbecker 
6048e904e6c2STejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
6049e904e6c2STejun Heo 
6050706026c2STejun Heo 	/* initialize CPU pools */
605129c91e99STejun Heo 	for_each_possible_cpu(cpu) {
60524ce62e9eSTejun Heo 		struct worker_pool *pool;
60538b03ae3cSTejun Heo 
60547a4e344cSTejun Heo 		i = 0;
6055f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
60567a4e344cSTejun Heo 			BUG_ON(init_worker_pool(pool));
6057ec22ca5eSTejun Heo 			pool->cpu = cpu;
60587a4e344cSTejun Heo 			cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
60597a4e344cSTejun Heo 			pool->attrs->nice = std_nice[i++];
6060f3f90ad4STejun Heo 			pool->node = cpu_to_node(cpu);
60617a4e344cSTejun Heo 
60629daf9e67STejun Heo 			/* alloc pool ID */
606368e13a67SLai Jiangshan 			mutex_lock(&wq_pool_mutex);
60649daf9e67STejun Heo 			BUG_ON(worker_pool_assign_id(pool));
606568e13a67SLai Jiangshan 			mutex_unlock(&wq_pool_mutex);
60664ce62e9eSTejun Heo 		}
60678b03ae3cSTejun Heo 	}
60688b03ae3cSTejun Heo 
60698a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
607029c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
607129c91e99STejun Heo 		struct workqueue_attrs *attrs;
607229c91e99STejun Heo 
6073be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
607429c91e99STejun Heo 		attrs->nice = std_nice[i];
607529c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
60768a2b7538STejun Heo 
60778a2b7538STejun Heo 		/*
60788a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
60798a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
60808a2b7538STejun Heo 		 * Turn off NUMA so that dfl_pwq is used for all nodes.
60818a2b7538STejun Heo 		 */
6082be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
60838a2b7538STejun Heo 		attrs->nice = std_nice[i];
60848a2b7538STejun Heo 		attrs->no_numa = true;
60858a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
608629c91e99STejun Heo 	}
608729c91e99STejun Heo 
6088d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
60891aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
6090d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
6091f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
6092f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
609324d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
609424d51addSTejun Heo 					      WQ_FREEZABLE, 0);
60950668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
60960668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
60970668106cSViresh Kumar 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
60980668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
60990668106cSViresh Kumar 					      0);
61001aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
61010668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
61020668106cSViresh Kumar 	       !system_power_efficient_wq ||
61030668106cSViresh Kumar 	       !system_freezable_power_efficient_wq);
61043347fa09STejun Heo }
61053347fa09STejun Heo 
61063347fa09STejun Heo /**
61073347fa09STejun Heo  * workqueue_init - bring workqueue subsystem fully online
61083347fa09STejun Heo  *
61093347fa09STejun Heo  * This is the latter half of two-staged workqueue subsystem initialization
61103347fa09STejun Heo  * and invoked as soon as kthreads can be created and scheduled.
61113347fa09STejun Heo  * Workqueues have been created and work items queued on them, but there
61123347fa09STejun Heo  * are no kworkers executing the work items yet.  Populate the worker pools
61133347fa09STejun Heo  * with the initial workers and enable future kworker creations.
61143347fa09STejun Heo  */
61152333e829SYu Chen void __init workqueue_init(void)
61163347fa09STejun Heo {
61172186d9f9STejun Heo 	struct workqueue_struct *wq;
61183347fa09STejun Heo 	struct worker_pool *pool;
61193347fa09STejun Heo 	int cpu, bkt;
61203347fa09STejun Heo 
61212186d9f9STejun Heo 	/*
61222186d9f9STejun Heo 	 * It'd be simpler to initialize NUMA in workqueue_init_early() but
61232186d9f9STejun Heo 	 * CPU to node mapping may not be available that early on some
61242186d9f9STejun Heo 	 * archs such as power and arm64.  As per-cpu pools created
61252186d9f9STejun Heo 	 * previously could be missing node hint and unbound pools NUMA
61262186d9f9STejun Heo 	 * affinity, fix them up.
612740c17f75STejun Heo 	 *
612840c17f75STejun Heo 	 * Also, while iterating workqueues, create rescuers if requested.
61292186d9f9STejun Heo 	 */
61302186d9f9STejun Heo 	wq_numa_init();
61312186d9f9STejun Heo 
61322186d9f9STejun Heo 	mutex_lock(&wq_pool_mutex);
61332186d9f9STejun Heo 
61342186d9f9STejun Heo 	for_each_possible_cpu(cpu) {
61352186d9f9STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
61362186d9f9STejun Heo 			pool->node = cpu_to_node(cpu);
61372186d9f9STejun Heo 		}
61382186d9f9STejun Heo 	}
61392186d9f9STejun Heo 
614040c17f75STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
61412186d9f9STejun Heo 		wq_update_unbound_numa(wq, smp_processor_id(), true);
614240c17f75STejun Heo 		WARN(init_rescuer(wq),
614340c17f75STejun Heo 		     "workqueue: failed to create early rescuer for %s",
614440c17f75STejun Heo 		     wq->name);
614540c17f75STejun Heo 	}
61462186d9f9STejun Heo 
61472186d9f9STejun Heo 	mutex_unlock(&wq_pool_mutex);
61482186d9f9STejun Heo 
61493347fa09STejun Heo 	/* create the initial workers */
61503347fa09STejun Heo 	for_each_online_cpu(cpu) {
61513347fa09STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
61523347fa09STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
61533347fa09STejun Heo 			BUG_ON(!create_worker(pool));
61543347fa09STejun Heo 		}
61553347fa09STejun Heo 	}
61563347fa09STejun Heo 
61573347fa09STejun Heo 	hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
61583347fa09STejun Heo 		BUG_ON(!create_worker(pool));
61593347fa09STejun Heo 
61603347fa09STejun Heo 	wq_online = true;
616182607adcSTejun Heo 	wq_watchdog_init();
61621da177e4SLinus Torvalds }
6163