xref: /linux-6.15/kernel/workqueue.c (revision 7cda9aae)
11da177e4SLinus Torvalds /*
2c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
31da177e4SLinus Torvalds  *
4c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
51da177e4SLinus Torvalds  *
61da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
71da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
8e1f8e874SFrancois Cami  *     Andrew Morton
91da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
101da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1189ada679SChristoph Lameter  *
12cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
13c54fce6eSTejun Heo  *
14c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
15c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
16c54fce6eSTejun Heo  *
17c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
18c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
19b11895c4SLibin  * automatically managed.  There are two worker pools for each CPU (one for
20b11895c4SLibin  * normal work items and the other for high priority ones) and some extra
21b11895c4SLibin  * pools for workqueues which are not bound to any specific CPU - the
22b11895c4SLibin  * number of these backing pools is dynamic.
23c54fce6eSTejun Heo  *
24c54fce6eSTejun Heo  * Please read Documentation/workqueue.txt for details.
251da177e4SLinus Torvalds  */
261da177e4SLinus Torvalds 
279984de1aSPaul Gortmaker #include <linux/export.h>
281da177e4SLinus Torvalds #include <linux/kernel.h>
291da177e4SLinus Torvalds #include <linux/sched.h>
301da177e4SLinus Torvalds #include <linux/init.h>
311da177e4SLinus Torvalds #include <linux/signal.h>
321da177e4SLinus Torvalds #include <linux/completion.h>
331da177e4SLinus Torvalds #include <linux/workqueue.h>
341da177e4SLinus Torvalds #include <linux/slab.h>
351da177e4SLinus Torvalds #include <linux/cpu.h>
361da177e4SLinus Torvalds #include <linux/notifier.h>
371da177e4SLinus Torvalds #include <linux/kthread.h>
381fa44ecaSJames Bottomley #include <linux/hardirq.h>
3946934023SChristoph Lameter #include <linux/mempolicy.h>
40341a5958SRafael J. Wysocki #include <linux/freezer.h>
41d5abe669SPeter Zijlstra #include <linux/kallsyms.h>
42d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
434e6045f1SJohannes Berg #include <linux/lockdep.h>
44c34056a3STejun Heo #include <linux/idr.h>
4529c91e99STejun Heo #include <linux/jhash.h>
4642f8570fSSasha Levin #include <linux/hashtable.h>
4776af4d93STejun Heo #include <linux/rculist.h>
48bce90380STejun Heo #include <linux/nodemask.h>
494c16bd32STejun Heo #include <linux/moduleparam.h>
503d1cb205STejun Heo #include <linux/uaccess.h>
51e22bee78STejun Heo 
52ea138446STejun Heo #include "workqueue_internal.h"
531da177e4SLinus Torvalds 
54c8e55f36STejun Heo enum {
55bc2ae0f5STejun Heo 	/*
5624647570STejun Heo 	 * worker_pool flags
57bc2ae0f5STejun Heo 	 *
5824647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
59bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
60bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
61bc2ae0f5STejun Heo 	 * is in effect.
62bc2ae0f5STejun Heo 	 *
63bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
64bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
6524647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
66bc2ae0f5STejun Heo 	 *
67bc3a1afcSTejun Heo 	 * Note that DISASSOCIATED should be flipped only while holding
68bc3a1afcSTejun Heo 	 * manager_mutex to avoid changing binding state while
6924647570STejun Heo 	 * create_worker() is in progress.
70bc2ae0f5STejun Heo 	 */
7124647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
7235b6bb63STejun Heo 	POOL_FREEZING		= 1 << 3,	/* freeze in progress */
73db7bccf4STejun Heo 
74c8e55f36STejun Heo 	/* worker flags */
75c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
76c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
77e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
78fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
79f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
80a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
81e22bee78STejun Heo 
82a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
83a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
84db7bccf4STejun Heo 
85e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
864ce62e9eSTejun Heo 
8729c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
88c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
89db7bccf4STejun Heo 
90e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
91e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
92e22bee78STejun Heo 
933233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
943233cdbdSTejun Heo 						/* call for help after 10ms
953233cdbdSTejun Heo 						   (min two ticks) */
96e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
97e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
981da177e4SLinus Torvalds 
991da177e4SLinus Torvalds 	/*
100e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
101e22bee78STejun Heo 	 * all cpus.  Give -20.
102e22bee78STejun Heo 	 */
103e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
1043270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
105ecf6881fSTejun Heo 
106ecf6881fSTejun Heo 	WQ_NAME_LEN		= 24,
107c8e55f36STejun Heo };
108c8e55f36STejun Heo 
1091da177e4SLinus Torvalds /*
1104690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1114690c4abSTejun Heo  *
112e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
113e41e704bSTejun Heo  *    everyone else.
1144690c4abSTejun Heo  *
115e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
116e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
117e22bee78STejun Heo  *
118d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1194690c4abSTejun Heo  *
120d565ed63STejun Heo  * X: During normal operation, modification requires pool->lock and should
121d565ed63STejun Heo  *    be done only from local cpu.  Either disabling preemption on local
122d565ed63STejun Heo  *    cpu or grabbing pool->lock is enough for read access.  If
123d565ed63STejun Heo  *    POOL_DISASSOCIATED is set, it's identical to L.
124e22bee78STejun Heo  *
1259625ab17SLai Jiangshan  * M: pool->manager_mutex protected.
126822d8405STejun Heo  *
12768e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
12876af4d93STejun Heo  *
12968e13a67SLai Jiangshan  * PR: wq_pool_mutex protected for writes.  Sched-RCU protected for reads.
1305bcab335STejun Heo  *
1313c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1323c25a55dSLai Jiangshan  *
133b5927605SLai Jiangshan  * WR: wq->mutex protected for writes.  Sched-RCU protected for reads.
1342e109a28STejun Heo  *
1352e109a28STejun Heo  * MD: wq_mayday_lock protected.
1364690c4abSTejun Heo  */
1374690c4abSTejun Heo 
1382eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
139c34056a3STejun Heo 
140bd7bdd43STejun Heo struct worker_pool {
141d565ed63STejun Heo 	spinlock_t		lock;		/* the pool lock */
142d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
143f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1449daf9e67STejun Heo 	int			id;		/* I: pool ID */
14511ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
146bd7bdd43STejun Heo 
147bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
148bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
149ea1abd61SLai Jiangshan 
150ea1abd61SLai Jiangshan 	/* nr_idle includes the ones off idle_list for rebinding */
151bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
152bd7bdd43STejun Heo 
153bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
154bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
155bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
156bd7bdd43STejun Heo 
157c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
158c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
159c9e7cf27STejun Heo 						/* L: hash of busy workers */
160c9e7cf27STejun Heo 
161bc3a1afcSTejun Heo 	/* see manage_workers() for details on the two manager mutexes */
16234a06bd6STejun Heo 	struct mutex		manager_arb;	/* manager arbitration */
163bc3a1afcSTejun Heo 	struct mutex		manager_mutex;	/* manager exclusion */
164da028469SLai Jiangshan 	struct list_head	workers;	/* M: attached workers */
16560f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
166e19e397aSTejun Heo 
167*7cda9aaeSLai Jiangshan 	struct ida		worker_ida;	/* worker IDs for task name */
168*7cda9aaeSLai Jiangshan 
1697a4e344cSTejun Heo 	struct workqueue_attrs	*attrs;		/* I: worker attributes */
17068e13a67SLai Jiangshan 	struct hlist_node	hash_node;	/* PL: unbound_pool_hash node */
17168e13a67SLai Jiangshan 	int			refcnt;		/* PL: refcnt for unbound pools */
1727a4e344cSTejun Heo 
173e19e397aSTejun Heo 	/*
174e19e397aSTejun Heo 	 * The current concurrency level.  As it's likely to be accessed
175e19e397aSTejun Heo 	 * from other CPUs during try_to_wake_up(), put it in a separate
176e19e397aSTejun Heo 	 * cacheline.
177e19e397aSTejun Heo 	 */
178e19e397aSTejun Heo 	atomic_t		nr_running ____cacheline_aligned_in_smp;
17929c91e99STejun Heo 
18029c91e99STejun Heo 	/*
18129c91e99STejun Heo 	 * Destruction of pool is sched-RCU protected to allow dereferences
18229c91e99STejun Heo 	 * from get_work_pool().
18329c91e99STejun Heo 	 */
18429c91e99STejun Heo 	struct rcu_head		rcu;
1858b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1868b03ae3cSTejun Heo 
1878b03ae3cSTejun Heo /*
188112202d9STejun Heo  * The per-pool workqueue.  While queued, the lower WORK_STRUCT_FLAG_BITS
189112202d9STejun Heo  * of work_struct->data are used for flags and the remaining high bits
190112202d9STejun Heo  * point to the pwq; thus, pwqs need to be aligned at two's power of the
191112202d9STejun Heo  * number of flag bits.
1921da177e4SLinus Torvalds  */
193112202d9STejun Heo struct pool_workqueue {
194bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1954690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
19673f53c4aSTejun Heo 	int			work_color;	/* L: current color */
19773f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
1988864b4e5STejun Heo 	int			refcnt;		/* L: reference count */
19973f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
20073f53c4aSTejun Heo 						/* L: nr of in_flight works */
2011e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
202a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
2031e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
2043c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2052e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2068864b4e5STejun Heo 
2078864b4e5STejun Heo 	/*
2088864b4e5STejun Heo 	 * Release of unbound pwq is punted to system_wq.  See put_pwq()
2098864b4e5STejun Heo 	 * and pwq_unbound_release_workfn() for details.  pool_workqueue
2108864b4e5STejun Heo 	 * itself is also sched-RCU protected so that the first pwq can be
211b09f4fd3SLai Jiangshan 	 * determined without grabbing wq->mutex.
2128864b4e5STejun Heo 	 */
2138864b4e5STejun Heo 	struct work_struct	unbound_release_work;
2148864b4e5STejun Heo 	struct rcu_head		rcu;
215e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS);
2161da177e4SLinus Torvalds 
2171da177e4SLinus Torvalds /*
21873f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
21973f53c4aSTejun Heo  */
22073f53c4aSTejun Heo struct wq_flusher {
2213c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
2223c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
22373f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
22473f53c4aSTejun Heo };
2251da177e4SLinus Torvalds 
226226223abSTejun Heo struct wq_device;
227226223abSTejun Heo 
22873f53c4aSTejun Heo /*
229c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
230c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
2311da177e4SLinus Torvalds  */
2321da177e4SLinus Torvalds struct workqueue_struct {
2333c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
23468e13a67SLai Jiangshan 	struct list_head	list;		/* PL: list of all workqueues */
23573f53c4aSTejun Heo 
2363c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
2373c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
2383c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
239112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
2403c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
2413c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
2423c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
24373f53c4aSTejun Heo 
2442e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
245e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
246e22bee78STejun Heo 
24787fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
248a357fc03SLai Jiangshan 	int			saved_max_active; /* WQ: saved pwq max_active */
249226223abSTejun Heo 
2506029a918STejun Heo 	struct workqueue_attrs	*unbound_attrs;	/* WQ: only for unbound wqs */
2514c16bd32STejun Heo 	struct pool_workqueue	*dfl_pwq;	/* WQ: only for unbound wqs */
2526029a918STejun Heo 
253226223abSTejun Heo #ifdef CONFIG_SYSFS
254226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
255226223abSTejun Heo #endif
2564e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2574e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2584e6045f1SJohannes Berg #endif
259ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
2602728fd2fSTejun Heo 
2612728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
2622728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
2632728fd2fSTejun Heo 	struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
264df2d5ae4STejun Heo 	struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */
2651da177e4SLinus Torvalds };
2661da177e4SLinus Torvalds 
267e904e6c2STejun Heo static struct kmem_cache *pwq_cache;
268e904e6c2STejun Heo 
269bce90380STejun Heo static int wq_numa_tbl_len;		/* highest possible NUMA node id + 1 */
270bce90380STejun Heo static cpumask_var_t *wq_numa_possible_cpumask;
271bce90380STejun Heo 					/* possible CPUs of each node */
272bce90380STejun Heo 
273d55262c4STejun Heo static bool wq_disable_numa;
274d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444);
275d55262c4STejun Heo 
276cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
277cee22a15SViresh Kumar #ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
278cee22a15SViresh Kumar static bool wq_power_efficient = true;
279cee22a15SViresh Kumar #else
280cee22a15SViresh Kumar static bool wq_power_efficient;
281cee22a15SViresh Kumar #endif
282cee22a15SViresh Kumar 
283cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
284cee22a15SViresh Kumar 
285bce90380STejun Heo static bool wq_numa_enabled;		/* unbound NUMA affinity enabled */
286bce90380STejun Heo 
2874c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
2884c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
2894c16bd32STejun Heo 
29068e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
2912e109a28STejun Heo static DEFINE_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
2925bcab335STejun Heo 
29368e13a67SLai Jiangshan static LIST_HEAD(workqueues);		/* PL: list of all workqueues */
29468e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
2957d19c5ceSTejun Heo 
2967d19c5ceSTejun Heo /* the per-cpu worker pools */
2977d19c5ceSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
2987d19c5ceSTejun Heo 				     cpu_worker_pools);
2997d19c5ceSTejun Heo 
30068e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
3017d19c5ceSTejun Heo 
30268e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
30329c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
30429c91e99STejun Heo 
305c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
30629c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
30729c91e99STejun Heo 
3088a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
3098a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
3108a2b7538STejun Heo 
311d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
312ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
313044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
3141aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
315044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
316d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
317044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
318f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
319044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
32024d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
3210668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly;
3220668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
3230668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
3240668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
325d320c038STejun Heo 
3267d19c5ceSTejun Heo static int worker_thread(void *__worker);
3277d19c5ceSTejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
3287d19c5ceSTejun Heo 				 const struct workqueue_attrs *from);
3297d19c5ceSTejun Heo 
33097bd2347STejun Heo #define CREATE_TRACE_POINTS
33197bd2347STejun Heo #include <trace/events/workqueue.h>
33297bd2347STejun Heo 
33368e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
3345bcab335STejun Heo 	rcu_lockdep_assert(rcu_read_lock_sched_held() ||		\
33568e13a67SLai Jiangshan 			   lockdep_is_held(&wq_pool_mutex),		\
33668e13a67SLai Jiangshan 			   "sched RCU or wq_pool_mutex should be held")
3375bcab335STejun Heo 
338b09f4fd3SLai Jiangshan #define assert_rcu_or_wq_mutex(wq)					\
33976af4d93STejun Heo 	rcu_lockdep_assert(rcu_read_lock_sched_held() ||		\
340b5927605SLai Jiangshan 			   lockdep_is_held(&wq->mutex),			\
341b09f4fd3SLai Jiangshan 			   "sched RCU or wq->mutex should be held")
34276af4d93STejun Heo 
343f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
344f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
345f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
3467a62c2c8STejun Heo 	     (pool)++)
3474ce62e9eSTejun Heo 
34849e3cf44STejun Heo /**
34917116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
35017116969STejun Heo  * @pool: iteration cursor
351611c92a0STejun Heo  * @pi: integer used for iteration
352fa1b54e6STejun Heo  *
35368e13a67SLai Jiangshan  * This must be called either with wq_pool_mutex held or sched RCU read
35468e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
35568e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
356fa1b54e6STejun Heo  *
357fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
358fa1b54e6STejun Heo  * ignored.
35917116969STejun Heo  */
360611c92a0STejun Heo #define for_each_pool(pool, pi)						\
361611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
36268e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
363fa1b54e6STejun Heo 		else
36417116969STejun Heo 
36517116969STejun Heo /**
366822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
367822d8405STejun Heo  * @worker: iteration cursor
368822d8405STejun Heo  * @pool: worker_pool to iterate workers of
369822d8405STejun Heo  *
3709625ab17SLai Jiangshan  * This must be called with @pool->manager_mutex.
371822d8405STejun Heo  *
372822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
373822d8405STejun Heo  * ignored.
374822d8405STejun Heo  */
375da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
376da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
3779625ab17SLai Jiangshan 		if (({ lockdep_assert_held(&pool->manager_mutex); false; })) { } \
378822d8405STejun Heo 		else
379822d8405STejun Heo 
380822d8405STejun Heo /**
38149e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
38249e3cf44STejun Heo  * @pwq: iteration cursor
38349e3cf44STejun Heo  * @wq: the target workqueue
38476af4d93STejun Heo  *
385b09f4fd3SLai Jiangshan  * This must be called either with wq->mutex held or sched RCU read locked.
386794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
387794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
38876af4d93STejun Heo  *
38976af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
39076af4d93STejun Heo  * ignored.
39149e3cf44STejun Heo  */
39249e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
39376af4d93STejun Heo 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node)		\
394b09f4fd3SLai Jiangshan 		if (({ assert_rcu_or_wq_mutex(wq); false; })) { }	\
39576af4d93STejun Heo 		else
396f3421797STejun Heo 
397dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
398dc186ad7SThomas Gleixner 
399dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
400dc186ad7SThomas Gleixner 
40199777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
40299777288SStanislaw Gruszka {
40399777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
40499777288SStanislaw Gruszka }
40599777288SStanislaw Gruszka 
406dc186ad7SThomas Gleixner /*
407dc186ad7SThomas Gleixner  * fixup_init is called when:
408dc186ad7SThomas Gleixner  * - an active object is initialized
409dc186ad7SThomas Gleixner  */
410dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
411dc186ad7SThomas Gleixner {
412dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
413dc186ad7SThomas Gleixner 
414dc186ad7SThomas Gleixner 	switch (state) {
415dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
416dc186ad7SThomas Gleixner 		cancel_work_sync(work);
417dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
418dc186ad7SThomas Gleixner 		return 1;
419dc186ad7SThomas Gleixner 	default:
420dc186ad7SThomas Gleixner 		return 0;
421dc186ad7SThomas Gleixner 	}
422dc186ad7SThomas Gleixner }
423dc186ad7SThomas Gleixner 
424dc186ad7SThomas Gleixner /*
425dc186ad7SThomas Gleixner  * fixup_activate is called when:
426dc186ad7SThomas Gleixner  * - an active object is activated
427dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
428dc186ad7SThomas Gleixner  */
429dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
430dc186ad7SThomas Gleixner {
431dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
432dc186ad7SThomas Gleixner 
433dc186ad7SThomas Gleixner 	switch (state) {
434dc186ad7SThomas Gleixner 
435dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
436dc186ad7SThomas Gleixner 		/*
437dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
438dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
439dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
440dc186ad7SThomas Gleixner 		 */
44122df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
442dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
443dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
444dc186ad7SThomas Gleixner 			return 0;
445dc186ad7SThomas Gleixner 		}
446dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
447dc186ad7SThomas Gleixner 		return 0;
448dc186ad7SThomas Gleixner 
449dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
450dc186ad7SThomas Gleixner 		WARN_ON(1);
451dc186ad7SThomas Gleixner 
452dc186ad7SThomas Gleixner 	default:
453dc186ad7SThomas Gleixner 		return 0;
454dc186ad7SThomas Gleixner 	}
455dc186ad7SThomas Gleixner }
456dc186ad7SThomas Gleixner 
457dc186ad7SThomas Gleixner /*
458dc186ad7SThomas Gleixner  * fixup_free is called when:
459dc186ad7SThomas Gleixner  * - an active object is freed
460dc186ad7SThomas Gleixner  */
461dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
462dc186ad7SThomas Gleixner {
463dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
464dc186ad7SThomas Gleixner 
465dc186ad7SThomas Gleixner 	switch (state) {
466dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
467dc186ad7SThomas Gleixner 		cancel_work_sync(work);
468dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
469dc186ad7SThomas Gleixner 		return 1;
470dc186ad7SThomas Gleixner 	default:
471dc186ad7SThomas Gleixner 		return 0;
472dc186ad7SThomas Gleixner 	}
473dc186ad7SThomas Gleixner }
474dc186ad7SThomas Gleixner 
475dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
476dc186ad7SThomas Gleixner 	.name		= "work_struct",
47799777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
478dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
479dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
480dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
481dc186ad7SThomas Gleixner };
482dc186ad7SThomas Gleixner 
483dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
484dc186ad7SThomas Gleixner {
485dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
486dc186ad7SThomas Gleixner }
487dc186ad7SThomas Gleixner 
488dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
489dc186ad7SThomas Gleixner {
490dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
491dc186ad7SThomas Gleixner }
492dc186ad7SThomas Gleixner 
493dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
494dc186ad7SThomas Gleixner {
495dc186ad7SThomas Gleixner 	if (onstack)
496dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
497dc186ad7SThomas Gleixner 	else
498dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
499dc186ad7SThomas Gleixner }
500dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
501dc186ad7SThomas Gleixner 
502dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
503dc186ad7SThomas Gleixner {
504dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
505dc186ad7SThomas Gleixner }
506dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
507dc186ad7SThomas Gleixner 
508ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
509ea2e64f2SThomas Gleixner {
510ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
511ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
512ea2e64f2SThomas Gleixner }
513ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
514ea2e64f2SThomas Gleixner 
515dc186ad7SThomas Gleixner #else
516dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
517dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
518dc186ad7SThomas Gleixner #endif
519dc186ad7SThomas Gleixner 
5204e8b22bdSLi Bin /**
5214e8b22bdSLi Bin  * worker_pool_assign_id - allocate ID and assing it to @pool
5224e8b22bdSLi Bin  * @pool: the pool pointer of interest
5234e8b22bdSLi Bin  *
5244e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
5254e8b22bdSLi Bin  * successfully, -errno on failure.
5264e8b22bdSLi Bin  */
5279daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
5289daf9e67STejun Heo {
5299daf9e67STejun Heo 	int ret;
5309daf9e67STejun Heo 
53168e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5325bcab335STejun Heo 
5334e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
5344e8b22bdSLi Bin 			GFP_KERNEL);
535229641a6STejun Heo 	if (ret >= 0) {
536e68035fbSTejun Heo 		pool->id = ret;
537229641a6STejun Heo 		return 0;
538229641a6STejun Heo 	}
5399daf9e67STejun Heo 	return ret;
5409daf9e67STejun Heo }
5419daf9e67STejun Heo 
54276af4d93STejun Heo /**
543df2d5ae4STejun Heo  * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
544df2d5ae4STejun Heo  * @wq: the target workqueue
545df2d5ae4STejun Heo  * @node: the node ID
546df2d5ae4STejun Heo  *
547df2d5ae4STejun Heo  * This must be called either with pwq_lock held or sched RCU read locked.
548df2d5ae4STejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
549df2d5ae4STejun Heo  * responsible for guaranteeing that the pwq stays online.
550d185af30SYacine Belkadi  *
551d185af30SYacine Belkadi  * Return: The unbound pool_workqueue for @node.
552df2d5ae4STejun Heo  */
553df2d5ae4STejun Heo static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
554df2d5ae4STejun Heo 						  int node)
555df2d5ae4STejun Heo {
556df2d5ae4STejun Heo 	assert_rcu_or_wq_mutex(wq);
557df2d5ae4STejun Heo 	return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
558df2d5ae4STejun Heo }
559df2d5ae4STejun Heo 
56073f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
56173f53c4aSTejun Heo {
56273f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
56373f53c4aSTejun Heo }
56473f53c4aSTejun Heo 
56573f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
56673f53c4aSTejun Heo {
56773f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
56873f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
56973f53c4aSTejun Heo }
57073f53c4aSTejun Heo 
57173f53c4aSTejun Heo static int work_next_color(int color)
57273f53c4aSTejun Heo {
57373f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
574a848e3b6SOleg Nesterov }
575a848e3b6SOleg Nesterov 
5764594bf15SDavid Howells /*
577112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
578112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
5797c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
5807a22ad75STejun Heo  *
581112202d9STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
582112202d9STejun Heo  * and clear_work_data() can be used to set the pwq, pool or clear
583bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
584bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5857a22ad75STejun Heo  *
586112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
5877c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
588112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
5897c3eed5cSTejun Heo  * available only while the work item is queued.
590bbb68dfaSTejun Heo  *
591bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
592bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
593bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
594bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5954594bf15SDavid Howells  */
5967a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5977a22ad75STejun Heo 				 unsigned long flags)
5987a22ad75STejun Heo {
5996183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
6007a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
6017a22ad75STejun Heo }
6027a22ad75STejun Heo 
603112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
6044690c4abSTejun Heo 			 unsigned long extra_flags)
605365970a1SDavid Howells {
606112202d9STejun Heo 	set_work_data(work, (unsigned long)pwq,
607112202d9STejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
608365970a1SDavid Howells }
609365970a1SDavid Howells 
6104468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
6114468a00fSLai Jiangshan 					   int pool_id)
6124468a00fSLai Jiangshan {
6134468a00fSLai Jiangshan 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
6144468a00fSLai Jiangshan 		      WORK_STRUCT_PENDING);
6154468a00fSLai Jiangshan }
6164468a00fSLai Jiangshan 
6177c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
6187c3eed5cSTejun Heo 					    int pool_id)
6194d707b9fSOleg Nesterov {
62023657bb1STejun Heo 	/*
62123657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
62223657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
62323657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
62423657bb1STejun Heo 	 * owner.
62523657bb1STejun Heo 	 */
62623657bb1STejun Heo 	smp_wmb();
6277c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
6284d707b9fSOleg Nesterov }
6294d707b9fSOleg Nesterov 
6307a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
631365970a1SDavid Howells {
6327c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
6337c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
6347a22ad75STejun Heo }
6357a22ad75STejun Heo 
636112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
6377a22ad75STejun Heo {
638e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
6397a22ad75STejun Heo 
640112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
641e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
642e120153dSTejun Heo 	else
643e120153dSTejun Heo 		return NULL;
6447a22ad75STejun Heo }
6457a22ad75STejun Heo 
6467c3eed5cSTejun Heo /**
6477c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
6487c3eed5cSTejun Heo  * @work: the work item of interest
6497c3eed5cSTejun Heo  *
65068e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
65168e13a67SLai Jiangshan  * access under sched-RCU read lock.  As such, this function should be
65268e13a67SLai Jiangshan  * called under wq_pool_mutex or with preemption disabled.
653fa1b54e6STejun Heo  *
654fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
655fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
656fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
657fa1b54e6STejun Heo  * returned pool is and stays online.
658d185af30SYacine Belkadi  *
659d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
6607c3eed5cSTejun Heo  */
6617c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
6627a22ad75STejun Heo {
663e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
6647c3eed5cSTejun Heo 	int pool_id;
6657a22ad75STejun Heo 
66668e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
667fa1b54e6STejun Heo 
668112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
669112202d9STejun Heo 		return ((struct pool_workqueue *)
6707c3eed5cSTejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool;
6717a22ad75STejun Heo 
6727c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
6737c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
6747a22ad75STejun Heo 		return NULL;
6757a22ad75STejun Heo 
676fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
6777c3eed5cSTejun Heo }
6787c3eed5cSTejun Heo 
6797c3eed5cSTejun Heo /**
6807c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
6817c3eed5cSTejun Heo  * @work: the work item of interest
6827c3eed5cSTejun Heo  *
683d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
6847c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
6857c3eed5cSTejun Heo  */
6867c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
6877c3eed5cSTejun Heo {
68854d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
6897c3eed5cSTejun Heo 
690112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
691112202d9STejun Heo 		return ((struct pool_workqueue *)
69254d5b7d0SLai Jiangshan 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
69354d5b7d0SLai Jiangshan 
69454d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
6957c3eed5cSTejun Heo }
6967c3eed5cSTejun Heo 
697bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
698bbb68dfaSTejun Heo {
6997c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
700bbb68dfaSTejun Heo 
7017c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
7027c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
703bbb68dfaSTejun Heo }
704bbb68dfaSTejun Heo 
705bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
706bbb68dfaSTejun Heo {
707bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
708bbb68dfaSTejun Heo 
709112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
710bbb68dfaSTejun Heo }
711bbb68dfaSTejun Heo 
712e22bee78STejun Heo /*
7133270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
7143270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
715d565ed63STejun Heo  * they're being called with pool->lock held.
716e22bee78STejun Heo  */
717e22bee78STejun Heo 
71863d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
719649027d7STejun Heo {
720e19e397aSTejun Heo 	return !atomic_read(&pool->nr_running);
721649027d7STejun Heo }
722649027d7STejun Heo 
723e22bee78STejun Heo /*
724e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
725e22bee78STejun Heo  * running workers.
726974271c4STejun Heo  *
727974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
728706026c2STejun Heo  * function will always return %true for unbound pools as long as the
729974271c4STejun Heo  * worklist isn't empty.
730e22bee78STejun Heo  */
73163d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
732e22bee78STejun Heo {
73363d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
734e22bee78STejun Heo }
735e22bee78STejun Heo 
736e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
73763d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
738e22bee78STejun Heo {
73963d95a91STejun Heo 	return pool->nr_idle;
740e22bee78STejun Heo }
741e22bee78STejun Heo 
742e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
74363d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
744e22bee78STejun Heo {
745e19e397aSTejun Heo 	return !list_empty(&pool->worklist) &&
746e19e397aSTejun Heo 		atomic_read(&pool->nr_running) <= 1;
747e22bee78STejun Heo }
748e22bee78STejun Heo 
749e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
75063d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
751e22bee78STejun Heo {
75263d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
753e22bee78STejun Heo }
754e22bee78STejun Heo 
755e22bee78STejun Heo /* Do we have too many workers and should some go away? */
75663d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
757e22bee78STejun Heo {
75834a06bd6STejun Heo 	bool managing = mutex_is_locked(&pool->manager_arb);
75963d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
76063d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
761e22bee78STejun Heo 
762ea1abd61SLai Jiangshan 	/*
763ea1abd61SLai Jiangshan 	 * nr_idle and idle_list may disagree if idle rebinding is in
764ea1abd61SLai Jiangshan 	 * progress.  Never return %true if idle_list is empty.
765ea1abd61SLai Jiangshan 	 */
766ea1abd61SLai Jiangshan 	if (list_empty(&pool->idle_list))
767ea1abd61SLai Jiangshan 		return false;
768ea1abd61SLai Jiangshan 
769e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
770e22bee78STejun Heo }
771e22bee78STejun Heo 
772e22bee78STejun Heo /*
773e22bee78STejun Heo  * Wake up functions.
774e22bee78STejun Heo  */
775e22bee78STejun Heo 
7767e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
77763d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
7787e11629dSTejun Heo {
77963d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
7807e11629dSTejun Heo 		return NULL;
7817e11629dSTejun Heo 
78263d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
7837e11629dSTejun Heo }
7847e11629dSTejun Heo 
7857e11629dSTejun Heo /**
7867e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
78763d95a91STejun Heo  * @pool: worker pool to wake worker from
7887e11629dSTejun Heo  *
78963d95a91STejun Heo  * Wake up the first idle worker of @pool.
7907e11629dSTejun Heo  *
7917e11629dSTejun Heo  * CONTEXT:
792d565ed63STejun Heo  * spin_lock_irq(pool->lock).
7937e11629dSTejun Heo  */
79463d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
7957e11629dSTejun Heo {
79663d95a91STejun Heo 	struct worker *worker = first_worker(pool);
7977e11629dSTejun Heo 
7987e11629dSTejun Heo 	if (likely(worker))
7997e11629dSTejun Heo 		wake_up_process(worker->task);
8007e11629dSTejun Heo }
8017e11629dSTejun Heo 
8024690c4abSTejun Heo /**
803e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
804e22bee78STejun Heo  * @task: task waking up
805e22bee78STejun Heo  * @cpu: CPU @task is waking up to
806e22bee78STejun Heo  *
807e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
808e22bee78STejun Heo  * being awoken.
809e22bee78STejun Heo  *
810e22bee78STejun Heo  * CONTEXT:
811e22bee78STejun Heo  * spin_lock_irq(rq->lock)
812e22bee78STejun Heo  */
813d84ff051STejun Heo void wq_worker_waking_up(struct task_struct *task, int cpu)
814e22bee78STejun Heo {
815e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
816e22bee78STejun Heo 
81736576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
818ec22ca5eSTejun Heo 		WARN_ON_ONCE(worker->pool->cpu != cpu);
819e19e397aSTejun Heo 		atomic_inc(&worker->pool->nr_running);
820e22bee78STejun Heo 	}
82136576000SJoonsoo Kim }
822e22bee78STejun Heo 
823e22bee78STejun Heo /**
824e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
825e22bee78STejun Heo  * @task: task going to sleep
826e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
827e22bee78STejun Heo  *
828e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
829e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
830e22bee78STejun Heo  * returning pointer to its task.
831e22bee78STejun Heo  *
832e22bee78STejun Heo  * CONTEXT:
833e22bee78STejun Heo  * spin_lock_irq(rq->lock)
834e22bee78STejun Heo  *
835d185af30SYacine Belkadi  * Return:
836e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
837e22bee78STejun Heo  */
838d84ff051STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
839e22bee78STejun Heo {
840e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
841111c225aSTejun Heo 	struct worker_pool *pool;
842e22bee78STejun Heo 
843111c225aSTejun Heo 	/*
844111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
845111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
846111c225aSTejun Heo 	 * checking NOT_RUNNING.
847111c225aSTejun Heo 	 */
8482d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
849e22bee78STejun Heo 		return NULL;
850e22bee78STejun Heo 
851111c225aSTejun Heo 	pool = worker->pool;
852111c225aSTejun Heo 
853e22bee78STejun Heo 	/* this can only happen on the local cpu */
8546183c009STejun Heo 	if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
8556183c009STejun Heo 		return NULL;
856e22bee78STejun Heo 
857e22bee78STejun Heo 	/*
858e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
859e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
860e22bee78STejun Heo 	 * Please read comment there.
861e22bee78STejun Heo 	 *
862628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
863628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
864628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
865d565ed63STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without pool
866628c78e7STejun Heo 	 * lock is safe.
867e22bee78STejun Heo 	 */
868e19e397aSTejun Heo 	if (atomic_dec_and_test(&pool->nr_running) &&
869e19e397aSTejun Heo 	    !list_empty(&pool->worklist))
87063d95a91STejun Heo 		to_wakeup = first_worker(pool);
871e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
872e22bee78STejun Heo }
873e22bee78STejun Heo 
874e22bee78STejun Heo /**
875e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
876cb444766STejun Heo  * @worker: self
877d302f017STejun Heo  * @flags: flags to set
878d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
879d302f017STejun Heo  *
880e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
881e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
882e22bee78STejun Heo  * woken up.
883d302f017STejun Heo  *
884cb444766STejun Heo  * CONTEXT:
885d565ed63STejun Heo  * spin_lock_irq(pool->lock)
886d302f017STejun Heo  */
887d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
888d302f017STejun Heo 				    bool wakeup)
889d302f017STejun Heo {
890bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
891e22bee78STejun Heo 
892cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
893cb444766STejun Heo 
894e22bee78STejun Heo 	/*
895e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
896e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
897e22bee78STejun Heo 	 * @wakeup.
898e22bee78STejun Heo 	 */
899e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
900e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
901e22bee78STejun Heo 		if (wakeup) {
902e19e397aSTejun Heo 			if (atomic_dec_and_test(&pool->nr_running) &&
903bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
90463d95a91STejun Heo 				wake_up_worker(pool);
905e22bee78STejun Heo 		} else
906e19e397aSTejun Heo 			atomic_dec(&pool->nr_running);
907e22bee78STejun Heo 	}
908e22bee78STejun Heo 
909d302f017STejun Heo 	worker->flags |= flags;
910d302f017STejun Heo }
911d302f017STejun Heo 
912d302f017STejun Heo /**
913e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
914cb444766STejun Heo  * @worker: self
915d302f017STejun Heo  * @flags: flags to clear
916d302f017STejun Heo  *
917e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
918d302f017STejun Heo  *
919cb444766STejun Heo  * CONTEXT:
920d565ed63STejun Heo  * spin_lock_irq(pool->lock)
921d302f017STejun Heo  */
922d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
923d302f017STejun Heo {
92463d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
925e22bee78STejun Heo 	unsigned int oflags = worker->flags;
926e22bee78STejun Heo 
927cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
928cb444766STejun Heo 
929d302f017STejun Heo 	worker->flags &= ~flags;
930e22bee78STejun Heo 
93142c025f3STejun Heo 	/*
93242c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
93342c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
93442c025f3STejun Heo 	 * of multiple flags, not a single flag.
93542c025f3STejun Heo 	 */
936e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
937e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
938e19e397aSTejun Heo 			atomic_inc(&pool->nr_running);
939d302f017STejun Heo }
940d302f017STejun Heo 
941d302f017STejun Heo /**
9428cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
943c9e7cf27STejun Heo  * @pool: pool of interest
9448cca0eeaSTejun Heo  * @work: work to find worker for
9458cca0eeaSTejun Heo  *
946c9e7cf27STejun Heo  * Find a worker which is executing @work on @pool by searching
947c9e7cf27STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
948a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
949a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
950a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
951a2c1c57bSTejun Heo  * being executed.
952a2c1c57bSTejun Heo  *
953a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
954a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
955a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
956a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
957a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
958a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
959a2c1c57bSTejun Heo  *
960c5aa87bbSTejun Heo  * This function checks the work item address and work function to avoid
961c5aa87bbSTejun Heo  * false positives.  Note that this isn't complete as one may construct a
962c5aa87bbSTejun Heo  * work function which can introduce dependency onto itself through a
963c5aa87bbSTejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
964c5aa87bbSTejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
965c5aa87bbSTejun Heo  * actually occurs, it should be easy to locate the culprit work function.
9668cca0eeaSTejun Heo  *
9678cca0eeaSTejun Heo  * CONTEXT:
968d565ed63STejun Heo  * spin_lock_irq(pool->lock).
9698cca0eeaSTejun Heo  *
970d185af30SYacine Belkadi  * Return:
971d185af30SYacine Belkadi  * Pointer to worker which is executing @work if found, %NULL
9728cca0eeaSTejun Heo  * otherwise.
9738cca0eeaSTejun Heo  */
974c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
9758cca0eeaSTejun Heo 						 struct work_struct *work)
9768cca0eeaSTejun Heo {
97742f8570fSSasha Levin 	struct worker *worker;
97842f8570fSSasha Levin 
979b67bfe0dSSasha Levin 	hash_for_each_possible(pool->busy_hash, worker, hentry,
980a2c1c57bSTejun Heo 			       (unsigned long)work)
981a2c1c57bSTejun Heo 		if (worker->current_work == work &&
982a2c1c57bSTejun Heo 		    worker->current_func == work->func)
98342f8570fSSasha Levin 			return worker;
98442f8570fSSasha Levin 
98542f8570fSSasha Levin 	return NULL;
9868cca0eeaSTejun Heo }
9878cca0eeaSTejun Heo 
9888cca0eeaSTejun Heo /**
989bf4ede01STejun Heo  * move_linked_works - move linked works to a list
990bf4ede01STejun Heo  * @work: start of series of works to be scheduled
991bf4ede01STejun Heo  * @head: target list to append @work to
992bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
993bf4ede01STejun Heo  *
994bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
995bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
996bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
997bf4ede01STejun Heo  *
998bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
999bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1000bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
1001bf4ede01STejun Heo  *
1002bf4ede01STejun Heo  * CONTEXT:
1003d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1004bf4ede01STejun Heo  */
1005bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1006bf4ede01STejun Heo 			      struct work_struct **nextp)
1007bf4ede01STejun Heo {
1008bf4ede01STejun Heo 	struct work_struct *n;
1009bf4ede01STejun Heo 
1010bf4ede01STejun Heo 	/*
1011bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
1012bf4ede01STejun Heo 	 * use NULL for list head.
1013bf4ede01STejun Heo 	 */
1014bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1015bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
1016bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1017bf4ede01STejun Heo 			break;
1018bf4ede01STejun Heo 	}
1019bf4ede01STejun Heo 
1020bf4ede01STejun Heo 	/*
1021bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
1022bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
1023bf4ede01STejun Heo 	 * needs to be updated.
1024bf4ede01STejun Heo 	 */
1025bf4ede01STejun Heo 	if (nextp)
1026bf4ede01STejun Heo 		*nextp = n;
1027bf4ede01STejun Heo }
1028bf4ede01STejun Heo 
10298864b4e5STejun Heo /**
10308864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
10318864b4e5STejun Heo  * @pwq: pool_workqueue to get
10328864b4e5STejun Heo  *
10338864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
10348864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
10358864b4e5STejun Heo  */
10368864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
10378864b4e5STejun Heo {
10388864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
10398864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
10408864b4e5STejun Heo 	pwq->refcnt++;
10418864b4e5STejun Heo }
10428864b4e5STejun Heo 
10438864b4e5STejun Heo /**
10448864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
10458864b4e5STejun Heo  * @pwq: pool_workqueue to put
10468864b4e5STejun Heo  *
10478864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
10488864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
10498864b4e5STejun Heo  */
10508864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
10518864b4e5STejun Heo {
10528864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
10538864b4e5STejun Heo 	if (likely(--pwq->refcnt))
10548864b4e5STejun Heo 		return;
10558864b4e5STejun Heo 	if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
10568864b4e5STejun Heo 		return;
10578864b4e5STejun Heo 	/*
10588864b4e5STejun Heo 	 * @pwq can't be released under pool->lock, bounce to
10598864b4e5STejun Heo 	 * pwq_unbound_release_workfn().  This never recurses on the same
10608864b4e5STejun Heo 	 * pool->lock as this path is taken only for unbound workqueues and
10618864b4e5STejun Heo 	 * the release work item is scheduled on a per-cpu workqueue.  To
10628864b4e5STejun Heo 	 * avoid lockdep warning, unbound pool->locks are given lockdep
10638864b4e5STejun Heo 	 * subclass of 1 in get_unbound_pool().
10648864b4e5STejun Heo 	 */
10658864b4e5STejun Heo 	schedule_work(&pwq->unbound_release_work);
10668864b4e5STejun Heo }
10678864b4e5STejun Heo 
1068dce90d47STejun Heo /**
1069dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1070dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1071dce90d47STejun Heo  *
1072dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1073dce90d47STejun Heo  */
1074dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1075dce90d47STejun Heo {
1076dce90d47STejun Heo 	if (pwq) {
1077dce90d47STejun Heo 		/*
1078dce90d47STejun Heo 		 * As both pwqs and pools are sched-RCU protected, the
1079dce90d47STejun Heo 		 * following lock operations are safe.
1080dce90d47STejun Heo 		 */
1081dce90d47STejun Heo 		spin_lock_irq(&pwq->pool->lock);
1082dce90d47STejun Heo 		put_pwq(pwq);
1083dce90d47STejun Heo 		spin_unlock_irq(&pwq->pool->lock);
1084dce90d47STejun Heo 	}
1085dce90d47STejun Heo }
1086dce90d47STejun Heo 
1087112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work)
1088bf4ede01STejun Heo {
1089112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1090bf4ede01STejun Heo 
1091bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
1092112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
1093bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1094112202d9STejun Heo 	pwq->nr_active++;
1095bf4ede01STejun Heo }
1096bf4ede01STejun Heo 
1097112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
10983aa62497SLai Jiangshan {
1099112202d9STejun Heo 	struct work_struct *work = list_first_entry(&pwq->delayed_works,
11003aa62497SLai Jiangshan 						    struct work_struct, entry);
11013aa62497SLai Jiangshan 
1102112202d9STejun Heo 	pwq_activate_delayed_work(work);
11033aa62497SLai Jiangshan }
11043aa62497SLai Jiangshan 
1105bf4ede01STejun Heo /**
1106112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1107112202d9STejun Heo  * @pwq: pwq of interest
1108bf4ede01STejun Heo  * @color: color of work which left the queue
1109bf4ede01STejun Heo  *
1110bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1111112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1112bf4ede01STejun Heo  *
1113bf4ede01STejun Heo  * CONTEXT:
1114d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1115bf4ede01STejun Heo  */
1116112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1117bf4ede01STejun Heo {
11188864b4e5STejun Heo 	/* uncolored work items don't participate in flushing or nr_active */
1119bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
11208864b4e5STejun Heo 		goto out_put;
1121bf4ede01STejun Heo 
1122112202d9STejun Heo 	pwq->nr_in_flight[color]--;
1123bf4ede01STejun Heo 
1124112202d9STejun Heo 	pwq->nr_active--;
1125112202d9STejun Heo 	if (!list_empty(&pwq->delayed_works)) {
1126bf4ede01STejun Heo 		/* one down, submit a delayed one */
1127112202d9STejun Heo 		if (pwq->nr_active < pwq->max_active)
1128112202d9STejun Heo 			pwq_activate_first_delayed(pwq);
1129bf4ede01STejun Heo 	}
1130bf4ede01STejun Heo 
1131bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1132112202d9STejun Heo 	if (likely(pwq->flush_color != color))
11338864b4e5STejun Heo 		goto out_put;
1134bf4ede01STejun Heo 
1135bf4ede01STejun Heo 	/* are there still in-flight works? */
1136112202d9STejun Heo 	if (pwq->nr_in_flight[color])
11378864b4e5STejun Heo 		goto out_put;
1138bf4ede01STejun Heo 
1139112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1140112202d9STejun Heo 	pwq->flush_color = -1;
1141bf4ede01STejun Heo 
1142bf4ede01STejun Heo 	/*
1143112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1144bf4ede01STejun Heo 	 * will handle the rest.
1145bf4ede01STejun Heo 	 */
1146112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1147112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
11488864b4e5STejun Heo out_put:
11498864b4e5STejun Heo 	put_pwq(pwq);
1150bf4ede01STejun Heo }
1151bf4ede01STejun Heo 
115236e227d2STejun Heo /**
1153bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
115436e227d2STejun Heo  * @work: work item to steal
115536e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1156bbb68dfaSTejun Heo  * @flags: place to store irq state
115736e227d2STejun Heo  *
115836e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
1159d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
116036e227d2STejun Heo  *
1161d185af30SYacine Belkadi  * Return:
116236e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
116336e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
116436e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1165bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1166bbb68dfaSTejun Heo  *		for arbitrarily long
116736e227d2STejun Heo  *
1168d185af30SYacine Belkadi  * Note:
1169bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1170e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1171e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1172e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1173bbb68dfaSTejun Heo  *
1174bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1175bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1176bbb68dfaSTejun Heo  *
1177e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1178bf4ede01STejun Heo  */
1179bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1180bbb68dfaSTejun Heo 			       unsigned long *flags)
1181bf4ede01STejun Heo {
1182d565ed63STejun Heo 	struct worker_pool *pool;
1183112202d9STejun Heo 	struct pool_workqueue *pwq;
1184bf4ede01STejun Heo 
1185bbb68dfaSTejun Heo 	local_irq_save(*flags);
1186bbb68dfaSTejun Heo 
118736e227d2STejun Heo 	/* try to steal the timer if it exists */
118836e227d2STejun Heo 	if (is_dwork) {
118936e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
119036e227d2STejun Heo 
1191e0aecdd8STejun Heo 		/*
1192e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1193e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1194e0aecdd8STejun Heo 		 * running on the local CPU.
1195e0aecdd8STejun Heo 		 */
119636e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
119736e227d2STejun Heo 			return 1;
119836e227d2STejun Heo 	}
119936e227d2STejun Heo 
120036e227d2STejun Heo 	/* try to claim PENDING the normal way */
1201bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1202bf4ede01STejun Heo 		return 0;
1203bf4ede01STejun Heo 
1204bf4ede01STejun Heo 	/*
1205bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1206bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1207bf4ede01STejun Heo 	 */
1208d565ed63STejun Heo 	pool = get_work_pool(work);
1209d565ed63STejun Heo 	if (!pool)
1210bbb68dfaSTejun Heo 		goto fail;
1211bf4ede01STejun Heo 
1212d565ed63STejun Heo 	spin_lock(&pool->lock);
1213bf4ede01STejun Heo 	/*
1214112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
1215112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
1216112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
1217112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
1218112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
12190b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
1220bf4ede01STejun Heo 	 */
1221112202d9STejun Heo 	pwq = get_work_pwq(work);
1222112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
1223bf4ede01STejun Heo 		debug_work_deactivate(work);
12243aa62497SLai Jiangshan 
12253aa62497SLai Jiangshan 		/*
122616062836STejun Heo 		 * A delayed work item cannot be grabbed directly because
122716062836STejun Heo 		 * it might have linked NO_COLOR work items which, if left
1228112202d9STejun Heo 		 * on the delayed_list, will confuse pwq->nr_active
122916062836STejun Heo 		 * management later on and cause stall.  Make sure the work
123016062836STejun Heo 		 * item is activated before grabbing.
12313aa62497SLai Jiangshan 		 */
12323aa62497SLai Jiangshan 		if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1233112202d9STejun Heo 			pwq_activate_delayed_work(work);
12343aa62497SLai Jiangshan 
1235bf4ede01STejun Heo 		list_del_init(&work->entry);
1236112202d9STejun Heo 		pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
123736e227d2STejun Heo 
1238112202d9STejun Heo 		/* work->data points to pwq iff queued, point to pool */
12394468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
12404468a00fSLai Jiangshan 
1241d565ed63STejun Heo 		spin_unlock(&pool->lock);
124236e227d2STejun Heo 		return 1;
1243bf4ede01STejun Heo 	}
1244d565ed63STejun Heo 	spin_unlock(&pool->lock);
1245bbb68dfaSTejun Heo fail:
1246bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1247bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1248bbb68dfaSTejun Heo 		return -ENOENT;
1249bbb68dfaSTejun Heo 	cpu_relax();
125036e227d2STejun Heo 	return -EAGAIN;
1251bf4ede01STejun Heo }
1252bf4ede01STejun Heo 
1253bf4ede01STejun Heo /**
1254706026c2STejun Heo  * insert_work - insert a work into a pool
1255112202d9STejun Heo  * @pwq: pwq @work belongs to
12564690c4abSTejun Heo  * @work: work to insert
12574690c4abSTejun Heo  * @head: insertion point
12584690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
12594690c4abSTejun Heo  *
1260112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
1261706026c2STejun Heo  * work_struct flags.
12624690c4abSTejun Heo  *
12634690c4abSTejun Heo  * CONTEXT:
1264d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1265365970a1SDavid Howells  */
1266112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1267112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
1268b89deed3SOleg Nesterov {
1269112202d9STejun Heo 	struct worker_pool *pool = pwq->pool;
1270e1d8aa9fSFrederic Weisbecker 
12714690c4abSTejun Heo 	/* we own @work, set data and link */
1272112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
12731a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
12748864b4e5STejun Heo 	get_pwq(pwq);
1275e22bee78STejun Heo 
1276e22bee78STejun Heo 	/*
1277c5aa87bbSTejun Heo 	 * Ensure either wq_worker_sleeping() sees the above
1278c5aa87bbSTejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers lying
1279c5aa87bbSTejun Heo 	 * around lazily while there are works to be processed.
1280e22bee78STejun Heo 	 */
1281e22bee78STejun Heo 	smp_mb();
1282e22bee78STejun Heo 
128363d95a91STejun Heo 	if (__need_more_worker(pool))
128463d95a91STejun Heo 		wake_up_worker(pool);
1285b89deed3SOleg Nesterov }
1286b89deed3SOleg Nesterov 
1287c8efcc25STejun Heo /*
1288c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
12898d03ecfeSTejun Heo  * same workqueue.
1290c8efcc25STejun Heo  */
1291c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1292c8efcc25STejun Heo {
1293c8efcc25STejun Heo 	struct worker *worker;
1294c8efcc25STejun Heo 
12958d03ecfeSTejun Heo 	worker = current_wq_worker();
1296c8efcc25STejun Heo 	/*
12978d03ecfeSTejun Heo 	 * Return %true iff I'm a worker execuing a work item on @wq.  If
12988d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
1299c8efcc25STejun Heo 	 */
1300112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
1301c8efcc25STejun Heo }
1302c8efcc25STejun Heo 
1303d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
13041da177e4SLinus Torvalds 			 struct work_struct *work)
13051da177e4SLinus Torvalds {
1306112202d9STejun Heo 	struct pool_workqueue *pwq;
1307c9178087STejun Heo 	struct worker_pool *last_pool;
13081e19ffc6STejun Heo 	struct list_head *worklist;
13098a2e8e5dSTejun Heo 	unsigned int work_flags;
1310b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
13118930cabaSTejun Heo 
13128930cabaSTejun Heo 	/*
13138930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
13148930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
13158930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
13168930cabaSTejun Heo 	 * happen with IRQ disabled.
13178930cabaSTejun Heo 	 */
13188930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
13191da177e4SLinus Torvalds 
1320dc186ad7SThomas Gleixner 	debug_work_activate(work);
13211e19ffc6STejun Heo 
13229ef28a73SLi Bin 	/* if draining, only works from the same workqueue are allowed */
1323618b01ebSTejun Heo 	if (unlikely(wq->flags & __WQ_DRAINING) &&
1324c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1325e41e704bSTejun Heo 		return;
13269e8cd2f5STejun Heo retry:
1327df2d5ae4STejun Heo 	if (req_cpu == WORK_CPU_UNBOUND)
1328f3421797STejun Heo 		cpu = raw_smp_processor_id();
1329df2d5ae4STejun Heo 
1330df2d5ae4STejun Heo 	/* pwq which will be used unless @work is executing elsewhere */
1331df2d5ae4STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
1332c9178087STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1333df2d5ae4STejun Heo 	else
1334df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1335f3421797STejun Heo 
133618aa9effSTejun Heo 	/*
1337c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
1338c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
1339c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
134018aa9effSTejun Heo 	 */
1341c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
1342112202d9STejun Heo 	if (last_pool && last_pool != pwq->pool) {
134318aa9effSTejun Heo 		struct worker *worker;
134418aa9effSTejun Heo 
1345d565ed63STejun Heo 		spin_lock(&last_pool->lock);
134618aa9effSTejun Heo 
1347c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
134818aa9effSTejun Heo 
1349112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
1350c9178087STejun Heo 			pwq = worker->current_pwq;
13518594fadeSLai Jiangshan 		} else {
135218aa9effSTejun Heo 			/* meh... not running there, queue here */
1353d565ed63STejun Heo 			spin_unlock(&last_pool->lock);
1354112202d9STejun Heo 			spin_lock(&pwq->pool->lock);
135518aa9effSTejun Heo 		}
13568930cabaSTejun Heo 	} else {
1357112202d9STejun Heo 		spin_lock(&pwq->pool->lock);
13588930cabaSTejun Heo 	}
1359502ca9d8STejun Heo 
13609e8cd2f5STejun Heo 	/*
13619e8cd2f5STejun Heo 	 * pwq is determined and locked.  For unbound pools, we could have
13629e8cd2f5STejun Heo 	 * raced with pwq release and it could already be dead.  If its
13639e8cd2f5STejun Heo 	 * refcnt is zero, repeat pwq selection.  Note that pwqs never die
1364df2d5ae4STejun Heo 	 * without another pwq replacing it in the numa_pwq_tbl or while
1365df2d5ae4STejun Heo 	 * work items are executing on it, so the retrying is guaranteed to
13669e8cd2f5STejun Heo 	 * make forward-progress.
13679e8cd2f5STejun Heo 	 */
13689e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
13699e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
13709e8cd2f5STejun Heo 			spin_unlock(&pwq->pool->lock);
13719e8cd2f5STejun Heo 			cpu_relax();
13729e8cd2f5STejun Heo 			goto retry;
13739e8cd2f5STejun Heo 		}
13749e8cd2f5STejun Heo 		/* oops */
13759e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
13769e8cd2f5STejun Heo 			  wq->name, cpu);
13779e8cd2f5STejun Heo 	}
13789e8cd2f5STejun Heo 
1379112202d9STejun Heo 	/* pwq determined, queue */
1380112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
1381502ca9d8STejun Heo 
1382f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1383112202d9STejun Heo 		spin_unlock(&pwq->pool->lock);
1384f5b2552bSDan Carpenter 		return;
1385f5b2552bSDan Carpenter 	}
13861e19ffc6STejun Heo 
1387112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
1388112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
13891e19ffc6STejun Heo 
1390112202d9STejun Heo 	if (likely(pwq->nr_active < pwq->max_active)) {
1391cdadf009STejun Heo 		trace_workqueue_activate_work(work);
1392112202d9STejun Heo 		pwq->nr_active++;
1393112202d9STejun Heo 		worklist = &pwq->pool->worklist;
13948a2e8e5dSTejun Heo 	} else {
13958a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
1396112202d9STejun Heo 		worklist = &pwq->delayed_works;
13978a2e8e5dSTejun Heo 	}
13981e19ffc6STejun Heo 
1399112202d9STejun Heo 	insert_work(pwq, work, worklist, work_flags);
14001e19ffc6STejun Heo 
1401112202d9STejun Heo 	spin_unlock(&pwq->pool->lock);
14021da177e4SLinus Torvalds }
14031da177e4SLinus Torvalds 
14040fcb78c2SRolf Eike Beer /**
1405c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1406c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1407c1a220e7SZhang Rui  * @wq: workqueue to use
1408c1a220e7SZhang Rui  * @work: work to queue
1409c1a220e7SZhang Rui  *
1410c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1411c1a220e7SZhang Rui  * can't go away.
1412d185af30SYacine Belkadi  *
1413d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
1414c1a220e7SZhang Rui  */
1415d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1416d4283e93STejun Heo 		   struct work_struct *work)
1417c1a220e7SZhang Rui {
1418d4283e93STejun Heo 	bool ret = false;
14198930cabaSTejun Heo 	unsigned long flags;
14208930cabaSTejun Heo 
14218930cabaSTejun Heo 	local_irq_save(flags);
1422c1a220e7SZhang Rui 
142322df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14244690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1425d4283e93STejun Heo 		ret = true;
1426c1a220e7SZhang Rui 	}
14278930cabaSTejun Heo 
14288930cabaSTejun Heo 	local_irq_restore(flags);
1429c1a220e7SZhang Rui 	return ret;
1430c1a220e7SZhang Rui }
1431ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
1432c1a220e7SZhang Rui 
1433d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
14341da177e4SLinus Torvalds {
143552bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
14361da177e4SLinus Torvalds 
1437e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
143860c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
14391da177e4SLinus Torvalds }
14401438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
14411da177e4SLinus Torvalds 
14427beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
144352bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
14441da177e4SLinus Torvalds {
14457beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
14467beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
14471da177e4SLinus Torvalds 
14487beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
14497beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
1450fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1451fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
14527beb2edfSTejun Heo 
14538852aac2STejun Heo 	/*
14548852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
14558852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
14568852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
14578852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
14588852aac2STejun Heo 	 */
14598852aac2STejun Heo 	if (!delay) {
14608852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
14618852aac2STejun Heo 		return;
14628852aac2STejun Heo 	}
14638852aac2STejun Heo 
14647beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
14657beb2edfSTejun Heo 
146660c057bcSLai Jiangshan 	dwork->wq = wq;
14671265057fSTejun Heo 	dwork->cpu = cpu;
14687beb2edfSTejun Heo 	timer->expires = jiffies + delay;
14697beb2edfSTejun Heo 
14707beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
14717beb2edfSTejun Heo 		add_timer_on(timer, cpu);
14727beb2edfSTejun Heo 	else
14737beb2edfSTejun Heo 		add_timer(timer);
14747beb2edfSTejun Heo }
14751da177e4SLinus Torvalds 
14760fcb78c2SRolf Eike Beer /**
14770fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
14780fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
14790fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1480af9997e4SRandy Dunlap  * @dwork: work to queue
14810fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
14820fcb78c2SRolf Eike Beer  *
1483d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
1484715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1485715f1300STejun Heo  * execution.
14860fcb78c2SRolf Eike Beer  */
1487d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
148852bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
14897a6bc1cdSVenkatesh Pallipadi {
149052bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1491d4283e93STejun Heo 	bool ret = false;
14928930cabaSTejun Heo 	unsigned long flags;
14938930cabaSTejun Heo 
14948930cabaSTejun Heo 	/* read the comment in __queue_work() */
14958930cabaSTejun Heo 	local_irq_save(flags);
14967a6bc1cdSVenkatesh Pallipadi 
149722df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14987beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1499d4283e93STejun Heo 		ret = true;
15007a6bc1cdSVenkatesh Pallipadi 	}
15018930cabaSTejun Heo 
15028930cabaSTejun Heo 	local_irq_restore(flags);
15037a6bc1cdSVenkatesh Pallipadi 	return ret;
15047a6bc1cdSVenkatesh Pallipadi }
1505ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
15061da177e4SLinus Torvalds 
1507c8e55f36STejun Heo /**
15088376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
15098376fe22STejun Heo  * @cpu: CPU number to execute work on
15108376fe22STejun Heo  * @wq: workqueue to use
15118376fe22STejun Heo  * @dwork: work to queue
15128376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
15138376fe22STejun Heo  *
15148376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
15158376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
15168376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
15178376fe22STejun Heo  * current state.
15188376fe22STejun Heo  *
1519d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
15208376fe22STejun Heo  * pending and its timer was modified.
15218376fe22STejun Heo  *
1522e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
15238376fe22STejun Heo  * See try_to_grab_pending() for details.
15248376fe22STejun Heo  */
15258376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
15268376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
15278376fe22STejun Heo {
15288376fe22STejun Heo 	unsigned long flags;
15298376fe22STejun Heo 	int ret;
15308376fe22STejun Heo 
15318376fe22STejun Heo 	do {
15328376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
15338376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
15348376fe22STejun Heo 
15358376fe22STejun Heo 	if (likely(ret >= 0)) {
15368376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
15378376fe22STejun Heo 		local_irq_restore(flags);
15388376fe22STejun Heo 	}
15398376fe22STejun Heo 
15408376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
15418376fe22STejun Heo 	return ret;
15428376fe22STejun Heo }
15438376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
15448376fe22STejun Heo 
15458376fe22STejun Heo /**
1546c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1547c8e55f36STejun Heo  * @worker: worker which is entering idle state
1548c8e55f36STejun Heo  *
1549c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1550c8e55f36STejun Heo  * necessary.
1551c8e55f36STejun Heo  *
1552c8e55f36STejun Heo  * LOCKING:
1553d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1554c8e55f36STejun Heo  */
1555c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
15561da177e4SLinus Torvalds {
1557bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1558c8e55f36STejun Heo 
15596183c009STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
15606183c009STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
15616183c009STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
15626183c009STejun Heo 		return;
1563c8e55f36STejun Heo 
1564cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1565cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1566bd7bdd43STejun Heo 	pool->nr_idle++;
1567e22bee78STejun Heo 	worker->last_active = jiffies;
1568c8e55f36STejun Heo 
1569c8e55f36STejun Heo 	/* idle_list is LIFO */
1570bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1571db7bccf4STejun Heo 
157263d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1573628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1574cb444766STejun Heo 
1575544ecf31STejun Heo 	/*
1576706026c2STejun Heo 	 * Sanity check nr_running.  Because wq_unbind_fn() releases
1577d565ed63STejun Heo 	 * pool->lock between setting %WORKER_UNBOUND and zapping
1578628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1579628c78e7STejun Heo 	 * unbind is not in progress.
1580544ecf31STejun Heo 	 */
158124647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1582bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
1583e19e397aSTejun Heo 		     atomic_read(&pool->nr_running));
1584c8e55f36STejun Heo }
1585c8e55f36STejun Heo 
1586c8e55f36STejun Heo /**
1587c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1588c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1589c8e55f36STejun Heo  *
1590c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1591c8e55f36STejun Heo  *
1592c8e55f36STejun Heo  * LOCKING:
1593d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1594c8e55f36STejun Heo  */
1595c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1596c8e55f36STejun Heo {
1597bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1598c8e55f36STejun Heo 
15996183c009STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
16006183c009STejun Heo 		return;
1601d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1602bd7bdd43STejun Heo 	pool->nr_idle--;
1603c8e55f36STejun Heo 	list_del_init(&worker->entry);
1604c8e55f36STejun Heo }
1605c8e55f36STejun Heo 
1606e22bee78STejun Heo /**
1607f36dc67bSLai Jiangshan  * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1608f36dc67bSLai Jiangshan  * @pool: target worker_pool
1609f36dc67bSLai Jiangshan  *
1610f36dc67bSLai Jiangshan  * Bind %current to the cpu of @pool if it is associated and lock @pool.
1611e22bee78STejun Heo  *
1612e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1613e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1614e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1615e22bee78STejun Heo  * guaranteed to execute on the cpu.
1616e22bee78STejun Heo  *
1617f5faa077SLai Jiangshan  * This function is to be used by unbound workers and rescuers to bind
1618e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1619e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1620e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1621706026c2STejun Heo  * verbatim as it's best effort and blocking and pool may be
1622e22bee78STejun Heo  * [dis]associated in the meantime.
1623e22bee78STejun Heo  *
1624706026c2STejun Heo  * This function tries set_cpus_allowed() and locks pool and verifies the
162524647570STejun Heo  * binding against %POOL_DISASSOCIATED which is set during
1626f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1627f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1628f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1629e22bee78STejun Heo  *
1630e22bee78STejun Heo  * CONTEXT:
1631d565ed63STejun Heo  * Might sleep.  Called without any lock but returns with pool->lock
1632e22bee78STejun Heo  * held.
1633e22bee78STejun Heo  *
1634d185af30SYacine Belkadi  * Return:
1635706026c2STejun Heo  * %true if the associated pool is online (@worker is successfully
1636e22bee78STejun Heo  * bound), %false if offline.
1637e22bee78STejun Heo  */
1638f36dc67bSLai Jiangshan static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
1639d565ed63STejun Heo __acquires(&pool->lock)
1640e22bee78STejun Heo {
1641e22bee78STejun Heo 	while (true) {
1642e22bee78STejun Heo 		/*
1643e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1644e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1645e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
164624647570STejun Heo 		 * against POOL_DISASSOCIATED.
1647e22bee78STejun Heo 		 */
164824647570STejun Heo 		if (!(pool->flags & POOL_DISASSOCIATED))
16497a4e344cSTejun Heo 			set_cpus_allowed_ptr(current, pool->attrs->cpumask);
1650e22bee78STejun Heo 
1651d565ed63STejun Heo 		spin_lock_irq(&pool->lock);
165224647570STejun Heo 		if (pool->flags & POOL_DISASSOCIATED)
1653e22bee78STejun Heo 			return false;
1654f5faa077SLai Jiangshan 		if (task_cpu(current) == pool->cpu &&
16557a4e344cSTejun Heo 		    cpumask_equal(&current->cpus_allowed, pool->attrs->cpumask))
1656e22bee78STejun Heo 			return true;
1657d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
1658e22bee78STejun Heo 
16595035b20fSTejun Heo 		/*
16605035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
16615035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
16625035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
16635035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
16645035b20fSTejun Heo 		 */
1665e22bee78STejun Heo 		cpu_relax();
16665035b20fSTejun Heo 		cond_resched();
1667e22bee78STejun Heo 	}
1668e22bee78STejun Heo }
1669e22bee78STejun Heo 
1670c34056a3STejun Heo static struct worker *alloc_worker(void)
1671c34056a3STejun Heo {
1672c34056a3STejun Heo 	struct worker *worker;
1673c34056a3STejun Heo 
1674c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1675c8e55f36STejun Heo 	if (worker) {
1676c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1677affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1678da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
1679e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1680e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1681c8e55f36STejun Heo 	}
1682c34056a3STejun Heo 	return worker;
1683c34056a3STejun Heo }
1684c34056a3STejun Heo 
1685c34056a3STejun Heo /**
168660f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
168760f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
168860f5a4bcSLai Jiangshan  * @pool: the pool @worker is attached to
168960f5a4bcSLai Jiangshan  *
169060f5a4bcSLai Jiangshan  * Undo the attaching which had been done in create_worker().  The caller
169160f5a4bcSLai Jiangshan  * worker shouldn't access to the pool after detached except it has other
169260f5a4bcSLai Jiangshan  * reference to the pool.
169360f5a4bcSLai Jiangshan  */
169460f5a4bcSLai Jiangshan static void worker_detach_from_pool(struct worker *worker,
169560f5a4bcSLai Jiangshan 				    struct worker_pool *pool)
169660f5a4bcSLai Jiangshan {
169760f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
169860f5a4bcSLai Jiangshan 
169960f5a4bcSLai Jiangshan 	mutex_lock(&pool->manager_mutex);
1700da028469SLai Jiangshan 	list_del(&worker->node);
1701da028469SLai Jiangshan 	if (list_empty(&pool->workers))
170260f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
170360f5a4bcSLai Jiangshan 	mutex_unlock(&pool->manager_mutex);
170460f5a4bcSLai Jiangshan 
170560f5a4bcSLai Jiangshan 	if (detach_completion)
170660f5a4bcSLai Jiangshan 		complete(detach_completion);
170760f5a4bcSLai Jiangshan }
170860f5a4bcSLai Jiangshan 
170960f5a4bcSLai Jiangshan /**
1710c34056a3STejun Heo  * create_worker - create a new workqueue worker
171163d95a91STejun Heo  * @pool: pool the new worker will belong to
1712c34056a3STejun Heo  *
171373eb7fe7SLai Jiangshan  * Create a new worker which is attached to @pool.  The new worker must be
171473eb7fe7SLai Jiangshan  * started by start_worker().
1715c34056a3STejun Heo  *
1716c34056a3STejun Heo  * CONTEXT:
1717c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1718c34056a3STejun Heo  *
1719d185af30SYacine Belkadi  * Return:
1720c34056a3STejun Heo  * Pointer to the newly created worker.
1721c34056a3STejun Heo  */
1722bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1723c34056a3STejun Heo {
1724c34056a3STejun Heo 	struct worker *worker = NULL;
1725f3421797STejun Heo 	int id = -1;
1726e3c916a4STejun Heo 	char id_buf[16];
1727c34056a3STejun Heo 
1728cd549687STejun Heo 	lockdep_assert_held(&pool->manager_mutex);
1729cd549687STejun Heo 
1730*7cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
1731*7cda9aaeSLai Jiangshan 	id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
1732822d8405STejun Heo 	if (id < 0)
1733c34056a3STejun Heo 		goto fail;
1734c34056a3STejun Heo 
1735c34056a3STejun Heo 	worker = alloc_worker();
1736c34056a3STejun Heo 	if (!worker)
1737c34056a3STejun Heo 		goto fail;
1738c34056a3STejun Heo 
1739bd7bdd43STejun Heo 	worker->pool = pool;
1740c34056a3STejun Heo 	worker->id = id;
1741c34056a3STejun Heo 
174229c91e99STejun Heo 	if (pool->cpu >= 0)
1743e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1744e3c916a4STejun Heo 			 pool->attrs->nice < 0  ? "H" : "");
1745f3421797STejun Heo 	else
1746e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1747e3c916a4STejun Heo 
1748f3f90ad4STejun Heo 	worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1749e3c916a4STejun Heo 					      "kworker/%s", id_buf);
1750c34056a3STejun Heo 	if (IS_ERR(worker->task))
1751c34056a3STejun Heo 		goto fail;
1752c34056a3STejun Heo 
175391151228SOleg Nesterov 	set_user_nice(worker->task, pool->attrs->nice);
175491151228SOleg Nesterov 
175591151228SOleg Nesterov 	/* prevent userland from meddling with cpumask of workqueue workers */
175691151228SOleg Nesterov 	worker->task->flags |= PF_NO_SETAFFINITY;
175791151228SOleg Nesterov 
1758c5aa87bbSTejun Heo 	/*
1759c5aa87bbSTejun Heo 	 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1760c5aa87bbSTejun Heo 	 * online CPUs.  It'll be re-applied when any of the CPUs come up.
1761c5aa87bbSTejun Heo 	 */
17627a4e344cSTejun Heo 	set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
17633270476aSTejun Heo 
17647a4e344cSTejun Heo 	/*
17657a4e344cSTejun Heo 	 * The caller is responsible for ensuring %POOL_DISASSOCIATED
17667a4e344cSTejun Heo 	 * remains stable across this function.  See the comments above the
17677a4e344cSTejun Heo 	 * flag definition for details.
17687a4e344cSTejun Heo 	 */
17697a4e344cSTejun Heo 	if (pool->flags & POOL_DISASSOCIATED)
1770f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1771c34056a3STejun Heo 
1772da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
1773da028469SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
1774822d8405STejun Heo 
1775c34056a3STejun Heo 	return worker;
1776822d8405STejun Heo 
1777c34056a3STejun Heo fail:
17789625ab17SLai Jiangshan 	if (id >= 0)
1779*7cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, id);
1780c34056a3STejun Heo 	kfree(worker);
1781c34056a3STejun Heo 	return NULL;
1782c34056a3STejun Heo }
1783c34056a3STejun Heo 
1784c34056a3STejun Heo /**
1785c34056a3STejun Heo  * start_worker - start a newly created worker
1786c34056a3STejun Heo  * @worker: worker to start
1787c34056a3STejun Heo  *
1788706026c2STejun Heo  * Make the pool aware of @worker and start it.
1789c34056a3STejun Heo  *
1790c34056a3STejun Heo  * CONTEXT:
1791d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1792c34056a3STejun Heo  */
1793c34056a3STejun Heo static void start_worker(struct worker *worker)
1794c34056a3STejun Heo {
1795bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1796c8e55f36STejun Heo 	worker_enter_idle(worker);
1797c34056a3STejun Heo 	wake_up_process(worker->task);
1798c34056a3STejun Heo }
1799c34056a3STejun Heo 
1800c34056a3STejun Heo /**
1801ebf44d16STejun Heo  * create_and_start_worker - create and start a worker for a pool
1802ebf44d16STejun Heo  * @pool: the target pool
1803ebf44d16STejun Heo  *
1804cd549687STejun Heo  * Grab the managership of @pool and create and start a new worker for it.
1805d185af30SYacine Belkadi  *
1806d185af30SYacine Belkadi  * Return: 0 on success. A negative error code otherwise.
1807ebf44d16STejun Heo  */
1808ebf44d16STejun Heo static int create_and_start_worker(struct worker_pool *pool)
1809ebf44d16STejun Heo {
1810ebf44d16STejun Heo 	struct worker *worker;
1811ebf44d16STejun Heo 
1812cd549687STejun Heo 	mutex_lock(&pool->manager_mutex);
1813cd549687STejun Heo 
1814ebf44d16STejun Heo 	worker = create_worker(pool);
1815ebf44d16STejun Heo 	if (worker) {
1816ebf44d16STejun Heo 		spin_lock_irq(&pool->lock);
1817ebf44d16STejun Heo 		start_worker(worker);
1818ebf44d16STejun Heo 		spin_unlock_irq(&pool->lock);
1819ebf44d16STejun Heo 	}
1820ebf44d16STejun Heo 
1821cd549687STejun Heo 	mutex_unlock(&pool->manager_mutex);
1822cd549687STejun Heo 
1823ebf44d16STejun Heo 	return worker ? 0 : -ENOMEM;
1824ebf44d16STejun Heo }
1825ebf44d16STejun Heo 
1826ebf44d16STejun Heo /**
1827c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1828c34056a3STejun Heo  * @worker: worker to be destroyed
1829c34056a3STejun Heo  *
183073eb7fe7SLai Jiangshan  * Destroy @worker and adjust @pool stats accordingly.  The worker should
183173eb7fe7SLai Jiangshan  * be idle.
1832c8e55f36STejun Heo  *
1833c8e55f36STejun Heo  * CONTEXT:
183460f5a4bcSLai Jiangshan  * spin_lock_irq(pool->lock).
1835c34056a3STejun Heo  */
1836c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1837c34056a3STejun Heo {
1838bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1839c34056a3STejun Heo 
1840cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
1841cd549687STejun Heo 
1842c34056a3STejun Heo 	/* sanity check frenzy */
18436183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
184473eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
184573eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
18466183c009STejun Heo 		return;
1847c34056a3STejun Heo 
1848bd7bdd43STejun Heo 	pool->nr_workers--;
1849bd7bdd43STejun Heo 	pool->nr_idle--;
1850c8e55f36STejun Heo 
1851c8e55f36STejun Heo 	list_del_init(&worker->entry);
1852cb444766STejun Heo 	worker->flags |= WORKER_DIE;
185360f5a4bcSLai Jiangshan 	wake_up_process(worker->task);
1854c34056a3STejun Heo }
1855c34056a3STejun Heo 
185663d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1857e22bee78STejun Heo {
185863d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1859e22bee78STejun Heo 
1860d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1861e22bee78STejun Heo 
18623347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
1863e22bee78STejun Heo 		struct worker *worker;
1864e22bee78STejun Heo 		unsigned long expires;
1865e22bee78STejun Heo 
1866e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
186763d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1868e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1869e22bee78STejun Heo 
18703347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
187163d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
18723347fc9fSLai Jiangshan 			break;
1873e22bee78STejun Heo 		}
18743347fc9fSLai Jiangshan 
18753347fc9fSLai Jiangshan 		destroy_worker(worker);
1876e22bee78STejun Heo 	}
1877e22bee78STejun Heo 
1878d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
1879e22bee78STejun Heo }
1880e22bee78STejun Heo 
1881493a1724STejun Heo static void send_mayday(struct work_struct *work)
1882e22bee78STejun Heo {
1883112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1884112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
1885493a1724STejun Heo 
18862e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
1887e22bee78STejun Heo 
1888493008a8STejun Heo 	if (!wq->rescuer)
1889493a1724STejun Heo 		return;
1890e22bee78STejun Heo 
1891e22bee78STejun Heo 	/* mayday mayday mayday */
1892493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
189377668c8bSLai Jiangshan 		/*
189477668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
189577668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
189677668c8bSLai Jiangshan 		 * rescuer is done with it.
189777668c8bSLai Jiangshan 		 */
189877668c8bSLai Jiangshan 		get_pwq(pwq);
1899493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
1900e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1901493a1724STejun Heo 	}
1902e22bee78STejun Heo }
1903e22bee78STejun Heo 
1904706026c2STejun Heo static void pool_mayday_timeout(unsigned long __pool)
1905e22bee78STejun Heo {
190663d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1907e22bee78STejun Heo 	struct work_struct *work;
1908e22bee78STejun Heo 
19092e109a28STejun Heo 	spin_lock_irq(&wq_mayday_lock);		/* for wq->maydays */
1910493a1724STejun Heo 	spin_lock(&pool->lock);
1911e22bee78STejun Heo 
191263d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1913e22bee78STejun Heo 		/*
1914e22bee78STejun Heo 		 * We've been trying to create a new worker but
1915e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1916e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1917e22bee78STejun Heo 		 * rescuers.
1918e22bee78STejun Heo 		 */
191963d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1920e22bee78STejun Heo 			send_mayday(work);
1921e22bee78STejun Heo 	}
1922e22bee78STejun Heo 
1923493a1724STejun Heo 	spin_unlock(&pool->lock);
19242e109a28STejun Heo 	spin_unlock_irq(&wq_mayday_lock);
1925e22bee78STejun Heo 
192663d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1927e22bee78STejun Heo }
1928e22bee78STejun Heo 
1929e22bee78STejun Heo /**
1930e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
193163d95a91STejun Heo  * @pool: pool to create a new worker for
1932e22bee78STejun Heo  *
193363d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1934e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1935e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
193663d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1937e22bee78STejun Heo  * possible allocation deadlock.
1938e22bee78STejun Heo  *
1939c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
1940c5aa87bbSTejun Heo  * may_start_working() %true.
1941e22bee78STejun Heo  *
1942e22bee78STejun Heo  * LOCKING:
1943d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
1944e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1945e22bee78STejun Heo  * manager.
1946e22bee78STejun Heo  *
1947d185af30SYacine Belkadi  * Return:
1948c5aa87bbSTejun Heo  * %false if no action was taken and pool->lock stayed locked, %true
1949e22bee78STejun Heo  * otherwise.
1950e22bee78STejun Heo  */
195163d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
1952d565ed63STejun Heo __releases(&pool->lock)
1953d565ed63STejun Heo __acquires(&pool->lock)
1954e22bee78STejun Heo {
195563d95a91STejun Heo 	if (!need_to_create_worker(pool))
1956e22bee78STejun Heo 		return false;
1957e22bee78STejun Heo restart:
1958d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
19599f9c2364STejun Heo 
1960e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
196163d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1962e22bee78STejun Heo 
1963e22bee78STejun Heo 	while (true) {
1964e22bee78STejun Heo 		struct worker *worker;
1965e22bee78STejun Heo 
1966bc2ae0f5STejun Heo 		worker = create_worker(pool);
1967e22bee78STejun Heo 		if (worker) {
196863d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1969d565ed63STejun Heo 			spin_lock_irq(&pool->lock);
1970e22bee78STejun Heo 			start_worker(worker);
19716183c009STejun Heo 			if (WARN_ON_ONCE(need_to_create_worker(pool)))
19726183c009STejun Heo 				goto restart;
1973e22bee78STejun Heo 			return true;
1974e22bee78STejun Heo 		}
1975e22bee78STejun Heo 
197663d95a91STejun Heo 		if (!need_to_create_worker(pool))
1977e22bee78STejun Heo 			break;
1978e22bee78STejun Heo 
1979e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1980e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
19819f9c2364STejun Heo 
198263d95a91STejun Heo 		if (!need_to_create_worker(pool))
1983e22bee78STejun Heo 			break;
1984e22bee78STejun Heo 	}
1985e22bee78STejun Heo 
198663d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1987d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
198863d95a91STejun Heo 	if (need_to_create_worker(pool))
1989e22bee78STejun Heo 		goto restart;
1990e22bee78STejun Heo 	return true;
1991e22bee78STejun Heo }
1992e22bee78STejun Heo 
1993e22bee78STejun Heo /**
1994e22bee78STejun Heo  * manage_workers - manage worker pool
1995e22bee78STejun Heo  * @worker: self
1996e22bee78STejun Heo  *
1997706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
1998e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1999706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
2000e22bee78STejun Heo  *
2001e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2002e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2003e22bee78STejun Heo  * and may_start_working() is true.
2004e22bee78STejun Heo  *
2005e22bee78STejun Heo  * CONTEXT:
2006d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2007e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2008e22bee78STejun Heo  *
2009d185af30SYacine Belkadi  * Return:
20102d498db9SLibin  * %false if the pool don't need management and the caller can safely start
20112d498db9SLibin  * processing works, %true indicates that the function released pool->lock
20122d498db9SLibin  * and reacquired it to perform some management function and that the
20132d498db9SLibin  * conditions that the caller verified while holding the lock before
20142d498db9SLibin  * calling the function might no longer be true.
2015e22bee78STejun Heo  */
2016e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2017e22bee78STejun Heo {
201863d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2019e22bee78STejun Heo 	bool ret = false;
2020e22bee78STejun Heo 
2021bc3a1afcSTejun Heo 	/*
2022bc3a1afcSTejun Heo 	 * Managership is governed by two mutexes - manager_arb and
2023bc3a1afcSTejun Heo 	 * manager_mutex.  manager_arb handles arbitration of manager role.
2024bc3a1afcSTejun Heo 	 * Anyone who successfully grabs manager_arb wins the arbitration
2025bc3a1afcSTejun Heo 	 * and becomes the manager.  mutex_trylock() on pool->manager_arb
2026bc3a1afcSTejun Heo 	 * failure while holding pool->lock reliably indicates that someone
2027bc3a1afcSTejun Heo 	 * else is managing the pool and the worker which failed trylock
2028bc3a1afcSTejun Heo 	 * can proceed to executing work items.  This means that anyone
2029bc3a1afcSTejun Heo 	 * grabbing manager_arb is responsible for actually performing
2030bc3a1afcSTejun Heo 	 * manager duties.  If manager_arb is grabbed and released without
2031bc3a1afcSTejun Heo 	 * actual management, the pool may stall indefinitely.
2032bc3a1afcSTejun Heo 	 *
2033bc3a1afcSTejun Heo 	 * manager_mutex is used for exclusion of actual management
2034bc3a1afcSTejun Heo 	 * operations.  The holder of manager_mutex can be sure that none
2035bc3a1afcSTejun Heo 	 * of management operations, including creation and destruction of
2036bc3a1afcSTejun Heo 	 * workers, won't take place until the mutex is released.  Because
2037bc3a1afcSTejun Heo 	 * manager_mutex doesn't interfere with manager role arbitration,
2038bc3a1afcSTejun Heo 	 * it is guaranteed that the pool's management, while may be
2039bc3a1afcSTejun Heo 	 * delayed, won't be disturbed by someone else grabbing
2040bc3a1afcSTejun Heo 	 * manager_mutex.
2041bc3a1afcSTejun Heo 	 */
204234a06bd6STejun Heo 	if (!mutex_trylock(&pool->manager_arb))
2043e22bee78STejun Heo 		return ret;
2044e22bee78STejun Heo 
2045ee378aa4SLai Jiangshan 	/*
2046bc3a1afcSTejun Heo 	 * With manager arbitration won, manager_mutex would be free in
2047bc3a1afcSTejun Heo 	 * most cases.  trylock first without dropping @pool->lock.
2048ee378aa4SLai Jiangshan 	 */
2049bc3a1afcSTejun Heo 	if (unlikely(!mutex_trylock(&pool->manager_mutex))) {
2050d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
2051bc3a1afcSTejun Heo 		mutex_lock(&pool->manager_mutex);
20528f174b11SJoonsoo Kim 		spin_lock_irq(&pool->lock);
2053ee378aa4SLai Jiangshan 		ret = true;
2054ee378aa4SLai Jiangshan 	}
2055ee378aa4SLai Jiangshan 
205663d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2057e22bee78STejun Heo 
2058bc3a1afcSTejun Heo 	mutex_unlock(&pool->manager_mutex);
205934a06bd6STejun Heo 	mutex_unlock(&pool->manager_arb);
2060e22bee78STejun Heo 	return ret;
2061e22bee78STejun Heo }
2062e22bee78STejun Heo 
2063a62428c0STejun Heo /**
2064a62428c0STejun Heo  * process_one_work - process single work
2065c34056a3STejun Heo  * @worker: self
2066a62428c0STejun Heo  * @work: work to process
2067a62428c0STejun Heo  *
2068a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2069a62428c0STejun Heo  * process a single work including synchronization against and
2070a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2071a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2072a62428c0STejun Heo  * call this function to process a work.
2073a62428c0STejun Heo  *
2074a62428c0STejun Heo  * CONTEXT:
2075d565ed63STejun Heo  * spin_lock_irq(pool->lock) which is released and regrabbed.
2076a62428c0STejun Heo  */
2077c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
2078d565ed63STejun Heo __releases(&pool->lock)
2079d565ed63STejun Heo __acquires(&pool->lock)
20801da177e4SLinus Torvalds {
2081112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2082bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2083112202d9STejun Heo 	bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
208473f53c4aSTejun Heo 	int work_color;
20857e11629dSTejun Heo 	struct worker *collision;
20864e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
20874e6045f1SJohannes Berg 	/*
2088a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2089a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2090a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2091a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2092a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
20934e6045f1SJohannes Berg 	 */
20944d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
20954d82a1deSPeter Zijlstra 
20964d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
20974e6045f1SJohannes Berg #endif
20986fec10a1STejun Heo 	/*
20996fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21006fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
210124647570STejun Heo 	 * unbound or a disassociated pool.
21026fec10a1STejun Heo 	 */
21035f7dabfdSLai Jiangshan 	WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
210424647570STejun Heo 		     !(pool->flags & POOL_DISASSOCIATED) &&
2105ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
210625511a47STejun Heo 
21077e11629dSTejun Heo 	/*
21087e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21097e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21107e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21117e11629dSTejun Heo 	 * currently executing one.
21127e11629dSTejun Heo 	 */
2113c9e7cf27STejun Heo 	collision = find_worker_executing_work(pool, work);
21147e11629dSTejun Heo 	if (unlikely(collision)) {
21157e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21167e11629dSTejun Heo 		return;
21177e11629dSTejun Heo 	}
21181da177e4SLinus Torvalds 
21198930cabaSTejun Heo 	/* claim and dequeue */
21201da177e4SLinus Torvalds 	debug_work_deactivate(work);
2121c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2122c34056a3STejun Heo 	worker->current_work = work;
2123a2c1c57bSTejun Heo 	worker->current_func = work->func;
2124112202d9STejun Heo 	worker->current_pwq = pwq;
212573f53c4aSTejun Heo 	work_color = get_work_color(work);
21267a22ad75STejun Heo 
2127a62428c0STejun Heo 	list_del_init(&work->entry);
2128a62428c0STejun Heo 
2129649027d7STejun Heo 	/*
2130fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2131fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2132fb0e7bebSTejun Heo 	 */
2133fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2134fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2135fb0e7bebSTejun Heo 
2136974271c4STejun Heo 	/*
2137d565ed63STejun Heo 	 * Unbound pool isn't concurrency managed and work items should be
2138974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2139974271c4STejun Heo 	 */
214063d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
214163d95a91STejun Heo 		wake_up_worker(pool);
2142974271c4STejun Heo 
21438930cabaSTejun Heo 	/*
21447c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
2145d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
214623657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
214723657bb1STejun Heo 	 * disabled.
21488930cabaSTejun Heo 	 */
21497c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
21501da177e4SLinus Torvalds 
2151d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2152365970a1SDavid Howells 
2153112202d9STejun Heo 	lock_map_acquire_read(&pwq->wq->lockdep_map);
21543295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2155e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2156a2c1c57bSTejun Heo 	worker->current_func(work);
2157e36c886aSArjan van de Ven 	/*
2158e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2159e36c886aSArjan van de Ven 	 * point will only record its address.
2160e36c886aSArjan van de Ven 	 */
2161e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
21623295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
2163112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
21641da177e4SLinus Torvalds 
2165d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2166044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2167044c782cSValentin Ilie 		       "     last function: %pf\n",
2168a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2169a2c1c57bSTejun Heo 		       worker->current_func);
2170d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2171d5abe669SPeter Zijlstra 		dump_stack();
2172d5abe669SPeter Zijlstra 	}
2173d5abe669SPeter Zijlstra 
2174b22ce278STejun Heo 	/*
2175b22ce278STejun Heo 	 * The following prevents a kworker from hogging CPU on !PREEMPT
2176b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
2177b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
2178b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
2179b22ce278STejun Heo 	 * stop_machine.
2180b22ce278STejun Heo 	 */
2181b22ce278STejun Heo 	cond_resched();
2182b22ce278STejun Heo 
2183d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2184a62428c0STejun Heo 
2185fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2186fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2187fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2188fb0e7bebSTejun Heo 
2189a62428c0STejun Heo 	/* we're done with it, release */
219042f8570fSSasha Levin 	hash_del(&worker->hentry);
2191c34056a3STejun Heo 	worker->current_work = NULL;
2192a2c1c57bSTejun Heo 	worker->current_func = NULL;
2193112202d9STejun Heo 	worker->current_pwq = NULL;
21943d1cb205STejun Heo 	worker->desc_valid = false;
2195112202d9STejun Heo 	pwq_dec_nr_in_flight(pwq, work_color);
21961da177e4SLinus Torvalds }
21971da177e4SLinus Torvalds 
2198affee4b2STejun Heo /**
2199affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2200affee4b2STejun Heo  * @worker: self
2201affee4b2STejun Heo  *
2202affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2203affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2204affee4b2STejun Heo  * fetches a work from the top and executes it.
2205affee4b2STejun Heo  *
2206affee4b2STejun Heo  * CONTEXT:
2207d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2208affee4b2STejun Heo  * multiple times.
2209affee4b2STejun Heo  */
2210affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22111da177e4SLinus Torvalds {
2212affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2213affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2214a62428c0STejun Heo 						struct work_struct, entry);
2215c34056a3STejun Heo 		process_one_work(worker, work);
2216a62428c0STejun Heo 	}
22171da177e4SLinus Torvalds }
22181da177e4SLinus Torvalds 
22194690c4abSTejun Heo /**
22204690c4abSTejun Heo  * worker_thread - the worker thread function
2221c34056a3STejun Heo  * @__worker: self
22224690c4abSTejun Heo  *
2223c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
2224c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
2225c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
2226c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
2227c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
2228d185af30SYacine Belkadi  *
2229d185af30SYacine Belkadi  * Return: 0
22304690c4abSTejun Heo  */
2231c34056a3STejun Heo static int worker_thread(void *__worker)
22321da177e4SLinus Torvalds {
2233c34056a3STejun Heo 	struct worker *worker = __worker;
2234bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
22351da177e4SLinus Torvalds 
2236e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2237e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2238c8e55f36STejun Heo woke_up:
2239d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2240affee4b2STejun Heo 
2241a9ab775bSTejun Heo 	/* am I supposed to die? */
2242a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
2243d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
2244a9ab775bSTejun Heo 		WARN_ON_ONCE(!list_empty(&worker->entry));
2245e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
224660f5a4bcSLai Jiangshan 
224760f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
2248*7cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, worker->id);
224960f5a4bcSLai Jiangshan 		worker_detach_from_pool(worker, pool);
225060f5a4bcSLai Jiangshan 		kfree(worker);
2251c8e55f36STejun Heo 		return 0;
2252c8e55f36STejun Heo 	}
2253c8e55f36STejun Heo 
2254c8e55f36STejun Heo 	worker_leave_idle(worker);
2255db7bccf4STejun Heo recheck:
2256e22bee78STejun Heo 	/* no more worker necessary? */
225763d95a91STejun Heo 	if (!need_more_worker(pool))
2258e22bee78STejun Heo 		goto sleep;
2259e22bee78STejun Heo 
2260e22bee78STejun Heo 	/* do we need to manage? */
226163d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2262e22bee78STejun Heo 		goto recheck;
2263e22bee78STejun Heo 
2264c8e55f36STejun Heo 	/*
2265c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2266c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2267c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2268c8e55f36STejun Heo 	 */
22696183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
2270c8e55f36STejun Heo 
2271e22bee78STejun Heo 	/*
2272a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
2273a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
2274a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
2275a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
2276a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
2277e22bee78STejun Heo 	 */
2278a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2279e22bee78STejun Heo 
2280e22bee78STejun Heo 	do {
2281affee4b2STejun Heo 		struct work_struct *work =
2282bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2283affee4b2STejun Heo 					 struct work_struct, entry);
2284affee4b2STejun Heo 
2285c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2286affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2287affee4b2STejun Heo 			process_one_work(worker, work);
2288affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2289affee4b2STejun Heo 				process_scheduled_works(worker);
2290affee4b2STejun Heo 		} else {
2291c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2292affee4b2STejun Heo 			process_scheduled_works(worker);
2293affee4b2STejun Heo 		}
229463d95a91STejun Heo 	} while (keep_working(pool));
2295affee4b2STejun Heo 
2296e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2297d313dd85STejun Heo sleep:
2298c8e55f36STejun Heo 	/*
2299d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
2300d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
2301d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
2302d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
2303d565ed63STejun Heo 	 * event.
2304c8e55f36STejun Heo 	 */
2305c8e55f36STejun Heo 	worker_enter_idle(worker);
2306c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
2307d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
23081da177e4SLinus Torvalds 	schedule();
2309c8e55f36STejun Heo 	goto woke_up;
23101da177e4SLinus Torvalds }
23111da177e4SLinus Torvalds 
2312e22bee78STejun Heo /**
2313e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2314111c225aSTejun Heo  * @__rescuer: self
2315e22bee78STejun Heo  *
2316e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2317493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
2318e22bee78STejun Heo  *
2319706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
2320e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2321e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2322e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2323e22bee78STejun Heo  * the problem rescuer solves.
2324e22bee78STejun Heo  *
2325706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
2326706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
2327e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2328e22bee78STejun Heo  *
2329e22bee78STejun Heo  * This should happen rarely.
2330d185af30SYacine Belkadi  *
2331d185af30SYacine Belkadi  * Return: 0
2332e22bee78STejun Heo  */
2333111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2334e22bee78STejun Heo {
2335111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2336111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2337e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
23384d595b86SLai Jiangshan 	bool should_stop;
2339e22bee78STejun Heo 
2340e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2341111c225aSTejun Heo 
2342111c225aSTejun Heo 	/*
2343111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2344111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2345111c225aSTejun Heo 	 */
2346111c225aSTejun Heo 	rescuer->task->flags |= PF_WQ_WORKER;
2347e22bee78STejun Heo repeat:
2348e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
23491da177e4SLinus Torvalds 
23504d595b86SLai Jiangshan 	/*
23514d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
23524d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
23534d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
23544d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
23554d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
23564d595b86SLai Jiangshan 	 * list is always empty on exit.
23574d595b86SLai Jiangshan 	 */
23584d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
23591da177e4SLinus Torvalds 
2360493a1724STejun Heo 	/* see whether any pwq is asking for help */
23612e109a28STejun Heo 	spin_lock_irq(&wq_mayday_lock);
2362493a1724STejun Heo 
2363493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
2364493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2365493a1724STejun Heo 					struct pool_workqueue, mayday_node);
2366112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
2367e22bee78STejun Heo 		struct work_struct *work, *n;
2368e22bee78STejun Heo 
2369e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2370493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
2371493a1724STejun Heo 
23722e109a28STejun Heo 		spin_unlock_irq(&wq_mayday_lock);
2373e22bee78STejun Heo 
2374e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2375f36dc67bSLai Jiangshan 		worker_maybe_bind_and_lock(pool);
2376b3104104SLai Jiangshan 		rescuer->pool = pool;
2377e22bee78STejun Heo 
2378e22bee78STejun Heo 		/*
2379e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2380e22bee78STejun Heo 		 * process'em.
2381e22bee78STejun Heo 		 */
23826183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
2383bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2384112202d9STejun Heo 			if (get_work_pwq(work) == pwq)
2385e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2386e22bee78STejun Heo 
2387e22bee78STejun Heo 		process_scheduled_works(rescuer);
23887576958aSTejun Heo 
23897576958aSTejun Heo 		/*
239077668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
239177668c8bSLai Jiangshan 		 * go away while we're holding its lock.
239277668c8bSLai Jiangshan 		 */
239377668c8bSLai Jiangshan 		put_pwq(pwq);
239477668c8bSLai Jiangshan 
239577668c8bSLai Jiangshan 		/*
2396d565ed63STejun Heo 		 * Leave this pool.  If keep_working() is %true, notify a
23977576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
23987576958aSTejun Heo 		 * and stalling the execution.
23997576958aSTejun Heo 		 */
240063d95a91STejun Heo 		if (keep_working(pool))
240163d95a91STejun Heo 			wake_up_worker(pool);
24027576958aSTejun Heo 
2403b3104104SLai Jiangshan 		rescuer->pool = NULL;
2404493a1724STejun Heo 		spin_unlock(&pool->lock);
24052e109a28STejun Heo 		spin_lock(&wq_mayday_lock);
24061da177e4SLinus Torvalds 	}
24071da177e4SLinus Torvalds 
24082e109a28STejun Heo 	spin_unlock_irq(&wq_mayday_lock);
2409493a1724STejun Heo 
24104d595b86SLai Jiangshan 	if (should_stop) {
24114d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
24124d595b86SLai Jiangshan 		rescuer->task->flags &= ~PF_WQ_WORKER;
24134d595b86SLai Jiangshan 		return 0;
24144d595b86SLai Jiangshan 	}
24154d595b86SLai Jiangshan 
2416111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2417111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2418e22bee78STejun Heo 	schedule();
2419e22bee78STejun Heo 	goto repeat;
24201da177e4SLinus Torvalds }
24211da177e4SLinus Torvalds 
2422fc2e4d70SOleg Nesterov struct wq_barrier {
2423fc2e4d70SOleg Nesterov 	struct work_struct	work;
2424fc2e4d70SOleg Nesterov 	struct completion	done;
2425fc2e4d70SOleg Nesterov };
2426fc2e4d70SOleg Nesterov 
2427fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2428fc2e4d70SOleg Nesterov {
2429fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2430fc2e4d70SOleg Nesterov 	complete(&barr->done);
2431fc2e4d70SOleg Nesterov }
2432fc2e4d70SOleg Nesterov 
24334690c4abSTejun Heo /**
24344690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
2435112202d9STejun Heo  * @pwq: pwq to insert barrier into
24364690c4abSTejun Heo  * @barr: wq_barrier to insert
2437affee4b2STejun Heo  * @target: target work to attach @barr to
2438affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24394690c4abSTejun Heo  *
2440affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2441affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2442affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2443affee4b2STejun Heo  * cpu.
2444affee4b2STejun Heo  *
2445affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2446affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2447affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2448affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2449affee4b2STejun Heo  * after a work with LINKED flag set.
2450affee4b2STejun Heo  *
2451affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2452112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
24534690c4abSTejun Heo  *
24544690c4abSTejun Heo  * CONTEXT:
2455d565ed63STejun Heo  * spin_lock_irq(pool->lock).
24564690c4abSTejun Heo  */
2457112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
2458affee4b2STejun Heo 			      struct wq_barrier *barr,
2459affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2460fc2e4d70SOleg Nesterov {
2461affee4b2STejun Heo 	struct list_head *head;
2462affee4b2STejun Heo 	unsigned int linked = 0;
2463affee4b2STejun Heo 
2464dc186ad7SThomas Gleixner 	/*
2465d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
2466dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2467dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2468dc186ad7SThomas Gleixner 	 * might deadlock.
2469dc186ad7SThomas Gleixner 	 */
2470ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
247122df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2472fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
247383c22520SOleg Nesterov 
2474affee4b2STejun Heo 	/*
2475affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2476affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2477affee4b2STejun Heo 	 */
2478affee4b2STejun Heo 	if (worker)
2479affee4b2STejun Heo 		head = worker->scheduled.next;
2480affee4b2STejun Heo 	else {
2481affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2482affee4b2STejun Heo 
2483affee4b2STejun Heo 		head = target->entry.next;
2484affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2485affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2486affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2487affee4b2STejun Heo 	}
2488affee4b2STejun Heo 
2489dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2490112202d9STejun Heo 	insert_work(pwq, &barr->work, head,
2491affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2492fc2e4d70SOleg Nesterov }
2493fc2e4d70SOleg Nesterov 
249473f53c4aSTejun Heo /**
2495112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
249673f53c4aSTejun Heo  * @wq: workqueue being flushed
249773f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
249873f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
249973f53c4aSTejun Heo  *
2500112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
250173f53c4aSTejun Heo  *
2502112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
2503112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
2504112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
2505112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
2506112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
250773f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
250873f53c4aSTejun Heo  *
250973f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
251073f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
251173f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
251273f53c4aSTejun Heo  * is returned.
251373f53c4aSTejun Heo  *
2514112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
251573f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
251673f53c4aSTejun Heo  * advanced to @work_color.
251773f53c4aSTejun Heo  *
251873f53c4aSTejun Heo  * CONTEXT:
25193c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
252073f53c4aSTejun Heo  *
2521d185af30SYacine Belkadi  * Return:
252273f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
252373f53c4aSTejun Heo  * otherwise.
252473f53c4aSTejun Heo  */
2525112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
252673f53c4aSTejun Heo 				      int flush_color, int work_color)
25271da177e4SLinus Torvalds {
252873f53c4aSTejun Heo 	bool wait = false;
252949e3cf44STejun Heo 	struct pool_workqueue *pwq;
25301da177e4SLinus Torvalds 
253173f53c4aSTejun Heo 	if (flush_color >= 0) {
25326183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2533112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
2534dc186ad7SThomas Gleixner 	}
253514441960SOleg Nesterov 
253649e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2537112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
25381da177e4SLinus Torvalds 
2539b09f4fd3SLai Jiangshan 		spin_lock_irq(&pool->lock);
254073f53c4aSTejun Heo 
254173f53c4aSTejun Heo 		if (flush_color >= 0) {
25426183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
254373f53c4aSTejun Heo 
2544112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
2545112202d9STejun Heo 				pwq->flush_color = flush_color;
2546112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
254773f53c4aSTejun Heo 				wait = true;
25481da177e4SLinus Torvalds 			}
254973f53c4aSTejun Heo 		}
255073f53c4aSTejun Heo 
255173f53c4aSTejun Heo 		if (work_color >= 0) {
25526183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2553112202d9STejun Heo 			pwq->work_color = work_color;
255473f53c4aSTejun Heo 		}
255573f53c4aSTejun Heo 
2556b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pool->lock);
25571da177e4SLinus Torvalds 	}
25581da177e4SLinus Torvalds 
2559112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
256073f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
256173f53c4aSTejun Heo 
256273f53c4aSTejun Heo 	return wait;
256383c22520SOleg Nesterov }
25641da177e4SLinus Torvalds 
25650fcb78c2SRolf Eike Beer /**
25661da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
25670fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
25681da177e4SLinus Torvalds  *
2569c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
2570c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
25711da177e4SLinus Torvalds  */
25727ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
25731da177e4SLinus Torvalds {
257473f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
257573f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
257673f53c4aSTejun Heo 		.flush_color = -1,
257773f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
257873f53c4aSTejun Heo 	};
257973f53c4aSTejun Heo 	int next_color;
2580b1f4ec17SOleg Nesterov 
25813295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
25823295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
258373f53c4aSTejun Heo 
25843c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
258573f53c4aSTejun Heo 
258673f53c4aSTejun Heo 	/*
258773f53c4aSTejun Heo 	 * Start-to-wait phase
258873f53c4aSTejun Heo 	 */
258973f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
259073f53c4aSTejun Heo 
259173f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
259273f53c4aSTejun Heo 		/*
259373f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
259473f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
259573f53c4aSTejun Heo 		 * by one.
259673f53c4aSTejun Heo 		 */
25976183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
259873f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
259973f53c4aSTejun Heo 		wq->work_color = next_color;
260073f53c4aSTejun Heo 
260173f53c4aSTejun Heo 		if (!wq->first_flusher) {
260273f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
26036183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
260473f53c4aSTejun Heo 
260573f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
260673f53c4aSTejun Heo 
2607112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
260873f53c4aSTejun Heo 						       wq->work_color)) {
260973f53c4aSTejun Heo 				/* nothing to flush, done */
261073f53c4aSTejun Heo 				wq->flush_color = next_color;
261173f53c4aSTejun Heo 				wq->first_flusher = NULL;
261273f53c4aSTejun Heo 				goto out_unlock;
261373f53c4aSTejun Heo 			}
261473f53c4aSTejun Heo 		} else {
261573f53c4aSTejun Heo 			/* wait in queue */
26166183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
261773f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
2618112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
261973f53c4aSTejun Heo 		}
262073f53c4aSTejun Heo 	} else {
262173f53c4aSTejun Heo 		/*
262273f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
262373f53c4aSTejun Heo 		 * The next flush completion will assign us
262473f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
262573f53c4aSTejun Heo 		 */
262673f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
262773f53c4aSTejun Heo 	}
262873f53c4aSTejun Heo 
26293c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
263073f53c4aSTejun Heo 
263173f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
263273f53c4aSTejun Heo 
263373f53c4aSTejun Heo 	/*
263473f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
263573f53c4aSTejun Heo 	 *
263673f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
263773f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
263873f53c4aSTejun Heo 	 */
263973f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
264073f53c4aSTejun Heo 		return;
264173f53c4aSTejun Heo 
26423c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
264373f53c4aSTejun Heo 
26444ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
26454ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
26464ce48b37STejun Heo 		goto out_unlock;
26474ce48b37STejun Heo 
264873f53c4aSTejun Heo 	wq->first_flusher = NULL;
264973f53c4aSTejun Heo 
26506183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
26516183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
265273f53c4aSTejun Heo 
265373f53c4aSTejun Heo 	while (true) {
265473f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
265573f53c4aSTejun Heo 
265673f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
265773f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
265873f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
265973f53c4aSTejun Heo 				break;
266073f53c4aSTejun Heo 			list_del_init(&next->list);
266173f53c4aSTejun Heo 			complete(&next->done);
266273f53c4aSTejun Heo 		}
266373f53c4aSTejun Heo 
26646183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
266573f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
266673f53c4aSTejun Heo 
266773f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
266873f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
266973f53c4aSTejun Heo 
267073f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
267173f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
267273f53c4aSTejun Heo 			/*
267373f53c4aSTejun Heo 			 * Assign the same color to all overflowed
267473f53c4aSTejun Heo 			 * flushers, advance work_color and append to
267573f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
267673f53c4aSTejun Heo 			 * phase for these overflowed flushers.
267773f53c4aSTejun Heo 			 */
267873f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
267973f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
268073f53c4aSTejun Heo 
268173f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
268273f53c4aSTejun Heo 
268373f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
268473f53c4aSTejun Heo 					      &wq->flusher_queue);
2685112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
268673f53c4aSTejun Heo 		}
268773f53c4aSTejun Heo 
268873f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
26896183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
269073f53c4aSTejun Heo 			break;
269173f53c4aSTejun Heo 		}
269273f53c4aSTejun Heo 
269373f53c4aSTejun Heo 		/*
269473f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
2695112202d9STejun Heo 		 * the new first flusher and arm pwqs.
269673f53c4aSTejun Heo 		 */
26976183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
26986183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
269973f53c4aSTejun Heo 
270073f53c4aSTejun Heo 		list_del_init(&next->list);
270173f53c4aSTejun Heo 		wq->first_flusher = next;
270273f53c4aSTejun Heo 
2703112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
270473f53c4aSTejun Heo 			break;
270573f53c4aSTejun Heo 
270673f53c4aSTejun Heo 		/*
270773f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
270873f53c4aSTejun Heo 		 * flusher and repeat cascading.
270973f53c4aSTejun Heo 		 */
271073f53c4aSTejun Heo 		wq->first_flusher = NULL;
271173f53c4aSTejun Heo 	}
271273f53c4aSTejun Heo 
271373f53c4aSTejun Heo out_unlock:
27143c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
27151da177e4SLinus Torvalds }
2716ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27171da177e4SLinus Torvalds 
27189c5a2ba7STejun Heo /**
27199c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27209c5a2ba7STejun Heo  * @wq: workqueue to drain
27219c5a2ba7STejun Heo  *
27229c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27239c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27249c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27259c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27269c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27279c5a2ba7STejun Heo  * takes too long.
27289c5a2ba7STejun Heo  */
27299c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27309c5a2ba7STejun Heo {
27319c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
273249e3cf44STejun Heo 	struct pool_workqueue *pwq;
27339c5a2ba7STejun Heo 
27349c5a2ba7STejun Heo 	/*
27359c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27369c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
2737618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
27389c5a2ba7STejun Heo 	 */
273987fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
27409c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
2741618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
274287fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
27439c5a2ba7STejun Heo reflush:
27449c5a2ba7STejun Heo 	flush_workqueue(wq);
27459c5a2ba7STejun Heo 
2746b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
274776af4d93STejun Heo 
274849e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2749fa2563e4SThomas Tuttle 		bool drained;
27509c5a2ba7STejun Heo 
2751b09f4fd3SLai Jiangshan 		spin_lock_irq(&pwq->pool->lock);
2752112202d9STejun Heo 		drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2753b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pwq->pool->lock);
2754fa2563e4SThomas Tuttle 
2755fa2563e4SThomas Tuttle 		if (drained)
27569c5a2ba7STejun Heo 			continue;
27579c5a2ba7STejun Heo 
27589c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
27599c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2760c5aa87bbSTejun Heo 			pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
27619c5a2ba7STejun Heo 				wq->name, flush_cnt);
276276af4d93STejun Heo 
2763b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
27649c5a2ba7STejun Heo 		goto reflush;
27659c5a2ba7STejun Heo 	}
27669c5a2ba7STejun Heo 
27679c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
2768618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
276987fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
27709c5a2ba7STejun Heo }
27719c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
27729c5a2ba7STejun Heo 
2773606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2774baf59022STejun Heo {
2775baf59022STejun Heo 	struct worker *worker = NULL;
2776c9e7cf27STejun Heo 	struct worker_pool *pool;
2777112202d9STejun Heo 	struct pool_workqueue *pwq;
2778baf59022STejun Heo 
2779baf59022STejun Heo 	might_sleep();
2780baf59022STejun Heo 
2781fa1b54e6STejun Heo 	local_irq_disable();
2782fa1b54e6STejun Heo 	pool = get_work_pool(work);
2783fa1b54e6STejun Heo 	if (!pool) {
2784fa1b54e6STejun Heo 		local_irq_enable();
2785fa1b54e6STejun Heo 		return false;
2786fa1b54e6STejun Heo 	}
2787fa1b54e6STejun Heo 
2788fa1b54e6STejun Heo 	spin_lock(&pool->lock);
27890b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
2790112202d9STejun Heo 	pwq = get_work_pwq(work);
2791112202d9STejun Heo 	if (pwq) {
2792112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
2793baf59022STejun Heo 			goto already_gone;
2794606a5020STejun Heo 	} else {
2795c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
2796baf59022STejun Heo 		if (!worker)
2797baf59022STejun Heo 			goto already_gone;
2798112202d9STejun Heo 		pwq = worker->current_pwq;
2799606a5020STejun Heo 	}
2800baf59022STejun Heo 
2801112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
2802d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2803baf59022STejun Heo 
2804e159489bSTejun Heo 	/*
2805e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2806e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2807e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2808e159489bSTejun Heo 	 * access.
2809e159489bSTejun Heo 	 */
2810493008a8STejun Heo 	if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
2811112202d9STejun Heo 		lock_map_acquire(&pwq->wq->lockdep_map);
2812e159489bSTejun Heo 	else
2813112202d9STejun Heo 		lock_map_acquire_read(&pwq->wq->lockdep_map);
2814112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
2815e159489bSTejun Heo 
2816baf59022STejun Heo 	return true;
2817baf59022STejun Heo already_gone:
2818d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2819baf59022STejun Heo 	return false;
2820baf59022STejun Heo }
2821baf59022STejun Heo 
2822db700897SOleg Nesterov /**
2823401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2824401a8d04STejun Heo  * @work: the work to flush
2825db700897SOleg Nesterov  *
2826606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2827606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2828401a8d04STejun Heo  *
2829d185af30SYacine Belkadi  * Return:
2830401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2831401a8d04STejun Heo  * %false if it was already idle.
2832db700897SOleg Nesterov  */
2833401a8d04STejun Heo bool flush_work(struct work_struct *work)
2834db700897SOleg Nesterov {
283512997d1aSBjorn Helgaas 	struct wq_barrier barr;
283612997d1aSBjorn Helgaas 
28370976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28380976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28390976dfc1SStephen Boyd 
284012997d1aSBjorn Helgaas 	if (start_flush_work(work, &barr)) {
284112997d1aSBjorn Helgaas 		wait_for_completion(&barr.done);
284212997d1aSBjorn Helgaas 		destroy_work_on_stack(&barr.work);
284312997d1aSBjorn Helgaas 		return true;
284412997d1aSBjorn Helgaas 	} else {
284512997d1aSBjorn Helgaas 		return false;
284612997d1aSBjorn Helgaas 	}
2847606a5020STejun Heo }
2848db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2849db700897SOleg Nesterov 
285036e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2851401a8d04STejun Heo {
2852bbb68dfaSTejun Heo 	unsigned long flags;
28531f1f642eSOleg Nesterov 	int ret;
28541f1f642eSOleg Nesterov 
28551f1f642eSOleg Nesterov 	do {
2856bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2857bbb68dfaSTejun Heo 		/*
2858bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2859bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2860bbb68dfaSTejun Heo 		 */
2861bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2862606a5020STejun Heo 			flush_work(work);
28631f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
28641f1f642eSOleg Nesterov 
2865bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2866bbb68dfaSTejun Heo 	mark_work_canceling(work);
2867bbb68dfaSTejun Heo 	local_irq_restore(flags);
2868bbb68dfaSTejun Heo 
2869606a5020STejun Heo 	flush_work(work);
28707a22ad75STejun Heo 	clear_work_data(work);
28711f1f642eSOleg Nesterov 	return ret;
28721f1f642eSOleg Nesterov }
28731f1f642eSOleg Nesterov 
28746e84d644SOleg Nesterov /**
2875401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2876401a8d04STejun Heo  * @work: the work to cancel
28776e84d644SOleg Nesterov  *
2878401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2879401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2880401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2881401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
28821f1f642eSOleg Nesterov  *
2883401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2884401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
28856e84d644SOleg Nesterov  *
2886401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
28876e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2888401a8d04STejun Heo  *
2889d185af30SYacine Belkadi  * Return:
2890401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
28916e84d644SOleg Nesterov  */
2892401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
28936e84d644SOleg Nesterov {
289436e227d2STejun Heo 	return __cancel_work_timer(work, false);
2895b89deed3SOleg Nesterov }
289628e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2897b89deed3SOleg Nesterov 
28986e84d644SOleg Nesterov /**
2899401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2900401a8d04STejun Heo  * @dwork: the delayed work to flush
29016e84d644SOleg Nesterov  *
2902401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2903401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2904401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29051f1f642eSOleg Nesterov  *
2906d185af30SYacine Belkadi  * Return:
2907401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2908401a8d04STejun Heo  * %false if it was already idle.
29096e84d644SOleg Nesterov  */
2910401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2911401a8d04STejun Heo {
29128930cabaSTejun Heo 	local_irq_disable();
2913401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
291460c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
29158930cabaSTejun Heo 	local_irq_enable();
2916401a8d04STejun Heo 	return flush_work(&dwork->work);
2917401a8d04STejun Heo }
2918401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2919401a8d04STejun Heo 
2920401a8d04STejun Heo /**
292157b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
292257b30ae7STejun Heo  * @dwork: delayed_work to cancel
292309383498STejun Heo  *
2924d185af30SYacine Belkadi  * Kill off a pending delayed_work.
2925d185af30SYacine Belkadi  *
2926d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
2927d185af30SYacine Belkadi  * pending.
2928d185af30SYacine Belkadi  *
2929d185af30SYacine Belkadi  * Note:
2930d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
2931d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
2932d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
293309383498STejun Heo  *
293457b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
293509383498STejun Heo  */
293657b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
293709383498STejun Heo {
293857b30ae7STejun Heo 	unsigned long flags;
293957b30ae7STejun Heo 	int ret;
294057b30ae7STejun Heo 
294157b30ae7STejun Heo 	do {
294257b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
294357b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
294457b30ae7STejun Heo 
294557b30ae7STejun Heo 	if (unlikely(ret < 0))
294657b30ae7STejun Heo 		return false;
294757b30ae7STejun Heo 
29487c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(&dwork->work,
29497c3eed5cSTejun Heo 					get_work_pool_id(&dwork->work));
295057b30ae7STejun Heo 	local_irq_restore(flags);
2951c0158ca6SDan Magenheimer 	return ret;
295209383498STejun Heo }
295357b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
295409383498STejun Heo 
295509383498STejun Heo /**
2956401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2957401a8d04STejun Heo  * @dwork: the delayed work cancel
2958401a8d04STejun Heo  *
2959401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2960401a8d04STejun Heo  *
2961d185af30SYacine Belkadi  * Return:
2962401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2963401a8d04STejun Heo  */
2964401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
29656e84d644SOleg Nesterov {
296636e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
29676e84d644SOleg Nesterov }
2968f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
29691da177e4SLinus Torvalds 
29700fcb78c2SRolf Eike Beer /**
297131ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
2972b6136773SAndrew Morton  * @func: the function to call
2973b6136773SAndrew Morton  *
297431ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
297531ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
2976b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
297731ddd871STejun Heo  *
2978d185af30SYacine Belkadi  * Return:
297931ddd871STejun Heo  * 0 on success, -errno on failure.
2980b6136773SAndrew Morton  */
298165f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
298215316ba8SChristoph Lameter {
298315316ba8SChristoph Lameter 	int cpu;
298438f51568SNamhyung Kim 	struct work_struct __percpu *works;
298515316ba8SChristoph Lameter 
2986b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
2987b6136773SAndrew Morton 	if (!works)
298815316ba8SChristoph Lameter 		return -ENOMEM;
2989b6136773SAndrew Morton 
299095402b38SGautham R Shenoy 	get_online_cpus();
299193981800STejun Heo 
299215316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
29939bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
29949bfb1839SIngo Molnar 
29959bfb1839SIngo Molnar 		INIT_WORK(work, func);
29968de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
299715316ba8SChristoph Lameter 	}
299893981800STejun Heo 
299993981800STejun Heo 	for_each_online_cpu(cpu)
30008616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
300193981800STejun Heo 
300295402b38SGautham R Shenoy 	put_online_cpus();
3003b6136773SAndrew Morton 	free_percpu(works);
300415316ba8SChristoph Lameter 	return 0;
300515316ba8SChristoph Lameter }
300615316ba8SChristoph Lameter 
3007eef6a7d5SAlan Stern /**
3008eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3009eef6a7d5SAlan Stern  *
3010eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3011eef6a7d5SAlan Stern  * completion.
3012eef6a7d5SAlan Stern  *
3013eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3014eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3015eef6a7d5SAlan Stern  * will lead to deadlock:
3016eef6a7d5SAlan Stern  *
3017eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3018eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3019eef6a7d5SAlan Stern  *
3020eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3021eef6a7d5SAlan Stern  *
3022eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3023eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3024eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3025eef6a7d5SAlan Stern  *
3026eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3027eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3028eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3029eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3030eef6a7d5SAlan Stern  */
30311da177e4SLinus Torvalds void flush_scheduled_work(void)
30321da177e4SLinus Torvalds {
3033d320c038STejun Heo 	flush_workqueue(system_wq);
30341da177e4SLinus Torvalds }
3035ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
30361da177e4SLinus Torvalds 
30371da177e4SLinus Torvalds /**
30381fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
30391fa44ecaSJames Bottomley  * @fn:		the function to execute
30401fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
30411fa44ecaSJames Bottomley  *		be available when the work executes)
30421fa44ecaSJames Bottomley  *
30431fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
30441fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
30451fa44ecaSJames Bottomley  *
3046d185af30SYacine Belkadi  * Return:	0 - function was executed
30471fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
30481fa44ecaSJames Bottomley  */
304965f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
30501fa44ecaSJames Bottomley {
30511fa44ecaSJames Bottomley 	if (!in_interrupt()) {
305265f27f38SDavid Howells 		fn(&ew->work);
30531fa44ecaSJames Bottomley 		return 0;
30541fa44ecaSJames Bottomley 	}
30551fa44ecaSJames Bottomley 
305665f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
30571fa44ecaSJames Bottomley 	schedule_work(&ew->work);
30581fa44ecaSJames Bottomley 
30591fa44ecaSJames Bottomley 	return 1;
30601fa44ecaSJames Bottomley }
30611fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
30621fa44ecaSJames Bottomley 
3063226223abSTejun Heo #ifdef CONFIG_SYSFS
3064226223abSTejun Heo /*
3065226223abSTejun Heo  * Workqueues with WQ_SYSFS flag set is visible to userland via
3066226223abSTejun Heo  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
3067226223abSTejun Heo  * following attributes.
3068226223abSTejun Heo  *
3069226223abSTejun Heo  *  per_cpu	RO bool	: whether the workqueue is per-cpu or unbound
3070226223abSTejun Heo  *  max_active	RW int	: maximum number of in-flight work items
3071226223abSTejun Heo  *
3072226223abSTejun Heo  * Unbound workqueues have the following extra attributes.
3073226223abSTejun Heo  *
3074226223abSTejun Heo  *  id		RO int	: the associated pool ID
3075226223abSTejun Heo  *  nice	RW int	: nice value of the workers
3076226223abSTejun Heo  *  cpumask	RW mask	: bitmask of allowed CPUs for the workers
3077226223abSTejun Heo  */
3078226223abSTejun Heo struct wq_device {
3079226223abSTejun Heo 	struct workqueue_struct		*wq;
3080226223abSTejun Heo 	struct device			dev;
3081226223abSTejun Heo };
3082226223abSTejun Heo 
3083226223abSTejun Heo static struct workqueue_struct *dev_to_wq(struct device *dev)
3084226223abSTejun Heo {
3085226223abSTejun Heo 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3086226223abSTejun Heo 
3087226223abSTejun Heo 	return wq_dev->wq;
3088226223abSTejun Heo }
3089226223abSTejun Heo 
30901a6661daSGreg Kroah-Hartman static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
30911a6661daSGreg Kroah-Hartman 			    char *buf)
3092226223abSTejun Heo {
3093226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3094226223abSTejun Heo 
3095226223abSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
3096226223abSTejun Heo }
30971a6661daSGreg Kroah-Hartman static DEVICE_ATTR_RO(per_cpu);
3098226223abSTejun Heo 
30991a6661daSGreg Kroah-Hartman static ssize_t max_active_show(struct device *dev,
3100226223abSTejun Heo 			       struct device_attribute *attr, char *buf)
3101226223abSTejun Heo {
3102226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3103226223abSTejun Heo 
3104226223abSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
3105226223abSTejun Heo }
3106226223abSTejun Heo 
31071a6661daSGreg Kroah-Hartman static ssize_t max_active_store(struct device *dev,
31081a6661daSGreg Kroah-Hartman 				struct device_attribute *attr, const char *buf,
31091a6661daSGreg Kroah-Hartman 				size_t count)
3110226223abSTejun Heo {
3111226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3112226223abSTejun Heo 	int val;
3113226223abSTejun Heo 
3114226223abSTejun Heo 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
3115226223abSTejun Heo 		return -EINVAL;
3116226223abSTejun Heo 
3117226223abSTejun Heo 	workqueue_set_max_active(wq, val);
3118226223abSTejun Heo 	return count;
3119226223abSTejun Heo }
31201a6661daSGreg Kroah-Hartman static DEVICE_ATTR_RW(max_active);
3121226223abSTejun Heo 
31221a6661daSGreg Kroah-Hartman static struct attribute *wq_sysfs_attrs[] = {
31231a6661daSGreg Kroah-Hartman 	&dev_attr_per_cpu.attr,
31241a6661daSGreg Kroah-Hartman 	&dev_attr_max_active.attr,
31251a6661daSGreg Kroah-Hartman 	NULL,
3126226223abSTejun Heo };
31271a6661daSGreg Kroah-Hartman ATTRIBUTE_GROUPS(wq_sysfs);
3128226223abSTejun Heo 
3129d55262c4STejun Heo static ssize_t wq_pool_ids_show(struct device *dev,
3130226223abSTejun Heo 				struct device_attribute *attr, char *buf)
3131226223abSTejun Heo {
3132226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3133d55262c4STejun Heo 	const char *delim = "";
3134d55262c4STejun Heo 	int node, written = 0;
3135226223abSTejun Heo 
3136226223abSTejun Heo 	rcu_read_lock_sched();
3137d55262c4STejun Heo 	for_each_node(node) {
3138d55262c4STejun Heo 		written += scnprintf(buf + written, PAGE_SIZE - written,
3139d55262c4STejun Heo 				     "%s%d:%d", delim, node,
3140d55262c4STejun Heo 				     unbound_pwq_by_node(wq, node)->pool->id);
3141d55262c4STejun Heo 		delim = " ";
3142d55262c4STejun Heo 	}
3143d55262c4STejun Heo 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3144226223abSTejun Heo 	rcu_read_unlock_sched();
3145226223abSTejun Heo 
3146226223abSTejun Heo 	return written;
3147226223abSTejun Heo }
3148226223abSTejun Heo 
3149226223abSTejun Heo static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3150226223abSTejun Heo 			    char *buf)
3151226223abSTejun Heo {
3152226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3153226223abSTejun Heo 	int written;
3154226223abSTejun Heo 
31556029a918STejun Heo 	mutex_lock(&wq->mutex);
31566029a918STejun Heo 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
31576029a918STejun Heo 	mutex_unlock(&wq->mutex);
3158226223abSTejun Heo 
3159226223abSTejun Heo 	return written;
3160226223abSTejun Heo }
3161226223abSTejun Heo 
3162226223abSTejun Heo /* prepare workqueue_attrs for sysfs store operations */
3163226223abSTejun Heo static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3164226223abSTejun Heo {
3165226223abSTejun Heo 	struct workqueue_attrs *attrs;
3166226223abSTejun Heo 
3167226223abSTejun Heo 	attrs = alloc_workqueue_attrs(GFP_KERNEL);
3168226223abSTejun Heo 	if (!attrs)
3169226223abSTejun Heo 		return NULL;
3170226223abSTejun Heo 
31716029a918STejun Heo 	mutex_lock(&wq->mutex);
31726029a918STejun Heo 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
31736029a918STejun Heo 	mutex_unlock(&wq->mutex);
3174226223abSTejun Heo 	return attrs;
3175226223abSTejun Heo }
3176226223abSTejun Heo 
3177226223abSTejun Heo static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3178226223abSTejun Heo 			     const char *buf, size_t count)
3179226223abSTejun Heo {
3180226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3181226223abSTejun Heo 	struct workqueue_attrs *attrs;
3182226223abSTejun Heo 	int ret;
3183226223abSTejun Heo 
3184226223abSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
3185226223abSTejun Heo 	if (!attrs)
3186226223abSTejun Heo 		return -ENOMEM;
3187226223abSTejun Heo 
3188226223abSTejun Heo 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
318914481842SDongsheng Yang 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
3190226223abSTejun Heo 		ret = apply_workqueue_attrs(wq, attrs);
3191226223abSTejun Heo 	else
3192226223abSTejun Heo 		ret = -EINVAL;
3193226223abSTejun Heo 
3194226223abSTejun Heo 	free_workqueue_attrs(attrs);
3195226223abSTejun Heo 	return ret ?: count;
3196226223abSTejun Heo }
3197226223abSTejun Heo 
3198226223abSTejun Heo static ssize_t wq_cpumask_show(struct device *dev,
3199226223abSTejun Heo 			       struct device_attribute *attr, char *buf)
3200226223abSTejun Heo {
3201226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3202226223abSTejun Heo 	int written;
3203226223abSTejun Heo 
32046029a918STejun Heo 	mutex_lock(&wq->mutex);
32056029a918STejun Heo 	written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
32066029a918STejun Heo 	mutex_unlock(&wq->mutex);
3207226223abSTejun Heo 
3208226223abSTejun Heo 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3209226223abSTejun Heo 	return written;
3210226223abSTejun Heo }
3211226223abSTejun Heo 
3212226223abSTejun Heo static ssize_t wq_cpumask_store(struct device *dev,
3213226223abSTejun Heo 				struct device_attribute *attr,
3214226223abSTejun Heo 				const char *buf, size_t count)
3215226223abSTejun Heo {
3216226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3217226223abSTejun Heo 	struct workqueue_attrs *attrs;
3218226223abSTejun Heo 	int ret;
3219226223abSTejun Heo 
3220226223abSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
3221226223abSTejun Heo 	if (!attrs)
3222226223abSTejun Heo 		return -ENOMEM;
3223226223abSTejun Heo 
3224226223abSTejun Heo 	ret = cpumask_parse(buf, attrs->cpumask);
3225226223abSTejun Heo 	if (!ret)
3226226223abSTejun Heo 		ret = apply_workqueue_attrs(wq, attrs);
3227226223abSTejun Heo 
3228226223abSTejun Heo 	free_workqueue_attrs(attrs);
3229226223abSTejun Heo 	return ret ?: count;
3230226223abSTejun Heo }
3231226223abSTejun Heo 
3232d55262c4STejun Heo static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
3233d55262c4STejun Heo 			    char *buf)
3234d55262c4STejun Heo {
3235d55262c4STejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3236d55262c4STejun Heo 	int written;
3237d55262c4STejun Heo 
3238d55262c4STejun Heo 	mutex_lock(&wq->mutex);
3239d55262c4STejun Heo 	written = scnprintf(buf, PAGE_SIZE, "%d\n",
3240d55262c4STejun Heo 			    !wq->unbound_attrs->no_numa);
3241d55262c4STejun Heo 	mutex_unlock(&wq->mutex);
3242d55262c4STejun Heo 
3243d55262c4STejun Heo 	return written;
3244d55262c4STejun Heo }
3245d55262c4STejun Heo 
3246d55262c4STejun Heo static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
3247d55262c4STejun Heo 			     const char *buf, size_t count)
3248d55262c4STejun Heo {
3249d55262c4STejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3250d55262c4STejun Heo 	struct workqueue_attrs *attrs;
3251d55262c4STejun Heo 	int v, ret;
3252d55262c4STejun Heo 
3253d55262c4STejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
3254d55262c4STejun Heo 	if (!attrs)
3255d55262c4STejun Heo 		return -ENOMEM;
3256d55262c4STejun Heo 
3257d55262c4STejun Heo 	ret = -EINVAL;
3258d55262c4STejun Heo 	if (sscanf(buf, "%d", &v) == 1) {
3259d55262c4STejun Heo 		attrs->no_numa = !v;
3260d55262c4STejun Heo 		ret = apply_workqueue_attrs(wq, attrs);
3261d55262c4STejun Heo 	}
3262d55262c4STejun Heo 
3263d55262c4STejun Heo 	free_workqueue_attrs(attrs);
3264d55262c4STejun Heo 	return ret ?: count;
3265d55262c4STejun Heo }
3266d55262c4STejun Heo 
3267226223abSTejun Heo static struct device_attribute wq_sysfs_unbound_attrs[] = {
3268d55262c4STejun Heo 	__ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
3269226223abSTejun Heo 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3270226223abSTejun Heo 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
3271d55262c4STejun Heo 	__ATTR(numa, 0644, wq_numa_show, wq_numa_store),
3272226223abSTejun Heo 	__ATTR_NULL,
3273226223abSTejun Heo };
3274226223abSTejun Heo 
3275226223abSTejun Heo static struct bus_type wq_subsys = {
3276226223abSTejun Heo 	.name				= "workqueue",
32771a6661daSGreg Kroah-Hartman 	.dev_groups			= wq_sysfs_groups,
3278226223abSTejun Heo };
3279226223abSTejun Heo 
3280226223abSTejun Heo static int __init wq_sysfs_init(void)
3281226223abSTejun Heo {
3282226223abSTejun Heo 	return subsys_virtual_register(&wq_subsys, NULL);
3283226223abSTejun Heo }
3284226223abSTejun Heo core_initcall(wq_sysfs_init);
3285226223abSTejun Heo 
3286226223abSTejun Heo static void wq_device_release(struct device *dev)
3287226223abSTejun Heo {
3288226223abSTejun Heo 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3289226223abSTejun Heo 
3290226223abSTejun Heo 	kfree(wq_dev);
3291226223abSTejun Heo }
3292226223abSTejun Heo 
3293226223abSTejun Heo /**
3294226223abSTejun Heo  * workqueue_sysfs_register - make a workqueue visible in sysfs
3295226223abSTejun Heo  * @wq: the workqueue to register
3296226223abSTejun Heo  *
3297226223abSTejun Heo  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3298226223abSTejun Heo  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3299226223abSTejun Heo  * which is the preferred method.
3300226223abSTejun Heo  *
3301226223abSTejun Heo  * Workqueue user should use this function directly iff it wants to apply
3302226223abSTejun Heo  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3303226223abSTejun Heo  * apply_workqueue_attrs() may race against userland updating the
3304226223abSTejun Heo  * attributes.
3305226223abSTejun Heo  *
3306d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.
3307226223abSTejun Heo  */
3308226223abSTejun Heo int workqueue_sysfs_register(struct workqueue_struct *wq)
3309226223abSTejun Heo {
3310226223abSTejun Heo 	struct wq_device *wq_dev;
3311226223abSTejun Heo 	int ret;
3312226223abSTejun Heo 
3313226223abSTejun Heo 	/*
3314226223abSTejun Heo 	 * Adjusting max_active or creating new pwqs by applyting
3315226223abSTejun Heo 	 * attributes breaks ordering guarantee.  Disallow exposing ordered
3316226223abSTejun Heo 	 * workqueues.
3317226223abSTejun Heo 	 */
3318226223abSTejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
3319226223abSTejun Heo 		return -EINVAL;
3320226223abSTejun Heo 
3321226223abSTejun Heo 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3322226223abSTejun Heo 	if (!wq_dev)
3323226223abSTejun Heo 		return -ENOMEM;
3324226223abSTejun Heo 
3325226223abSTejun Heo 	wq_dev->wq = wq;
3326226223abSTejun Heo 	wq_dev->dev.bus = &wq_subsys;
3327226223abSTejun Heo 	wq_dev->dev.init_name = wq->name;
3328226223abSTejun Heo 	wq_dev->dev.release = wq_device_release;
3329226223abSTejun Heo 
3330226223abSTejun Heo 	/*
3331226223abSTejun Heo 	 * unbound_attrs are created separately.  Suppress uevent until
3332226223abSTejun Heo 	 * everything is ready.
3333226223abSTejun Heo 	 */
3334226223abSTejun Heo 	dev_set_uevent_suppress(&wq_dev->dev, true);
3335226223abSTejun Heo 
3336226223abSTejun Heo 	ret = device_register(&wq_dev->dev);
3337226223abSTejun Heo 	if (ret) {
3338226223abSTejun Heo 		kfree(wq_dev);
3339226223abSTejun Heo 		wq->wq_dev = NULL;
3340226223abSTejun Heo 		return ret;
3341226223abSTejun Heo 	}
3342226223abSTejun Heo 
3343226223abSTejun Heo 	if (wq->flags & WQ_UNBOUND) {
3344226223abSTejun Heo 		struct device_attribute *attr;
3345226223abSTejun Heo 
3346226223abSTejun Heo 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3347226223abSTejun Heo 			ret = device_create_file(&wq_dev->dev, attr);
3348226223abSTejun Heo 			if (ret) {
3349226223abSTejun Heo 				device_unregister(&wq_dev->dev);
3350226223abSTejun Heo 				wq->wq_dev = NULL;
3351226223abSTejun Heo 				return ret;
3352226223abSTejun Heo 			}
3353226223abSTejun Heo 		}
3354226223abSTejun Heo 	}
3355226223abSTejun Heo 
3356226223abSTejun Heo 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3357226223abSTejun Heo 	return 0;
3358226223abSTejun Heo }
3359226223abSTejun Heo 
3360226223abSTejun Heo /**
3361226223abSTejun Heo  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3362226223abSTejun Heo  * @wq: the workqueue to unregister
3363226223abSTejun Heo  *
3364226223abSTejun Heo  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3365226223abSTejun Heo  */
3366226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3367226223abSTejun Heo {
3368226223abSTejun Heo 	struct wq_device *wq_dev = wq->wq_dev;
3369226223abSTejun Heo 
3370226223abSTejun Heo 	if (!wq->wq_dev)
3371226223abSTejun Heo 		return;
3372226223abSTejun Heo 
3373226223abSTejun Heo 	wq->wq_dev = NULL;
3374226223abSTejun Heo 	device_unregister(&wq_dev->dev);
3375226223abSTejun Heo }
3376226223abSTejun Heo #else	/* CONFIG_SYSFS */
3377226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
3378226223abSTejun Heo #endif	/* CONFIG_SYSFS */
3379226223abSTejun Heo 
33807a4e344cSTejun Heo /**
33817a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
33827a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
33837a4e344cSTejun Heo  *
33847a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
33857a4e344cSTejun Heo  */
33867a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs)
33877a4e344cSTejun Heo {
33887a4e344cSTejun Heo 	if (attrs) {
33897a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
33907a4e344cSTejun Heo 		kfree(attrs);
33917a4e344cSTejun Heo 	}
33927a4e344cSTejun Heo }
33937a4e344cSTejun Heo 
33947a4e344cSTejun Heo /**
33957a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
33967a4e344cSTejun Heo  * @gfp_mask: allocation mask to use
33977a4e344cSTejun Heo  *
33987a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
3399d185af30SYacine Belkadi  * return it.
3400d185af30SYacine Belkadi  *
3401d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
34027a4e344cSTejun Heo  */
34037a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
34047a4e344cSTejun Heo {
34057a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
34067a4e344cSTejun Heo 
34077a4e344cSTejun Heo 	attrs = kzalloc(sizeof(*attrs), gfp_mask);
34087a4e344cSTejun Heo 	if (!attrs)
34097a4e344cSTejun Heo 		goto fail;
34107a4e344cSTejun Heo 	if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
34117a4e344cSTejun Heo 		goto fail;
34127a4e344cSTejun Heo 
341313e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
34147a4e344cSTejun Heo 	return attrs;
34157a4e344cSTejun Heo fail:
34167a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
34177a4e344cSTejun Heo 	return NULL;
34187a4e344cSTejun Heo }
34197a4e344cSTejun Heo 
342029c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
342129c91e99STejun Heo 				 const struct workqueue_attrs *from)
342229c91e99STejun Heo {
342329c91e99STejun Heo 	to->nice = from->nice;
342429c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
34252865a8fbSShaohua Li 	/*
34262865a8fbSShaohua Li 	 * Unlike hash and equality test, this function doesn't ignore
34272865a8fbSShaohua Li 	 * ->no_numa as it is used for both pool and wq attrs.  Instead,
34282865a8fbSShaohua Li 	 * get_unbound_pool() explicitly clears ->no_numa after copying.
34292865a8fbSShaohua Li 	 */
34302865a8fbSShaohua Li 	to->no_numa = from->no_numa;
343129c91e99STejun Heo }
343229c91e99STejun Heo 
343329c91e99STejun Heo /* hash value of the content of @attr */
343429c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
343529c91e99STejun Heo {
343629c91e99STejun Heo 	u32 hash = 0;
343729c91e99STejun Heo 
343829c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
343913e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
344013e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
344129c91e99STejun Heo 	return hash;
344229c91e99STejun Heo }
344329c91e99STejun Heo 
344429c91e99STejun Heo /* content equality test */
344529c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
344629c91e99STejun Heo 			  const struct workqueue_attrs *b)
344729c91e99STejun Heo {
344829c91e99STejun Heo 	if (a->nice != b->nice)
344929c91e99STejun Heo 		return false;
345029c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
345129c91e99STejun Heo 		return false;
345229c91e99STejun Heo 	return true;
345329c91e99STejun Heo }
345429c91e99STejun Heo 
34557a4e344cSTejun Heo /**
34567a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
34577a4e344cSTejun Heo  * @pool: worker_pool to initialize
34587a4e344cSTejun Heo  *
34597a4e344cSTejun Heo  * Initiailize a newly zalloc'd @pool.  It also allocates @pool->attrs.
3460d185af30SYacine Belkadi  *
3461d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
346229c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
346329c91e99STejun Heo  * on @pool safely to release it.
34647a4e344cSTejun Heo  */
34657a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
34664e1a1f9aSTejun Heo {
34674e1a1f9aSTejun Heo 	spin_lock_init(&pool->lock);
346829c91e99STejun Heo 	pool->id = -1;
346929c91e99STejun Heo 	pool->cpu = -1;
3470f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
34714e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
34724e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
34734e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
34744e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
34754e1a1f9aSTejun Heo 
34764e1a1f9aSTejun Heo 	init_timer_deferrable(&pool->idle_timer);
34774e1a1f9aSTejun Heo 	pool->idle_timer.function = idle_worker_timeout;
34784e1a1f9aSTejun Heo 	pool->idle_timer.data = (unsigned long)pool;
34794e1a1f9aSTejun Heo 
34804e1a1f9aSTejun Heo 	setup_timer(&pool->mayday_timer, pool_mayday_timeout,
34814e1a1f9aSTejun Heo 		    (unsigned long)pool);
34824e1a1f9aSTejun Heo 
34834e1a1f9aSTejun Heo 	mutex_init(&pool->manager_arb);
3484bc3a1afcSTejun Heo 	mutex_init(&pool->manager_mutex);
3485da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
34867a4e344cSTejun Heo 
3487*7cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
348829c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
348929c91e99STejun Heo 	pool->refcnt = 1;
349029c91e99STejun Heo 
349129c91e99STejun Heo 	/* shouldn't fail above this point */
34927a4e344cSTejun Heo 	pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
34937a4e344cSTejun Heo 	if (!pool->attrs)
34947a4e344cSTejun Heo 		return -ENOMEM;
34957a4e344cSTejun Heo 	return 0;
34964e1a1f9aSTejun Heo }
34974e1a1f9aSTejun Heo 
349829c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
349929c91e99STejun Heo {
350029c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
350129c91e99STejun Heo 
3502*7cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
350329c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
350429c91e99STejun Heo 	kfree(pool);
350529c91e99STejun Heo }
350629c91e99STejun Heo 
350729c91e99STejun Heo /**
350829c91e99STejun Heo  * put_unbound_pool - put a worker_pool
350929c91e99STejun Heo  * @pool: worker_pool to put
351029c91e99STejun Heo  *
351129c91e99STejun Heo  * Put @pool.  If its refcnt reaches zero, it gets destroyed in sched-RCU
3512c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
3513c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
3514c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
3515a892caccSTejun Heo  *
3516a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
351729c91e99STejun Heo  */
351829c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
351929c91e99STejun Heo {
352060f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
352129c91e99STejun Heo 	struct worker *worker;
352229c91e99STejun Heo 
3523a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3524a892caccSTejun Heo 
3525a892caccSTejun Heo 	if (--pool->refcnt)
352629c91e99STejun Heo 		return;
352729c91e99STejun Heo 
352829c91e99STejun Heo 	/* sanity checks */
352929c91e99STejun Heo 	if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
3530a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
353129c91e99STejun Heo 		return;
353229c91e99STejun Heo 
353329c91e99STejun Heo 	/* release id and unhash */
353429c91e99STejun Heo 	if (pool->id >= 0)
353529c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
353629c91e99STejun Heo 	hash_del(&pool->hash_node);
353729c91e99STejun Heo 
3538c5aa87bbSTejun Heo 	/*
3539c5aa87bbSTejun Heo 	 * Become the manager and destroy all workers.  Grabbing
3540c5aa87bbSTejun Heo 	 * manager_arb prevents @pool's workers from blocking on
3541c5aa87bbSTejun Heo 	 * manager_mutex.
3542c5aa87bbSTejun Heo 	 */
354329c91e99STejun Heo 	mutex_lock(&pool->manager_arb);
354429c91e99STejun Heo 
354560f5a4bcSLai Jiangshan 	spin_lock_irq(&pool->lock);
354629c91e99STejun Heo 	while ((worker = first_worker(pool)))
354729c91e99STejun Heo 		destroy_worker(worker);
354829c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
354929c91e99STejun Heo 	spin_unlock_irq(&pool->lock);
355060f5a4bcSLai Jiangshan 
355160f5a4bcSLai Jiangshan 	mutex_lock(&pool->manager_mutex);
3552da028469SLai Jiangshan 	if (!list_empty(&pool->workers))
355360f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
3554cd549687STejun Heo 	mutex_unlock(&pool->manager_mutex);
355560f5a4bcSLai Jiangshan 
355660f5a4bcSLai Jiangshan 	if (pool->detach_completion)
355760f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
355860f5a4bcSLai Jiangshan 
355929c91e99STejun Heo 	mutex_unlock(&pool->manager_arb);
356029c91e99STejun Heo 
356129c91e99STejun Heo 	/* shut down the timers */
356229c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
356329c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
356429c91e99STejun Heo 
356529c91e99STejun Heo 	/* sched-RCU protected to allow dereferences from get_work_pool() */
356629c91e99STejun Heo 	call_rcu_sched(&pool->rcu, rcu_free_pool);
356729c91e99STejun Heo }
356829c91e99STejun Heo 
356929c91e99STejun Heo /**
357029c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
357129c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
357229c91e99STejun Heo  *
357329c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
357429c91e99STejun Heo  * reference count and return it.  If there already is a matching
357529c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
3576d185af30SYacine Belkadi  * create a new one.
3577a892caccSTejun Heo  *
3578a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
3579d185af30SYacine Belkadi  *
3580d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
3581d185af30SYacine Belkadi  * On failure, %NULL.
358229c91e99STejun Heo  */
358329c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
358429c91e99STejun Heo {
358529c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
358629c91e99STejun Heo 	struct worker_pool *pool;
3587f3f90ad4STejun Heo 	int node;
358829c91e99STejun Heo 
3589a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
359029c91e99STejun Heo 
359129c91e99STejun Heo 	/* do we already have a matching pool? */
359229c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
359329c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
359429c91e99STejun Heo 			pool->refcnt++;
359529c91e99STejun Heo 			goto out_unlock;
359629c91e99STejun Heo 		}
359729c91e99STejun Heo 	}
359829c91e99STejun Heo 
359929c91e99STejun Heo 	/* nope, create a new one */
360029c91e99STejun Heo 	pool = kzalloc(sizeof(*pool), GFP_KERNEL);
360129c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
360229c91e99STejun Heo 		goto fail;
360329c91e99STejun Heo 
360412ee4fc6SLai Jiangshan 	if (workqueue_freezing)
360512ee4fc6SLai Jiangshan 		pool->flags |= POOL_FREEZING;
360612ee4fc6SLai Jiangshan 
36078864b4e5STejun Heo 	lockdep_set_subclass(&pool->lock, 1);	/* see put_pwq() */
360829c91e99STejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
360929c91e99STejun Heo 
36102865a8fbSShaohua Li 	/*
36112865a8fbSShaohua Li 	 * no_numa isn't a worker_pool attribute, always clear it.  See
36122865a8fbSShaohua Li 	 * 'struct workqueue_attrs' comments for detail.
36132865a8fbSShaohua Li 	 */
36142865a8fbSShaohua Li 	pool->attrs->no_numa = false;
36152865a8fbSShaohua Li 
3616f3f90ad4STejun Heo 	/* if cpumask is contained inside a NUMA node, we belong to that node */
3617f3f90ad4STejun Heo 	if (wq_numa_enabled) {
3618f3f90ad4STejun Heo 		for_each_node(node) {
3619f3f90ad4STejun Heo 			if (cpumask_subset(pool->attrs->cpumask,
3620f3f90ad4STejun Heo 					   wq_numa_possible_cpumask[node])) {
3621f3f90ad4STejun Heo 				pool->node = node;
3622f3f90ad4STejun Heo 				break;
3623f3f90ad4STejun Heo 			}
3624f3f90ad4STejun Heo 		}
3625f3f90ad4STejun Heo 	}
3626f3f90ad4STejun Heo 
362729c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
362829c91e99STejun Heo 		goto fail;
362929c91e99STejun Heo 
363029c91e99STejun Heo 	/* create and start the initial worker */
3631ebf44d16STejun Heo 	if (create_and_start_worker(pool) < 0)
363229c91e99STejun Heo 		goto fail;
363329c91e99STejun Heo 
363429c91e99STejun Heo 	/* install */
363529c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
363629c91e99STejun Heo out_unlock:
363729c91e99STejun Heo 	return pool;
363829c91e99STejun Heo fail:
363929c91e99STejun Heo 	if (pool)
364029c91e99STejun Heo 		put_unbound_pool(pool);
364129c91e99STejun Heo 	return NULL;
364229c91e99STejun Heo }
364329c91e99STejun Heo 
36448864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
36458864b4e5STejun Heo {
36468864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
36478864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
36488864b4e5STejun Heo }
36498864b4e5STejun Heo 
36508864b4e5STejun Heo /*
36518864b4e5STejun Heo  * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
36528864b4e5STejun Heo  * and needs to be destroyed.
36538864b4e5STejun Heo  */
36548864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work)
36558864b4e5STejun Heo {
36568864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
36578864b4e5STejun Heo 						  unbound_release_work);
36588864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
36598864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
3660bc0caf09STejun Heo 	bool is_last;
36618864b4e5STejun Heo 
36628864b4e5STejun Heo 	if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
36638864b4e5STejun Heo 		return;
36648864b4e5STejun Heo 
366575ccf595STejun Heo 	/*
36663c25a55dSLai Jiangshan 	 * Unlink @pwq.  Synchronization against wq->mutex isn't strictly
366775ccf595STejun Heo 	 * necessary on release but do it anyway.  It's easier to verify
366875ccf595STejun Heo 	 * and consistent with the linking path.
366975ccf595STejun Heo 	 */
36703c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
36718864b4e5STejun Heo 	list_del_rcu(&pwq->pwqs_node);
3672bc0caf09STejun Heo 	is_last = list_empty(&wq->pwqs);
36733c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
36748864b4e5STejun Heo 
3675a892caccSTejun Heo 	mutex_lock(&wq_pool_mutex);
36768864b4e5STejun Heo 	put_unbound_pool(pool);
3677a892caccSTejun Heo 	mutex_unlock(&wq_pool_mutex);
3678a892caccSTejun Heo 
36798864b4e5STejun Heo 	call_rcu_sched(&pwq->rcu, rcu_free_pwq);
36808864b4e5STejun Heo 
36818864b4e5STejun Heo 	/*
36828864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
36838864b4e5STejun Heo 	 * is gonna access it anymore.  Free it.
36848864b4e5STejun Heo 	 */
36856029a918STejun Heo 	if (is_last) {
36866029a918STejun Heo 		free_workqueue_attrs(wq->unbound_attrs);
36878864b4e5STejun Heo 		kfree(wq);
36888864b4e5STejun Heo 	}
36896029a918STejun Heo }
36908864b4e5STejun Heo 
36910fbd95aaSTejun Heo /**
3692699ce097STejun Heo  * pwq_adjust_max_active - update a pwq's max_active to the current setting
36930fbd95aaSTejun Heo  * @pwq: target pool_workqueue
36940fbd95aaSTejun Heo  *
3695699ce097STejun Heo  * If @pwq isn't freezing, set @pwq->max_active to the associated
3696699ce097STejun Heo  * workqueue's saved_max_active and activate delayed work items
3697699ce097STejun Heo  * accordingly.  If @pwq is freezing, clear @pwq->max_active to zero.
36980fbd95aaSTejun Heo  */
3699699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq)
37000fbd95aaSTejun Heo {
3701699ce097STejun Heo 	struct workqueue_struct *wq = pwq->wq;
3702699ce097STejun Heo 	bool freezable = wq->flags & WQ_FREEZABLE;
3703699ce097STejun Heo 
3704699ce097STejun Heo 	/* for @wq->saved_max_active */
3705a357fc03SLai Jiangshan 	lockdep_assert_held(&wq->mutex);
3706699ce097STejun Heo 
3707699ce097STejun Heo 	/* fast exit for non-freezable wqs */
3708699ce097STejun Heo 	if (!freezable && pwq->max_active == wq->saved_max_active)
3709699ce097STejun Heo 		return;
3710699ce097STejun Heo 
3711a357fc03SLai Jiangshan 	spin_lock_irq(&pwq->pool->lock);
3712699ce097STejun Heo 
3713699ce097STejun Heo 	if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) {
3714699ce097STejun Heo 		pwq->max_active = wq->saved_max_active;
37150fbd95aaSTejun Heo 
37160fbd95aaSTejun Heo 		while (!list_empty(&pwq->delayed_works) &&
37170fbd95aaSTejun Heo 		       pwq->nr_active < pwq->max_active)
37180fbd95aaSTejun Heo 			pwq_activate_first_delayed(pwq);
3719951a078aSLai Jiangshan 
3720951a078aSLai Jiangshan 		/*
3721951a078aSLai Jiangshan 		 * Need to kick a worker after thawed or an unbound wq's
3722951a078aSLai Jiangshan 		 * max_active is bumped.  It's a slow path.  Do it always.
3723951a078aSLai Jiangshan 		 */
3724951a078aSLai Jiangshan 		wake_up_worker(pwq->pool);
3725699ce097STejun Heo 	} else {
3726699ce097STejun Heo 		pwq->max_active = 0;
3727699ce097STejun Heo 	}
3728699ce097STejun Heo 
3729a357fc03SLai Jiangshan 	spin_unlock_irq(&pwq->pool->lock);
37300fbd95aaSTejun Heo }
37310fbd95aaSTejun Heo 
3732e50aba9aSTejun Heo /* initialize newly alloced @pwq which is associated with @wq and @pool */
3733f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3734f147f29eSTejun Heo 		     struct worker_pool *pool)
3735d2c1d404STejun Heo {
3736d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3737d2c1d404STejun Heo 
3738e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
3739e50aba9aSTejun Heo 
3740d2c1d404STejun Heo 	pwq->pool = pool;
3741d2c1d404STejun Heo 	pwq->wq = wq;
3742d2c1d404STejun Heo 	pwq->flush_color = -1;
37438864b4e5STejun Heo 	pwq->refcnt = 1;
3744d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->delayed_works);
37451befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
3746d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
37478864b4e5STejun Heo 	INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3748f147f29eSTejun Heo }
3749d2c1d404STejun Heo 
3750f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
37511befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
3752f147f29eSTejun Heo {
3753f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
3754f147f29eSTejun Heo 
3755f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
375675ccf595STejun Heo 
37571befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
37581befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
37591befcf30STejun Heo 		return;
37601befcf30STejun Heo 
3761983ca25eSTejun Heo 	/*
3762983ca25eSTejun Heo 	 * Set the matching work_color.  This is synchronized with
37633c25a55dSLai Jiangshan 	 * wq->mutex to avoid confusing flush_workqueue().
3764983ca25eSTejun Heo 	 */
376575ccf595STejun Heo 	pwq->work_color = wq->work_color;
3766983ca25eSTejun Heo 
3767983ca25eSTejun Heo 	/* sync max_active to the current setting */
3768983ca25eSTejun Heo 	pwq_adjust_max_active(pwq);
3769983ca25eSTejun Heo 
3770983ca25eSTejun Heo 	/* link in @pwq */
37719e8cd2f5STejun Heo 	list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3772df2d5ae4STejun Heo }
37736029a918STejun Heo 
3774f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3775f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3776f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
3777f147f29eSTejun Heo {
3778f147f29eSTejun Heo 	struct worker_pool *pool;
3779f147f29eSTejun Heo 	struct pool_workqueue *pwq;
3780f147f29eSTejun Heo 
3781f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3782f147f29eSTejun Heo 
3783f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
3784f147f29eSTejun Heo 	if (!pool)
3785f147f29eSTejun Heo 		return NULL;
3786f147f29eSTejun Heo 
3787e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3788f147f29eSTejun Heo 	if (!pwq) {
3789f147f29eSTejun Heo 		put_unbound_pool(pool);
3790f147f29eSTejun Heo 		return NULL;
3791f147f29eSTejun Heo 	}
3792f147f29eSTejun Heo 
3793f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
3794f147f29eSTejun Heo 	return pwq;
3795d2c1d404STejun Heo }
3796d2c1d404STejun Heo 
37974c16bd32STejun Heo /* undo alloc_unbound_pwq(), used only in the error path */
37984c16bd32STejun Heo static void free_unbound_pwq(struct pool_workqueue *pwq)
37994c16bd32STejun Heo {
38004c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
38014c16bd32STejun Heo 
38024c16bd32STejun Heo 	if (pwq) {
38034c16bd32STejun Heo 		put_unbound_pool(pwq->pool);
3804cece95dfSWei Yongjun 		kmem_cache_free(pwq_cache, pwq);
38054c16bd32STejun Heo 	}
38064c16bd32STejun Heo }
38074c16bd32STejun Heo 
38084c16bd32STejun Heo /**
38094c16bd32STejun Heo  * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
38104c16bd32STejun Heo  * @attrs: the wq_attrs of interest
38114c16bd32STejun Heo  * @node: the target NUMA node
38124c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
38134c16bd32STejun Heo  * @cpumask: outarg, the resulting cpumask
38144c16bd32STejun Heo  *
38154c16bd32STejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @node.  If
38164c16bd32STejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during
3817d185af30SYacine Belkadi  * calculation.  The result is stored in @cpumask.
38184c16bd32STejun Heo  *
38194c16bd32STejun Heo  * If NUMA affinity is not enabled, @attrs->cpumask is always used.  If
38204c16bd32STejun Heo  * enabled and @node has online CPUs requested by @attrs, the returned
38214c16bd32STejun Heo  * cpumask is the intersection of the possible CPUs of @node and
38224c16bd32STejun Heo  * @attrs->cpumask.
38234c16bd32STejun Heo  *
38244c16bd32STejun Heo  * The caller is responsible for ensuring that the cpumask of @node stays
38254c16bd32STejun Heo  * stable.
3826d185af30SYacine Belkadi  *
3827d185af30SYacine Belkadi  * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3828d185af30SYacine Belkadi  * %false if equal.
38294c16bd32STejun Heo  */
38304c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
38314c16bd32STejun Heo 				 int cpu_going_down, cpumask_t *cpumask)
38324c16bd32STejun Heo {
3833d55262c4STejun Heo 	if (!wq_numa_enabled || attrs->no_numa)
38344c16bd32STejun Heo 		goto use_dfl;
38354c16bd32STejun Heo 
38364c16bd32STejun Heo 	/* does @node have any online CPUs @attrs wants? */
38374c16bd32STejun Heo 	cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
38384c16bd32STejun Heo 	if (cpu_going_down >= 0)
38394c16bd32STejun Heo 		cpumask_clear_cpu(cpu_going_down, cpumask);
38404c16bd32STejun Heo 
38414c16bd32STejun Heo 	if (cpumask_empty(cpumask))
38424c16bd32STejun Heo 		goto use_dfl;
38434c16bd32STejun Heo 
38444c16bd32STejun Heo 	/* yeap, return possible CPUs in @node that @attrs wants */
38454c16bd32STejun Heo 	cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
38464c16bd32STejun Heo 	return !cpumask_equal(cpumask, attrs->cpumask);
38474c16bd32STejun Heo 
38484c16bd32STejun Heo use_dfl:
38494c16bd32STejun Heo 	cpumask_copy(cpumask, attrs->cpumask);
38504c16bd32STejun Heo 	return false;
38514c16bd32STejun Heo }
38524c16bd32STejun Heo 
38531befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
38541befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
38551befcf30STejun Heo 						   int node,
38561befcf30STejun Heo 						   struct pool_workqueue *pwq)
38571befcf30STejun Heo {
38581befcf30STejun Heo 	struct pool_workqueue *old_pwq;
38591befcf30STejun Heo 
38601befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
38611befcf30STejun Heo 
38621befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
38631befcf30STejun Heo 	link_pwq(pwq);
38641befcf30STejun Heo 
38651befcf30STejun Heo 	old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
38661befcf30STejun Heo 	rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
38671befcf30STejun Heo 	return old_pwq;
38681befcf30STejun Heo }
38691befcf30STejun Heo 
38709e8cd2f5STejun Heo /**
38719e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
38729e8cd2f5STejun Heo  * @wq: the target workqueue
38739e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
38749e8cd2f5STejun Heo  *
38754c16bd32STejun Heo  * Apply @attrs to an unbound workqueue @wq.  Unless disabled, on NUMA
38764c16bd32STejun Heo  * machines, this function maps a separate pwq to each NUMA node with
38774c16bd32STejun Heo  * possibles CPUs in @attrs->cpumask so that work items are affine to the
38784c16bd32STejun Heo  * NUMA node it was issued on.  Older pwqs are released as in-flight work
38794c16bd32STejun Heo  * items finish.  Note that a work item which repeatedly requeues itself
38804c16bd32STejun Heo  * back-to-back will stay on its current pwq.
38819e8cd2f5STejun Heo  *
3882d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
3883d185af30SYacine Belkadi  *
3884d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
38859e8cd2f5STejun Heo  */
38869e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq,
38879e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
38889e8cd2f5STejun Heo {
38894c16bd32STejun Heo 	struct workqueue_attrs *new_attrs, *tmp_attrs;
38904c16bd32STejun Heo 	struct pool_workqueue **pwq_tbl, *dfl_pwq;
3891f147f29eSTejun Heo 	int node, ret;
38929e8cd2f5STejun Heo 
38938719dceaSTejun Heo 	/* only unbound workqueues can change attributes */
38949e8cd2f5STejun Heo 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
38959e8cd2f5STejun Heo 		return -EINVAL;
38969e8cd2f5STejun Heo 
38978719dceaSTejun Heo 	/* creating multiple pwqs breaks ordering guarantee */
38988719dceaSTejun Heo 	if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
38998719dceaSTejun Heo 		return -EINVAL;
39008719dceaSTejun Heo 
39014c16bd32STejun Heo 	pwq_tbl = kzalloc(wq_numa_tbl_len * sizeof(pwq_tbl[0]), GFP_KERNEL);
390213e2e556STejun Heo 	new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
39034c16bd32STejun Heo 	tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
39044c16bd32STejun Heo 	if (!pwq_tbl || !new_attrs || !tmp_attrs)
390513e2e556STejun Heo 		goto enomem;
390613e2e556STejun Heo 
39074c16bd32STejun Heo 	/* make a copy of @attrs and sanitize it */
390813e2e556STejun Heo 	copy_workqueue_attrs(new_attrs, attrs);
390913e2e556STejun Heo 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
391013e2e556STejun Heo 
39114c16bd32STejun Heo 	/*
39124c16bd32STejun Heo 	 * We may create multiple pwqs with differing cpumasks.  Make a
39134c16bd32STejun Heo 	 * copy of @new_attrs which will be modified and used to obtain
39144c16bd32STejun Heo 	 * pools.
39154c16bd32STejun Heo 	 */
39164c16bd32STejun Heo 	copy_workqueue_attrs(tmp_attrs, new_attrs);
39179e8cd2f5STejun Heo 
39184c16bd32STejun Heo 	/*
39194c16bd32STejun Heo 	 * CPUs should stay stable across pwq creations and installations.
39204c16bd32STejun Heo 	 * Pin CPUs, determine the target cpumask for each node and create
39214c16bd32STejun Heo 	 * pwqs accordingly.
39224c16bd32STejun Heo 	 */
39234c16bd32STejun Heo 	get_online_cpus();
39244c16bd32STejun Heo 
39254c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
39264c16bd32STejun Heo 
39274c16bd32STejun Heo 	/*
39284c16bd32STejun Heo 	 * If something goes wrong during CPU up/down, we'll fall back to
39294c16bd32STejun Heo 	 * the default pwq covering whole @attrs->cpumask.  Always create
39304c16bd32STejun Heo 	 * it even if we don't use it immediately.
39314c16bd32STejun Heo 	 */
39324c16bd32STejun Heo 	dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
39334c16bd32STejun Heo 	if (!dfl_pwq)
39344c16bd32STejun Heo 		goto enomem_pwq;
39354c16bd32STejun Heo 
39364c16bd32STejun Heo 	for_each_node(node) {
39374c16bd32STejun Heo 		if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
39384c16bd32STejun Heo 			pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
39394c16bd32STejun Heo 			if (!pwq_tbl[node])
39404c16bd32STejun Heo 				goto enomem_pwq;
39414c16bd32STejun Heo 		} else {
39424c16bd32STejun Heo 			dfl_pwq->refcnt++;
39434c16bd32STejun Heo 			pwq_tbl[node] = dfl_pwq;
39444c16bd32STejun Heo 		}
39454c16bd32STejun Heo 	}
39464c16bd32STejun Heo 
39474c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
39484c16bd32STejun Heo 
39494c16bd32STejun Heo 	/* all pwqs have been created successfully, let's install'em */
3950f147f29eSTejun Heo 	mutex_lock(&wq->mutex);
3951a892caccSTejun Heo 
3952f147f29eSTejun Heo 	copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
39534c16bd32STejun Heo 
39544c16bd32STejun Heo 	/* save the previous pwq and install the new one */
3955f147f29eSTejun Heo 	for_each_node(node)
39564c16bd32STejun Heo 		pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
39574c16bd32STejun Heo 
39584c16bd32STejun Heo 	/* @dfl_pwq might not have been used, ensure it's linked */
39594c16bd32STejun Heo 	link_pwq(dfl_pwq);
39604c16bd32STejun Heo 	swap(wq->dfl_pwq, dfl_pwq);
3961f147f29eSTejun Heo 
3962f147f29eSTejun Heo 	mutex_unlock(&wq->mutex);
3963f147f29eSTejun Heo 
39644c16bd32STejun Heo 	/* put the old pwqs */
39654c16bd32STejun Heo 	for_each_node(node)
39664c16bd32STejun Heo 		put_pwq_unlocked(pwq_tbl[node]);
39674c16bd32STejun Heo 	put_pwq_unlocked(dfl_pwq);
39684c16bd32STejun Heo 
39694c16bd32STejun Heo 	put_online_cpus();
39704862125bSTejun Heo 	ret = 0;
39714862125bSTejun Heo 	/* fall through */
39724862125bSTejun Heo out_free:
39734c16bd32STejun Heo 	free_workqueue_attrs(tmp_attrs);
39744862125bSTejun Heo 	free_workqueue_attrs(new_attrs);
39754c16bd32STejun Heo 	kfree(pwq_tbl);
39764862125bSTejun Heo 	return ret;
397713e2e556STejun Heo 
39784c16bd32STejun Heo enomem_pwq:
39794c16bd32STejun Heo 	free_unbound_pwq(dfl_pwq);
39804c16bd32STejun Heo 	for_each_node(node)
39814c16bd32STejun Heo 		if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
39824c16bd32STejun Heo 			free_unbound_pwq(pwq_tbl[node]);
39834c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
39844c16bd32STejun Heo 	put_online_cpus();
398513e2e556STejun Heo enomem:
39864862125bSTejun Heo 	ret = -ENOMEM;
39874862125bSTejun Heo 	goto out_free;
39889e8cd2f5STejun Heo }
39899e8cd2f5STejun Heo 
39904c16bd32STejun Heo /**
39914c16bd32STejun Heo  * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
39924c16bd32STejun Heo  * @wq: the target workqueue
39934c16bd32STejun Heo  * @cpu: the CPU coming up or going down
39944c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
39954c16bd32STejun Heo  *
39964c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
39974c16bd32STejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update NUMA affinity of
39984c16bd32STejun Heo  * @wq accordingly.
39994c16bd32STejun Heo  *
40004c16bd32STejun Heo  * If NUMA affinity can't be adjusted due to memory allocation failure, it
40014c16bd32STejun Heo  * falls back to @wq->dfl_pwq which may not be optimal but is always
40024c16bd32STejun Heo  * correct.
40034c16bd32STejun Heo  *
40044c16bd32STejun Heo  * Note that when the last allowed CPU of a NUMA node goes offline for a
40054c16bd32STejun Heo  * workqueue with a cpumask spanning multiple nodes, the workers which were
40064c16bd32STejun Heo  * already executing the work items for the workqueue will lose their CPU
40074c16bd32STejun Heo  * affinity and may execute on any CPU.  This is similar to how per-cpu
40084c16bd32STejun Heo  * workqueues behave on CPU_DOWN.  If a workqueue user wants strict
40094c16bd32STejun Heo  * affinity, it's the user's responsibility to flush the work item from
40104c16bd32STejun Heo  * CPU_DOWN_PREPARE.
40114c16bd32STejun Heo  */
40124c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
40134c16bd32STejun Heo 				   bool online)
40144c16bd32STejun Heo {
40154c16bd32STejun Heo 	int node = cpu_to_node(cpu);
40164c16bd32STejun Heo 	int cpu_off = online ? -1 : cpu;
40174c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
40184c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
40194c16bd32STejun Heo 	cpumask_t *cpumask;
40204c16bd32STejun Heo 
40214c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
40224c16bd32STejun Heo 
40234c16bd32STejun Heo 	if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
40244c16bd32STejun Heo 		return;
40254c16bd32STejun Heo 
40264c16bd32STejun Heo 	/*
40274c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
40284c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
40294c16bd32STejun Heo 	 * CPU hotplug exclusion.
40304c16bd32STejun Heo 	 */
40314c16bd32STejun Heo 	target_attrs = wq_update_unbound_numa_attrs_buf;
40324c16bd32STejun Heo 	cpumask = target_attrs->cpumask;
40334c16bd32STejun Heo 
40344c16bd32STejun Heo 	mutex_lock(&wq->mutex);
4035d55262c4STejun Heo 	if (wq->unbound_attrs->no_numa)
4036d55262c4STejun Heo 		goto out_unlock;
40374c16bd32STejun Heo 
40384c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
40394c16bd32STejun Heo 	pwq = unbound_pwq_by_node(wq, node);
40404c16bd32STejun Heo 
40414c16bd32STejun Heo 	/*
40424c16bd32STejun Heo 	 * Let's determine what needs to be done.  If the target cpumask is
40434c16bd32STejun Heo 	 * different from wq's, we need to compare it to @pwq's and create
40444c16bd32STejun Heo 	 * a new one if they don't match.  If the target cpumask equals
4045534a3fbbSDaeseok Youn 	 * wq's, the default pwq should be used.
40464c16bd32STejun Heo 	 */
40474c16bd32STejun Heo 	if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
40484c16bd32STejun Heo 		if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
40494c16bd32STejun Heo 			goto out_unlock;
40504c16bd32STejun Heo 	} else {
40514c16bd32STejun Heo 		goto use_dfl_pwq;
40524c16bd32STejun Heo 	}
40534c16bd32STejun Heo 
40544c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
40554c16bd32STejun Heo 
40564c16bd32STejun Heo 	/* create a new pwq */
40574c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
40584c16bd32STejun Heo 	if (!pwq) {
40592d916033SFabian Frederick 		pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
40604c16bd32STejun Heo 			wq->name);
406177f300b1SDaeseok Youn 		mutex_lock(&wq->mutex);
406277f300b1SDaeseok Youn 		goto use_dfl_pwq;
40634c16bd32STejun Heo 	}
40644c16bd32STejun Heo 
40654c16bd32STejun Heo 	/*
40664c16bd32STejun Heo 	 * Install the new pwq.  As this function is called only from CPU
40674c16bd32STejun Heo 	 * hotplug callbacks and applying a new attrs is wrapped with
40684c16bd32STejun Heo 	 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
40694c16bd32STejun Heo 	 * inbetween.
40704c16bd32STejun Heo 	 */
40714c16bd32STejun Heo 	mutex_lock(&wq->mutex);
40724c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, pwq);
40734c16bd32STejun Heo 	goto out_unlock;
40744c16bd32STejun Heo 
40754c16bd32STejun Heo use_dfl_pwq:
40764c16bd32STejun Heo 	spin_lock_irq(&wq->dfl_pwq->pool->lock);
40774c16bd32STejun Heo 	get_pwq(wq->dfl_pwq);
40784c16bd32STejun Heo 	spin_unlock_irq(&wq->dfl_pwq->pool->lock);
40794c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
40804c16bd32STejun Heo out_unlock:
40814c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
40824c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
40834c16bd32STejun Heo }
40844c16bd32STejun Heo 
408530cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
40861da177e4SLinus Torvalds {
408749e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
40888a2b7538STejun Heo 	int cpu, ret;
4089e1d8aa9fSFrederic Weisbecker 
409030cdf249STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
4091420c0ddbSTejun Heo 		wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4092420c0ddbSTejun Heo 		if (!wq->cpu_pwqs)
409330cdf249STejun Heo 			return -ENOMEM;
409430cdf249STejun Heo 
409530cdf249STejun Heo 		for_each_possible_cpu(cpu) {
40967fb98ea7STejun Heo 			struct pool_workqueue *pwq =
40977fb98ea7STejun Heo 				per_cpu_ptr(wq->cpu_pwqs, cpu);
40987a62c2c8STejun Heo 			struct worker_pool *cpu_pools =
4099f02ae73aSTejun Heo 				per_cpu(cpu_worker_pools, cpu);
410030cdf249STejun Heo 
4101f147f29eSTejun Heo 			init_pwq(pwq, wq, &cpu_pools[highpri]);
4102f147f29eSTejun Heo 
4103f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
41041befcf30STejun Heo 			link_pwq(pwq);
4105f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
410630cdf249STejun Heo 		}
410730cdf249STejun Heo 		return 0;
41088a2b7538STejun Heo 	} else if (wq->flags & __WQ_ORDERED) {
41098a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
41108a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
41118a2b7538STejun Heo 		WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
41128a2b7538STejun Heo 			      wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
41138a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
41148a2b7538STejun Heo 		return ret;
41159e8cd2f5STejun Heo 	} else {
41169e8cd2f5STejun Heo 		return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
41179e8cd2f5STejun Heo 	}
41180f900049STejun Heo }
41190f900049STejun Heo 
4120f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
4121f3421797STejun Heo 			       const char *name)
4122b71ab8c2STejun Heo {
4123f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4124f3421797STejun Heo 
4125f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
4126044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4127f3421797STejun Heo 			max_active, name, 1, lim);
4128b71ab8c2STejun Heo 
4129f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
4130b71ab8c2STejun Heo }
4131b71ab8c2STejun Heo 
4132b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
413397e37d7bSTejun Heo 					       unsigned int flags,
41341e19ffc6STejun Heo 					       int max_active,
4135eb13ba87SJohannes Berg 					       struct lock_class_key *key,
4136b196be89STejun Heo 					       const char *lock_name, ...)
41373af24433SOleg Nesterov {
4138df2d5ae4STejun Heo 	size_t tbl_size = 0;
4139ecf6881fSTejun Heo 	va_list args;
41403af24433SOleg Nesterov 	struct workqueue_struct *wq;
414149e3cf44STejun Heo 	struct pool_workqueue *pwq;
4142b196be89STejun Heo 
4143cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
4144cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4145cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
4146cee22a15SViresh Kumar 
4147ecf6881fSTejun Heo 	/* allocate wq and format name */
4148df2d5ae4STejun Heo 	if (flags & WQ_UNBOUND)
4149df2d5ae4STejun Heo 		tbl_size = wq_numa_tbl_len * sizeof(wq->numa_pwq_tbl[0]);
4150df2d5ae4STejun Heo 
4151df2d5ae4STejun Heo 	wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
4152b196be89STejun Heo 	if (!wq)
4153d2c1d404STejun Heo 		return NULL;
4154b196be89STejun Heo 
41556029a918STejun Heo 	if (flags & WQ_UNBOUND) {
41566029a918STejun Heo 		wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
41576029a918STejun Heo 		if (!wq->unbound_attrs)
41586029a918STejun Heo 			goto err_free_wq;
41596029a918STejun Heo 	}
41606029a918STejun Heo 
4161ecf6881fSTejun Heo 	va_start(args, lock_name);
4162ecf6881fSTejun Heo 	vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4163b196be89STejun Heo 	va_end(args);
41643af24433SOleg Nesterov 
4165d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
4166b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
41673af24433SOleg Nesterov 
4168b196be89STejun Heo 	/* init wq */
416997e37d7bSTejun Heo 	wq->flags = flags;
4170a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
41713c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
4172112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
417330cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
417473f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
417573f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
4176493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
41773af24433SOleg Nesterov 
4178eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
4179cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
41803af24433SOleg Nesterov 
418130cdf249STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
4182d2c1d404STejun Heo 		goto err_free_wq;
41831537663fSTejun Heo 
4184493008a8STejun Heo 	/*
4185493008a8STejun Heo 	 * Workqueues which may be used during memory reclaim should
4186493008a8STejun Heo 	 * have a rescuer to guarantee forward progress.
4187493008a8STejun Heo 	 */
4188493008a8STejun Heo 	if (flags & WQ_MEM_RECLAIM) {
4189e22bee78STejun Heo 		struct worker *rescuer;
4190e22bee78STejun Heo 
4191d2c1d404STejun Heo 		rescuer = alloc_worker();
4192e22bee78STejun Heo 		if (!rescuer)
4193d2c1d404STejun Heo 			goto err_destroy;
4194e22bee78STejun Heo 
4195111c225aSTejun Heo 		rescuer->rescue_wq = wq;
4196111c225aSTejun Heo 		rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
4197b196be89STejun Heo 					       wq->name);
4198d2c1d404STejun Heo 		if (IS_ERR(rescuer->task)) {
4199d2c1d404STejun Heo 			kfree(rescuer);
4200d2c1d404STejun Heo 			goto err_destroy;
4201d2c1d404STejun Heo 		}
4202e22bee78STejun Heo 
4203d2c1d404STejun Heo 		wq->rescuer = rescuer;
420414a40ffcSTejun Heo 		rescuer->task->flags |= PF_NO_SETAFFINITY;
4205e22bee78STejun Heo 		wake_up_process(rescuer->task);
42063af24433SOleg Nesterov 	}
42071537663fSTejun Heo 
4208226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4209226223abSTejun Heo 		goto err_destroy;
4210226223abSTejun Heo 
42113af24433SOleg Nesterov 	/*
421268e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
421368e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
421468e13a67SLai Jiangshan 	 * list.
42153af24433SOleg Nesterov 	 */
421668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4217a0a1a5fdSTejun Heo 
4218a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
421949e3cf44STejun Heo 	for_each_pwq(pwq, wq)
4220699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4221a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4222a0a1a5fdSTejun Heo 
42233af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
4224a0a1a5fdSTejun Heo 
422568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
42263af24433SOleg Nesterov 
42273af24433SOleg Nesterov 	return wq;
4228d2c1d404STejun Heo 
4229d2c1d404STejun Heo err_free_wq:
42306029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
42314690c4abSTejun Heo 	kfree(wq);
4232d2c1d404STejun Heo 	return NULL;
4233d2c1d404STejun Heo err_destroy:
4234d2c1d404STejun Heo 	destroy_workqueue(wq);
42354690c4abSTejun Heo 	return NULL;
42361da177e4SLinus Torvalds }
4237d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
42381da177e4SLinus Torvalds 
42393af24433SOleg Nesterov /**
42403af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
42413af24433SOleg Nesterov  * @wq: target workqueue
42423af24433SOleg Nesterov  *
42433af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
42443af24433SOleg Nesterov  */
42453af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
42463af24433SOleg Nesterov {
424749e3cf44STejun Heo 	struct pool_workqueue *pwq;
42484c16bd32STejun Heo 	int node;
42493af24433SOleg Nesterov 
42509c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
42519c5a2ba7STejun Heo 	drain_workqueue(wq);
4252c8efcc25STejun Heo 
42536183c009STejun Heo 	/* sanity checks */
4254b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
425549e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
42566183c009STejun Heo 		int i;
42576183c009STejun Heo 
425876af4d93STejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++) {
425976af4d93STejun Heo 			if (WARN_ON(pwq->nr_in_flight[i])) {
4260b09f4fd3SLai Jiangshan 				mutex_unlock(&wq->mutex);
42616183c009STejun Heo 				return;
426276af4d93STejun Heo 			}
426376af4d93STejun Heo 		}
426476af4d93STejun Heo 
42655c529597SLai Jiangshan 		if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
42668864b4e5STejun Heo 		    WARN_ON(pwq->nr_active) ||
426776af4d93STejun Heo 		    WARN_ON(!list_empty(&pwq->delayed_works))) {
4268b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
42696183c009STejun Heo 			return;
42706183c009STejun Heo 		}
427176af4d93STejun Heo 	}
4272b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
42736183c009STejun Heo 
4274a0a1a5fdSTejun Heo 	/*
4275a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
4276a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
4277a0a1a5fdSTejun Heo 	 */
427868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4279d2c1d404STejun Heo 	list_del_init(&wq->list);
428068e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
42813af24433SOleg Nesterov 
4282226223abSTejun Heo 	workqueue_sysfs_unregister(wq);
4283226223abSTejun Heo 
4284493008a8STejun Heo 	if (wq->rescuer) {
4285e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
42868d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
4287493008a8STejun Heo 		wq->rescuer = NULL;
4288e22bee78STejun Heo 	}
4289e22bee78STejun Heo 
42908864b4e5STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
429129c91e99STejun Heo 		/*
42928864b4e5STejun Heo 		 * The base ref is never dropped on per-cpu pwqs.  Directly
42938864b4e5STejun Heo 		 * free the pwqs and wq.
429429c91e99STejun Heo 		 */
42958864b4e5STejun Heo 		free_percpu(wq->cpu_pwqs);
42968864b4e5STejun Heo 		kfree(wq);
42978864b4e5STejun Heo 	} else {
42988864b4e5STejun Heo 		/*
42998864b4e5STejun Heo 		 * We're the sole accessor of @wq at this point.  Directly
43004c16bd32STejun Heo 		 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
43014c16bd32STejun Heo 		 * @wq will be freed when the last pwq is released.
43028864b4e5STejun Heo 		 */
43034c16bd32STejun Heo 		for_each_node(node) {
43044c16bd32STejun Heo 			pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
43054c16bd32STejun Heo 			RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
43064c16bd32STejun Heo 			put_pwq_unlocked(pwq);
43074c16bd32STejun Heo 		}
43084c16bd32STejun Heo 
43094c16bd32STejun Heo 		/*
43104c16bd32STejun Heo 		 * Put dfl_pwq.  @wq may be freed any time after dfl_pwq is
43114c16bd32STejun Heo 		 * put.  Don't access it afterwards.
43124c16bd32STejun Heo 		 */
43134c16bd32STejun Heo 		pwq = wq->dfl_pwq;
43144c16bd32STejun Heo 		wq->dfl_pwq = NULL;
4315dce90d47STejun Heo 		put_pwq_unlocked(pwq);
431629c91e99STejun Heo 	}
43173af24433SOleg Nesterov }
43183af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
43193af24433SOleg Nesterov 
4320dcd989cbSTejun Heo /**
4321dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
4322dcd989cbSTejun Heo  * @wq: target workqueue
4323dcd989cbSTejun Heo  * @max_active: new max_active value.
4324dcd989cbSTejun Heo  *
4325dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
4326dcd989cbSTejun Heo  *
4327dcd989cbSTejun Heo  * CONTEXT:
4328dcd989cbSTejun Heo  * Don't call from IRQ context.
4329dcd989cbSTejun Heo  */
4330dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4331dcd989cbSTejun Heo {
433249e3cf44STejun Heo 	struct pool_workqueue *pwq;
4333dcd989cbSTejun Heo 
43348719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
43358719dceaSTejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
43368719dceaSTejun Heo 		return;
43378719dceaSTejun Heo 
4338f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4339dcd989cbSTejun Heo 
4340a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
4341dcd989cbSTejun Heo 
4342dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
4343dcd989cbSTejun Heo 
4344699ce097STejun Heo 	for_each_pwq(pwq, wq)
4345699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4346dcd989cbSTejun Heo 
4347a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4348dcd989cbSTejun Heo }
4349dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4350dcd989cbSTejun Heo 
4351dcd989cbSTejun Heo /**
4352e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
4353e6267616STejun Heo  *
4354e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
4355e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
4356d185af30SYacine Belkadi  *
4357d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
4358e6267616STejun Heo  */
4359e6267616STejun Heo bool current_is_workqueue_rescuer(void)
4360e6267616STejun Heo {
4361e6267616STejun Heo 	struct worker *worker = current_wq_worker();
4362e6267616STejun Heo 
43636a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
4364e6267616STejun Heo }
4365e6267616STejun Heo 
4366e6267616STejun Heo /**
4367dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
4368dcd989cbSTejun Heo  * @cpu: CPU in question
4369dcd989cbSTejun Heo  * @wq: target workqueue
4370dcd989cbSTejun Heo  *
4371dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
4372dcd989cbSTejun Heo  * no synchronization around this function and the test result is
4373dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4374dcd989cbSTejun Heo  *
4375d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4376d3251859STejun Heo  * Note that both per-cpu and unbound workqueues may be associated with
4377d3251859STejun Heo  * multiple pool_workqueues which have separate congested states.  A
4378d3251859STejun Heo  * workqueue being congested on one CPU doesn't mean the workqueue is also
4379d3251859STejun Heo  * contested on other CPUs / NUMA nodes.
4380d3251859STejun Heo  *
4381d185af30SYacine Belkadi  * Return:
4382dcd989cbSTejun Heo  * %true if congested, %false otherwise.
4383dcd989cbSTejun Heo  */
4384d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4385dcd989cbSTejun Heo {
43867fb98ea7STejun Heo 	struct pool_workqueue *pwq;
438776af4d93STejun Heo 	bool ret;
438876af4d93STejun Heo 
438988109453SLai Jiangshan 	rcu_read_lock_sched();
43907fb98ea7STejun Heo 
4391d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
4392d3251859STejun Heo 		cpu = smp_processor_id();
4393d3251859STejun Heo 
43947fb98ea7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
43957fb98ea7STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
43967fb98ea7STejun Heo 	else
4397df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4398dcd989cbSTejun Heo 
439976af4d93STejun Heo 	ret = !list_empty(&pwq->delayed_works);
440088109453SLai Jiangshan 	rcu_read_unlock_sched();
440176af4d93STejun Heo 
440276af4d93STejun Heo 	return ret;
4403dcd989cbSTejun Heo }
4404dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
4405dcd989cbSTejun Heo 
4406dcd989cbSTejun Heo /**
4407dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
4408dcd989cbSTejun Heo  * @work: the work to be tested
4409dcd989cbSTejun Heo  *
4410dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
4411dcd989cbSTejun Heo  * synchronization around this function and the test result is
4412dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4413dcd989cbSTejun Heo  *
4414d185af30SYacine Belkadi  * Return:
4415dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
4416dcd989cbSTejun Heo  */
4417dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
4418dcd989cbSTejun Heo {
4419fa1b54e6STejun Heo 	struct worker_pool *pool;
4420dcd989cbSTejun Heo 	unsigned long flags;
4421dcd989cbSTejun Heo 	unsigned int ret = 0;
4422dcd989cbSTejun Heo 
4423dcd989cbSTejun Heo 	if (work_pending(work))
4424dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
4425038366c5SLai Jiangshan 
4426fa1b54e6STejun Heo 	local_irq_save(flags);
4427fa1b54e6STejun Heo 	pool = get_work_pool(work);
4428038366c5SLai Jiangshan 	if (pool) {
4429fa1b54e6STejun Heo 		spin_lock(&pool->lock);
4430c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
4431dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
4432fa1b54e6STejun Heo 		spin_unlock(&pool->lock);
4433038366c5SLai Jiangshan 	}
4434fa1b54e6STejun Heo 	local_irq_restore(flags);
4435dcd989cbSTejun Heo 
4436dcd989cbSTejun Heo 	return ret;
4437dcd989cbSTejun Heo }
4438dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
4439dcd989cbSTejun Heo 
44403d1cb205STejun Heo /**
44413d1cb205STejun Heo  * set_worker_desc - set description for the current work item
44423d1cb205STejun Heo  * @fmt: printf-style format string
44433d1cb205STejun Heo  * @...: arguments for the format string
44443d1cb205STejun Heo  *
44453d1cb205STejun Heo  * This function can be called by a running work function to describe what
44463d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
44473d1cb205STejun Heo  * information will be printed out together to help debugging.  The
44483d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
44493d1cb205STejun Heo  */
44503d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
44513d1cb205STejun Heo {
44523d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
44533d1cb205STejun Heo 	va_list args;
44543d1cb205STejun Heo 
44553d1cb205STejun Heo 	if (worker) {
44563d1cb205STejun Heo 		va_start(args, fmt);
44573d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
44583d1cb205STejun Heo 		va_end(args);
44593d1cb205STejun Heo 		worker->desc_valid = true;
44603d1cb205STejun Heo 	}
44613d1cb205STejun Heo }
44623d1cb205STejun Heo 
44633d1cb205STejun Heo /**
44643d1cb205STejun Heo  * print_worker_info - print out worker information and description
44653d1cb205STejun Heo  * @log_lvl: the log level to use when printing
44663d1cb205STejun Heo  * @task: target task
44673d1cb205STejun Heo  *
44683d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
44693d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
44703d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
44713d1cb205STejun Heo  *
44723d1cb205STejun Heo  * This function can be safely called on any task as long as the
44733d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
44743d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
44753d1cb205STejun Heo  */
44763d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
44773d1cb205STejun Heo {
44783d1cb205STejun Heo 	work_func_t *fn = NULL;
44793d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
44803d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
44813d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
44823d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
44833d1cb205STejun Heo 	bool desc_valid = false;
44843d1cb205STejun Heo 	struct worker *worker;
44853d1cb205STejun Heo 
44863d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
44873d1cb205STejun Heo 		return;
44883d1cb205STejun Heo 
44893d1cb205STejun Heo 	/*
44903d1cb205STejun Heo 	 * This function is called without any synchronization and @task
44913d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
44923d1cb205STejun Heo 	 */
44933d1cb205STejun Heo 	worker = probe_kthread_data(task);
44943d1cb205STejun Heo 
44953d1cb205STejun Heo 	/*
44963d1cb205STejun Heo 	 * Carefully copy the associated workqueue's workfn and name.  Keep
44973d1cb205STejun Heo 	 * the original last '\0' in case the original contains garbage.
44983d1cb205STejun Heo 	 */
44993d1cb205STejun Heo 	probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
45003d1cb205STejun Heo 	probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
45013d1cb205STejun Heo 	probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
45023d1cb205STejun Heo 	probe_kernel_read(name, wq->name, sizeof(name) - 1);
45033d1cb205STejun Heo 
45043d1cb205STejun Heo 	/* copy worker description */
45053d1cb205STejun Heo 	probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
45063d1cb205STejun Heo 	if (desc_valid)
45073d1cb205STejun Heo 		probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
45083d1cb205STejun Heo 
45093d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
45102d916033SFabian Frederick 		pr_info("%sWorkqueue: %s %pf", log_lvl, name, fn);
45113d1cb205STejun Heo 		if (desc[0])
45123d1cb205STejun Heo 			pr_cont(" (%s)", desc);
45133d1cb205STejun Heo 		pr_cont("\n");
45143d1cb205STejun Heo 	}
45153d1cb205STejun Heo }
45163d1cb205STejun Heo 
4517db7bccf4STejun Heo /*
4518db7bccf4STejun Heo  * CPU hotplug.
4519db7bccf4STejun Heo  *
4520e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
4521112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
4522706026c2STejun Heo  * pool which make migrating pending and scheduled works very
4523e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
452494cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
4525e22bee78STejun Heo  * blocked draining impractical.
4526e22bee78STejun Heo  *
452724647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
4528628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
4529628c78e7STejun Heo  * cpu comes back online.
4530db7bccf4STejun Heo  */
4531db7bccf4STejun Heo 
4532706026c2STejun Heo static void wq_unbind_fn(struct work_struct *work)
4533db7bccf4STejun Heo {
453438db41d9STejun Heo 	int cpu = smp_processor_id();
45354ce62e9eSTejun Heo 	struct worker_pool *pool;
4536db7bccf4STejun Heo 	struct worker *worker;
4537db7bccf4STejun Heo 
4538f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
45396183c009STejun Heo 		WARN_ON_ONCE(cpu != smp_processor_id());
4540db7bccf4STejun Heo 
4541bc3a1afcSTejun Heo 		mutex_lock(&pool->manager_mutex);
454294cf58bbSTejun Heo 		spin_lock_irq(&pool->lock);
4543e22bee78STejun Heo 
4544f2d5a0eeSTejun Heo 		/*
4545bc3a1afcSTejun Heo 		 * We've blocked all manager operations.  Make all workers
454694cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
454794cf58bbSTejun Heo 		 * except for the ones which are still executing works from
454894cf58bbSTejun Heo 		 * before the last CPU down must be on the cpu.  After
454994cf58bbSTejun Heo 		 * this, they may become diasporas.
4550f2d5a0eeSTejun Heo 		 */
4551da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
4552403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
4553db7bccf4STejun Heo 
455424647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
4555f2d5a0eeSTejun Heo 
455694cf58bbSTejun Heo 		spin_unlock_irq(&pool->lock);
4557bc3a1afcSTejun Heo 		mutex_unlock(&pool->manager_mutex);
4558e22bee78STejun Heo 
4559e22bee78STejun Heo 		/*
4560eb283428SLai Jiangshan 		 * Call schedule() so that we cross rq->lock and thus can
4561eb283428SLai Jiangshan 		 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4562eb283428SLai Jiangshan 		 * This is necessary as scheduler callbacks may be invoked
4563eb283428SLai Jiangshan 		 * from other cpus.
4564628c78e7STejun Heo 		 */
4565628c78e7STejun Heo 		schedule();
4566628c78e7STejun Heo 
4567628c78e7STejun Heo 		/*
4568eb283428SLai Jiangshan 		 * Sched callbacks are disabled now.  Zap nr_running.
4569eb283428SLai Jiangshan 		 * After this, nr_running stays zero and need_more_worker()
4570eb283428SLai Jiangshan 		 * and keep_working() are always true as long as the
4571eb283428SLai Jiangshan 		 * worklist is not empty.  This pool now behaves as an
4572eb283428SLai Jiangshan 		 * unbound (in terms of concurrency management) pool which
4573eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
4574e22bee78STejun Heo 		 */
4575e19e397aSTejun Heo 		atomic_set(&pool->nr_running, 0);
4576eb283428SLai Jiangshan 
4577eb283428SLai Jiangshan 		/*
4578eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
4579eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
4580eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
4581eb283428SLai Jiangshan 		 */
4582eb283428SLai Jiangshan 		spin_lock_irq(&pool->lock);
4583eb283428SLai Jiangshan 		wake_up_worker(pool);
4584eb283428SLai Jiangshan 		spin_unlock_irq(&pool->lock);
4585eb283428SLai Jiangshan 	}
4586db7bccf4STejun Heo }
4587db7bccf4STejun Heo 
4588bd7c089eSTejun Heo /**
4589bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
4590bd7c089eSTejun Heo  * @pool: pool of interest
4591bd7c089eSTejun Heo  *
4592a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
4593bd7c089eSTejun Heo  */
4594bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
4595bd7c089eSTejun Heo {
4596a9ab775bSTejun Heo 	struct worker *worker;
4597bd7c089eSTejun Heo 
4598bd7c089eSTejun Heo 	lockdep_assert_held(&pool->manager_mutex);
4599bd7c089eSTejun Heo 
4600bd7c089eSTejun Heo 	/*
4601a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
4602a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
4603a9ab775bSTejun Heo 	 * wake-ups for concurrency management happen, restore CPU affinty
4604a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
4605a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
4606bd7c089eSTejun Heo 	 */
4607da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
4608a9ab775bSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4609a9ab775bSTejun Heo 						  pool->attrs->cpumask) < 0);
4610a9ab775bSTejun Heo 
4611a9ab775bSTejun Heo 	spin_lock_irq(&pool->lock);
4612a9ab775bSTejun Heo 
4613da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
4614a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
4615a9ab775bSTejun Heo 
4616a9ab775bSTejun Heo 		/*
4617a9ab775bSTejun Heo 		 * A bound idle worker should actually be on the runqueue
4618a9ab775bSTejun Heo 		 * of the associated CPU for local wake-ups targeting it to
4619a9ab775bSTejun Heo 		 * work.  Kick all idle workers so that they migrate to the
4620a9ab775bSTejun Heo 		 * associated CPU.  Doing this in the same loop as
4621a9ab775bSTejun Heo 		 * replacing UNBOUND with REBOUND is safe as no worker will
4622a9ab775bSTejun Heo 		 * be bound before @pool->lock is released.
4623a9ab775bSTejun Heo 		 */
4624a9ab775bSTejun Heo 		if (worker_flags & WORKER_IDLE)
4625bd7c089eSTejun Heo 			wake_up_process(worker->task);
4626bd7c089eSTejun Heo 
4627bd7c089eSTejun Heo 		/*
4628a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
4629a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
4630a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4631a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
4632a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
4633a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
4634a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
4635a9ab775bSTejun Heo 		 *
4636a9ab775bSTejun Heo 		 * ACCESS_ONCE() is necessary because @worker->flags may be
4637a9ab775bSTejun Heo 		 * tested without holding any lock in
4638a9ab775bSTejun Heo 		 * wq_worker_waking_up().  Without it, NOT_RUNNING test may
4639a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
4640a9ab775bSTejun Heo 		 * management operations.
4641bd7c089eSTejun Heo 		 */
4642a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4643a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
4644a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
4645a9ab775bSTejun Heo 		ACCESS_ONCE(worker->flags) = worker_flags;
4646bd7c089eSTejun Heo 	}
4647a9ab775bSTejun Heo 
4648a9ab775bSTejun Heo 	spin_unlock_irq(&pool->lock);
4649bd7c089eSTejun Heo }
4650bd7c089eSTejun Heo 
46517dbc725eSTejun Heo /**
46527dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
46537dbc725eSTejun Heo  * @pool: unbound pool of interest
46547dbc725eSTejun Heo  * @cpu: the CPU which is coming up
46557dbc725eSTejun Heo  *
46567dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
46577dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
46587dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
46597dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
46607dbc725eSTejun Heo  */
46617dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
46627dbc725eSTejun Heo {
46637dbc725eSTejun Heo 	static cpumask_t cpumask;
46647dbc725eSTejun Heo 	struct worker *worker;
46657dbc725eSTejun Heo 
46667dbc725eSTejun Heo 	lockdep_assert_held(&pool->manager_mutex);
46677dbc725eSTejun Heo 
46687dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
46697dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
46707dbc725eSTejun Heo 		return;
46717dbc725eSTejun Heo 
46727dbc725eSTejun Heo 	/* is @cpu the only online CPU? */
46737dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
46747dbc725eSTejun Heo 	if (cpumask_weight(&cpumask) != 1)
46757dbc725eSTejun Heo 		return;
46767dbc725eSTejun Heo 
46777dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
4678da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
46797dbc725eSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
46807dbc725eSTejun Heo 						  pool->attrs->cpumask) < 0);
46817dbc725eSTejun Heo }
46827dbc725eSTejun Heo 
46838db25e78STejun Heo /*
46848db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
46858db25e78STejun Heo  * This will be registered high priority CPU notifier.
46868db25e78STejun Heo  */
46870db0628dSPaul Gortmaker static int workqueue_cpu_up_callback(struct notifier_block *nfb,
46881da177e4SLinus Torvalds 					       unsigned long action,
46891da177e4SLinus Torvalds 					       void *hcpu)
46901da177e4SLinus Torvalds {
4691d84ff051STejun Heo 	int cpu = (unsigned long)hcpu;
46924ce62e9eSTejun Heo 	struct worker_pool *pool;
46934c16bd32STejun Heo 	struct workqueue_struct *wq;
46947dbc725eSTejun Heo 	int pi;
46951da177e4SLinus Torvalds 
46968db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
46973af24433SOleg Nesterov 	case CPU_UP_PREPARE:
4698f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
46993ce63377STejun Heo 			if (pool->nr_workers)
47003ce63377STejun Heo 				continue;
4701ebf44d16STejun Heo 			if (create_and_start_worker(pool) < 0)
47023ce63377STejun Heo 				return NOTIFY_BAD;
47033af24433SOleg Nesterov 		}
47041da177e4SLinus Torvalds 		break;
47051da177e4SLinus Torvalds 
470665758202STejun Heo 	case CPU_DOWN_FAILED:
470765758202STejun Heo 	case CPU_ONLINE:
470868e13a67SLai Jiangshan 		mutex_lock(&wq_pool_mutex);
47097dbc725eSTejun Heo 
47107dbc725eSTejun Heo 		for_each_pool(pool, pi) {
4711bc3a1afcSTejun Heo 			mutex_lock(&pool->manager_mutex);
471294cf58bbSTejun Heo 
47137dbc725eSTejun Heo 			if (pool->cpu == cpu) {
4714a9ab775bSTejun Heo 				spin_lock_irq(&pool->lock);
471524647570STejun Heo 				pool->flags &= ~POOL_DISASSOCIATED;
4716a9ab775bSTejun Heo 				spin_unlock_irq(&pool->lock);
4717a9ab775bSTejun Heo 
471894cf58bbSTejun Heo 				rebind_workers(pool);
47197dbc725eSTejun Heo 			} else if (pool->cpu < 0) {
47207dbc725eSTejun Heo 				restore_unbound_workers_cpumask(pool, cpu);
47217dbc725eSTejun Heo 			}
472294cf58bbSTejun Heo 
4723bc3a1afcSTejun Heo 			mutex_unlock(&pool->manager_mutex);
472494cf58bbSTejun Heo 		}
47257dbc725eSTejun Heo 
47264c16bd32STejun Heo 		/* update NUMA affinity of unbound workqueues */
47274c16bd32STejun Heo 		list_for_each_entry(wq, &workqueues, list)
47284c16bd32STejun Heo 			wq_update_unbound_numa(wq, cpu, true);
47294c16bd32STejun Heo 
473068e13a67SLai Jiangshan 		mutex_unlock(&wq_pool_mutex);
47318db25e78STejun Heo 		break;
473265758202STejun Heo 	}
473365758202STejun Heo 	return NOTIFY_OK;
473465758202STejun Heo }
473565758202STejun Heo 
473665758202STejun Heo /*
473765758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
473865758202STejun Heo  * This will be registered as low priority CPU notifier.
473965758202STejun Heo  */
47400db0628dSPaul Gortmaker static int workqueue_cpu_down_callback(struct notifier_block *nfb,
474165758202STejun Heo 						 unsigned long action,
474265758202STejun Heo 						 void *hcpu)
474365758202STejun Heo {
4744d84ff051STejun Heo 	int cpu = (unsigned long)hcpu;
47458db25e78STejun Heo 	struct work_struct unbind_work;
47464c16bd32STejun Heo 	struct workqueue_struct *wq;
47478db25e78STejun Heo 
474865758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
474965758202STejun Heo 	case CPU_DOWN_PREPARE:
47504c16bd32STejun Heo 		/* unbinding per-cpu workers should happen on the local CPU */
4751706026c2STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
47527635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
47534c16bd32STejun Heo 
47544c16bd32STejun Heo 		/* update NUMA affinity of unbound workqueues */
47554c16bd32STejun Heo 		mutex_lock(&wq_pool_mutex);
47564c16bd32STejun Heo 		list_for_each_entry(wq, &workqueues, list)
47574c16bd32STejun Heo 			wq_update_unbound_numa(wq, cpu, false);
47584c16bd32STejun Heo 		mutex_unlock(&wq_pool_mutex);
47594c16bd32STejun Heo 
47604c16bd32STejun Heo 		/* wait for per-cpu unbinding to finish */
47618db25e78STejun Heo 		flush_work(&unbind_work);
4762440a1136SChuansheng Liu 		destroy_work_on_stack(&unbind_work);
47638db25e78STejun Heo 		break;
476465758202STejun Heo 	}
476565758202STejun Heo 	return NOTIFY_OK;
476665758202STejun Heo }
476765758202STejun Heo 
47682d3854a3SRusty Russell #ifdef CONFIG_SMP
47698ccad40dSRusty Russell 
47702d3854a3SRusty Russell struct work_for_cpu {
4771ed48ece2STejun Heo 	struct work_struct work;
47722d3854a3SRusty Russell 	long (*fn)(void *);
47732d3854a3SRusty Russell 	void *arg;
47742d3854a3SRusty Russell 	long ret;
47752d3854a3SRusty Russell };
47762d3854a3SRusty Russell 
4777ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
47782d3854a3SRusty Russell {
4779ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4780ed48ece2STejun Heo 
47812d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
47822d3854a3SRusty Russell }
47832d3854a3SRusty Russell 
47842d3854a3SRusty Russell /**
47852d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
47862d3854a3SRusty Russell  * @cpu: the cpu to run on
47872d3854a3SRusty Russell  * @fn: the function to run
47882d3854a3SRusty Russell  * @arg: the function arg
47892d3854a3SRusty Russell  *
479031ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
47916b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
4792d185af30SYacine Belkadi  *
4793d185af30SYacine Belkadi  * Return: The value @fn returns.
47942d3854a3SRusty Russell  */
4795d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
47962d3854a3SRusty Russell {
4797ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
47982d3854a3SRusty Russell 
4799ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4800ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
480112997d1aSBjorn Helgaas 	flush_work(&wfc.work);
4802440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
48032d3854a3SRusty Russell 	return wfc.ret;
48042d3854a3SRusty Russell }
48052d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
48062d3854a3SRusty Russell #endif /* CONFIG_SMP */
48072d3854a3SRusty Russell 
4808a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
4809e7577c50SRusty Russell 
4810a0a1a5fdSTejun Heo /**
4811a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
4812a0a1a5fdSTejun Heo  *
481358a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
4814c5aa87bbSTejun Heo  * workqueues will queue new works to their delayed_works list instead of
4815706026c2STejun Heo  * pool->worklist.
4816a0a1a5fdSTejun Heo  *
4817a0a1a5fdSTejun Heo  * CONTEXT:
4818a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4819a0a1a5fdSTejun Heo  */
4820a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
4821a0a1a5fdSTejun Heo {
482217116969STejun Heo 	struct worker_pool *pool;
482324b8a847STejun Heo 	struct workqueue_struct *wq;
482424b8a847STejun Heo 	struct pool_workqueue *pwq;
4825611c92a0STejun Heo 	int pi;
4826a0a1a5fdSTejun Heo 
482768e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4828a0a1a5fdSTejun Heo 
48296183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
4830a0a1a5fdSTejun Heo 	workqueue_freezing = true;
4831a0a1a5fdSTejun Heo 
483224b8a847STejun Heo 	/* set FREEZING */
4833611c92a0STejun Heo 	for_each_pool(pool, pi) {
48345bcab335STejun Heo 		spin_lock_irq(&pool->lock);
483535b6bb63STejun Heo 		WARN_ON_ONCE(pool->flags & POOL_FREEZING);
483635b6bb63STejun Heo 		pool->flags |= POOL_FREEZING;
48375bcab335STejun Heo 		spin_unlock_irq(&pool->lock);
48381da177e4SLinus Torvalds 	}
48398b03ae3cSTejun Heo 
484024b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
4841a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
4842699ce097STejun Heo 		for_each_pwq(pwq, wq)
4843699ce097STejun Heo 			pwq_adjust_max_active(pwq);
4844a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
4845a1056305STejun Heo 	}
48465bcab335STejun Heo 
484768e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4848a0a1a5fdSTejun Heo }
4849a0a1a5fdSTejun Heo 
4850a0a1a5fdSTejun Heo /**
485158a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
4852a0a1a5fdSTejun Heo  *
4853a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
4854a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
4855a0a1a5fdSTejun Heo  *
4856a0a1a5fdSTejun Heo  * CONTEXT:
485768e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
4858a0a1a5fdSTejun Heo  *
4859d185af30SYacine Belkadi  * Return:
486058a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
486158a69cb4STejun Heo  * is complete.
4862a0a1a5fdSTejun Heo  */
4863a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
4864a0a1a5fdSTejun Heo {
4865a0a1a5fdSTejun Heo 	bool busy = false;
486624b8a847STejun Heo 	struct workqueue_struct *wq;
486724b8a847STejun Heo 	struct pool_workqueue *pwq;
4868a0a1a5fdSTejun Heo 
486968e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4870a0a1a5fdSTejun Heo 
48716183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
4872a0a1a5fdSTejun Heo 
487324b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
487424b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
487524b8a847STejun Heo 			continue;
4876a0a1a5fdSTejun Heo 		/*
4877a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
4878a0a1a5fdSTejun Heo 		 * to peek without lock.
4879a0a1a5fdSTejun Heo 		 */
488088109453SLai Jiangshan 		rcu_read_lock_sched();
488124b8a847STejun Heo 		for_each_pwq(pwq, wq) {
48826183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
4883112202d9STejun Heo 			if (pwq->nr_active) {
4884a0a1a5fdSTejun Heo 				busy = true;
488588109453SLai Jiangshan 				rcu_read_unlock_sched();
4886a0a1a5fdSTejun Heo 				goto out_unlock;
4887a0a1a5fdSTejun Heo 			}
4888a0a1a5fdSTejun Heo 		}
488988109453SLai Jiangshan 		rcu_read_unlock_sched();
4890a0a1a5fdSTejun Heo 	}
4891a0a1a5fdSTejun Heo out_unlock:
489268e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4893a0a1a5fdSTejun Heo 	return busy;
4894a0a1a5fdSTejun Heo }
4895a0a1a5fdSTejun Heo 
4896a0a1a5fdSTejun Heo /**
4897a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
4898a0a1a5fdSTejun Heo  *
4899a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
4900706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
4901a0a1a5fdSTejun Heo  *
4902a0a1a5fdSTejun Heo  * CONTEXT:
4903a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4904a0a1a5fdSTejun Heo  */
4905a0a1a5fdSTejun Heo void thaw_workqueues(void)
4906a0a1a5fdSTejun Heo {
490724b8a847STejun Heo 	struct workqueue_struct *wq;
490824b8a847STejun Heo 	struct pool_workqueue *pwq;
490924b8a847STejun Heo 	struct worker_pool *pool;
4910611c92a0STejun Heo 	int pi;
4911a0a1a5fdSTejun Heo 
491268e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4913a0a1a5fdSTejun Heo 
4914a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
4915a0a1a5fdSTejun Heo 		goto out_unlock;
4916a0a1a5fdSTejun Heo 
491724b8a847STejun Heo 	/* clear FREEZING */
4918611c92a0STejun Heo 	for_each_pool(pool, pi) {
49195bcab335STejun Heo 		spin_lock_irq(&pool->lock);
492035b6bb63STejun Heo 		WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
492135b6bb63STejun Heo 		pool->flags &= ~POOL_FREEZING;
49225bcab335STejun Heo 		spin_unlock_irq(&pool->lock);
4923d565ed63STejun Heo 	}
492424b8a847STejun Heo 
492524b8a847STejun Heo 	/* restore max_active and repopulate worklist */
492624b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
4927a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
4928699ce097STejun Heo 		for_each_pwq(pwq, wq)
4929699ce097STejun Heo 			pwq_adjust_max_active(pwq);
4930a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
493124b8a847STejun Heo 	}
493224b8a847STejun Heo 
4933a0a1a5fdSTejun Heo 	workqueue_freezing = false;
4934a0a1a5fdSTejun Heo out_unlock:
493568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4936a0a1a5fdSTejun Heo }
4937a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
4938a0a1a5fdSTejun Heo 
4939bce90380STejun Heo static void __init wq_numa_init(void)
4940bce90380STejun Heo {
4941bce90380STejun Heo 	cpumask_var_t *tbl;
4942bce90380STejun Heo 	int node, cpu;
4943bce90380STejun Heo 
4944bce90380STejun Heo 	/* determine NUMA pwq table len - highest node id + 1 */
4945bce90380STejun Heo 	for_each_node(node)
4946bce90380STejun Heo 		wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1);
4947bce90380STejun Heo 
4948bce90380STejun Heo 	if (num_possible_nodes() <= 1)
4949bce90380STejun Heo 		return;
4950bce90380STejun Heo 
4951d55262c4STejun Heo 	if (wq_disable_numa) {
4952d55262c4STejun Heo 		pr_info("workqueue: NUMA affinity support disabled\n");
4953d55262c4STejun Heo 		return;
4954d55262c4STejun Heo 	}
4955d55262c4STejun Heo 
49564c16bd32STejun Heo 	wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
49574c16bd32STejun Heo 	BUG_ON(!wq_update_unbound_numa_attrs_buf);
49584c16bd32STejun Heo 
4959bce90380STejun Heo 	/*
4960bce90380STejun Heo 	 * We want masks of possible CPUs of each node which isn't readily
4961bce90380STejun Heo 	 * available.  Build one from cpu_to_node() which should have been
4962bce90380STejun Heo 	 * fully initialized by now.
4963bce90380STejun Heo 	 */
4964bce90380STejun Heo 	tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL);
4965bce90380STejun Heo 	BUG_ON(!tbl);
4966bce90380STejun Heo 
4967bce90380STejun Heo 	for_each_node(node)
49681be0c25dSTejun Heo 		BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
49691be0c25dSTejun Heo 				node_online(node) ? node : NUMA_NO_NODE));
4970bce90380STejun Heo 
4971bce90380STejun Heo 	for_each_possible_cpu(cpu) {
4972bce90380STejun Heo 		node = cpu_to_node(cpu);
4973bce90380STejun Heo 		if (WARN_ON(node == NUMA_NO_NODE)) {
4974bce90380STejun Heo 			pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
4975bce90380STejun Heo 			/* happens iff arch is bonkers, let's just proceed */
4976bce90380STejun Heo 			return;
4977bce90380STejun Heo 		}
4978bce90380STejun Heo 		cpumask_set_cpu(cpu, tbl[node]);
4979bce90380STejun Heo 	}
4980bce90380STejun Heo 
4981bce90380STejun Heo 	wq_numa_possible_cpumask = tbl;
4982bce90380STejun Heo 	wq_numa_enabled = true;
4983bce90380STejun Heo }
4984bce90380STejun Heo 
49856ee0578bSSuresh Siddha static int __init init_workqueues(void)
49861da177e4SLinus Torvalds {
49877a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
49887a4e344cSTejun Heo 	int i, cpu;
4989c34056a3STejun Heo 
4990e904e6c2STejun Heo 	WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4991e904e6c2STejun Heo 
4992e904e6c2STejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4993e904e6c2STejun Heo 
499465758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
4995a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
49968b03ae3cSTejun Heo 
4997bce90380STejun Heo 	wq_numa_init();
4998bce90380STejun Heo 
4999706026c2STejun Heo 	/* initialize CPU pools */
500029c91e99STejun Heo 	for_each_possible_cpu(cpu) {
50014ce62e9eSTejun Heo 		struct worker_pool *pool;
50028b03ae3cSTejun Heo 
50037a4e344cSTejun Heo 		i = 0;
5004f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
50057a4e344cSTejun Heo 			BUG_ON(init_worker_pool(pool));
5006ec22ca5eSTejun Heo 			pool->cpu = cpu;
50077a4e344cSTejun Heo 			cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
50087a4e344cSTejun Heo 			pool->attrs->nice = std_nice[i++];
5009f3f90ad4STejun Heo 			pool->node = cpu_to_node(cpu);
50107a4e344cSTejun Heo 
50119daf9e67STejun Heo 			/* alloc pool ID */
501268e13a67SLai Jiangshan 			mutex_lock(&wq_pool_mutex);
50139daf9e67STejun Heo 			BUG_ON(worker_pool_assign_id(pool));
501468e13a67SLai Jiangshan 			mutex_unlock(&wq_pool_mutex);
50154ce62e9eSTejun Heo 		}
50168b03ae3cSTejun Heo 	}
50178b03ae3cSTejun Heo 
5018e22bee78STejun Heo 	/* create the initial worker */
501929c91e99STejun Heo 	for_each_online_cpu(cpu) {
50204ce62e9eSTejun Heo 		struct worker_pool *pool;
5021e22bee78STejun Heo 
5022f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
502324647570STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
5024ebf44d16STejun Heo 			BUG_ON(create_and_start_worker(pool) < 0);
5025e22bee78STejun Heo 		}
50264ce62e9eSTejun Heo 	}
5027e22bee78STejun Heo 
50288a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
502929c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
503029c91e99STejun Heo 		struct workqueue_attrs *attrs;
503129c91e99STejun Heo 
503229c91e99STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
503329c91e99STejun Heo 		attrs->nice = std_nice[i];
503429c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
50358a2b7538STejun Heo 
50368a2b7538STejun Heo 		/*
50378a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
50388a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
50398a2b7538STejun Heo 		 * Turn off NUMA so that dfl_pwq is used for all nodes.
50408a2b7538STejun Heo 		 */
50418a2b7538STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
50428a2b7538STejun Heo 		attrs->nice = std_nice[i];
50438a2b7538STejun Heo 		attrs->no_numa = true;
50448a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
504529c91e99STejun Heo 	}
504629c91e99STejun Heo 
5047d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
50481aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
5049d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
5050f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5051f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
505224d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
505324d51addSTejun Heo 					      WQ_FREEZABLE, 0);
50540668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
50550668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
50560668106cSViresh Kumar 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
50570668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
50580668106cSViresh Kumar 					      0);
50591aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
50600668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
50610668106cSViresh Kumar 	       !system_power_efficient_wq ||
50620668106cSViresh Kumar 	       !system_freezable_power_efficient_wq);
50636ee0578bSSuresh Siddha 	return 0;
50641da177e4SLinus Torvalds }
50656ee0578bSSuresh Siddha early_initcall(init_workqueues);
5066