xref: /linux-6.15/kernel/workqueue.c (revision ddcb57e2)
11da177e4SLinus Torvalds /*
2c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
31da177e4SLinus Torvalds  *
4c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
51da177e4SLinus Torvalds  *
61da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
71da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
8e1f8e874SFrancois Cami  *     Andrew Morton
91da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
101da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1189ada679SChristoph Lameter  *
12cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
13c54fce6eSTejun Heo  *
14c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
15c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
16c54fce6eSTejun Heo  *
17c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
18c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
19b11895c4SLibin  * automatically managed.  There are two worker pools for each CPU (one for
20b11895c4SLibin  * normal work items and the other for high priority ones) and some extra
21b11895c4SLibin  * pools for workqueues which are not bound to any specific CPU - the
22b11895c4SLibin  * number of these backing pools is dynamic.
23c54fce6eSTejun Heo  *
24c54fce6eSTejun Heo  * Please read Documentation/workqueue.txt for details.
251da177e4SLinus Torvalds  */
261da177e4SLinus Torvalds 
279984de1aSPaul Gortmaker #include <linux/export.h>
281da177e4SLinus Torvalds #include <linux/kernel.h>
291da177e4SLinus Torvalds #include <linux/sched.h>
301da177e4SLinus Torvalds #include <linux/init.h>
311da177e4SLinus Torvalds #include <linux/signal.h>
321da177e4SLinus Torvalds #include <linux/completion.h>
331da177e4SLinus Torvalds #include <linux/workqueue.h>
341da177e4SLinus Torvalds #include <linux/slab.h>
351da177e4SLinus Torvalds #include <linux/cpu.h>
361da177e4SLinus Torvalds #include <linux/notifier.h>
371da177e4SLinus Torvalds #include <linux/kthread.h>
381fa44ecaSJames Bottomley #include <linux/hardirq.h>
3946934023SChristoph Lameter #include <linux/mempolicy.h>
40341a5958SRafael J. Wysocki #include <linux/freezer.h>
41d5abe669SPeter Zijlstra #include <linux/kallsyms.h>
42d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
434e6045f1SJohannes Berg #include <linux/lockdep.h>
44c34056a3STejun Heo #include <linux/idr.h>
4529c91e99STejun Heo #include <linux/jhash.h>
4642f8570fSSasha Levin #include <linux/hashtable.h>
4776af4d93STejun Heo #include <linux/rculist.h>
48bce90380STejun Heo #include <linux/nodemask.h>
494c16bd32STejun Heo #include <linux/moduleparam.h>
503d1cb205STejun Heo #include <linux/uaccess.h>
51e22bee78STejun Heo 
52ea138446STejun Heo #include "workqueue_internal.h"
531da177e4SLinus Torvalds 
54c8e55f36STejun Heo enum {
55bc2ae0f5STejun Heo 	/*
5624647570STejun Heo 	 * worker_pool flags
57bc2ae0f5STejun Heo 	 *
5824647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
59bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
60bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
61bc2ae0f5STejun Heo 	 * is in effect.
62bc2ae0f5STejun Heo 	 *
63bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
64bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
6524647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
66bc2ae0f5STejun Heo 	 *
67bc3a1afcSTejun Heo 	 * Note that DISASSOCIATED should be flipped only while holding
6892f9c5c4SLai Jiangshan 	 * attach_mutex to avoid changing binding state while
694736cbf7SLai Jiangshan 	 * worker_attach_to_pool() is in progress.
70bc2ae0f5STejun Heo 	 */
7124647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
72db7bccf4STejun Heo 
73c8e55f36STejun Heo 	/* worker flags */
74c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
75c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
76e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
77fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
78f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
79a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
80e22bee78STejun Heo 
81a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
82a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
83db7bccf4STejun Heo 
84e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
854ce62e9eSTejun Heo 
8629c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
87c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
88db7bccf4STejun Heo 
89e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
90e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
91e22bee78STejun Heo 
923233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
933233cdbdSTejun Heo 						/* call for help after 10ms
943233cdbdSTejun Heo 						   (min two ticks) */
95e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
96e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
971da177e4SLinus Torvalds 
981da177e4SLinus Torvalds 	/*
99e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
1008698a745SDongsheng Yang 	 * all cpus.  Give MIN_NICE.
101e22bee78STejun Heo 	 */
1028698a745SDongsheng Yang 	RESCUER_NICE_LEVEL	= MIN_NICE,
1038698a745SDongsheng Yang 	HIGHPRI_NICE_LEVEL	= MIN_NICE,
104ecf6881fSTejun Heo 
105ecf6881fSTejun Heo 	WQ_NAME_LEN		= 24,
106c8e55f36STejun Heo };
107c8e55f36STejun Heo 
1081da177e4SLinus Torvalds /*
1094690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1104690c4abSTejun Heo  *
111e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
112e41e704bSTejun Heo  *    everyone else.
1134690c4abSTejun Heo  *
114e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
115e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
116e22bee78STejun Heo  *
117d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1184690c4abSTejun Heo  *
119d565ed63STejun Heo  * X: During normal operation, modification requires pool->lock and should
120d565ed63STejun Heo  *    be done only from local cpu.  Either disabling preemption on local
121d565ed63STejun Heo  *    cpu or grabbing pool->lock is enough for read access.  If
122d565ed63STejun Heo  *    POOL_DISASSOCIATED is set, it's identical to L.
123e22bee78STejun Heo  *
12492f9c5c4SLai Jiangshan  * A: pool->attach_mutex protected.
125822d8405STejun Heo  *
12668e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
12776af4d93STejun Heo  *
12868e13a67SLai Jiangshan  * PR: wq_pool_mutex protected for writes.  Sched-RCU protected for reads.
1295bcab335STejun Heo  *
1303c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1313c25a55dSLai Jiangshan  *
132b5927605SLai Jiangshan  * WR: wq->mutex protected for writes.  Sched-RCU protected for reads.
1332e109a28STejun Heo  *
1342e109a28STejun Heo  * MD: wq_mayday_lock protected.
1354690c4abSTejun Heo  */
1364690c4abSTejun Heo 
1372eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
138c34056a3STejun Heo 
139bd7bdd43STejun Heo struct worker_pool {
140d565ed63STejun Heo 	spinlock_t		lock;		/* the pool lock */
141d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
142f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1439daf9e67STejun Heo 	int			id;		/* I: pool ID */
14411ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
145bd7bdd43STejun Heo 
146bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
147bd7bdd43STejun Heo 	int			nr_workers;	/* L: total number of workers */
148ea1abd61SLai Jiangshan 
149ea1abd61SLai Jiangshan 	/* nr_idle includes the ones off idle_list for rebinding */
150bd7bdd43STejun Heo 	int			nr_idle;	/* L: currently idle ones */
151bd7bdd43STejun Heo 
152bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
153bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
154bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
155bd7bdd43STejun Heo 
156c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
157c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
158c9e7cf27STejun Heo 						/* L: hash of busy workers */
159c9e7cf27STejun Heo 
160bc3a1afcSTejun Heo 	/* see manage_workers() for details on the two manager mutexes */
16134a06bd6STejun Heo 	struct mutex		manager_arb;	/* manager arbitration */
16292f9c5c4SLai Jiangshan 	struct mutex		attach_mutex;	/* attach/detach exclusion */
16392f9c5c4SLai Jiangshan 	struct list_head	workers;	/* A: attached workers */
16460f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
165e19e397aSTejun Heo 
1667cda9aaeSLai Jiangshan 	struct ida		worker_ida;	/* worker IDs for task name */
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 cpumask_var_t *wq_numa_possible_cpumask;
269bce90380STejun Heo 					/* possible CPUs of each node */
270bce90380STejun Heo 
271d55262c4STejun Heo static bool wq_disable_numa;
272d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444);
273d55262c4STejun Heo 
274cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
275cee22a15SViresh Kumar #ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
276cee22a15SViresh Kumar static bool wq_power_efficient = true;
277cee22a15SViresh Kumar #else
278cee22a15SViresh Kumar static bool wq_power_efficient;
279cee22a15SViresh Kumar #endif
280cee22a15SViresh Kumar 
281cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
282cee22a15SViresh Kumar 
283bce90380STejun Heo static bool wq_numa_enabled;		/* unbound NUMA affinity enabled */
284bce90380STejun Heo 
2854c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
2864c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
2874c16bd32STejun Heo 
28868e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
2892e109a28STejun Heo static DEFINE_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
2905bcab335STejun Heo 
29168e13a67SLai Jiangshan static LIST_HEAD(workqueues);		/* PL: list of all workqueues */
29268e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
2937d19c5ceSTejun Heo 
2947d19c5ceSTejun Heo /* the per-cpu worker pools */
2957d19c5ceSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
2967d19c5ceSTejun Heo 				     cpu_worker_pools);
2977d19c5ceSTejun Heo 
29868e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
2997d19c5ceSTejun Heo 
30068e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
30129c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
30229c91e99STejun Heo 
303c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
30429c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
30529c91e99STejun Heo 
3068a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
3078a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
3088a2b7538STejun Heo 
309d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
310ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
311044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
3121aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
313044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
314d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
315044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
316f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
317044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
31824d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
3190668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly;
3200668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
3210668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
3220668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
323d320c038STejun Heo 
3247d19c5ceSTejun Heo static int worker_thread(void *__worker);
3257d19c5ceSTejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
3267d19c5ceSTejun Heo 				 const struct workqueue_attrs *from);
3277d19c5ceSTejun Heo 
32897bd2347STejun Heo #define CREATE_TRACE_POINTS
32997bd2347STejun Heo #include <trace/events/workqueue.h>
33097bd2347STejun Heo 
33168e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
3325bcab335STejun Heo 	rcu_lockdep_assert(rcu_read_lock_sched_held() ||		\
33368e13a67SLai Jiangshan 			   lockdep_is_held(&wq_pool_mutex),		\
33468e13a67SLai Jiangshan 			   "sched RCU or wq_pool_mutex should be held")
3355bcab335STejun Heo 
336b09f4fd3SLai Jiangshan #define assert_rcu_or_wq_mutex(wq)					\
33776af4d93STejun Heo 	rcu_lockdep_assert(rcu_read_lock_sched_held() ||		\
338b5927605SLai Jiangshan 			   lockdep_is_held(&wq->mutex),			\
339b09f4fd3SLai Jiangshan 			   "sched RCU or wq->mutex should be held")
34076af4d93STejun Heo 
341f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
342f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
343f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
3447a62c2c8STejun Heo 	     (pool)++)
3454ce62e9eSTejun Heo 
34649e3cf44STejun Heo /**
34717116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
34817116969STejun Heo  * @pool: iteration cursor
349611c92a0STejun Heo  * @pi: integer used for iteration
350fa1b54e6STejun Heo  *
35168e13a67SLai Jiangshan  * This must be called either with wq_pool_mutex held or sched RCU read
35268e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
35368e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
354fa1b54e6STejun Heo  *
355fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
356fa1b54e6STejun Heo  * ignored.
35717116969STejun Heo  */
358611c92a0STejun Heo #define for_each_pool(pool, pi)						\
359611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
36068e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
361fa1b54e6STejun Heo 		else
36217116969STejun Heo 
36317116969STejun Heo /**
364822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
365822d8405STejun Heo  * @worker: iteration cursor
366822d8405STejun Heo  * @pool: worker_pool to iterate workers of
367822d8405STejun Heo  *
36892f9c5c4SLai Jiangshan  * This must be called with @pool->attach_mutex.
369822d8405STejun Heo  *
370822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
371822d8405STejun Heo  * ignored.
372822d8405STejun Heo  */
373da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
374da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
37592f9c5c4SLai Jiangshan 		if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
376822d8405STejun Heo 		else
377822d8405STejun Heo 
378822d8405STejun Heo /**
37949e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
38049e3cf44STejun Heo  * @pwq: iteration cursor
38149e3cf44STejun Heo  * @wq: the target workqueue
38276af4d93STejun Heo  *
383b09f4fd3SLai Jiangshan  * This must be called either with wq->mutex held or sched RCU read locked.
384794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
385794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
38676af4d93STejun Heo  *
38776af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
38876af4d93STejun Heo  * ignored.
38949e3cf44STejun Heo  */
39049e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
39176af4d93STejun Heo 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node)		\
392b09f4fd3SLai Jiangshan 		if (({ assert_rcu_or_wq_mutex(wq); false; })) { }	\
39376af4d93STejun Heo 		else
394f3421797STejun Heo 
395dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
396dc186ad7SThomas Gleixner 
397dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
398dc186ad7SThomas Gleixner 
39999777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
40099777288SStanislaw Gruszka {
40199777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
40299777288SStanislaw Gruszka }
40399777288SStanislaw Gruszka 
404dc186ad7SThomas Gleixner /*
405dc186ad7SThomas Gleixner  * fixup_init is called when:
406dc186ad7SThomas Gleixner  * - an active object is initialized
407dc186ad7SThomas Gleixner  */
408dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state)
409dc186ad7SThomas Gleixner {
410dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
411dc186ad7SThomas Gleixner 
412dc186ad7SThomas Gleixner 	switch (state) {
413dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
414dc186ad7SThomas Gleixner 		cancel_work_sync(work);
415dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
416dc186ad7SThomas Gleixner 		return 1;
417dc186ad7SThomas Gleixner 	default:
418dc186ad7SThomas Gleixner 		return 0;
419dc186ad7SThomas Gleixner 	}
420dc186ad7SThomas Gleixner }
421dc186ad7SThomas Gleixner 
422dc186ad7SThomas Gleixner /*
423dc186ad7SThomas Gleixner  * fixup_activate is called when:
424dc186ad7SThomas Gleixner  * - an active object is activated
425dc186ad7SThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
426dc186ad7SThomas Gleixner  */
427dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state)
428dc186ad7SThomas Gleixner {
429dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
430dc186ad7SThomas Gleixner 
431dc186ad7SThomas Gleixner 	switch (state) {
432dc186ad7SThomas Gleixner 
433dc186ad7SThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
434dc186ad7SThomas Gleixner 		/*
435dc186ad7SThomas Gleixner 		 * This is not really a fixup. The work struct was
436dc186ad7SThomas Gleixner 		 * statically initialized. We just make sure that it
437dc186ad7SThomas Gleixner 		 * is tracked in the object tracker.
438dc186ad7SThomas Gleixner 		 */
43922df02bbSTejun Heo 		if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
440dc186ad7SThomas Gleixner 			debug_object_init(work, &work_debug_descr);
441dc186ad7SThomas Gleixner 			debug_object_activate(work, &work_debug_descr);
442dc186ad7SThomas Gleixner 			return 0;
443dc186ad7SThomas Gleixner 		}
444dc186ad7SThomas Gleixner 		WARN_ON_ONCE(1);
445dc186ad7SThomas Gleixner 		return 0;
446dc186ad7SThomas Gleixner 
447dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
448dc186ad7SThomas Gleixner 		WARN_ON(1);
449dc186ad7SThomas Gleixner 
450dc186ad7SThomas Gleixner 	default:
451dc186ad7SThomas Gleixner 		return 0;
452dc186ad7SThomas Gleixner 	}
453dc186ad7SThomas Gleixner }
454dc186ad7SThomas Gleixner 
455dc186ad7SThomas Gleixner /*
456dc186ad7SThomas Gleixner  * fixup_free is called when:
457dc186ad7SThomas Gleixner  * - an active object is freed
458dc186ad7SThomas Gleixner  */
459dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state)
460dc186ad7SThomas Gleixner {
461dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
462dc186ad7SThomas Gleixner 
463dc186ad7SThomas Gleixner 	switch (state) {
464dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
465dc186ad7SThomas Gleixner 		cancel_work_sync(work);
466dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
467dc186ad7SThomas Gleixner 		return 1;
468dc186ad7SThomas Gleixner 	default:
469dc186ad7SThomas Gleixner 		return 0;
470dc186ad7SThomas Gleixner 	}
471dc186ad7SThomas Gleixner }
472dc186ad7SThomas Gleixner 
473dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
474dc186ad7SThomas Gleixner 	.name		= "work_struct",
47599777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
476dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
477dc186ad7SThomas Gleixner 	.fixup_activate	= work_fixup_activate,
478dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
479dc186ad7SThomas Gleixner };
480dc186ad7SThomas Gleixner 
481dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
482dc186ad7SThomas Gleixner {
483dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
484dc186ad7SThomas Gleixner }
485dc186ad7SThomas Gleixner 
486dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
487dc186ad7SThomas Gleixner {
488dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
489dc186ad7SThomas Gleixner }
490dc186ad7SThomas Gleixner 
491dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
492dc186ad7SThomas Gleixner {
493dc186ad7SThomas Gleixner 	if (onstack)
494dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
495dc186ad7SThomas Gleixner 	else
496dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
497dc186ad7SThomas Gleixner }
498dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
499dc186ad7SThomas Gleixner 
500dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
501dc186ad7SThomas Gleixner {
502dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
503dc186ad7SThomas Gleixner }
504dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
505dc186ad7SThomas Gleixner 
506ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
507ea2e64f2SThomas Gleixner {
508ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
509ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
510ea2e64f2SThomas Gleixner }
511ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
512ea2e64f2SThomas Gleixner 
513dc186ad7SThomas Gleixner #else
514dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
515dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
516dc186ad7SThomas Gleixner #endif
517dc186ad7SThomas Gleixner 
5184e8b22bdSLi Bin /**
5194e8b22bdSLi Bin  * worker_pool_assign_id - allocate ID and assing it to @pool
5204e8b22bdSLi Bin  * @pool: the pool pointer of interest
5214e8b22bdSLi Bin  *
5224e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
5234e8b22bdSLi Bin  * successfully, -errno on failure.
5244e8b22bdSLi Bin  */
5259daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
5269daf9e67STejun Heo {
5279daf9e67STejun Heo 	int ret;
5289daf9e67STejun Heo 
52968e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5305bcab335STejun Heo 
5314e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
5324e8b22bdSLi Bin 			GFP_KERNEL);
533229641a6STejun Heo 	if (ret >= 0) {
534e68035fbSTejun Heo 		pool->id = ret;
535229641a6STejun Heo 		return 0;
536229641a6STejun Heo 	}
5379daf9e67STejun Heo 	return ret;
5389daf9e67STejun Heo }
5399daf9e67STejun Heo 
54076af4d93STejun Heo /**
541df2d5ae4STejun Heo  * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
542df2d5ae4STejun Heo  * @wq: the target workqueue
543df2d5ae4STejun Heo  * @node: the node ID
544df2d5ae4STejun Heo  *
545df2d5ae4STejun Heo  * This must be called either with pwq_lock held or sched RCU read locked.
546df2d5ae4STejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
547df2d5ae4STejun Heo  * responsible for guaranteeing that the pwq stays online.
548d185af30SYacine Belkadi  *
549d185af30SYacine Belkadi  * Return: The unbound pool_workqueue for @node.
550df2d5ae4STejun Heo  */
551df2d5ae4STejun Heo static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
552df2d5ae4STejun Heo 						  int node)
553df2d5ae4STejun Heo {
554df2d5ae4STejun Heo 	assert_rcu_or_wq_mutex(wq);
555df2d5ae4STejun Heo 	return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
556df2d5ae4STejun Heo }
557df2d5ae4STejun Heo 
55873f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
55973f53c4aSTejun Heo {
56073f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
56173f53c4aSTejun Heo }
56273f53c4aSTejun Heo 
56373f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
56473f53c4aSTejun Heo {
56573f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
56673f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
56773f53c4aSTejun Heo }
56873f53c4aSTejun Heo 
56973f53c4aSTejun Heo static int work_next_color(int color)
57073f53c4aSTejun Heo {
57173f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
572a848e3b6SOleg Nesterov }
573a848e3b6SOleg Nesterov 
5744594bf15SDavid Howells /*
575112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
576112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
5777c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
5787a22ad75STejun Heo  *
579112202d9STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
580112202d9STejun Heo  * and clear_work_data() can be used to set the pwq, pool or clear
581bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
582bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
5837a22ad75STejun Heo  *
584112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
5857c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
586112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
5877c3eed5cSTejun Heo  * available only while the work item is queued.
588bbb68dfaSTejun Heo  *
589bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
590bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
591bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
592bbb68dfaSTejun Heo  * try to steal the PENDING bit.
5934594bf15SDavid Howells  */
5947a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
5957a22ad75STejun Heo 				 unsigned long flags)
5967a22ad75STejun Heo {
5976183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
5987a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
5997a22ad75STejun Heo }
6007a22ad75STejun Heo 
601112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
6024690c4abSTejun Heo 			 unsigned long extra_flags)
603365970a1SDavid Howells {
604112202d9STejun Heo 	set_work_data(work, (unsigned long)pwq,
605112202d9STejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
606365970a1SDavid Howells }
607365970a1SDavid Howells 
6084468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
6094468a00fSLai Jiangshan 					   int pool_id)
6104468a00fSLai Jiangshan {
6114468a00fSLai Jiangshan 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
6124468a00fSLai Jiangshan 		      WORK_STRUCT_PENDING);
6134468a00fSLai Jiangshan }
6144468a00fSLai Jiangshan 
6157c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
6167c3eed5cSTejun Heo 					    int pool_id)
6174d707b9fSOleg Nesterov {
61823657bb1STejun Heo 	/*
61923657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
62023657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
62123657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
62223657bb1STejun Heo 	 * owner.
62323657bb1STejun Heo 	 */
62423657bb1STejun Heo 	smp_wmb();
6257c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
6264d707b9fSOleg Nesterov }
6274d707b9fSOleg Nesterov 
6287a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
629365970a1SDavid Howells {
6307c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
6317c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
6327a22ad75STejun Heo }
6337a22ad75STejun Heo 
634112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
6357a22ad75STejun Heo {
636e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
6377a22ad75STejun Heo 
638112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
639e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
640e120153dSTejun Heo 	else
641e120153dSTejun Heo 		return NULL;
6427a22ad75STejun Heo }
6437a22ad75STejun Heo 
6447c3eed5cSTejun Heo /**
6457c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
6467c3eed5cSTejun Heo  * @work: the work item of interest
6477c3eed5cSTejun Heo  *
64868e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
64968e13a67SLai Jiangshan  * access under sched-RCU read lock.  As such, this function should be
65068e13a67SLai Jiangshan  * called under wq_pool_mutex or with preemption disabled.
651fa1b54e6STejun Heo  *
652fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
653fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
654fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
655fa1b54e6STejun Heo  * returned pool is and stays online.
656d185af30SYacine Belkadi  *
657d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
6587c3eed5cSTejun Heo  */
6597c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
6607a22ad75STejun Heo {
661e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
6627c3eed5cSTejun Heo 	int pool_id;
6637a22ad75STejun Heo 
66468e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
665fa1b54e6STejun Heo 
666112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
667112202d9STejun Heo 		return ((struct pool_workqueue *)
6687c3eed5cSTejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool;
6697a22ad75STejun Heo 
6707c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
6717c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
6727a22ad75STejun Heo 		return NULL;
6737a22ad75STejun Heo 
674fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
6757c3eed5cSTejun Heo }
6767c3eed5cSTejun Heo 
6777c3eed5cSTejun Heo /**
6787c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
6797c3eed5cSTejun Heo  * @work: the work item of interest
6807c3eed5cSTejun Heo  *
681d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
6827c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
6837c3eed5cSTejun Heo  */
6847c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
6857c3eed5cSTejun Heo {
68654d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
6877c3eed5cSTejun Heo 
688112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
689112202d9STejun Heo 		return ((struct pool_workqueue *)
69054d5b7d0SLai Jiangshan 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
69154d5b7d0SLai Jiangshan 
69254d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
6937c3eed5cSTejun Heo }
6947c3eed5cSTejun Heo 
695bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
696bbb68dfaSTejun Heo {
6977c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
698bbb68dfaSTejun Heo 
6997c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
7007c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
701bbb68dfaSTejun Heo }
702bbb68dfaSTejun Heo 
703bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
704bbb68dfaSTejun Heo {
705bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
706bbb68dfaSTejun Heo 
707112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
708bbb68dfaSTejun Heo }
709bbb68dfaSTejun Heo 
710e22bee78STejun Heo /*
7113270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
7123270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
713d565ed63STejun Heo  * they're being called with pool->lock held.
714e22bee78STejun Heo  */
715e22bee78STejun Heo 
71663d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
717649027d7STejun Heo {
718e19e397aSTejun Heo 	return !atomic_read(&pool->nr_running);
719649027d7STejun Heo }
720649027d7STejun Heo 
721e22bee78STejun Heo /*
722e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
723e22bee78STejun Heo  * running workers.
724974271c4STejun Heo  *
725974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
726706026c2STejun Heo  * function will always return %true for unbound pools as long as the
727974271c4STejun Heo  * worklist isn't empty.
728e22bee78STejun Heo  */
72963d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
730e22bee78STejun Heo {
73163d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
732e22bee78STejun Heo }
733e22bee78STejun Heo 
734e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
73563d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
736e22bee78STejun Heo {
73763d95a91STejun Heo 	return pool->nr_idle;
738e22bee78STejun Heo }
739e22bee78STejun Heo 
740e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
74163d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
742e22bee78STejun Heo {
743e19e397aSTejun Heo 	return !list_empty(&pool->worklist) &&
744e19e397aSTejun Heo 		atomic_read(&pool->nr_running) <= 1;
745e22bee78STejun Heo }
746e22bee78STejun Heo 
747e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
74863d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
749e22bee78STejun Heo {
75063d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
751e22bee78STejun Heo }
752e22bee78STejun Heo 
753e22bee78STejun Heo /* Do we have too many workers and should some go away? */
75463d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
755e22bee78STejun Heo {
75634a06bd6STejun Heo 	bool managing = mutex_is_locked(&pool->manager_arb);
75763d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
75863d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
759e22bee78STejun Heo 
760e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
761e22bee78STejun Heo }
762e22bee78STejun Heo 
763e22bee78STejun Heo /*
764e22bee78STejun Heo  * Wake up functions.
765e22bee78STejun Heo  */
766e22bee78STejun Heo 
7671037de36SLai Jiangshan /* Return the first idle worker.  Safe with preemption disabled */
7681037de36SLai Jiangshan static struct worker *first_idle_worker(struct worker_pool *pool)
7697e11629dSTejun Heo {
77063d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
7717e11629dSTejun Heo 		return NULL;
7727e11629dSTejun Heo 
77363d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
7747e11629dSTejun Heo }
7757e11629dSTejun Heo 
7767e11629dSTejun Heo /**
7777e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
77863d95a91STejun Heo  * @pool: worker pool to wake worker from
7797e11629dSTejun Heo  *
78063d95a91STejun Heo  * Wake up the first idle worker of @pool.
7817e11629dSTejun Heo  *
7827e11629dSTejun Heo  * CONTEXT:
783d565ed63STejun Heo  * spin_lock_irq(pool->lock).
7847e11629dSTejun Heo  */
78563d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
7867e11629dSTejun Heo {
7871037de36SLai Jiangshan 	struct worker *worker = first_idle_worker(pool);
7887e11629dSTejun Heo 
7897e11629dSTejun Heo 	if (likely(worker))
7907e11629dSTejun Heo 		wake_up_process(worker->task);
7917e11629dSTejun Heo }
7927e11629dSTejun Heo 
7934690c4abSTejun Heo /**
794e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
795e22bee78STejun Heo  * @task: task waking up
796e22bee78STejun Heo  * @cpu: CPU @task is waking up to
797e22bee78STejun Heo  *
798e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
799e22bee78STejun Heo  * being awoken.
800e22bee78STejun Heo  *
801e22bee78STejun Heo  * CONTEXT:
802e22bee78STejun Heo  * spin_lock_irq(rq->lock)
803e22bee78STejun Heo  */
804d84ff051STejun Heo void wq_worker_waking_up(struct task_struct *task, int cpu)
805e22bee78STejun Heo {
806e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
807e22bee78STejun Heo 
80836576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
809ec22ca5eSTejun Heo 		WARN_ON_ONCE(worker->pool->cpu != cpu);
810e19e397aSTejun Heo 		atomic_inc(&worker->pool->nr_running);
811e22bee78STejun Heo 	}
81236576000SJoonsoo Kim }
813e22bee78STejun Heo 
814e22bee78STejun Heo /**
815e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
816e22bee78STejun Heo  * @task: task going to sleep
817e22bee78STejun Heo  * @cpu: CPU in question, must be the current CPU number
818e22bee78STejun Heo  *
819e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
820e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
821e22bee78STejun Heo  * returning pointer to its task.
822e22bee78STejun Heo  *
823e22bee78STejun Heo  * CONTEXT:
824e22bee78STejun Heo  * spin_lock_irq(rq->lock)
825e22bee78STejun Heo  *
826d185af30SYacine Belkadi  * Return:
827e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
828e22bee78STejun Heo  */
829d84ff051STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
830e22bee78STejun Heo {
831e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
832111c225aSTejun Heo 	struct worker_pool *pool;
833e22bee78STejun Heo 
834111c225aSTejun Heo 	/*
835111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
836111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
837111c225aSTejun Heo 	 * checking NOT_RUNNING.
838111c225aSTejun Heo 	 */
8392d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
840e22bee78STejun Heo 		return NULL;
841e22bee78STejun Heo 
842111c225aSTejun Heo 	pool = worker->pool;
843111c225aSTejun Heo 
844e22bee78STejun Heo 	/* this can only happen on the local cpu */
84592b69f50SLai Jiangshan 	if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
8466183c009STejun Heo 		return NULL;
847e22bee78STejun Heo 
848e22bee78STejun Heo 	/*
849e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
850e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
851e22bee78STejun Heo 	 * Please read comment there.
852e22bee78STejun Heo 	 *
853628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
854628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
855628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
856d565ed63STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without pool
857628c78e7STejun Heo 	 * lock is safe.
858e22bee78STejun Heo 	 */
859e19e397aSTejun Heo 	if (atomic_dec_and_test(&pool->nr_running) &&
860e19e397aSTejun Heo 	    !list_empty(&pool->worklist))
8611037de36SLai Jiangshan 		to_wakeup = first_idle_worker(pool);
862e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
863e22bee78STejun Heo }
864e22bee78STejun Heo 
865e22bee78STejun Heo /**
866e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
867cb444766STejun Heo  * @worker: self
868d302f017STejun Heo  * @flags: flags to set
869d302f017STejun Heo  *
870228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
871d302f017STejun Heo  *
872cb444766STejun Heo  * CONTEXT:
873d565ed63STejun Heo  * spin_lock_irq(pool->lock)
874d302f017STejun Heo  */
875228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
876d302f017STejun Heo {
877bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
878e22bee78STejun Heo 
879cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
880cb444766STejun Heo 
881228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
882e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
883e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
884e19e397aSTejun Heo 		atomic_dec(&pool->nr_running);
885e22bee78STejun Heo 	}
886e22bee78STejun Heo 
887d302f017STejun Heo 	worker->flags |= flags;
888d302f017STejun Heo }
889d302f017STejun Heo 
890d302f017STejun Heo /**
891e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
892cb444766STejun Heo  * @worker: self
893d302f017STejun Heo  * @flags: flags to clear
894d302f017STejun Heo  *
895e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
896d302f017STejun Heo  *
897cb444766STejun Heo  * CONTEXT:
898d565ed63STejun Heo  * spin_lock_irq(pool->lock)
899d302f017STejun Heo  */
900d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
901d302f017STejun Heo {
90263d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
903e22bee78STejun Heo 	unsigned int oflags = worker->flags;
904e22bee78STejun Heo 
905cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
906cb444766STejun Heo 
907d302f017STejun Heo 	worker->flags &= ~flags;
908e22bee78STejun Heo 
90942c025f3STejun Heo 	/*
91042c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
91142c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
91242c025f3STejun Heo 	 * of multiple flags, not a single flag.
91342c025f3STejun Heo 	 */
914e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
915e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
916e19e397aSTejun Heo 			atomic_inc(&pool->nr_running);
917d302f017STejun Heo }
918d302f017STejun Heo 
919d302f017STejun Heo /**
9208cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
921c9e7cf27STejun Heo  * @pool: pool of interest
9228cca0eeaSTejun Heo  * @work: work to find worker for
9238cca0eeaSTejun Heo  *
924c9e7cf27STejun Heo  * Find a worker which is executing @work on @pool by searching
925c9e7cf27STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
926a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
927a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
928a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
929a2c1c57bSTejun Heo  * being executed.
930a2c1c57bSTejun Heo  *
931a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
932a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
933a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
934a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
935a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
936a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
937a2c1c57bSTejun Heo  *
938c5aa87bbSTejun Heo  * This function checks the work item address and work function to avoid
939c5aa87bbSTejun Heo  * false positives.  Note that this isn't complete as one may construct a
940c5aa87bbSTejun Heo  * work function which can introduce dependency onto itself through a
941c5aa87bbSTejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
942c5aa87bbSTejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
943c5aa87bbSTejun Heo  * actually occurs, it should be easy to locate the culprit work function.
9448cca0eeaSTejun Heo  *
9458cca0eeaSTejun Heo  * CONTEXT:
946d565ed63STejun Heo  * spin_lock_irq(pool->lock).
9478cca0eeaSTejun Heo  *
948d185af30SYacine Belkadi  * Return:
949d185af30SYacine Belkadi  * Pointer to worker which is executing @work if found, %NULL
9508cca0eeaSTejun Heo  * otherwise.
9518cca0eeaSTejun Heo  */
952c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
9538cca0eeaSTejun Heo 						 struct work_struct *work)
9548cca0eeaSTejun Heo {
95542f8570fSSasha Levin 	struct worker *worker;
95642f8570fSSasha Levin 
957b67bfe0dSSasha Levin 	hash_for_each_possible(pool->busy_hash, worker, hentry,
958a2c1c57bSTejun Heo 			       (unsigned long)work)
959a2c1c57bSTejun Heo 		if (worker->current_work == work &&
960a2c1c57bSTejun Heo 		    worker->current_func == work->func)
96142f8570fSSasha Levin 			return worker;
96242f8570fSSasha Levin 
96342f8570fSSasha Levin 	return NULL;
9648cca0eeaSTejun Heo }
9658cca0eeaSTejun Heo 
9668cca0eeaSTejun Heo /**
967bf4ede01STejun Heo  * move_linked_works - move linked works to a list
968bf4ede01STejun Heo  * @work: start of series of works to be scheduled
969bf4ede01STejun Heo  * @head: target list to append @work to
970bf4ede01STejun Heo  * @nextp: out paramter for nested worklist walking
971bf4ede01STejun Heo  *
972bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
973bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
974bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
975bf4ede01STejun Heo  *
976bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
977bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
978bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
979bf4ede01STejun Heo  *
980bf4ede01STejun Heo  * CONTEXT:
981d565ed63STejun Heo  * spin_lock_irq(pool->lock).
982bf4ede01STejun Heo  */
983bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
984bf4ede01STejun Heo 			      struct work_struct **nextp)
985bf4ede01STejun Heo {
986bf4ede01STejun Heo 	struct work_struct *n;
987bf4ede01STejun Heo 
988bf4ede01STejun Heo 	/*
989bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
990bf4ede01STejun Heo 	 * use NULL for list head.
991bf4ede01STejun Heo 	 */
992bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
993bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
994bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
995bf4ede01STejun Heo 			break;
996bf4ede01STejun Heo 	}
997bf4ede01STejun Heo 
998bf4ede01STejun Heo 	/*
999bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
1000bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
1001bf4ede01STejun Heo 	 * needs to be updated.
1002bf4ede01STejun Heo 	 */
1003bf4ede01STejun Heo 	if (nextp)
1004bf4ede01STejun Heo 		*nextp = n;
1005bf4ede01STejun Heo }
1006bf4ede01STejun Heo 
10078864b4e5STejun Heo /**
10088864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
10098864b4e5STejun Heo  * @pwq: pool_workqueue to get
10108864b4e5STejun Heo  *
10118864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
10128864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
10138864b4e5STejun Heo  */
10148864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
10158864b4e5STejun Heo {
10168864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
10178864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
10188864b4e5STejun Heo 	pwq->refcnt++;
10198864b4e5STejun Heo }
10208864b4e5STejun Heo 
10218864b4e5STejun Heo /**
10228864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
10238864b4e5STejun Heo  * @pwq: pool_workqueue to put
10248864b4e5STejun Heo  *
10258864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
10268864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
10278864b4e5STejun Heo  */
10288864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
10298864b4e5STejun Heo {
10308864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
10318864b4e5STejun Heo 	if (likely(--pwq->refcnt))
10328864b4e5STejun Heo 		return;
10338864b4e5STejun Heo 	if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
10348864b4e5STejun Heo 		return;
10358864b4e5STejun Heo 	/*
10368864b4e5STejun Heo 	 * @pwq can't be released under pool->lock, bounce to
10378864b4e5STejun Heo 	 * pwq_unbound_release_workfn().  This never recurses on the same
10388864b4e5STejun Heo 	 * pool->lock as this path is taken only for unbound workqueues and
10398864b4e5STejun Heo 	 * the release work item is scheduled on a per-cpu workqueue.  To
10408864b4e5STejun Heo 	 * avoid lockdep warning, unbound pool->locks are given lockdep
10418864b4e5STejun Heo 	 * subclass of 1 in get_unbound_pool().
10428864b4e5STejun Heo 	 */
10438864b4e5STejun Heo 	schedule_work(&pwq->unbound_release_work);
10448864b4e5STejun Heo }
10458864b4e5STejun Heo 
1046dce90d47STejun Heo /**
1047dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1048dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1049dce90d47STejun Heo  *
1050dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1051dce90d47STejun Heo  */
1052dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1053dce90d47STejun Heo {
1054dce90d47STejun Heo 	if (pwq) {
1055dce90d47STejun Heo 		/*
1056dce90d47STejun Heo 		 * As both pwqs and pools are sched-RCU protected, the
1057dce90d47STejun Heo 		 * following lock operations are safe.
1058dce90d47STejun Heo 		 */
1059dce90d47STejun Heo 		spin_lock_irq(&pwq->pool->lock);
1060dce90d47STejun Heo 		put_pwq(pwq);
1061dce90d47STejun Heo 		spin_unlock_irq(&pwq->pool->lock);
1062dce90d47STejun Heo 	}
1063dce90d47STejun Heo }
1064dce90d47STejun Heo 
1065112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work)
1066bf4ede01STejun Heo {
1067112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1068bf4ede01STejun Heo 
1069bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
1070112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
1071bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1072112202d9STejun Heo 	pwq->nr_active++;
1073bf4ede01STejun Heo }
1074bf4ede01STejun Heo 
1075112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
10763aa62497SLai Jiangshan {
1077112202d9STejun Heo 	struct work_struct *work = list_first_entry(&pwq->delayed_works,
10783aa62497SLai Jiangshan 						    struct work_struct, entry);
10793aa62497SLai Jiangshan 
1080112202d9STejun Heo 	pwq_activate_delayed_work(work);
10813aa62497SLai Jiangshan }
10823aa62497SLai Jiangshan 
1083bf4ede01STejun Heo /**
1084112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1085112202d9STejun Heo  * @pwq: pwq of interest
1086bf4ede01STejun Heo  * @color: color of work which left the queue
1087bf4ede01STejun Heo  *
1088bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1089112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1090bf4ede01STejun Heo  *
1091bf4ede01STejun Heo  * CONTEXT:
1092d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1093bf4ede01STejun Heo  */
1094112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1095bf4ede01STejun Heo {
10968864b4e5STejun Heo 	/* uncolored work items don't participate in flushing or nr_active */
1097bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
10988864b4e5STejun Heo 		goto out_put;
1099bf4ede01STejun Heo 
1100112202d9STejun Heo 	pwq->nr_in_flight[color]--;
1101bf4ede01STejun Heo 
1102112202d9STejun Heo 	pwq->nr_active--;
1103112202d9STejun Heo 	if (!list_empty(&pwq->delayed_works)) {
1104bf4ede01STejun Heo 		/* one down, submit a delayed one */
1105112202d9STejun Heo 		if (pwq->nr_active < pwq->max_active)
1106112202d9STejun Heo 			pwq_activate_first_delayed(pwq);
1107bf4ede01STejun Heo 	}
1108bf4ede01STejun Heo 
1109bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1110112202d9STejun Heo 	if (likely(pwq->flush_color != color))
11118864b4e5STejun Heo 		goto out_put;
1112bf4ede01STejun Heo 
1113bf4ede01STejun Heo 	/* are there still in-flight works? */
1114112202d9STejun Heo 	if (pwq->nr_in_flight[color])
11158864b4e5STejun Heo 		goto out_put;
1116bf4ede01STejun Heo 
1117112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1118112202d9STejun Heo 	pwq->flush_color = -1;
1119bf4ede01STejun Heo 
1120bf4ede01STejun Heo 	/*
1121112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1122bf4ede01STejun Heo 	 * will handle the rest.
1123bf4ede01STejun Heo 	 */
1124112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1125112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
11268864b4e5STejun Heo out_put:
11278864b4e5STejun Heo 	put_pwq(pwq);
1128bf4ede01STejun Heo }
1129bf4ede01STejun Heo 
113036e227d2STejun Heo /**
1131bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
113236e227d2STejun Heo  * @work: work item to steal
113336e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1134bbb68dfaSTejun Heo  * @flags: place to store irq state
113536e227d2STejun Heo  *
113636e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
1137d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
113836e227d2STejun Heo  *
1139d185af30SYacine Belkadi  * Return:
114036e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
114136e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
114236e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1143bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1144bbb68dfaSTejun Heo  *		for arbitrarily long
114536e227d2STejun Heo  *
1146d185af30SYacine Belkadi  * Note:
1147bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1148e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1149e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1150e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1151bbb68dfaSTejun Heo  *
1152bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1153bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1154bbb68dfaSTejun Heo  *
1155e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1156bf4ede01STejun Heo  */
1157bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1158bbb68dfaSTejun Heo 			       unsigned long *flags)
1159bf4ede01STejun Heo {
1160d565ed63STejun Heo 	struct worker_pool *pool;
1161112202d9STejun Heo 	struct pool_workqueue *pwq;
1162bf4ede01STejun Heo 
1163bbb68dfaSTejun Heo 	local_irq_save(*flags);
1164bbb68dfaSTejun Heo 
116536e227d2STejun Heo 	/* try to steal the timer if it exists */
116636e227d2STejun Heo 	if (is_dwork) {
116736e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
116836e227d2STejun Heo 
1169e0aecdd8STejun Heo 		/*
1170e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1171e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1172e0aecdd8STejun Heo 		 * running on the local CPU.
1173e0aecdd8STejun Heo 		 */
117436e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
117536e227d2STejun Heo 			return 1;
117636e227d2STejun Heo 	}
117736e227d2STejun Heo 
117836e227d2STejun Heo 	/* try to claim PENDING the normal way */
1179bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1180bf4ede01STejun Heo 		return 0;
1181bf4ede01STejun Heo 
1182bf4ede01STejun Heo 	/*
1183bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1184bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1185bf4ede01STejun Heo 	 */
1186d565ed63STejun Heo 	pool = get_work_pool(work);
1187d565ed63STejun Heo 	if (!pool)
1188bbb68dfaSTejun Heo 		goto fail;
1189bf4ede01STejun Heo 
1190d565ed63STejun Heo 	spin_lock(&pool->lock);
1191bf4ede01STejun Heo 	/*
1192112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
1193112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
1194112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
1195112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
1196112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
11970b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
1198bf4ede01STejun Heo 	 */
1199112202d9STejun Heo 	pwq = get_work_pwq(work);
1200112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
1201bf4ede01STejun Heo 		debug_work_deactivate(work);
12023aa62497SLai Jiangshan 
12033aa62497SLai Jiangshan 		/*
120416062836STejun Heo 		 * A delayed work item cannot be grabbed directly because
120516062836STejun Heo 		 * it might have linked NO_COLOR work items which, if left
1206112202d9STejun Heo 		 * on the delayed_list, will confuse pwq->nr_active
120716062836STejun Heo 		 * management later on and cause stall.  Make sure the work
120816062836STejun Heo 		 * item is activated before grabbing.
12093aa62497SLai Jiangshan 		 */
12103aa62497SLai Jiangshan 		if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1211112202d9STejun Heo 			pwq_activate_delayed_work(work);
12123aa62497SLai Jiangshan 
1213bf4ede01STejun Heo 		list_del_init(&work->entry);
12149c34a704SLai Jiangshan 		pwq_dec_nr_in_flight(pwq, get_work_color(work));
121536e227d2STejun Heo 
1216112202d9STejun Heo 		/* work->data points to pwq iff queued, point to pool */
12174468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
12184468a00fSLai Jiangshan 
1219d565ed63STejun Heo 		spin_unlock(&pool->lock);
122036e227d2STejun Heo 		return 1;
1221bf4ede01STejun Heo 	}
1222d565ed63STejun Heo 	spin_unlock(&pool->lock);
1223bbb68dfaSTejun Heo fail:
1224bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1225bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1226bbb68dfaSTejun Heo 		return -ENOENT;
1227bbb68dfaSTejun Heo 	cpu_relax();
122836e227d2STejun Heo 	return -EAGAIN;
1229bf4ede01STejun Heo }
1230bf4ede01STejun Heo 
1231bf4ede01STejun Heo /**
1232706026c2STejun Heo  * insert_work - insert a work into a pool
1233112202d9STejun Heo  * @pwq: pwq @work belongs to
12344690c4abSTejun Heo  * @work: work to insert
12354690c4abSTejun Heo  * @head: insertion point
12364690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
12374690c4abSTejun Heo  *
1238112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
1239706026c2STejun Heo  * work_struct flags.
12404690c4abSTejun Heo  *
12414690c4abSTejun Heo  * CONTEXT:
1242d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1243365970a1SDavid Howells  */
1244112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1245112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
1246b89deed3SOleg Nesterov {
1247112202d9STejun Heo 	struct worker_pool *pool = pwq->pool;
1248e1d8aa9fSFrederic Weisbecker 
12494690c4abSTejun Heo 	/* we own @work, set data and link */
1250112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
12511a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
12528864b4e5STejun Heo 	get_pwq(pwq);
1253e22bee78STejun Heo 
1254e22bee78STejun Heo 	/*
1255c5aa87bbSTejun Heo 	 * Ensure either wq_worker_sleeping() sees the above
1256c5aa87bbSTejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers lying
1257c5aa87bbSTejun Heo 	 * around lazily while there are works to be processed.
1258e22bee78STejun Heo 	 */
1259e22bee78STejun Heo 	smp_mb();
1260e22bee78STejun Heo 
126163d95a91STejun Heo 	if (__need_more_worker(pool))
126263d95a91STejun Heo 		wake_up_worker(pool);
1263b89deed3SOleg Nesterov }
1264b89deed3SOleg Nesterov 
1265c8efcc25STejun Heo /*
1266c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
12678d03ecfeSTejun Heo  * same workqueue.
1268c8efcc25STejun Heo  */
1269c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1270c8efcc25STejun Heo {
1271c8efcc25STejun Heo 	struct worker *worker;
1272c8efcc25STejun Heo 
12738d03ecfeSTejun Heo 	worker = current_wq_worker();
1274c8efcc25STejun Heo 	/*
12758d03ecfeSTejun Heo 	 * Return %true iff I'm a worker execuing a work item on @wq.  If
12768d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
1277c8efcc25STejun Heo 	 */
1278112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
1279c8efcc25STejun Heo }
1280c8efcc25STejun Heo 
1281d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
12821da177e4SLinus Torvalds 			 struct work_struct *work)
12831da177e4SLinus Torvalds {
1284112202d9STejun Heo 	struct pool_workqueue *pwq;
1285c9178087STejun Heo 	struct worker_pool *last_pool;
12861e19ffc6STejun Heo 	struct list_head *worklist;
12878a2e8e5dSTejun Heo 	unsigned int work_flags;
1288b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
12898930cabaSTejun Heo 
12908930cabaSTejun Heo 	/*
12918930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
12928930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
12938930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
12948930cabaSTejun Heo 	 * happen with IRQ disabled.
12958930cabaSTejun Heo 	 */
12968930cabaSTejun Heo 	WARN_ON_ONCE(!irqs_disabled());
12971da177e4SLinus Torvalds 
1298dc186ad7SThomas Gleixner 	debug_work_activate(work);
12991e19ffc6STejun Heo 
13009ef28a73SLi Bin 	/* if draining, only works from the same workqueue are allowed */
1301618b01ebSTejun Heo 	if (unlikely(wq->flags & __WQ_DRAINING) &&
1302c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1303e41e704bSTejun Heo 		return;
13049e8cd2f5STejun Heo retry:
1305df2d5ae4STejun Heo 	if (req_cpu == WORK_CPU_UNBOUND)
1306f3421797STejun Heo 		cpu = raw_smp_processor_id();
1307df2d5ae4STejun Heo 
1308df2d5ae4STejun Heo 	/* pwq which will be used unless @work is executing elsewhere */
1309df2d5ae4STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
1310c9178087STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1311df2d5ae4STejun Heo 	else
1312df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1313f3421797STejun Heo 
131418aa9effSTejun Heo 	/*
1315c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
1316c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
1317c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
131818aa9effSTejun Heo 	 */
1319c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
1320112202d9STejun Heo 	if (last_pool && last_pool != pwq->pool) {
132118aa9effSTejun Heo 		struct worker *worker;
132218aa9effSTejun Heo 
1323d565ed63STejun Heo 		spin_lock(&last_pool->lock);
132418aa9effSTejun Heo 
1325c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
132618aa9effSTejun Heo 
1327112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
1328c9178087STejun Heo 			pwq = worker->current_pwq;
13298594fadeSLai Jiangshan 		} else {
133018aa9effSTejun Heo 			/* meh... not running there, queue here */
1331d565ed63STejun Heo 			spin_unlock(&last_pool->lock);
1332112202d9STejun Heo 			spin_lock(&pwq->pool->lock);
133318aa9effSTejun Heo 		}
13348930cabaSTejun Heo 	} else {
1335112202d9STejun Heo 		spin_lock(&pwq->pool->lock);
13368930cabaSTejun Heo 	}
1337502ca9d8STejun Heo 
13389e8cd2f5STejun Heo 	/*
13399e8cd2f5STejun Heo 	 * pwq is determined and locked.  For unbound pools, we could have
13409e8cd2f5STejun Heo 	 * raced with pwq release and it could already be dead.  If its
13419e8cd2f5STejun Heo 	 * refcnt is zero, repeat pwq selection.  Note that pwqs never die
1342df2d5ae4STejun Heo 	 * without another pwq replacing it in the numa_pwq_tbl or while
1343df2d5ae4STejun Heo 	 * work items are executing on it, so the retrying is guaranteed to
13449e8cd2f5STejun Heo 	 * make forward-progress.
13459e8cd2f5STejun Heo 	 */
13469e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
13479e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
13489e8cd2f5STejun Heo 			spin_unlock(&pwq->pool->lock);
13499e8cd2f5STejun Heo 			cpu_relax();
13509e8cd2f5STejun Heo 			goto retry;
13519e8cd2f5STejun Heo 		}
13529e8cd2f5STejun Heo 		/* oops */
13539e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
13549e8cd2f5STejun Heo 			  wq->name, cpu);
13559e8cd2f5STejun Heo 	}
13569e8cd2f5STejun Heo 
1357112202d9STejun Heo 	/* pwq determined, queue */
1358112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
1359502ca9d8STejun Heo 
1360f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1361112202d9STejun Heo 		spin_unlock(&pwq->pool->lock);
1362f5b2552bSDan Carpenter 		return;
1363f5b2552bSDan Carpenter 	}
13641e19ffc6STejun Heo 
1365112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
1366112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
13671e19ffc6STejun Heo 
1368112202d9STejun Heo 	if (likely(pwq->nr_active < pwq->max_active)) {
1369cdadf009STejun Heo 		trace_workqueue_activate_work(work);
1370112202d9STejun Heo 		pwq->nr_active++;
1371112202d9STejun Heo 		worklist = &pwq->pool->worklist;
13728a2e8e5dSTejun Heo 	} else {
13738a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
1374112202d9STejun Heo 		worklist = &pwq->delayed_works;
13758a2e8e5dSTejun Heo 	}
13761e19ffc6STejun Heo 
1377112202d9STejun Heo 	insert_work(pwq, work, worklist, work_flags);
13781e19ffc6STejun Heo 
1379112202d9STejun Heo 	spin_unlock(&pwq->pool->lock);
13801da177e4SLinus Torvalds }
13811da177e4SLinus Torvalds 
13820fcb78c2SRolf Eike Beer /**
1383c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1384c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1385c1a220e7SZhang Rui  * @wq: workqueue to use
1386c1a220e7SZhang Rui  * @work: work to queue
1387c1a220e7SZhang Rui  *
1388c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1389c1a220e7SZhang Rui  * can't go away.
1390d185af30SYacine Belkadi  *
1391d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
1392c1a220e7SZhang Rui  */
1393d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1394d4283e93STejun Heo 		   struct work_struct *work)
1395c1a220e7SZhang Rui {
1396d4283e93STejun Heo 	bool ret = false;
13978930cabaSTejun Heo 	unsigned long flags;
13988930cabaSTejun Heo 
13998930cabaSTejun Heo 	local_irq_save(flags);
1400c1a220e7SZhang Rui 
140122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14024690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1403d4283e93STejun Heo 		ret = true;
1404c1a220e7SZhang Rui 	}
14058930cabaSTejun Heo 
14068930cabaSTejun Heo 	local_irq_restore(flags);
1407c1a220e7SZhang Rui 	return ret;
1408c1a220e7SZhang Rui }
1409ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
1410c1a220e7SZhang Rui 
1411d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data)
14121da177e4SLinus Torvalds {
141352bad64dSDavid Howells 	struct delayed_work *dwork = (struct delayed_work *)__data;
14141da177e4SLinus Torvalds 
1415e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
141660c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
14171da177e4SLinus Torvalds }
14181438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
14191da177e4SLinus Torvalds 
14207beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
142152bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
14221da177e4SLinus Torvalds {
14237beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
14247beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
14251da177e4SLinus Torvalds 
14267beb2edfSTejun Heo 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
14277beb2edfSTejun Heo 		     timer->data != (unsigned long)dwork);
1428fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1429fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
14307beb2edfSTejun Heo 
14318852aac2STejun Heo 	/*
14328852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
14338852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
14348852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
14358852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
14368852aac2STejun Heo 	 */
14378852aac2STejun Heo 	if (!delay) {
14388852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
14398852aac2STejun Heo 		return;
14408852aac2STejun Heo 	}
14418852aac2STejun Heo 
14427beb2edfSTejun Heo 	timer_stats_timer_set_start_info(&dwork->timer);
14437beb2edfSTejun Heo 
144460c057bcSLai Jiangshan 	dwork->wq = wq;
14451265057fSTejun Heo 	dwork->cpu = cpu;
14467beb2edfSTejun Heo 	timer->expires = jiffies + delay;
14477beb2edfSTejun Heo 
14487beb2edfSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
14497beb2edfSTejun Heo 		add_timer_on(timer, cpu);
14507beb2edfSTejun Heo 	else
14517beb2edfSTejun Heo 		add_timer(timer);
14527beb2edfSTejun Heo }
14531da177e4SLinus Torvalds 
14540fcb78c2SRolf Eike Beer /**
14550fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
14560fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
14570fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1458af9997e4SRandy Dunlap  * @dwork: work to queue
14590fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
14600fcb78c2SRolf Eike Beer  *
1461d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
1462715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1463715f1300STejun Heo  * execution.
14640fcb78c2SRolf Eike Beer  */
1465d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
146652bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
14677a6bc1cdSVenkatesh Pallipadi {
146852bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1469d4283e93STejun Heo 	bool ret = false;
14708930cabaSTejun Heo 	unsigned long flags;
14718930cabaSTejun Heo 
14728930cabaSTejun Heo 	/* read the comment in __queue_work() */
14738930cabaSTejun Heo 	local_irq_save(flags);
14747a6bc1cdSVenkatesh Pallipadi 
147522df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
14767beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1477d4283e93STejun Heo 		ret = true;
14787a6bc1cdSVenkatesh Pallipadi 	}
14798930cabaSTejun Heo 
14808930cabaSTejun Heo 	local_irq_restore(flags);
14817a6bc1cdSVenkatesh Pallipadi 	return ret;
14827a6bc1cdSVenkatesh Pallipadi }
1483ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
14841da177e4SLinus Torvalds 
1485c8e55f36STejun Heo /**
14868376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
14878376fe22STejun Heo  * @cpu: CPU number to execute work on
14888376fe22STejun Heo  * @wq: workqueue to use
14898376fe22STejun Heo  * @dwork: work to queue
14908376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
14918376fe22STejun Heo  *
14928376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
14938376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
14948376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
14958376fe22STejun Heo  * current state.
14968376fe22STejun Heo  *
1497d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
14988376fe22STejun Heo  * pending and its timer was modified.
14998376fe22STejun Heo  *
1500e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
15018376fe22STejun Heo  * See try_to_grab_pending() for details.
15028376fe22STejun Heo  */
15038376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
15048376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
15058376fe22STejun Heo {
15068376fe22STejun Heo 	unsigned long flags;
15078376fe22STejun Heo 	int ret;
15088376fe22STejun Heo 
15098376fe22STejun Heo 	do {
15108376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
15118376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
15128376fe22STejun Heo 
15138376fe22STejun Heo 	if (likely(ret >= 0)) {
15148376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
15158376fe22STejun Heo 		local_irq_restore(flags);
15168376fe22STejun Heo 	}
15178376fe22STejun Heo 
15188376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
15198376fe22STejun Heo 	return ret;
15208376fe22STejun Heo }
15218376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
15228376fe22STejun Heo 
15238376fe22STejun Heo /**
1524c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1525c8e55f36STejun Heo  * @worker: worker which is entering idle state
1526c8e55f36STejun Heo  *
1527c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1528c8e55f36STejun Heo  * necessary.
1529c8e55f36STejun Heo  *
1530c8e55f36STejun Heo  * LOCKING:
1531d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1532c8e55f36STejun Heo  */
1533c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
15341da177e4SLinus Torvalds {
1535bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1536c8e55f36STejun Heo 
15376183c009STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
15386183c009STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
15396183c009STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
15406183c009STejun Heo 		return;
1541c8e55f36STejun Heo 
1542051e1850SLai Jiangshan 	/* can't use worker_set_flags(), also called from create_worker() */
1543cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1544bd7bdd43STejun Heo 	pool->nr_idle++;
1545e22bee78STejun Heo 	worker->last_active = jiffies;
1546c8e55f36STejun Heo 
1547c8e55f36STejun Heo 	/* idle_list is LIFO */
1548bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1549db7bccf4STejun Heo 
155063d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1551628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1552cb444766STejun Heo 
1553544ecf31STejun Heo 	/*
1554706026c2STejun Heo 	 * Sanity check nr_running.  Because wq_unbind_fn() releases
1555d565ed63STejun Heo 	 * pool->lock between setting %WORKER_UNBOUND and zapping
1556628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1557628c78e7STejun Heo 	 * unbind is not in progress.
1558544ecf31STejun Heo 	 */
155924647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1560bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
1561e19e397aSTejun Heo 		     atomic_read(&pool->nr_running));
1562c8e55f36STejun Heo }
1563c8e55f36STejun Heo 
1564c8e55f36STejun Heo /**
1565c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1566c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1567c8e55f36STejun Heo  *
1568c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1569c8e55f36STejun Heo  *
1570c8e55f36STejun Heo  * LOCKING:
1571d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1572c8e55f36STejun Heo  */
1573c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1574c8e55f36STejun Heo {
1575bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1576c8e55f36STejun Heo 
15776183c009STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
15786183c009STejun Heo 		return;
1579d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1580bd7bdd43STejun Heo 	pool->nr_idle--;
1581c8e55f36STejun Heo 	list_del_init(&worker->entry);
1582c8e55f36STejun Heo }
1583c8e55f36STejun Heo 
1584f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
1585c34056a3STejun Heo {
1586c34056a3STejun Heo 	struct worker *worker;
1587c34056a3STejun Heo 
1588f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
1589c8e55f36STejun Heo 	if (worker) {
1590c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1591affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1592da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
1593e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1594e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1595c8e55f36STejun Heo 	}
1596c34056a3STejun Heo 	return worker;
1597c34056a3STejun Heo }
1598c34056a3STejun Heo 
1599c34056a3STejun Heo /**
16004736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
16014736cbf7SLai Jiangshan  * @worker: worker to be attached
16024736cbf7SLai Jiangshan  * @pool: the target pool
16034736cbf7SLai Jiangshan  *
16044736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
16054736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
16064736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
16074736cbf7SLai Jiangshan  */
16084736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
16094736cbf7SLai Jiangshan 				   struct worker_pool *pool)
16104736cbf7SLai Jiangshan {
16114736cbf7SLai Jiangshan 	mutex_lock(&pool->attach_mutex);
16124736cbf7SLai Jiangshan 
16134736cbf7SLai Jiangshan 	/*
16144736cbf7SLai Jiangshan 	 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
16154736cbf7SLai Jiangshan 	 * online CPUs.  It'll be re-applied when any of the CPUs come up.
16164736cbf7SLai Jiangshan 	 */
16174736cbf7SLai Jiangshan 	set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
16184736cbf7SLai Jiangshan 
16194736cbf7SLai Jiangshan 	/*
16204736cbf7SLai Jiangshan 	 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
16214736cbf7SLai Jiangshan 	 * stable across this function.  See the comments above the
16224736cbf7SLai Jiangshan 	 * flag definition for details.
16234736cbf7SLai Jiangshan 	 */
16244736cbf7SLai Jiangshan 	if (pool->flags & POOL_DISASSOCIATED)
16254736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
16264736cbf7SLai Jiangshan 
16274736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
16284736cbf7SLai Jiangshan 
16294736cbf7SLai Jiangshan 	mutex_unlock(&pool->attach_mutex);
16304736cbf7SLai Jiangshan }
16314736cbf7SLai Jiangshan 
16324736cbf7SLai Jiangshan /**
163360f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
163460f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
163560f5a4bcSLai Jiangshan  * @pool: the pool @worker is attached to
163660f5a4bcSLai Jiangshan  *
16374736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
16384736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
16394736cbf7SLai Jiangshan  * other reference to the pool.
164060f5a4bcSLai Jiangshan  */
164160f5a4bcSLai Jiangshan static void worker_detach_from_pool(struct worker *worker,
164260f5a4bcSLai Jiangshan 				    struct worker_pool *pool)
164360f5a4bcSLai Jiangshan {
164460f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
164560f5a4bcSLai Jiangshan 
164692f9c5c4SLai Jiangshan 	mutex_lock(&pool->attach_mutex);
1647da028469SLai Jiangshan 	list_del(&worker->node);
1648da028469SLai Jiangshan 	if (list_empty(&pool->workers))
164960f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
165092f9c5c4SLai Jiangshan 	mutex_unlock(&pool->attach_mutex);
165160f5a4bcSLai Jiangshan 
1652b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
1653b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1654b62c0751SLai Jiangshan 
165560f5a4bcSLai Jiangshan 	if (detach_completion)
165660f5a4bcSLai Jiangshan 		complete(detach_completion);
165760f5a4bcSLai Jiangshan }
165860f5a4bcSLai Jiangshan 
165960f5a4bcSLai Jiangshan /**
1660c34056a3STejun Heo  * create_worker - create a new workqueue worker
166163d95a91STejun Heo  * @pool: pool the new worker will belong to
1662c34056a3STejun Heo  *
1663051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
1664c34056a3STejun Heo  *
1665c34056a3STejun Heo  * CONTEXT:
1666c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1667c34056a3STejun Heo  *
1668d185af30SYacine Belkadi  * Return:
1669c34056a3STejun Heo  * Pointer to the newly created worker.
1670c34056a3STejun Heo  */
1671bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1672c34056a3STejun Heo {
1673c34056a3STejun Heo 	struct worker *worker = NULL;
1674f3421797STejun Heo 	int id = -1;
1675e3c916a4STejun Heo 	char id_buf[16];
1676c34056a3STejun Heo 
16777cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
16787cda9aaeSLai Jiangshan 	id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
1679822d8405STejun Heo 	if (id < 0)
1680c34056a3STejun Heo 		goto fail;
1681c34056a3STejun Heo 
1682f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
1683c34056a3STejun Heo 	if (!worker)
1684c34056a3STejun Heo 		goto fail;
1685c34056a3STejun Heo 
1686bd7bdd43STejun Heo 	worker->pool = pool;
1687c34056a3STejun Heo 	worker->id = id;
1688c34056a3STejun Heo 
168929c91e99STejun Heo 	if (pool->cpu >= 0)
1690e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1691e3c916a4STejun Heo 			 pool->attrs->nice < 0  ? "H" : "");
1692f3421797STejun Heo 	else
1693e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1694e3c916a4STejun Heo 
1695f3f90ad4STejun Heo 	worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1696e3c916a4STejun Heo 					      "kworker/%s", id_buf);
1697c34056a3STejun Heo 	if (IS_ERR(worker->task))
1698c34056a3STejun Heo 		goto fail;
1699c34056a3STejun Heo 
170091151228SOleg Nesterov 	set_user_nice(worker->task, pool->attrs->nice);
170191151228SOleg Nesterov 
170291151228SOleg Nesterov 	/* prevent userland from meddling with cpumask of workqueue workers */
170391151228SOleg Nesterov 	worker->task->flags |= PF_NO_SETAFFINITY;
170491151228SOleg Nesterov 
1705da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
17064736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
1707822d8405STejun Heo 
1708051e1850SLai Jiangshan 	/* start the newly created worker */
1709051e1850SLai Jiangshan 	spin_lock_irq(&pool->lock);
1710051e1850SLai Jiangshan 	worker->pool->nr_workers++;
1711051e1850SLai Jiangshan 	worker_enter_idle(worker);
1712051e1850SLai Jiangshan 	wake_up_process(worker->task);
1713051e1850SLai Jiangshan 	spin_unlock_irq(&pool->lock);
1714051e1850SLai Jiangshan 
1715c34056a3STejun Heo 	return worker;
1716822d8405STejun Heo 
1717c34056a3STejun Heo fail:
17189625ab17SLai Jiangshan 	if (id >= 0)
17197cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, id);
1720c34056a3STejun Heo 	kfree(worker);
1721c34056a3STejun Heo 	return NULL;
1722c34056a3STejun Heo }
1723c34056a3STejun Heo 
1724c34056a3STejun Heo /**
1725c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1726c34056a3STejun Heo  * @worker: worker to be destroyed
1727c34056a3STejun Heo  *
172873eb7fe7SLai Jiangshan  * Destroy @worker and adjust @pool stats accordingly.  The worker should
172973eb7fe7SLai Jiangshan  * be idle.
1730c8e55f36STejun Heo  *
1731c8e55f36STejun Heo  * CONTEXT:
173260f5a4bcSLai Jiangshan  * spin_lock_irq(pool->lock).
1733c34056a3STejun Heo  */
1734c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1735c34056a3STejun Heo {
1736bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1737c34056a3STejun Heo 
1738cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
1739cd549687STejun Heo 
1740c34056a3STejun Heo 	/* sanity check frenzy */
17416183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
174273eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
174373eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
17446183c009STejun Heo 		return;
1745c34056a3STejun Heo 
1746bd7bdd43STejun Heo 	pool->nr_workers--;
1747bd7bdd43STejun Heo 	pool->nr_idle--;
1748c8e55f36STejun Heo 
1749c8e55f36STejun Heo 	list_del_init(&worker->entry);
1750cb444766STejun Heo 	worker->flags |= WORKER_DIE;
175160f5a4bcSLai Jiangshan 	wake_up_process(worker->task);
1752c34056a3STejun Heo }
1753c34056a3STejun Heo 
175463d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool)
1755e22bee78STejun Heo {
175663d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1757e22bee78STejun Heo 
1758d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1759e22bee78STejun Heo 
17603347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
1761e22bee78STejun Heo 		struct worker *worker;
1762e22bee78STejun Heo 		unsigned long expires;
1763e22bee78STejun Heo 
1764e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
176563d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1766e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1767e22bee78STejun Heo 
17683347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
176963d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
17703347fc9fSLai Jiangshan 			break;
1771e22bee78STejun Heo 		}
17723347fc9fSLai Jiangshan 
17733347fc9fSLai Jiangshan 		destroy_worker(worker);
1774e22bee78STejun Heo 	}
1775e22bee78STejun Heo 
1776d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
1777e22bee78STejun Heo }
1778e22bee78STejun Heo 
1779493a1724STejun Heo static void send_mayday(struct work_struct *work)
1780e22bee78STejun Heo {
1781112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1782112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
1783493a1724STejun Heo 
17842e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
1785e22bee78STejun Heo 
1786493008a8STejun Heo 	if (!wq->rescuer)
1787493a1724STejun Heo 		return;
1788e22bee78STejun Heo 
1789e22bee78STejun Heo 	/* mayday mayday mayday */
1790493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
179177668c8bSLai Jiangshan 		/*
179277668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
179377668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
179477668c8bSLai Jiangshan 		 * rescuer is done with it.
179577668c8bSLai Jiangshan 		 */
179677668c8bSLai Jiangshan 		get_pwq(pwq);
1797493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
1798e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
1799493a1724STejun Heo 	}
1800e22bee78STejun Heo }
1801e22bee78STejun Heo 
1802706026c2STejun Heo static void pool_mayday_timeout(unsigned long __pool)
1803e22bee78STejun Heo {
180463d95a91STejun Heo 	struct worker_pool *pool = (void *)__pool;
1805e22bee78STejun Heo 	struct work_struct *work;
1806e22bee78STejun Heo 
18072e109a28STejun Heo 	spin_lock_irq(&wq_mayday_lock);		/* for wq->maydays */
1808493a1724STejun Heo 	spin_lock(&pool->lock);
1809e22bee78STejun Heo 
181063d95a91STejun Heo 	if (need_to_create_worker(pool)) {
1811e22bee78STejun Heo 		/*
1812e22bee78STejun Heo 		 * We've been trying to create a new worker but
1813e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
1814e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
1815e22bee78STejun Heo 		 * rescuers.
1816e22bee78STejun Heo 		 */
181763d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
1818e22bee78STejun Heo 			send_mayday(work);
1819e22bee78STejun Heo 	}
1820e22bee78STejun Heo 
1821493a1724STejun Heo 	spin_unlock(&pool->lock);
18222e109a28STejun Heo 	spin_unlock_irq(&wq_mayday_lock);
1823e22bee78STejun Heo 
182463d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
1825e22bee78STejun Heo }
1826e22bee78STejun Heo 
1827e22bee78STejun Heo /**
1828e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
182963d95a91STejun Heo  * @pool: pool to create a new worker for
1830e22bee78STejun Heo  *
183163d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
1832e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
1833e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
183463d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
1835e22bee78STejun Heo  * possible allocation deadlock.
1836e22bee78STejun Heo  *
1837c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
1838c5aa87bbSTejun Heo  * may_start_working() %true.
1839e22bee78STejun Heo  *
1840e22bee78STejun Heo  * LOCKING:
1841d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
1842e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
1843e22bee78STejun Heo  * manager.
1844e22bee78STejun Heo  *
1845d185af30SYacine Belkadi  * Return:
1846c5aa87bbSTejun Heo  * %false if no action was taken and pool->lock stayed locked, %true
1847e22bee78STejun Heo  * otherwise.
1848e22bee78STejun Heo  */
184963d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool)
1850d565ed63STejun Heo __releases(&pool->lock)
1851d565ed63STejun Heo __acquires(&pool->lock)
1852e22bee78STejun Heo {
185363d95a91STejun Heo 	if (!need_to_create_worker(pool))
1854e22bee78STejun Heo 		return false;
1855e22bee78STejun Heo restart:
1856d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
18579f9c2364STejun Heo 
1858e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
185963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1860e22bee78STejun Heo 
1861e22bee78STejun Heo 	while (true) {
1862051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
1863e22bee78STejun Heo 			break;
1864e22bee78STejun Heo 
1865e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
18669f9c2364STejun Heo 
186763d95a91STejun Heo 		if (!need_to_create_worker(pool))
1868e22bee78STejun Heo 			break;
1869e22bee78STejun Heo 	}
1870e22bee78STejun Heo 
187163d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
1872d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1873051e1850SLai Jiangshan 	/*
1874051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
1875051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
1876051e1850SLai Jiangshan 	 * already become busy.
1877051e1850SLai Jiangshan 	 */
187863d95a91STejun Heo 	if (need_to_create_worker(pool))
1879e22bee78STejun Heo 		goto restart;
1880e22bee78STejun Heo 	return true;
1881e22bee78STejun Heo }
1882e22bee78STejun Heo 
1883e22bee78STejun Heo /**
1884e22bee78STejun Heo  * manage_workers - manage worker pool
1885e22bee78STejun Heo  * @worker: self
1886e22bee78STejun Heo  *
1887706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
1888e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
1889706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
1890e22bee78STejun Heo  *
1891e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
1892e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
1893e22bee78STejun Heo  * and may_start_working() is true.
1894e22bee78STejun Heo  *
1895e22bee78STejun Heo  * CONTEXT:
1896d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
1897e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
1898e22bee78STejun Heo  *
1899d185af30SYacine Belkadi  * Return:
19002d498db9SLibin  * %false if the pool don't need management and the caller can safely start
19012d498db9SLibin  * processing works, %true indicates that the function released pool->lock
19022d498db9SLibin  * and reacquired it to perform some management function and that the
19032d498db9SLibin  * conditions that the caller verified while holding the lock before
19042d498db9SLibin  * calling the function might no longer be true.
1905e22bee78STejun Heo  */
1906e22bee78STejun Heo static bool manage_workers(struct worker *worker)
1907e22bee78STejun Heo {
190863d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
1909e22bee78STejun Heo 	bool ret = false;
1910e22bee78STejun Heo 
1911bc3a1afcSTejun Heo 	/*
1912bc3a1afcSTejun Heo 	 * Anyone who successfully grabs manager_arb wins the arbitration
1913bc3a1afcSTejun Heo 	 * and becomes the manager.  mutex_trylock() on pool->manager_arb
1914bc3a1afcSTejun Heo 	 * failure while holding pool->lock reliably indicates that someone
1915bc3a1afcSTejun Heo 	 * else is managing the pool and the worker which failed trylock
1916bc3a1afcSTejun Heo 	 * can proceed to executing work items.  This means that anyone
1917bc3a1afcSTejun Heo 	 * grabbing manager_arb is responsible for actually performing
1918bc3a1afcSTejun Heo 	 * manager duties.  If manager_arb is grabbed and released without
1919bc3a1afcSTejun Heo 	 * actual management, the pool may stall indefinitely.
1920bc3a1afcSTejun Heo 	 */
192134a06bd6STejun Heo 	if (!mutex_trylock(&pool->manager_arb))
1922e22bee78STejun Heo 		return ret;
1923e22bee78STejun Heo 
192463d95a91STejun Heo 	ret |= maybe_create_worker(pool);
1925e22bee78STejun Heo 
192634a06bd6STejun Heo 	mutex_unlock(&pool->manager_arb);
1927e22bee78STejun Heo 	return ret;
1928e22bee78STejun Heo }
1929e22bee78STejun Heo 
1930a62428c0STejun Heo /**
1931a62428c0STejun Heo  * process_one_work - process single work
1932c34056a3STejun Heo  * @worker: self
1933a62428c0STejun Heo  * @work: work to process
1934a62428c0STejun Heo  *
1935a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
1936a62428c0STejun Heo  * process a single work including synchronization against and
1937a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
1938a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
1939a62428c0STejun Heo  * call this function to process a work.
1940a62428c0STejun Heo  *
1941a62428c0STejun Heo  * CONTEXT:
1942d565ed63STejun Heo  * spin_lock_irq(pool->lock) which is released and regrabbed.
1943a62428c0STejun Heo  */
1944c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
1945d565ed63STejun Heo __releases(&pool->lock)
1946d565ed63STejun Heo __acquires(&pool->lock)
19471da177e4SLinus Torvalds {
1948112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1949bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1950112202d9STejun Heo 	bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
195173f53c4aSTejun Heo 	int work_color;
19527e11629dSTejun Heo 	struct worker *collision;
19534e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
19544e6045f1SJohannes Berg 	/*
1955a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
1956a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
1957a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
1958a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
1959a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
19604e6045f1SJohannes Berg 	 */
19614d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
19624d82a1deSPeter Zijlstra 
19634d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
19644e6045f1SJohannes Berg #endif
196585327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1966ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
196725511a47STejun Heo 
19687e11629dSTejun Heo 	/*
19697e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
19707e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
19717e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
19727e11629dSTejun Heo 	 * currently executing one.
19737e11629dSTejun Heo 	 */
1974c9e7cf27STejun Heo 	collision = find_worker_executing_work(pool, work);
19757e11629dSTejun Heo 	if (unlikely(collision)) {
19767e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
19777e11629dSTejun Heo 		return;
19787e11629dSTejun Heo 	}
19791da177e4SLinus Torvalds 
19808930cabaSTejun Heo 	/* claim and dequeue */
19811da177e4SLinus Torvalds 	debug_work_deactivate(work);
1982c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
1983c34056a3STejun Heo 	worker->current_work = work;
1984a2c1c57bSTejun Heo 	worker->current_func = work->func;
1985112202d9STejun Heo 	worker->current_pwq = pwq;
198673f53c4aSTejun Heo 	work_color = get_work_color(work);
19877a22ad75STejun Heo 
1988a62428c0STejun Heo 	list_del_init(&work->entry);
1989a62428c0STejun Heo 
1990649027d7STejun Heo 	/*
1991228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
1992228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
1993228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
1994228f1d00SLai Jiangshan 	 * execution of the pending work items.
1995fb0e7bebSTejun Heo 	 */
1996fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
1997228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
1998fb0e7bebSTejun Heo 
1999974271c4STejun Heo 	/*
2000a489a03eSLai Jiangshan 	 * Wake up another worker if necessary.  The condition is always
2001a489a03eSLai Jiangshan 	 * false for normal per-cpu workers since nr_running would always
2002a489a03eSLai Jiangshan 	 * be >= 1 at this point.  This is used to chain execution of the
2003a489a03eSLai Jiangshan 	 * pending work items for WORKER_NOT_RUNNING workers such as the
2004228f1d00SLai Jiangshan 	 * UNBOUND and CPU_INTENSIVE ones.
2005974271c4STejun Heo 	 */
2006a489a03eSLai Jiangshan 	if (need_more_worker(pool))
200763d95a91STejun Heo 		wake_up_worker(pool);
2008974271c4STejun Heo 
20098930cabaSTejun Heo 	/*
20107c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
2011d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
201223657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
201323657bb1STejun Heo 	 * disabled.
20148930cabaSTejun Heo 	 */
20157c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
20161da177e4SLinus Torvalds 
2017d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2018365970a1SDavid Howells 
2019112202d9STejun Heo 	lock_map_acquire_read(&pwq->wq->lockdep_map);
20203295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2021e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2022a2c1c57bSTejun Heo 	worker->current_func(work);
2023e36c886aSArjan van de Ven 	/*
2024e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2025e36c886aSArjan van de Ven 	 * point will only record its address.
2026e36c886aSArjan van de Ven 	 */
2027e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
20283295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
2029112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
20301da177e4SLinus Torvalds 
2031d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2032044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2033044c782cSValentin Ilie 		       "     last function: %pf\n",
2034a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2035a2c1c57bSTejun Heo 		       worker->current_func);
2036d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2037d5abe669SPeter Zijlstra 		dump_stack();
2038d5abe669SPeter Zijlstra 	}
2039d5abe669SPeter Zijlstra 
2040b22ce278STejun Heo 	/*
2041b22ce278STejun Heo 	 * The following prevents a kworker from hogging CPU on !PREEMPT
2042b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
2043b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
2044b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
2045b22ce278STejun Heo 	 * stop_machine.
2046b22ce278STejun Heo 	 */
2047b22ce278STejun Heo 	cond_resched();
2048b22ce278STejun Heo 
2049d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2050a62428c0STejun Heo 
2051fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2052fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2053fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2054fb0e7bebSTejun Heo 
2055a62428c0STejun Heo 	/* we're done with it, release */
205642f8570fSSasha Levin 	hash_del(&worker->hentry);
2057c34056a3STejun Heo 	worker->current_work = NULL;
2058a2c1c57bSTejun Heo 	worker->current_func = NULL;
2059112202d9STejun Heo 	worker->current_pwq = NULL;
20603d1cb205STejun Heo 	worker->desc_valid = false;
2061112202d9STejun Heo 	pwq_dec_nr_in_flight(pwq, work_color);
20621da177e4SLinus Torvalds }
20631da177e4SLinus Torvalds 
2064affee4b2STejun Heo /**
2065affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2066affee4b2STejun Heo  * @worker: self
2067affee4b2STejun Heo  *
2068affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2069affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2070affee4b2STejun Heo  * fetches a work from the top and executes it.
2071affee4b2STejun Heo  *
2072affee4b2STejun Heo  * CONTEXT:
2073d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2074affee4b2STejun Heo  * multiple times.
2075affee4b2STejun Heo  */
2076affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
20771da177e4SLinus Torvalds {
2078affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2079affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2080a62428c0STejun Heo 						struct work_struct, entry);
2081c34056a3STejun Heo 		process_one_work(worker, work);
2082a62428c0STejun Heo 	}
20831da177e4SLinus Torvalds }
20841da177e4SLinus Torvalds 
20854690c4abSTejun Heo /**
20864690c4abSTejun Heo  * worker_thread - the worker thread function
2087c34056a3STejun Heo  * @__worker: self
20884690c4abSTejun Heo  *
2089c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
2090c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
2091c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
2092c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
2093c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
2094d185af30SYacine Belkadi  *
2095d185af30SYacine Belkadi  * Return: 0
20964690c4abSTejun Heo  */
2097c34056a3STejun Heo static int worker_thread(void *__worker)
20981da177e4SLinus Torvalds {
2099c34056a3STejun Heo 	struct worker *worker = __worker;
2100bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
21011da177e4SLinus Torvalds 
2102e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2103e22bee78STejun Heo 	worker->task->flags |= PF_WQ_WORKER;
2104c8e55f36STejun Heo woke_up:
2105d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2106affee4b2STejun Heo 
2107a9ab775bSTejun Heo 	/* am I supposed to die? */
2108a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
2109d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
2110a9ab775bSTejun Heo 		WARN_ON_ONCE(!list_empty(&worker->entry));
2111e22bee78STejun Heo 		worker->task->flags &= ~PF_WQ_WORKER;
211260f5a4bcSLai Jiangshan 
211360f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
21147cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, worker->id);
211560f5a4bcSLai Jiangshan 		worker_detach_from_pool(worker, pool);
211660f5a4bcSLai Jiangshan 		kfree(worker);
2117c8e55f36STejun Heo 		return 0;
2118c8e55f36STejun Heo 	}
2119c8e55f36STejun Heo 
2120c8e55f36STejun Heo 	worker_leave_idle(worker);
2121db7bccf4STejun Heo recheck:
2122e22bee78STejun Heo 	/* no more worker necessary? */
212363d95a91STejun Heo 	if (!need_more_worker(pool))
2124e22bee78STejun Heo 		goto sleep;
2125e22bee78STejun Heo 
2126e22bee78STejun Heo 	/* do we need to manage? */
212763d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2128e22bee78STejun Heo 		goto recheck;
2129e22bee78STejun Heo 
2130c8e55f36STejun Heo 	/*
2131c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2132c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2133c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2134c8e55f36STejun Heo 	 */
21356183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
2136c8e55f36STejun Heo 
2137e22bee78STejun Heo 	/*
2138a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
2139a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
2140a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
2141a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
2142a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
2143e22bee78STejun Heo 	 */
2144a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2145e22bee78STejun Heo 
2146e22bee78STejun Heo 	do {
2147affee4b2STejun Heo 		struct work_struct *work =
2148bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2149affee4b2STejun Heo 					 struct work_struct, entry);
2150affee4b2STejun Heo 
2151c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2152affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2153affee4b2STejun Heo 			process_one_work(worker, work);
2154affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2155affee4b2STejun Heo 				process_scheduled_works(worker);
2156affee4b2STejun Heo 		} else {
2157c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2158affee4b2STejun Heo 			process_scheduled_works(worker);
2159affee4b2STejun Heo 		}
216063d95a91STejun Heo 	} while (keep_working(pool));
2161affee4b2STejun Heo 
2162228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
2163d313dd85STejun Heo sleep:
2164c8e55f36STejun Heo 	/*
2165d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
2166d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
2167d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
2168d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
2169d565ed63STejun Heo 	 * event.
2170c8e55f36STejun Heo 	 */
2171c8e55f36STejun Heo 	worker_enter_idle(worker);
2172c8e55f36STejun Heo 	__set_current_state(TASK_INTERRUPTIBLE);
2173d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
21741da177e4SLinus Torvalds 	schedule();
2175c8e55f36STejun Heo 	goto woke_up;
21761da177e4SLinus Torvalds }
21771da177e4SLinus Torvalds 
2178e22bee78STejun Heo /**
2179e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2180111c225aSTejun Heo  * @__rescuer: self
2181e22bee78STejun Heo  *
2182e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2183493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
2184e22bee78STejun Heo  *
2185706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
2186e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2187e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2188e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2189e22bee78STejun Heo  * the problem rescuer solves.
2190e22bee78STejun Heo  *
2191706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
2192706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
2193e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2194e22bee78STejun Heo  *
2195e22bee78STejun Heo  * This should happen rarely.
2196d185af30SYacine Belkadi  *
2197d185af30SYacine Belkadi  * Return: 0
2198e22bee78STejun Heo  */
2199111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2200e22bee78STejun Heo {
2201111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2202111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2203e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
22044d595b86SLai Jiangshan 	bool should_stop;
2205e22bee78STejun Heo 
2206e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2207111c225aSTejun Heo 
2208111c225aSTejun Heo 	/*
2209111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2210111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2211111c225aSTejun Heo 	 */
2212111c225aSTejun Heo 	rescuer->task->flags |= PF_WQ_WORKER;
2213e22bee78STejun Heo repeat:
2214e22bee78STejun Heo 	set_current_state(TASK_INTERRUPTIBLE);
22151da177e4SLinus Torvalds 
22164d595b86SLai Jiangshan 	/*
22174d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
22184d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
22194d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
22204d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
22214d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
22224d595b86SLai Jiangshan 	 * list is always empty on exit.
22234d595b86SLai Jiangshan 	 */
22244d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
22251da177e4SLinus Torvalds 
2226493a1724STejun Heo 	/* see whether any pwq is asking for help */
22272e109a28STejun Heo 	spin_lock_irq(&wq_mayday_lock);
2228493a1724STejun Heo 
2229493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
2230493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2231493a1724STejun Heo 					struct pool_workqueue, mayday_node);
2232112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
2233e22bee78STejun Heo 		struct work_struct *work, *n;
2234e22bee78STejun Heo 
2235e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2236493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
2237493a1724STejun Heo 
22382e109a28STejun Heo 		spin_unlock_irq(&wq_mayday_lock);
2239e22bee78STejun Heo 
224051697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
224151697d39SLai Jiangshan 
224251697d39SLai Jiangshan 		spin_lock_irq(&pool->lock);
2243b3104104SLai Jiangshan 		rescuer->pool = pool;
2244e22bee78STejun Heo 
2245e22bee78STejun Heo 		/*
2246e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2247e22bee78STejun Heo 		 * process'em.
2248e22bee78STejun Heo 		 */
22496183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
2250bd7bdd43STejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry)
2251112202d9STejun Heo 			if (get_work_pwq(work) == pwq)
2252e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
2253e22bee78STejun Heo 
2254e22bee78STejun Heo 		process_scheduled_works(rescuer);
22557576958aSTejun Heo 
22567576958aSTejun Heo 		/*
225777668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
225813b1d625SLai Jiangshan 		 * go away while we're still attached to it.
225977668c8bSLai Jiangshan 		 */
226077668c8bSLai Jiangshan 		put_pwq(pwq);
226177668c8bSLai Jiangshan 
226277668c8bSLai Jiangshan 		/*
2263d8ca83e6SLai Jiangshan 		 * Leave this pool.  If need_more_worker() is %true, notify a
22647576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
22657576958aSTejun Heo 		 * and stalling the execution.
22667576958aSTejun Heo 		 */
2267d8ca83e6SLai Jiangshan 		if (need_more_worker(pool))
226863d95a91STejun Heo 			wake_up_worker(pool);
22697576958aSTejun Heo 
2270b3104104SLai Jiangshan 		rescuer->pool = NULL;
227113b1d625SLai Jiangshan 		spin_unlock_irq(&pool->lock);
227213b1d625SLai Jiangshan 
227313b1d625SLai Jiangshan 		worker_detach_from_pool(rescuer, pool);
227413b1d625SLai Jiangshan 
227513b1d625SLai Jiangshan 		spin_lock_irq(&wq_mayday_lock);
22761da177e4SLinus Torvalds 	}
22771da177e4SLinus Torvalds 
22782e109a28STejun Heo 	spin_unlock_irq(&wq_mayday_lock);
2279493a1724STejun Heo 
22804d595b86SLai Jiangshan 	if (should_stop) {
22814d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
22824d595b86SLai Jiangshan 		rescuer->task->flags &= ~PF_WQ_WORKER;
22834d595b86SLai Jiangshan 		return 0;
22844d595b86SLai Jiangshan 	}
22854d595b86SLai Jiangshan 
2286111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2287111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2288e22bee78STejun Heo 	schedule();
2289e22bee78STejun Heo 	goto repeat;
22901da177e4SLinus Torvalds }
22911da177e4SLinus Torvalds 
2292fc2e4d70SOleg Nesterov struct wq_barrier {
2293fc2e4d70SOleg Nesterov 	struct work_struct	work;
2294fc2e4d70SOleg Nesterov 	struct completion	done;
2295fc2e4d70SOleg Nesterov };
2296fc2e4d70SOleg Nesterov 
2297fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2298fc2e4d70SOleg Nesterov {
2299fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2300fc2e4d70SOleg Nesterov 	complete(&barr->done);
2301fc2e4d70SOleg Nesterov }
2302fc2e4d70SOleg Nesterov 
23034690c4abSTejun Heo /**
23044690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
2305112202d9STejun Heo  * @pwq: pwq to insert barrier into
23064690c4abSTejun Heo  * @barr: wq_barrier to insert
2307affee4b2STejun Heo  * @target: target work to attach @barr to
2308affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
23094690c4abSTejun Heo  *
2310affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2311affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2312affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2313affee4b2STejun Heo  * cpu.
2314affee4b2STejun Heo  *
2315affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2316affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2317affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2318affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2319affee4b2STejun Heo  * after a work with LINKED flag set.
2320affee4b2STejun Heo  *
2321affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2322112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
23234690c4abSTejun Heo  *
23244690c4abSTejun Heo  * CONTEXT:
2325d565ed63STejun Heo  * spin_lock_irq(pool->lock).
23264690c4abSTejun Heo  */
2327112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
2328affee4b2STejun Heo 			      struct wq_barrier *barr,
2329affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2330fc2e4d70SOleg Nesterov {
2331affee4b2STejun Heo 	struct list_head *head;
2332affee4b2STejun Heo 	unsigned int linked = 0;
2333affee4b2STejun Heo 
2334dc186ad7SThomas Gleixner 	/*
2335d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
2336dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2337dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2338dc186ad7SThomas Gleixner 	 * might deadlock.
2339dc186ad7SThomas Gleixner 	 */
2340ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
234122df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2342fc2e4d70SOleg Nesterov 	init_completion(&barr->done);
234383c22520SOleg Nesterov 
2344affee4b2STejun Heo 	/*
2345affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2346affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2347affee4b2STejun Heo 	 */
2348affee4b2STejun Heo 	if (worker)
2349affee4b2STejun Heo 		head = worker->scheduled.next;
2350affee4b2STejun Heo 	else {
2351affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2352affee4b2STejun Heo 
2353affee4b2STejun Heo 		head = target->entry.next;
2354affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2355affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2356affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2357affee4b2STejun Heo 	}
2358affee4b2STejun Heo 
2359dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2360112202d9STejun Heo 	insert_work(pwq, &barr->work, head,
2361affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2362fc2e4d70SOleg Nesterov }
2363fc2e4d70SOleg Nesterov 
236473f53c4aSTejun Heo /**
2365112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
236673f53c4aSTejun Heo  * @wq: workqueue being flushed
236773f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
236873f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
236973f53c4aSTejun Heo  *
2370112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
237173f53c4aSTejun Heo  *
2372112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
2373112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
2374112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
2375112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
2376112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
237773f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
237873f53c4aSTejun Heo  *
237973f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
238073f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
238173f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
238273f53c4aSTejun Heo  * is returned.
238373f53c4aSTejun Heo  *
2384112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
238573f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
238673f53c4aSTejun Heo  * advanced to @work_color.
238773f53c4aSTejun Heo  *
238873f53c4aSTejun Heo  * CONTEXT:
23893c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
239073f53c4aSTejun Heo  *
2391d185af30SYacine Belkadi  * Return:
239273f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
239373f53c4aSTejun Heo  * otherwise.
239473f53c4aSTejun Heo  */
2395112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
239673f53c4aSTejun Heo 				      int flush_color, int work_color)
23971da177e4SLinus Torvalds {
239873f53c4aSTejun Heo 	bool wait = false;
239949e3cf44STejun Heo 	struct pool_workqueue *pwq;
24001da177e4SLinus Torvalds 
240173f53c4aSTejun Heo 	if (flush_color >= 0) {
24026183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2403112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
2404dc186ad7SThomas Gleixner 	}
240514441960SOleg Nesterov 
240649e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2407112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
24081da177e4SLinus Torvalds 
2409b09f4fd3SLai Jiangshan 		spin_lock_irq(&pool->lock);
241073f53c4aSTejun Heo 
241173f53c4aSTejun Heo 		if (flush_color >= 0) {
24126183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
241373f53c4aSTejun Heo 
2414112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
2415112202d9STejun Heo 				pwq->flush_color = flush_color;
2416112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
241773f53c4aSTejun Heo 				wait = true;
24181da177e4SLinus Torvalds 			}
241973f53c4aSTejun Heo 		}
242073f53c4aSTejun Heo 
242173f53c4aSTejun Heo 		if (work_color >= 0) {
24226183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2423112202d9STejun Heo 			pwq->work_color = work_color;
242473f53c4aSTejun Heo 		}
242573f53c4aSTejun Heo 
2426b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pool->lock);
24271da177e4SLinus Torvalds 	}
24281da177e4SLinus Torvalds 
2429112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
243073f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
243173f53c4aSTejun Heo 
243273f53c4aSTejun Heo 	return wait;
243383c22520SOleg Nesterov }
24341da177e4SLinus Torvalds 
24350fcb78c2SRolf Eike Beer /**
24361da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
24370fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
24381da177e4SLinus Torvalds  *
2439c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
2440c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
24411da177e4SLinus Torvalds  */
24427ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
24431da177e4SLinus Torvalds {
244473f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
244573f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
244673f53c4aSTejun Heo 		.flush_color = -1,
244773f53c4aSTejun Heo 		.done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
244873f53c4aSTejun Heo 	};
244973f53c4aSTejun Heo 	int next_color;
2450b1f4ec17SOleg Nesterov 
24513295f0efSIngo Molnar 	lock_map_acquire(&wq->lockdep_map);
24523295f0efSIngo Molnar 	lock_map_release(&wq->lockdep_map);
245373f53c4aSTejun Heo 
24543c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
245573f53c4aSTejun Heo 
245673f53c4aSTejun Heo 	/*
245773f53c4aSTejun Heo 	 * Start-to-wait phase
245873f53c4aSTejun Heo 	 */
245973f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
246073f53c4aSTejun Heo 
246173f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
246273f53c4aSTejun Heo 		/*
246373f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
246473f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
246573f53c4aSTejun Heo 		 * by one.
246673f53c4aSTejun Heo 		 */
24676183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
246873f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
246973f53c4aSTejun Heo 		wq->work_color = next_color;
247073f53c4aSTejun Heo 
247173f53c4aSTejun Heo 		if (!wq->first_flusher) {
247273f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
24736183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
247473f53c4aSTejun Heo 
247573f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
247673f53c4aSTejun Heo 
2477112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
247873f53c4aSTejun Heo 						       wq->work_color)) {
247973f53c4aSTejun Heo 				/* nothing to flush, done */
248073f53c4aSTejun Heo 				wq->flush_color = next_color;
248173f53c4aSTejun Heo 				wq->first_flusher = NULL;
248273f53c4aSTejun Heo 				goto out_unlock;
248373f53c4aSTejun Heo 			}
248473f53c4aSTejun Heo 		} else {
248573f53c4aSTejun Heo 			/* wait in queue */
24866183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
248773f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
2488112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
248973f53c4aSTejun Heo 		}
249073f53c4aSTejun Heo 	} else {
249173f53c4aSTejun Heo 		/*
249273f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
249373f53c4aSTejun Heo 		 * The next flush completion will assign us
249473f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
249573f53c4aSTejun Heo 		 */
249673f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
249773f53c4aSTejun Heo 	}
249873f53c4aSTejun Heo 
24993c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
250073f53c4aSTejun Heo 
250173f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
250273f53c4aSTejun Heo 
250373f53c4aSTejun Heo 	/*
250473f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
250573f53c4aSTejun Heo 	 *
250673f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
250773f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
250873f53c4aSTejun Heo 	 */
250973f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
251073f53c4aSTejun Heo 		return;
251173f53c4aSTejun Heo 
25123c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
251373f53c4aSTejun Heo 
25144ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
25154ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
25164ce48b37STejun Heo 		goto out_unlock;
25174ce48b37STejun Heo 
251873f53c4aSTejun Heo 	wq->first_flusher = NULL;
251973f53c4aSTejun Heo 
25206183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
25216183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
252273f53c4aSTejun Heo 
252373f53c4aSTejun Heo 	while (true) {
252473f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
252573f53c4aSTejun Heo 
252673f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
252773f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
252873f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
252973f53c4aSTejun Heo 				break;
253073f53c4aSTejun Heo 			list_del_init(&next->list);
253173f53c4aSTejun Heo 			complete(&next->done);
253273f53c4aSTejun Heo 		}
253373f53c4aSTejun Heo 
25346183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
253573f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
253673f53c4aSTejun Heo 
253773f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
253873f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
253973f53c4aSTejun Heo 
254073f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
254173f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
254273f53c4aSTejun Heo 			/*
254373f53c4aSTejun Heo 			 * Assign the same color to all overflowed
254473f53c4aSTejun Heo 			 * flushers, advance work_color and append to
254573f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
254673f53c4aSTejun Heo 			 * phase for these overflowed flushers.
254773f53c4aSTejun Heo 			 */
254873f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
254973f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
255073f53c4aSTejun Heo 
255173f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
255273f53c4aSTejun Heo 
255373f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
255473f53c4aSTejun Heo 					      &wq->flusher_queue);
2555112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
255673f53c4aSTejun Heo 		}
255773f53c4aSTejun Heo 
255873f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
25596183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
256073f53c4aSTejun Heo 			break;
256173f53c4aSTejun Heo 		}
256273f53c4aSTejun Heo 
256373f53c4aSTejun Heo 		/*
256473f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
2565112202d9STejun Heo 		 * the new first flusher and arm pwqs.
256673f53c4aSTejun Heo 		 */
25676183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
25686183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
256973f53c4aSTejun Heo 
257073f53c4aSTejun Heo 		list_del_init(&next->list);
257173f53c4aSTejun Heo 		wq->first_flusher = next;
257273f53c4aSTejun Heo 
2573112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
257473f53c4aSTejun Heo 			break;
257573f53c4aSTejun Heo 
257673f53c4aSTejun Heo 		/*
257773f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
257873f53c4aSTejun Heo 		 * flusher and repeat cascading.
257973f53c4aSTejun Heo 		 */
258073f53c4aSTejun Heo 		wq->first_flusher = NULL;
258173f53c4aSTejun Heo 	}
258273f53c4aSTejun Heo 
258373f53c4aSTejun Heo out_unlock:
25843c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
25851da177e4SLinus Torvalds }
2586ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue);
25871da177e4SLinus Torvalds 
25889c5a2ba7STejun Heo /**
25899c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
25909c5a2ba7STejun Heo  * @wq: workqueue to drain
25919c5a2ba7STejun Heo  *
25929c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
25939c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
25949c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
25959c5a2ba7STejun Heo  * repeatedly until it becomes empty.  The number of flushing is detemined
25969c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
25979c5a2ba7STejun Heo  * takes too long.
25989c5a2ba7STejun Heo  */
25999c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
26009c5a2ba7STejun Heo {
26019c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
260249e3cf44STejun Heo 	struct pool_workqueue *pwq;
26039c5a2ba7STejun Heo 
26049c5a2ba7STejun Heo 	/*
26059c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
26069c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
2607618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
26089c5a2ba7STejun Heo 	 */
260987fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
26109c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
2611618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
261287fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
26139c5a2ba7STejun Heo reflush:
26149c5a2ba7STejun Heo 	flush_workqueue(wq);
26159c5a2ba7STejun Heo 
2616b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
261776af4d93STejun Heo 
261849e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2619fa2563e4SThomas Tuttle 		bool drained;
26209c5a2ba7STejun Heo 
2621b09f4fd3SLai Jiangshan 		spin_lock_irq(&pwq->pool->lock);
2622112202d9STejun Heo 		drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2623b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pwq->pool->lock);
2624fa2563e4SThomas Tuttle 
2625fa2563e4SThomas Tuttle 		if (drained)
26269c5a2ba7STejun Heo 			continue;
26279c5a2ba7STejun Heo 
26289c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
26299c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2630c5aa87bbSTejun Heo 			pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
26319c5a2ba7STejun Heo 				wq->name, flush_cnt);
263276af4d93STejun Heo 
2633b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
26349c5a2ba7STejun Heo 		goto reflush;
26359c5a2ba7STejun Heo 	}
26369c5a2ba7STejun Heo 
26379c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
2638618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
263987fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
26409c5a2ba7STejun Heo }
26419c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
26429c5a2ba7STejun Heo 
2643606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
2644baf59022STejun Heo {
2645baf59022STejun Heo 	struct worker *worker = NULL;
2646c9e7cf27STejun Heo 	struct worker_pool *pool;
2647112202d9STejun Heo 	struct pool_workqueue *pwq;
2648baf59022STejun Heo 
2649baf59022STejun Heo 	might_sleep();
2650baf59022STejun Heo 
2651fa1b54e6STejun Heo 	local_irq_disable();
2652fa1b54e6STejun Heo 	pool = get_work_pool(work);
2653fa1b54e6STejun Heo 	if (!pool) {
2654fa1b54e6STejun Heo 		local_irq_enable();
2655fa1b54e6STejun Heo 		return false;
2656fa1b54e6STejun Heo 	}
2657fa1b54e6STejun Heo 
2658fa1b54e6STejun Heo 	spin_lock(&pool->lock);
26590b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
2660112202d9STejun Heo 	pwq = get_work_pwq(work);
2661112202d9STejun Heo 	if (pwq) {
2662112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
2663baf59022STejun Heo 			goto already_gone;
2664606a5020STejun Heo 	} else {
2665c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
2666baf59022STejun Heo 		if (!worker)
2667baf59022STejun Heo 			goto already_gone;
2668112202d9STejun Heo 		pwq = worker->current_pwq;
2669606a5020STejun Heo 	}
2670baf59022STejun Heo 
2671112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
2672d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2673baf59022STejun Heo 
2674e159489bSTejun Heo 	/*
2675e159489bSTejun Heo 	 * If @max_active is 1 or rescuer is in use, flushing another work
2676e159489bSTejun Heo 	 * item on the same workqueue may lead to deadlock.  Make sure the
2677e159489bSTejun Heo 	 * flusher is not running on the same workqueue by verifying write
2678e159489bSTejun Heo 	 * access.
2679e159489bSTejun Heo 	 */
2680493008a8STejun Heo 	if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
2681112202d9STejun Heo 		lock_map_acquire(&pwq->wq->lockdep_map);
2682e159489bSTejun Heo 	else
2683112202d9STejun Heo 		lock_map_acquire_read(&pwq->wq->lockdep_map);
2684112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
2685e159489bSTejun Heo 
2686baf59022STejun Heo 	return true;
2687baf59022STejun Heo already_gone:
2688d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2689baf59022STejun Heo 	return false;
2690baf59022STejun Heo }
2691baf59022STejun Heo 
2692db700897SOleg Nesterov /**
2693401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
2694401a8d04STejun Heo  * @work: the work to flush
2695db700897SOleg Nesterov  *
2696606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
2697606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
2698401a8d04STejun Heo  *
2699d185af30SYacine Belkadi  * Return:
2700401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2701401a8d04STejun Heo  * %false if it was already idle.
2702db700897SOleg Nesterov  */
2703401a8d04STejun Heo bool flush_work(struct work_struct *work)
2704db700897SOleg Nesterov {
270512997d1aSBjorn Helgaas 	struct wq_barrier barr;
270612997d1aSBjorn Helgaas 
27070976dfc1SStephen Boyd 	lock_map_acquire(&work->lockdep_map);
27080976dfc1SStephen Boyd 	lock_map_release(&work->lockdep_map);
27090976dfc1SStephen Boyd 
271012997d1aSBjorn Helgaas 	if (start_flush_work(work, &barr)) {
271112997d1aSBjorn Helgaas 		wait_for_completion(&barr.done);
271212997d1aSBjorn Helgaas 		destroy_work_on_stack(&barr.work);
271312997d1aSBjorn Helgaas 		return true;
271412997d1aSBjorn Helgaas 	} else {
271512997d1aSBjorn Helgaas 		return false;
271612997d1aSBjorn Helgaas 	}
2717606a5020STejun Heo }
2718db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
2719db700897SOleg Nesterov 
272036e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
2721401a8d04STejun Heo {
2722bbb68dfaSTejun Heo 	unsigned long flags;
27231f1f642eSOleg Nesterov 	int ret;
27241f1f642eSOleg Nesterov 
27251f1f642eSOleg Nesterov 	do {
2726bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
2727bbb68dfaSTejun Heo 		/*
2728bbb68dfaSTejun Heo 		 * If someone else is canceling, wait for the same event it
2729bbb68dfaSTejun Heo 		 * would be waiting for before retrying.
2730bbb68dfaSTejun Heo 		 */
2731bbb68dfaSTejun Heo 		if (unlikely(ret == -ENOENT))
2732606a5020STejun Heo 			flush_work(work);
27331f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
27341f1f642eSOleg Nesterov 
2735bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
2736bbb68dfaSTejun Heo 	mark_work_canceling(work);
2737bbb68dfaSTejun Heo 	local_irq_restore(flags);
2738bbb68dfaSTejun Heo 
2739606a5020STejun Heo 	flush_work(work);
27407a22ad75STejun Heo 	clear_work_data(work);
27411f1f642eSOleg Nesterov 	return ret;
27421f1f642eSOleg Nesterov }
27431f1f642eSOleg Nesterov 
27446e84d644SOleg Nesterov /**
2745401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
2746401a8d04STejun Heo  * @work: the work to cancel
27476e84d644SOleg Nesterov  *
2748401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
2749401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
2750401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
2751401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
27521f1f642eSOleg Nesterov  *
2753401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
2754401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
27556e84d644SOleg Nesterov  *
2756401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
27576e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
2758401a8d04STejun Heo  *
2759d185af30SYacine Belkadi  * Return:
2760401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
27616e84d644SOleg Nesterov  */
2762401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
27636e84d644SOleg Nesterov {
276436e227d2STejun Heo 	return __cancel_work_timer(work, false);
2765b89deed3SOleg Nesterov }
276628e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
2767b89deed3SOleg Nesterov 
27686e84d644SOleg Nesterov /**
2769401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
2770401a8d04STejun Heo  * @dwork: the delayed work to flush
27716e84d644SOleg Nesterov  *
2772401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
2773401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
2774401a8d04STejun Heo  * considers the last queueing instance of @dwork.
27751f1f642eSOleg Nesterov  *
2776d185af30SYacine Belkadi  * Return:
2777401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
2778401a8d04STejun Heo  * %false if it was already idle.
27796e84d644SOleg Nesterov  */
2780401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
2781401a8d04STejun Heo {
27828930cabaSTejun Heo 	local_irq_disable();
2783401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
278460c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
27858930cabaSTejun Heo 	local_irq_enable();
2786401a8d04STejun Heo 	return flush_work(&dwork->work);
2787401a8d04STejun Heo }
2788401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
2789401a8d04STejun Heo 
2790401a8d04STejun Heo /**
279157b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
279257b30ae7STejun Heo  * @dwork: delayed_work to cancel
279309383498STejun Heo  *
2794d185af30SYacine Belkadi  * Kill off a pending delayed_work.
2795d185af30SYacine Belkadi  *
2796d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
2797d185af30SYacine Belkadi  * pending.
2798d185af30SYacine Belkadi  *
2799d185af30SYacine Belkadi  * Note:
2800d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
2801d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
2802d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
280309383498STejun Heo  *
280457b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
280509383498STejun Heo  */
280657b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
280709383498STejun Heo {
280857b30ae7STejun Heo 	unsigned long flags;
280957b30ae7STejun Heo 	int ret;
281057b30ae7STejun Heo 
281157b30ae7STejun Heo 	do {
281257b30ae7STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
281357b30ae7STejun Heo 	} while (unlikely(ret == -EAGAIN));
281457b30ae7STejun Heo 
281557b30ae7STejun Heo 	if (unlikely(ret < 0))
281657b30ae7STejun Heo 		return false;
281757b30ae7STejun Heo 
28187c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(&dwork->work,
28197c3eed5cSTejun Heo 					get_work_pool_id(&dwork->work));
282057b30ae7STejun Heo 	local_irq_restore(flags);
2821c0158ca6SDan Magenheimer 	return ret;
282209383498STejun Heo }
282357b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
282409383498STejun Heo 
282509383498STejun Heo /**
2826401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2827401a8d04STejun Heo  * @dwork: the delayed work cancel
2828401a8d04STejun Heo  *
2829401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
2830401a8d04STejun Heo  *
2831d185af30SYacine Belkadi  * Return:
2832401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
2833401a8d04STejun Heo  */
2834401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
28356e84d644SOleg Nesterov {
283636e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
28376e84d644SOleg Nesterov }
2838f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
28391da177e4SLinus Torvalds 
28400fcb78c2SRolf Eike Beer /**
284131ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
2842b6136773SAndrew Morton  * @func: the function to call
2843b6136773SAndrew Morton  *
284431ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
284531ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
2846b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
284731ddd871STejun Heo  *
2848d185af30SYacine Belkadi  * Return:
284931ddd871STejun Heo  * 0 on success, -errno on failure.
2850b6136773SAndrew Morton  */
285165f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
285215316ba8SChristoph Lameter {
285315316ba8SChristoph Lameter 	int cpu;
285438f51568SNamhyung Kim 	struct work_struct __percpu *works;
285515316ba8SChristoph Lameter 
2856b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
2857b6136773SAndrew Morton 	if (!works)
285815316ba8SChristoph Lameter 		return -ENOMEM;
2859b6136773SAndrew Morton 
286095402b38SGautham R Shenoy 	get_online_cpus();
286193981800STejun Heo 
286215316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
28639bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
28649bfb1839SIngo Molnar 
28659bfb1839SIngo Molnar 		INIT_WORK(work, func);
28668de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
286715316ba8SChristoph Lameter 	}
286893981800STejun Heo 
286993981800STejun Heo 	for_each_online_cpu(cpu)
28708616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
287193981800STejun Heo 
287295402b38SGautham R Shenoy 	put_online_cpus();
2873b6136773SAndrew Morton 	free_percpu(works);
287415316ba8SChristoph Lameter 	return 0;
287515316ba8SChristoph Lameter }
287615316ba8SChristoph Lameter 
2877eef6a7d5SAlan Stern /**
2878eef6a7d5SAlan Stern  * flush_scheduled_work - ensure that any scheduled work has run to completion.
2879eef6a7d5SAlan Stern  *
2880eef6a7d5SAlan Stern  * Forces execution of the kernel-global workqueue and blocks until its
2881eef6a7d5SAlan Stern  * completion.
2882eef6a7d5SAlan Stern  *
2883eef6a7d5SAlan Stern  * Think twice before calling this function!  It's very easy to get into
2884eef6a7d5SAlan Stern  * trouble if you don't take great care.  Either of the following situations
2885eef6a7d5SAlan Stern  * will lead to deadlock:
2886eef6a7d5SAlan Stern  *
2887eef6a7d5SAlan Stern  *	One of the work items currently on the workqueue needs to acquire
2888eef6a7d5SAlan Stern  *	a lock held by your code or its caller.
2889eef6a7d5SAlan Stern  *
2890eef6a7d5SAlan Stern  *	Your code is running in the context of a work routine.
2891eef6a7d5SAlan Stern  *
2892eef6a7d5SAlan Stern  * They will be detected by lockdep when they occur, but the first might not
2893eef6a7d5SAlan Stern  * occur very often.  It depends on what work items are on the workqueue and
2894eef6a7d5SAlan Stern  * what locks they need, which you have no control over.
2895eef6a7d5SAlan Stern  *
2896eef6a7d5SAlan Stern  * In most situations flushing the entire workqueue is overkill; you merely
2897eef6a7d5SAlan Stern  * need to know that a particular work item isn't queued and isn't running.
2898eef6a7d5SAlan Stern  * In such cases you should use cancel_delayed_work_sync() or
2899eef6a7d5SAlan Stern  * cancel_work_sync() instead.
2900eef6a7d5SAlan Stern  */
29011da177e4SLinus Torvalds void flush_scheduled_work(void)
29021da177e4SLinus Torvalds {
2903d320c038STejun Heo 	flush_workqueue(system_wq);
29041da177e4SLinus Torvalds }
2905ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work);
29061da177e4SLinus Torvalds 
29071da177e4SLinus Torvalds /**
29081fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
29091fa44ecaSJames Bottomley  * @fn:		the function to execute
29101fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
29111fa44ecaSJames Bottomley  *		be available when the work executes)
29121fa44ecaSJames Bottomley  *
29131fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
29141fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
29151fa44ecaSJames Bottomley  *
2916d185af30SYacine Belkadi  * Return:	0 - function was executed
29171fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
29181fa44ecaSJames Bottomley  */
291965f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
29201fa44ecaSJames Bottomley {
29211fa44ecaSJames Bottomley 	if (!in_interrupt()) {
292265f27f38SDavid Howells 		fn(&ew->work);
29231fa44ecaSJames Bottomley 		return 0;
29241fa44ecaSJames Bottomley 	}
29251fa44ecaSJames Bottomley 
292665f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
29271fa44ecaSJames Bottomley 	schedule_work(&ew->work);
29281fa44ecaSJames Bottomley 
29291fa44ecaSJames Bottomley 	return 1;
29301fa44ecaSJames Bottomley }
29311fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
29321fa44ecaSJames Bottomley 
2933226223abSTejun Heo #ifdef CONFIG_SYSFS
2934226223abSTejun Heo /*
2935226223abSTejun Heo  * Workqueues with WQ_SYSFS flag set is visible to userland via
2936226223abSTejun Heo  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
2937226223abSTejun Heo  * following attributes.
2938226223abSTejun Heo  *
2939226223abSTejun Heo  *  per_cpu	RO bool	: whether the workqueue is per-cpu or unbound
2940226223abSTejun Heo  *  max_active	RW int	: maximum number of in-flight work items
2941226223abSTejun Heo  *
2942226223abSTejun Heo  * Unbound workqueues have the following extra attributes.
2943226223abSTejun Heo  *
2944226223abSTejun Heo  *  id		RO int	: the associated pool ID
2945226223abSTejun Heo  *  nice	RW int	: nice value of the workers
2946226223abSTejun Heo  *  cpumask	RW mask	: bitmask of allowed CPUs for the workers
2947226223abSTejun Heo  */
2948226223abSTejun Heo struct wq_device {
2949226223abSTejun Heo 	struct workqueue_struct		*wq;
2950226223abSTejun Heo 	struct device			dev;
2951226223abSTejun Heo };
2952226223abSTejun Heo 
2953226223abSTejun Heo static struct workqueue_struct *dev_to_wq(struct device *dev)
2954226223abSTejun Heo {
2955226223abSTejun Heo 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
2956226223abSTejun Heo 
2957226223abSTejun Heo 	return wq_dev->wq;
2958226223abSTejun Heo }
2959226223abSTejun Heo 
29601a6661daSGreg Kroah-Hartman static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
29611a6661daSGreg Kroah-Hartman 			    char *buf)
2962226223abSTejun Heo {
2963226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
2964226223abSTejun Heo 
2965226223abSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
2966226223abSTejun Heo }
29671a6661daSGreg Kroah-Hartman static DEVICE_ATTR_RO(per_cpu);
2968226223abSTejun Heo 
29691a6661daSGreg Kroah-Hartman static ssize_t max_active_show(struct device *dev,
2970226223abSTejun Heo 			       struct device_attribute *attr, char *buf)
2971226223abSTejun Heo {
2972226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
2973226223abSTejun Heo 
2974226223abSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
2975226223abSTejun Heo }
2976226223abSTejun Heo 
29771a6661daSGreg Kroah-Hartman static ssize_t max_active_store(struct device *dev,
29781a6661daSGreg Kroah-Hartman 				struct device_attribute *attr, const char *buf,
29791a6661daSGreg Kroah-Hartman 				size_t count)
2980226223abSTejun Heo {
2981226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
2982226223abSTejun Heo 	int val;
2983226223abSTejun Heo 
2984226223abSTejun Heo 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
2985226223abSTejun Heo 		return -EINVAL;
2986226223abSTejun Heo 
2987226223abSTejun Heo 	workqueue_set_max_active(wq, val);
2988226223abSTejun Heo 	return count;
2989226223abSTejun Heo }
29901a6661daSGreg Kroah-Hartman static DEVICE_ATTR_RW(max_active);
2991226223abSTejun Heo 
29921a6661daSGreg Kroah-Hartman static struct attribute *wq_sysfs_attrs[] = {
29931a6661daSGreg Kroah-Hartman 	&dev_attr_per_cpu.attr,
29941a6661daSGreg Kroah-Hartman 	&dev_attr_max_active.attr,
29951a6661daSGreg Kroah-Hartman 	NULL,
2996226223abSTejun Heo };
29971a6661daSGreg Kroah-Hartman ATTRIBUTE_GROUPS(wq_sysfs);
2998226223abSTejun Heo 
2999d55262c4STejun Heo static ssize_t wq_pool_ids_show(struct device *dev,
3000226223abSTejun Heo 				struct device_attribute *attr, char *buf)
3001226223abSTejun Heo {
3002226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3003d55262c4STejun Heo 	const char *delim = "";
3004d55262c4STejun Heo 	int node, written = 0;
3005226223abSTejun Heo 
3006226223abSTejun Heo 	rcu_read_lock_sched();
3007d55262c4STejun Heo 	for_each_node(node) {
3008d55262c4STejun Heo 		written += scnprintf(buf + written, PAGE_SIZE - written,
3009d55262c4STejun Heo 				     "%s%d:%d", delim, node,
3010d55262c4STejun Heo 				     unbound_pwq_by_node(wq, node)->pool->id);
3011d55262c4STejun Heo 		delim = " ";
3012d55262c4STejun Heo 	}
3013d55262c4STejun Heo 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3014226223abSTejun Heo 	rcu_read_unlock_sched();
3015226223abSTejun Heo 
3016226223abSTejun Heo 	return written;
3017226223abSTejun Heo }
3018226223abSTejun Heo 
3019226223abSTejun Heo static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3020226223abSTejun Heo 			    char *buf)
3021226223abSTejun Heo {
3022226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3023226223abSTejun Heo 	int written;
3024226223abSTejun Heo 
30256029a918STejun Heo 	mutex_lock(&wq->mutex);
30266029a918STejun Heo 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
30276029a918STejun Heo 	mutex_unlock(&wq->mutex);
3028226223abSTejun Heo 
3029226223abSTejun Heo 	return written;
3030226223abSTejun Heo }
3031226223abSTejun Heo 
3032226223abSTejun Heo /* prepare workqueue_attrs for sysfs store operations */
3033226223abSTejun Heo static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3034226223abSTejun Heo {
3035226223abSTejun Heo 	struct workqueue_attrs *attrs;
3036226223abSTejun Heo 
3037226223abSTejun Heo 	attrs = alloc_workqueue_attrs(GFP_KERNEL);
3038226223abSTejun Heo 	if (!attrs)
3039226223abSTejun Heo 		return NULL;
3040226223abSTejun Heo 
30416029a918STejun Heo 	mutex_lock(&wq->mutex);
30426029a918STejun Heo 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
30436029a918STejun Heo 	mutex_unlock(&wq->mutex);
3044226223abSTejun Heo 	return attrs;
3045226223abSTejun Heo }
3046226223abSTejun Heo 
3047226223abSTejun Heo static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3048226223abSTejun Heo 			     const char *buf, size_t count)
3049226223abSTejun Heo {
3050226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3051226223abSTejun Heo 	struct workqueue_attrs *attrs;
3052226223abSTejun Heo 	int ret;
3053226223abSTejun Heo 
3054226223abSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
3055226223abSTejun Heo 	if (!attrs)
3056226223abSTejun Heo 		return -ENOMEM;
3057226223abSTejun Heo 
3058226223abSTejun Heo 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
305914481842SDongsheng Yang 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
3060226223abSTejun Heo 		ret = apply_workqueue_attrs(wq, attrs);
3061226223abSTejun Heo 	else
3062226223abSTejun Heo 		ret = -EINVAL;
3063226223abSTejun Heo 
3064226223abSTejun Heo 	free_workqueue_attrs(attrs);
3065226223abSTejun Heo 	return ret ?: count;
3066226223abSTejun Heo }
3067226223abSTejun Heo 
3068226223abSTejun Heo static ssize_t wq_cpumask_show(struct device *dev,
3069226223abSTejun Heo 			       struct device_attribute *attr, char *buf)
3070226223abSTejun Heo {
3071226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3072226223abSTejun Heo 	int written;
3073226223abSTejun Heo 
30746029a918STejun Heo 	mutex_lock(&wq->mutex);
30756029a918STejun Heo 	written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
30766029a918STejun Heo 	mutex_unlock(&wq->mutex);
3077226223abSTejun Heo 
3078226223abSTejun Heo 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3079226223abSTejun Heo 	return written;
3080226223abSTejun Heo }
3081226223abSTejun Heo 
3082226223abSTejun Heo static ssize_t wq_cpumask_store(struct device *dev,
3083226223abSTejun Heo 				struct device_attribute *attr,
3084226223abSTejun Heo 				const char *buf, size_t count)
3085226223abSTejun Heo {
3086226223abSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3087226223abSTejun Heo 	struct workqueue_attrs *attrs;
3088226223abSTejun Heo 	int ret;
3089226223abSTejun Heo 
3090226223abSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
3091226223abSTejun Heo 	if (!attrs)
3092226223abSTejun Heo 		return -ENOMEM;
3093226223abSTejun Heo 
3094226223abSTejun Heo 	ret = cpumask_parse(buf, attrs->cpumask);
3095226223abSTejun Heo 	if (!ret)
3096226223abSTejun Heo 		ret = apply_workqueue_attrs(wq, attrs);
3097226223abSTejun Heo 
3098226223abSTejun Heo 	free_workqueue_attrs(attrs);
3099226223abSTejun Heo 	return ret ?: count;
3100226223abSTejun Heo }
3101226223abSTejun Heo 
3102d55262c4STejun Heo static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
3103d55262c4STejun Heo 			    char *buf)
3104d55262c4STejun Heo {
3105d55262c4STejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3106d55262c4STejun Heo 	int written;
3107d55262c4STejun Heo 
3108d55262c4STejun Heo 	mutex_lock(&wq->mutex);
3109d55262c4STejun Heo 	written = scnprintf(buf, PAGE_SIZE, "%d\n",
3110d55262c4STejun Heo 			    !wq->unbound_attrs->no_numa);
3111d55262c4STejun Heo 	mutex_unlock(&wq->mutex);
3112d55262c4STejun Heo 
3113d55262c4STejun Heo 	return written;
3114d55262c4STejun Heo }
3115d55262c4STejun Heo 
3116d55262c4STejun Heo static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
3117d55262c4STejun Heo 			     const char *buf, size_t count)
3118d55262c4STejun Heo {
3119d55262c4STejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
3120d55262c4STejun Heo 	struct workqueue_attrs *attrs;
3121d55262c4STejun Heo 	int v, ret;
3122d55262c4STejun Heo 
3123d55262c4STejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
3124d55262c4STejun Heo 	if (!attrs)
3125d55262c4STejun Heo 		return -ENOMEM;
3126d55262c4STejun Heo 
3127d55262c4STejun Heo 	ret = -EINVAL;
3128d55262c4STejun Heo 	if (sscanf(buf, "%d", &v) == 1) {
3129d55262c4STejun Heo 		attrs->no_numa = !v;
3130d55262c4STejun Heo 		ret = apply_workqueue_attrs(wq, attrs);
3131d55262c4STejun Heo 	}
3132d55262c4STejun Heo 
3133d55262c4STejun Heo 	free_workqueue_attrs(attrs);
3134d55262c4STejun Heo 	return ret ?: count;
3135d55262c4STejun Heo }
3136d55262c4STejun Heo 
3137226223abSTejun Heo static struct device_attribute wq_sysfs_unbound_attrs[] = {
3138d55262c4STejun Heo 	__ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
3139226223abSTejun Heo 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3140226223abSTejun Heo 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
3141d55262c4STejun Heo 	__ATTR(numa, 0644, wq_numa_show, wq_numa_store),
3142226223abSTejun Heo 	__ATTR_NULL,
3143226223abSTejun Heo };
3144226223abSTejun Heo 
3145226223abSTejun Heo static struct bus_type wq_subsys = {
3146226223abSTejun Heo 	.name				= "workqueue",
31471a6661daSGreg Kroah-Hartman 	.dev_groups			= wq_sysfs_groups,
3148226223abSTejun Heo };
3149226223abSTejun Heo 
3150226223abSTejun Heo static int __init wq_sysfs_init(void)
3151226223abSTejun Heo {
3152226223abSTejun Heo 	return subsys_virtual_register(&wq_subsys, NULL);
3153226223abSTejun Heo }
3154226223abSTejun Heo core_initcall(wq_sysfs_init);
3155226223abSTejun Heo 
3156226223abSTejun Heo static void wq_device_release(struct device *dev)
3157226223abSTejun Heo {
3158226223abSTejun Heo 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3159226223abSTejun Heo 
3160226223abSTejun Heo 	kfree(wq_dev);
3161226223abSTejun Heo }
3162226223abSTejun Heo 
3163226223abSTejun Heo /**
3164226223abSTejun Heo  * workqueue_sysfs_register - make a workqueue visible in sysfs
3165226223abSTejun Heo  * @wq: the workqueue to register
3166226223abSTejun Heo  *
3167226223abSTejun Heo  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3168226223abSTejun Heo  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3169226223abSTejun Heo  * which is the preferred method.
3170226223abSTejun Heo  *
3171226223abSTejun Heo  * Workqueue user should use this function directly iff it wants to apply
3172226223abSTejun Heo  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3173226223abSTejun Heo  * apply_workqueue_attrs() may race against userland updating the
3174226223abSTejun Heo  * attributes.
3175226223abSTejun Heo  *
3176d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.
3177226223abSTejun Heo  */
3178226223abSTejun Heo int workqueue_sysfs_register(struct workqueue_struct *wq)
3179226223abSTejun Heo {
3180226223abSTejun Heo 	struct wq_device *wq_dev;
3181226223abSTejun Heo 	int ret;
3182226223abSTejun Heo 
3183226223abSTejun Heo 	/*
3184226223abSTejun Heo 	 * Adjusting max_active or creating new pwqs by applyting
3185226223abSTejun Heo 	 * attributes breaks ordering guarantee.  Disallow exposing ordered
3186226223abSTejun Heo 	 * workqueues.
3187226223abSTejun Heo 	 */
3188226223abSTejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
3189226223abSTejun Heo 		return -EINVAL;
3190226223abSTejun Heo 
3191226223abSTejun Heo 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3192226223abSTejun Heo 	if (!wq_dev)
3193226223abSTejun Heo 		return -ENOMEM;
3194226223abSTejun Heo 
3195226223abSTejun Heo 	wq_dev->wq = wq;
3196226223abSTejun Heo 	wq_dev->dev.bus = &wq_subsys;
3197226223abSTejun Heo 	wq_dev->dev.init_name = wq->name;
3198226223abSTejun Heo 	wq_dev->dev.release = wq_device_release;
3199226223abSTejun Heo 
3200226223abSTejun Heo 	/*
3201226223abSTejun Heo 	 * unbound_attrs are created separately.  Suppress uevent until
3202226223abSTejun Heo 	 * everything is ready.
3203226223abSTejun Heo 	 */
3204226223abSTejun Heo 	dev_set_uevent_suppress(&wq_dev->dev, true);
3205226223abSTejun Heo 
3206226223abSTejun Heo 	ret = device_register(&wq_dev->dev);
3207226223abSTejun Heo 	if (ret) {
3208226223abSTejun Heo 		kfree(wq_dev);
3209226223abSTejun Heo 		wq->wq_dev = NULL;
3210226223abSTejun Heo 		return ret;
3211226223abSTejun Heo 	}
3212226223abSTejun Heo 
3213226223abSTejun Heo 	if (wq->flags & WQ_UNBOUND) {
3214226223abSTejun Heo 		struct device_attribute *attr;
3215226223abSTejun Heo 
3216226223abSTejun Heo 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3217226223abSTejun Heo 			ret = device_create_file(&wq_dev->dev, attr);
3218226223abSTejun Heo 			if (ret) {
3219226223abSTejun Heo 				device_unregister(&wq_dev->dev);
3220226223abSTejun Heo 				wq->wq_dev = NULL;
3221226223abSTejun Heo 				return ret;
3222226223abSTejun Heo 			}
3223226223abSTejun Heo 		}
3224226223abSTejun Heo 	}
3225226223abSTejun Heo 
3226226223abSTejun Heo 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3227226223abSTejun Heo 	return 0;
3228226223abSTejun Heo }
3229226223abSTejun Heo 
3230226223abSTejun Heo /**
3231226223abSTejun Heo  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3232226223abSTejun Heo  * @wq: the workqueue to unregister
3233226223abSTejun Heo  *
3234226223abSTejun Heo  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3235226223abSTejun Heo  */
3236226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3237226223abSTejun Heo {
3238226223abSTejun Heo 	struct wq_device *wq_dev = wq->wq_dev;
3239226223abSTejun Heo 
3240226223abSTejun Heo 	if (!wq->wq_dev)
3241226223abSTejun Heo 		return;
3242226223abSTejun Heo 
3243226223abSTejun Heo 	wq->wq_dev = NULL;
3244226223abSTejun Heo 	device_unregister(&wq_dev->dev);
3245226223abSTejun Heo }
3246226223abSTejun Heo #else	/* CONFIG_SYSFS */
3247226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
3248226223abSTejun Heo #endif	/* CONFIG_SYSFS */
3249226223abSTejun Heo 
32507a4e344cSTejun Heo /**
32517a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
32527a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
32537a4e344cSTejun Heo  *
32547a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
32557a4e344cSTejun Heo  */
32567a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs)
32577a4e344cSTejun Heo {
32587a4e344cSTejun Heo 	if (attrs) {
32597a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
32607a4e344cSTejun Heo 		kfree(attrs);
32617a4e344cSTejun Heo 	}
32627a4e344cSTejun Heo }
32637a4e344cSTejun Heo 
32647a4e344cSTejun Heo /**
32657a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
32667a4e344cSTejun Heo  * @gfp_mask: allocation mask to use
32677a4e344cSTejun Heo  *
32687a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
3269d185af30SYacine Belkadi  * return it.
3270d185af30SYacine Belkadi  *
3271d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
32727a4e344cSTejun Heo  */
32737a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
32747a4e344cSTejun Heo {
32757a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
32767a4e344cSTejun Heo 
32777a4e344cSTejun Heo 	attrs = kzalloc(sizeof(*attrs), gfp_mask);
32787a4e344cSTejun Heo 	if (!attrs)
32797a4e344cSTejun Heo 		goto fail;
32807a4e344cSTejun Heo 	if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
32817a4e344cSTejun Heo 		goto fail;
32827a4e344cSTejun Heo 
328313e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
32847a4e344cSTejun Heo 	return attrs;
32857a4e344cSTejun Heo fail:
32867a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
32877a4e344cSTejun Heo 	return NULL;
32887a4e344cSTejun Heo }
32897a4e344cSTejun Heo 
329029c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
329129c91e99STejun Heo 				 const struct workqueue_attrs *from)
329229c91e99STejun Heo {
329329c91e99STejun Heo 	to->nice = from->nice;
329429c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
32952865a8fbSShaohua Li 	/*
32962865a8fbSShaohua Li 	 * Unlike hash and equality test, this function doesn't ignore
32972865a8fbSShaohua Li 	 * ->no_numa as it is used for both pool and wq attrs.  Instead,
32982865a8fbSShaohua Li 	 * get_unbound_pool() explicitly clears ->no_numa after copying.
32992865a8fbSShaohua Li 	 */
33002865a8fbSShaohua Li 	to->no_numa = from->no_numa;
330129c91e99STejun Heo }
330229c91e99STejun Heo 
330329c91e99STejun Heo /* hash value of the content of @attr */
330429c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
330529c91e99STejun Heo {
330629c91e99STejun Heo 	u32 hash = 0;
330729c91e99STejun Heo 
330829c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
330913e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
331013e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
331129c91e99STejun Heo 	return hash;
331229c91e99STejun Heo }
331329c91e99STejun Heo 
331429c91e99STejun Heo /* content equality test */
331529c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
331629c91e99STejun Heo 			  const struct workqueue_attrs *b)
331729c91e99STejun Heo {
331829c91e99STejun Heo 	if (a->nice != b->nice)
331929c91e99STejun Heo 		return false;
332029c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
332129c91e99STejun Heo 		return false;
332229c91e99STejun Heo 	return true;
332329c91e99STejun Heo }
332429c91e99STejun Heo 
33257a4e344cSTejun Heo /**
33267a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
33277a4e344cSTejun Heo  * @pool: worker_pool to initialize
33287a4e344cSTejun Heo  *
33297a4e344cSTejun Heo  * Initiailize a newly zalloc'd @pool.  It also allocates @pool->attrs.
3330d185af30SYacine Belkadi  *
3331d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
333229c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
333329c91e99STejun Heo  * on @pool safely to release it.
33347a4e344cSTejun Heo  */
33357a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
33364e1a1f9aSTejun Heo {
33374e1a1f9aSTejun Heo 	spin_lock_init(&pool->lock);
333829c91e99STejun Heo 	pool->id = -1;
333929c91e99STejun Heo 	pool->cpu = -1;
3340f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
33414e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
33424e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
33434e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
33444e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
33454e1a1f9aSTejun Heo 
33464e1a1f9aSTejun Heo 	init_timer_deferrable(&pool->idle_timer);
33474e1a1f9aSTejun Heo 	pool->idle_timer.function = idle_worker_timeout;
33484e1a1f9aSTejun Heo 	pool->idle_timer.data = (unsigned long)pool;
33494e1a1f9aSTejun Heo 
33504e1a1f9aSTejun Heo 	setup_timer(&pool->mayday_timer, pool_mayday_timeout,
33514e1a1f9aSTejun Heo 		    (unsigned long)pool);
33524e1a1f9aSTejun Heo 
33534e1a1f9aSTejun Heo 	mutex_init(&pool->manager_arb);
335492f9c5c4SLai Jiangshan 	mutex_init(&pool->attach_mutex);
3355da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
33567a4e344cSTejun Heo 
33577cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
335829c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
335929c91e99STejun Heo 	pool->refcnt = 1;
336029c91e99STejun Heo 
336129c91e99STejun Heo 	/* shouldn't fail above this point */
33627a4e344cSTejun Heo 	pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
33637a4e344cSTejun Heo 	if (!pool->attrs)
33647a4e344cSTejun Heo 		return -ENOMEM;
33657a4e344cSTejun Heo 	return 0;
33664e1a1f9aSTejun Heo }
33674e1a1f9aSTejun Heo 
336829c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
336929c91e99STejun Heo {
337029c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
337129c91e99STejun Heo 
33727cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
337329c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
337429c91e99STejun Heo 	kfree(pool);
337529c91e99STejun Heo }
337629c91e99STejun Heo 
337729c91e99STejun Heo /**
337829c91e99STejun Heo  * put_unbound_pool - put a worker_pool
337929c91e99STejun Heo  * @pool: worker_pool to put
338029c91e99STejun Heo  *
338129c91e99STejun Heo  * Put @pool.  If its refcnt reaches zero, it gets destroyed in sched-RCU
3382c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
3383c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
3384c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
3385a892caccSTejun Heo  *
3386a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
338729c91e99STejun Heo  */
338829c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
338929c91e99STejun Heo {
339060f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
339129c91e99STejun Heo 	struct worker *worker;
339229c91e99STejun Heo 
3393a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3394a892caccSTejun Heo 
3395a892caccSTejun Heo 	if (--pool->refcnt)
339629c91e99STejun Heo 		return;
339729c91e99STejun Heo 
339829c91e99STejun Heo 	/* sanity checks */
339961d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
3400a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
340129c91e99STejun Heo 		return;
340229c91e99STejun Heo 
340329c91e99STejun Heo 	/* release id and unhash */
340429c91e99STejun Heo 	if (pool->id >= 0)
340529c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
340629c91e99STejun Heo 	hash_del(&pool->hash_node);
340729c91e99STejun Heo 
3408c5aa87bbSTejun Heo 	/*
3409c5aa87bbSTejun Heo 	 * Become the manager and destroy all workers.  Grabbing
3410c5aa87bbSTejun Heo 	 * manager_arb prevents @pool's workers from blocking on
341192f9c5c4SLai Jiangshan 	 * attach_mutex.
3412c5aa87bbSTejun Heo 	 */
341329c91e99STejun Heo 	mutex_lock(&pool->manager_arb);
341429c91e99STejun Heo 
341560f5a4bcSLai Jiangshan 	spin_lock_irq(&pool->lock);
34161037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
341729c91e99STejun Heo 		destroy_worker(worker);
341829c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
341929c91e99STejun Heo 	spin_unlock_irq(&pool->lock);
342060f5a4bcSLai Jiangshan 
342192f9c5c4SLai Jiangshan 	mutex_lock(&pool->attach_mutex);
3422da028469SLai Jiangshan 	if (!list_empty(&pool->workers))
342360f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
342492f9c5c4SLai Jiangshan 	mutex_unlock(&pool->attach_mutex);
342560f5a4bcSLai Jiangshan 
342660f5a4bcSLai Jiangshan 	if (pool->detach_completion)
342760f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
342860f5a4bcSLai Jiangshan 
342929c91e99STejun Heo 	mutex_unlock(&pool->manager_arb);
343029c91e99STejun Heo 
343129c91e99STejun Heo 	/* shut down the timers */
343229c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
343329c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
343429c91e99STejun Heo 
343529c91e99STejun Heo 	/* sched-RCU protected to allow dereferences from get_work_pool() */
343629c91e99STejun Heo 	call_rcu_sched(&pool->rcu, rcu_free_pool);
343729c91e99STejun Heo }
343829c91e99STejun Heo 
343929c91e99STejun Heo /**
344029c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
344129c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
344229c91e99STejun Heo  *
344329c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
344429c91e99STejun Heo  * reference count and return it.  If there already is a matching
344529c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
3446d185af30SYacine Belkadi  * create a new one.
3447a892caccSTejun Heo  *
3448a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
3449d185af30SYacine Belkadi  *
3450d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
3451d185af30SYacine Belkadi  * On failure, %NULL.
345229c91e99STejun Heo  */
345329c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
345429c91e99STejun Heo {
345529c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
345629c91e99STejun Heo 	struct worker_pool *pool;
3457f3f90ad4STejun Heo 	int node;
345829c91e99STejun Heo 
3459a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
346029c91e99STejun Heo 
346129c91e99STejun Heo 	/* do we already have a matching pool? */
346229c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
346329c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
346429c91e99STejun Heo 			pool->refcnt++;
34653fb1823cSLai Jiangshan 			return pool;
346629c91e99STejun Heo 		}
346729c91e99STejun Heo 	}
346829c91e99STejun Heo 
346929c91e99STejun Heo 	/* nope, create a new one */
347029c91e99STejun Heo 	pool = kzalloc(sizeof(*pool), GFP_KERNEL);
347129c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
347229c91e99STejun Heo 		goto fail;
347329c91e99STejun Heo 
34748864b4e5STejun Heo 	lockdep_set_subclass(&pool->lock, 1);	/* see put_pwq() */
347529c91e99STejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
347629c91e99STejun Heo 
34772865a8fbSShaohua Li 	/*
34782865a8fbSShaohua Li 	 * no_numa isn't a worker_pool attribute, always clear it.  See
34792865a8fbSShaohua Li 	 * 'struct workqueue_attrs' comments for detail.
34802865a8fbSShaohua Li 	 */
34812865a8fbSShaohua Li 	pool->attrs->no_numa = false;
34822865a8fbSShaohua Li 
3483f3f90ad4STejun Heo 	/* if cpumask is contained inside a NUMA node, we belong to that node */
3484f3f90ad4STejun Heo 	if (wq_numa_enabled) {
3485f3f90ad4STejun Heo 		for_each_node(node) {
3486f3f90ad4STejun Heo 			if (cpumask_subset(pool->attrs->cpumask,
3487f3f90ad4STejun Heo 					   wq_numa_possible_cpumask[node])) {
3488f3f90ad4STejun Heo 				pool->node = node;
3489f3f90ad4STejun Heo 				break;
3490f3f90ad4STejun Heo 			}
3491f3f90ad4STejun Heo 		}
3492f3f90ad4STejun Heo 	}
3493f3f90ad4STejun Heo 
349429c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
349529c91e99STejun Heo 		goto fail;
349629c91e99STejun Heo 
349729c91e99STejun Heo 	/* create and start the initial worker */
3498051e1850SLai Jiangshan 	if (!create_worker(pool))
349929c91e99STejun Heo 		goto fail;
350029c91e99STejun Heo 
350129c91e99STejun Heo 	/* install */
350229c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
35033fb1823cSLai Jiangshan 
350429c91e99STejun Heo 	return pool;
350529c91e99STejun Heo fail:
350629c91e99STejun Heo 	if (pool)
350729c91e99STejun Heo 		put_unbound_pool(pool);
350829c91e99STejun Heo 	return NULL;
350929c91e99STejun Heo }
351029c91e99STejun Heo 
35118864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
35128864b4e5STejun Heo {
35138864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
35148864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
35158864b4e5STejun Heo }
35168864b4e5STejun Heo 
35178864b4e5STejun Heo /*
35188864b4e5STejun Heo  * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
35198864b4e5STejun Heo  * and needs to be destroyed.
35208864b4e5STejun Heo  */
35218864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work)
35228864b4e5STejun Heo {
35238864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
35248864b4e5STejun Heo 						  unbound_release_work);
35258864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
35268864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
3527bc0caf09STejun Heo 	bool is_last;
35288864b4e5STejun Heo 
35298864b4e5STejun Heo 	if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
35308864b4e5STejun Heo 		return;
35318864b4e5STejun Heo 
35323c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
35338864b4e5STejun Heo 	list_del_rcu(&pwq->pwqs_node);
3534bc0caf09STejun Heo 	is_last = list_empty(&wq->pwqs);
35353c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
35368864b4e5STejun Heo 
3537a892caccSTejun Heo 	mutex_lock(&wq_pool_mutex);
35388864b4e5STejun Heo 	put_unbound_pool(pool);
3539a892caccSTejun Heo 	mutex_unlock(&wq_pool_mutex);
3540a892caccSTejun Heo 
35418864b4e5STejun Heo 	call_rcu_sched(&pwq->rcu, rcu_free_pwq);
35428864b4e5STejun Heo 
35438864b4e5STejun Heo 	/*
35448864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
35458864b4e5STejun Heo 	 * is gonna access it anymore.  Free it.
35468864b4e5STejun Heo 	 */
35476029a918STejun Heo 	if (is_last) {
35486029a918STejun Heo 		free_workqueue_attrs(wq->unbound_attrs);
35498864b4e5STejun Heo 		kfree(wq);
35508864b4e5STejun Heo 	}
35516029a918STejun Heo }
35528864b4e5STejun Heo 
35530fbd95aaSTejun Heo /**
3554699ce097STejun Heo  * pwq_adjust_max_active - update a pwq's max_active to the current setting
35550fbd95aaSTejun Heo  * @pwq: target pool_workqueue
35560fbd95aaSTejun Heo  *
3557699ce097STejun Heo  * If @pwq isn't freezing, set @pwq->max_active to the associated
3558699ce097STejun Heo  * workqueue's saved_max_active and activate delayed work items
3559699ce097STejun Heo  * accordingly.  If @pwq is freezing, clear @pwq->max_active to zero.
35600fbd95aaSTejun Heo  */
3561699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq)
35620fbd95aaSTejun Heo {
3563699ce097STejun Heo 	struct workqueue_struct *wq = pwq->wq;
3564699ce097STejun Heo 	bool freezable = wq->flags & WQ_FREEZABLE;
3565699ce097STejun Heo 
3566699ce097STejun Heo 	/* for @wq->saved_max_active */
3567a357fc03SLai Jiangshan 	lockdep_assert_held(&wq->mutex);
3568699ce097STejun Heo 
3569699ce097STejun Heo 	/* fast exit for non-freezable wqs */
3570699ce097STejun Heo 	if (!freezable && pwq->max_active == wq->saved_max_active)
3571699ce097STejun Heo 		return;
3572699ce097STejun Heo 
3573a357fc03SLai Jiangshan 	spin_lock_irq(&pwq->pool->lock);
3574699ce097STejun Heo 
357574b414eaSLai Jiangshan 	/*
357674b414eaSLai Jiangshan 	 * During [un]freezing, the caller is responsible for ensuring that
357774b414eaSLai Jiangshan 	 * this function is called at least once after @workqueue_freezing
357874b414eaSLai Jiangshan 	 * is updated and visible.
357974b414eaSLai Jiangshan 	 */
358074b414eaSLai Jiangshan 	if (!freezable || !workqueue_freezing) {
3581699ce097STejun Heo 		pwq->max_active = wq->saved_max_active;
35820fbd95aaSTejun Heo 
35830fbd95aaSTejun Heo 		while (!list_empty(&pwq->delayed_works) &&
35840fbd95aaSTejun Heo 		       pwq->nr_active < pwq->max_active)
35850fbd95aaSTejun Heo 			pwq_activate_first_delayed(pwq);
3586951a078aSLai Jiangshan 
3587951a078aSLai Jiangshan 		/*
3588951a078aSLai Jiangshan 		 * Need to kick a worker after thawed or an unbound wq's
3589951a078aSLai Jiangshan 		 * max_active is bumped.  It's a slow path.  Do it always.
3590951a078aSLai Jiangshan 		 */
3591951a078aSLai Jiangshan 		wake_up_worker(pwq->pool);
3592699ce097STejun Heo 	} else {
3593699ce097STejun Heo 		pwq->max_active = 0;
3594699ce097STejun Heo 	}
3595699ce097STejun Heo 
3596a357fc03SLai Jiangshan 	spin_unlock_irq(&pwq->pool->lock);
35970fbd95aaSTejun Heo }
35980fbd95aaSTejun Heo 
3599e50aba9aSTejun Heo /* initialize newly alloced @pwq which is associated with @wq and @pool */
3600f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3601f147f29eSTejun Heo 		     struct worker_pool *pool)
3602d2c1d404STejun Heo {
3603d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3604d2c1d404STejun Heo 
3605e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
3606e50aba9aSTejun Heo 
3607d2c1d404STejun Heo 	pwq->pool = pool;
3608d2c1d404STejun Heo 	pwq->wq = wq;
3609d2c1d404STejun Heo 	pwq->flush_color = -1;
36108864b4e5STejun Heo 	pwq->refcnt = 1;
3611d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->delayed_works);
36121befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
3613d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
36148864b4e5STejun Heo 	INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3615f147f29eSTejun Heo }
3616d2c1d404STejun Heo 
3617f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
36181befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
3619f147f29eSTejun Heo {
3620f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
3621f147f29eSTejun Heo 
3622f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
362375ccf595STejun Heo 
36241befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
36251befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
36261befcf30STejun Heo 		return;
36271befcf30STejun Heo 
362829b1cb41SLai Jiangshan 	/* set the matching work_color */
362975ccf595STejun Heo 	pwq->work_color = wq->work_color;
3630983ca25eSTejun Heo 
3631983ca25eSTejun Heo 	/* sync max_active to the current setting */
3632983ca25eSTejun Heo 	pwq_adjust_max_active(pwq);
3633983ca25eSTejun Heo 
3634983ca25eSTejun Heo 	/* link in @pwq */
36359e8cd2f5STejun Heo 	list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3636df2d5ae4STejun Heo }
36376029a918STejun Heo 
3638f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3639f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3640f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
3641f147f29eSTejun Heo {
3642f147f29eSTejun Heo 	struct worker_pool *pool;
3643f147f29eSTejun Heo 	struct pool_workqueue *pwq;
3644f147f29eSTejun Heo 
3645f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3646f147f29eSTejun Heo 
3647f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
3648f147f29eSTejun Heo 	if (!pool)
3649f147f29eSTejun Heo 		return NULL;
3650f147f29eSTejun Heo 
3651e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3652f147f29eSTejun Heo 	if (!pwq) {
3653f147f29eSTejun Heo 		put_unbound_pool(pool);
3654f147f29eSTejun Heo 		return NULL;
3655f147f29eSTejun Heo 	}
3656f147f29eSTejun Heo 
3657f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
3658f147f29eSTejun Heo 	return pwq;
3659d2c1d404STejun Heo }
3660d2c1d404STejun Heo 
36614c16bd32STejun Heo /* undo alloc_unbound_pwq(), used only in the error path */
36624c16bd32STejun Heo static void free_unbound_pwq(struct pool_workqueue *pwq)
36634c16bd32STejun Heo {
36644c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
36654c16bd32STejun Heo 
36664c16bd32STejun Heo 	if (pwq) {
36674c16bd32STejun Heo 		put_unbound_pool(pwq->pool);
3668cece95dfSWei Yongjun 		kmem_cache_free(pwq_cache, pwq);
36694c16bd32STejun Heo 	}
36704c16bd32STejun Heo }
36714c16bd32STejun Heo 
36724c16bd32STejun Heo /**
36734c16bd32STejun Heo  * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
36744c16bd32STejun Heo  * @attrs: the wq_attrs of interest
36754c16bd32STejun Heo  * @node: the target NUMA node
36764c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
36774c16bd32STejun Heo  * @cpumask: outarg, the resulting cpumask
36784c16bd32STejun Heo  *
36794c16bd32STejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @node.  If
36804c16bd32STejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during
3681d185af30SYacine Belkadi  * calculation.  The result is stored in @cpumask.
36824c16bd32STejun Heo  *
36834c16bd32STejun Heo  * If NUMA affinity is not enabled, @attrs->cpumask is always used.  If
36844c16bd32STejun Heo  * enabled and @node has online CPUs requested by @attrs, the returned
36854c16bd32STejun Heo  * cpumask is the intersection of the possible CPUs of @node and
36864c16bd32STejun Heo  * @attrs->cpumask.
36874c16bd32STejun Heo  *
36884c16bd32STejun Heo  * The caller is responsible for ensuring that the cpumask of @node stays
36894c16bd32STejun Heo  * stable.
3690d185af30SYacine Belkadi  *
3691d185af30SYacine Belkadi  * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3692d185af30SYacine Belkadi  * %false if equal.
36934c16bd32STejun Heo  */
36944c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
36954c16bd32STejun Heo 				 int cpu_going_down, cpumask_t *cpumask)
36964c16bd32STejun Heo {
3697d55262c4STejun Heo 	if (!wq_numa_enabled || attrs->no_numa)
36984c16bd32STejun Heo 		goto use_dfl;
36994c16bd32STejun Heo 
37004c16bd32STejun Heo 	/* does @node have any online CPUs @attrs wants? */
37014c16bd32STejun Heo 	cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
37024c16bd32STejun Heo 	if (cpu_going_down >= 0)
37034c16bd32STejun Heo 		cpumask_clear_cpu(cpu_going_down, cpumask);
37044c16bd32STejun Heo 
37054c16bd32STejun Heo 	if (cpumask_empty(cpumask))
37064c16bd32STejun Heo 		goto use_dfl;
37074c16bd32STejun Heo 
37084c16bd32STejun Heo 	/* yeap, return possible CPUs in @node that @attrs wants */
37094c16bd32STejun Heo 	cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
37104c16bd32STejun Heo 	return !cpumask_equal(cpumask, attrs->cpumask);
37114c16bd32STejun Heo 
37124c16bd32STejun Heo use_dfl:
37134c16bd32STejun Heo 	cpumask_copy(cpumask, attrs->cpumask);
37144c16bd32STejun Heo 	return false;
37154c16bd32STejun Heo }
37164c16bd32STejun Heo 
37171befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
37181befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
37191befcf30STejun Heo 						   int node,
37201befcf30STejun Heo 						   struct pool_workqueue *pwq)
37211befcf30STejun Heo {
37221befcf30STejun Heo 	struct pool_workqueue *old_pwq;
37231befcf30STejun Heo 
37241befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
37251befcf30STejun Heo 
37261befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
37271befcf30STejun Heo 	link_pwq(pwq);
37281befcf30STejun Heo 
37291befcf30STejun Heo 	old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
37301befcf30STejun Heo 	rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
37311befcf30STejun Heo 	return old_pwq;
37321befcf30STejun Heo }
37331befcf30STejun Heo 
37349e8cd2f5STejun Heo /**
37359e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
37369e8cd2f5STejun Heo  * @wq: the target workqueue
37379e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
37389e8cd2f5STejun Heo  *
37394c16bd32STejun Heo  * Apply @attrs to an unbound workqueue @wq.  Unless disabled, on NUMA
37404c16bd32STejun Heo  * machines, this function maps a separate pwq to each NUMA node with
37414c16bd32STejun Heo  * possibles CPUs in @attrs->cpumask so that work items are affine to the
37424c16bd32STejun Heo  * NUMA node it was issued on.  Older pwqs are released as in-flight work
37434c16bd32STejun Heo  * items finish.  Note that a work item which repeatedly requeues itself
37444c16bd32STejun Heo  * back-to-back will stay on its current pwq.
37459e8cd2f5STejun Heo  *
3746d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
3747d185af30SYacine Belkadi  *
3748d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
37499e8cd2f5STejun Heo  */
37509e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq,
37519e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
37529e8cd2f5STejun Heo {
37534c16bd32STejun Heo 	struct workqueue_attrs *new_attrs, *tmp_attrs;
37544c16bd32STejun Heo 	struct pool_workqueue **pwq_tbl, *dfl_pwq;
3755f147f29eSTejun Heo 	int node, ret;
37569e8cd2f5STejun Heo 
37578719dceaSTejun Heo 	/* only unbound workqueues can change attributes */
37589e8cd2f5STejun Heo 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
37599e8cd2f5STejun Heo 		return -EINVAL;
37609e8cd2f5STejun Heo 
37618719dceaSTejun Heo 	/* creating multiple pwqs breaks ordering guarantee */
37628719dceaSTejun Heo 	if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
37638719dceaSTejun Heo 		return -EINVAL;
37648719dceaSTejun Heo 
3765*ddcb57e2SLai Jiangshan 	pwq_tbl = kzalloc(nr_node_ids * sizeof(pwq_tbl[0]), GFP_KERNEL);
376613e2e556STejun Heo 	new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
37674c16bd32STejun Heo 	tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
37684c16bd32STejun Heo 	if (!pwq_tbl || !new_attrs || !tmp_attrs)
376913e2e556STejun Heo 		goto enomem;
377013e2e556STejun Heo 
37714c16bd32STejun Heo 	/* make a copy of @attrs and sanitize it */
377213e2e556STejun Heo 	copy_workqueue_attrs(new_attrs, attrs);
377313e2e556STejun Heo 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
377413e2e556STejun Heo 
37754c16bd32STejun Heo 	/*
37764c16bd32STejun Heo 	 * We may create multiple pwqs with differing cpumasks.  Make a
37774c16bd32STejun Heo 	 * copy of @new_attrs which will be modified and used to obtain
37784c16bd32STejun Heo 	 * pools.
37794c16bd32STejun Heo 	 */
37804c16bd32STejun Heo 	copy_workqueue_attrs(tmp_attrs, new_attrs);
37819e8cd2f5STejun Heo 
37824c16bd32STejun Heo 	/*
37834c16bd32STejun Heo 	 * CPUs should stay stable across pwq creations and installations.
37844c16bd32STejun Heo 	 * Pin CPUs, determine the target cpumask for each node and create
37854c16bd32STejun Heo 	 * pwqs accordingly.
37864c16bd32STejun Heo 	 */
37874c16bd32STejun Heo 	get_online_cpus();
37884c16bd32STejun Heo 
37894c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
37904c16bd32STejun Heo 
37914c16bd32STejun Heo 	/*
37924c16bd32STejun Heo 	 * If something goes wrong during CPU up/down, we'll fall back to
37934c16bd32STejun Heo 	 * the default pwq covering whole @attrs->cpumask.  Always create
37944c16bd32STejun Heo 	 * it even if we don't use it immediately.
37954c16bd32STejun Heo 	 */
37964c16bd32STejun Heo 	dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
37974c16bd32STejun Heo 	if (!dfl_pwq)
37984c16bd32STejun Heo 		goto enomem_pwq;
37994c16bd32STejun Heo 
38004c16bd32STejun Heo 	for_each_node(node) {
38014c16bd32STejun Heo 		if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
38024c16bd32STejun Heo 			pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
38034c16bd32STejun Heo 			if (!pwq_tbl[node])
38044c16bd32STejun Heo 				goto enomem_pwq;
38054c16bd32STejun Heo 		} else {
38064c16bd32STejun Heo 			dfl_pwq->refcnt++;
38074c16bd32STejun Heo 			pwq_tbl[node] = dfl_pwq;
38084c16bd32STejun Heo 		}
38094c16bd32STejun Heo 	}
38104c16bd32STejun Heo 
38114c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
38124c16bd32STejun Heo 
38134c16bd32STejun Heo 	/* all pwqs have been created successfully, let's install'em */
3814f147f29eSTejun Heo 	mutex_lock(&wq->mutex);
3815a892caccSTejun Heo 
3816f147f29eSTejun Heo 	copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
38174c16bd32STejun Heo 
38184c16bd32STejun Heo 	/* save the previous pwq and install the new one */
3819f147f29eSTejun Heo 	for_each_node(node)
38204c16bd32STejun Heo 		pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
38214c16bd32STejun Heo 
38224c16bd32STejun Heo 	/* @dfl_pwq might not have been used, ensure it's linked */
38234c16bd32STejun Heo 	link_pwq(dfl_pwq);
38244c16bd32STejun Heo 	swap(wq->dfl_pwq, dfl_pwq);
3825f147f29eSTejun Heo 
3826f147f29eSTejun Heo 	mutex_unlock(&wq->mutex);
3827f147f29eSTejun Heo 
38284c16bd32STejun Heo 	/* put the old pwqs */
38294c16bd32STejun Heo 	for_each_node(node)
38304c16bd32STejun Heo 		put_pwq_unlocked(pwq_tbl[node]);
38314c16bd32STejun Heo 	put_pwq_unlocked(dfl_pwq);
38324c16bd32STejun Heo 
38334c16bd32STejun Heo 	put_online_cpus();
38344862125bSTejun Heo 	ret = 0;
38354862125bSTejun Heo 	/* fall through */
38364862125bSTejun Heo out_free:
38374c16bd32STejun Heo 	free_workqueue_attrs(tmp_attrs);
38384862125bSTejun Heo 	free_workqueue_attrs(new_attrs);
38394c16bd32STejun Heo 	kfree(pwq_tbl);
38404862125bSTejun Heo 	return ret;
384113e2e556STejun Heo 
38424c16bd32STejun Heo enomem_pwq:
38434c16bd32STejun Heo 	free_unbound_pwq(dfl_pwq);
38444c16bd32STejun Heo 	for_each_node(node)
38454c16bd32STejun Heo 		if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
38464c16bd32STejun Heo 			free_unbound_pwq(pwq_tbl[node]);
38474c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
38484c16bd32STejun Heo 	put_online_cpus();
384913e2e556STejun Heo enomem:
38504862125bSTejun Heo 	ret = -ENOMEM;
38514862125bSTejun Heo 	goto out_free;
38529e8cd2f5STejun Heo }
38539e8cd2f5STejun Heo 
38544c16bd32STejun Heo /**
38554c16bd32STejun Heo  * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
38564c16bd32STejun Heo  * @wq: the target workqueue
38574c16bd32STejun Heo  * @cpu: the CPU coming up or going down
38584c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
38594c16bd32STejun Heo  *
38604c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
38614c16bd32STejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update NUMA affinity of
38624c16bd32STejun Heo  * @wq accordingly.
38634c16bd32STejun Heo  *
38644c16bd32STejun Heo  * If NUMA affinity can't be adjusted due to memory allocation failure, it
38654c16bd32STejun Heo  * falls back to @wq->dfl_pwq which may not be optimal but is always
38664c16bd32STejun Heo  * correct.
38674c16bd32STejun Heo  *
38684c16bd32STejun Heo  * Note that when the last allowed CPU of a NUMA node goes offline for a
38694c16bd32STejun Heo  * workqueue with a cpumask spanning multiple nodes, the workers which were
38704c16bd32STejun Heo  * already executing the work items for the workqueue will lose their CPU
38714c16bd32STejun Heo  * affinity and may execute on any CPU.  This is similar to how per-cpu
38724c16bd32STejun Heo  * workqueues behave on CPU_DOWN.  If a workqueue user wants strict
38734c16bd32STejun Heo  * affinity, it's the user's responsibility to flush the work item from
38744c16bd32STejun Heo  * CPU_DOWN_PREPARE.
38754c16bd32STejun Heo  */
38764c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
38774c16bd32STejun Heo 				   bool online)
38784c16bd32STejun Heo {
38794c16bd32STejun Heo 	int node = cpu_to_node(cpu);
38804c16bd32STejun Heo 	int cpu_off = online ? -1 : cpu;
38814c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
38824c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
38834c16bd32STejun Heo 	cpumask_t *cpumask;
38844c16bd32STejun Heo 
38854c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
38864c16bd32STejun Heo 
38874c16bd32STejun Heo 	if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
38884c16bd32STejun Heo 		return;
38894c16bd32STejun Heo 
38904c16bd32STejun Heo 	/*
38914c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
38924c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
38934c16bd32STejun Heo 	 * CPU hotplug exclusion.
38944c16bd32STejun Heo 	 */
38954c16bd32STejun Heo 	target_attrs = wq_update_unbound_numa_attrs_buf;
38964c16bd32STejun Heo 	cpumask = target_attrs->cpumask;
38974c16bd32STejun Heo 
38984c16bd32STejun Heo 	mutex_lock(&wq->mutex);
3899d55262c4STejun Heo 	if (wq->unbound_attrs->no_numa)
3900d55262c4STejun Heo 		goto out_unlock;
39014c16bd32STejun Heo 
39024c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
39034c16bd32STejun Heo 	pwq = unbound_pwq_by_node(wq, node);
39044c16bd32STejun Heo 
39054c16bd32STejun Heo 	/*
39064c16bd32STejun Heo 	 * Let's determine what needs to be done.  If the target cpumask is
39074c16bd32STejun Heo 	 * different from wq's, we need to compare it to @pwq's and create
39084c16bd32STejun Heo 	 * a new one if they don't match.  If the target cpumask equals
3909534a3fbbSDaeseok Youn 	 * wq's, the default pwq should be used.
39104c16bd32STejun Heo 	 */
39114c16bd32STejun Heo 	if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
39124c16bd32STejun Heo 		if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
39134c16bd32STejun Heo 			goto out_unlock;
39144c16bd32STejun Heo 	} else {
39154c16bd32STejun Heo 		goto use_dfl_pwq;
39164c16bd32STejun Heo 	}
39174c16bd32STejun Heo 
39184c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
39194c16bd32STejun Heo 
39204c16bd32STejun Heo 	/* create a new pwq */
39214c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
39224c16bd32STejun Heo 	if (!pwq) {
39232d916033SFabian Frederick 		pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
39244c16bd32STejun Heo 			wq->name);
392577f300b1SDaeseok Youn 		mutex_lock(&wq->mutex);
392677f300b1SDaeseok Youn 		goto use_dfl_pwq;
39274c16bd32STejun Heo 	}
39284c16bd32STejun Heo 
39294c16bd32STejun Heo 	/*
39304c16bd32STejun Heo 	 * Install the new pwq.  As this function is called only from CPU
39314c16bd32STejun Heo 	 * hotplug callbacks and applying a new attrs is wrapped with
39324c16bd32STejun Heo 	 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
39334c16bd32STejun Heo 	 * inbetween.
39344c16bd32STejun Heo 	 */
39354c16bd32STejun Heo 	mutex_lock(&wq->mutex);
39364c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, pwq);
39374c16bd32STejun Heo 	goto out_unlock;
39384c16bd32STejun Heo 
39394c16bd32STejun Heo use_dfl_pwq:
39404c16bd32STejun Heo 	spin_lock_irq(&wq->dfl_pwq->pool->lock);
39414c16bd32STejun Heo 	get_pwq(wq->dfl_pwq);
39424c16bd32STejun Heo 	spin_unlock_irq(&wq->dfl_pwq->pool->lock);
39434c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
39444c16bd32STejun Heo out_unlock:
39454c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
39464c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
39474c16bd32STejun Heo }
39484c16bd32STejun Heo 
394930cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
39501da177e4SLinus Torvalds {
395149e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
39528a2b7538STejun Heo 	int cpu, ret;
3953e1d8aa9fSFrederic Weisbecker 
395430cdf249STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
3955420c0ddbSTejun Heo 		wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3956420c0ddbSTejun Heo 		if (!wq->cpu_pwqs)
395730cdf249STejun Heo 			return -ENOMEM;
395830cdf249STejun Heo 
395930cdf249STejun Heo 		for_each_possible_cpu(cpu) {
39607fb98ea7STejun Heo 			struct pool_workqueue *pwq =
39617fb98ea7STejun Heo 				per_cpu_ptr(wq->cpu_pwqs, cpu);
39627a62c2c8STejun Heo 			struct worker_pool *cpu_pools =
3963f02ae73aSTejun Heo 				per_cpu(cpu_worker_pools, cpu);
396430cdf249STejun Heo 
3965f147f29eSTejun Heo 			init_pwq(pwq, wq, &cpu_pools[highpri]);
3966f147f29eSTejun Heo 
3967f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
39681befcf30STejun Heo 			link_pwq(pwq);
3969f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
397030cdf249STejun Heo 		}
397130cdf249STejun Heo 		return 0;
39728a2b7538STejun Heo 	} else if (wq->flags & __WQ_ORDERED) {
39738a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
39748a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
39758a2b7538STejun Heo 		WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
39768a2b7538STejun Heo 			      wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
39778a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
39788a2b7538STejun Heo 		return ret;
39799e8cd2f5STejun Heo 	} else {
39809e8cd2f5STejun Heo 		return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
39819e8cd2f5STejun Heo 	}
39820f900049STejun Heo }
39830f900049STejun Heo 
3984f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
3985f3421797STejun Heo 			       const char *name)
3986b71ab8c2STejun Heo {
3987f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3988f3421797STejun Heo 
3989f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
3990044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3991f3421797STejun Heo 			max_active, name, 1, lim);
3992b71ab8c2STejun Heo 
3993f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
3994b71ab8c2STejun Heo }
3995b71ab8c2STejun Heo 
3996b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
399797e37d7bSTejun Heo 					       unsigned int flags,
39981e19ffc6STejun Heo 					       int max_active,
3999eb13ba87SJohannes Berg 					       struct lock_class_key *key,
4000b196be89STejun Heo 					       const char *lock_name, ...)
40013af24433SOleg Nesterov {
4002df2d5ae4STejun Heo 	size_t tbl_size = 0;
4003ecf6881fSTejun Heo 	va_list args;
40043af24433SOleg Nesterov 	struct workqueue_struct *wq;
400549e3cf44STejun Heo 	struct pool_workqueue *pwq;
4006b196be89STejun Heo 
4007cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
4008cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4009cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
4010cee22a15SViresh Kumar 
4011ecf6881fSTejun Heo 	/* allocate wq and format name */
4012df2d5ae4STejun Heo 	if (flags & WQ_UNBOUND)
4013*ddcb57e2SLai Jiangshan 		tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
4014df2d5ae4STejun Heo 
4015df2d5ae4STejun Heo 	wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
4016b196be89STejun Heo 	if (!wq)
4017d2c1d404STejun Heo 		return NULL;
4018b196be89STejun Heo 
40196029a918STejun Heo 	if (flags & WQ_UNBOUND) {
40206029a918STejun Heo 		wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
40216029a918STejun Heo 		if (!wq->unbound_attrs)
40226029a918STejun Heo 			goto err_free_wq;
40236029a918STejun Heo 	}
40246029a918STejun Heo 
4025ecf6881fSTejun Heo 	va_start(args, lock_name);
4026ecf6881fSTejun Heo 	vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4027b196be89STejun Heo 	va_end(args);
40283af24433SOleg Nesterov 
4029d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
4030b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
40313af24433SOleg Nesterov 
4032b196be89STejun Heo 	/* init wq */
403397e37d7bSTejun Heo 	wq->flags = flags;
4034a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
40353c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
4036112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
403730cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
403873f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
403973f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
4040493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
40413af24433SOleg Nesterov 
4042eb13ba87SJohannes Berg 	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
4043cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
40443af24433SOleg Nesterov 
404530cdf249STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
4046d2c1d404STejun Heo 		goto err_free_wq;
40471537663fSTejun Heo 
4048493008a8STejun Heo 	/*
4049493008a8STejun Heo 	 * Workqueues which may be used during memory reclaim should
4050493008a8STejun Heo 	 * have a rescuer to guarantee forward progress.
4051493008a8STejun Heo 	 */
4052493008a8STejun Heo 	if (flags & WQ_MEM_RECLAIM) {
4053e22bee78STejun Heo 		struct worker *rescuer;
4054e22bee78STejun Heo 
4055f7537df5SLai Jiangshan 		rescuer = alloc_worker(NUMA_NO_NODE);
4056e22bee78STejun Heo 		if (!rescuer)
4057d2c1d404STejun Heo 			goto err_destroy;
4058e22bee78STejun Heo 
4059111c225aSTejun Heo 		rescuer->rescue_wq = wq;
4060111c225aSTejun Heo 		rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
4061b196be89STejun Heo 					       wq->name);
4062d2c1d404STejun Heo 		if (IS_ERR(rescuer->task)) {
4063d2c1d404STejun Heo 			kfree(rescuer);
4064d2c1d404STejun Heo 			goto err_destroy;
4065d2c1d404STejun Heo 		}
4066e22bee78STejun Heo 
4067d2c1d404STejun Heo 		wq->rescuer = rescuer;
406814a40ffcSTejun Heo 		rescuer->task->flags |= PF_NO_SETAFFINITY;
4069e22bee78STejun Heo 		wake_up_process(rescuer->task);
40703af24433SOleg Nesterov 	}
40711537663fSTejun Heo 
4072226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4073226223abSTejun Heo 		goto err_destroy;
4074226223abSTejun Heo 
40753af24433SOleg Nesterov 	/*
407668e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
407768e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
407868e13a67SLai Jiangshan 	 * list.
40793af24433SOleg Nesterov 	 */
408068e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4081a0a1a5fdSTejun Heo 
4082a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
408349e3cf44STejun Heo 	for_each_pwq(pwq, wq)
4084699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4085a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4086a0a1a5fdSTejun Heo 
40873af24433SOleg Nesterov 	list_add(&wq->list, &workqueues);
4088a0a1a5fdSTejun Heo 
408968e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
40903af24433SOleg Nesterov 
40913af24433SOleg Nesterov 	return wq;
4092d2c1d404STejun Heo 
4093d2c1d404STejun Heo err_free_wq:
40946029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
40954690c4abSTejun Heo 	kfree(wq);
4096d2c1d404STejun Heo 	return NULL;
4097d2c1d404STejun Heo err_destroy:
4098d2c1d404STejun Heo 	destroy_workqueue(wq);
40994690c4abSTejun Heo 	return NULL;
41001da177e4SLinus Torvalds }
4101d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
41021da177e4SLinus Torvalds 
41033af24433SOleg Nesterov /**
41043af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
41053af24433SOleg Nesterov  * @wq: target workqueue
41063af24433SOleg Nesterov  *
41073af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
41083af24433SOleg Nesterov  */
41093af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
41103af24433SOleg Nesterov {
411149e3cf44STejun Heo 	struct pool_workqueue *pwq;
41124c16bd32STejun Heo 	int node;
41133af24433SOleg Nesterov 
41149c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
41159c5a2ba7STejun Heo 	drain_workqueue(wq);
4116c8efcc25STejun Heo 
41176183c009STejun Heo 	/* sanity checks */
4118b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
411949e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
41206183c009STejun Heo 		int i;
41216183c009STejun Heo 
412276af4d93STejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++) {
412376af4d93STejun Heo 			if (WARN_ON(pwq->nr_in_flight[i])) {
4124b09f4fd3SLai Jiangshan 				mutex_unlock(&wq->mutex);
41256183c009STejun Heo 				return;
412676af4d93STejun Heo 			}
412776af4d93STejun Heo 		}
412876af4d93STejun Heo 
41295c529597SLai Jiangshan 		if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
41308864b4e5STejun Heo 		    WARN_ON(pwq->nr_active) ||
413176af4d93STejun Heo 		    WARN_ON(!list_empty(&pwq->delayed_works))) {
4132b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
41336183c009STejun Heo 			return;
41346183c009STejun Heo 		}
413576af4d93STejun Heo 	}
4136b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
41376183c009STejun Heo 
4138a0a1a5fdSTejun Heo 	/*
4139a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
4140a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
4141a0a1a5fdSTejun Heo 	 */
414268e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4143d2c1d404STejun Heo 	list_del_init(&wq->list);
414468e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
41453af24433SOleg Nesterov 
4146226223abSTejun Heo 	workqueue_sysfs_unregister(wq);
4147226223abSTejun Heo 
4148493008a8STejun Heo 	if (wq->rescuer) {
4149e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
41508d9df9f0SXiaotian Feng 		kfree(wq->rescuer);
4151493008a8STejun Heo 		wq->rescuer = NULL;
4152e22bee78STejun Heo 	}
4153e22bee78STejun Heo 
41548864b4e5STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
415529c91e99STejun Heo 		/*
41568864b4e5STejun Heo 		 * The base ref is never dropped on per-cpu pwqs.  Directly
41578864b4e5STejun Heo 		 * free the pwqs and wq.
415829c91e99STejun Heo 		 */
41598864b4e5STejun Heo 		free_percpu(wq->cpu_pwqs);
41608864b4e5STejun Heo 		kfree(wq);
41618864b4e5STejun Heo 	} else {
41628864b4e5STejun Heo 		/*
41638864b4e5STejun Heo 		 * We're the sole accessor of @wq at this point.  Directly
41644c16bd32STejun Heo 		 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
41654c16bd32STejun Heo 		 * @wq will be freed when the last pwq is released.
41668864b4e5STejun Heo 		 */
41674c16bd32STejun Heo 		for_each_node(node) {
41684c16bd32STejun Heo 			pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
41694c16bd32STejun Heo 			RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
41704c16bd32STejun Heo 			put_pwq_unlocked(pwq);
41714c16bd32STejun Heo 		}
41724c16bd32STejun Heo 
41734c16bd32STejun Heo 		/*
41744c16bd32STejun Heo 		 * Put dfl_pwq.  @wq may be freed any time after dfl_pwq is
41754c16bd32STejun Heo 		 * put.  Don't access it afterwards.
41764c16bd32STejun Heo 		 */
41774c16bd32STejun Heo 		pwq = wq->dfl_pwq;
41784c16bd32STejun Heo 		wq->dfl_pwq = NULL;
4179dce90d47STejun Heo 		put_pwq_unlocked(pwq);
418029c91e99STejun Heo 	}
41813af24433SOleg Nesterov }
41823af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
41833af24433SOleg Nesterov 
4184dcd989cbSTejun Heo /**
4185dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
4186dcd989cbSTejun Heo  * @wq: target workqueue
4187dcd989cbSTejun Heo  * @max_active: new max_active value.
4188dcd989cbSTejun Heo  *
4189dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
4190dcd989cbSTejun Heo  *
4191dcd989cbSTejun Heo  * CONTEXT:
4192dcd989cbSTejun Heo  * Don't call from IRQ context.
4193dcd989cbSTejun Heo  */
4194dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4195dcd989cbSTejun Heo {
419649e3cf44STejun Heo 	struct pool_workqueue *pwq;
4197dcd989cbSTejun Heo 
41988719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
41998719dceaSTejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
42008719dceaSTejun Heo 		return;
42018719dceaSTejun Heo 
4202f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4203dcd989cbSTejun Heo 
4204a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
4205dcd989cbSTejun Heo 
4206dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
4207dcd989cbSTejun Heo 
4208699ce097STejun Heo 	for_each_pwq(pwq, wq)
4209699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4210dcd989cbSTejun Heo 
4211a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4212dcd989cbSTejun Heo }
4213dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4214dcd989cbSTejun Heo 
4215dcd989cbSTejun Heo /**
4216e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
4217e6267616STejun Heo  *
4218e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
4219e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
4220d185af30SYacine Belkadi  *
4221d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
4222e6267616STejun Heo  */
4223e6267616STejun Heo bool current_is_workqueue_rescuer(void)
4224e6267616STejun Heo {
4225e6267616STejun Heo 	struct worker *worker = current_wq_worker();
4226e6267616STejun Heo 
42276a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
4228e6267616STejun Heo }
4229e6267616STejun Heo 
4230e6267616STejun Heo /**
4231dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
4232dcd989cbSTejun Heo  * @cpu: CPU in question
4233dcd989cbSTejun Heo  * @wq: target workqueue
4234dcd989cbSTejun Heo  *
4235dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
4236dcd989cbSTejun Heo  * no synchronization around this function and the test result is
4237dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4238dcd989cbSTejun Heo  *
4239d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4240d3251859STejun Heo  * Note that both per-cpu and unbound workqueues may be associated with
4241d3251859STejun Heo  * multiple pool_workqueues which have separate congested states.  A
4242d3251859STejun Heo  * workqueue being congested on one CPU doesn't mean the workqueue is also
4243d3251859STejun Heo  * contested on other CPUs / NUMA nodes.
4244d3251859STejun Heo  *
4245d185af30SYacine Belkadi  * Return:
4246dcd989cbSTejun Heo  * %true if congested, %false otherwise.
4247dcd989cbSTejun Heo  */
4248d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4249dcd989cbSTejun Heo {
42507fb98ea7STejun Heo 	struct pool_workqueue *pwq;
425176af4d93STejun Heo 	bool ret;
425276af4d93STejun Heo 
425388109453SLai Jiangshan 	rcu_read_lock_sched();
42547fb98ea7STejun Heo 
4255d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
4256d3251859STejun Heo 		cpu = smp_processor_id();
4257d3251859STejun Heo 
42587fb98ea7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
42597fb98ea7STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
42607fb98ea7STejun Heo 	else
4261df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4262dcd989cbSTejun Heo 
426376af4d93STejun Heo 	ret = !list_empty(&pwq->delayed_works);
426488109453SLai Jiangshan 	rcu_read_unlock_sched();
426576af4d93STejun Heo 
426676af4d93STejun Heo 	return ret;
4267dcd989cbSTejun Heo }
4268dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
4269dcd989cbSTejun Heo 
4270dcd989cbSTejun Heo /**
4271dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
4272dcd989cbSTejun Heo  * @work: the work to be tested
4273dcd989cbSTejun Heo  *
4274dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
4275dcd989cbSTejun Heo  * synchronization around this function and the test result is
4276dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4277dcd989cbSTejun Heo  *
4278d185af30SYacine Belkadi  * Return:
4279dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
4280dcd989cbSTejun Heo  */
4281dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
4282dcd989cbSTejun Heo {
4283fa1b54e6STejun Heo 	struct worker_pool *pool;
4284dcd989cbSTejun Heo 	unsigned long flags;
4285dcd989cbSTejun Heo 	unsigned int ret = 0;
4286dcd989cbSTejun Heo 
4287dcd989cbSTejun Heo 	if (work_pending(work))
4288dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
4289038366c5SLai Jiangshan 
4290fa1b54e6STejun Heo 	local_irq_save(flags);
4291fa1b54e6STejun Heo 	pool = get_work_pool(work);
4292038366c5SLai Jiangshan 	if (pool) {
4293fa1b54e6STejun Heo 		spin_lock(&pool->lock);
4294c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
4295dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
4296fa1b54e6STejun Heo 		spin_unlock(&pool->lock);
4297038366c5SLai Jiangshan 	}
4298fa1b54e6STejun Heo 	local_irq_restore(flags);
4299dcd989cbSTejun Heo 
4300dcd989cbSTejun Heo 	return ret;
4301dcd989cbSTejun Heo }
4302dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
4303dcd989cbSTejun Heo 
43043d1cb205STejun Heo /**
43053d1cb205STejun Heo  * set_worker_desc - set description for the current work item
43063d1cb205STejun Heo  * @fmt: printf-style format string
43073d1cb205STejun Heo  * @...: arguments for the format string
43083d1cb205STejun Heo  *
43093d1cb205STejun Heo  * This function can be called by a running work function to describe what
43103d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
43113d1cb205STejun Heo  * information will be printed out together to help debugging.  The
43123d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
43133d1cb205STejun Heo  */
43143d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
43153d1cb205STejun Heo {
43163d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
43173d1cb205STejun Heo 	va_list args;
43183d1cb205STejun Heo 
43193d1cb205STejun Heo 	if (worker) {
43203d1cb205STejun Heo 		va_start(args, fmt);
43213d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
43223d1cb205STejun Heo 		va_end(args);
43233d1cb205STejun Heo 		worker->desc_valid = true;
43243d1cb205STejun Heo 	}
43253d1cb205STejun Heo }
43263d1cb205STejun Heo 
43273d1cb205STejun Heo /**
43283d1cb205STejun Heo  * print_worker_info - print out worker information and description
43293d1cb205STejun Heo  * @log_lvl: the log level to use when printing
43303d1cb205STejun Heo  * @task: target task
43313d1cb205STejun Heo  *
43323d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
43333d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
43343d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
43353d1cb205STejun Heo  *
43363d1cb205STejun Heo  * This function can be safely called on any task as long as the
43373d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
43383d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
43393d1cb205STejun Heo  */
43403d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
43413d1cb205STejun Heo {
43423d1cb205STejun Heo 	work_func_t *fn = NULL;
43433d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
43443d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
43453d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
43463d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
43473d1cb205STejun Heo 	bool desc_valid = false;
43483d1cb205STejun Heo 	struct worker *worker;
43493d1cb205STejun Heo 
43503d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
43513d1cb205STejun Heo 		return;
43523d1cb205STejun Heo 
43533d1cb205STejun Heo 	/*
43543d1cb205STejun Heo 	 * This function is called without any synchronization and @task
43553d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
43563d1cb205STejun Heo 	 */
43573d1cb205STejun Heo 	worker = probe_kthread_data(task);
43583d1cb205STejun Heo 
43593d1cb205STejun Heo 	/*
43603d1cb205STejun Heo 	 * Carefully copy the associated workqueue's workfn and name.  Keep
43613d1cb205STejun Heo 	 * the original last '\0' in case the original contains garbage.
43623d1cb205STejun Heo 	 */
43633d1cb205STejun Heo 	probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
43643d1cb205STejun Heo 	probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
43653d1cb205STejun Heo 	probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
43663d1cb205STejun Heo 	probe_kernel_read(name, wq->name, sizeof(name) - 1);
43673d1cb205STejun Heo 
43683d1cb205STejun Heo 	/* copy worker description */
43693d1cb205STejun Heo 	probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
43703d1cb205STejun Heo 	if (desc_valid)
43713d1cb205STejun Heo 		probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
43723d1cb205STejun Heo 
43733d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
43743d1cb205STejun Heo 		printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
43753d1cb205STejun Heo 		if (desc[0])
43763d1cb205STejun Heo 			pr_cont(" (%s)", desc);
43773d1cb205STejun Heo 		pr_cont("\n");
43783d1cb205STejun Heo 	}
43793d1cb205STejun Heo }
43803d1cb205STejun Heo 
4381db7bccf4STejun Heo /*
4382db7bccf4STejun Heo  * CPU hotplug.
4383db7bccf4STejun Heo  *
4384e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
4385112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
4386706026c2STejun Heo  * pool which make migrating pending and scheduled works very
4387e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
438894cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
4389e22bee78STejun Heo  * blocked draining impractical.
4390e22bee78STejun Heo  *
439124647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
4392628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
4393628c78e7STejun Heo  * cpu comes back online.
4394db7bccf4STejun Heo  */
4395db7bccf4STejun Heo 
4396706026c2STejun Heo static void wq_unbind_fn(struct work_struct *work)
4397db7bccf4STejun Heo {
439838db41d9STejun Heo 	int cpu = smp_processor_id();
43994ce62e9eSTejun Heo 	struct worker_pool *pool;
4400db7bccf4STejun Heo 	struct worker *worker;
4401db7bccf4STejun Heo 
4402f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
440392f9c5c4SLai Jiangshan 		mutex_lock(&pool->attach_mutex);
440494cf58bbSTejun Heo 		spin_lock_irq(&pool->lock);
4405e22bee78STejun Heo 
4406f2d5a0eeSTejun Heo 		/*
440792f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
440894cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
440994cf58bbSTejun Heo 		 * except for the ones which are still executing works from
441094cf58bbSTejun Heo 		 * before the last CPU down must be on the cpu.  After
441194cf58bbSTejun Heo 		 * this, they may become diasporas.
4412f2d5a0eeSTejun Heo 		 */
4413da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
4414403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
4415db7bccf4STejun Heo 
441624647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
4417f2d5a0eeSTejun Heo 
441894cf58bbSTejun Heo 		spin_unlock_irq(&pool->lock);
441992f9c5c4SLai Jiangshan 		mutex_unlock(&pool->attach_mutex);
4420e22bee78STejun Heo 
4421e22bee78STejun Heo 		/*
4422eb283428SLai Jiangshan 		 * Call schedule() so that we cross rq->lock and thus can
4423eb283428SLai Jiangshan 		 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4424eb283428SLai Jiangshan 		 * This is necessary as scheduler callbacks may be invoked
4425eb283428SLai Jiangshan 		 * from other cpus.
4426628c78e7STejun Heo 		 */
4427628c78e7STejun Heo 		schedule();
4428628c78e7STejun Heo 
4429628c78e7STejun Heo 		/*
4430eb283428SLai Jiangshan 		 * Sched callbacks are disabled now.  Zap nr_running.
4431eb283428SLai Jiangshan 		 * After this, nr_running stays zero and need_more_worker()
4432eb283428SLai Jiangshan 		 * and keep_working() are always true as long as the
4433eb283428SLai Jiangshan 		 * worklist is not empty.  This pool now behaves as an
4434eb283428SLai Jiangshan 		 * unbound (in terms of concurrency management) pool which
4435eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
4436e22bee78STejun Heo 		 */
4437e19e397aSTejun Heo 		atomic_set(&pool->nr_running, 0);
4438eb283428SLai Jiangshan 
4439eb283428SLai Jiangshan 		/*
4440eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
4441eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
4442eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
4443eb283428SLai Jiangshan 		 */
4444eb283428SLai Jiangshan 		spin_lock_irq(&pool->lock);
4445eb283428SLai Jiangshan 		wake_up_worker(pool);
4446eb283428SLai Jiangshan 		spin_unlock_irq(&pool->lock);
4447eb283428SLai Jiangshan 	}
4448db7bccf4STejun Heo }
4449db7bccf4STejun Heo 
4450bd7c089eSTejun Heo /**
4451bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
4452bd7c089eSTejun Heo  * @pool: pool of interest
4453bd7c089eSTejun Heo  *
4454a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
4455bd7c089eSTejun Heo  */
4456bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
4457bd7c089eSTejun Heo {
4458a9ab775bSTejun Heo 	struct worker *worker;
4459bd7c089eSTejun Heo 
446092f9c5c4SLai Jiangshan 	lockdep_assert_held(&pool->attach_mutex);
4461bd7c089eSTejun Heo 
4462bd7c089eSTejun Heo 	/*
4463a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
4464a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
4465a9ab775bSTejun Heo 	 * wake-ups for concurrency management happen, restore CPU affinty
4466a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
4467a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
4468bd7c089eSTejun Heo 	 */
4469da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
4470a9ab775bSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4471a9ab775bSTejun Heo 						  pool->attrs->cpumask) < 0);
4472a9ab775bSTejun Heo 
4473a9ab775bSTejun Heo 	spin_lock_irq(&pool->lock);
44743de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
4475a9ab775bSTejun Heo 
4476da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
4477a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
4478a9ab775bSTejun Heo 
4479a9ab775bSTejun Heo 		/*
4480a9ab775bSTejun Heo 		 * A bound idle worker should actually be on the runqueue
4481a9ab775bSTejun Heo 		 * of the associated CPU for local wake-ups targeting it to
4482a9ab775bSTejun Heo 		 * work.  Kick all idle workers so that they migrate to the
4483a9ab775bSTejun Heo 		 * associated CPU.  Doing this in the same loop as
4484a9ab775bSTejun Heo 		 * replacing UNBOUND with REBOUND is safe as no worker will
4485a9ab775bSTejun Heo 		 * be bound before @pool->lock is released.
4486a9ab775bSTejun Heo 		 */
4487a9ab775bSTejun Heo 		if (worker_flags & WORKER_IDLE)
4488bd7c089eSTejun Heo 			wake_up_process(worker->task);
4489bd7c089eSTejun Heo 
4490bd7c089eSTejun Heo 		/*
4491a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
4492a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
4493a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4494a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
4495a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
4496a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
4497a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
4498a9ab775bSTejun Heo 		 *
4499a9ab775bSTejun Heo 		 * ACCESS_ONCE() is necessary because @worker->flags may be
4500a9ab775bSTejun Heo 		 * tested without holding any lock in
4501a9ab775bSTejun Heo 		 * wq_worker_waking_up().  Without it, NOT_RUNNING test may
4502a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
4503a9ab775bSTejun Heo 		 * management operations.
4504bd7c089eSTejun Heo 		 */
4505a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4506a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
4507a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
4508a9ab775bSTejun Heo 		ACCESS_ONCE(worker->flags) = worker_flags;
4509bd7c089eSTejun Heo 	}
4510a9ab775bSTejun Heo 
4511a9ab775bSTejun Heo 	spin_unlock_irq(&pool->lock);
4512bd7c089eSTejun Heo }
4513bd7c089eSTejun Heo 
45147dbc725eSTejun Heo /**
45157dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
45167dbc725eSTejun Heo  * @pool: unbound pool of interest
45177dbc725eSTejun Heo  * @cpu: the CPU which is coming up
45187dbc725eSTejun Heo  *
45197dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
45207dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
45217dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
45227dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
45237dbc725eSTejun Heo  */
45247dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
45257dbc725eSTejun Heo {
45267dbc725eSTejun Heo 	static cpumask_t cpumask;
45277dbc725eSTejun Heo 	struct worker *worker;
45287dbc725eSTejun Heo 
452992f9c5c4SLai Jiangshan 	lockdep_assert_held(&pool->attach_mutex);
45307dbc725eSTejun Heo 
45317dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
45327dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
45337dbc725eSTejun Heo 		return;
45347dbc725eSTejun Heo 
45357dbc725eSTejun Heo 	/* is @cpu the only online CPU? */
45367dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
45377dbc725eSTejun Heo 	if (cpumask_weight(&cpumask) != 1)
45387dbc725eSTejun Heo 		return;
45397dbc725eSTejun Heo 
45407dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
4541da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
45427dbc725eSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
45437dbc725eSTejun Heo 						  pool->attrs->cpumask) < 0);
45447dbc725eSTejun Heo }
45457dbc725eSTejun Heo 
45468db25e78STejun Heo /*
45478db25e78STejun Heo  * Workqueues should be brought up before normal priority CPU notifiers.
45488db25e78STejun Heo  * This will be registered high priority CPU notifier.
45498db25e78STejun Heo  */
45500db0628dSPaul Gortmaker static int workqueue_cpu_up_callback(struct notifier_block *nfb,
45511da177e4SLinus Torvalds 					       unsigned long action,
45521da177e4SLinus Torvalds 					       void *hcpu)
45531da177e4SLinus Torvalds {
4554d84ff051STejun Heo 	int cpu = (unsigned long)hcpu;
45554ce62e9eSTejun Heo 	struct worker_pool *pool;
45564c16bd32STejun Heo 	struct workqueue_struct *wq;
45577dbc725eSTejun Heo 	int pi;
45581da177e4SLinus Torvalds 
45598db25e78STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
45603af24433SOleg Nesterov 	case CPU_UP_PREPARE:
4561f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
45623ce63377STejun Heo 			if (pool->nr_workers)
45633ce63377STejun Heo 				continue;
4564051e1850SLai Jiangshan 			if (!create_worker(pool))
45653ce63377STejun Heo 				return NOTIFY_BAD;
45663af24433SOleg Nesterov 		}
45671da177e4SLinus Torvalds 		break;
45681da177e4SLinus Torvalds 
456965758202STejun Heo 	case CPU_DOWN_FAILED:
457065758202STejun Heo 	case CPU_ONLINE:
457168e13a67SLai Jiangshan 		mutex_lock(&wq_pool_mutex);
45727dbc725eSTejun Heo 
45737dbc725eSTejun Heo 		for_each_pool(pool, pi) {
457492f9c5c4SLai Jiangshan 			mutex_lock(&pool->attach_mutex);
457594cf58bbSTejun Heo 
45767dbc725eSTejun Heo 			if (pool->cpu == cpu) {
457794cf58bbSTejun Heo 				rebind_workers(pool);
45787dbc725eSTejun Heo 			} else if (pool->cpu < 0) {
45797dbc725eSTejun Heo 				restore_unbound_workers_cpumask(pool, cpu);
45807dbc725eSTejun Heo 			}
458194cf58bbSTejun Heo 
458292f9c5c4SLai Jiangshan 			mutex_unlock(&pool->attach_mutex);
458394cf58bbSTejun Heo 		}
45847dbc725eSTejun Heo 
45854c16bd32STejun Heo 		/* update NUMA affinity of unbound workqueues */
45864c16bd32STejun Heo 		list_for_each_entry(wq, &workqueues, list)
45874c16bd32STejun Heo 			wq_update_unbound_numa(wq, cpu, true);
45884c16bd32STejun Heo 
458968e13a67SLai Jiangshan 		mutex_unlock(&wq_pool_mutex);
45908db25e78STejun Heo 		break;
459165758202STejun Heo 	}
459265758202STejun Heo 	return NOTIFY_OK;
459365758202STejun Heo }
459465758202STejun Heo 
459565758202STejun Heo /*
459665758202STejun Heo  * Workqueues should be brought down after normal priority CPU notifiers.
459765758202STejun Heo  * This will be registered as low priority CPU notifier.
459865758202STejun Heo  */
45990db0628dSPaul Gortmaker static int workqueue_cpu_down_callback(struct notifier_block *nfb,
460065758202STejun Heo 						 unsigned long action,
460165758202STejun Heo 						 void *hcpu)
460265758202STejun Heo {
4603d84ff051STejun Heo 	int cpu = (unsigned long)hcpu;
46048db25e78STejun Heo 	struct work_struct unbind_work;
46054c16bd32STejun Heo 	struct workqueue_struct *wq;
46068db25e78STejun Heo 
460765758202STejun Heo 	switch (action & ~CPU_TASKS_FROZEN) {
460865758202STejun Heo 	case CPU_DOWN_PREPARE:
46094c16bd32STejun Heo 		/* unbinding per-cpu workers should happen on the local CPU */
4610706026c2STejun Heo 		INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
46117635d2fdSJoonsoo Kim 		queue_work_on(cpu, system_highpri_wq, &unbind_work);
46124c16bd32STejun Heo 
46134c16bd32STejun Heo 		/* update NUMA affinity of unbound workqueues */
46144c16bd32STejun Heo 		mutex_lock(&wq_pool_mutex);
46154c16bd32STejun Heo 		list_for_each_entry(wq, &workqueues, list)
46164c16bd32STejun Heo 			wq_update_unbound_numa(wq, cpu, false);
46174c16bd32STejun Heo 		mutex_unlock(&wq_pool_mutex);
46184c16bd32STejun Heo 
46194c16bd32STejun Heo 		/* wait for per-cpu unbinding to finish */
46208db25e78STejun Heo 		flush_work(&unbind_work);
4621440a1136SChuansheng Liu 		destroy_work_on_stack(&unbind_work);
46228db25e78STejun Heo 		break;
462365758202STejun Heo 	}
462465758202STejun Heo 	return NOTIFY_OK;
462565758202STejun Heo }
462665758202STejun Heo 
46272d3854a3SRusty Russell #ifdef CONFIG_SMP
46288ccad40dSRusty Russell 
46292d3854a3SRusty Russell struct work_for_cpu {
4630ed48ece2STejun Heo 	struct work_struct work;
46312d3854a3SRusty Russell 	long (*fn)(void *);
46322d3854a3SRusty Russell 	void *arg;
46332d3854a3SRusty Russell 	long ret;
46342d3854a3SRusty Russell };
46352d3854a3SRusty Russell 
4636ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
46372d3854a3SRusty Russell {
4638ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4639ed48ece2STejun Heo 
46402d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
46412d3854a3SRusty Russell }
46422d3854a3SRusty Russell 
46432d3854a3SRusty Russell /**
46442d3854a3SRusty Russell  * work_on_cpu - run a function in user context on a particular cpu
46452d3854a3SRusty Russell  * @cpu: the cpu to run on
46462d3854a3SRusty Russell  * @fn: the function to run
46472d3854a3SRusty Russell  * @arg: the function arg
46482d3854a3SRusty Russell  *
464931ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
46506b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
4651d185af30SYacine Belkadi  *
4652d185af30SYacine Belkadi  * Return: The value @fn returns.
46532d3854a3SRusty Russell  */
4654d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
46552d3854a3SRusty Russell {
4656ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
46572d3854a3SRusty Russell 
4658ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4659ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
466012997d1aSBjorn Helgaas 	flush_work(&wfc.work);
4661440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
46622d3854a3SRusty Russell 	return wfc.ret;
46632d3854a3SRusty Russell }
46642d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
46652d3854a3SRusty Russell #endif /* CONFIG_SMP */
46662d3854a3SRusty Russell 
4667a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
4668e7577c50SRusty Russell 
4669a0a1a5fdSTejun Heo /**
4670a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
4671a0a1a5fdSTejun Heo  *
467258a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
4673c5aa87bbSTejun Heo  * workqueues will queue new works to their delayed_works list instead of
4674706026c2STejun Heo  * pool->worklist.
4675a0a1a5fdSTejun Heo  *
4676a0a1a5fdSTejun Heo  * CONTEXT:
4677a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4678a0a1a5fdSTejun Heo  */
4679a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
4680a0a1a5fdSTejun Heo {
468124b8a847STejun Heo 	struct workqueue_struct *wq;
468224b8a847STejun Heo 	struct pool_workqueue *pwq;
4683a0a1a5fdSTejun Heo 
468468e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4685a0a1a5fdSTejun Heo 
46866183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
4687a0a1a5fdSTejun Heo 	workqueue_freezing = true;
4688a0a1a5fdSTejun Heo 
468924b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
4690a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
4691699ce097STejun Heo 		for_each_pwq(pwq, wq)
4692699ce097STejun Heo 			pwq_adjust_max_active(pwq);
4693a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
4694a1056305STejun Heo 	}
46955bcab335STejun Heo 
469668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4697a0a1a5fdSTejun Heo }
4698a0a1a5fdSTejun Heo 
4699a0a1a5fdSTejun Heo /**
470058a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
4701a0a1a5fdSTejun Heo  *
4702a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
4703a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
4704a0a1a5fdSTejun Heo  *
4705a0a1a5fdSTejun Heo  * CONTEXT:
470668e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
4707a0a1a5fdSTejun Heo  *
4708d185af30SYacine Belkadi  * Return:
470958a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
471058a69cb4STejun Heo  * is complete.
4711a0a1a5fdSTejun Heo  */
4712a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
4713a0a1a5fdSTejun Heo {
4714a0a1a5fdSTejun Heo 	bool busy = false;
471524b8a847STejun Heo 	struct workqueue_struct *wq;
471624b8a847STejun Heo 	struct pool_workqueue *pwq;
4717a0a1a5fdSTejun Heo 
471868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4719a0a1a5fdSTejun Heo 
47206183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
4721a0a1a5fdSTejun Heo 
472224b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
472324b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
472424b8a847STejun Heo 			continue;
4725a0a1a5fdSTejun Heo 		/*
4726a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
4727a0a1a5fdSTejun Heo 		 * to peek without lock.
4728a0a1a5fdSTejun Heo 		 */
472988109453SLai Jiangshan 		rcu_read_lock_sched();
473024b8a847STejun Heo 		for_each_pwq(pwq, wq) {
47316183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
4732112202d9STejun Heo 			if (pwq->nr_active) {
4733a0a1a5fdSTejun Heo 				busy = true;
473488109453SLai Jiangshan 				rcu_read_unlock_sched();
4735a0a1a5fdSTejun Heo 				goto out_unlock;
4736a0a1a5fdSTejun Heo 			}
4737a0a1a5fdSTejun Heo 		}
473888109453SLai Jiangshan 		rcu_read_unlock_sched();
4739a0a1a5fdSTejun Heo 	}
4740a0a1a5fdSTejun Heo out_unlock:
474168e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4742a0a1a5fdSTejun Heo 	return busy;
4743a0a1a5fdSTejun Heo }
4744a0a1a5fdSTejun Heo 
4745a0a1a5fdSTejun Heo /**
4746a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
4747a0a1a5fdSTejun Heo  *
4748a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
4749706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
4750a0a1a5fdSTejun Heo  *
4751a0a1a5fdSTejun Heo  * CONTEXT:
4752a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
4753a0a1a5fdSTejun Heo  */
4754a0a1a5fdSTejun Heo void thaw_workqueues(void)
4755a0a1a5fdSTejun Heo {
475624b8a847STejun Heo 	struct workqueue_struct *wq;
475724b8a847STejun Heo 	struct pool_workqueue *pwq;
4758a0a1a5fdSTejun Heo 
475968e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4760a0a1a5fdSTejun Heo 
4761a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
4762a0a1a5fdSTejun Heo 		goto out_unlock;
4763a0a1a5fdSTejun Heo 
476474b414eaSLai Jiangshan 	workqueue_freezing = false;
476524b8a847STejun Heo 
476624b8a847STejun Heo 	/* restore max_active and repopulate worklist */
476724b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
4768a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
4769699ce097STejun Heo 		for_each_pwq(pwq, wq)
4770699ce097STejun Heo 			pwq_adjust_max_active(pwq);
4771a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
477224b8a847STejun Heo 	}
477324b8a847STejun Heo 
4774a0a1a5fdSTejun Heo out_unlock:
477568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4776a0a1a5fdSTejun Heo }
4777a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
4778a0a1a5fdSTejun Heo 
4779bce90380STejun Heo static void __init wq_numa_init(void)
4780bce90380STejun Heo {
4781bce90380STejun Heo 	cpumask_var_t *tbl;
4782bce90380STejun Heo 	int node, cpu;
4783bce90380STejun Heo 
4784bce90380STejun Heo 	if (num_possible_nodes() <= 1)
4785bce90380STejun Heo 		return;
4786bce90380STejun Heo 
4787d55262c4STejun Heo 	if (wq_disable_numa) {
4788d55262c4STejun Heo 		pr_info("workqueue: NUMA affinity support disabled\n");
4789d55262c4STejun Heo 		return;
4790d55262c4STejun Heo 	}
4791d55262c4STejun Heo 
47924c16bd32STejun Heo 	wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
47934c16bd32STejun Heo 	BUG_ON(!wq_update_unbound_numa_attrs_buf);
47944c16bd32STejun Heo 
4795bce90380STejun Heo 	/*
4796bce90380STejun Heo 	 * We want masks of possible CPUs of each node which isn't readily
4797bce90380STejun Heo 	 * available.  Build one from cpu_to_node() which should have been
4798bce90380STejun Heo 	 * fully initialized by now.
4799bce90380STejun Heo 	 */
4800*ddcb57e2SLai Jiangshan 	tbl = kzalloc(nr_node_ids * sizeof(tbl[0]), GFP_KERNEL);
4801bce90380STejun Heo 	BUG_ON(!tbl);
4802bce90380STejun Heo 
4803bce90380STejun Heo 	for_each_node(node)
48041be0c25dSTejun Heo 		BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
48051be0c25dSTejun Heo 				node_online(node) ? node : NUMA_NO_NODE));
4806bce90380STejun Heo 
4807bce90380STejun Heo 	for_each_possible_cpu(cpu) {
4808bce90380STejun Heo 		node = cpu_to_node(cpu);
4809bce90380STejun Heo 		if (WARN_ON(node == NUMA_NO_NODE)) {
4810bce90380STejun Heo 			pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
4811bce90380STejun Heo 			/* happens iff arch is bonkers, let's just proceed */
4812bce90380STejun Heo 			return;
4813bce90380STejun Heo 		}
4814bce90380STejun Heo 		cpumask_set_cpu(cpu, tbl[node]);
4815bce90380STejun Heo 	}
4816bce90380STejun Heo 
4817bce90380STejun Heo 	wq_numa_possible_cpumask = tbl;
4818bce90380STejun Heo 	wq_numa_enabled = true;
4819bce90380STejun Heo }
4820bce90380STejun Heo 
48216ee0578bSSuresh Siddha static int __init init_workqueues(void)
48221da177e4SLinus Torvalds {
48237a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
48247a4e344cSTejun Heo 	int i, cpu;
4825c34056a3STejun Heo 
4826e904e6c2STejun Heo 	WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4827e904e6c2STejun Heo 
4828e904e6c2STejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4829e904e6c2STejun Heo 
483065758202STejun Heo 	cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
4831a5b4e57dSLai Jiangshan 	hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
48328b03ae3cSTejun Heo 
4833bce90380STejun Heo 	wq_numa_init();
4834bce90380STejun Heo 
4835706026c2STejun Heo 	/* initialize CPU pools */
483629c91e99STejun Heo 	for_each_possible_cpu(cpu) {
48374ce62e9eSTejun Heo 		struct worker_pool *pool;
48388b03ae3cSTejun Heo 
48397a4e344cSTejun Heo 		i = 0;
4840f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
48417a4e344cSTejun Heo 			BUG_ON(init_worker_pool(pool));
4842ec22ca5eSTejun Heo 			pool->cpu = cpu;
48437a4e344cSTejun Heo 			cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
48447a4e344cSTejun Heo 			pool->attrs->nice = std_nice[i++];
4845f3f90ad4STejun Heo 			pool->node = cpu_to_node(cpu);
48467a4e344cSTejun Heo 
48479daf9e67STejun Heo 			/* alloc pool ID */
484868e13a67SLai Jiangshan 			mutex_lock(&wq_pool_mutex);
48499daf9e67STejun Heo 			BUG_ON(worker_pool_assign_id(pool));
485068e13a67SLai Jiangshan 			mutex_unlock(&wq_pool_mutex);
48514ce62e9eSTejun Heo 		}
48528b03ae3cSTejun Heo 	}
48538b03ae3cSTejun Heo 
4854e22bee78STejun Heo 	/* create the initial worker */
485529c91e99STejun Heo 	for_each_online_cpu(cpu) {
48564ce62e9eSTejun Heo 		struct worker_pool *pool;
4857e22bee78STejun Heo 
4858f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
485924647570STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
4860051e1850SLai Jiangshan 			BUG_ON(!create_worker(pool));
4861e22bee78STejun Heo 		}
48624ce62e9eSTejun Heo 	}
4863e22bee78STejun Heo 
48648a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
486529c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
486629c91e99STejun Heo 		struct workqueue_attrs *attrs;
486729c91e99STejun Heo 
486829c91e99STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
486929c91e99STejun Heo 		attrs->nice = std_nice[i];
487029c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
48718a2b7538STejun Heo 
48728a2b7538STejun Heo 		/*
48738a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
48748a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
48758a2b7538STejun Heo 		 * Turn off NUMA so that dfl_pwq is used for all nodes.
48768a2b7538STejun Heo 		 */
48778a2b7538STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
48788a2b7538STejun Heo 		attrs->nice = std_nice[i];
48798a2b7538STejun Heo 		attrs->no_numa = true;
48808a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
488129c91e99STejun Heo 	}
488229c91e99STejun Heo 
4883d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
48841aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
4885d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
4886f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
4887f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
488824d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
488924d51addSTejun Heo 					      WQ_FREEZABLE, 0);
48900668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
48910668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
48920668106cSViresh Kumar 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
48930668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
48940668106cSViresh Kumar 					      0);
48951aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
48960668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
48970668106cSViresh Kumar 	       !system_power_efficient_wq ||
48980668106cSViresh Kumar 	       !system_freezable_power_efficient_wq);
48996ee0578bSSuresh Siddha 	return 0;
49001da177e4SLinus Torvalds }
49016ee0578bSSuresh Siddha early_initcall(init_workqueues);
4902