xref: /linux-6.15/kernel/workqueue.c (revision 6d25be57)
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  *
249a261491SBenjamin Peterson  * Please read Documentation/core-api/workqueue.rst 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/debug_locks.h>
424e6045f1SJohannes Berg #include <linux/lockdep.h>
43c34056a3STejun Heo #include <linux/idr.h>
4429c91e99STejun Heo #include <linux/jhash.h>
4542f8570fSSasha Levin #include <linux/hashtable.h>
4676af4d93STejun Heo #include <linux/rculist.h>
47bce90380STejun Heo #include <linux/nodemask.h>
484c16bd32STejun Heo #include <linux/moduleparam.h>
493d1cb205STejun Heo #include <linux/uaccess.h>
50c98a9805STal Shorer #include <linux/sched/isolation.h>
5162635ea8SSergey Senozhatsky #include <linux/nmi.h>
52e22bee78STejun Heo 
53ea138446STejun Heo #include "workqueue_internal.h"
541da177e4SLinus Torvalds 
55c8e55f36STejun Heo enum {
56bc2ae0f5STejun Heo 	/*
5724647570STejun Heo 	 * worker_pool flags
58bc2ae0f5STejun Heo 	 *
5924647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
60bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
61bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
62bc2ae0f5STejun Heo 	 * is in effect.
63bc2ae0f5STejun Heo 	 *
64bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
65bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
6624647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
67bc2ae0f5STejun Heo 	 *
68bc3a1afcSTejun Heo 	 * Note that DISASSOCIATED should be flipped only while holding
691258fae7STejun Heo 	 * wq_pool_attach_mutex to avoid changing binding state while
704736cbf7SLai Jiangshan 	 * worker_attach_to_pool() is in progress.
71bc2ae0f5STejun Heo 	 */
72692b4825STejun Heo 	POOL_MANAGER_ACTIVE	= 1 << 0,	/* being managed */
7324647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
74db7bccf4STejun Heo 
75c8e55f36STejun Heo 	/* worker flags */
76c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
77c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
78e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
79fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
80f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
81a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
82e22bee78STejun Heo 
83a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
84a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
85db7bccf4STejun Heo 
86e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
874ce62e9eSTejun Heo 
8829c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
89c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
90db7bccf4STejun Heo 
91e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
92e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
93e22bee78STejun Heo 
943233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
953233cdbdSTejun Heo 						/* call for help after 10ms
963233cdbdSTejun Heo 						   (min two ticks) */
97e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
98e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
991da177e4SLinus Torvalds 
1001da177e4SLinus Torvalds 	/*
101e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
1028698a745SDongsheng Yang 	 * all cpus.  Give MIN_NICE.
103e22bee78STejun Heo 	 */
1048698a745SDongsheng Yang 	RESCUER_NICE_LEVEL	= MIN_NICE,
1058698a745SDongsheng Yang 	HIGHPRI_NICE_LEVEL	= MIN_NICE,
106ecf6881fSTejun Heo 
107ecf6881fSTejun Heo 	WQ_NAME_LEN		= 24,
108c8e55f36STejun Heo };
109c8e55f36STejun Heo 
1101da177e4SLinus Torvalds /*
1114690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1124690c4abSTejun Heo  *
113e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
114e41e704bSTejun Heo  *    everyone else.
1154690c4abSTejun Heo  *
116e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
117e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
118e22bee78STejun Heo  *
119d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1204690c4abSTejun Heo  *
121d565ed63STejun Heo  * X: During normal operation, modification requires pool->lock and should
122d565ed63STejun Heo  *    be done only from local cpu.  Either disabling preemption on local
123d565ed63STejun Heo  *    cpu or grabbing pool->lock is enough for read access.  If
124d565ed63STejun Heo  *    POOL_DISASSOCIATED is set, it's identical to L.
125e22bee78STejun Heo  *
1261258fae7STejun Heo  * A: wq_pool_attach_mutex protected.
127822d8405STejun Heo  *
12868e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
12976af4d93STejun Heo  *
13068e13a67SLai Jiangshan  * PR: wq_pool_mutex protected for writes.  Sched-RCU protected for reads.
1315bcab335STejun Heo  *
1325b95e1afSLai Jiangshan  * PW: wq_pool_mutex and wq->mutex protected for writes.  Either for reads.
1335b95e1afSLai Jiangshan  *
1345b95e1afSLai Jiangshan  * PWR: wq_pool_mutex and wq->mutex protected for writes.  Either or
1355b95e1afSLai Jiangshan  *      sched-RCU for reads.
1365b95e1afSLai Jiangshan  *
1373c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1383c25a55dSLai Jiangshan  *
139b5927605SLai Jiangshan  * WR: wq->mutex protected for writes.  Sched-RCU protected for reads.
1402e109a28STejun Heo  *
1412e109a28STejun Heo  * MD: wq_mayday_lock protected.
1424690c4abSTejun Heo  */
1434690c4abSTejun Heo 
1442eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
145c34056a3STejun Heo 
146bd7bdd43STejun Heo struct worker_pool {
147d565ed63STejun Heo 	spinlock_t		lock;		/* the pool lock */
148d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
149f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1509daf9e67STejun Heo 	int			id;		/* I: pool ID */
15111ebea50STejun Heo 	unsigned int		flags;		/* X: flags */
152bd7bdd43STejun Heo 
15382607adcSTejun Heo 	unsigned long		watchdog_ts;	/* L: watchdog timestamp */
15482607adcSTejun Heo 
155bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
156ea1abd61SLai Jiangshan 
1575826cc8fSLai Jiangshan 	int			nr_workers;	/* L: total number of workers */
1585826cc8fSLai Jiangshan 	int			nr_idle;	/* L: currently idle workers */
159bd7bdd43STejun Heo 
160bd7bdd43STejun Heo 	struct list_head	idle_list;	/* X: list of idle workers */
161bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
162bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	/* L: SOS timer for workers */
163bd7bdd43STejun Heo 
164c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
165c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
166c9e7cf27STejun Heo 						/* L: hash of busy workers */
167c9e7cf27STejun Heo 
1682607d7a6STejun Heo 	struct worker		*manager;	/* L: purely informational */
16992f9c5c4SLai Jiangshan 	struct list_head	workers;	/* A: attached workers */
17060f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
171e19e397aSTejun Heo 
1727cda9aaeSLai Jiangshan 	struct ida		worker_ida;	/* worker IDs for task name */
173e19e397aSTejun Heo 
1747a4e344cSTejun Heo 	struct workqueue_attrs	*attrs;		/* I: worker attributes */
17568e13a67SLai Jiangshan 	struct hlist_node	hash_node;	/* PL: unbound_pool_hash node */
17668e13a67SLai Jiangshan 	int			refcnt;		/* PL: refcnt for unbound pools */
1777a4e344cSTejun Heo 
178e19e397aSTejun Heo 	/*
179e19e397aSTejun Heo 	 * The current concurrency level.  As it's likely to be accessed
180e19e397aSTejun Heo 	 * from other CPUs during try_to_wake_up(), put it in a separate
181e19e397aSTejun Heo 	 * cacheline.
182e19e397aSTejun Heo 	 */
183e19e397aSTejun Heo 	atomic_t		nr_running ____cacheline_aligned_in_smp;
18429c91e99STejun Heo 
18529c91e99STejun Heo 	/*
18629c91e99STejun Heo 	 * Destruction of pool is sched-RCU protected to allow dereferences
18729c91e99STejun Heo 	 * from get_work_pool().
18829c91e99STejun Heo 	 */
18929c91e99STejun Heo 	struct rcu_head		rcu;
1908b03ae3cSTejun Heo } ____cacheline_aligned_in_smp;
1918b03ae3cSTejun Heo 
1928b03ae3cSTejun Heo /*
193112202d9STejun Heo  * The per-pool workqueue.  While queued, the lower WORK_STRUCT_FLAG_BITS
194112202d9STejun Heo  * of work_struct->data are used for flags and the remaining high bits
195112202d9STejun Heo  * point to the pwq; thus, pwqs need to be aligned at two's power of the
196112202d9STejun Heo  * number of flag bits.
1971da177e4SLinus Torvalds  */
198112202d9STejun Heo struct pool_workqueue {
199bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
2004690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
20173f53c4aSTejun Heo 	int			work_color;	/* L: current color */
20273f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
2038864b4e5STejun Heo 	int			refcnt;		/* L: reference count */
20473f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
20573f53c4aSTejun Heo 						/* L: nr of in_flight works */
2061e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
207a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
2081e19ffc6STejun Heo 	struct list_head	delayed_works;	/* L: delayed works */
2093c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2102e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2118864b4e5STejun Heo 
2128864b4e5STejun Heo 	/*
2138864b4e5STejun Heo 	 * Release of unbound pwq is punted to system_wq.  See put_pwq()
2148864b4e5STejun Heo 	 * and pwq_unbound_release_workfn() for details.  pool_workqueue
2158864b4e5STejun Heo 	 * itself is also sched-RCU protected so that the first pwq can be
216b09f4fd3SLai Jiangshan 	 * determined without grabbing wq->mutex.
2178864b4e5STejun Heo 	 */
2188864b4e5STejun Heo 	struct work_struct	unbound_release_work;
2198864b4e5STejun Heo 	struct rcu_head		rcu;
220e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS);
2211da177e4SLinus Torvalds 
2221da177e4SLinus Torvalds /*
22373f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
22473f53c4aSTejun Heo  */
22573f53c4aSTejun Heo struct wq_flusher {
2263c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
2273c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
22873f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
22973f53c4aSTejun Heo };
2301da177e4SLinus Torvalds 
231226223abSTejun Heo struct wq_device;
232226223abSTejun Heo 
23373f53c4aSTejun Heo /*
234c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
235c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
2361da177e4SLinus Torvalds  */
2371da177e4SLinus Torvalds struct workqueue_struct {
2383c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
239e2dca7adSTejun Heo 	struct list_head	list;		/* PR: list of all workqueues */
24073f53c4aSTejun Heo 
2413c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
2423c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
2433c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
244112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
2453c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
2463c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
2473c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
24873f53c4aSTejun Heo 
2492e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
250e22bee78STejun Heo 	struct worker		*rescuer;	/* I: rescue worker */
251e22bee78STejun Heo 
25287fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
253a357fc03SLai Jiangshan 	int			saved_max_active; /* WQ: saved pwq max_active */
254226223abSTejun Heo 
2555b95e1afSLai Jiangshan 	struct workqueue_attrs	*unbound_attrs;	/* PW: only for unbound wqs */
2565b95e1afSLai Jiangshan 	struct pool_workqueue	*dfl_pwq;	/* PW: only for unbound wqs */
2576029a918STejun Heo 
258226223abSTejun Heo #ifdef CONFIG_SYSFS
259226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
260226223abSTejun Heo #endif
2614e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
262669de8bdSBart Van Assche 	char			*lock_name;
263669de8bdSBart Van Assche 	struct lock_class_key	key;
2644e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
2654e6045f1SJohannes Berg #endif
266ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
2672728fd2fSTejun Heo 
268e2dca7adSTejun Heo 	/*
269e2dca7adSTejun Heo 	 * Destruction of workqueue_struct is sched-RCU protected to allow
270e2dca7adSTejun Heo 	 * walking the workqueues list without grabbing wq_pool_mutex.
271e2dca7adSTejun Heo 	 * This is used to dump all workqueues from sysrq.
272e2dca7adSTejun Heo 	 */
273e2dca7adSTejun Heo 	struct rcu_head		rcu;
274e2dca7adSTejun Heo 
2752728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
2762728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
2772728fd2fSTejun Heo 	struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
2785b95e1afSLai Jiangshan 	struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
2791da177e4SLinus Torvalds };
2801da177e4SLinus Torvalds 
281e904e6c2STejun Heo static struct kmem_cache *pwq_cache;
282e904e6c2STejun Heo 
283bce90380STejun Heo static cpumask_var_t *wq_numa_possible_cpumask;
284bce90380STejun Heo 					/* possible CPUs of each node */
285bce90380STejun Heo 
286d55262c4STejun Heo static bool wq_disable_numa;
287d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444);
288d55262c4STejun Heo 
289cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
290552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
291cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
292cee22a15SViresh Kumar 
293863b710bSTejun Heo static bool wq_online;			/* can kworkers be created yet? */
2943347fa09STejun Heo 
295bce90380STejun Heo static bool wq_numa_enabled;		/* unbound NUMA affinity enabled */
296bce90380STejun Heo 
2974c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
2984c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
2994c16bd32STejun Heo 
30068e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
3011258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
3022e109a28STejun Heo static DEFINE_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
303692b4825STejun Heo static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
3045bcab335STejun Heo 
305e2dca7adSTejun Heo static LIST_HEAD(workqueues);		/* PR: list of all workqueues */
30668e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
3077d19c5ceSTejun Heo 
308ef557180SMike Galbraith /* PL: allowable cpus for unbound wqs and work items */
309ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask;
310ef557180SMike Galbraith 
311ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */
312ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last);
313b05a7928SFrederic Weisbecker 
314f303fccbSTejun Heo /*
315f303fccbSTejun Heo  * Local execution of unbound work items is no longer guaranteed.  The
316f303fccbSTejun Heo  * following always forces round-robin CPU selection on unbound work items
317f303fccbSTejun Heo  * to uncover usages which depend on it.
318f303fccbSTejun Heo  */
319f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
320f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true;
321f303fccbSTejun Heo #else
322f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false;
323f303fccbSTejun Heo #endif
324f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
325f303fccbSTejun Heo 
3267d19c5ceSTejun Heo /* the per-cpu worker pools */
32725528213SPeter Zijlstra static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
3287d19c5ceSTejun Heo 
32968e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
3307d19c5ceSTejun Heo 
33168e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
33229c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
33329c91e99STejun Heo 
334c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
33529c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
33629c91e99STejun Heo 
3378a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
3388a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
3398a2b7538STejun Heo 
340d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
341ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
342044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
3431aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
344044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
345d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
346044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
347f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
348044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
34924d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
3500668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly;
3510668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
3520668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
3530668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
354d320c038STejun Heo 
3557d19c5ceSTejun Heo static int worker_thread(void *__worker);
3566ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
3577d19c5ceSTejun Heo 
35897bd2347STejun Heo #define CREATE_TRACE_POINTS
35997bd2347STejun Heo #include <trace/events/workqueue.h>
36097bd2347STejun Heo 
36168e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
362f78f5b90SPaul E. McKenney 	RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() &&			\
363f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
36468e13a67SLai Jiangshan 			 "sched RCU or wq_pool_mutex should be held")
3655bcab335STejun Heo 
366b09f4fd3SLai Jiangshan #define assert_rcu_or_wq_mutex(wq)					\
367f78f5b90SPaul E. McKenney 	RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() &&			\
368f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex),			\
369b09f4fd3SLai Jiangshan 			 "sched RCU or wq->mutex should be held")
37076af4d93STejun Heo 
3715b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)			\
372f78f5b90SPaul E. McKenney 	RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() &&			\
373f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex) &&		\
374f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
3755b95e1afSLai Jiangshan 			 "sched RCU, wq->mutex or wq_pool_mutex should be held")
3765b95e1afSLai Jiangshan 
377f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
378f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
379f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
3807a62c2c8STejun Heo 	     (pool)++)
3814ce62e9eSTejun Heo 
38249e3cf44STejun Heo /**
38317116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
38417116969STejun Heo  * @pool: iteration cursor
385611c92a0STejun Heo  * @pi: integer used for iteration
386fa1b54e6STejun Heo  *
38768e13a67SLai Jiangshan  * This must be called either with wq_pool_mutex held or sched RCU read
38868e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
38968e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
390fa1b54e6STejun Heo  *
391fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
392fa1b54e6STejun Heo  * ignored.
39317116969STejun Heo  */
394611c92a0STejun Heo #define for_each_pool(pool, pi)						\
395611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
39668e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
397fa1b54e6STejun Heo 		else
39817116969STejun Heo 
39917116969STejun Heo /**
400822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
401822d8405STejun Heo  * @worker: iteration cursor
402822d8405STejun Heo  * @pool: worker_pool to iterate workers of
403822d8405STejun Heo  *
4041258fae7STejun Heo  * This must be called with wq_pool_attach_mutex.
405822d8405STejun Heo  *
406822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
407822d8405STejun Heo  * ignored.
408822d8405STejun Heo  */
409da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
410da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
4111258fae7STejun Heo 		if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
412822d8405STejun Heo 		else
413822d8405STejun Heo 
414822d8405STejun Heo /**
41549e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
41649e3cf44STejun Heo  * @pwq: iteration cursor
41749e3cf44STejun Heo  * @wq: the target workqueue
41876af4d93STejun Heo  *
419b09f4fd3SLai Jiangshan  * This must be called either with wq->mutex held or sched RCU read locked.
420794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
421794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
42276af4d93STejun Heo  *
42376af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
42476af4d93STejun Heo  * ignored.
42549e3cf44STejun Heo  */
42649e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
42776af4d93STejun Heo 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node)		\
428b09f4fd3SLai Jiangshan 		if (({ assert_rcu_or_wq_mutex(wq); false; })) { }	\
42976af4d93STejun Heo 		else
430f3421797STejun Heo 
431dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
432dc186ad7SThomas Gleixner 
433dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr;
434dc186ad7SThomas Gleixner 
43599777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
43699777288SStanislaw Gruszka {
43799777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
43899777288SStanislaw Gruszka }
43999777288SStanislaw Gruszka 
440b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr)
441b9fdac7fSDu, Changbin {
442b9fdac7fSDu, Changbin 	struct work_struct *work = addr;
443b9fdac7fSDu, Changbin 
444b9fdac7fSDu, Changbin 	return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
445b9fdac7fSDu, Changbin }
446b9fdac7fSDu, Changbin 
447dc186ad7SThomas Gleixner /*
448dc186ad7SThomas Gleixner  * fixup_init is called when:
449dc186ad7SThomas Gleixner  * - an active object is initialized
450dc186ad7SThomas Gleixner  */
45102a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state)
452dc186ad7SThomas Gleixner {
453dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
454dc186ad7SThomas Gleixner 
455dc186ad7SThomas Gleixner 	switch (state) {
456dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
457dc186ad7SThomas Gleixner 		cancel_work_sync(work);
458dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
45902a982a6SDu, Changbin 		return true;
460dc186ad7SThomas Gleixner 	default:
46102a982a6SDu, Changbin 		return false;
462dc186ad7SThomas Gleixner 	}
463dc186ad7SThomas Gleixner }
464dc186ad7SThomas Gleixner 
465dc186ad7SThomas Gleixner /*
466dc186ad7SThomas Gleixner  * fixup_free is called when:
467dc186ad7SThomas Gleixner  * - an active object is freed
468dc186ad7SThomas Gleixner  */
46902a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state)
470dc186ad7SThomas Gleixner {
471dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
472dc186ad7SThomas Gleixner 
473dc186ad7SThomas Gleixner 	switch (state) {
474dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
475dc186ad7SThomas Gleixner 		cancel_work_sync(work);
476dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
47702a982a6SDu, Changbin 		return true;
478dc186ad7SThomas Gleixner 	default:
47902a982a6SDu, Changbin 		return false;
480dc186ad7SThomas Gleixner 	}
481dc186ad7SThomas Gleixner }
482dc186ad7SThomas Gleixner 
483dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = {
484dc186ad7SThomas Gleixner 	.name		= "work_struct",
48599777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
486b9fdac7fSDu, Changbin 	.is_static_object = work_is_static_object,
487dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
488dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
489dc186ad7SThomas Gleixner };
490dc186ad7SThomas Gleixner 
491dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
492dc186ad7SThomas Gleixner {
493dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
494dc186ad7SThomas Gleixner }
495dc186ad7SThomas Gleixner 
496dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
497dc186ad7SThomas Gleixner {
498dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
499dc186ad7SThomas Gleixner }
500dc186ad7SThomas Gleixner 
501dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
502dc186ad7SThomas Gleixner {
503dc186ad7SThomas Gleixner 	if (onstack)
504dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
505dc186ad7SThomas Gleixner 	else
506dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
507dc186ad7SThomas Gleixner }
508dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
509dc186ad7SThomas Gleixner 
510dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
511dc186ad7SThomas Gleixner {
512dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
513dc186ad7SThomas Gleixner }
514dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
515dc186ad7SThomas Gleixner 
516ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
517ea2e64f2SThomas Gleixner {
518ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
519ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
520ea2e64f2SThomas Gleixner }
521ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
522ea2e64f2SThomas Gleixner 
523dc186ad7SThomas Gleixner #else
524dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
525dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
526dc186ad7SThomas Gleixner #endif
527dc186ad7SThomas Gleixner 
5284e8b22bdSLi Bin /**
5294e8b22bdSLi Bin  * worker_pool_assign_id - allocate ID and assing it to @pool
5304e8b22bdSLi Bin  * @pool: the pool pointer of interest
5314e8b22bdSLi Bin  *
5324e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
5334e8b22bdSLi Bin  * successfully, -errno on failure.
5344e8b22bdSLi Bin  */
5359daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
5369daf9e67STejun Heo {
5379daf9e67STejun Heo 	int ret;
5389daf9e67STejun Heo 
53968e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5405bcab335STejun Heo 
5414e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
5424e8b22bdSLi Bin 			GFP_KERNEL);
543229641a6STejun Heo 	if (ret >= 0) {
544e68035fbSTejun Heo 		pool->id = ret;
545229641a6STejun Heo 		return 0;
546229641a6STejun Heo 	}
5479daf9e67STejun Heo 	return ret;
5489daf9e67STejun Heo }
5499daf9e67STejun Heo 
55076af4d93STejun Heo /**
551df2d5ae4STejun Heo  * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
552df2d5ae4STejun Heo  * @wq: the target workqueue
553df2d5ae4STejun Heo  * @node: the node ID
554df2d5ae4STejun Heo  *
5555b95e1afSLai Jiangshan  * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
5565b95e1afSLai Jiangshan  * read locked.
557df2d5ae4STejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
558df2d5ae4STejun Heo  * responsible for guaranteeing that the pwq stays online.
559d185af30SYacine Belkadi  *
560d185af30SYacine Belkadi  * Return: The unbound pool_workqueue for @node.
561df2d5ae4STejun Heo  */
562df2d5ae4STejun Heo static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
563df2d5ae4STejun Heo 						  int node)
564df2d5ae4STejun Heo {
5655b95e1afSLai Jiangshan 	assert_rcu_or_wq_mutex_or_pool_mutex(wq);
566d6e022f1STejun Heo 
567d6e022f1STejun Heo 	/*
568d6e022f1STejun Heo 	 * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
569d6e022f1STejun Heo 	 * delayed item is pending.  The plan is to keep CPU -> NODE
570d6e022f1STejun Heo 	 * mapping valid and stable across CPU on/offlines.  Once that
571d6e022f1STejun Heo 	 * happens, this workaround can be removed.
572d6e022f1STejun Heo 	 */
573d6e022f1STejun Heo 	if (unlikely(node == NUMA_NO_NODE))
574d6e022f1STejun Heo 		return wq->dfl_pwq;
575d6e022f1STejun Heo 
576df2d5ae4STejun Heo 	return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
577df2d5ae4STejun Heo }
578df2d5ae4STejun Heo 
57973f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
58073f53c4aSTejun Heo {
58173f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
58273f53c4aSTejun Heo }
58373f53c4aSTejun Heo 
58473f53c4aSTejun Heo static int get_work_color(struct work_struct *work)
58573f53c4aSTejun Heo {
58673f53c4aSTejun Heo 	return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
58773f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
58873f53c4aSTejun Heo }
58973f53c4aSTejun Heo 
59073f53c4aSTejun Heo static int work_next_color(int color)
59173f53c4aSTejun Heo {
59273f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
593a848e3b6SOleg Nesterov }
594a848e3b6SOleg Nesterov 
5954594bf15SDavid Howells /*
596112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
597112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
5987c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
5997a22ad75STejun Heo  *
600112202d9STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
601112202d9STejun Heo  * and clear_work_data() can be used to set the pwq, pool or clear
602bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
603bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
6047a22ad75STejun Heo  *
605112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
6067c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
607112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
6087c3eed5cSTejun Heo  * available only while the work item is queued.
609bbb68dfaSTejun Heo  *
610bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
611bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
612bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
613bbb68dfaSTejun Heo  * try to steal the PENDING bit.
6144594bf15SDavid Howells  */
6157a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
6167a22ad75STejun Heo 				 unsigned long flags)
6177a22ad75STejun Heo {
6186183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
6197a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
6207a22ad75STejun Heo }
6217a22ad75STejun Heo 
622112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
6234690c4abSTejun Heo 			 unsigned long extra_flags)
624365970a1SDavid Howells {
625112202d9STejun Heo 	set_work_data(work, (unsigned long)pwq,
626112202d9STejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
627365970a1SDavid Howells }
628365970a1SDavid Howells 
6294468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
6304468a00fSLai Jiangshan 					   int pool_id)
6314468a00fSLai Jiangshan {
6324468a00fSLai Jiangshan 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
6334468a00fSLai Jiangshan 		      WORK_STRUCT_PENDING);
6344468a00fSLai Jiangshan }
6354468a00fSLai Jiangshan 
6367c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
6377c3eed5cSTejun Heo 					    int pool_id)
6384d707b9fSOleg Nesterov {
63923657bb1STejun Heo 	/*
64023657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
64123657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
64223657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
64323657bb1STejun Heo 	 * owner.
64423657bb1STejun Heo 	 */
64523657bb1STejun Heo 	smp_wmb();
6467c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
647346c09f8SRoman Pen 	/*
648346c09f8SRoman Pen 	 * The following mb guarantees that previous clear of a PENDING bit
649346c09f8SRoman Pen 	 * will not be reordered with any speculative LOADS or STORES from
650346c09f8SRoman Pen 	 * work->current_func, which is executed afterwards.  This possible
6518bdc6201SLiu Song 	 * reordering can lead to a missed execution on attempt to queue
652346c09f8SRoman Pen 	 * the same @work.  E.g. consider this case:
653346c09f8SRoman Pen 	 *
654346c09f8SRoman Pen 	 *   CPU#0                         CPU#1
655346c09f8SRoman Pen 	 *   ----------------------------  --------------------------------
656346c09f8SRoman Pen 	 *
657346c09f8SRoman Pen 	 * 1  STORE event_indicated
658346c09f8SRoman Pen 	 * 2  queue_work_on() {
659346c09f8SRoman Pen 	 * 3    test_and_set_bit(PENDING)
660346c09f8SRoman Pen 	 * 4 }                             set_..._and_clear_pending() {
661346c09f8SRoman Pen 	 * 5                                 set_work_data() # clear bit
662346c09f8SRoman Pen 	 * 6                                 smp_mb()
663346c09f8SRoman Pen 	 * 7                               work->current_func() {
664346c09f8SRoman Pen 	 * 8				      LOAD event_indicated
665346c09f8SRoman Pen 	 *				   }
666346c09f8SRoman Pen 	 *
667346c09f8SRoman Pen 	 * Without an explicit full barrier speculative LOAD on line 8 can
668346c09f8SRoman Pen 	 * be executed before CPU#0 does STORE on line 1.  If that happens,
669346c09f8SRoman Pen 	 * CPU#0 observes the PENDING bit is still set and new execution of
670346c09f8SRoman Pen 	 * a @work is not queued in a hope, that CPU#1 will eventually
671346c09f8SRoman Pen 	 * finish the queued @work.  Meanwhile CPU#1 does not see
672346c09f8SRoman Pen 	 * event_indicated is set, because speculative LOAD was executed
673346c09f8SRoman Pen 	 * before actual STORE.
674346c09f8SRoman Pen 	 */
675346c09f8SRoman Pen 	smp_mb();
6764d707b9fSOleg Nesterov }
6774d707b9fSOleg Nesterov 
6787a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
679365970a1SDavid Howells {
6807c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
6817c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
6827a22ad75STejun Heo }
6837a22ad75STejun Heo 
684112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
6857a22ad75STejun Heo {
686e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
6877a22ad75STejun Heo 
688112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
689e120153dSTejun Heo 		return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
690e120153dSTejun Heo 	else
691e120153dSTejun Heo 		return NULL;
6927a22ad75STejun Heo }
6937a22ad75STejun Heo 
6947c3eed5cSTejun Heo /**
6957c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
6967c3eed5cSTejun Heo  * @work: the work item of interest
6977c3eed5cSTejun Heo  *
69868e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
69968e13a67SLai Jiangshan  * access under sched-RCU read lock.  As such, this function should be
70068e13a67SLai Jiangshan  * called under wq_pool_mutex or with preemption disabled.
701fa1b54e6STejun Heo  *
702fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
703fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
704fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
705fa1b54e6STejun Heo  * returned pool is and stays online.
706d185af30SYacine Belkadi  *
707d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
7087c3eed5cSTejun Heo  */
7097c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
7107a22ad75STejun Heo {
711e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
7127c3eed5cSTejun Heo 	int pool_id;
7137a22ad75STejun Heo 
71468e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
715fa1b54e6STejun Heo 
716112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
717112202d9STejun Heo 		return ((struct pool_workqueue *)
7187c3eed5cSTejun Heo 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool;
7197a22ad75STejun Heo 
7207c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
7217c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
7227a22ad75STejun Heo 		return NULL;
7237a22ad75STejun Heo 
724fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
7257c3eed5cSTejun Heo }
7267c3eed5cSTejun Heo 
7277c3eed5cSTejun Heo /**
7287c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
7297c3eed5cSTejun Heo  * @work: the work item of interest
7307c3eed5cSTejun Heo  *
731d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
7327c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
7337c3eed5cSTejun Heo  */
7347c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
7357c3eed5cSTejun Heo {
73654d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
7377c3eed5cSTejun Heo 
738112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
739112202d9STejun Heo 		return ((struct pool_workqueue *)
74054d5b7d0SLai Jiangshan 			(data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
74154d5b7d0SLai Jiangshan 
74254d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
7437c3eed5cSTejun Heo }
7447c3eed5cSTejun Heo 
745bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
746bbb68dfaSTejun Heo {
7477c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
748bbb68dfaSTejun Heo 
7497c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
7507c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
751bbb68dfaSTejun Heo }
752bbb68dfaSTejun Heo 
753bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
754bbb68dfaSTejun Heo {
755bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
756bbb68dfaSTejun Heo 
757112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
758bbb68dfaSTejun Heo }
759bbb68dfaSTejun Heo 
760e22bee78STejun Heo /*
7613270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
7623270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
763d565ed63STejun Heo  * they're being called with pool->lock held.
764e22bee78STejun Heo  */
765e22bee78STejun Heo 
76663d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool)
767649027d7STejun Heo {
768e19e397aSTejun Heo 	return !atomic_read(&pool->nr_running);
769649027d7STejun Heo }
770649027d7STejun Heo 
771e22bee78STejun Heo /*
772e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
773e22bee78STejun Heo  * running workers.
774974271c4STejun Heo  *
775974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
776706026c2STejun Heo  * function will always return %true for unbound pools as long as the
777974271c4STejun Heo  * worklist isn't empty.
778e22bee78STejun Heo  */
77963d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
780e22bee78STejun Heo {
78163d95a91STejun Heo 	return !list_empty(&pool->worklist) && __need_more_worker(pool);
782e22bee78STejun Heo }
783e22bee78STejun Heo 
784e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
78563d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
786e22bee78STejun Heo {
78763d95a91STejun Heo 	return pool->nr_idle;
788e22bee78STejun Heo }
789e22bee78STejun Heo 
790e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
79163d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
792e22bee78STejun Heo {
793e19e397aSTejun Heo 	return !list_empty(&pool->worklist) &&
794e19e397aSTejun Heo 		atomic_read(&pool->nr_running) <= 1;
795e22bee78STejun Heo }
796e22bee78STejun Heo 
797e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
79863d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
799e22bee78STejun Heo {
80063d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
801e22bee78STejun Heo }
802e22bee78STejun Heo 
803e22bee78STejun Heo /* Do we have too many workers and should some go away? */
80463d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
805e22bee78STejun Heo {
806692b4825STejun Heo 	bool managing = pool->flags & POOL_MANAGER_ACTIVE;
80763d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
80863d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
809e22bee78STejun Heo 
810e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
811e22bee78STejun Heo }
812e22bee78STejun Heo 
813e22bee78STejun Heo /*
814e22bee78STejun Heo  * Wake up functions.
815e22bee78STejun Heo  */
816e22bee78STejun Heo 
8171037de36SLai Jiangshan /* Return the first idle worker.  Safe with preemption disabled */
8181037de36SLai Jiangshan static struct worker *first_idle_worker(struct worker_pool *pool)
8197e11629dSTejun Heo {
82063d95a91STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
8217e11629dSTejun Heo 		return NULL;
8227e11629dSTejun Heo 
82363d95a91STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
8247e11629dSTejun Heo }
8257e11629dSTejun Heo 
8267e11629dSTejun Heo /**
8277e11629dSTejun Heo  * wake_up_worker - wake up an idle worker
82863d95a91STejun Heo  * @pool: worker pool to wake worker from
8297e11629dSTejun Heo  *
83063d95a91STejun Heo  * Wake up the first idle worker of @pool.
8317e11629dSTejun Heo  *
8327e11629dSTejun Heo  * CONTEXT:
833d565ed63STejun Heo  * spin_lock_irq(pool->lock).
8347e11629dSTejun Heo  */
83563d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool)
8367e11629dSTejun Heo {
8371037de36SLai Jiangshan 	struct worker *worker = first_idle_worker(pool);
8387e11629dSTejun Heo 
8397e11629dSTejun Heo 	if (likely(worker))
8407e11629dSTejun Heo 		wake_up_process(worker->task);
8417e11629dSTejun Heo }
8427e11629dSTejun Heo 
8434690c4abSTejun Heo /**
844*6d25be57SThomas Gleixner  * wq_worker_running - a worker is running again
845e22bee78STejun Heo  * @task: task waking up
846e22bee78STejun Heo  *
847*6d25be57SThomas Gleixner  * This function is called when a worker returns from schedule()
848e22bee78STejun Heo  */
849*6d25be57SThomas Gleixner void wq_worker_running(struct task_struct *task)
850e22bee78STejun Heo {
851e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
852e22bee78STejun Heo 
853*6d25be57SThomas Gleixner 	if (!worker->sleeping)
854*6d25be57SThomas Gleixner 		return;
855*6d25be57SThomas Gleixner 	if (!(worker->flags & WORKER_NOT_RUNNING))
856e19e397aSTejun Heo 		atomic_inc(&worker->pool->nr_running);
857*6d25be57SThomas Gleixner 	worker->sleeping = 0;
85836576000SJoonsoo Kim }
859e22bee78STejun Heo 
860e22bee78STejun Heo /**
861e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
862e22bee78STejun Heo  * @task: task going to sleep
863e22bee78STejun Heo  *
864*6d25be57SThomas Gleixner  * This function is called from schedule() when a busy worker is
865*6d25be57SThomas Gleixner  * going to sleep.
866e22bee78STejun Heo  */
867*6d25be57SThomas Gleixner void wq_worker_sleeping(struct task_struct *task)
868e22bee78STejun Heo {
869*6d25be57SThomas Gleixner 	struct worker *next, *worker = kthread_data(task);
870111c225aSTejun Heo 	struct worker_pool *pool;
871e22bee78STejun Heo 
872111c225aSTejun Heo 	/*
873111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
874111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
875111c225aSTejun Heo 	 * checking NOT_RUNNING.
876111c225aSTejun Heo 	 */
8772d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
878*6d25be57SThomas Gleixner 		return;
879e22bee78STejun Heo 
880111c225aSTejun Heo 	pool = worker->pool;
881111c225aSTejun Heo 
882*6d25be57SThomas Gleixner 	if (WARN_ON_ONCE(worker->sleeping))
883*6d25be57SThomas Gleixner 		return;
884*6d25be57SThomas Gleixner 
885*6d25be57SThomas Gleixner 	worker->sleeping = 1;
886*6d25be57SThomas Gleixner 	spin_lock_irq(&pool->lock);
887e22bee78STejun Heo 
888e22bee78STejun Heo 	/*
889e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
890e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
891e22bee78STejun Heo 	 * Please read comment there.
892e22bee78STejun Heo 	 *
893628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
894628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
895628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
896d565ed63STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without pool
897628c78e7STejun Heo 	 * lock is safe.
898e22bee78STejun Heo 	 */
899e19e397aSTejun Heo 	if (atomic_dec_and_test(&pool->nr_running) &&
900*6d25be57SThomas Gleixner 	    !list_empty(&pool->worklist)) {
901*6d25be57SThomas Gleixner 		next = first_idle_worker(pool);
902*6d25be57SThomas Gleixner 		if (next)
903*6d25be57SThomas Gleixner 			wake_up_process(next->task);
904*6d25be57SThomas Gleixner 	}
905*6d25be57SThomas Gleixner 	spin_unlock_irq(&pool->lock);
906e22bee78STejun Heo }
907e22bee78STejun Heo 
908e22bee78STejun Heo /**
9091b69ac6bSJohannes Weiner  * wq_worker_last_func - retrieve worker's last work function
9101b69ac6bSJohannes Weiner  *
9111b69ac6bSJohannes Weiner  * Determine the last function a worker executed. This is called from
9121b69ac6bSJohannes Weiner  * the scheduler to get a worker's last known identity.
9131b69ac6bSJohannes Weiner  *
9141b69ac6bSJohannes Weiner  * CONTEXT:
9151b69ac6bSJohannes Weiner  * spin_lock_irq(rq->lock)
9161b69ac6bSJohannes Weiner  *
9174b047002SJohannes Weiner  * This function is called during schedule() when a kworker is going
9184b047002SJohannes Weiner  * to sleep. It's used by psi to identify aggregation workers during
9194b047002SJohannes Weiner  * dequeuing, to allow periodic aggregation to shut-off when that
9204b047002SJohannes Weiner  * worker is the last task in the system or cgroup to go to sleep.
9214b047002SJohannes Weiner  *
9224b047002SJohannes Weiner  * As this function doesn't involve any workqueue-related locking, it
9234b047002SJohannes Weiner  * only returns stable values when called from inside the scheduler's
9244b047002SJohannes Weiner  * queuing and dequeuing paths, when @task, which must be a kworker,
9254b047002SJohannes Weiner  * is guaranteed to not be processing any works.
9264b047002SJohannes Weiner  *
9271b69ac6bSJohannes Weiner  * Return:
9281b69ac6bSJohannes Weiner  * The last work function %current executed as a worker, NULL if it
9291b69ac6bSJohannes Weiner  * hasn't executed any work yet.
9301b69ac6bSJohannes Weiner  */
9311b69ac6bSJohannes Weiner work_func_t wq_worker_last_func(struct task_struct *task)
9321b69ac6bSJohannes Weiner {
9331b69ac6bSJohannes Weiner 	struct worker *worker = kthread_data(task);
9341b69ac6bSJohannes Weiner 
9351b69ac6bSJohannes Weiner 	return worker->last_func;
9361b69ac6bSJohannes Weiner }
9371b69ac6bSJohannes Weiner 
9381b69ac6bSJohannes Weiner /**
939e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
940cb444766STejun Heo  * @worker: self
941d302f017STejun Heo  * @flags: flags to set
942d302f017STejun Heo  *
943228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
944d302f017STejun Heo  *
945cb444766STejun Heo  * CONTEXT:
946d565ed63STejun Heo  * spin_lock_irq(pool->lock)
947d302f017STejun Heo  */
948228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
949d302f017STejun Heo {
950bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
951e22bee78STejun Heo 
952cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
953cb444766STejun Heo 
954228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
955e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
956e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
957e19e397aSTejun Heo 		atomic_dec(&pool->nr_running);
958e22bee78STejun Heo 	}
959e22bee78STejun Heo 
960d302f017STejun Heo 	worker->flags |= flags;
961d302f017STejun Heo }
962d302f017STejun Heo 
963d302f017STejun Heo /**
964e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
965cb444766STejun Heo  * @worker: self
966d302f017STejun Heo  * @flags: flags to clear
967d302f017STejun Heo  *
968e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
969d302f017STejun Heo  *
970cb444766STejun Heo  * CONTEXT:
971d565ed63STejun Heo  * spin_lock_irq(pool->lock)
972d302f017STejun Heo  */
973d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
974d302f017STejun Heo {
97563d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
976e22bee78STejun Heo 	unsigned int oflags = worker->flags;
977e22bee78STejun Heo 
978cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
979cb444766STejun Heo 
980d302f017STejun Heo 	worker->flags &= ~flags;
981e22bee78STejun Heo 
98242c025f3STejun Heo 	/*
98342c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
98442c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
98542c025f3STejun Heo 	 * of multiple flags, not a single flag.
98642c025f3STejun Heo 	 */
987e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
988e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
989e19e397aSTejun Heo 			atomic_inc(&pool->nr_running);
990d302f017STejun Heo }
991d302f017STejun Heo 
992d302f017STejun Heo /**
9938cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
994c9e7cf27STejun Heo  * @pool: pool of interest
9958cca0eeaSTejun Heo  * @work: work to find worker for
9968cca0eeaSTejun Heo  *
997c9e7cf27STejun Heo  * Find a worker which is executing @work on @pool by searching
998c9e7cf27STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
999a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
1000a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
1001a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
1002a2c1c57bSTejun Heo  * being executed.
1003a2c1c57bSTejun Heo  *
1004a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
1005a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
1006a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
1007a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
1008a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
1009a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
1010a2c1c57bSTejun Heo  *
1011c5aa87bbSTejun Heo  * This function checks the work item address and work function to avoid
1012c5aa87bbSTejun Heo  * false positives.  Note that this isn't complete as one may construct a
1013c5aa87bbSTejun Heo  * work function which can introduce dependency onto itself through a
1014c5aa87bbSTejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
1015c5aa87bbSTejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
1016c5aa87bbSTejun Heo  * actually occurs, it should be easy to locate the culprit work function.
10178cca0eeaSTejun Heo  *
10188cca0eeaSTejun Heo  * CONTEXT:
1019d565ed63STejun Heo  * spin_lock_irq(pool->lock).
10208cca0eeaSTejun Heo  *
1021d185af30SYacine Belkadi  * Return:
1022d185af30SYacine Belkadi  * Pointer to worker which is executing @work if found, %NULL
10238cca0eeaSTejun Heo  * otherwise.
10248cca0eeaSTejun Heo  */
1025c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
10268cca0eeaSTejun Heo 						 struct work_struct *work)
10278cca0eeaSTejun Heo {
102842f8570fSSasha Levin 	struct worker *worker;
102942f8570fSSasha Levin 
1030b67bfe0dSSasha Levin 	hash_for_each_possible(pool->busy_hash, worker, hentry,
1031a2c1c57bSTejun Heo 			       (unsigned long)work)
1032a2c1c57bSTejun Heo 		if (worker->current_work == work &&
1033a2c1c57bSTejun Heo 		    worker->current_func == work->func)
103442f8570fSSasha Levin 			return worker;
103542f8570fSSasha Levin 
103642f8570fSSasha Levin 	return NULL;
10378cca0eeaSTejun Heo }
10388cca0eeaSTejun Heo 
10398cca0eeaSTejun Heo /**
1040bf4ede01STejun Heo  * move_linked_works - move linked works to a list
1041bf4ede01STejun Heo  * @work: start of series of works to be scheduled
1042bf4ede01STejun Heo  * @head: target list to append @work to
1043402dd89dSShailendra Verma  * @nextp: out parameter for nested worklist walking
1044bf4ede01STejun Heo  *
1045bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1046bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1047bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1048bf4ede01STejun Heo  *
1049bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1050bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1051bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
1052bf4ede01STejun Heo  *
1053bf4ede01STejun Heo  * CONTEXT:
1054d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1055bf4ede01STejun Heo  */
1056bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1057bf4ede01STejun Heo 			      struct work_struct **nextp)
1058bf4ede01STejun Heo {
1059bf4ede01STejun Heo 	struct work_struct *n;
1060bf4ede01STejun Heo 
1061bf4ede01STejun Heo 	/*
1062bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
1063bf4ede01STejun Heo 	 * use NULL for list head.
1064bf4ede01STejun Heo 	 */
1065bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1066bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
1067bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1068bf4ede01STejun Heo 			break;
1069bf4ede01STejun Heo 	}
1070bf4ede01STejun Heo 
1071bf4ede01STejun Heo 	/*
1072bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
1073bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
1074bf4ede01STejun Heo 	 * needs to be updated.
1075bf4ede01STejun Heo 	 */
1076bf4ede01STejun Heo 	if (nextp)
1077bf4ede01STejun Heo 		*nextp = n;
1078bf4ede01STejun Heo }
1079bf4ede01STejun Heo 
10808864b4e5STejun Heo /**
10818864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
10828864b4e5STejun Heo  * @pwq: pool_workqueue to get
10838864b4e5STejun Heo  *
10848864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
10858864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
10868864b4e5STejun Heo  */
10878864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
10888864b4e5STejun Heo {
10898864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
10908864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
10918864b4e5STejun Heo 	pwq->refcnt++;
10928864b4e5STejun Heo }
10938864b4e5STejun Heo 
10948864b4e5STejun Heo /**
10958864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
10968864b4e5STejun Heo  * @pwq: pool_workqueue to put
10978864b4e5STejun Heo  *
10988864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
10998864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
11008864b4e5STejun Heo  */
11018864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
11028864b4e5STejun Heo {
11038864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
11048864b4e5STejun Heo 	if (likely(--pwq->refcnt))
11058864b4e5STejun Heo 		return;
11068864b4e5STejun Heo 	if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
11078864b4e5STejun Heo 		return;
11088864b4e5STejun Heo 	/*
11098864b4e5STejun Heo 	 * @pwq can't be released under pool->lock, bounce to
11108864b4e5STejun Heo 	 * pwq_unbound_release_workfn().  This never recurses on the same
11118864b4e5STejun Heo 	 * pool->lock as this path is taken only for unbound workqueues and
11128864b4e5STejun Heo 	 * the release work item is scheduled on a per-cpu workqueue.  To
11138864b4e5STejun Heo 	 * avoid lockdep warning, unbound pool->locks are given lockdep
11148864b4e5STejun Heo 	 * subclass of 1 in get_unbound_pool().
11158864b4e5STejun Heo 	 */
11168864b4e5STejun Heo 	schedule_work(&pwq->unbound_release_work);
11178864b4e5STejun Heo }
11188864b4e5STejun Heo 
1119dce90d47STejun Heo /**
1120dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1121dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1122dce90d47STejun Heo  *
1123dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1124dce90d47STejun Heo  */
1125dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1126dce90d47STejun Heo {
1127dce90d47STejun Heo 	if (pwq) {
1128dce90d47STejun Heo 		/*
1129dce90d47STejun Heo 		 * As both pwqs and pools are sched-RCU protected, the
1130dce90d47STejun Heo 		 * following lock operations are safe.
1131dce90d47STejun Heo 		 */
1132dce90d47STejun Heo 		spin_lock_irq(&pwq->pool->lock);
1133dce90d47STejun Heo 		put_pwq(pwq);
1134dce90d47STejun Heo 		spin_unlock_irq(&pwq->pool->lock);
1135dce90d47STejun Heo 	}
1136dce90d47STejun Heo }
1137dce90d47STejun Heo 
1138112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work)
1139bf4ede01STejun Heo {
1140112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1141bf4ede01STejun Heo 
1142bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
114382607adcSTejun Heo 	if (list_empty(&pwq->pool->worklist))
114482607adcSTejun Heo 		pwq->pool->watchdog_ts = jiffies;
1145112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
1146bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1147112202d9STejun Heo 	pwq->nr_active++;
1148bf4ede01STejun Heo }
1149bf4ede01STejun Heo 
1150112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
11513aa62497SLai Jiangshan {
1152112202d9STejun Heo 	struct work_struct *work = list_first_entry(&pwq->delayed_works,
11533aa62497SLai Jiangshan 						    struct work_struct, entry);
11543aa62497SLai Jiangshan 
1155112202d9STejun Heo 	pwq_activate_delayed_work(work);
11563aa62497SLai Jiangshan }
11573aa62497SLai Jiangshan 
1158bf4ede01STejun Heo /**
1159112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1160112202d9STejun Heo  * @pwq: pwq of interest
1161bf4ede01STejun Heo  * @color: color of work which left the queue
1162bf4ede01STejun Heo  *
1163bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1164112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1165bf4ede01STejun Heo  *
1166bf4ede01STejun Heo  * CONTEXT:
1167d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1168bf4ede01STejun Heo  */
1169112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1170bf4ede01STejun Heo {
11718864b4e5STejun Heo 	/* uncolored work items don't participate in flushing or nr_active */
1172bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
11738864b4e5STejun Heo 		goto out_put;
1174bf4ede01STejun Heo 
1175112202d9STejun Heo 	pwq->nr_in_flight[color]--;
1176bf4ede01STejun Heo 
1177112202d9STejun Heo 	pwq->nr_active--;
1178112202d9STejun Heo 	if (!list_empty(&pwq->delayed_works)) {
1179bf4ede01STejun Heo 		/* one down, submit a delayed one */
1180112202d9STejun Heo 		if (pwq->nr_active < pwq->max_active)
1181112202d9STejun Heo 			pwq_activate_first_delayed(pwq);
1182bf4ede01STejun Heo 	}
1183bf4ede01STejun Heo 
1184bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1185112202d9STejun Heo 	if (likely(pwq->flush_color != color))
11868864b4e5STejun Heo 		goto out_put;
1187bf4ede01STejun Heo 
1188bf4ede01STejun Heo 	/* are there still in-flight works? */
1189112202d9STejun Heo 	if (pwq->nr_in_flight[color])
11908864b4e5STejun Heo 		goto out_put;
1191bf4ede01STejun Heo 
1192112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1193112202d9STejun Heo 	pwq->flush_color = -1;
1194bf4ede01STejun Heo 
1195bf4ede01STejun Heo 	/*
1196112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1197bf4ede01STejun Heo 	 * will handle the rest.
1198bf4ede01STejun Heo 	 */
1199112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1200112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
12018864b4e5STejun Heo out_put:
12028864b4e5STejun Heo 	put_pwq(pwq);
1203bf4ede01STejun Heo }
1204bf4ede01STejun Heo 
120536e227d2STejun Heo /**
1206bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
120736e227d2STejun Heo  * @work: work item to steal
120836e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1209bbb68dfaSTejun Heo  * @flags: place to store irq state
121036e227d2STejun Heo  *
121136e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
1212d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
121336e227d2STejun Heo  *
1214d185af30SYacine Belkadi  * Return:
121536e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
121636e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
121736e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1218bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1219bbb68dfaSTejun Heo  *		for arbitrarily long
122036e227d2STejun Heo  *
1221d185af30SYacine Belkadi  * Note:
1222bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1223e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1224e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1225e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1226bbb68dfaSTejun Heo  *
1227bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1228bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1229bbb68dfaSTejun Heo  *
1230e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1231bf4ede01STejun Heo  */
1232bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1233bbb68dfaSTejun Heo 			       unsigned long *flags)
1234bf4ede01STejun Heo {
1235d565ed63STejun Heo 	struct worker_pool *pool;
1236112202d9STejun Heo 	struct pool_workqueue *pwq;
1237bf4ede01STejun Heo 
1238bbb68dfaSTejun Heo 	local_irq_save(*flags);
1239bbb68dfaSTejun Heo 
124036e227d2STejun Heo 	/* try to steal the timer if it exists */
124136e227d2STejun Heo 	if (is_dwork) {
124236e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
124336e227d2STejun Heo 
1244e0aecdd8STejun Heo 		/*
1245e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1246e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1247e0aecdd8STejun Heo 		 * running on the local CPU.
1248e0aecdd8STejun Heo 		 */
124936e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
125036e227d2STejun Heo 			return 1;
125136e227d2STejun Heo 	}
125236e227d2STejun Heo 
125336e227d2STejun Heo 	/* try to claim PENDING the normal way */
1254bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1255bf4ede01STejun Heo 		return 0;
1256bf4ede01STejun Heo 
1257bf4ede01STejun Heo 	/*
1258bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1259bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1260bf4ede01STejun Heo 	 */
1261d565ed63STejun Heo 	pool = get_work_pool(work);
1262d565ed63STejun Heo 	if (!pool)
1263bbb68dfaSTejun Heo 		goto fail;
1264bf4ede01STejun Heo 
1265d565ed63STejun Heo 	spin_lock(&pool->lock);
1266bf4ede01STejun Heo 	/*
1267112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
1268112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
1269112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
1270112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
1271112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
12720b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
1273bf4ede01STejun Heo 	 */
1274112202d9STejun Heo 	pwq = get_work_pwq(work);
1275112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
1276bf4ede01STejun Heo 		debug_work_deactivate(work);
12773aa62497SLai Jiangshan 
12783aa62497SLai Jiangshan 		/*
127916062836STejun Heo 		 * A delayed work item cannot be grabbed directly because
128016062836STejun Heo 		 * it might have linked NO_COLOR work items which, if left
1281112202d9STejun Heo 		 * on the delayed_list, will confuse pwq->nr_active
128216062836STejun Heo 		 * management later on and cause stall.  Make sure the work
128316062836STejun Heo 		 * item is activated before grabbing.
12843aa62497SLai Jiangshan 		 */
12853aa62497SLai Jiangshan 		if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1286112202d9STejun Heo 			pwq_activate_delayed_work(work);
12873aa62497SLai Jiangshan 
1288bf4ede01STejun Heo 		list_del_init(&work->entry);
12899c34a704SLai Jiangshan 		pwq_dec_nr_in_flight(pwq, get_work_color(work));
129036e227d2STejun Heo 
1291112202d9STejun Heo 		/* work->data points to pwq iff queued, point to pool */
12924468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
12934468a00fSLai Jiangshan 
1294d565ed63STejun Heo 		spin_unlock(&pool->lock);
129536e227d2STejun Heo 		return 1;
1296bf4ede01STejun Heo 	}
1297d565ed63STejun Heo 	spin_unlock(&pool->lock);
1298bbb68dfaSTejun Heo fail:
1299bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1300bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1301bbb68dfaSTejun Heo 		return -ENOENT;
1302bbb68dfaSTejun Heo 	cpu_relax();
130336e227d2STejun Heo 	return -EAGAIN;
1304bf4ede01STejun Heo }
1305bf4ede01STejun Heo 
1306bf4ede01STejun Heo /**
1307706026c2STejun Heo  * insert_work - insert a work into a pool
1308112202d9STejun Heo  * @pwq: pwq @work belongs to
13094690c4abSTejun Heo  * @work: work to insert
13104690c4abSTejun Heo  * @head: insertion point
13114690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
13124690c4abSTejun Heo  *
1313112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
1314706026c2STejun Heo  * work_struct flags.
13154690c4abSTejun Heo  *
13164690c4abSTejun Heo  * CONTEXT:
1317d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1318365970a1SDavid Howells  */
1319112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1320112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
1321b89deed3SOleg Nesterov {
1322112202d9STejun Heo 	struct worker_pool *pool = pwq->pool;
1323e1d8aa9fSFrederic Weisbecker 
13244690c4abSTejun Heo 	/* we own @work, set data and link */
1325112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
13261a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
13278864b4e5STejun Heo 	get_pwq(pwq);
1328e22bee78STejun Heo 
1329e22bee78STejun Heo 	/*
1330c5aa87bbSTejun Heo 	 * Ensure either wq_worker_sleeping() sees the above
1331c5aa87bbSTejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers lying
1332c5aa87bbSTejun Heo 	 * around lazily while there are works to be processed.
1333e22bee78STejun Heo 	 */
1334e22bee78STejun Heo 	smp_mb();
1335e22bee78STejun Heo 
133663d95a91STejun Heo 	if (__need_more_worker(pool))
133763d95a91STejun Heo 		wake_up_worker(pool);
1338b89deed3SOleg Nesterov }
1339b89deed3SOleg Nesterov 
1340c8efcc25STejun Heo /*
1341c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
13428d03ecfeSTejun Heo  * same workqueue.
1343c8efcc25STejun Heo  */
1344c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1345c8efcc25STejun Heo {
1346c8efcc25STejun Heo 	struct worker *worker;
1347c8efcc25STejun Heo 
13488d03ecfeSTejun Heo 	worker = current_wq_worker();
1349c8efcc25STejun Heo 	/*
1350bf393fd4SBart Van Assche 	 * Return %true iff I'm a worker executing a work item on @wq.  If
13518d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
1352c8efcc25STejun Heo 	 */
1353112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
1354c8efcc25STejun Heo }
1355c8efcc25STejun Heo 
1356ef557180SMike Galbraith /*
1357ef557180SMike Galbraith  * When queueing an unbound work item to a wq, prefer local CPU if allowed
1358ef557180SMike Galbraith  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
1359ef557180SMike Galbraith  * avoid perturbing sensitive tasks.
1360ef557180SMike Galbraith  */
1361ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu)
1362ef557180SMike Galbraith {
1363f303fccbSTejun Heo 	static bool printed_dbg_warning;
1364ef557180SMike Galbraith 	int new_cpu;
1365ef557180SMike Galbraith 
1366f303fccbSTejun Heo 	if (likely(!wq_debug_force_rr_cpu)) {
1367ef557180SMike Galbraith 		if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1368ef557180SMike Galbraith 			return cpu;
1369f303fccbSTejun Heo 	} else if (!printed_dbg_warning) {
1370f303fccbSTejun Heo 		pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1371f303fccbSTejun Heo 		printed_dbg_warning = true;
1372f303fccbSTejun Heo 	}
1373f303fccbSTejun Heo 
1374ef557180SMike Galbraith 	if (cpumask_empty(wq_unbound_cpumask))
1375ef557180SMike Galbraith 		return cpu;
1376ef557180SMike Galbraith 
1377ef557180SMike Galbraith 	new_cpu = __this_cpu_read(wq_rr_cpu_last);
1378ef557180SMike Galbraith 	new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1379ef557180SMike Galbraith 	if (unlikely(new_cpu >= nr_cpu_ids)) {
1380ef557180SMike Galbraith 		new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1381ef557180SMike Galbraith 		if (unlikely(new_cpu >= nr_cpu_ids))
1382ef557180SMike Galbraith 			return cpu;
1383ef557180SMike Galbraith 	}
1384ef557180SMike Galbraith 	__this_cpu_write(wq_rr_cpu_last, new_cpu);
1385ef557180SMike Galbraith 
1386ef557180SMike Galbraith 	return new_cpu;
1387ef557180SMike Galbraith }
1388ef557180SMike Galbraith 
1389d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
13901da177e4SLinus Torvalds 			 struct work_struct *work)
13911da177e4SLinus Torvalds {
1392112202d9STejun Heo 	struct pool_workqueue *pwq;
1393c9178087STejun Heo 	struct worker_pool *last_pool;
13941e19ffc6STejun Heo 	struct list_head *worklist;
13958a2e8e5dSTejun Heo 	unsigned int work_flags;
1396b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
13978930cabaSTejun Heo 
13988930cabaSTejun Heo 	/*
13998930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
14008930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
14018930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
14028930cabaSTejun Heo 	 * happen with IRQ disabled.
14038930cabaSTejun Heo 	 */
14048e8eb730SFrederic Weisbecker 	lockdep_assert_irqs_disabled();
14051da177e4SLinus Torvalds 
1406dc186ad7SThomas Gleixner 	debug_work_activate(work);
14071e19ffc6STejun Heo 
14089ef28a73SLi Bin 	/* if draining, only works from the same workqueue are allowed */
1409618b01ebSTejun Heo 	if (unlikely(wq->flags & __WQ_DRAINING) &&
1410c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1411e41e704bSTejun Heo 		return;
14129e8cd2f5STejun Heo retry:
1413df2d5ae4STejun Heo 	if (req_cpu == WORK_CPU_UNBOUND)
1414ef557180SMike Galbraith 		cpu = wq_select_unbound_cpu(raw_smp_processor_id());
1415df2d5ae4STejun Heo 
1416df2d5ae4STejun Heo 	/* pwq which will be used unless @work is executing elsewhere */
1417df2d5ae4STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
1418c9178087STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1419df2d5ae4STejun Heo 	else
1420df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1421f3421797STejun Heo 
142218aa9effSTejun Heo 	/*
1423c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
1424c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
1425c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
142618aa9effSTejun Heo 	 */
1427c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
1428112202d9STejun Heo 	if (last_pool && last_pool != pwq->pool) {
142918aa9effSTejun Heo 		struct worker *worker;
143018aa9effSTejun Heo 
1431d565ed63STejun Heo 		spin_lock(&last_pool->lock);
143218aa9effSTejun Heo 
1433c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
143418aa9effSTejun Heo 
1435112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
1436c9178087STejun Heo 			pwq = worker->current_pwq;
14378594fadeSLai Jiangshan 		} else {
143818aa9effSTejun Heo 			/* meh... not running there, queue here */
1439d565ed63STejun Heo 			spin_unlock(&last_pool->lock);
1440112202d9STejun Heo 			spin_lock(&pwq->pool->lock);
144118aa9effSTejun Heo 		}
14428930cabaSTejun Heo 	} else {
1443112202d9STejun Heo 		spin_lock(&pwq->pool->lock);
14448930cabaSTejun Heo 	}
1445502ca9d8STejun Heo 
14469e8cd2f5STejun Heo 	/*
14479e8cd2f5STejun Heo 	 * pwq is determined and locked.  For unbound pools, we could have
14489e8cd2f5STejun Heo 	 * raced with pwq release and it could already be dead.  If its
14499e8cd2f5STejun Heo 	 * refcnt is zero, repeat pwq selection.  Note that pwqs never die
1450df2d5ae4STejun Heo 	 * without another pwq replacing it in the numa_pwq_tbl or while
1451df2d5ae4STejun Heo 	 * work items are executing on it, so the retrying is guaranteed to
14529e8cd2f5STejun Heo 	 * make forward-progress.
14539e8cd2f5STejun Heo 	 */
14549e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
14559e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
14569e8cd2f5STejun Heo 			spin_unlock(&pwq->pool->lock);
14579e8cd2f5STejun Heo 			cpu_relax();
14589e8cd2f5STejun Heo 			goto retry;
14599e8cd2f5STejun Heo 		}
14609e8cd2f5STejun Heo 		/* oops */
14619e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
14629e8cd2f5STejun Heo 			  wq->name, cpu);
14639e8cd2f5STejun Heo 	}
14649e8cd2f5STejun Heo 
1465112202d9STejun Heo 	/* pwq determined, queue */
1466112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
1467502ca9d8STejun Heo 
1468f5b2552bSDan Carpenter 	if (WARN_ON(!list_empty(&work->entry))) {
1469112202d9STejun Heo 		spin_unlock(&pwq->pool->lock);
1470f5b2552bSDan Carpenter 		return;
1471f5b2552bSDan Carpenter 	}
14721e19ffc6STejun Heo 
1473112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
1474112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
14751e19ffc6STejun Heo 
1476112202d9STejun Heo 	if (likely(pwq->nr_active < pwq->max_active)) {
1477cdadf009STejun Heo 		trace_workqueue_activate_work(work);
1478112202d9STejun Heo 		pwq->nr_active++;
1479112202d9STejun Heo 		worklist = &pwq->pool->worklist;
148082607adcSTejun Heo 		if (list_empty(worklist))
148182607adcSTejun Heo 			pwq->pool->watchdog_ts = jiffies;
14828a2e8e5dSTejun Heo 	} else {
14838a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
1484112202d9STejun Heo 		worklist = &pwq->delayed_works;
14858a2e8e5dSTejun Heo 	}
14861e19ffc6STejun Heo 
1487112202d9STejun Heo 	insert_work(pwq, work, worklist, work_flags);
14881e19ffc6STejun Heo 
1489112202d9STejun Heo 	spin_unlock(&pwq->pool->lock);
14901da177e4SLinus Torvalds }
14911da177e4SLinus Torvalds 
14920fcb78c2SRolf Eike Beer /**
1493c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1494c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1495c1a220e7SZhang Rui  * @wq: workqueue to use
1496c1a220e7SZhang Rui  * @work: work to queue
1497c1a220e7SZhang Rui  *
1498c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1499c1a220e7SZhang Rui  * can't go away.
1500d185af30SYacine Belkadi  *
1501d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
1502c1a220e7SZhang Rui  */
1503d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1504d4283e93STejun Heo 		   struct work_struct *work)
1505c1a220e7SZhang Rui {
1506d4283e93STejun Heo 	bool ret = false;
15078930cabaSTejun Heo 	unsigned long flags;
15088930cabaSTejun Heo 
15098930cabaSTejun Heo 	local_irq_save(flags);
1510c1a220e7SZhang Rui 
151122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
15124690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1513d4283e93STejun Heo 		ret = true;
1514c1a220e7SZhang Rui 	}
15158930cabaSTejun Heo 
15168930cabaSTejun Heo 	local_irq_restore(flags);
1517c1a220e7SZhang Rui 	return ret;
1518c1a220e7SZhang Rui }
1519ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
1520c1a220e7SZhang Rui 
15218204e0c1SAlexander Duyck /**
15228204e0c1SAlexander Duyck  * workqueue_select_cpu_near - Select a CPU based on NUMA node
15238204e0c1SAlexander Duyck  * @node: NUMA node ID that we want to select a CPU from
15248204e0c1SAlexander Duyck  *
15258204e0c1SAlexander Duyck  * This function will attempt to find a "random" cpu available on a given
15268204e0c1SAlexander Duyck  * node. If there are no CPUs available on the given node it will return
15278204e0c1SAlexander Duyck  * WORK_CPU_UNBOUND indicating that we should just schedule to any
15288204e0c1SAlexander Duyck  * available CPU if we need to schedule this work.
15298204e0c1SAlexander Duyck  */
15308204e0c1SAlexander Duyck static int workqueue_select_cpu_near(int node)
15318204e0c1SAlexander Duyck {
15328204e0c1SAlexander Duyck 	int cpu;
15338204e0c1SAlexander Duyck 
15348204e0c1SAlexander Duyck 	/* No point in doing this if NUMA isn't enabled for workqueues */
15358204e0c1SAlexander Duyck 	if (!wq_numa_enabled)
15368204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
15378204e0c1SAlexander Duyck 
15388204e0c1SAlexander Duyck 	/* Delay binding to CPU if node is not valid or online */
15398204e0c1SAlexander Duyck 	if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
15408204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
15418204e0c1SAlexander Duyck 
15428204e0c1SAlexander Duyck 	/* Use local node/cpu if we are already there */
15438204e0c1SAlexander Duyck 	cpu = raw_smp_processor_id();
15448204e0c1SAlexander Duyck 	if (node == cpu_to_node(cpu))
15458204e0c1SAlexander Duyck 		return cpu;
15468204e0c1SAlexander Duyck 
15478204e0c1SAlexander Duyck 	/* Use "random" otherwise know as "first" online CPU of node */
15488204e0c1SAlexander Duyck 	cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
15498204e0c1SAlexander Duyck 
15508204e0c1SAlexander Duyck 	/* If CPU is valid return that, otherwise just defer */
15518204e0c1SAlexander Duyck 	return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
15528204e0c1SAlexander Duyck }
15538204e0c1SAlexander Duyck 
15548204e0c1SAlexander Duyck /**
15558204e0c1SAlexander Duyck  * queue_work_node - queue work on a "random" cpu for a given NUMA node
15568204e0c1SAlexander Duyck  * @node: NUMA node that we are targeting the work for
15578204e0c1SAlexander Duyck  * @wq: workqueue to use
15588204e0c1SAlexander Duyck  * @work: work to queue
15598204e0c1SAlexander Duyck  *
15608204e0c1SAlexander Duyck  * We queue the work to a "random" CPU within a given NUMA node. The basic
15618204e0c1SAlexander Duyck  * idea here is to provide a way to somehow associate work with a given
15628204e0c1SAlexander Duyck  * NUMA node.
15638204e0c1SAlexander Duyck  *
15648204e0c1SAlexander Duyck  * This function will only make a best effort attempt at getting this onto
15658204e0c1SAlexander Duyck  * the right NUMA node. If no node is requested or the requested node is
15668204e0c1SAlexander Duyck  * offline then we just fall back to standard queue_work behavior.
15678204e0c1SAlexander Duyck  *
15688204e0c1SAlexander Duyck  * Currently the "random" CPU ends up being the first available CPU in the
15698204e0c1SAlexander Duyck  * intersection of cpu_online_mask and the cpumask of the node, unless we
15708204e0c1SAlexander Duyck  * are running on the node. In that case we just use the current CPU.
15718204e0c1SAlexander Duyck  *
15728204e0c1SAlexander Duyck  * Return: %false if @work was already on a queue, %true otherwise.
15738204e0c1SAlexander Duyck  */
15748204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq,
15758204e0c1SAlexander Duyck 		     struct work_struct *work)
15768204e0c1SAlexander Duyck {
15778204e0c1SAlexander Duyck 	unsigned long flags;
15788204e0c1SAlexander Duyck 	bool ret = false;
15798204e0c1SAlexander Duyck 
15808204e0c1SAlexander Duyck 	/*
15818204e0c1SAlexander Duyck 	 * This current implementation is specific to unbound workqueues.
15828204e0c1SAlexander Duyck 	 * Specifically we only return the first available CPU for a given
15838204e0c1SAlexander Duyck 	 * node instead of cycling through individual CPUs within the node.
15848204e0c1SAlexander Duyck 	 *
15858204e0c1SAlexander Duyck 	 * If this is used with a per-cpu workqueue then the logic in
15868204e0c1SAlexander Duyck 	 * workqueue_select_cpu_near would need to be updated to allow for
15878204e0c1SAlexander Duyck 	 * some round robin type logic.
15888204e0c1SAlexander Duyck 	 */
15898204e0c1SAlexander Duyck 	WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
15908204e0c1SAlexander Duyck 
15918204e0c1SAlexander Duyck 	local_irq_save(flags);
15928204e0c1SAlexander Duyck 
15938204e0c1SAlexander Duyck 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
15948204e0c1SAlexander Duyck 		int cpu = workqueue_select_cpu_near(node);
15958204e0c1SAlexander Duyck 
15968204e0c1SAlexander Duyck 		__queue_work(cpu, wq, work);
15978204e0c1SAlexander Duyck 		ret = true;
15988204e0c1SAlexander Duyck 	}
15998204e0c1SAlexander Duyck 
16008204e0c1SAlexander Duyck 	local_irq_restore(flags);
16018204e0c1SAlexander Duyck 	return ret;
16028204e0c1SAlexander Duyck }
16038204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node);
16048204e0c1SAlexander Duyck 
16058c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t)
16061da177e4SLinus Torvalds {
16078c20feb6SKees Cook 	struct delayed_work *dwork = from_timer(dwork, t, timer);
16081da177e4SLinus Torvalds 
1609e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
161060c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
16111da177e4SLinus Torvalds }
16121438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
16131da177e4SLinus Torvalds 
16147beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
161552bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
16161da177e4SLinus Torvalds {
16177beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
16187beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
16191da177e4SLinus Torvalds 
1620637fdbaeSTejun Heo 	WARN_ON_ONCE(!wq);
1621841b86f3SKees Cook 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
1622fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1623fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
16247beb2edfSTejun Heo 
16258852aac2STejun Heo 	/*
16268852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
16278852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
16288852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
16298852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
16308852aac2STejun Heo 	 */
16318852aac2STejun Heo 	if (!delay) {
16328852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
16338852aac2STejun Heo 		return;
16348852aac2STejun Heo 	}
16358852aac2STejun Heo 
163660c057bcSLai Jiangshan 	dwork->wq = wq;
16371265057fSTejun Heo 	dwork->cpu = cpu;
16387beb2edfSTejun Heo 	timer->expires = jiffies + delay;
16397beb2edfSTejun Heo 
1640041bd12eSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
16417beb2edfSTejun Heo 		add_timer_on(timer, cpu);
1642041bd12eSTejun Heo 	else
1643041bd12eSTejun Heo 		add_timer(timer);
16447beb2edfSTejun Heo }
16451da177e4SLinus Torvalds 
16460fcb78c2SRolf Eike Beer /**
16470fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
16480fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
16490fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1650af9997e4SRandy Dunlap  * @dwork: work to queue
16510fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
16520fcb78c2SRolf Eike Beer  *
1653d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
1654715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1655715f1300STejun Heo  * execution.
16560fcb78c2SRolf Eike Beer  */
1657d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
165852bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
16597a6bc1cdSVenkatesh Pallipadi {
166052bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1661d4283e93STejun Heo 	bool ret = false;
16628930cabaSTejun Heo 	unsigned long flags;
16638930cabaSTejun Heo 
16648930cabaSTejun Heo 	/* read the comment in __queue_work() */
16658930cabaSTejun Heo 	local_irq_save(flags);
16667a6bc1cdSVenkatesh Pallipadi 
166722df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
16687beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1669d4283e93STejun Heo 		ret = true;
16707a6bc1cdSVenkatesh Pallipadi 	}
16718930cabaSTejun Heo 
16728930cabaSTejun Heo 	local_irq_restore(flags);
16737a6bc1cdSVenkatesh Pallipadi 	return ret;
16747a6bc1cdSVenkatesh Pallipadi }
1675ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
16761da177e4SLinus Torvalds 
1677c8e55f36STejun Heo /**
16788376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
16798376fe22STejun Heo  * @cpu: CPU number to execute work on
16808376fe22STejun Heo  * @wq: workqueue to use
16818376fe22STejun Heo  * @dwork: work to queue
16828376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
16838376fe22STejun Heo  *
16848376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
16858376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
16868376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
16878376fe22STejun Heo  * current state.
16888376fe22STejun Heo  *
1689d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
16908376fe22STejun Heo  * pending and its timer was modified.
16918376fe22STejun Heo  *
1692e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
16938376fe22STejun Heo  * See try_to_grab_pending() for details.
16948376fe22STejun Heo  */
16958376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
16968376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
16978376fe22STejun Heo {
16988376fe22STejun Heo 	unsigned long flags;
16998376fe22STejun Heo 	int ret;
17008376fe22STejun Heo 
17018376fe22STejun Heo 	do {
17028376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
17038376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
17048376fe22STejun Heo 
17058376fe22STejun Heo 	if (likely(ret >= 0)) {
17068376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
17078376fe22STejun Heo 		local_irq_restore(flags);
17088376fe22STejun Heo 	}
17098376fe22STejun Heo 
17108376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
17118376fe22STejun Heo 	return ret;
17128376fe22STejun Heo }
17138376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
17148376fe22STejun Heo 
171505f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu)
171605f0fe6bSTejun Heo {
171705f0fe6bSTejun Heo 	struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
171805f0fe6bSTejun Heo 
171905f0fe6bSTejun Heo 	/* read the comment in __queue_work() */
172005f0fe6bSTejun Heo 	local_irq_disable();
172105f0fe6bSTejun Heo 	__queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
172205f0fe6bSTejun Heo 	local_irq_enable();
172305f0fe6bSTejun Heo }
172405f0fe6bSTejun Heo 
172505f0fe6bSTejun Heo /**
172605f0fe6bSTejun Heo  * queue_rcu_work - queue work after a RCU grace period
172705f0fe6bSTejun Heo  * @wq: workqueue to use
172805f0fe6bSTejun Heo  * @rwork: work to queue
172905f0fe6bSTejun Heo  *
173005f0fe6bSTejun Heo  * Return: %false if @rwork was already pending, %true otherwise.  Note
173105f0fe6bSTejun Heo  * that a full RCU grace period is guaranteed only after a %true return.
1732bf393fd4SBart Van Assche  * While @rwork is guaranteed to be executed after a %false return, the
173305f0fe6bSTejun Heo  * execution may happen before a full RCU grace period has passed.
173405f0fe6bSTejun Heo  */
173505f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
173605f0fe6bSTejun Heo {
173705f0fe6bSTejun Heo 	struct work_struct *work = &rwork->work;
173805f0fe6bSTejun Heo 
173905f0fe6bSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
174005f0fe6bSTejun Heo 		rwork->wq = wq;
174105f0fe6bSTejun Heo 		call_rcu(&rwork->rcu, rcu_work_rcufn);
174205f0fe6bSTejun Heo 		return true;
174305f0fe6bSTejun Heo 	}
174405f0fe6bSTejun Heo 
174505f0fe6bSTejun Heo 	return false;
174605f0fe6bSTejun Heo }
174705f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work);
174805f0fe6bSTejun Heo 
17498376fe22STejun Heo /**
1750c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1751c8e55f36STejun Heo  * @worker: worker which is entering idle state
1752c8e55f36STejun Heo  *
1753c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1754c8e55f36STejun Heo  * necessary.
1755c8e55f36STejun Heo  *
1756c8e55f36STejun Heo  * LOCKING:
1757d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1758c8e55f36STejun Heo  */
1759c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
17601da177e4SLinus Torvalds {
1761bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1762c8e55f36STejun Heo 
17636183c009STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
17646183c009STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
17656183c009STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
17666183c009STejun Heo 		return;
1767c8e55f36STejun Heo 
1768051e1850SLai Jiangshan 	/* can't use worker_set_flags(), also called from create_worker() */
1769cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1770bd7bdd43STejun Heo 	pool->nr_idle++;
1771e22bee78STejun Heo 	worker->last_active = jiffies;
1772c8e55f36STejun Heo 
1773c8e55f36STejun Heo 	/* idle_list is LIFO */
1774bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1775db7bccf4STejun Heo 
177663d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1777628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1778cb444766STejun Heo 
1779544ecf31STejun Heo 	/*
1780e8b3f8dbSLai Jiangshan 	 * Sanity check nr_running.  Because unbind_workers() releases
1781d565ed63STejun Heo 	 * pool->lock between setting %WORKER_UNBOUND and zapping
1782628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1783628c78e7STejun Heo 	 * unbind is not in progress.
1784544ecf31STejun Heo 	 */
178524647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1786bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
1787e19e397aSTejun Heo 		     atomic_read(&pool->nr_running));
1788c8e55f36STejun Heo }
1789c8e55f36STejun Heo 
1790c8e55f36STejun Heo /**
1791c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1792c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1793c8e55f36STejun Heo  *
1794c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1795c8e55f36STejun Heo  *
1796c8e55f36STejun Heo  * LOCKING:
1797d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1798c8e55f36STejun Heo  */
1799c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1800c8e55f36STejun Heo {
1801bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1802c8e55f36STejun Heo 
18036183c009STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
18046183c009STejun Heo 		return;
1805d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1806bd7bdd43STejun Heo 	pool->nr_idle--;
1807c8e55f36STejun Heo 	list_del_init(&worker->entry);
1808c8e55f36STejun Heo }
1809c8e55f36STejun Heo 
1810f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
1811c34056a3STejun Heo {
1812c34056a3STejun Heo 	struct worker *worker;
1813c34056a3STejun Heo 
1814f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
1815c8e55f36STejun Heo 	if (worker) {
1816c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1817affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1818da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
1819e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1820e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1821c8e55f36STejun Heo 	}
1822c34056a3STejun Heo 	return worker;
1823c34056a3STejun Heo }
1824c34056a3STejun Heo 
1825c34056a3STejun Heo /**
18264736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
18274736cbf7SLai Jiangshan  * @worker: worker to be attached
18284736cbf7SLai Jiangshan  * @pool: the target pool
18294736cbf7SLai Jiangshan  *
18304736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
18314736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
18324736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
18334736cbf7SLai Jiangshan  */
18344736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
18354736cbf7SLai Jiangshan 				   struct worker_pool *pool)
18364736cbf7SLai Jiangshan {
18371258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
18384736cbf7SLai Jiangshan 
18394736cbf7SLai Jiangshan 	/*
18404736cbf7SLai Jiangshan 	 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
18414736cbf7SLai Jiangshan 	 * online CPUs.  It'll be re-applied when any of the CPUs come up.
18424736cbf7SLai Jiangshan 	 */
18434736cbf7SLai Jiangshan 	set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
18444736cbf7SLai Jiangshan 
18454736cbf7SLai Jiangshan 	/*
18461258fae7STejun Heo 	 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
18471258fae7STejun Heo 	 * stable across this function.  See the comments above the flag
18481258fae7STejun Heo 	 * definition for details.
18494736cbf7SLai Jiangshan 	 */
18504736cbf7SLai Jiangshan 	if (pool->flags & POOL_DISASSOCIATED)
18514736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
18524736cbf7SLai Jiangshan 
18534736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
1854a2d812a2STejun Heo 	worker->pool = pool;
18554736cbf7SLai Jiangshan 
18561258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
18574736cbf7SLai Jiangshan }
18584736cbf7SLai Jiangshan 
18594736cbf7SLai Jiangshan /**
186060f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
186160f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
186260f5a4bcSLai Jiangshan  *
18634736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
18644736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
18654736cbf7SLai Jiangshan  * other reference to the pool.
186660f5a4bcSLai Jiangshan  */
1867a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker)
186860f5a4bcSLai Jiangshan {
1869a2d812a2STejun Heo 	struct worker_pool *pool = worker->pool;
187060f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
187160f5a4bcSLai Jiangshan 
18721258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
1873a2d812a2STejun Heo 
1874da028469SLai Jiangshan 	list_del(&worker->node);
1875a2d812a2STejun Heo 	worker->pool = NULL;
1876a2d812a2STejun Heo 
1877da028469SLai Jiangshan 	if (list_empty(&pool->workers))
187860f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
18791258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
188060f5a4bcSLai Jiangshan 
1881b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
1882b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1883b62c0751SLai Jiangshan 
188460f5a4bcSLai Jiangshan 	if (detach_completion)
188560f5a4bcSLai Jiangshan 		complete(detach_completion);
188660f5a4bcSLai Jiangshan }
188760f5a4bcSLai Jiangshan 
188860f5a4bcSLai Jiangshan /**
1889c34056a3STejun Heo  * create_worker - create a new workqueue worker
189063d95a91STejun Heo  * @pool: pool the new worker will belong to
1891c34056a3STejun Heo  *
1892051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
1893c34056a3STejun Heo  *
1894c34056a3STejun Heo  * CONTEXT:
1895c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1896c34056a3STejun Heo  *
1897d185af30SYacine Belkadi  * Return:
1898c34056a3STejun Heo  * Pointer to the newly created worker.
1899c34056a3STejun Heo  */
1900bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1901c34056a3STejun Heo {
1902c34056a3STejun Heo 	struct worker *worker = NULL;
1903f3421797STejun Heo 	int id = -1;
1904e3c916a4STejun Heo 	char id_buf[16];
1905c34056a3STejun Heo 
19067cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
19077cda9aaeSLai Jiangshan 	id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
1908822d8405STejun Heo 	if (id < 0)
1909c34056a3STejun Heo 		goto fail;
1910c34056a3STejun Heo 
1911f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
1912c34056a3STejun Heo 	if (!worker)
1913c34056a3STejun Heo 		goto fail;
1914c34056a3STejun Heo 
1915c34056a3STejun Heo 	worker->id = id;
1916c34056a3STejun Heo 
191729c91e99STejun Heo 	if (pool->cpu >= 0)
1918e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1919e3c916a4STejun Heo 			 pool->attrs->nice < 0  ? "H" : "");
1920f3421797STejun Heo 	else
1921e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1922e3c916a4STejun Heo 
1923f3f90ad4STejun Heo 	worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1924e3c916a4STejun Heo 					      "kworker/%s", id_buf);
1925c34056a3STejun Heo 	if (IS_ERR(worker->task))
1926c34056a3STejun Heo 		goto fail;
1927c34056a3STejun Heo 
192891151228SOleg Nesterov 	set_user_nice(worker->task, pool->attrs->nice);
192925834c73SPeter Zijlstra 	kthread_bind_mask(worker->task, pool->attrs->cpumask);
193091151228SOleg Nesterov 
1931da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
19324736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
1933822d8405STejun Heo 
1934051e1850SLai Jiangshan 	/* start the newly created worker */
1935051e1850SLai Jiangshan 	spin_lock_irq(&pool->lock);
1936051e1850SLai Jiangshan 	worker->pool->nr_workers++;
1937051e1850SLai Jiangshan 	worker_enter_idle(worker);
1938051e1850SLai Jiangshan 	wake_up_process(worker->task);
1939051e1850SLai Jiangshan 	spin_unlock_irq(&pool->lock);
1940051e1850SLai Jiangshan 
1941c34056a3STejun Heo 	return worker;
1942822d8405STejun Heo 
1943c34056a3STejun Heo fail:
19449625ab17SLai Jiangshan 	if (id >= 0)
19457cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, id);
1946c34056a3STejun Heo 	kfree(worker);
1947c34056a3STejun Heo 	return NULL;
1948c34056a3STejun Heo }
1949c34056a3STejun Heo 
1950c34056a3STejun Heo /**
1951c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1952c34056a3STejun Heo  * @worker: worker to be destroyed
1953c34056a3STejun Heo  *
195473eb7fe7SLai Jiangshan  * Destroy @worker and adjust @pool stats accordingly.  The worker should
195573eb7fe7SLai Jiangshan  * be idle.
1956c8e55f36STejun Heo  *
1957c8e55f36STejun Heo  * CONTEXT:
195860f5a4bcSLai Jiangshan  * spin_lock_irq(pool->lock).
1959c34056a3STejun Heo  */
1960c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1961c34056a3STejun Heo {
1962bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1963c34056a3STejun Heo 
1964cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
1965cd549687STejun Heo 
1966c34056a3STejun Heo 	/* sanity check frenzy */
19676183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
196873eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
196973eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
19706183c009STejun Heo 		return;
1971c34056a3STejun Heo 
1972bd7bdd43STejun Heo 	pool->nr_workers--;
1973bd7bdd43STejun Heo 	pool->nr_idle--;
1974c8e55f36STejun Heo 
1975c8e55f36STejun Heo 	list_del_init(&worker->entry);
1976cb444766STejun Heo 	worker->flags |= WORKER_DIE;
197760f5a4bcSLai Jiangshan 	wake_up_process(worker->task);
1978c34056a3STejun Heo }
1979c34056a3STejun Heo 
198032a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t)
1981e22bee78STejun Heo {
198232a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, idle_timer);
1983e22bee78STejun Heo 
1984d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1985e22bee78STejun Heo 
19863347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
1987e22bee78STejun Heo 		struct worker *worker;
1988e22bee78STejun Heo 		unsigned long expires;
1989e22bee78STejun Heo 
1990e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
199163d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
1992e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1993e22bee78STejun Heo 
19943347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
199563d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
19963347fc9fSLai Jiangshan 			break;
1997e22bee78STejun Heo 		}
19983347fc9fSLai Jiangshan 
19993347fc9fSLai Jiangshan 		destroy_worker(worker);
2000e22bee78STejun Heo 	}
2001e22bee78STejun Heo 
2002d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2003e22bee78STejun Heo }
2004e22bee78STejun Heo 
2005493a1724STejun Heo static void send_mayday(struct work_struct *work)
2006e22bee78STejun Heo {
2007112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2008112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
2009493a1724STejun Heo 
20102e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
2011e22bee78STejun Heo 
2012493008a8STejun Heo 	if (!wq->rescuer)
2013493a1724STejun Heo 		return;
2014e22bee78STejun Heo 
2015e22bee78STejun Heo 	/* mayday mayday mayday */
2016493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
201777668c8bSLai Jiangshan 		/*
201877668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
201977668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
202077668c8bSLai Jiangshan 		 * rescuer is done with it.
202177668c8bSLai Jiangshan 		 */
202277668c8bSLai Jiangshan 		get_pwq(pwq);
2023493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
2024e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
2025493a1724STejun Heo 	}
2026e22bee78STejun Heo }
2027e22bee78STejun Heo 
202832a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t)
2029e22bee78STejun Heo {
203032a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, mayday_timer);
2031e22bee78STejun Heo 	struct work_struct *work;
2032e22bee78STejun Heo 
2033b2d82909STejun Heo 	spin_lock_irq(&pool->lock);
2034b2d82909STejun Heo 	spin_lock(&wq_mayday_lock);		/* for wq->maydays */
2035e22bee78STejun Heo 
203663d95a91STejun Heo 	if (need_to_create_worker(pool)) {
2037e22bee78STejun Heo 		/*
2038e22bee78STejun Heo 		 * We've been trying to create a new worker but
2039e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
2040e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
2041e22bee78STejun Heo 		 * rescuers.
2042e22bee78STejun Heo 		 */
204363d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
2044e22bee78STejun Heo 			send_mayday(work);
2045e22bee78STejun Heo 	}
2046e22bee78STejun Heo 
2047b2d82909STejun Heo 	spin_unlock(&wq_mayday_lock);
2048b2d82909STejun Heo 	spin_unlock_irq(&pool->lock);
2049e22bee78STejun Heo 
205063d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
2051e22bee78STejun Heo }
2052e22bee78STejun Heo 
2053e22bee78STejun Heo /**
2054e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
205563d95a91STejun Heo  * @pool: pool to create a new worker for
2056e22bee78STejun Heo  *
205763d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
2058e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
2059e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
206063d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
2061e22bee78STejun Heo  * possible allocation deadlock.
2062e22bee78STejun Heo  *
2063c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
2064c5aa87bbSTejun Heo  * may_start_working() %true.
2065e22bee78STejun Heo  *
2066e22bee78STejun Heo  * LOCKING:
2067d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2068e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
2069e22bee78STejun Heo  * manager.
2070e22bee78STejun Heo  */
207129187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool)
2072d565ed63STejun Heo __releases(&pool->lock)
2073d565ed63STejun Heo __acquires(&pool->lock)
2074e22bee78STejun Heo {
2075e22bee78STejun Heo restart:
2076d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
20779f9c2364STejun Heo 
2078e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
207963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2080e22bee78STejun Heo 
2081e22bee78STejun Heo 	while (true) {
2082051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
2083e22bee78STejun Heo 			break;
2084e22bee78STejun Heo 
2085e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
20869f9c2364STejun Heo 
208763d95a91STejun Heo 		if (!need_to_create_worker(pool))
2088e22bee78STejun Heo 			break;
2089e22bee78STejun Heo 	}
2090e22bee78STejun Heo 
209163d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2092d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2093051e1850SLai Jiangshan 	/*
2094051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
2095051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
2096051e1850SLai Jiangshan 	 * already become busy.
2097051e1850SLai Jiangshan 	 */
209863d95a91STejun Heo 	if (need_to_create_worker(pool))
2099e22bee78STejun Heo 		goto restart;
2100e22bee78STejun Heo }
2101e22bee78STejun Heo 
2102e22bee78STejun Heo /**
2103e22bee78STejun Heo  * manage_workers - manage worker pool
2104e22bee78STejun Heo  * @worker: self
2105e22bee78STejun Heo  *
2106706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
2107e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2108706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
2109e22bee78STejun Heo  *
2110e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2111e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2112e22bee78STejun Heo  * and may_start_working() is true.
2113e22bee78STejun Heo  *
2114e22bee78STejun Heo  * CONTEXT:
2115d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2116e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2117e22bee78STejun Heo  *
2118d185af30SYacine Belkadi  * Return:
211929187a9eSTejun Heo  * %false if the pool doesn't need management and the caller can safely
212029187a9eSTejun Heo  * start processing works, %true if management function was performed and
212129187a9eSTejun Heo  * the conditions that the caller verified before calling the function may
212229187a9eSTejun Heo  * no longer be true.
2123e22bee78STejun Heo  */
2124e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2125e22bee78STejun Heo {
212663d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2127e22bee78STejun Heo 
2128692b4825STejun Heo 	if (pool->flags & POOL_MANAGER_ACTIVE)
212929187a9eSTejun Heo 		return false;
2130692b4825STejun Heo 
2131692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
21322607d7a6STejun Heo 	pool->manager = worker;
2133e22bee78STejun Heo 
213429187a9eSTejun Heo 	maybe_create_worker(pool);
2135e22bee78STejun Heo 
21362607d7a6STejun Heo 	pool->manager = NULL;
2137692b4825STejun Heo 	pool->flags &= ~POOL_MANAGER_ACTIVE;
2138692b4825STejun Heo 	wake_up(&wq_manager_wait);
213929187a9eSTejun Heo 	return true;
2140e22bee78STejun Heo }
2141e22bee78STejun Heo 
2142a62428c0STejun Heo /**
2143a62428c0STejun Heo  * process_one_work - process single work
2144c34056a3STejun Heo  * @worker: self
2145a62428c0STejun Heo  * @work: work to process
2146a62428c0STejun Heo  *
2147a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2148a62428c0STejun Heo  * process a single work including synchronization against and
2149a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2150a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2151a62428c0STejun Heo  * call this function to process a work.
2152a62428c0STejun Heo  *
2153a62428c0STejun Heo  * CONTEXT:
2154d565ed63STejun Heo  * spin_lock_irq(pool->lock) which is released and regrabbed.
2155a62428c0STejun Heo  */
2156c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
2157d565ed63STejun Heo __releases(&pool->lock)
2158d565ed63STejun Heo __acquires(&pool->lock)
21591da177e4SLinus Torvalds {
2160112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2161bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2162112202d9STejun Heo 	bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
216373f53c4aSTejun Heo 	int work_color;
21647e11629dSTejun Heo 	struct worker *collision;
21654e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21664e6045f1SJohannes Berg 	/*
2167a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2168a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2169a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2170a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2171a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21724e6045f1SJohannes Berg 	 */
21734d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21744d82a1deSPeter Zijlstra 
21754d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21764e6045f1SJohannes Berg #endif
2177807407c0SLai Jiangshan 	/* ensure we're on the correct CPU */
217885327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
2179ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
218025511a47STejun Heo 
21817e11629dSTejun Heo 	/*
21827e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21837e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21847e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21857e11629dSTejun Heo 	 * currently executing one.
21867e11629dSTejun Heo 	 */
2187c9e7cf27STejun Heo 	collision = find_worker_executing_work(pool, work);
21887e11629dSTejun Heo 	if (unlikely(collision)) {
21897e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
21907e11629dSTejun Heo 		return;
21917e11629dSTejun Heo 	}
21921da177e4SLinus Torvalds 
21938930cabaSTejun Heo 	/* claim and dequeue */
21941da177e4SLinus Torvalds 	debug_work_deactivate(work);
2195c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2196c34056a3STejun Heo 	worker->current_work = work;
2197a2c1c57bSTejun Heo 	worker->current_func = work->func;
2198112202d9STejun Heo 	worker->current_pwq = pwq;
219973f53c4aSTejun Heo 	work_color = get_work_color(work);
22007a22ad75STejun Heo 
22018bf89593STejun Heo 	/*
22028bf89593STejun Heo 	 * Record wq name for cmdline and debug reporting, may get
22038bf89593STejun Heo 	 * overridden through set_worker_desc().
22048bf89593STejun Heo 	 */
22058bf89593STejun Heo 	strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
22068bf89593STejun Heo 
2207a62428c0STejun Heo 	list_del_init(&work->entry);
2208a62428c0STejun Heo 
2209649027d7STejun Heo 	/*
2210228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
2211228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
2212228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
2213228f1d00SLai Jiangshan 	 * execution of the pending work items.
2214fb0e7bebSTejun Heo 	 */
2215fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2216228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
2217fb0e7bebSTejun Heo 
2218974271c4STejun Heo 	/*
2219a489a03eSLai Jiangshan 	 * Wake up another worker if necessary.  The condition is always
2220a489a03eSLai Jiangshan 	 * false for normal per-cpu workers since nr_running would always
2221a489a03eSLai Jiangshan 	 * be >= 1 at this point.  This is used to chain execution of the
2222a489a03eSLai Jiangshan 	 * pending work items for WORKER_NOT_RUNNING workers such as the
2223228f1d00SLai Jiangshan 	 * UNBOUND and CPU_INTENSIVE ones.
2224974271c4STejun Heo 	 */
2225a489a03eSLai Jiangshan 	if (need_more_worker(pool))
222663d95a91STejun Heo 		wake_up_worker(pool);
2227974271c4STejun Heo 
22288930cabaSTejun Heo 	/*
22297c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
2230d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
223123657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
223223657bb1STejun Heo 	 * disabled.
22338930cabaSTejun Heo 	 */
22347c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
22351da177e4SLinus Torvalds 
2236d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2237365970a1SDavid Howells 
2238a1d14934SPeter Zijlstra 	lock_map_acquire(&pwq->wq->lockdep_map);
22393295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2240e6f3faa7SPeter Zijlstra 	/*
2241f52be570SPeter Zijlstra 	 * Strictly speaking we should mark the invariant state without holding
2242f52be570SPeter Zijlstra 	 * any locks, that is, before these two lock_map_acquire()'s.
2243e6f3faa7SPeter Zijlstra 	 *
2244e6f3faa7SPeter Zijlstra 	 * However, that would result in:
2245e6f3faa7SPeter Zijlstra 	 *
2246e6f3faa7SPeter Zijlstra 	 *   A(W1)
2247e6f3faa7SPeter Zijlstra 	 *   WFC(C)
2248e6f3faa7SPeter Zijlstra 	 *		A(W1)
2249e6f3faa7SPeter Zijlstra 	 *		C(C)
2250e6f3faa7SPeter Zijlstra 	 *
2251e6f3faa7SPeter Zijlstra 	 * Which would create W1->C->W1 dependencies, even though there is no
2252e6f3faa7SPeter Zijlstra 	 * actual deadlock possible. There are two solutions, using a
2253e6f3faa7SPeter Zijlstra 	 * read-recursive acquire on the work(queue) 'locks', but this will then
2254f52be570SPeter Zijlstra 	 * hit the lockdep limitation on recursive locks, or simply discard
2255e6f3faa7SPeter Zijlstra 	 * these locks.
2256e6f3faa7SPeter Zijlstra 	 *
2257e6f3faa7SPeter Zijlstra 	 * AFAICT there is no possible deadlock scenario between the
2258e6f3faa7SPeter Zijlstra 	 * flush_work() and complete() primitives (except for single-threaded
2259e6f3faa7SPeter Zijlstra 	 * workqueues), so hiding them isn't a problem.
2260e6f3faa7SPeter Zijlstra 	 */
2261f52be570SPeter Zijlstra 	lockdep_invariant_state(true);
2262e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2263a2c1c57bSTejun Heo 	worker->current_func(work);
2264e36c886aSArjan van de Ven 	/*
2265e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2266e36c886aSArjan van de Ven 	 * point will only record its address.
2267e36c886aSArjan van de Ven 	 */
2268e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22693295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
2270112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
22711da177e4SLinus Torvalds 
2272d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2273044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2274044c782cSValentin Ilie 		       "     last function: %pf\n",
2275a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2276a2c1c57bSTejun Heo 		       worker->current_func);
2277d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2278d5abe669SPeter Zijlstra 		dump_stack();
2279d5abe669SPeter Zijlstra 	}
2280d5abe669SPeter Zijlstra 
2281b22ce278STejun Heo 	/*
2282b22ce278STejun Heo 	 * The following prevents a kworker from hogging CPU on !PREEMPT
2283b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
2284b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
2285b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
2286789cbbecSJoe Lawrence 	 * stop_machine. At the same time, report a quiescent RCU state so
2287789cbbecSJoe Lawrence 	 * the same condition doesn't freeze RCU.
2288b22ce278STejun Heo 	 */
2289a7e6425eSPaul E. McKenney 	cond_resched();
2290b22ce278STejun Heo 
2291d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2292a62428c0STejun Heo 
2293fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2294fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2295fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2296fb0e7bebSTejun Heo 
22971b69ac6bSJohannes Weiner 	/* tag the worker for identification in schedule() */
22981b69ac6bSJohannes Weiner 	worker->last_func = worker->current_func;
22991b69ac6bSJohannes Weiner 
2300a62428c0STejun Heo 	/* we're done with it, release */
230142f8570fSSasha Levin 	hash_del(&worker->hentry);
2302c34056a3STejun Heo 	worker->current_work = NULL;
2303a2c1c57bSTejun Heo 	worker->current_func = NULL;
2304112202d9STejun Heo 	worker->current_pwq = NULL;
2305112202d9STejun Heo 	pwq_dec_nr_in_flight(pwq, work_color);
23061da177e4SLinus Torvalds }
23071da177e4SLinus Torvalds 
2308affee4b2STejun Heo /**
2309affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2310affee4b2STejun Heo  * @worker: self
2311affee4b2STejun Heo  *
2312affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2313affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2314affee4b2STejun Heo  * fetches a work from the top and executes it.
2315affee4b2STejun Heo  *
2316affee4b2STejun Heo  * CONTEXT:
2317d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2318affee4b2STejun Heo  * multiple times.
2319affee4b2STejun Heo  */
2320affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
23211da177e4SLinus Torvalds {
2322affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2323affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2324a62428c0STejun Heo 						struct work_struct, entry);
2325c34056a3STejun Heo 		process_one_work(worker, work);
2326a62428c0STejun Heo 	}
23271da177e4SLinus Torvalds }
23281da177e4SLinus Torvalds 
2329197f6accSTejun Heo static void set_pf_worker(bool val)
2330197f6accSTejun Heo {
2331197f6accSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
2332197f6accSTejun Heo 	if (val)
2333197f6accSTejun Heo 		current->flags |= PF_WQ_WORKER;
2334197f6accSTejun Heo 	else
2335197f6accSTejun Heo 		current->flags &= ~PF_WQ_WORKER;
2336197f6accSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
2337197f6accSTejun Heo }
2338197f6accSTejun Heo 
23394690c4abSTejun Heo /**
23404690c4abSTejun Heo  * worker_thread - the worker thread function
2341c34056a3STejun Heo  * @__worker: self
23424690c4abSTejun Heo  *
2343c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
2344c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
2345c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
2346c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
2347c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
2348d185af30SYacine Belkadi  *
2349d185af30SYacine Belkadi  * Return: 0
23504690c4abSTejun Heo  */
2351c34056a3STejun Heo static int worker_thread(void *__worker)
23521da177e4SLinus Torvalds {
2353c34056a3STejun Heo 	struct worker *worker = __worker;
2354bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
23551da177e4SLinus Torvalds 
2356e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2357197f6accSTejun Heo 	set_pf_worker(true);
2358c8e55f36STejun Heo woke_up:
2359d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2360affee4b2STejun Heo 
2361a9ab775bSTejun Heo 	/* am I supposed to die? */
2362a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
2363d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
2364a9ab775bSTejun Heo 		WARN_ON_ONCE(!list_empty(&worker->entry));
2365197f6accSTejun Heo 		set_pf_worker(false);
236660f5a4bcSLai Jiangshan 
236760f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
23687cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, worker->id);
2369a2d812a2STejun Heo 		worker_detach_from_pool(worker);
237060f5a4bcSLai Jiangshan 		kfree(worker);
2371c8e55f36STejun Heo 		return 0;
2372c8e55f36STejun Heo 	}
2373c8e55f36STejun Heo 
2374c8e55f36STejun Heo 	worker_leave_idle(worker);
2375db7bccf4STejun Heo recheck:
2376e22bee78STejun Heo 	/* no more worker necessary? */
237763d95a91STejun Heo 	if (!need_more_worker(pool))
2378e22bee78STejun Heo 		goto sleep;
2379e22bee78STejun Heo 
2380e22bee78STejun Heo 	/* do we need to manage? */
238163d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2382e22bee78STejun Heo 		goto recheck;
2383e22bee78STejun Heo 
2384c8e55f36STejun Heo 	/*
2385c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2386c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2387c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2388c8e55f36STejun Heo 	 */
23896183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
2390c8e55f36STejun Heo 
2391e22bee78STejun Heo 	/*
2392a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
2393a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
2394a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
2395a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
2396a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
2397e22bee78STejun Heo 	 */
2398a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2399e22bee78STejun Heo 
2400e22bee78STejun Heo 	do {
2401affee4b2STejun Heo 		struct work_struct *work =
2402bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2403affee4b2STejun Heo 					 struct work_struct, entry);
2404affee4b2STejun Heo 
240582607adcSTejun Heo 		pool->watchdog_ts = jiffies;
240682607adcSTejun Heo 
2407c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2408affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2409affee4b2STejun Heo 			process_one_work(worker, work);
2410affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2411affee4b2STejun Heo 				process_scheduled_works(worker);
2412affee4b2STejun Heo 		} else {
2413c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2414affee4b2STejun Heo 			process_scheduled_works(worker);
2415affee4b2STejun Heo 		}
241663d95a91STejun Heo 	} while (keep_working(pool));
2417affee4b2STejun Heo 
2418228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
2419d313dd85STejun Heo sleep:
2420c8e55f36STejun Heo 	/*
2421d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
2422d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
2423d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
2424d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
2425d565ed63STejun Heo 	 * event.
2426c8e55f36STejun Heo 	 */
2427c8e55f36STejun Heo 	worker_enter_idle(worker);
2428c5a94a61SPeter Zijlstra 	__set_current_state(TASK_IDLE);
2429d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
24301da177e4SLinus Torvalds 	schedule();
2431c8e55f36STejun Heo 	goto woke_up;
24321da177e4SLinus Torvalds }
24331da177e4SLinus Torvalds 
2434e22bee78STejun Heo /**
2435e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2436111c225aSTejun Heo  * @__rescuer: self
2437e22bee78STejun Heo  *
2438e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2439493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
2440e22bee78STejun Heo  *
2441706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
2442e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2443e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2444e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2445e22bee78STejun Heo  * the problem rescuer solves.
2446e22bee78STejun Heo  *
2447706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
2448706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
2449e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2450e22bee78STejun Heo  *
2451e22bee78STejun Heo  * This should happen rarely.
2452d185af30SYacine Belkadi  *
2453d185af30SYacine Belkadi  * Return: 0
2454e22bee78STejun Heo  */
2455111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2456e22bee78STejun Heo {
2457111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2458111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2459e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
24604d595b86SLai Jiangshan 	bool should_stop;
2461e22bee78STejun Heo 
2462e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2463111c225aSTejun Heo 
2464111c225aSTejun Heo 	/*
2465111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2466111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2467111c225aSTejun Heo 	 */
2468197f6accSTejun Heo 	set_pf_worker(true);
2469e22bee78STejun Heo repeat:
2470c5a94a61SPeter Zijlstra 	set_current_state(TASK_IDLE);
24711da177e4SLinus Torvalds 
24724d595b86SLai Jiangshan 	/*
24734d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
24744d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
24754d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
24764d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
24774d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
24784d595b86SLai Jiangshan 	 * list is always empty on exit.
24794d595b86SLai Jiangshan 	 */
24804d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
24811da177e4SLinus Torvalds 
2482493a1724STejun Heo 	/* see whether any pwq is asking for help */
24832e109a28STejun Heo 	spin_lock_irq(&wq_mayday_lock);
2484493a1724STejun Heo 
2485493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
2486493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2487493a1724STejun Heo 					struct pool_workqueue, mayday_node);
2488112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
2489e22bee78STejun Heo 		struct work_struct *work, *n;
249082607adcSTejun Heo 		bool first = true;
2491e22bee78STejun Heo 
2492e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2493493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
2494493a1724STejun Heo 
24952e109a28STejun Heo 		spin_unlock_irq(&wq_mayday_lock);
2496e22bee78STejun Heo 
249751697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
249851697d39SLai Jiangshan 
249951697d39SLai Jiangshan 		spin_lock_irq(&pool->lock);
2500e22bee78STejun Heo 
2501e22bee78STejun Heo 		/*
2502e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2503e22bee78STejun Heo 		 * process'em.
2504e22bee78STejun Heo 		 */
25050479c8c5STejun Heo 		WARN_ON_ONCE(!list_empty(scheduled));
250682607adcSTejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry) {
250782607adcSTejun Heo 			if (get_work_pwq(work) == pwq) {
250882607adcSTejun Heo 				if (first)
250982607adcSTejun Heo 					pool->watchdog_ts = jiffies;
2510e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
251182607adcSTejun Heo 			}
251282607adcSTejun Heo 			first = false;
251382607adcSTejun Heo 		}
2514e22bee78STejun Heo 
2515008847f6SNeilBrown 		if (!list_empty(scheduled)) {
2516e22bee78STejun Heo 			process_scheduled_works(rescuer);
25177576958aSTejun Heo 
25187576958aSTejun Heo 			/*
2519008847f6SNeilBrown 			 * The above execution of rescued work items could
2520008847f6SNeilBrown 			 * have created more to rescue through
2521008847f6SNeilBrown 			 * pwq_activate_first_delayed() or chained
2522008847f6SNeilBrown 			 * queueing.  Let's put @pwq back on mayday list so
2523008847f6SNeilBrown 			 * that such back-to-back work items, which may be
2524008847f6SNeilBrown 			 * being used to relieve memory pressure, don't
2525008847f6SNeilBrown 			 * incur MAYDAY_INTERVAL delay inbetween.
2526008847f6SNeilBrown 			 */
2527008847f6SNeilBrown 			if (need_to_create_worker(pool)) {
2528008847f6SNeilBrown 				spin_lock(&wq_mayday_lock);
2529008847f6SNeilBrown 				get_pwq(pwq);
2530008847f6SNeilBrown 				list_move_tail(&pwq->mayday_node, &wq->maydays);
2531008847f6SNeilBrown 				spin_unlock(&wq_mayday_lock);
2532008847f6SNeilBrown 			}
2533008847f6SNeilBrown 		}
2534008847f6SNeilBrown 
2535008847f6SNeilBrown 		/*
253677668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
253713b1d625SLai Jiangshan 		 * go away while we're still attached to it.
253877668c8bSLai Jiangshan 		 */
253977668c8bSLai Jiangshan 		put_pwq(pwq);
254077668c8bSLai Jiangshan 
254177668c8bSLai Jiangshan 		/*
2542d8ca83e6SLai Jiangshan 		 * Leave this pool.  If need_more_worker() is %true, notify a
25437576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
25447576958aSTejun Heo 		 * and stalling the execution.
25457576958aSTejun Heo 		 */
2546d8ca83e6SLai Jiangshan 		if (need_more_worker(pool))
254763d95a91STejun Heo 			wake_up_worker(pool);
25487576958aSTejun Heo 
254913b1d625SLai Jiangshan 		spin_unlock_irq(&pool->lock);
255013b1d625SLai Jiangshan 
2551a2d812a2STejun Heo 		worker_detach_from_pool(rescuer);
255213b1d625SLai Jiangshan 
255313b1d625SLai Jiangshan 		spin_lock_irq(&wq_mayday_lock);
25541da177e4SLinus Torvalds 	}
25551da177e4SLinus Torvalds 
25562e109a28STejun Heo 	spin_unlock_irq(&wq_mayday_lock);
2557493a1724STejun Heo 
25584d595b86SLai Jiangshan 	if (should_stop) {
25594d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
2560197f6accSTejun Heo 		set_pf_worker(false);
25614d595b86SLai Jiangshan 		return 0;
25624d595b86SLai Jiangshan 	}
25634d595b86SLai Jiangshan 
2564111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2565111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2566e22bee78STejun Heo 	schedule();
2567e22bee78STejun Heo 	goto repeat;
25681da177e4SLinus Torvalds }
25691da177e4SLinus Torvalds 
2570fca839c0STejun Heo /**
2571fca839c0STejun Heo  * check_flush_dependency - check for flush dependency sanity
2572fca839c0STejun Heo  * @target_wq: workqueue being flushed
2573fca839c0STejun Heo  * @target_work: work item being flushed (NULL for workqueue flushes)
2574fca839c0STejun Heo  *
2575fca839c0STejun Heo  * %current is trying to flush the whole @target_wq or @target_work on it.
2576fca839c0STejun Heo  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2577fca839c0STejun Heo  * reclaiming memory or running on a workqueue which doesn't have
2578fca839c0STejun Heo  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2579fca839c0STejun Heo  * a deadlock.
2580fca839c0STejun Heo  */
2581fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq,
2582fca839c0STejun Heo 				   struct work_struct *target_work)
2583fca839c0STejun Heo {
2584fca839c0STejun Heo 	work_func_t target_func = target_work ? target_work->func : NULL;
2585fca839c0STejun Heo 	struct worker *worker;
2586fca839c0STejun Heo 
2587fca839c0STejun Heo 	if (target_wq->flags & WQ_MEM_RECLAIM)
2588fca839c0STejun Heo 		return;
2589fca839c0STejun Heo 
2590fca839c0STejun Heo 	worker = current_wq_worker();
2591fca839c0STejun Heo 
2592fca839c0STejun Heo 	WARN_ONCE(current->flags & PF_MEMALLOC,
2593fca839c0STejun Heo 		  "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2594fca839c0STejun Heo 		  current->pid, current->comm, target_wq->name, target_func);
259523d11a58STejun Heo 	WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
259623d11a58STejun Heo 			      (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
2597fca839c0STejun Heo 		  "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2598fca839c0STejun Heo 		  worker->current_pwq->wq->name, worker->current_func,
2599fca839c0STejun Heo 		  target_wq->name, target_func);
2600fca839c0STejun Heo }
2601fca839c0STejun Heo 
2602fc2e4d70SOleg Nesterov struct wq_barrier {
2603fc2e4d70SOleg Nesterov 	struct work_struct	work;
2604fc2e4d70SOleg Nesterov 	struct completion	done;
26052607d7a6STejun Heo 	struct task_struct	*task;	/* purely informational */
2606fc2e4d70SOleg Nesterov };
2607fc2e4d70SOleg Nesterov 
2608fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2609fc2e4d70SOleg Nesterov {
2610fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2611fc2e4d70SOleg Nesterov 	complete(&barr->done);
2612fc2e4d70SOleg Nesterov }
2613fc2e4d70SOleg Nesterov 
26144690c4abSTejun Heo /**
26154690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
2616112202d9STejun Heo  * @pwq: pwq to insert barrier into
26174690c4abSTejun Heo  * @barr: wq_barrier to insert
2618affee4b2STejun Heo  * @target: target work to attach @barr to
2619affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
26204690c4abSTejun Heo  *
2621affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2622affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2623affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2624affee4b2STejun Heo  * cpu.
2625affee4b2STejun Heo  *
2626affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2627affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2628affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2629affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2630affee4b2STejun Heo  * after a work with LINKED flag set.
2631affee4b2STejun Heo  *
2632affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2633112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
26344690c4abSTejun Heo  *
26354690c4abSTejun Heo  * CONTEXT:
2636d565ed63STejun Heo  * spin_lock_irq(pool->lock).
26374690c4abSTejun Heo  */
2638112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
2639affee4b2STejun Heo 			      struct wq_barrier *barr,
2640affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2641fc2e4d70SOleg Nesterov {
2642affee4b2STejun Heo 	struct list_head *head;
2643affee4b2STejun Heo 	unsigned int linked = 0;
2644affee4b2STejun Heo 
2645dc186ad7SThomas Gleixner 	/*
2646d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
2647dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2648dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2649dc186ad7SThomas Gleixner 	 * might deadlock.
2650dc186ad7SThomas Gleixner 	 */
2651ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
265222df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
265352fa5bc5SBoqun Feng 
2654fd1a5b04SByungchul Park 	init_completion_map(&barr->done, &target->lockdep_map);
2655fd1a5b04SByungchul Park 
26562607d7a6STejun Heo 	barr->task = current;
265783c22520SOleg Nesterov 
2658affee4b2STejun Heo 	/*
2659affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2660affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2661affee4b2STejun Heo 	 */
2662affee4b2STejun Heo 	if (worker)
2663affee4b2STejun Heo 		head = worker->scheduled.next;
2664affee4b2STejun Heo 	else {
2665affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2666affee4b2STejun Heo 
2667affee4b2STejun Heo 		head = target->entry.next;
2668affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2669affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2670affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2671affee4b2STejun Heo 	}
2672affee4b2STejun Heo 
2673dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2674112202d9STejun Heo 	insert_work(pwq, &barr->work, head,
2675affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2676fc2e4d70SOleg Nesterov }
2677fc2e4d70SOleg Nesterov 
267873f53c4aSTejun Heo /**
2679112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
268073f53c4aSTejun Heo  * @wq: workqueue being flushed
268173f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
268273f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
268373f53c4aSTejun Heo  *
2684112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
268573f53c4aSTejun Heo  *
2686112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
2687112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
2688112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
2689112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
2690112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
269173f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
269273f53c4aSTejun Heo  *
269373f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
269473f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
269573f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
269673f53c4aSTejun Heo  * is returned.
269773f53c4aSTejun Heo  *
2698112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
269973f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
270073f53c4aSTejun Heo  * advanced to @work_color.
270173f53c4aSTejun Heo  *
270273f53c4aSTejun Heo  * CONTEXT:
27033c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
270473f53c4aSTejun Heo  *
2705d185af30SYacine Belkadi  * Return:
270673f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
270773f53c4aSTejun Heo  * otherwise.
270873f53c4aSTejun Heo  */
2709112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
271073f53c4aSTejun Heo 				      int flush_color, int work_color)
27111da177e4SLinus Torvalds {
271273f53c4aSTejun Heo 	bool wait = false;
271349e3cf44STejun Heo 	struct pool_workqueue *pwq;
27141da177e4SLinus Torvalds 
271573f53c4aSTejun Heo 	if (flush_color >= 0) {
27166183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2717112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
2718dc186ad7SThomas Gleixner 	}
271914441960SOleg Nesterov 
272049e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2721112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
27221da177e4SLinus Torvalds 
2723b09f4fd3SLai Jiangshan 		spin_lock_irq(&pool->lock);
272473f53c4aSTejun Heo 
272573f53c4aSTejun Heo 		if (flush_color >= 0) {
27266183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
272773f53c4aSTejun Heo 
2728112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
2729112202d9STejun Heo 				pwq->flush_color = flush_color;
2730112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
273173f53c4aSTejun Heo 				wait = true;
27321da177e4SLinus Torvalds 			}
273373f53c4aSTejun Heo 		}
273473f53c4aSTejun Heo 
273573f53c4aSTejun Heo 		if (work_color >= 0) {
27366183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2737112202d9STejun Heo 			pwq->work_color = work_color;
273873f53c4aSTejun Heo 		}
273973f53c4aSTejun Heo 
2740b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pool->lock);
27411da177e4SLinus Torvalds 	}
27421da177e4SLinus Torvalds 
2743112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
274473f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
274573f53c4aSTejun Heo 
274673f53c4aSTejun Heo 	return wait;
274783c22520SOleg Nesterov }
27481da177e4SLinus Torvalds 
27490fcb78c2SRolf Eike Beer /**
27501da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
27510fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
27521da177e4SLinus Torvalds  *
2753c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
2754c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
27551da177e4SLinus Torvalds  */
27567ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
27571da177e4SLinus Torvalds {
275873f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
275973f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
276073f53c4aSTejun Heo 		.flush_color = -1,
2761fd1a5b04SByungchul Park 		.done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
276273f53c4aSTejun Heo 	};
276373f53c4aSTejun Heo 	int next_color;
2764b1f4ec17SOleg Nesterov 
27653347fa09STejun Heo 	if (WARN_ON(!wq_online))
27663347fa09STejun Heo 		return;
27673347fa09STejun Heo 
276887915adcSJohannes Berg 	lock_map_acquire(&wq->lockdep_map);
276987915adcSJohannes Berg 	lock_map_release(&wq->lockdep_map);
277087915adcSJohannes Berg 
27713c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
277273f53c4aSTejun Heo 
277373f53c4aSTejun Heo 	/*
277473f53c4aSTejun Heo 	 * Start-to-wait phase
277573f53c4aSTejun Heo 	 */
277673f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
277773f53c4aSTejun Heo 
277873f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
277973f53c4aSTejun Heo 		/*
278073f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
278173f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
278273f53c4aSTejun Heo 		 * by one.
278373f53c4aSTejun Heo 		 */
27846183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
278573f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
278673f53c4aSTejun Heo 		wq->work_color = next_color;
278773f53c4aSTejun Heo 
278873f53c4aSTejun Heo 		if (!wq->first_flusher) {
278973f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
27906183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
279173f53c4aSTejun Heo 
279273f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
279373f53c4aSTejun Heo 
2794112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
279573f53c4aSTejun Heo 						       wq->work_color)) {
279673f53c4aSTejun Heo 				/* nothing to flush, done */
279773f53c4aSTejun Heo 				wq->flush_color = next_color;
279873f53c4aSTejun Heo 				wq->first_flusher = NULL;
279973f53c4aSTejun Heo 				goto out_unlock;
280073f53c4aSTejun Heo 			}
280173f53c4aSTejun Heo 		} else {
280273f53c4aSTejun Heo 			/* wait in queue */
28036183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
280473f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
2805112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
280673f53c4aSTejun Heo 		}
280773f53c4aSTejun Heo 	} else {
280873f53c4aSTejun Heo 		/*
280973f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
281073f53c4aSTejun Heo 		 * The next flush completion will assign us
281173f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
281273f53c4aSTejun Heo 		 */
281373f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
281473f53c4aSTejun Heo 	}
281573f53c4aSTejun Heo 
2816fca839c0STejun Heo 	check_flush_dependency(wq, NULL);
2817fca839c0STejun Heo 
28183c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
281973f53c4aSTejun Heo 
282073f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
282173f53c4aSTejun Heo 
282273f53c4aSTejun Heo 	/*
282373f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
282473f53c4aSTejun Heo 	 *
282573f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
282673f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
282773f53c4aSTejun Heo 	 */
282873f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
282973f53c4aSTejun Heo 		return;
283073f53c4aSTejun Heo 
28313c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
283273f53c4aSTejun Heo 
28334ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
28344ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
28354ce48b37STejun Heo 		goto out_unlock;
28364ce48b37STejun Heo 
283773f53c4aSTejun Heo 	wq->first_flusher = NULL;
283873f53c4aSTejun Heo 
28396183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
28406183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
284173f53c4aSTejun Heo 
284273f53c4aSTejun Heo 	while (true) {
284373f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
284473f53c4aSTejun Heo 
284573f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
284673f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
284773f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
284873f53c4aSTejun Heo 				break;
284973f53c4aSTejun Heo 			list_del_init(&next->list);
285073f53c4aSTejun Heo 			complete(&next->done);
285173f53c4aSTejun Heo 		}
285273f53c4aSTejun Heo 
28536183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
285473f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
285573f53c4aSTejun Heo 
285673f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
285773f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
285873f53c4aSTejun Heo 
285973f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
286073f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
286173f53c4aSTejun Heo 			/*
286273f53c4aSTejun Heo 			 * Assign the same color to all overflowed
286373f53c4aSTejun Heo 			 * flushers, advance work_color and append to
286473f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
286573f53c4aSTejun Heo 			 * phase for these overflowed flushers.
286673f53c4aSTejun Heo 			 */
286773f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
286873f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
286973f53c4aSTejun Heo 
287073f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
287173f53c4aSTejun Heo 
287273f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
287373f53c4aSTejun Heo 					      &wq->flusher_queue);
2874112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
287573f53c4aSTejun Heo 		}
287673f53c4aSTejun Heo 
287773f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
28786183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
287973f53c4aSTejun Heo 			break;
288073f53c4aSTejun Heo 		}
288173f53c4aSTejun Heo 
288273f53c4aSTejun Heo 		/*
288373f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
2884112202d9STejun Heo 		 * the new first flusher and arm pwqs.
288573f53c4aSTejun Heo 		 */
28866183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
28876183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
288873f53c4aSTejun Heo 
288973f53c4aSTejun Heo 		list_del_init(&next->list);
289073f53c4aSTejun Heo 		wq->first_flusher = next;
289173f53c4aSTejun Heo 
2892112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
289373f53c4aSTejun Heo 			break;
289473f53c4aSTejun Heo 
289573f53c4aSTejun Heo 		/*
289673f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
289773f53c4aSTejun Heo 		 * flusher and repeat cascading.
289873f53c4aSTejun Heo 		 */
289973f53c4aSTejun Heo 		wq->first_flusher = NULL;
290073f53c4aSTejun Heo 	}
290173f53c4aSTejun Heo 
290273f53c4aSTejun Heo out_unlock:
29033c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
29041da177e4SLinus Torvalds }
29051dadafa8STim Gardner EXPORT_SYMBOL(flush_workqueue);
29061da177e4SLinus Torvalds 
29079c5a2ba7STejun Heo /**
29089c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
29099c5a2ba7STejun Heo  * @wq: workqueue to drain
29109c5a2ba7STejun Heo  *
29119c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
29129c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
29139c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
2914b749b1b6SChen Hanxiao  * repeatedly until it becomes empty.  The number of flushing is determined
29159c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
29169c5a2ba7STejun Heo  * takes too long.
29179c5a2ba7STejun Heo  */
29189c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
29199c5a2ba7STejun Heo {
29209c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
292149e3cf44STejun Heo 	struct pool_workqueue *pwq;
29229c5a2ba7STejun Heo 
29239c5a2ba7STejun Heo 	/*
29249c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
29259c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
2926618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
29279c5a2ba7STejun Heo 	 */
292887fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
29299c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
2930618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
293187fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
29329c5a2ba7STejun Heo reflush:
29339c5a2ba7STejun Heo 	flush_workqueue(wq);
29349c5a2ba7STejun Heo 
2935b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
293676af4d93STejun Heo 
293749e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2938fa2563e4SThomas Tuttle 		bool drained;
29399c5a2ba7STejun Heo 
2940b09f4fd3SLai Jiangshan 		spin_lock_irq(&pwq->pool->lock);
2941112202d9STejun Heo 		drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2942b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pwq->pool->lock);
2943fa2563e4SThomas Tuttle 
2944fa2563e4SThomas Tuttle 		if (drained)
29459c5a2ba7STejun Heo 			continue;
29469c5a2ba7STejun Heo 
29479c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
29489c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2949c5aa87bbSTejun Heo 			pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
29509c5a2ba7STejun Heo 				wq->name, flush_cnt);
295176af4d93STejun Heo 
2952b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
29539c5a2ba7STejun Heo 		goto reflush;
29549c5a2ba7STejun Heo 	}
29559c5a2ba7STejun Heo 
29569c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
2957618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
295887fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
29599c5a2ba7STejun Heo }
29609c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
29619c5a2ba7STejun Heo 
2962d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2963d6e89786SJohannes Berg 			     bool from_cancel)
2964baf59022STejun Heo {
2965baf59022STejun Heo 	struct worker *worker = NULL;
2966c9e7cf27STejun Heo 	struct worker_pool *pool;
2967112202d9STejun Heo 	struct pool_workqueue *pwq;
2968baf59022STejun Heo 
2969baf59022STejun Heo 	might_sleep();
2970baf59022STejun Heo 
2971fa1b54e6STejun Heo 	local_irq_disable();
2972fa1b54e6STejun Heo 	pool = get_work_pool(work);
2973fa1b54e6STejun Heo 	if (!pool) {
2974fa1b54e6STejun Heo 		local_irq_enable();
2975fa1b54e6STejun Heo 		return false;
2976fa1b54e6STejun Heo 	}
2977fa1b54e6STejun Heo 
2978fa1b54e6STejun Heo 	spin_lock(&pool->lock);
29790b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
2980112202d9STejun Heo 	pwq = get_work_pwq(work);
2981112202d9STejun Heo 	if (pwq) {
2982112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
2983baf59022STejun Heo 			goto already_gone;
2984606a5020STejun Heo 	} else {
2985c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
2986baf59022STejun Heo 		if (!worker)
2987baf59022STejun Heo 			goto already_gone;
2988112202d9STejun Heo 		pwq = worker->current_pwq;
2989606a5020STejun Heo 	}
2990baf59022STejun Heo 
2991fca839c0STejun Heo 	check_flush_dependency(pwq->wq, work);
2992fca839c0STejun Heo 
2993112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
2994d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2995baf59022STejun Heo 
2996e159489bSTejun Heo 	/*
2997a1d14934SPeter Zijlstra 	 * Force a lock recursion deadlock when using flush_work() inside a
2998a1d14934SPeter Zijlstra 	 * single-threaded or rescuer equipped workqueue.
2999a1d14934SPeter Zijlstra 	 *
3000a1d14934SPeter Zijlstra 	 * For single threaded workqueues the deadlock happens when the work
3001a1d14934SPeter Zijlstra 	 * is after the work issuing the flush_work(). For rescuer equipped
3002a1d14934SPeter Zijlstra 	 * workqueues the deadlock happens when the rescuer stalls, blocking
3003a1d14934SPeter Zijlstra 	 * forward progress.
3004e159489bSTejun Heo 	 */
3005d6e89786SJohannes Berg 	if (!from_cancel &&
3006d6e89786SJohannes Berg 	    (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
3007112202d9STejun Heo 		lock_map_acquire(&pwq->wq->lockdep_map);
3008112202d9STejun Heo 		lock_map_release(&pwq->wq->lockdep_map);
3009a1d14934SPeter Zijlstra 	}
3010e159489bSTejun Heo 
3011baf59022STejun Heo 	return true;
3012baf59022STejun Heo already_gone:
3013d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
3014baf59022STejun Heo 	return false;
3015baf59022STejun Heo }
3016baf59022STejun Heo 
3017d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel)
3018d6e89786SJohannes Berg {
3019d6e89786SJohannes Berg 	struct wq_barrier barr;
3020d6e89786SJohannes Berg 
3021d6e89786SJohannes Berg 	if (WARN_ON(!wq_online))
3022d6e89786SJohannes Berg 		return false;
3023d6e89786SJohannes Berg 
30244d43d395STetsuo Handa 	if (WARN_ON(!work->func))
30254d43d395STetsuo Handa 		return false;
30264d43d395STetsuo Handa 
302787915adcSJohannes Berg 	if (!from_cancel) {
302887915adcSJohannes Berg 		lock_map_acquire(&work->lockdep_map);
302987915adcSJohannes Berg 		lock_map_release(&work->lockdep_map);
303087915adcSJohannes Berg 	}
303187915adcSJohannes Berg 
3032d6e89786SJohannes Berg 	if (start_flush_work(work, &barr, from_cancel)) {
3033d6e89786SJohannes Berg 		wait_for_completion(&barr.done);
3034d6e89786SJohannes Berg 		destroy_work_on_stack(&barr.work);
3035d6e89786SJohannes Berg 		return true;
3036d6e89786SJohannes Berg 	} else {
3037d6e89786SJohannes Berg 		return false;
3038d6e89786SJohannes Berg 	}
3039d6e89786SJohannes Berg }
3040d6e89786SJohannes Berg 
3041db700897SOleg Nesterov /**
3042401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
3043401a8d04STejun Heo  * @work: the work to flush
3044db700897SOleg Nesterov  *
3045606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
3046606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
3047401a8d04STejun Heo  *
3048d185af30SYacine Belkadi  * Return:
3049401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3050401a8d04STejun Heo  * %false if it was already idle.
3051db700897SOleg Nesterov  */
3052401a8d04STejun Heo bool flush_work(struct work_struct *work)
3053db700897SOleg Nesterov {
3054d6e89786SJohannes Berg 	return __flush_work(work, false);
3055606a5020STejun Heo }
3056db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
3057db700897SOleg Nesterov 
30588603e1b3STejun Heo struct cwt_wait {
3059ac6424b9SIngo Molnar 	wait_queue_entry_t		wait;
30608603e1b3STejun Heo 	struct work_struct	*work;
30618603e1b3STejun Heo };
30628603e1b3STejun Heo 
3063ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
30648603e1b3STejun Heo {
30658603e1b3STejun Heo 	struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
30668603e1b3STejun Heo 
30678603e1b3STejun Heo 	if (cwait->work != key)
30688603e1b3STejun Heo 		return 0;
30698603e1b3STejun Heo 	return autoremove_wake_function(wait, mode, sync, key);
30708603e1b3STejun Heo }
30718603e1b3STejun Heo 
307236e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
3073401a8d04STejun Heo {
30748603e1b3STejun Heo 	static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
3075bbb68dfaSTejun Heo 	unsigned long flags;
30761f1f642eSOleg Nesterov 	int ret;
30771f1f642eSOleg Nesterov 
30781f1f642eSOleg Nesterov 	do {
3079bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
3080bbb68dfaSTejun Heo 		/*
30818603e1b3STejun Heo 		 * If someone else is already canceling, wait for it to
30828603e1b3STejun Heo 		 * finish.  flush_work() doesn't work for PREEMPT_NONE
30838603e1b3STejun Heo 		 * because we may get scheduled between @work's completion
30848603e1b3STejun Heo 		 * and the other canceling task resuming and clearing
30858603e1b3STejun Heo 		 * CANCELING - flush_work() will return false immediately
30868603e1b3STejun Heo 		 * as @work is no longer busy, try_to_grab_pending() will
30878603e1b3STejun Heo 		 * return -ENOENT as @work is still being canceled and the
30888603e1b3STejun Heo 		 * other canceling task won't be able to clear CANCELING as
30898603e1b3STejun Heo 		 * we're hogging the CPU.
30908603e1b3STejun Heo 		 *
30918603e1b3STejun Heo 		 * Let's wait for completion using a waitqueue.  As this
30928603e1b3STejun Heo 		 * may lead to the thundering herd problem, use a custom
30938603e1b3STejun Heo 		 * wake function which matches @work along with exclusive
30948603e1b3STejun Heo 		 * wait and wakeup.
3095bbb68dfaSTejun Heo 		 */
30968603e1b3STejun Heo 		if (unlikely(ret == -ENOENT)) {
30978603e1b3STejun Heo 			struct cwt_wait cwait;
30988603e1b3STejun Heo 
30998603e1b3STejun Heo 			init_wait(&cwait.wait);
31008603e1b3STejun Heo 			cwait.wait.func = cwt_wakefn;
31018603e1b3STejun Heo 			cwait.work = work;
31028603e1b3STejun Heo 
31038603e1b3STejun Heo 			prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
31048603e1b3STejun Heo 						  TASK_UNINTERRUPTIBLE);
31058603e1b3STejun Heo 			if (work_is_canceling(work))
31068603e1b3STejun Heo 				schedule();
31078603e1b3STejun Heo 			finish_wait(&cancel_waitq, &cwait.wait);
31088603e1b3STejun Heo 		}
31091f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
31101f1f642eSOleg Nesterov 
3111bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
3112bbb68dfaSTejun Heo 	mark_work_canceling(work);
3113bbb68dfaSTejun Heo 	local_irq_restore(flags);
3114bbb68dfaSTejun Heo 
31153347fa09STejun Heo 	/*
31163347fa09STejun Heo 	 * This allows canceling during early boot.  We know that @work
31173347fa09STejun Heo 	 * isn't executing.
31183347fa09STejun Heo 	 */
31193347fa09STejun Heo 	if (wq_online)
3120d6e89786SJohannes Berg 		__flush_work(work, true);
31213347fa09STejun Heo 
31227a22ad75STejun Heo 	clear_work_data(work);
31238603e1b3STejun Heo 
31248603e1b3STejun Heo 	/*
31258603e1b3STejun Heo 	 * Paired with prepare_to_wait() above so that either
31268603e1b3STejun Heo 	 * waitqueue_active() is visible here or !work_is_canceling() is
31278603e1b3STejun Heo 	 * visible there.
31288603e1b3STejun Heo 	 */
31298603e1b3STejun Heo 	smp_mb();
31308603e1b3STejun Heo 	if (waitqueue_active(&cancel_waitq))
31318603e1b3STejun Heo 		__wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
31328603e1b3STejun Heo 
31331f1f642eSOleg Nesterov 	return ret;
31341f1f642eSOleg Nesterov }
31351f1f642eSOleg Nesterov 
31366e84d644SOleg Nesterov /**
3137401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
3138401a8d04STejun Heo  * @work: the work to cancel
31396e84d644SOleg Nesterov  *
3140401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
3141401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
3142401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
3143401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
31441f1f642eSOleg Nesterov  *
3145401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
3146401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
31476e84d644SOleg Nesterov  *
3148401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
31496e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
3150401a8d04STejun Heo  *
3151d185af30SYacine Belkadi  * Return:
3152401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
31536e84d644SOleg Nesterov  */
3154401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
31556e84d644SOleg Nesterov {
315636e227d2STejun Heo 	return __cancel_work_timer(work, false);
3157b89deed3SOleg Nesterov }
315828e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
3159b89deed3SOleg Nesterov 
31606e84d644SOleg Nesterov /**
3161401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
3162401a8d04STejun Heo  * @dwork: the delayed work to flush
31636e84d644SOleg Nesterov  *
3164401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
3165401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
3166401a8d04STejun Heo  * considers the last queueing instance of @dwork.
31671f1f642eSOleg Nesterov  *
3168d185af30SYacine Belkadi  * Return:
3169401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3170401a8d04STejun Heo  * %false if it was already idle.
31716e84d644SOleg Nesterov  */
3172401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
3173401a8d04STejun Heo {
31748930cabaSTejun Heo 	local_irq_disable();
3175401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
317660c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
31778930cabaSTejun Heo 	local_irq_enable();
3178401a8d04STejun Heo 	return flush_work(&dwork->work);
3179401a8d04STejun Heo }
3180401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
3181401a8d04STejun Heo 
318205f0fe6bSTejun Heo /**
318305f0fe6bSTejun Heo  * flush_rcu_work - wait for a rwork to finish executing the last queueing
318405f0fe6bSTejun Heo  * @rwork: the rcu work to flush
318505f0fe6bSTejun Heo  *
318605f0fe6bSTejun Heo  * Return:
318705f0fe6bSTejun Heo  * %true if flush_rcu_work() waited for the work to finish execution,
318805f0fe6bSTejun Heo  * %false if it was already idle.
318905f0fe6bSTejun Heo  */
319005f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork)
319105f0fe6bSTejun Heo {
319205f0fe6bSTejun Heo 	if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
319305f0fe6bSTejun Heo 		rcu_barrier();
319405f0fe6bSTejun Heo 		flush_work(&rwork->work);
319505f0fe6bSTejun Heo 		return true;
319605f0fe6bSTejun Heo 	} else {
319705f0fe6bSTejun Heo 		return flush_work(&rwork->work);
319805f0fe6bSTejun Heo 	}
319905f0fe6bSTejun Heo }
320005f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work);
320105f0fe6bSTejun Heo 
3202f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork)
3203f72b8792SJens Axboe {
3204f72b8792SJens Axboe 	unsigned long flags;
3205f72b8792SJens Axboe 	int ret;
3206f72b8792SJens Axboe 
3207f72b8792SJens Axboe 	do {
3208f72b8792SJens Axboe 		ret = try_to_grab_pending(work, is_dwork, &flags);
3209f72b8792SJens Axboe 	} while (unlikely(ret == -EAGAIN));
3210f72b8792SJens Axboe 
3211f72b8792SJens Axboe 	if (unlikely(ret < 0))
3212f72b8792SJens Axboe 		return false;
3213f72b8792SJens Axboe 
3214f72b8792SJens Axboe 	set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3215f72b8792SJens Axboe 	local_irq_restore(flags);
3216f72b8792SJens Axboe 	return ret;
3217f72b8792SJens Axboe }
3218f72b8792SJens Axboe 
3219401a8d04STejun Heo /**
322057b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
322157b30ae7STejun Heo  * @dwork: delayed_work to cancel
322209383498STejun Heo  *
3223d185af30SYacine Belkadi  * Kill off a pending delayed_work.
3224d185af30SYacine Belkadi  *
3225d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
3226d185af30SYacine Belkadi  * pending.
3227d185af30SYacine Belkadi  *
3228d185af30SYacine Belkadi  * Note:
3229d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
3230d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
3231d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
323209383498STejun Heo  *
323357b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
323409383498STejun Heo  */
323557b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
323609383498STejun Heo {
3237f72b8792SJens Axboe 	return __cancel_work(&dwork->work, true);
323809383498STejun Heo }
323957b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
324009383498STejun Heo 
324109383498STejun Heo /**
3242401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3243401a8d04STejun Heo  * @dwork: the delayed work cancel
3244401a8d04STejun Heo  *
3245401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
3246401a8d04STejun Heo  *
3247d185af30SYacine Belkadi  * Return:
3248401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
3249401a8d04STejun Heo  */
3250401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
32516e84d644SOleg Nesterov {
325236e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
32536e84d644SOleg Nesterov }
3254f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
32551da177e4SLinus Torvalds 
32560fcb78c2SRolf Eike Beer /**
325731ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3258b6136773SAndrew Morton  * @func: the function to call
3259b6136773SAndrew Morton  *
326031ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
326131ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3262b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
326331ddd871STejun Heo  *
3264d185af30SYacine Belkadi  * Return:
326531ddd871STejun Heo  * 0 on success, -errno on failure.
3266b6136773SAndrew Morton  */
326765f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
326815316ba8SChristoph Lameter {
326915316ba8SChristoph Lameter 	int cpu;
327038f51568SNamhyung Kim 	struct work_struct __percpu *works;
327115316ba8SChristoph Lameter 
3272b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3273b6136773SAndrew Morton 	if (!works)
327415316ba8SChristoph Lameter 		return -ENOMEM;
3275b6136773SAndrew Morton 
327695402b38SGautham R Shenoy 	get_online_cpus();
327793981800STejun Heo 
327815316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
32799bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
32809bfb1839SIngo Molnar 
32819bfb1839SIngo Molnar 		INIT_WORK(work, func);
32828de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
328315316ba8SChristoph Lameter 	}
328493981800STejun Heo 
328593981800STejun Heo 	for_each_online_cpu(cpu)
32868616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
328793981800STejun Heo 
328895402b38SGautham R Shenoy 	put_online_cpus();
3289b6136773SAndrew Morton 	free_percpu(works);
329015316ba8SChristoph Lameter 	return 0;
329115316ba8SChristoph Lameter }
329215316ba8SChristoph Lameter 
3293eef6a7d5SAlan Stern /**
32941fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
32951fa44ecaSJames Bottomley  * @fn:		the function to execute
32961fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
32971fa44ecaSJames Bottomley  *		be available when the work executes)
32981fa44ecaSJames Bottomley  *
32991fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
33001fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
33011fa44ecaSJames Bottomley  *
3302d185af30SYacine Belkadi  * Return:	0 - function was executed
33031fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
33041fa44ecaSJames Bottomley  */
330565f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
33061fa44ecaSJames Bottomley {
33071fa44ecaSJames Bottomley 	if (!in_interrupt()) {
330865f27f38SDavid Howells 		fn(&ew->work);
33091fa44ecaSJames Bottomley 		return 0;
33101fa44ecaSJames Bottomley 	}
33111fa44ecaSJames Bottomley 
331265f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
33131fa44ecaSJames Bottomley 	schedule_work(&ew->work);
33141fa44ecaSJames Bottomley 
33151fa44ecaSJames Bottomley 	return 1;
33161fa44ecaSJames Bottomley }
33171fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
33181fa44ecaSJames Bottomley 
33197a4e344cSTejun Heo /**
33207a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
33217a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
33227a4e344cSTejun Heo  *
33237a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
33247a4e344cSTejun Heo  */
33257a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs)
33267a4e344cSTejun Heo {
33277a4e344cSTejun Heo 	if (attrs) {
33287a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
33297a4e344cSTejun Heo 		kfree(attrs);
33307a4e344cSTejun Heo 	}
33317a4e344cSTejun Heo }
33327a4e344cSTejun Heo 
33337a4e344cSTejun Heo /**
33347a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
33357a4e344cSTejun Heo  * @gfp_mask: allocation mask to use
33367a4e344cSTejun Heo  *
33377a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
3338d185af30SYacine Belkadi  * return it.
3339d185af30SYacine Belkadi  *
3340d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
33417a4e344cSTejun Heo  */
33427a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
33437a4e344cSTejun Heo {
33447a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
33457a4e344cSTejun Heo 
33467a4e344cSTejun Heo 	attrs = kzalloc(sizeof(*attrs), gfp_mask);
33477a4e344cSTejun Heo 	if (!attrs)
33487a4e344cSTejun Heo 		goto fail;
33497a4e344cSTejun Heo 	if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
33507a4e344cSTejun Heo 		goto fail;
33517a4e344cSTejun Heo 
335213e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
33537a4e344cSTejun Heo 	return attrs;
33547a4e344cSTejun Heo fail:
33557a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
33567a4e344cSTejun Heo 	return NULL;
33577a4e344cSTejun Heo }
33587a4e344cSTejun Heo 
335929c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
336029c91e99STejun Heo 				 const struct workqueue_attrs *from)
336129c91e99STejun Heo {
336229c91e99STejun Heo 	to->nice = from->nice;
336329c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
33642865a8fbSShaohua Li 	/*
33652865a8fbSShaohua Li 	 * Unlike hash and equality test, this function doesn't ignore
33662865a8fbSShaohua Li 	 * ->no_numa as it is used for both pool and wq attrs.  Instead,
33672865a8fbSShaohua Li 	 * get_unbound_pool() explicitly clears ->no_numa after copying.
33682865a8fbSShaohua Li 	 */
33692865a8fbSShaohua Li 	to->no_numa = from->no_numa;
337029c91e99STejun Heo }
337129c91e99STejun Heo 
337229c91e99STejun Heo /* hash value of the content of @attr */
337329c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
337429c91e99STejun Heo {
337529c91e99STejun Heo 	u32 hash = 0;
337629c91e99STejun Heo 
337729c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
337813e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
337913e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
338029c91e99STejun Heo 	return hash;
338129c91e99STejun Heo }
338229c91e99STejun Heo 
338329c91e99STejun Heo /* content equality test */
338429c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
338529c91e99STejun Heo 			  const struct workqueue_attrs *b)
338629c91e99STejun Heo {
338729c91e99STejun Heo 	if (a->nice != b->nice)
338829c91e99STejun Heo 		return false;
338929c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
339029c91e99STejun Heo 		return false;
339129c91e99STejun Heo 	return true;
339229c91e99STejun Heo }
339329c91e99STejun Heo 
33947a4e344cSTejun Heo /**
33957a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
33967a4e344cSTejun Heo  * @pool: worker_pool to initialize
33977a4e344cSTejun Heo  *
3398402dd89dSShailendra Verma  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
3399d185af30SYacine Belkadi  *
3400d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
340129c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
340229c91e99STejun Heo  * on @pool safely to release it.
34037a4e344cSTejun Heo  */
34047a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
34054e1a1f9aSTejun Heo {
34064e1a1f9aSTejun Heo 	spin_lock_init(&pool->lock);
340729c91e99STejun Heo 	pool->id = -1;
340829c91e99STejun Heo 	pool->cpu = -1;
3409f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
34104e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
341182607adcSTejun Heo 	pool->watchdog_ts = jiffies;
34124e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
34134e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
34144e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
34154e1a1f9aSTejun Heo 
341632a6c723SKees Cook 	timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
34174e1a1f9aSTejun Heo 
341832a6c723SKees Cook 	timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
34194e1a1f9aSTejun Heo 
3420da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
34217a4e344cSTejun Heo 
34227cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
342329c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
342429c91e99STejun Heo 	pool->refcnt = 1;
342529c91e99STejun Heo 
342629c91e99STejun Heo 	/* shouldn't fail above this point */
34277a4e344cSTejun Heo 	pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
34287a4e344cSTejun Heo 	if (!pool->attrs)
34297a4e344cSTejun Heo 		return -ENOMEM;
34307a4e344cSTejun Heo 	return 0;
34314e1a1f9aSTejun Heo }
34324e1a1f9aSTejun Heo 
3433669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP
3434669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
3435669de8bdSBart Van Assche {
3436669de8bdSBart Van Assche 	char *lock_name;
3437669de8bdSBart Van Assche 
3438669de8bdSBart Van Assche 	lockdep_register_key(&wq->key);
3439669de8bdSBart Van Assche 	lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3440669de8bdSBart Van Assche 	if (!lock_name)
3441669de8bdSBart Van Assche 		lock_name = wq->name;
344269a106c0SQian Cai 
344369a106c0SQian Cai 	wq->lock_name = lock_name;
3444669de8bdSBart Van Assche 	lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3445669de8bdSBart Van Assche }
3446669de8bdSBart Van Assche 
3447669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
3448669de8bdSBart Van Assche {
3449669de8bdSBart Van Assche 	lockdep_unregister_key(&wq->key);
3450669de8bdSBart Van Assche }
3451669de8bdSBart Van Assche 
3452669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
3453669de8bdSBart Van Assche {
3454669de8bdSBart Van Assche 	if (wq->lock_name != wq->name)
3455669de8bdSBart Van Assche 		kfree(wq->lock_name);
3456669de8bdSBart Van Assche }
3457669de8bdSBart Van Assche #else
3458669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
3459669de8bdSBart Van Assche {
3460669de8bdSBart Van Assche }
3461669de8bdSBart Van Assche 
3462669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
3463669de8bdSBart Van Assche {
3464669de8bdSBart Van Assche }
3465669de8bdSBart Van Assche 
3466669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
3467669de8bdSBart Van Assche {
3468669de8bdSBart Van Assche }
3469669de8bdSBart Van Assche #endif
3470669de8bdSBart Van Assche 
3471e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu)
3472e2dca7adSTejun Heo {
3473e2dca7adSTejun Heo 	struct workqueue_struct *wq =
3474e2dca7adSTejun Heo 		container_of(rcu, struct workqueue_struct, rcu);
3475e2dca7adSTejun Heo 
3476669de8bdSBart Van Assche 	wq_free_lockdep(wq);
3477669de8bdSBart Van Assche 
3478e2dca7adSTejun Heo 	if (!(wq->flags & WQ_UNBOUND))
3479e2dca7adSTejun Heo 		free_percpu(wq->cpu_pwqs);
3480e2dca7adSTejun Heo 	else
3481e2dca7adSTejun Heo 		free_workqueue_attrs(wq->unbound_attrs);
3482e2dca7adSTejun Heo 
3483e2dca7adSTejun Heo 	kfree(wq->rescuer);
3484e2dca7adSTejun Heo 	kfree(wq);
3485e2dca7adSTejun Heo }
3486e2dca7adSTejun Heo 
348729c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
348829c91e99STejun Heo {
348929c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
349029c91e99STejun Heo 
34917cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
349229c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
349329c91e99STejun Heo 	kfree(pool);
349429c91e99STejun Heo }
349529c91e99STejun Heo 
349629c91e99STejun Heo /**
349729c91e99STejun Heo  * put_unbound_pool - put a worker_pool
349829c91e99STejun Heo  * @pool: worker_pool to put
349929c91e99STejun Heo  *
350029c91e99STejun Heo  * Put @pool.  If its refcnt reaches zero, it gets destroyed in sched-RCU
3501c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
3502c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
3503c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
3504a892caccSTejun Heo  *
3505a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
350629c91e99STejun Heo  */
350729c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
350829c91e99STejun Heo {
350960f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
351029c91e99STejun Heo 	struct worker *worker;
351129c91e99STejun Heo 
3512a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3513a892caccSTejun Heo 
3514a892caccSTejun Heo 	if (--pool->refcnt)
351529c91e99STejun Heo 		return;
351629c91e99STejun Heo 
351729c91e99STejun Heo 	/* sanity checks */
351861d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
3519a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
352029c91e99STejun Heo 		return;
352129c91e99STejun Heo 
352229c91e99STejun Heo 	/* release id and unhash */
352329c91e99STejun Heo 	if (pool->id >= 0)
352429c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
352529c91e99STejun Heo 	hash_del(&pool->hash_node);
352629c91e99STejun Heo 
3527c5aa87bbSTejun Heo 	/*
3528692b4825STejun Heo 	 * Become the manager and destroy all workers.  This prevents
3529692b4825STejun Heo 	 * @pool's workers from blocking on attach_mutex.  We're the last
3530692b4825STejun Heo 	 * manager and @pool gets freed with the flag set.
3531c5aa87bbSTejun Heo 	 */
353260f5a4bcSLai Jiangshan 	spin_lock_irq(&pool->lock);
3533692b4825STejun Heo 	wait_event_lock_irq(wq_manager_wait,
3534692b4825STejun Heo 			    !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3535692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
3536692b4825STejun Heo 
35371037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
353829c91e99STejun Heo 		destroy_worker(worker);
353929c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
354029c91e99STejun Heo 	spin_unlock_irq(&pool->lock);
354160f5a4bcSLai Jiangshan 
35421258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
3543da028469SLai Jiangshan 	if (!list_empty(&pool->workers))
354460f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
35451258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
354660f5a4bcSLai Jiangshan 
354760f5a4bcSLai Jiangshan 	if (pool->detach_completion)
354860f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
354960f5a4bcSLai Jiangshan 
355029c91e99STejun Heo 	/* shut down the timers */
355129c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
355229c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
355329c91e99STejun Heo 
355429c91e99STejun Heo 	/* sched-RCU protected to allow dereferences from get_work_pool() */
355525b00775SPaul E. McKenney 	call_rcu(&pool->rcu, rcu_free_pool);
355629c91e99STejun Heo }
355729c91e99STejun Heo 
355829c91e99STejun Heo /**
355929c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
356029c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
356129c91e99STejun Heo  *
356229c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
356329c91e99STejun Heo  * reference count and return it.  If there already is a matching
356429c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
3565d185af30SYacine Belkadi  * create a new one.
3566a892caccSTejun Heo  *
3567a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
3568d185af30SYacine Belkadi  *
3569d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
3570d185af30SYacine Belkadi  * On failure, %NULL.
357129c91e99STejun Heo  */
357229c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
357329c91e99STejun Heo {
357429c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
357529c91e99STejun Heo 	struct worker_pool *pool;
3576f3f90ad4STejun Heo 	int node;
3577e2273584SXunlei Pang 	int target_node = NUMA_NO_NODE;
357829c91e99STejun Heo 
3579a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
358029c91e99STejun Heo 
358129c91e99STejun Heo 	/* do we already have a matching pool? */
358229c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
358329c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
358429c91e99STejun Heo 			pool->refcnt++;
35853fb1823cSLai Jiangshan 			return pool;
358629c91e99STejun Heo 		}
358729c91e99STejun Heo 	}
358829c91e99STejun Heo 
3589e2273584SXunlei Pang 	/* if cpumask is contained inside a NUMA node, we belong to that node */
3590e2273584SXunlei Pang 	if (wq_numa_enabled) {
3591e2273584SXunlei Pang 		for_each_node(node) {
3592e2273584SXunlei Pang 			if (cpumask_subset(attrs->cpumask,
3593e2273584SXunlei Pang 					   wq_numa_possible_cpumask[node])) {
3594e2273584SXunlei Pang 				target_node = node;
3595e2273584SXunlei Pang 				break;
3596e2273584SXunlei Pang 			}
3597e2273584SXunlei Pang 		}
3598e2273584SXunlei Pang 	}
3599e2273584SXunlei Pang 
360029c91e99STejun Heo 	/* nope, create a new one */
3601e2273584SXunlei Pang 	pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
360229c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
360329c91e99STejun Heo 		goto fail;
360429c91e99STejun Heo 
36058864b4e5STejun Heo 	lockdep_set_subclass(&pool->lock, 1);	/* see put_pwq() */
360629c91e99STejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
3607e2273584SXunlei Pang 	pool->node = target_node;
360829c91e99STejun Heo 
36092865a8fbSShaohua Li 	/*
36102865a8fbSShaohua Li 	 * no_numa isn't a worker_pool attribute, always clear it.  See
36112865a8fbSShaohua Li 	 * 'struct workqueue_attrs' comments for detail.
36122865a8fbSShaohua Li 	 */
36132865a8fbSShaohua Li 	pool->attrs->no_numa = false;
36142865a8fbSShaohua Li 
361529c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
361629c91e99STejun Heo 		goto fail;
361729c91e99STejun Heo 
361829c91e99STejun Heo 	/* create and start the initial worker */
36193347fa09STejun Heo 	if (wq_online && !create_worker(pool))
362029c91e99STejun Heo 		goto fail;
362129c91e99STejun Heo 
362229c91e99STejun Heo 	/* install */
362329c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
36243fb1823cSLai Jiangshan 
362529c91e99STejun Heo 	return pool;
362629c91e99STejun Heo fail:
362729c91e99STejun Heo 	if (pool)
362829c91e99STejun Heo 		put_unbound_pool(pool);
362929c91e99STejun Heo 	return NULL;
363029c91e99STejun Heo }
363129c91e99STejun Heo 
36328864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
36338864b4e5STejun Heo {
36348864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
36358864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
36368864b4e5STejun Heo }
36378864b4e5STejun Heo 
36388864b4e5STejun Heo /*
36398864b4e5STejun Heo  * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
36408864b4e5STejun Heo  * and needs to be destroyed.
36418864b4e5STejun Heo  */
36428864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work)
36438864b4e5STejun Heo {
36448864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
36458864b4e5STejun Heo 						  unbound_release_work);
36468864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
36478864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
3648bc0caf09STejun Heo 	bool is_last;
36498864b4e5STejun Heo 
36508864b4e5STejun Heo 	if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
36518864b4e5STejun Heo 		return;
36528864b4e5STejun Heo 
36533c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
36548864b4e5STejun Heo 	list_del_rcu(&pwq->pwqs_node);
3655bc0caf09STejun Heo 	is_last = list_empty(&wq->pwqs);
36563c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
36578864b4e5STejun Heo 
3658a892caccSTejun Heo 	mutex_lock(&wq_pool_mutex);
36598864b4e5STejun Heo 	put_unbound_pool(pool);
3660a892caccSTejun Heo 	mutex_unlock(&wq_pool_mutex);
3661a892caccSTejun Heo 
366225b00775SPaul E. McKenney 	call_rcu(&pwq->rcu, rcu_free_pwq);
36638864b4e5STejun Heo 
36648864b4e5STejun Heo 	/*
36658864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
3666e2dca7adSTejun Heo 	 * is gonna access it anymore.  Schedule RCU free.
36678864b4e5STejun Heo 	 */
3668669de8bdSBart Van Assche 	if (is_last) {
3669669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
367025b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
36716029a918STejun Heo 	}
3672669de8bdSBart Van Assche }
36738864b4e5STejun Heo 
36740fbd95aaSTejun Heo /**
3675699ce097STejun Heo  * pwq_adjust_max_active - update a pwq's max_active to the current setting
36760fbd95aaSTejun Heo  * @pwq: target pool_workqueue
36770fbd95aaSTejun Heo  *
3678699ce097STejun Heo  * If @pwq isn't freezing, set @pwq->max_active to the associated
3679699ce097STejun Heo  * workqueue's saved_max_active and activate delayed work items
3680699ce097STejun Heo  * accordingly.  If @pwq is freezing, clear @pwq->max_active to zero.
36810fbd95aaSTejun Heo  */
3682699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq)
36830fbd95aaSTejun Heo {
3684699ce097STejun Heo 	struct workqueue_struct *wq = pwq->wq;
3685699ce097STejun Heo 	bool freezable = wq->flags & WQ_FREEZABLE;
36863347fa09STejun Heo 	unsigned long flags;
3687699ce097STejun Heo 
3688699ce097STejun Heo 	/* for @wq->saved_max_active */
3689a357fc03SLai Jiangshan 	lockdep_assert_held(&wq->mutex);
3690699ce097STejun Heo 
3691699ce097STejun Heo 	/* fast exit for non-freezable wqs */
3692699ce097STejun Heo 	if (!freezable && pwq->max_active == wq->saved_max_active)
3693699ce097STejun Heo 		return;
3694699ce097STejun Heo 
36953347fa09STejun Heo 	/* this function can be called during early boot w/ irq disabled */
36963347fa09STejun Heo 	spin_lock_irqsave(&pwq->pool->lock, flags);
3697699ce097STejun Heo 
369874b414eaSLai Jiangshan 	/*
369974b414eaSLai Jiangshan 	 * During [un]freezing, the caller is responsible for ensuring that
370074b414eaSLai Jiangshan 	 * this function is called at least once after @workqueue_freezing
370174b414eaSLai Jiangshan 	 * is updated and visible.
370274b414eaSLai Jiangshan 	 */
370374b414eaSLai Jiangshan 	if (!freezable || !workqueue_freezing) {
3704699ce097STejun Heo 		pwq->max_active = wq->saved_max_active;
37050fbd95aaSTejun Heo 
37060fbd95aaSTejun Heo 		while (!list_empty(&pwq->delayed_works) &&
37070fbd95aaSTejun Heo 		       pwq->nr_active < pwq->max_active)
37080fbd95aaSTejun Heo 			pwq_activate_first_delayed(pwq);
3709951a078aSLai Jiangshan 
3710951a078aSLai Jiangshan 		/*
3711951a078aSLai Jiangshan 		 * Need to kick a worker after thawed or an unbound wq's
3712951a078aSLai Jiangshan 		 * max_active is bumped.  It's a slow path.  Do it always.
3713951a078aSLai Jiangshan 		 */
3714951a078aSLai Jiangshan 		wake_up_worker(pwq->pool);
3715699ce097STejun Heo 	} else {
3716699ce097STejun Heo 		pwq->max_active = 0;
3717699ce097STejun Heo 	}
3718699ce097STejun Heo 
37193347fa09STejun Heo 	spin_unlock_irqrestore(&pwq->pool->lock, flags);
37200fbd95aaSTejun Heo }
37210fbd95aaSTejun Heo 
3722e50aba9aSTejun Heo /* initialize newly alloced @pwq which is associated with @wq and @pool */
3723f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3724f147f29eSTejun Heo 		     struct worker_pool *pool)
3725d2c1d404STejun Heo {
3726d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3727d2c1d404STejun Heo 
3728e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
3729e50aba9aSTejun Heo 
3730d2c1d404STejun Heo 	pwq->pool = pool;
3731d2c1d404STejun Heo 	pwq->wq = wq;
3732d2c1d404STejun Heo 	pwq->flush_color = -1;
37338864b4e5STejun Heo 	pwq->refcnt = 1;
3734d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->delayed_works);
37351befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
3736d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
37378864b4e5STejun Heo 	INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3738f147f29eSTejun Heo }
3739d2c1d404STejun Heo 
3740f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
37411befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
3742f147f29eSTejun Heo {
3743f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
3744f147f29eSTejun Heo 
3745f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
374675ccf595STejun Heo 
37471befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
37481befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
37491befcf30STejun Heo 		return;
37501befcf30STejun Heo 
375129b1cb41SLai Jiangshan 	/* set the matching work_color */
375275ccf595STejun Heo 	pwq->work_color = wq->work_color;
3753983ca25eSTejun Heo 
3754983ca25eSTejun Heo 	/* sync max_active to the current setting */
3755983ca25eSTejun Heo 	pwq_adjust_max_active(pwq);
3756983ca25eSTejun Heo 
3757983ca25eSTejun Heo 	/* link in @pwq */
37589e8cd2f5STejun Heo 	list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3759df2d5ae4STejun Heo }
37606029a918STejun Heo 
3761f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3762f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3763f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
3764f147f29eSTejun Heo {
3765f147f29eSTejun Heo 	struct worker_pool *pool;
3766f147f29eSTejun Heo 	struct pool_workqueue *pwq;
3767f147f29eSTejun Heo 
3768f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3769f147f29eSTejun Heo 
3770f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
3771f147f29eSTejun Heo 	if (!pool)
3772f147f29eSTejun Heo 		return NULL;
3773f147f29eSTejun Heo 
3774e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3775f147f29eSTejun Heo 	if (!pwq) {
3776f147f29eSTejun Heo 		put_unbound_pool(pool);
3777f147f29eSTejun Heo 		return NULL;
3778f147f29eSTejun Heo 	}
3779f147f29eSTejun Heo 
3780f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
3781f147f29eSTejun Heo 	return pwq;
3782d2c1d404STejun Heo }
3783d2c1d404STejun Heo 
37844c16bd32STejun Heo /**
378530186c6fSGong Zhaogang  * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
3786042f7df1SLai Jiangshan  * @attrs: the wq_attrs of the default pwq of the target workqueue
37874c16bd32STejun Heo  * @node: the target NUMA node
37884c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
37894c16bd32STejun Heo  * @cpumask: outarg, the resulting cpumask
37904c16bd32STejun Heo  *
37914c16bd32STejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @node.  If
37924c16bd32STejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during
3793d185af30SYacine Belkadi  * calculation.  The result is stored in @cpumask.
37944c16bd32STejun Heo  *
37954c16bd32STejun Heo  * If NUMA affinity is not enabled, @attrs->cpumask is always used.  If
37964c16bd32STejun Heo  * enabled and @node has online CPUs requested by @attrs, the returned
37974c16bd32STejun Heo  * cpumask is the intersection of the possible CPUs of @node and
37984c16bd32STejun Heo  * @attrs->cpumask.
37994c16bd32STejun Heo  *
38004c16bd32STejun Heo  * The caller is responsible for ensuring that the cpumask of @node stays
38014c16bd32STejun Heo  * stable.
3802d185af30SYacine Belkadi  *
3803d185af30SYacine Belkadi  * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3804d185af30SYacine Belkadi  * %false if equal.
38054c16bd32STejun Heo  */
38064c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
38074c16bd32STejun Heo 				 int cpu_going_down, cpumask_t *cpumask)
38084c16bd32STejun Heo {
3809d55262c4STejun Heo 	if (!wq_numa_enabled || attrs->no_numa)
38104c16bd32STejun Heo 		goto use_dfl;
38114c16bd32STejun Heo 
38124c16bd32STejun Heo 	/* does @node have any online CPUs @attrs wants? */
38134c16bd32STejun Heo 	cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
38144c16bd32STejun Heo 	if (cpu_going_down >= 0)
38154c16bd32STejun Heo 		cpumask_clear_cpu(cpu_going_down, cpumask);
38164c16bd32STejun Heo 
38174c16bd32STejun Heo 	if (cpumask_empty(cpumask))
38184c16bd32STejun Heo 		goto use_dfl;
38194c16bd32STejun Heo 
38204c16bd32STejun Heo 	/* yeap, return possible CPUs in @node that @attrs wants */
38214c16bd32STejun Heo 	cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
38221ad0f0a7SMichael Bringmann 
38231ad0f0a7SMichael Bringmann 	if (cpumask_empty(cpumask)) {
38241ad0f0a7SMichael Bringmann 		pr_warn_once("WARNING: workqueue cpumask: online intersect > "
38251ad0f0a7SMichael Bringmann 				"possible intersect\n");
38261ad0f0a7SMichael Bringmann 		return false;
38271ad0f0a7SMichael Bringmann 	}
38281ad0f0a7SMichael Bringmann 
38294c16bd32STejun Heo 	return !cpumask_equal(cpumask, attrs->cpumask);
38304c16bd32STejun Heo 
38314c16bd32STejun Heo use_dfl:
38324c16bd32STejun Heo 	cpumask_copy(cpumask, attrs->cpumask);
38334c16bd32STejun Heo 	return false;
38344c16bd32STejun Heo }
38354c16bd32STejun Heo 
38361befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
38371befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
38381befcf30STejun Heo 						   int node,
38391befcf30STejun Heo 						   struct pool_workqueue *pwq)
38401befcf30STejun Heo {
38411befcf30STejun Heo 	struct pool_workqueue *old_pwq;
38421befcf30STejun Heo 
38435b95e1afSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
38441befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
38451befcf30STejun Heo 
38461befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
38471befcf30STejun Heo 	link_pwq(pwq);
38481befcf30STejun Heo 
38491befcf30STejun Heo 	old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
38501befcf30STejun Heo 	rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
38511befcf30STejun Heo 	return old_pwq;
38521befcf30STejun Heo }
38531befcf30STejun Heo 
38542d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */
38552d5f0764SLai Jiangshan struct apply_wqattrs_ctx {
38562d5f0764SLai Jiangshan 	struct workqueue_struct	*wq;		/* target workqueue */
38572d5f0764SLai Jiangshan 	struct workqueue_attrs	*attrs;		/* attrs to apply */
3858042f7df1SLai Jiangshan 	struct list_head	list;		/* queued for batching commit */
38592d5f0764SLai Jiangshan 	struct pool_workqueue	*dfl_pwq;
38602d5f0764SLai Jiangshan 	struct pool_workqueue	*pwq_tbl[];
38612d5f0764SLai Jiangshan };
38622d5f0764SLai Jiangshan 
38632d5f0764SLai Jiangshan /* free the resources after success or abort */
38642d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
38652d5f0764SLai Jiangshan {
38662d5f0764SLai Jiangshan 	if (ctx) {
38672d5f0764SLai Jiangshan 		int node;
38682d5f0764SLai Jiangshan 
38692d5f0764SLai Jiangshan 		for_each_node(node)
38702d5f0764SLai Jiangshan 			put_pwq_unlocked(ctx->pwq_tbl[node]);
38712d5f0764SLai Jiangshan 		put_pwq_unlocked(ctx->dfl_pwq);
38722d5f0764SLai Jiangshan 
38732d5f0764SLai Jiangshan 		free_workqueue_attrs(ctx->attrs);
38742d5f0764SLai Jiangshan 
38752d5f0764SLai Jiangshan 		kfree(ctx);
38762d5f0764SLai Jiangshan 	}
38772d5f0764SLai Jiangshan }
38782d5f0764SLai Jiangshan 
38792d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */
38802d5f0764SLai Jiangshan static struct apply_wqattrs_ctx *
38812d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq,
38822d5f0764SLai Jiangshan 		      const struct workqueue_attrs *attrs)
38832d5f0764SLai Jiangshan {
38842d5f0764SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
38852d5f0764SLai Jiangshan 	struct workqueue_attrs *new_attrs, *tmp_attrs;
38862d5f0764SLai Jiangshan 	int node;
38872d5f0764SLai Jiangshan 
38882d5f0764SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
38892d5f0764SLai Jiangshan 
3890acafe7e3SKees Cook 	ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
38912d5f0764SLai Jiangshan 
38922d5f0764SLai Jiangshan 	new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
38932d5f0764SLai Jiangshan 	tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
38942d5f0764SLai Jiangshan 	if (!ctx || !new_attrs || !tmp_attrs)
38952d5f0764SLai Jiangshan 		goto out_free;
38962d5f0764SLai Jiangshan 
3897042f7df1SLai Jiangshan 	/*
3898042f7df1SLai Jiangshan 	 * Calculate the attrs of the default pwq.
3899042f7df1SLai Jiangshan 	 * If the user configured cpumask doesn't overlap with the
3900042f7df1SLai Jiangshan 	 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3901042f7df1SLai Jiangshan 	 */
39022d5f0764SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
3903b05a7928SFrederic Weisbecker 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
3904042f7df1SLai Jiangshan 	if (unlikely(cpumask_empty(new_attrs->cpumask)))
3905042f7df1SLai Jiangshan 		cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
39062d5f0764SLai Jiangshan 
39072d5f0764SLai Jiangshan 	/*
39082d5f0764SLai Jiangshan 	 * We may create multiple pwqs with differing cpumasks.  Make a
39092d5f0764SLai Jiangshan 	 * copy of @new_attrs which will be modified and used to obtain
39102d5f0764SLai Jiangshan 	 * pools.
39112d5f0764SLai Jiangshan 	 */
39122d5f0764SLai Jiangshan 	copy_workqueue_attrs(tmp_attrs, new_attrs);
39132d5f0764SLai Jiangshan 
39142d5f0764SLai Jiangshan 	/*
39152d5f0764SLai Jiangshan 	 * If something goes wrong during CPU up/down, we'll fall back to
39162d5f0764SLai Jiangshan 	 * the default pwq covering whole @attrs->cpumask.  Always create
39172d5f0764SLai Jiangshan 	 * it even if we don't use it immediately.
39182d5f0764SLai Jiangshan 	 */
39192d5f0764SLai Jiangshan 	ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
39202d5f0764SLai Jiangshan 	if (!ctx->dfl_pwq)
39212d5f0764SLai Jiangshan 		goto out_free;
39222d5f0764SLai Jiangshan 
39232d5f0764SLai Jiangshan 	for_each_node(node) {
3924042f7df1SLai Jiangshan 		if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
39252d5f0764SLai Jiangshan 			ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
39262d5f0764SLai Jiangshan 			if (!ctx->pwq_tbl[node])
39272d5f0764SLai Jiangshan 				goto out_free;
39282d5f0764SLai Jiangshan 		} else {
39292d5f0764SLai Jiangshan 			ctx->dfl_pwq->refcnt++;
39302d5f0764SLai Jiangshan 			ctx->pwq_tbl[node] = ctx->dfl_pwq;
39312d5f0764SLai Jiangshan 		}
39322d5f0764SLai Jiangshan 	}
39332d5f0764SLai Jiangshan 
3934042f7df1SLai Jiangshan 	/* save the user configured attrs and sanitize it. */
3935042f7df1SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
3936042f7df1SLai Jiangshan 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
39372d5f0764SLai Jiangshan 	ctx->attrs = new_attrs;
3938042f7df1SLai Jiangshan 
39392d5f0764SLai Jiangshan 	ctx->wq = wq;
39402d5f0764SLai Jiangshan 	free_workqueue_attrs(tmp_attrs);
39412d5f0764SLai Jiangshan 	return ctx;
39422d5f0764SLai Jiangshan 
39432d5f0764SLai Jiangshan out_free:
39442d5f0764SLai Jiangshan 	free_workqueue_attrs(tmp_attrs);
39452d5f0764SLai Jiangshan 	free_workqueue_attrs(new_attrs);
39462d5f0764SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
39472d5f0764SLai Jiangshan 	return NULL;
39482d5f0764SLai Jiangshan }
39492d5f0764SLai Jiangshan 
39502d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
39512d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
39522d5f0764SLai Jiangshan {
39532d5f0764SLai Jiangshan 	int node;
39542d5f0764SLai Jiangshan 
39552d5f0764SLai Jiangshan 	/* all pwqs have been created successfully, let's install'em */
39562d5f0764SLai Jiangshan 	mutex_lock(&ctx->wq->mutex);
39572d5f0764SLai Jiangshan 
39582d5f0764SLai Jiangshan 	copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
39592d5f0764SLai Jiangshan 
39602d5f0764SLai Jiangshan 	/* save the previous pwq and install the new one */
39612d5f0764SLai Jiangshan 	for_each_node(node)
39622d5f0764SLai Jiangshan 		ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
39632d5f0764SLai Jiangshan 							  ctx->pwq_tbl[node]);
39642d5f0764SLai Jiangshan 
39652d5f0764SLai Jiangshan 	/* @dfl_pwq might not have been used, ensure it's linked */
39662d5f0764SLai Jiangshan 	link_pwq(ctx->dfl_pwq);
39672d5f0764SLai Jiangshan 	swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
39682d5f0764SLai Jiangshan 
39692d5f0764SLai Jiangshan 	mutex_unlock(&ctx->wq->mutex);
39702d5f0764SLai Jiangshan }
39712d5f0764SLai Jiangshan 
3972a0111cf6SLai Jiangshan static void apply_wqattrs_lock(void)
3973a0111cf6SLai Jiangshan {
3974a0111cf6SLai Jiangshan 	/* CPUs should stay stable across pwq creations and installations */
3975a0111cf6SLai Jiangshan 	get_online_cpus();
3976a0111cf6SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
3977a0111cf6SLai Jiangshan }
3978a0111cf6SLai Jiangshan 
3979a0111cf6SLai Jiangshan static void apply_wqattrs_unlock(void)
3980a0111cf6SLai Jiangshan {
3981a0111cf6SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
3982a0111cf6SLai Jiangshan 	put_online_cpus();
3983a0111cf6SLai Jiangshan }
3984a0111cf6SLai Jiangshan 
3985a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3986a0111cf6SLai Jiangshan 					const struct workqueue_attrs *attrs)
3987a0111cf6SLai Jiangshan {
3988a0111cf6SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
3989a0111cf6SLai Jiangshan 
3990a0111cf6SLai Jiangshan 	/* only unbound workqueues can change attributes */
3991a0111cf6SLai Jiangshan 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3992a0111cf6SLai Jiangshan 		return -EINVAL;
3993a0111cf6SLai Jiangshan 
3994a0111cf6SLai Jiangshan 	/* creating multiple pwqs breaks ordering guarantee */
39950a94efb5STejun Heo 	if (!list_empty(&wq->pwqs)) {
39960a94efb5STejun Heo 		if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
3997a0111cf6SLai Jiangshan 			return -EINVAL;
3998a0111cf6SLai Jiangshan 
39990a94efb5STejun Heo 		wq->flags &= ~__WQ_ORDERED;
40000a94efb5STejun Heo 	}
40010a94efb5STejun Heo 
4002a0111cf6SLai Jiangshan 	ctx = apply_wqattrs_prepare(wq, attrs);
40036201171eSwanghaibin 	if (!ctx)
40046201171eSwanghaibin 		return -ENOMEM;
4005a0111cf6SLai Jiangshan 
4006a0111cf6SLai Jiangshan 	/* the ctx has been prepared successfully, let's commit it */
4007a0111cf6SLai Jiangshan 	apply_wqattrs_commit(ctx);
4008a0111cf6SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
4009a0111cf6SLai Jiangshan 
40106201171eSwanghaibin 	return 0;
4011a0111cf6SLai Jiangshan }
4012a0111cf6SLai Jiangshan 
40139e8cd2f5STejun Heo /**
40149e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
40159e8cd2f5STejun Heo  * @wq: the target workqueue
40169e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
40179e8cd2f5STejun Heo  *
40184c16bd32STejun Heo  * Apply @attrs to an unbound workqueue @wq.  Unless disabled, on NUMA
40194c16bd32STejun Heo  * machines, this function maps a separate pwq to each NUMA node with
40204c16bd32STejun Heo  * possibles CPUs in @attrs->cpumask so that work items are affine to the
40214c16bd32STejun Heo  * NUMA node it was issued on.  Older pwqs are released as in-flight work
40224c16bd32STejun Heo  * items finish.  Note that a work item which repeatedly requeues itself
40234c16bd32STejun Heo  * back-to-back will stay on its current pwq.
40249e8cd2f5STejun Heo  *
4025d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
4026d185af30SYacine Belkadi  *
4027d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
40289e8cd2f5STejun Heo  */
40299e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq,
40309e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
40319e8cd2f5STejun Heo {
4032a0111cf6SLai Jiangshan 	int ret;
40339e8cd2f5STejun Heo 
4034a0111cf6SLai Jiangshan 	apply_wqattrs_lock();
4035a0111cf6SLai Jiangshan 	ret = apply_workqueue_attrs_locked(wq, attrs);
4036a0111cf6SLai Jiangshan 	apply_wqattrs_unlock();
40372d5f0764SLai Jiangshan 
40382d5f0764SLai Jiangshan 	return ret;
40399e8cd2f5STejun Heo }
40406106c0f8SNeilBrown EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
40419e8cd2f5STejun Heo 
40424c16bd32STejun Heo /**
40434c16bd32STejun Heo  * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
40444c16bd32STejun Heo  * @wq: the target workqueue
40454c16bd32STejun Heo  * @cpu: the CPU coming up or going down
40464c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
40474c16bd32STejun Heo  *
40484c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
40494c16bd32STejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update NUMA affinity of
40504c16bd32STejun Heo  * @wq accordingly.
40514c16bd32STejun Heo  *
40524c16bd32STejun Heo  * If NUMA affinity can't be adjusted due to memory allocation failure, it
40534c16bd32STejun Heo  * falls back to @wq->dfl_pwq which may not be optimal but is always
40544c16bd32STejun Heo  * correct.
40554c16bd32STejun Heo  *
40564c16bd32STejun Heo  * Note that when the last allowed CPU of a NUMA node goes offline for a
40574c16bd32STejun Heo  * workqueue with a cpumask spanning multiple nodes, the workers which were
40584c16bd32STejun Heo  * already executing the work items for the workqueue will lose their CPU
40594c16bd32STejun Heo  * affinity and may execute on any CPU.  This is similar to how per-cpu
40604c16bd32STejun Heo  * workqueues behave on CPU_DOWN.  If a workqueue user wants strict
40614c16bd32STejun Heo  * affinity, it's the user's responsibility to flush the work item from
40624c16bd32STejun Heo  * CPU_DOWN_PREPARE.
40634c16bd32STejun Heo  */
40644c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
40654c16bd32STejun Heo 				   bool online)
40664c16bd32STejun Heo {
40674c16bd32STejun Heo 	int node = cpu_to_node(cpu);
40684c16bd32STejun Heo 	int cpu_off = online ? -1 : cpu;
40694c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
40704c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
40714c16bd32STejun Heo 	cpumask_t *cpumask;
40724c16bd32STejun Heo 
40734c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
40744c16bd32STejun Heo 
4075f7142ed4SLai Jiangshan 	if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4076f7142ed4SLai Jiangshan 	    wq->unbound_attrs->no_numa)
40774c16bd32STejun Heo 		return;
40784c16bd32STejun Heo 
40794c16bd32STejun Heo 	/*
40804c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
40814c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
40824c16bd32STejun Heo 	 * CPU hotplug exclusion.
40834c16bd32STejun Heo 	 */
40844c16bd32STejun Heo 	target_attrs = wq_update_unbound_numa_attrs_buf;
40854c16bd32STejun Heo 	cpumask = target_attrs->cpumask;
40864c16bd32STejun Heo 
40874c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
40884c16bd32STejun Heo 	pwq = unbound_pwq_by_node(wq, node);
40894c16bd32STejun Heo 
40904c16bd32STejun Heo 	/*
40914c16bd32STejun Heo 	 * Let's determine what needs to be done.  If the target cpumask is
4092042f7df1SLai Jiangshan 	 * different from the default pwq's, we need to compare it to @pwq's
4093042f7df1SLai Jiangshan 	 * and create a new one if they don't match.  If the target cpumask
4094042f7df1SLai Jiangshan 	 * equals the default pwq's, the default pwq should be used.
40954c16bd32STejun Heo 	 */
4096042f7df1SLai Jiangshan 	if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
40974c16bd32STejun Heo 		if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
4098f7142ed4SLai Jiangshan 			return;
40994c16bd32STejun Heo 	} else {
41004c16bd32STejun Heo 		goto use_dfl_pwq;
41014c16bd32STejun Heo 	}
41024c16bd32STejun Heo 
41034c16bd32STejun Heo 	/* create a new pwq */
41044c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
41054c16bd32STejun Heo 	if (!pwq) {
41062d916033SFabian Frederick 		pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
41074c16bd32STejun Heo 			wq->name);
410877f300b1SDaeseok Youn 		goto use_dfl_pwq;
41094c16bd32STejun Heo 	}
41104c16bd32STejun Heo 
4111f7142ed4SLai Jiangshan 	/* Install the new pwq. */
41124c16bd32STejun Heo 	mutex_lock(&wq->mutex);
41134c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, pwq);
41144c16bd32STejun Heo 	goto out_unlock;
41154c16bd32STejun Heo 
41164c16bd32STejun Heo use_dfl_pwq:
4117f7142ed4SLai Jiangshan 	mutex_lock(&wq->mutex);
41184c16bd32STejun Heo 	spin_lock_irq(&wq->dfl_pwq->pool->lock);
41194c16bd32STejun Heo 	get_pwq(wq->dfl_pwq);
41204c16bd32STejun Heo 	spin_unlock_irq(&wq->dfl_pwq->pool->lock);
41214c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
41224c16bd32STejun Heo out_unlock:
41234c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
41244c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
41254c16bd32STejun Heo }
41264c16bd32STejun Heo 
412730cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
41281da177e4SLinus Torvalds {
412949e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
41308a2b7538STejun Heo 	int cpu, ret;
4131e1d8aa9fSFrederic Weisbecker 
413230cdf249STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
4133420c0ddbSTejun Heo 		wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4134420c0ddbSTejun Heo 		if (!wq->cpu_pwqs)
413530cdf249STejun Heo 			return -ENOMEM;
413630cdf249STejun Heo 
413730cdf249STejun Heo 		for_each_possible_cpu(cpu) {
41387fb98ea7STejun Heo 			struct pool_workqueue *pwq =
41397fb98ea7STejun Heo 				per_cpu_ptr(wq->cpu_pwqs, cpu);
41407a62c2c8STejun Heo 			struct worker_pool *cpu_pools =
4141f02ae73aSTejun Heo 				per_cpu(cpu_worker_pools, cpu);
414230cdf249STejun Heo 
4143f147f29eSTejun Heo 			init_pwq(pwq, wq, &cpu_pools[highpri]);
4144f147f29eSTejun Heo 
4145f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
41461befcf30STejun Heo 			link_pwq(pwq);
4147f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
414830cdf249STejun Heo 		}
414930cdf249STejun Heo 		return 0;
41508a2b7538STejun Heo 	} else if (wq->flags & __WQ_ORDERED) {
41518a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
41528a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
41538a2b7538STejun Heo 		WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
41548a2b7538STejun Heo 			      wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
41558a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
41568a2b7538STejun Heo 		return ret;
41579e8cd2f5STejun Heo 	} else {
41589e8cd2f5STejun Heo 		return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
41599e8cd2f5STejun Heo 	}
41600f900049STejun Heo }
41610f900049STejun Heo 
4162f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
4163f3421797STejun Heo 			       const char *name)
4164b71ab8c2STejun Heo {
4165f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4166f3421797STejun Heo 
4167f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
4168044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4169f3421797STejun Heo 			max_active, name, 1, lim);
4170b71ab8c2STejun Heo 
4171f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
4172b71ab8c2STejun Heo }
4173b71ab8c2STejun Heo 
4174983c7515STejun Heo /*
4175983c7515STejun Heo  * Workqueues which may be used during memory reclaim should have a rescuer
4176983c7515STejun Heo  * to guarantee forward progress.
4177983c7515STejun Heo  */
4178983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq)
4179983c7515STejun Heo {
4180983c7515STejun Heo 	struct worker *rescuer;
4181983c7515STejun Heo 	int ret;
4182983c7515STejun Heo 
4183983c7515STejun Heo 	if (!(wq->flags & WQ_MEM_RECLAIM))
4184983c7515STejun Heo 		return 0;
4185983c7515STejun Heo 
4186983c7515STejun Heo 	rescuer = alloc_worker(NUMA_NO_NODE);
4187983c7515STejun Heo 	if (!rescuer)
4188983c7515STejun Heo 		return -ENOMEM;
4189983c7515STejun Heo 
4190983c7515STejun Heo 	rescuer->rescue_wq = wq;
4191983c7515STejun Heo 	rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4192983c7515STejun Heo 	ret = PTR_ERR_OR_ZERO(rescuer->task);
4193983c7515STejun Heo 	if (ret) {
4194983c7515STejun Heo 		kfree(rescuer);
4195983c7515STejun Heo 		return ret;
4196983c7515STejun Heo 	}
4197983c7515STejun Heo 
4198983c7515STejun Heo 	wq->rescuer = rescuer;
4199983c7515STejun Heo 	kthread_bind_mask(rescuer->task, cpu_possible_mask);
4200983c7515STejun Heo 	wake_up_process(rescuer->task);
4201983c7515STejun Heo 
4202983c7515STejun Heo 	return 0;
4203983c7515STejun Heo }
4204983c7515STejun Heo 
4205669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt,
420697e37d7bSTejun Heo 					 unsigned int flags,
4207669de8bdSBart Van Assche 					 int max_active, ...)
42083af24433SOleg Nesterov {
4209df2d5ae4STejun Heo 	size_t tbl_size = 0;
4210ecf6881fSTejun Heo 	va_list args;
42113af24433SOleg Nesterov 	struct workqueue_struct *wq;
421249e3cf44STejun Heo 	struct pool_workqueue *pwq;
4213b196be89STejun Heo 
42145c0338c6STejun Heo 	/*
42155c0338c6STejun Heo 	 * Unbound && max_active == 1 used to imply ordered, which is no
42165c0338c6STejun Heo 	 * longer the case on NUMA machines due to per-node pools.  While
42175c0338c6STejun Heo 	 * alloc_ordered_workqueue() is the right way to create an ordered
42185c0338c6STejun Heo 	 * workqueue, keep the previous behavior to avoid subtle breakages
42195c0338c6STejun Heo 	 * on NUMA.
42205c0338c6STejun Heo 	 */
42215c0338c6STejun Heo 	if ((flags & WQ_UNBOUND) && max_active == 1)
42225c0338c6STejun Heo 		flags |= __WQ_ORDERED;
42235c0338c6STejun Heo 
4224cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
4225cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4226cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
4227cee22a15SViresh Kumar 
4228ecf6881fSTejun Heo 	/* allocate wq and format name */
4229df2d5ae4STejun Heo 	if (flags & WQ_UNBOUND)
4230ddcb57e2SLai Jiangshan 		tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
4231df2d5ae4STejun Heo 
4232df2d5ae4STejun Heo 	wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
4233b196be89STejun Heo 	if (!wq)
4234d2c1d404STejun Heo 		return NULL;
4235b196be89STejun Heo 
42366029a918STejun Heo 	if (flags & WQ_UNBOUND) {
42376029a918STejun Heo 		wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
42386029a918STejun Heo 		if (!wq->unbound_attrs)
42396029a918STejun Heo 			goto err_free_wq;
42406029a918STejun Heo 	}
42416029a918STejun Heo 
4242669de8bdSBart Van Assche 	va_start(args, max_active);
4243ecf6881fSTejun Heo 	vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4244b196be89STejun Heo 	va_end(args);
42453af24433SOleg Nesterov 
4246d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
4247b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
42483af24433SOleg Nesterov 
4249b196be89STejun Heo 	/* init wq */
425097e37d7bSTejun Heo 	wq->flags = flags;
4251a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
42523c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
4253112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
425430cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
425573f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
425673f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
4257493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
42583af24433SOleg Nesterov 
4259669de8bdSBart Van Assche 	wq_init_lockdep(wq);
4260cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
42613af24433SOleg Nesterov 
426230cdf249STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
426382efcab3SBart Van Assche 		goto err_unreg_lockdep;
42641537663fSTejun Heo 
426540c17f75STejun Heo 	if (wq_online && init_rescuer(wq) < 0)
4266d2c1d404STejun Heo 		goto err_destroy;
4267e22bee78STejun Heo 
4268226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4269226223abSTejun Heo 		goto err_destroy;
4270226223abSTejun Heo 
42716af8bf3dSOleg Nesterov 	/*
427268e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
427368e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
427468e13a67SLai Jiangshan 	 * list.
42756af8bf3dSOleg Nesterov 	 */
427668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4277a0a1a5fdSTejun Heo 
4278a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
427949e3cf44STejun Heo 	for_each_pwq(pwq, wq)
4280699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4281a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4282a0a1a5fdSTejun Heo 
4283e2dca7adSTejun Heo 	list_add_tail_rcu(&wq->list, &workqueues);
4284a0a1a5fdSTejun Heo 
428568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
42863af24433SOleg Nesterov 
42873af24433SOleg Nesterov 	return wq;
4288d2c1d404STejun Heo 
428982efcab3SBart Van Assche err_unreg_lockdep:
4290009bb421SBart Van Assche 	wq_unregister_lockdep(wq);
4291009bb421SBart Van Assche 	wq_free_lockdep(wq);
429282efcab3SBart Van Assche err_free_wq:
42936029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
42944690c4abSTejun Heo 	kfree(wq);
4295d2c1d404STejun Heo 	return NULL;
4296d2c1d404STejun Heo err_destroy:
4297d2c1d404STejun Heo 	destroy_workqueue(wq);
42984690c4abSTejun Heo 	return NULL;
42991da177e4SLinus Torvalds }
4300669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue);
43011da177e4SLinus Torvalds 
43023af24433SOleg Nesterov /**
43033af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
43043af24433SOleg Nesterov  * @wq: target workqueue
43053af24433SOleg Nesterov  *
43063af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
43073af24433SOleg Nesterov  */
43083af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
43093af24433SOleg Nesterov {
431049e3cf44STejun Heo 	struct pool_workqueue *pwq;
43114c16bd32STejun Heo 	int node;
43123af24433SOleg Nesterov 
43139c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
43149c5a2ba7STejun Heo 	drain_workqueue(wq);
4315c8efcc25STejun Heo 
43166183c009STejun Heo 	/* sanity checks */
4317b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
431849e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
43196183c009STejun Heo 		int i;
43206183c009STejun Heo 
432176af4d93STejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++) {
432276af4d93STejun Heo 			if (WARN_ON(pwq->nr_in_flight[i])) {
4323b09f4fd3SLai Jiangshan 				mutex_unlock(&wq->mutex);
4324fa07fb6aSTejun Heo 				show_workqueue_state();
43256183c009STejun Heo 				return;
432676af4d93STejun Heo 			}
432776af4d93STejun Heo 		}
432876af4d93STejun Heo 
43295c529597SLai Jiangshan 		if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
43308864b4e5STejun Heo 		    WARN_ON(pwq->nr_active) ||
433176af4d93STejun Heo 		    WARN_ON(!list_empty(&pwq->delayed_works))) {
4332b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
4333fa07fb6aSTejun Heo 			show_workqueue_state();
43346183c009STejun Heo 			return;
43356183c009STejun Heo 		}
433676af4d93STejun Heo 	}
4337b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
43386183c009STejun Heo 
4339a0a1a5fdSTejun Heo 	/*
4340a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
4341a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
4342a0a1a5fdSTejun Heo 	 */
434368e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4344e2dca7adSTejun Heo 	list_del_rcu(&wq->list);
434568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
43463af24433SOleg Nesterov 
4347226223abSTejun Heo 	workqueue_sysfs_unregister(wq);
4348226223abSTejun Heo 
4349e2dca7adSTejun Heo 	if (wq->rescuer)
4350e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
4351e22bee78STejun Heo 
43528864b4e5STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
4353669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
435429c91e99STejun Heo 		/*
43558864b4e5STejun Heo 		 * The base ref is never dropped on per-cpu pwqs.  Directly
4356e2dca7adSTejun Heo 		 * schedule RCU free.
435729c91e99STejun Heo 		 */
435825b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
43598864b4e5STejun Heo 	} else {
43608864b4e5STejun Heo 		/*
43618864b4e5STejun Heo 		 * We're the sole accessor of @wq at this point.  Directly
43624c16bd32STejun Heo 		 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
43634c16bd32STejun Heo 		 * @wq will be freed when the last pwq is released.
43648864b4e5STejun Heo 		 */
43654c16bd32STejun Heo 		for_each_node(node) {
43664c16bd32STejun Heo 			pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
43674c16bd32STejun Heo 			RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
43684c16bd32STejun Heo 			put_pwq_unlocked(pwq);
43694c16bd32STejun Heo 		}
43704c16bd32STejun Heo 
43714c16bd32STejun Heo 		/*
43724c16bd32STejun Heo 		 * Put dfl_pwq.  @wq may be freed any time after dfl_pwq is
43734c16bd32STejun Heo 		 * put.  Don't access it afterwards.
43744c16bd32STejun Heo 		 */
43754c16bd32STejun Heo 		pwq = wq->dfl_pwq;
43764c16bd32STejun Heo 		wq->dfl_pwq = NULL;
4377dce90d47STejun Heo 		put_pwq_unlocked(pwq);
437829c91e99STejun Heo 	}
43793af24433SOleg Nesterov }
43803af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
43813af24433SOleg Nesterov 
4382dcd989cbSTejun Heo /**
4383dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
4384dcd989cbSTejun Heo  * @wq: target workqueue
4385dcd989cbSTejun Heo  * @max_active: new max_active value.
4386dcd989cbSTejun Heo  *
4387dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
4388dcd989cbSTejun Heo  *
4389dcd989cbSTejun Heo  * CONTEXT:
4390dcd989cbSTejun Heo  * Don't call from IRQ context.
4391dcd989cbSTejun Heo  */
4392dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4393dcd989cbSTejun Heo {
439449e3cf44STejun Heo 	struct pool_workqueue *pwq;
4395dcd989cbSTejun Heo 
43968719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
43970a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
43988719dceaSTejun Heo 		return;
43998719dceaSTejun Heo 
4400f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4401dcd989cbSTejun Heo 
4402a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
4403dcd989cbSTejun Heo 
44040a94efb5STejun Heo 	wq->flags &= ~__WQ_ORDERED;
4405dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
4406dcd989cbSTejun Heo 
4407699ce097STejun Heo 	for_each_pwq(pwq, wq)
4408699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4409dcd989cbSTejun Heo 
4410a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4411dcd989cbSTejun Heo }
4412dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4413dcd989cbSTejun Heo 
4414dcd989cbSTejun Heo /**
441527d4ee03SLukas Wunner  * current_work - retrieve %current task's work struct
441627d4ee03SLukas Wunner  *
441727d4ee03SLukas Wunner  * Determine if %current task is a workqueue worker and what it's working on.
441827d4ee03SLukas Wunner  * Useful to find out the context that the %current task is running in.
441927d4ee03SLukas Wunner  *
442027d4ee03SLukas Wunner  * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
442127d4ee03SLukas Wunner  */
442227d4ee03SLukas Wunner struct work_struct *current_work(void)
442327d4ee03SLukas Wunner {
442427d4ee03SLukas Wunner 	struct worker *worker = current_wq_worker();
442527d4ee03SLukas Wunner 
442627d4ee03SLukas Wunner 	return worker ? worker->current_work : NULL;
442727d4ee03SLukas Wunner }
442827d4ee03SLukas Wunner EXPORT_SYMBOL(current_work);
442927d4ee03SLukas Wunner 
443027d4ee03SLukas Wunner /**
4431e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
4432e6267616STejun Heo  *
4433e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
4434e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
4435d185af30SYacine Belkadi  *
4436d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
4437e6267616STejun Heo  */
4438e6267616STejun Heo bool current_is_workqueue_rescuer(void)
4439e6267616STejun Heo {
4440e6267616STejun Heo 	struct worker *worker = current_wq_worker();
4441e6267616STejun Heo 
44426a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
4443e6267616STejun Heo }
4444e6267616STejun Heo 
4445e6267616STejun Heo /**
4446dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
4447dcd989cbSTejun Heo  * @cpu: CPU in question
4448dcd989cbSTejun Heo  * @wq: target workqueue
4449dcd989cbSTejun Heo  *
4450dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
4451dcd989cbSTejun Heo  * no synchronization around this function and the test result is
4452dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4453dcd989cbSTejun Heo  *
4454d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4455d3251859STejun Heo  * Note that both per-cpu and unbound workqueues may be associated with
4456d3251859STejun Heo  * multiple pool_workqueues which have separate congested states.  A
4457d3251859STejun Heo  * workqueue being congested on one CPU doesn't mean the workqueue is also
4458d3251859STejun Heo  * contested on other CPUs / NUMA nodes.
4459d3251859STejun Heo  *
4460d185af30SYacine Belkadi  * Return:
4461dcd989cbSTejun Heo  * %true if congested, %false otherwise.
4462dcd989cbSTejun Heo  */
4463d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4464dcd989cbSTejun Heo {
44657fb98ea7STejun Heo 	struct pool_workqueue *pwq;
446676af4d93STejun Heo 	bool ret;
446776af4d93STejun Heo 
446888109453SLai Jiangshan 	rcu_read_lock_sched();
44697fb98ea7STejun Heo 
4470d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
4471d3251859STejun Heo 		cpu = smp_processor_id();
4472d3251859STejun Heo 
44737fb98ea7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
44747fb98ea7STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
44757fb98ea7STejun Heo 	else
4476df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4477dcd989cbSTejun Heo 
447876af4d93STejun Heo 	ret = !list_empty(&pwq->delayed_works);
447988109453SLai Jiangshan 	rcu_read_unlock_sched();
448076af4d93STejun Heo 
448176af4d93STejun Heo 	return ret;
4482dcd989cbSTejun Heo }
4483dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
4484dcd989cbSTejun Heo 
4485dcd989cbSTejun Heo /**
4486dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
4487dcd989cbSTejun Heo  * @work: the work to be tested
4488dcd989cbSTejun Heo  *
4489dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
4490dcd989cbSTejun Heo  * synchronization around this function and the test result is
4491dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4492dcd989cbSTejun Heo  *
4493d185af30SYacine Belkadi  * Return:
4494dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
4495dcd989cbSTejun Heo  */
4496dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
4497dcd989cbSTejun Heo {
4498fa1b54e6STejun Heo 	struct worker_pool *pool;
4499dcd989cbSTejun Heo 	unsigned long flags;
4500dcd989cbSTejun Heo 	unsigned int ret = 0;
4501dcd989cbSTejun Heo 
4502dcd989cbSTejun Heo 	if (work_pending(work))
4503dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
4504038366c5SLai Jiangshan 
4505fa1b54e6STejun Heo 	local_irq_save(flags);
4506fa1b54e6STejun Heo 	pool = get_work_pool(work);
4507038366c5SLai Jiangshan 	if (pool) {
4508fa1b54e6STejun Heo 		spin_lock(&pool->lock);
4509c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
4510dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
4511fa1b54e6STejun Heo 		spin_unlock(&pool->lock);
4512038366c5SLai Jiangshan 	}
4513fa1b54e6STejun Heo 	local_irq_restore(flags);
4514dcd989cbSTejun Heo 
4515dcd989cbSTejun Heo 	return ret;
4516dcd989cbSTejun Heo }
4517dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
4518dcd989cbSTejun Heo 
45193d1cb205STejun Heo /**
45203d1cb205STejun Heo  * set_worker_desc - set description for the current work item
45213d1cb205STejun Heo  * @fmt: printf-style format string
45223d1cb205STejun Heo  * @...: arguments for the format string
45233d1cb205STejun Heo  *
45243d1cb205STejun Heo  * This function can be called by a running work function to describe what
45253d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
45263d1cb205STejun Heo  * information will be printed out together to help debugging.  The
45273d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
45283d1cb205STejun Heo  */
45293d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
45303d1cb205STejun Heo {
45313d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
45323d1cb205STejun Heo 	va_list args;
45333d1cb205STejun Heo 
45343d1cb205STejun Heo 	if (worker) {
45353d1cb205STejun Heo 		va_start(args, fmt);
45363d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
45373d1cb205STejun Heo 		va_end(args);
45383d1cb205STejun Heo 	}
45393d1cb205STejun Heo }
45405c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc);
45413d1cb205STejun Heo 
45423d1cb205STejun Heo /**
45433d1cb205STejun Heo  * print_worker_info - print out worker information and description
45443d1cb205STejun Heo  * @log_lvl: the log level to use when printing
45453d1cb205STejun Heo  * @task: target task
45463d1cb205STejun Heo  *
45473d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
45483d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
45493d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
45503d1cb205STejun Heo  *
45513d1cb205STejun Heo  * This function can be safely called on any task as long as the
45523d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
45533d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
45543d1cb205STejun Heo  */
45553d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
45563d1cb205STejun Heo {
45573d1cb205STejun Heo 	work_func_t *fn = NULL;
45583d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
45593d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
45603d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
45613d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
45623d1cb205STejun Heo 	struct worker *worker;
45633d1cb205STejun Heo 
45643d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
45653d1cb205STejun Heo 		return;
45663d1cb205STejun Heo 
45673d1cb205STejun Heo 	/*
45683d1cb205STejun Heo 	 * This function is called without any synchronization and @task
45693d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
45703d1cb205STejun Heo 	 */
4571e700591aSPetr Mladek 	worker = kthread_probe_data(task);
45723d1cb205STejun Heo 
45733d1cb205STejun Heo 	/*
45748bf89593STejun Heo 	 * Carefully copy the associated workqueue's workfn, name and desc.
45758bf89593STejun Heo 	 * Keep the original last '\0' in case the original is garbage.
45763d1cb205STejun Heo 	 */
45773d1cb205STejun Heo 	probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
45783d1cb205STejun Heo 	probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
45793d1cb205STejun Heo 	probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
45803d1cb205STejun Heo 	probe_kernel_read(name, wq->name, sizeof(name) - 1);
45813d1cb205STejun Heo 	probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
45823d1cb205STejun Heo 
45833d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
45843d1cb205STejun Heo 		printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
45858bf89593STejun Heo 		if (strcmp(name, desc))
45863d1cb205STejun Heo 			pr_cont(" (%s)", desc);
45873d1cb205STejun Heo 		pr_cont("\n");
45883d1cb205STejun Heo 	}
45893d1cb205STejun Heo }
45903d1cb205STejun Heo 
45913494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool)
45923494fc30STejun Heo {
45933494fc30STejun Heo 	pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
45943494fc30STejun Heo 	if (pool->node != NUMA_NO_NODE)
45953494fc30STejun Heo 		pr_cont(" node=%d", pool->node);
45963494fc30STejun Heo 	pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
45973494fc30STejun Heo }
45983494fc30STejun Heo 
45993494fc30STejun Heo static void pr_cont_work(bool comma, struct work_struct *work)
46003494fc30STejun Heo {
46013494fc30STejun Heo 	if (work->func == wq_barrier_func) {
46023494fc30STejun Heo 		struct wq_barrier *barr;
46033494fc30STejun Heo 
46043494fc30STejun Heo 		barr = container_of(work, struct wq_barrier, work);
46053494fc30STejun Heo 
46063494fc30STejun Heo 		pr_cont("%s BAR(%d)", comma ? "," : "",
46073494fc30STejun Heo 			task_pid_nr(barr->task));
46083494fc30STejun Heo 	} else {
46093494fc30STejun Heo 		pr_cont("%s %pf", comma ? "," : "", work->func);
46103494fc30STejun Heo 	}
46113494fc30STejun Heo }
46123494fc30STejun Heo 
46133494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq)
46143494fc30STejun Heo {
46153494fc30STejun Heo 	struct worker_pool *pool = pwq->pool;
46163494fc30STejun Heo 	struct work_struct *work;
46173494fc30STejun Heo 	struct worker *worker;
46183494fc30STejun Heo 	bool has_in_flight = false, has_pending = false;
46193494fc30STejun Heo 	int bkt;
46203494fc30STejun Heo 
46213494fc30STejun Heo 	pr_info("  pwq %d:", pool->id);
46223494fc30STejun Heo 	pr_cont_pool_info(pool);
46233494fc30STejun Heo 
46243494fc30STejun Heo 	pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
46253494fc30STejun Heo 		!list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
46263494fc30STejun Heo 
46273494fc30STejun Heo 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
46283494fc30STejun Heo 		if (worker->current_pwq == pwq) {
46293494fc30STejun Heo 			has_in_flight = true;
46303494fc30STejun Heo 			break;
46313494fc30STejun Heo 		}
46323494fc30STejun Heo 	}
46333494fc30STejun Heo 	if (has_in_flight) {
46343494fc30STejun Heo 		bool comma = false;
46353494fc30STejun Heo 
46363494fc30STejun Heo 		pr_info("    in-flight:");
46373494fc30STejun Heo 		hash_for_each(pool->busy_hash, bkt, worker, hentry) {
46383494fc30STejun Heo 			if (worker->current_pwq != pwq)
46393494fc30STejun Heo 				continue;
46403494fc30STejun Heo 
46413494fc30STejun Heo 			pr_cont("%s %d%s:%pf", comma ? "," : "",
46423494fc30STejun Heo 				task_pid_nr(worker->task),
46433494fc30STejun Heo 				worker == pwq->wq->rescuer ? "(RESCUER)" : "",
46443494fc30STejun Heo 				worker->current_func);
46453494fc30STejun Heo 			list_for_each_entry(work, &worker->scheduled, entry)
46463494fc30STejun Heo 				pr_cont_work(false, work);
46473494fc30STejun Heo 			comma = true;
46483494fc30STejun Heo 		}
46493494fc30STejun Heo 		pr_cont("\n");
46503494fc30STejun Heo 	}
46513494fc30STejun Heo 
46523494fc30STejun Heo 	list_for_each_entry(work, &pool->worklist, entry) {
46533494fc30STejun Heo 		if (get_work_pwq(work) == pwq) {
46543494fc30STejun Heo 			has_pending = true;
46553494fc30STejun Heo 			break;
46563494fc30STejun Heo 		}
46573494fc30STejun Heo 	}
46583494fc30STejun Heo 	if (has_pending) {
46593494fc30STejun Heo 		bool comma = false;
46603494fc30STejun Heo 
46613494fc30STejun Heo 		pr_info("    pending:");
46623494fc30STejun Heo 		list_for_each_entry(work, &pool->worklist, entry) {
46633494fc30STejun Heo 			if (get_work_pwq(work) != pwq)
46643494fc30STejun Heo 				continue;
46653494fc30STejun Heo 
46663494fc30STejun Heo 			pr_cont_work(comma, work);
46673494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
46683494fc30STejun Heo 		}
46693494fc30STejun Heo 		pr_cont("\n");
46703494fc30STejun Heo 	}
46713494fc30STejun Heo 
46723494fc30STejun Heo 	if (!list_empty(&pwq->delayed_works)) {
46733494fc30STejun Heo 		bool comma = false;
46743494fc30STejun Heo 
46753494fc30STejun Heo 		pr_info("    delayed:");
46763494fc30STejun Heo 		list_for_each_entry(work, &pwq->delayed_works, entry) {
46773494fc30STejun Heo 			pr_cont_work(comma, work);
46783494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
46793494fc30STejun Heo 		}
46803494fc30STejun Heo 		pr_cont("\n");
46813494fc30STejun Heo 	}
46823494fc30STejun Heo }
46833494fc30STejun Heo 
46843494fc30STejun Heo /**
46853494fc30STejun Heo  * show_workqueue_state - dump workqueue state
46863494fc30STejun Heo  *
46877b776af6SRoger Lu  * Called from a sysrq handler or try_to_freeze_tasks() and prints out
46887b776af6SRoger Lu  * all busy workqueues and pools.
46893494fc30STejun Heo  */
46903494fc30STejun Heo void show_workqueue_state(void)
46913494fc30STejun Heo {
46923494fc30STejun Heo 	struct workqueue_struct *wq;
46933494fc30STejun Heo 	struct worker_pool *pool;
46943494fc30STejun Heo 	unsigned long flags;
46953494fc30STejun Heo 	int pi;
46963494fc30STejun Heo 
46973494fc30STejun Heo 	rcu_read_lock_sched();
46983494fc30STejun Heo 
46993494fc30STejun Heo 	pr_info("Showing busy workqueues and worker pools:\n");
47003494fc30STejun Heo 
47013494fc30STejun Heo 	list_for_each_entry_rcu(wq, &workqueues, list) {
47023494fc30STejun Heo 		struct pool_workqueue *pwq;
47033494fc30STejun Heo 		bool idle = true;
47043494fc30STejun Heo 
47053494fc30STejun Heo 		for_each_pwq(pwq, wq) {
47063494fc30STejun Heo 			if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
47073494fc30STejun Heo 				idle = false;
47083494fc30STejun Heo 				break;
47093494fc30STejun Heo 			}
47103494fc30STejun Heo 		}
47113494fc30STejun Heo 		if (idle)
47123494fc30STejun Heo 			continue;
47133494fc30STejun Heo 
47143494fc30STejun Heo 		pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
47153494fc30STejun Heo 
47163494fc30STejun Heo 		for_each_pwq(pwq, wq) {
47173494fc30STejun Heo 			spin_lock_irqsave(&pwq->pool->lock, flags);
47183494fc30STejun Heo 			if (pwq->nr_active || !list_empty(&pwq->delayed_works))
47193494fc30STejun Heo 				show_pwq(pwq);
47203494fc30STejun Heo 			spin_unlock_irqrestore(&pwq->pool->lock, flags);
472162635ea8SSergey Senozhatsky 			/*
472262635ea8SSergey Senozhatsky 			 * We could be printing a lot from atomic context, e.g.
472362635ea8SSergey Senozhatsky 			 * sysrq-t -> show_workqueue_state(). Avoid triggering
472462635ea8SSergey Senozhatsky 			 * hard lockup.
472562635ea8SSergey Senozhatsky 			 */
472662635ea8SSergey Senozhatsky 			touch_nmi_watchdog();
47273494fc30STejun Heo 		}
47283494fc30STejun Heo 	}
47293494fc30STejun Heo 
47303494fc30STejun Heo 	for_each_pool(pool, pi) {
47313494fc30STejun Heo 		struct worker *worker;
47323494fc30STejun Heo 		bool first = true;
47333494fc30STejun Heo 
47343494fc30STejun Heo 		spin_lock_irqsave(&pool->lock, flags);
47353494fc30STejun Heo 		if (pool->nr_workers == pool->nr_idle)
47363494fc30STejun Heo 			goto next_pool;
47373494fc30STejun Heo 
47383494fc30STejun Heo 		pr_info("pool %d:", pool->id);
47393494fc30STejun Heo 		pr_cont_pool_info(pool);
474082607adcSTejun Heo 		pr_cont(" hung=%us workers=%d",
474182607adcSTejun Heo 			jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
474282607adcSTejun Heo 			pool->nr_workers);
47433494fc30STejun Heo 		if (pool->manager)
47443494fc30STejun Heo 			pr_cont(" manager: %d",
47453494fc30STejun Heo 				task_pid_nr(pool->manager->task));
47463494fc30STejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry) {
47473494fc30STejun Heo 			pr_cont(" %s%d", first ? "idle: " : "",
47483494fc30STejun Heo 				task_pid_nr(worker->task));
47493494fc30STejun Heo 			first = false;
47503494fc30STejun Heo 		}
47513494fc30STejun Heo 		pr_cont("\n");
47523494fc30STejun Heo 	next_pool:
47533494fc30STejun Heo 		spin_unlock_irqrestore(&pool->lock, flags);
475462635ea8SSergey Senozhatsky 		/*
475562635ea8SSergey Senozhatsky 		 * We could be printing a lot from atomic context, e.g.
475662635ea8SSergey Senozhatsky 		 * sysrq-t -> show_workqueue_state(). Avoid triggering
475762635ea8SSergey Senozhatsky 		 * hard lockup.
475862635ea8SSergey Senozhatsky 		 */
475962635ea8SSergey Senozhatsky 		touch_nmi_watchdog();
47603494fc30STejun Heo 	}
47613494fc30STejun Heo 
47623494fc30STejun Heo 	rcu_read_unlock_sched();
47633494fc30STejun Heo }
47643494fc30STejun Heo 
47656b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */
47666b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
47676b59808bSTejun Heo {
47686b59808bSTejun Heo 	int off;
47696b59808bSTejun Heo 
47706b59808bSTejun Heo 	/* always show the actual comm */
47716b59808bSTejun Heo 	off = strscpy(buf, task->comm, size);
47726b59808bSTejun Heo 	if (off < 0)
47736b59808bSTejun Heo 		return;
47746b59808bSTejun Heo 
4775197f6accSTejun Heo 	/* stabilize PF_WQ_WORKER and worker pool association */
47766b59808bSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
47776b59808bSTejun Heo 
4778197f6accSTejun Heo 	if (task->flags & PF_WQ_WORKER) {
4779197f6accSTejun Heo 		struct worker *worker = kthread_data(task);
4780197f6accSTejun Heo 		struct worker_pool *pool = worker->pool;
47816b59808bSTejun Heo 
47826b59808bSTejun Heo 		if (pool) {
47836b59808bSTejun Heo 			spin_lock_irq(&pool->lock);
47846b59808bSTejun Heo 			/*
4785197f6accSTejun Heo 			 * ->desc tracks information (wq name or
4786197f6accSTejun Heo 			 * set_worker_desc()) for the latest execution.  If
4787197f6accSTejun Heo 			 * current, prepend '+', otherwise '-'.
47886b59808bSTejun Heo 			 */
47896b59808bSTejun Heo 			if (worker->desc[0] != '\0') {
47906b59808bSTejun Heo 				if (worker->current_work)
47916b59808bSTejun Heo 					scnprintf(buf + off, size - off, "+%s",
47926b59808bSTejun Heo 						  worker->desc);
47936b59808bSTejun Heo 				else
47946b59808bSTejun Heo 					scnprintf(buf + off, size - off, "-%s",
47956b59808bSTejun Heo 						  worker->desc);
47966b59808bSTejun Heo 			}
47976b59808bSTejun Heo 			spin_unlock_irq(&pool->lock);
47986b59808bSTejun Heo 		}
4799197f6accSTejun Heo 	}
48006b59808bSTejun Heo 
48016b59808bSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
48026b59808bSTejun Heo }
48036b59808bSTejun Heo 
480466448bc2SMathieu Malaterre #ifdef CONFIG_SMP
480566448bc2SMathieu Malaterre 
4806db7bccf4STejun Heo /*
4807db7bccf4STejun Heo  * CPU hotplug.
4808db7bccf4STejun Heo  *
4809e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
4810112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
4811706026c2STejun Heo  * pool which make migrating pending and scheduled works very
4812e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
481394cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
4814e22bee78STejun Heo  * blocked draining impractical.
4815e22bee78STejun Heo  *
481624647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
4817628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
4818628c78e7STejun Heo  * cpu comes back online.
4819db7bccf4STejun Heo  */
4820db7bccf4STejun Heo 
4821e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu)
4822db7bccf4STejun Heo {
48234ce62e9eSTejun Heo 	struct worker_pool *pool;
4824db7bccf4STejun Heo 	struct worker *worker;
4825db7bccf4STejun Heo 
4826f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
48271258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
482894cf58bbSTejun Heo 		spin_lock_irq(&pool->lock);
4829e22bee78STejun Heo 
4830f2d5a0eeSTejun Heo 		/*
483192f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
483294cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
483394cf58bbSTejun Heo 		 * except for the ones which are still executing works from
483494cf58bbSTejun Heo 		 * before the last CPU down must be on the cpu.  After
483594cf58bbSTejun Heo 		 * this, they may become diasporas.
4836f2d5a0eeSTejun Heo 		 */
4837da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
4838403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
4839db7bccf4STejun Heo 
484024647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
4841f2d5a0eeSTejun Heo 
484294cf58bbSTejun Heo 		spin_unlock_irq(&pool->lock);
48431258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
4844e22bee78STejun Heo 
4845e22bee78STejun Heo 		/*
4846eb283428SLai Jiangshan 		 * Call schedule() so that we cross rq->lock and thus can
4847eb283428SLai Jiangshan 		 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4848eb283428SLai Jiangshan 		 * This is necessary as scheduler callbacks may be invoked
4849eb283428SLai Jiangshan 		 * from other cpus.
4850628c78e7STejun Heo 		 */
4851628c78e7STejun Heo 		schedule();
4852628c78e7STejun Heo 
4853628c78e7STejun Heo 		/*
4854eb283428SLai Jiangshan 		 * Sched callbacks are disabled now.  Zap nr_running.
4855eb283428SLai Jiangshan 		 * After this, nr_running stays zero and need_more_worker()
4856eb283428SLai Jiangshan 		 * and keep_working() are always true as long as the
4857eb283428SLai Jiangshan 		 * worklist is not empty.  This pool now behaves as an
4858eb283428SLai Jiangshan 		 * unbound (in terms of concurrency management) pool which
4859eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
4860e22bee78STejun Heo 		 */
4861e19e397aSTejun Heo 		atomic_set(&pool->nr_running, 0);
4862eb283428SLai Jiangshan 
4863eb283428SLai Jiangshan 		/*
4864eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
4865eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
4866eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
4867eb283428SLai Jiangshan 		 */
4868eb283428SLai Jiangshan 		spin_lock_irq(&pool->lock);
4869eb283428SLai Jiangshan 		wake_up_worker(pool);
4870eb283428SLai Jiangshan 		spin_unlock_irq(&pool->lock);
4871eb283428SLai Jiangshan 	}
4872db7bccf4STejun Heo }
4873db7bccf4STejun Heo 
4874bd7c089eSTejun Heo /**
4875bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
4876bd7c089eSTejun Heo  * @pool: pool of interest
4877bd7c089eSTejun Heo  *
4878a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
4879bd7c089eSTejun Heo  */
4880bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
4881bd7c089eSTejun Heo {
4882a9ab775bSTejun Heo 	struct worker *worker;
4883bd7c089eSTejun Heo 
48841258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
4885bd7c089eSTejun Heo 
4886bd7c089eSTejun Heo 	/*
4887a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
4888a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
4889402dd89dSShailendra Verma 	 * wake-ups for concurrency management happen, restore CPU affinity
4890a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
4891a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
4892bd7c089eSTejun Heo 	 */
4893da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
4894a9ab775bSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4895a9ab775bSTejun Heo 						  pool->attrs->cpumask) < 0);
4896a9ab775bSTejun Heo 
4897a9ab775bSTejun Heo 	spin_lock_irq(&pool->lock);
4898f7c17d26SWanpeng Li 
48993de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
4900a9ab775bSTejun Heo 
4901da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
4902a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
4903a9ab775bSTejun Heo 
4904a9ab775bSTejun Heo 		/*
4905a9ab775bSTejun Heo 		 * A bound idle worker should actually be on the runqueue
4906a9ab775bSTejun Heo 		 * of the associated CPU for local wake-ups targeting it to
4907a9ab775bSTejun Heo 		 * work.  Kick all idle workers so that they migrate to the
4908a9ab775bSTejun Heo 		 * associated CPU.  Doing this in the same loop as
4909a9ab775bSTejun Heo 		 * replacing UNBOUND with REBOUND is safe as no worker will
4910a9ab775bSTejun Heo 		 * be bound before @pool->lock is released.
4911a9ab775bSTejun Heo 		 */
4912a9ab775bSTejun Heo 		if (worker_flags & WORKER_IDLE)
4913bd7c089eSTejun Heo 			wake_up_process(worker->task);
4914bd7c089eSTejun Heo 
4915bd7c089eSTejun Heo 		/*
4916a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
4917a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
4918a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4919a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
4920a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
4921a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
4922a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
4923a9ab775bSTejun Heo 		 *
4924c95491edSMark Rutland 		 * WRITE_ONCE() is necessary because @worker->flags may be
4925a9ab775bSTejun Heo 		 * tested without holding any lock in
4926*6d25be57SThomas Gleixner 		 * wq_worker_running().  Without it, NOT_RUNNING test may
4927a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
4928a9ab775bSTejun Heo 		 * management operations.
4929bd7c089eSTejun Heo 		 */
4930a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4931a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
4932a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
4933c95491edSMark Rutland 		WRITE_ONCE(worker->flags, worker_flags);
4934bd7c089eSTejun Heo 	}
4935a9ab775bSTejun Heo 
4936a9ab775bSTejun Heo 	spin_unlock_irq(&pool->lock);
4937bd7c089eSTejun Heo }
4938bd7c089eSTejun Heo 
49397dbc725eSTejun Heo /**
49407dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
49417dbc725eSTejun Heo  * @pool: unbound pool of interest
49427dbc725eSTejun Heo  * @cpu: the CPU which is coming up
49437dbc725eSTejun Heo  *
49447dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
49457dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
49467dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
49477dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
49487dbc725eSTejun Heo  */
49497dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
49507dbc725eSTejun Heo {
49517dbc725eSTejun Heo 	static cpumask_t cpumask;
49527dbc725eSTejun Heo 	struct worker *worker;
49537dbc725eSTejun Heo 
49541258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
49557dbc725eSTejun Heo 
49567dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
49577dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
49587dbc725eSTejun Heo 		return;
49597dbc725eSTejun Heo 
49607dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
49617dbc725eSTejun Heo 
49627dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
4963da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
4964d945b5e9SPeter Zijlstra 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
49657dbc725eSTejun Heo }
49667dbc725eSTejun Heo 
49677ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu)
49681da177e4SLinus Torvalds {
49694ce62e9eSTejun Heo 	struct worker_pool *pool;
49701da177e4SLinus Torvalds 
4971f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
49723ce63377STejun Heo 		if (pool->nr_workers)
49733ce63377STejun Heo 			continue;
4974051e1850SLai Jiangshan 		if (!create_worker(pool))
49757ee681b2SThomas Gleixner 			return -ENOMEM;
49763af24433SOleg Nesterov 	}
49777ee681b2SThomas Gleixner 	return 0;
49787ee681b2SThomas Gleixner }
49791da177e4SLinus Torvalds 
49807ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu)
49817ee681b2SThomas Gleixner {
49827ee681b2SThomas Gleixner 	struct worker_pool *pool;
49837ee681b2SThomas Gleixner 	struct workqueue_struct *wq;
49847ee681b2SThomas Gleixner 	int pi;
49857ee681b2SThomas Gleixner 
498668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
49877dbc725eSTejun Heo 
49887dbc725eSTejun Heo 	for_each_pool(pool, pi) {
49891258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
499094cf58bbSTejun Heo 
4991f05b558dSLai Jiangshan 		if (pool->cpu == cpu)
499294cf58bbSTejun Heo 			rebind_workers(pool);
4993f05b558dSLai Jiangshan 		else if (pool->cpu < 0)
49947dbc725eSTejun Heo 			restore_unbound_workers_cpumask(pool, cpu);
499594cf58bbSTejun Heo 
49961258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
499794cf58bbSTejun Heo 	}
49987dbc725eSTejun Heo 
49994c16bd32STejun Heo 	/* update NUMA affinity of unbound workqueues */
50004c16bd32STejun Heo 	list_for_each_entry(wq, &workqueues, list)
50014c16bd32STejun Heo 		wq_update_unbound_numa(wq, cpu, true);
50024c16bd32STejun Heo 
500368e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
50047ee681b2SThomas Gleixner 	return 0;
500565758202STejun Heo }
500665758202STejun Heo 
50077ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu)
500865758202STejun Heo {
50094c16bd32STejun Heo 	struct workqueue_struct *wq;
50108db25e78STejun Heo 
50114c16bd32STejun Heo 	/* unbinding per-cpu workers should happen on the local CPU */
5012e8b3f8dbSLai Jiangshan 	if (WARN_ON(cpu != smp_processor_id()))
5013e8b3f8dbSLai Jiangshan 		return -1;
5014e8b3f8dbSLai Jiangshan 
5015e8b3f8dbSLai Jiangshan 	unbind_workers(cpu);
50164c16bd32STejun Heo 
50174c16bd32STejun Heo 	/* update NUMA affinity of unbound workqueues */
50184c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
50194c16bd32STejun Heo 	list_for_each_entry(wq, &workqueues, list)
50204c16bd32STejun Heo 		wq_update_unbound_numa(wq, cpu, false);
50214c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
50224c16bd32STejun Heo 
50237ee681b2SThomas Gleixner 	return 0;
502465758202STejun Heo }
502565758202STejun Heo 
50262d3854a3SRusty Russell struct work_for_cpu {
5027ed48ece2STejun Heo 	struct work_struct work;
50282d3854a3SRusty Russell 	long (*fn)(void *);
50292d3854a3SRusty Russell 	void *arg;
50302d3854a3SRusty Russell 	long ret;
50312d3854a3SRusty Russell };
50322d3854a3SRusty Russell 
5033ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
50342d3854a3SRusty Russell {
5035ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5036ed48ece2STejun Heo 
50372d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
50382d3854a3SRusty Russell }
50392d3854a3SRusty Russell 
50402d3854a3SRusty Russell /**
504122aceb31SAnna-Maria Gleixner  * work_on_cpu - run a function in thread context on a particular cpu
50422d3854a3SRusty Russell  * @cpu: the cpu to run on
50432d3854a3SRusty Russell  * @fn: the function to run
50442d3854a3SRusty Russell  * @arg: the function arg
50452d3854a3SRusty Russell  *
504631ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
50476b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
5048d185af30SYacine Belkadi  *
5049d185af30SYacine Belkadi  * Return: The value @fn returns.
50502d3854a3SRusty Russell  */
5051d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
50522d3854a3SRusty Russell {
5053ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
50542d3854a3SRusty Russell 
5055ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5056ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
505712997d1aSBjorn Helgaas 	flush_work(&wfc.work);
5058440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
50592d3854a3SRusty Russell 	return wfc.ret;
50602d3854a3SRusty Russell }
50612d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
50620e8d6a93SThomas Gleixner 
50630e8d6a93SThomas Gleixner /**
50640e8d6a93SThomas Gleixner  * work_on_cpu_safe - run a function in thread context on a particular cpu
50650e8d6a93SThomas Gleixner  * @cpu: the cpu to run on
50660e8d6a93SThomas Gleixner  * @fn:  the function to run
50670e8d6a93SThomas Gleixner  * @arg: the function argument
50680e8d6a93SThomas Gleixner  *
50690e8d6a93SThomas Gleixner  * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
50700e8d6a93SThomas Gleixner  * any locks which would prevent @fn from completing.
50710e8d6a93SThomas Gleixner  *
50720e8d6a93SThomas Gleixner  * Return: The value @fn returns.
50730e8d6a93SThomas Gleixner  */
50740e8d6a93SThomas Gleixner long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
50750e8d6a93SThomas Gleixner {
50760e8d6a93SThomas Gleixner 	long ret = -ENODEV;
50770e8d6a93SThomas Gleixner 
50780e8d6a93SThomas Gleixner 	get_online_cpus();
50790e8d6a93SThomas Gleixner 	if (cpu_online(cpu))
50800e8d6a93SThomas Gleixner 		ret = work_on_cpu(cpu, fn, arg);
50810e8d6a93SThomas Gleixner 	put_online_cpus();
50820e8d6a93SThomas Gleixner 	return ret;
50830e8d6a93SThomas Gleixner }
50840e8d6a93SThomas Gleixner EXPORT_SYMBOL_GPL(work_on_cpu_safe);
50852d3854a3SRusty Russell #endif /* CONFIG_SMP */
50862d3854a3SRusty Russell 
5087a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
5088e7577c50SRusty Russell 
5089a0a1a5fdSTejun Heo /**
5090a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
5091a0a1a5fdSTejun Heo  *
509258a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
5093c5aa87bbSTejun Heo  * workqueues will queue new works to their delayed_works list instead of
5094706026c2STejun Heo  * pool->worklist.
5095a0a1a5fdSTejun Heo  *
5096a0a1a5fdSTejun Heo  * CONTEXT:
5097a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5098a0a1a5fdSTejun Heo  */
5099a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
5100a0a1a5fdSTejun Heo {
510124b8a847STejun Heo 	struct workqueue_struct *wq;
510224b8a847STejun Heo 	struct pool_workqueue *pwq;
5103a0a1a5fdSTejun Heo 
510468e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5105a0a1a5fdSTejun Heo 
51066183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
5107a0a1a5fdSTejun Heo 	workqueue_freezing = true;
5108a0a1a5fdSTejun Heo 
510924b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
5110a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
5111699ce097STejun Heo 		for_each_pwq(pwq, wq)
5112699ce097STejun Heo 			pwq_adjust_max_active(pwq);
5113a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
5114a1056305STejun Heo 	}
51155bcab335STejun Heo 
511668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5117a0a1a5fdSTejun Heo }
5118a0a1a5fdSTejun Heo 
5119a0a1a5fdSTejun Heo /**
512058a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
5121a0a1a5fdSTejun Heo  *
5122a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
5123a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
5124a0a1a5fdSTejun Heo  *
5125a0a1a5fdSTejun Heo  * CONTEXT:
512668e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
5127a0a1a5fdSTejun Heo  *
5128d185af30SYacine Belkadi  * Return:
512958a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
513058a69cb4STejun Heo  * is complete.
5131a0a1a5fdSTejun Heo  */
5132a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
5133a0a1a5fdSTejun Heo {
5134a0a1a5fdSTejun Heo 	bool busy = false;
513524b8a847STejun Heo 	struct workqueue_struct *wq;
513624b8a847STejun Heo 	struct pool_workqueue *pwq;
5137a0a1a5fdSTejun Heo 
513868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5139a0a1a5fdSTejun Heo 
51406183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
5141a0a1a5fdSTejun Heo 
514224b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
514324b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
514424b8a847STejun Heo 			continue;
5145a0a1a5fdSTejun Heo 		/*
5146a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
5147a0a1a5fdSTejun Heo 		 * to peek without lock.
5148a0a1a5fdSTejun Heo 		 */
514988109453SLai Jiangshan 		rcu_read_lock_sched();
515024b8a847STejun Heo 		for_each_pwq(pwq, wq) {
51516183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
5152112202d9STejun Heo 			if (pwq->nr_active) {
5153a0a1a5fdSTejun Heo 				busy = true;
515488109453SLai Jiangshan 				rcu_read_unlock_sched();
5155a0a1a5fdSTejun Heo 				goto out_unlock;
5156a0a1a5fdSTejun Heo 			}
5157a0a1a5fdSTejun Heo 		}
515888109453SLai Jiangshan 		rcu_read_unlock_sched();
5159a0a1a5fdSTejun Heo 	}
5160a0a1a5fdSTejun Heo out_unlock:
516168e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5162a0a1a5fdSTejun Heo 	return busy;
5163a0a1a5fdSTejun Heo }
5164a0a1a5fdSTejun Heo 
5165a0a1a5fdSTejun Heo /**
5166a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
5167a0a1a5fdSTejun Heo  *
5168a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
5169706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
5170a0a1a5fdSTejun Heo  *
5171a0a1a5fdSTejun Heo  * CONTEXT:
5172a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5173a0a1a5fdSTejun Heo  */
5174a0a1a5fdSTejun Heo void thaw_workqueues(void)
5175a0a1a5fdSTejun Heo {
517624b8a847STejun Heo 	struct workqueue_struct *wq;
517724b8a847STejun Heo 	struct pool_workqueue *pwq;
5178a0a1a5fdSTejun Heo 
517968e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5180a0a1a5fdSTejun Heo 
5181a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
5182a0a1a5fdSTejun Heo 		goto out_unlock;
5183a0a1a5fdSTejun Heo 
518474b414eaSLai Jiangshan 	workqueue_freezing = false;
518524b8a847STejun Heo 
518624b8a847STejun Heo 	/* restore max_active and repopulate worklist */
518724b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
5188a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
5189699ce097STejun Heo 		for_each_pwq(pwq, wq)
5190699ce097STejun Heo 			pwq_adjust_max_active(pwq);
5191a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
519224b8a847STejun Heo 	}
519324b8a847STejun Heo 
5194a0a1a5fdSTejun Heo out_unlock:
519568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5196a0a1a5fdSTejun Heo }
5197a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
5198a0a1a5fdSTejun Heo 
5199042f7df1SLai Jiangshan static int workqueue_apply_unbound_cpumask(void)
5200042f7df1SLai Jiangshan {
5201042f7df1SLai Jiangshan 	LIST_HEAD(ctxs);
5202042f7df1SLai Jiangshan 	int ret = 0;
5203042f7df1SLai Jiangshan 	struct workqueue_struct *wq;
5204042f7df1SLai Jiangshan 	struct apply_wqattrs_ctx *ctx, *n;
5205042f7df1SLai Jiangshan 
5206042f7df1SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5207042f7df1SLai Jiangshan 
5208042f7df1SLai Jiangshan 	list_for_each_entry(wq, &workqueues, list) {
5209042f7df1SLai Jiangshan 		if (!(wq->flags & WQ_UNBOUND))
5210042f7df1SLai Jiangshan 			continue;
5211042f7df1SLai Jiangshan 		/* creating multiple pwqs breaks ordering guarantee */
5212042f7df1SLai Jiangshan 		if (wq->flags & __WQ_ORDERED)
5213042f7df1SLai Jiangshan 			continue;
5214042f7df1SLai Jiangshan 
5215042f7df1SLai Jiangshan 		ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5216042f7df1SLai Jiangshan 		if (!ctx) {
5217042f7df1SLai Jiangshan 			ret = -ENOMEM;
5218042f7df1SLai Jiangshan 			break;
5219042f7df1SLai Jiangshan 		}
5220042f7df1SLai Jiangshan 
5221042f7df1SLai Jiangshan 		list_add_tail(&ctx->list, &ctxs);
5222042f7df1SLai Jiangshan 	}
5223042f7df1SLai Jiangshan 
5224042f7df1SLai Jiangshan 	list_for_each_entry_safe(ctx, n, &ctxs, list) {
5225042f7df1SLai Jiangshan 		if (!ret)
5226042f7df1SLai Jiangshan 			apply_wqattrs_commit(ctx);
5227042f7df1SLai Jiangshan 		apply_wqattrs_cleanup(ctx);
5228042f7df1SLai Jiangshan 	}
5229042f7df1SLai Jiangshan 
5230042f7df1SLai Jiangshan 	return ret;
5231042f7df1SLai Jiangshan }
5232042f7df1SLai Jiangshan 
5233042f7df1SLai Jiangshan /**
5234042f7df1SLai Jiangshan  *  workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5235042f7df1SLai Jiangshan  *  @cpumask: the cpumask to set
5236042f7df1SLai Jiangshan  *
5237042f7df1SLai Jiangshan  *  The low-level workqueues cpumask is a global cpumask that limits
5238042f7df1SLai Jiangshan  *  the affinity of all unbound workqueues.  This function check the @cpumask
5239042f7df1SLai Jiangshan  *  and apply it to all unbound workqueues and updates all pwqs of them.
5240042f7df1SLai Jiangshan  *
5241042f7df1SLai Jiangshan  *  Retun:	0	- Success
5242042f7df1SLai Jiangshan  *  		-EINVAL	- Invalid @cpumask
5243042f7df1SLai Jiangshan  *  		-ENOMEM	- Failed to allocate memory for attrs or pwqs.
5244042f7df1SLai Jiangshan  */
5245042f7df1SLai Jiangshan int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5246042f7df1SLai Jiangshan {
5247042f7df1SLai Jiangshan 	int ret = -EINVAL;
5248042f7df1SLai Jiangshan 	cpumask_var_t saved_cpumask;
5249042f7df1SLai Jiangshan 
5250042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5251042f7df1SLai Jiangshan 		return -ENOMEM;
5252042f7df1SLai Jiangshan 
5253c98a9805STal Shorer 	/*
5254c98a9805STal Shorer 	 * Not excluding isolated cpus on purpose.
5255c98a9805STal Shorer 	 * If the user wishes to include them, we allow that.
5256c98a9805STal Shorer 	 */
5257042f7df1SLai Jiangshan 	cpumask_and(cpumask, cpumask, cpu_possible_mask);
5258042f7df1SLai Jiangshan 	if (!cpumask_empty(cpumask)) {
5259a0111cf6SLai Jiangshan 		apply_wqattrs_lock();
5260042f7df1SLai Jiangshan 
5261042f7df1SLai Jiangshan 		/* save the old wq_unbound_cpumask. */
5262042f7df1SLai Jiangshan 		cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5263042f7df1SLai Jiangshan 
5264042f7df1SLai Jiangshan 		/* update wq_unbound_cpumask at first and apply it to wqs. */
5265042f7df1SLai Jiangshan 		cpumask_copy(wq_unbound_cpumask, cpumask);
5266042f7df1SLai Jiangshan 		ret = workqueue_apply_unbound_cpumask();
5267042f7df1SLai Jiangshan 
5268042f7df1SLai Jiangshan 		/* restore the wq_unbound_cpumask when failed. */
5269042f7df1SLai Jiangshan 		if (ret < 0)
5270042f7df1SLai Jiangshan 			cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5271042f7df1SLai Jiangshan 
5272a0111cf6SLai Jiangshan 		apply_wqattrs_unlock();
5273042f7df1SLai Jiangshan 	}
5274042f7df1SLai Jiangshan 
5275042f7df1SLai Jiangshan 	free_cpumask_var(saved_cpumask);
5276042f7df1SLai Jiangshan 	return ret;
5277042f7df1SLai Jiangshan }
5278042f7df1SLai Jiangshan 
52796ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS
52806ba94429SFrederic Weisbecker /*
52816ba94429SFrederic Weisbecker  * Workqueues with WQ_SYSFS flag set is visible to userland via
52826ba94429SFrederic Weisbecker  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
52836ba94429SFrederic Weisbecker  * following attributes.
52846ba94429SFrederic Weisbecker  *
52856ba94429SFrederic Weisbecker  *  per_cpu	RO bool	: whether the workqueue is per-cpu or unbound
52866ba94429SFrederic Weisbecker  *  max_active	RW int	: maximum number of in-flight work items
52876ba94429SFrederic Weisbecker  *
52886ba94429SFrederic Weisbecker  * Unbound workqueues have the following extra attributes.
52896ba94429SFrederic Weisbecker  *
52909a19b463SWang Long  *  pool_ids	RO int	: the associated pool IDs for each node
52916ba94429SFrederic Weisbecker  *  nice	RW int	: nice value of the workers
52926ba94429SFrederic Weisbecker  *  cpumask	RW mask	: bitmask of allowed CPUs for the workers
52939a19b463SWang Long  *  numa	RW bool	: whether enable NUMA affinity
52946ba94429SFrederic Weisbecker  */
52956ba94429SFrederic Weisbecker struct wq_device {
52966ba94429SFrederic Weisbecker 	struct workqueue_struct		*wq;
52976ba94429SFrederic Weisbecker 	struct device			dev;
52986ba94429SFrederic Weisbecker };
52996ba94429SFrederic Weisbecker 
53006ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev)
53016ba94429SFrederic Weisbecker {
53026ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
53036ba94429SFrederic Weisbecker 
53046ba94429SFrederic Weisbecker 	return wq_dev->wq;
53056ba94429SFrederic Weisbecker }
53066ba94429SFrederic Weisbecker 
53076ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
53086ba94429SFrederic Weisbecker 			    char *buf)
53096ba94429SFrederic Weisbecker {
53106ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53116ba94429SFrederic Weisbecker 
53126ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
53136ba94429SFrederic Weisbecker }
53146ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu);
53156ba94429SFrederic Weisbecker 
53166ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev,
53176ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
53186ba94429SFrederic Weisbecker {
53196ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53206ba94429SFrederic Weisbecker 
53216ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
53226ba94429SFrederic Weisbecker }
53236ba94429SFrederic Weisbecker 
53246ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev,
53256ba94429SFrederic Weisbecker 				struct device_attribute *attr, const char *buf,
53266ba94429SFrederic Weisbecker 				size_t count)
53276ba94429SFrederic Weisbecker {
53286ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53296ba94429SFrederic Weisbecker 	int val;
53306ba94429SFrederic Weisbecker 
53316ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
53326ba94429SFrederic Weisbecker 		return -EINVAL;
53336ba94429SFrederic Weisbecker 
53346ba94429SFrederic Weisbecker 	workqueue_set_max_active(wq, val);
53356ba94429SFrederic Weisbecker 	return count;
53366ba94429SFrederic Weisbecker }
53376ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active);
53386ba94429SFrederic Weisbecker 
53396ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = {
53406ba94429SFrederic Weisbecker 	&dev_attr_per_cpu.attr,
53416ba94429SFrederic Weisbecker 	&dev_attr_max_active.attr,
53426ba94429SFrederic Weisbecker 	NULL,
53436ba94429SFrederic Weisbecker };
53446ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs);
53456ba94429SFrederic Weisbecker 
53466ba94429SFrederic Weisbecker static ssize_t wq_pool_ids_show(struct device *dev,
53476ba94429SFrederic Weisbecker 				struct device_attribute *attr, char *buf)
53486ba94429SFrederic Weisbecker {
53496ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53506ba94429SFrederic Weisbecker 	const char *delim = "";
53516ba94429SFrederic Weisbecker 	int node, written = 0;
53526ba94429SFrederic Weisbecker 
53536ba94429SFrederic Weisbecker 	rcu_read_lock_sched();
53546ba94429SFrederic Weisbecker 	for_each_node(node) {
53556ba94429SFrederic Weisbecker 		written += scnprintf(buf + written, PAGE_SIZE - written,
53566ba94429SFrederic Weisbecker 				     "%s%d:%d", delim, node,
53576ba94429SFrederic Weisbecker 				     unbound_pwq_by_node(wq, node)->pool->id);
53586ba94429SFrederic Weisbecker 		delim = " ";
53596ba94429SFrederic Weisbecker 	}
53606ba94429SFrederic Weisbecker 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
53616ba94429SFrederic Weisbecker 	rcu_read_unlock_sched();
53626ba94429SFrederic Weisbecker 
53636ba94429SFrederic Weisbecker 	return written;
53646ba94429SFrederic Weisbecker }
53656ba94429SFrederic Weisbecker 
53666ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
53676ba94429SFrederic Weisbecker 			    char *buf)
53686ba94429SFrederic Weisbecker {
53696ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53706ba94429SFrederic Weisbecker 	int written;
53716ba94429SFrederic Weisbecker 
53726ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
53736ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
53746ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
53756ba94429SFrederic Weisbecker 
53766ba94429SFrederic Weisbecker 	return written;
53776ba94429SFrederic Weisbecker }
53786ba94429SFrederic Weisbecker 
53796ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */
53806ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
53816ba94429SFrederic Weisbecker {
53826ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
53836ba94429SFrederic Weisbecker 
5384899a94feSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5385899a94feSLai Jiangshan 
53866ba94429SFrederic Weisbecker 	attrs = alloc_workqueue_attrs(GFP_KERNEL);
53876ba94429SFrederic Weisbecker 	if (!attrs)
53886ba94429SFrederic Weisbecker 		return NULL;
53896ba94429SFrederic Weisbecker 
53906ba94429SFrederic Weisbecker 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
53916ba94429SFrederic Weisbecker 	return attrs;
53926ba94429SFrederic Weisbecker }
53936ba94429SFrederic Weisbecker 
53946ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
53956ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
53966ba94429SFrederic Weisbecker {
53976ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53986ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5399d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
5400d4d3e257SLai Jiangshan 
5401d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
54026ba94429SFrederic Weisbecker 
54036ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
54046ba94429SFrederic Weisbecker 	if (!attrs)
5405d4d3e257SLai Jiangshan 		goto out_unlock;
54066ba94429SFrederic Weisbecker 
54076ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
54086ba94429SFrederic Weisbecker 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
5409d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
54106ba94429SFrederic Weisbecker 	else
54116ba94429SFrederic Weisbecker 		ret = -EINVAL;
54126ba94429SFrederic Weisbecker 
5413d4d3e257SLai Jiangshan out_unlock:
5414d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
54156ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
54166ba94429SFrederic Weisbecker 	return ret ?: count;
54176ba94429SFrederic Weisbecker }
54186ba94429SFrederic Weisbecker 
54196ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev,
54206ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
54216ba94429SFrederic Weisbecker {
54226ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54236ba94429SFrederic Weisbecker 	int written;
54246ba94429SFrederic Weisbecker 
54256ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
54266ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
54276ba94429SFrederic Weisbecker 			    cpumask_pr_args(wq->unbound_attrs->cpumask));
54286ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
54296ba94429SFrederic Weisbecker 	return written;
54306ba94429SFrederic Weisbecker }
54316ba94429SFrederic Weisbecker 
54326ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev,
54336ba94429SFrederic Weisbecker 				struct device_attribute *attr,
54346ba94429SFrederic Weisbecker 				const char *buf, size_t count)
54356ba94429SFrederic Weisbecker {
54366ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54376ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5438d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
5439d4d3e257SLai Jiangshan 
5440d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
54416ba94429SFrederic Weisbecker 
54426ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
54436ba94429SFrederic Weisbecker 	if (!attrs)
5444d4d3e257SLai Jiangshan 		goto out_unlock;
54456ba94429SFrederic Weisbecker 
54466ba94429SFrederic Weisbecker 	ret = cpumask_parse(buf, attrs->cpumask);
54476ba94429SFrederic Weisbecker 	if (!ret)
5448d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
54496ba94429SFrederic Weisbecker 
5450d4d3e257SLai Jiangshan out_unlock:
5451d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
54526ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
54536ba94429SFrederic Weisbecker 	return ret ?: count;
54546ba94429SFrederic Weisbecker }
54556ba94429SFrederic Weisbecker 
54566ba94429SFrederic Weisbecker static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
54576ba94429SFrederic Weisbecker 			    char *buf)
54586ba94429SFrederic Weisbecker {
54596ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54606ba94429SFrederic Weisbecker 	int written;
54616ba94429SFrederic Weisbecker 
54626ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
54636ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n",
54646ba94429SFrederic Weisbecker 			    !wq->unbound_attrs->no_numa);
54656ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
54666ba94429SFrederic Weisbecker 
54676ba94429SFrederic Weisbecker 	return written;
54686ba94429SFrederic Weisbecker }
54696ba94429SFrederic Weisbecker 
54706ba94429SFrederic Weisbecker static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
54716ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
54726ba94429SFrederic Weisbecker {
54736ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54746ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5475d4d3e257SLai Jiangshan 	int v, ret = -ENOMEM;
5476d4d3e257SLai Jiangshan 
5477d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
54786ba94429SFrederic Weisbecker 
54796ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
54806ba94429SFrederic Weisbecker 	if (!attrs)
5481d4d3e257SLai Jiangshan 		goto out_unlock;
54826ba94429SFrederic Weisbecker 
54836ba94429SFrederic Weisbecker 	ret = -EINVAL;
54846ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &v) == 1) {
54856ba94429SFrederic Weisbecker 		attrs->no_numa = !v;
5486d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
54876ba94429SFrederic Weisbecker 	}
54886ba94429SFrederic Weisbecker 
5489d4d3e257SLai Jiangshan out_unlock:
5490d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
54916ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
54926ba94429SFrederic Weisbecker 	return ret ?: count;
54936ba94429SFrederic Weisbecker }
54946ba94429SFrederic Weisbecker 
54956ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = {
54966ba94429SFrederic Weisbecker 	__ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
54976ba94429SFrederic Weisbecker 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
54986ba94429SFrederic Weisbecker 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
54996ba94429SFrederic Weisbecker 	__ATTR(numa, 0644, wq_numa_show, wq_numa_store),
55006ba94429SFrederic Weisbecker 	__ATTR_NULL,
55016ba94429SFrederic Weisbecker };
55026ba94429SFrederic Weisbecker 
55036ba94429SFrederic Weisbecker static struct bus_type wq_subsys = {
55046ba94429SFrederic Weisbecker 	.name				= "workqueue",
55056ba94429SFrederic Weisbecker 	.dev_groups			= wq_sysfs_groups,
55066ba94429SFrederic Weisbecker };
55076ba94429SFrederic Weisbecker 
5508b05a7928SFrederic Weisbecker static ssize_t wq_unbound_cpumask_show(struct device *dev,
5509b05a7928SFrederic Weisbecker 		struct device_attribute *attr, char *buf)
5510b05a7928SFrederic Weisbecker {
5511b05a7928SFrederic Weisbecker 	int written;
5512b05a7928SFrederic Weisbecker 
5513042f7df1SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5514b05a7928SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5515b05a7928SFrederic Weisbecker 			    cpumask_pr_args(wq_unbound_cpumask));
5516042f7df1SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5517b05a7928SFrederic Weisbecker 
5518b05a7928SFrederic Weisbecker 	return written;
5519b05a7928SFrederic Weisbecker }
5520b05a7928SFrederic Weisbecker 
5521042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev,
5522042f7df1SLai Jiangshan 		struct device_attribute *attr, const char *buf, size_t count)
5523042f7df1SLai Jiangshan {
5524042f7df1SLai Jiangshan 	cpumask_var_t cpumask;
5525042f7df1SLai Jiangshan 	int ret;
5526042f7df1SLai Jiangshan 
5527042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5528042f7df1SLai Jiangshan 		return -ENOMEM;
5529042f7df1SLai Jiangshan 
5530042f7df1SLai Jiangshan 	ret = cpumask_parse(buf, cpumask);
5531042f7df1SLai Jiangshan 	if (!ret)
5532042f7df1SLai Jiangshan 		ret = workqueue_set_unbound_cpumask(cpumask);
5533042f7df1SLai Jiangshan 
5534042f7df1SLai Jiangshan 	free_cpumask_var(cpumask);
5535042f7df1SLai Jiangshan 	return ret ? ret : count;
5536042f7df1SLai Jiangshan }
5537042f7df1SLai Jiangshan 
5538b05a7928SFrederic Weisbecker static struct device_attribute wq_sysfs_cpumask_attr =
5539042f7df1SLai Jiangshan 	__ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5540042f7df1SLai Jiangshan 	       wq_unbound_cpumask_store);
5541b05a7928SFrederic Weisbecker 
55426ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void)
55436ba94429SFrederic Weisbecker {
5544b05a7928SFrederic Weisbecker 	int err;
5545b05a7928SFrederic Weisbecker 
5546b05a7928SFrederic Weisbecker 	err = subsys_virtual_register(&wq_subsys, NULL);
5547b05a7928SFrederic Weisbecker 	if (err)
5548b05a7928SFrederic Weisbecker 		return err;
5549b05a7928SFrederic Weisbecker 
5550b05a7928SFrederic Weisbecker 	return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
55516ba94429SFrederic Weisbecker }
55526ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init);
55536ba94429SFrederic Weisbecker 
55546ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev)
55556ba94429SFrederic Weisbecker {
55566ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
55576ba94429SFrederic Weisbecker 
55586ba94429SFrederic Weisbecker 	kfree(wq_dev);
55596ba94429SFrederic Weisbecker }
55606ba94429SFrederic Weisbecker 
55616ba94429SFrederic Weisbecker /**
55626ba94429SFrederic Weisbecker  * workqueue_sysfs_register - make a workqueue visible in sysfs
55636ba94429SFrederic Weisbecker  * @wq: the workqueue to register
55646ba94429SFrederic Weisbecker  *
55656ba94429SFrederic Weisbecker  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
55666ba94429SFrederic Weisbecker  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
55676ba94429SFrederic Weisbecker  * which is the preferred method.
55686ba94429SFrederic Weisbecker  *
55696ba94429SFrederic Weisbecker  * Workqueue user should use this function directly iff it wants to apply
55706ba94429SFrederic Weisbecker  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
55716ba94429SFrederic Weisbecker  * apply_workqueue_attrs() may race against userland updating the
55726ba94429SFrederic Weisbecker  * attributes.
55736ba94429SFrederic Weisbecker  *
55746ba94429SFrederic Weisbecker  * Return: 0 on success, -errno on failure.
55756ba94429SFrederic Weisbecker  */
55766ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq)
55776ba94429SFrederic Weisbecker {
55786ba94429SFrederic Weisbecker 	struct wq_device *wq_dev;
55796ba94429SFrederic Weisbecker 	int ret;
55806ba94429SFrederic Weisbecker 
55816ba94429SFrederic Weisbecker 	/*
5582402dd89dSShailendra Verma 	 * Adjusting max_active or creating new pwqs by applying
55836ba94429SFrederic Weisbecker 	 * attributes breaks ordering guarantee.  Disallow exposing ordered
55846ba94429SFrederic Weisbecker 	 * workqueues.
55856ba94429SFrederic Weisbecker 	 */
55860a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
55876ba94429SFrederic Weisbecker 		return -EINVAL;
55886ba94429SFrederic Weisbecker 
55896ba94429SFrederic Weisbecker 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
55906ba94429SFrederic Weisbecker 	if (!wq_dev)
55916ba94429SFrederic Weisbecker 		return -ENOMEM;
55926ba94429SFrederic Weisbecker 
55936ba94429SFrederic Weisbecker 	wq_dev->wq = wq;
55946ba94429SFrederic Weisbecker 	wq_dev->dev.bus = &wq_subsys;
55956ba94429SFrederic Weisbecker 	wq_dev->dev.release = wq_device_release;
559623217b44SLars-Peter Clausen 	dev_set_name(&wq_dev->dev, "%s", wq->name);
55976ba94429SFrederic Weisbecker 
55986ba94429SFrederic Weisbecker 	/*
55996ba94429SFrederic Weisbecker 	 * unbound_attrs are created separately.  Suppress uevent until
56006ba94429SFrederic Weisbecker 	 * everything is ready.
56016ba94429SFrederic Weisbecker 	 */
56026ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, true);
56036ba94429SFrederic Weisbecker 
56046ba94429SFrederic Weisbecker 	ret = device_register(&wq_dev->dev);
56056ba94429SFrederic Weisbecker 	if (ret) {
5606537f4146SArvind Yadav 		put_device(&wq_dev->dev);
56076ba94429SFrederic Weisbecker 		wq->wq_dev = NULL;
56086ba94429SFrederic Weisbecker 		return ret;
56096ba94429SFrederic Weisbecker 	}
56106ba94429SFrederic Weisbecker 
56116ba94429SFrederic Weisbecker 	if (wq->flags & WQ_UNBOUND) {
56126ba94429SFrederic Weisbecker 		struct device_attribute *attr;
56136ba94429SFrederic Weisbecker 
56146ba94429SFrederic Weisbecker 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
56156ba94429SFrederic Weisbecker 			ret = device_create_file(&wq_dev->dev, attr);
56166ba94429SFrederic Weisbecker 			if (ret) {
56176ba94429SFrederic Weisbecker 				device_unregister(&wq_dev->dev);
56186ba94429SFrederic Weisbecker 				wq->wq_dev = NULL;
56196ba94429SFrederic Weisbecker 				return ret;
56206ba94429SFrederic Weisbecker 			}
56216ba94429SFrederic Weisbecker 		}
56226ba94429SFrederic Weisbecker 	}
56236ba94429SFrederic Weisbecker 
56246ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, false);
56256ba94429SFrederic Weisbecker 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
56266ba94429SFrederic Weisbecker 	return 0;
56276ba94429SFrederic Weisbecker }
56286ba94429SFrederic Weisbecker 
56296ba94429SFrederic Weisbecker /**
56306ba94429SFrederic Weisbecker  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
56316ba94429SFrederic Weisbecker  * @wq: the workqueue to unregister
56326ba94429SFrederic Weisbecker  *
56336ba94429SFrederic Weisbecker  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
56346ba94429SFrederic Weisbecker  */
56356ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
56366ba94429SFrederic Weisbecker {
56376ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = wq->wq_dev;
56386ba94429SFrederic Weisbecker 
56396ba94429SFrederic Weisbecker 	if (!wq->wq_dev)
56406ba94429SFrederic Weisbecker 		return;
56416ba94429SFrederic Weisbecker 
56426ba94429SFrederic Weisbecker 	wq->wq_dev = NULL;
56436ba94429SFrederic Weisbecker 	device_unregister(&wq_dev->dev);
56446ba94429SFrederic Weisbecker }
56456ba94429SFrederic Weisbecker #else	/* CONFIG_SYSFS */
56466ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
56476ba94429SFrederic Weisbecker #endif	/* CONFIG_SYSFS */
56486ba94429SFrederic Weisbecker 
564982607adcSTejun Heo /*
565082607adcSTejun Heo  * Workqueue watchdog.
565182607adcSTejun Heo  *
565282607adcSTejun Heo  * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
565382607adcSTejun Heo  * flush dependency, a concurrency managed work item which stays RUNNING
565482607adcSTejun Heo  * indefinitely.  Workqueue stalls can be very difficult to debug as the
565582607adcSTejun Heo  * usual warning mechanisms don't trigger and internal workqueue state is
565682607adcSTejun Heo  * largely opaque.
565782607adcSTejun Heo  *
565882607adcSTejun Heo  * Workqueue watchdog monitors all worker pools periodically and dumps
565982607adcSTejun Heo  * state if some pools failed to make forward progress for a while where
566082607adcSTejun Heo  * forward progress is defined as the first item on ->worklist changing.
566182607adcSTejun Heo  *
566282607adcSTejun Heo  * This mechanism is controlled through the kernel parameter
566382607adcSTejun Heo  * "workqueue.watchdog_thresh" which can be updated at runtime through the
566482607adcSTejun Heo  * corresponding sysfs parameter file.
566582607adcSTejun Heo  */
566682607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG
566782607adcSTejun Heo 
566882607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30;
56695cd79d6aSKees Cook static struct timer_list wq_watchdog_timer;
567082607adcSTejun Heo 
567182607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
567282607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
567382607adcSTejun Heo 
567482607adcSTejun Heo static void wq_watchdog_reset_touched(void)
567582607adcSTejun Heo {
567682607adcSTejun Heo 	int cpu;
567782607adcSTejun Heo 
567882607adcSTejun Heo 	wq_watchdog_touched = jiffies;
567982607adcSTejun Heo 	for_each_possible_cpu(cpu)
568082607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
568182607adcSTejun Heo }
568282607adcSTejun Heo 
56835cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused)
568482607adcSTejun Heo {
568582607adcSTejun Heo 	unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
568682607adcSTejun Heo 	bool lockup_detected = false;
568782607adcSTejun Heo 	struct worker_pool *pool;
568882607adcSTejun Heo 	int pi;
568982607adcSTejun Heo 
569082607adcSTejun Heo 	if (!thresh)
569182607adcSTejun Heo 		return;
569282607adcSTejun Heo 
569382607adcSTejun Heo 	rcu_read_lock();
569482607adcSTejun Heo 
569582607adcSTejun Heo 	for_each_pool(pool, pi) {
569682607adcSTejun Heo 		unsigned long pool_ts, touched, ts;
569782607adcSTejun Heo 
569882607adcSTejun Heo 		if (list_empty(&pool->worklist))
569982607adcSTejun Heo 			continue;
570082607adcSTejun Heo 
570182607adcSTejun Heo 		/* get the latest of pool and touched timestamps */
570282607adcSTejun Heo 		pool_ts = READ_ONCE(pool->watchdog_ts);
570382607adcSTejun Heo 		touched = READ_ONCE(wq_watchdog_touched);
570482607adcSTejun Heo 
570582607adcSTejun Heo 		if (time_after(pool_ts, touched))
570682607adcSTejun Heo 			ts = pool_ts;
570782607adcSTejun Heo 		else
570882607adcSTejun Heo 			ts = touched;
570982607adcSTejun Heo 
571082607adcSTejun Heo 		if (pool->cpu >= 0) {
571182607adcSTejun Heo 			unsigned long cpu_touched =
571282607adcSTejun Heo 				READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
571382607adcSTejun Heo 						  pool->cpu));
571482607adcSTejun Heo 			if (time_after(cpu_touched, ts))
571582607adcSTejun Heo 				ts = cpu_touched;
571682607adcSTejun Heo 		}
571782607adcSTejun Heo 
571882607adcSTejun Heo 		/* did we stall? */
571982607adcSTejun Heo 		if (time_after(jiffies, ts + thresh)) {
572082607adcSTejun Heo 			lockup_detected = true;
572182607adcSTejun Heo 			pr_emerg("BUG: workqueue lockup - pool");
572282607adcSTejun Heo 			pr_cont_pool_info(pool);
572382607adcSTejun Heo 			pr_cont(" stuck for %us!\n",
572482607adcSTejun Heo 				jiffies_to_msecs(jiffies - pool_ts) / 1000);
572582607adcSTejun Heo 		}
572682607adcSTejun Heo 	}
572782607adcSTejun Heo 
572882607adcSTejun Heo 	rcu_read_unlock();
572982607adcSTejun Heo 
573082607adcSTejun Heo 	if (lockup_detected)
573182607adcSTejun Heo 		show_workqueue_state();
573282607adcSTejun Heo 
573382607adcSTejun Heo 	wq_watchdog_reset_touched();
573482607adcSTejun Heo 	mod_timer(&wq_watchdog_timer, jiffies + thresh);
573582607adcSTejun Heo }
573682607adcSTejun Heo 
5737cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu)
573882607adcSTejun Heo {
573982607adcSTejun Heo 	if (cpu >= 0)
574082607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
574182607adcSTejun Heo 	else
574282607adcSTejun Heo 		wq_watchdog_touched = jiffies;
574382607adcSTejun Heo }
574482607adcSTejun Heo 
574582607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh)
574682607adcSTejun Heo {
574782607adcSTejun Heo 	wq_watchdog_thresh = 0;
574882607adcSTejun Heo 	del_timer_sync(&wq_watchdog_timer);
574982607adcSTejun Heo 
575082607adcSTejun Heo 	if (thresh) {
575182607adcSTejun Heo 		wq_watchdog_thresh = thresh;
575282607adcSTejun Heo 		wq_watchdog_reset_touched();
575382607adcSTejun Heo 		mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
575482607adcSTejun Heo 	}
575582607adcSTejun Heo }
575682607adcSTejun Heo 
575782607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val,
575882607adcSTejun Heo 					const struct kernel_param *kp)
575982607adcSTejun Heo {
576082607adcSTejun Heo 	unsigned long thresh;
576182607adcSTejun Heo 	int ret;
576282607adcSTejun Heo 
576382607adcSTejun Heo 	ret = kstrtoul(val, 0, &thresh);
576482607adcSTejun Heo 	if (ret)
576582607adcSTejun Heo 		return ret;
576682607adcSTejun Heo 
576782607adcSTejun Heo 	if (system_wq)
576882607adcSTejun Heo 		wq_watchdog_set_thresh(thresh);
576982607adcSTejun Heo 	else
577082607adcSTejun Heo 		wq_watchdog_thresh = thresh;
577182607adcSTejun Heo 
577282607adcSTejun Heo 	return 0;
577382607adcSTejun Heo }
577482607adcSTejun Heo 
577582607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = {
577682607adcSTejun Heo 	.set	= wq_watchdog_param_set_thresh,
577782607adcSTejun Heo 	.get	= param_get_ulong,
577882607adcSTejun Heo };
577982607adcSTejun Heo 
578082607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
578182607adcSTejun Heo 		0644);
578282607adcSTejun Heo 
578382607adcSTejun Heo static void wq_watchdog_init(void)
578482607adcSTejun Heo {
57855cd79d6aSKees Cook 	timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
578682607adcSTejun Heo 	wq_watchdog_set_thresh(wq_watchdog_thresh);
578782607adcSTejun Heo }
578882607adcSTejun Heo 
578982607adcSTejun Heo #else	/* CONFIG_WQ_WATCHDOG */
579082607adcSTejun Heo 
579182607adcSTejun Heo static inline void wq_watchdog_init(void) { }
579282607adcSTejun Heo 
579382607adcSTejun Heo #endif	/* CONFIG_WQ_WATCHDOG */
579482607adcSTejun Heo 
5795bce90380STejun Heo static void __init wq_numa_init(void)
5796bce90380STejun Heo {
5797bce90380STejun Heo 	cpumask_var_t *tbl;
5798bce90380STejun Heo 	int node, cpu;
5799bce90380STejun Heo 
5800bce90380STejun Heo 	if (num_possible_nodes() <= 1)
5801bce90380STejun Heo 		return;
5802bce90380STejun Heo 
5803d55262c4STejun Heo 	if (wq_disable_numa) {
5804d55262c4STejun Heo 		pr_info("workqueue: NUMA affinity support disabled\n");
5805d55262c4STejun Heo 		return;
5806d55262c4STejun Heo 	}
5807d55262c4STejun Heo 
58084c16bd32STejun Heo 	wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
58094c16bd32STejun Heo 	BUG_ON(!wq_update_unbound_numa_attrs_buf);
58104c16bd32STejun Heo 
5811bce90380STejun Heo 	/*
5812bce90380STejun Heo 	 * We want masks of possible CPUs of each node which isn't readily
5813bce90380STejun Heo 	 * available.  Build one from cpu_to_node() which should have been
5814bce90380STejun Heo 	 * fully initialized by now.
5815bce90380STejun Heo 	 */
58166396bb22SKees Cook 	tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
5817bce90380STejun Heo 	BUG_ON(!tbl);
5818bce90380STejun Heo 
5819bce90380STejun Heo 	for_each_node(node)
58205a6024f1SYasuaki Ishimatsu 		BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
58211be0c25dSTejun Heo 				node_online(node) ? node : NUMA_NO_NODE));
5822bce90380STejun Heo 
5823bce90380STejun Heo 	for_each_possible_cpu(cpu) {
5824bce90380STejun Heo 		node = cpu_to_node(cpu);
5825bce90380STejun Heo 		if (WARN_ON(node == NUMA_NO_NODE)) {
5826bce90380STejun Heo 			pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5827bce90380STejun Heo 			/* happens iff arch is bonkers, let's just proceed */
5828bce90380STejun Heo 			return;
5829bce90380STejun Heo 		}
5830bce90380STejun Heo 		cpumask_set_cpu(cpu, tbl[node]);
5831bce90380STejun Heo 	}
5832bce90380STejun Heo 
5833bce90380STejun Heo 	wq_numa_possible_cpumask = tbl;
5834bce90380STejun Heo 	wq_numa_enabled = true;
5835bce90380STejun Heo }
5836bce90380STejun Heo 
58373347fa09STejun Heo /**
58383347fa09STejun Heo  * workqueue_init_early - early init for workqueue subsystem
58393347fa09STejun Heo  *
58403347fa09STejun Heo  * This is the first half of two-staged workqueue subsystem initialization
58413347fa09STejun Heo  * and invoked as soon as the bare basics - memory allocation, cpumasks and
58423347fa09STejun Heo  * idr are up.  It sets up all the data structures and system workqueues
58433347fa09STejun Heo  * and allows early boot code to create workqueues and queue/cancel work
58443347fa09STejun Heo  * items.  Actual work item execution starts only after kthreads can be
58453347fa09STejun Heo  * created and scheduled right before early initcalls.
58463347fa09STejun Heo  */
58473347fa09STejun Heo int __init workqueue_init_early(void)
58481da177e4SLinus Torvalds {
58497a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
58501bda3f80SFrederic Weisbecker 	int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
58517a4e344cSTejun Heo 	int i, cpu;
5852c34056a3STejun Heo 
5853e904e6c2STejun Heo 	WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5854e904e6c2STejun Heo 
5855b05a7928SFrederic Weisbecker 	BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
58561bda3f80SFrederic Weisbecker 	cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
5857b05a7928SFrederic Weisbecker 
5858e904e6c2STejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5859e904e6c2STejun Heo 
5860706026c2STejun Heo 	/* initialize CPU pools */
586129c91e99STejun Heo 	for_each_possible_cpu(cpu) {
58624ce62e9eSTejun Heo 		struct worker_pool *pool;
58638b03ae3cSTejun Heo 
58647a4e344cSTejun Heo 		i = 0;
5865f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
58667a4e344cSTejun Heo 			BUG_ON(init_worker_pool(pool));
5867ec22ca5eSTejun Heo 			pool->cpu = cpu;
58687a4e344cSTejun Heo 			cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
58697a4e344cSTejun Heo 			pool->attrs->nice = std_nice[i++];
5870f3f90ad4STejun Heo 			pool->node = cpu_to_node(cpu);
58717a4e344cSTejun Heo 
58729daf9e67STejun Heo 			/* alloc pool ID */
587368e13a67SLai Jiangshan 			mutex_lock(&wq_pool_mutex);
58749daf9e67STejun Heo 			BUG_ON(worker_pool_assign_id(pool));
587568e13a67SLai Jiangshan 			mutex_unlock(&wq_pool_mutex);
58764ce62e9eSTejun Heo 		}
58778b03ae3cSTejun Heo 	}
58788b03ae3cSTejun Heo 
58798a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
588029c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
588129c91e99STejun Heo 		struct workqueue_attrs *attrs;
588229c91e99STejun Heo 
588329c91e99STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
588429c91e99STejun Heo 		attrs->nice = std_nice[i];
588529c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
58868a2b7538STejun Heo 
58878a2b7538STejun Heo 		/*
58888a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
58898a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
58908a2b7538STejun Heo 		 * Turn off NUMA so that dfl_pwq is used for all nodes.
58918a2b7538STejun Heo 		 */
58928a2b7538STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
58938a2b7538STejun Heo 		attrs->nice = std_nice[i];
58948a2b7538STejun Heo 		attrs->no_numa = true;
58958a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
589629c91e99STejun Heo 	}
589729c91e99STejun Heo 
5898d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
58991aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
5900d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
5901f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5902f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
590324d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
590424d51addSTejun Heo 					      WQ_FREEZABLE, 0);
59050668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
59060668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
59070668106cSViresh Kumar 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
59080668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
59090668106cSViresh Kumar 					      0);
59101aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
59110668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
59120668106cSViresh Kumar 	       !system_power_efficient_wq ||
59130668106cSViresh Kumar 	       !system_freezable_power_efficient_wq);
591482607adcSTejun Heo 
59153347fa09STejun Heo 	return 0;
59163347fa09STejun Heo }
59173347fa09STejun Heo 
59183347fa09STejun Heo /**
59193347fa09STejun Heo  * workqueue_init - bring workqueue subsystem fully online
59203347fa09STejun Heo  *
59213347fa09STejun Heo  * This is the latter half of two-staged workqueue subsystem initialization
59223347fa09STejun Heo  * and invoked as soon as kthreads can be created and scheduled.
59233347fa09STejun Heo  * Workqueues have been created and work items queued on them, but there
59243347fa09STejun Heo  * are no kworkers executing the work items yet.  Populate the worker pools
59253347fa09STejun Heo  * with the initial workers and enable future kworker creations.
59263347fa09STejun Heo  */
59273347fa09STejun Heo int __init workqueue_init(void)
59283347fa09STejun Heo {
59292186d9f9STejun Heo 	struct workqueue_struct *wq;
59303347fa09STejun Heo 	struct worker_pool *pool;
59313347fa09STejun Heo 	int cpu, bkt;
59323347fa09STejun Heo 
59332186d9f9STejun Heo 	/*
59342186d9f9STejun Heo 	 * It'd be simpler to initialize NUMA in workqueue_init_early() but
59352186d9f9STejun Heo 	 * CPU to node mapping may not be available that early on some
59362186d9f9STejun Heo 	 * archs such as power and arm64.  As per-cpu pools created
59372186d9f9STejun Heo 	 * previously could be missing node hint and unbound pools NUMA
59382186d9f9STejun Heo 	 * affinity, fix them up.
593940c17f75STejun Heo 	 *
594040c17f75STejun Heo 	 * Also, while iterating workqueues, create rescuers if requested.
59412186d9f9STejun Heo 	 */
59422186d9f9STejun Heo 	wq_numa_init();
59432186d9f9STejun Heo 
59442186d9f9STejun Heo 	mutex_lock(&wq_pool_mutex);
59452186d9f9STejun Heo 
59462186d9f9STejun Heo 	for_each_possible_cpu(cpu) {
59472186d9f9STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
59482186d9f9STejun Heo 			pool->node = cpu_to_node(cpu);
59492186d9f9STejun Heo 		}
59502186d9f9STejun Heo 	}
59512186d9f9STejun Heo 
595240c17f75STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
59532186d9f9STejun Heo 		wq_update_unbound_numa(wq, smp_processor_id(), true);
595440c17f75STejun Heo 		WARN(init_rescuer(wq),
595540c17f75STejun Heo 		     "workqueue: failed to create early rescuer for %s",
595640c17f75STejun Heo 		     wq->name);
595740c17f75STejun Heo 	}
59582186d9f9STejun Heo 
59592186d9f9STejun Heo 	mutex_unlock(&wq_pool_mutex);
59602186d9f9STejun Heo 
59613347fa09STejun Heo 	/* create the initial workers */
59623347fa09STejun Heo 	for_each_online_cpu(cpu) {
59633347fa09STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
59643347fa09STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
59653347fa09STejun Heo 			BUG_ON(!create_worker(pool));
59663347fa09STejun Heo 		}
59673347fa09STejun Heo 	}
59683347fa09STejun Heo 
59693347fa09STejun Heo 	hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
59703347fa09STejun Heo 		BUG_ON(!create_worker(pool));
59713347fa09STejun Heo 
59723347fa09STejun Heo 	wq_online = true;
597382607adcSTejun Heo 	wq_watchdog_init();
597482607adcSTejun Heo 
59756ee0578bSSuresh Siddha 	return 0;
59761da177e4SLinus Torvalds }
5977