xref: /linux-6.15/kernel/workqueue.c (revision 24acfb71)
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  *
130*24acfb71SThomas Gleixner  * PR: wq_pool_mutex protected for writes.  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
135*24acfb71SThomas Gleixner  *      RCU for reads.
1365b95e1afSLai Jiangshan  *
1373c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1383c25a55dSLai Jiangshan  *
139*24acfb71SThomas Gleixner  * WR: wq->mutex protected for writes.  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 	/*
186*24acfb71SThomas Gleixner 	 * Destruction of pool is 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
215*24acfb71SThomas Gleixner 	 * itself is also 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 	/*
269*24acfb71SThomas Gleixner 	 * Destruction of workqueue_struct is RCU protected to allow walking
270*24acfb71SThomas Gleixner 	 * 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()					\
362*24acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
363f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
364*24acfb71SThomas Gleixner 			 "RCU or wq_pool_mutex should be held")
3655bcab335STejun Heo 
366b09f4fd3SLai Jiangshan #define assert_rcu_or_wq_mutex(wq)					\
367*24acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
368f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex),			\
369*24acfb71SThomas Gleixner 			 "RCU or wq->mutex should be held")
37076af4d93STejun Heo 
3715b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)			\
372*24acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
373f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex) &&		\
374f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
375*24acfb71SThomas Gleixner 			 "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  *
387*24acfb71SThomas Gleixner  * This must be called either with wq_pool_mutex held or 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  *
419*24acfb71SThomas Gleixner  * This must be called either with wq->mutex held or 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  *
555*24acfb71SThomas Gleixner  * This must be called with any of wq_pool_mutex, wq->mutex or 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
699*24acfb71SThomas Gleixner  * access under RCU read lock.  As such, this function should be
700*24acfb71SThomas Gleixner  * called under wq_pool_mutex or inside of a rcu_read_lock() region.
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 /**
844e22bee78STejun Heo  * wq_worker_waking_up - a worker is waking up
845e22bee78STejun Heo  * @task: task waking up
846e22bee78STejun Heo  * @cpu: CPU @task is waking up to
847e22bee78STejun Heo  *
848e22bee78STejun Heo  * This function is called during try_to_wake_up() when a worker is
849e22bee78STejun Heo  * being awoken.
850e22bee78STejun Heo  *
851e22bee78STejun Heo  * CONTEXT:
852e22bee78STejun Heo  * spin_lock_irq(rq->lock)
853e22bee78STejun Heo  */
854d84ff051STejun Heo void wq_worker_waking_up(struct task_struct *task, int cpu)
855e22bee78STejun Heo {
856e22bee78STejun Heo 	struct worker *worker = kthread_data(task);
857e22bee78STejun Heo 
85836576000SJoonsoo Kim 	if (!(worker->flags & WORKER_NOT_RUNNING)) {
859ec22ca5eSTejun Heo 		WARN_ON_ONCE(worker->pool->cpu != cpu);
860e19e397aSTejun Heo 		atomic_inc(&worker->pool->nr_running);
861e22bee78STejun Heo 	}
86236576000SJoonsoo Kim }
863e22bee78STejun Heo 
864e22bee78STejun Heo /**
865e22bee78STejun Heo  * wq_worker_sleeping - a worker is going to sleep
866e22bee78STejun Heo  * @task: task going to sleep
867e22bee78STejun Heo  *
868e22bee78STejun Heo  * This function is called during schedule() when a busy worker is
869e22bee78STejun Heo  * going to sleep.  Worker on the same cpu can be woken up by
870e22bee78STejun Heo  * returning pointer to its task.
871e22bee78STejun Heo  *
872e22bee78STejun Heo  * CONTEXT:
873e22bee78STejun Heo  * spin_lock_irq(rq->lock)
874e22bee78STejun Heo  *
875d185af30SYacine Belkadi  * Return:
876e22bee78STejun Heo  * Worker task on @cpu to wake up, %NULL if none.
877e22bee78STejun Heo  */
8789b7f6597SAlexander Gordeev struct task_struct *wq_worker_sleeping(struct task_struct *task)
879e22bee78STejun Heo {
880e22bee78STejun Heo 	struct worker *worker = kthread_data(task), *to_wakeup = NULL;
881111c225aSTejun Heo 	struct worker_pool *pool;
882e22bee78STejun Heo 
883111c225aSTejun Heo 	/*
884111c225aSTejun Heo 	 * Rescuers, which may not have all the fields set up like normal
885111c225aSTejun Heo 	 * workers, also reach here, let's not access anything before
886111c225aSTejun Heo 	 * checking NOT_RUNNING.
887111c225aSTejun Heo 	 */
8882d64672eSSteven Rostedt 	if (worker->flags & WORKER_NOT_RUNNING)
889e22bee78STejun Heo 		return NULL;
890e22bee78STejun Heo 
891111c225aSTejun Heo 	pool = worker->pool;
892111c225aSTejun Heo 
893e22bee78STejun Heo 	/* this can only happen on the local cpu */
8949b7f6597SAlexander Gordeev 	if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
8956183c009STejun Heo 		return NULL;
896e22bee78STejun Heo 
897e22bee78STejun Heo 	/*
898e22bee78STejun Heo 	 * The counterpart of the following dec_and_test, implied mb,
899e22bee78STejun Heo 	 * worklist not empty test sequence is in insert_work().
900e22bee78STejun Heo 	 * Please read comment there.
901e22bee78STejun Heo 	 *
902628c78e7STejun Heo 	 * NOT_RUNNING is clear.  This means that we're bound to and
903628c78e7STejun Heo 	 * running on the local cpu w/ rq lock held and preemption
904628c78e7STejun Heo 	 * disabled, which in turn means that none else could be
905d565ed63STejun Heo 	 * manipulating idle_list, so dereferencing idle_list without pool
906628c78e7STejun Heo 	 * lock is safe.
907e22bee78STejun Heo 	 */
908e19e397aSTejun Heo 	if (atomic_dec_and_test(&pool->nr_running) &&
909e19e397aSTejun Heo 	    !list_empty(&pool->worklist))
9101037de36SLai Jiangshan 		to_wakeup = first_idle_worker(pool);
911e22bee78STejun Heo 	return to_wakeup ? to_wakeup->task : NULL;
912e22bee78STejun Heo }
913e22bee78STejun Heo 
914e22bee78STejun Heo /**
9151b69ac6bSJohannes Weiner  * wq_worker_last_func - retrieve worker's last work function
9168194fe94SBart Van Assche  * @task: Task to retrieve last work function of.
9171b69ac6bSJohannes Weiner  *
9181b69ac6bSJohannes Weiner  * Determine the last function a worker executed. This is called from
9191b69ac6bSJohannes Weiner  * the scheduler to get a worker's last known identity.
9201b69ac6bSJohannes Weiner  *
9211b69ac6bSJohannes Weiner  * CONTEXT:
9221b69ac6bSJohannes Weiner  * spin_lock_irq(rq->lock)
9231b69ac6bSJohannes Weiner  *
9244b047002SJohannes Weiner  * This function is called during schedule() when a kworker is going
9254b047002SJohannes Weiner  * to sleep. It's used by psi to identify aggregation workers during
9264b047002SJohannes Weiner  * dequeuing, to allow periodic aggregation to shut-off when that
9274b047002SJohannes Weiner  * worker is the last task in the system or cgroup to go to sleep.
9284b047002SJohannes Weiner  *
9294b047002SJohannes Weiner  * As this function doesn't involve any workqueue-related locking, it
9304b047002SJohannes Weiner  * only returns stable values when called from inside the scheduler's
9314b047002SJohannes Weiner  * queuing and dequeuing paths, when @task, which must be a kworker,
9324b047002SJohannes Weiner  * is guaranteed to not be processing any works.
9334b047002SJohannes Weiner  *
9341b69ac6bSJohannes Weiner  * Return:
9351b69ac6bSJohannes Weiner  * The last work function %current executed as a worker, NULL if it
9361b69ac6bSJohannes Weiner  * hasn't executed any work yet.
9371b69ac6bSJohannes Weiner  */
9381b69ac6bSJohannes Weiner work_func_t wq_worker_last_func(struct task_struct *task)
9391b69ac6bSJohannes Weiner {
9401b69ac6bSJohannes Weiner 	struct worker *worker = kthread_data(task);
9411b69ac6bSJohannes Weiner 
9421b69ac6bSJohannes Weiner 	return worker->last_func;
9431b69ac6bSJohannes Weiner }
9441b69ac6bSJohannes Weiner 
9451b69ac6bSJohannes Weiner /**
946e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
947cb444766STejun Heo  * @worker: self
948d302f017STejun Heo  * @flags: flags to set
949d302f017STejun Heo  *
950228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
951d302f017STejun Heo  *
952cb444766STejun Heo  * CONTEXT:
953d565ed63STejun Heo  * spin_lock_irq(pool->lock)
954d302f017STejun Heo  */
955228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
956d302f017STejun Heo {
957bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
958e22bee78STejun Heo 
959cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
960cb444766STejun Heo 
961228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
962e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
963e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
964e19e397aSTejun Heo 		atomic_dec(&pool->nr_running);
965e22bee78STejun Heo 	}
966e22bee78STejun Heo 
967d302f017STejun Heo 	worker->flags |= flags;
968d302f017STejun Heo }
969d302f017STejun Heo 
970d302f017STejun Heo /**
971e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
972cb444766STejun Heo  * @worker: self
973d302f017STejun Heo  * @flags: flags to clear
974d302f017STejun Heo  *
975e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
976d302f017STejun Heo  *
977cb444766STejun Heo  * CONTEXT:
978d565ed63STejun Heo  * spin_lock_irq(pool->lock)
979d302f017STejun Heo  */
980d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
981d302f017STejun Heo {
98263d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
983e22bee78STejun Heo 	unsigned int oflags = worker->flags;
984e22bee78STejun Heo 
985cb444766STejun Heo 	WARN_ON_ONCE(worker->task != current);
986cb444766STejun Heo 
987d302f017STejun Heo 	worker->flags &= ~flags;
988e22bee78STejun Heo 
98942c025f3STejun Heo 	/*
99042c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
99142c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
99242c025f3STejun Heo 	 * of multiple flags, not a single flag.
99342c025f3STejun Heo 	 */
994e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
995e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
996e19e397aSTejun Heo 			atomic_inc(&pool->nr_running);
997d302f017STejun Heo }
998d302f017STejun Heo 
999d302f017STejun Heo /**
10008cca0eeaSTejun Heo  * find_worker_executing_work - find worker which is executing a work
1001c9e7cf27STejun Heo  * @pool: pool of interest
10028cca0eeaSTejun Heo  * @work: work to find worker for
10038cca0eeaSTejun Heo  *
1004c9e7cf27STejun Heo  * Find a worker which is executing @work on @pool by searching
1005c9e7cf27STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
1006a2c1c57bSTejun Heo  * to match, its current execution should match the address of @work and
1007a2c1c57bSTejun Heo  * its work function.  This is to avoid unwanted dependency between
1008a2c1c57bSTejun Heo  * unrelated work executions through a work item being recycled while still
1009a2c1c57bSTejun Heo  * being executed.
1010a2c1c57bSTejun Heo  *
1011a2c1c57bSTejun Heo  * This is a bit tricky.  A work item may be freed once its execution
1012a2c1c57bSTejun Heo  * starts and nothing prevents the freed area from being recycled for
1013a2c1c57bSTejun Heo  * another work item.  If the same work item address ends up being reused
1014a2c1c57bSTejun Heo  * before the original execution finishes, workqueue will identify the
1015a2c1c57bSTejun Heo  * recycled work item as currently executing and make it wait until the
1016a2c1c57bSTejun Heo  * current execution finishes, introducing an unwanted dependency.
1017a2c1c57bSTejun Heo  *
1018c5aa87bbSTejun Heo  * This function checks the work item address and work function to avoid
1019c5aa87bbSTejun Heo  * false positives.  Note that this isn't complete as one may construct a
1020c5aa87bbSTejun Heo  * work function which can introduce dependency onto itself through a
1021c5aa87bbSTejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
1022c5aa87bbSTejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
1023c5aa87bbSTejun Heo  * actually occurs, it should be easy to locate the culprit work function.
10248cca0eeaSTejun Heo  *
10258cca0eeaSTejun Heo  * CONTEXT:
1026d565ed63STejun Heo  * spin_lock_irq(pool->lock).
10278cca0eeaSTejun Heo  *
1028d185af30SYacine Belkadi  * Return:
1029d185af30SYacine Belkadi  * Pointer to worker which is executing @work if found, %NULL
10308cca0eeaSTejun Heo  * otherwise.
10318cca0eeaSTejun Heo  */
1032c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
10338cca0eeaSTejun Heo 						 struct work_struct *work)
10348cca0eeaSTejun Heo {
103542f8570fSSasha Levin 	struct worker *worker;
103642f8570fSSasha Levin 
1037b67bfe0dSSasha Levin 	hash_for_each_possible(pool->busy_hash, worker, hentry,
1038a2c1c57bSTejun Heo 			       (unsigned long)work)
1039a2c1c57bSTejun Heo 		if (worker->current_work == work &&
1040a2c1c57bSTejun Heo 		    worker->current_func == work->func)
104142f8570fSSasha Levin 			return worker;
104242f8570fSSasha Levin 
104342f8570fSSasha Levin 	return NULL;
10448cca0eeaSTejun Heo }
10458cca0eeaSTejun Heo 
10468cca0eeaSTejun Heo /**
1047bf4ede01STejun Heo  * move_linked_works - move linked works to a list
1048bf4ede01STejun Heo  * @work: start of series of works to be scheduled
1049bf4ede01STejun Heo  * @head: target list to append @work to
1050402dd89dSShailendra Verma  * @nextp: out parameter for nested worklist walking
1051bf4ede01STejun Heo  *
1052bf4ede01STejun Heo  * Schedule linked works starting from @work to @head.  Work series to
1053bf4ede01STejun Heo  * be scheduled starts at @work and includes any consecutive work with
1054bf4ede01STejun Heo  * WORK_STRUCT_LINKED set in its predecessor.
1055bf4ede01STejun Heo  *
1056bf4ede01STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of
1057bf4ede01STejun Heo  * the last scheduled work.  This allows move_linked_works() to be
1058bf4ede01STejun Heo  * nested inside outer list_for_each_entry_safe().
1059bf4ede01STejun Heo  *
1060bf4ede01STejun Heo  * CONTEXT:
1061d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1062bf4ede01STejun Heo  */
1063bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1064bf4ede01STejun Heo 			      struct work_struct **nextp)
1065bf4ede01STejun Heo {
1066bf4ede01STejun Heo 	struct work_struct *n;
1067bf4ede01STejun Heo 
1068bf4ede01STejun Heo 	/*
1069bf4ede01STejun Heo 	 * Linked worklist will always end before the end of the list,
1070bf4ede01STejun Heo 	 * use NULL for list head.
1071bf4ede01STejun Heo 	 */
1072bf4ede01STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1073bf4ede01STejun Heo 		list_move_tail(&work->entry, head);
1074bf4ede01STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1075bf4ede01STejun Heo 			break;
1076bf4ede01STejun Heo 	}
1077bf4ede01STejun Heo 
1078bf4ede01STejun Heo 	/*
1079bf4ede01STejun Heo 	 * If we're already inside safe list traversal and have moved
1080bf4ede01STejun Heo 	 * multiple works to the scheduled queue, the next position
1081bf4ede01STejun Heo 	 * needs to be updated.
1082bf4ede01STejun Heo 	 */
1083bf4ede01STejun Heo 	if (nextp)
1084bf4ede01STejun Heo 		*nextp = n;
1085bf4ede01STejun Heo }
1086bf4ede01STejun Heo 
10878864b4e5STejun Heo /**
10888864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
10898864b4e5STejun Heo  * @pwq: pool_workqueue to get
10908864b4e5STejun Heo  *
10918864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
10928864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
10938864b4e5STejun Heo  */
10948864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
10958864b4e5STejun Heo {
10968864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
10978864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
10988864b4e5STejun Heo 	pwq->refcnt++;
10998864b4e5STejun Heo }
11008864b4e5STejun Heo 
11018864b4e5STejun Heo /**
11028864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
11038864b4e5STejun Heo  * @pwq: pool_workqueue to put
11048864b4e5STejun Heo  *
11058864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
11068864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
11078864b4e5STejun Heo  */
11088864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
11098864b4e5STejun Heo {
11108864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
11118864b4e5STejun Heo 	if (likely(--pwq->refcnt))
11128864b4e5STejun Heo 		return;
11138864b4e5STejun Heo 	if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
11148864b4e5STejun Heo 		return;
11158864b4e5STejun Heo 	/*
11168864b4e5STejun Heo 	 * @pwq can't be released under pool->lock, bounce to
11178864b4e5STejun Heo 	 * pwq_unbound_release_workfn().  This never recurses on the same
11188864b4e5STejun Heo 	 * pool->lock as this path is taken only for unbound workqueues and
11198864b4e5STejun Heo 	 * the release work item is scheduled on a per-cpu workqueue.  To
11208864b4e5STejun Heo 	 * avoid lockdep warning, unbound pool->locks are given lockdep
11218864b4e5STejun Heo 	 * subclass of 1 in get_unbound_pool().
11228864b4e5STejun Heo 	 */
11238864b4e5STejun Heo 	schedule_work(&pwq->unbound_release_work);
11248864b4e5STejun Heo }
11258864b4e5STejun Heo 
1126dce90d47STejun Heo /**
1127dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1128dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1129dce90d47STejun Heo  *
1130dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1131dce90d47STejun Heo  */
1132dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1133dce90d47STejun Heo {
1134dce90d47STejun Heo 	if (pwq) {
1135dce90d47STejun Heo 		/*
1136*24acfb71SThomas Gleixner 		 * As both pwqs and pools are RCU protected, the
1137dce90d47STejun Heo 		 * following lock operations are safe.
1138dce90d47STejun Heo 		 */
1139dce90d47STejun Heo 		spin_lock_irq(&pwq->pool->lock);
1140dce90d47STejun Heo 		put_pwq(pwq);
1141dce90d47STejun Heo 		spin_unlock_irq(&pwq->pool->lock);
1142dce90d47STejun Heo 	}
1143dce90d47STejun Heo }
1144dce90d47STejun Heo 
1145112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work)
1146bf4ede01STejun Heo {
1147112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1148bf4ede01STejun Heo 
1149bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
115082607adcSTejun Heo 	if (list_empty(&pwq->pool->worklist))
115182607adcSTejun Heo 		pwq->pool->watchdog_ts = jiffies;
1152112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
1153bf4ede01STejun Heo 	__clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1154112202d9STejun Heo 	pwq->nr_active++;
1155bf4ede01STejun Heo }
1156bf4ede01STejun Heo 
1157112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
11583aa62497SLai Jiangshan {
1159112202d9STejun Heo 	struct work_struct *work = list_first_entry(&pwq->delayed_works,
11603aa62497SLai Jiangshan 						    struct work_struct, entry);
11613aa62497SLai Jiangshan 
1162112202d9STejun Heo 	pwq_activate_delayed_work(work);
11633aa62497SLai Jiangshan }
11643aa62497SLai Jiangshan 
1165bf4ede01STejun Heo /**
1166112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1167112202d9STejun Heo  * @pwq: pwq of interest
1168bf4ede01STejun Heo  * @color: color of work which left the queue
1169bf4ede01STejun Heo  *
1170bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1171112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1172bf4ede01STejun Heo  *
1173bf4ede01STejun Heo  * CONTEXT:
1174d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1175bf4ede01STejun Heo  */
1176112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1177bf4ede01STejun Heo {
11788864b4e5STejun Heo 	/* uncolored work items don't participate in flushing or nr_active */
1179bf4ede01STejun Heo 	if (color == WORK_NO_COLOR)
11808864b4e5STejun Heo 		goto out_put;
1181bf4ede01STejun Heo 
1182112202d9STejun Heo 	pwq->nr_in_flight[color]--;
1183bf4ede01STejun Heo 
1184112202d9STejun Heo 	pwq->nr_active--;
1185112202d9STejun Heo 	if (!list_empty(&pwq->delayed_works)) {
1186bf4ede01STejun Heo 		/* one down, submit a delayed one */
1187112202d9STejun Heo 		if (pwq->nr_active < pwq->max_active)
1188112202d9STejun Heo 			pwq_activate_first_delayed(pwq);
1189bf4ede01STejun Heo 	}
1190bf4ede01STejun Heo 
1191bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1192112202d9STejun Heo 	if (likely(pwq->flush_color != color))
11938864b4e5STejun Heo 		goto out_put;
1194bf4ede01STejun Heo 
1195bf4ede01STejun Heo 	/* are there still in-flight works? */
1196112202d9STejun Heo 	if (pwq->nr_in_flight[color])
11978864b4e5STejun Heo 		goto out_put;
1198bf4ede01STejun Heo 
1199112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1200112202d9STejun Heo 	pwq->flush_color = -1;
1201bf4ede01STejun Heo 
1202bf4ede01STejun Heo 	/*
1203112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1204bf4ede01STejun Heo 	 * will handle the rest.
1205bf4ede01STejun Heo 	 */
1206112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1207112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
12088864b4e5STejun Heo out_put:
12098864b4e5STejun Heo 	put_pwq(pwq);
1210bf4ede01STejun Heo }
1211bf4ede01STejun Heo 
121236e227d2STejun Heo /**
1213bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
121436e227d2STejun Heo  * @work: work item to steal
121536e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1216bbb68dfaSTejun Heo  * @flags: place to store irq state
121736e227d2STejun Heo  *
121836e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
1219d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
122036e227d2STejun Heo  *
1221d185af30SYacine Belkadi  * Return:
122236e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
122336e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
122436e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1225bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1226bbb68dfaSTejun Heo  *		for arbitrarily long
122736e227d2STejun Heo  *
1228d185af30SYacine Belkadi  * Note:
1229bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1230e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1231e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1232e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1233bbb68dfaSTejun Heo  *
1234bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1235bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1236bbb68dfaSTejun Heo  *
1237e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1238bf4ede01STejun Heo  */
1239bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1240bbb68dfaSTejun Heo 			       unsigned long *flags)
1241bf4ede01STejun Heo {
1242d565ed63STejun Heo 	struct worker_pool *pool;
1243112202d9STejun Heo 	struct pool_workqueue *pwq;
1244bf4ede01STejun Heo 
1245bbb68dfaSTejun Heo 	local_irq_save(*flags);
1246bbb68dfaSTejun Heo 
124736e227d2STejun Heo 	/* try to steal the timer if it exists */
124836e227d2STejun Heo 	if (is_dwork) {
124936e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
125036e227d2STejun Heo 
1251e0aecdd8STejun Heo 		/*
1252e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1253e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1254e0aecdd8STejun Heo 		 * running on the local CPU.
1255e0aecdd8STejun Heo 		 */
125636e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
125736e227d2STejun Heo 			return 1;
125836e227d2STejun Heo 	}
125936e227d2STejun Heo 
126036e227d2STejun Heo 	/* try to claim PENDING the normal way */
1261bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1262bf4ede01STejun Heo 		return 0;
1263bf4ede01STejun Heo 
1264*24acfb71SThomas Gleixner 	rcu_read_lock();
1265bf4ede01STejun Heo 	/*
1266bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1267bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1268bf4ede01STejun Heo 	 */
1269d565ed63STejun Heo 	pool = get_work_pool(work);
1270d565ed63STejun Heo 	if (!pool)
1271bbb68dfaSTejun Heo 		goto fail;
1272bf4ede01STejun Heo 
1273d565ed63STejun Heo 	spin_lock(&pool->lock);
1274bf4ede01STejun Heo 	/*
1275112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
1276112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
1277112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
1278112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
1279112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
12800b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
1281bf4ede01STejun Heo 	 */
1282112202d9STejun Heo 	pwq = get_work_pwq(work);
1283112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
1284bf4ede01STejun Heo 		debug_work_deactivate(work);
12853aa62497SLai Jiangshan 
12863aa62497SLai Jiangshan 		/*
128716062836STejun Heo 		 * A delayed work item cannot be grabbed directly because
128816062836STejun Heo 		 * it might have linked NO_COLOR work items which, if left
1289112202d9STejun Heo 		 * on the delayed_list, will confuse pwq->nr_active
129016062836STejun Heo 		 * management later on and cause stall.  Make sure the work
129116062836STejun Heo 		 * item is activated before grabbing.
12923aa62497SLai Jiangshan 		 */
12933aa62497SLai Jiangshan 		if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1294112202d9STejun Heo 			pwq_activate_delayed_work(work);
12953aa62497SLai Jiangshan 
1296bf4ede01STejun Heo 		list_del_init(&work->entry);
12979c34a704SLai Jiangshan 		pwq_dec_nr_in_flight(pwq, get_work_color(work));
129836e227d2STejun Heo 
1299112202d9STejun Heo 		/* work->data points to pwq iff queued, point to pool */
13004468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
13014468a00fSLai Jiangshan 
1302d565ed63STejun Heo 		spin_unlock(&pool->lock);
1303*24acfb71SThomas Gleixner 		rcu_read_unlock();
130436e227d2STejun Heo 		return 1;
1305bf4ede01STejun Heo 	}
1306d565ed63STejun Heo 	spin_unlock(&pool->lock);
1307bbb68dfaSTejun Heo fail:
1308*24acfb71SThomas Gleixner 	rcu_read_unlock();
1309bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1310bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1311bbb68dfaSTejun Heo 		return -ENOENT;
1312bbb68dfaSTejun Heo 	cpu_relax();
131336e227d2STejun Heo 	return -EAGAIN;
1314bf4ede01STejun Heo }
1315bf4ede01STejun Heo 
1316bf4ede01STejun Heo /**
1317706026c2STejun Heo  * insert_work - insert a work into a pool
1318112202d9STejun Heo  * @pwq: pwq @work belongs to
13194690c4abSTejun Heo  * @work: work to insert
13204690c4abSTejun Heo  * @head: insertion point
13214690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
13224690c4abSTejun Heo  *
1323112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
1324706026c2STejun Heo  * work_struct flags.
13254690c4abSTejun Heo  *
13264690c4abSTejun Heo  * CONTEXT:
1327d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1328365970a1SDavid Howells  */
1329112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1330112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
1331b89deed3SOleg Nesterov {
1332112202d9STejun Heo 	struct worker_pool *pool = pwq->pool;
1333e1d8aa9fSFrederic Weisbecker 
13344690c4abSTejun Heo 	/* we own @work, set data and link */
1335112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
13361a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
13378864b4e5STejun Heo 	get_pwq(pwq);
1338e22bee78STejun Heo 
1339e22bee78STejun Heo 	/*
1340c5aa87bbSTejun Heo 	 * Ensure either wq_worker_sleeping() sees the above
1341c5aa87bbSTejun Heo 	 * list_add_tail() or we see zero nr_running to avoid workers lying
1342c5aa87bbSTejun Heo 	 * around lazily while there are works to be processed.
1343e22bee78STejun Heo 	 */
1344e22bee78STejun Heo 	smp_mb();
1345e22bee78STejun Heo 
134663d95a91STejun Heo 	if (__need_more_worker(pool))
134763d95a91STejun Heo 		wake_up_worker(pool);
1348b89deed3SOleg Nesterov }
1349b89deed3SOleg Nesterov 
1350c8efcc25STejun Heo /*
1351c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
13528d03ecfeSTejun Heo  * same workqueue.
1353c8efcc25STejun Heo  */
1354c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1355c8efcc25STejun Heo {
1356c8efcc25STejun Heo 	struct worker *worker;
1357c8efcc25STejun Heo 
13588d03ecfeSTejun Heo 	worker = current_wq_worker();
1359c8efcc25STejun Heo 	/*
1360bf393fd4SBart Van Assche 	 * Return %true iff I'm a worker executing a work item on @wq.  If
13618d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
1362c8efcc25STejun Heo 	 */
1363112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
1364c8efcc25STejun Heo }
1365c8efcc25STejun Heo 
1366ef557180SMike Galbraith /*
1367ef557180SMike Galbraith  * When queueing an unbound work item to a wq, prefer local CPU if allowed
1368ef557180SMike Galbraith  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
1369ef557180SMike Galbraith  * avoid perturbing sensitive tasks.
1370ef557180SMike Galbraith  */
1371ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu)
1372ef557180SMike Galbraith {
1373f303fccbSTejun Heo 	static bool printed_dbg_warning;
1374ef557180SMike Galbraith 	int new_cpu;
1375ef557180SMike Galbraith 
1376f303fccbSTejun Heo 	if (likely(!wq_debug_force_rr_cpu)) {
1377ef557180SMike Galbraith 		if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1378ef557180SMike Galbraith 			return cpu;
1379f303fccbSTejun Heo 	} else if (!printed_dbg_warning) {
1380f303fccbSTejun Heo 		pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1381f303fccbSTejun Heo 		printed_dbg_warning = true;
1382f303fccbSTejun Heo 	}
1383f303fccbSTejun Heo 
1384ef557180SMike Galbraith 	if (cpumask_empty(wq_unbound_cpumask))
1385ef557180SMike Galbraith 		return cpu;
1386ef557180SMike Galbraith 
1387ef557180SMike Galbraith 	new_cpu = __this_cpu_read(wq_rr_cpu_last);
1388ef557180SMike Galbraith 	new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1389ef557180SMike Galbraith 	if (unlikely(new_cpu >= nr_cpu_ids)) {
1390ef557180SMike Galbraith 		new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1391ef557180SMike Galbraith 		if (unlikely(new_cpu >= nr_cpu_ids))
1392ef557180SMike Galbraith 			return cpu;
1393ef557180SMike Galbraith 	}
1394ef557180SMike Galbraith 	__this_cpu_write(wq_rr_cpu_last, new_cpu);
1395ef557180SMike Galbraith 
1396ef557180SMike Galbraith 	return new_cpu;
1397ef557180SMike Galbraith }
1398ef557180SMike Galbraith 
1399d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
14001da177e4SLinus Torvalds 			 struct work_struct *work)
14011da177e4SLinus Torvalds {
1402112202d9STejun Heo 	struct pool_workqueue *pwq;
1403c9178087STejun Heo 	struct worker_pool *last_pool;
14041e19ffc6STejun Heo 	struct list_head *worklist;
14058a2e8e5dSTejun Heo 	unsigned int work_flags;
1406b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
14078930cabaSTejun Heo 
14088930cabaSTejun Heo 	/*
14098930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
14108930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
14118930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
14128930cabaSTejun Heo 	 * happen with IRQ disabled.
14138930cabaSTejun Heo 	 */
14148e8eb730SFrederic Weisbecker 	lockdep_assert_irqs_disabled();
14151da177e4SLinus Torvalds 
1416dc186ad7SThomas Gleixner 	debug_work_activate(work);
14171e19ffc6STejun Heo 
14189ef28a73SLi Bin 	/* if draining, only works from the same workqueue are allowed */
1419618b01ebSTejun Heo 	if (unlikely(wq->flags & __WQ_DRAINING) &&
1420c8efcc25STejun Heo 	    WARN_ON_ONCE(!is_chained_work(wq)))
1421e41e704bSTejun Heo 		return;
1422*24acfb71SThomas Gleixner 	rcu_read_lock();
14239e8cd2f5STejun Heo retry:
1424df2d5ae4STejun Heo 	if (req_cpu == WORK_CPU_UNBOUND)
1425ef557180SMike Galbraith 		cpu = wq_select_unbound_cpu(raw_smp_processor_id());
1426df2d5ae4STejun Heo 
1427df2d5ae4STejun Heo 	/* pwq which will be used unless @work is executing elsewhere */
1428df2d5ae4STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
1429c9178087STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1430df2d5ae4STejun Heo 	else
1431df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1432f3421797STejun Heo 
143318aa9effSTejun Heo 	/*
1434c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
1435c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
1436c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
143718aa9effSTejun Heo 	 */
1438c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
1439112202d9STejun Heo 	if (last_pool && last_pool != pwq->pool) {
144018aa9effSTejun Heo 		struct worker *worker;
144118aa9effSTejun Heo 
1442d565ed63STejun Heo 		spin_lock(&last_pool->lock);
144318aa9effSTejun Heo 
1444c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
144518aa9effSTejun Heo 
1446112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
1447c9178087STejun Heo 			pwq = worker->current_pwq;
14488594fadeSLai Jiangshan 		} else {
144918aa9effSTejun Heo 			/* meh... not running there, queue here */
1450d565ed63STejun Heo 			spin_unlock(&last_pool->lock);
1451112202d9STejun Heo 			spin_lock(&pwq->pool->lock);
145218aa9effSTejun Heo 		}
14538930cabaSTejun Heo 	} else {
1454112202d9STejun Heo 		spin_lock(&pwq->pool->lock);
14558930cabaSTejun Heo 	}
1456502ca9d8STejun Heo 
14579e8cd2f5STejun Heo 	/*
14589e8cd2f5STejun Heo 	 * pwq is determined and locked.  For unbound pools, we could have
14599e8cd2f5STejun Heo 	 * raced with pwq release and it could already be dead.  If its
14609e8cd2f5STejun Heo 	 * refcnt is zero, repeat pwq selection.  Note that pwqs never die
1461df2d5ae4STejun Heo 	 * without another pwq replacing it in the numa_pwq_tbl or while
1462df2d5ae4STejun Heo 	 * work items are executing on it, so the retrying is guaranteed to
14639e8cd2f5STejun Heo 	 * make forward-progress.
14649e8cd2f5STejun Heo 	 */
14659e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
14669e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
14679e8cd2f5STejun Heo 			spin_unlock(&pwq->pool->lock);
14689e8cd2f5STejun Heo 			cpu_relax();
14699e8cd2f5STejun Heo 			goto retry;
14709e8cd2f5STejun Heo 		}
14719e8cd2f5STejun Heo 		/* oops */
14729e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
14739e8cd2f5STejun Heo 			  wq->name, cpu);
14749e8cd2f5STejun Heo 	}
14759e8cd2f5STejun Heo 
1476112202d9STejun Heo 	/* pwq determined, queue */
1477112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
1478502ca9d8STejun Heo 
1479*24acfb71SThomas Gleixner 	if (WARN_ON(!list_empty(&work->entry)))
1480*24acfb71SThomas Gleixner 		goto out;
14811e19ffc6STejun Heo 
1482112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
1483112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
14841e19ffc6STejun Heo 
1485112202d9STejun Heo 	if (likely(pwq->nr_active < pwq->max_active)) {
1486cdadf009STejun Heo 		trace_workqueue_activate_work(work);
1487112202d9STejun Heo 		pwq->nr_active++;
1488112202d9STejun Heo 		worklist = &pwq->pool->worklist;
148982607adcSTejun Heo 		if (list_empty(worklist))
149082607adcSTejun Heo 			pwq->pool->watchdog_ts = jiffies;
14918a2e8e5dSTejun Heo 	} else {
14928a2e8e5dSTejun Heo 		work_flags |= WORK_STRUCT_DELAYED;
1493112202d9STejun Heo 		worklist = &pwq->delayed_works;
14948a2e8e5dSTejun Heo 	}
14951e19ffc6STejun Heo 
1496112202d9STejun Heo 	insert_work(pwq, work, worklist, work_flags);
14971e19ffc6STejun Heo 
1498*24acfb71SThomas Gleixner out:
1499112202d9STejun Heo 	spin_unlock(&pwq->pool->lock);
1500*24acfb71SThomas Gleixner 	rcu_read_unlock();
15011da177e4SLinus Torvalds }
15021da177e4SLinus Torvalds 
15030fcb78c2SRolf Eike Beer /**
1504c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1505c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1506c1a220e7SZhang Rui  * @wq: workqueue to use
1507c1a220e7SZhang Rui  * @work: work to queue
1508c1a220e7SZhang Rui  *
1509c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1510c1a220e7SZhang Rui  * can't go away.
1511d185af30SYacine Belkadi  *
1512d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
1513c1a220e7SZhang Rui  */
1514d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1515d4283e93STejun Heo 		   struct work_struct *work)
1516c1a220e7SZhang Rui {
1517d4283e93STejun Heo 	bool ret = false;
15188930cabaSTejun Heo 	unsigned long flags;
15198930cabaSTejun Heo 
15208930cabaSTejun Heo 	local_irq_save(flags);
1521c1a220e7SZhang Rui 
152222df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
15234690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1524d4283e93STejun Heo 		ret = true;
1525c1a220e7SZhang Rui 	}
15268930cabaSTejun Heo 
15278930cabaSTejun Heo 	local_irq_restore(flags);
1528c1a220e7SZhang Rui 	return ret;
1529c1a220e7SZhang Rui }
1530ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
1531c1a220e7SZhang Rui 
15328204e0c1SAlexander Duyck /**
15338204e0c1SAlexander Duyck  * workqueue_select_cpu_near - Select a CPU based on NUMA node
15348204e0c1SAlexander Duyck  * @node: NUMA node ID that we want to select a CPU from
15358204e0c1SAlexander Duyck  *
15368204e0c1SAlexander Duyck  * This function will attempt to find a "random" cpu available on a given
15378204e0c1SAlexander Duyck  * node. If there are no CPUs available on the given node it will return
15388204e0c1SAlexander Duyck  * WORK_CPU_UNBOUND indicating that we should just schedule to any
15398204e0c1SAlexander Duyck  * available CPU if we need to schedule this work.
15408204e0c1SAlexander Duyck  */
15418204e0c1SAlexander Duyck static int workqueue_select_cpu_near(int node)
15428204e0c1SAlexander Duyck {
15438204e0c1SAlexander Duyck 	int cpu;
15448204e0c1SAlexander Duyck 
15458204e0c1SAlexander Duyck 	/* No point in doing this if NUMA isn't enabled for workqueues */
15468204e0c1SAlexander Duyck 	if (!wq_numa_enabled)
15478204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
15488204e0c1SAlexander Duyck 
15498204e0c1SAlexander Duyck 	/* Delay binding to CPU if node is not valid or online */
15508204e0c1SAlexander Duyck 	if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
15518204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
15528204e0c1SAlexander Duyck 
15538204e0c1SAlexander Duyck 	/* Use local node/cpu if we are already there */
15548204e0c1SAlexander Duyck 	cpu = raw_smp_processor_id();
15558204e0c1SAlexander Duyck 	if (node == cpu_to_node(cpu))
15568204e0c1SAlexander Duyck 		return cpu;
15578204e0c1SAlexander Duyck 
15588204e0c1SAlexander Duyck 	/* Use "random" otherwise know as "first" online CPU of node */
15598204e0c1SAlexander Duyck 	cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
15608204e0c1SAlexander Duyck 
15618204e0c1SAlexander Duyck 	/* If CPU is valid return that, otherwise just defer */
15628204e0c1SAlexander Duyck 	return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
15638204e0c1SAlexander Duyck }
15648204e0c1SAlexander Duyck 
15658204e0c1SAlexander Duyck /**
15668204e0c1SAlexander Duyck  * queue_work_node - queue work on a "random" cpu for a given NUMA node
15678204e0c1SAlexander Duyck  * @node: NUMA node that we are targeting the work for
15688204e0c1SAlexander Duyck  * @wq: workqueue to use
15698204e0c1SAlexander Duyck  * @work: work to queue
15708204e0c1SAlexander Duyck  *
15718204e0c1SAlexander Duyck  * We queue the work to a "random" CPU within a given NUMA node. The basic
15728204e0c1SAlexander Duyck  * idea here is to provide a way to somehow associate work with a given
15738204e0c1SAlexander Duyck  * NUMA node.
15748204e0c1SAlexander Duyck  *
15758204e0c1SAlexander Duyck  * This function will only make a best effort attempt at getting this onto
15768204e0c1SAlexander Duyck  * the right NUMA node. If no node is requested or the requested node is
15778204e0c1SAlexander Duyck  * offline then we just fall back to standard queue_work behavior.
15788204e0c1SAlexander Duyck  *
15798204e0c1SAlexander Duyck  * Currently the "random" CPU ends up being the first available CPU in the
15808204e0c1SAlexander Duyck  * intersection of cpu_online_mask and the cpumask of the node, unless we
15818204e0c1SAlexander Duyck  * are running on the node. In that case we just use the current CPU.
15828204e0c1SAlexander Duyck  *
15838204e0c1SAlexander Duyck  * Return: %false if @work was already on a queue, %true otherwise.
15848204e0c1SAlexander Duyck  */
15858204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq,
15868204e0c1SAlexander Duyck 		     struct work_struct *work)
15878204e0c1SAlexander Duyck {
15888204e0c1SAlexander Duyck 	unsigned long flags;
15898204e0c1SAlexander Duyck 	bool ret = false;
15908204e0c1SAlexander Duyck 
15918204e0c1SAlexander Duyck 	/*
15928204e0c1SAlexander Duyck 	 * This current implementation is specific to unbound workqueues.
15938204e0c1SAlexander Duyck 	 * Specifically we only return the first available CPU for a given
15948204e0c1SAlexander Duyck 	 * node instead of cycling through individual CPUs within the node.
15958204e0c1SAlexander Duyck 	 *
15968204e0c1SAlexander Duyck 	 * If this is used with a per-cpu workqueue then the logic in
15978204e0c1SAlexander Duyck 	 * workqueue_select_cpu_near would need to be updated to allow for
15988204e0c1SAlexander Duyck 	 * some round robin type logic.
15998204e0c1SAlexander Duyck 	 */
16008204e0c1SAlexander Duyck 	WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
16018204e0c1SAlexander Duyck 
16028204e0c1SAlexander Duyck 	local_irq_save(flags);
16038204e0c1SAlexander Duyck 
16048204e0c1SAlexander Duyck 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
16058204e0c1SAlexander Duyck 		int cpu = workqueue_select_cpu_near(node);
16068204e0c1SAlexander Duyck 
16078204e0c1SAlexander Duyck 		__queue_work(cpu, wq, work);
16088204e0c1SAlexander Duyck 		ret = true;
16098204e0c1SAlexander Duyck 	}
16108204e0c1SAlexander Duyck 
16118204e0c1SAlexander Duyck 	local_irq_restore(flags);
16128204e0c1SAlexander Duyck 	return ret;
16138204e0c1SAlexander Duyck }
16148204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node);
16158204e0c1SAlexander Duyck 
16168c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t)
16171da177e4SLinus Torvalds {
16188c20feb6SKees Cook 	struct delayed_work *dwork = from_timer(dwork, t, timer);
16191da177e4SLinus Torvalds 
1620e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
162160c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
16221da177e4SLinus Torvalds }
16231438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
16241da177e4SLinus Torvalds 
16257beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
162652bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
16271da177e4SLinus Torvalds {
16287beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
16297beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
16301da177e4SLinus Torvalds 
1631637fdbaeSTejun Heo 	WARN_ON_ONCE(!wq);
1632841b86f3SKees Cook 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
1633fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1634fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
16357beb2edfSTejun Heo 
16368852aac2STejun Heo 	/*
16378852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
16388852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
16398852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
16408852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
16418852aac2STejun Heo 	 */
16428852aac2STejun Heo 	if (!delay) {
16438852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
16448852aac2STejun Heo 		return;
16458852aac2STejun Heo 	}
16468852aac2STejun Heo 
164760c057bcSLai Jiangshan 	dwork->wq = wq;
16481265057fSTejun Heo 	dwork->cpu = cpu;
16497beb2edfSTejun Heo 	timer->expires = jiffies + delay;
16507beb2edfSTejun Heo 
1651041bd12eSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
16527beb2edfSTejun Heo 		add_timer_on(timer, cpu);
1653041bd12eSTejun Heo 	else
1654041bd12eSTejun Heo 		add_timer(timer);
16557beb2edfSTejun Heo }
16561da177e4SLinus Torvalds 
16570fcb78c2SRolf Eike Beer /**
16580fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
16590fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
16600fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1661af9997e4SRandy Dunlap  * @dwork: work to queue
16620fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
16630fcb78c2SRolf Eike Beer  *
1664d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
1665715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1666715f1300STejun Heo  * execution.
16670fcb78c2SRolf Eike Beer  */
1668d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
166952bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
16707a6bc1cdSVenkatesh Pallipadi {
167152bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1672d4283e93STejun Heo 	bool ret = false;
16738930cabaSTejun Heo 	unsigned long flags;
16748930cabaSTejun Heo 
16758930cabaSTejun Heo 	/* read the comment in __queue_work() */
16768930cabaSTejun Heo 	local_irq_save(flags);
16777a6bc1cdSVenkatesh Pallipadi 
167822df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
16797beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1680d4283e93STejun Heo 		ret = true;
16817a6bc1cdSVenkatesh Pallipadi 	}
16828930cabaSTejun Heo 
16838930cabaSTejun Heo 	local_irq_restore(flags);
16847a6bc1cdSVenkatesh Pallipadi 	return ret;
16857a6bc1cdSVenkatesh Pallipadi }
1686ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
16871da177e4SLinus Torvalds 
1688c8e55f36STejun Heo /**
16898376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
16908376fe22STejun Heo  * @cpu: CPU number to execute work on
16918376fe22STejun Heo  * @wq: workqueue to use
16928376fe22STejun Heo  * @dwork: work to queue
16938376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
16948376fe22STejun Heo  *
16958376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
16968376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
16978376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
16988376fe22STejun Heo  * current state.
16998376fe22STejun Heo  *
1700d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
17018376fe22STejun Heo  * pending and its timer was modified.
17028376fe22STejun Heo  *
1703e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
17048376fe22STejun Heo  * See try_to_grab_pending() for details.
17058376fe22STejun Heo  */
17068376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
17078376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
17088376fe22STejun Heo {
17098376fe22STejun Heo 	unsigned long flags;
17108376fe22STejun Heo 	int ret;
17118376fe22STejun Heo 
17128376fe22STejun Heo 	do {
17138376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
17148376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
17158376fe22STejun Heo 
17168376fe22STejun Heo 	if (likely(ret >= 0)) {
17178376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
17188376fe22STejun Heo 		local_irq_restore(flags);
17198376fe22STejun Heo 	}
17208376fe22STejun Heo 
17218376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
17228376fe22STejun Heo 	return ret;
17238376fe22STejun Heo }
17248376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
17258376fe22STejun Heo 
172605f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu)
172705f0fe6bSTejun Heo {
172805f0fe6bSTejun Heo 	struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
172905f0fe6bSTejun Heo 
173005f0fe6bSTejun Heo 	/* read the comment in __queue_work() */
173105f0fe6bSTejun Heo 	local_irq_disable();
173205f0fe6bSTejun Heo 	__queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
173305f0fe6bSTejun Heo 	local_irq_enable();
173405f0fe6bSTejun Heo }
173505f0fe6bSTejun Heo 
173605f0fe6bSTejun Heo /**
173705f0fe6bSTejun Heo  * queue_rcu_work - queue work after a RCU grace period
173805f0fe6bSTejun Heo  * @wq: workqueue to use
173905f0fe6bSTejun Heo  * @rwork: work to queue
174005f0fe6bSTejun Heo  *
174105f0fe6bSTejun Heo  * Return: %false if @rwork was already pending, %true otherwise.  Note
174205f0fe6bSTejun Heo  * that a full RCU grace period is guaranteed only after a %true return.
1743bf393fd4SBart Van Assche  * While @rwork is guaranteed to be executed after a %false return, the
174405f0fe6bSTejun Heo  * execution may happen before a full RCU grace period has passed.
174505f0fe6bSTejun Heo  */
174605f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
174705f0fe6bSTejun Heo {
174805f0fe6bSTejun Heo 	struct work_struct *work = &rwork->work;
174905f0fe6bSTejun Heo 
175005f0fe6bSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
175105f0fe6bSTejun Heo 		rwork->wq = wq;
175205f0fe6bSTejun Heo 		call_rcu(&rwork->rcu, rcu_work_rcufn);
175305f0fe6bSTejun Heo 		return true;
175405f0fe6bSTejun Heo 	}
175505f0fe6bSTejun Heo 
175605f0fe6bSTejun Heo 	return false;
175705f0fe6bSTejun Heo }
175805f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work);
175905f0fe6bSTejun Heo 
17608376fe22STejun Heo /**
1761c8e55f36STejun Heo  * worker_enter_idle - enter idle state
1762c8e55f36STejun Heo  * @worker: worker which is entering idle state
1763c8e55f36STejun Heo  *
1764c8e55f36STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1765c8e55f36STejun Heo  * necessary.
1766c8e55f36STejun Heo  *
1767c8e55f36STejun Heo  * LOCKING:
1768d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1769c8e55f36STejun Heo  */
1770c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker)
17711da177e4SLinus Torvalds {
1772bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1773c8e55f36STejun Heo 
17746183c009STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
17756183c009STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
17766183c009STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
17776183c009STejun Heo 		return;
1778c8e55f36STejun Heo 
1779051e1850SLai Jiangshan 	/* can't use worker_set_flags(), also called from create_worker() */
1780cb444766STejun Heo 	worker->flags |= WORKER_IDLE;
1781bd7bdd43STejun Heo 	pool->nr_idle++;
1782e22bee78STejun Heo 	worker->last_active = jiffies;
1783c8e55f36STejun Heo 
1784c8e55f36STejun Heo 	/* idle_list is LIFO */
1785bd7bdd43STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1786db7bccf4STejun Heo 
178763d95a91STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1788628c78e7STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1789cb444766STejun Heo 
1790544ecf31STejun Heo 	/*
1791e8b3f8dbSLai Jiangshan 	 * Sanity check nr_running.  Because unbind_workers() releases
1792d565ed63STejun Heo 	 * pool->lock between setting %WORKER_UNBOUND and zapping
1793628c78e7STejun Heo 	 * nr_running, the warning may trigger spuriously.  Check iff
1794628c78e7STejun Heo 	 * unbind is not in progress.
1795544ecf31STejun Heo 	 */
179624647570STejun Heo 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1797bd7bdd43STejun Heo 		     pool->nr_workers == pool->nr_idle &&
1798e19e397aSTejun Heo 		     atomic_read(&pool->nr_running));
1799c8e55f36STejun Heo }
1800c8e55f36STejun Heo 
1801c8e55f36STejun Heo /**
1802c8e55f36STejun Heo  * worker_leave_idle - leave idle state
1803c8e55f36STejun Heo  * @worker: worker which is leaving idle state
1804c8e55f36STejun Heo  *
1805c8e55f36STejun Heo  * @worker is leaving idle state.  Update stats.
1806c8e55f36STejun Heo  *
1807c8e55f36STejun Heo  * LOCKING:
1808d565ed63STejun Heo  * spin_lock_irq(pool->lock).
1809c8e55f36STejun Heo  */
1810c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker)
1811c8e55f36STejun Heo {
1812bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1813c8e55f36STejun Heo 
18146183c009STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
18156183c009STejun Heo 		return;
1816d302f017STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1817bd7bdd43STejun Heo 	pool->nr_idle--;
1818c8e55f36STejun Heo 	list_del_init(&worker->entry);
1819c8e55f36STejun Heo }
1820c8e55f36STejun Heo 
1821f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
1822c34056a3STejun Heo {
1823c34056a3STejun Heo 	struct worker *worker;
1824c34056a3STejun Heo 
1825f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
1826c8e55f36STejun Heo 	if (worker) {
1827c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
1828affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
1829da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
1830e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
1831e22bee78STejun Heo 		worker->flags = WORKER_PREP;
1832c8e55f36STejun Heo 	}
1833c34056a3STejun Heo 	return worker;
1834c34056a3STejun Heo }
1835c34056a3STejun Heo 
1836c34056a3STejun Heo /**
18374736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
18384736cbf7SLai Jiangshan  * @worker: worker to be attached
18394736cbf7SLai Jiangshan  * @pool: the target pool
18404736cbf7SLai Jiangshan  *
18414736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
18424736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
18434736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
18444736cbf7SLai Jiangshan  */
18454736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
18464736cbf7SLai Jiangshan 				   struct worker_pool *pool)
18474736cbf7SLai Jiangshan {
18481258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
18494736cbf7SLai Jiangshan 
18504736cbf7SLai Jiangshan 	/*
18514736cbf7SLai Jiangshan 	 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
18524736cbf7SLai Jiangshan 	 * online CPUs.  It'll be re-applied when any of the CPUs come up.
18534736cbf7SLai Jiangshan 	 */
18544736cbf7SLai Jiangshan 	set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
18554736cbf7SLai Jiangshan 
18564736cbf7SLai Jiangshan 	/*
18571258fae7STejun Heo 	 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
18581258fae7STejun Heo 	 * stable across this function.  See the comments above the flag
18591258fae7STejun Heo 	 * definition for details.
18604736cbf7SLai Jiangshan 	 */
18614736cbf7SLai Jiangshan 	if (pool->flags & POOL_DISASSOCIATED)
18624736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
18634736cbf7SLai Jiangshan 
18644736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
1865a2d812a2STejun Heo 	worker->pool = pool;
18664736cbf7SLai Jiangshan 
18671258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
18684736cbf7SLai Jiangshan }
18694736cbf7SLai Jiangshan 
18704736cbf7SLai Jiangshan /**
187160f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
187260f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
187360f5a4bcSLai Jiangshan  *
18744736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
18754736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
18764736cbf7SLai Jiangshan  * other reference to the pool.
187760f5a4bcSLai Jiangshan  */
1878a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker)
187960f5a4bcSLai Jiangshan {
1880a2d812a2STejun Heo 	struct worker_pool *pool = worker->pool;
188160f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
188260f5a4bcSLai Jiangshan 
18831258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
1884a2d812a2STejun Heo 
1885da028469SLai Jiangshan 	list_del(&worker->node);
1886a2d812a2STejun Heo 	worker->pool = NULL;
1887a2d812a2STejun Heo 
1888da028469SLai Jiangshan 	if (list_empty(&pool->workers))
188960f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
18901258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
189160f5a4bcSLai Jiangshan 
1892b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
1893b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1894b62c0751SLai Jiangshan 
189560f5a4bcSLai Jiangshan 	if (detach_completion)
189660f5a4bcSLai Jiangshan 		complete(detach_completion);
189760f5a4bcSLai Jiangshan }
189860f5a4bcSLai Jiangshan 
189960f5a4bcSLai Jiangshan /**
1900c34056a3STejun Heo  * create_worker - create a new workqueue worker
190163d95a91STejun Heo  * @pool: pool the new worker will belong to
1902c34056a3STejun Heo  *
1903051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
1904c34056a3STejun Heo  *
1905c34056a3STejun Heo  * CONTEXT:
1906c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
1907c34056a3STejun Heo  *
1908d185af30SYacine Belkadi  * Return:
1909c34056a3STejun Heo  * Pointer to the newly created worker.
1910c34056a3STejun Heo  */
1911bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
1912c34056a3STejun Heo {
1913c34056a3STejun Heo 	struct worker *worker = NULL;
1914f3421797STejun Heo 	int id = -1;
1915e3c916a4STejun Heo 	char id_buf[16];
1916c34056a3STejun Heo 
19177cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
19187cda9aaeSLai Jiangshan 	id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
1919822d8405STejun Heo 	if (id < 0)
1920c34056a3STejun Heo 		goto fail;
1921c34056a3STejun Heo 
1922f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
1923c34056a3STejun Heo 	if (!worker)
1924c34056a3STejun Heo 		goto fail;
1925c34056a3STejun Heo 
1926c34056a3STejun Heo 	worker->id = id;
1927c34056a3STejun Heo 
192829c91e99STejun Heo 	if (pool->cpu >= 0)
1929e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1930e3c916a4STejun Heo 			 pool->attrs->nice < 0  ? "H" : "");
1931f3421797STejun Heo 	else
1932e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1933e3c916a4STejun Heo 
1934f3f90ad4STejun Heo 	worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1935e3c916a4STejun Heo 					      "kworker/%s", id_buf);
1936c34056a3STejun Heo 	if (IS_ERR(worker->task))
1937c34056a3STejun Heo 		goto fail;
1938c34056a3STejun Heo 
193991151228SOleg Nesterov 	set_user_nice(worker->task, pool->attrs->nice);
194025834c73SPeter Zijlstra 	kthread_bind_mask(worker->task, pool->attrs->cpumask);
194191151228SOleg Nesterov 
1942da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
19434736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
1944822d8405STejun Heo 
1945051e1850SLai Jiangshan 	/* start the newly created worker */
1946051e1850SLai Jiangshan 	spin_lock_irq(&pool->lock);
1947051e1850SLai Jiangshan 	worker->pool->nr_workers++;
1948051e1850SLai Jiangshan 	worker_enter_idle(worker);
1949051e1850SLai Jiangshan 	wake_up_process(worker->task);
1950051e1850SLai Jiangshan 	spin_unlock_irq(&pool->lock);
1951051e1850SLai Jiangshan 
1952c34056a3STejun Heo 	return worker;
1953822d8405STejun Heo 
1954c34056a3STejun Heo fail:
19559625ab17SLai Jiangshan 	if (id >= 0)
19567cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, id);
1957c34056a3STejun Heo 	kfree(worker);
1958c34056a3STejun Heo 	return NULL;
1959c34056a3STejun Heo }
1960c34056a3STejun Heo 
1961c34056a3STejun Heo /**
1962c34056a3STejun Heo  * destroy_worker - destroy a workqueue worker
1963c34056a3STejun Heo  * @worker: worker to be destroyed
1964c34056a3STejun Heo  *
196573eb7fe7SLai Jiangshan  * Destroy @worker and adjust @pool stats accordingly.  The worker should
196673eb7fe7SLai Jiangshan  * be idle.
1967c8e55f36STejun Heo  *
1968c8e55f36STejun Heo  * CONTEXT:
196960f5a4bcSLai Jiangshan  * spin_lock_irq(pool->lock).
1970c34056a3STejun Heo  */
1971c34056a3STejun Heo static void destroy_worker(struct worker *worker)
1972c34056a3STejun Heo {
1973bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
1974c34056a3STejun Heo 
1975cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
1976cd549687STejun Heo 
1977c34056a3STejun Heo 	/* sanity check frenzy */
19786183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
197973eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
198073eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
19816183c009STejun Heo 		return;
1982c34056a3STejun Heo 
1983bd7bdd43STejun Heo 	pool->nr_workers--;
1984bd7bdd43STejun Heo 	pool->nr_idle--;
1985c8e55f36STejun Heo 
1986c8e55f36STejun Heo 	list_del_init(&worker->entry);
1987cb444766STejun Heo 	worker->flags |= WORKER_DIE;
198860f5a4bcSLai Jiangshan 	wake_up_process(worker->task);
1989c34056a3STejun Heo }
1990c34056a3STejun Heo 
199132a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t)
1992e22bee78STejun Heo {
199332a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, idle_timer);
1994e22bee78STejun Heo 
1995d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
1996e22bee78STejun Heo 
19973347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
1998e22bee78STejun Heo 		struct worker *worker;
1999e22bee78STejun Heo 		unsigned long expires;
2000e22bee78STejun Heo 
2001e22bee78STejun Heo 		/* idle_list is kept in LIFO order, check the last one */
200263d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2003e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2004e22bee78STejun Heo 
20053347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
200663d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
20073347fc9fSLai Jiangshan 			break;
2008e22bee78STejun Heo 		}
20093347fc9fSLai Jiangshan 
20103347fc9fSLai Jiangshan 		destroy_worker(worker);
2011e22bee78STejun Heo 	}
2012e22bee78STejun Heo 
2013d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2014e22bee78STejun Heo }
2015e22bee78STejun Heo 
2016493a1724STejun Heo static void send_mayday(struct work_struct *work)
2017e22bee78STejun Heo {
2018112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2019112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
2020493a1724STejun Heo 
20212e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
2022e22bee78STejun Heo 
2023493008a8STejun Heo 	if (!wq->rescuer)
2024493a1724STejun Heo 		return;
2025e22bee78STejun Heo 
2026e22bee78STejun Heo 	/* mayday mayday mayday */
2027493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
202877668c8bSLai Jiangshan 		/*
202977668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
203077668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
203177668c8bSLai Jiangshan 		 * rescuer is done with it.
203277668c8bSLai Jiangshan 		 */
203377668c8bSLai Jiangshan 		get_pwq(pwq);
2034493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
2035e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
2036493a1724STejun Heo 	}
2037e22bee78STejun Heo }
2038e22bee78STejun Heo 
203932a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t)
2040e22bee78STejun Heo {
204132a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, mayday_timer);
2042e22bee78STejun Heo 	struct work_struct *work;
2043e22bee78STejun Heo 
2044b2d82909STejun Heo 	spin_lock_irq(&pool->lock);
2045b2d82909STejun Heo 	spin_lock(&wq_mayday_lock);		/* for wq->maydays */
2046e22bee78STejun Heo 
204763d95a91STejun Heo 	if (need_to_create_worker(pool)) {
2048e22bee78STejun Heo 		/*
2049e22bee78STejun Heo 		 * We've been trying to create a new worker but
2050e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
2051e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
2052e22bee78STejun Heo 		 * rescuers.
2053e22bee78STejun Heo 		 */
205463d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
2055e22bee78STejun Heo 			send_mayday(work);
2056e22bee78STejun Heo 	}
2057e22bee78STejun Heo 
2058b2d82909STejun Heo 	spin_unlock(&wq_mayday_lock);
2059b2d82909STejun Heo 	spin_unlock_irq(&pool->lock);
2060e22bee78STejun Heo 
206163d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
2062e22bee78STejun Heo }
2063e22bee78STejun Heo 
2064e22bee78STejun Heo /**
2065e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
206663d95a91STejun Heo  * @pool: pool to create a new worker for
2067e22bee78STejun Heo  *
206863d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
2069e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
2070e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
207163d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
2072e22bee78STejun Heo  * possible allocation deadlock.
2073e22bee78STejun Heo  *
2074c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
2075c5aa87bbSTejun Heo  * may_start_working() %true.
2076e22bee78STejun Heo  *
2077e22bee78STejun Heo  * LOCKING:
2078d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2079e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
2080e22bee78STejun Heo  * manager.
2081e22bee78STejun Heo  */
208229187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool)
2083d565ed63STejun Heo __releases(&pool->lock)
2084d565ed63STejun Heo __acquires(&pool->lock)
2085e22bee78STejun Heo {
2086e22bee78STejun Heo restart:
2087d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
20889f9c2364STejun Heo 
2089e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
209063d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2091e22bee78STejun Heo 
2092e22bee78STejun Heo 	while (true) {
2093051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
2094e22bee78STejun Heo 			break;
2095e22bee78STejun Heo 
2096e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
20979f9c2364STejun Heo 
209863d95a91STejun Heo 		if (!need_to_create_worker(pool))
2099e22bee78STejun Heo 			break;
2100e22bee78STejun Heo 	}
2101e22bee78STejun Heo 
210263d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2103d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2104051e1850SLai Jiangshan 	/*
2105051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
2106051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
2107051e1850SLai Jiangshan 	 * already become busy.
2108051e1850SLai Jiangshan 	 */
210963d95a91STejun Heo 	if (need_to_create_worker(pool))
2110e22bee78STejun Heo 		goto restart;
2111e22bee78STejun Heo }
2112e22bee78STejun Heo 
2113e22bee78STejun Heo /**
2114e22bee78STejun Heo  * manage_workers - manage worker pool
2115e22bee78STejun Heo  * @worker: self
2116e22bee78STejun Heo  *
2117706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
2118e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2119706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
2120e22bee78STejun Heo  *
2121e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2122e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2123e22bee78STejun Heo  * and may_start_working() is true.
2124e22bee78STejun Heo  *
2125e22bee78STejun Heo  * CONTEXT:
2126d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2127e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2128e22bee78STejun Heo  *
2129d185af30SYacine Belkadi  * Return:
213029187a9eSTejun Heo  * %false if the pool doesn't need management and the caller can safely
213129187a9eSTejun Heo  * start processing works, %true if management function was performed and
213229187a9eSTejun Heo  * the conditions that the caller verified before calling the function may
213329187a9eSTejun Heo  * no longer be true.
2134e22bee78STejun Heo  */
2135e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2136e22bee78STejun Heo {
213763d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2138e22bee78STejun Heo 
2139692b4825STejun Heo 	if (pool->flags & POOL_MANAGER_ACTIVE)
214029187a9eSTejun Heo 		return false;
2141692b4825STejun Heo 
2142692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
21432607d7a6STejun Heo 	pool->manager = worker;
2144e22bee78STejun Heo 
214529187a9eSTejun Heo 	maybe_create_worker(pool);
2146e22bee78STejun Heo 
21472607d7a6STejun Heo 	pool->manager = NULL;
2148692b4825STejun Heo 	pool->flags &= ~POOL_MANAGER_ACTIVE;
2149692b4825STejun Heo 	wake_up(&wq_manager_wait);
215029187a9eSTejun Heo 	return true;
2151e22bee78STejun Heo }
2152e22bee78STejun Heo 
2153a62428c0STejun Heo /**
2154a62428c0STejun Heo  * process_one_work - process single work
2155c34056a3STejun Heo  * @worker: self
2156a62428c0STejun Heo  * @work: work to process
2157a62428c0STejun Heo  *
2158a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2159a62428c0STejun Heo  * process a single work including synchronization against and
2160a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2161a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2162a62428c0STejun Heo  * call this function to process a work.
2163a62428c0STejun Heo  *
2164a62428c0STejun Heo  * CONTEXT:
2165d565ed63STejun Heo  * spin_lock_irq(pool->lock) which is released and regrabbed.
2166a62428c0STejun Heo  */
2167c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
2168d565ed63STejun Heo __releases(&pool->lock)
2169d565ed63STejun Heo __acquires(&pool->lock)
21701da177e4SLinus Torvalds {
2171112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2172bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2173112202d9STejun Heo 	bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
217473f53c4aSTejun Heo 	int work_color;
21757e11629dSTejun Heo 	struct worker *collision;
21764e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
21774e6045f1SJohannes Berg 	/*
2178a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2179a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2180a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2181a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2182a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
21834e6045f1SJohannes Berg 	 */
21844d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
21854d82a1deSPeter Zijlstra 
21864d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
21874e6045f1SJohannes Berg #endif
2188807407c0SLai Jiangshan 	/* ensure we're on the correct CPU */
218985327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
2190ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
219125511a47STejun Heo 
21927e11629dSTejun Heo 	/*
21937e11629dSTejun Heo 	 * A single work shouldn't be executed concurrently by
21947e11629dSTejun Heo 	 * multiple workers on a single cpu.  Check whether anyone is
21957e11629dSTejun Heo 	 * already processing the work.  If so, defer the work to the
21967e11629dSTejun Heo 	 * currently executing one.
21977e11629dSTejun Heo 	 */
2198c9e7cf27STejun Heo 	collision = find_worker_executing_work(pool, work);
21997e11629dSTejun Heo 	if (unlikely(collision)) {
22007e11629dSTejun Heo 		move_linked_works(work, &collision->scheduled, NULL);
22017e11629dSTejun Heo 		return;
22027e11629dSTejun Heo 	}
22031da177e4SLinus Torvalds 
22048930cabaSTejun Heo 	/* claim and dequeue */
22051da177e4SLinus Torvalds 	debug_work_deactivate(work);
2206c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2207c34056a3STejun Heo 	worker->current_work = work;
2208a2c1c57bSTejun Heo 	worker->current_func = work->func;
2209112202d9STejun Heo 	worker->current_pwq = pwq;
221073f53c4aSTejun Heo 	work_color = get_work_color(work);
22117a22ad75STejun Heo 
22128bf89593STejun Heo 	/*
22138bf89593STejun Heo 	 * Record wq name for cmdline and debug reporting, may get
22148bf89593STejun Heo 	 * overridden through set_worker_desc().
22158bf89593STejun Heo 	 */
22168bf89593STejun Heo 	strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
22178bf89593STejun Heo 
2218a62428c0STejun Heo 	list_del_init(&work->entry);
2219a62428c0STejun Heo 
2220649027d7STejun Heo 	/*
2221228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
2222228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
2223228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
2224228f1d00SLai Jiangshan 	 * execution of the pending work items.
2225fb0e7bebSTejun Heo 	 */
2226fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2227228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
2228fb0e7bebSTejun Heo 
2229974271c4STejun Heo 	/*
2230a489a03eSLai Jiangshan 	 * Wake up another worker if necessary.  The condition is always
2231a489a03eSLai Jiangshan 	 * false for normal per-cpu workers since nr_running would always
2232a489a03eSLai Jiangshan 	 * be >= 1 at this point.  This is used to chain execution of the
2233a489a03eSLai Jiangshan 	 * pending work items for WORKER_NOT_RUNNING workers such as the
2234228f1d00SLai Jiangshan 	 * UNBOUND and CPU_INTENSIVE ones.
2235974271c4STejun Heo 	 */
2236a489a03eSLai Jiangshan 	if (need_more_worker(pool))
223763d95a91STejun Heo 		wake_up_worker(pool);
2238974271c4STejun Heo 
22398930cabaSTejun Heo 	/*
22407c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
2241d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
224223657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
224323657bb1STejun Heo 	 * disabled.
22448930cabaSTejun Heo 	 */
22457c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
22461da177e4SLinus Torvalds 
2247d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
2248365970a1SDavid Howells 
2249a1d14934SPeter Zijlstra 	lock_map_acquire(&pwq->wq->lockdep_map);
22503295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2251e6f3faa7SPeter Zijlstra 	/*
2252f52be570SPeter Zijlstra 	 * Strictly speaking we should mark the invariant state without holding
2253f52be570SPeter Zijlstra 	 * any locks, that is, before these two lock_map_acquire()'s.
2254e6f3faa7SPeter Zijlstra 	 *
2255e6f3faa7SPeter Zijlstra 	 * However, that would result in:
2256e6f3faa7SPeter Zijlstra 	 *
2257e6f3faa7SPeter Zijlstra 	 *   A(W1)
2258e6f3faa7SPeter Zijlstra 	 *   WFC(C)
2259e6f3faa7SPeter Zijlstra 	 *		A(W1)
2260e6f3faa7SPeter Zijlstra 	 *		C(C)
2261e6f3faa7SPeter Zijlstra 	 *
2262e6f3faa7SPeter Zijlstra 	 * Which would create W1->C->W1 dependencies, even though there is no
2263e6f3faa7SPeter Zijlstra 	 * actual deadlock possible. There are two solutions, using a
2264e6f3faa7SPeter Zijlstra 	 * read-recursive acquire on the work(queue) 'locks', but this will then
2265f52be570SPeter Zijlstra 	 * hit the lockdep limitation on recursive locks, or simply discard
2266e6f3faa7SPeter Zijlstra 	 * these locks.
2267e6f3faa7SPeter Zijlstra 	 *
2268e6f3faa7SPeter Zijlstra 	 * AFAICT there is no possible deadlock scenario between the
2269e6f3faa7SPeter Zijlstra 	 * flush_work() and complete() primitives (except for single-threaded
2270e6f3faa7SPeter Zijlstra 	 * workqueues), so hiding them isn't a problem.
2271e6f3faa7SPeter Zijlstra 	 */
2272f52be570SPeter Zijlstra 	lockdep_invariant_state(true);
2273e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2274a2c1c57bSTejun Heo 	worker->current_func(work);
2275e36c886aSArjan van de Ven 	/*
2276e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2277e36c886aSArjan van de Ven 	 * point will only record its address.
2278e36c886aSArjan van de Ven 	 */
2279e36c886aSArjan van de Ven 	trace_workqueue_execute_end(work);
22803295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
2281112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
22821da177e4SLinus Torvalds 
2283d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2284044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2285044c782cSValentin Ilie 		       "     last function: %pf\n",
2286a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2287a2c1c57bSTejun Heo 		       worker->current_func);
2288d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2289d5abe669SPeter Zijlstra 		dump_stack();
2290d5abe669SPeter Zijlstra 	}
2291d5abe669SPeter Zijlstra 
2292b22ce278STejun Heo 	/*
2293b22ce278STejun Heo 	 * The following prevents a kworker from hogging CPU on !PREEMPT
2294b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
2295b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
2296b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
2297789cbbecSJoe Lawrence 	 * stop_machine. At the same time, report a quiescent RCU state so
2298789cbbecSJoe Lawrence 	 * the same condition doesn't freeze RCU.
2299b22ce278STejun Heo 	 */
2300a7e6425eSPaul E. McKenney 	cond_resched();
2301b22ce278STejun Heo 
2302d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2303a62428c0STejun Heo 
2304fb0e7bebSTejun Heo 	/* clear cpu intensive status */
2305fb0e7bebSTejun Heo 	if (unlikely(cpu_intensive))
2306fb0e7bebSTejun Heo 		worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2307fb0e7bebSTejun Heo 
23081b69ac6bSJohannes Weiner 	/* tag the worker for identification in schedule() */
23091b69ac6bSJohannes Weiner 	worker->last_func = worker->current_func;
23101b69ac6bSJohannes Weiner 
2311a62428c0STejun Heo 	/* we're done with it, release */
231242f8570fSSasha Levin 	hash_del(&worker->hentry);
2313c34056a3STejun Heo 	worker->current_work = NULL;
2314a2c1c57bSTejun Heo 	worker->current_func = NULL;
2315112202d9STejun Heo 	worker->current_pwq = NULL;
2316112202d9STejun Heo 	pwq_dec_nr_in_flight(pwq, work_color);
23171da177e4SLinus Torvalds }
23181da177e4SLinus Torvalds 
2319affee4b2STejun Heo /**
2320affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2321affee4b2STejun Heo  * @worker: self
2322affee4b2STejun Heo  *
2323affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2324affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2325affee4b2STejun Heo  * fetches a work from the top and executes it.
2326affee4b2STejun Heo  *
2327affee4b2STejun Heo  * CONTEXT:
2328d565ed63STejun Heo  * spin_lock_irq(pool->lock) which may be released and regrabbed
2329affee4b2STejun Heo  * multiple times.
2330affee4b2STejun Heo  */
2331affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
23321da177e4SLinus Torvalds {
2333affee4b2STejun Heo 	while (!list_empty(&worker->scheduled)) {
2334affee4b2STejun Heo 		struct work_struct *work = list_first_entry(&worker->scheduled,
2335a62428c0STejun Heo 						struct work_struct, entry);
2336c34056a3STejun Heo 		process_one_work(worker, work);
2337a62428c0STejun Heo 	}
23381da177e4SLinus Torvalds }
23391da177e4SLinus Torvalds 
2340197f6accSTejun Heo static void set_pf_worker(bool val)
2341197f6accSTejun Heo {
2342197f6accSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
2343197f6accSTejun Heo 	if (val)
2344197f6accSTejun Heo 		current->flags |= PF_WQ_WORKER;
2345197f6accSTejun Heo 	else
2346197f6accSTejun Heo 		current->flags &= ~PF_WQ_WORKER;
2347197f6accSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
2348197f6accSTejun Heo }
2349197f6accSTejun Heo 
23504690c4abSTejun Heo /**
23514690c4abSTejun Heo  * worker_thread - the worker thread function
2352c34056a3STejun Heo  * @__worker: self
23534690c4abSTejun Heo  *
2354c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
2355c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
2356c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
2357c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
2358c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
2359d185af30SYacine Belkadi  *
2360d185af30SYacine Belkadi  * Return: 0
23614690c4abSTejun Heo  */
2362c34056a3STejun Heo static int worker_thread(void *__worker)
23631da177e4SLinus Torvalds {
2364c34056a3STejun Heo 	struct worker *worker = __worker;
2365bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
23661da177e4SLinus Torvalds 
2367e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2368197f6accSTejun Heo 	set_pf_worker(true);
2369c8e55f36STejun Heo woke_up:
2370d565ed63STejun Heo 	spin_lock_irq(&pool->lock);
2371affee4b2STejun Heo 
2372a9ab775bSTejun Heo 	/* am I supposed to die? */
2373a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
2374d565ed63STejun Heo 		spin_unlock_irq(&pool->lock);
2375a9ab775bSTejun Heo 		WARN_ON_ONCE(!list_empty(&worker->entry));
2376197f6accSTejun Heo 		set_pf_worker(false);
237760f5a4bcSLai Jiangshan 
237860f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
23797cda9aaeSLai Jiangshan 		ida_simple_remove(&pool->worker_ida, worker->id);
2380a2d812a2STejun Heo 		worker_detach_from_pool(worker);
238160f5a4bcSLai Jiangshan 		kfree(worker);
2382c8e55f36STejun Heo 		return 0;
2383c8e55f36STejun Heo 	}
2384c8e55f36STejun Heo 
2385c8e55f36STejun Heo 	worker_leave_idle(worker);
2386db7bccf4STejun Heo recheck:
2387e22bee78STejun Heo 	/* no more worker necessary? */
238863d95a91STejun Heo 	if (!need_more_worker(pool))
2389e22bee78STejun Heo 		goto sleep;
2390e22bee78STejun Heo 
2391e22bee78STejun Heo 	/* do we need to manage? */
239263d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2393e22bee78STejun Heo 		goto recheck;
2394e22bee78STejun Heo 
2395c8e55f36STejun Heo 	/*
2396c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2397c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2398c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2399c8e55f36STejun Heo 	 */
24006183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
2401c8e55f36STejun Heo 
2402e22bee78STejun Heo 	/*
2403a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
2404a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
2405a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
2406a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
2407a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
2408e22bee78STejun Heo 	 */
2409a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2410e22bee78STejun Heo 
2411e22bee78STejun Heo 	do {
2412affee4b2STejun Heo 		struct work_struct *work =
2413bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2414affee4b2STejun Heo 					 struct work_struct, entry);
2415affee4b2STejun Heo 
241682607adcSTejun Heo 		pool->watchdog_ts = jiffies;
241782607adcSTejun Heo 
2418c8e55f36STejun Heo 		if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2419affee4b2STejun Heo 			/* optimization path, not strictly necessary */
2420affee4b2STejun Heo 			process_one_work(worker, work);
2421affee4b2STejun Heo 			if (unlikely(!list_empty(&worker->scheduled)))
2422affee4b2STejun Heo 				process_scheduled_works(worker);
2423affee4b2STejun Heo 		} else {
2424c8e55f36STejun Heo 			move_linked_works(work, &worker->scheduled, NULL);
2425affee4b2STejun Heo 			process_scheduled_works(worker);
2426affee4b2STejun Heo 		}
242763d95a91STejun Heo 	} while (keep_working(pool));
2428affee4b2STejun Heo 
2429228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
2430d313dd85STejun Heo sleep:
2431c8e55f36STejun Heo 	/*
2432d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
2433d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
2434d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
2435d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
2436d565ed63STejun Heo 	 * event.
2437c8e55f36STejun Heo 	 */
2438c8e55f36STejun Heo 	worker_enter_idle(worker);
2439c5a94a61SPeter Zijlstra 	__set_current_state(TASK_IDLE);
2440d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
24411da177e4SLinus Torvalds 	schedule();
2442c8e55f36STejun Heo 	goto woke_up;
24431da177e4SLinus Torvalds }
24441da177e4SLinus Torvalds 
2445e22bee78STejun Heo /**
2446e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2447111c225aSTejun Heo  * @__rescuer: self
2448e22bee78STejun Heo  *
2449e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2450493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
2451e22bee78STejun Heo  *
2452706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
2453e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2454e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2455e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2456e22bee78STejun Heo  * the problem rescuer solves.
2457e22bee78STejun Heo  *
2458706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
2459706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
2460e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2461e22bee78STejun Heo  *
2462e22bee78STejun Heo  * This should happen rarely.
2463d185af30SYacine Belkadi  *
2464d185af30SYacine Belkadi  * Return: 0
2465e22bee78STejun Heo  */
2466111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2467e22bee78STejun Heo {
2468111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2469111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
2470e22bee78STejun Heo 	struct list_head *scheduled = &rescuer->scheduled;
24714d595b86SLai Jiangshan 	bool should_stop;
2472e22bee78STejun Heo 
2473e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2474111c225aSTejun Heo 
2475111c225aSTejun Heo 	/*
2476111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2477111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2478111c225aSTejun Heo 	 */
2479197f6accSTejun Heo 	set_pf_worker(true);
2480e22bee78STejun Heo repeat:
2481c5a94a61SPeter Zijlstra 	set_current_state(TASK_IDLE);
24821da177e4SLinus Torvalds 
24834d595b86SLai Jiangshan 	/*
24844d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
24854d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
24864d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
24874d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
24884d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
24894d595b86SLai Jiangshan 	 * list is always empty on exit.
24904d595b86SLai Jiangshan 	 */
24914d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
24921da177e4SLinus Torvalds 
2493493a1724STejun Heo 	/* see whether any pwq is asking for help */
24942e109a28STejun Heo 	spin_lock_irq(&wq_mayday_lock);
2495493a1724STejun Heo 
2496493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
2497493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2498493a1724STejun Heo 					struct pool_workqueue, mayday_node);
2499112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
2500e22bee78STejun Heo 		struct work_struct *work, *n;
250182607adcSTejun Heo 		bool first = true;
2502e22bee78STejun Heo 
2503e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2504493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
2505493a1724STejun Heo 
25062e109a28STejun Heo 		spin_unlock_irq(&wq_mayday_lock);
2507e22bee78STejun Heo 
250851697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
250951697d39SLai Jiangshan 
251051697d39SLai Jiangshan 		spin_lock_irq(&pool->lock);
2511e22bee78STejun Heo 
2512e22bee78STejun Heo 		/*
2513e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2514e22bee78STejun Heo 		 * process'em.
2515e22bee78STejun Heo 		 */
25160479c8c5STejun Heo 		WARN_ON_ONCE(!list_empty(scheduled));
251782607adcSTejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry) {
251882607adcSTejun Heo 			if (get_work_pwq(work) == pwq) {
251982607adcSTejun Heo 				if (first)
252082607adcSTejun Heo 					pool->watchdog_ts = jiffies;
2521e22bee78STejun Heo 				move_linked_works(work, scheduled, &n);
252282607adcSTejun Heo 			}
252382607adcSTejun Heo 			first = false;
252482607adcSTejun Heo 		}
2525e22bee78STejun Heo 
2526008847f6SNeilBrown 		if (!list_empty(scheduled)) {
2527e22bee78STejun Heo 			process_scheduled_works(rescuer);
25287576958aSTejun Heo 
25297576958aSTejun Heo 			/*
2530008847f6SNeilBrown 			 * The above execution of rescued work items could
2531008847f6SNeilBrown 			 * have created more to rescue through
2532008847f6SNeilBrown 			 * pwq_activate_first_delayed() or chained
2533008847f6SNeilBrown 			 * queueing.  Let's put @pwq back on mayday list so
2534008847f6SNeilBrown 			 * that such back-to-back work items, which may be
2535008847f6SNeilBrown 			 * being used to relieve memory pressure, don't
2536008847f6SNeilBrown 			 * incur MAYDAY_INTERVAL delay inbetween.
2537008847f6SNeilBrown 			 */
2538008847f6SNeilBrown 			if (need_to_create_worker(pool)) {
2539008847f6SNeilBrown 				spin_lock(&wq_mayday_lock);
2540008847f6SNeilBrown 				get_pwq(pwq);
2541008847f6SNeilBrown 				list_move_tail(&pwq->mayday_node, &wq->maydays);
2542008847f6SNeilBrown 				spin_unlock(&wq_mayday_lock);
2543008847f6SNeilBrown 			}
2544008847f6SNeilBrown 		}
2545008847f6SNeilBrown 
2546008847f6SNeilBrown 		/*
254777668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
254813b1d625SLai Jiangshan 		 * go away while we're still attached to it.
254977668c8bSLai Jiangshan 		 */
255077668c8bSLai Jiangshan 		put_pwq(pwq);
255177668c8bSLai Jiangshan 
255277668c8bSLai Jiangshan 		/*
2553d8ca83e6SLai Jiangshan 		 * Leave this pool.  If need_more_worker() is %true, notify a
25547576958aSTejun Heo 		 * regular worker; otherwise, we end up with 0 concurrency
25557576958aSTejun Heo 		 * and stalling the execution.
25567576958aSTejun Heo 		 */
2557d8ca83e6SLai Jiangshan 		if (need_more_worker(pool))
255863d95a91STejun Heo 			wake_up_worker(pool);
25597576958aSTejun Heo 
256013b1d625SLai Jiangshan 		spin_unlock_irq(&pool->lock);
256113b1d625SLai Jiangshan 
2562a2d812a2STejun Heo 		worker_detach_from_pool(rescuer);
256313b1d625SLai Jiangshan 
256413b1d625SLai Jiangshan 		spin_lock_irq(&wq_mayday_lock);
25651da177e4SLinus Torvalds 	}
25661da177e4SLinus Torvalds 
25672e109a28STejun Heo 	spin_unlock_irq(&wq_mayday_lock);
2568493a1724STejun Heo 
25694d595b86SLai Jiangshan 	if (should_stop) {
25704d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
2571197f6accSTejun Heo 		set_pf_worker(false);
25724d595b86SLai Jiangshan 		return 0;
25734d595b86SLai Jiangshan 	}
25744d595b86SLai Jiangshan 
2575111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2576111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2577e22bee78STejun Heo 	schedule();
2578e22bee78STejun Heo 	goto repeat;
25791da177e4SLinus Torvalds }
25801da177e4SLinus Torvalds 
2581fca839c0STejun Heo /**
2582fca839c0STejun Heo  * check_flush_dependency - check for flush dependency sanity
2583fca839c0STejun Heo  * @target_wq: workqueue being flushed
2584fca839c0STejun Heo  * @target_work: work item being flushed (NULL for workqueue flushes)
2585fca839c0STejun Heo  *
2586fca839c0STejun Heo  * %current is trying to flush the whole @target_wq or @target_work on it.
2587fca839c0STejun Heo  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2588fca839c0STejun Heo  * reclaiming memory or running on a workqueue which doesn't have
2589fca839c0STejun Heo  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2590fca839c0STejun Heo  * a deadlock.
2591fca839c0STejun Heo  */
2592fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq,
2593fca839c0STejun Heo 				   struct work_struct *target_work)
2594fca839c0STejun Heo {
2595fca839c0STejun Heo 	work_func_t target_func = target_work ? target_work->func : NULL;
2596fca839c0STejun Heo 	struct worker *worker;
2597fca839c0STejun Heo 
2598fca839c0STejun Heo 	if (target_wq->flags & WQ_MEM_RECLAIM)
2599fca839c0STejun Heo 		return;
2600fca839c0STejun Heo 
2601fca839c0STejun Heo 	worker = current_wq_worker();
2602fca839c0STejun Heo 
2603fca839c0STejun Heo 	WARN_ONCE(current->flags & PF_MEMALLOC,
2604fca839c0STejun Heo 		  "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2605fca839c0STejun Heo 		  current->pid, current->comm, target_wq->name, target_func);
260623d11a58STejun Heo 	WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
260723d11a58STejun Heo 			      (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
2608fca839c0STejun Heo 		  "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2609fca839c0STejun Heo 		  worker->current_pwq->wq->name, worker->current_func,
2610fca839c0STejun Heo 		  target_wq->name, target_func);
2611fca839c0STejun Heo }
2612fca839c0STejun Heo 
2613fc2e4d70SOleg Nesterov struct wq_barrier {
2614fc2e4d70SOleg Nesterov 	struct work_struct	work;
2615fc2e4d70SOleg Nesterov 	struct completion	done;
26162607d7a6STejun Heo 	struct task_struct	*task;	/* purely informational */
2617fc2e4d70SOleg Nesterov };
2618fc2e4d70SOleg Nesterov 
2619fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2620fc2e4d70SOleg Nesterov {
2621fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2622fc2e4d70SOleg Nesterov 	complete(&barr->done);
2623fc2e4d70SOleg Nesterov }
2624fc2e4d70SOleg Nesterov 
26254690c4abSTejun Heo /**
26264690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
2627112202d9STejun Heo  * @pwq: pwq to insert barrier into
26284690c4abSTejun Heo  * @barr: wq_barrier to insert
2629affee4b2STejun Heo  * @target: target work to attach @barr to
2630affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
26314690c4abSTejun Heo  *
2632affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2633affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2634affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2635affee4b2STejun Heo  * cpu.
2636affee4b2STejun Heo  *
2637affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2638affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2639affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2640affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2641affee4b2STejun Heo  * after a work with LINKED flag set.
2642affee4b2STejun Heo  *
2643affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
2644112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
26454690c4abSTejun Heo  *
26464690c4abSTejun Heo  * CONTEXT:
2647d565ed63STejun Heo  * spin_lock_irq(pool->lock).
26484690c4abSTejun Heo  */
2649112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
2650affee4b2STejun Heo 			      struct wq_barrier *barr,
2651affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
2652fc2e4d70SOleg Nesterov {
2653affee4b2STejun Heo 	struct list_head *head;
2654affee4b2STejun Heo 	unsigned int linked = 0;
2655affee4b2STejun Heo 
2656dc186ad7SThomas Gleixner 	/*
2657d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
2658dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
2659dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
2660dc186ad7SThomas Gleixner 	 * might deadlock.
2661dc186ad7SThomas Gleixner 	 */
2662ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
266322df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
266452fa5bc5SBoqun Feng 
2665fd1a5b04SByungchul Park 	init_completion_map(&barr->done, &target->lockdep_map);
2666fd1a5b04SByungchul Park 
26672607d7a6STejun Heo 	barr->task = current;
266883c22520SOleg Nesterov 
2669affee4b2STejun Heo 	/*
2670affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
2671affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
2672affee4b2STejun Heo 	 */
2673affee4b2STejun Heo 	if (worker)
2674affee4b2STejun Heo 		head = worker->scheduled.next;
2675affee4b2STejun Heo 	else {
2676affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
2677affee4b2STejun Heo 
2678affee4b2STejun Heo 		head = target->entry.next;
2679affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
2680affee4b2STejun Heo 		linked = *bits & WORK_STRUCT_LINKED;
2681affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
2682affee4b2STejun Heo 	}
2683affee4b2STejun Heo 
2684dc186ad7SThomas Gleixner 	debug_work_activate(&barr->work);
2685112202d9STejun Heo 	insert_work(pwq, &barr->work, head,
2686affee4b2STejun Heo 		    work_color_to_flags(WORK_NO_COLOR) | linked);
2687fc2e4d70SOleg Nesterov }
2688fc2e4d70SOleg Nesterov 
268973f53c4aSTejun Heo /**
2690112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
269173f53c4aSTejun Heo  * @wq: workqueue being flushed
269273f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
269373f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
269473f53c4aSTejun Heo  *
2695112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
269673f53c4aSTejun Heo  *
2697112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
2698112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
2699112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
2700112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
2701112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
270273f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
270373f53c4aSTejun Heo  *
270473f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
270573f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
270673f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
270773f53c4aSTejun Heo  * is returned.
270873f53c4aSTejun Heo  *
2709112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
271073f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
271173f53c4aSTejun Heo  * advanced to @work_color.
271273f53c4aSTejun Heo  *
271373f53c4aSTejun Heo  * CONTEXT:
27143c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
271573f53c4aSTejun Heo  *
2716d185af30SYacine Belkadi  * Return:
271773f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
271873f53c4aSTejun Heo  * otherwise.
271973f53c4aSTejun Heo  */
2720112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
272173f53c4aSTejun Heo 				      int flush_color, int work_color)
27221da177e4SLinus Torvalds {
272373f53c4aSTejun Heo 	bool wait = false;
272449e3cf44STejun Heo 	struct pool_workqueue *pwq;
27251da177e4SLinus Torvalds 
272673f53c4aSTejun Heo 	if (flush_color >= 0) {
27276183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2728112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
2729dc186ad7SThomas Gleixner 	}
273014441960SOleg Nesterov 
273149e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2732112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
27331da177e4SLinus Torvalds 
2734b09f4fd3SLai Jiangshan 		spin_lock_irq(&pool->lock);
273573f53c4aSTejun Heo 
273673f53c4aSTejun Heo 		if (flush_color >= 0) {
27376183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
273873f53c4aSTejun Heo 
2739112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
2740112202d9STejun Heo 				pwq->flush_color = flush_color;
2741112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
274273f53c4aSTejun Heo 				wait = true;
27431da177e4SLinus Torvalds 			}
274473f53c4aSTejun Heo 		}
274573f53c4aSTejun Heo 
274673f53c4aSTejun Heo 		if (work_color >= 0) {
27476183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2748112202d9STejun Heo 			pwq->work_color = work_color;
274973f53c4aSTejun Heo 		}
275073f53c4aSTejun Heo 
2751b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pool->lock);
27521da177e4SLinus Torvalds 	}
27531da177e4SLinus Torvalds 
2754112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
275573f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
275673f53c4aSTejun Heo 
275773f53c4aSTejun Heo 	return wait;
275883c22520SOleg Nesterov }
27591da177e4SLinus Torvalds 
27600fcb78c2SRolf Eike Beer /**
27611da177e4SLinus Torvalds  * flush_workqueue - ensure that any scheduled work has run to completion.
27620fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
27631da177e4SLinus Torvalds  *
2764c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
2765c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
27661da177e4SLinus Torvalds  */
27677ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq)
27681da177e4SLinus Torvalds {
276973f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
277073f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
277173f53c4aSTejun Heo 		.flush_color = -1,
2772fd1a5b04SByungchul Park 		.done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
277373f53c4aSTejun Heo 	};
277473f53c4aSTejun Heo 	int next_color;
2775b1f4ec17SOleg Nesterov 
27763347fa09STejun Heo 	if (WARN_ON(!wq_online))
27773347fa09STejun Heo 		return;
27783347fa09STejun Heo 
277987915adcSJohannes Berg 	lock_map_acquire(&wq->lockdep_map);
278087915adcSJohannes Berg 	lock_map_release(&wq->lockdep_map);
278187915adcSJohannes Berg 
27823c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
278373f53c4aSTejun Heo 
278473f53c4aSTejun Heo 	/*
278573f53c4aSTejun Heo 	 * Start-to-wait phase
278673f53c4aSTejun Heo 	 */
278773f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
278873f53c4aSTejun Heo 
278973f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
279073f53c4aSTejun Heo 		/*
279173f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
279273f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
279373f53c4aSTejun Heo 		 * by one.
279473f53c4aSTejun Heo 		 */
27956183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
279673f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
279773f53c4aSTejun Heo 		wq->work_color = next_color;
279873f53c4aSTejun Heo 
279973f53c4aSTejun Heo 		if (!wq->first_flusher) {
280073f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
28016183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
280273f53c4aSTejun Heo 
280373f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
280473f53c4aSTejun Heo 
2805112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
280673f53c4aSTejun Heo 						       wq->work_color)) {
280773f53c4aSTejun Heo 				/* nothing to flush, done */
280873f53c4aSTejun Heo 				wq->flush_color = next_color;
280973f53c4aSTejun Heo 				wq->first_flusher = NULL;
281073f53c4aSTejun Heo 				goto out_unlock;
281173f53c4aSTejun Heo 			}
281273f53c4aSTejun Heo 		} else {
281373f53c4aSTejun Heo 			/* wait in queue */
28146183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
281573f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
2816112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
281773f53c4aSTejun Heo 		}
281873f53c4aSTejun Heo 	} else {
281973f53c4aSTejun Heo 		/*
282073f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
282173f53c4aSTejun Heo 		 * The next flush completion will assign us
282273f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
282373f53c4aSTejun Heo 		 */
282473f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
282573f53c4aSTejun Heo 	}
282673f53c4aSTejun Heo 
2827fca839c0STejun Heo 	check_flush_dependency(wq, NULL);
2828fca839c0STejun Heo 
28293c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
283073f53c4aSTejun Heo 
283173f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
283273f53c4aSTejun Heo 
283373f53c4aSTejun Heo 	/*
283473f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
283573f53c4aSTejun Heo 	 *
283673f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
283773f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
283873f53c4aSTejun Heo 	 */
283973f53c4aSTejun Heo 	if (wq->first_flusher != &this_flusher)
284073f53c4aSTejun Heo 		return;
284173f53c4aSTejun Heo 
28423c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
284373f53c4aSTejun Heo 
28444ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
28454ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
28464ce48b37STejun Heo 		goto out_unlock;
28474ce48b37STejun Heo 
284873f53c4aSTejun Heo 	wq->first_flusher = NULL;
284973f53c4aSTejun Heo 
28506183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
28516183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
285273f53c4aSTejun Heo 
285373f53c4aSTejun Heo 	while (true) {
285473f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
285573f53c4aSTejun Heo 
285673f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
285773f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
285873f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
285973f53c4aSTejun Heo 				break;
286073f53c4aSTejun Heo 			list_del_init(&next->list);
286173f53c4aSTejun Heo 			complete(&next->done);
286273f53c4aSTejun Heo 		}
286373f53c4aSTejun Heo 
28646183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
286573f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
286673f53c4aSTejun Heo 
286773f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
286873f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
286973f53c4aSTejun Heo 
287073f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
287173f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
287273f53c4aSTejun Heo 			/*
287373f53c4aSTejun Heo 			 * Assign the same color to all overflowed
287473f53c4aSTejun Heo 			 * flushers, advance work_color and append to
287573f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
287673f53c4aSTejun Heo 			 * phase for these overflowed flushers.
287773f53c4aSTejun Heo 			 */
287873f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
287973f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
288073f53c4aSTejun Heo 
288173f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
288273f53c4aSTejun Heo 
288373f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
288473f53c4aSTejun Heo 					      &wq->flusher_queue);
2885112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
288673f53c4aSTejun Heo 		}
288773f53c4aSTejun Heo 
288873f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
28896183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
289073f53c4aSTejun Heo 			break;
289173f53c4aSTejun Heo 		}
289273f53c4aSTejun Heo 
289373f53c4aSTejun Heo 		/*
289473f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
2895112202d9STejun Heo 		 * the new first flusher and arm pwqs.
289673f53c4aSTejun Heo 		 */
28976183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
28986183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
289973f53c4aSTejun Heo 
290073f53c4aSTejun Heo 		list_del_init(&next->list);
290173f53c4aSTejun Heo 		wq->first_flusher = next;
290273f53c4aSTejun Heo 
2903112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
290473f53c4aSTejun Heo 			break;
290573f53c4aSTejun Heo 
290673f53c4aSTejun Heo 		/*
290773f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
290873f53c4aSTejun Heo 		 * flusher and repeat cascading.
290973f53c4aSTejun Heo 		 */
291073f53c4aSTejun Heo 		wq->first_flusher = NULL;
291173f53c4aSTejun Heo 	}
291273f53c4aSTejun Heo 
291373f53c4aSTejun Heo out_unlock:
29143c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
29151da177e4SLinus Torvalds }
29161dadafa8STim Gardner EXPORT_SYMBOL(flush_workqueue);
29171da177e4SLinus Torvalds 
29189c5a2ba7STejun Heo /**
29199c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
29209c5a2ba7STejun Heo  * @wq: workqueue to drain
29219c5a2ba7STejun Heo  *
29229c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
29239c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
29249c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
2925b749b1b6SChen Hanxiao  * repeatedly until it becomes empty.  The number of flushing is determined
29269c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
29279c5a2ba7STejun Heo  * takes too long.
29289c5a2ba7STejun Heo  */
29299c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
29309c5a2ba7STejun Heo {
29319c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
293249e3cf44STejun Heo 	struct pool_workqueue *pwq;
29339c5a2ba7STejun Heo 
29349c5a2ba7STejun Heo 	/*
29359c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
29369c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
2937618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
29389c5a2ba7STejun Heo 	 */
293987fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
29409c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
2941618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
294287fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
29439c5a2ba7STejun Heo reflush:
29449c5a2ba7STejun Heo 	flush_workqueue(wq);
29459c5a2ba7STejun Heo 
2946b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
294776af4d93STejun Heo 
294849e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
2949fa2563e4SThomas Tuttle 		bool drained;
29509c5a2ba7STejun Heo 
2951b09f4fd3SLai Jiangshan 		spin_lock_irq(&pwq->pool->lock);
2952112202d9STejun Heo 		drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2953b09f4fd3SLai Jiangshan 		spin_unlock_irq(&pwq->pool->lock);
2954fa2563e4SThomas Tuttle 
2955fa2563e4SThomas Tuttle 		if (drained)
29569c5a2ba7STejun Heo 			continue;
29579c5a2ba7STejun Heo 
29589c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
29599c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2960c5aa87bbSTejun Heo 			pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
29619c5a2ba7STejun Heo 				wq->name, flush_cnt);
296276af4d93STejun Heo 
2963b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
29649c5a2ba7STejun Heo 		goto reflush;
29659c5a2ba7STejun Heo 	}
29669c5a2ba7STejun Heo 
29679c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
2968618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
296987fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
29709c5a2ba7STejun Heo }
29719c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
29729c5a2ba7STejun Heo 
2973d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2974d6e89786SJohannes Berg 			     bool from_cancel)
2975baf59022STejun Heo {
2976baf59022STejun Heo 	struct worker *worker = NULL;
2977c9e7cf27STejun Heo 	struct worker_pool *pool;
2978112202d9STejun Heo 	struct pool_workqueue *pwq;
2979baf59022STejun Heo 
2980baf59022STejun Heo 	might_sleep();
2981baf59022STejun Heo 
2982*24acfb71SThomas Gleixner 	rcu_read_lock();
2983fa1b54e6STejun Heo 	pool = get_work_pool(work);
2984fa1b54e6STejun Heo 	if (!pool) {
2985*24acfb71SThomas Gleixner 		rcu_read_unlock();
2986fa1b54e6STejun Heo 		return false;
2987fa1b54e6STejun Heo 	}
2988fa1b54e6STejun Heo 
2989*24acfb71SThomas Gleixner 	spin_lock_irq(&pool->lock);
29900b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
2991112202d9STejun Heo 	pwq = get_work_pwq(work);
2992112202d9STejun Heo 	if (pwq) {
2993112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
2994baf59022STejun Heo 			goto already_gone;
2995606a5020STejun Heo 	} else {
2996c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
2997baf59022STejun Heo 		if (!worker)
2998baf59022STejun Heo 			goto already_gone;
2999112202d9STejun Heo 		pwq = worker->current_pwq;
3000606a5020STejun Heo 	}
3001baf59022STejun Heo 
3002fca839c0STejun Heo 	check_flush_dependency(pwq->wq, work);
3003fca839c0STejun Heo 
3004112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
3005d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
3006baf59022STejun Heo 
3007e159489bSTejun Heo 	/*
3008a1d14934SPeter Zijlstra 	 * Force a lock recursion deadlock when using flush_work() inside a
3009a1d14934SPeter Zijlstra 	 * single-threaded or rescuer equipped workqueue.
3010a1d14934SPeter Zijlstra 	 *
3011a1d14934SPeter Zijlstra 	 * For single threaded workqueues the deadlock happens when the work
3012a1d14934SPeter Zijlstra 	 * is after the work issuing the flush_work(). For rescuer equipped
3013a1d14934SPeter Zijlstra 	 * workqueues the deadlock happens when the rescuer stalls, blocking
3014a1d14934SPeter Zijlstra 	 * forward progress.
3015e159489bSTejun Heo 	 */
3016d6e89786SJohannes Berg 	if (!from_cancel &&
3017d6e89786SJohannes Berg 	    (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
3018112202d9STejun Heo 		lock_map_acquire(&pwq->wq->lockdep_map);
3019112202d9STejun Heo 		lock_map_release(&pwq->wq->lockdep_map);
3020a1d14934SPeter Zijlstra 	}
3021*24acfb71SThomas Gleixner 	rcu_read_unlock();
3022baf59022STejun Heo 	return true;
3023baf59022STejun Heo already_gone:
3024d565ed63STejun Heo 	spin_unlock_irq(&pool->lock);
3025*24acfb71SThomas Gleixner 	rcu_read_unlock();
3026baf59022STejun Heo 	return false;
3027baf59022STejun Heo }
3028baf59022STejun Heo 
3029d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel)
3030d6e89786SJohannes Berg {
3031d6e89786SJohannes Berg 	struct wq_barrier barr;
3032d6e89786SJohannes Berg 
3033d6e89786SJohannes Berg 	if (WARN_ON(!wq_online))
3034d6e89786SJohannes Berg 		return false;
3035d6e89786SJohannes Berg 
30364d43d395STetsuo Handa 	if (WARN_ON(!work->func))
30374d43d395STetsuo Handa 		return false;
30384d43d395STetsuo Handa 
303987915adcSJohannes Berg 	if (!from_cancel) {
304087915adcSJohannes Berg 		lock_map_acquire(&work->lockdep_map);
304187915adcSJohannes Berg 		lock_map_release(&work->lockdep_map);
304287915adcSJohannes Berg 	}
304387915adcSJohannes Berg 
3044d6e89786SJohannes Berg 	if (start_flush_work(work, &barr, from_cancel)) {
3045d6e89786SJohannes Berg 		wait_for_completion(&barr.done);
3046d6e89786SJohannes Berg 		destroy_work_on_stack(&barr.work);
3047d6e89786SJohannes Berg 		return true;
3048d6e89786SJohannes Berg 	} else {
3049d6e89786SJohannes Berg 		return false;
3050d6e89786SJohannes Berg 	}
3051d6e89786SJohannes Berg }
3052d6e89786SJohannes Berg 
3053db700897SOleg Nesterov /**
3054401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
3055401a8d04STejun Heo  * @work: the work to flush
3056db700897SOleg Nesterov  *
3057606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
3058606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
3059401a8d04STejun Heo  *
3060d185af30SYacine Belkadi  * Return:
3061401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3062401a8d04STejun Heo  * %false if it was already idle.
3063db700897SOleg Nesterov  */
3064401a8d04STejun Heo bool flush_work(struct work_struct *work)
3065db700897SOleg Nesterov {
3066d6e89786SJohannes Berg 	return __flush_work(work, false);
3067606a5020STejun Heo }
3068db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
3069db700897SOleg Nesterov 
30708603e1b3STejun Heo struct cwt_wait {
3071ac6424b9SIngo Molnar 	wait_queue_entry_t		wait;
30728603e1b3STejun Heo 	struct work_struct	*work;
30738603e1b3STejun Heo };
30748603e1b3STejun Heo 
3075ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
30768603e1b3STejun Heo {
30778603e1b3STejun Heo 	struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
30788603e1b3STejun Heo 
30798603e1b3STejun Heo 	if (cwait->work != key)
30808603e1b3STejun Heo 		return 0;
30818603e1b3STejun Heo 	return autoremove_wake_function(wait, mode, sync, key);
30828603e1b3STejun Heo }
30838603e1b3STejun Heo 
308436e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
3085401a8d04STejun Heo {
30868603e1b3STejun Heo 	static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
3087bbb68dfaSTejun Heo 	unsigned long flags;
30881f1f642eSOleg Nesterov 	int ret;
30891f1f642eSOleg Nesterov 
30901f1f642eSOleg Nesterov 	do {
3091bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
3092bbb68dfaSTejun Heo 		/*
30938603e1b3STejun Heo 		 * If someone else is already canceling, wait for it to
30948603e1b3STejun Heo 		 * finish.  flush_work() doesn't work for PREEMPT_NONE
30958603e1b3STejun Heo 		 * because we may get scheduled between @work's completion
30968603e1b3STejun Heo 		 * and the other canceling task resuming and clearing
30978603e1b3STejun Heo 		 * CANCELING - flush_work() will return false immediately
30988603e1b3STejun Heo 		 * as @work is no longer busy, try_to_grab_pending() will
30998603e1b3STejun Heo 		 * return -ENOENT as @work is still being canceled and the
31008603e1b3STejun Heo 		 * other canceling task won't be able to clear CANCELING as
31018603e1b3STejun Heo 		 * we're hogging the CPU.
31028603e1b3STejun Heo 		 *
31038603e1b3STejun Heo 		 * Let's wait for completion using a waitqueue.  As this
31048603e1b3STejun Heo 		 * may lead to the thundering herd problem, use a custom
31058603e1b3STejun Heo 		 * wake function which matches @work along with exclusive
31068603e1b3STejun Heo 		 * wait and wakeup.
3107bbb68dfaSTejun Heo 		 */
31088603e1b3STejun Heo 		if (unlikely(ret == -ENOENT)) {
31098603e1b3STejun Heo 			struct cwt_wait cwait;
31108603e1b3STejun Heo 
31118603e1b3STejun Heo 			init_wait(&cwait.wait);
31128603e1b3STejun Heo 			cwait.wait.func = cwt_wakefn;
31138603e1b3STejun Heo 			cwait.work = work;
31148603e1b3STejun Heo 
31158603e1b3STejun Heo 			prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
31168603e1b3STejun Heo 						  TASK_UNINTERRUPTIBLE);
31178603e1b3STejun Heo 			if (work_is_canceling(work))
31188603e1b3STejun Heo 				schedule();
31198603e1b3STejun Heo 			finish_wait(&cancel_waitq, &cwait.wait);
31208603e1b3STejun Heo 		}
31211f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
31221f1f642eSOleg Nesterov 
3123bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
3124bbb68dfaSTejun Heo 	mark_work_canceling(work);
3125bbb68dfaSTejun Heo 	local_irq_restore(flags);
3126bbb68dfaSTejun Heo 
31273347fa09STejun Heo 	/*
31283347fa09STejun Heo 	 * This allows canceling during early boot.  We know that @work
31293347fa09STejun Heo 	 * isn't executing.
31303347fa09STejun Heo 	 */
31313347fa09STejun Heo 	if (wq_online)
3132d6e89786SJohannes Berg 		__flush_work(work, true);
31333347fa09STejun Heo 
31347a22ad75STejun Heo 	clear_work_data(work);
31358603e1b3STejun Heo 
31368603e1b3STejun Heo 	/*
31378603e1b3STejun Heo 	 * Paired with prepare_to_wait() above so that either
31388603e1b3STejun Heo 	 * waitqueue_active() is visible here or !work_is_canceling() is
31398603e1b3STejun Heo 	 * visible there.
31408603e1b3STejun Heo 	 */
31418603e1b3STejun Heo 	smp_mb();
31428603e1b3STejun Heo 	if (waitqueue_active(&cancel_waitq))
31438603e1b3STejun Heo 		__wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
31448603e1b3STejun Heo 
31451f1f642eSOleg Nesterov 	return ret;
31461f1f642eSOleg Nesterov }
31471f1f642eSOleg Nesterov 
31486e84d644SOleg Nesterov /**
3149401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
3150401a8d04STejun Heo  * @work: the work to cancel
31516e84d644SOleg Nesterov  *
3152401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
3153401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
3154401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
3155401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
31561f1f642eSOleg Nesterov  *
3157401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
3158401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
31596e84d644SOleg Nesterov  *
3160401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
31616e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
3162401a8d04STejun Heo  *
3163d185af30SYacine Belkadi  * Return:
3164401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
31656e84d644SOleg Nesterov  */
3166401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
31676e84d644SOleg Nesterov {
316836e227d2STejun Heo 	return __cancel_work_timer(work, false);
3169b89deed3SOleg Nesterov }
317028e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
3171b89deed3SOleg Nesterov 
31726e84d644SOleg Nesterov /**
3173401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
3174401a8d04STejun Heo  * @dwork: the delayed work to flush
31756e84d644SOleg Nesterov  *
3176401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
3177401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
3178401a8d04STejun Heo  * considers the last queueing instance of @dwork.
31791f1f642eSOleg Nesterov  *
3180d185af30SYacine Belkadi  * Return:
3181401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3182401a8d04STejun Heo  * %false if it was already idle.
31836e84d644SOleg Nesterov  */
3184401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
3185401a8d04STejun Heo {
31868930cabaSTejun Heo 	local_irq_disable();
3187401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
318860c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
31898930cabaSTejun Heo 	local_irq_enable();
3190401a8d04STejun Heo 	return flush_work(&dwork->work);
3191401a8d04STejun Heo }
3192401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
3193401a8d04STejun Heo 
319405f0fe6bSTejun Heo /**
319505f0fe6bSTejun Heo  * flush_rcu_work - wait for a rwork to finish executing the last queueing
319605f0fe6bSTejun Heo  * @rwork: the rcu work to flush
319705f0fe6bSTejun Heo  *
319805f0fe6bSTejun Heo  * Return:
319905f0fe6bSTejun Heo  * %true if flush_rcu_work() waited for the work to finish execution,
320005f0fe6bSTejun Heo  * %false if it was already idle.
320105f0fe6bSTejun Heo  */
320205f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork)
320305f0fe6bSTejun Heo {
320405f0fe6bSTejun Heo 	if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
320505f0fe6bSTejun Heo 		rcu_barrier();
320605f0fe6bSTejun Heo 		flush_work(&rwork->work);
320705f0fe6bSTejun Heo 		return true;
320805f0fe6bSTejun Heo 	} else {
320905f0fe6bSTejun Heo 		return flush_work(&rwork->work);
321005f0fe6bSTejun Heo 	}
321105f0fe6bSTejun Heo }
321205f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work);
321305f0fe6bSTejun Heo 
3214f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork)
3215f72b8792SJens Axboe {
3216f72b8792SJens Axboe 	unsigned long flags;
3217f72b8792SJens Axboe 	int ret;
3218f72b8792SJens Axboe 
3219f72b8792SJens Axboe 	do {
3220f72b8792SJens Axboe 		ret = try_to_grab_pending(work, is_dwork, &flags);
3221f72b8792SJens Axboe 	} while (unlikely(ret == -EAGAIN));
3222f72b8792SJens Axboe 
3223f72b8792SJens Axboe 	if (unlikely(ret < 0))
3224f72b8792SJens Axboe 		return false;
3225f72b8792SJens Axboe 
3226f72b8792SJens Axboe 	set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3227f72b8792SJens Axboe 	local_irq_restore(flags);
3228f72b8792SJens Axboe 	return ret;
3229f72b8792SJens Axboe }
3230f72b8792SJens Axboe 
3231401a8d04STejun Heo /**
323257b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
323357b30ae7STejun Heo  * @dwork: delayed_work to cancel
323409383498STejun Heo  *
3235d185af30SYacine Belkadi  * Kill off a pending delayed_work.
3236d185af30SYacine Belkadi  *
3237d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
3238d185af30SYacine Belkadi  * pending.
3239d185af30SYacine Belkadi  *
3240d185af30SYacine Belkadi  * Note:
3241d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
3242d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
3243d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
324409383498STejun Heo  *
324557b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
324609383498STejun Heo  */
324757b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
324809383498STejun Heo {
3249f72b8792SJens Axboe 	return __cancel_work(&dwork->work, true);
325009383498STejun Heo }
325157b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
325209383498STejun Heo 
325309383498STejun Heo /**
3254401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3255401a8d04STejun Heo  * @dwork: the delayed work cancel
3256401a8d04STejun Heo  *
3257401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
3258401a8d04STejun Heo  *
3259d185af30SYacine Belkadi  * Return:
3260401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
3261401a8d04STejun Heo  */
3262401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
32636e84d644SOleg Nesterov {
326436e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
32656e84d644SOleg Nesterov }
3266f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
32671da177e4SLinus Torvalds 
32680fcb78c2SRolf Eike Beer /**
326931ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3270b6136773SAndrew Morton  * @func: the function to call
3271b6136773SAndrew Morton  *
327231ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
327331ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3274b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
327531ddd871STejun Heo  *
3276d185af30SYacine Belkadi  * Return:
327731ddd871STejun Heo  * 0 on success, -errno on failure.
3278b6136773SAndrew Morton  */
327965f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
328015316ba8SChristoph Lameter {
328115316ba8SChristoph Lameter 	int cpu;
328238f51568SNamhyung Kim 	struct work_struct __percpu *works;
328315316ba8SChristoph Lameter 
3284b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3285b6136773SAndrew Morton 	if (!works)
328615316ba8SChristoph Lameter 		return -ENOMEM;
3287b6136773SAndrew Morton 
328895402b38SGautham R Shenoy 	get_online_cpus();
328993981800STejun Heo 
329015316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
32919bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
32929bfb1839SIngo Molnar 
32939bfb1839SIngo Molnar 		INIT_WORK(work, func);
32948de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
329515316ba8SChristoph Lameter 	}
329693981800STejun Heo 
329793981800STejun Heo 	for_each_online_cpu(cpu)
32988616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
329993981800STejun Heo 
330095402b38SGautham R Shenoy 	put_online_cpus();
3301b6136773SAndrew Morton 	free_percpu(works);
330215316ba8SChristoph Lameter 	return 0;
330315316ba8SChristoph Lameter }
330415316ba8SChristoph Lameter 
3305eef6a7d5SAlan Stern /**
33061fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
33071fa44ecaSJames Bottomley  * @fn:		the function to execute
33081fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
33091fa44ecaSJames Bottomley  *		be available when the work executes)
33101fa44ecaSJames Bottomley  *
33111fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
33121fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
33131fa44ecaSJames Bottomley  *
3314d185af30SYacine Belkadi  * Return:	0 - function was executed
33151fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
33161fa44ecaSJames Bottomley  */
331765f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
33181fa44ecaSJames Bottomley {
33191fa44ecaSJames Bottomley 	if (!in_interrupt()) {
332065f27f38SDavid Howells 		fn(&ew->work);
33211fa44ecaSJames Bottomley 		return 0;
33221fa44ecaSJames Bottomley 	}
33231fa44ecaSJames Bottomley 
332465f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
33251fa44ecaSJames Bottomley 	schedule_work(&ew->work);
33261fa44ecaSJames Bottomley 
33271fa44ecaSJames Bottomley 	return 1;
33281fa44ecaSJames Bottomley }
33291fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
33301fa44ecaSJames Bottomley 
33317a4e344cSTejun Heo /**
33327a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
33337a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
33347a4e344cSTejun Heo  *
33357a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
33367a4e344cSTejun Heo  */
33377a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs)
33387a4e344cSTejun Heo {
33397a4e344cSTejun Heo 	if (attrs) {
33407a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
33417a4e344cSTejun Heo 		kfree(attrs);
33427a4e344cSTejun Heo 	}
33437a4e344cSTejun Heo }
33447a4e344cSTejun Heo 
33457a4e344cSTejun Heo /**
33467a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
33477a4e344cSTejun Heo  * @gfp_mask: allocation mask to use
33487a4e344cSTejun Heo  *
33497a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
3350d185af30SYacine Belkadi  * return it.
3351d185af30SYacine Belkadi  *
3352d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
33537a4e344cSTejun Heo  */
33547a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
33557a4e344cSTejun Heo {
33567a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
33577a4e344cSTejun Heo 
33587a4e344cSTejun Heo 	attrs = kzalloc(sizeof(*attrs), gfp_mask);
33597a4e344cSTejun Heo 	if (!attrs)
33607a4e344cSTejun Heo 		goto fail;
33617a4e344cSTejun Heo 	if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
33627a4e344cSTejun Heo 		goto fail;
33637a4e344cSTejun Heo 
336413e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
33657a4e344cSTejun Heo 	return attrs;
33667a4e344cSTejun Heo fail:
33677a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
33687a4e344cSTejun Heo 	return NULL;
33697a4e344cSTejun Heo }
33707a4e344cSTejun Heo 
337129c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
337229c91e99STejun Heo 				 const struct workqueue_attrs *from)
337329c91e99STejun Heo {
337429c91e99STejun Heo 	to->nice = from->nice;
337529c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
33762865a8fbSShaohua Li 	/*
33772865a8fbSShaohua Li 	 * Unlike hash and equality test, this function doesn't ignore
33782865a8fbSShaohua Li 	 * ->no_numa as it is used for both pool and wq attrs.  Instead,
33792865a8fbSShaohua Li 	 * get_unbound_pool() explicitly clears ->no_numa after copying.
33802865a8fbSShaohua Li 	 */
33812865a8fbSShaohua Li 	to->no_numa = from->no_numa;
338229c91e99STejun Heo }
338329c91e99STejun Heo 
338429c91e99STejun Heo /* hash value of the content of @attr */
338529c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
338629c91e99STejun Heo {
338729c91e99STejun Heo 	u32 hash = 0;
338829c91e99STejun Heo 
338929c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
339013e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
339113e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
339229c91e99STejun Heo 	return hash;
339329c91e99STejun Heo }
339429c91e99STejun Heo 
339529c91e99STejun Heo /* content equality test */
339629c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
339729c91e99STejun Heo 			  const struct workqueue_attrs *b)
339829c91e99STejun Heo {
339929c91e99STejun Heo 	if (a->nice != b->nice)
340029c91e99STejun Heo 		return false;
340129c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
340229c91e99STejun Heo 		return false;
340329c91e99STejun Heo 	return true;
340429c91e99STejun Heo }
340529c91e99STejun Heo 
34067a4e344cSTejun Heo /**
34077a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
34087a4e344cSTejun Heo  * @pool: worker_pool to initialize
34097a4e344cSTejun Heo  *
3410402dd89dSShailendra Verma  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
3411d185af30SYacine Belkadi  *
3412d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
341329c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
341429c91e99STejun Heo  * on @pool safely to release it.
34157a4e344cSTejun Heo  */
34167a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
34174e1a1f9aSTejun Heo {
34184e1a1f9aSTejun Heo 	spin_lock_init(&pool->lock);
341929c91e99STejun Heo 	pool->id = -1;
342029c91e99STejun Heo 	pool->cpu = -1;
3421f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
34224e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
342382607adcSTejun Heo 	pool->watchdog_ts = jiffies;
34244e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
34254e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
34264e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
34274e1a1f9aSTejun Heo 
342832a6c723SKees Cook 	timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
34294e1a1f9aSTejun Heo 
343032a6c723SKees Cook 	timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
34314e1a1f9aSTejun Heo 
3432da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
34337a4e344cSTejun Heo 
34347cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
343529c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
343629c91e99STejun Heo 	pool->refcnt = 1;
343729c91e99STejun Heo 
343829c91e99STejun Heo 	/* shouldn't fail above this point */
34397a4e344cSTejun Heo 	pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
34407a4e344cSTejun Heo 	if (!pool->attrs)
34417a4e344cSTejun Heo 		return -ENOMEM;
34427a4e344cSTejun Heo 	return 0;
34434e1a1f9aSTejun Heo }
34444e1a1f9aSTejun Heo 
3445669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP
3446669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
3447669de8bdSBart Van Assche {
3448669de8bdSBart Van Assche 	char *lock_name;
3449669de8bdSBart Van Assche 
3450669de8bdSBart Van Assche 	lockdep_register_key(&wq->key);
3451669de8bdSBart Van Assche 	lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3452669de8bdSBart Van Assche 	if (!lock_name)
3453669de8bdSBart Van Assche 		lock_name = wq->name;
345469a106c0SQian Cai 
345569a106c0SQian Cai 	wq->lock_name = lock_name;
3456669de8bdSBart Van Assche 	lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3457669de8bdSBart Van Assche }
3458669de8bdSBart Van Assche 
3459669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
3460669de8bdSBart Van Assche {
3461669de8bdSBart Van Assche 	lockdep_unregister_key(&wq->key);
3462669de8bdSBart Van Assche }
3463669de8bdSBart Van Assche 
3464669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
3465669de8bdSBart Van Assche {
3466669de8bdSBart Van Assche 	if (wq->lock_name != wq->name)
3467669de8bdSBart Van Assche 		kfree(wq->lock_name);
3468669de8bdSBart Van Assche }
3469669de8bdSBart Van Assche #else
3470669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
3471669de8bdSBart Van Assche {
3472669de8bdSBart Van Assche }
3473669de8bdSBart Van Assche 
3474669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
3475669de8bdSBart Van Assche {
3476669de8bdSBart Van Assche }
3477669de8bdSBart Van Assche 
3478669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
3479669de8bdSBart Van Assche {
3480669de8bdSBart Van Assche }
3481669de8bdSBart Van Assche #endif
3482669de8bdSBart Van Assche 
3483e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu)
3484e2dca7adSTejun Heo {
3485e2dca7adSTejun Heo 	struct workqueue_struct *wq =
3486e2dca7adSTejun Heo 		container_of(rcu, struct workqueue_struct, rcu);
3487e2dca7adSTejun Heo 
3488669de8bdSBart Van Assche 	wq_free_lockdep(wq);
3489669de8bdSBart Van Assche 
3490e2dca7adSTejun Heo 	if (!(wq->flags & WQ_UNBOUND))
3491e2dca7adSTejun Heo 		free_percpu(wq->cpu_pwqs);
3492e2dca7adSTejun Heo 	else
3493e2dca7adSTejun Heo 		free_workqueue_attrs(wq->unbound_attrs);
3494e2dca7adSTejun Heo 
3495e2dca7adSTejun Heo 	kfree(wq->rescuer);
3496e2dca7adSTejun Heo 	kfree(wq);
3497e2dca7adSTejun Heo }
3498e2dca7adSTejun Heo 
349929c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
350029c91e99STejun Heo {
350129c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
350229c91e99STejun Heo 
35037cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
350429c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
350529c91e99STejun Heo 	kfree(pool);
350629c91e99STejun Heo }
350729c91e99STejun Heo 
350829c91e99STejun Heo /**
350929c91e99STejun Heo  * put_unbound_pool - put a worker_pool
351029c91e99STejun Heo  * @pool: worker_pool to put
351129c91e99STejun Heo  *
3512*24acfb71SThomas Gleixner  * Put @pool.  If its refcnt reaches zero, it gets destroyed in RCU
3513c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
3514c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
3515c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
3516a892caccSTejun Heo  *
3517a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
351829c91e99STejun Heo  */
351929c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
352029c91e99STejun Heo {
352160f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
352229c91e99STejun Heo 	struct worker *worker;
352329c91e99STejun Heo 
3524a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3525a892caccSTejun Heo 
3526a892caccSTejun Heo 	if (--pool->refcnt)
352729c91e99STejun Heo 		return;
352829c91e99STejun Heo 
352929c91e99STejun Heo 	/* sanity checks */
353061d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
3531a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
353229c91e99STejun Heo 		return;
353329c91e99STejun Heo 
353429c91e99STejun Heo 	/* release id and unhash */
353529c91e99STejun Heo 	if (pool->id >= 0)
353629c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
353729c91e99STejun Heo 	hash_del(&pool->hash_node);
353829c91e99STejun Heo 
3539c5aa87bbSTejun Heo 	/*
3540692b4825STejun Heo 	 * Become the manager and destroy all workers.  This prevents
3541692b4825STejun Heo 	 * @pool's workers from blocking on attach_mutex.  We're the last
3542692b4825STejun Heo 	 * manager and @pool gets freed with the flag set.
3543c5aa87bbSTejun Heo 	 */
354460f5a4bcSLai Jiangshan 	spin_lock_irq(&pool->lock);
3545692b4825STejun Heo 	wait_event_lock_irq(wq_manager_wait,
3546692b4825STejun Heo 			    !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock);
3547692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
3548692b4825STejun Heo 
35491037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
355029c91e99STejun Heo 		destroy_worker(worker);
355129c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
355229c91e99STejun Heo 	spin_unlock_irq(&pool->lock);
355360f5a4bcSLai Jiangshan 
35541258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
3555da028469SLai Jiangshan 	if (!list_empty(&pool->workers))
355660f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
35571258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
355860f5a4bcSLai Jiangshan 
355960f5a4bcSLai Jiangshan 	if (pool->detach_completion)
356060f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
356160f5a4bcSLai Jiangshan 
356229c91e99STejun Heo 	/* shut down the timers */
356329c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
356429c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
356529c91e99STejun Heo 
3566*24acfb71SThomas Gleixner 	/* RCU protected to allow dereferences from get_work_pool() */
356725b00775SPaul E. McKenney 	call_rcu(&pool->rcu, rcu_free_pool);
356829c91e99STejun Heo }
356929c91e99STejun Heo 
357029c91e99STejun Heo /**
357129c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
357229c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
357329c91e99STejun Heo  *
357429c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
357529c91e99STejun Heo  * reference count and return it.  If there already is a matching
357629c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
3577d185af30SYacine Belkadi  * create a new one.
3578a892caccSTejun Heo  *
3579a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
3580d185af30SYacine Belkadi  *
3581d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
3582d185af30SYacine Belkadi  * On failure, %NULL.
358329c91e99STejun Heo  */
358429c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
358529c91e99STejun Heo {
358629c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
358729c91e99STejun Heo 	struct worker_pool *pool;
3588f3f90ad4STejun Heo 	int node;
3589e2273584SXunlei Pang 	int target_node = NUMA_NO_NODE;
359029c91e99STejun Heo 
3591a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
359229c91e99STejun Heo 
359329c91e99STejun Heo 	/* do we already have a matching pool? */
359429c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
359529c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
359629c91e99STejun Heo 			pool->refcnt++;
35973fb1823cSLai Jiangshan 			return pool;
359829c91e99STejun Heo 		}
359929c91e99STejun Heo 	}
360029c91e99STejun Heo 
3601e2273584SXunlei Pang 	/* if cpumask is contained inside a NUMA node, we belong to that node */
3602e2273584SXunlei Pang 	if (wq_numa_enabled) {
3603e2273584SXunlei Pang 		for_each_node(node) {
3604e2273584SXunlei Pang 			if (cpumask_subset(attrs->cpumask,
3605e2273584SXunlei Pang 					   wq_numa_possible_cpumask[node])) {
3606e2273584SXunlei Pang 				target_node = node;
3607e2273584SXunlei Pang 				break;
3608e2273584SXunlei Pang 			}
3609e2273584SXunlei Pang 		}
3610e2273584SXunlei Pang 	}
3611e2273584SXunlei Pang 
361229c91e99STejun Heo 	/* nope, create a new one */
3613e2273584SXunlei Pang 	pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node);
361429c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
361529c91e99STejun Heo 		goto fail;
361629c91e99STejun Heo 
36178864b4e5STejun Heo 	lockdep_set_subclass(&pool->lock, 1);	/* see put_pwq() */
361829c91e99STejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
3619e2273584SXunlei Pang 	pool->node = target_node;
362029c91e99STejun Heo 
36212865a8fbSShaohua Li 	/*
36222865a8fbSShaohua Li 	 * no_numa isn't a worker_pool attribute, always clear it.  See
36232865a8fbSShaohua Li 	 * 'struct workqueue_attrs' comments for detail.
36242865a8fbSShaohua Li 	 */
36252865a8fbSShaohua Li 	pool->attrs->no_numa = false;
36262865a8fbSShaohua Li 
362729c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
362829c91e99STejun Heo 		goto fail;
362929c91e99STejun Heo 
363029c91e99STejun Heo 	/* create and start the initial worker */
36313347fa09STejun Heo 	if (wq_online && !create_worker(pool))
363229c91e99STejun Heo 		goto fail;
363329c91e99STejun Heo 
363429c91e99STejun Heo 	/* install */
363529c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
36363fb1823cSLai Jiangshan 
363729c91e99STejun Heo 	return pool;
363829c91e99STejun Heo fail:
363929c91e99STejun Heo 	if (pool)
364029c91e99STejun Heo 		put_unbound_pool(pool);
364129c91e99STejun Heo 	return NULL;
364229c91e99STejun Heo }
364329c91e99STejun Heo 
36448864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
36458864b4e5STejun Heo {
36468864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
36478864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
36488864b4e5STejun Heo }
36498864b4e5STejun Heo 
36508864b4e5STejun Heo /*
36518864b4e5STejun Heo  * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
36528864b4e5STejun Heo  * and needs to be destroyed.
36538864b4e5STejun Heo  */
36548864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work)
36558864b4e5STejun Heo {
36568864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
36578864b4e5STejun Heo 						  unbound_release_work);
36588864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
36598864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
3660bc0caf09STejun Heo 	bool is_last;
36618864b4e5STejun Heo 
36628864b4e5STejun Heo 	if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
36638864b4e5STejun Heo 		return;
36648864b4e5STejun Heo 
36653c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
36668864b4e5STejun Heo 	list_del_rcu(&pwq->pwqs_node);
3667bc0caf09STejun Heo 	is_last = list_empty(&wq->pwqs);
36683c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
36698864b4e5STejun Heo 
3670a892caccSTejun Heo 	mutex_lock(&wq_pool_mutex);
36718864b4e5STejun Heo 	put_unbound_pool(pool);
3672a892caccSTejun Heo 	mutex_unlock(&wq_pool_mutex);
3673a892caccSTejun Heo 
367425b00775SPaul E. McKenney 	call_rcu(&pwq->rcu, rcu_free_pwq);
36758864b4e5STejun Heo 
36768864b4e5STejun Heo 	/*
36778864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
3678e2dca7adSTejun Heo 	 * is gonna access it anymore.  Schedule RCU free.
36798864b4e5STejun Heo 	 */
3680669de8bdSBart Van Assche 	if (is_last) {
3681669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
368225b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
36836029a918STejun Heo 	}
3684669de8bdSBart Van Assche }
36858864b4e5STejun Heo 
36860fbd95aaSTejun Heo /**
3687699ce097STejun Heo  * pwq_adjust_max_active - update a pwq's max_active to the current setting
36880fbd95aaSTejun Heo  * @pwq: target pool_workqueue
36890fbd95aaSTejun Heo  *
3690699ce097STejun Heo  * If @pwq isn't freezing, set @pwq->max_active to the associated
3691699ce097STejun Heo  * workqueue's saved_max_active and activate delayed work items
3692699ce097STejun Heo  * accordingly.  If @pwq is freezing, clear @pwq->max_active to zero.
36930fbd95aaSTejun Heo  */
3694699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq)
36950fbd95aaSTejun Heo {
3696699ce097STejun Heo 	struct workqueue_struct *wq = pwq->wq;
3697699ce097STejun Heo 	bool freezable = wq->flags & WQ_FREEZABLE;
36983347fa09STejun Heo 	unsigned long flags;
3699699ce097STejun Heo 
3700699ce097STejun Heo 	/* for @wq->saved_max_active */
3701a357fc03SLai Jiangshan 	lockdep_assert_held(&wq->mutex);
3702699ce097STejun Heo 
3703699ce097STejun Heo 	/* fast exit for non-freezable wqs */
3704699ce097STejun Heo 	if (!freezable && pwq->max_active == wq->saved_max_active)
3705699ce097STejun Heo 		return;
3706699ce097STejun Heo 
37073347fa09STejun Heo 	/* this function can be called during early boot w/ irq disabled */
37083347fa09STejun Heo 	spin_lock_irqsave(&pwq->pool->lock, flags);
3709699ce097STejun Heo 
371074b414eaSLai Jiangshan 	/*
371174b414eaSLai Jiangshan 	 * During [un]freezing, the caller is responsible for ensuring that
371274b414eaSLai Jiangshan 	 * this function is called at least once after @workqueue_freezing
371374b414eaSLai Jiangshan 	 * is updated and visible.
371474b414eaSLai Jiangshan 	 */
371574b414eaSLai Jiangshan 	if (!freezable || !workqueue_freezing) {
3716699ce097STejun Heo 		pwq->max_active = wq->saved_max_active;
37170fbd95aaSTejun Heo 
37180fbd95aaSTejun Heo 		while (!list_empty(&pwq->delayed_works) &&
37190fbd95aaSTejun Heo 		       pwq->nr_active < pwq->max_active)
37200fbd95aaSTejun Heo 			pwq_activate_first_delayed(pwq);
3721951a078aSLai Jiangshan 
3722951a078aSLai Jiangshan 		/*
3723951a078aSLai Jiangshan 		 * Need to kick a worker after thawed or an unbound wq's
3724951a078aSLai Jiangshan 		 * max_active is bumped.  It's a slow path.  Do it always.
3725951a078aSLai Jiangshan 		 */
3726951a078aSLai Jiangshan 		wake_up_worker(pwq->pool);
3727699ce097STejun Heo 	} else {
3728699ce097STejun Heo 		pwq->max_active = 0;
3729699ce097STejun Heo 	}
3730699ce097STejun Heo 
37313347fa09STejun Heo 	spin_unlock_irqrestore(&pwq->pool->lock, flags);
37320fbd95aaSTejun Heo }
37330fbd95aaSTejun Heo 
3734e50aba9aSTejun Heo /* initialize newly alloced @pwq which is associated with @wq and @pool */
3735f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3736f147f29eSTejun Heo 		     struct worker_pool *pool)
3737d2c1d404STejun Heo {
3738d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3739d2c1d404STejun Heo 
3740e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
3741e50aba9aSTejun Heo 
3742d2c1d404STejun Heo 	pwq->pool = pool;
3743d2c1d404STejun Heo 	pwq->wq = wq;
3744d2c1d404STejun Heo 	pwq->flush_color = -1;
37458864b4e5STejun Heo 	pwq->refcnt = 1;
3746d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->delayed_works);
37471befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
3748d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
37498864b4e5STejun Heo 	INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
3750f147f29eSTejun Heo }
3751d2c1d404STejun Heo 
3752f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
37531befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
3754f147f29eSTejun Heo {
3755f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
3756f147f29eSTejun Heo 
3757f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
375875ccf595STejun Heo 
37591befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
37601befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
37611befcf30STejun Heo 		return;
37621befcf30STejun Heo 
376329b1cb41SLai Jiangshan 	/* set the matching work_color */
376475ccf595STejun Heo 	pwq->work_color = wq->work_color;
3765983ca25eSTejun Heo 
3766983ca25eSTejun Heo 	/* sync max_active to the current setting */
3767983ca25eSTejun Heo 	pwq_adjust_max_active(pwq);
3768983ca25eSTejun Heo 
3769983ca25eSTejun Heo 	/* link in @pwq */
37709e8cd2f5STejun Heo 	list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
3771df2d5ae4STejun Heo }
37726029a918STejun Heo 
3773f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3774f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3775f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
3776f147f29eSTejun Heo {
3777f147f29eSTejun Heo 	struct worker_pool *pool;
3778f147f29eSTejun Heo 	struct pool_workqueue *pwq;
3779f147f29eSTejun Heo 
3780f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3781f147f29eSTejun Heo 
3782f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
3783f147f29eSTejun Heo 	if (!pool)
3784f147f29eSTejun Heo 		return NULL;
3785f147f29eSTejun Heo 
3786e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
3787f147f29eSTejun Heo 	if (!pwq) {
3788f147f29eSTejun Heo 		put_unbound_pool(pool);
3789f147f29eSTejun Heo 		return NULL;
3790f147f29eSTejun Heo 	}
3791f147f29eSTejun Heo 
3792f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
3793f147f29eSTejun Heo 	return pwq;
3794d2c1d404STejun Heo }
3795d2c1d404STejun Heo 
37964c16bd32STejun Heo /**
379730186c6fSGong Zhaogang  * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node
3798042f7df1SLai Jiangshan  * @attrs: the wq_attrs of the default pwq of the target workqueue
37994c16bd32STejun Heo  * @node: the target NUMA node
38004c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
38014c16bd32STejun Heo  * @cpumask: outarg, the resulting cpumask
38024c16bd32STejun Heo  *
38034c16bd32STejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @node.  If
38044c16bd32STejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during
3805d185af30SYacine Belkadi  * calculation.  The result is stored in @cpumask.
38064c16bd32STejun Heo  *
38074c16bd32STejun Heo  * If NUMA affinity is not enabled, @attrs->cpumask is always used.  If
38084c16bd32STejun Heo  * enabled and @node has online CPUs requested by @attrs, the returned
38094c16bd32STejun Heo  * cpumask is the intersection of the possible CPUs of @node and
38104c16bd32STejun Heo  * @attrs->cpumask.
38114c16bd32STejun Heo  *
38124c16bd32STejun Heo  * The caller is responsible for ensuring that the cpumask of @node stays
38134c16bd32STejun Heo  * stable.
3814d185af30SYacine Belkadi  *
3815d185af30SYacine Belkadi  * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3816d185af30SYacine Belkadi  * %false if equal.
38174c16bd32STejun Heo  */
38184c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
38194c16bd32STejun Heo 				 int cpu_going_down, cpumask_t *cpumask)
38204c16bd32STejun Heo {
3821d55262c4STejun Heo 	if (!wq_numa_enabled || attrs->no_numa)
38224c16bd32STejun Heo 		goto use_dfl;
38234c16bd32STejun Heo 
38244c16bd32STejun Heo 	/* does @node have any online CPUs @attrs wants? */
38254c16bd32STejun Heo 	cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
38264c16bd32STejun Heo 	if (cpu_going_down >= 0)
38274c16bd32STejun Heo 		cpumask_clear_cpu(cpu_going_down, cpumask);
38284c16bd32STejun Heo 
38294c16bd32STejun Heo 	if (cpumask_empty(cpumask))
38304c16bd32STejun Heo 		goto use_dfl;
38314c16bd32STejun Heo 
38324c16bd32STejun Heo 	/* yeap, return possible CPUs in @node that @attrs wants */
38334c16bd32STejun Heo 	cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
38341ad0f0a7SMichael Bringmann 
38351ad0f0a7SMichael Bringmann 	if (cpumask_empty(cpumask)) {
38361ad0f0a7SMichael Bringmann 		pr_warn_once("WARNING: workqueue cpumask: online intersect > "
38371ad0f0a7SMichael Bringmann 				"possible intersect\n");
38381ad0f0a7SMichael Bringmann 		return false;
38391ad0f0a7SMichael Bringmann 	}
38401ad0f0a7SMichael Bringmann 
38414c16bd32STejun Heo 	return !cpumask_equal(cpumask, attrs->cpumask);
38424c16bd32STejun Heo 
38434c16bd32STejun Heo use_dfl:
38444c16bd32STejun Heo 	cpumask_copy(cpumask, attrs->cpumask);
38454c16bd32STejun Heo 	return false;
38464c16bd32STejun Heo }
38474c16bd32STejun Heo 
38481befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
38491befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
38501befcf30STejun Heo 						   int node,
38511befcf30STejun Heo 						   struct pool_workqueue *pwq)
38521befcf30STejun Heo {
38531befcf30STejun Heo 	struct pool_workqueue *old_pwq;
38541befcf30STejun Heo 
38555b95e1afSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
38561befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
38571befcf30STejun Heo 
38581befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
38591befcf30STejun Heo 	link_pwq(pwq);
38601befcf30STejun Heo 
38611befcf30STejun Heo 	old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
38621befcf30STejun Heo 	rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
38631befcf30STejun Heo 	return old_pwq;
38641befcf30STejun Heo }
38651befcf30STejun Heo 
38662d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */
38672d5f0764SLai Jiangshan struct apply_wqattrs_ctx {
38682d5f0764SLai Jiangshan 	struct workqueue_struct	*wq;		/* target workqueue */
38692d5f0764SLai Jiangshan 	struct workqueue_attrs	*attrs;		/* attrs to apply */
3870042f7df1SLai Jiangshan 	struct list_head	list;		/* queued for batching commit */
38712d5f0764SLai Jiangshan 	struct pool_workqueue	*dfl_pwq;
38722d5f0764SLai Jiangshan 	struct pool_workqueue	*pwq_tbl[];
38732d5f0764SLai Jiangshan };
38742d5f0764SLai Jiangshan 
38752d5f0764SLai Jiangshan /* free the resources after success or abort */
38762d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
38772d5f0764SLai Jiangshan {
38782d5f0764SLai Jiangshan 	if (ctx) {
38792d5f0764SLai Jiangshan 		int node;
38802d5f0764SLai Jiangshan 
38812d5f0764SLai Jiangshan 		for_each_node(node)
38822d5f0764SLai Jiangshan 			put_pwq_unlocked(ctx->pwq_tbl[node]);
38832d5f0764SLai Jiangshan 		put_pwq_unlocked(ctx->dfl_pwq);
38842d5f0764SLai Jiangshan 
38852d5f0764SLai Jiangshan 		free_workqueue_attrs(ctx->attrs);
38862d5f0764SLai Jiangshan 
38872d5f0764SLai Jiangshan 		kfree(ctx);
38882d5f0764SLai Jiangshan 	}
38892d5f0764SLai Jiangshan }
38902d5f0764SLai Jiangshan 
38912d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */
38922d5f0764SLai Jiangshan static struct apply_wqattrs_ctx *
38932d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq,
38942d5f0764SLai Jiangshan 		      const struct workqueue_attrs *attrs)
38952d5f0764SLai Jiangshan {
38962d5f0764SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
38972d5f0764SLai Jiangshan 	struct workqueue_attrs *new_attrs, *tmp_attrs;
38982d5f0764SLai Jiangshan 	int node;
38992d5f0764SLai Jiangshan 
39002d5f0764SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
39012d5f0764SLai Jiangshan 
3902acafe7e3SKees Cook 	ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL);
39032d5f0764SLai Jiangshan 
39042d5f0764SLai Jiangshan 	new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
39052d5f0764SLai Jiangshan 	tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
39062d5f0764SLai Jiangshan 	if (!ctx || !new_attrs || !tmp_attrs)
39072d5f0764SLai Jiangshan 		goto out_free;
39082d5f0764SLai Jiangshan 
3909042f7df1SLai Jiangshan 	/*
3910042f7df1SLai Jiangshan 	 * Calculate the attrs of the default pwq.
3911042f7df1SLai Jiangshan 	 * If the user configured cpumask doesn't overlap with the
3912042f7df1SLai Jiangshan 	 * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask.
3913042f7df1SLai Jiangshan 	 */
39142d5f0764SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
3915b05a7928SFrederic Weisbecker 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask);
3916042f7df1SLai Jiangshan 	if (unlikely(cpumask_empty(new_attrs->cpumask)))
3917042f7df1SLai Jiangshan 		cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask);
39182d5f0764SLai Jiangshan 
39192d5f0764SLai Jiangshan 	/*
39202d5f0764SLai Jiangshan 	 * We may create multiple pwqs with differing cpumasks.  Make a
39212d5f0764SLai Jiangshan 	 * copy of @new_attrs which will be modified and used to obtain
39222d5f0764SLai Jiangshan 	 * pools.
39232d5f0764SLai Jiangshan 	 */
39242d5f0764SLai Jiangshan 	copy_workqueue_attrs(tmp_attrs, new_attrs);
39252d5f0764SLai Jiangshan 
39262d5f0764SLai Jiangshan 	/*
39272d5f0764SLai Jiangshan 	 * If something goes wrong during CPU up/down, we'll fall back to
39282d5f0764SLai Jiangshan 	 * the default pwq covering whole @attrs->cpumask.  Always create
39292d5f0764SLai Jiangshan 	 * it even if we don't use it immediately.
39302d5f0764SLai Jiangshan 	 */
39312d5f0764SLai Jiangshan 	ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
39322d5f0764SLai Jiangshan 	if (!ctx->dfl_pwq)
39332d5f0764SLai Jiangshan 		goto out_free;
39342d5f0764SLai Jiangshan 
39352d5f0764SLai Jiangshan 	for_each_node(node) {
3936042f7df1SLai Jiangshan 		if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) {
39372d5f0764SLai Jiangshan 			ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
39382d5f0764SLai Jiangshan 			if (!ctx->pwq_tbl[node])
39392d5f0764SLai Jiangshan 				goto out_free;
39402d5f0764SLai Jiangshan 		} else {
39412d5f0764SLai Jiangshan 			ctx->dfl_pwq->refcnt++;
39422d5f0764SLai Jiangshan 			ctx->pwq_tbl[node] = ctx->dfl_pwq;
39432d5f0764SLai Jiangshan 		}
39442d5f0764SLai Jiangshan 	}
39452d5f0764SLai Jiangshan 
3946042f7df1SLai Jiangshan 	/* save the user configured attrs and sanitize it. */
3947042f7df1SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
3948042f7df1SLai Jiangshan 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
39492d5f0764SLai Jiangshan 	ctx->attrs = new_attrs;
3950042f7df1SLai Jiangshan 
39512d5f0764SLai Jiangshan 	ctx->wq = wq;
39522d5f0764SLai Jiangshan 	free_workqueue_attrs(tmp_attrs);
39532d5f0764SLai Jiangshan 	return ctx;
39542d5f0764SLai Jiangshan 
39552d5f0764SLai Jiangshan out_free:
39562d5f0764SLai Jiangshan 	free_workqueue_attrs(tmp_attrs);
39572d5f0764SLai Jiangshan 	free_workqueue_attrs(new_attrs);
39582d5f0764SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
39592d5f0764SLai Jiangshan 	return NULL;
39602d5f0764SLai Jiangshan }
39612d5f0764SLai Jiangshan 
39622d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
39632d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
39642d5f0764SLai Jiangshan {
39652d5f0764SLai Jiangshan 	int node;
39662d5f0764SLai Jiangshan 
39672d5f0764SLai Jiangshan 	/* all pwqs have been created successfully, let's install'em */
39682d5f0764SLai Jiangshan 	mutex_lock(&ctx->wq->mutex);
39692d5f0764SLai Jiangshan 
39702d5f0764SLai Jiangshan 	copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
39712d5f0764SLai Jiangshan 
39722d5f0764SLai Jiangshan 	/* save the previous pwq and install the new one */
39732d5f0764SLai Jiangshan 	for_each_node(node)
39742d5f0764SLai Jiangshan 		ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node,
39752d5f0764SLai Jiangshan 							  ctx->pwq_tbl[node]);
39762d5f0764SLai Jiangshan 
39772d5f0764SLai Jiangshan 	/* @dfl_pwq might not have been used, ensure it's linked */
39782d5f0764SLai Jiangshan 	link_pwq(ctx->dfl_pwq);
39792d5f0764SLai Jiangshan 	swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
39802d5f0764SLai Jiangshan 
39812d5f0764SLai Jiangshan 	mutex_unlock(&ctx->wq->mutex);
39822d5f0764SLai Jiangshan }
39832d5f0764SLai Jiangshan 
3984a0111cf6SLai Jiangshan static void apply_wqattrs_lock(void)
3985a0111cf6SLai Jiangshan {
3986a0111cf6SLai Jiangshan 	/* CPUs should stay stable across pwq creations and installations */
3987a0111cf6SLai Jiangshan 	get_online_cpus();
3988a0111cf6SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
3989a0111cf6SLai Jiangshan }
3990a0111cf6SLai Jiangshan 
3991a0111cf6SLai Jiangshan static void apply_wqattrs_unlock(void)
3992a0111cf6SLai Jiangshan {
3993a0111cf6SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
3994a0111cf6SLai Jiangshan 	put_online_cpus();
3995a0111cf6SLai Jiangshan }
3996a0111cf6SLai Jiangshan 
3997a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
3998a0111cf6SLai Jiangshan 					const struct workqueue_attrs *attrs)
3999a0111cf6SLai Jiangshan {
4000a0111cf6SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
4001a0111cf6SLai Jiangshan 
4002a0111cf6SLai Jiangshan 	/* only unbound workqueues can change attributes */
4003a0111cf6SLai Jiangshan 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4004a0111cf6SLai Jiangshan 		return -EINVAL;
4005a0111cf6SLai Jiangshan 
4006a0111cf6SLai Jiangshan 	/* creating multiple pwqs breaks ordering guarantee */
40070a94efb5STejun Heo 	if (!list_empty(&wq->pwqs)) {
40080a94efb5STejun Heo 		if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4009a0111cf6SLai Jiangshan 			return -EINVAL;
4010a0111cf6SLai Jiangshan 
40110a94efb5STejun Heo 		wq->flags &= ~__WQ_ORDERED;
40120a94efb5STejun Heo 	}
40130a94efb5STejun Heo 
4014a0111cf6SLai Jiangshan 	ctx = apply_wqattrs_prepare(wq, attrs);
40156201171eSwanghaibin 	if (!ctx)
40166201171eSwanghaibin 		return -ENOMEM;
4017a0111cf6SLai Jiangshan 
4018a0111cf6SLai Jiangshan 	/* the ctx has been prepared successfully, let's commit it */
4019a0111cf6SLai Jiangshan 	apply_wqattrs_commit(ctx);
4020a0111cf6SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
4021a0111cf6SLai Jiangshan 
40226201171eSwanghaibin 	return 0;
4023a0111cf6SLai Jiangshan }
4024a0111cf6SLai Jiangshan 
40259e8cd2f5STejun Heo /**
40269e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
40279e8cd2f5STejun Heo  * @wq: the target workqueue
40289e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
40299e8cd2f5STejun Heo  *
40304c16bd32STejun Heo  * Apply @attrs to an unbound workqueue @wq.  Unless disabled, on NUMA
40314c16bd32STejun Heo  * machines, this function maps a separate pwq to each NUMA node with
40324c16bd32STejun Heo  * possibles CPUs in @attrs->cpumask so that work items are affine to the
40334c16bd32STejun Heo  * NUMA node it was issued on.  Older pwqs are released as in-flight work
40344c16bd32STejun Heo  * items finish.  Note that a work item which repeatedly requeues itself
40354c16bd32STejun Heo  * back-to-back will stay on its current pwq.
40369e8cd2f5STejun Heo  *
4037d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
4038d185af30SYacine Belkadi  *
4039d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
40409e8cd2f5STejun Heo  */
40419e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq,
40429e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
40439e8cd2f5STejun Heo {
4044a0111cf6SLai Jiangshan 	int ret;
40459e8cd2f5STejun Heo 
4046a0111cf6SLai Jiangshan 	apply_wqattrs_lock();
4047a0111cf6SLai Jiangshan 	ret = apply_workqueue_attrs_locked(wq, attrs);
4048a0111cf6SLai Jiangshan 	apply_wqattrs_unlock();
40492d5f0764SLai Jiangshan 
40502d5f0764SLai Jiangshan 	return ret;
40519e8cd2f5STejun Heo }
40526106c0f8SNeilBrown EXPORT_SYMBOL_GPL(apply_workqueue_attrs);
40539e8cd2f5STejun Heo 
40544c16bd32STejun Heo /**
40554c16bd32STejun Heo  * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
40564c16bd32STejun Heo  * @wq: the target workqueue
40574c16bd32STejun Heo  * @cpu: the CPU coming up or going down
40584c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
40594c16bd32STejun Heo  *
40604c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
40614c16bd32STejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update NUMA affinity of
40624c16bd32STejun Heo  * @wq accordingly.
40634c16bd32STejun Heo  *
40644c16bd32STejun Heo  * If NUMA affinity can't be adjusted due to memory allocation failure, it
40654c16bd32STejun Heo  * falls back to @wq->dfl_pwq which may not be optimal but is always
40664c16bd32STejun Heo  * correct.
40674c16bd32STejun Heo  *
40684c16bd32STejun Heo  * Note that when the last allowed CPU of a NUMA node goes offline for a
40694c16bd32STejun Heo  * workqueue with a cpumask spanning multiple nodes, the workers which were
40704c16bd32STejun Heo  * already executing the work items for the workqueue will lose their CPU
40714c16bd32STejun Heo  * affinity and may execute on any CPU.  This is similar to how per-cpu
40724c16bd32STejun Heo  * workqueues behave on CPU_DOWN.  If a workqueue user wants strict
40734c16bd32STejun Heo  * affinity, it's the user's responsibility to flush the work item from
40744c16bd32STejun Heo  * CPU_DOWN_PREPARE.
40754c16bd32STejun Heo  */
40764c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
40774c16bd32STejun Heo 				   bool online)
40784c16bd32STejun Heo {
40794c16bd32STejun Heo 	int node = cpu_to_node(cpu);
40804c16bd32STejun Heo 	int cpu_off = online ? -1 : cpu;
40814c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
40824c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
40834c16bd32STejun Heo 	cpumask_t *cpumask;
40844c16bd32STejun Heo 
40854c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
40864c16bd32STejun Heo 
4087f7142ed4SLai Jiangshan 	if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) ||
4088f7142ed4SLai Jiangshan 	    wq->unbound_attrs->no_numa)
40894c16bd32STejun Heo 		return;
40904c16bd32STejun Heo 
40914c16bd32STejun Heo 	/*
40924c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
40934c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
40944c16bd32STejun Heo 	 * CPU hotplug exclusion.
40954c16bd32STejun Heo 	 */
40964c16bd32STejun Heo 	target_attrs = wq_update_unbound_numa_attrs_buf;
40974c16bd32STejun Heo 	cpumask = target_attrs->cpumask;
40984c16bd32STejun Heo 
40994c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
41004c16bd32STejun Heo 	pwq = unbound_pwq_by_node(wq, node);
41014c16bd32STejun Heo 
41024c16bd32STejun Heo 	/*
41034c16bd32STejun Heo 	 * Let's determine what needs to be done.  If the target cpumask is
4104042f7df1SLai Jiangshan 	 * different from the default pwq's, we need to compare it to @pwq's
4105042f7df1SLai Jiangshan 	 * and create a new one if they don't match.  If the target cpumask
4106042f7df1SLai Jiangshan 	 * equals the default pwq's, the default pwq should be used.
41074c16bd32STejun Heo 	 */
4108042f7df1SLai Jiangshan 	if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) {
41094c16bd32STejun Heo 		if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
4110f7142ed4SLai Jiangshan 			return;
41114c16bd32STejun Heo 	} else {
41124c16bd32STejun Heo 		goto use_dfl_pwq;
41134c16bd32STejun Heo 	}
41144c16bd32STejun Heo 
41154c16bd32STejun Heo 	/* create a new pwq */
41164c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
41174c16bd32STejun Heo 	if (!pwq) {
41182d916033SFabian Frederick 		pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
41194c16bd32STejun Heo 			wq->name);
412077f300b1SDaeseok Youn 		goto use_dfl_pwq;
41214c16bd32STejun Heo 	}
41224c16bd32STejun Heo 
4123f7142ed4SLai Jiangshan 	/* Install the new pwq. */
41244c16bd32STejun Heo 	mutex_lock(&wq->mutex);
41254c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, pwq);
41264c16bd32STejun Heo 	goto out_unlock;
41274c16bd32STejun Heo 
41284c16bd32STejun Heo use_dfl_pwq:
4129f7142ed4SLai Jiangshan 	mutex_lock(&wq->mutex);
41304c16bd32STejun Heo 	spin_lock_irq(&wq->dfl_pwq->pool->lock);
41314c16bd32STejun Heo 	get_pwq(wq->dfl_pwq);
41324c16bd32STejun Heo 	spin_unlock_irq(&wq->dfl_pwq->pool->lock);
41334c16bd32STejun Heo 	old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
41344c16bd32STejun Heo out_unlock:
41354c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
41364c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
41374c16bd32STejun Heo }
41384c16bd32STejun Heo 
413930cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
41401da177e4SLinus Torvalds {
414149e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
41428a2b7538STejun Heo 	int cpu, ret;
4143e1d8aa9fSFrederic Weisbecker 
414430cdf249STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
4145420c0ddbSTejun Heo 		wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
4146420c0ddbSTejun Heo 		if (!wq->cpu_pwqs)
414730cdf249STejun Heo 			return -ENOMEM;
414830cdf249STejun Heo 
414930cdf249STejun Heo 		for_each_possible_cpu(cpu) {
41507fb98ea7STejun Heo 			struct pool_workqueue *pwq =
41517fb98ea7STejun Heo 				per_cpu_ptr(wq->cpu_pwqs, cpu);
41527a62c2c8STejun Heo 			struct worker_pool *cpu_pools =
4153f02ae73aSTejun Heo 				per_cpu(cpu_worker_pools, cpu);
415430cdf249STejun Heo 
4155f147f29eSTejun Heo 			init_pwq(pwq, wq, &cpu_pools[highpri]);
4156f147f29eSTejun Heo 
4157f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
41581befcf30STejun Heo 			link_pwq(pwq);
4159f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
416030cdf249STejun Heo 		}
416130cdf249STejun Heo 		return 0;
41628a2b7538STejun Heo 	} else if (wq->flags & __WQ_ORDERED) {
41638a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
41648a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
41658a2b7538STejun Heo 		WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
41668a2b7538STejun Heo 			      wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
41678a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
41688a2b7538STejun Heo 		return ret;
41699e8cd2f5STejun Heo 	} else {
41709e8cd2f5STejun Heo 		return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
41719e8cd2f5STejun Heo 	}
41720f900049STejun Heo }
41730f900049STejun Heo 
4174f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
4175f3421797STejun Heo 			       const char *name)
4176b71ab8c2STejun Heo {
4177f3421797STejun Heo 	int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
4178f3421797STejun Heo 
4179f3421797STejun Heo 	if (max_active < 1 || max_active > lim)
4180044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4181f3421797STejun Heo 			max_active, name, 1, lim);
4182b71ab8c2STejun Heo 
4183f3421797STejun Heo 	return clamp_val(max_active, 1, lim);
4184b71ab8c2STejun Heo }
4185b71ab8c2STejun Heo 
4186983c7515STejun Heo /*
4187983c7515STejun Heo  * Workqueues which may be used during memory reclaim should have a rescuer
4188983c7515STejun Heo  * to guarantee forward progress.
4189983c7515STejun Heo  */
4190983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq)
4191983c7515STejun Heo {
4192983c7515STejun Heo 	struct worker *rescuer;
4193983c7515STejun Heo 	int ret;
4194983c7515STejun Heo 
4195983c7515STejun Heo 	if (!(wq->flags & WQ_MEM_RECLAIM))
4196983c7515STejun Heo 		return 0;
4197983c7515STejun Heo 
4198983c7515STejun Heo 	rescuer = alloc_worker(NUMA_NO_NODE);
4199983c7515STejun Heo 	if (!rescuer)
4200983c7515STejun Heo 		return -ENOMEM;
4201983c7515STejun Heo 
4202983c7515STejun Heo 	rescuer->rescue_wq = wq;
4203983c7515STejun Heo 	rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4204983c7515STejun Heo 	ret = PTR_ERR_OR_ZERO(rescuer->task);
4205983c7515STejun Heo 	if (ret) {
4206983c7515STejun Heo 		kfree(rescuer);
4207983c7515STejun Heo 		return ret;
4208983c7515STejun Heo 	}
4209983c7515STejun Heo 
4210983c7515STejun Heo 	wq->rescuer = rescuer;
4211983c7515STejun Heo 	kthread_bind_mask(rescuer->task, cpu_possible_mask);
4212983c7515STejun Heo 	wake_up_process(rescuer->task);
4213983c7515STejun Heo 
4214983c7515STejun Heo 	return 0;
4215983c7515STejun Heo }
4216983c7515STejun Heo 
4217a2775bbcSMathieu Malaterre __printf(1, 4)
4218669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt,
421997e37d7bSTejun Heo 					 unsigned int flags,
4220669de8bdSBart Van Assche 					 int max_active, ...)
42213af24433SOleg Nesterov {
4222df2d5ae4STejun Heo 	size_t tbl_size = 0;
4223ecf6881fSTejun Heo 	va_list args;
42243af24433SOleg Nesterov 	struct workqueue_struct *wq;
422549e3cf44STejun Heo 	struct pool_workqueue *pwq;
4226b196be89STejun Heo 
42275c0338c6STejun Heo 	/*
42285c0338c6STejun Heo 	 * Unbound && max_active == 1 used to imply ordered, which is no
42295c0338c6STejun Heo 	 * longer the case on NUMA machines due to per-node pools.  While
42305c0338c6STejun Heo 	 * alloc_ordered_workqueue() is the right way to create an ordered
42315c0338c6STejun Heo 	 * workqueue, keep the previous behavior to avoid subtle breakages
42325c0338c6STejun Heo 	 * on NUMA.
42335c0338c6STejun Heo 	 */
42345c0338c6STejun Heo 	if ((flags & WQ_UNBOUND) && max_active == 1)
42355c0338c6STejun Heo 		flags |= __WQ_ORDERED;
42365c0338c6STejun Heo 
4237cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
4238cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4239cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
4240cee22a15SViresh Kumar 
4241ecf6881fSTejun Heo 	/* allocate wq and format name */
4242df2d5ae4STejun Heo 	if (flags & WQ_UNBOUND)
4243ddcb57e2SLai Jiangshan 		tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]);
4244df2d5ae4STejun Heo 
4245df2d5ae4STejun Heo 	wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
4246b196be89STejun Heo 	if (!wq)
4247d2c1d404STejun Heo 		return NULL;
4248b196be89STejun Heo 
42496029a918STejun Heo 	if (flags & WQ_UNBOUND) {
42506029a918STejun Heo 		wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
42516029a918STejun Heo 		if (!wq->unbound_attrs)
42526029a918STejun Heo 			goto err_free_wq;
42536029a918STejun Heo 	}
42546029a918STejun Heo 
4255669de8bdSBart Van Assche 	va_start(args, max_active);
4256ecf6881fSTejun Heo 	vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4257b196be89STejun Heo 	va_end(args);
42583af24433SOleg Nesterov 
4259d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
4260b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
42613af24433SOleg Nesterov 
4262b196be89STejun Heo 	/* init wq */
426397e37d7bSTejun Heo 	wq->flags = flags;
4264a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
42653c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
4266112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
426730cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
426873f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
426973f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
4270493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
42713af24433SOleg Nesterov 
4272669de8bdSBart Van Assche 	wq_init_lockdep(wq);
4273cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
42743af24433SOleg Nesterov 
427530cdf249STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
4276d2c1d404STejun Heo 		goto err_free_wq;
42771537663fSTejun Heo 
427840c17f75STejun Heo 	if (wq_online && init_rescuer(wq) < 0)
4279d2c1d404STejun Heo 		goto err_destroy;
4280e22bee78STejun Heo 
4281226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4282226223abSTejun Heo 		goto err_destroy;
4283226223abSTejun Heo 
42846af8bf3dSOleg Nesterov 	/*
428568e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
428668e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
428768e13a67SLai Jiangshan 	 * list.
42886af8bf3dSOleg Nesterov 	 */
428968e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4290a0a1a5fdSTejun Heo 
4291a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
429249e3cf44STejun Heo 	for_each_pwq(pwq, wq)
4293699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4294a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4295a0a1a5fdSTejun Heo 
4296e2dca7adSTejun Heo 	list_add_tail_rcu(&wq->list, &workqueues);
4297a0a1a5fdSTejun Heo 
429868e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
42993af24433SOleg Nesterov 
43003af24433SOleg Nesterov 	return wq;
4301d2c1d404STejun Heo 
4302d2c1d404STejun Heo err_free_wq:
4303009bb421SBart Van Assche 	wq_unregister_lockdep(wq);
4304009bb421SBart Van Assche 	wq_free_lockdep(wq);
43056029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
43064690c4abSTejun Heo 	kfree(wq);
4307d2c1d404STejun Heo 	return NULL;
4308d2c1d404STejun Heo err_destroy:
4309d2c1d404STejun Heo 	destroy_workqueue(wq);
43104690c4abSTejun Heo 	return NULL;
43111da177e4SLinus Torvalds }
4312669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue);
43131da177e4SLinus Torvalds 
43143af24433SOleg Nesterov /**
43153af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
43163af24433SOleg Nesterov  * @wq: target workqueue
43173af24433SOleg Nesterov  *
43183af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
43193af24433SOleg Nesterov  */
43203af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
43213af24433SOleg Nesterov {
432249e3cf44STejun Heo 	struct pool_workqueue *pwq;
43234c16bd32STejun Heo 	int node;
43243af24433SOleg Nesterov 
43259c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
43269c5a2ba7STejun Heo 	drain_workqueue(wq);
4327c8efcc25STejun Heo 
43286183c009STejun Heo 	/* sanity checks */
4329b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
433049e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
43316183c009STejun Heo 		int i;
43326183c009STejun Heo 
433376af4d93STejun Heo 		for (i = 0; i < WORK_NR_COLORS; i++) {
433476af4d93STejun Heo 			if (WARN_ON(pwq->nr_in_flight[i])) {
4335b09f4fd3SLai Jiangshan 				mutex_unlock(&wq->mutex);
4336fa07fb6aSTejun Heo 				show_workqueue_state();
43376183c009STejun Heo 				return;
433876af4d93STejun Heo 			}
433976af4d93STejun Heo 		}
434076af4d93STejun Heo 
43415c529597SLai Jiangshan 		if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
43428864b4e5STejun Heo 		    WARN_ON(pwq->nr_active) ||
434376af4d93STejun Heo 		    WARN_ON(!list_empty(&pwq->delayed_works))) {
4344b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
4345fa07fb6aSTejun Heo 			show_workqueue_state();
43466183c009STejun Heo 			return;
43476183c009STejun Heo 		}
434876af4d93STejun Heo 	}
4349b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
43506183c009STejun Heo 
4351a0a1a5fdSTejun Heo 	/*
4352a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
4353a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
4354a0a1a5fdSTejun Heo 	 */
435568e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4356e2dca7adSTejun Heo 	list_del_rcu(&wq->list);
435768e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
43583af24433SOleg Nesterov 
4359226223abSTejun Heo 	workqueue_sysfs_unregister(wq);
4360226223abSTejun Heo 
4361e2dca7adSTejun Heo 	if (wq->rescuer)
4362e22bee78STejun Heo 		kthread_stop(wq->rescuer->task);
4363e22bee78STejun Heo 
43648864b4e5STejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
4365669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
436629c91e99STejun Heo 		/*
43678864b4e5STejun Heo 		 * The base ref is never dropped on per-cpu pwqs.  Directly
4368e2dca7adSTejun Heo 		 * schedule RCU free.
436929c91e99STejun Heo 		 */
437025b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
43718864b4e5STejun Heo 	} else {
43728864b4e5STejun Heo 		/*
43738864b4e5STejun Heo 		 * We're the sole accessor of @wq at this point.  Directly
43744c16bd32STejun Heo 		 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
43754c16bd32STejun Heo 		 * @wq will be freed when the last pwq is released.
43768864b4e5STejun Heo 		 */
43774c16bd32STejun Heo 		for_each_node(node) {
43784c16bd32STejun Heo 			pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
43794c16bd32STejun Heo 			RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
43804c16bd32STejun Heo 			put_pwq_unlocked(pwq);
43814c16bd32STejun Heo 		}
43824c16bd32STejun Heo 
43834c16bd32STejun Heo 		/*
43844c16bd32STejun Heo 		 * Put dfl_pwq.  @wq may be freed any time after dfl_pwq is
43854c16bd32STejun Heo 		 * put.  Don't access it afterwards.
43864c16bd32STejun Heo 		 */
43874c16bd32STejun Heo 		pwq = wq->dfl_pwq;
43884c16bd32STejun Heo 		wq->dfl_pwq = NULL;
4389dce90d47STejun Heo 		put_pwq_unlocked(pwq);
439029c91e99STejun Heo 	}
43913af24433SOleg Nesterov }
43923af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
43933af24433SOleg Nesterov 
4394dcd989cbSTejun Heo /**
4395dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
4396dcd989cbSTejun Heo  * @wq: target workqueue
4397dcd989cbSTejun Heo  * @max_active: new max_active value.
4398dcd989cbSTejun Heo  *
4399dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
4400dcd989cbSTejun Heo  *
4401dcd989cbSTejun Heo  * CONTEXT:
4402dcd989cbSTejun Heo  * Don't call from IRQ context.
4403dcd989cbSTejun Heo  */
4404dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4405dcd989cbSTejun Heo {
440649e3cf44STejun Heo 	struct pool_workqueue *pwq;
4407dcd989cbSTejun Heo 
44088719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
44090a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
44108719dceaSTejun Heo 		return;
44118719dceaSTejun Heo 
4412f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4413dcd989cbSTejun Heo 
4414a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
4415dcd989cbSTejun Heo 
44160a94efb5STejun Heo 	wq->flags &= ~__WQ_ORDERED;
4417dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
4418dcd989cbSTejun Heo 
4419699ce097STejun Heo 	for_each_pwq(pwq, wq)
4420699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4421dcd989cbSTejun Heo 
4422a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4423dcd989cbSTejun Heo }
4424dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4425dcd989cbSTejun Heo 
4426dcd989cbSTejun Heo /**
442727d4ee03SLukas Wunner  * current_work - retrieve %current task's work struct
442827d4ee03SLukas Wunner  *
442927d4ee03SLukas Wunner  * Determine if %current task is a workqueue worker and what it's working on.
443027d4ee03SLukas Wunner  * Useful to find out the context that the %current task is running in.
443127d4ee03SLukas Wunner  *
443227d4ee03SLukas Wunner  * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
443327d4ee03SLukas Wunner  */
443427d4ee03SLukas Wunner struct work_struct *current_work(void)
443527d4ee03SLukas Wunner {
443627d4ee03SLukas Wunner 	struct worker *worker = current_wq_worker();
443727d4ee03SLukas Wunner 
443827d4ee03SLukas Wunner 	return worker ? worker->current_work : NULL;
443927d4ee03SLukas Wunner }
444027d4ee03SLukas Wunner EXPORT_SYMBOL(current_work);
444127d4ee03SLukas Wunner 
444227d4ee03SLukas Wunner /**
4443e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
4444e6267616STejun Heo  *
4445e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
4446e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
4447d185af30SYacine Belkadi  *
4448d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
4449e6267616STejun Heo  */
4450e6267616STejun Heo bool current_is_workqueue_rescuer(void)
4451e6267616STejun Heo {
4452e6267616STejun Heo 	struct worker *worker = current_wq_worker();
4453e6267616STejun Heo 
44546a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
4455e6267616STejun Heo }
4456e6267616STejun Heo 
4457e6267616STejun Heo /**
4458dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
4459dcd989cbSTejun Heo  * @cpu: CPU in question
4460dcd989cbSTejun Heo  * @wq: target workqueue
4461dcd989cbSTejun Heo  *
4462dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
4463dcd989cbSTejun Heo  * no synchronization around this function and the test result is
4464dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4465dcd989cbSTejun Heo  *
4466d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4467d3251859STejun Heo  * Note that both per-cpu and unbound workqueues may be associated with
4468d3251859STejun Heo  * multiple pool_workqueues which have separate congested states.  A
4469d3251859STejun Heo  * workqueue being congested on one CPU doesn't mean the workqueue is also
4470d3251859STejun Heo  * contested on other CPUs / NUMA nodes.
4471d3251859STejun Heo  *
4472d185af30SYacine Belkadi  * Return:
4473dcd989cbSTejun Heo  * %true if congested, %false otherwise.
4474dcd989cbSTejun Heo  */
4475d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4476dcd989cbSTejun Heo {
44777fb98ea7STejun Heo 	struct pool_workqueue *pwq;
447876af4d93STejun Heo 	bool ret;
447976af4d93STejun Heo 
4480*24acfb71SThomas Gleixner 	rcu_read_lock();
4481*24acfb71SThomas Gleixner 	preempt_disable();
44827fb98ea7STejun Heo 
4483d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
4484d3251859STejun Heo 		cpu = smp_processor_id();
4485d3251859STejun Heo 
44867fb98ea7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
44877fb98ea7STejun Heo 		pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
44887fb98ea7STejun Heo 	else
4489df2d5ae4STejun Heo 		pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
4490dcd989cbSTejun Heo 
449176af4d93STejun Heo 	ret = !list_empty(&pwq->delayed_works);
4492*24acfb71SThomas Gleixner 	preempt_enable();
4493*24acfb71SThomas Gleixner 	rcu_read_unlock();
449476af4d93STejun Heo 
449576af4d93STejun Heo 	return ret;
4496dcd989cbSTejun Heo }
4497dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
4498dcd989cbSTejun Heo 
4499dcd989cbSTejun Heo /**
4500dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
4501dcd989cbSTejun Heo  * @work: the work to be tested
4502dcd989cbSTejun Heo  *
4503dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
4504dcd989cbSTejun Heo  * synchronization around this function and the test result is
4505dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4506dcd989cbSTejun Heo  *
4507d185af30SYacine Belkadi  * Return:
4508dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
4509dcd989cbSTejun Heo  */
4510dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
4511dcd989cbSTejun Heo {
4512fa1b54e6STejun Heo 	struct worker_pool *pool;
4513dcd989cbSTejun Heo 	unsigned long flags;
4514dcd989cbSTejun Heo 	unsigned int ret = 0;
4515dcd989cbSTejun Heo 
4516dcd989cbSTejun Heo 	if (work_pending(work))
4517dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
4518038366c5SLai Jiangshan 
4519*24acfb71SThomas Gleixner 	rcu_read_lock();
4520fa1b54e6STejun Heo 	pool = get_work_pool(work);
4521038366c5SLai Jiangshan 	if (pool) {
4522*24acfb71SThomas Gleixner 		spin_lock_irqsave(&pool->lock, flags);
4523c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
4524dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
4525*24acfb71SThomas Gleixner 		spin_unlock_irqrestore(&pool->lock, flags);
4526038366c5SLai Jiangshan 	}
4527*24acfb71SThomas Gleixner 	rcu_read_unlock();
4528dcd989cbSTejun Heo 
4529dcd989cbSTejun Heo 	return ret;
4530dcd989cbSTejun Heo }
4531dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
4532dcd989cbSTejun Heo 
45333d1cb205STejun Heo /**
45343d1cb205STejun Heo  * set_worker_desc - set description for the current work item
45353d1cb205STejun Heo  * @fmt: printf-style format string
45363d1cb205STejun Heo  * @...: arguments for the format string
45373d1cb205STejun Heo  *
45383d1cb205STejun Heo  * This function can be called by a running work function to describe what
45393d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
45403d1cb205STejun Heo  * information will be printed out together to help debugging.  The
45413d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
45423d1cb205STejun Heo  */
45433d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
45443d1cb205STejun Heo {
45453d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
45463d1cb205STejun Heo 	va_list args;
45473d1cb205STejun Heo 
45483d1cb205STejun Heo 	if (worker) {
45493d1cb205STejun Heo 		va_start(args, fmt);
45503d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
45513d1cb205STejun Heo 		va_end(args);
45523d1cb205STejun Heo 	}
45533d1cb205STejun Heo }
45545c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc);
45553d1cb205STejun Heo 
45563d1cb205STejun Heo /**
45573d1cb205STejun Heo  * print_worker_info - print out worker information and description
45583d1cb205STejun Heo  * @log_lvl: the log level to use when printing
45593d1cb205STejun Heo  * @task: target task
45603d1cb205STejun Heo  *
45613d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
45623d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
45633d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
45643d1cb205STejun Heo  *
45653d1cb205STejun Heo  * This function can be safely called on any task as long as the
45663d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
45673d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
45683d1cb205STejun Heo  */
45693d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
45703d1cb205STejun Heo {
45713d1cb205STejun Heo 	work_func_t *fn = NULL;
45723d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
45733d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
45743d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
45753d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
45763d1cb205STejun Heo 	struct worker *worker;
45773d1cb205STejun Heo 
45783d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
45793d1cb205STejun Heo 		return;
45803d1cb205STejun Heo 
45813d1cb205STejun Heo 	/*
45823d1cb205STejun Heo 	 * This function is called without any synchronization and @task
45833d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
45843d1cb205STejun Heo 	 */
4585e700591aSPetr Mladek 	worker = kthread_probe_data(task);
45863d1cb205STejun Heo 
45873d1cb205STejun Heo 	/*
45888bf89593STejun Heo 	 * Carefully copy the associated workqueue's workfn, name and desc.
45898bf89593STejun Heo 	 * Keep the original last '\0' in case the original is garbage.
45903d1cb205STejun Heo 	 */
45913d1cb205STejun Heo 	probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
45923d1cb205STejun Heo 	probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
45933d1cb205STejun Heo 	probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
45943d1cb205STejun Heo 	probe_kernel_read(name, wq->name, sizeof(name) - 1);
45953d1cb205STejun Heo 	probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
45963d1cb205STejun Heo 
45973d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
45983d1cb205STejun Heo 		printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
45998bf89593STejun Heo 		if (strcmp(name, desc))
46003d1cb205STejun Heo 			pr_cont(" (%s)", desc);
46013d1cb205STejun Heo 		pr_cont("\n");
46023d1cb205STejun Heo 	}
46033d1cb205STejun Heo }
46043d1cb205STejun Heo 
46053494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool)
46063494fc30STejun Heo {
46073494fc30STejun Heo 	pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
46083494fc30STejun Heo 	if (pool->node != NUMA_NO_NODE)
46093494fc30STejun Heo 		pr_cont(" node=%d", pool->node);
46103494fc30STejun Heo 	pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
46113494fc30STejun Heo }
46123494fc30STejun Heo 
46133494fc30STejun Heo static void pr_cont_work(bool comma, struct work_struct *work)
46143494fc30STejun Heo {
46153494fc30STejun Heo 	if (work->func == wq_barrier_func) {
46163494fc30STejun Heo 		struct wq_barrier *barr;
46173494fc30STejun Heo 
46183494fc30STejun Heo 		barr = container_of(work, struct wq_barrier, work);
46193494fc30STejun Heo 
46203494fc30STejun Heo 		pr_cont("%s BAR(%d)", comma ? "," : "",
46213494fc30STejun Heo 			task_pid_nr(barr->task));
46223494fc30STejun Heo 	} else {
46233494fc30STejun Heo 		pr_cont("%s %pf", comma ? "," : "", work->func);
46243494fc30STejun Heo 	}
46253494fc30STejun Heo }
46263494fc30STejun Heo 
46273494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq)
46283494fc30STejun Heo {
46293494fc30STejun Heo 	struct worker_pool *pool = pwq->pool;
46303494fc30STejun Heo 	struct work_struct *work;
46313494fc30STejun Heo 	struct worker *worker;
46323494fc30STejun Heo 	bool has_in_flight = false, has_pending = false;
46333494fc30STejun Heo 	int bkt;
46343494fc30STejun Heo 
46353494fc30STejun Heo 	pr_info("  pwq %d:", pool->id);
46363494fc30STejun Heo 	pr_cont_pool_info(pool);
46373494fc30STejun Heo 
46383494fc30STejun Heo 	pr_cont(" active=%d/%d%s\n", pwq->nr_active, pwq->max_active,
46393494fc30STejun Heo 		!list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
46403494fc30STejun Heo 
46413494fc30STejun Heo 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
46423494fc30STejun Heo 		if (worker->current_pwq == pwq) {
46433494fc30STejun Heo 			has_in_flight = true;
46443494fc30STejun Heo 			break;
46453494fc30STejun Heo 		}
46463494fc30STejun Heo 	}
46473494fc30STejun Heo 	if (has_in_flight) {
46483494fc30STejun Heo 		bool comma = false;
46493494fc30STejun Heo 
46503494fc30STejun Heo 		pr_info("    in-flight:");
46513494fc30STejun Heo 		hash_for_each(pool->busy_hash, bkt, worker, hentry) {
46523494fc30STejun Heo 			if (worker->current_pwq != pwq)
46533494fc30STejun Heo 				continue;
46543494fc30STejun Heo 
46553494fc30STejun Heo 			pr_cont("%s %d%s:%pf", comma ? "," : "",
46563494fc30STejun Heo 				task_pid_nr(worker->task),
46573494fc30STejun Heo 				worker == pwq->wq->rescuer ? "(RESCUER)" : "",
46583494fc30STejun Heo 				worker->current_func);
46593494fc30STejun Heo 			list_for_each_entry(work, &worker->scheduled, entry)
46603494fc30STejun Heo 				pr_cont_work(false, work);
46613494fc30STejun Heo 			comma = true;
46623494fc30STejun Heo 		}
46633494fc30STejun Heo 		pr_cont("\n");
46643494fc30STejun Heo 	}
46653494fc30STejun Heo 
46663494fc30STejun Heo 	list_for_each_entry(work, &pool->worklist, entry) {
46673494fc30STejun Heo 		if (get_work_pwq(work) == pwq) {
46683494fc30STejun Heo 			has_pending = true;
46693494fc30STejun Heo 			break;
46703494fc30STejun Heo 		}
46713494fc30STejun Heo 	}
46723494fc30STejun Heo 	if (has_pending) {
46733494fc30STejun Heo 		bool comma = false;
46743494fc30STejun Heo 
46753494fc30STejun Heo 		pr_info("    pending:");
46763494fc30STejun Heo 		list_for_each_entry(work, &pool->worklist, entry) {
46773494fc30STejun Heo 			if (get_work_pwq(work) != pwq)
46783494fc30STejun Heo 				continue;
46793494fc30STejun Heo 
46803494fc30STejun Heo 			pr_cont_work(comma, work);
46813494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
46823494fc30STejun Heo 		}
46833494fc30STejun Heo 		pr_cont("\n");
46843494fc30STejun Heo 	}
46853494fc30STejun Heo 
46863494fc30STejun Heo 	if (!list_empty(&pwq->delayed_works)) {
46873494fc30STejun Heo 		bool comma = false;
46883494fc30STejun Heo 
46893494fc30STejun Heo 		pr_info("    delayed:");
46903494fc30STejun Heo 		list_for_each_entry(work, &pwq->delayed_works, entry) {
46913494fc30STejun Heo 			pr_cont_work(comma, work);
46923494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
46933494fc30STejun Heo 		}
46943494fc30STejun Heo 		pr_cont("\n");
46953494fc30STejun Heo 	}
46963494fc30STejun Heo }
46973494fc30STejun Heo 
46983494fc30STejun Heo /**
46993494fc30STejun Heo  * show_workqueue_state - dump workqueue state
47003494fc30STejun Heo  *
47017b776af6SRoger Lu  * Called from a sysrq handler or try_to_freeze_tasks() and prints out
47027b776af6SRoger Lu  * all busy workqueues and pools.
47033494fc30STejun Heo  */
47043494fc30STejun Heo void show_workqueue_state(void)
47053494fc30STejun Heo {
47063494fc30STejun Heo 	struct workqueue_struct *wq;
47073494fc30STejun Heo 	struct worker_pool *pool;
47083494fc30STejun Heo 	unsigned long flags;
47093494fc30STejun Heo 	int pi;
47103494fc30STejun Heo 
4711*24acfb71SThomas Gleixner 	rcu_read_lock();
47123494fc30STejun Heo 
47133494fc30STejun Heo 	pr_info("Showing busy workqueues and worker pools:\n");
47143494fc30STejun Heo 
47153494fc30STejun Heo 	list_for_each_entry_rcu(wq, &workqueues, list) {
47163494fc30STejun Heo 		struct pool_workqueue *pwq;
47173494fc30STejun Heo 		bool idle = true;
47183494fc30STejun Heo 
47193494fc30STejun Heo 		for_each_pwq(pwq, wq) {
47203494fc30STejun Heo 			if (pwq->nr_active || !list_empty(&pwq->delayed_works)) {
47213494fc30STejun Heo 				idle = false;
47223494fc30STejun Heo 				break;
47233494fc30STejun Heo 			}
47243494fc30STejun Heo 		}
47253494fc30STejun Heo 		if (idle)
47263494fc30STejun Heo 			continue;
47273494fc30STejun Heo 
47283494fc30STejun Heo 		pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
47293494fc30STejun Heo 
47303494fc30STejun Heo 		for_each_pwq(pwq, wq) {
47313494fc30STejun Heo 			spin_lock_irqsave(&pwq->pool->lock, flags);
47323494fc30STejun Heo 			if (pwq->nr_active || !list_empty(&pwq->delayed_works))
47333494fc30STejun Heo 				show_pwq(pwq);
47343494fc30STejun Heo 			spin_unlock_irqrestore(&pwq->pool->lock, flags);
473562635ea8SSergey Senozhatsky 			/*
473662635ea8SSergey Senozhatsky 			 * We could be printing a lot from atomic context, e.g.
473762635ea8SSergey Senozhatsky 			 * sysrq-t -> show_workqueue_state(). Avoid triggering
473862635ea8SSergey Senozhatsky 			 * hard lockup.
473962635ea8SSergey Senozhatsky 			 */
474062635ea8SSergey Senozhatsky 			touch_nmi_watchdog();
47413494fc30STejun Heo 		}
47423494fc30STejun Heo 	}
47433494fc30STejun Heo 
47443494fc30STejun Heo 	for_each_pool(pool, pi) {
47453494fc30STejun Heo 		struct worker *worker;
47463494fc30STejun Heo 		bool first = true;
47473494fc30STejun Heo 
47483494fc30STejun Heo 		spin_lock_irqsave(&pool->lock, flags);
47493494fc30STejun Heo 		if (pool->nr_workers == pool->nr_idle)
47503494fc30STejun Heo 			goto next_pool;
47513494fc30STejun Heo 
47523494fc30STejun Heo 		pr_info("pool %d:", pool->id);
47533494fc30STejun Heo 		pr_cont_pool_info(pool);
475482607adcSTejun Heo 		pr_cont(" hung=%us workers=%d",
475582607adcSTejun Heo 			jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000,
475682607adcSTejun Heo 			pool->nr_workers);
47573494fc30STejun Heo 		if (pool->manager)
47583494fc30STejun Heo 			pr_cont(" manager: %d",
47593494fc30STejun Heo 				task_pid_nr(pool->manager->task));
47603494fc30STejun Heo 		list_for_each_entry(worker, &pool->idle_list, entry) {
47613494fc30STejun Heo 			pr_cont(" %s%d", first ? "idle: " : "",
47623494fc30STejun Heo 				task_pid_nr(worker->task));
47633494fc30STejun Heo 			first = false;
47643494fc30STejun Heo 		}
47653494fc30STejun Heo 		pr_cont("\n");
47663494fc30STejun Heo 	next_pool:
47673494fc30STejun Heo 		spin_unlock_irqrestore(&pool->lock, flags);
476862635ea8SSergey Senozhatsky 		/*
476962635ea8SSergey Senozhatsky 		 * We could be printing a lot from atomic context, e.g.
477062635ea8SSergey Senozhatsky 		 * sysrq-t -> show_workqueue_state(). Avoid triggering
477162635ea8SSergey Senozhatsky 		 * hard lockup.
477262635ea8SSergey Senozhatsky 		 */
477362635ea8SSergey Senozhatsky 		touch_nmi_watchdog();
47743494fc30STejun Heo 	}
47753494fc30STejun Heo 
4776*24acfb71SThomas Gleixner 	rcu_read_unlock();
47773494fc30STejun Heo }
47783494fc30STejun Heo 
47796b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */
47806b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
47816b59808bSTejun Heo {
47826b59808bSTejun Heo 	int off;
47836b59808bSTejun Heo 
47846b59808bSTejun Heo 	/* always show the actual comm */
47856b59808bSTejun Heo 	off = strscpy(buf, task->comm, size);
47866b59808bSTejun Heo 	if (off < 0)
47876b59808bSTejun Heo 		return;
47886b59808bSTejun Heo 
4789197f6accSTejun Heo 	/* stabilize PF_WQ_WORKER and worker pool association */
47906b59808bSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
47916b59808bSTejun Heo 
4792197f6accSTejun Heo 	if (task->flags & PF_WQ_WORKER) {
4793197f6accSTejun Heo 		struct worker *worker = kthread_data(task);
4794197f6accSTejun Heo 		struct worker_pool *pool = worker->pool;
47956b59808bSTejun Heo 
47966b59808bSTejun Heo 		if (pool) {
47976b59808bSTejun Heo 			spin_lock_irq(&pool->lock);
47986b59808bSTejun Heo 			/*
4799197f6accSTejun Heo 			 * ->desc tracks information (wq name or
4800197f6accSTejun Heo 			 * set_worker_desc()) for the latest execution.  If
4801197f6accSTejun Heo 			 * current, prepend '+', otherwise '-'.
48026b59808bSTejun Heo 			 */
48036b59808bSTejun Heo 			if (worker->desc[0] != '\0') {
48046b59808bSTejun Heo 				if (worker->current_work)
48056b59808bSTejun Heo 					scnprintf(buf + off, size - off, "+%s",
48066b59808bSTejun Heo 						  worker->desc);
48076b59808bSTejun Heo 				else
48086b59808bSTejun Heo 					scnprintf(buf + off, size - off, "-%s",
48096b59808bSTejun Heo 						  worker->desc);
48106b59808bSTejun Heo 			}
48116b59808bSTejun Heo 			spin_unlock_irq(&pool->lock);
48126b59808bSTejun Heo 		}
4813197f6accSTejun Heo 	}
48146b59808bSTejun Heo 
48156b59808bSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
48166b59808bSTejun Heo }
48176b59808bSTejun Heo 
481866448bc2SMathieu Malaterre #ifdef CONFIG_SMP
481966448bc2SMathieu Malaterre 
4820db7bccf4STejun Heo /*
4821db7bccf4STejun Heo  * CPU hotplug.
4822db7bccf4STejun Heo  *
4823e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
4824112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
4825706026c2STejun Heo  * pool which make migrating pending and scheduled works very
4826e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
482794cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
4828e22bee78STejun Heo  * blocked draining impractical.
4829e22bee78STejun Heo  *
483024647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
4831628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
4832628c78e7STejun Heo  * cpu comes back online.
4833db7bccf4STejun Heo  */
4834db7bccf4STejun Heo 
4835e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu)
4836db7bccf4STejun Heo {
48374ce62e9eSTejun Heo 	struct worker_pool *pool;
4838db7bccf4STejun Heo 	struct worker *worker;
4839db7bccf4STejun Heo 
4840f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
48411258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
484294cf58bbSTejun Heo 		spin_lock_irq(&pool->lock);
4843e22bee78STejun Heo 
4844f2d5a0eeSTejun Heo 		/*
484592f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
484694cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
484794cf58bbSTejun Heo 		 * except for the ones which are still executing works from
484894cf58bbSTejun Heo 		 * before the last CPU down must be on the cpu.  After
484994cf58bbSTejun Heo 		 * this, they may become diasporas.
4850f2d5a0eeSTejun Heo 		 */
4851da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
4852403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
4853db7bccf4STejun Heo 
485424647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
4855f2d5a0eeSTejun Heo 
485694cf58bbSTejun Heo 		spin_unlock_irq(&pool->lock);
48571258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
4858e22bee78STejun Heo 
4859e22bee78STejun Heo 		/*
4860eb283428SLai Jiangshan 		 * Call schedule() so that we cross rq->lock and thus can
4861eb283428SLai Jiangshan 		 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4862eb283428SLai Jiangshan 		 * This is necessary as scheduler callbacks may be invoked
4863eb283428SLai Jiangshan 		 * from other cpus.
4864628c78e7STejun Heo 		 */
4865628c78e7STejun Heo 		schedule();
4866628c78e7STejun Heo 
4867628c78e7STejun Heo 		/*
4868eb283428SLai Jiangshan 		 * Sched callbacks are disabled now.  Zap nr_running.
4869eb283428SLai Jiangshan 		 * After this, nr_running stays zero and need_more_worker()
4870eb283428SLai Jiangshan 		 * and keep_working() are always true as long as the
4871eb283428SLai Jiangshan 		 * worklist is not empty.  This pool now behaves as an
4872eb283428SLai Jiangshan 		 * unbound (in terms of concurrency management) pool which
4873eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
4874e22bee78STejun Heo 		 */
4875e19e397aSTejun Heo 		atomic_set(&pool->nr_running, 0);
4876eb283428SLai Jiangshan 
4877eb283428SLai Jiangshan 		/*
4878eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
4879eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
4880eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
4881eb283428SLai Jiangshan 		 */
4882eb283428SLai Jiangshan 		spin_lock_irq(&pool->lock);
4883eb283428SLai Jiangshan 		wake_up_worker(pool);
4884eb283428SLai Jiangshan 		spin_unlock_irq(&pool->lock);
4885eb283428SLai Jiangshan 	}
4886db7bccf4STejun Heo }
4887db7bccf4STejun Heo 
4888bd7c089eSTejun Heo /**
4889bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
4890bd7c089eSTejun Heo  * @pool: pool of interest
4891bd7c089eSTejun Heo  *
4892a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
4893bd7c089eSTejun Heo  */
4894bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
4895bd7c089eSTejun Heo {
4896a9ab775bSTejun Heo 	struct worker *worker;
4897bd7c089eSTejun Heo 
48981258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
4899bd7c089eSTejun Heo 
4900bd7c089eSTejun Heo 	/*
4901a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
4902a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
4903402dd89dSShailendra Verma 	 * wake-ups for concurrency management happen, restore CPU affinity
4904a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
4905a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
4906bd7c089eSTejun Heo 	 */
4907da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
4908a9ab775bSTejun Heo 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4909a9ab775bSTejun Heo 						  pool->attrs->cpumask) < 0);
4910a9ab775bSTejun Heo 
4911a9ab775bSTejun Heo 	spin_lock_irq(&pool->lock);
4912f7c17d26SWanpeng Li 
49133de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
4914a9ab775bSTejun Heo 
4915da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
4916a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
4917a9ab775bSTejun Heo 
4918a9ab775bSTejun Heo 		/*
4919a9ab775bSTejun Heo 		 * A bound idle worker should actually be on the runqueue
4920a9ab775bSTejun Heo 		 * of the associated CPU for local wake-ups targeting it to
4921a9ab775bSTejun Heo 		 * work.  Kick all idle workers so that they migrate to the
4922a9ab775bSTejun Heo 		 * associated CPU.  Doing this in the same loop as
4923a9ab775bSTejun Heo 		 * replacing UNBOUND with REBOUND is safe as no worker will
4924a9ab775bSTejun Heo 		 * be bound before @pool->lock is released.
4925a9ab775bSTejun Heo 		 */
4926a9ab775bSTejun Heo 		if (worker_flags & WORKER_IDLE)
4927bd7c089eSTejun Heo 			wake_up_process(worker->task);
4928bd7c089eSTejun Heo 
4929bd7c089eSTejun Heo 		/*
4930a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
4931a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
4932a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4933a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
4934a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
4935a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
4936a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
4937a9ab775bSTejun Heo 		 *
4938c95491edSMark Rutland 		 * WRITE_ONCE() is necessary because @worker->flags may be
4939a9ab775bSTejun Heo 		 * tested without holding any lock in
4940a9ab775bSTejun Heo 		 * wq_worker_waking_up().  Without it, NOT_RUNNING test may
4941a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
4942a9ab775bSTejun Heo 		 * management operations.
4943bd7c089eSTejun Heo 		 */
4944a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4945a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
4946a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
4947c95491edSMark Rutland 		WRITE_ONCE(worker->flags, worker_flags);
4948bd7c089eSTejun Heo 	}
4949a9ab775bSTejun Heo 
4950a9ab775bSTejun Heo 	spin_unlock_irq(&pool->lock);
4951bd7c089eSTejun Heo }
4952bd7c089eSTejun Heo 
49537dbc725eSTejun Heo /**
49547dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
49557dbc725eSTejun Heo  * @pool: unbound pool of interest
49567dbc725eSTejun Heo  * @cpu: the CPU which is coming up
49577dbc725eSTejun Heo  *
49587dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
49597dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
49607dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
49617dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
49627dbc725eSTejun Heo  */
49637dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
49647dbc725eSTejun Heo {
49657dbc725eSTejun Heo 	static cpumask_t cpumask;
49667dbc725eSTejun Heo 	struct worker *worker;
49677dbc725eSTejun Heo 
49681258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
49697dbc725eSTejun Heo 
49707dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
49717dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
49727dbc725eSTejun Heo 		return;
49737dbc725eSTejun Heo 
49747dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
49757dbc725eSTejun Heo 
49767dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
4977da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
4978d945b5e9SPeter Zijlstra 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
49797dbc725eSTejun Heo }
49807dbc725eSTejun Heo 
49817ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu)
49821da177e4SLinus Torvalds {
49834ce62e9eSTejun Heo 	struct worker_pool *pool;
49841da177e4SLinus Torvalds 
4985f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
49863ce63377STejun Heo 		if (pool->nr_workers)
49873ce63377STejun Heo 			continue;
4988051e1850SLai Jiangshan 		if (!create_worker(pool))
49897ee681b2SThomas Gleixner 			return -ENOMEM;
49903af24433SOleg Nesterov 	}
49917ee681b2SThomas Gleixner 	return 0;
49927ee681b2SThomas Gleixner }
49931da177e4SLinus Torvalds 
49947ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu)
49957ee681b2SThomas Gleixner {
49967ee681b2SThomas Gleixner 	struct worker_pool *pool;
49977ee681b2SThomas Gleixner 	struct workqueue_struct *wq;
49987ee681b2SThomas Gleixner 	int pi;
49997ee681b2SThomas Gleixner 
500068e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
50017dbc725eSTejun Heo 
50027dbc725eSTejun Heo 	for_each_pool(pool, pi) {
50031258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
500494cf58bbSTejun Heo 
5005f05b558dSLai Jiangshan 		if (pool->cpu == cpu)
500694cf58bbSTejun Heo 			rebind_workers(pool);
5007f05b558dSLai Jiangshan 		else if (pool->cpu < 0)
50087dbc725eSTejun Heo 			restore_unbound_workers_cpumask(pool, cpu);
500994cf58bbSTejun Heo 
50101258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
501194cf58bbSTejun Heo 	}
50127dbc725eSTejun Heo 
50134c16bd32STejun Heo 	/* update NUMA affinity of unbound workqueues */
50144c16bd32STejun Heo 	list_for_each_entry(wq, &workqueues, list)
50154c16bd32STejun Heo 		wq_update_unbound_numa(wq, cpu, true);
50164c16bd32STejun Heo 
501768e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
50187ee681b2SThomas Gleixner 	return 0;
501965758202STejun Heo }
502065758202STejun Heo 
50217ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu)
502265758202STejun Heo {
50234c16bd32STejun Heo 	struct workqueue_struct *wq;
50248db25e78STejun Heo 
50254c16bd32STejun Heo 	/* unbinding per-cpu workers should happen on the local CPU */
5026e8b3f8dbSLai Jiangshan 	if (WARN_ON(cpu != smp_processor_id()))
5027e8b3f8dbSLai Jiangshan 		return -1;
5028e8b3f8dbSLai Jiangshan 
5029e8b3f8dbSLai Jiangshan 	unbind_workers(cpu);
50304c16bd32STejun Heo 
50314c16bd32STejun Heo 	/* update NUMA affinity of unbound workqueues */
50324c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
50334c16bd32STejun Heo 	list_for_each_entry(wq, &workqueues, list)
50344c16bd32STejun Heo 		wq_update_unbound_numa(wq, cpu, false);
50354c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
50364c16bd32STejun Heo 
50377ee681b2SThomas Gleixner 	return 0;
503865758202STejun Heo }
503965758202STejun Heo 
50402d3854a3SRusty Russell struct work_for_cpu {
5041ed48ece2STejun Heo 	struct work_struct work;
50422d3854a3SRusty Russell 	long (*fn)(void *);
50432d3854a3SRusty Russell 	void *arg;
50442d3854a3SRusty Russell 	long ret;
50452d3854a3SRusty Russell };
50462d3854a3SRusty Russell 
5047ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
50482d3854a3SRusty Russell {
5049ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5050ed48ece2STejun Heo 
50512d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
50522d3854a3SRusty Russell }
50532d3854a3SRusty Russell 
50542d3854a3SRusty Russell /**
505522aceb31SAnna-Maria Gleixner  * work_on_cpu - run a function in thread context on a particular cpu
50562d3854a3SRusty Russell  * @cpu: the cpu to run on
50572d3854a3SRusty Russell  * @fn: the function to run
50582d3854a3SRusty Russell  * @arg: the function arg
50592d3854a3SRusty Russell  *
506031ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
50616b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
5062d185af30SYacine Belkadi  *
5063d185af30SYacine Belkadi  * Return: The value @fn returns.
50642d3854a3SRusty Russell  */
5065d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
50662d3854a3SRusty Russell {
5067ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
50682d3854a3SRusty Russell 
5069ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5070ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
507112997d1aSBjorn Helgaas 	flush_work(&wfc.work);
5072440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
50732d3854a3SRusty Russell 	return wfc.ret;
50742d3854a3SRusty Russell }
50752d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
50760e8d6a93SThomas Gleixner 
50770e8d6a93SThomas Gleixner /**
50780e8d6a93SThomas Gleixner  * work_on_cpu_safe - run a function in thread context on a particular cpu
50790e8d6a93SThomas Gleixner  * @cpu: the cpu to run on
50800e8d6a93SThomas Gleixner  * @fn:  the function to run
50810e8d6a93SThomas Gleixner  * @arg: the function argument
50820e8d6a93SThomas Gleixner  *
50830e8d6a93SThomas Gleixner  * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
50840e8d6a93SThomas Gleixner  * any locks which would prevent @fn from completing.
50850e8d6a93SThomas Gleixner  *
50860e8d6a93SThomas Gleixner  * Return: The value @fn returns.
50870e8d6a93SThomas Gleixner  */
50880e8d6a93SThomas Gleixner long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
50890e8d6a93SThomas Gleixner {
50900e8d6a93SThomas Gleixner 	long ret = -ENODEV;
50910e8d6a93SThomas Gleixner 
50920e8d6a93SThomas Gleixner 	get_online_cpus();
50930e8d6a93SThomas Gleixner 	if (cpu_online(cpu))
50940e8d6a93SThomas Gleixner 		ret = work_on_cpu(cpu, fn, arg);
50950e8d6a93SThomas Gleixner 	put_online_cpus();
50960e8d6a93SThomas Gleixner 	return ret;
50970e8d6a93SThomas Gleixner }
50980e8d6a93SThomas Gleixner EXPORT_SYMBOL_GPL(work_on_cpu_safe);
50992d3854a3SRusty Russell #endif /* CONFIG_SMP */
51002d3854a3SRusty Russell 
5101a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
5102e7577c50SRusty Russell 
5103a0a1a5fdSTejun Heo /**
5104a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
5105a0a1a5fdSTejun Heo  *
510658a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
5107c5aa87bbSTejun Heo  * workqueues will queue new works to their delayed_works list instead of
5108706026c2STejun Heo  * pool->worklist.
5109a0a1a5fdSTejun Heo  *
5110a0a1a5fdSTejun Heo  * CONTEXT:
5111a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5112a0a1a5fdSTejun Heo  */
5113a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
5114a0a1a5fdSTejun Heo {
511524b8a847STejun Heo 	struct workqueue_struct *wq;
511624b8a847STejun Heo 	struct pool_workqueue *pwq;
5117a0a1a5fdSTejun Heo 
511868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5119a0a1a5fdSTejun Heo 
51206183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
5121a0a1a5fdSTejun Heo 	workqueue_freezing = true;
5122a0a1a5fdSTejun Heo 
512324b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
5124a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
5125699ce097STejun Heo 		for_each_pwq(pwq, wq)
5126699ce097STejun Heo 			pwq_adjust_max_active(pwq);
5127a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
5128a1056305STejun Heo 	}
51295bcab335STejun Heo 
513068e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5131a0a1a5fdSTejun Heo }
5132a0a1a5fdSTejun Heo 
5133a0a1a5fdSTejun Heo /**
513458a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
5135a0a1a5fdSTejun Heo  *
5136a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
5137a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
5138a0a1a5fdSTejun Heo  *
5139a0a1a5fdSTejun Heo  * CONTEXT:
514068e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
5141a0a1a5fdSTejun Heo  *
5142d185af30SYacine Belkadi  * Return:
514358a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
514458a69cb4STejun Heo  * is complete.
5145a0a1a5fdSTejun Heo  */
5146a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
5147a0a1a5fdSTejun Heo {
5148a0a1a5fdSTejun Heo 	bool busy = false;
514924b8a847STejun Heo 	struct workqueue_struct *wq;
515024b8a847STejun Heo 	struct pool_workqueue *pwq;
5151a0a1a5fdSTejun Heo 
515268e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5153a0a1a5fdSTejun Heo 
51546183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
5155a0a1a5fdSTejun Heo 
515624b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
515724b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
515824b8a847STejun Heo 			continue;
5159a0a1a5fdSTejun Heo 		/*
5160a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
5161a0a1a5fdSTejun Heo 		 * to peek without lock.
5162a0a1a5fdSTejun Heo 		 */
5163*24acfb71SThomas Gleixner 		rcu_read_lock();
516424b8a847STejun Heo 		for_each_pwq(pwq, wq) {
51656183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
5166112202d9STejun Heo 			if (pwq->nr_active) {
5167a0a1a5fdSTejun Heo 				busy = true;
5168*24acfb71SThomas Gleixner 				rcu_read_unlock();
5169a0a1a5fdSTejun Heo 				goto out_unlock;
5170a0a1a5fdSTejun Heo 			}
5171a0a1a5fdSTejun Heo 		}
5172*24acfb71SThomas Gleixner 		rcu_read_unlock();
5173a0a1a5fdSTejun Heo 	}
5174a0a1a5fdSTejun Heo out_unlock:
517568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5176a0a1a5fdSTejun Heo 	return busy;
5177a0a1a5fdSTejun Heo }
5178a0a1a5fdSTejun Heo 
5179a0a1a5fdSTejun Heo /**
5180a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
5181a0a1a5fdSTejun Heo  *
5182a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
5183706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
5184a0a1a5fdSTejun Heo  *
5185a0a1a5fdSTejun Heo  * CONTEXT:
5186a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5187a0a1a5fdSTejun Heo  */
5188a0a1a5fdSTejun Heo void thaw_workqueues(void)
5189a0a1a5fdSTejun Heo {
519024b8a847STejun Heo 	struct workqueue_struct *wq;
519124b8a847STejun Heo 	struct pool_workqueue *pwq;
5192a0a1a5fdSTejun Heo 
519368e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5194a0a1a5fdSTejun Heo 
5195a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
5196a0a1a5fdSTejun Heo 		goto out_unlock;
5197a0a1a5fdSTejun Heo 
519874b414eaSLai Jiangshan 	workqueue_freezing = false;
519924b8a847STejun Heo 
520024b8a847STejun Heo 	/* restore max_active and repopulate worklist */
520124b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
5202a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
5203699ce097STejun Heo 		for_each_pwq(pwq, wq)
5204699ce097STejun Heo 			pwq_adjust_max_active(pwq);
5205a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
520624b8a847STejun Heo 	}
520724b8a847STejun Heo 
5208a0a1a5fdSTejun Heo out_unlock:
520968e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5210a0a1a5fdSTejun Heo }
5211a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
5212a0a1a5fdSTejun Heo 
5213042f7df1SLai Jiangshan static int workqueue_apply_unbound_cpumask(void)
5214042f7df1SLai Jiangshan {
5215042f7df1SLai Jiangshan 	LIST_HEAD(ctxs);
5216042f7df1SLai Jiangshan 	int ret = 0;
5217042f7df1SLai Jiangshan 	struct workqueue_struct *wq;
5218042f7df1SLai Jiangshan 	struct apply_wqattrs_ctx *ctx, *n;
5219042f7df1SLai Jiangshan 
5220042f7df1SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5221042f7df1SLai Jiangshan 
5222042f7df1SLai Jiangshan 	list_for_each_entry(wq, &workqueues, list) {
5223042f7df1SLai Jiangshan 		if (!(wq->flags & WQ_UNBOUND))
5224042f7df1SLai Jiangshan 			continue;
5225042f7df1SLai Jiangshan 		/* creating multiple pwqs breaks ordering guarantee */
5226042f7df1SLai Jiangshan 		if (wq->flags & __WQ_ORDERED)
5227042f7df1SLai Jiangshan 			continue;
5228042f7df1SLai Jiangshan 
5229042f7df1SLai Jiangshan 		ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs);
5230042f7df1SLai Jiangshan 		if (!ctx) {
5231042f7df1SLai Jiangshan 			ret = -ENOMEM;
5232042f7df1SLai Jiangshan 			break;
5233042f7df1SLai Jiangshan 		}
5234042f7df1SLai Jiangshan 
5235042f7df1SLai Jiangshan 		list_add_tail(&ctx->list, &ctxs);
5236042f7df1SLai Jiangshan 	}
5237042f7df1SLai Jiangshan 
5238042f7df1SLai Jiangshan 	list_for_each_entry_safe(ctx, n, &ctxs, list) {
5239042f7df1SLai Jiangshan 		if (!ret)
5240042f7df1SLai Jiangshan 			apply_wqattrs_commit(ctx);
5241042f7df1SLai Jiangshan 		apply_wqattrs_cleanup(ctx);
5242042f7df1SLai Jiangshan 	}
5243042f7df1SLai Jiangshan 
5244042f7df1SLai Jiangshan 	return ret;
5245042f7df1SLai Jiangshan }
5246042f7df1SLai Jiangshan 
5247042f7df1SLai Jiangshan /**
5248042f7df1SLai Jiangshan  *  workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5249042f7df1SLai Jiangshan  *  @cpumask: the cpumask to set
5250042f7df1SLai Jiangshan  *
5251042f7df1SLai Jiangshan  *  The low-level workqueues cpumask is a global cpumask that limits
5252042f7df1SLai Jiangshan  *  the affinity of all unbound workqueues.  This function check the @cpumask
5253042f7df1SLai Jiangshan  *  and apply it to all unbound workqueues and updates all pwqs of them.
5254042f7df1SLai Jiangshan  *
5255042f7df1SLai Jiangshan  *  Retun:	0	- Success
5256042f7df1SLai Jiangshan  *  		-EINVAL	- Invalid @cpumask
5257042f7df1SLai Jiangshan  *  		-ENOMEM	- Failed to allocate memory for attrs or pwqs.
5258042f7df1SLai Jiangshan  */
5259042f7df1SLai Jiangshan int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5260042f7df1SLai Jiangshan {
5261042f7df1SLai Jiangshan 	int ret = -EINVAL;
5262042f7df1SLai Jiangshan 	cpumask_var_t saved_cpumask;
5263042f7df1SLai Jiangshan 
5264042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL))
5265042f7df1SLai Jiangshan 		return -ENOMEM;
5266042f7df1SLai Jiangshan 
5267c98a9805STal Shorer 	/*
5268c98a9805STal Shorer 	 * Not excluding isolated cpus on purpose.
5269c98a9805STal Shorer 	 * If the user wishes to include them, we allow that.
5270c98a9805STal Shorer 	 */
5271042f7df1SLai Jiangshan 	cpumask_and(cpumask, cpumask, cpu_possible_mask);
5272042f7df1SLai Jiangshan 	if (!cpumask_empty(cpumask)) {
5273a0111cf6SLai Jiangshan 		apply_wqattrs_lock();
5274042f7df1SLai Jiangshan 
5275042f7df1SLai Jiangshan 		/* save the old wq_unbound_cpumask. */
5276042f7df1SLai Jiangshan 		cpumask_copy(saved_cpumask, wq_unbound_cpumask);
5277042f7df1SLai Jiangshan 
5278042f7df1SLai Jiangshan 		/* update wq_unbound_cpumask at first and apply it to wqs. */
5279042f7df1SLai Jiangshan 		cpumask_copy(wq_unbound_cpumask, cpumask);
5280042f7df1SLai Jiangshan 		ret = workqueue_apply_unbound_cpumask();
5281042f7df1SLai Jiangshan 
5282042f7df1SLai Jiangshan 		/* restore the wq_unbound_cpumask when failed. */
5283042f7df1SLai Jiangshan 		if (ret < 0)
5284042f7df1SLai Jiangshan 			cpumask_copy(wq_unbound_cpumask, saved_cpumask);
5285042f7df1SLai Jiangshan 
5286a0111cf6SLai Jiangshan 		apply_wqattrs_unlock();
5287042f7df1SLai Jiangshan 	}
5288042f7df1SLai Jiangshan 
5289042f7df1SLai Jiangshan 	free_cpumask_var(saved_cpumask);
5290042f7df1SLai Jiangshan 	return ret;
5291042f7df1SLai Jiangshan }
5292042f7df1SLai Jiangshan 
52936ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS
52946ba94429SFrederic Weisbecker /*
52956ba94429SFrederic Weisbecker  * Workqueues with WQ_SYSFS flag set is visible to userland via
52966ba94429SFrederic Weisbecker  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
52976ba94429SFrederic Weisbecker  * following attributes.
52986ba94429SFrederic Weisbecker  *
52996ba94429SFrederic Weisbecker  *  per_cpu	RO bool	: whether the workqueue is per-cpu or unbound
53006ba94429SFrederic Weisbecker  *  max_active	RW int	: maximum number of in-flight work items
53016ba94429SFrederic Weisbecker  *
53026ba94429SFrederic Weisbecker  * Unbound workqueues have the following extra attributes.
53036ba94429SFrederic Weisbecker  *
53049a19b463SWang Long  *  pool_ids	RO int	: the associated pool IDs for each node
53056ba94429SFrederic Weisbecker  *  nice	RW int	: nice value of the workers
53066ba94429SFrederic Weisbecker  *  cpumask	RW mask	: bitmask of allowed CPUs for the workers
53079a19b463SWang Long  *  numa	RW bool	: whether enable NUMA affinity
53086ba94429SFrederic Weisbecker  */
53096ba94429SFrederic Weisbecker struct wq_device {
53106ba94429SFrederic Weisbecker 	struct workqueue_struct		*wq;
53116ba94429SFrederic Weisbecker 	struct device			dev;
53126ba94429SFrederic Weisbecker };
53136ba94429SFrederic Weisbecker 
53146ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev)
53156ba94429SFrederic Weisbecker {
53166ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
53176ba94429SFrederic Weisbecker 
53186ba94429SFrederic Weisbecker 	return wq_dev->wq;
53196ba94429SFrederic Weisbecker }
53206ba94429SFrederic Weisbecker 
53216ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
53226ba94429SFrederic Weisbecker 			    char *buf)
53236ba94429SFrederic Weisbecker {
53246ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53256ba94429SFrederic Weisbecker 
53266ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
53276ba94429SFrederic Weisbecker }
53286ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu);
53296ba94429SFrederic Weisbecker 
53306ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev,
53316ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
53326ba94429SFrederic Weisbecker {
53336ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53346ba94429SFrederic Weisbecker 
53356ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
53366ba94429SFrederic Weisbecker }
53376ba94429SFrederic Weisbecker 
53386ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev,
53396ba94429SFrederic Weisbecker 				struct device_attribute *attr, const char *buf,
53406ba94429SFrederic Weisbecker 				size_t count)
53416ba94429SFrederic Weisbecker {
53426ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53436ba94429SFrederic Weisbecker 	int val;
53446ba94429SFrederic Weisbecker 
53456ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
53466ba94429SFrederic Weisbecker 		return -EINVAL;
53476ba94429SFrederic Weisbecker 
53486ba94429SFrederic Weisbecker 	workqueue_set_max_active(wq, val);
53496ba94429SFrederic Weisbecker 	return count;
53506ba94429SFrederic Weisbecker }
53516ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active);
53526ba94429SFrederic Weisbecker 
53536ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = {
53546ba94429SFrederic Weisbecker 	&dev_attr_per_cpu.attr,
53556ba94429SFrederic Weisbecker 	&dev_attr_max_active.attr,
53566ba94429SFrederic Weisbecker 	NULL,
53576ba94429SFrederic Weisbecker };
53586ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs);
53596ba94429SFrederic Weisbecker 
53606ba94429SFrederic Weisbecker static ssize_t wq_pool_ids_show(struct device *dev,
53616ba94429SFrederic Weisbecker 				struct device_attribute *attr, char *buf)
53626ba94429SFrederic Weisbecker {
53636ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53646ba94429SFrederic Weisbecker 	const char *delim = "";
53656ba94429SFrederic Weisbecker 	int node, written = 0;
53666ba94429SFrederic Weisbecker 
5367*24acfb71SThomas Gleixner 	get_online_cpus();
5368*24acfb71SThomas Gleixner 	rcu_read_lock();
53696ba94429SFrederic Weisbecker 	for_each_node(node) {
53706ba94429SFrederic Weisbecker 		written += scnprintf(buf + written, PAGE_SIZE - written,
53716ba94429SFrederic Weisbecker 				     "%s%d:%d", delim, node,
53726ba94429SFrederic Weisbecker 				     unbound_pwq_by_node(wq, node)->pool->id);
53736ba94429SFrederic Weisbecker 		delim = " ";
53746ba94429SFrederic Weisbecker 	}
53756ba94429SFrederic Weisbecker 	written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
5376*24acfb71SThomas Gleixner 	rcu_read_unlock();
5377*24acfb71SThomas Gleixner 	put_online_cpus();
53786ba94429SFrederic Weisbecker 
53796ba94429SFrederic Weisbecker 	return written;
53806ba94429SFrederic Weisbecker }
53816ba94429SFrederic Weisbecker 
53826ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
53836ba94429SFrederic Weisbecker 			    char *buf)
53846ba94429SFrederic Weisbecker {
53856ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
53866ba94429SFrederic Weisbecker 	int written;
53876ba94429SFrederic Weisbecker 
53886ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
53896ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
53906ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
53916ba94429SFrederic Weisbecker 
53926ba94429SFrederic Weisbecker 	return written;
53936ba94429SFrederic Weisbecker }
53946ba94429SFrederic Weisbecker 
53956ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */
53966ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
53976ba94429SFrederic Weisbecker {
53986ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
53996ba94429SFrederic Weisbecker 
5400899a94feSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5401899a94feSLai Jiangshan 
54026ba94429SFrederic Weisbecker 	attrs = alloc_workqueue_attrs(GFP_KERNEL);
54036ba94429SFrederic Weisbecker 	if (!attrs)
54046ba94429SFrederic Weisbecker 		return NULL;
54056ba94429SFrederic Weisbecker 
54066ba94429SFrederic Weisbecker 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
54076ba94429SFrederic Weisbecker 	return attrs;
54086ba94429SFrederic Weisbecker }
54096ba94429SFrederic Weisbecker 
54106ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
54116ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
54126ba94429SFrederic Weisbecker {
54136ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54146ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5415d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
5416d4d3e257SLai Jiangshan 
5417d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
54186ba94429SFrederic Weisbecker 
54196ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
54206ba94429SFrederic Weisbecker 	if (!attrs)
5421d4d3e257SLai Jiangshan 		goto out_unlock;
54226ba94429SFrederic Weisbecker 
54236ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
54246ba94429SFrederic Weisbecker 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
5425d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
54266ba94429SFrederic Weisbecker 	else
54276ba94429SFrederic Weisbecker 		ret = -EINVAL;
54286ba94429SFrederic Weisbecker 
5429d4d3e257SLai Jiangshan out_unlock:
5430d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
54316ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
54326ba94429SFrederic Weisbecker 	return ret ?: count;
54336ba94429SFrederic Weisbecker }
54346ba94429SFrederic Weisbecker 
54356ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev,
54366ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
54376ba94429SFrederic Weisbecker {
54386ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54396ba94429SFrederic Weisbecker 	int written;
54406ba94429SFrederic Weisbecker 
54416ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
54426ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
54436ba94429SFrederic Weisbecker 			    cpumask_pr_args(wq->unbound_attrs->cpumask));
54446ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
54456ba94429SFrederic Weisbecker 	return written;
54466ba94429SFrederic Weisbecker }
54476ba94429SFrederic Weisbecker 
54486ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev,
54496ba94429SFrederic Weisbecker 				struct device_attribute *attr,
54506ba94429SFrederic Weisbecker 				const char *buf, size_t count)
54516ba94429SFrederic Weisbecker {
54526ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54536ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5454d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
5455d4d3e257SLai Jiangshan 
5456d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
54576ba94429SFrederic Weisbecker 
54586ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
54596ba94429SFrederic Weisbecker 	if (!attrs)
5460d4d3e257SLai Jiangshan 		goto out_unlock;
54616ba94429SFrederic Weisbecker 
54626ba94429SFrederic Weisbecker 	ret = cpumask_parse(buf, attrs->cpumask);
54636ba94429SFrederic Weisbecker 	if (!ret)
5464d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
54656ba94429SFrederic Weisbecker 
5466d4d3e257SLai Jiangshan out_unlock:
5467d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
54686ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
54696ba94429SFrederic Weisbecker 	return ret ?: count;
54706ba94429SFrederic Weisbecker }
54716ba94429SFrederic Weisbecker 
54726ba94429SFrederic Weisbecker static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
54736ba94429SFrederic Weisbecker 			    char *buf)
54746ba94429SFrederic Weisbecker {
54756ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54766ba94429SFrederic Weisbecker 	int written;
54776ba94429SFrederic Weisbecker 
54786ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
54796ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n",
54806ba94429SFrederic Weisbecker 			    !wq->unbound_attrs->no_numa);
54816ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
54826ba94429SFrederic Weisbecker 
54836ba94429SFrederic Weisbecker 	return written;
54846ba94429SFrederic Weisbecker }
54856ba94429SFrederic Weisbecker 
54866ba94429SFrederic Weisbecker static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr,
54876ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
54886ba94429SFrederic Weisbecker {
54896ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
54906ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5491d4d3e257SLai Jiangshan 	int v, ret = -ENOMEM;
5492d4d3e257SLai Jiangshan 
5493d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
54946ba94429SFrederic Weisbecker 
54956ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
54966ba94429SFrederic Weisbecker 	if (!attrs)
5497d4d3e257SLai Jiangshan 		goto out_unlock;
54986ba94429SFrederic Weisbecker 
54996ba94429SFrederic Weisbecker 	ret = -EINVAL;
55006ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &v) == 1) {
55016ba94429SFrederic Weisbecker 		attrs->no_numa = !v;
5502d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
55036ba94429SFrederic Weisbecker 	}
55046ba94429SFrederic Weisbecker 
5505d4d3e257SLai Jiangshan out_unlock:
5506d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
55076ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
55086ba94429SFrederic Weisbecker 	return ret ?: count;
55096ba94429SFrederic Weisbecker }
55106ba94429SFrederic Weisbecker 
55116ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = {
55126ba94429SFrederic Weisbecker 	__ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
55136ba94429SFrederic Weisbecker 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
55146ba94429SFrederic Weisbecker 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
55156ba94429SFrederic Weisbecker 	__ATTR(numa, 0644, wq_numa_show, wq_numa_store),
55166ba94429SFrederic Weisbecker 	__ATTR_NULL,
55176ba94429SFrederic Weisbecker };
55186ba94429SFrederic Weisbecker 
55196ba94429SFrederic Weisbecker static struct bus_type wq_subsys = {
55206ba94429SFrederic Weisbecker 	.name				= "workqueue",
55216ba94429SFrederic Weisbecker 	.dev_groups			= wq_sysfs_groups,
55226ba94429SFrederic Weisbecker };
55236ba94429SFrederic Weisbecker 
5524b05a7928SFrederic Weisbecker static ssize_t wq_unbound_cpumask_show(struct device *dev,
5525b05a7928SFrederic Weisbecker 		struct device_attribute *attr, char *buf)
5526b05a7928SFrederic Weisbecker {
5527b05a7928SFrederic Weisbecker 	int written;
5528b05a7928SFrederic Weisbecker 
5529042f7df1SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5530b05a7928SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
5531b05a7928SFrederic Weisbecker 			    cpumask_pr_args(wq_unbound_cpumask));
5532042f7df1SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5533b05a7928SFrederic Weisbecker 
5534b05a7928SFrederic Weisbecker 	return written;
5535b05a7928SFrederic Weisbecker }
5536b05a7928SFrederic Weisbecker 
5537042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev,
5538042f7df1SLai Jiangshan 		struct device_attribute *attr, const char *buf, size_t count)
5539042f7df1SLai Jiangshan {
5540042f7df1SLai Jiangshan 	cpumask_var_t cpumask;
5541042f7df1SLai Jiangshan 	int ret;
5542042f7df1SLai Jiangshan 
5543042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
5544042f7df1SLai Jiangshan 		return -ENOMEM;
5545042f7df1SLai Jiangshan 
5546042f7df1SLai Jiangshan 	ret = cpumask_parse(buf, cpumask);
5547042f7df1SLai Jiangshan 	if (!ret)
5548042f7df1SLai Jiangshan 		ret = workqueue_set_unbound_cpumask(cpumask);
5549042f7df1SLai Jiangshan 
5550042f7df1SLai Jiangshan 	free_cpumask_var(cpumask);
5551042f7df1SLai Jiangshan 	return ret ? ret : count;
5552042f7df1SLai Jiangshan }
5553042f7df1SLai Jiangshan 
5554b05a7928SFrederic Weisbecker static struct device_attribute wq_sysfs_cpumask_attr =
5555042f7df1SLai Jiangshan 	__ATTR(cpumask, 0644, wq_unbound_cpumask_show,
5556042f7df1SLai Jiangshan 	       wq_unbound_cpumask_store);
5557b05a7928SFrederic Weisbecker 
55586ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void)
55596ba94429SFrederic Weisbecker {
5560b05a7928SFrederic Weisbecker 	int err;
5561b05a7928SFrederic Weisbecker 
5562b05a7928SFrederic Weisbecker 	err = subsys_virtual_register(&wq_subsys, NULL);
5563b05a7928SFrederic Weisbecker 	if (err)
5564b05a7928SFrederic Weisbecker 		return err;
5565b05a7928SFrederic Weisbecker 
5566b05a7928SFrederic Weisbecker 	return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr);
55676ba94429SFrederic Weisbecker }
55686ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init);
55696ba94429SFrederic Weisbecker 
55706ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev)
55716ba94429SFrederic Weisbecker {
55726ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
55736ba94429SFrederic Weisbecker 
55746ba94429SFrederic Weisbecker 	kfree(wq_dev);
55756ba94429SFrederic Weisbecker }
55766ba94429SFrederic Weisbecker 
55776ba94429SFrederic Weisbecker /**
55786ba94429SFrederic Weisbecker  * workqueue_sysfs_register - make a workqueue visible in sysfs
55796ba94429SFrederic Weisbecker  * @wq: the workqueue to register
55806ba94429SFrederic Weisbecker  *
55816ba94429SFrederic Weisbecker  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
55826ba94429SFrederic Weisbecker  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
55836ba94429SFrederic Weisbecker  * which is the preferred method.
55846ba94429SFrederic Weisbecker  *
55856ba94429SFrederic Weisbecker  * Workqueue user should use this function directly iff it wants to apply
55866ba94429SFrederic Weisbecker  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
55876ba94429SFrederic Weisbecker  * apply_workqueue_attrs() may race against userland updating the
55886ba94429SFrederic Weisbecker  * attributes.
55896ba94429SFrederic Weisbecker  *
55906ba94429SFrederic Weisbecker  * Return: 0 on success, -errno on failure.
55916ba94429SFrederic Weisbecker  */
55926ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq)
55936ba94429SFrederic Weisbecker {
55946ba94429SFrederic Weisbecker 	struct wq_device *wq_dev;
55956ba94429SFrederic Weisbecker 	int ret;
55966ba94429SFrederic Weisbecker 
55976ba94429SFrederic Weisbecker 	/*
5598402dd89dSShailendra Verma 	 * Adjusting max_active or creating new pwqs by applying
55996ba94429SFrederic Weisbecker 	 * attributes breaks ordering guarantee.  Disallow exposing ordered
56006ba94429SFrederic Weisbecker 	 * workqueues.
56016ba94429SFrederic Weisbecker 	 */
56020a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
56036ba94429SFrederic Weisbecker 		return -EINVAL;
56046ba94429SFrederic Weisbecker 
56056ba94429SFrederic Weisbecker 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
56066ba94429SFrederic Weisbecker 	if (!wq_dev)
56076ba94429SFrederic Weisbecker 		return -ENOMEM;
56086ba94429SFrederic Weisbecker 
56096ba94429SFrederic Weisbecker 	wq_dev->wq = wq;
56106ba94429SFrederic Weisbecker 	wq_dev->dev.bus = &wq_subsys;
56116ba94429SFrederic Weisbecker 	wq_dev->dev.release = wq_device_release;
561223217b44SLars-Peter Clausen 	dev_set_name(&wq_dev->dev, "%s", wq->name);
56136ba94429SFrederic Weisbecker 
56146ba94429SFrederic Weisbecker 	/*
56156ba94429SFrederic Weisbecker 	 * unbound_attrs are created separately.  Suppress uevent until
56166ba94429SFrederic Weisbecker 	 * everything is ready.
56176ba94429SFrederic Weisbecker 	 */
56186ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, true);
56196ba94429SFrederic Weisbecker 
56206ba94429SFrederic Weisbecker 	ret = device_register(&wq_dev->dev);
56216ba94429SFrederic Weisbecker 	if (ret) {
5622537f4146SArvind Yadav 		put_device(&wq_dev->dev);
56236ba94429SFrederic Weisbecker 		wq->wq_dev = NULL;
56246ba94429SFrederic Weisbecker 		return ret;
56256ba94429SFrederic Weisbecker 	}
56266ba94429SFrederic Weisbecker 
56276ba94429SFrederic Weisbecker 	if (wq->flags & WQ_UNBOUND) {
56286ba94429SFrederic Weisbecker 		struct device_attribute *attr;
56296ba94429SFrederic Weisbecker 
56306ba94429SFrederic Weisbecker 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
56316ba94429SFrederic Weisbecker 			ret = device_create_file(&wq_dev->dev, attr);
56326ba94429SFrederic Weisbecker 			if (ret) {
56336ba94429SFrederic Weisbecker 				device_unregister(&wq_dev->dev);
56346ba94429SFrederic Weisbecker 				wq->wq_dev = NULL;
56356ba94429SFrederic Weisbecker 				return ret;
56366ba94429SFrederic Weisbecker 			}
56376ba94429SFrederic Weisbecker 		}
56386ba94429SFrederic Weisbecker 	}
56396ba94429SFrederic Weisbecker 
56406ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, false);
56416ba94429SFrederic Weisbecker 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
56426ba94429SFrederic Weisbecker 	return 0;
56436ba94429SFrederic Weisbecker }
56446ba94429SFrederic Weisbecker 
56456ba94429SFrederic Weisbecker /**
56466ba94429SFrederic Weisbecker  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
56476ba94429SFrederic Weisbecker  * @wq: the workqueue to unregister
56486ba94429SFrederic Weisbecker  *
56496ba94429SFrederic Weisbecker  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
56506ba94429SFrederic Weisbecker  */
56516ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
56526ba94429SFrederic Weisbecker {
56536ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = wq->wq_dev;
56546ba94429SFrederic Weisbecker 
56556ba94429SFrederic Weisbecker 	if (!wq->wq_dev)
56566ba94429SFrederic Weisbecker 		return;
56576ba94429SFrederic Weisbecker 
56586ba94429SFrederic Weisbecker 	wq->wq_dev = NULL;
56596ba94429SFrederic Weisbecker 	device_unregister(&wq_dev->dev);
56606ba94429SFrederic Weisbecker }
56616ba94429SFrederic Weisbecker #else	/* CONFIG_SYSFS */
56626ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
56636ba94429SFrederic Weisbecker #endif	/* CONFIG_SYSFS */
56646ba94429SFrederic Weisbecker 
566582607adcSTejun Heo /*
566682607adcSTejun Heo  * Workqueue watchdog.
566782607adcSTejun Heo  *
566882607adcSTejun Heo  * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
566982607adcSTejun Heo  * flush dependency, a concurrency managed work item which stays RUNNING
567082607adcSTejun Heo  * indefinitely.  Workqueue stalls can be very difficult to debug as the
567182607adcSTejun Heo  * usual warning mechanisms don't trigger and internal workqueue state is
567282607adcSTejun Heo  * largely opaque.
567382607adcSTejun Heo  *
567482607adcSTejun Heo  * Workqueue watchdog monitors all worker pools periodically and dumps
567582607adcSTejun Heo  * state if some pools failed to make forward progress for a while where
567682607adcSTejun Heo  * forward progress is defined as the first item on ->worklist changing.
567782607adcSTejun Heo  *
567882607adcSTejun Heo  * This mechanism is controlled through the kernel parameter
567982607adcSTejun Heo  * "workqueue.watchdog_thresh" which can be updated at runtime through the
568082607adcSTejun Heo  * corresponding sysfs parameter file.
568182607adcSTejun Heo  */
568282607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG
568382607adcSTejun Heo 
568482607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30;
56855cd79d6aSKees Cook static struct timer_list wq_watchdog_timer;
568682607adcSTejun Heo 
568782607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
568882607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
568982607adcSTejun Heo 
569082607adcSTejun Heo static void wq_watchdog_reset_touched(void)
569182607adcSTejun Heo {
569282607adcSTejun Heo 	int cpu;
569382607adcSTejun Heo 
569482607adcSTejun Heo 	wq_watchdog_touched = jiffies;
569582607adcSTejun Heo 	for_each_possible_cpu(cpu)
569682607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
569782607adcSTejun Heo }
569882607adcSTejun Heo 
56995cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused)
570082607adcSTejun Heo {
570182607adcSTejun Heo 	unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
570282607adcSTejun Heo 	bool lockup_detected = false;
570382607adcSTejun Heo 	struct worker_pool *pool;
570482607adcSTejun Heo 	int pi;
570582607adcSTejun Heo 
570682607adcSTejun Heo 	if (!thresh)
570782607adcSTejun Heo 		return;
570882607adcSTejun Heo 
570982607adcSTejun Heo 	rcu_read_lock();
571082607adcSTejun Heo 
571182607adcSTejun Heo 	for_each_pool(pool, pi) {
571282607adcSTejun Heo 		unsigned long pool_ts, touched, ts;
571382607adcSTejun Heo 
571482607adcSTejun Heo 		if (list_empty(&pool->worklist))
571582607adcSTejun Heo 			continue;
571682607adcSTejun Heo 
571782607adcSTejun Heo 		/* get the latest of pool and touched timestamps */
571882607adcSTejun Heo 		pool_ts = READ_ONCE(pool->watchdog_ts);
571982607adcSTejun Heo 		touched = READ_ONCE(wq_watchdog_touched);
572082607adcSTejun Heo 
572182607adcSTejun Heo 		if (time_after(pool_ts, touched))
572282607adcSTejun Heo 			ts = pool_ts;
572382607adcSTejun Heo 		else
572482607adcSTejun Heo 			ts = touched;
572582607adcSTejun Heo 
572682607adcSTejun Heo 		if (pool->cpu >= 0) {
572782607adcSTejun Heo 			unsigned long cpu_touched =
572882607adcSTejun Heo 				READ_ONCE(per_cpu(wq_watchdog_touched_cpu,
572982607adcSTejun Heo 						  pool->cpu));
573082607adcSTejun Heo 			if (time_after(cpu_touched, ts))
573182607adcSTejun Heo 				ts = cpu_touched;
573282607adcSTejun Heo 		}
573382607adcSTejun Heo 
573482607adcSTejun Heo 		/* did we stall? */
573582607adcSTejun Heo 		if (time_after(jiffies, ts + thresh)) {
573682607adcSTejun Heo 			lockup_detected = true;
573782607adcSTejun Heo 			pr_emerg("BUG: workqueue lockup - pool");
573882607adcSTejun Heo 			pr_cont_pool_info(pool);
573982607adcSTejun Heo 			pr_cont(" stuck for %us!\n",
574082607adcSTejun Heo 				jiffies_to_msecs(jiffies - pool_ts) / 1000);
574182607adcSTejun Heo 		}
574282607adcSTejun Heo 	}
574382607adcSTejun Heo 
574482607adcSTejun Heo 	rcu_read_unlock();
574582607adcSTejun Heo 
574682607adcSTejun Heo 	if (lockup_detected)
574782607adcSTejun Heo 		show_workqueue_state();
574882607adcSTejun Heo 
574982607adcSTejun Heo 	wq_watchdog_reset_touched();
575082607adcSTejun Heo 	mod_timer(&wq_watchdog_timer, jiffies + thresh);
575182607adcSTejun Heo }
575282607adcSTejun Heo 
5753cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu)
575482607adcSTejun Heo {
575582607adcSTejun Heo 	if (cpu >= 0)
575682607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
575782607adcSTejun Heo 	else
575882607adcSTejun Heo 		wq_watchdog_touched = jiffies;
575982607adcSTejun Heo }
576082607adcSTejun Heo 
576182607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh)
576282607adcSTejun Heo {
576382607adcSTejun Heo 	wq_watchdog_thresh = 0;
576482607adcSTejun Heo 	del_timer_sync(&wq_watchdog_timer);
576582607adcSTejun Heo 
576682607adcSTejun Heo 	if (thresh) {
576782607adcSTejun Heo 		wq_watchdog_thresh = thresh;
576882607adcSTejun Heo 		wq_watchdog_reset_touched();
576982607adcSTejun Heo 		mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
577082607adcSTejun Heo 	}
577182607adcSTejun Heo }
577282607adcSTejun Heo 
577382607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val,
577482607adcSTejun Heo 					const struct kernel_param *kp)
577582607adcSTejun Heo {
577682607adcSTejun Heo 	unsigned long thresh;
577782607adcSTejun Heo 	int ret;
577882607adcSTejun Heo 
577982607adcSTejun Heo 	ret = kstrtoul(val, 0, &thresh);
578082607adcSTejun Heo 	if (ret)
578182607adcSTejun Heo 		return ret;
578282607adcSTejun Heo 
578382607adcSTejun Heo 	if (system_wq)
578482607adcSTejun Heo 		wq_watchdog_set_thresh(thresh);
578582607adcSTejun Heo 	else
578682607adcSTejun Heo 		wq_watchdog_thresh = thresh;
578782607adcSTejun Heo 
578882607adcSTejun Heo 	return 0;
578982607adcSTejun Heo }
579082607adcSTejun Heo 
579182607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = {
579282607adcSTejun Heo 	.set	= wq_watchdog_param_set_thresh,
579382607adcSTejun Heo 	.get	= param_get_ulong,
579482607adcSTejun Heo };
579582607adcSTejun Heo 
579682607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
579782607adcSTejun Heo 		0644);
579882607adcSTejun Heo 
579982607adcSTejun Heo static void wq_watchdog_init(void)
580082607adcSTejun Heo {
58015cd79d6aSKees Cook 	timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
580282607adcSTejun Heo 	wq_watchdog_set_thresh(wq_watchdog_thresh);
580382607adcSTejun Heo }
580482607adcSTejun Heo 
580582607adcSTejun Heo #else	/* CONFIG_WQ_WATCHDOG */
580682607adcSTejun Heo 
580782607adcSTejun Heo static inline void wq_watchdog_init(void) { }
580882607adcSTejun Heo 
580982607adcSTejun Heo #endif	/* CONFIG_WQ_WATCHDOG */
581082607adcSTejun Heo 
5811bce90380STejun Heo static void __init wq_numa_init(void)
5812bce90380STejun Heo {
5813bce90380STejun Heo 	cpumask_var_t *tbl;
5814bce90380STejun Heo 	int node, cpu;
5815bce90380STejun Heo 
5816bce90380STejun Heo 	if (num_possible_nodes() <= 1)
5817bce90380STejun Heo 		return;
5818bce90380STejun Heo 
5819d55262c4STejun Heo 	if (wq_disable_numa) {
5820d55262c4STejun Heo 		pr_info("workqueue: NUMA affinity support disabled\n");
5821d55262c4STejun Heo 		return;
5822d55262c4STejun Heo 	}
5823d55262c4STejun Heo 
58244c16bd32STejun Heo 	wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
58254c16bd32STejun Heo 	BUG_ON(!wq_update_unbound_numa_attrs_buf);
58264c16bd32STejun Heo 
5827bce90380STejun Heo 	/*
5828bce90380STejun Heo 	 * We want masks of possible CPUs of each node which isn't readily
5829bce90380STejun Heo 	 * available.  Build one from cpu_to_node() which should have been
5830bce90380STejun Heo 	 * fully initialized by now.
5831bce90380STejun Heo 	 */
58326396bb22SKees Cook 	tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL);
5833bce90380STejun Heo 	BUG_ON(!tbl);
5834bce90380STejun Heo 
5835bce90380STejun Heo 	for_each_node(node)
58365a6024f1SYasuaki Ishimatsu 		BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
58371be0c25dSTejun Heo 				node_online(node) ? node : NUMA_NO_NODE));
5838bce90380STejun Heo 
5839bce90380STejun Heo 	for_each_possible_cpu(cpu) {
5840bce90380STejun Heo 		node = cpu_to_node(cpu);
5841bce90380STejun Heo 		if (WARN_ON(node == NUMA_NO_NODE)) {
5842bce90380STejun Heo 			pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
5843bce90380STejun Heo 			/* happens iff arch is bonkers, let's just proceed */
5844bce90380STejun Heo 			return;
5845bce90380STejun Heo 		}
5846bce90380STejun Heo 		cpumask_set_cpu(cpu, tbl[node]);
5847bce90380STejun Heo 	}
5848bce90380STejun Heo 
5849bce90380STejun Heo 	wq_numa_possible_cpumask = tbl;
5850bce90380STejun Heo 	wq_numa_enabled = true;
5851bce90380STejun Heo }
5852bce90380STejun Heo 
58533347fa09STejun Heo /**
58543347fa09STejun Heo  * workqueue_init_early - early init for workqueue subsystem
58553347fa09STejun Heo  *
58563347fa09STejun Heo  * This is the first half of two-staged workqueue subsystem initialization
58573347fa09STejun Heo  * and invoked as soon as the bare basics - memory allocation, cpumasks and
58583347fa09STejun Heo  * idr are up.  It sets up all the data structures and system workqueues
58593347fa09STejun Heo  * and allows early boot code to create workqueues and queue/cancel work
58603347fa09STejun Heo  * items.  Actual work item execution starts only after kthreads can be
58613347fa09STejun Heo  * created and scheduled right before early initcalls.
58623347fa09STejun Heo  */
58633347fa09STejun Heo int __init workqueue_init_early(void)
58641da177e4SLinus Torvalds {
58657a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
58661bda3f80SFrederic Weisbecker 	int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
58677a4e344cSTejun Heo 	int i, cpu;
5868c34056a3STejun Heo 
5869e904e6c2STejun Heo 	WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
5870e904e6c2STejun Heo 
5871b05a7928SFrederic Weisbecker 	BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
58721bda3f80SFrederic Weisbecker 	cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags));
5873b05a7928SFrederic Weisbecker 
5874e904e6c2STejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
5875e904e6c2STejun Heo 
5876706026c2STejun Heo 	/* initialize CPU pools */
587729c91e99STejun Heo 	for_each_possible_cpu(cpu) {
58784ce62e9eSTejun Heo 		struct worker_pool *pool;
58798b03ae3cSTejun Heo 
58807a4e344cSTejun Heo 		i = 0;
5881f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
58827a4e344cSTejun Heo 			BUG_ON(init_worker_pool(pool));
5883ec22ca5eSTejun Heo 			pool->cpu = cpu;
58847a4e344cSTejun Heo 			cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
58857a4e344cSTejun Heo 			pool->attrs->nice = std_nice[i++];
5886f3f90ad4STejun Heo 			pool->node = cpu_to_node(cpu);
58877a4e344cSTejun Heo 
58889daf9e67STejun Heo 			/* alloc pool ID */
588968e13a67SLai Jiangshan 			mutex_lock(&wq_pool_mutex);
58909daf9e67STejun Heo 			BUG_ON(worker_pool_assign_id(pool));
589168e13a67SLai Jiangshan 			mutex_unlock(&wq_pool_mutex);
58924ce62e9eSTejun Heo 		}
58938b03ae3cSTejun Heo 	}
58948b03ae3cSTejun Heo 
58958a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
589629c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
589729c91e99STejun Heo 		struct workqueue_attrs *attrs;
589829c91e99STejun Heo 
589929c91e99STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
590029c91e99STejun Heo 		attrs->nice = std_nice[i];
590129c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
59028a2b7538STejun Heo 
59038a2b7538STejun Heo 		/*
59048a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
59058a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
59068a2b7538STejun Heo 		 * Turn off NUMA so that dfl_pwq is used for all nodes.
59078a2b7538STejun Heo 		 */
59088a2b7538STejun Heo 		BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
59098a2b7538STejun Heo 		attrs->nice = std_nice[i];
59108a2b7538STejun Heo 		attrs->no_numa = true;
59118a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
591229c91e99STejun Heo 	}
591329c91e99STejun Heo 
5914d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
59151aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
5916d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
5917f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
5918f3421797STejun Heo 					    WQ_UNBOUND_MAX_ACTIVE);
591924d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
592024d51addSTejun Heo 					      WQ_FREEZABLE, 0);
59210668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
59220668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
59230668106cSViresh Kumar 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
59240668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
59250668106cSViresh Kumar 					      0);
59261aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
59270668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
59280668106cSViresh Kumar 	       !system_power_efficient_wq ||
59290668106cSViresh Kumar 	       !system_freezable_power_efficient_wq);
593082607adcSTejun Heo 
59313347fa09STejun Heo 	return 0;
59323347fa09STejun Heo }
59333347fa09STejun Heo 
59343347fa09STejun Heo /**
59353347fa09STejun Heo  * workqueue_init - bring workqueue subsystem fully online
59363347fa09STejun Heo  *
59373347fa09STejun Heo  * This is the latter half of two-staged workqueue subsystem initialization
59383347fa09STejun Heo  * and invoked as soon as kthreads can be created and scheduled.
59393347fa09STejun Heo  * Workqueues have been created and work items queued on them, but there
59403347fa09STejun Heo  * are no kworkers executing the work items yet.  Populate the worker pools
59413347fa09STejun Heo  * with the initial workers and enable future kworker creations.
59423347fa09STejun Heo  */
59433347fa09STejun Heo int __init workqueue_init(void)
59443347fa09STejun Heo {
59452186d9f9STejun Heo 	struct workqueue_struct *wq;
59463347fa09STejun Heo 	struct worker_pool *pool;
59473347fa09STejun Heo 	int cpu, bkt;
59483347fa09STejun Heo 
59492186d9f9STejun Heo 	/*
59502186d9f9STejun Heo 	 * It'd be simpler to initialize NUMA in workqueue_init_early() but
59512186d9f9STejun Heo 	 * CPU to node mapping may not be available that early on some
59522186d9f9STejun Heo 	 * archs such as power and arm64.  As per-cpu pools created
59532186d9f9STejun Heo 	 * previously could be missing node hint and unbound pools NUMA
59542186d9f9STejun Heo 	 * affinity, fix them up.
595540c17f75STejun Heo 	 *
595640c17f75STejun Heo 	 * Also, while iterating workqueues, create rescuers if requested.
59572186d9f9STejun Heo 	 */
59582186d9f9STejun Heo 	wq_numa_init();
59592186d9f9STejun Heo 
59602186d9f9STejun Heo 	mutex_lock(&wq_pool_mutex);
59612186d9f9STejun Heo 
59622186d9f9STejun Heo 	for_each_possible_cpu(cpu) {
59632186d9f9STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
59642186d9f9STejun Heo 			pool->node = cpu_to_node(cpu);
59652186d9f9STejun Heo 		}
59662186d9f9STejun Heo 	}
59672186d9f9STejun Heo 
596840c17f75STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
59692186d9f9STejun Heo 		wq_update_unbound_numa(wq, smp_processor_id(), true);
597040c17f75STejun Heo 		WARN(init_rescuer(wq),
597140c17f75STejun Heo 		     "workqueue: failed to create early rescuer for %s",
597240c17f75STejun Heo 		     wq->name);
597340c17f75STejun Heo 	}
59742186d9f9STejun Heo 
59752186d9f9STejun Heo 	mutex_unlock(&wq_pool_mutex);
59762186d9f9STejun Heo 
59773347fa09STejun Heo 	/* create the initial workers */
59783347fa09STejun Heo 	for_each_online_cpu(cpu) {
59793347fa09STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
59803347fa09STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
59813347fa09STejun Heo 			BUG_ON(!create_worker(pool));
59823347fa09STejun Heo 		}
59833347fa09STejun Heo 	}
59843347fa09STejun Heo 
59853347fa09STejun Heo 	hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
59863347fa09STejun Heo 		BUG_ON(!create_worker(pool));
59873347fa09STejun Heo 
59883347fa09STejun Heo 	wq_online = true;
598982607adcSTejun Heo 	wq_watchdog_init();
599082607adcSTejun Heo 
59916ee0578bSSuresh Siddha 	return 0;
59921da177e4SLinus Torvalds }
5993