xref: /linux-6.15/kernel/workqueue.c (revision 60f5a4bc)
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 	 */
7111ebea50STejun Heo 	POOL_MANAGE_WORKERS	= 1 << 0,	/* need to manage workers */
7224647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
7335b6bb63STejun Heo 	POOL_FREEZING		= 1 << 3,	/* freeze in progress */
74db7bccf4STejun Heo 
75c8e55f36STejun Heo 	/* worker flags */
76c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
77c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
78e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
79fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
80f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
81a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
82e22bee78STejun Heo 
83a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
84a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
85db7bccf4STejun Heo 
86e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
874ce62e9eSTejun Heo 
8829c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
89c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
90db7bccf4STejun Heo 
91e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
92e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
93e22bee78STejun Heo 
943233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
953233cdbdSTejun Heo 						/* call for help after 10ms
963233cdbdSTejun Heo 						   (min two ticks) */
97e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
98e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
991da177e4SLinus Torvalds 
1001da177e4SLinus Torvalds 	/*
101e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
102e22bee78STejun Heo 	 * all cpus.  Give -20.
103e22bee78STejun Heo 	 */
104e22bee78STejun Heo 	RESCUER_NICE_LEVEL	= -20,
1053270476aSTejun Heo 	HIGHPRI_NICE_LEVEL	= -20,
106ecf6881fSTejun Heo 
107ecf6881fSTejun Heo 	WQ_NAME_LEN		= 24,
108c8e55f36STejun Heo };
109c8e55f36STejun Heo 
1101da177e4SLinus Torvalds /*
1114690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1124690c4abSTejun Heo  *
113e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
114e41e704bSTejun Heo  *    everyone else.
1154690c4abSTejun Heo  *
116e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
117e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
118e22bee78STejun Heo  *
119d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1204690c4abSTejun Heo  *
121d565ed63STejun Heo  * X: During normal operation, modification requires pool->lock and should
122d565ed63STejun Heo  *    be done only from local cpu.  Either disabling preemption on local
123d565ed63STejun Heo  *    cpu or grabbing pool->lock is enough for read access.  If
124d565ed63STejun Heo  *    POOL_DISASSOCIATED is set, it's identical to L.
125e22bee78STejun Heo  *
1269625ab17SLai Jiangshan  * M: pool->manager_mutex protected.
127822d8405STejun Heo  *
12868e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
12976af4d93STejun Heo  *
13068e13a67SLai Jiangshan  * PR: wq_pool_mutex protected for writes.  Sched-RCU protected for reads.
1315bcab335STejun Heo  *
1323c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1333c25a55dSLai Jiangshan  *
134b5927605SLai Jiangshan  * WR: wq->mutex protected for writes.  Sched-RCU protected for reads.
1352e109a28STejun Heo  *
1362e109a28STejun Heo  * MD: wq_mayday_lock protected.
1374690c4abSTejun Heo  */
1384690c4abSTejun Heo 
1392eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
140c34056a3STejun Heo 
141bd7bdd43STejun Heo struct worker_pool {
142d565ed63STejun Heo 	spinlock_t		lock;		/* the pool lock */
143d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
144f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1459daf9e67STejun Heo 	int			id;		/* I: pool ID */
14611ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
147bd7bdd43STejun Heo 
148bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
149bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
150ea1abd61SLai Jiangshan 
151ea1abd61SLai Jiangshan 	/* nr_idle includes the ones off idle_list for rebinding */
152bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
153bd7bdd43STejun Heo 
154bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
155bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
156bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
157bd7bdd43STejun Heo 
158c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
159c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
160c9e7cf27STejun Heo 						/* L: hash of busy workers */
161c9e7cf27STejun Heo 
162bc3a1afcSTejun Heo 	/* see manage_workers() for details on the two manager mutexes */
16334a06bd6STejun Heo 	struct mutex		manager_arb;	/* manager arbitration */
164bc3a1afcSTejun Heo 	struct mutex		manager_mutex;	/* manager exclusion */
1659625ab17SLai Jiangshan 	struct idr		worker_idr;	/* M: worker IDs and iteration */
166*60f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
167e19e397aSTejun Heo 
1687a4e344cSTejun Heo 	struct workqueue_attrs	*attrs;		/* I: worker attributes */
16968e13a67SLai Jiangshan 	struct hlist_node	hash_node;	/* PL: unbound_pool_hash node */
17068e13a67SLai Jiangshan 	int			refcnt;		/* PL: refcnt for unbound pools */
1717a4e344cSTejun Heo 
172e19e397aSTejun Heo 	/*
173e19e397aSTejun Heo 	 * The current concurrency level.  As it's likely to be accessed
174e19e397aSTejun Heo 	 * from other CPUs during try_to_wake_up(), put it in a separate
175e19e397aSTejun Heo 	 * cacheline.
176e19e397aSTejun Heo 	 */
177e19e397aSTejun Heo 	atomic_t		nr_running ____cacheline_aligned_in_smp;
17829c91e99STejun Heo 
17929c91e99STejun Heo 	/*
18029c91e99STejun Heo 	 * Destruction of pool is sched-RCU protected to allow dereferences
18129c91e99STejun Heo 	 * from get_work_pool().
18229c91e99STejun Heo 	 */
18329c91e99STejun Heo 	struct rcu_head		rcu;
1848b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1858b03ae3cSTejun Heo 
1868b03ae3cSTejun Heo /*
187112202d9STejun Heo  * The per-pool workqueue.  While queued, the lower WORK_STRUCT_FLAG_BITS
188112202d9STejun Heo  * of work_struct->data are used for flags and the remaining high bits
189112202d9STejun Heo  * point to the pwq; thus, pwqs need to be aligned at two's power of the
190112202d9STejun Heo  * number of flag bits.
1911da177e4SLinus Torvalds  */
192112202d9STejun Heo struct pool_workqueue {
193bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
1944690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
19573f53c4aSTejun Heo 	int			work_color;	/* L: current color */
19673f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
1978864b4e5STejun Heo 	int			refcnt;		/* L: reference count */
19873f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
19973f53c4aSTejun Heo 						/* L: nr of in_flight works */
2001e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
201a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
2021e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
2033c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2042e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2058864b4e5STejun Heo 
2068864b4e5STejun Heo 	/*
2078864b4e5STejun Heo 	 * Release of unbound pwq is punted to system_wq.  See put_pwq()
2088864b4e5STejun Heo 	 * and pwq_unbound_release_workfn() for details.  pool_workqueue
2098864b4e5STejun Heo 	 * itself is also sched-RCU protected so that the first pwq can be
210b09f4fd3SLai Jiangshan 	 * determined without grabbing wq->mutex.
2118864b4e5STejun Heo 	 */
2128864b4e5STejun Heo 	struct work_struct	unbound_release_work;
2138864b4e5STejun Heo 	struct rcu_head		rcu;
214e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS);
2151da177e4SLinus Torvalds 
2161da177e4SLinus Torvalds /*
21773f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
21873f53c4aSTejun Heo  */
21973f53c4aSTejun Heo struct wq_flusher {
2203c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
2213c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
22273f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
22373f53c4aSTejun Heo };
2241da177e4SLinus Torvalds 
225226223abSTejun Heo struct wq_device;
226226223abSTejun Heo 
22773f53c4aSTejun Heo /*
228c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
229c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
2301da177e4SLinus Torvalds  */
2311da177e4SLinus Torvalds struct workqueue_struct {
2323c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
23368e13a67SLai Jiangshan 	struct list_head	list;		/* PL: list of all workqueues */
23473f53c4aSTejun Heo 
2353c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
2363c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
2373c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
238112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
2393c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
2403c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
2413c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
24273f53c4aSTejun Heo 
2432e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
244e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
245e22bee78STejun Heo 
24687fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
247a357fc03SLai Jiangshan 	int			saved_max_active; /* WQ: saved pwq max_active */
248226223abSTejun Heo 
2496029a918STejun Heo 	struct workqueue_attrs	*unbound_attrs;	/* WQ: only for unbound wqs */
2504c16bd32STejun Heo 	struct pool_workqueue	*dfl_pwq;	/* WQ: only for unbound wqs */
2516029a918STejun Heo 
252226223abSTejun Heo #ifdef CONFIG_SYSFS
253226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
254226223abSTejun Heo #endif
2554e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
2564e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2574e6045f1SJohannes Berg #endif
258ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
2592728fd2fSTejun Heo 
2602728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
2612728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
2622728fd2fSTejun Heo 	struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
263df2d5ae4STejun Heo 	struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */
2641da177e4SLinus Torvalds };
2651da177e4SLinus Torvalds 
266e904e6c2STejun Heo static struct kmem_cache *pwq_cache;
267e904e6c2STejun Heo 
268bce90380STejun Heo static int wq_numa_tbl_len;		/* highest possible NUMA node id + 1 */
269bce90380STejun Heo static cpumask_var_t *wq_numa_possible_cpumask;
270bce90380STejun Heo 					/* possible CPUs of each node */
271bce90380STejun Heo 
272d55262c4STejun Heo static bool wq_disable_numa;
273d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444);
274d55262c4STejun Heo 
275cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
276cee22a15SViresh Kumar #ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
277cee22a15SViresh Kumar static bool wq_power_efficient = true;
278cee22a15SViresh Kumar #else
279cee22a15SViresh Kumar static bool wq_power_efficient;
280cee22a15SViresh Kumar #endif
281cee22a15SViresh Kumar 
282cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
283cee22a15SViresh Kumar 
284bce90380STejun Heo static bool wq_numa_enabled;		/* unbound NUMA affinity enabled */
285bce90380STejun Heo 
2864c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
2874c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
2884c16bd32STejun Heo 
28968e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
2902e109a28STejun Heo static DEFINE_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
2915bcab335STejun Heo 
29268e13a67SLai Jiangshan static LIST_HEAD(workqueues);		/* PL: list of all workqueues */
29368e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
2947d19c5ceSTejun Heo 
2957d19c5ceSTejun Heo /* the per-cpu worker pools */
2967d19c5ceSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
2977d19c5ceSTejun Heo 				     cpu_worker_pools);
2987d19c5ceSTejun Heo 
29968e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
3007d19c5ceSTejun Heo 
30168e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
30229c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
30329c91e99STejun Heo 
304c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
30529c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
30629c91e99STejun Heo 
3078a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
3088a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
3098a2b7538STejun Heo 
310d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
311ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
312044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
3131aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
314044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
315d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
316044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
317f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
318044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
31924d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
3200668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly;
3210668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
3220668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
3230668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
324d320c038STejun Heo 
3257d19c5ceSTejun Heo static int worker_thread(void *__worker);
3267d19c5ceSTejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
3277d19c5ceSTejun Heo 				 const struct workqueue_attrs *from);
3287d19c5ceSTejun Heo 
32997bd2347STejun Heo #define CREATE_TRACE_POINTS
33097bd2347STejun Heo #include <trace/events/workqueue.h>
33197bd2347STejun Heo 
33268e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
3335bcab335STejun Heo 	rcu_lockdep_assert(rcu_read_lock_sched_held() ||		\
33468e13a67SLai Jiangshan 			   lockdep_is_held(&wq_pool_mutex),		\
33568e13a67SLai Jiangshan 			   "sched RCU or wq_pool_mutex should be held")
3365bcab335STejun Heo 
337b09f4fd3SLai Jiangshan #define assert_rcu_or_wq_mutex(wq)					\
33876af4d93STejun Heo 	rcu_lockdep_assert(rcu_read_lock_sched_held() ||		\
339b5927605SLai Jiangshan 			   lockdep_is_held(&wq->mutex),			\
340b09f4fd3SLai Jiangshan 			   "sched RCU or wq->mutex should be held")
34176af4d93STejun Heo 
342f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
343f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
344f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
3457a62c2c8STejun Heo 	     (pool)++)
3464ce62e9eSTejun Heo 
34749e3cf44STejun Heo /**
34817116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
34917116969STejun Heo  * @pool: iteration cursor
350611c92a0STejun Heo  * @pi: integer used for iteration
351fa1b54e6STejun Heo  *
35268e13a67SLai Jiangshan  * This must be called either with wq_pool_mutex held or sched RCU read
35368e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
35468e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
355fa1b54e6STejun Heo  *
356fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
357fa1b54e6STejun Heo  * ignored.
35817116969STejun Heo  */
359611c92a0STejun Heo #define for_each_pool(pool, pi)						\
360611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
36168e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
362fa1b54e6STejun Heo 		else
36317116969STejun Heo 
36417116969STejun Heo /**
365822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
366822d8405STejun Heo  * @worker: iteration cursor
367822d8405STejun Heo  * @wi: integer used for iteration
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  */
375822d8405STejun Heo #define for_each_pool_worker(worker, wi, pool)				\
376822d8405STejun Heo 	idr_for_each_entry(&(pool)->worker_idr, (worker), (wi))		\
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 I need to be the manager? */
75663d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool)
757e22bee78STejun Heo {
75863d95a91STejun Heo 	return need_to_create_worker(pool) ||
75911ebea50STejun Heo 		(pool->flags & POOL_MANAGE_WORKERS);
760e22bee78STejun Heo }
761e22bee78STejun Heo 
762e22bee78STejun Heo /* Do we have too many workers and should some go away? */
76363d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
764e22bee78STejun Heo {
76534a06bd6STejun Heo 	bool managing = mutex_is_locked(&pool->manager_arb);
76663d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
76763d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
768e22bee78STejun Heo 
769ea1abd61SLai Jiangshan 	/*
770ea1abd61SLai Jiangshan 	 * nr_idle and idle_list may disagree if idle rebinding is in
771ea1abd61SLai Jiangshan 	 * progress.  Never return %true if idle_list is empty.
772ea1abd61SLai Jiangshan 	 */
773ea1abd61SLai Jiangshan 	if (list_empty(&pool->idle_list))
774ea1abd61SLai Jiangshan 		return false;
775ea1abd61SLai Jiangshan 
776e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
777e22bee78STejun Heo }
778e22bee78STejun Heo 
779e22bee78STejun Heo /*
780e22bee78STejun Heo  * Wake up functions.
781e22bee78STejun Heo  */
782e22bee78STejun Heo 
7837e11629dSTejun Heo /* Return the first worker.  Safe with preemption disabled */
78463d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool)
7857e11629dSTejun Heo {
78663d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
7877e11629dSTejun Heo 		return NULL;
7887e11629dSTejun Heo 
78963d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
7907e11629dSTejun Heo }
7917e11629dSTejun Heo 
7927e11629dSTejun Heo /**
7937e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
79463d95a91STejun Heo  * @pool: worker pool to wake worker from
7957e11629dSTejun Heo  *
79663d95a91STejun Heo  * Wake up the first idle worker of @pool.
7977e11629dSTejun Heo  *
7987e11629dSTejun Heo  * CONTEXT:
799d565ed63STejun Heo  * spin_lock_irq(pool->lock).
8007e11629dSTejun Heo  */
80163d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
8027e11629dSTejun Heo {
80363d95a91STejun Heo 	struct worker *worker = first_worker(pool);
8047e11629dSTejun Heo 
8057e11629dSTejun Heo 	if (likely(worker))
8067e11629dSTejun Heo 		wake_up_process(worker->task);
8077e11629dSTejun Heo }
8087e11629dSTejun Heo 
8094690c4abSTejun Heo /**
810e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
811e22bee78STejun Heo  * @task: task waking up
812e22bee78STejun Heo  * @cpu: CPU @task is waking up to
813e22bee78STejun Heo  *
814e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
815e22bee78STejun Heo  * being awoken.
816e22bee78STejun Heo  *
817e22bee78STejun Heo  * CONTEXT:
818e22bee78STejun Heo  * spin_lock_irq(rq->lock)
819e22bee78STejun Heo  */
820d84ff051STejun Heo void wq_worker_waking_up(struct task_struct *task, int cpu)
821e22bee78STejun Heo {
822e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
823e22bee78STejun Heo 
82436576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
825ec22ca5eSTejun Heo 		WARN_ON_ONCE(worker->pool->cpu != cpu);
826e19e397aSTejun Heo 		atomic_inc(&worker->pool->nr_running);
827e22bee78STejun Heo 	}
82836576000SJoonsoo Kim }
829e22bee78STejun Heo 
830e22bee78STejun Heo /**
831e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
832e22bee78STejun Heo  * @task: task going to sleep
833e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
834e22bee78STejun Heo  *
835e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
836e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
837e22bee78STejun Heo  * returning pointer to its task.
838e22bee78STejun Heo  *
839e22bee78STejun Heo  * CONTEXT:
840e22bee78STejun Heo  * spin_lock_irq(rq->lock)
841e22bee78STejun Heo  *
842d185af30SYacine Belkadi  * Return:
843e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
844e22bee78STejun Heo  */
845d84ff051STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
846e22bee78STejun Heo {
847e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
848111c225aSTejun Heo 	struct worker_pool *pool;
849e22bee78STejun Heo 
850111c225aSTejun Heo 	/*
851111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
852111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
853111c225aSTejun Heo 	 * checking NOT_RUNNING.
854111c225aSTejun Heo 	 */
8552d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
856e22bee78STejun Heo 		return NULL;
857e22bee78STejun Heo 
858111c225aSTejun Heo 	pool = worker->pool;
859111c225aSTejun Heo 
860e22bee78STejun Heo 	/* this can only happen on the local cpu */
8616183c009STejun Heo 	if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
8626183c009STejun Heo 		return NULL;
863e22bee78STejun Heo 
864e22bee78STejun Heo 	/*
865e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
866e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
867e22bee78STejun Heo 	 * Please read comment there.
868e22bee78STejun Heo 	 *
869628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
870628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
871628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
872d565ed63STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without pool
873628c78e7STejun Heo 	 * lock is safe.
874e22bee78STejun Heo 	 */
875e19e397aSTejun Heo 	if (atomic_dec_and_test(&pool->nr_running) &&
876e19e397aSTejun Heo 	    !list_empty(&pool->worklist))
87763d95a91STejun Heo 		to_wakeup = first_worker(pool);
878e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
879e22bee78STejun Heo }
880e22bee78STejun Heo 
881e22bee78STejun Heo /**
882e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
883cb444766STejun Heo  * @worker: self
884d302f017STejun Heo  * @flags: flags to set
885d302f017STejun Heo  * @wakeup: wakeup an idle worker if necessary
886d302f017STejun Heo  *
887e22bee78STejun Heo  * Set @flags in @worker->flags and adjust nr_running accordingly.  If
888e22bee78STejun Heo  * nr_running becomes zero and @wakeup is %true, an idle worker is
889e22bee78STejun Heo  * woken up.
890d302f017STejun Heo  *
891cb444766STejun Heo  * CONTEXT:
892d565ed63STejun Heo  * spin_lock_irq(pool->lock)
893d302f017STejun Heo  */
894d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags,
895d302f017STejun Heo 				    bool wakeup)
896d302f017STejun Heo {
897bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
898e22bee78STejun Heo 
899cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
900cb444766STejun Heo 
901e22bee78STejun Heo 	/*
902e22bee78STejun Heo 	 * If transitioning into NOT_RUNNING, adjust nr_running and
903e22bee78STejun Heo 	 * wake up an idle worker as necessary if requested by
904e22bee78STejun Heo 	 * @wakeup.
905e22bee78STejun Heo 	 */
906e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
907e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
908e22bee78STejun Heo 		if (wakeup) {
909e19e397aSTejun Heo 			if (atomic_dec_and_test(&pool->nr_running) &&
910bd7bdd43STejun Heo 			    !list_empty(&pool->worklist))
91163d95a91STejun Heo 				wake_up_worker(pool);
912e22bee78STejun Heo 		} else
913e19e397aSTejun Heo 			atomic_dec(&pool->nr_running);
914e22bee78STejun Heo 	}
915e22bee78STejun Heo 
916d302f017STejun Heo 	worker->flags |= flags;
917d302f017STejun Heo }
918d302f017STejun Heo 
919d302f017STejun Heo /**
920e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
921cb444766STejun Heo  * @worker: self
922d302f017STejun Heo  * @flags: flags to clear
923d302f017STejun Heo  *
924e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
925d302f017STejun Heo  *
926cb444766STejun Heo  * CONTEXT:
927d565ed63STejun Heo  * spin_lock_irq(pool->lock)
928d302f017STejun Heo  */
929d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
930d302f017STejun Heo {
93163d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
932e22bee78STejun Heo 	unsigned int oflags = worker->flags;
933e22bee78STejun Heo 
934cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
935cb444766STejun Heo 
936d302f017STejun Heo 	worker->flags &= ~flags;
937e22bee78STejun Heo 
93842c025f3STejun Heo 	/*
93942c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
94042c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
94142c025f3STejun Heo 	 * of multiple flags, not a single flag.
94242c025f3STejun Heo 	 */
943e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
944e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
945e19e397aSTejun Heo 			atomic_inc(&pool->nr_running);
946d302f017STejun Heo }
947d302f017STejun Heo 
948d302f017STejun Heo /**
9498cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
950c9e7cf27STejun Heo  * @pool: pool of interest
9518cca0eeaSTejun Heo  * @work: work to find worker for
9528cca0eeaSTejun Heo  *
953c9e7cf27STejun Heo  * Find a worker which is executing @work on @pool by searching
954c9e7cf27STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
955a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
956a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
957a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
958a2c1c57bSTejun Heo  * being executed.
959a2c1c57bSTejun Heo  *
960a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
961a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
962a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
963a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
964a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
965a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
966a2c1c57bSTejun Heo  *
967c5aa87bbSTejun Heo  * This function checks the work item address and work function to avoid
968c5aa87bbSTejun Heo  * false positives.  Note that this isn't complete as one may construct a
969c5aa87bbSTejun Heo  * work function which can introduce dependency onto itself through a
970c5aa87bbSTejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
971c5aa87bbSTejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
972c5aa87bbSTejun Heo  * actually occurs, it should be easy to locate the culprit work function.
9738cca0eeaSTejun Heo  *
9748cca0eeaSTejun Heo  * CONTEXT:
975d565ed63STejun Heo  * spin_lock_irq(pool->lock).
9768cca0eeaSTejun Heo  *
977d185af30SYacine Belkadi  * Return:
978d185af30SYacine Belkadi  * Pointer to worker which is executing @work if found, %NULL
9798cca0eeaSTejun Heo  * otherwise.
9808cca0eeaSTejun Heo  */
981c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
9828cca0eeaSTejun Heo 						 struct work_struct *work)
9838cca0eeaSTejun Heo {
98442f8570fSSasha Levin 	struct worker *worker;
98542f8570fSSasha Levin 
986b67bfe0dSSasha Levin 	hash_for_each_possible(pool->busy_hash, worker, hentry,
987a2c1c57bSTejun Heo 			       (unsigned long)work)
988a2c1c57bSTejun Heo 		if (worker->current_work == work &&
989a2c1c57bSTejun Heo 		    worker->current_func == work->func)
99042f8570fSSasha Levin 			return worker;
99142f8570fSSasha Levin 
99242f8570fSSasha Levin 	return NULL;
9938cca0eeaSTejun Heo }
9948cca0eeaSTejun Heo 
9958cca0eeaSTejun Heo /**
996bf4ede01STejun Heo  * move_linked_works - move linked works to a list
997bf4ede01STejun Heo  * @work: start of series of works to be scheduled
998bf4ede01STejun Heo  * @head: target list to append @work to
999bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
1000bf4ede01STejun Heo  *
1001bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1002bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1003bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1004bf4ede01STejun Heo  *
1005bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1006bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1007bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
1008bf4ede01STejun Heo  *
1009bf4ede01STejun Heo  * CONTEXT:
1010d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1011bf4ede01STejun Heo  */
1012bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1013bf4ede01STejun Heo 			      struct work_struct **nextp)
1014bf4ede01STejun Heo {
1015bf4ede01STejun Heo 	struct work_struct *n;
1016bf4ede01STejun Heo 
1017bf4ede01STejun Heo 	/*
1018bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
1019bf4ede01STejun Heo 	 * use NULL for list head.
1020bf4ede01STejun Heo 	 */
1021bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1022bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
1023bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1024bf4ede01STejun Heo 			break;
1025bf4ede01STejun Heo 	}
1026bf4ede01STejun Heo 
1027bf4ede01STejun Heo 	/*
1028bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
1029bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
1030bf4ede01STejun Heo 	 * needs to be updated.
1031bf4ede01STejun Heo 	 */
1032bf4ede01STejun Heo 	if (nextp)
1033bf4ede01STejun Heo 		*nextp = n;
1034bf4ede01STejun Heo }
1035bf4ede01STejun Heo 
10368864b4e5STejun Heo /**
10378864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
10388864b4e5STejun Heo  * @pwq: pool_workqueue to get
10398864b4e5STejun Heo  *
10408864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
10418864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
10428864b4e5STejun Heo  */
10438864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
10448864b4e5STejun Heo {
10458864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
10468864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
10478864b4e5STejun Heo 	pwq->refcnt++;
10488864b4e5STejun Heo }
10498864b4e5STejun Heo 
10508864b4e5STejun Heo /**
10518864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
10528864b4e5STejun Heo  * @pwq: pool_workqueue to put
10538864b4e5STejun Heo  *
10548864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
10558864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
10568864b4e5STejun Heo  */
10578864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
10588864b4e5STejun Heo {
10598864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
10608864b4e5STejun Heo 	if (likely(--pwq->refcnt))
10618864b4e5STejun Heo 		return;
10628864b4e5STejun Heo 	if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
10638864b4e5STejun Heo 		return;
10648864b4e5STejun Heo 	/*
10658864b4e5STejun Heo 	 * @pwq can't be released under pool->lock, bounce to
10668864b4e5STejun Heo 	 * pwq_unbound_release_workfn().  This never recurses on the same
10678864b4e5STejun Heo 	 * pool->lock as this path is taken only for unbound workqueues and
10688864b4e5STejun Heo 	 * the release work item is scheduled on a per-cpu workqueue.  To
10698864b4e5STejun Heo 	 * avoid lockdep warning, unbound pool->locks are given lockdep
10708864b4e5STejun Heo 	 * subclass of 1 in get_unbound_pool().
10718864b4e5STejun Heo 	 */
10728864b4e5STejun Heo 	schedule_work(&pwq->unbound_release_work);
10738864b4e5STejun Heo }
10748864b4e5STejun Heo 
1075dce90d47STejun Heo /**
1076dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1077dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1078dce90d47STejun Heo  *
1079dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1080dce90d47STejun Heo  */
1081dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1082dce90d47STejun Heo {
1083dce90d47STejun Heo 	if (pwq) {
1084dce90d47STejun Heo 		/*
1085dce90d47STejun Heo 		 * As both pwqs and pools are sched-RCU protected, the
1086dce90d47STejun Heo 		 * following lock operations are safe.
1087dce90d47STejun Heo 		 */
1088dce90d47STejun Heo 		spin_lock_irq(&pwq->pool->lock);
1089dce90d47STejun Heo 		put_pwq(pwq);
1090dce90d47STejun Heo 		spin_unlock_irq(&pwq->pool->lock);
1091dce90d47STejun Heo 	}
1092dce90d47STejun Heo }
1093dce90d47STejun Heo 
1094112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work)
1095bf4ede01STejun Heo {
1096112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1097bf4ede01STejun Heo 
1098bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
1099112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
1100bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1101112202d9STejun Heo 	pwq->nr_active++;
1102bf4ede01STejun Heo }
1103bf4ede01STejun Heo 
1104112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
11053aa62497SLai Jiangshan {
1106112202d9STejun Heo 	struct work_struct *work = list_first_entry(&pwq->delayed_works,
11073aa62497SLai Jiangshan 						    struct work_struct, entry);
11083aa62497SLai Jiangshan 
1109112202d9STejun Heo 	pwq_activate_delayed_work(work);
11103aa62497SLai Jiangshan }
11113aa62497SLai Jiangshan 
1112bf4ede01STejun Heo /**
1113112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1114112202d9STejun Heo  * @pwq: pwq of interest
1115bf4ede01STejun Heo  * @color: color of work which left the queue
1116bf4ede01STejun Heo  *
1117bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1118112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1119bf4ede01STejun Heo  *
1120bf4ede01STejun Heo  * CONTEXT:
1121d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1122bf4ede01STejun Heo  */
1123112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1124bf4ede01STejun Heo {
11258864b4e5STejun Heo 	/* uncolored work items don't participate in flushing or nr_active */
1126bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
11278864b4e5STejun Heo 		goto out_put;
1128bf4ede01STejun Heo 
1129112202d9STejun Heo 	pwq->nr_in_flight[color]--;
1130bf4ede01STejun Heo 
1131112202d9STejun Heo 	pwq->nr_active--;
1132112202d9STejun Heo 	if (!list_empty(&pwq->delayed_works)) {
1133bf4ede01STejun Heo 		/* one down, submit a delayed one */
1134112202d9STejun Heo 		if (pwq->nr_active < pwq->max_active)
1135112202d9STejun Heo 			pwq_activate_first_delayed(pwq);
1136bf4ede01STejun Heo 	}
1137bf4ede01STejun Heo 
1138bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1139112202d9STejun Heo 	if (likely(pwq->flush_color != color))
11408864b4e5STejun Heo 		goto out_put;
1141bf4ede01STejun Heo 
1142bf4ede01STejun Heo 	/* are there still in-flight works? */
1143112202d9STejun Heo 	if (pwq->nr_in_flight[color])
11448864b4e5STejun Heo 		goto out_put;
1145bf4ede01STejun Heo 
1146112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1147112202d9STejun Heo 	pwq->flush_color = -1;
1148bf4ede01STejun Heo 
1149bf4ede01STejun Heo 	/*
1150112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1151bf4ede01STejun Heo 	 * will handle the rest.
1152bf4ede01STejun Heo 	 */
1153112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1154112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
11558864b4e5STejun Heo out_put:
11568864b4e5STejun Heo 	put_pwq(pwq);
1157bf4ede01STejun Heo }
1158bf4ede01STejun Heo 
115936e227d2STejun Heo /**
1160bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
116136e227d2STejun Heo  * @work: work item to steal
116236e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1163bbb68dfaSTejun Heo  * @flags: place to store irq state
116436e227d2STejun Heo  *
116536e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
1166d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
116736e227d2STejun Heo  *
1168d185af30SYacine Belkadi  * Return:
116936e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
117036e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
117136e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1172bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1173bbb68dfaSTejun Heo  *		for arbitrarily long
117436e227d2STejun Heo  *
1175d185af30SYacine Belkadi  * Note:
1176bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1177e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1178e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1179e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1180bbb68dfaSTejun Heo  *
1181bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1182bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1183bbb68dfaSTejun Heo  *
1184e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1185bf4ede01STejun Heo  */
1186bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1187bbb68dfaSTejun Heo 			       unsigned long *flags)
1188bf4ede01STejun Heo {
1189d565ed63STejun Heo 	struct worker_pool *pool;
1190112202d9STejun Heo 	struct pool_workqueue *pwq;
1191bf4ede01STejun Heo 
1192bbb68dfaSTejun Heo 	local_irq_save(*flags);
1193bbb68dfaSTejun Heo 
119436e227d2STejun Heo 	/* try to steal the timer if it exists */
119536e227d2STejun Heo 	if (is_dwork) {
119636e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
119736e227d2STejun Heo 
1198e0aecdd8STejun Heo 		/*
1199e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1200e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1201e0aecdd8STejun Heo 		 * running on the local CPU.
1202e0aecdd8STejun Heo 		 */
120336e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
120436e227d2STejun Heo 			return 1;
120536e227d2STejun Heo 	}
120636e227d2STejun Heo 
120736e227d2STejun Heo 	/* try to claim PENDING the normal way */
1208bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1209bf4ede01STejun Heo 		return 0;
1210bf4ede01STejun Heo 
1211bf4ede01STejun Heo 	/*
1212bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1213bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1214bf4ede01STejun Heo 	 */
1215d565ed63STejun Heo 	pool = get_work_pool(work);
1216d565ed63STejun Heo 	if (!pool)
1217bbb68dfaSTejun Heo 		goto fail;
1218bf4ede01STejun Heo 
1219d565ed63STejun Heo 	spin_lock(&pool->lock);
1220bf4ede01STejun Heo 	/*
1221112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
1222112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
1223112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
1224112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
1225112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
12260b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
1227bf4ede01STejun Heo 	 */
1228112202d9STejun Heo 	pwq = get_work_pwq(work);
1229112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
1230bf4ede01STejun Heo 		debug_work_deactivate(work);
12313aa62497SLai Jiangshan 
12323aa62497SLai Jiangshan 		/*
123316062836STejun Heo 		 * A delayed work item cannot be grabbed directly because
123416062836STejun Heo 		 * it might have linked NO_COLOR work items which, if left
1235112202d9STejun Heo 		 * on the delayed_list, will confuse pwq->nr_active
123616062836STejun Heo 		 * management later on and cause stall.  Make sure the work
123716062836STejun Heo 		 * item is activated before grabbing.
12383aa62497SLai Jiangshan 		 */
12393aa62497SLai Jiangshan 		if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1240112202d9STejun Heo 			pwq_activate_delayed_work(work);
12413aa62497SLai Jiangshan 
1242bf4ede01STejun Heo 		list_del_init(&work->entry);
1243112202d9STejun Heo 		pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
124436e227d2STejun Heo 
1245112202d9STejun Heo 		/* work->data points to pwq iff queued, point to pool */
12464468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
12474468a00fSLai Jiangshan 
1248d565ed63STejun Heo 		spin_unlock(&pool->lock);
124936e227d2STejun Heo 		return 1;
1250bf4ede01STejun Heo 	}
1251d565ed63STejun Heo 	spin_unlock(&pool->lock);
1252bbb68dfaSTejun Heo fail:
1253bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1254bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1255bbb68dfaSTejun Heo 		return -ENOENT;
1256bbb68dfaSTejun Heo 	cpu_relax();
125736e227d2STejun Heo 	return -EAGAIN;
1258bf4ede01STejun Heo }
1259bf4ede01STejun Heo 
1260bf4ede01STejun Heo /**
1261706026c2STejun Heo  * insert_work - insert a work into a pool
1262112202d9STejun Heo  * @pwq: pwq @work belongs to
12634690c4abSTejun Heo  * @work: work to insert
12644690c4abSTejun Heo  * @head: insertion point
12654690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
12664690c4abSTejun Heo  *
1267112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
1268706026c2STejun Heo  * work_struct flags.
12694690c4abSTejun Heo  *
12704690c4abSTejun Heo  * CONTEXT:
1271d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1272365970a1SDavid Howells  */
1273112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1274112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
1275b89deed3SOleg Nesterov {
1276112202d9STejun Heo 	struct worker_pool *pool = pwq->pool;
1277e1d8aa9fSFrederic Weisbecker 
12784690c4abSTejun Heo 	/* we own @work, set data and link */
1279112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
12801a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
12818864b4e5STejun Heo 	get_pwq(pwq);
1282e22bee78STejun Heo 
1283e22bee78STejun Heo 	/*
1284c5aa87bbSTejun Heo 	 * Ensure either wq_worker_sleeping() sees the above
1285c5aa87bbSTejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers lying
1286c5aa87bbSTejun Heo 	 * around lazily while there are works to be processed.
1287e22bee78STejun Heo 	 */
1288e22bee78STejun Heo 	smp_mb();
1289e22bee78STejun Heo 
129063d95a91STejun Heo 	if (__need_more_worker(pool))
129163d95a91STejun Heo 		wake_up_worker(pool);
1292b89deed3SOleg Nesterov }
1293b89deed3SOleg Nesterov 
1294c8efcc25STejun Heo /*
1295c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
12968d03ecfeSTejun Heo  * same workqueue.
1297c8efcc25STejun Heo  */
1298c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1299c8efcc25STejun Heo {
1300c8efcc25STejun Heo 	struct worker *worker;
1301c8efcc25STejun Heo 
13028d03ecfeSTejun Heo 	worker = current_wq_worker();
1303c8efcc25STejun Heo 	/*
13048d03ecfeSTejun Heo 	 * Return %true iff I'm a worker execuing a work item on @wq.  If
13058d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
1306c8efcc25STejun Heo 	 */
1307112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
1308c8efcc25STejun Heo }
1309c8efcc25STejun Heo 
1310d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
13111da177e4SLinus Torvalds 			 struct work_struct *work)
13121da177e4SLinus Torvalds {
1313112202d9STejun Heo 	struct pool_workqueue *pwq;
1314c9178087STejun Heo 	struct worker_pool *last_pool;
13151e19ffc6STejun Heo 	struct list_head *worklist;
13168a2e8e5dSTejun Heo 	unsigned int work_flags;
1317b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
13188930cabaSTejun Heo 
13198930cabaSTejun Heo 	/*
13208930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
13218930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
13228930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
13238930cabaSTejun Heo 	 * happen with IRQ disabled.
13248930cabaSTejun Heo 	 */
13258930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
13261da177e4SLinus Torvalds 
1327dc186ad7SThomas Gleixner 	debug_work_activate(work);
13281e19ffc6STejun Heo 
13299ef28a73SLi Bin 	/* if draining, only works from the same workqueue are allowed */
1330618b01ebSTejun Heo 	if (unlikely(wq->flags & __WQ_DRAINING) &&
1331c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1332e41e704bSTejun Heo 		return;
13339e8cd2f5STejun Heo retry:
1334df2d5ae4STejun Heo 	if (req_cpu == WORK_CPU_UNBOUND)
1335f3421797STejun Heo 		cpu = raw_smp_processor_id();
1336df2d5ae4STejun Heo 
1337df2d5ae4STejun Heo 	/* pwq which will be used unless @work is executing elsewhere */
1338df2d5ae4STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
1339c9178087STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1340df2d5ae4STejun Heo 	else
1341df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1342f3421797STejun Heo 
134318aa9effSTejun Heo 	/*
1344c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
1345c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
1346c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
134718aa9effSTejun Heo 	 */
1348c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
1349112202d9STejun Heo 	if (last_pool && last_pool != pwq->pool) {
135018aa9effSTejun Heo 		struct worker *worker;
135118aa9effSTejun Heo 
1352d565ed63STejun Heo 		spin_lock(&last_pool->lock);
135318aa9effSTejun Heo 
1354c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
135518aa9effSTejun Heo 
1356112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
1357c9178087STejun Heo 			pwq = worker->current_pwq;
13588594fadeSLai Jiangshan 		} else {
135918aa9effSTejun Heo 			/* meh... not running there, queue here */
1360d565ed63STejun Heo 			spin_unlock(&last_pool->lock);
1361112202d9STejun Heo 			spin_lock(&pwq->pool->lock);
136218aa9effSTejun Heo 		}
13638930cabaSTejun Heo 	} else {
1364112202d9STejun Heo 		spin_lock(&pwq->pool->lock);
13658930cabaSTejun Heo 	}
1366502ca9d8STejun Heo 
13679e8cd2f5STejun Heo 	/*
13689e8cd2f5STejun Heo 	 * pwq is determined and locked.  For unbound pools, we could have
13699e8cd2f5STejun Heo 	 * raced with pwq release and it could already be dead.  If its
13709e8cd2f5STejun Heo 	 * refcnt is zero, repeat pwq selection.  Note that pwqs never die
1371df2d5ae4STejun Heo 	 * without another pwq replacing it in the numa_pwq_tbl or while
1372df2d5ae4STejun Heo 	 * work items are executing on it, so the retrying is guaranteed to
13739e8cd2f5STejun Heo 	 * make forward-progress.
13749e8cd2f5STejun Heo 	 */
13759e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
13769e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
13779e8cd2f5STejun Heo 			spin_unlock(&pwq->pool->lock);
13789e8cd2f5STejun Heo 			cpu_relax();
13799e8cd2f5STejun Heo 			goto retry;
13809e8cd2f5STejun Heo 		}
13819e8cd2f5STejun Heo 		/* oops */
13829e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
13839e8cd2f5STejun Heo 			  wq->name, cpu);
13849e8cd2f5STejun Heo 	}
13859e8cd2f5STejun Heo 
1386112202d9STejun Heo 	/* pwq determined, queue */
1387112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
1388502ca9d8STejun Heo 
1389f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1390112202d9STejun Heo 		spin_unlock(&pwq->pool->lock);
1391f5b2552bSDan Carpenter 		return;
1392f5b2552bSDan Carpenter 	}
13931e19ffc6STejun Heo 
1394112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
1395112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
13961e19ffc6STejun Heo 
1397112202d9STejun Heo 	if (likely(pwq->nr_active < pwq->max_active)) {
1398cdadf009STejun Heo 		trace_workqueue_activate_work(work);
1399112202d9STejun Heo 		pwq->nr_active++;
1400112202d9STejun Heo 		worklist = &pwq->pool->worklist;
14018a2e8e5dSTejun Heo 	} else {
14028a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
1403112202d9STejun Heo 		worklist = &pwq->delayed_works;
14048a2e8e5dSTejun Heo 	}
14051e19ffc6STejun Heo 
1406112202d9STejun Heo 	insert_work(pwq, work, worklist, work_flags);
14071e19ffc6STejun Heo 
1408112202d9STejun Heo 	spin_unlock(&pwq->pool->lock);
14091da177e4SLinus Torvalds }
14101da177e4SLinus Torvalds 
14110fcb78c2SRolf Eike Beer /**
1412c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1413c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1414c1a220e7SZhang Rui  * @wq: workqueue to use
1415c1a220e7SZhang Rui  * @work: work to queue
1416c1a220e7SZhang Rui  *
1417c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1418c1a220e7SZhang Rui  * can't go away.
1419d185af30SYacine Belkadi  *
1420d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
1421c1a220e7SZhang Rui  */
1422d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1423d4283e93STejun Heo 		   struct work_struct *work)
1424c1a220e7SZhang Rui {
1425d4283e93STejun Heo 	bool ret = false;
14268930cabaSTejun Heo 	unsigned long flags;
14278930cabaSTejun Heo 
14288930cabaSTejun Heo 	local_irq_save(flags);
1429c1a220e7SZhang Rui 
143022df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14314690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1432d4283e93STejun Heo 		ret = true;
1433c1a220e7SZhang Rui 	}
14348930cabaSTejun Heo 
14358930cabaSTejun Heo 	local_irq_restore(flags);
1436c1a220e7SZhang Rui 	return ret;
1437c1a220e7SZhang Rui }
1438ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
1439c1a220e7SZhang Rui 
1440d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
14411da177e4SLinus Torvalds {
144252bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
14431da177e4SLinus Torvalds 
1444e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
144560c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
14461da177e4SLinus Torvalds }
14471438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
14481da177e4SLinus Torvalds 
14497beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
145052bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
14511da177e4SLinus Torvalds {
14527beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
14537beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
14541da177e4SLinus Torvalds 
14557beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
14567beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
1457fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1458fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
14597beb2edfSTejun Heo 
14608852aac2STejun Heo 	/*
14618852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
14628852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
14638852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
14648852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
14658852aac2STejun Heo 	 */
14668852aac2STejun Heo 	if (!delay) {
14678852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
14688852aac2STejun Heo 		return;
14698852aac2STejun Heo 	}
14708852aac2STejun Heo 
14717beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
14727beb2edfSTejun Heo 
147360c057bcSLai Jiangshan 	dwork->wq = wq;
14741265057fSTejun Heo 	dwork->cpu = cpu;
14757beb2edfSTejun Heo 	timer->expires = jiffies + delay;
14767beb2edfSTejun Heo 
14777beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
14787beb2edfSTejun Heo 		add_timer_on(timer, cpu);
14797beb2edfSTejun Heo 	else
14807beb2edfSTejun Heo 		add_timer(timer);
14817beb2edfSTejun Heo }
14821da177e4SLinus Torvalds 
14830fcb78c2SRolf Eike Beer /**
14840fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
14850fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
14860fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1487af9997e4SRandy Dunlap  * @dwork: work to queue
14880fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
14890fcb78c2SRolf Eike Beer  *
1490d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
1491715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1492715f1300STejun Heo  * execution.
14930fcb78c2SRolf Eike Beer  */
1494d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
149552bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
14967a6bc1cdSVenkatesh Pallipadi {
149752bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1498d4283e93STejun Heo 	bool ret = false;
14998930cabaSTejun Heo 	unsigned long flags;
15008930cabaSTejun Heo 
15018930cabaSTejun Heo 	/* read the comment in __queue_work() */
15028930cabaSTejun Heo 	local_irq_save(flags);
15037a6bc1cdSVenkatesh Pallipadi 
150422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
15057beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1506d4283e93STejun Heo 		ret = true;
15077a6bc1cdSVenkatesh Pallipadi 	}
15088930cabaSTejun Heo 
15098930cabaSTejun Heo 	local_irq_restore(flags);
15107a6bc1cdSVenkatesh Pallipadi 	return ret;
15117a6bc1cdSVenkatesh Pallipadi }
1512ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
15131da177e4SLinus Torvalds 
1514c8e55f36STejun Heo /**
15158376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
15168376fe22STejun Heo  * @cpu: CPU number to execute work on
15178376fe22STejun Heo  * @wq: workqueue to use
15188376fe22STejun Heo  * @dwork: work to queue
15198376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
15208376fe22STejun Heo  *
15218376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
15228376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
15238376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
15248376fe22STejun Heo  * current state.
15258376fe22STejun Heo  *
1526d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
15278376fe22STejun Heo  * pending and its timer was modified.
15288376fe22STejun Heo  *
1529e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
15308376fe22STejun Heo  * See try_to_grab_pending() for details.
15318376fe22STejun Heo  */
15328376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
15338376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
15348376fe22STejun Heo {
15358376fe22STejun Heo 	unsigned long flags;
15368376fe22STejun Heo 	int ret;
15378376fe22STejun Heo 
15388376fe22STejun Heo 	do {
15398376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
15408376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
15418376fe22STejun Heo 
15428376fe22STejun Heo 	if (likely(ret >= 0)) {
15438376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
15448376fe22STejun Heo 		local_irq_restore(flags);
15458376fe22STejun Heo 	}
15468376fe22STejun Heo 
15478376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
15488376fe22STejun Heo 	return ret;
15498376fe22STejun Heo }
15508376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
15518376fe22STejun Heo 
15528376fe22STejun Heo /**
1553c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1554c8e55f36STejun Heo  * @worker: worker which is entering idle state
1555c8e55f36STejun Heo  *
1556c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1557c8e55f36STejun Heo  * necessary.
1558c8e55f36STejun Heo  *
1559c8e55f36STejun Heo  * LOCKING:
1560d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1561c8e55f36STejun Heo  */
1562c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
15631da177e4SLinus Torvalds {
1564bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1565c8e55f36STejun Heo 
15666183c009STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
15676183c009STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
15686183c009STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
15696183c009STejun Heo 		return;
1570c8e55f36STejun Heo 
1571cb444766STejun Heo 	/* can't use worker_set_flags(), also called from start_worker() */
1572cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1573bd7bdd43STejun Heo 	pool->nr_idle++;
1574e22bee78STejun Heo 	worker->last_active = jiffies;
1575c8e55f36STejun Heo 
1576c8e55f36STejun Heo 	/* idle_list is LIFO */
1577bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1578db7bccf4STejun Heo 
157963d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1580628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1581cb444766STejun Heo 
1582544ecf31STejun Heo 	/*
1583706026c2STejun Heo 	 * Sanity check nr_running.  Because wq_unbind_fn() releases
1584d565ed63STejun Heo 	 * pool->lock between setting %WORKER_UNBOUND and zapping
1585628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1586628c78e7STejun Heo 	 * unbind is not in progress.
1587544ecf31STejun Heo 	 */
158824647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1589bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
1590e19e397aSTejun Heo 		     atomic_read(&pool->nr_running));
1591c8e55f36STejun Heo }
1592c8e55f36STejun Heo 
1593c8e55f36STejun Heo /**
1594c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1595c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1596c8e55f36STejun Heo  *
1597c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1598c8e55f36STejun Heo  *
1599c8e55f36STejun Heo  * LOCKING:
1600d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1601c8e55f36STejun Heo  */
1602c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1603c8e55f36STejun Heo {
1604bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1605c8e55f36STejun Heo 
16066183c009STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
16076183c009STejun Heo 		return;
1608d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1609bd7bdd43STejun Heo 	pool->nr_idle--;
1610c8e55f36STejun Heo 	list_del_init(&worker->entry);
1611c8e55f36STejun Heo }
1612c8e55f36STejun Heo 
1613e22bee78STejun Heo /**
1614f36dc67bSLai Jiangshan  * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1615f36dc67bSLai Jiangshan  * @pool: target worker_pool
1616f36dc67bSLai Jiangshan  *
1617f36dc67bSLai Jiangshan  * Bind %current to the cpu of @pool if it is associated and lock @pool.
1618e22bee78STejun Heo  *
1619e22bee78STejun Heo  * Works which are scheduled while the cpu is online must at least be
1620e22bee78STejun Heo  * scheduled to a worker which is bound to the cpu so that if they are
1621e22bee78STejun Heo  * flushed from cpu callbacks while cpu is going down, they are
1622e22bee78STejun Heo  * guaranteed to execute on the cpu.
1623e22bee78STejun Heo  *
1624f5faa077SLai Jiangshan  * This function is to be used by unbound workers and rescuers to bind
1625e22bee78STejun Heo  * themselves to the target cpu and may race with cpu going down or
1626e22bee78STejun Heo  * coming online.  kthread_bind() can't be used because it may put the
1627e22bee78STejun Heo  * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1628706026c2STejun Heo  * verbatim as it's best effort and blocking and pool may be
1629e22bee78STejun Heo  * [dis]associated in the meantime.
1630e22bee78STejun Heo  *
1631706026c2STejun Heo  * This function tries set_cpus_allowed() and locks pool and verifies the
163224647570STejun Heo  * binding against %POOL_DISASSOCIATED which is set during
1633f2d5a0eeSTejun Heo  * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1634f2d5a0eeSTejun Heo  * enters idle state or fetches works without dropping lock, it can
1635f2d5a0eeSTejun Heo  * guarantee the scheduling requirement described in the first paragraph.
1636e22bee78STejun Heo  *
1637e22bee78STejun Heo  * CONTEXT:
1638d565ed63STejun Heo  * Might sleep.  Called without any lock but returns with pool->lock
1639e22bee78STejun Heo  * held.
1640e22bee78STejun Heo  *
1641d185af30SYacine Belkadi  * Return:
1642706026c2STejun Heo  * %true if the associated pool is online (@worker is successfully
1643e22bee78STejun Heo  * bound), %false if offline.
1644e22bee78STejun Heo  */
1645f36dc67bSLai Jiangshan static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
1646d565ed63STejun Heo __acquires(&pool->lock)
1647e22bee78STejun Heo {
1648e22bee78STejun Heo 	while (true) {
1649e22bee78STejun Heo 		/*
1650e22bee78STejun Heo 		 * The following call may fail, succeed or succeed
1651e22bee78STejun Heo 		 * without actually migrating the task to the cpu if
1652e22bee78STejun Heo 		 * it races with cpu hotunplug operation.  Verify
165324647570STejun Heo 		 * against POOL_DISASSOCIATED.
1654e22bee78STejun Heo 		 */
165524647570STejun Heo 		if (!(pool->flags & POOL_DISASSOCIATED))
16567a4e344cSTejun Heo 			set_cpus_allowed_ptr(current, pool->attrs->cpumask);
1657e22bee78STejun Heo 
1658d565ed63STejun Heo 		spin_lock_irq(&pool->lock);
165924647570STejun Heo 		if (pool->flags & POOL_DISASSOCIATED)
1660e22bee78STejun Heo 			return false;
1661f5faa077SLai Jiangshan 		if (task_cpu(current) == pool->cpu &&
16627a4e344cSTejun Heo 		    cpumask_equal(&current->cpus_allowed, pool->attrs->cpumask))
1663e22bee78STejun Heo 			return true;
1664d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
1665e22bee78STejun Heo 
16665035b20fSTejun Heo 		/*
16675035b20fSTejun Heo 		 * We've raced with CPU hot[un]plug.  Give it a breather
16685035b20fSTejun Heo 		 * and retry migration.  cond_resched() is required here;
16695035b20fSTejun Heo 		 * otherwise, we might deadlock against cpu_stop trying to
16705035b20fSTejun Heo 		 * bring down the CPU on non-preemptive kernel.
16715035b20fSTejun Heo 		 */
1672e22bee78STejun Heo 		cpu_relax();
16735035b20fSTejun Heo 		cond_resched();
1674e22bee78STejun Heo 	}
1675e22bee78STejun Heo }
1676e22bee78STejun Heo 
1677c34056a3STejun Heo static struct worker *alloc_worker(void)
1678c34056a3STejun Heo {
1679c34056a3STejun Heo 	struct worker *worker;
1680c34056a3STejun Heo 
1681c34056a3STejun Heo 	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
1682c8e55f36STejun Heo 	if (worker) {
1683c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1684affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1685e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1686e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1687c8e55f36STejun Heo 	}
1688c34056a3STejun Heo 	return worker;
1689c34056a3STejun Heo }
1690c34056a3STejun Heo 
1691c34056a3STejun Heo /**
1692*60f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
1693*60f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
1694*60f5a4bcSLai Jiangshan  * @pool: the pool @worker is attached to
1695*60f5a4bcSLai Jiangshan  *
1696*60f5a4bcSLai Jiangshan  * Undo the attaching which had been done in create_worker().  The caller
1697*60f5a4bcSLai Jiangshan  * worker shouldn't access to the pool after detached except it has other
1698*60f5a4bcSLai Jiangshan  * reference to the pool.
1699*60f5a4bcSLai Jiangshan  */
1700*60f5a4bcSLai Jiangshan static void worker_detach_from_pool(struct worker *worker,
1701*60f5a4bcSLai Jiangshan 				    struct worker_pool *pool)
1702*60f5a4bcSLai Jiangshan {
1703*60f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
1704*60f5a4bcSLai Jiangshan 
1705*60f5a4bcSLai Jiangshan 	mutex_lock(&pool->manager_mutex);
1706*60f5a4bcSLai Jiangshan 	idr_remove(&pool->worker_idr, worker->id);
1707*60f5a4bcSLai Jiangshan 	if (idr_is_empty(&pool->worker_idr))
1708*60f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
1709*60f5a4bcSLai Jiangshan 	mutex_unlock(&pool->manager_mutex);
1710*60f5a4bcSLai Jiangshan 
1711*60f5a4bcSLai Jiangshan 	if (detach_completion)
1712*60f5a4bcSLai Jiangshan 		complete(detach_completion);
1713*60f5a4bcSLai Jiangshan }
1714*60f5a4bcSLai Jiangshan 
1715*60f5a4bcSLai Jiangshan /**
1716c34056a3STejun Heo  * create_worker - create a new workqueue worker
171763d95a91STejun Heo  * @pool: pool the new worker will belong to
1718c34056a3STejun Heo  *
171973eb7fe7SLai Jiangshan  * Create a new worker which is attached to @pool.  The new worker must be
172073eb7fe7SLai Jiangshan  * started by start_worker().
1721c34056a3STejun Heo  *
1722c34056a3STejun Heo  * CONTEXT:
1723c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1724c34056a3STejun Heo  *
1725d185af30SYacine Belkadi  * Return:
1726c34056a3STejun Heo  * Pointer to the newly created worker.
1727c34056a3STejun Heo  */
1728bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1729c34056a3STejun Heo {
1730c34056a3STejun Heo 	struct worker *worker = NULL;
1731f3421797STejun Heo 	int id = -1;
1732e3c916a4STejun Heo 	char id_buf[16];
1733c34056a3STejun Heo 
1734cd549687STejun Heo 	lockdep_assert_held(&pool->manager_mutex);
1735cd549687STejun Heo 
1736822d8405STejun Heo 	/*
1737822d8405STejun Heo 	 * ID is needed to determine kthread name.  Allocate ID first
1738822d8405STejun Heo 	 * without installing the pointer.
1739822d8405STejun Heo 	 */
17409625ab17SLai Jiangshan 	id = idr_alloc(&pool->worker_idr, NULL, 0, 0, GFP_KERNEL);
1741822d8405STejun Heo 	if (id < 0)
1742c34056a3STejun Heo 		goto fail;
1743c34056a3STejun Heo 
1744c34056a3STejun Heo 	worker = alloc_worker();
1745c34056a3STejun Heo 	if (!worker)
1746c34056a3STejun Heo 		goto fail;
1747c34056a3STejun Heo 
1748bd7bdd43STejun Heo 	worker->pool = pool;
1749c34056a3STejun Heo 	worker->id = id;
1750c34056a3STejun Heo 
175129c91e99STejun Heo 	if (pool->cpu >= 0)
1752e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1753e3c916a4STejun Heo 			 pool->attrs->nice < 0  ? "H" : "");
1754f3421797STejun Heo 	else
1755e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1756e3c916a4STejun Heo 
1757f3f90ad4STejun Heo 	worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1758e3c916a4STejun Heo 					      "kworker/%s", id_buf);
1759c34056a3STejun Heo 	if (IS_ERR(worker->task))
1760c34056a3STejun Heo 		goto fail;
1761c34056a3STejun Heo 
176291151228SOleg Nesterov 	set_user_nice(worker->task, pool->attrs->nice);
176391151228SOleg Nesterov 
176491151228SOleg Nesterov 	/* prevent userland from meddling with cpumask of workqueue workers */
176591151228SOleg Nesterov 	worker->task->flags |= PF_NO_SETAFFINITY;
176691151228SOleg Nesterov 
1767c5aa87bbSTejun Heo 	/*
1768c5aa87bbSTejun Heo 	 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1769c5aa87bbSTejun Heo 	 * online CPUs.  It'll be re-applied when any of the CPUs come up.
1770c5aa87bbSTejun Heo 	 */
17717a4e344cSTejun Heo 	set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
17723270476aSTejun Heo 
17737a4e344cSTejun Heo 	/*
17747a4e344cSTejun Heo 	 * The caller is responsible for ensuring %POOL_DISASSOCIATED
17757a4e344cSTejun Heo 	 * remains stable across this function.  See the comments above the
17767a4e344cSTejun Heo 	 * flag definition for details.
17777a4e344cSTejun Heo 	 */
17787a4e344cSTejun Heo 	if (pool->flags & POOL_DISASSOCIATED)
1779f3421797STejun Heo 		worker->flags |= WORKER_UNBOUND;
1780c34056a3STejun Heo 
1781822d8405STejun Heo 	/* successful, commit the pointer to idr */
1782822d8405STejun Heo 	idr_replace(&pool->worker_idr, worker, worker->id);
1783822d8405STejun Heo 
1784c34056a3STejun Heo 	return worker;
1785822d8405STejun Heo 
1786c34056a3STejun Heo fail:
17879625ab17SLai Jiangshan 	if (id >= 0)
1788822d8405STejun Heo 		idr_remove(&pool->worker_idr, id);
1789c34056a3STejun Heo 	kfree(worker);
1790c34056a3STejun Heo 	return NULL;
1791c34056a3STejun Heo }
1792c34056a3STejun Heo 
1793c34056a3STejun Heo /**
1794c34056a3STejun Heo  * start_worker - start a newly created worker
1795c34056a3STejun Heo  * @worker: worker to start
1796c34056a3STejun Heo  *
1797706026c2STejun Heo  * Make the pool aware of @worker and start it.
1798c34056a3STejun Heo  *
1799c34056a3STejun Heo  * CONTEXT:
1800d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1801c34056a3STejun Heo  */
1802c34056a3STejun Heo static void start_worker(struct worker *worker)
1803c34056a3STejun Heo {
1804bd7bdd43STejun Heo 	worker->pool->nr_workers++;
1805c8e55f36STejun Heo 	worker_enter_idle(worker);
1806c34056a3STejun Heo 	wake_up_process(worker->task);
1807c34056a3STejun Heo }
1808c34056a3STejun Heo 
1809c34056a3STejun Heo /**
1810ebf44d16STejun Heo  * create_and_start_worker - create and start a worker for a pool
1811ebf44d16STejun Heo  * @pool: the target pool
1812ebf44d16STejun Heo  *
1813cd549687STejun Heo  * Grab the managership of @pool and create and start a new worker for it.
1814d185af30SYacine Belkadi  *
1815d185af30SYacine Belkadi  * Return: 0 on success. A negative error code otherwise.
1816ebf44d16STejun Heo  */
1817ebf44d16STejun Heo static int create_and_start_worker(struct worker_pool *pool)
1818ebf44d16STejun Heo {
1819ebf44d16STejun Heo 	struct worker *worker;
1820ebf44d16STejun Heo 
1821cd549687STejun Heo 	mutex_lock(&pool->manager_mutex);
1822cd549687STejun Heo 
1823ebf44d16STejun Heo 	worker = create_worker(pool);
1824ebf44d16STejun Heo 	if (worker) {
1825ebf44d16STejun Heo 		spin_lock_irq(&pool->lock);
1826ebf44d16STejun Heo 		start_worker(worker);
1827ebf44d16STejun Heo 		spin_unlock_irq(&pool->lock);
1828ebf44d16STejun Heo 	}
1829ebf44d16STejun Heo 
1830cd549687STejun Heo 	mutex_unlock(&pool->manager_mutex);
1831cd549687STejun Heo 
1832ebf44d16STejun Heo 	return worker ? 0 : -ENOMEM;
1833ebf44d16STejun Heo }
1834ebf44d16STejun Heo 
1835ebf44d16STejun Heo /**
1836c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1837c34056a3STejun Heo  * @worker: worker to be destroyed
1838c34056a3STejun Heo  *
183973eb7fe7SLai Jiangshan  * Destroy @worker and adjust @pool stats accordingly.  The worker should
184073eb7fe7SLai Jiangshan  * be idle.
1841c8e55f36STejun Heo  *
1842c8e55f36STejun Heo  * CONTEXT:
1843*60f5a4bcSLai Jiangshan  * spin_lock_irq(pool->lock).
1844c34056a3STejun Heo  */
1845c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1846c34056a3STejun Heo {
1847bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1848c34056a3STejun Heo 
1849cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
1850cd549687STejun Heo 
1851c34056a3STejun Heo 	/* sanity check frenzy */
18526183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
185373eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
185473eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
18556183c009STejun Heo 		return;
1856c34056a3STejun Heo 
1857bd7bdd43STejun Heo 	pool->nr_workers--;
1858bd7bdd43STejun Heo 	pool->nr_idle--;
1859c8e55f36STejun Heo 
1860c8e55f36STejun Heo 	list_del_init(&worker->entry);
1861cb444766STejun Heo 	worker->flags |= WORKER_DIE;
1862*60f5a4bcSLai Jiangshan 	wake_up_process(worker->task);
1863c34056a3STejun Heo }
1864c34056a3STejun Heo 
186563d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1866e22bee78STejun Heo {
186763d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1868e22bee78STejun Heo 
1869d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1870e22bee78STejun Heo 
187163d95a91STejun Heo 	if (too_many_workers(pool)) {
1872e22bee78STejun Heo 		struct worker *worker;
1873e22bee78STejun Heo 		unsigned long expires;
1874e22bee78STejun Heo 
1875e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
187663d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1877e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1878e22bee78STejun Heo 
1879e22bee78STejun Heo 		if (time_before(jiffies, expires))
188063d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
1881e22bee78STejun Heo 		else {
1882e22bee78STejun Heo 			/* it's been idle for too long, wake up manager */
188311ebea50STejun Heo 			pool->flags |= POOL_MANAGE_WORKERS;
188463d95a91STejun Heo 			wake_up_worker(pool);
1885e22bee78STejun Heo 		}
1886e22bee78STejun Heo 	}
1887e22bee78STejun Heo 
1888d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
1889e22bee78STejun Heo }
1890e22bee78STejun Heo 
1891493a1724STejun Heo static void send_mayday(struct work_struct *work)
1892e22bee78STejun Heo {
1893112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1894112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
1895493a1724STejun Heo 
18962e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
1897e22bee78STejun Heo 
1898493008a8STejun Heo 	if (!wq->rescuer)
1899493a1724STejun Heo 		return;
1900e22bee78STejun Heo 
1901e22bee78STejun Heo 	/* mayday mayday mayday */
1902493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
190377668c8bSLai Jiangshan 		/*
190477668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
190577668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
190677668c8bSLai Jiangshan 		 * rescuer is done with it.
190777668c8bSLai Jiangshan 		 */
190877668c8bSLai Jiangshan 		get_pwq(pwq);
1909493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
1910e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1911493a1724STejun Heo 	}
1912e22bee78STejun Heo }
1913e22bee78STejun Heo 
1914706026c2STejun Heo static void pool_mayday_timeout(unsigned long __pool)
1915e22bee78STejun Heo {
191663d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1917e22bee78STejun Heo 	struct work_struct *work;
1918e22bee78STejun Heo 
19192e109a28STejun Heo 	spin_lock_irq(&wq_mayday_lock);		/* for wq->maydays */
1920493a1724STejun Heo 	spin_lock(&pool->lock);
1921e22bee78STejun Heo 
192263d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1923e22bee78STejun Heo 		/*
1924e22bee78STejun Heo 		 * We've been trying to create a new worker but
1925e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1926e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1927e22bee78STejun Heo 		 * rescuers.
1928e22bee78STejun Heo 		 */
192963d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1930e22bee78STejun Heo 			send_mayday(work);
1931e22bee78STejun Heo 	}
1932e22bee78STejun Heo 
1933493a1724STejun Heo 	spin_unlock(&pool->lock);
19342e109a28STejun Heo 	spin_unlock_irq(&wq_mayday_lock);
1935e22bee78STejun Heo 
193663d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1937e22bee78STejun Heo }
1938e22bee78STejun Heo 
1939e22bee78STejun Heo /**
1940e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
194163d95a91STejun Heo  * @pool: pool to create a new worker for
1942e22bee78STejun Heo  *
194363d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1944e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1945e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
194663d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1947e22bee78STejun Heo  * possible allocation deadlock.
1948e22bee78STejun Heo  *
1949c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
1950c5aa87bbSTejun Heo  * may_start_working() %true.
1951e22bee78STejun Heo  *
1952e22bee78STejun Heo  * LOCKING:
1953d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
1954e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1955e22bee78STejun Heo  * manager.
1956e22bee78STejun Heo  *
1957d185af30SYacine Belkadi  * Return:
1958c5aa87bbSTejun Heo  * %false if no action was taken and pool->lock stayed locked, %true
1959e22bee78STejun Heo  * otherwise.
1960e22bee78STejun Heo  */
196163d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
1962d565ed63STejun Heo __releases(&pool->lock)
1963d565ed63STejun Heo __acquires(&pool->lock)
1964e22bee78STejun Heo {
196563d95a91STejun Heo 	if (!need_to_create_worker(pool))
1966e22bee78STejun Heo 		return false;
1967e22bee78STejun Heo restart:
1968d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
19699f9c2364STejun Heo 
1970e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
197163d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1972e22bee78STejun Heo 
1973e22bee78STejun Heo 	while (true) {
1974e22bee78STejun Heo 		struct worker *worker;
1975e22bee78STejun Heo 
1976bc2ae0f5STejun Heo 		worker = create_worker(pool);
1977e22bee78STejun Heo 		if (worker) {
197863d95a91STejun Heo 			del_timer_sync(&pool->mayday_timer);
1979d565ed63STejun Heo 			spin_lock_irq(&pool->lock);
1980e22bee78STejun Heo 			start_worker(worker);
19816183c009STejun Heo 			if (WARN_ON_ONCE(need_to_create_worker(pool)))
19826183c009STejun Heo 				goto restart;
1983e22bee78STejun Heo 			return true;
1984e22bee78STejun Heo 		}
1985e22bee78STejun Heo 
198663d95a91STejun Heo 		if (!need_to_create_worker(pool))
1987e22bee78STejun Heo 			break;
1988e22bee78STejun Heo 
1989e22bee78STejun Heo 		__set_current_state(TASK_INTERRUPTIBLE);
1990e22bee78STejun Heo 		schedule_timeout(CREATE_COOLDOWN);
19919f9c2364STejun Heo 
199263d95a91STejun Heo 		if (!need_to_create_worker(pool))
1993e22bee78STejun Heo 			break;
1994e22bee78STejun Heo 	}
1995e22bee78STejun Heo 
199663d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1997d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
199863d95a91STejun Heo 	if (need_to_create_worker(pool))
1999e22bee78STejun Heo 		goto restart;
2000e22bee78STejun Heo 	return true;
2001e22bee78STejun Heo }
2002e22bee78STejun Heo 
2003e22bee78STejun Heo /**
2004e22bee78STejun Heo  * maybe_destroy_worker - destroy workers which have been idle for a while
200563d95a91STejun Heo  * @pool: pool to destroy workers for
2006e22bee78STejun Heo  *
200763d95a91STejun Heo  * Destroy @pool workers which have been idle for longer than
2008e22bee78STejun Heo  * IDLE_WORKER_TIMEOUT.
2009e22bee78STejun Heo  *
2010e22bee78STejun Heo  * LOCKING:
2011d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2012e22bee78STejun Heo  * multiple times.  Called only from manager.
2013e22bee78STejun Heo  *
2014d185af30SYacine Belkadi  * Return:
2015c5aa87bbSTejun Heo  * %false if no action was taken and pool->lock stayed locked, %true
2016e22bee78STejun Heo  * otherwise.
2017e22bee78STejun Heo  */
201863d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool)
2019e22bee78STejun Heo {
2020e22bee78STejun Heo 	bool ret = false;
2021e22bee78STejun Heo 
202263d95a91STejun Heo 	while (too_many_workers(pool)) {
2023e22bee78STejun Heo 		struct worker *worker;
2024e22bee78STejun Heo 		unsigned long expires;
2025e22bee78STejun Heo 
202663d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2027e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2028e22bee78STejun Heo 
2029e22bee78STejun Heo 		if (time_before(jiffies, expires)) {
203063d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
2031e22bee78STejun Heo 			break;
2032e22bee78STejun Heo 		}
2033e22bee78STejun Heo 
2034e22bee78STejun Heo 		destroy_worker(worker);
2035e22bee78STejun Heo 		ret = true;
2036e22bee78STejun Heo 	}
2037e22bee78STejun Heo 
2038e22bee78STejun Heo 	return ret;
2039e22bee78STejun Heo }
2040e22bee78STejun Heo 
2041e22bee78STejun Heo /**
2042e22bee78STejun Heo  * manage_workers - manage worker pool
2043e22bee78STejun Heo  * @worker: self
2044e22bee78STejun Heo  *
2045706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
2046e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2047706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
2048e22bee78STejun Heo  *
2049e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2050e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2051e22bee78STejun Heo  * and may_start_working() is true.
2052e22bee78STejun Heo  *
2053e22bee78STejun Heo  * CONTEXT:
2054d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2055e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2056e22bee78STejun Heo  *
2057d185af30SYacine Belkadi  * Return:
20582d498db9SLibin  * %false if the pool don't need management and the caller can safely start
20592d498db9SLibin  * processing works, %true indicates that the function released pool->lock
20602d498db9SLibin  * and reacquired it to perform some management function and that the
20612d498db9SLibin  * conditions that the caller verified while holding the lock before
20622d498db9SLibin  * calling the function might no longer be true.
2063e22bee78STejun Heo  */
2064e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2065e22bee78STejun Heo {
206663d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2067e22bee78STejun Heo 	bool ret = false;
2068e22bee78STejun Heo 
2069bc3a1afcSTejun Heo 	/*
2070bc3a1afcSTejun Heo 	 * Managership is governed by two mutexes - manager_arb and
2071bc3a1afcSTejun Heo 	 * manager_mutex.  manager_arb handles arbitration of manager role.
2072bc3a1afcSTejun Heo 	 * Anyone who successfully grabs manager_arb wins the arbitration
2073bc3a1afcSTejun Heo 	 * and becomes the manager.  mutex_trylock() on pool->manager_arb
2074bc3a1afcSTejun Heo 	 * failure while holding pool->lock reliably indicates that someone
2075bc3a1afcSTejun Heo 	 * else is managing the pool and the worker which failed trylock
2076bc3a1afcSTejun Heo 	 * can proceed to executing work items.  This means that anyone
2077bc3a1afcSTejun Heo 	 * grabbing manager_arb is responsible for actually performing
2078bc3a1afcSTejun Heo 	 * manager duties.  If manager_arb is grabbed and released without
2079bc3a1afcSTejun Heo 	 * actual management, the pool may stall indefinitely.
2080bc3a1afcSTejun Heo 	 *
2081bc3a1afcSTejun Heo 	 * manager_mutex is used for exclusion of actual management
2082bc3a1afcSTejun Heo 	 * operations.  The holder of manager_mutex can be sure that none
2083bc3a1afcSTejun Heo 	 * of management operations, including creation and destruction of
2084bc3a1afcSTejun Heo 	 * workers, won't take place until the mutex is released.  Because
2085bc3a1afcSTejun Heo 	 * manager_mutex doesn't interfere with manager role arbitration,
2086bc3a1afcSTejun Heo 	 * it is guaranteed that the pool's management, while may be
2087bc3a1afcSTejun Heo 	 * delayed, won't be disturbed by someone else grabbing
2088bc3a1afcSTejun Heo 	 * manager_mutex.
2089bc3a1afcSTejun Heo 	 */
209034a06bd6STejun Heo 	if (!mutex_trylock(&pool->manager_arb))
2091e22bee78STejun Heo 		return ret;
2092e22bee78STejun Heo 
2093ee378aa4SLai Jiangshan 	/*
2094bc3a1afcSTejun Heo 	 * With manager arbitration won, manager_mutex would be free in
2095bc3a1afcSTejun Heo 	 * most cases.  trylock first without dropping @pool->lock.
2096ee378aa4SLai Jiangshan 	 */
2097bc3a1afcSTejun Heo 	if (unlikely(!mutex_trylock(&pool->manager_mutex))) {
2098d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
2099bc3a1afcSTejun Heo 		mutex_lock(&pool->manager_mutex);
21008f174b11SJoonsoo Kim 		spin_lock_irq(&pool->lock);
2101ee378aa4SLai Jiangshan 		ret = true;
2102ee378aa4SLai Jiangshan 	}
2103ee378aa4SLai Jiangshan 
210411ebea50STejun Heo 	pool->flags &= ~POOL_MANAGE_WORKERS;
2105e22bee78STejun Heo 
2106e22bee78STejun Heo 	/*
2107e22bee78STejun Heo 	 * Destroy and then create so that may_start_working() is true
2108e22bee78STejun Heo 	 * on return.
2109e22bee78STejun Heo 	 */
211063d95a91STejun Heo 	ret |= maybe_destroy_workers(pool);
211163d95a91STejun Heo 	ret |= maybe_create_worker(pool);
2112e22bee78STejun Heo 
2113bc3a1afcSTejun Heo 	mutex_unlock(&pool->manager_mutex);
211434a06bd6STejun Heo 	mutex_unlock(&pool->manager_arb);
2115e22bee78STejun Heo 	return ret;
2116e22bee78STejun Heo }
2117e22bee78STejun Heo 
2118a62428c0STejun Heo /**
2119a62428c0STejun Heo  * process_one_work - process single work
2120c34056a3STejun Heo  * @worker: self
2121a62428c0STejun Heo  * @work: work to process
2122a62428c0STejun Heo  *
2123a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2124a62428c0STejun Heo  * process a single work including synchronization against and
2125a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2126a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2127a62428c0STejun Heo  * call this function to process a work.
2128a62428c0STejun Heo  *
2129a62428c0STejun Heo  * CONTEXT:
2130d565ed63STejun Heo  * spin_lock_irq(pool->lock) which is released and regrabbed.
2131a62428c0STejun Heo  */
2132c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
2133d565ed63STejun Heo __releases(&pool->lock)
2134d565ed63STejun Heo __acquires(&pool->lock)
21351da177e4SLinus Torvalds {
2136112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2137bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2138112202d9STejun Heo 	bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
213973f53c4aSTejun Heo 	int work_color;
21407e11629dSTejun Heo 	struct worker *collision;
21414e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21424e6045f1SJohannes Berg 	/*
2143a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2144a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2145a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2146a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2147a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21484e6045f1SJohannes Berg 	 */
21494d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21504d82a1deSPeter Zijlstra 
21514d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21524e6045f1SJohannes Berg #endif
21536fec10a1STejun Heo 	/*
21546fec10a1STejun Heo 	 * Ensure we're on the correct CPU.  DISASSOCIATED test is
21556fec10a1STejun Heo 	 * necessary to avoid spurious warnings from rescuers servicing the
215624647570STejun Heo 	 * unbound or a disassociated pool.
21576fec10a1STejun Heo 	 */
21585f7dabfdSLai Jiangshan 	WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
215924647570STejun Heo 		     !(pool->flags & POOL_DISASSOCIATED) &&
2160ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
216125511a47STejun Heo 
21627e11629dSTejun Heo 	/*
21637e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21647e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21657e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21667e11629dSTejun Heo 	 * currently executing one.
21677e11629dSTejun Heo 	 */
2168c9e7cf27STejun Heo 	collision = find_worker_executing_work(pool, work);
21697e11629dSTejun Heo 	if (unlikely(collision)) {
21707e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21717e11629dSTejun Heo 		return;
21727e11629dSTejun Heo 	}
21731da177e4SLinus Torvalds 
21748930cabaSTejun Heo 	/* claim and dequeue */
21751da177e4SLinus Torvalds 	debug_work_deactivate(work);
2176c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2177c34056a3STejun Heo 	worker->current_work = work;
2178a2c1c57bSTejun Heo 	worker->current_func = work->func;
2179112202d9STejun Heo 	worker->current_pwq = pwq;
218073f53c4aSTejun Heo 	work_color = get_work_color(work);
21817a22ad75STejun Heo 
2182a62428c0STejun Heo 	list_del_init(&work->entry);
2183a62428c0STejun Heo 
2184649027d7STejun Heo 	/*
2185fb0e7bebSTejun Heo 	 * CPU intensive works don't participate in concurrency
2186fb0e7bebSTejun Heo 	 * management.  They're the scheduler's responsibility.
2187fb0e7bebSTejun Heo 	 */
2188fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2189fb0e7bebSTejun Heo 		worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2190fb0e7bebSTejun Heo 
2191974271c4STejun Heo 	/*
2192d565ed63STejun Heo 	 * Unbound pool isn't concurrency managed and work items should be
2193974271c4STejun Heo 	 * executed ASAP.  Wake up another worker if necessary.
2194974271c4STejun Heo 	 */
219563d95a91STejun Heo 	if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
219663d95a91STejun Heo 		wake_up_worker(pool);
2197974271c4STejun Heo 
21988930cabaSTejun Heo 	/*
21997c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
2200d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
220123657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
220223657bb1STejun Heo 	 * disabled.
22038930cabaSTejun Heo 	 */
22047c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
22051da177e4SLinus Torvalds 
2206d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2207365970a1SDavid Howells 
2208112202d9STejun Heo 	lock_map_acquire_read(&pwq->wq->lockdep_map);
22093295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2210e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2211a2c1c57bSTejun Heo 	worker->current_func(work);
2212e36c886aSArjan van de Ven 	/*
2213e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2214e36c886aSArjan van de Ven 	 * point will only record its address.
2215e36c886aSArjan van de Ven 	 */
2216e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22173295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
2218112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
22191da177e4SLinus Torvalds 
2220d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2221044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2222044c782cSValentin Ilie 		       "     last function: %pf\n",
2223a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2224a2c1c57bSTejun Heo 		       worker->current_func);
2225d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2226d5abe669SPeter Zijlstra 		dump_stack();
2227d5abe669SPeter Zijlstra 	}
2228d5abe669SPeter Zijlstra 
2229b22ce278STejun Heo 	/*
2230b22ce278STejun Heo 	 * The following prevents a kworker from hogging CPU on !PREEMPT
2231b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
2232b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
2233b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
2234b22ce278STejun Heo 	 * stop_machine.
2235b22ce278STejun Heo 	 */
2236b22ce278STejun Heo 	cond_resched();
2237b22ce278STejun Heo 
2238d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2239a62428c0STejun Heo 
2240fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2241fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2242fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2243fb0e7bebSTejun Heo 
2244a62428c0STejun Heo 	/* we're done with it, release */
224542f8570fSSasha Levin 	hash_del(&worker->hentry);
2246c34056a3STejun Heo 	worker->current_work = NULL;
2247a2c1c57bSTejun Heo 	worker->current_func = NULL;
2248112202d9STejun Heo 	worker->current_pwq = NULL;
22493d1cb205STejun Heo 	worker->desc_valid = false;
2250112202d9STejun Heo 	pwq_dec_nr_in_flight(pwq, work_color);
22511da177e4SLinus Torvalds }
22521da177e4SLinus Torvalds 
2253affee4b2STejun Heo /**
2254affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2255affee4b2STejun Heo  * @worker: self
2256affee4b2STejun Heo  *
2257affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2258affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2259affee4b2STejun Heo  * fetches a work from the top and executes it.
2260affee4b2STejun Heo  *
2261affee4b2STejun Heo  * CONTEXT:
2262d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2263affee4b2STejun Heo  * multiple times.
2264affee4b2STejun Heo  */
2265affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
22661da177e4SLinus Torvalds {
2267affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2268affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2269a62428c0STejun Heo 						struct work_struct, entry);
2270c34056a3STejun Heo 		process_one_work(worker, work);
2271a62428c0STejun Heo 	}
22721da177e4SLinus Torvalds }
22731da177e4SLinus Torvalds 
22744690c4abSTejun Heo /**
22754690c4abSTejun Heo  * worker_thread - the worker thread function
2276c34056a3STejun Heo  * @__worker: self
22774690c4abSTejun Heo  *
2278c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
2279c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
2280c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
2281c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
2282c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
2283d185af30SYacine Belkadi  *
2284d185af30SYacine Belkadi  * Return: 0
22854690c4abSTejun Heo  */
2286c34056a3STejun Heo static int worker_thread(void *__worker)
22871da177e4SLinus Torvalds {
2288c34056a3STejun Heo 	struct worker *worker = __worker;
2289bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
22901da177e4SLinus Torvalds 
2291e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2292e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2293c8e55f36STejun Heo woke_up:
2294d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2295affee4b2STejun Heo 
2296a9ab775bSTejun Heo 	/* am I supposed to die? */
2297a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
2298d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
2299a9ab775bSTejun Heo 		WARN_ON_ONCE(!list_empty(&worker->entry));
2300e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
2301*60f5a4bcSLai Jiangshan 
2302*60f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
2303*60f5a4bcSLai Jiangshan 		worker_detach_from_pool(worker, pool);
2304*60f5a4bcSLai Jiangshan 		kfree(worker);
2305c8e55f36STejun Heo 		return 0;
2306c8e55f36STejun Heo 	}
2307c8e55f36STejun Heo 
2308c8e55f36STejun Heo 	worker_leave_idle(worker);
2309db7bccf4STejun Heo recheck:
2310e22bee78STejun Heo 	/* no more worker necessary? */
231163d95a91STejun Heo 	if (!need_more_worker(pool))
2312e22bee78STejun Heo 		goto sleep;
2313e22bee78STejun Heo 
2314e22bee78STejun Heo 	/* do we need to manage? */
231563d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2316e22bee78STejun Heo 		goto recheck;
2317e22bee78STejun Heo 
2318c8e55f36STejun Heo 	/*
2319c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2320c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2321c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2322c8e55f36STejun Heo 	 */
23236183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
2324c8e55f36STejun Heo 
2325e22bee78STejun Heo 	/*
2326a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
2327a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
2328a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
2329a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
2330a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
2331e22bee78STejun Heo 	 */
2332a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2333e22bee78STejun Heo 
2334e22bee78STejun Heo 	do {
2335affee4b2STejun Heo 		struct work_struct *work =
2336bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2337affee4b2STejun Heo 					 struct work_struct, entry);
2338affee4b2STejun Heo 
2339c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2340affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2341affee4b2STejun Heo 			process_one_work(worker, work);
2342affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2343affee4b2STejun Heo 				process_scheduled_works(worker);
2344affee4b2STejun Heo 		} else {
2345c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2346affee4b2STejun Heo 			process_scheduled_works(worker);
2347affee4b2STejun Heo 		}
234863d95a91STejun Heo 	} while (keep_working(pool));
2349affee4b2STejun Heo 
2350e22bee78STejun Heo 	worker_set_flags(worker, WORKER_PREP, false);
2351d313dd85STejun Heo sleep:
235263d95a91STejun Heo 	if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
2353e22bee78STejun Heo 		goto recheck;
2354d313dd85STejun Heo 
2355c8e55f36STejun Heo 	/*
2356d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
2357d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
2358d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
2359d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
2360d565ed63STejun Heo 	 * event.
2361c8e55f36STejun Heo 	 */
2362c8e55f36STejun Heo 	worker_enter_idle(worker);
2363c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
2364d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
23651da177e4SLinus Torvalds 	schedule();
2366c8e55f36STejun Heo 	goto woke_up;
23671da177e4SLinus Torvalds }
23681da177e4SLinus Torvalds 
2369e22bee78STejun Heo /**
2370e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2371111c225aSTejun Heo  * @__rescuer: self
2372e22bee78STejun Heo  *
2373e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2374493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
2375e22bee78STejun Heo  *
2376706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
2377e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2378e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2379e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2380e22bee78STejun Heo  * the problem rescuer solves.
2381e22bee78STejun Heo  *
2382706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
2383706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
2384e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2385e22bee78STejun Heo  *
2386e22bee78STejun Heo  * This should happen rarely.
2387d185af30SYacine Belkadi  *
2388d185af30SYacine Belkadi  * Return: 0
2389e22bee78STejun Heo  */
2390111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2391e22bee78STejun Heo {
2392111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2393111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2394e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
23954d595b86SLai Jiangshan 	bool should_stop;
2396e22bee78STejun Heo 
2397e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2398111c225aSTejun Heo 
2399111c225aSTejun Heo 	/*
2400111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2401111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2402111c225aSTejun Heo 	 */
2403111c225aSTejun Heo 	rescuer->task->flags |= PF_WQ_WORKER;
2404e22bee78STejun Heo repeat:
2405e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
24061da177e4SLinus Torvalds 
24074d595b86SLai Jiangshan 	/*
24084d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
24094d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
24104d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
24114d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
24124d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
24134d595b86SLai Jiangshan 	 * list is always empty on exit.
24144d595b86SLai Jiangshan 	 */
24154d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
24161da177e4SLinus Torvalds 
2417493a1724STejun Heo 	/* see whether any pwq is asking for help */
24182e109a28STejun Heo 	spin_lock_irq(&wq_mayday_lock);
2419493a1724STejun Heo 
2420493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
2421493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2422493a1724STejun Heo 					struct pool_workqueue, mayday_node);
2423112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
2424e22bee78STejun Heo 		struct work_struct *work, *n;
2425e22bee78STejun Heo 
2426e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2427493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
2428493a1724STejun Heo 
24292e109a28STejun Heo 		spin_unlock_irq(&wq_mayday_lock);
2430e22bee78STejun Heo 
2431e22bee78STejun Heo 		/* migrate to the target cpu if possible */
2432f36dc67bSLai Jiangshan 		worker_maybe_bind_and_lock(pool);
2433b3104104SLai Jiangshan 		rescuer->pool = pool;
2434e22bee78STejun Heo 
2435e22bee78STejun Heo 		/*
2436e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2437e22bee78STejun Heo 		 * process'em.
2438e22bee78STejun Heo 		 */
24396183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
2440bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2441112202d9STejun Heo 			if (get_work_pwq(work) == pwq)
2442e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2443e22bee78STejun Heo 
2444e22bee78STejun Heo 		process_scheduled_works(rescuer);
24457576958aSTejun Heo 
24467576958aSTejun Heo 		/*
244777668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
244877668c8bSLai Jiangshan 		 * go away while we're holding its lock.
244977668c8bSLai Jiangshan 		 */
245077668c8bSLai Jiangshan 		put_pwq(pwq);
245177668c8bSLai Jiangshan 
245277668c8bSLai Jiangshan 		/*
2453d565ed63STejun Heo 		 * Leave this pool.  If keep_working() is %true, notify a
24547576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
24557576958aSTejun Heo 		 * and stalling the execution.
24567576958aSTejun Heo 		 */
245763d95a91STejun Heo 		if (keep_working(pool))
245863d95a91STejun Heo 			wake_up_worker(pool);
24597576958aSTejun Heo 
2460b3104104SLai Jiangshan 		rescuer->pool = NULL;
2461493a1724STejun Heo 		spin_unlock(&pool->lock);
24622e109a28STejun Heo 		spin_lock(&wq_mayday_lock);
24631da177e4SLinus Torvalds 	}
24641da177e4SLinus Torvalds 
24652e109a28STejun Heo 	spin_unlock_irq(&wq_mayday_lock);
2466493a1724STejun Heo 
24674d595b86SLai Jiangshan 	if (should_stop) {
24684d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
24694d595b86SLai Jiangshan 		rescuer->task->flags &= ~PF_WQ_WORKER;
24704d595b86SLai Jiangshan 		return 0;
24714d595b86SLai Jiangshan 	}
24724d595b86SLai Jiangshan 
2473111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2474111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2475e22bee78STejun Heo 	schedule();
2476e22bee78STejun Heo 	goto repeat;
24771da177e4SLinus Torvalds }
24781da177e4SLinus Torvalds 
2479fc2e4d70SOleg Nesterov struct wq_barrier {
2480fc2e4d70SOleg Nesterov 	struct work_struct	work;
2481fc2e4d70SOleg Nesterov 	struct completion	done;
2482fc2e4d70SOleg Nesterov };
2483fc2e4d70SOleg Nesterov 
2484fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2485fc2e4d70SOleg Nesterov {
2486fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2487fc2e4d70SOleg Nesterov 	complete(&barr->done);
2488fc2e4d70SOleg Nesterov }
2489fc2e4d70SOleg Nesterov 
24904690c4abSTejun Heo /**
24914690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
2492112202d9STejun Heo  * @pwq: pwq to insert barrier into
24934690c4abSTejun Heo  * @barr: wq_barrier to insert
2494affee4b2STejun Heo  * @target: target work to attach @barr to
2495affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
24964690c4abSTejun Heo  *
2497affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2498affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2499affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2500affee4b2STejun Heo  * cpu.
2501affee4b2STejun Heo  *
2502affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2503affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2504affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2505affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2506affee4b2STejun Heo  * after a work with LINKED flag set.
2507affee4b2STejun Heo  *
2508affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2509112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
25104690c4abSTejun Heo  *
25114690c4abSTejun Heo  * CONTEXT:
2512d565ed63STejun Heo  * spin_lock_irq(pool->lock).
25134690c4abSTejun Heo  */
2514112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
2515affee4b2STejun Heo 			      struct wq_barrier *barr,
2516affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2517fc2e4d70SOleg Nesterov {
2518affee4b2STejun Heo 	struct list_head *head;
2519affee4b2STejun Heo 	unsigned int linked = 0;
2520affee4b2STejun Heo 
2521dc186ad7SThomas Gleixner 	/*
2522d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
2523dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2524dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2525dc186ad7SThomas Gleixner 	 * might deadlock.
2526dc186ad7SThomas Gleixner 	 */
2527ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
252822df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2529fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
253083c22520SOleg Nesterov 
2531affee4b2STejun Heo 	/*
2532affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2533affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2534affee4b2STejun Heo 	 */
2535affee4b2STejun Heo 	if (worker)
2536affee4b2STejun Heo 		head = worker->scheduled.next;
2537affee4b2STejun Heo 	else {
2538affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2539affee4b2STejun Heo 
2540affee4b2STejun Heo 		head = target->entry.next;
2541affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2542affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2543affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2544affee4b2STejun Heo 	}
2545affee4b2STejun Heo 
2546dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2547112202d9STejun Heo 	insert_work(pwq, &barr->work, head,
2548affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2549fc2e4d70SOleg Nesterov }
2550fc2e4d70SOleg Nesterov 
255173f53c4aSTejun Heo /**
2552112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
255373f53c4aSTejun Heo  * @wq: workqueue being flushed
255473f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
255573f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
255673f53c4aSTejun Heo  *
2557112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
255873f53c4aSTejun Heo  *
2559112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
2560112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
2561112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
2562112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
2563112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
256473f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
256573f53c4aSTejun Heo  *
256673f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
256773f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
256873f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
256973f53c4aSTejun Heo  * is returned.
257073f53c4aSTejun Heo  *
2571112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
257273f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
257373f53c4aSTejun Heo  * advanced to @work_color.
257473f53c4aSTejun Heo  *
257573f53c4aSTejun Heo  * CONTEXT:
25763c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
257773f53c4aSTejun Heo  *
2578d185af30SYacine Belkadi  * Return:
257973f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
258073f53c4aSTejun Heo  * otherwise.
258173f53c4aSTejun Heo  */
2582112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
258373f53c4aSTejun Heo 				      int flush_color, int work_color)
25841da177e4SLinus Torvalds {
258573f53c4aSTejun Heo 	bool wait = false;
258649e3cf44STejun Heo 	struct pool_workqueue *pwq;
25871da177e4SLinus Torvalds 
258873f53c4aSTejun Heo 	if (flush_color >= 0) {
25896183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2590112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
2591dc186ad7SThomas Gleixner 	}
259214441960SOleg Nesterov 
259349e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2594112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
25951da177e4SLinus Torvalds 
2596b09f4fd3SLai Jiangshan 		spin_lock_irq(&pool->lock);
259773f53c4aSTejun Heo 
259873f53c4aSTejun Heo 		if (flush_color >= 0) {
25996183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
260073f53c4aSTejun Heo 
2601112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
2602112202d9STejun Heo 				pwq->flush_color = flush_color;
2603112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
260473f53c4aSTejun Heo 				wait = true;
26051da177e4SLinus Torvalds 			}
260673f53c4aSTejun Heo 		}
260773f53c4aSTejun Heo 
260873f53c4aSTejun Heo 		if (work_color >= 0) {
26096183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2610112202d9STejun Heo 			pwq->work_color = work_color;
261173f53c4aSTejun Heo 		}
261273f53c4aSTejun Heo 
2613b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pool->lock);
26141da177e4SLinus Torvalds 	}
26151da177e4SLinus Torvalds 
2616112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
261773f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
261873f53c4aSTejun Heo 
261973f53c4aSTejun Heo 	return wait;
262083c22520SOleg Nesterov }
26211da177e4SLinus Torvalds 
26220fcb78c2SRolf Eike Beer /**
26231da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
26240fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
26251da177e4SLinus Torvalds  *
2626c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
2627c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
26281da177e4SLinus Torvalds  */
26297ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
26301da177e4SLinus Torvalds {
263173f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
263273f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
263373f53c4aSTejun Heo 		.flush_color = -1,
263473f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
263573f53c4aSTejun Heo 	};
263673f53c4aSTejun Heo 	int next_color;
2637b1f4ec17SOleg Nesterov 
26383295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
26393295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
264073f53c4aSTejun Heo 
26413c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
264273f53c4aSTejun Heo 
264373f53c4aSTejun Heo 	/*
264473f53c4aSTejun Heo 	 * Start-to-wait phase
264573f53c4aSTejun Heo 	 */
264673f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
264773f53c4aSTejun Heo 
264873f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
264973f53c4aSTejun Heo 		/*
265073f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
265173f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
265273f53c4aSTejun Heo 		 * by one.
265373f53c4aSTejun Heo 		 */
26546183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
265573f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
265673f53c4aSTejun Heo 		wq->work_color = next_color;
265773f53c4aSTejun Heo 
265873f53c4aSTejun Heo 		if (!wq->first_flusher) {
265973f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
26606183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
266173f53c4aSTejun Heo 
266273f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
266373f53c4aSTejun Heo 
2664112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
266573f53c4aSTejun Heo 						       wq->work_color)) {
266673f53c4aSTejun Heo 				/* nothing to flush, done */
266773f53c4aSTejun Heo 				wq->flush_color = next_color;
266873f53c4aSTejun Heo 				wq->first_flusher = NULL;
266973f53c4aSTejun Heo 				goto out_unlock;
267073f53c4aSTejun Heo 			}
267173f53c4aSTejun Heo 		} else {
267273f53c4aSTejun Heo 			/* wait in queue */
26736183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
267473f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
2675112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
267673f53c4aSTejun Heo 		}
267773f53c4aSTejun Heo 	} else {
267873f53c4aSTejun Heo 		/*
267973f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
268073f53c4aSTejun Heo 		 * The next flush completion will assign us
268173f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
268273f53c4aSTejun Heo 		 */
268373f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
268473f53c4aSTejun Heo 	}
268573f53c4aSTejun Heo 
26863c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
268773f53c4aSTejun Heo 
268873f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
268973f53c4aSTejun Heo 
269073f53c4aSTejun Heo 	/*
269173f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
269273f53c4aSTejun Heo 	 *
269373f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
269473f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
269573f53c4aSTejun Heo 	 */
269673f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
269773f53c4aSTejun Heo 		return;
269873f53c4aSTejun Heo 
26993c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
270073f53c4aSTejun Heo 
27014ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
27024ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
27034ce48b37STejun Heo 		goto out_unlock;
27044ce48b37STejun Heo 
270573f53c4aSTejun Heo 	wq->first_flusher = NULL;
270673f53c4aSTejun Heo 
27076183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
27086183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
270973f53c4aSTejun Heo 
271073f53c4aSTejun Heo 	while (true) {
271173f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
271273f53c4aSTejun Heo 
271373f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
271473f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
271573f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
271673f53c4aSTejun Heo 				break;
271773f53c4aSTejun Heo 			list_del_init(&next->list);
271873f53c4aSTejun Heo 			complete(&next->done);
271973f53c4aSTejun Heo 		}
272073f53c4aSTejun Heo 
27216183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
272273f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
272373f53c4aSTejun Heo 
272473f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
272573f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
272673f53c4aSTejun Heo 
272773f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
272873f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
272973f53c4aSTejun Heo 			/*
273073f53c4aSTejun Heo 			 * Assign the same color to all overflowed
273173f53c4aSTejun Heo 			 * flushers, advance work_color and append to
273273f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
273373f53c4aSTejun Heo 			 * phase for these overflowed flushers.
273473f53c4aSTejun Heo 			 */
273573f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
273673f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
273773f53c4aSTejun Heo 
273873f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
273973f53c4aSTejun Heo 
274073f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
274173f53c4aSTejun Heo 					      &wq->flusher_queue);
2742112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
274373f53c4aSTejun Heo 		}
274473f53c4aSTejun Heo 
274573f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
27466183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
274773f53c4aSTejun Heo 			break;
274873f53c4aSTejun Heo 		}
274973f53c4aSTejun Heo 
275073f53c4aSTejun Heo 		/*
275173f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
2752112202d9STejun Heo 		 * the new first flusher and arm pwqs.
275373f53c4aSTejun Heo 		 */
27546183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
27556183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
275673f53c4aSTejun Heo 
275773f53c4aSTejun Heo 		list_del_init(&next->list);
275873f53c4aSTejun Heo 		wq->first_flusher = next;
275973f53c4aSTejun Heo 
2760112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
276173f53c4aSTejun Heo 			break;
276273f53c4aSTejun Heo 
276373f53c4aSTejun Heo 		/*
276473f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
276573f53c4aSTejun Heo 		 * flusher and repeat cascading.
276673f53c4aSTejun Heo 		 */
276773f53c4aSTejun Heo 		wq->first_flusher = NULL;
276873f53c4aSTejun Heo 	}
276973f53c4aSTejun Heo 
277073f53c4aSTejun Heo out_unlock:
27713c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
27721da177e4SLinus Torvalds }
2773ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
27741da177e4SLinus Torvalds 
27759c5a2ba7STejun Heo /**
27769c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
27779c5a2ba7STejun Heo  * @wq: workqueue to drain
27789c5a2ba7STejun Heo  *
27799c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
27809c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
27819c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
27829c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
27839c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
27849c5a2ba7STejun Heo  * takes too long.
27859c5a2ba7STejun Heo  */
27869c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
27879c5a2ba7STejun Heo {
27889c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
278949e3cf44STejun Heo 	struct pool_workqueue *pwq;
27909c5a2ba7STejun Heo 
27919c5a2ba7STejun Heo 	/*
27929c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
27939c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
2794618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
27959c5a2ba7STejun Heo 	 */
279687fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
27979c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
2798618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
279987fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
28009c5a2ba7STejun Heo reflush:
28019c5a2ba7STejun Heo 	flush_workqueue(wq);
28029c5a2ba7STejun Heo 
2803b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
280476af4d93STejun Heo 
280549e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2806fa2563e4SThomas Tuttle 		bool drained;
28079c5a2ba7STejun Heo 
2808b09f4fd3SLai Jiangshan 		spin_lock_irq(&pwq->pool->lock);
2809112202d9STejun Heo 		drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2810b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pwq->pool->lock);
2811fa2563e4SThomas Tuttle 
2812fa2563e4SThomas Tuttle 		if (drained)
28139c5a2ba7STejun Heo 			continue;
28149c5a2ba7STejun Heo 
28159c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
28169c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2817c5aa87bbSTejun Heo 			pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
28189c5a2ba7STejun Heo 				wq->name, flush_cnt);
281976af4d93STejun Heo 
2820b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
28219c5a2ba7STejun Heo 		goto reflush;
28229c5a2ba7STejun Heo 	}
28239c5a2ba7STejun Heo 
28249c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
2825618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
282687fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
28279c5a2ba7STejun Heo }
28289c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
28299c5a2ba7STejun Heo 
2830606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2831baf59022STejun Heo {
2832baf59022STejun Heo 	struct worker *worker = NULL;
2833c9e7cf27STejun Heo 	struct worker_pool *pool;
2834112202d9STejun Heo 	struct pool_workqueue *pwq;
2835baf59022STejun Heo 
2836baf59022STejun Heo 	might_sleep();
2837baf59022STejun Heo 
2838fa1b54e6STejun Heo 	local_irq_disable();
2839fa1b54e6STejun Heo 	pool = get_work_pool(work);
2840fa1b54e6STejun Heo 	if (!pool) {
2841fa1b54e6STejun Heo 		local_irq_enable();
2842fa1b54e6STejun Heo 		return false;
2843fa1b54e6STejun Heo 	}
2844fa1b54e6STejun Heo 
2845fa1b54e6STejun Heo 	spin_lock(&pool->lock);
28460b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
2847112202d9STejun Heo 	pwq = get_work_pwq(work);
2848112202d9STejun Heo 	if (pwq) {
2849112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
2850baf59022STejun Heo 			goto already_gone;
2851606a5020STejun Heo 	} else {
2852c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
2853baf59022STejun Heo 		if (!worker)
2854baf59022STejun Heo 			goto already_gone;
2855112202d9STejun Heo 		pwq = worker->current_pwq;
2856606a5020STejun Heo 	}
2857baf59022STejun Heo 
2858112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
2859d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2860baf59022STejun Heo 
2861e159489bSTejun Heo 	/*
2862e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2863e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2864e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2865e159489bSTejun Heo 	 * access.
2866e159489bSTejun Heo 	 */
2867493008a8STejun Heo 	if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
2868112202d9STejun Heo 		lock_map_acquire(&pwq->wq->lockdep_map);
2869e159489bSTejun Heo 	else
2870112202d9STejun Heo 		lock_map_acquire_read(&pwq->wq->lockdep_map);
2871112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
2872e159489bSTejun Heo 
2873baf59022STejun Heo 	return true;
2874baf59022STejun Heo already_gone:
2875d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2876baf59022STejun Heo 	return false;
2877baf59022STejun Heo }
2878baf59022STejun Heo 
2879db700897SOleg Nesterov /**
2880401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2881401a8d04STejun Heo  * @work: the work to flush
2882db700897SOleg Nesterov  *
2883606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2884606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2885401a8d04STejun Heo  *
2886d185af30SYacine Belkadi  * Return:
2887401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2888401a8d04STejun Heo  * %false if it was already idle.
2889db700897SOleg Nesterov  */
2890401a8d04STejun Heo bool flush_work(struct work_struct *work)
2891db700897SOleg Nesterov {
289212997d1aSBjorn Helgaas 	struct wq_barrier barr;
289312997d1aSBjorn Helgaas 
28940976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
28950976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
28960976dfc1SStephen Boyd 
289712997d1aSBjorn Helgaas 	if (start_flush_work(work, &barr)) {
289812997d1aSBjorn Helgaas 		wait_for_completion(&barr.done);
289912997d1aSBjorn Helgaas 		destroy_work_on_stack(&barr.work);
290012997d1aSBjorn Helgaas 		return true;
290112997d1aSBjorn Helgaas 	} else {
290212997d1aSBjorn Helgaas 		return false;
290312997d1aSBjorn Helgaas 	}
2904606a5020STejun Heo }
2905db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2906db700897SOleg Nesterov 
290736e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2908401a8d04STejun Heo {
2909bbb68dfaSTejun Heo 	unsigned long flags;
29101f1f642eSOleg Nesterov 	int ret;
29111f1f642eSOleg Nesterov 
29121f1f642eSOleg Nesterov 	do {
2913bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2914bbb68dfaSTejun Heo 		/*
2915bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2916bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2917bbb68dfaSTejun Heo 		 */
2918bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2919606a5020STejun Heo 			flush_work(work);
29201f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
29211f1f642eSOleg Nesterov 
2922bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2923bbb68dfaSTejun Heo 	mark_work_canceling(work);
2924bbb68dfaSTejun Heo 	local_irq_restore(flags);
2925bbb68dfaSTejun Heo 
2926606a5020STejun Heo 	flush_work(work);
29277a22ad75STejun Heo 	clear_work_data(work);
29281f1f642eSOleg Nesterov 	return ret;
29291f1f642eSOleg Nesterov }
29301f1f642eSOleg Nesterov 
29316e84d644SOleg Nesterov /**
2932401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2933401a8d04STejun Heo  * @work: the work to cancel
29346e84d644SOleg Nesterov  *
2935401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2936401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2937401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2938401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
29391f1f642eSOleg Nesterov  *
2940401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2941401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
29426e84d644SOleg Nesterov  *
2943401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
29446e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2945401a8d04STejun Heo  *
2946d185af30SYacine Belkadi  * Return:
2947401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
29486e84d644SOleg Nesterov  */
2949401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
29506e84d644SOleg Nesterov {
295136e227d2STejun Heo 	return __cancel_work_timer(work, false);
2952b89deed3SOleg Nesterov }
295328e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2954b89deed3SOleg Nesterov 
29556e84d644SOleg Nesterov /**
2956401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2957401a8d04STejun Heo  * @dwork: the delayed work to flush
29586e84d644SOleg Nesterov  *
2959401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2960401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2961401a8d04STejun Heo  * considers the last queueing instance of @dwork.
29621f1f642eSOleg Nesterov  *
2963d185af30SYacine Belkadi  * Return:
2964401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2965401a8d04STejun Heo  * %false if it was already idle.
29666e84d644SOleg Nesterov  */
2967401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2968401a8d04STejun Heo {
29698930cabaSTejun Heo 	local_irq_disable();
2970401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
297160c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
29728930cabaSTejun Heo 	local_irq_enable();
2973401a8d04STejun Heo 	return flush_work(&dwork->work);
2974401a8d04STejun Heo }
2975401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2976401a8d04STejun Heo 
2977401a8d04STejun Heo /**
297857b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
297957b30ae7STejun Heo  * @dwork: delayed_work to cancel
298009383498STejun Heo  *
2981d185af30SYacine Belkadi  * Kill off a pending delayed_work.
2982d185af30SYacine Belkadi  *
2983d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
2984d185af30SYacine Belkadi  * pending.
2985d185af30SYacine Belkadi  *
2986d185af30SYacine Belkadi  * Note:
2987d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
2988d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
2989d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
299009383498STejun Heo  *
299157b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
299209383498STejun Heo  */
299357b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
299409383498STejun Heo {
299557b30ae7STejun Heo 	unsigned long flags;
299657b30ae7STejun Heo 	int ret;
299757b30ae7STejun Heo 
299857b30ae7STejun Heo 	do {
299957b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
300057b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
300157b30ae7STejun Heo 
300257b30ae7STejun Heo 	if (unlikely(ret < 0))
300357b30ae7STejun Heo 		return false;
300457b30ae7STejun Heo 
30057c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(&dwork->work,
30067c3eed5cSTejun Heo 					get_work_pool_id(&dwork->work));
300757b30ae7STejun Heo 	local_irq_restore(flags);
3008c0158ca6SDan Magenheimer 	return ret;
300909383498STejun Heo }
301057b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
301109383498STejun Heo 
301209383498STejun Heo /**
3013401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3014401a8d04STejun Heo  * @dwork: the delayed work cancel
3015401a8d04STejun Heo  *
3016401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
3017401a8d04STejun Heo  *
3018d185af30SYacine Belkadi  * Return:
3019401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
3020401a8d04STejun Heo  */
3021401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
30226e84d644SOleg Nesterov {
302336e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
30246e84d644SOleg Nesterov }
3025f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
30261da177e4SLinus Torvalds 
30270fcb78c2SRolf Eike Beer /**
302831ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3029b6136773SAndrew Morton  * @func: the function to call
3030b6136773SAndrew Morton  *
303131ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
303231ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3033b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
303431ddd871STejun Heo  *
3035d185af30SYacine Belkadi  * Return:
303631ddd871STejun Heo  * 0 on success, -errno on failure.
3037b6136773SAndrew Morton  */
303865f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
303915316ba8SChristoph Lameter {
304015316ba8SChristoph Lameter 	int cpu;
304138f51568SNamhyung Kim 	struct work_struct __percpu *works;
304215316ba8SChristoph Lameter 
3043b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3044b6136773SAndrew Morton 	if (!works)
304515316ba8SChristoph Lameter 		return -ENOMEM;
3046b6136773SAndrew Morton 
304795402b38SGautham R Shenoy 	get_online_cpus();
304893981800STejun Heo 
304915316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
30509bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
30519bfb1839SIngo Molnar 
30529bfb1839SIngo Molnar 		INIT_WORK(work, func);
30538de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
305415316ba8SChristoph Lameter 	}
305593981800STejun Heo 
305693981800STejun Heo 	for_each_online_cpu(cpu)
30578616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
305893981800STejun Heo 
305995402b38SGautham R Shenoy 	put_online_cpus();
3060b6136773SAndrew Morton 	free_percpu(works);
306115316ba8SChristoph Lameter 	return 0;
306215316ba8SChristoph Lameter }
306315316ba8SChristoph Lameter 
3064eef6a7d5SAlan Stern /**
3065eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
3066eef6a7d5SAlan Stern  *
3067eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
3068eef6a7d5SAlan Stern  * completion.
3069eef6a7d5SAlan Stern  *
3070eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
3071eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
3072eef6a7d5SAlan Stern  * will lead to deadlock:
3073eef6a7d5SAlan Stern  *
3074eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
3075eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
3076eef6a7d5SAlan Stern  *
3077eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
3078eef6a7d5SAlan Stern  *
3079eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
3080eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
3081eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
3082eef6a7d5SAlan Stern  *
3083eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
3084eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
3085eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
3086eef6a7d5SAlan Stern  * cancel_work_sync() instead.
3087eef6a7d5SAlan Stern  */
30881da177e4SLinus Torvalds void flush_scheduled_work(void)
30891da177e4SLinus Torvalds {
3090d320c038STejun Heo 	flush_workqueue(system_wq);
30911da177e4SLinus Torvalds }
3092ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
30931da177e4SLinus Torvalds 
30941da177e4SLinus Torvalds /**
30951fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
30961fa44ecaSJames Bottomley  * @fn:		the function to execute
30971fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
30981fa44ecaSJames Bottomley  *		be available when the work executes)
30991fa44ecaSJames Bottomley  *
31001fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
31011fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
31021fa44ecaSJames Bottomley  *
3103d185af30SYacine Belkadi  * Return:	0 - function was executed
31041fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
31051fa44ecaSJames Bottomley  */
310665f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
31071fa44ecaSJames Bottomley {
31081fa44ecaSJames Bottomley 	if (!in_interrupt()) {
310965f27f38SDavid Howells 		fn(&ew->work);
31101fa44ecaSJames Bottomley 		return 0;
31111fa44ecaSJames Bottomley 	}
31121fa44ecaSJames Bottomley 
311365f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
31141fa44ecaSJames Bottomley 	schedule_work(&ew->work);
31151fa44ecaSJames Bottomley 
31161fa44ecaSJames Bottomley 	return 1;
31171fa44ecaSJames Bottomley }
31181fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
31191fa44ecaSJames Bottomley 
3120226223abSTejun Heo #ifdef CONFIG_SYSFS
3121226223abSTejun Heo /*
3122226223abSTejun Heo  * Workqueues with WQ_SYSFS flag set is visible to userland via
3123226223abSTejun Heo  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
3124226223abSTejun Heo  * following attributes.
3125226223abSTejun Heo  *
3126226223abSTejun Heo  *  per_cpu	RO bool	: whether the workqueue is per-cpu or unbound
3127226223abSTejun Heo  *  max_active	RW int	: maximum number of in-flight work items
3128226223abSTejun Heo  *
3129226223abSTejun Heo  * Unbound workqueues have the following extra attributes.
3130226223abSTejun Heo  *
3131226223abSTejun Heo  *  id		RO int	: the associated pool ID
3132226223abSTejun Heo  *  nice	RW int	: nice value of the workers
3133226223abSTejun Heo  *  cpumask	RW mask	: bitmask of allowed CPUs for the workers
3134226223abSTejun Heo  */
3135226223abSTejun Heo struct wq_device {
3136226223abSTejun Heo 	struct workqueue_struct		*wq;
3137226223abSTejun Heo 	struct device			dev;
3138226223abSTejun Heo };
3139226223abSTejun Heo 
3140226223abSTejun Heo static struct workqueue_struct *dev_to_wq(struct device *dev)
3141226223abSTejun Heo {
3142226223abSTejun Heo 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3143226223abSTejun Heo 
3144226223abSTejun Heo 	return wq_dev->wq;
3145226223abSTejun Heo }
3146226223abSTejun Heo 
31471a6661daSGreg Kroah-Hartman static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
31481a6661daSGreg Kroah-Hartman 			    char *buf)
3149226223abSTejun Heo {
3150226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3151226223abSTejun Heo 
3152226223abSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
3153226223abSTejun Heo }
31541a6661daSGreg Kroah-Hartman static DEVICE_ATTR_RO(per_cpu);
3155226223abSTejun Heo 
31561a6661daSGreg Kroah-Hartman static ssize_t max_active_show(struct device *dev,
3157226223abSTejun Heo 			       struct device_attribute *attr, char *buf)
3158226223abSTejun Heo {
3159226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3160226223abSTejun Heo 
3161226223abSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
3162226223abSTejun Heo }
3163226223abSTejun Heo 
31641a6661daSGreg Kroah-Hartman static ssize_t max_active_store(struct device *dev,
31651a6661daSGreg Kroah-Hartman 				struct device_attribute *attr, const char *buf,
31661a6661daSGreg Kroah-Hartman 				size_t count)
3167226223abSTejun Heo {
3168226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3169226223abSTejun Heo 	int val;
3170226223abSTejun Heo 
3171226223abSTejun Heo 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
3172226223abSTejun Heo 		return -EINVAL;
3173226223abSTejun Heo 
3174226223abSTejun Heo 	workqueue_set_max_active(wq, val);
3175226223abSTejun Heo 	return count;
3176226223abSTejun Heo }
31771a6661daSGreg Kroah-Hartman static DEVICE_ATTR_RW(max_active);
3178226223abSTejun Heo 
31791a6661daSGreg Kroah-Hartman static struct attribute *wq_sysfs_attrs[] = {
31801a6661daSGreg Kroah-Hartman 	&dev_attr_per_cpu.attr,
31811a6661daSGreg Kroah-Hartman 	&dev_attr_max_active.attr,
31821a6661daSGreg Kroah-Hartman 	NULL,
3183226223abSTejun Heo };
31841a6661daSGreg Kroah-Hartman ATTRIBUTE_GROUPS(wq_sysfs);
3185226223abSTejun Heo 
3186d55262c4STejun Heo static ssize_t wq_pool_ids_show(struct device *dev,
3187226223abSTejun Heo 				struct device_attribute *attr, char *buf)
3188226223abSTejun Heo {
3189226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3190d55262c4STejun Heo 	const char *delim = "";
3191d55262c4STejun Heo 	int node, written = 0;
3192226223abSTejun Heo 
3193226223abSTejun Heo 	rcu_read_lock_sched();
3194d55262c4STejun Heo 	for_each_node(node) {
3195d55262c4STejun Heo 		written += scnprintf(buf + written, PAGE_SIZE - written,
3196d55262c4STejun Heo 				     "%s%d:%d", delim, node,
3197d55262c4STejun Heo 				     unbound_pwq_by_node(wq, node)->pool->id);
3198d55262c4STejun Heo 		delim = " ";
3199d55262c4STejun Heo 	}
3200d55262c4STejun Heo 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3201226223abSTejun Heo 	rcu_read_unlock_sched();
3202226223abSTejun Heo 
3203226223abSTejun Heo 	return written;
3204226223abSTejun Heo }
3205226223abSTejun Heo 
3206226223abSTejun Heo static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3207226223abSTejun Heo 			    char *buf)
3208226223abSTejun Heo {
3209226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3210226223abSTejun Heo 	int written;
3211226223abSTejun Heo 
32126029a918STejun Heo 	mutex_lock(&wq->mutex);
32136029a918STejun Heo 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
32146029a918STejun Heo 	mutex_unlock(&wq->mutex);
3215226223abSTejun Heo 
3216226223abSTejun Heo 	return written;
3217226223abSTejun Heo }
3218226223abSTejun Heo 
3219226223abSTejun Heo /* prepare workqueue_attrs for sysfs store operations */
3220226223abSTejun Heo static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3221226223abSTejun Heo {
3222226223abSTejun Heo 	struct workqueue_attrs *attrs;
3223226223abSTejun Heo 
3224226223abSTejun Heo 	attrs = alloc_workqueue_attrs(GFP_KERNEL);
3225226223abSTejun Heo 	if (!attrs)
3226226223abSTejun Heo 		return NULL;
3227226223abSTejun Heo 
32286029a918STejun Heo 	mutex_lock(&wq->mutex);
32296029a918STejun Heo 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
32306029a918STejun Heo 	mutex_unlock(&wq->mutex);
3231226223abSTejun Heo 	return attrs;
3232226223abSTejun Heo }
3233226223abSTejun Heo 
3234226223abSTejun Heo static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3235226223abSTejun Heo 			     const char *buf, size_t count)
3236226223abSTejun Heo {
3237226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3238226223abSTejun Heo 	struct workqueue_attrs *attrs;
3239226223abSTejun Heo 	int ret;
3240226223abSTejun Heo 
3241226223abSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
3242226223abSTejun Heo 	if (!attrs)
3243226223abSTejun Heo 		return -ENOMEM;
3244226223abSTejun Heo 
3245226223abSTejun Heo 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
324614481842SDongsheng Yang 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
3247226223abSTejun Heo 		ret = apply_workqueue_attrs(wq, attrs);
3248226223abSTejun Heo 	else
3249226223abSTejun Heo 		ret = -EINVAL;
3250226223abSTejun Heo 
3251226223abSTejun Heo 	free_workqueue_attrs(attrs);
3252226223abSTejun Heo 	return ret ?: count;
3253226223abSTejun Heo }
3254226223abSTejun Heo 
3255226223abSTejun Heo static ssize_t wq_cpumask_show(struct device *dev,
3256226223abSTejun Heo 			       struct device_attribute *attr, char *buf)
3257226223abSTejun Heo {
3258226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3259226223abSTejun Heo 	int written;
3260226223abSTejun Heo 
32616029a918STejun Heo 	mutex_lock(&wq->mutex);
32626029a918STejun Heo 	written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
32636029a918STejun Heo 	mutex_unlock(&wq->mutex);
3264226223abSTejun Heo 
3265226223abSTejun Heo 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3266226223abSTejun Heo 	return written;
3267226223abSTejun Heo }
3268226223abSTejun Heo 
3269226223abSTejun Heo static ssize_t wq_cpumask_store(struct device *dev,
3270226223abSTejun Heo 				struct device_attribute *attr,
3271226223abSTejun Heo 				const char *buf, size_t count)
3272226223abSTejun Heo {
3273226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3274226223abSTejun Heo 	struct workqueue_attrs *attrs;
3275226223abSTejun Heo 	int ret;
3276226223abSTejun Heo 
3277226223abSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
3278226223abSTejun Heo 	if (!attrs)
3279226223abSTejun Heo 		return -ENOMEM;
3280226223abSTejun Heo 
3281226223abSTejun Heo 	ret = cpumask_parse(buf, attrs->cpumask);
3282226223abSTejun Heo 	if (!ret)
3283226223abSTejun Heo 		ret = apply_workqueue_attrs(wq, attrs);
3284226223abSTejun Heo 
3285226223abSTejun Heo 	free_workqueue_attrs(attrs);
3286226223abSTejun Heo 	return ret ?: count;
3287226223abSTejun Heo }
3288226223abSTejun Heo 
3289d55262c4STejun Heo static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
3290d55262c4STejun Heo 			    char *buf)
3291d55262c4STejun Heo {
3292d55262c4STejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3293d55262c4STejun Heo 	int written;
3294d55262c4STejun Heo 
3295d55262c4STejun Heo 	mutex_lock(&wq->mutex);
3296d55262c4STejun Heo 	written = scnprintf(buf, PAGE_SIZE, "%d\n",
3297d55262c4STejun Heo 			    !wq->unbound_attrs->no_numa);
3298d55262c4STejun Heo 	mutex_unlock(&wq->mutex);
3299d55262c4STejun Heo 
3300d55262c4STejun Heo 	return written;
3301d55262c4STejun Heo }
3302d55262c4STejun Heo 
3303d55262c4STejun Heo static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
3304d55262c4STejun Heo 			     const char *buf, size_t count)
3305d55262c4STejun Heo {
3306d55262c4STejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3307d55262c4STejun Heo 	struct workqueue_attrs *attrs;
3308d55262c4STejun Heo 	int v, ret;
3309d55262c4STejun Heo 
3310d55262c4STejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
3311d55262c4STejun Heo 	if (!attrs)
3312d55262c4STejun Heo 		return -ENOMEM;
3313d55262c4STejun Heo 
3314d55262c4STejun Heo 	ret = -EINVAL;
3315d55262c4STejun Heo 	if (sscanf(buf, "%d", &v) == 1) {
3316d55262c4STejun Heo 		attrs->no_numa = !v;
3317d55262c4STejun Heo 		ret = apply_workqueue_attrs(wq, attrs);
3318d55262c4STejun Heo 	}
3319d55262c4STejun Heo 
3320d55262c4STejun Heo 	free_workqueue_attrs(attrs);
3321d55262c4STejun Heo 	return ret ?: count;
3322d55262c4STejun Heo }
3323d55262c4STejun Heo 
3324226223abSTejun Heo static struct device_attribute wq_sysfs_unbound_attrs[] = {
3325d55262c4STejun Heo 	__ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
3326226223abSTejun Heo 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3327226223abSTejun Heo 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
3328d55262c4STejun Heo 	__ATTR(numa, 0644, wq_numa_show, wq_numa_store),
3329226223abSTejun Heo 	__ATTR_NULL,
3330226223abSTejun Heo };
3331226223abSTejun Heo 
3332226223abSTejun Heo static struct bus_type wq_subsys = {
3333226223abSTejun Heo 	.name				= "workqueue",
33341a6661daSGreg Kroah-Hartman 	.dev_groups			= wq_sysfs_groups,
3335226223abSTejun Heo };
3336226223abSTejun Heo 
3337226223abSTejun Heo static int __init wq_sysfs_init(void)
3338226223abSTejun Heo {
3339226223abSTejun Heo 	return subsys_virtual_register(&wq_subsys, NULL);
3340226223abSTejun Heo }
3341226223abSTejun Heo core_initcall(wq_sysfs_init);
3342226223abSTejun Heo 
3343226223abSTejun Heo static void wq_device_release(struct device *dev)
3344226223abSTejun Heo {
3345226223abSTejun Heo 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3346226223abSTejun Heo 
3347226223abSTejun Heo 	kfree(wq_dev);
3348226223abSTejun Heo }
3349226223abSTejun Heo 
3350226223abSTejun Heo /**
3351226223abSTejun Heo  * workqueue_sysfs_register - make a workqueue visible in sysfs
3352226223abSTejun Heo  * @wq: the workqueue to register
3353226223abSTejun Heo  *
3354226223abSTejun Heo  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3355226223abSTejun Heo  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3356226223abSTejun Heo  * which is the preferred method.
3357226223abSTejun Heo  *
3358226223abSTejun Heo  * Workqueue user should use this function directly iff it wants to apply
3359226223abSTejun Heo  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3360226223abSTejun Heo  * apply_workqueue_attrs() may race against userland updating the
3361226223abSTejun Heo  * attributes.
3362226223abSTejun Heo  *
3363d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.
3364226223abSTejun Heo  */
3365226223abSTejun Heo int workqueue_sysfs_register(struct workqueue_struct *wq)
3366226223abSTejun Heo {
3367226223abSTejun Heo 	struct wq_device *wq_dev;
3368226223abSTejun Heo 	int ret;
3369226223abSTejun Heo 
3370226223abSTejun Heo 	/*
3371226223abSTejun Heo 	 * Adjusting max_active or creating new pwqs by applyting
3372226223abSTejun Heo 	 * attributes breaks ordering guarantee.  Disallow exposing ordered
3373226223abSTejun Heo 	 * workqueues.
3374226223abSTejun Heo 	 */
3375226223abSTejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
3376226223abSTejun Heo 		return -EINVAL;
3377226223abSTejun Heo 
3378226223abSTejun Heo 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3379226223abSTejun Heo 	if (!wq_dev)
3380226223abSTejun Heo 		return -ENOMEM;
3381226223abSTejun Heo 
3382226223abSTejun Heo 	wq_dev->wq = wq;
3383226223abSTejun Heo 	wq_dev->dev.bus = &wq_subsys;
3384226223abSTejun Heo 	wq_dev->dev.init_name = wq->name;
3385226223abSTejun Heo 	wq_dev->dev.release = wq_device_release;
3386226223abSTejun Heo 
3387226223abSTejun Heo 	/*
3388226223abSTejun Heo 	 * unbound_attrs are created separately.  Suppress uevent until
3389226223abSTejun Heo 	 * everything is ready.
3390226223abSTejun Heo 	 */
3391226223abSTejun Heo 	dev_set_uevent_suppress(&wq_dev->dev, true);
3392226223abSTejun Heo 
3393226223abSTejun Heo 	ret = device_register(&wq_dev->dev);
3394226223abSTejun Heo 	if (ret) {
3395226223abSTejun Heo 		kfree(wq_dev);
3396226223abSTejun Heo 		wq->wq_dev = NULL;
3397226223abSTejun Heo 		return ret;
3398226223abSTejun Heo 	}
3399226223abSTejun Heo 
3400226223abSTejun Heo 	if (wq->flags & WQ_UNBOUND) {
3401226223abSTejun Heo 		struct device_attribute *attr;
3402226223abSTejun Heo 
3403226223abSTejun Heo 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3404226223abSTejun Heo 			ret = device_create_file(&wq_dev->dev, attr);
3405226223abSTejun Heo 			if (ret) {
3406226223abSTejun Heo 				device_unregister(&wq_dev->dev);
3407226223abSTejun Heo 				wq->wq_dev = NULL;
3408226223abSTejun Heo 				return ret;
3409226223abSTejun Heo 			}
3410226223abSTejun Heo 		}
3411226223abSTejun Heo 	}
3412226223abSTejun Heo 
3413226223abSTejun Heo 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3414226223abSTejun Heo 	return 0;
3415226223abSTejun Heo }
3416226223abSTejun Heo 
3417226223abSTejun Heo /**
3418226223abSTejun Heo  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3419226223abSTejun Heo  * @wq: the workqueue to unregister
3420226223abSTejun Heo  *
3421226223abSTejun Heo  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3422226223abSTejun Heo  */
3423226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3424226223abSTejun Heo {
3425226223abSTejun Heo 	struct wq_device *wq_dev = wq->wq_dev;
3426226223abSTejun Heo 
3427226223abSTejun Heo 	if (!wq->wq_dev)
3428226223abSTejun Heo 		return;
3429226223abSTejun Heo 
3430226223abSTejun Heo 	wq->wq_dev = NULL;
3431226223abSTejun Heo 	device_unregister(&wq_dev->dev);
3432226223abSTejun Heo }
3433226223abSTejun Heo #else	/* CONFIG_SYSFS */
3434226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
3435226223abSTejun Heo #endif	/* CONFIG_SYSFS */
3436226223abSTejun Heo 
34377a4e344cSTejun Heo /**
34387a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
34397a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
34407a4e344cSTejun Heo  *
34417a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
34427a4e344cSTejun Heo  */
34437a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs)
34447a4e344cSTejun Heo {
34457a4e344cSTejun Heo 	if (attrs) {
34467a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
34477a4e344cSTejun Heo 		kfree(attrs);
34487a4e344cSTejun Heo 	}
34497a4e344cSTejun Heo }
34507a4e344cSTejun Heo 
34517a4e344cSTejun Heo /**
34527a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
34537a4e344cSTejun Heo  * @gfp_mask: allocation mask to use
34547a4e344cSTejun Heo  *
34557a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
3456d185af30SYacine Belkadi  * return it.
3457d185af30SYacine Belkadi  *
3458d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
34597a4e344cSTejun Heo  */
34607a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
34617a4e344cSTejun Heo {
34627a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
34637a4e344cSTejun Heo 
34647a4e344cSTejun Heo 	attrs = kzalloc(sizeof(*attrs), gfp_mask);
34657a4e344cSTejun Heo 	if (!attrs)
34667a4e344cSTejun Heo 		goto fail;
34677a4e344cSTejun Heo 	if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
34687a4e344cSTejun Heo 		goto fail;
34697a4e344cSTejun Heo 
347013e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
34717a4e344cSTejun Heo 	return attrs;
34727a4e344cSTejun Heo fail:
34737a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
34747a4e344cSTejun Heo 	return NULL;
34757a4e344cSTejun Heo }
34767a4e344cSTejun Heo 
347729c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
347829c91e99STejun Heo 				 const struct workqueue_attrs *from)
347929c91e99STejun Heo {
348029c91e99STejun Heo 	to->nice = from->nice;
348129c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
34822865a8fbSShaohua Li 	/*
34832865a8fbSShaohua Li 	 * Unlike hash and equality test, this function doesn't ignore
34842865a8fbSShaohua Li 	 * ->no_numa as it is used for both pool and wq attrs.  Instead,
34852865a8fbSShaohua Li 	 * get_unbound_pool() explicitly clears ->no_numa after copying.
34862865a8fbSShaohua Li 	 */
34872865a8fbSShaohua Li 	to->no_numa = from->no_numa;
348829c91e99STejun Heo }
348929c91e99STejun Heo 
349029c91e99STejun Heo /* hash value of the content of @attr */
349129c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
349229c91e99STejun Heo {
349329c91e99STejun Heo 	u32 hash = 0;
349429c91e99STejun Heo 
349529c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
349613e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
349713e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
349829c91e99STejun Heo 	return hash;
349929c91e99STejun Heo }
350029c91e99STejun Heo 
350129c91e99STejun Heo /* content equality test */
350229c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
350329c91e99STejun Heo 			  const struct workqueue_attrs *b)
350429c91e99STejun Heo {
350529c91e99STejun Heo 	if (a->nice != b->nice)
350629c91e99STejun Heo 		return false;
350729c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
350829c91e99STejun Heo 		return false;
350929c91e99STejun Heo 	return true;
351029c91e99STejun Heo }
351129c91e99STejun Heo 
35127a4e344cSTejun Heo /**
35137a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
35147a4e344cSTejun Heo  * @pool: worker_pool to initialize
35157a4e344cSTejun Heo  *
35167a4e344cSTejun Heo  * Initiailize a newly zalloc'd @pool.  It also allocates @pool->attrs.
3517d185af30SYacine Belkadi  *
3518d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
351929c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
352029c91e99STejun Heo  * on @pool safely to release it.
35217a4e344cSTejun Heo  */
35227a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
35234e1a1f9aSTejun Heo {
35244e1a1f9aSTejun Heo 	spin_lock_init(&pool->lock);
352529c91e99STejun Heo 	pool->id = -1;
352629c91e99STejun Heo 	pool->cpu = -1;
3527f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
35284e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
35294e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
35304e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
35314e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
35324e1a1f9aSTejun Heo 
35334e1a1f9aSTejun Heo 	init_timer_deferrable(&pool->idle_timer);
35344e1a1f9aSTejun Heo 	pool->idle_timer.function = idle_worker_timeout;
35354e1a1f9aSTejun Heo 	pool->idle_timer.data = (unsigned long)pool;
35364e1a1f9aSTejun Heo 
35374e1a1f9aSTejun Heo 	setup_timer(&pool->mayday_timer, pool_mayday_timeout,
35384e1a1f9aSTejun Heo 		    (unsigned long)pool);
35394e1a1f9aSTejun Heo 
35404e1a1f9aSTejun Heo 	mutex_init(&pool->manager_arb);
3541bc3a1afcSTejun Heo 	mutex_init(&pool->manager_mutex);
3542822d8405STejun Heo 	idr_init(&pool->worker_idr);
35437a4e344cSTejun Heo 
354429c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
354529c91e99STejun Heo 	pool->refcnt = 1;
354629c91e99STejun Heo 
354729c91e99STejun Heo 	/* shouldn't fail above this point */
35487a4e344cSTejun Heo 	pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
35497a4e344cSTejun Heo 	if (!pool->attrs)
35507a4e344cSTejun Heo 		return -ENOMEM;
35517a4e344cSTejun Heo 	return 0;
35524e1a1f9aSTejun Heo }
35534e1a1f9aSTejun Heo 
355429c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
355529c91e99STejun Heo {
355629c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
355729c91e99STejun Heo 
3558822d8405STejun Heo 	idr_destroy(&pool->worker_idr);
355929c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
356029c91e99STejun Heo 	kfree(pool);
356129c91e99STejun Heo }
356229c91e99STejun Heo 
356329c91e99STejun Heo /**
356429c91e99STejun Heo  * put_unbound_pool - put a worker_pool
356529c91e99STejun Heo  * @pool: worker_pool to put
356629c91e99STejun Heo  *
356729c91e99STejun Heo  * Put @pool.  If its refcnt reaches zero, it gets destroyed in sched-RCU
3568c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
3569c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
3570c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
3571a892caccSTejun Heo  *
3572a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
357329c91e99STejun Heo  */
357429c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
357529c91e99STejun Heo {
3576*60f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
357729c91e99STejun Heo 	struct worker *worker;
357829c91e99STejun Heo 
3579a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3580a892caccSTejun Heo 
3581a892caccSTejun Heo 	if (--pool->refcnt)
358229c91e99STejun Heo 		return;
358329c91e99STejun Heo 
358429c91e99STejun Heo 	/* sanity checks */
358529c91e99STejun Heo 	if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
3586a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
358729c91e99STejun Heo 		return;
358829c91e99STejun Heo 
358929c91e99STejun Heo 	/* release id and unhash */
359029c91e99STejun Heo 	if (pool->id >= 0)
359129c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
359229c91e99STejun Heo 	hash_del(&pool->hash_node);
359329c91e99STejun Heo 
3594c5aa87bbSTejun Heo 	/*
3595c5aa87bbSTejun Heo 	 * Become the manager and destroy all workers.  Grabbing
3596c5aa87bbSTejun Heo 	 * manager_arb prevents @pool's workers from blocking on
3597c5aa87bbSTejun Heo 	 * manager_mutex.
3598c5aa87bbSTejun Heo 	 */
359929c91e99STejun Heo 	mutex_lock(&pool->manager_arb);
360029c91e99STejun Heo 
3601*60f5a4bcSLai Jiangshan 	spin_lock_irq(&pool->lock);
360229c91e99STejun Heo 	while ((worker = first_worker(pool)))
360329c91e99STejun Heo 		destroy_worker(worker);
360429c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
360529c91e99STejun Heo 	spin_unlock_irq(&pool->lock);
3606*60f5a4bcSLai Jiangshan 
3607*60f5a4bcSLai Jiangshan 	mutex_lock(&pool->manager_mutex);
3608*60f5a4bcSLai Jiangshan 	if (!idr_is_empty(&pool->worker_idr))
3609*60f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
3610cd549687STejun Heo 	mutex_unlock(&pool->manager_mutex);
3611*60f5a4bcSLai Jiangshan 
3612*60f5a4bcSLai Jiangshan 	if (pool->detach_completion)
3613*60f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
3614*60f5a4bcSLai Jiangshan 
361529c91e99STejun Heo 	mutex_unlock(&pool->manager_arb);
361629c91e99STejun Heo 
361729c91e99STejun Heo 	/* shut down the timers */
361829c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
361929c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
362029c91e99STejun Heo 
362129c91e99STejun Heo 	/* sched-RCU protected to allow dereferences from get_work_pool() */
362229c91e99STejun Heo 	call_rcu_sched(&pool->rcu, rcu_free_pool);
362329c91e99STejun Heo }
362429c91e99STejun Heo 
362529c91e99STejun Heo /**
362629c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
362729c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
362829c91e99STejun Heo  *
362929c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
363029c91e99STejun Heo  * reference count and return it.  If there already is a matching
363129c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
3632d185af30SYacine Belkadi  * create a new one.
3633a892caccSTejun Heo  *
3634a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
3635d185af30SYacine Belkadi  *
3636d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
3637d185af30SYacine Belkadi  * On failure, %NULL.
363829c91e99STejun Heo  */
363929c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
364029c91e99STejun Heo {
364129c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
364229c91e99STejun Heo 	struct worker_pool *pool;
3643f3f90ad4STejun Heo 	int node;
364429c91e99STejun Heo 
3645a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
364629c91e99STejun Heo 
364729c91e99STejun Heo 	/* do we already have a matching pool? */
364829c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
364929c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
365029c91e99STejun Heo 			pool->refcnt++;
365129c91e99STejun Heo 			goto out_unlock;
365229c91e99STejun Heo 		}
365329c91e99STejun Heo 	}
365429c91e99STejun Heo 
365529c91e99STejun Heo 	/* nope, create a new one */
365629c91e99STejun Heo 	pool = kzalloc(sizeof(*pool), GFP_KERNEL);
365729c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
365829c91e99STejun Heo 		goto fail;
365929c91e99STejun Heo 
366012ee4fc6SLai Jiangshan 	if (workqueue_freezing)
366112ee4fc6SLai Jiangshan 		pool->flags |= POOL_FREEZING;
366212ee4fc6SLai Jiangshan 
36638864b4e5STejun Heo 	lockdep_set_subclass(&pool->lock, 1);	/* see put_pwq() */
366429c91e99STejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
366529c91e99STejun Heo 
36662865a8fbSShaohua Li 	/*
36672865a8fbSShaohua Li 	 * no_numa isn't a worker_pool attribute, always clear it.  See
36682865a8fbSShaohua Li 	 * 'struct workqueue_attrs' comments for detail.
36692865a8fbSShaohua Li 	 */
36702865a8fbSShaohua Li 	pool->attrs->no_numa = false;
36712865a8fbSShaohua Li 
3672f3f90ad4STejun Heo 	/* if cpumask is contained inside a NUMA node, we belong to that node */
3673f3f90ad4STejun Heo 	if (wq_numa_enabled) {
3674f3f90ad4STejun Heo 		for_each_node(node) {
3675f3f90ad4STejun Heo 			if (cpumask_subset(pool->attrs->cpumask,
3676f3f90ad4STejun Heo 					   wq_numa_possible_cpumask[node])) {
3677f3f90ad4STejun Heo 				pool->node = node;
3678f3f90ad4STejun Heo 				break;
3679f3f90ad4STejun Heo 			}
3680f3f90ad4STejun Heo 		}
3681f3f90ad4STejun Heo 	}
3682f3f90ad4STejun Heo 
368329c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
368429c91e99STejun Heo 		goto fail;
368529c91e99STejun Heo 
368629c91e99STejun Heo 	/* create and start the initial worker */
3687ebf44d16STejun Heo 	if (create_and_start_worker(pool) < 0)
368829c91e99STejun Heo 		goto fail;
368929c91e99STejun Heo 
369029c91e99STejun Heo 	/* install */
369129c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
369229c91e99STejun Heo out_unlock:
369329c91e99STejun Heo 	return pool;
369429c91e99STejun Heo fail:
369529c91e99STejun Heo 	if (pool)
369629c91e99STejun Heo 		put_unbound_pool(pool);
369729c91e99STejun Heo 	return NULL;
369829c91e99STejun Heo }
369929c91e99STejun Heo 
37008864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
37018864b4e5STejun Heo {
37028864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
37038864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
37048864b4e5STejun Heo }
37058864b4e5STejun Heo 
37068864b4e5STejun Heo /*
37078864b4e5STejun Heo  * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
37088864b4e5STejun Heo  * and needs to be destroyed.
37098864b4e5STejun Heo  */
37108864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work)
37118864b4e5STejun Heo {
37128864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
37138864b4e5STejun Heo 						  unbound_release_work);
37148864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
37158864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
3716bc0caf09STejun Heo 	bool is_last;
37178864b4e5STejun Heo 
37188864b4e5STejun Heo 	if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
37198864b4e5STejun Heo 		return;
37208864b4e5STejun Heo 
372175ccf595STejun Heo 	/*
37223c25a55dSLai Jiangshan 	 * Unlink @pwq.  Synchronization against wq->mutex isn't strictly
372375ccf595STejun Heo 	 * necessary on release but do it anyway.  It's easier to verify
372475ccf595STejun Heo 	 * and consistent with the linking path.
372575ccf595STejun Heo 	 */
37263c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
37278864b4e5STejun Heo 	list_del_rcu(&pwq->pwqs_node);
3728bc0caf09STejun Heo 	is_last = list_empty(&wq->pwqs);
37293c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
37308864b4e5STejun Heo 
3731a892caccSTejun Heo 	mutex_lock(&wq_pool_mutex);
37328864b4e5STejun Heo 	put_unbound_pool(pool);
3733a892caccSTejun Heo 	mutex_unlock(&wq_pool_mutex);
3734a892caccSTejun Heo 
37358864b4e5STejun Heo 	call_rcu_sched(&pwq->rcu, rcu_free_pwq);
37368864b4e5STejun Heo 
37378864b4e5STejun Heo 	/*
37388864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
37398864b4e5STejun Heo 	 * is gonna access it anymore.  Free it.
37408864b4e5STejun Heo 	 */
37416029a918STejun Heo 	if (is_last) {
37426029a918STejun Heo 		free_workqueue_attrs(wq->unbound_attrs);
37438864b4e5STejun Heo 		kfree(wq);
37448864b4e5STejun Heo 	}
37456029a918STejun Heo }
37468864b4e5STejun Heo 
37470fbd95aaSTejun Heo /**
3748699ce097STejun Heo  * pwq_adjust_max_active - update a pwq's max_active to the current setting
37490fbd95aaSTejun Heo  * @pwq: target pool_workqueue
37500fbd95aaSTejun Heo  *
3751699ce097STejun Heo  * If @pwq isn't freezing, set @pwq->max_active to the associated
3752699ce097STejun Heo  * workqueue's saved_max_active and activate delayed work items
3753699ce097STejun Heo  * accordingly.  If @pwq is freezing, clear @pwq->max_active to zero.
37540fbd95aaSTejun Heo  */
3755699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq)
37560fbd95aaSTejun Heo {
3757699ce097STejun Heo 	struct workqueue_struct *wq = pwq->wq;
3758699ce097STejun Heo 	bool freezable = wq->flags & WQ_FREEZABLE;
3759699ce097STejun Heo 
3760699ce097STejun Heo 	/* for @wq->saved_max_active */
3761a357fc03SLai Jiangshan 	lockdep_assert_held(&wq->mutex);
3762699ce097STejun Heo 
3763699ce097STejun Heo 	/* fast exit for non-freezable wqs */
3764699ce097STejun Heo 	if (!freezable && pwq->max_active == wq->saved_max_active)
3765699ce097STejun Heo 		return;
3766699ce097STejun Heo 
3767a357fc03SLai Jiangshan 	spin_lock_irq(&pwq->pool->lock);
3768699ce097STejun Heo 
3769699ce097STejun Heo 	if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) {
3770699ce097STejun Heo 		pwq->max_active = wq->saved_max_active;
37710fbd95aaSTejun Heo 
37720fbd95aaSTejun Heo 		while (!list_empty(&pwq->delayed_works) &&
37730fbd95aaSTejun Heo 		       pwq->nr_active < pwq->max_active)
37740fbd95aaSTejun Heo 			pwq_activate_first_delayed(pwq);
3775951a078aSLai Jiangshan 
3776951a078aSLai Jiangshan 		/*
3777951a078aSLai Jiangshan 		 * Need to kick a worker after thawed or an unbound wq's
3778951a078aSLai Jiangshan 		 * max_active is bumped.  It's a slow path.  Do it always.
3779951a078aSLai Jiangshan 		 */
3780951a078aSLai Jiangshan 		wake_up_worker(pwq->pool);
3781699ce097STejun Heo 	} else {
3782699ce097STejun Heo 		pwq->max_active = 0;
3783699ce097STejun Heo 	}
3784699ce097STejun Heo 
3785a357fc03SLai Jiangshan 	spin_unlock_irq(&pwq->pool->lock);
37860fbd95aaSTejun Heo }
37870fbd95aaSTejun Heo 
3788e50aba9aSTejun Heo /* initialize newly alloced @pwq which is associated with @wq and @pool */
3789f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3790f147f29eSTejun Heo 		     struct worker_pool *pool)
3791d2c1d404STejun Heo {
3792d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3793d2c1d404STejun Heo 
3794e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
3795e50aba9aSTejun Heo 
3796d2c1d404STejun Heo 	pwq->pool = pool;
3797d2c1d404STejun Heo 	pwq->wq = wq;
3798d2c1d404STejun Heo 	pwq->flush_color = -1;
37998864b4e5STejun Heo 	pwq->refcnt = 1;
3800d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->delayed_works);
38011befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
3802d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
38038864b4e5STejun Heo 	INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3804f147f29eSTejun Heo }
3805d2c1d404STejun Heo 
3806f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
38071befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
3808f147f29eSTejun Heo {
3809f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
3810f147f29eSTejun Heo 
3811f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
381275ccf595STejun Heo 
38131befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
38141befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
38151befcf30STejun Heo 		return;
38161befcf30STejun Heo 
3817983ca25eSTejun Heo 	/*
3818983ca25eSTejun Heo 	 * Set the matching work_color.  This is synchronized with
38193c25a55dSLai Jiangshan 	 * wq->mutex to avoid confusing flush_workqueue().
3820983ca25eSTejun Heo 	 */
382175ccf595STejun Heo 	pwq->work_color = wq->work_color;
3822983ca25eSTejun Heo 
3823983ca25eSTejun Heo 	/* sync max_active to the current setting */
3824983ca25eSTejun Heo 	pwq_adjust_max_active(pwq);
3825983ca25eSTejun Heo 
3826983ca25eSTejun Heo 	/* link in @pwq */
38279e8cd2f5STejun Heo 	list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3828df2d5ae4STejun Heo }
38296029a918STejun Heo 
3830f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3831f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3832f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
3833f147f29eSTejun Heo {
3834f147f29eSTejun Heo 	struct worker_pool *pool;
3835f147f29eSTejun Heo 	struct pool_workqueue *pwq;
3836f147f29eSTejun Heo 
3837f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3838f147f29eSTejun Heo 
3839f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
3840f147f29eSTejun Heo 	if (!pool)
3841f147f29eSTejun Heo 		return NULL;
3842f147f29eSTejun Heo 
3843e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3844f147f29eSTejun Heo 	if (!pwq) {
3845f147f29eSTejun Heo 		put_unbound_pool(pool);
3846f147f29eSTejun Heo 		return NULL;
3847f147f29eSTejun Heo 	}
3848f147f29eSTejun Heo 
3849f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
3850f147f29eSTejun Heo 	return pwq;
3851d2c1d404STejun Heo }
3852d2c1d404STejun Heo 
38534c16bd32STejun Heo /* undo alloc_unbound_pwq(), used only in the error path */
38544c16bd32STejun Heo static void free_unbound_pwq(struct pool_workqueue *pwq)
38554c16bd32STejun Heo {
38564c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
38574c16bd32STejun Heo 
38584c16bd32STejun Heo 	if (pwq) {
38594c16bd32STejun Heo 		put_unbound_pool(pwq->pool);
3860cece95dfSWei Yongjun 		kmem_cache_free(pwq_cache, pwq);
38614c16bd32STejun Heo 	}
38624c16bd32STejun Heo }
38634c16bd32STejun Heo 
38644c16bd32STejun Heo /**
38654c16bd32STejun Heo  * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
38664c16bd32STejun Heo  * @attrs: the wq_attrs of interest
38674c16bd32STejun Heo  * @node: the target NUMA node
38684c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
38694c16bd32STejun Heo  * @cpumask: outarg, the resulting cpumask
38704c16bd32STejun Heo  *
38714c16bd32STejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @node.  If
38724c16bd32STejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during
3873d185af30SYacine Belkadi  * calculation.  The result is stored in @cpumask.
38744c16bd32STejun Heo  *
38754c16bd32STejun Heo  * If NUMA affinity is not enabled, @attrs->cpumask is always used.  If
38764c16bd32STejun Heo  * enabled and @node has online CPUs requested by @attrs, the returned
38774c16bd32STejun Heo  * cpumask is the intersection of the possible CPUs of @node and
38784c16bd32STejun Heo  * @attrs->cpumask.
38794c16bd32STejun Heo  *
38804c16bd32STejun Heo  * The caller is responsible for ensuring that the cpumask of @node stays
38814c16bd32STejun Heo  * stable.
3882d185af30SYacine Belkadi  *
3883d185af30SYacine Belkadi  * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3884d185af30SYacine Belkadi  * %false if equal.
38854c16bd32STejun Heo  */
38864c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
38874c16bd32STejun Heo 				 int cpu_going_down, cpumask_t *cpumask)
38884c16bd32STejun Heo {
3889d55262c4STejun Heo 	if (!wq_numa_enabled || attrs->no_numa)
38904c16bd32STejun Heo 		goto use_dfl;
38914c16bd32STejun Heo 
38924c16bd32STejun Heo 	/* does @node have any online CPUs @attrs wants? */
38934c16bd32STejun Heo 	cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
38944c16bd32STejun Heo 	if (cpu_going_down >= 0)
38954c16bd32STejun Heo 		cpumask_clear_cpu(cpu_going_down, cpumask);
38964c16bd32STejun Heo 
38974c16bd32STejun Heo 	if (cpumask_empty(cpumask))
38984c16bd32STejun Heo 		goto use_dfl;
38994c16bd32STejun Heo 
39004c16bd32STejun Heo 	/* yeap, return possible CPUs in @node that @attrs wants */
39014c16bd32STejun Heo 	cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
39024c16bd32STejun Heo 	return !cpumask_equal(cpumask, attrs->cpumask);
39034c16bd32STejun Heo 
39044c16bd32STejun Heo use_dfl:
39054c16bd32STejun Heo 	cpumask_copy(cpumask, attrs->cpumask);
39064c16bd32STejun Heo 	return false;
39074c16bd32STejun Heo }
39084c16bd32STejun Heo 
39091befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
39101befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
39111befcf30STejun Heo 						   int node,
39121befcf30STejun Heo 						   struct pool_workqueue *pwq)
39131befcf30STejun Heo {
39141befcf30STejun Heo 	struct pool_workqueue *old_pwq;
39151befcf30STejun Heo 
39161befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
39171befcf30STejun Heo 
39181befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
39191befcf30STejun Heo 	link_pwq(pwq);
39201befcf30STejun Heo 
39211befcf30STejun Heo 	old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
39221befcf30STejun Heo 	rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
39231befcf30STejun Heo 	return old_pwq;
39241befcf30STejun Heo }
39251befcf30STejun Heo 
39269e8cd2f5STejun Heo /**
39279e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
39289e8cd2f5STejun Heo  * @wq: the target workqueue
39299e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
39309e8cd2f5STejun Heo  *
39314c16bd32STejun Heo  * Apply @attrs to an unbound workqueue @wq.  Unless disabled, on NUMA
39324c16bd32STejun Heo  * machines, this function maps a separate pwq to each NUMA node with
39334c16bd32STejun Heo  * possibles CPUs in @attrs->cpumask so that work items are affine to the
39344c16bd32STejun Heo  * NUMA node it was issued on.  Older pwqs are released as in-flight work
39354c16bd32STejun Heo  * items finish.  Note that a work item which repeatedly requeues itself
39364c16bd32STejun Heo  * back-to-back will stay on its current pwq.
39379e8cd2f5STejun Heo  *
3938d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
3939d185af30SYacine Belkadi  *
3940d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
39419e8cd2f5STejun Heo  */
39429e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq,
39439e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
39449e8cd2f5STejun Heo {
39454c16bd32STejun Heo 	struct workqueue_attrs *new_attrs, *tmp_attrs;
39464c16bd32STejun Heo 	struct pool_workqueue **pwq_tbl, *dfl_pwq;
3947f147f29eSTejun Heo 	int node, ret;
39489e8cd2f5STejun Heo 
39498719dceaSTejun Heo 	/* only unbound workqueues can change attributes */
39509e8cd2f5STejun Heo 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
39519e8cd2f5STejun Heo 		return -EINVAL;
39529e8cd2f5STejun Heo 
39538719dceaSTejun Heo 	/* creating multiple pwqs breaks ordering guarantee */
39548719dceaSTejun Heo 	if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
39558719dceaSTejun Heo 		return -EINVAL;
39568719dceaSTejun Heo 
39574c16bd32STejun Heo 	pwq_tbl = kzalloc(wq_numa_tbl_len * sizeof(pwq_tbl[0]), GFP_KERNEL);
395813e2e556STejun Heo 	new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
39594c16bd32STejun Heo 	tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
39604c16bd32STejun Heo 	if (!pwq_tbl || !new_attrs || !tmp_attrs)
396113e2e556STejun Heo 		goto enomem;
396213e2e556STejun Heo 
39634c16bd32STejun Heo 	/* make a copy of @attrs and sanitize it */
396413e2e556STejun Heo 	copy_workqueue_attrs(new_attrs, attrs);
396513e2e556STejun Heo 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
396613e2e556STejun Heo 
39674c16bd32STejun Heo 	/*
39684c16bd32STejun Heo 	 * We may create multiple pwqs with differing cpumasks.  Make a
39694c16bd32STejun Heo 	 * copy of @new_attrs which will be modified and used to obtain
39704c16bd32STejun Heo 	 * pools.
39714c16bd32STejun Heo 	 */
39724c16bd32STejun Heo 	copy_workqueue_attrs(tmp_attrs, new_attrs);
39739e8cd2f5STejun Heo 
39744c16bd32STejun Heo 	/*
39754c16bd32STejun Heo 	 * CPUs should stay stable across pwq creations and installations.
39764c16bd32STejun Heo 	 * Pin CPUs, determine the target cpumask for each node and create
39774c16bd32STejun Heo 	 * pwqs accordingly.
39784c16bd32STejun Heo 	 */
39794c16bd32STejun Heo 	get_online_cpus();
39804c16bd32STejun Heo 
39814c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
39824c16bd32STejun Heo 
39834c16bd32STejun Heo 	/*
39844c16bd32STejun Heo 	 * If something goes wrong during CPU up/down, we'll fall back to
39854c16bd32STejun Heo 	 * the default pwq covering whole @attrs->cpumask.  Always create
39864c16bd32STejun Heo 	 * it even if we don't use it immediately.
39874c16bd32STejun Heo 	 */
39884c16bd32STejun Heo 	dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
39894c16bd32STejun Heo 	if (!dfl_pwq)
39904c16bd32STejun Heo 		goto enomem_pwq;
39914c16bd32STejun Heo 
39924c16bd32STejun Heo 	for_each_node(node) {
39934c16bd32STejun Heo 		if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
39944c16bd32STejun Heo 			pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
39954c16bd32STejun Heo 			if (!pwq_tbl[node])
39964c16bd32STejun Heo 				goto enomem_pwq;
39974c16bd32STejun Heo 		} else {
39984c16bd32STejun Heo 			dfl_pwq->refcnt++;
39994c16bd32STejun Heo 			pwq_tbl[node] = dfl_pwq;
40004c16bd32STejun Heo 		}
40014c16bd32STejun Heo 	}
40024c16bd32STejun Heo 
40034c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
40044c16bd32STejun Heo 
40054c16bd32STejun Heo 	/* all pwqs have been created successfully, let's install'em */
4006f147f29eSTejun Heo 	mutex_lock(&wq->mutex);
4007a892caccSTejun Heo 
4008f147f29eSTejun Heo 	copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
40094c16bd32STejun Heo 
40104c16bd32STejun Heo 	/* save the previous pwq and install the new one */
4011f147f29eSTejun Heo 	for_each_node(node)
40124c16bd32STejun Heo 		pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
40134c16bd32STejun Heo 
40144c16bd32STejun Heo 	/* @dfl_pwq might not have been used, ensure it's linked */
40154c16bd32STejun Heo 	link_pwq(dfl_pwq);
40164c16bd32STejun Heo 	swap(wq->dfl_pwq, dfl_pwq);
4017f147f29eSTejun Heo 
4018f147f29eSTejun Heo 	mutex_unlock(&wq->mutex);
4019f147f29eSTejun Heo 
40204c16bd32STejun Heo 	/* put the old pwqs */
40214c16bd32STejun Heo 	for_each_node(node)
40224c16bd32STejun Heo 		put_pwq_unlocked(pwq_tbl[node]);
40234c16bd32STejun Heo 	put_pwq_unlocked(dfl_pwq);
40244c16bd32STejun Heo 
40254c16bd32STejun Heo 	put_online_cpus();
40264862125bSTejun Heo 	ret = 0;
40274862125bSTejun Heo 	/* fall through */
40284862125bSTejun Heo out_free:
40294c16bd32STejun Heo 	free_workqueue_attrs(tmp_attrs);
40304862125bSTejun Heo 	free_workqueue_attrs(new_attrs);
40314c16bd32STejun Heo 	kfree(pwq_tbl);
40324862125bSTejun Heo 	return ret;
403313e2e556STejun Heo 
40344c16bd32STejun Heo enomem_pwq:
40354c16bd32STejun Heo 	free_unbound_pwq(dfl_pwq);
40364c16bd32STejun Heo 	for_each_node(node)
40374c16bd32STejun Heo 		if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
40384c16bd32STejun Heo 			free_unbound_pwq(pwq_tbl[node]);
40394c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
40404c16bd32STejun Heo 	put_online_cpus();
404113e2e556STejun Heo enomem:
40424862125bSTejun Heo 	ret = -ENOMEM;
40434862125bSTejun Heo 	goto out_free;
40449e8cd2f5STejun Heo }
40459e8cd2f5STejun Heo 
40464c16bd32STejun Heo /**
40474c16bd32STejun Heo  * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
40484c16bd32STejun Heo  * @wq: the target workqueue
40494c16bd32STejun Heo  * @cpu: the CPU coming up or going down
40504c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
40514c16bd32STejun Heo  *
40524c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
40534c16bd32STejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update NUMA affinity of
40544c16bd32STejun Heo  * @wq accordingly.
40554c16bd32STejun Heo  *
40564c16bd32STejun Heo  * If NUMA affinity can't be adjusted due to memory allocation failure, it
40574c16bd32STejun Heo  * falls back to @wq->dfl_pwq which may not be optimal but is always
40584c16bd32STejun Heo  * correct.
40594c16bd32STejun Heo  *
40604c16bd32STejun Heo  * Note that when the last allowed CPU of a NUMA node goes offline for a
40614c16bd32STejun Heo  * workqueue with a cpumask spanning multiple nodes, the workers which were
40624c16bd32STejun Heo  * already executing the work items for the workqueue will lose their CPU
40634c16bd32STejun Heo  * affinity and may execute on any CPU.  This is similar to how per-cpu
40644c16bd32STejun Heo  * workqueues behave on CPU_DOWN.  If a workqueue user wants strict
40654c16bd32STejun Heo  * affinity, it's the user's responsibility to flush the work item from
40664c16bd32STejun Heo  * CPU_DOWN_PREPARE.
40674c16bd32STejun Heo  */
40684c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
40694c16bd32STejun Heo 				   bool online)
40704c16bd32STejun Heo {
40714c16bd32STejun Heo 	int node = cpu_to_node(cpu);
40724c16bd32STejun Heo 	int cpu_off = online ? -1 : cpu;
40734c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
40744c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
40754c16bd32STejun Heo 	cpumask_t *cpumask;
40764c16bd32STejun Heo 
40774c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
40784c16bd32STejun Heo 
40794c16bd32STejun Heo 	if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
40804c16bd32STejun Heo 		return;
40814c16bd32STejun Heo 
40824c16bd32STejun Heo 	/*
40834c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
40844c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
40854c16bd32STejun Heo 	 * CPU hotplug exclusion.
40864c16bd32STejun Heo 	 */
40874c16bd32STejun Heo 	target_attrs = wq_update_unbound_numa_attrs_buf;
40884c16bd32STejun Heo 	cpumask = target_attrs->cpumask;
40894c16bd32STejun Heo 
40904c16bd32STejun Heo 	mutex_lock(&wq->mutex);
4091d55262c4STejun Heo 	if (wq->unbound_attrs->no_numa)
4092d55262c4STejun Heo 		goto out_unlock;
40934c16bd32STejun Heo 
40944c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
40954c16bd32STejun Heo 	pwq = unbound_pwq_by_node(wq, node);
40964c16bd32STejun Heo 
40974c16bd32STejun Heo 	/*
40984c16bd32STejun Heo 	 * Let's determine what needs to be done.  If the target cpumask is
40994c16bd32STejun Heo 	 * different from wq's, we need to compare it to @pwq's and create
41004c16bd32STejun Heo 	 * a new one if they don't match.  If the target cpumask equals
4101534a3fbbSDaeseok Youn 	 * wq's, the default pwq should be used.
41024c16bd32STejun Heo 	 */
41034c16bd32STejun Heo 	if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
41044c16bd32STejun Heo 		if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
41054c16bd32STejun Heo 			goto out_unlock;
41064c16bd32STejun Heo 	} else {
41074c16bd32STejun Heo 		goto use_dfl_pwq;
41084c16bd32STejun Heo 	}
41094c16bd32STejun Heo 
41104c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
41114c16bd32STejun Heo 
41124c16bd32STejun Heo 	/* create a new pwq */
41134c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
41144c16bd32STejun Heo 	if (!pwq) {
41152d916033SFabian Frederick 		pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
41164c16bd32STejun Heo 			wq->name);
411777f300b1SDaeseok Youn 		mutex_lock(&wq->mutex);
411877f300b1SDaeseok Youn 		goto use_dfl_pwq;
41194c16bd32STejun Heo 	}
41204c16bd32STejun Heo 
41214c16bd32STejun Heo 	/*
41224c16bd32STejun Heo 	 * Install the new pwq.  As this function is called only from CPU
41234c16bd32STejun Heo 	 * hotplug callbacks and applying a new attrs is wrapped with
41244c16bd32STejun Heo 	 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
41254c16bd32STejun Heo 	 * inbetween.
41264c16bd32STejun Heo 	 */
41274c16bd32STejun Heo 	mutex_lock(&wq->mutex);
41284c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, pwq);
41294c16bd32STejun Heo 	goto out_unlock;
41304c16bd32STejun Heo 
41314c16bd32STejun Heo use_dfl_pwq:
41324c16bd32STejun Heo 	spin_lock_irq(&wq->dfl_pwq->pool->lock);
41334c16bd32STejun Heo 	get_pwq(wq->dfl_pwq);
41344c16bd32STejun Heo 	spin_unlock_irq(&wq->dfl_pwq->pool->lock);
41354c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
41364c16bd32STejun Heo out_unlock:
41374c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
41384c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
41394c16bd32STejun Heo }
41404c16bd32STejun Heo 
414130cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
41421da177e4SLinus Torvalds {
414349e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
41448a2b7538STejun Heo 	int cpu, ret;
4145e1d8aa9fSFrederic Weisbecker 
414630cdf249STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
4147420c0ddbSTejun Heo 		wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4148420c0ddbSTejun Heo 		if (!wq->cpu_pwqs)
414930cdf249STejun Heo 			return -ENOMEM;
415030cdf249STejun Heo 
415130cdf249STejun Heo 		for_each_possible_cpu(cpu) {
41527fb98ea7STejun Heo 			struct pool_workqueue *pwq =
41537fb98ea7STejun Heo 				per_cpu_ptr(wq->cpu_pwqs, cpu);
41547a62c2c8STejun Heo 			struct worker_pool *cpu_pools =
4155f02ae73aSTejun Heo 				per_cpu(cpu_worker_pools, cpu);
415630cdf249STejun Heo 
4157f147f29eSTejun Heo 			init_pwq(pwq, wq, &cpu_pools[highpri]);
4158f147f29eSTejun Heo 
4159f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
41601befcf30STejun Heo 			link_pwq(pwq);
4161f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
416230cdf249STejun Heo 		}
416330cdf249STejun Heo 		return 0;
41648a2b7538STejun Heo 	} else if (wq->flags & __WQ_ORDERED) {
41658a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
41668a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
41678a2b7538STejun Heo 		WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
41688a2b7538STejun Heo 			      wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
41698a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
41708a2b7538STejun Heo 		return ret;
41719e8cd2f5STejun Heo 	} else {
41729e8cd2f5STejun Heo 		return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
41739e8cd2f5STejun Heo 	}
41740f900049STejun Heo }
41750f900049STejun Heo 
4176f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
4177f3421797STejun Heo 			       const char *name)
4178b71ab8c2STejun Heo {
4179f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4180f3421797STejun Heo 
4181f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
4182044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4183f3421797STejun Heo 			max_active, name, 1, lim);
4184b71ab8c2STejun Heo 
4185f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
4186b71ab8c2STejun Heo }
4187b71ab8c2STejun Heo 
4188b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
418997e37d7bSTejun Heo 					       unsigned int flags,
41901e19ffc6STejun Heo 					       int max_active,
4191eb13ba87SJohannes Berg 					       struct lock_class_key *key,
4192b196be89STejun Heo 					       const char *lock_name, ...)
41933af24433SOleg Nesterov {
4194df2d5ae4STejun Heo 	size_t tbl_size = 0;
4195ecf6881fSTejun Heo 	va_list args;
41963af24433SOleg Nesterov 	struct workqueue_struct *wq;
419749e3cf44STejun Heo 	struct pool_workqueue *pwq;
4198b196be89STejun Heo 
4199cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
4200cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4201cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
4202cee22a15SViresh Kumar 
4203ecf6881fSTejun Heo 	/* allocate wq and format name */
4204df2d5ae4STejun Heo 	if (flags & WQ_UNBOUND)
4205df2d5ae4STejun Heo 		tbl_size = wq_numa_tbl_len * sizeof(wq->numa_pwq_tbl[0]);
4206df2d5ae4STejun Heo 
4207df2d5ae4STejun Heo 	wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
4208b196be89STejun Heo 	if (!wq)
4209d2c1d404STejun Heo 		return NULL;
4210b196be89STejun Heo 
42116029a918STejun Heo 	if (flags & WQ_UNBOUND) {
42126029a918STejun Heo 		wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
42136029a918STejun Heo 		if (!wq->unbound_attrs)
42146029a918STejun Heo 			goto err_free_wq;
42156029a918STejun Heo 	}
42166029a918STejun Heo 
4217ecf6881fSTejun Heo 	va_start(args, lock_name);
4218ecf6881fSTejun Heo 	vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4219b196be89STejun Heo 	va_end(args);
42203af24433SOleg Nesterov 
4221d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
4222b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
42233af24433SOleg Nesterov 
4224b196be89STejun Heo 	/* init wq */
422597e37d7bSTejun Heo 	wq->flags = flags;
4226a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
42273c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
4228112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
422930cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
423073f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
423173f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
4232493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
42333af24433SOleg Nesterov 
4234eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
4235cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
42363af24433SOleg Nesterov 
423730cdf249STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
4238d2c1d404STejun Heo 		goto err_free_wq;
42391537663fSTejun Heo 
4240493008a8STejun Heo 	/*
4241493008a8STejun Heo 	 * Workqueues which may be used during memory reclaim should
4242493008a8STejun Heo 	 * have a rescuer to guarantee forward progress.
4243493008a8STejun Heo 	 */
4244493008a8STejun Heo 	if (flags & WQ_MEM_RECLAIM) {
4245e22bee78STejun Heo 		struct worker *rescuer;
4246e22bee78STejun Heo 
4247d2c1d404STejun Heo 		rescuer = alloc_worker();
4248e22bee78STejun Heo 		if (!rescuer)
4249d2c1d404STejun Heo 			goto err_destroy;
4250e22bee78STejun Heo 
4251111c225aSTejun Heo 		rescuer->rescue_wq = wq;
4252111c225aSTejun Heo 		rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
4253b196be89STejun Heo 					       wq->name);
4254d2c1d404STejun Heo 		if (IS_ERR(rescuer->task)) {
4255d2c1d404STejun Heo 			kfree(rescuer);
4256d2c1d404STejun Heo 			goto err_destroy;
4257d2c1d404STejun Heo 		}
4258e22bee78STejun Heo 
4259d2c1d404STejun Heo 		wq->rescuer = rescuer;
426014a40ffcSTejun Heo 		rescuer->task->flags |= PF_NO_SETAFFINITY;
4261e22bee78STejun Heo 		wake_up_process(rescuer->task);
42623af24433SOleg Nesterov 	}
42631537663fSTejun Heo 
4264226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4265226223abSTejun Heo 		goto err_destroy;
4266226223abSTejun Heo 
42673af24433SOleg Nesterov 	/*
426868e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
426968e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
427068e13a67SLai Jiangshan 	 * list.
42713af24433SOleg Nesterov 	 */
427268e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4273a0a1a5fdSTejun Heo 
4274a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
427549e3cf44STejun Heo 	for_each_pwq(pwq, wq)
4276699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4277a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4278a0a1a5fdSTejun Heo 
42793af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
4280a0a1a5fdSTejun Heo 
428168e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
42823af24433SOleg Nesterov 
42833af24433SOleg Nesterov 	return wq;
4284d2c1d404STejun Heo 
4285d2c1d404STejun Heo err_free_wq:
42866029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
42874690c4abSTejun Heo 	kfree(wq);
4288d2c1d404STejun Heo 	return NULL;
4289d2c1d404STejun Heo err_destroy:
4290d2c1d404STejun Heo 	destroy_workqueue(wq);
42914690c4abSTejun Heo 	return NULL;
42921da177e4SLinus Torvalds }
4293d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
42941da177e4SLinus Torvalds 
42953af24433SOleg Nesterov /**
42963af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
42973af24433SOleg Nesterov  * @wq: target workqueue
42983af24433SOleg Nesterov  *
42993af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
43003af24433SOleg Nesterov  */
43013af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
43023af24433SOleg Nesterov {
430349e3cf44STejun Heo 	struct pool_workqueue *pwq;
43044c16bd32STejun Heo 	int node;
43053af24433SOleg Nesterov 
43069c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
43079c5a2ba7STejun Heo 	drain_workqueue(wq);
4308c8efcc25STejun Heo 
43096183c009STejun Heo 	/* sanity checks */
4310b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
431149e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
43126183c009STejun Heo 		int i;
43136183c009STejun Heo 
431476af4d93STejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++) {
431576af4d93STejun Heo 			if (WARN_ON(pwq->nr_in_flight[i])) {
4316b09f4fd3SLai Jiangshan 				mutex_unlock(&wq->mutex);
43176183c009STejun Heo 				return;
431876af4d93STejun Heo 			}
431976af4d93STejun Heo 		}
432076af4d93STejun Heo 
43215c529597SLai Jiangshan 		if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
43228864b4e5STejun Heo 		    WARN_ON(pwq->nr_active) ||
432376af4d93STejun Heo 		    WARN_ON(!list_empty(&pwq->delayed_works))) {
4324b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
43256183c009STejun Heo 			return;
43266183c009STejun Heo 		}
432776af4d93STejun Heo 	}
4328b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
43296183c009STejun Heo 
4330a0a1a5fdSTejun Heo 	/*
4331a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
4332a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
4333a0a1a5fdSTejun Heo 	 */
433468e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4335d2c1d404STejun Heo 	list_del_init(&wq->list);
433668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
43373af24433SOleg Nesterov 
4338226223abSTejun Heo 	workqueue_sysfs_unregister(wq);
4339226223abSTejun Heo 
4340493008a8STejun Heo 	if (wq->rescuer) {
4341e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
43428d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
4343493008a8STejun Heo 		wq->rescuer = NULL;
4344e22bee78STejun Heo 	}
4345e22bee78STejun Heo 
43468864b4e5STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
434729c91e99STejun Heo 		/*
43488864b4e5STejun Heo 		 * The base ref is never dropped on per-cpu pwqs.  Directly
43498864b4e5STejun Heo 		 * free the pwqs and wq.
435029c91e99STejun Heo 		 */
43518864b4e5STejun Heo 		free_percpu(wq->cpu_pwqs);
43528864b4e5STejun Heo 		kfree(wq);
43538864b4e5STejun Heo 	} else {
43548864b4e5STejun Heo 		/*
43558864b4e5STejun Heo 		 * We're the sole accessor of @wq at this point.  Directly
43564c16bd32STejun Heo 		 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
43574c16bd32STejun Heo 		 * @wq will be freed when the last pwq is released.
43588864b4e5STejun Heo 		 */
43594c16bd32STejun Heo 		for_each_node(node) {
43604c16bd32STejun Heo 			pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
43614c16bd32STejun Heo 			RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
43624c16bd32STejun Heo 			put_pwq_unlocked(pwq);
43634c16bd32STejun Heo 		}
43644c16bd32STejun Heo 
43654c16bd32STejun Heo 		/*
43664c16bd32STejun Heo 		 * Put dfl_pwq.  @wq may be freed any time after dfl_pwq is
43674c16bd32STejun Heo 		 * put.  Don't access it afterwards.
43684c16bd32STejun Heo 		 */
43694c16bd32STejun Heo 		pwq = wq->dfl_pwq;
43704c16bd32STejun Heo 		wq->dfl_pwq = NULL;
4371dce90d47STejun Heo 		put_pwq_unlocked(pwq);
437229c91e99STejun Heo 	}
43733af24433SOleg Nesterov }
43743af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
43753af24433SOleg Nesterov 
4376dcd989cbSTejun Heo /**
4377dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
4378dcd989cbSTejun Heo  * @wq: target workqueue
4379dcd989cbSTejun Heo  * @max_active: new max_active value.
4380dcd989cbSTejun Heo  *
4381dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
4382dcd989cbSTejun Heo  *
4383dcd989cbSTejun Heo  * CONTEXT:
4384dcd989cbSTejun Heo  * Don't call from IRQ context.
4385dcd989cbSTejun Heo  */
4386dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4387dcd989cbSTejun Heo {
438849e3cf44STejun Heo 	struct pool_workqueue *pwq;
4389dcd989cbSTejun Heo 
43908719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
43918719dceaSTejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
43928719dceaSTejun Heo 		return;
43938719dceaSTejun Heo 
4394f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4395dcd989cbSTejun Heo 
4396a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
4397dcd989cbSTejun Heo 
4398dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
4399dcd989cbSTejun Heo 
4400699ce097STejun Heo 	for_each_pwq(pwq, wq)
4401699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4402dcd989cbSTejun Heo 
4403a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4404dcd989cbSTejun Heo }
4405dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4406dcd989cbSTejun Heo 
4407dcd989cbSTejun Heo /**
4408e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
4409e6267616STejun Heo  *
4410e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
4411e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
4412d185af30SYacine Belkadi  *
4413d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
4414e6267616STejun Heo  */
4415e6267616STejun Heo bool current_is_workqueue_rescuer(void)
4416e6267616STejun Heo {
4417e6267616STejun Heo 	struct worker *worker = current_wq_worker();
4418e6267616STejun Heo 
44196a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
4420e6267616STejun Heo }
4421e6267616STejun Heo 
4422e6267616STejun Heo /**
4423dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
4424dcd989cbSTejun Heo  * @cpu: CPU in question
4425dcd989cbSTejun Heo  * @wq: target workqueue
4426dcd989cbSTejun Heo  *
4427dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
4428dcd989cbSTejun Heo  * no synchronization around this function and the test result is
4429dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4430dcd989cbSTejun Heo  *
4431d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4432d3251859STejun Heo  * Note that both per-cpu and unbound workqueues may be associated with
4433d3251859STejun Heo  * multiple pool_workqueues which have separate congested states.  A
4434d3251859STejun Heo  * workqueue being congested on one CPU doesn't mean the workqueue is also
4435d3251859STejun Heo  * contested on other CPUs / NUMA nodes.
4436d3251859STejun Heo  *
4437d185af30SYacine Belkadi  * Return:
4438dcd989cbSTejun Heo  * %true if congested, %false otherwise.
4439dcd989cbSTejun Heo  */
4440d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4441dcd989cbSTejun Heo {
44427fb98ea7STejun Heo 	struct pool_workqueue *pwq;
444376af4d93STejun Heo 	bool ret;
444476af4d93STejun Heo 
444588109453SLai Jiangshan 	rcu_read_lock_sched();
44467fb98ea7STejun Heo 
4447d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
4448d3251859STejun Heo 		cpu = smp_processor_id();
4449d3251859STejun Heo 
44507fb98ea7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
44517fb98ea7STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
44527fb98ea7STejun Heo 	else
4453df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4454dcd989cbSTejun Heo 
445576af4d93STejun Heo 	ret = !list_empty(&pwq->delayed_works);
445688109453SLai Jiangshan 	rcu_read_unlock_sched();
445776af4d93STejun Heo 
445876af4d93STejun Heo 	return ret;
4459dcd989cbSTejun Heo }
4460dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
4461dcd989cbSTejun Heo 
4462dcd989cbSTejun Heo /**
4463dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
4464dcd989cbSTejun Heo  * @work: the work to be tested
4465dcd989cbSTejun Heo  *
4466dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
4467dcd989cbSTejun Heo  * synchronization around this function and the test result is
4468dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4469dcd989cbSTejun Heo  *
4470d185af30SYacine Belkadi  * Return:
4471dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
4472dcd989cbSTejun Heo  */
4473dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
4474dcd989cbSTejun Heo {
4475fa1b54e6STejun Heo 	struct worker_pool *pool;
4476dcd989cbSTejun Heo 	unsigned long flags;
4477dcd989cbSTejun Heo 	unsigned int ret = 0;
4478dcd989cbSTejun Heo 
4479dcd989cbSTejun Heo 	if (work_pending(work))
4480dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
4481038366c5SLai Jiangshan 
4482fa1b54e6STejun Heo 	local_irq_save(flags);
4483fa1b54e6STejun Heo 	pool = get_work_pool(work);
4484038366c5SLai Jiangshan 	if (pool) {
4485fa1b54e6STejun Heo 		spin_lock(&pool->lock);
4486c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
4487dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
4488fa1b54e6STejun Heo 		spin_unlock(&pool->lock);
4489038366c5SLai Jiangshan 	}
4490fa1b54e6STejun Heo 	local_irq_restore(flags);
4491dcd989cbSTejun Heo 
4492dcd989cbSTejun Heo 	return ret;
4493dcd989cbSTejun Heo }
4494dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
4495dcd989cbSTejun Heo 
44963d1cb205STejun Heo /**
44973d1cb205STejun Heo  * set_worker_desc - set description for the current work item
44983d1cb205STejun Heo  * @fmt: printf-style format string
44993d1cb205STejun Heo  * @...: arguments for the format string
45003d1cb205STejun Heo  *
45013d1cb205STejun Heo  * This function can be called by a running work function to describe what
45023d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
45033d1cb205STejun Heo  * information will be printed out together to help debugging.  The
45043d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
45053d1cb205STejun Heo  */
45063d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
45073d1cb205STejun Heo {
45083d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
45093d1cb205STejun Heo 	va_list args;
45103d1cb205STejun Heo 
45113d1cb205STejun Heo 	if (worker) {
45123d1cb205STejun Heo 		va_start(args, fmt);
45133d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
45143d1cb205STejun Heo 		va_end(args);
45153d1cb205STejun Heo 		worker->desc_valid = true;
45163d1cb205STejun Heo 	}
45173d1cb205STejun Heo }
45183d1cb205STejun Heo 
45193d1cb205STejun Heo /**
45203d1cb205STejun Heo  * print_worker_info - print out worker information and description
45213d1cb205STejun Heo  * @log_lvl: the log level to use when printing
45223d1cb205STejun Heo  * @task: target task
45233d1cb205STejun Heo  *
45243d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
45253d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
45263d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
45273d1cb205STejun Heo  *
45283d1cb205STejun Heo  * This function can be safely called on any task as long as the
45293d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
45303d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
45313d1cb205STejun Heo  */
45323d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
45333d1cb205STejun Heo {
45343d1cb205STejun Heo 	work_func_t *fn = NULL;
45353d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
45363d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
45373d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
45383d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
45393d1cb205STejun Heo 	bool desc_valid = false;
45403d1cb205STejun Heo 	struct worker *worker;
45413d1cb205STejun Heo 
45423d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
45433d1cb205STejun Heo 		return;
45443d1cb205STejun Heo 
45453d1cb205STejun Heo 	/*
45463d1cb205STejun Heo 	 * This function is called without any synchronization and @task
45473d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
45483d1cb205STejun Heo 	 */
45493d1cb205STejun Heo 	worker = probe_kthread_data(task);
45503d1cb205STejun Heo 
45513d1cb205STejun Heo 	/*
45523d1cb205STejun Heo 	 * Carefully copy the associated workqueue's workfn and name.  Keep
45533d1cb205STejun Heo 	 * the original last '\0' in case the original contains garbage.
45543d1cb205STejun Heo 	 */
45553d1cb205STejun Heo 	probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
45563d1cb205STejun Heo 	probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
45573d1cb205STejun Heo 	probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
45583d1cb205STejun Heo 	probe_kernel_read(name, wq->name, sizeof(name) - 1);
45593d1cb205STejun Heo 
45603d1cb205STejun Heo 	/* copy worker description */
45613d1cb205STejun Heo 	probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
45623d1cb205STejun Heo 	if (desc_valid)
45633d1cb205STejun Heo 		probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
45643d1cb205STejun Heo 
45653d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
45662d916033SFabian Frederick 		pr_info("%sWorkqueue: %s %pf", log_lvl, name, fn);
45673d1cb205STejun Heo 		if (desc[0])
45683d1cb205STejun Heo 			pr_cont(" (%s)", desc);
45693d1cb205STejun Heo 		pr_cont("\n");
45703d1cb205STejun Heo 	}
45713d1cb205STejun Heo }
45723d1cb205STejun Heo 
4573db7bccf4STejun Heo /*
4574db7bccf4STejun Heo  * CPU hotplug.
4575db7bccf4STejun Heo  *
4576e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
4577112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
4578706026c2STejun Heo  * pool which make migrating pending and scheduled works very
4579e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
458094cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
4581e22bee78STejun Heo  * blocked draining impractical.
4582e22bee78STejun Heo  *
458324647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
4584628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
4585628c78e7STejun Heo  * cpu comes back online.
4586db7bccf4STejun Heo  */
4587db7bccf4STejun Heo 
4588706026c2STejun Heo static void wq_unbind_fn(struct work_struct *work)
4589db7bccf4STejun Heo {
459038db41d9STejun Heo 	int cpu = smp_processor_id();
45914ce62e9eSTejun Heo 	struct worker_pool *pool;
4592db7bccf4STejun Heo 	struct worker *worker;
4593a9ab775bSTejun Heo 	int wi;
4594db7bccf4STejun Heo 
4595f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
45966183c009STejun Heo 		WARN_ON_ONCE(cpu != smp_processor_id());
4597db7bccf4STejun Heo 
4598bc3a1afcSTejun Heo 		mutex_lock(&pool->manager_mutex);
459994cf58bbSTejun Heo 		spin_lock_irq(&pool->lock);
4600e22bee78STejun Heo 
4601f2d5a0eeSTejun Heo 		/*
4602bc3a1afcSTejun Heo 		 * We've blocked all manager operations.  Make all workers
460394cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
460494cf58bbSTejun Heo 		 * except for the ones which are still executing works from
460594cf58bbSTejun Heo 		 * before the last CPU down must be on the cpu.  After
460694cf58bbSTejun Heo 		 * this, they may become diasporas.
4607f2d5a0eeSTejun Heo 		 */
4608a9ab775bSTejun Heo 		for_each_pool_worker(worker, wi, pool)
4609403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
4610db7bccf4STejun Heo 
461124647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
4612f2d5a0eeSTejun Heo 
461394cf58bbSTejun Heo 		spin_unlock_irq(&pool->lock);
4614bc3a1afcSTejun Heo 		mutex_unlock(&pool->manager_mutex);
4615e22bee78STejun Heo 
4616e22bee78STejun Heo 		/*
4617eb283428SLai Jiangshan 		 * Call schedule() so that we cross rq->lock and thus can
4618eb283428SLai Jiangshan 		 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4619eb283428SLai Jiangshan 		 * This is necessary as scheduler callbacks may be invoked
4620eb283428SLai Jiangshan 		 * from other cpus.
4621628c78e7STejun Heo 		 */
4622628c78e7STejun Heo 		schedule();
4623628c78e7STejun Heo 
4624628c78e7STejun Heo 		/*
4625eb283428SLai Jiangshan 		 * Sched callbacks are disabled now.  Zap nr_running.
4626eb283428SLai Jiangshan 		 * After this, nr_running stays zero and need_more_worker()
4627eb283428SLai Jiangshan 		 * and keep_working() are always true as long as the
4628eb283428SLai Jiangshan 		 * worklist is not empty.  This pool now behaves as an
4629eb283428SLai Jiangshan 		 * unbound (in terms of concurrency management) pool which
4630eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
4631e22bee78STejun Heo 		 */
4632e19e397aSTejun Heo 		atomic_set(&pool->nr_running, 0);
4633eb283428SLai Jiangshan 
4634eb283428SLai Jiangshan 		/*
4635eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
4636eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
4637eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
4638eb283428SLai Jiangshan 		 */
4639eb283428SLai Jiangshan 		spin_lock_irq(&pool->lock);
4640eb283428SLai Jiangshan 		wake_up_worker(pool);
4641eb283428SLai Jiangshan 		spin_unlock_irq(&pool->lock);
4642eb283428SLai Jiangshan 	}
4643db7bccf4STejun Heo }
4644db7bccf4STejun Heo 
4645bd7c089eSTejun Heo /**
4646bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
4647bd7c089eSTejun Heo  * @pool: pool of interest
4648bd7c089eSTejun Heo  *
4649a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
4650bd7c089eSTejun Heo  */
4651bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
4652bd7c089eSTejun Heo {
4653a9ab775bSTejun Heo 	struct worker *worker;
4654a9ab775bSTejun Heo 	int wi;
4655bd7c089eSTejun Heo 
4656bd7c089eSTejun Heo 	lockdep_assert_held(&pool->manager_mutex);
4657bd7c089eSTejun Heo 
4658bd7c089eSTejun Heo 	/*
4659a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
4660a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
4661a9ab775bSTejun Heo 	 * wake-ups for concurrency management happen, restore CPU affinty
4662a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
4663a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
4664bd7c089eSTejun Heo 	 */
4665a9ab775bSTejun Heo 	for_each_pool_worker(worker, wi, pool)
4666a9ab775bSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4667a9ab775bSTejun Heo 						  pool->attrs->cpumask) < 0);
4668a9ab775bSTejun Heo 
4669a9ab775bSTejun Heo 	spin_lock_irq(&pool->lock);
4670a9ab775bSTejun Heo 
4671a9ab775bSTejun Heo 	for_each_pool_worker(worker, wi, pool) {
4672a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
4673a9ab775bSTejun Heo 
4674a9ab775bSTejun Heo 		/*
4675a9ab775bSTejun Heo 		 * A bound idle worker should actually be on the runqueue
4676a9ab775bSTejun Heo 		 * of the associated CPU for local wake-ups targeting it to
4677a9ab775bSTejun Heo 		 * work.  Kick all idle workers so that they migrate to the
4678a9ab775bSTejun Heo 		 * associated CPU.  Doing this in the same loop as
4679a9ab775bSTejun Heo 		 * replacing UNBOUND with REBOUND is safe as no worker will
4680a9ab775bSTejun Heo 		 * be bound before @pool->lock is released.
4681a9ab775bSTejun Heo 		 */
4682a9ab775bSTejun Heo 		if (worker_flags & WORKER_IDLE)
4683bd7c089eSTejun Heo 			wake_up_process(worker->task);
4684bd7c089eSTejun Heo 
4685bd7c089eSTejun Heo 		/*
4686a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
4687a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
4688a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4689a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
4690a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
4691a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
4692a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
4693a9ab775bSTejun Heo 		 *
4694a9ab775bSTejun Heo 		 * ACCESS_ONCE() is necessary because @worker->flags may be
4695a9ab775bSTejun Heo 		 * tested without holding any lock in
4696a9ab775bSTejun Heo 		 * wq_worker_waking_up().  Without it, NOT_RUNNING test may
4697a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
4698a9ab775bSTejun Heo 		 * management operations.
4699bd7c089eSTejun Heo 		 */
4700a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4701a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
4702a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
4703a9ab775bSTejun Heo 		ACCESS_ONCE(worker->flags) = worker_flags;
4704bd7c089eSTejun Heo 	}
4705a9ab775bSTejun Heo 
4706a9ab775bSTejun Heo 	spin_unlock_irq(&pool->lock);
4707bd7c089eSTejun Heo }
4708bd7c089eSTejun Heo 
47097dbc725eSTejun Heo /**
47107dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
47117dbc725eSTejun Heo  * @pool: unbound pool of interest
47127dbc725eSTejun Heo  * @cpu: the CPU which is coming up
47137dbc725eSTejun Heo  *
47147dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
47157dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
47167dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
47177dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
47187dbc725eSTejun Heo  */
47197dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
47207dbc725eSTejun Heo {
47217dbc725eSTejun Heo 	static cpumask_t cpumask;
47227dbc725eSTejun Heo 	struct worker *worker;
47237dbc725eSTejun Heo 	int wi;
47247dbc725eSTejun Heo 
47257dbc725eSTejun Heo 	lockdep_assert_held(&pool->manager_mutex);
47267dbc725eSTejun Heo 
47277dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
47287dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
47297dbc725eSTejun Heo 		return;
47307dbc725eSTejun Heo 
47317dbc725eSTejun Heo 	/* is @cpu the only online CPU? */
47327dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
47337dbc725eSTejun Heo 	if (cpumask_weight(&cpumask) != 1)
47347dbc725eSTejun Heo 		return;
47357dbc725eSTejun Heo 
47367dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
47377dbc725eSTejun Heo 	for_each_pool_worker(worker, wi, pool)
47387dbc725eSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
47397dbc725eSTejun Heo 						  pool->attrs->cpumask) < 0);
47407dbc725eSTejun Heo }
47417dbc725eSTejun Heo 
47428db25e78STejun Heo /*
47438db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
47448db25e78STejun Heo  * This will be registered high priority CPU notifier.
47458db25e78STejun Heo  */
47460db0628dSPaul Gortmaker static int workqueue_cpu_up_callback(struct notifier_block *nfb,
47471da177e4SLinus Torvalds 					       unsigned long action,
47481da177e4SLinus Torvalds 					       void *hcpu)
47491da177e4SLinus Torvalds {
4750d84ff051STejun Heo 	int cpu = (unsigned long)hcpu;
47514ce62e9eSTejun Heo 	struct worker_pool *pool;
47524c16bd32STejun Heo 	struct workqueue_struct *wq;
47537dbc725eSTejun Heo 	int pi;
47541da177e4SLinus Torvalds 
47558db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
47563af24433SOleg Nesterov 	case CPU_UP_PREPARE:
4757f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
47583ce63377STejun Heo 			if (pool->nr_workers)
47593ce63377STejun Heo 				continue;
4760ebf44d16STejun Heo 			if (create_and_start_worker(pool) < 0)
47613ce63377STejun Heo 				return NOTIFY_BAD;
47623af24433SOleg Nesterov 		}
47631da177e4SLinus Torvalds 		break;
47641da177e4SLinus Torvalds 
476565758202STejun Heo 	case CPU_DOWN_FAILED:
476665758202STejun Heo 	case CPU_ONLINE:
476768e13a67SLai Jiangshan 		mutex_lock(&wq_pool_mutex);
47687dbc725eSTejun Heo 
47697dbc725eSTejun Heo 		for_each_pool(pool, pi) {
4770bc3a1afcSTejun Heo 			mutex_lock(&pool->manager_mutex);
477194cf58bbSTejun Heo 
47727dbc725eSTejun Heo 			if (pool->cpu == cpu) {
4773a9ab775bSTejun Heo 				spin_lock_irq(&pool->lock);
477424647570STejun Heo 				pool->flags &= ~POOL_DISASSOCIATED;
4775a9ab775bSTejun Heo 				spin_unlock_irq(&pool->lock);
4776a9ab775bSTejun Heo 
477794cf58bbSTejun Heo 				rebind_workers(pool);
47787dbc725eSTejun Heo 			} else if (pool->cpu < 0) {
47797dbc725eSTejun Heo 				restore_unbound_workers_cpumask(pool, cpu);
47807dbc725eSTejun Heo 			}
478194cf58bbSTejun Heo 
4782bc3a1afcSTejun Heo 			mutex_unlock(&pool->manager_mutex);
478394cf58bbSTejun Heo 		}
47847dbc725eSTejun Heo 
47854c16bd32STejun Heo 		/* update NUMA affinity of unbound workqueues */
47864c16bd32STejun Heo 		list_for_each_entry(wq, &workqueues, list)
47874c16bd32STejun Heo 			wq_update_unbound_numa(wq, cpu, true);
47884c16bd32STejun Heo 
478968e13a67SLai Jiangshan 		mutex_unlock(&wq_pool_mutex);
47908db25e78STejun Heo 		break;
479165758202STejun Heo 	}
479265758202STejun Heo 	return NOTIFY_OK;
479365758202STejun Heo }
479465758202STejun Heo 
479565758202STejun Heo /*
479665758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
479765758202STejun Heo  * This will be registered as low priority CPU notifier.
479865758202STejun Heo  */
47990db0628dSPaul Gortmaker static int workqueue_cpu_down_callback(struct notifier_block *nfb,
480065758202STejun Heo 						 unsigned long action,
480165758202STejun Heo 						 void *hcpu)
480265758202STejun Heo {
4803d84ff051STejun Heo 	int cpu = (unsigned long)hcpu;
48048db25e78STejun Heo 	struct work_struct unbind_work;
48054c16bd32STejun Heo 	struct workqueue_struct *wq;
48068db25e78STejun Heo 
480765758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
480865758202STejun Heo 	case CPU_DOWN_PREPARE:
48094c16bd32STejun Heo 		/* unbinding per-cpu workers should happen on the local CPU */
4810706026c2STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
48117635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
48124c16bd32STejun Heo 
48134c16bd32STejun Heo 		/* update NUMA affinity of unbound workqueues */
48144c16bd32STejun Heo 		mutex_lock(&wq_pool_mutex);
48154c16bd32STejun Heo 		list_for_each_entry(wq, &workqueues, list)
48164c16bd32STejun Heo 			wq_update_unbound_numa(wq, cpu, false);
48174c16bd32STejun Heo 		mutex_unlock(&wq_pool_mutex);
48184c16bd32STejun Heo 
48194c16bd32STejun Heo 		/* wait for per-cpu unbinding to finish */
48208db25e78STejun Heo 		flush_work(&unbind_work);
4821440a1136SChuansheng Liu 		destroy_work_on_stack(&unbind_work);
48228db25e78STejun Heo 		break;
482365758202STejun Heo 	}
482465758202STejun Heo 	return NOTIFY_OK;
482565758202STejun Heo }
482665758202STejun Heo 
48272d3854a3SRusty Russell #ifdef CONFIG_SMP
48288ccad40dSRusty Russell 
48292d3854a3SRusty Russell struct work_for_cpu {
4830ed48ece2STejun Heo 	struct work_struct work;
48312d3854a3SRusty Russell 	long (*fn)(void *);
48322d3854a3SRusty Russell 	void *arg;
48332d3854a3SRusty Russell 	long ret;
48342d3854a3SRusty Russell };
48352d3854a3SRusty Russell 
4836ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
48372d3854a3SRusty Russell {
4838ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4839ed48ece2STejun Heo 
48402d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
48412d3854a3SRusty Russell }
48422d3854a3SRusty Russell 
48432d3854a3SRusty Russell /**
48442d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
48452d3854a3SRusty Russell  * @cpu: the cpu to run on
48462d3854a3SRusty Russell  * @fn: the function to run
48472d3854a3SRusty Russell  * @arg: the function arg
48482d3854a3SRusty Russell  *
484931ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
48506b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
4851d185af30SYacine Belkadi  *
4852d185af30SYacine Belkadi  * Return: The value @fn returns.
48532d3854a3SRusty Russell  */
4854d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
48552d3854a3SRusty Russell {
4856ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
48572d3854a3SRusty Russell 
4858ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4859ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
486012997d1aSBjorn Helgaas 	flush_work(&wfc.work);
4861440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
48622d3854a3SRusty Russell 	return wfc.ret;
48632d3854a3SRusty Russell }
48642d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
48652d3854a3SRusty Russell #endif /* CONFIG_SMP */
48662d3854a3SRusty Russell 
4867a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
4868e7577c50SRusty Russell 
4869a0a1a5fdSTejun Heo /**
4870a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
4871a0a1a5fdSTejun Heo  *
487258a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
4873c5aa87bbSTejun Heo  * workqueues will queue new works to their delayed_works list instead of
4874706026c2STejun Heo  * pool->worklist.
4875a0a1a5fdSTejun Heo  *
4876a0a1a5fdSTejun Heo  * CONTEXT:
4877a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4878a0a1a5fdSTejun Heo  */
4879a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
4880a0a1a5fdSTejun Heo {
488117116969STejun Heo 	struct worker_pool *pool;
488224b8a847STejun Heo 	struct workqueue_struct *wq;
488324b8a847STejun Heo 	struct pool_workqueue *pwq;
4884611c92a0STejun Heo 	int pi;
4885a0a1a5fdSTejun Heo 
488668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4887a0a1a5fdSTejun Heo 
48886183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
4889a0a1a5fdSTejun Heo 	workqueue_freezing = true;
4890a0a1a5fdSTejun Heo 
489124b8a847STejun Heo 	/* set FREEZING */
4892611c92a0STejun Heo 	for_each_pool(pool, pi) {
48935bcab335STejun Heo 		spin_lock_irq(&pool->lock);
489435b6bb63STejun Heo 		WARN_ON_ONCE(pool->flags & POOL_FREEZING);
489535b6bb63STejun Heo 		pool->flags |= POOL_FREEZING;
48965bcab335STejun Heo 		spin_unlock_irq(&pool->lock);
48971da177e4SLinus Torvalds 	}
48988b03ae3cSTejun Heo 
489924b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
4900a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
4901699ce097STejun Heo 		for_each_pwq(pwq, wq)
4902699ce097STejun Heo 			pwq_adjust_max_active(pwq);
4903a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
4904a1056305STejun Heo 	}
49055bcab335STejun Heo 
490668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4907a0a1a5fdSTejun Heo }
4908a0a1a5fdSTejun Heo 
4909a0a1a5fdSTejun Heo /**
491058a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
4911a0a1a5fdSTejun Heo  *
4912a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
4913a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
4914a0a1a5fdSTejun Heo  *
4915a0a1a5fdSTejun Heo  * CONTEXT:
491668e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
4917a0a1a5fdSTejun Heo  *
4918d185af30SYacine Belkadi  * Return:
491958a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
492058a69cb4STejun Heo  * is complete.
4921a0a1a5fdSTejun Heo  */
4922a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
4923a0a1a5fdSTejun Heo {
4924a0a1a5fdSTejun Heo 	bool busy = false;
492524b8a847STejun Heo 	struct workqueue_struct *wq;
492624b8a847STejun Heo 	struct pool_workqueue *pwq;
4927a0a1a5fdSTejun Heo 
492868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4929a0a1a5fdSTejun Heo 
49306183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
4931a0a1a5fdSTejun Heo 
493224b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
493324b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
493424b8a847STejun Heo 			continue;
4935a0a1a5fdSTejun Heo 		/*
4936a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
4937a0a1a5fdSTejun Heo 		 * to peek without lock.
4938a0a1a5fdSTejun Heo 		 */
493988109453SLai Jiangshan 		rcu_read_lock_sched();
494024b8a847STejun Heo 		for_each_pwq(pwq, wq) {
49416183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
4942112202d9STejun Heo 			if (pwq->nr_active) {
4943a0a1a5fdSTejun Heo 				busy = true;
494488109453SLai Jiangshan 				rcu_read_unlock_sched();
4945a0a1a5fdSTejun Heo 				goto out_unlock;
4946a0a1a5fdSTejun Heo 			}
4947a0a1a5fdSTejun Heo 		}
494888109453SLai Jiangshan 		rcu_read_unlock_sched();
4949a0a1a5fdSTejun Heo 	}
4950a0a1a5fdSTejun Heo out_unlock:
495168e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4952a0a1a5fdSTejun Heo 	return busy;
4953a0a1a5fdSTejun Heo }
4954a0a1a5fdSTejun Heo 
4955a0a1a5fdSTejun Heo /**
4956a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
4957a0a1a5fdSTejun Heo  *
4958a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
4959706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
4960a0a1a5fdSTejun Heo  *
4961a0a1a5fdSTejun Heo  * CONTEXT:
4962a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4963a0a1a5fdSTejun Heo  */
4964a0a1a5fdSTejun Heo void thaw_workqueues(void)
4965a0a1a5fdSTejun Heo {
496624b8a847STejun Heo 	struct workqueue_struct *wq;
496724b8a847STejun Heo 	struct pool_workqueue *pwq;
496824b8a847STejun Heo 	struct worker_pool *pool;
4969611c92a0STejun Heo 	int pi;
4970a0a1a5fdSTejun Heo 
497168e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4972a0a1a5fdSTejun Heo 
4973a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
4974a0a1a5fdSTejun Heo 		goto out_unlock;
4975a0a1a5fdSTejun Heo 
497624b8a847STejun Heo 	/* clear FREEZING */
4977611c92a0STejun Heo 	for_each_pool(pool, pi) {
49785bcab335STejun Heo 		spin_lock_irq(&pool->lock);
497935b6bb63STejun Heo 		WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
498035b6bb63STejun Heo 		pool->flags &= ~POOL_FREEZING;
49815bcab335STejun Heo 		spin_unlock_irq(&pool->lock);
4982d565ed63STejun Heo 	}
498324b8a847STejun Heo 
498424b8a847STejun Heo 	/* restore max_active and repopulate worklist */
498524b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
4986a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
4987699ce097STejun Heo 		for_each_pwq(pwq, wq)
4988699ce097STejun Heo 			pwq_adjust_max_active(pwq);
4989a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
499024b8a847STejun Heo 	}
499124b8a847STejun Heo 
4992a0a1a5fdSTejun Heo 	workqueue_freezing = false;
4993a0a1a5fdSTejun Heo out_unlock:
499468e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4995a0a1a5fdSTejun Heo }
4996a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
4997a0a1a5fdSTejun Heo 
4998bce90380STejun Heo static void __init wq_numa_init(void)
4999bce90380STejun Heo {
5000bce90380STejun Heo 	cpumask_var_t *tbl;
5001bce90380STejun Heo 	int node, cpu;
5002bce90380STejun Heo 
5003bce90380STejun Heo 	/* determine NUMA pwq table len - highest node id + 1 */
5004bce90380STejun Heo 	for_each_node(node)
5005bce90380STejun Heo 		wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1);
5006bce90380STejun Heo 
5007bce90380STejun Heo 	if (num_possible_nodes() <= 1)
5008bce90380STejun Heo 		return;
5009bce90380STejun Heo 
5010d55262c4STejun Heo 	if (wq_disable_numa) {
5011d55262c4STejun Heo 		pr_info("workqueue: NUMA affinity support disabled\n");
5012d55262c4STejun Heo 		return;
5013d55262c4STejun Heo 	}
5014d55262c4STejun Heo 
50154c16bd32STejun Heo 	wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
50164c16bd32STejun Heo 	BUG_ON(!wq_update_unbound_numa_attrs_buf);
50174c16bd32STejun Heo 
5018bce90380STejun Heo 	/*
5019bce90380STejun Heo 	 * We want masks of possible CPUs of each node which isn't readily
5020bce90380STejun Heo 	 * available.  Build one from cpu_to_node() which should have been
5021bce90380STejun Heo 	 * fully initialized by now.
5022bce90380STejun Heo 	 */
5023bce90380STejun Heo 	tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL);
5024bce90380STejun Heo 	BUG_ON(!tbl);
5025bce90380STejun Heo 
5026bce90380STejun Heo 	for_each_node(node)
50271be0c25dSTejun Heo 		BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
50281be0c25dSTejun Heo 				node_online(node) ? node : NUMA_NO_NODE));
5029bce90380STejun Heo 
5030bce90380STejun Heo 	for_each_possible_cpu(cpu) {
5031bce90380STejun Heo 		node = cpu_to_node(cpu);
5032bce90380STejun Heo 		if (WARN_ON(node == NUMA_NO_NODE)) {
5033bce90380STejun Heo 			pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5034bce90380STejun Heo 			/* happens iff arch is bonkers, let's just proceed */
5035bce90380STejun Heo 			return;
5036bce90380STejun Heo 		}
5037bce90380STejun Heo 		cpumask_set_cpu(cpu, tbl[node]);
5038bce90380STejun Heo 	}
5039bce90380STejun Heo 
5040bce90380STejun Heo 	wq_numa_possible_cpumask = tbl;
5041bce90380STejun Heo 	wq_numa_enabled = true;
5042bce90380STejun Heo }
5043bce90380STejun Heo 
50446ee0578bSSuresh Siddha static int __init init_workqueues(void)
50451da177e4SLinus Torvalds {
50467a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
50477a4e344cSTejun Heo 	int i, cpu;
5048c34056a3STejun Heo 
5049e904e6c2STejun Heo 	WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5050e904e6c2STejun Heo 
5051e904e6c2STejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5052e904e6c2STejun Heo 
505365758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
5054a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
50558b03ae3cSTejun Heo 
5056bce90380STejun Heo 	wq_numa_init();
5057bce90380STejun Heo 
5058706026c2STejun Heo 	/* initialize CPU pools */
505929c91e99STejun Heo 	for_each_possible_cpu(cpu) {
50604ce62e9eSTejun Heo 		struct worker_pool *pool;
50618b03ae3cSTejun Heo 
50627a4e344cSTejun Heo 		i = 0;
5063f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
50647a4e344cSTejun Heo 			BUG_ON(init_worker_pool(pool));
5065ec22ca5eSTejun Heo 			pool->cpu = cpu;
50667a4e344cSTejun Heo 			cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
50677a4e344cSTejun Heo 			pool->attrs->nice = std_nice[i++];
5068f3f90ad4STejun Heo 			pool->node = cpu_to_node(cpu);
50697a4e344cSTejun Heo 
50709daf9e67STejun Heo 			/* alloc pool ID */
507168e13a67SLai Jiangshan 			mutex_lock(&wq_pool_mutex);
50729daf9e67STejun Heo 			BUG_ON(worker_pool_assign_id(pool));
507368e13a67SLai Jiangshan 			mutex_unlock(&wq_pool_mutex);
50744ce62e9eSTejun Heo 		}
50758b03ae3cSTejun Heo 	}
50768b03ae3cSTejun Heo 
5077e22bee78STejun Heo 	/* create the initial worker */
507829c91e99STejun Heo 	for_each_online_cpu(cpu) {
50794ce62e9eSTejun Heo 		struct worker_pool *pool;
5080e22bee78STejun Heo 
5081f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
508224647570STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
5083ebf44d16STejun Heo 			BUG_ON(create_and_start_worker(pool) < 0);
5084e22bee78STejun Heo 		}
50854ce62e9eSTejun Heo 	}
5086e22bee78STejun Heo 
50878a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
508829c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
508929c91e99STejun Heo 		struct workqueue_attrs *attrs;
509029c91e99STejun Heo 
509129c91e99STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
509229c91e99STejun Heo 		attrs->nice = std_nice[i];
509329c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
50948a2b7538STejun Heo 
50958a2b7538STejun Heo 		/*
50968a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
50978a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
50988a2b7538STejun Heo 		 * Turn off NUMA so that dfl_pwq is used for all nodes.
50998a2b7538STejun Heo 		 */
51008a2b7538STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
51018a2b7538STejun Heo 		attrs->nice = std_nice[i];
51028a2b7538STejun Heo 		attrs->no_numa = true;
51038a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
510429c91e99STejun Heo 	}
510529c91e99STejun Heo 
5106d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
51071aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
5108d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
5109f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5110f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
511124d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
511224d51addSTejun Heo 					      WQ_FREEZABLE, 0);
51130668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
51140668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
51150668106cSViresh Kumar 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
51160668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
51170668106cSViresh Kumar 					      0);
51181aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
51190668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
51200668106cSViresh Kumar 	       !system_power_efficient_wq ||
51210668106cSViresh Kumar 	       !system_freezable_power_efficient_wq);
51226ee0578bSSuresh Siddha 	return 0;
51231da177e4SLinus Torvalds }
51246ee0578bSSuresh Siddha early_initcall(init_workqueues);
5125