xref: /linux-6.15/kernel/workqueue.c (revision 8639eceb)
1457c8996SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
21da177e4SLinus Torvalds /*
3c54fce6eSTejun Heo  * kernel/workqueue.c - generic async execution with shared worker pool
41da177e4SLinus Torvalds  *
5c54fce6eSTejun Heo  * Copyright (C) 2002		Ingo Molnar
61da177e4SLinus Torvalds  *
71da177e4SLinus Torvalds  *   Derived from the taskqueue/keventd code by:
81da177e4SLinus Torvalds  *     David Woodhouse <[email protected]>
9e1f8e874SFrancois Cami  *     Andrew Morton
101da177e4SLinus Torvalds  *     Kai Petzke <[email protected]>
111da177e4SLinus Torvalds  *     Theodore Ts'o <[email protected]>
1289ada679SChristoph Lameter  *
13cde53535SChristoph Lameter  * Made to use alloc_percpu by Christoph Lameter.
14c54fce6eSTejun Heo  *
15c54fce6eSTejun Heo  * Copyright (C) 2010		SUSE Linux Products GmbH
16c54fce6eSTejun Heo  * Copyright (C) 2010		Tejun Heo <[email protected]>
17c54fce6eSTejun Heo  *
18c54fce6eSTejun Heo  * This is the generic async execution mechanism.  Work items as are
19c54fce6eSTejun Heo  * executed in process context.  The worker pool is shared and
20b11895c4SLibin  * automatically managed.  There are two worker pools for each CPU (one for
21b11895c4SLibin  * normal work items and the other for high priority ones) and some extra
22b11895c4SLibin  * pools for workqueues which are not bound to any specific CPU - the
23b11895c4SLibin  * number of these backing pools is dynamic.
24c54fce6eSTejun Heo  *
259a261491SBenjamin Peterson  * Please read Documentation/core-api/workqueue.rst for details.
261da177e4SLinus Torvalds  */
271da177e4SLinus Torvalds 
289984de1aSPaul Gortmaker #include <linux/export.h>
291da177e4SLinus Torvalds #include <linux/kernel.h>
301da177e4SLinus Torvalds #include <linux/sched.h>
311da177e4SLinus Torvalds #include <linux/init.h>
321da177e4SLinus Torvalds #include <linux/signal.h>
331da177e4SLinus Torvalds #include <linux/completion.h>
341da177e4SLinus Torvalds #include <linux/workqueue.h>
351da177e4SLinus Torvalds #include <linux/slab.h>
361da177e4SLinus Torvalds #include <linux/cpu.h>
371da177e4SLinus Torvalds #include <linux/notifier.h>
381da177e4SLinus Torvalds #include <linux/kthread.h>
391fa44ecaSJames Bottomley #include <linux/hardirq.h>
4046934023SChristoph Lameter #include <linux/mempolicy.h>
41341a5958SRafael J. Wysocki #include <linux/freezer.h>
42d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
434e6045f1SJohannes Berg #include <linux/lockdep.h>
44c34056a3STejun Heo #include <linux/idr.h>
4529c91e99STejun Heo #include <linux/jhash.h>
4642f8570fSSasha Levin #include <linux/hashtable.h>
4776af4d93STejun Heo #include <linux/rculist.h>
48bce90380STejun Heo #include <linux/nodemask.h>
494c16bd32STejun Heo #include <linux/moduleparam.h>
503d1cb205STejun Heo #include <linux/uaccess.h>
51c98a9805STal Shorer #include <linux/sched/isolation.h>
52cd2440d6SPetr Mladek #include <linux/sched/debug.h>
5362635ea8SSergey Senozhatsky #include <linux/nmi.h>
54940d71c6SSergey Senozhatsky #include <linux/kvm_para.h>
55aa6fde93STejun Heo #include <linux/delay.h>
56e22bee78STejun Heo 
57ea138446STejun Heo #include "workqueue_internal.h"
581da177e4SLinus Torvalds 
59c8e55f36STejun Heo enum {
60bc2ae0f5STejun Heo 	/*
6124647570STejun Heo 	 * worker_pool flags
62bc2ae0f5STejun Heo 	 *
6324647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
64bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
65bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
66bc2ae0f5STejun Heo 	 * is in effect.
67bc2ae0f5STejun Heo 	 *
68bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
69bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
7024647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
71bc2ae0f5STejun Heo 	 *
72bc3a1afcSTejun Heo 	 * Note that DISASSOCIATED should be flipped only while holding
731258fae7STejun Heo 	 * wq_pool_attach_mutex to avoid changing binding state while
744736cbf7SLai Jiangshan 	 * worker_attach_to_pool() is in progress.
75bc2ae0f5STejun Heo 	 */
76692b4825STejun Heo 	POOL_MANAGER_ACTIVE	= 1 << 0,	/* being managed */
7724647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
78db7bccf4STejun Heo 
79c8e55f36STejun Heo 	/* worker flags */
80c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
81c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
82e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
83fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
84f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
85a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
86e22bee78STejun Heo 
87a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
88a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
89db7bccf4STejun Heo 
90e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
914ce62e9eSTejun Heo 
9229c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
93c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
94db7bccf4STejun Heo 
95e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
96e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
97e22bee78STejun Heo 
983233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
993233cdbdSTejun Heo 						/* call for help after 10ms
1003233cdbdSTejun Heo 						   (min two ticks) */
101e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
102e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
1031da177e4SLinus Torvalds 
1041da177e4SLinus Torvalds 	/*
105e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
1068698a745SDongsheng Yang 	 * all cpus.  Give MIN_NICE.
107e22bee78STejun Heo 	 */
1088698a745SDongsheng Yang 	RESCUER_NICE_LEVEL	= MIN_NICE,
1098698a745SDongsheng Yang 	HIGHPRI_NICE_LEVEL	= MIN_NICE,
110ecf6881fSTejun Heo 
111ecf6881fSTejun Heo 	WQ_NAME_LEN		= 24,
112c8e55f36STejun Heo };
113c8e55f36STejun Heo 
1141da177e4SLinus Torvalds /*
1154690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1164690c4abSTejun Heo  *
117e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
118e41e704bSTejun Heo  *    everyone else.
1194690c4abSTejun Heo  *
120e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
121e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
122e22bee78STejun Heo  *
123d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1244690c4abSTejun Heo  *
125bdf8b9bfSTejun Heo  * K: Only modified by worker while holding pool->lock. Can be safely read by
126bdf8b9bfSTejun Heo  *    self, while holding pool->lock or from IRQ context if %current is the
127bdf8b9bfSTejun Heo  *    kworker.
128bdf8b9bfSTejun Heo  *
129bdf8b9bfSTejun Heo  * S: Only modified by worker self.
130bdf8b9bfSTejun Heo  *
1311258fae7STejun Heo  * A: wq_pool_attach_mutex protected.
132822d8405STejun Heo  *
13368e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
13476af4d93STejun Heo  *
13524acfb71SThomas Gleixner  * PR: wq_pool_mutex protected for writes.  RCU protected for reads.
1365bcab335STejun Heo  *
1375b95e1afSLai Jiangshan  * PW: wq_pool_mutex and wq->mutex protected for writes.  Either for reads.
1385b95e1afSLai Jiangshan  *
1395b95e1afSLai Jiangshan  * PWR: wq_pool_mutex and wq->mutex protected for writes.  Either or
14024acfb71SThomas Gleixner  *      RCU for reads.
1415b95e1afSLai Jiangshan  *
1423c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1433c25a55dSLai Jiangshan  *
14424acfb71SThomas Gleixner  * WR: wq->mutex protected for writes.  RCU protected for reads.
1452e109a28STejun Heo  *
1462e109a28STejun Heo  * MD: wq_mayday_lock protected.
147cd2440d6SPetr Mladek  *
148cd2440d6SPetr Mladek  * WD: Used internally by the watchdog.
1494690c4abSTejun Heo  */
1504690c4abSTejun Heo 
1512eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
152c34056a3STejun Heo 
153bd7bdd43STejun Heo struct worker_pool {
154a9b8a985SSebastian Andrzej Siewior 	raw_spinlock_t		lock;		/* the pool lock */
155d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
156f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1579daf9e67STejun Heo 	int			id;		/* I: pool ID */
158bc8b50c2STejun Heo 	unsigned int		flags;		/* L: flags */
159bd7bdd43STejun Heo 
16082607adcSTejun Heo 	unsigned long		watchdog_ts;	/* L: watchdog timestamp */
161cd2440d6SPetr Mladek 	bool			cpu_stall;	/* WD: stalled cpu bound pool */
16282607adcSTejun Heo 
163bc35f7efSLai Jiangshan 	/*
164bc35f7efSLai Jiangshan 	 * The counter is incremented in a process context on the associated CPU
165bc35f7efSLai Jiangshan 	 * w/ preemption disabled, and decremented or reset in the same context
166bc35f7efSLai Jiangshan 	 * but w/ pool->lock held. The readers grab pool->lock and are
167bc35f7efSLai Jiangshan 	 * guaranteed to see if the counter reached zero.
168bc35f7efSLai Jiangshan 	 */
169bc35f7efSLai Jiangshan 	int			nr_running;
17084f91c62SLai Jiangshan 
171bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
172ea1abd61SLai Jiangshan 
1735826cc8fSLai Jiangshan 	int			nr_workers;	/* L: total number of workers */
1745826cc8fSLai Jiangshan 	int			nr_idle;	/* L: currently idle workers */
175bd7bdd43STejun Heo 
1762c1f1a91SLai Jiangshan 	struct list_head	idle_list;	/* L: list of idle workers */
177bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
1783f959aa3SValentin Schneider 	struct work_struct      idle_cull_work; /* L: worker idle cleanup */
1793f959aa3SValentin Schneider 
180bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	  /* L: SOS timer for workers */
181bd7bdd43STejun Heo 
182c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
183c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
184c9e7cf27STejun Heo 						/* L: hash of busy workers */
185c9e7cf27STejun Heo 
1862607d7a6STejun Heo 	struct worker		*manager;	/* L: purely informational */
18792f9c5c4SLai Jiangshan 	struct list_head	workers;	/* A: attached workers */
188e02b9312SValentin Schneider 	struct list_head        dying_workers;  /* A: workers about to die */
18960f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
190e19e397aSTejun Heo 
1917cda9aaeSLai Jiangshan 	struct ida		worker_ida;	/* worker IDs for task name */
192e19e397aSTejun Heo 
1937a4e344cSTejun Heo 	struct workqueue_attrs	*attrs;		/* I: worker attributes */
19468e13a67SLai Jiangshan 	struct hlist_node	hash_node;	/* PL: unbound_pool_hash node */
19568e13a67SLai Jiangshan 	int			refcnt;		/* PL: refcnt for unbound pools */
1967a4e344cSTejun Heo 
197e19e397aSTejun Heo 	/*
19824acfb71SThomas Gleixner 	 * Destruction of pool is RCU protected to allow dereferences
19929c91e99STejun Heo 	 * from get_work_pool().
20029c91e99STejun Heo 	 */
20129c91e99STejun Heo 	struct rcu_head		rcu;
20284f91c62SLai Jiangshan };
2038b03ae3cSTejun Heo 
2048b03ae3cSTejun Heo /*
205725e8ec5STejun Heo  * Per-pool_workqueue statistics. These can be monitored using
206725e8ec5STejun Heo  * tools/workqueue/wq_monitor.py.
207725e8ec5STejun Heo  */
208725e8ec5STejun Heo enum pool_workqueue_stats {
209725e8ec5STejun Heo 	PWQ_STAT_STARTED,	/* work items started execution */
210725e8ec5STejun Heo 	PWQ_STAT_COMPLETED,	/* work items completed execution */
2118a1dd1e5STejun Heo 	PWQ_STAT_CPU_TIME,	/* total CPU time consumed */
212616db877STejun Heo 	PWQ_STAT_CPU_INTENSIVE,	/* wq_cpu_intensive_thresh_us violations */
213725e8ec5STejun Heo 	PWQ_STAT_CM_WAKEUP,	/* concurrency-management worker wakeups */
214*8639ecebSTejun Heo 	PWQ_STAT_REPATRIATED,	/* unbound workers brought back into scope */
215725e8ec5STejun Heo 	PWQ_STAT_MAYDAY,	/* maydays to rescuer */
216725e8ec5STejun Heo 	PWQ_STAT_RESCUED,	/* linked work items executed by rescuer */
217725e8ec5STejun Heo 
218725e8ec5STejun Heo 	PWQ_NR_STATS,
219725e8ec5STejun Heo };
220725e8ec5STejun Heo 
221725e8ec5STejun Heo /*
222112202d9STejun Heo  * The per-pool workqueue.  While queued, the lower WORK_STRUCT_FLAG_BITS
223112202d9STejun Heo  * of work_struct->data are used for flags and the remaining high bits
224112202d9STejun Heo  * point to the pwq; thus, pwqs need to be aligned at two's power of the
225112202d9STejun Heo  * number of flag bits.
2261da177e4SLinus Torvalds  */
227112202d9STejun Heo struct pool_workqueue {
228bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
2294690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
23073f53c4aSTejun Heo 	int			work_color;	/* L: current color */
23173f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
2328864b4e5STejun Heo 	int			refcnt;		/* L: reference count */
23373f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
23473f53c4aSTejun Heo 						/* L: nr of in_flight works */
235018f3a13SLai Jiangshan 
236018f3a13SLai Jiangshan 	/*
237018f3a13SLai Jiangshan 	 * nr_active management and WORK_STRUCT_INACTIVE:
238018f3a13SLai Jiangshan 	 *
239018f3a13SLai Jiangshan 	 * When pwq->nr_active >= max_active, new work item is queued to
240018f3a13SLai Jiangshan 	 * pwq->inactive_works instead of pool->worklist and marked with
241018f3a13SLai Jiangshan 	 * WORK_STRUCT_INACTIVE.
242018f3a13SLai Jiangshan 	 *
243018f3a13SLai Jiangshan 	 * All work items marked with WORK_STRUCT_INACTIVE do not participate
244018f3a13SLai Jiangshan 	 * in pwq->nr_active and all work items in pwq->inactive_works are
245018f3a13SLai Jiangshan 	 * marked with WORK_STRUCT_INACTIVE.  But not all WORK_STRUCT_INACTIVE
246018f3a13SLai Jiangshan 	 * work items are in pwq->inactive_works.  Some of them are ready to
247018f3a13SLai Jiangshan 	 * run in pool->worklist or worker->scheduled.  Those work itmes are
248018f3a13SLai Jiangshan 	 * only struct wq_barrier which is used for flush_work() and should
249018f3a13SLai Jiangshan 	 * not participate in pwq->nr_active.  For non-barrier work item, it
250018f3a13SLai Jiangshan 	 * is marked with WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works.
251018f3a13SLai Jiangshan 	 */
2521e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
253a0a1a5fdSTejun Heo 	int			max_active;	/* L: max active works */
254f97a4a1aSLai Jiangshan 	struct list_head	inactive_works;	/* L: inactive works */
2553c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2562e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2578864b4e5STejun Heo 
258725e8ec5STejun Heo 	u64			stats[PWQ_NR_STATS];
259725e8ec5STejun Heo 
2608864b4e5STejun Heo 	/*
261967b494eSTejun Heo 	 * Release of unbound pwq is punted to a kthread_worker. See put_pwq()
262687a9aa5STejun Heo 	 * and pwq_release_workfn() for details. pool_workqueue itself is also
263687a9aa5STejun Heo 	 * RCU protected so that the first pwq can be determined without
264967b494eSTejun Heo 	 * grabbing wq->mutex.
2658864b4e5STejun Heo 	 */
266687a9aa5STejun Heo 	struct kthread_work	release_work;
2678864b4e5STejun Heo 	struct rcu_head		rcu;
268e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS);
2691da177e4SLinus Torvalds 
2701da177e4SLinus Torvalds /*
27173f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
27273f53c4aSTejun Heo  */
27373f53c4aSTejun Heo struct wq_flusher {
2743c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
2753c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
27673f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
27773f53c4aSTejun Heo };
2781da177e4SLinus Torvalds 
279226223abSTejun Heo struct wq_device;
280226223abSTejun Heo 
28173f53c4aSTejun Heo /*
282c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
283c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
2841da177e4SLinus Torvalds  */
2851da177e4SLinus Torvalds struct workqueue_struct {
2863c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
287e2dca7adSTejun Heo 	struct list_head	list;		/* PR: list of all workqueues */
28873f53c4aSTejun Heo 
2893c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
2903c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
2913c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
292112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
2933c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
2943c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
2953c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
29673f53c4aSTejun Heo 
2972e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
29830ae2fc0STejun Heo 	struct worker		*rescuer;	/* MD: rescue worker */
299e22bee78STejun Heo 
30087fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
301a357fc03SLai Jiangshan 	int			saved_max_active; /* WQ: saved pwq max_active */
302226223abSTejun Heo 
3035b95e1afSLai Jiangshan 	struct workqueue_attrs	*unbound_attrs;	/* PW: only for unbound wqs */
3045b95e1afSLai Jiangshan 	struct pool_workqueue	*dfl_pwq;	/* PW: only for unbound wqs */
3056029a918STejun Heo 
306226223abSTejun Heo #ifdef CONFIG_SYSFS
307226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
308226223abSTejun Heo #endif
3094e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
310669de8bdSBart Van Assche 	char			*lock_name;
311669de8bdSBart Van Assche 	struct lock_class_key	key;
3124e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
3134e6045f1SJohannes Berg #endif
314ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
3152728fd2fSTejun Heo 
316e2dca7adSTejun Heo 	/*
31724acfb71SThomas Gleixner 	 * Destruction of workqueue_struct is RCU protected to allow walking
31824acfb71SThomas Gleixner 	 * the workqueues list without grabbing wq_pool_mutex.
319e2dca7adSTejun Heo 	 * This is used to dump all workqueues from sysrq.
320e2dca7adSTejun Heo 	 */
321e2dca7adSTejun Heo 	struct rcu_head		rcu;
322e2dca7adSTejun Heo 
3232728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
3242728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
325636b927eSTejun Heo 	struct pool_workqueue __percpu __rcu **cpu_pwq; /* I: per-cpu pwqs */
3261da177e4SLinus Torvalds };
3271da177e4SLinus Torvalds 
328e904e6c2STejun Heo static struct kmem_cache *pwq_cache;
329e904e6c2STejun Heo 
33084193c07STejun Heo /*
33184193c07STejun Heo  * Each pod type describes how CPUs should be grouped for unbound workqueues.
33284193c07STejun Heo  * See the comment above workqueue_attrs->affn_scope.
33384193c07STejun Heo  */
33484193c07STejun Heo struct wq_pod_type {
33584193c07STejun Heo 	int			nr_pods;	/* number of pods */
33684193c07STejun Heo 	cpumask_var_t		*pod_cpus;	/* pod -> cpus */
33784193c07STejun Heo 	int			*pod_node;	/* pod -> node */
33884193c07STejun Heo 	int			*cpu_pod;	/* cpu -> pod */
33984193c07STejun Heo };
34084193c07STejun Heo 
34184193c07STejun Heo static struct wq_pod_type wq_pod_types[WQ_AFFN_NR_TYPES];
34263c5484eSTejun Heo static enum wq_affn_scope wq_affn_dfl = WQ_AFFN_DFL;
34363c5484eSTejun Heo 
34463c5484eSTejun Heo static const char *wq_affn_names[WQ_AFFN_NR_TYPES] = {
34563c5484eSTejun Heo 	[WQ_AFFN_CPU]			= "cpu",
34663c5484eSTejun Heo 	[WQ_AFFN_SMT]			= "smt",
34763c5484eSTejun Heo 	[WQ_AFFN_CACHE]			= "cache",
34863c5484eSTejun Heo 	[WQ_AFFN_NUMA]			= "numa",
34963c5484eSTejun Heo 	[WQ_AFFN_SYSTEM]		= "system",
35063c5484eSTejun Heo };
351bce90380STejun Heo 
352616db877STejun Heo /*
353616db877STejun Heo  * Per-cpu work items which run for longer than the following threshold are
354616db877STejun Heo  * automatically considered CPU intensive and excluded from concurrency
355616db877STejun Heo  * management to prevent them from noticeably delaying other per-cpu work items.
356aa6fde93STejun Heo  * ULONG_MAX indicates that the user hasn't overridden it with a boot parameter.
357aa6fde93STejun Heo  * The actual value is initialized in wq_cpu_intensive_thresh_init().
358616db877STejun Heo  */
359aa6fde93STejun Heo static unsigned long wq_cpu_intensive_thresh_us = ULONG_MAX;
360616db877STejun Heo module_param_named(cpu_intensive_thresh_us, wq_cpu_intensive_thresh_us, ulong, 0644);
361616db877STejun Heo 
362cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
363552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
364cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
365cee22a15SViresh Kumar 
366863b710bSTejun Heo static bool wq_online;			/* can kworkers be created yet? */
3673347fa09STejun Heo 
368fef59c9cSTejun Heo /* buf for wq_update_unbound_pod_attrs(), protected by CPU hotplug exclusion */
369fef59c9cSTejun Heo static struct workqueue_attrs *wq_update_pod_attrs_buf;
3704c16bd32STejun Heo 
37168e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
3721258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
373a9b8a985SSebastian Andrzej Siewior static DEFINE_RAW_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
374d8bb65abSSebastian Andrzej Siewior /* wait for manager to go away */
375d8bb65abSSebastian Andrzej Siewior static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
3765bcab335STejun Heo 
377e2dca7adSTejun Heo static LIST_HEAD(workqueues);		/* PR: list of all workqueues */
37868e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
3797d19c5ceSTejun Heo 
38099c621efSLai Jiangshan /* PL&A: allowable cpus for unbound wqs and work items */
381ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask;
382ef557180SMike Galbraith 
383ace3c549Stiozhang /* for further constrain wq_unbound_cpumask by cmdline parameter*/
384ace3c549Stiozhang static struct cpumask wq_cmdline_cpumask __initdata;
385ace3c549Stiozhang 
386ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */
387ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last);
388b05a7928SFrederic Weisbecker 
389f303fccbSTejun Heo /*
390f303fccbSTejun Heo  * Local execution of unbound work items is no longer guaranteed.  The
391f303fccbSTejun Heo  * following always forces round-robin CPU selection on unbound work items
392f303fccbSTejun Heo  * to uncover usages which depend on it.
393f303fccbSTejun Heo  */
394f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
395f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true;
396f303fccbSTejun Heo #else
397f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false;
398f303fccbSTejun Heo #endif
399f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
400f303fccbSTejun Heo 
4017d19c5ceSTejun Heo /* the per-cpu worker pools */
40225528213SPeter Zijlstra static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
4037d19c5ceSTejun Heo 
40468e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
4057d19c5ceSTejun Heo 
40668e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
40729c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
40829c91e99STejun Heo 
409c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
41029c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
41129c91e99STejun Heo 
4128a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
4138a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
4148a2b7538STejun Heo 
415967b494eSTejun Heo /*
416967b494eSTejun Heo  * I: kthread_worker to release pwq's. pwq release needs to be bounced to a
417967b494eSTejun Heo  * process context while holding a pool lock. Bounce to a dedicated kthread
418967b494eSTejun Heo  * worker to avoid A-A deadlocks.
419967b494eSTejun Heo  */
420967b494eSTejun Heo static struct kthread_worker *pwq_release_worker;
421967b494eSTejun Heo 
422d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly;
423ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
424044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly;
4251aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
426044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly;
427d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
428044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly;
429f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
430044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly;
43124d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
4320668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly;
4330668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
4340668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
4350668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
436d320c038STejun Heo 
4377d19c5ceSTejun Heo static int worker_thread(void *__worker);
4386ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
439c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq);
44055df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool);
4417d19c5ceSTejun Heo 
44297bd2347STejun Heo #define CREATE_TRACE_POINTS
44397bd2347STejun Heo #include <trace/events/workqueue.h>
44497bd2347STejun Heo 
44568e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
44624acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
447f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
44824acfb71SThomas Gleixner 			 "RCU or wq_pool_mutex should be held")
4495bcab335STejun Heo 
4505b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)			\
45124acfb71SThomas Gleixner 	RCU_LOCKDEP_WARN(!rcu_read_lock_held() &&			\
452f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex) &&		\
453f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
45424acfb71SThomas Gleixner 			 "RCU, wq->mutex or wq_pool_mutex should be held")
4555b95e1afSLai Jiangshan 
456f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
457f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
458f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
4597a62c2c8STejun Heo 	     (pool)++)
4604ce62e9eSTejun Heo 
46149e3cf44STejun Heo /**
46217116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
46317116969STejun Heo  * @pool: iteration cursor
464611c92a0STejun Heo  * @pi: integer used for iteration
465fa1b54e6STejun Heo  *
46624acfb71SThomas Gleixner  * This must be called either with wq_pool_mutex held or RCU read
46768e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
46868e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
469fa1b54e6STejun Heo  *
470fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
471fa1b54e6STejun Heo  * ignored.
47217116969STejun Heo  */
473611c92a0STejun Heo #define for_each_pool(pool, pi)						\
474611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
47568e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
476fa1b54e6STejun Heo 		else
47717116969STejun Heo 
47817116969STejun Heo /**
479822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
480822d8405STejun Heo  * @worker: iteration cursor
481822d8405STejun Heo  * @pool: worker_pool to iterate workers of
482822d8405STejun Heo  *
4831258fae7STejun Heo  * This must be called with wq_pool_attach_mutex.
484822d8405STejun Heo  *
485822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
486822d8405STejun Heo  * ignored.
487822d8405STejun Heo  */
488da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
489da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
4901258fae7STejun Heo 		if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
491822d8405STejun Heo 		else
492822d8405STejun Heo 
493822d8405STejun Heo /**
49449e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
49549e3cf44STejun Heo  * @pwq: iteration cursor
49649e3cf44STejun Heo  * @wq: the target workqueue
49776af4d93STejun Heo  *
49824acfb71SThomas Gleixner  * This must be called either with wq->mutex held or RCU read locked.
499794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
500794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
50176af4d93STejun Heo  *
50276af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
50376af4d93STejun Heo  * ignored.
50449e3cf44STejun Heo  */
50549e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
50649e9d1a9SSebastian Andrzej Siewior 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node,		\
5075a644662SJoel Fernandes (Google) 				 lockdep_is_held(&(wq->mutex)))
508f3421797STejun Heo 
509dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
510dc186ad7SThomas Gleixner 
511f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr;
512dc186ad7SThomas Gleixner 
51399777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
51499777288SStanislaw Gruszka {
51599777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
51699777288SStanislaw Gruszka }
51799777288SStanislaw Gruszka 
518b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr)
519b9fdac7fSDu, Changbin {
520b9fdac7fSDu, Changbin 	struct work_struct *work = addr;
521b9fdac7fSDu, Changbin 
522b9fdac7fSDu, Changbin 	return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
523b9fdac7fSDu, Changbin }
524b9fdac7fSDu, Changbin 
525dc186ad7SThomas Gleixner /*
526dc186ad7SThomas Gleixner  * fixup_init is called when:
527dc186ad7SThomas Gleixner  * - an active object is initialized
528dc186ad7SThomas Gleixner  */
52902a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state)
530dc186ad7SThomas Gleixner {
531dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
532dc186ad7SThomas Gleixner 
533dc186ad7SThomas Gleixner 	switch (state) {
534dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
535dc186ad7SThomas Gleixner 		cancel_work_sync(work);
536dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
53702a982a6SDu, Changbin 		return true;
538dc186ad7SThomas Gleixner 	default:
53902a982a6SDu, Changbin 		return false;
540dc186ad7SThomas Gleixner 	}
541dc186ad7SThomas Gleixner }
542dc186ad7SThomas Gleixner 
543dc186ad7SThomas Gleixner /*
544dc186ad7SThomas Gleixner  * fixup_free is called when:
545dc186ad7SThomas Gleixner  * - an active object is freed
546dc186ad7SThomas Gleixner  */
54702a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state)
548dc186ad7SThomas Gleixner {
549dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
550dc186ad7SThomas Gleixner 
551dc186ad7SThomas Gleixner 	switch (state) {
552dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
553dc186ad7SThomas Gleixner 		cancel_work_sync(work);
554dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
55502a982a6SDu, Changbin 		return true;
556dc186ad7SThomas Gleixner 	default:
55702a982a6SDu, Changbin 		return false;
558dc186ad7SThomas Gleixner 	}
559dc186ad7SThomas Gleixner }
560dc186ad7SThomas Gleixner 
561f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = {
562dc186ad7SThomas Gleixner 	.name		= "work_struct",
56399777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
564b9fdac7fSDu, Changbin 	.is_static_object = work_is_static_object,
565dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
566dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
567dc186ad7SThomas Gleixner };
568dc186ad7SThomas Gleixner 
569dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
570dc186ad7SThomas Gleixner {
571dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
572dc186ad7SThomas Gleixner }
573dc186ad7SThomas Gleixner 
574dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
575dc186ad7SThomas Gleixner {
576dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
577dc186ad7SThomas Gleixner }
578dc186ad7SThomas Gleixner 
579dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
580dc186ad7SThomas Gleixner {
581dc186ad7SThomas Gleixner 	if (onstack)
582dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
583dc186ad7SThomas Gleixner 	else
584dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
585dc186ad7SThomas Gleixner }
586dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
587dc186ad7SThomas Gleixner 
588dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
589dc186ad7SThomas Gleixner {
590dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
591dc186ad7SThomas Gleixner }
592dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
593dc186ad7SThomas Gleixner 
594ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
595ea2e64f2SThomas Gleixner {
596ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
597ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
598ea2e64f2SThomas Gleixner }
599ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
600ea2e64f2SThomas Gleixner 
601dc186ad7SThomas Gleixner #else
602dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
603dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
604dc186ad7SThomas Gleixner #endif
605dc186ad7SThomas Gleixner 
6064e8b22bdSLi Bin /**
60767dc8325SCai Huoqing  * worker_pool_assign_id - allocate ID and assign it to @pool
6084e8b22bdSLi Bin  * @pool: the pool pointer of interest
6094e8b22bdSLi Bin  *
6104e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
6114e8b22bdSLi Bin  * successfully, -errno on failure.
6124e8b22bdSLi Bin  */
6139daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
6149daf9e67STejun Heo {
6159daf9e67STejun Heo 	int ret;
6169daf9e67STejun Heo 
61768e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6185bcab335STejun Heo 
6194e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
6204e8b22bdSLi Bin 			GFP_KERNEL);
621229641a6STejun Heo 	if (ret >= 0) {
622e68035fbSTejun Heo 		pool->id = ret;
623229641a6STejun Heo 		return 0;
624229641a6STejun Heo 	}
6259daf9e67STejun Heo 	return ret;
6269daf9e67STejun Heo }
6279daf9e67STejun Heo 
62873f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
62973f53c4aSTejun Heo {
63073f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
63173f53c4aSTejun Heo }
63273f53c4aSTejun Heo 
633c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data)
63473f53c4aSTejun Heo {
635c4560c2cSLai Jiangshan 	return (work_data >> WORK_STRUCT_COLOR_SHIFT) &
63673f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
63773f53c4aSTejun Heo }
63873f53c4aSTejun Heo 
63973f53c4aSTejun Heo static int work_next_color(int color)
64073f53c4aSTejun Heo {
64173f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
642a848e3b6SOleg Nesterov }
643a848e3b6SOleg Nesterov 
6444594bf15SDavid Howells /*
645112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
646112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
6477c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
6487a22ad75STejun Heo  *
649112202d9STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
650112202d9STejun Heo  * and clear_work_data() can be used to set the pwq, pool or clear
651bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
652bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
6537a22ad75STejun Heo  *
654112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
6557c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
656112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
6577c3eed5cSTejun Heo  * available only while the work item is queued.
658bbb68dfaSTejun Heo  *
659bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
660bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
661bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
662bbb68dfaSTejun Heo  * try to steal the PENDING bit.
6634594bf15SDavid Howells  */
6647a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
6657a22ad75STejun Heo 				 unsigned long flags)
6667a22ad75STejun Heo {
6676183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
6687a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
6697a22ad75STejun Heo }
6707a22ad75STejun Heo 
671112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
6724690c4abSTejun Heo 			 unsigned long extra_flags)
673365970a1SDavid Howells {
674112202d9STejun Heo 	set_work_data(work, (unsigned long)pwq,
675112202d9STejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
676365970a1SDavid Howells }
677365970a1SDavid Howells 
6784468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
6794468a00fSLai Jiangshan 					   int pool_id)
6804468a00fSLai Jiangshan {
6814468a00fSLai Jiangshan 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
6824468a00fSLai Jiangshan 		      WORK_STRUCT_PENDING);
6834468a00fSLai Jiangshan }
6844468a00fSLai Jiangshan 
6857c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
6867c3eed5cSTejun Heo 					    int pool_id)
6874d707b9fSOleg Nesterov {
68823657bb1STejun Heo 	/*
68923657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
69023657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
69123657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
69223657bb1STejun Heo 	 * owner.
69323657bb1STejun Heo 	 */
69423657bb1STejun Heo 	smp_wmb();
6957c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
696346c09f8SRoman Pen 	/*
697346c09f8SRoman Pen 	 * The following mb guarantees that previous clear of a PENDING bit
698346c09f8SRoman Pen 	 * will not be reordered with any speculative LOADS or STORES from
699346c09f8SRoman Pen 	 * work->current_func, which is executed afterwards.  This possible
7008bdc6201SLiu Song 	 * reordering can lead to a missed execution on attempt to queue
701346c09f8SRoman Pen 	 * the same @work.  E.g. consider this case:
702346c09f8SRoman Pen 	 *
703346c09f8SRoman Pen 	 *   CPU#0                         CPU#1
704346c09f8SRoman Pen 	 *   ----------------------------  --------------------------------
705346c09f8SRoman Pen 	 *
706346c09f8SRoman Pen 	 * 1  STORE event_indicated
707346c09f8SRoman Pen 	 * 2  queue_work_on() {
708346c09f8SRoman Pen 	 * 3    test_and_set_bit(PENDING)
709346c09f8SRoman Pen 	 * 4 }                             set_..._and_clear_pending() {
710346c09f8SRoman Pen 	 * 5                                 set_work_data() # clear bit
711346c09f8SRoman Pen 	 * 6                                 smp_mb()
712346c09f8SRoman Pen 	 * 7                               work->current_func() {
713346c09f8SRoman Pen 	 * 8				      LOAD event_indicated
714346c09f8SRoman Pen 	 *				   }
715346c09f8SRoman Pen 	 *
716346c09f8SRoman Pen 	 * Without an explicit full barrier speculative LOAD on line 8 can
717346c09f8SRoman Pen 	 * be executed before CPU#0 does STORE on line 1.  If that happens,
718346c09f8SRoman Pen 	 * CPU#0 observes the PENDING bit is still set and new execution of
719346c09f8SRoman Pen 	 * a @work is not queued in a hope, that CPU#1 will eventually
720346c09f8SRoman Pen 	 * finish the queued @work.  Meanwhile CPU#1 does not see
721346c09f8SRoman Pen 	 * event_indicated is set, because speculative LOAD was executed
722346c09f8SRoman Pen 	 * before actual STORE.
723346c09f8SRoman Pen 	 */
724346c09f8SRoman Pen 	smp_mb();
7254d707b9fSOleg Nesterov }
7264d707b9fSOleg Nesterov 
7277a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
728365970a1SDavid Howells {
7297c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
7307c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
7317a22ad75STejun Heo }
7327a22ad75STejun Heo 
733afa4bb77SLinus Torvalds static inline struct pool_workqueue *work_struct_pwq(unsigned long data)
734afa4bb77SLinus Torvalds {
735afa4bb77SLinus Torvalds 	return (struct pool_workqueue *)(data & WORK_STRUCT_WQ_DATA_MASK);
736afa4bb77SLinus Torvalds }
737afa4bb77SLinus Torvalds 
738112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
7397a22ad75STejun Heo {
740e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
7417a22ad75STejun Heo 
742112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
743afa4bb77SLinus Torvalds 		return work_struct_pwq(data);
744e120153dSTejun Heo 	else
745e120153dSTejun Heo 		return NULL;
7467a22ad75STejun Heo }
7477a22ad75STejun Heo 
7487c3eed5cSTejun Heo /**
7497c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
7507c3eed5cSTejun Heo  * @work: the work item of interest
7517c3eed5cSTejun Heo  *
75268e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
75324acfb71SThomas Gleixner  * access under RCU read lock.  As such, this function should be
75424acfb71SThomas Gleixner  * called under wq_pool_mutex or inside of a rcu_read_lock() region.
755fa1b54e6STejun Heo  *
756fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
757fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
758fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
759fa1b54e6STejun Heo  * returned pool is and stays online.
760d185af30SYacine Belkadi  *
761d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
7627c3eed5cSTejun Heo  */
7637c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
7647a22ad75STejun Heo {
765e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
7667c3eed5cSTejun Heo 	int pool_id;
7677a22ad75STejun Heo 
76868e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
769fa1b54e6STejun Heo 
770112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
771afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool;
7727a22ad75STejun Heo 
7737c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
7747c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
7757a22ad75STejun Heo 		return NULL;
7767a22ad75STejun Heo 
777fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
7787c3eed5cSTejun Heo }
7797c3eed5cSTejun Heo 
7807c3eed5cSTejun Heo /**
7817c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
7827c3eed5cSTejun Heo  * @work: the work item of interest
7837c3eed5cSTejun Heo  *
784d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
7857c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
7867c3eed5cSTejun Heo  */
7877c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
7887c3eed5cSTejun Heo {
78954d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
7907c3eed5cSTejun Heo 
791112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
792afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool->id;
79354d5b7d0SLai Jiangshan 
79454d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
7957c3eed5cSTejun Heo }
7967c3eed5cSTejun Heo 
797bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
798bbb68dfaSTejun Heo {
7997c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
800bbb68dfaSTejun Heo 
8017c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
8027c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
803bbb68dfaSTejun Heo }
804bbb68dfaSTejun Heo 
805bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
806bbb68dfaSTejun Heo {
807bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
808bbb68dfaSTejun Heo 
809112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
810bbb68dfaSTejun Heo }
811bbb68dfaSTejun Heo 
812e22bee78STejun Heo /*
8133270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
8143270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
815d565ed63STejun Heo  * they're being called with pool->lock held.
816e22bee78STejun Heo  */
817e22bee78STejun Heo 
818e22bee78STejun Heo /*
819e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
820e22bee78STejun Heo  * running workers.
821974271c4STejun Heo  *
822974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
823706026c2STejun Heo  * function will always return %true for unbound pools as long as the
824974271c4STejun Heo  * worklist isn't empty.
825e22bee78STejun Heo  */
82663d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
827e22bee78STejun Heo {
8280219a352STejun Heo 	return !list_empty(&pool->worklist) && !pool->nr_running;
829e22bee78STejun Heo }
830e22bee78STejun Heo 
831e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
83263d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
833e22bee78STejun Heo {
83463d95a91STejun Heo 	return pool->nr_idle;
835e22bee78STejun Heo }
836e22bee78STejun Heo 
837e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
83863d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
839e22bee78STejun Heo {
840bc35f7efSLai Jiangshan 	return !list_empty(&pool->worklist) && (pool->nr_running <= 1);
841e22bee78STejun Heo }
842e22bee78STejun Heo 
843e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
84463d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
845e22bee78STejun Heo {
84663d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
847e22bee78STejun Heo }
848e22bee78STejun Heo 
849e22bee78STejun Heo /* Do we have too many workers and should some go away? */
85063d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
851e22bee78STejun Heo {
852692b4825STejun Heo 	bool managing = pool->flags & POOL_MANAGER_ACTIVE;
85363d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
85463d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
855e22bee78STejun Heo 
856e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
857e22bee78STejun Heo }
858e22bee78STejun Heo 
8594690c4abSTejun Heo /**
860e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
861cb444766STejun Heo  * @worker: self
862d302f017STejun Heo  * @flags: flags to set
863d302f017STejun Heo  *
864228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
865d302f017STejun Heo  */
866228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
867d302f017STejun Heo {
868bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
869e22bee78STejun Heo 
870bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
871cb444766STejun Heo 
872228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
873e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
874e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
875bc35f7efSLai Jiangshan 		pool->nr_running--;
876e22bee78STejun Heo 	}
877e22bee78STejun Heo 
878d302f017STejun Heo 	worker->flags |= flags;
879d302f017STejun Heo }
880d302f017STejun Heo 
881d302f017STejun Heo /**
882e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
883cb444766STejun Heo  * @worker: self
884d302f017STejun Heo  * @flags: flags to clear
885d302f017STejun Heo  *
886e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
887d302f017STejun Heo  */
888d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
889d302f017STejun Heo {
89063d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
891e22bee78STejun Heo 	unsigned int oflags = worker->flags;
892e22bee78STejun Heo 
893bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
894cb444766STejun Heo 
895d302f017STejun Heo 	worker->flags &= ~flags;
896e22bee78STejun Heo 
89742c025f3STejun Heo 	/*
89842c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
89942c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
90042c025f3STejun Heo 	 * of multiple flags, not a single flag.
90142c025f3STejun Heo 	 */
902e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
903e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
904bc35f7efSLai Jiangshan 			pool->nr_running++;
905d302f017STejun Heo }
906d302f017STejun Heo 
907797e8345STejun Heo /* Return the first idle worker.  Called with pool->lock held. */
908797e8345STejun Heo static struct worker *first_idle_worker(struct worker_pool *pool)
909797e8345STejun Heo {
910797e8345STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
911797e8345STejun Heo 		return NULL;
912797e8345STejun Heo 
913797e8345STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
914797e8345STejun Heo }
915797e8345STejun Heo 
916797e8345STejun Heo /**
917797e8345STejun Heo  * worker_enter_idle - enter idle state
918797e8345STejun Heo  * @worker: worker which is entering idle state
919797e8345STejun Heo  *
920797e8345STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
921797e8345STejun Heo  * necessary.
922797e8345STejun Heo  *
923797e8345STejun Heo  * LOCKING:
924797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
925797e8345STejun Heo  */
926797e8345STejun Heo static void worker_enter_idle(struct worker *worker)
927797e8345STejun Heo {
928797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
929797e8345STejun Heo 
930797e8345STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
931797e8345STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
932797e8345STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
933797e8345STejun Heo 		return;
934797e8345STejun Heo 
935797e8345STejun Heo 	/* can't use worker_set_flags(), also called from create_worker() */
936797e8345STejun Heo 	worker->flags |= WORKER_IDLE;
937797e8345STejun Heo 	pool->nr_idle++;
938797e8345STejun Heo 	worker->last_active = jiffies;
939797e8345STejun Heo 
940797e8345STejun Heo 	/* idle_list is LIFO */
941797e8345STejun Heo 	list_add(&worker->entry, &pool->idle_list);
942797e8345STejun Heo 
943797e8345STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
944797e8345STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
945797e8345STejun Heo 
946797e8345STejun Heo 	/* Sanity check nr_running. */
947797e8345STejun Heo 	WARN_ON_ONCE(pool->nr_workers == pool->nr_idle && pool->nr_running);
948797e8345STejun Heo }
949797e8345STejun Heo 
950797e8345STejun Heo /**
951797e8345STejun Heo  * worker_leave_idle - leave idle state
952797e8345STejun Heo  * @worker: worker which is leaving idle state
953797e8345STejun Heo  *
954797e8345STejun Heo  * @worker is leaving idle state.  Update stats.
955797e8345STejun Heo  *
956797e8345STejun Heo  * LOCKING:
957797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
958797e8345STejun Heo  */
959797e8345STejun Heo static void worker_leave_idle(struct worker *worker)
960797e8345STejun Heo {
961797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
962797e8345STejun Heo 
963797e8345STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
964797e8345STejun Heo 		return;
965797e8345STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
966797e8345STejun Heo 	pool->nr_idle--;
967797e8345STejun Heo 	list_del_init(&worker->entry);
968797e8345STejun Heo }
969797e8345STejun Heo 
970797e8345STejun Heo /**
971797e8345STejun Heo  * find_worker_executing_work - find worker which is executing a work
972797e8345STejun Heo  * @pool: pool of interest
973797e8345STejun Heo  * @work: work to find worker for
974797e8345STejun Heo  *
975797e8345STejun Heo  * Find a worker which is executing @work on @pool by searching
976797e8345STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
977797e8345STejun Heo  * to match, its current execution should match the address of @work and
978797e8345STejun Heo  * its work function.  This is to avoid unwanted dependency between
979797e8345STejun Heo  * unrelated work executions through a work item being recycled while still
980797e8345STejun Heo  * being executed.
981797e8345STejun Heo  *
982797e8345STejun Heo  * This is a bit tricky.  A work item may be freed once its execution
983797e8345STejun Heo  * starts and nothing prevents the freed area from being recycled for
984797e8345STejun Heo  * another work item.  If the same work item address ends up being reused
985797e8345STejun Heo  * before the original execution finishes, workqueue will identify the
986797e8345STejun Heo  * recycled work item as currently executing and make it wait until the
987797e8345STejun Heo  * current execution finishes, introducing an unwanted dependency.
988797e8345STejun Heo  *
989797e8345STejun Heo  * This function checks the work item address and work function to avoid
990797e8345STejun Heo  * false positives.  Note that this isn't complete as one may construct a
991797e8345STejun Heo  * work function which can introduce dependency onto itself through a
992797e8345STejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
993797e8345STejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
994797e8345STejun Heo  * actually occurs, it should be easy to locate the culprit work function.
995797e8345STejun Heo  *
996797e8345STejun Heo  * CONTEXT:
997797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
998797e8345STejun Heo  *
999797e8345STejun Heo  * Return:
1000797e8345STejun Heo  * Pointer to worker which is executing @work if found, %NULL
1001797e8345STejun Heo  * otherwise.
1002797e8345STejun Heo  */
1003797e8345STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
1004797e8345STejun Heo 						 struct work_struct *work)
1005797e8345STejun Heo {
1006797e8345STejun Heo 	struct worker *worker;
1007797e8345STejun Heo 
1008797e8345STejun Heo 	hash_for_each_possible(pool->busy_hash, worker, hentry,
1009797e8345STejun Heo 			       (unsigned long)work)
1010797e8345STejun Heo 		if (worker->current_work == work &&
1011797e8345STejun Heo 		    worker->current_func == work->func)
1012797e8345STejun Heo 			return worker;
1013797e8345STejun Heo 
1014797e8345STejun Heo 	return NULL;
1015797e8345STejun Heo }
1016797e8345STejun Heo 
1017797e8345STejun Heo /**
1018797e8345STejun Heo  * move_linked_works - move linked works to a list
1019797e8345STejun Heo  * @work: start of series of works to be scheduled
1020797e8345STejun Heo  * @head: target list to append @work to
1021797e8345STejun Heo  * @nextp: out parameter for nested worklist walking
1022797e8345STejun Heo  *
1023873eaca6STejun Heo  * Schedule linked works starting from @work to @head. Work series to be
1024873eaca6STejun Heo  * scheduled starts at @work and includes any consecutive work with
1025873eaca6STejun Heo  * WORK_STRUCT_LINKED set in its predecessor. See assign_work() for details on
1026873eaca6STejun Heo  * @nextp.
1027797e8345STejun Heo  *
1028797e8345STejun Heo  * CONTEXT:
1029797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1030797e8345STejun Heo  */
1031797e8345STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1032797e8345STejun Heo 			      struct work_struct **nextp)
1033797e8345STejun Heo {
1034797e8345STejun Heo 	struct work_struct *n;
1035797e8345STejun Heo 
1036797e8345STejun Heo 	/*
1037797e8345STejun Heo 	 * Linked worklist will always end before the end of the list,
1038797e8345STejun Heo 	 * use NULL for list head.
1039797e8345STejun Heo 	 */
1040797e8345STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1041797e8345STejun Heo 		list_move_tail(&work->entry, head);
1042797e8345STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1043797e8345STejun Heo 			break;
1044797e8345STejun Heo 	}
1045797e8345STejun Heo 
1046797e8345STejun Heo 	/*
1047797e8345STejun Heo 	 * If we're already inside safe list traversal and have moved
1048797e8345STejun Heo 	 * multiple works to the scheduled queue, the next position
1049797e8345STejun Heo 	 * needs to be updated.
1050797e8345STejun Heo 	 */
1051797e8345STejun Heo 	if (nextp)
1052797e8345STejun Heo 		*nextp = n;
1053797e8345STejun Heo }
1054797e8345STejun Heo 
1055797e8345STejun Heo /**
1056873eaca6STejun Heo  * assign_work - assign a work item and its linked work items to a worker
1057873eaca6STejun Heo  * @work: work to assign
1058873eaca6STejun Heo  * @worker: worker to assign to
1059873eaca6STejun Heo  * @nextp: out parameter for nested worklist walking
1060873eaca6STejun Heo  *
1061873eaca6STejun Heo  * Assign @work and its linked work items to @worker. If @work is already being
1062873eaca6STejun Heo  * executed by another worker in the same pool, it'll be punted there.
1063873eaca6STejun Heo  *
1064873eaca6STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of the last
1065873eaca6STejun Heo  * scheduled work. This allows assign_work() to be nested inside
1066873eaca6STejun Heo  * list_for_each_entry_safe().
1067873eaca6STejun Heo  *
1068873eaca6STejun Heo  * Returns %true if @work was successfully assigned to @worker. %false if @work
1069873eaca6STejun Heo  * was punted to another worker already executing it.
1070873eaca6STejun Heo  */
1071873eaca6STejun Heo static bool assign_work(struct work_struct *work, struct worker *worker,
1072873eaca6STejun Heo 			struct work_struct **nextp)
1073873eaca6STejun Heo {
1074873eaca6STejun Heo 	struct worker_pool *pool = worker->pool;
1075873eaca6STejun Heo 	struct worker *collision;
1076873eaca6STejun Heo 
1077873eaca6STejun Heo 	lockdep_assert_held(&pool->lock);
1078873eaca6STejun Heo 
1079873eaca6STejun Heo 	/*
1080873eaca6STejun Heo 	 * A single work shouldn't be executed concurrently by multiple workers.
1081873eaca6STejun Heo 	 * __queue_work() ensures that @work doesn't jump to a different pool
1082873eaca6STejun Heo 	 * while still running in the previous pool. Here, we should ensure that
1083873eaca6STejun Heo 	 * @work is not executed concurrently by multiple workers from the same
1084873eaca6STejun Heo 	 * pool. Check whether anyone is already processing the work. If so,
1085873eaca6STejun Heo 	 * defer the work to the currently executing one.
1086873eaca6STejun Heo 	 */
1087873eaca6STejun Heo 	collision = find_worker_executing_work(pool, work);
1088873eaca6STejun Heo 	if (unlikely(collision)) {
1089873eaca6STejun Heo 		move_linked_works(work, &collision->scheduled, nextp);
1090873eaca6STejun Heo 		return false;
1091873eaca6STejun Heo 	}
1092873eaca6STejun Heo 
1093873eaca6STejun Heo 	move_linked_works(work, &worker->scheduled, nextp);
1094873eaca6STejun Heo 	return true;
1095873eaca6STejun Heo }
1096873eaca6STejun Heo 
1097873eaca6STejun Heo /**
10980219a352STejun Heo  * kick_pool - wake up an idle worker if necessary
10990219a352STejun Heo  * @pool: pool to kick
1100797e8345STejun Heo  *
11010219a352STejun Heo  * @pool may have pending work items. Wake up worker if necessary. Returns
11020219a352STejun Heo  * whether a worker was woken up.
1103797e8345STejun Heo  */
11040219a352STejun Heo static bool kick_pool(struct worker_pool *pool)
1105797e8345STejun Heo {
1106797e8345STejun Heo 	struct worker *worker = first_idle_worker(pool);
1107*8639ecebSTejun Heo 	struct task_struct *p;
1108797e8345STejun Heo 
11090219a352STejun Heo 	lockdep_assert_held(&pool->lock);
11100219a352STejun Heo 
11110219a352STejun Heo 	if (!need_more_worker(pool) || !worker)
11120219a352STejun Heo 		return false;
11130219a352STejun Heo 
1114*8639ecebSTejun Heo 	p = worker->task;
1115*8639ecebSTejun Heo 
1116*8639ecebSTejun Heo #ifdef CONFIG_SMP
1117*8639ecebSTejun Heo 	/*
1118*8639ecebSTejun Heo 	 * Idle @worker is about to execute @work and waking up provides an
1119*8639ecebSTejun Heo 	 * opportunity to migrate @worker at a lower cost by setting the task's
1120*8639ecebSTejun Heo 	 * wake_cpu field. Let's see if we want to move @worker to improve
1121*8639ecebSTejun Heo 	 * execution locality.
1122*8639ecebSTejun Heo 	 *
1123*8639ecebSTejun Heo 	 * We're waking the worker that went idle the latest and there's some
1124*8639ecebSTejun Heo 	 * chance that @worker is marked idle but hasn't gone off CPU yet. If
1125*8639ecebSTejun Heo 	 * so, setting the wake_cpu won't do anything. As this is a best-effort
1126*8639ecebSTejun Heo 	 * optimization and the race window is narrow, let's leave as-is for
1127*8639ecebSTejun Heo 	 * now. If this becomes pronounced, we can skip over workers which are
1128*8639ecebSTejun Heo 	 * still on cpu when picking an idle worker.
1129*8639ecebSTejun Heo 	 *
1130*8639ecebSTejun Heo 	 * If @pool has non-strict affinity, @worker might have ended up outside
1131*8639ecebSTejun Heo 	 * its affinity scope. Repatriate.
1132*8639ecebSTejun Heo 	 */
1133*8639ecebSTejun Heo 	if (!pool->attrs->affn_strict &&
1134*8639ecebSTejun Heo 	    !cpumask_test_cpu(p->wake_cpu, pool->attrs->__pod_cpumask)) {
1135*8639ecebSTejun Heo 		struct work_struct *work = list_first_entry(&pool->worklist,
1136*8639ecebSTejun Heo 						struct work_struct, entry);
1137*8639ecebSTejun Heo 		p->wake_cpu = cpumask_any_distribute(pool->attrs->__pod_cpumask);
1138*8639ecebSTejun Heo 		get_work_pwq(work)->stats[PWQ_STAT_REPATRIATED]++;
1139*8639ecebSTejun Heo 	}
1140*8639ecebSTejun Heo #endif
1141*8639ecebSTejun Heo 	wake_up_process(p);
11420219a352STejun Heo 	return true;
1143797e8345STejun Heo }
1144797e8345STejun Heo 
114563638450STejun Heo #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT
114663638450STejun Heo 
114763638450STejun Heo /*
114863638450STejun Heo  * Concurrency-managed per-cpu work items that hog CPU for longer than
114963638450STejun Heo  * wq_cpu_intensive_thresh_us trigger the automatic CPU_INTENSIVE mechanism,
115063638450STejun Heo  * which prevents them from stalling other concurrency-managed work items. If a
115163638450STejun Heo  * work function keeps triggering this mechanism, it's likely that the work item
115263638450STejun Heo  * should be using an unbound workqueue instead.
115363638450STejun Heo  *
115463638450STejun Heo  * wq_cpu_intensive_report() tracks work functions which trigger such conditions
115563638450STejun Heo  * and report them so that they can be examined and converted to use unbound
115663638450STejun Heo  * workqueues as appropriate. To avoid flooding the console, each violating work
115763638450STejun Heo  * function is tracked and reported with exponential backoff.
115863638450STejun Heo  */
115963638450STejun Heo #define WCI_MAX_ENTS 128
116063638450STejun Heo 
116163638450STejun Heo struct wci_ent {
116263638450STejun Heo 	work_func_t		func;
116363638450STejun Heo 	atomic64_t		cnt;
116463638450STejun Heo 	struct hlist_node	hash_node;
116563638450STejun Heo };
116663638450STejun Heo 
116763638450STejun Heo static struct wci_ent wci_ents[WCI_MAX_ENTS];
116863638450STejun Heo static int wci_nr_ents;
116963638450STejun Heo static DEFINE_RAW_SPINLOCK(wci_lock);
117063638450STejun Heo static DEFINE_HASHTABLE(wci_hash, ilog2(WCI_MAX_ENTS));
117163638450STejun Heo 
117263638450STejun Heo static struct wci_ent *wci_find_ent(work_func_t func)
117363638450STejun Heo {
117463638450STejun Heo 	struct wci_ent *ent;
117563638450STejun Heo 
117663638450STejun Heo 	hash_for_each_possible_rcu(wci_hash, ent, hash_node,
117763638450STejun Heo 				   (unsigned long)func) {
117863638450STejun Heo 		if (ent->func == func)
117963638450STejun Heo 			return ent;
118063638450STejun Heo 	}
118163638450STejun Heo 	return NULL;
118263638450STejun Heo }
118363638450STejun Heo 
118463638450STejun Heo static void wq_cpu_intensive_report(work_func_t func)
118563638450STejun Heo {
118663638450STejun Heo 	struct wci_ent *ent;
118763638450STejun Heo 
118863638450STejun Heo restart:
118963638450STejun Heo 	ent = wci_find_ent(func);
119063638450STejun Heo 	if (ent) {
119163638450STejun Heo 		u64 cnt;
119263638450STejun Heo 
119363638450STejun Heo 		/*
119463638450STejun Heo 		 * Start reporting from the fourth time and back off
119563638450STejun Heo 		 * exponentially.
119663638450STejun Heo 		 */
119763638450STejun Heo 		cnt = atomic64_inc_return_relaxed(&ent->cnt);
119863638450STejun Heo 		if (cnt >= 4 && is_power_of_2(cnt))
119963638450STejun Heo 			printk_deferred(KERN_WARNING "workqueue: %ps hogged CPU for >%luus %llu times, consider switching to WQ_UNBOUND\n",
120063638450STejun Heo 					ent->func, wq_cpu_intensive_thresh_us,
120163638450STejun Heo 					atomic64_read(&ent->cnt));
120263638450STejun Heo 		return;
120363638450STejun Heo 	}
120463638450STejun Heo 
120563638450STejun Heo 	/*
120663638450STejun Heo 	 * @func is a new violation. Allocate a new entry for it. If wcn_ents[]
120763638450STejun Heo 	 * is exhausted, something went really wrong and we probably made enough
120863638450STejun Heo 	 * noise already.
120963638450STejun Heo 	 */
121063638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS)
121163638450STejun Heo 		return;
121263638450STejun Heo 
121363638450STejun Heo 	raw_spin_lock(&wci_lock);
121463638450STejun Heo 
121563638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS) {
121663638450STejun Heo 		raw_spin_unlock(&wci_lock);
121763638450STejun Heo 		return;
121863638450STejun Heo 	}
121963638450STejun Heo 
122063638450STejun Heo 	if (wci_find_ent(func)) {
122163638450STejun Heo 		raw_spin_unlock(&wci_lock);
122263638450STejun Heo 		goto restart;
122363638450STejun Heo 	}
122463638450STejun Heo 
122563638450STejun Heo 	ent = &wci_ents[wci_nr_ents++];
122663638450STejun Heo 	ent->func = func;
122763638450STejun Heo 	atomic64_set(&ent->cnt, 1);
122863638450STejun Heo 	hash_add_rcu(wci_hash, &ent->hash_node, (unsigned long)func);
122963638450STejun Heo 
123063638450STejun Heo 	raw_spin_unlock(&wci_lock);
123163638450STejun Heo }
123263638450STejun Heo 
123363638450STejun Heo #else	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
123463638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) {}
123563638450STejun Heo #endif	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
123663638450STejun Heo 
1237c54d5046STejun Heo /**
12381da177e4SLinus Torvalds  * wq_worker_running - a worker is running again
12391da177e4SLinus Torvalds  * @task: task waking up
12401da177e4SLinus Torvalds  *
12411da177e4SLinus Torvalds  * This function is called when a worker returns from schedule()
12421da177e4SLinus Torvalds  */
12431da177e4SLinus Torvalds void wq_worker_running(struct task_struct *task)
12441da177e4SLinus Torvalds {
12451da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
12461da177e4SLinus Torvalds 
1247c8f6219bSZqiang 	if (!READ_ONCE(worker->sleeping))
12481da177e4SLinus Torvalds 		return;
12491da177e4SLinus Torvalds 
12501da177e4SLinus Torvalds 	/*
12511da177e4SLinus Torvalds 	 * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check
12521da177e4SLinus Torvalds 	 * and the nr_running increment below, we may ruin the nr_running reset
12531da177e4SLinus Torvalds 	 * and leave with an unexpected pool->nr_running == 1 on the newly unbound
12541da177e4SLinus Torvalds 	 * pool. Protect against such race.
12551da177e4SLinus Torvalds 	 */
12561da177e4SLinus Torvalds 	preempt_disable();
12571da177e4SLinus Torvalds 	if (!(worker->flags & WORKER_NOT_RUNNING))
12581da177e4SLinus Torvalds 		worker->pool->nr_running++;
12591da177e4SLinus Torvalds 	preempt_enable();
1260616db877STejun Heo 
1261616db877STejun Heo 	/*
1262616db877STejun Heo 	 * CPU intensive auto-detection cares about how long a work item hogged
1263616db877STejun Heo 	 * CPU without sleeping. Reset the starting timestamp on wakeup.
1264616db877STejun Heo 	 */
1265616db877STejun Heo 	worker->current_at = worker->task->se.sum_exec_runtime;
1266616db877STejun Heo 
1267c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 0);
12681da177e4SLinus Torvalds }
12691da177e4SLinus Torvalds 
12701da177e4SLinus Torvalds /**
12711da177e4SLinus Torvalds  * wq_worker_sleeping - a worker is going to sleep
12721da177e4SLinus Torvalds  * @task: task going to sleep
12731da177e4SLinus Torvalds  *
12741da177e4SLinus Torvalds  * This function is called from schedule() when a busy worker is
12751da177e4SLinus Torvalds  * going to sleep.
12761da177e4SLinus Torvalds  */
12771da177e4SLinus Torvalds void wq_worker_sleeping(struct task_struct *task)
12781da177e4SLinus Torvalds {
12791da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
12801da177e4SLinus Torvalds 	struct worker_pool *pool;
12811da177e4SLinus Torvalds 
12821da177e4SLinus Torvalds 	/*
12831da177e4SLinus Torvalds 	 * Rescuers, which may not have all the fields set up like normal
12841da177e4SLinus Torvalds 	 * workers, also reach here, let's not access anything before
12851da177e4SLinus Torvalds 	 * checking NOT_RUNNING.
12861da177e4SLinus Torvalds 	 */
12871da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING)
12881da177e4SLinus Torvalds 		return;
12891da177e4SLinus Torvalds 
12901da177e4SLinus Torvalds 	pool = worker->pool;
12911da177e4SLinus Torvalds 
12921da177e4SLinus Torvalds 	/* Return if preempted before wq_worker_running() was reached */
1293c8f6219bSZqiang 	if (READ_ONCE(worker->sleeping))
12941da177e4SLinus Torvalds 		return;
12951da177e4SLinus Torvalds 
1296c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 1);
12971da177e4SLinus Torvalds 	raw_spin_lock_irq(&pool->lock);
12981da177e4SLinus Torvalds 
12991da177e4SLinus Torvalds 	/*
13001da177e4SLinus Torvalds 	 * Recheck in case unbind_workers() preempted us. We don't
13011da177e4SLinus Torvalds 	 * want to decrement nr_running after the worker is unbound
13021da177e4SLinus Torvalds 	 * and nr_running has been reset.
13031da177e4SLinus Torvalds 	 */
13041da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING) {
13051da177e4SLinus Torvalds 		raw_spin_unlock_irq(&pool->lock);
13061da177e4SLinus Torvalds 		return;
13071da177e4SLinus Torvalds 	}
13081da177e4SLinus Torvalds 
13091da177e4SLinus Torvalds 	pool->nr_running--;
13100219a352STejun Heo 	if (kick_pool(pool))
1311725e8ec5STejun Heo 		worker->current_pwq->stats[PWQ_STAT_CM_WAKEUP]++;
13120219a352STejun Heo 
13131da177e4SLinus Torvalds 	raw_spin_unlock_irq(&pool->lock);
13141da177e4SLinus Torvalds }
13151da177e4SLinus Torvalds 
13161da177e4SLinus Torvalds /**
1317616db877STejun Heo  * wq_worker_tick - a scheduler tick occurred while a kworker is running
1318616db877STejun Heo  * @task: task currently running
1319616db877STejun Heo  *
1320616db877STejun Heo  * Called from scheduler_tick(). We're in the IRQ context and the current
1321616db877STejun Heo  * worker's fields which follow the 'K' locking rule can be accessed safely.
1322616db877STejun Heo  */
1323616db877STejun Heo void wq_worker_tick(struct task_struct *task)
1324616db877STejun Heo {
1325616db877STejun Heo 	struct worker *worker = kthread_data(task);
1326616db877STejun Heo 	struct pool_workqueue *pwq = worker->current_pwq;
1327616db877STejun Heo 	struct worker_pool *pool = worker->pool;
1328616db877STejun Heo 
1329616db877STejun Heo 	if (!pwq)
1330616db877STejun Heo 		return;
1331616db877STejun Heo 
13328a1dd1e5STejun Heo 	pwq->stats[PWQ_STAT_CPU_TIME] += TICK_USEC;
13338a1dd1e5STejun Heo 
133418c8ae81SZqiang 	if (!wq_cpu_intensive_thresh_us)
133518c8ae81SZqiang 		return;
133618c8ae81SZqiang 
1337616db877STejun Heo 	/*
1338616db877STejun Heo 	 * If the current worker is concurrency managed and hogged the CPU for
1339616db877STejun Heo 	 * longer than wq_cpu_intensive_thresh_us, it's automatically marked
1340616db877STejun Heo 	 * CPU_INTENSIVE to avoid stalling other concurrency-managed work items.
1341c8f6219bSZqiang 	 *
1342c8f6219bSZqiang 	 * Set @worker->sleeping means that @worker is in the process of
1343c8f6219bSZqiang 	 * switching out voluntarily and won't be contributing to
1344c8f6219bSZqiang 	 * @pool->nr_running until it wakes up. As wq_worker_sleeping() also
1345c8f6219bSZqiang 	 * decrements ->nr_running, setting CPU_INTENSIVE here can lead to
1346c8f6219bSZqiang 	 * double decrements. The task is releasing the CPU anyway. Let's skip.
1347c8f6219bSZqiang 	 * We probably want to make this prettier in the future.
1348616db877STejun Heo 	 */
1349c8f6219bSZqiang 	if ((worker->flags & WORKER_NOT_RUNNING) || READ_ONCE(worker->sleeping) ||
1350616db877STejun Heo 	    worker->task->se.sum_exec_runtime - worker->current_at <
1351616db877STejun Heo 	    wq_cpu_intensive_thresh_us * NSEC_PER_USEC)
1352616db877STejun Heo 		return;
1353616db877STejun Heo 
1354616db877STejun Heo 	raw_spin_lock(&pool->lock);
1355616db877STejun Heo 
1356616db877STejun Heo 	worker_set_flags(worker, WORKER_CPU_INTENSIVE);
135763638450STejun Heo 	wq_cpu_intensive_report(worker->current_func);
1358616db877STejun Heo 	pwq->stats[PWQ_STAT_CPU_INTENSIVE]++;
1359616db877STejun Heo 
13600219a352STejun Heo 	if (kick_pool(pool))
1361616db877STejun Heo 		pwq->stats[PWQ_STAT_CM_WAKEUP]++;
1362616db877STejun Heo 
1363616db877STejun Heo 	raw_spin_unlock(&pool->lock);
1364616db877STejun Heo }
1365616db877STejun Heo 
1366616db877STejun Heo /**
13671da177e4SLinus Torvalds  * wq_worker_last_func - retrieve worker's last work function
13681da177e4SLinus Torvalds  * @task: Task to retrieve last work function of.
13691da177e4SLinus Torvalds  *
13701da177e4SLinus Torvalds  * Determine the last function a worker executed. This is called from
13711da177e4SLinus Torvalds  * the scheduler to get a worker's last known identity.
13721da177e4SLinus Torvalds  *
13731da177e4SLinus Torvalds  * CONTEXT:
13749b41ea72SAndrew Morton  * raw_spin_lock_irq(rq->lock)
13751da177e4SLinus Torvalds  *
13761da177e4SLinus Torvalds  * This function is called during schedule() when a kworker is going
1377f756d5e2SNathan Lynch  * to sleep. It's used by psi to identify aggregation workers during
1378f756d5e2SNathan Lynch  * dequeuing, to allow periodic aggregation to shut-off when that
13791da177e4SLinus Torvalds  * worker is the last task in the system or cgroup to go to sleep.
13801da177e4SLinus Torvalds  *
13811da177e4SLinus Torvalds  * As this function doesn't involve any workqueue-related locking, it
13821da177e4SLinus Torvalds  * only returns stable values when called from inside the scheduler's
13831da177e4SLinus Torvalds  * queuing and dequeuing paths, when @task, which must be a kworker,
13841da177e4SLinus Torvalds  * is guaranteed to not be processing any works.
1385365970a1SDavid Howells  *
1386365970a1SDavid Howells  * Return:
1387365970a1SDavid Howells  * The last work function %current executed as a worker, NULL if it
1388365970a1SDavid Howells  * hasn't executed any work yet.
1389365970a1SDavid Howells  */
1390365970a1SDavid Howells work_func_t wq_worker_last_func(struct task_struct *task)
1391365970a1SDavid Howells {
1392365970a1SDavid Howells 	struct worker *worker = kthread_data(task);
1393365970a1SDavid Howells 
1394365970a1SDavid Howells 	return worker->last_func;
1395365970a1SDavid Howells }
1396365970a1SDavid Howells 
1397d302f017STejun Heo /**
13988864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
13998864b4e5STejun Heo  * @pwq: pool_workqueue to get
14008864b4e5STejun Heo  *
14018864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
14028864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
14038864b4e5STejun Heo  */
14048864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
14058864b4e5STejun Heo {
14068864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
14078864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
14088864b4e5STejun Heo 	pwq->refcnt++;
14098864b4e5STejun Heo }
14108864b4e5STejun Heo 
14118864b4e5STejun Heo /**
14128864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
14138864b4e5STejun Heo  * @pwq: pool_workqueue to put
14148864b4e5STejun Heo  *
14158864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
14168864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
14178864b4e5STejun Heo  */
14188864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
14198864b4e5STejun Heo {
14208864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
14218864b4e5STejun Heo 	if (likely(--pwq->refcnt))
14228864b4e5STejun Heo 		return;
14238864b4e5STejun Heo 	/*
1424967b494eSTejun Heo 	 * @pwq can't be released under pool->lock, bounce to a dedicated
1425967b494eSTejun Heo 	 * kthread_worker to avoid A-A deadlocks.
14268864b4e5STejun Heo 	 */
1427687a9aa5STejun Heo 	kthread_queue_work(pwq_release_worker, &pwq->release_work);
14288864b4e5STejun Heo }
14298864b4e5STejun Heo 
1430dce90d47STejun Heo /**
1431dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1432dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1433dce90d47STejun Heo  *
1434dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1435dce90d47STejun Heo  */
1436dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1437dce90d47STejun Heo {
1438dce90d47STejun Heo 	if (pwq) {
1439dce90d47STejun Heo 		/*
144024acfb71SThomas Gleixner 		 * As both pwqs and pools are RCU protected, the
1441dce90d47STejun Heo 		 * following lock operations are safe.
1442dce90d47STejun Heo 		 */
1443a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
1444dce90d47STejun Heo 		put_pwq(pwq);
1445a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
1446dce90d47STejun Heo 	}
1447dce90d47STejun Heo }
1448dce90d47STejun Heo 
1449f97a4a1aSLai Jiangshan static void pwq_activate_inactive_work(struct work_struct *work)
1450bf4ede01STejun Heo {
1451112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
1452bf4ede01STejun Heo 
1453bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
145482607adcSTejun Heo 	if (list_empty(&pwq->pool->worklist))
145582607adcSTejun Heo 		pwq->pool->watchdog_ts = jiffies;
1456112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
1457f97a4a1aSLai Jiangshan 	__clear_bit(WORK_STRUCT_INACTIVE_BIT, work_data_bits(work));
1458112202d9STejun Heo 	pwq->nr_active++;
1459bf4ede01STejun Heo }
1460bf4ede01STejun Heo 
1461f97a4a1aSLai Jiangshan static void pwq_activate_first_inactive(struct pool_workqueue *pwq)
14623aa62497SLai Jiangshan {
1463f97a4a1aSLai Jiangshan 	struct work_struct *work = list_first_entry(&pwq->inactive_works,
14643aa62497SLai Jiangshan 						    struct work_struct, entry);
14653aa62497SLai Jiangshan 
1466f97a4a1aSLai Jiangshan 	pwq_activate_inactive_work(work);
14673aa62497SLai Jiangshan }
14683aa62497SLai Jiangshan 
1469bf4ede01STejun Heo /**
1470112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1471112202d9STejun Heo  * @pwq: pwq of interest
1472c4560c2cSLai Jiangshan  * @work_data: work_data of work which left the queue
1473bf4ede01STejun Heo  *
1474bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1475112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1476bf4ede01STejun Heo  *
1477bf4ede01STejun Heo  * CONTEXT:
1478a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1479bf4ede01STejun Heo  */
1480c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data)
1481bf4ede01STejun Heo {
1482c4560c2cSLai Jiangshan 	int color = get_work_color(work_data);
1483c4560c2cSLai Jiangshan 
1484018f3a13SLai Jiangshan 	if (!(work_data & WORK_STRUCT_INACTIVE)) {
1485112202d9STejun Heo 		pwq->nr_active--;
1486f97a4a1aSLai Jiangshan 		if (!list_empty(&pwq->inactive_works)) {
1487f97a4a1aSLai Jiangshan 			/* one down, submit an inactive one */
1488112202d9STejun Heo 			if (pwq->nr_active < pwq->max_active)
1489f97a4a1aSLai Jiangshan 				pwq_activate_first_inactive(pwq);
1490bf4ede01STejun Heo 		}
1491018f3a13SLai Jiangshan 	}
1492018f3a13SLai Jiangshan 
1493018f3a13SLai Jiangshan 	pwq->nr_in_flight[color]--;
1494bf4ede01STejun Heo 
1495bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
1496112202d9STejun Heo 	if (likely(pwq->flush_color != color))
14978864b4e5STejun Heo 		goto out_put;
1498bf4ede01STejun Heo 
1499bf4ede01STejun Heo 	/* are there still in-flight works? */
1500112202d9STejun Heo 	if (pwq->nr_in_flight[color])
15018864b4e5STejun Heo 		goto out_put;
1502bf4ede01STejun Heo 
1503112202d9STejun Heo 	/* this pwq is done, clear flush_color */
1504112202d9STejun Heo 	pwq->flush_color = -1;
1505bf4ede01STejun Heo 
1506bf4ede01STejun Heo 	/*
1507112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
1508bf4ede01STejun Heo 	 * will handle the rest.
1509bf4ede01STejun Heo 	 */
1510112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1511112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
15128864b4e5STejun Heo out_put:
15138864b4e5STejun Heo 	put_pwq(pwq);
1514bf4ede01STejun Heo }
1515bf4ede01STejun Heo 
151636e227d2STejun Heo /**
1517bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
151836e227d2STejun Heo  * @work: work item to steal
151936e227d2STejun Heo  * @is_dwork: @work is a delayed_work
1520bbb68dfaSTejun Heo  * @flags: place to store irq state
152136e227d2STejun Heo  *
152236e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
1523d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
152436e227d2STejun Heo  *
1525d185af30SYacine Belkadi  * Return:
15263eb6b31bSMauro Carvalho Chehab  *
15273eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
152836e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
152936e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
153036e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
1531bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
1532bbb68dfaSTejun Heo  *		for arbitrarily long
15333eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
153436e227d2STejun Heo  *
1535d185af30SYacine Belkadi  * Note:
1536bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1537e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
1538e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
1539e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1540bbb68dfaSTejun Heo  *
1541bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
1542bbb68dfaSTejun Heo  * responsible for releasing it using local_irq_restore(*@flags).
1543bbb68dfaSTejun Heo  *
1544e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
1545bf4ede01STejun Heo  */
1546bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1547bbb68dfaSTejun Heo 			       unsigned long *flags)
1548bf4ede01STejun Heo {
1549d565ed63STejun Heo 	struct worker_pool *pool;
1550112202d9STejun Heo 	struct pool_workqueue *pwq;
1551bf4ede01STejun Heo 
1552bbb68dfaSTejun Heo 	local_irq_save(*flags);
1553bbb68dfaSTejun Heo 
155436e227d2STejun Heo 	/* try to steal the timer if it exists */
155536e227d2STejun Heo 	if (is_dwork) {
155636e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
155736e227d2STejun Heo 
1558e0aecdd8STejun Heo 		/*
1559e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
1560e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
1561e0aecdd8STejun Heo 		 * running on the local CPU.
1562e0aecdd8STejun Heo 		 */
156336e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
156436e227d2STejun Heo 			return 1;
156536e227d2STejun Heo 	}
156636e227d2STejun Heo 
156736e227d2STejun Heo 	/* try to claim PENDING the normal way */
1568bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1569bf4ede01STejun Heo 		return 0;
1570bf4ede01STejun Heo 
157124acfb71SThomas Gleixner 	rcu_read_lock();
1572bf4ede01STejun Heo 	/*
1573bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
1574bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1575bf4ede01STejun Heo 	 */
1576d565ed63STejun Heo 	pool = get_work_pool(work);
1577d565ed63STejun Heo 	if (!pool)
1578bbb68dfaSTejun Heo 		goto fail;
1579bf4ede01STejun Heo 
1580a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&pool->lock);
1581bf4ede01STejun Heo 	/*
1582112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
1583112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
1584112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
1585112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
1586112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
15870b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
1588bf4ede01STejun Heo 	 */
1589112202d9STejun Heo 	pwq = get_work_pwq(work);
1590112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
1591bf4ede01STejun Heo 		debug_work_deactivate(work);
15923aa62497SLai Jiangshan 
15933aa62497SLai Jiangshan 		/*
1594018f3a13SLai Jiangshan 		 * A cancelable inactive work item must be in the
1595018f3a13SLai Jiangshan 		 * pwq->inactive_works since a queued barrier can't be
1596018f3a13SLai Jiangshan 		 * canceled (see the comments in insert_wq_barrier()).
1597018f3a13SLai Jiangshan 		 *
1598f97a4a1aSLai Jiangshan 		 * An inactive work item cannot be grabbed directly because
1599d812796eSLai Jiangshan 		 * it might have linked barrier work items which, if left
1600f97a4a1aSLai Jiangshan 		 * on the inactive_works list, will confuse pwq->nr_active
160116062836STejun Heo 		 * management later on and cause stall.  Make sure the work
160216062836STejun Heo 		 * item is activated before grabbing.
16033aa62497SLai Jiangshan 		 */
1604f97a4a1aSLai Jiangshan 		if (*work_data_bits(work) & WORK_STRUCT_INACTIVE)
1605f97a4a1aSLai Jiangshan 			pwq_activate_inactive_work(work);
16063aa62497SLai Jiangshan 
1607bf4ede01STejun Heo 		list_del_init(&work->entry);
1608c4560c2cSLai Jiangshan 		pwq_dec_nr_in_flight(pwq, *work_data_bits(work));
160936e227d2STejun Heo 
1610112202d9STejun Heo 		/* work->data points to pwq iff queued, point to pool */
16114468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
16124468a00fSLai Jiangshan 
1613a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock(&pool->lock);
161424acfb71SThomas Gleixner 		rcu_read_unlock();
161536e227d2STejun Heo 		return 1;
1616bf4ede01STejun Heo 	}
1617a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&pool->lock);
1618bbb68dfaSTejun Heo fail:
161924acfb71SThomas Gleixner 	rcu_read_unlock();
1620bbb68dfaSTejun Heo 	local_irq_restore(*flags);
1621bbb68dfaSTejun Heo 	if (work_is_canceling(work))
1622bbb68dfaSTejun Heo 		return -ENOENT;
1623bbb68dfaSTejun Heo 	cpu_relax();
162436e227d2STejun Heo 	return -EAGAIN;
1625bf4ede01STejun Heo }
1626bf4ede01STejun Heo 
1627bf4ede01STejun Heo /**
1628706026c2STejun Heo  * insert_work - insert a work into a pool
1629112202d9STejun Heo  * @pwq: pwq @work belongs to
16304690c4abSTejun Heo  * @work: work to insert
16314690c4abSTejun Heo  * @head: insertion point
16324690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
16334690c4abSTejun Heo  *
1634112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
1635706026c2STejun Heo  * work_struct flags.
16364690c4abSTejun Heo  *
16374690c4abSTejun Heo  * CONTEXT:
1638a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1639365970a1SDavid Howells  */
1640112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1641112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
1642b89deed3SOleg Nesterov {
1643fe089f87STejun Heo 	debug_work_activate(work);
1644e1d8aa9fSFrederic Weisbecker 
1645e89a85d6SWalter Wu 	/* record the work call stack in order to print it in KASAN reports */
1646f70da745SMarco Elver 	kasan_record_aux_stack_noalloc(work);
1647e89a85d6SWalter Wu 
16484690c4abSTejun Heo 	/* we own @work, set data and link */
1649112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
16501a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
16518864b4e5STejun Heo 	get_pwq(pwq);
1652b89deed3SOleg Nesterov }
1653b89deed3SOleg Nesterov 
1654c8efcc25STejun Heo /*
1655c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
16568d03ecfeSTejun Heo  * same workqueue.
1657c8efcc25STejun Heo  */
1658c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
1659c8efcc25STejun Heo {
1660c8efcc25STejun Heo 	struct worker *worker;
1661c8efcc25STejun Heo 
16628d03ecfeSTejun Heo 	worker = current_wq_worker();
1663c8efcc25STejun Heo 	/*
1664bf393fd4SBart Van Assche 	 * Return %true iff I'm a worker executing a work item on @wq.  If
16658d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
1666c8efcc25STejun Heo 	 */
1667112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
1668c8efcc25STejun Heo }
1669c8efcc25STejun Heo 
1670ef557180SMike Galbraith /*
1671ef557180SMike Galbraith  * When queueing an unbound work item to a wq, prefer local CPU if allowed
1672ef557180SMike Galbraith  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
1673ef557180SMike Galbraith  * avoid perturbing sensitive tasks.
1674ef557180SMike Galbraith  */
1675ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu)
1676ef557180SMike Galbraith {
1677ef557180SMike Galbraith 	int new_cpu;
1678ef557180SMike Galbraith 
1679f303fccbSTejun Heo 	if (likely(!wq_debug_force_rr_cpu)) {
1680ef557180SMike Galbraith 		if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1681ef557180SMike Galbraith 			return cpu;
1682a8ec5880SAmmar Faizi 	} else {
1683a8ec5880SAmmar Faizi 		pr_warn_once("workqueue: round-robin CPU selection forced, expect performance impact\n");
1684f303fccbSTejun Heo 	}
1685f303fccbSTejun Heo 
1686ef557180SMike Galbraith 	if (cpumask_empty(wq_unbound_cpumask))
1687ef557180SMike Galbraith 		return cpu;
1688ef557180SMike Galbraith 
1689ef557180SMike Galbraith 	new_cpu = __this_cpu_read(wq_rr_cpu_last);
1690ef557180SMike Galbraith 	new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1691ef557180SMike Galbraith 	if (unlikely(new_cpu >= nr_cpu_ids)) {
1692ef557180SMike Galbraith 		new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1693ef557180SMike Galbraith 		if (unlikely(new_cpu >= nr_cpu_ids))
1694ef557180SMike Galbraith 			return cpu;
1695ef557180SMike Galbraith 	}
1696ef557180SMike Galbraith 	__this_cpu_write(wq_rr_cpu_last, new_cpu);
1697ef557180SMike Galbraith 
1698ef557180SMike Galbraith 	return new_cpu;
1699ef557180SMike Galbraith }
1700ef557180SMike Galbraith 
1701d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
17021da177e4SLinus Torvalds 			 struct work_struct *work)
17031da177e4SLinus Torvalds {
1704112202d9STejun Heo 	struct pool_workqueue *pwq;
1705fe089f87STejun Heo 	struct worker_pool *last_pool, *pool;
17068a2e8e5dSTejun Heo 	unsigned int work_flags;
1707b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
17088930cabaSTejun Heo 
17098930cabaSTejun Heo 	/*
17108930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
17118930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
17128930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
17138930cabaSTejun Heo 	 * happen with IRQ disabled.
17148930cabaSTejun Heo 	 */
17158e8eb730SFrederic Weisbecker 	lockdep_assert_irqs_disabled();
17161da177e4SLinus Torvalds 
17171e19ffc6STejun Heo 
171833e3f0a3SRichard Clark 	/*
171933e3f0a3SRichard Clark 	 * For a draining wq, only works from the same workqueue are
172033e3f0a3SRichard Clark 	 * allowed. The __WQ_DESTROYING helps to spot the issue that
172133e3f0a3SRichard Clark 	 * queues a new work item to a wq after destroy_workqueue(wq).
172233e3f0a3SRichard Clark 	 */
172333e3f0a3SRichard Clark 	if (unlikely(wq->flags & (__WQ_DESTROYING | __WQ_DRAINING) &&
172433e3f0a3SRichard Clark 		     WARN_ON_ONCE(!is_chained_work(wq))))
1725e41e704bSTejun Heo 		return;
172624acfb71SThomas Gleixner 	rcu_read_lock();
17279e8cd2f5STejun Heo retry:
1728aa202f1fSHillf Danton 	/* pwq which will be used unless @work is executing elsewhere */
1729636b927eSTejun Heo 	if (req_cpu == WORK_CPU_UNBOUND) {
1730636b927eSTejun Heo 		if (wq->flags & WQ_UNBOUND)
1731ef557180SMike Galbraith 			cpu = wq_select_unbound_cpu(raw_smp_processor_id());
1732636b927eSTejun Heo 		else
1733aa202f1fSHillf Danton 			cpu = raw_smp_processor_id();
1734aa202f1fSHillf Danton 	}
1735f3421797STejun Heo 
1736636b927eSTejun Heo 	pwq = rcu_dereference(*per_cpu_ptr(wq->cpu_pwq, cpu));
1737fe089f87STejun Heo 	pool = pwq->pool;
1738fe089f87STejun Heo 
173918aa9effSTejun Heo 	/*
1740c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
1741c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
1742c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
174318aa9effSTejun Heo 	 */
1744c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
1745fe089f87STejun Heo 	if (last_pool && last_pool != pool) {
174618aa9effSTejun Heo 		struct worker *worker;
174718aa9effSTejun Heo 
1748a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock(&last_pool->lock);
174918aa9effSTejun Heo 
1750c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
175118aa9effSTejun Heo 
1752112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
1753c9178087STejun Heo 			pwq = worker->current_pwq;
1754fe089f87STejun Heo 			pool = pwq->pool;
1755fe089f87STejun Heo 			WARN_ON_ONCE(pool != last_pool);
17568594fadeSLai Jiangshan 		} else {
175718aa9effSTejun Heo 			/* meh... not running there, queue here */
1758a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock(&last_pool->lock);
1759fe089f87STejun Heo 			raw_spin_lock(&pool->lock);
176018aa9effSTejun Heo 		}
17618930cabaSTejun Heo 	} else {
1762fe089f87STejun Heo 		raw_spin_lock(&pool->lock);
17638930cabaSTejun Heo 	}
1764502ca9d8STejun Heo 
17659e8cd2f5STejun Heo 	/*
1766636b927eSTejun Heo 	 * pwq is determined and locked. For unbound pools, we could have raced
1767636b927eSTejun Heo 	 * with pwq release and it could already be dead. If its refcnt is zero,
1768636b927eSTejun Heo 	 * repeat pwq selection. Note that unbound pwqs never die without
1769636b927eSTejun Heo 	 * another pwq replacing it in cpu_pwq or while work items are executing
1770636b927eSTejun Heo 	 * on it, so the retrying is guaranteed to make forward-progress.
17719e8cd2f5STejun Heo 	 */
17729e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
17739e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
1774fe089f87STejun Heo 			raw_spin_unlock(&pool->lock);
17759e8cd2f5STejun Heo 			cpu_relax();
17769e8cd2f5STejun Heo 			goto retry;
17779e8cd2f5STejun Heo 		}
17789e8cd2f5STejun Heo 		/* oops */
17799e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
17809e8cd2f5STejun Heo 			  wq->name, cpu);
17819e8cd2f5STejun Heo 	}
17829e8cd2f5STejun Heo 
1783112202d9STejun Heo 	/* pwq determined, queue */
1784112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
1785502ca9d8STejun Heo 
178624acfb71SThomas Gleixner 	if (WARN_ON(!list_empty(&work->entry)))
178724acfb71SThomas Gleixner 		goto out;
17881e19ffc6STejun Heo 
1789112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
1790112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
17911e19ffc6STejun Heo 
1792112202d9STejun Heo 	if (likely(pwq->nr_active < pwq->max_active)) {
1793fe089f87STejun Heo 		if (list_empty(&pool->worklist))
1794fe089f87STejun Heo 			pool->watchdog_ts = jiffies;
1795fe089f87STejun Heo 
1796cdadf009STejun Heo 		trace_workqueue_activate_work(work);
1797112202d9STejun Heo 		pwq->nr_active++;
1798fe089f87STejun Heo 		insert_work(pwq, work, &pool->worklist, work_flags);
17990219a352STejun Heo 		kick_pool(pool);
18008a2e8e5dSTejun Heo 	} else {
1801f97a4a1aSLai Jiangshan 		work_flags |= WORK_STRUCT_INACTIVE;
1802fe089f87STejun Heo 		insert_work(pwq, work, &pwq->inactive_works, work_flags);
18038a2e8e5dSTejun Heo 	}
18041e19ffc6STejun Heo 
180524acfb71SThomas Gleixner out:
1806fe089f87STejun Heo 	raw_spin_unlock(&pool->lock);
180724acfb71SThomas Gleixner 	rcu_read_unlock();
18081da177e4SLinus Torvalds }
18091da177e4SLinus Torvalds 
18100fcb78c2SRolf Eike Beer /**
1811c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
1812c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
1813c1a220e7SZhang Rui  * @wq: workqueue to use
1814c1a220e7SZhang Rui  * @work: work to queue
1815c1a220e7SZhang Rui  *
1816c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
1817443378f0SPaul E. McKenney  * can't go away.  Callers that fail to ensure that the specified
1818443378f0SPaul E. McKenney  * CPU cannot go away will execute on a randomly chosen CPU.
1819854f5cc5SPaul E. McKenney  * But note well that callers specifying a CPU that never has been
1820854f5cc5SPaul E. McKenney  * online will get a splat.
1821d185af30SYacine Belkadi  *
1822d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
1823c1a220e7SZhang Rui  */
1824d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
1825d4283e93STejun Heo 		   struct work_struct *work)
1826c1a220e7SZhang Rui {
1827d4283e93STejun Heo 	bool ret = false;
18288930cabaSTejun Heo 	unsigned long flags;
18298930cabaSTejun Heo 
18308930cabaSTejun Heo 	local_irq_save(flags);
1831c1a220e7SZhang Rui 
183222df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
18334690c4abSTejun Heo 		__queue_work(cpu, wq, work);
1834d4283e93STejun Heo 		ret = true;
1835c1a220e7SZhang Rui 	}
18368930cabaSTejun Heo 
18378930cabaSTejun Heo 	local_irq_restore(flags);
1838c1a220e7SZhang Rui 	return ret;
1839c1a220e7SZhang Rui }
1840ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
1841c1a220e7SZhang Rui 
18428204e0c1SAlexander Duyck /**
1843fef59c9cSTejun Heo  * select_numa_node_cpu - Select a CPU based on NUMA node
18448204e0c1SAlexander Duyck  * @node: NUMA node ID that we want to select a CPU from
18458204e0c1SAlexander Duyck  *
18468204e0c1SAlexander Duyck  * This function will attempt to find a "random" cpu available on a given
18478204e0c1SAlexander Duyck  * node. If there are no CPUs available on the given node it will return
18488204e0c1SAlexander Duyck  * WORK_CPU_UNBOUND indicating that we should just schedule to any
18498204e0c1SAlexander Duyck  * available CPU if we need to schedule this work.
18508204e0c1SAlexander Duyck  */
1851fef59c9cSTejun Heo static int select_numa_node_cpu(int node)
18528204e0c1SAlexander Duyck {
18538204e0c1SAlexander Duyck 	int cpu;
18548204e0c1SAlexander Duyck 
18558204e0c1SAlexander Duyck 	/* Delay binding to CPU if node is not valid or online */
18568204e0c1SAlexander Duyck 	if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
18578204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
18588204e0c1SAlexander Duyck 
18598204e0c1SAlexander Duyck 	/* Use local node/cpu if we are already there */
18608204e0c1SAlexander Duyck 	cpu = raw_smp_processor_id();
18618204e0c1SAlexander Duyck 	if (node == cpu_to_node(cpu))
18628204e0c1SAlexander Duyck 		return cpu;
18638204e0c1SAlexander Duyck 
18648204e0c1SAlexander Duyck 	/* Use "random" otherwise know as "first" online CPU of node */
18658204e0c1SAlexander Duyck 	cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
18668204e0c1SAlexander Duyck 
18678204e0c1SAlexander Duyck 	/* If CPU is valid return that, otherwise just defer */
18688204e0c1SAlexander Duyck 	return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
18698204e0c1SAlexander Duyck }
18708204e0c1SAlexander Duyck 
18718204e0c1SAlexander Duyck /**
18728204e0c1SAlexander Duyck  * queue_work_node - queue work on a "random" cpu for a given NUMA node
18738204e0c1SAlexander Duyck  * @node: NUMA node that we are targeting the work for
18748204e0c1SAlexander Duyck  * @wq: workqueue to use
18758204e0c1SAlexander Duyck  * @work: work to queue
18768204e0c1SAlexander Duyck  *
18778204e0c1SAlexander Duyck  * We queue the work to a "random" CPU within a given NUMA node. The basic
18788204e0c1SAlexander Duyck  * idea here is to provide a way to somehow associate work with a given
18798204e0c1SAlexander Duyck  * NUMA node.
18808204e0c1SAlexander Duyck  *
18818204e0c1SAlexander Duyck  * This function will only make a best effort attempt at getting this onto
18828204e0c1SAlexander Duyck  * the right NUMA node. If no node is requested or the requested node is
18838204e0c1SAlexander Duyck  * offline then we just fall back to standard queue_work behavior.
18848204e0c1SAlexander Duyck  *
18858204e0c1SAlexander Duyck  * Currently the "random" CPU ends up being the first available CPU in the
18868204e0c1SAlexander Duyck  * intersection of cpu_online_mask and the cpumask of the node, unless we
18878204e0c1SAlexander Duyck  * are running on the node. In that case we just use the current CPU.
18888204e0c1SAlexander Duyck  *
18898204e0c1SAlexander Duyck  * Return: %false if @work was already on a queue, %true otherwise.
18908204e0c1SAlexander Duyck  */
18918204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq,
18928204e0c1SAlexander Duyck 		     struct work_struct *work)
18938204e0c1SAlexander Duyck {
18948204e0c1SAlexander Duyck 	unsigned long flags;
18958204e0c1SAlexander Duyck 	bool ret = false;
18968204e0c1SAlexander Duyck 
18978204e0c1SAlexander Duyck 	/*
18988204e0c1SAlexander Duyck 	 * This current implementation is specific to unbound workqueues.
18998204e0c1SAlexander Duyck 	 * Specifically we only return the first available CPU for a given
19008204e0c1SAlexander Duyck 	 * node instead of cycling through individual CPUs within the node.
19018204e0c1SAlexander Duyck 	 *
19028204e0c1SAlexander Duyck 	 * If this is used with a per-cpu workqueue then the logic in
19038204e0c1SAlexander Duyck 	 * workqueue_select_cpu_near would need to be updated to allow for
19048204e0c1SAlexander Duyck 	 * some round robin type logic.
19058204e0c1SAlexander Duyck 	 */
19068204e0c1SAlexander Duyck 	WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
19078204e0c1SAlexander Duyck 
19088204e0c1SAlexander Duyck 	local_irq_save(flags);
19098204e0c1SAlexander Duyck 
19108204e0c1SAlexander Duyck 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1911fef59c9cSTejun Heo 		int cpu = select_numa_node_cpu(node);
19128204e0c1SAlexander Duyck 
19138204e0c1SAlexander Duyck 		__queue_work(cpu, wq, work);
19148204e0c1SAlexander Duyck 		ret = true;
19158204e0c1SAlexander Duyck 	}
19168204e0c1SAlexander Duyck 
19178204e0c1SAlexander Duyck 	local_irq_restore(flags);
19188204e0c1SAlexander Duyck 	return ret;
19198204e0c1SAlexander Duyck }
19208204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node);
19218204e0c1SAlexander Duyck 
19228c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t)
19231da177e4SLinus Torvalds {
19248c20feb6SKees Cook 	struct delayed_work *dwork = from_timer(dwork, t, timer);
19251da177e4SLinus Torvalds 
1926e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
192760c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
19281da177e4SLinus Torvalds }
19291438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
19301da177e4SLinus Torvalds 
19317beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
193252bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
19331da177e4SLinus Torvalds {
19347beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
19357beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
19361da177e4SLinus Torvalds 
1937637fdbaeSTejun Heo 	WARN_ON_ONCE(!wq);
19384b243563SSami Tolvanen 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
1939fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
1940fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
19417beb2edfSTejun Heo 
19428852aac2STejun Heo 	/*
19438852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
19448852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
19458852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
19468852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
19478852aac2STejun Heo 	 */
19488852aac2STejun Heo 	if (!delay) {
19498852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
19508852aac2STejun Heo 		return;
19518852aac2STejun Heo 	}
19528852aac2STejun Heo 
195360c057bcSLai Jiangshan 	dwork->wq = wq;
19541265057fSTejun Heo 	dwork->cpu = cpu;
19557beb2edfSTejun Heo 	timer->expires = jiffies + delay;
19567beb2edfSTejun Heo 
1957041bd12eSTejun Heo 	if (unlikely(cpu != WORK_CPU_UNBOUND))
19587beb2edfSTejun Heo 		add_timer_on(timer, cpu);
1959041bd12eSTejun Heo 	else
1960041bd12eSTejun Heo 		add_timer(timer);
19617beb2edfSTejun Heo }
19621da177e4SLinus Torvalds 
19630fcb78c2SRolf Eike Beer /**
19640fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
19650fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
19660fcb78c2SRolf Eike Beer  * @wq: workqueue to use
1967af9997e4SRandy Dunlap  * @dwork: work to queue
19680fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
19690fcb78c2SRolf Eike Beer  *
1970d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
1971715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1972715f1300STejun Heo  * execution.
19730fcb78c2SRolf Eike Beer  */
1974d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
197552bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
19767a6bc1cdSVenkatesh Pallipadi {
197752bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
1978d4283e93STejun Heo 	bool ret = false;
19798930cabaSTejun Heo 	unsigned long flags;
19808930cabaSTejun Heo 
19818930cabaSTejun Heo 	/* read the comment in __queue_work() */
19828930cabaSTejun Heo 	local_irq_save(flags);
19837a6bc1cdSVenkatesh Pallipadi 
198422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
19857beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
1986d4283e93STejun Heo 		ret = true;
19877a6bc1cdSVenkatesh Pallipadi 	}
19888930cabaSTejun Heo 
19898930cabaSTejun Heo 	local_irq_restore(flags);
19907a6bc1cdSVenkatesh Pallipadi 	return ret;
19917a6bc1cdSVenkatesh Pallipadi }
1992ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
19931da177e4SLinus Torvalds 
1994c8e55f36STejun Heo /**
19958376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
19968376fe22STejun Heo  * @cpu: CPU number to execute work on
19978376fe22STejun Heo  * @wq: workqueue to use
19988376fe22STejun Heo  * @dwork: work to queue
19998376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
20008376fe22STejun Heo  *
20018376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
20028376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
20038376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
20048376fe22STejun Heo  * current state.
20058376fe22STejun Heo  *
2006d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
20078376fe22STejun Heo  * pending and its timer was modified.
20088376fe22STejun Heo  *
2009e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
20108376fe22STejun Heo  * See try_to_grab_pending() for details.
20118376fe22STejun Heo  */
20128376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
20138376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
20148376fe22STejun Heo {
20158376fe22STejun Heo 	unsigned long flags;
20168376fe22STejun Heo 	int ret;
20178376fe22STejun Heo 
20188376fe22STejun Heo 	do {
20198376fe22STejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &flags);
20208376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
20218376fe22STejun Heo 
20228376fe22STejun Heo 	if (likely(ret >= 0)) {
20238376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
20248376fe22STejun Heo 		local_irq_restore(flags);
20258376fe22STejun Heo 	}
20268376fe22STejun Heo 
20278376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
20288376fe22STejun Heo 	return ret;
20298376fe22STejun Heo }
20308376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
20318376fe22STejun Heo 
203205f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu)
203305f0fe6bSTejun Heo {
203405f0fe6bSTejun Heo 	struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
203505f0fe6bSTejun Heo 
203605f0fe6bSTejun Heo 	/* read the comment in __queue_work() */
203705f0fe6bSTejun Heo 	local_irq_disable();
203805f0fe6bSTejun Heo 	__queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
203905f0fe6bSTejun Heo 	local_irq_enable();
204005f0fe6bSTejun Heo }
204105f0fe6bSTejun Heo 
204205f0fe6bSTejun Heo /**
204305f0fe6bSTejun Heo  * queue_rcu_work - queue work after a RCU grace period
204405f0fe6bSTejun Heo  * @wq: workqueue to use
204505f0fe6bSTejun Heo  * @rwork: work to queue
204605f0fe6bSTejun Heo  *
204705f0fe6bSTejun Heo  * Return: %false if @rwork was already pending, %true otherwise.  Note
204805f0fe6bSTejun Heo  * that a full RCU grace period is guaranteed only after a %true return.
2049bf393fd4SBart Van Assche  * While @rwork is guaranteed to be executed after a %false return, the
205005f0fe6bSTejun Heo  * execution may happen before a full RCU grace period has passed.
205105f0fe6bSTejun Heo  */
205205f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
205305f0fe6bSTejun Heo {
205405f0fe6bSTejun Heo 	struct work_struct *work = &rwork->work;
205505f0fe6bSTejun Heo 
205605f0fe6bSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
205705f0fe6bSTejun Heo 		rwork->wq = wq;
2058a7e30c0eSUladzislau Rezki 		call_rcu_hurry(&rwork->rcu, rcu_work_rcufn);
205905f0fe6bSTejun Heo 		return true;
206005f0fe6bSTejun Heo 	}
206105f0fe6bSTejun Heo 
206205f0fe6bSTejun Heo 	return false;
206305f0fe6bSTejun Heo }
206405f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work);
206505f0fe6bSTejun Heo 
2066f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
2067c34056a3STejun Heo {
2068c34056a3STejun Heo 	struct worker *worker;
2069c34056a3STejun Heo 
2070f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
2071c8e55f36STejun Heo 	if (worker) {
2072c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
2073affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
2074da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
2075e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
2076e22bee78STejun Heo 		worker->flags = WORKER_PREP;
2077c8e55f36STejun Heo 	}
2078c34056a3STejun Heo 	return worker;
2079c34056a3STejun Heo }
2080c34056a3STejun Heo 
20819546b29eSTejun Heo static cpumask_t *pool_allowed_cpus(struct worker_pool *pool)
20829546b29eSTejun Heo {
2083*8639ecebSTejun Heo 	if (pool->cpu < 0 && pool->attrs->affn_strict)
20849546b29eSTejun Heo 		return pool->attrs->__pod_cpumask;
2085*8639ecebSTejun Heo 	else
2086*8639ecebSTejun Heo 		return pool->attrs->cpumask;
20879546b29eSTejun Heo }
20889546b29eSTejun Heo 
2089c34056a3STejun Heo /**
20904736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
20914736cbf7SLai Jiangshan  * @worker: worker to be attached
20924736cbf7SLai Jiangshan  * @pool: the target pool
20934736cbf7SLai Jiangshan  *
20944736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
20954736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
20964736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
20974736cbf7SLai Jiangshan  */
20984736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
20994736cbf7SLai Jiangshan 				   struct worker_pool *pool)
21004736cbf7SLai Jiangshan {
21011258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
21024736cbf7SLai Jiangshan 
21034736cbf7SLai Jiangshan 	/*
21041258fae7STejun Heo 	 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
21051258fae7STejun Heo 	 * stable across this function.  See the comments above the flag
21061258fae7STejun Heo 	 * definition for details.
21074736cbf7SLai Jiangshan 	 */
21084736cbf7SLai Jiangshan 	if (pool->flags & POOL_DISASSOCIATED)
21094736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
21105c25b5ffSPeter Zijlstra 	else
21115c25b5ffSPeter Zijlstra 		kthread_set_per_cpu(worker->task, pool->cpu);
21124736cbf7SLai Jiangshan 
2113640f17c8SPeter Zijlstra 	if (worker->rescue_wq)
21149546b29eSTejun Heo 		set_cpus_allowed_ptr(worker->task, pool_allowed_cpus(pool));
2115640f17c8SPeter Zijlstra 
21164736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
2117a2d812a2STejun Heo 	worker->pool = pool;
21184736cbf7SLai Jiangshan 
21191258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
21204736cbf7SLai Jiangshan }
21214736cbf7SLai Jiangshan 
21224736cbf7SLai Jiangshan /**
212360f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
212460f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
212560f5a4bcSLai Jiangshan  *
21264736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
21274736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
21284736cbf7SLai Jiangshan  * other reference to the pool.
212960f5a4bcSLai Jiangshan  */
2130a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker)
213160f5a4bcSLai Jiangshan {
2132a2d812a2STejun Heo 	struct worker_pool *pool = worker->pool;
213360f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
213460f5a4bcSLai Jiangshan 
21351258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
2136a2d812a2STejun Heo 
21375c25b5ffSPeter Zijlstra 	kthread_set_per_cpu(worker->task, -1);
2138da028469SLai Jiangshan 	list_del(&worker->node);
2139a2d812a2STejun Heo 	worker->pool = NULL;
2140a2d812a2STejun Heo 
2141e02b9312SValentin Schneider 	if (list_empty(&pool->workers) && list_empty(&pool->dying_workers))
214260f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
21431258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
214460f5a4bcSLai Jiangshan 
2145b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
2146b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
2147b62c0751SLai Jiangshan 
214860f5a4bcSLai Jiangshan 	if (detach_completion)
214960f5a4bcSLai Jiangshan 		complete(detach_completion);
215060f5a4bcSLai Jiangshan }
215160f5a4bcSLai Jiangshan 
215260f5a4bcSLai Jiangshan /**
2153c34056a3STejun Heo  * create_worker - create a new workqueue worker
215463d95a91STejun Heo  * @pool: pool the new worker will belong to
2155c34056a3STejun Heo  *
2156051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
2157c34056a3STejun Heo  *
2158c34056a3STejun Heo  * CONTEXT:
2159c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
2160c34056a3STejun Heo  *
2161d185af30SYacine Belkadi  * Return:
2162c34056a3STejun Heo  * Pointer to the newly created worker.
2163c34056a3STejun Heo  */
2164bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
2165c34056a3STejun Heo {
2166e441b56fSZhen Lei 	struct worker *worker;
2167e441b56fSZhen Lei 	int id;
2168e3c916a4STejun Heo 	char id_buf[16];
2169c34056a3STejun Heo 
21707cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
2171e441b56fSZhen Lei 	id = ida_alloc(&pool->worker_ida, GFP_KERNEL);
21723f0ea0b8SPetr Mladek 	if (id < 0) {
21733f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker ID: %pe\n",
21743f0ea0b8SPetr Mladek 			    ERR_PTR(id));
2175e441b56fSZhen Lei 		return NULL;
21763f0ea0b8SPetr Mladek 	}
2177c34056a3STejun Heo 
2178f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
21793f0ea0b8SPetr Mladek 	if (!worker) {
21803f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker\n");
2181c34056a3STejun Heo 		goto fail;
21823f0ea0b8SPetr Mladek 	}
2183c34056a3STejun Heo 
2184c34056a3STejun Heo 	worker->id = id;
2185c34056a3STejun Heo 
218629c91e99STejun Heo 	if (pool->cpu >= 0)
2187e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
2188e3c916a4STejun Heo 			 pool->attrs->nice < 0  ? "H" : "");
2189f3421797STejun Heo 	else
2190e3c916a4STejun Heo 		snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
2191e3c916a4STejun Heo 
2192f3f90ad4STejun Heo 	worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
2193e3c916a4STejun Heo 					      "kworker/%s", id_buf);
21943f0ea0b8SPetr Mladek 	if (IS_ERR(worker->task)) {
219560f54038SPetr Mladek 		if (PTR_ERR(worker->task) == -EINTR) {
219660f54038SPetr Mladek 			pr_err("workqueue: Interrupted when creating a worker thread \"kworker/%s\"\n",
219760f54038SPetr Mladek 			       id_buf);
219860f54038SPetr Mladek 		} else {
21993f0ea0b8SPetr Mladek 			pr_err_once("workqueue: Failed to create a worker thread: %pe",
22003f0ea0b8SPetr Mladek 				    worker->task);
220160f54038SPetr Mladek 		}
2202c34056a3STejun Heo 		goto fail;
22033f0ea0b8SPetr Mladek 	}
2204c34056a3STejun Heo 
220591151228SOleg Nesterov 	set_user_nice(worker->task, pool->attrs->nice);
22069546b29eSTejun Heo 	kthread_bind_mask(worker->task, pool_allowed_cpus(pool));
220791151228SOleg Nesterov 
2208da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
22094736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
2210822d8405STejun Heo 
2211051e1850SLai Jiangshan 	/* start the newly created worker */
2212a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
22130219a352STejun Heo 
2214051e1850SLai Jiangshan 	worker->pool->nr_workers++;
2215051e1850SLai Jiangshan 	worker_enter_idle(worker);
22160219a352STejun Heo 	kick_pool(pool);
22170219a352STejun Heo 
22180219a352STejun Heo 	/*
22190219a352STejun Heo 	 * @worker is waiting on a completion in kthread() and will trigger hung
22200219a352STejun Heo 	 * check if not woken up soon. As kick_pool() might not have waken it
22210219a352STejun Heo 	 * up, wake it up explicitly once more.
22220219a352STejun Heo 	 */
2223051e1850SLai Jiangshan 	wake_up_process(worker->task);
22240219a352STejun Heo 
2225a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2226051e1850SLai Jiangshan 
2227c34056a3STejun Heo 	return worker;
2228822d8405STejun Heo 
2229c34056a3STejun Heo fail:
2230e441b56fSZhen Lei 	ida_free(&pool->worker_ida, id);
2231c34056a3STejun Heo 	kfree(worker);
2232c34056a3STejun Heo 	return NULL;
2233c34056a3STejun Heo }
2234c34056a3STejun Heo 
2235793777bcSValentin Schneider static void unbind_worker(struct worker *worker)
2236793777bcSValentin Schneider {
2237793777bcSValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2238793777bcSValentin Schneider 
2239793777bcSValentin Schneider 	kthread_set_per_cpu(worker->task, -1);
2240793777bcSValentin Schneider 	if (cpumask_intersects(wq_unbound_cpumask, cpu_active_mask))
2241793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, wq_unbound_cpumask) < 0);
2242793777bcSValentin Schneider 	else
2243793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
2244793777bcSValentin Schneider }
2245793777bcSValentin Schneider 
2246e02b9312SValentin Schneider static void wake_dying_workers(struct list_head *cull_list)
2247e02b9312SValentin Schneider {
2248e02b9312SValentin Schneider 	struct worker *worker, *tmp;
2249e02b9312SValentin Schneider 
2250e02b9312SValentin Schneider 	list_for_each_entry_safe(worker, tmp, cull_list, entry) {
2251e02b9312SValentin Schneider 		list_del_init(&worker->entry);
2252e02b9312SValentin Schneider 		unbind_worker(worker);
2253e02b9312SValentin Schneider 		/*
2254e02b9312SValentin Schneider 		 * If the worker was somehow already running, then it had to be
2255e02b9312SValentin Schneider 		 * in pool->idle_list when set_worker_dying() happened or we
2256e02b9312SValentin Schneider 		 * wouldn't have gotten here.
2257c34056a3STejun Heo 		 *
2258e02b9312SValentin Schneider 		 * Thus, the worker must either have observed the WORKER_DIE
2259e02b9312SValentin Schneider 		 * flag, or have set its state to TASK_IDLE. Either way, the
2260e02b9312SValentin Schneider 		 * below will be observed by the worker and is safe to do
2261e02b9312SValentin Schneider 		 * outside of pool->lock.
2262e02b9312SValentin Schneider 		 */
2263e02b9312SValentin Schneider 		wake_up_process(worker->task);
2264e02b9312SValentin Schneider 	}
2265e02b9312SValentin Schneider }
2266e02b9312SValentin Schneider 
2267e02b9312SValentin Schneider /**
2268e02b9312SValentin Schneider  * set_worker_dying - Tag a worker for destruction
2269e02b9312SValentin Schneider  * @worker: worker to be destroyed
2270e02b9312SValentin Schneider  * @list: transfer worker away from its pool->idle_list and into list
2271e02b9312SValentin Schneider  *
2272e02b9312SValentin Schneider  * Tag @worker for destruction and adjust @pool stats accordingly.  The worker
2273e02b9312SValentin Schneider  * should be idle.
2274c8e55f36STejun Heo  *
2275c8e55f36STejun Heo  * CONTEXT:
2276a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2277c34056a3STejun Heo  */
2278e02b9312SValentin Schneider static void set_worker_dying(struct worker *worker, struct list_head *list)
2279c34056a3STejun Heo {
2280bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2281c34056a3STejun Heo 
2282cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
2283e02b9312SValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2284cd549687STejun Heo 
2285c34056a3STejun Heo 	/* sanity check frenzy */
22866183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
228773eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
228873eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
22896183c009STejun Heo 		return;
2290c34056a3STejun Heo 
2291bd7bdd43STejun Heo 	pool->nr_workers--;
2292bd7bdd43STejun Heo 	pool->nr_idle--;
2293c8e55f36STejun Heo 
2294cb444766STejun Heo 	worker->flags |= WORKER_DIE;
2295e02b9312SValentin Schneider 
2296e02b9312SValentin Schneider 	list_move(&worker->entry, list);
2297e02b9312SValentin Schneider 	list_move(&worker->node, &pool->dying_workers);
2298c34056a3STejun Heo }
2299c34056a3STejun Heo 
23003f959aa3SValentin Schneider /**
23013f959aa3SValentin Schneider  * idle_worker_timeout - check if some idle workers can now be deleted.
23023f959aa3SValentin Schneider  * @t: The pool's idle_timer that just expired
23033f959aa3SValentin Schneider  *
23043f959aa3SValentin Schneider  * The timer is armed in worker_enter_idle(). Note that it isn't disarmed in
23053f959aa3SValentin Schneider  * worker_leave_idle(), as a worker flicking between idle and active while its
23063f959aa3SValentin Schneider  * pool is at the too_many_workers() tipping point would cause too much timer
23073f959aa3SValentin Schneider  * housekeeping overhead. Since IDLE_WORKER_TIMEOUT is long enough, we just let
23083f959aa3SValentin Schneider  * it expire and re-evaluate things from there.
23093f959aa3SValentin Schneider  */
231032a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t)
2311e22bee78STejun Heo {
231232a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, idle_timer);
23133f959aa3SValentin Schneider 	bool do_cull = false;
23143f959aa3SValentin Schneider 
23153f959aa3SValentin Schneider 	if (work_pending(&pool->idle_cull_work))
23163f959aa3SValentin Schneider 		return;
23173f959aa3SValentin Schneider 
23183f959aa3SValentin Schneider 	raw_spin_lock_irq(&pool->lock);
23193f959aa3SValentin Schneider 
23203f959aa3SValentin Schneider 	if (too_many_workers(pool)) {
23213f959aa3SValentin Schneider 		struct worker *worker;
23223f959aa3SValentin Schneider 		unsigned long expires;
23233f959aa3SValentin Schneider 
23243f959aa3SValentin Schneider 		/* idle_list is kept in LIFO order, check the last one */
23253f959aa3SValentin Schneider 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
23263f959aa3SValentin Schneider 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
23273f959aa3SValentin Schneider 		do_cull = !time_before(jiffies, expires);
23283f959aa3SValentin Schneider 
23293f959aa3SValentin Schneider 		if (!do_cull)
23303f959aa3SValentin Schneider 			mod_timer(&pool->idle_timer, expires);
23313f959aa3SValentin Schneider 	}
23323f959aa3SValentin Schneider 	raw_spin_unlock_irq(&pool->lock);
23333f959aa3SValentin Schneider 
23343f959aa3SValentin Schneider 	if (do_cull)
23353f959aa3SValentin Schneider 		queue_work(system_unbound_wq, &pool->idle_cull_work);
23363f959aa3SValentin Schneider }
23373f959aa3SValentin Schneider 
23383f959aa3SValentin Schneider /**
23393f959aa3SValentin Schneider  * idle_cull_fn - cull workers that have been idle for too long.
23403f959aa3SValentin Schneider  * @work: the pool's work for handling these idle workers
23413f959aa3SValentin Schneider  *
23423f959aa3SValentin Schneider  * This goes through a pool's idle workers and gets rid of those that have been
23433f959aa3SValentin Schneider  * idle for at least IDLE_WORKER_TIMEOUT seconds.
2344e02b9312SValentin Schneider  *
2345e02b9312SValentin Schneider  * We don't want to disturb isolated CPUs because of a pcpu kworker being
2346e02b9312SValentin Schneider  * culled, so this also resets worker affinity. This requires a sleepable
2347e02b9312SValentin Schneider  * context, hence the split between timer callback and work item.
23483f959aa3SValentin Schneider  */
23493f959aa3SValentin Schneider static void idle_cull_fn(struct work_struct *work)
23503f959aa3SValentin Schneider {
23513f959aa3SValentin Schneider 	struct worker_pool *pool = container_of(work, struct worker_pool, idle_cull_work);
23529680540cSYang Yingliang 	LIST_HEAD(cull_list);
2353e22bee78STejun Heo 
2354e02b9312SValentin Schneider 	/*
2355e02b9312SValentin Schneider 	 * Grabbing wq_pool_attach_mutex here ensures an already-running worker
2356e02b9312SValentin Schneider 	 * cannot proceed beyong worker_detach_from_pool() in its self-destruct
2357e02b9312SValentin Schneider 	 * path. This is required as a previously-preempted worker could run after
2358e02b9312SValentin Schneider 	 * set_worker_dying() has happened but before wake_dying_workers() did.
2359e02b9312SValentin Schneider 	 */
2360e02b9312SValentin Schneider 	mutex_lock(&wq_pool_attach_mutex);
2361a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2362e22bee78STejun Heo 
23633347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
2364e22bee78STejun Heo 		struct worker *worker;
2365e22bee78STejun Heo 		unsigned long expires;
2366e22bee78STejun Heo 
236763d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2368e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2369e22bee78STejun Heo 
23703347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
237163d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
23723347fc9fSLai Jiangshan 			break;
2373e22bee78STejun Heo 		}
23743347fc9fSLai Jiangshan 
2375e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
2376e22bee78STejun Heo 	}
2377e22bee78STejun Heo 
2378a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2379e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
2380e02b9312SValentin Schneider 	mutex_unlock(&wq_pool_attach_mutex);
2381e22bee78STejun Heo }
2382e22bee78STejun Heo 
2383493a1724STejun Heo static void send_mayday(struct work_struct *work)
2384e22bee78STejun Heo {
2385112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2386112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
2387493a1724STejun Heo 
23882e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
2389e22bee78STejun Heo 
2390493008a8STejun Heo 	if (!wq->rescuer)
2391493a1724STejun Heo 		return;
2392e22bee78STejun Heo 
2393e22bee78STejun Heo 	/* mayday mayday mayday */
2394493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
239577668c8bSLai Jiangshan 		/*
239677668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
239777668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
239877668c8bSLai Jiangshan 		 * rescuer is done with it.
239977668c8bSLai Jiangshan 		 */
240077668c8bSLai Jiangshan 		get_pwq(pwq);
2401493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
2402e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
2403725e8ec5STejun Heo 		pwq->stats[PWQ_STAT_MAYDAY]++;
2404493a1724STejun Heo 	}
2405e22bee78STejun Heo }
2406e22bee78STejun Heo 
240732a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t)
2408e22bee78STejun Heo {
240932a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, mayday_timer);
2410e22bee78STejun Heo 	struct work_struct *work;
2411e22bee78STejun Heo 
2412a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2413a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&wq_mayday_lock);		/* for wq->maydays */
2414e22bee78STejun Heo 
241563d95a91STejun Heo 	if (need_to_create_worker(pool)) {
2416e22bee78STejun Heo 		/*
2417e22bee78STejun Heo 		 * We've been trying to create a new worker but
2418e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
2419e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
2420e22bee78STejun Heo 		 * rescuers.
2421e22bee78STejun Heo 		 */
242263d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
2423e22bee78STejun Heo 			send_mayday(work);
2424e22bee78STejun Heo 	}
2425e22bee78STejun Heo 
2426a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&wq_mayday_lock);
2427a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2428e22bee78STejun Heo 
242963d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
2430e22bee78STejun Heo }
2431e22bee78STejun Heo 
2432e22bee78STejun Heo /**
2433e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
243463d95a91STejun Heo  * @pool: pool to create a new worker for
2435e22bee78STejun Heo  *
243663d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
2437e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
2438e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
243963d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
2440e22bee78STejun Heo  * possible allocation deadlock.
2441e22bee78STejun Heo  *
2442c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
2443c5aa87bbSTejun Heo  * may_start_working() %true.
2444e22bee78STejun Heo  *
2445e22bee78STejun Heo  * LOCKING:
2446a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2447e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
2448e22bee78STejun Heo  * manager.
2449e22bee78STejun Heo  */
245029187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool)
2451d565ed63STejun Heo __releases(&pool->lock)
2452d565ed63STejun Heo __acquires(&pool->lock)
2453e22bee78STejun Heo {
2454e22bee78STejun Heo restart:
2455a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
24569f9c2364STejun Heo 
2457e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
245863d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2459e22bee78STejun Heo 
2460e22bee78STejun Heo 	while (true) {
2461051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
2462e22bee78STejun Heo 			break;
2463e22bee78STejun Heo 
2464e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
24659f9c2364STejun Heo 
246663d95a91STejun Heo 		if (!need_to_create_worker(pool))
2467e22bee78STejun Heo 			break;
2468e22bee78STejun Heo 	}
2469e22bee78STejun Heo 
247063d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
2471a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2472051e1850SLai Jiangshan 	/*
2473051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
2474051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
2475051e1850SLai Jiangshan 	 * already become busy.
2476051e1850SLai Jiangshan 	 */
247763d95a91STejun Heo 	if (need_to_create_worker(pool))
2478e22bee78STejun Heo 		goto restart;
2479e22bee78STejun Heo }
2480e22bee78STejun Heo 
2481e22bee78STejun Heo /**
2482e22bee78STejun Heo  * manage_workers - manage worker pool
2483e22bee78STejun Heo  * @worker: self
2484e22bee78STejun Heo  *
2485706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
2486e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
2487706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
2488e22bee78STejun Heo  *
2489e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
2490e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
2491e22bee78STejun Heo  * and may_start_working() is true.
2492e22bee78STejun Heo  *
2493e22bee78STejun Heo  * CONTEXT:
2494a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2495e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
2496e22bee78STejun Heo  *
2497d185af30SYacine Belkadi  * Return:
249829187a9eSTejun Heo  * %false if the pool doesn't need management and the caller can safely
249929187a9eSTejun Heo  * start processing works, %true if management function was performed and
250029187a9eSTejun Heo  * the conditions that the caller verified before calling the function may
250129187a9eSTejun Heo  * no longer be true.
2502e22bee78STejun Heo  */
2503e22bee78STejun Heo static bool manage_workers(struct worker *worker)
2504e22bee78STejun Heo {
250563d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
2506e22bee78STejun Heo 
2507692b4825STejun Heo 	if (pool->flags & POOL_MANAGER_ACTIVE)
250829187a9eSTejun Heo 		return false;
2509692b4825STejun Heo 
2510692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
25112607d7a6STejun Heo 	pool->manager = worker;
2512e22bee78STejun Heo 
251329187a9eSTejun Heo 	maybe_create_worker(pool);
2514e22bee78STejun Heo 
25152607d7a6STejun Heo 	pool->manager = NULL;
2516692b4825STejun Heo 	pool->flags &= ~POOL_MANAGER_ACTIVE;
2517d8bb65abSSebastian Andrzej Siewior 	rcuwait_wake_up(&manager_wait);
251829187a9eSTejun Heo 	return true;
2519e22bee78STejun Heo }
2520e22bee78STejun Heo 
2521a62428c0STejun Heo /**
2522a62428c0STejun Heo  * process_one_work - process single work
2523c34056a3STejun Heo  * @worker: self
2524a62428c0STejun Heo  * @work: work to process
2525a62428c0STejun Heo  *
2526a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
2527a62428c0STejun Heo  * process a single work including synchronization against and
2528a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
2529a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
2530a62428c0STejun Heo  * call this function to process a work.
2531a62428c0STejun Heo  *
2532a62428c0STejun Heo  * CONTEXT:
2533a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
2534a62428c0STejun Heo  */
2535c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
2536d565ed63STejun Heo __releases(&pool->lock)
2537d565ed63STejun Heo __acquires(&pool->lock)
25381da177e4SLinus Torvalds {
2539112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2540bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2541c4560c2cSLai Jiangshan 	unsigned long work_data;
25424e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
25434e6045f1SJohannes Berg 	/*
2544a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
2545a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
2546a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
2547a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
2548a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
25494e6045f1SJohannes Berg 	 */
25504d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
25514d82a1deSPeter Zijlstra 
25524d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
25534e6045f1SJohannes Berg #endif
2554807407c0SLai Jiangshan 	/* ensure we're on the correct CPU */
255585327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
2556ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
255725511a47STejun Heo 
25588930cabaSTejun Heo 	/* claim and dequeue */
2559dc186ad7SThomas Gleixner 	debug_work_deactivate(work);
2560c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2561c34056a3STejun Heo 	worker->current_work = work;
2562a2c1c57bSTejun Heo 	worker->current_func = work->func;
2563112202d9STejun Heo 	worker->current_pwq = pwq;
2564616db877STejun Heo 	worker->current_at = worker->task->se.sum_exec_runtime;
2565c4560c2cSLai Jiangshan 	work_data = *work_data_bits(work);
2566d812796eSLai Jiangshan 	worker->current_color = get_work_color(work_data);
25677a22ad75STejun Heo 
25688bf89593STejun Heo 	/*
25698bf89593STejun Heo 	 * Record wq name for cmdline and debug reporting, may get
25708bf89593STejun Heo 	 * overridden through set_worker_desc().
25718bf89593STejun Heo 	 */
25728bf89593STejun Heo 	strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
25738bf89593STejun Heo 
2574a62428c0STejun Heo 	list_del_init(&work->entry);
2575a62428c0STejun Heo 
2576649027d7STejun Heo 	/*
2577228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
2578228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
2579228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
2580228f1d00SLai Jiangshan 	 * execution of the pending work items.
2581fb0e7bebSTejun Heo 	 */
2582616db877STejun Heo 	if (unlikely(pwq->wq->flags & WQ_CPU_INTENSIVE))
2583228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
2584fb0e7bebSTejun Heo 
2585974271c4STejun Heo 	/*
25860219a352STejun Heo 	 * Kick @pool if necessary. It's always noop for per-cpu worker pools
25870219a352STejun Heo 	 * since nr_running would always be >= 1 at this point. This is used to
25880219a352STejun Heo 	 * chain execution of the pending work items for WORKER_NOT_RUNNING
25890219a352STejun Heo 	 * workers such as the UNBOUND and CPU_INTENSIVE ones.
2590974271c4STejun Heo 	 */
25910219a352STejun Heo 	kick_pool(pool);
2592974271c4STejun Heo 
25938930cabaSTejun Heo 	/*
25947c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
2595d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
259623657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
259723657bb1STejun Heo 	 * disabled.
25988930cabaSTejun Heo 	 */
25997c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
26001da177e4SLinus Torvalds 
2601a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2602365970a1SDavid Howells 
2603a1d14934SPeter Zijlstra 	lock_map_acquire(&pwq->wq->lockdep_map);
26043295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
2605e6f3faa7SPeter Zijlstra 	/*
2606f52be570SPeter Zijlstra 	 * Strictly speaking we should mark the invariant state without holding
2607f52be570SPeter Zijlstra 	 * any locks, that is, before these two lock_map_acquire()'s.
2608e6f3faa7SPeter Zijlstra 	 *
2609e6f3faa7SPeter Zijlstra 	 * However, that would result in:
2610e6f3faa7SPeter Zijlstra 	 *
2611e6f3faa7SPeter Zijlstra 	 *   A(W1)
2612e6f3faa7SPeter Zijlstra 	 *   WFC(C)
2613e6f3faa7SPeter Zijlstra 	 *		A(W1)
2614e6f3faa7SPeter Zijlstra 	 *		C(C)
2615e6f3faa7SPeter Zijlstra 	 *
2616e6f3faa7SPeter Zijlstra 	 * Which would create W1->C->W1 dependencies, even though there is no
2617e6f3faa7SPeter Zijlstra 	 * actual deadlock possible. There are two solutions, using a
2618e6f3faa7SPeter Zijlstra 	 * read-recursive acquire on the work(queue) 'locks', but this will then
2619f52be570SPeter Zijlstra 	 * hit the lockdep limitation on recursive locks, or simply discard
2620e6f3faa7SPeter Zijlstra 	 * these locks.
2621e6f3faa7SPeter Zijlstra 	 *
2622e6f3faa7SPeter Zijlstra 	 * AFAICT there is no possible deadlock scenario between the
2623e6f3faa7SPeter Zijlstra 	 * flush_work() and complete() primitives (except for single-threaded
2624e6f3faa7SPeter Zijlstra 	 * workqueues), so hiding them isn't a problem.
2625e6f3faa7SPeter Zijlstra 	 */
2626f52be570SPeter Zijlstra 	lockdep_invariant_state(true);
2627725e8ec5STejun Heo 	pwq->stats[PWQ_STAT_STARTED]++;
2628e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
2629a2c1c57bSTejun Heo 	worker->current_func(work);
2630e36c886aSArjan van de Ven 	/*
2631e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
2632e36c886aSArjan van de Ven 	 * point will only record its address.
2633e36c886aSArjan van de Ven 	 */
26341c5da0ecSDaniel Jordan 	trace_workqueue_execute_end(work, worker->current_func);
2635725e8ec5STejun Heo 	pwq->stats[PWQ_STAT_COMPLETED]++;
26363295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
2637112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
26381da177e4SLinus Torvalds 
2639d5abe669SPeter Zijlstra 	if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2640044c782cSValentin Ilie 		pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2641d75f773cSSakari Ailus 		       "     last function: %ps\n",
2642a2c1c57bSTejun Heo 		       current->comm, preempt_count(), task_pid_nr(current),
2643a2c1c57bSTejun Heo 		       worker->current_func);
2644d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
2645d5abe669SPeter Zijlstra 		dump_stack();
2646d5abe669SPeter Zijlstra 	}
2647d5abe669SPeter Zijlstra 
2648b22ce278STejun Heo 	/*
2649025f50f3SSebastian Andrzej Siewior 	 * The following prevents a kworker from hogging CPU on !PREEMPTION
2650b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
2651b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
2652b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
2653789cbbecSJoe Lawrence 	 * stop_machine. At the same time, report a quiescent RCU state so
2654789cbbecSJoe Lawrence 	 * the same condition doesn't freeze RCU.
2655b22ce278STejun Heo 	 */
2656a7e6425eSPaul E. McKenney 	cond_resched();
2657b22ce278STejun Heo 
2658a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2659a62428c0STejun Heo 
2660616db877STejun Heo 	/*
2661616db877STejun Heo 	 * In addition to %WQ_CPU_INTENSIVE, @worker may also have been marked
2662616db877STejun Heo 	 * CPU intensive by wq_worker_tick() if @work hogged CPU longer than
2663616db877STejun Heo 	 * wq_cpu_intensive_thresh_us. Clear it.
2664616db877STejun Heo 	 */
2665fb0e7bebSTejun Heo 	worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2666fb0e7bebSTejun Heo 
26671b69ac6bSJohannes Weiner 	/* tag the worker for identification in schedule() */
26681b69ac6bSJohannes Weiner 	worker->last_func = worker->current_func;
26691b69ac6bSJohannes Weiner 
2670a62428c0STejun Heo 	/* we're done with it, release */
267142f8570fSSasha Levin 	hash_del(&worker->hentry);
2672c34056a3STejun Heo 	worker->current_work = NULL;
2673a2c1c57bSTejun Heo 	worker->current_func = NULL;
2674112202d9STejun Heo 	worker->current_pwq = NULL;
2675d812796eSLai Jiangshan 	worker->current_color = INT_MAX;
2676c4560c2cSLai Jiangshan 	pwq_dec_nr_in_flight(pwq, work_data);
26771da177e4SLinus Torvalds }
26781da177e4SLinus Torvalds 
2679affee4b2STejun Heo /**
2680affee4b2STejun Heo  * process_scheduled_works - process scheduled works
2681affee4b2STejun Heo  * @worker: self
2682affee4b2STejun Heo  *
2683affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
2684affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
2685affee4b2STejun Heo  * fetches a work from the top and executes it.
2686affee4b2STejun Heo  *
2687affee4b2STejun Heo  * CONTEXT:
2688a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2689affee4b2STejun Heo  * multiple times.
2690affee4b2STejun Heo  */
2691affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
26921da177e4SLinus Torvalds {
2693c0ab017dSTejun Heo 	struct work_struct *work;
2694c0ab017dSTejun Heo 	bool first = true;
2695c0ab017dSTejun Heo 
2696c0ab017dSTejun Heo 	while ((work = list_first_entry_or_null(&worker->scheduled,
2697c0ab017dSTejun Heo 						struct work_struct, entry))) {
2698c0ab017dSTejun Heo 		if (first) {
2699c0ab017dSTejun Heo 			worker->pool->watchdog_ts = jiffies;
2700c0ab017dSTejun Heo 			first = false;
2701c0ab017dSTejun Heo 		}
2702c34056a3STejun Heo 		process_one_work(worker, work);
2703a62428c0STejun Heo 	}
27041da177e4SLinus Torvalds }
27051da177e4SLinus Torvalds 
2706197f6accSTejun Heo static void set_pf_worker(bool val)
2707197f6accSTejun Heo {
2708197f6accSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
2709197f6accSTejun Heo 	if (val)
2710197f6accSTejun Heo 		current->flags |= PF_WQ_WORKER;
2711197f6accSTejun Heo 	else
2712197f6accSTejun Heo 		current->flags &= ~PF_WQ_WORKER;
2713197f6accSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
2714197f6accSTejun Heo }
2715197f6accSTejun Heo 
27164690c4abSTejun Heo /**
27174690c4abSTejun Heo  * worker_thread - the worker thread function
2718c34056a3STejun Heo  * @__worker: self
27194690c4abSTejun Heo  *
2720c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
2721c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
2722c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
2723c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
2724c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
2725d185af30SYacine Belkadi  *
2726d185af30SYacine Belkadi  * Return: 0
27274690c4abSTejun Heo  */
2728c34056a3STejun Heo static int worker_thread(void *__worker)
27291da177e4SLinus Torvalds {
2730c34056a3STejun Heo 	struct worker *worker = __worker;
2731bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
27321da177e4SLinus Torvalds 
2733e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
2734197f6accSTejun Heo 	set_pf_worker(true);
2735c8e55f36STejun Heo woke_up:
2736a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2737affee4b2STejun Heo 
2738a9ab775bSTejun Heo 	/* am I supposed to die? */
2739a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
2740a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
2741197f6accSTejun Heo 		set_pf_worker(false);
274260f5a4bcSLai Jiangshan 
274360f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
2744e441b56fSZhen Lei 		ida_free(&pool->worker_ida, worker->id);
2745a2d812a2STejun Heo 		worker_detach_from_pool(worker);
2746e02b9312SValentin Schneider 		WARN_ON_ONCE(!list_empty(&worker->entry));
274760f5a4bcSLai Jiangshan 		kfree(worker);
2748c8e55f36STejun Heo 		return 0;
2749c8e55f36STejun Heo 	}
2750c8e55f36STejun Heo 
2751c8e55f36STejun Heo 	worker_leave_idle(worker);
2752db7bccf4STejun Heo recheck:
2753e22bee78STejun Heo 	/* no more worker necessary? */
275463d95a91STejun Heo 	if (!need_more_worker(pool))
2755e22bee78STejun Heo 		goto sleep;
2756e22bee78STejun Heo 
2757e22bee78STejun Heo 	/* do we need to manage? */
275863d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2759e22bee78STejun Heo 		goto recheck;
2760e22bee78STejun Heo 
2761c8e55f36STejun Heo 	/*
2762c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
2763c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
2764c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
2765c8e55f36STejun Heo 	 */
27666183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
2767c8e55f36STejun Heo 
2768e22bee78STejun Heo 	/*
2769a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
2770a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
2771a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
2772a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
2773a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
2774e22bee78STejun Heo 	 */
2775a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2776e22bee78STejun Heo 
2777e22bee78STejun Heo 	do {
2778affee4b2STejun Heo 		struct work_struct *work =
2779bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
2780affee4b2STejun Heo 					 struct work_struct, entry);
2781affee4b2STejun Heo 
2782873eaca6STejun Heo 		if (assign_work(work, worker, NULL))
2783affee4b2STejun Heo 			process_scheduled_works(worker);
278463d95a91STejun Heo 	} while (keep_working(pool));
2785affee4b2STejun Heo 
2786228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
2787d313dd85STejun Heo sleep:
2788c8e55f36STejun Heo 	/*
2789d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
2790d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
2791d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
2792d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
2793d565ed63STejun Heo 	 * event.
2794c8e55f36STejun Heo 	 */
2795c8e55f36STejun Heo 	worker_enter_idle(worker);
2796c5a94a61SPeter Zijlstra 	__set_current_state(TASK_IDLE);
2797a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
27981da177e4SLinus Torvalds 	schedule();
2799c8e55f36STejun Heo 	goto woke_up;
28001da177e4SLinus Torvalds }
28011da177e4SLinus Torvalds 
2802e22bee78STejun Heo /**
2803e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
2804111c225aSTejun Heo  * @__rescuer: self
2805e22bee78STejun Heo  *
2806e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
2807493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
2808e22bee78STejun Heo  *
2809706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
2810e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
2811e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
2812e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2813e22bee78STejun Heo  * the problem rescuer solves.
2814e22bee78STejun Heo  *
2815706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
2816706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
2817e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
2818e22bee78STejun Heo  *
2819e22bee78STejun Heo  * This should happen rarely.
2820d185af30SYacine Belkadi  *
2821d185af30SYacine Belkadi  * Return: 0
2822e22bee78STejun Heo  */
2823111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
2824e22bee78STejun Heo {
2825111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
2826111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
28274d595b86SLai Jiangshan 	bool should_stop;
2828e22bee78STejun Heo 
2829e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
2830111c225aSTejun Heo 
2831111c225aSTejun Heo 	/*
2832111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2833111c225aSTejun Heo 	 * doesn't participate in concurrency management.
2834111c225aSTejun Heo 	 */
2835197f6accSTejun Heo 	set_pf_worker(true);
2836e22bee78STejun Heo repeat:
2837c5a94a61SPeter Zijlstra 	set_current_state(TASK_IDLE);
28381da177e4SLinus Torvalds 
28394d595b86SLai Jiangshan 	/*
28404d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
28414d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
28424d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
28434d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
28444d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
28454d595b86SLai Jiangshan 	 * list is always empty on exit.
28464d595b86SLai Jiangshan 	 */
28474d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
28481da177e4SLinus Torvalds 
2849493a1724STejun Heo 	/* see whether any pwq is asking for help */
2850a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&wq_mayday_lock);
2851493a1724STejun Heo 
2852493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
2853493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2854493a1724STejun Heo 					struct pool_workqueue, mayday_node);
2855112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
2856e22bee78STejun Heo 		struct work_struct *work, *n;
2857e22bee78STejun Heo 
2858e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
2859493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
2860493a1724STejun Heo 
2861a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
2862e22bee78STejun Heo 
286351697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
286451697d39SLai Jiangshan 
2865a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
2866e22bee78STejun Heo 
2867e22bee78STejun Heo 		/*
2868e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
2869e22bee78STejun Heo 		 * process'em.
2870e22bee78STejun Heo 		 */
2871873eaca6STejun Heo 		WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
287282607adcSTejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2873873eaca6STejun Heo 			if (get_work_pwq(work) == pwq &&
2874873eaca6STejun Heo 			    assign_work(work, rescuer, &n))
2875725e8ec5STejun Heo 				pwq->stats[PWQ_STAT_RESCUED]++;
287682607adcSTejun Heo 		}
2877e22bee78STejun Heo 
2878873eaca6STejun Heo 		if (!list_empty(&rescuer->scheduled)) {
2879e22bee78STejun Heo 			process_scheduled_works(rescuer);
28807576958aSTejun Heo 
28817576958aSTejun Heo 			/*
2882008847f6SNeilBrown 			 * The above execution of rescued work items could
2883008847f6SNeilBrown 			 * have created more to rescue through
2884f97a4a1aSLai Jiangshan 			 * pwq_activate_first_inactive() or chained
2885008847f6SNeilBrown 			 * queueing.  Let's put @pwq back on mayday list so
2886008847f6SNeilBrown 			 * that such back-to-back work items, which may be
2887008847f6SNeilBrown 			 * being used to relieve memory pressure, don't
2888008847f6SNeilBrown 			 * incur MAYDAY_INTERVAL delay inbetween.
2889008847f6SNeilBrown 			 */
28904f3f4cf3SLai Jiangshan 			if (pwq->nr_active && need_to_create_worker(pool)) {
2891a9b8a985SSebastian Andrzej Siewior 				raw_spin_lock(&wq_mayday_lock);
2892e66b39afSTejun Heo 				/*
2893e66b39afSTejun Heo 				 * Queue iff we aren't racing destruction
2894e66b39afSTejun Heo 				 * and somebody else hasn't queued it already.
2895e66b39afSTejun Heo 				 */
2896e66b39afSTejun Heo 				if (wq->rescuer && list_empty(&pwq->mayday_node)) {
2897008847f6SNeilBrown 					get_pwq(pwq);
2898e66b39afSTejun Heo 					list_add_tail(&pwq->mayday_node, &wq->maydays);
2899e66b39afSTejun Heo 				}
2900a9b8a985SSebastian Andrzej Siewior 				raw_spin_unlock(&wq_mayday_lock);
2901008847f6SNeilBrown 			}
2902008847f6SNeilBrown 		}
2903008847f6SNeilBrown 
2904008847f6SNeilBrown 		/*
290577668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
290613b1d625SLai Jiangshan 		 * go away while we're still attached to it.
290777668c8bSLai Jiangshan 		 */
290877668c8bSLai Jiangshan 		put_pwq(pwq);
290977668c8bSLai Jiangshan 
291077668c8bSLai Jiangshan 		/*
29110219a352STejun Heo 		 * Leave this pool. Notify regular workers; otherwise, we end up
29120219a352STejun Heo 		 * with 0 concurrency and stalling the execution.
29137576958aSTejun Heo 		 */
29140219a352STejun Heo 		kick_pool(pool);
29157576958aSTejun Heo 
2916a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
291713b1d625SLai Jiangshan 
2918a2d812a2STejun Heo 		worker_detach_from_pool(rescuer);
291913b1d625SLai Jiangshan 
2920a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
29211da177e4SLinus Torvalds 	}
29221da177e4SLinus Torvalds 
2923a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&wq_mayday_lock);
2924493a1724STejun Heo 
29254d595b86SLai Jiangshan 	if (should_stop) {
29264d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
2927197f6accSTejun Heo 		set_pf_worker(false);
29284d595b86SLai Jiangshan 		return 0;
29294d595b86SLai Jiangshan 	}
29304d595b86SLai Jiangshan 
2931111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
2932111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2933e22bee78STejun Heo 	schedule();
2934e22bee78STejun Heo 	goto repeat;
29351da177e4SLinus Torvalds }
29361da177e4SLinus Torvalds 
2937fca839c0STejun Heo /**
2938fca839c0STejun Heo  * check_flush_dependency - check for flush dependency sanity
2939fca839c0STejun Heo  * @target_wq: workqueue being flushed
2940fca839c0STejun Heo  * @target_work: work item being flushed (NULL for workqueue flushes)
2941fca839c0STejun Heo  *
2942fca839c0STejun Heo  * %current is trying to flush the whole @target_wq or @target_work on it.
2943fca839c0STejun Heo  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2944fca839c0STejun Heo  * reclaiming memory or running on a workqueue which doesn't have
2945fca839c0STejun Heo  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2946fca839c0STejun Heo  * a deadlock.
2947fca839c0STejun Heo  */
2948fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq,
2949fca839c0STejun Heo 				   struct work_struct *target_work)
2950fca839c0STejun Heo {
2951fca839c0STejun Heo 	work_func_t target_func = target_work ? target_work->func : NULL;
2952fca839c0STejun Heo 	struct worker *worker;
2953fca839c0STejun Heo 
2954fca839c0STejun Heo 	if (target_wq->flags & WQ_MEM_RECLAIM)
2955fca839c0STejun Heo 		return;
2956fca839c0STejun Heo 
2957fca839c0STejun Heo 	worker = current_wq_worker();
2958fca839c0STejun Heo 
2959fca839c0STejun Heo 	WARN_ONCE(current->flags & PF_MEMALLOC,
2960d75f773cSSakari Ailus 		  "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
2961fca839c0STejun Heo 		  current->pid, current->comm, target_wq->name, target_func);
296223d11a58STejun Heo 	WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
296323d11a58STejun Heo 			      (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
2964d75f773cSSakari Ailus 		  "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
2965fca839c0STejun Heo 		  worker->current_pwq->wq->name, worker->current_func,
2966fca839c0STejun Heo 		  target_wq->name, target_func);
2967fca839c0STejun Heo }
2968fca839c0STejun Heo 
2969fc2e4d70SOleg Nesterov struct wq_barrier {
2970fc2e4d70SOleg Nesterov 	struct work_struct	work;
2971fc2e4d70SOleg Nesterov 	struct completion	done;
29722607d7a6STejun Heo 	struct task_struct	*task;	/* purely informational */
2973fc2e4d70SOleg Nesterov };
2974fc2e4d70SOleg Nesterov 
2975fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
2976fc2e4d70SOleg Nesterov {
2977fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2978fc2e4d70SOleg Nesterov 	complete(&barr->done);
2979fc2e4d70SOleg Nesterov }
2980fc2e4d70SOleg Nesterov 
29814690c4abSTejun Heo /**
29824690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
2983112202d9STejun Heo  * @pwq: pwq to insert barrier into
29844690c4abSTejun Heo  * @barr: wq_barrier to insert
2985affee4b2STejun Heo  * @target: target work to attach @barr to
2986affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
29874690c4abSTejun Heo  *
2988affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
2989affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
2990affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
2991affee4b2STejun Heo  * cpu.
2992affee4b2STejun Heo  *
2993affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
2994affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
2995affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
2996affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
2997affee4b2STejun Heo  * after a work with LINKED flag set.
2998affee4b2STejun Heo  *
2999affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
3000112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
30014690c4abSTejun Heo  *
30024690c4abSTejun Heo  * CONTEXT:
3003a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
30044690c4abSTejun Heo  */
3005112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
3006affee4b2STejun Heo 			      struct wq_barrier *barr,
3007affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
3008fc2e4d70SOleg Nesterov {
3009d812796eSLai Jiangshan 	unsigned int work_flags = 0;
3010d812796eSLai Jiangshan 	unsigned int work_color;
3011affee4b2STejun Heo 	struct list_head *head;
3012affee4b2STejun Heo 
3013dc186ad7SThomas Gleixner 	/*
3014d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
3015dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
3016dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
3017dc186ad7SThomas Gleixner 	 * might deadlock.
3018dc186ad7SThomas Gleixner 	 */
3019ca1cab37SAndrew Morton 	INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
302022df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
302152fa5bc5SBoqun Feng 
3022fd1a5b04SByungchul Park 	init_completion_map(&barr->done, &target->lockdep_map);
3023fd1a5b04SByungchul Park 
30242607d7a6STejun Heo 	barr->task = current;
302583c22520SOleg Nesterov 
3026018f3a13SLai Jiangshan 	/* The barrier work item does not participate in pwq->nr_active. */
3027018f3a13SLai Jiangshan 	work_flags |= WORK_STRUCT_INACTIVE;
3028018f3a13SLai Jiangshan 
3029affee4b2STejun Heo 	/*
3030affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
3031affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
3032affee4b2STejun Heo 	 */
3033d812796eSLai Jiangshan 	if (worker) {
3034affee4b2STejun Heo 		head = worker->scheduled.next;
3035d812796eSLai Jiangshan 		work_color = worker->current_color;
3036d812796eSLai Jiangshan 	} else {
3037affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
3038affee4b2STejun Heo 
3039affee4b2STejun Heo 		head = target->entry.next;
3040affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
3041d21cece0SLai Jiangshan 		work_flags |= *bits & WORK_STRUCT_LINKED;
3042d812796eSLai Jiangshan 		work_color = get_work_color(*bits);
3043affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
3044affee4b2STejun Heo 	}
3045affee4b2STejun Heo 
3046d812796eSLai Jiangshan 	pwq->nr_in_flight[work_color]++;
3047d812796eSLai Jiangshan 	work_flags |= work_color_to_flags(work_color);
3048d812796eSLai Jiangshan 
3049d21cece0SLai Jiangshan 	insert_work(pwq, &barr->work, head, work_flags);
3050fc2e4d70SOleg Nesterov }
3051fc2e4d70SOleg Nesterov 
305273f53c4aSTejun Heo /**
3053112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
305473f53c4aSTejun Heo  * @wq: workqueue being flushed
305573f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
305673f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
305773f53c4aSTejun Heo  *
3058112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
305973f53c4aSTejun Heo  *
3060112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
3061112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
3062112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
3063112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
3064112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
306573f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
306673f53c4aSTejun Heo  *
306773f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
306873f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
306973f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
307073f53c4aSTejun Heo  * is returned.
307173f53c4aSTejun Heo  *
3072112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
307373f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
307473f53c4aSTejun Heo  * advanced to @work_color.
307573f53c4aSTejun Heo  *
307673f53c4aSTejun Heo  * CONTEXT:
30773c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
307873f53c4aSTejun Heo  *
3079d185af30SYacine Belkadi  * Return:
308073f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
308173f53c4aSTejun Heo  * otherwise.
308273f53c4aSTejun Heo  */
3083112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
308473f53c4aSTejun Heo 				      int flush_color, int work_color)
30851da177e4SLinus Torvalds {
308673f53c4aSTejun Heo 	bool wait = false;
308749e3cf44STejun Heo 	struct pool_workqueue *pwq;
30881da177e4SLinus Torvalds 
308973f53c4aSTejun Heo 	if (flush_color >= 0) {
30906183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
3091112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
3092dc186ad7SThomas Gleixner 	}
309314441960SOleg Nesterov 
309449e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3095112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
30961da177e4SLinus Torvalds 
3097a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
309873f53c4aSTejun Heo 
309973f53c4aSTejun Heo 		if (flush_color >= 0) {
31006183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
310173f53c4aSTejun Heo 
3102112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
3103112202d9STejun Heo 				pwq->flush_color = flush_color;
3104112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
310573f53c4aSTejun Heo 				wait = true;
31061da177e4SLinus Torvalds 			}
310773f53c4aSTejun Heo 		}
310873f53c4aSTejun Heo 
310973f53c4aSTejun Heo 		if (work_color >= 0) {
31106183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
3111112202d9STejun Heo 			pwq->work_color = work_color;
311273f53c4aSTejun Heo 		}
311373f53c4aSTejun Heo 
3114a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
31151da177e4SLinus Torvalds 	}
31161da177e4SLinus Torvalds 
3117112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
311873f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
311973f53c4aSTejun Heo 
312073f53c4aSTejun Heo 	return wait;
312183c22520SOleg Nesterov }
31221da177e4SLinus Torvalds 
31230fcb78c2SRolf Eike Beer /**
3124c4f135d6STetsuo Handa  * __flush_workqueue - ensure that any scheduled work has run to completion.
31250fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
31261da177e4SLinus Torvalds  *
3127c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
3128c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
31291da177e4SLinus Torvalds  */
3130c4f135d6STetsuo Handa void __flush_workqueue(struct workqueue_struct *wq)
31311da177e4SLinus Torvalds {
313273f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
313373f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
313473f53c4aSTejun Heo 		.flush_color = -1,
3135fd1a5b04SByungchul Park 		.done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
313673f53c4aSTejun Heo 	};
313773f53c4aSTejun Heo 	int next_color;
3138b1f4ec17SOleg Nesterov 
31393347fa09STejun Heo 	if (WARN_ON(!wq_online))
31403347fa09STejun Heo 		return;
31413347fa09STejun Heo 
314287915adcSJohannes Berg 	lock_map_acquire(&wq->lockdep_map);
314387915adcSJohannes Berg 	lock_map_release(&wq->lockdep_map);
314487915adcSJohannes Berg 
31453c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
314673f53c4aSTejun Heo 
314773f53c4aSTejun Heo 	/*
314873f53c4aSTejun Heo 	 * Start-to-wait phase
314973f53c4aSTejun Heo 	 */
315073f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
315173f53c4aSTejun Heo 
315273f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
315373f53c4aSTejun Heo 		/*
315473f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
315573f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
315673f53c4aSTejun Heo 		 * by one.
315773f53c4aSTejun Heo 		 */
31586183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
315973f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
316073f53c4aSTejun Heo 		wq->work_color = next_color;
316173f53c4aSTejun Heo 
316273f53c4aSTejun Heo 		if (!wq->first_flusher) {
316373f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
31646183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
316573f53c4aSTejun Heo 
316673f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
316773f53c4aSTejun Heo 
3168112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
316973f53c4aSTejun Heo 						       wq->work_color)) {
317073f53c4aSTejun Heo 				/* nothing to flush, done */
317173f53c4aSTejun Heo 				wq->flush_color = next_color;
317273f53c4aSTejun Heo 				wq->first_flusher = NULL;
317373f53c4aSTejun Heo 				goto out_unlock;
317473f53c4aSTejun Heo 			}
317573f53c4aSTejun Heo 		} else {
317673f53c4aSTejun Heo 			/* wait in queue */
31776183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
317873f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
3179112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
318073f53c4aSTejun Heo 		}
318173f53c4aSTejun Heo 	} else {
318273f53c4aSTejun Heo 		/*
318373f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
318473f53c4aSTejun Heo 		 * The next flush completion will assign us
318573f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
318673f53c4aSTejun Heo 		 */
318773f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
318873f53c4aSTejun Heo 	}
318973f53c4aSTejun Heo 
3190fca839c0STejun Heo 	check_flush_dependency(wq, NULL);
3191fca839c0STejun Heo 
31923c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
319373f53c4aSTejun Heo 
319473f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
319573f53c4aSTejun Heo 
319673f53c4aSTejun Heo 	/*
319773f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
319873f53c4aSTejun Heo 	 *
319973f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
320073f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
320173f53c4aSTejun Heo 	 */
320200d5d15bSChris Wilson 	if (READ_ONCE(wq->first_flusher) != &this_flusher)
320373f53c4aSTejun Heo 		return;
320473f53c4aSTejun Heo 
32053c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
320673f53c4aSTejun Heo 
32074ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
32084ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
32094ce48b37STejun Heo 		goto out_unlock;
32104ce48b37STejun Heo 
321100d5d15bSChris Wilson 	WRITE_ONCE(wq->first_flusher, NULL);
321273f53c4aSTejun Heo 
32136183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
32146183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
321573f53c4aSTejun Heo 
321673f53c4aSTejun Heo 	while (true) {
321773f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
321873f53c4aSTejun Heo 
321973f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
322073f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
322173f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
322273f53c4aSTejun Heo 				break;
322373f53c4aSTejun Heo 			list_del_init(&next->list);
322473f53c4aSTejun Heo 			complete(&next->done);
322573f53c4aSTejun Heo 		}
322673f53c4aSTejun Heo 
32276183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
322873f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
322973f53c4aSTejun Heo 
323073f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
323173f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
323273f53c4aSTejun Heo 
323373f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
323473f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
323573f53c4aSTejun Heo 			/*
323673f53c4aSTejun Heo 			 * Assign the same color to all overflowed
323773f53c4aSTejun Heo 			 * flushers, advance work_color and append to
323873f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
323973f53c4aSTejun Heo 			 * phase for these overflowed flushers.
324073f53c4aSTejun Heo 			 */
324173f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
324273f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
324373f53c4aSTejun Heo 
324473f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
324573f53c4aSTejun Heo 
324673f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
324773f53c4aSTejun Heo 					      &wq->flusher_queue);
3248112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
324973f53c4aSTejun Heo 		}
325073f53c4aSTejun Heo 
325173f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
32526183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
325373f53c4aSTejun Heo 			break;
325473f53c4aSTejun Heo 		}
325573f53c4aSTejun Heo 
325673f53c4aSTejun Heo 		/*
325773f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
3258112202d9STejun Heo 		 * the new first flusher and arm pwqs.
325973f53c4aSTejun Heo 		 */
32606183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
32616183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
326273f53c4aSTejun Heo 
326373f53c4aSTejun Heo 		list_del_init(&next->list);
326473f53c4aSTejun Heo 		wq->first_flusher = next;
326573f53c4aSTejun Heo 
3266112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
326773f53c4aSTejun Heo 			break;
326873f53c4aSTejun Heo 
326973f53c4aSTejun Heo 		/*
327073f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
327173f53c4aSTejun Heo 		 * flusher and repeat cascading.
327273f53c4aSTejun Heo 		 */
327373f53c4aSTejun Heo 		wq->first_flusher = NULL;
327473f53c4aSTejun Heo 	}
327573f53c4aSTejun Heo 
327673f53c4aSTejun Heo out_unlock:
32773c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
32781da177e4SLinus Torvalds }
3279c4f135d6STetsuo Handa EXPORT_SYMBOL(__flush_workqueue);
32801da177e4SLinus Torvalds 
32819c5a2ba7STejun Heo /**
32829c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
32839c5a2ba7STejun Heo  * @wq: workqueue to drain
32849c5a2ba7STejun Heo  *
32859c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
32869c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
32879c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
3288b749b1b6SChen Hanxiao  * repeatedly until it becomes empty.  The number of flushing is determined
32899c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
32909c5a2ba7STejun Heo  * takes too long.
32919c5a2ba7STejun Heo  */
32929c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
32939c5a2ba7STejun Heo {
32949c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
329549e3cf44STejun Heo 	struct pool_workqueue *pwq;
32969c5a2ba7STejun Heo 
32979c5a2ba7STejun Heo 	/*
32989c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
32999c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
3300618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
33019c5a2ba7STejun Heo 	 */
330287fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
33039c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
3304618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
330587fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
33069c5a2ba7STejun Heo reflush:
3307c4f135d6STetsuo Handa 	__flush_workqueue(wq);
33089c5a2ba7STejun Heo 
3309b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
331076af4d93STejun Heo 
331149e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3312fa2563e4SThomas Tuttle 		bool drained;
33139c5a2ba7STejun Heo 
3314a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
3315f97a4a1aSLai Jiangshan 		drained = !pwq->nr_active && list_empty(&pwq->inactive_works);
3316a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
3317fa2563e4SThomas Tuttle 
3318fa2563e4SThomas Tuttle 		if (drained)
33199c5a2ba7STejun Heo 			continue;
33209c5a2ba7STejun Heo 
33219c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
33229c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
3323e9ad2eb3SStephen Zhang 			pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
3324e9ad2eb3SStephen Zhang 				wq->name, __func__, flush_cnt);
332576af4d93STejun Heo 
3326b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
33279c5a2ba7STejun Heo 		goto reflush;
33289c5a2ba7STejun Heo 	}
33299c5a2ba7STejun Heo 
33309c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
3331618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
333287fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
33339c5a2ba7STejun Heo }
33349c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
33359c5a2ba7STejun Heo 
3336d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
3337d6e89786SJohannes Berg 			     bool from_cancel)
3338baf59022STejun Heo {
3339baf59022STejun Heo 	struct worker *worker = NULL;
3340c9e7cf27STejun Heo 	struct worker_pool *pool;
3341112202d9STejun Heo 	struct pool_workqueue *pwq;
3342baf59022STejun Heo 
3343baf59022STejun Heo 	might_sleep();
3344baf59022STejun Heo 
334524acfb71SThomas Gleixner 	rcu_read_lock();
3346fa1b54e6STejun Heo 	pool = get_work_pool(work);
3347fa1b54e6STejun Heo 	if (!pool) {
334824acfb71SThomas Gleixner 		rcu_read_unlock();
3349fa1b54e6STejun Heo 		return false;
3350fa1b54e6STejun Heo 	}
3351fa1b54e6STejun Heo 
3352a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
33530b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
3354112202d9STejun Heo 	pwq = get_work_pwq(work);
3355112202d9STejun Heo 	if (pwq) {
3356112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
3357baf59022STejun Heo 			goto already_gone;
3358606a5020STejun Heo 	} else {
3359c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
3360baf59022STejun Heo 		if (!worker)
3361baf59022STejun Heo 			goto already_gone;
3362112202d9STejun Heo 		pwq = worker->current_pwq;
3363606a5020STejun Heo 	}
3364baf59022STejun Heo 
3365fca839c0STejun Heo 	check_flush_dependency(pwq->wq, work);
3366fca839c0STejun Heo 
3367112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
3368a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
3369baf59022STejun Heo 
3370e159489bSTejun Heo 	/*
3371a1d14934SPeter Zijlstra 	 * Force a lock recursion deadlock when using flush_work() inside a
3372a1d14934SPeter Zijlstra 	 * single-threaded or rescuer equipped workqueue.
3373a1d14934SPeter Zijlstra 	 *
3374a1d14934SPeter Zijlstra 	 * For single threaded workqueues the deadlock happens when the work
3375a1d14934SPeter Zijlstra 	 * is after the work issuing the flush_work(). For rescuer equipped
3376a1d14934SPeter Zijlstra 	 * workqueues the deadlock happens when the rescuer stalls, blocking
3377a1d14934SPeter Zijlstra 	 * forward progress.
3378e159489bSTejun Heo 	 */
3379d6e89786SJohannes Berg 	if (!from_cancel &&
3380d6e89786SJohannes Berg 	    (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
3381112202d9STejun Heo 		lock_map_acquire(&pwq->wq->lockdep_map);
3382112202d9STejun Heo 		lock_map_release(&pwq->wq->lockdep_map);
3383a1d14934SPeter Zijlstra 	}
338424acfb71SThomas Gleixner 	rcu_read_unlock();
3385baf59022STejun Heo 	return true;
3386baf59022STejun Heo already_gone:
3387a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
338824acfb71SThomas Gleixner 	rcu_read_unlock();
3389baf59022STejun Heo 	return false;
3390baf59022STejun Heo }
3391baf59022STejun Heo 
3392d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel)
3393d6e89786SJohannes Berg {
3394d6e89786SJohannes Berg 	struct wq_barrier barr;
3395d6e89786SJohannes Berg 
3396d6e89786SJohannes Berg 	if (WARN_ON(!wq_online))
3397d6e89786SJohannes Berg 		return false;
3398d6e89786SJohannes Berg 
33994d43d395STetsuo Handa 	if (WARN_ON(!work->func))
34004d43d395STetsuo Handa 		return false;
34014d43d395STetsuo Handa 
340287915adcSJohannes Berg 	lock_map_acquire(&work->lockdep_map);
340387915adcSJohannes Berg 	lock_map_release(&work->lockdep_map);
340487915adcSJohannes Berg 
3405d6e89786SJohannes Berg 	if (start_flush_work(work, &barr, from_cancel)) {
3406d6e89786SJohannes Berg 		wait_for_completion(&barr.done);
3407d6e89786SJohannes Berg 		destroy_work_on_stack(&barr.work);
3408d6e89786SJohannes Berg 		return true;
3409d6e89786SJohannes Berg 	} else {
3410d6e89786SJohannes Berg 		return false;
3411d6e89786SJohannes Berg 	}
3412d6e89786SJohannes Berg }
3413d6e89786SJohannes Berg 
3414db700897SOleg Nesterov /**
3415401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
3416401a8d04STejun Heo  * @work: the work to flush
3417db700897SOleg Nesterov  *
3418606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
3419606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
3420401a8d04STejun Heo  *
3421d185af30SYacine Belkadi  * Return:
3422401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3423401a8d04STejun Heo  * %false if it was already idle.
3424db700897SOleg Nesterov  */
3425401a8d04STejun Heo bool flush_work(struct work_struct *work)
3426db700897SOleg Nesterov {
3427d6e89786SJohannes Berg 	return __flush_work(work, false);
3428606a5020STejun Heo }
3429db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
3430db700897SOleg Nesterov 
34318603e1b3STejun Heo struct cwt_wait {
3432ac6424b9SIngo Molnar 	wait_queue_entry_t		wait;
34338603e1b3STejun Heo 	struct work_struct	*work;
34348603e1b3STejun Heo };
34358603e1b3STejun Heo 
3436ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
34378603e1b3STejun Heo {
34388603e1b3STejun Heo 	struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
34398603e1b3STejun Heo 
34408603e1b3STejun Heo 	if (cwait->work != key)
34418603e1b3STejun Heo 		return 0;
34428603e1b3STejun Heo 	return autoremove_wake_function(wait, mode, sync, key);
34438603e1b3STejun Heo }
34448603e1b3STejun Heo 
344536e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
3446401a8d04STejun Heo {
34478603e1b3STejun Heo 	static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
3448bbb68dfaSTejun Heo 	unsigned long flags;
34491f1f642eSOleg Nesterov 	int ret;
34501f1f642eSOleg Nesterov 
34511f1f642eSOleg Nesterov 	do {
3452bbb68dfaSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &flags);
3453bbb68dfaSTejun Heo 		/*
34548603e1b3STejun Heo 		 * If someone else is already canceling, wait for it to
34558603e1b3STejun Heo 		 * finish.  flush_work() doesn't work for PREEMPT_NONE
34568603e1b3STejun Heo 		 * because we may get scheduled between @work's completion
34578603e1b3STejun Heo 		 * and the other canceling task resuming and clearing
34588603e1b3STejun Heo 		 * CANCELING - flush_work() will return false immediately
34598603e1b3STejun Heo 		 * as @work is no longer busy, try_to_grab_pending() will
34608603e1b3STejun Heo 		 * return -ENOENT as @work is still being canceled and the
34618603e1b3STejun Heo 		 * other canceling task won't be able to clear CANCELING as
34628603e1b3STejun Heo 		 * we're hogging the CPU.
34638603e1b3STejun Heo 		 *
34648603e1b3STejun Heo 		 * Let's wait for completion using a waitqueue.  As this
34658603e1b3STejun Heo 		 * may lead to the thundering herd problem, use a custom
34668603e1b3STejun Heo 		 * wake function which matches @work along with exclusive
34678603e1b3STejun Heo 		 * wait and wakeup.
3468bbb68dfaSTejun Heo 		 */
34698603e1b3STejun Heo 		if (unlikely(ret == -ENOENT)) {
34708603e1b3STejun Heo 			struct cwt_wait cwait;
34718603e1b3STejun Heo 
34728603e1b3STejun Heo 			init_wait(&cwait.wait);
34738603e1b3STejun Heo 			cwait.wait.func = cwt_wakefn;
34748603e1b3STejun Heo 			cwait.work = work;
34758603e1b3STejun Heo 
34768603e1b3STejun Heo 			prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
34778603e1b3STejun Heo 						  TASK_UNINTERRUPTIBLE);
34788603e1b3STejun Heo 			if (work_is_canceling(work))
34798603e1b3STejun Heo 				schedule();
34808603e1b3STejun Heo 			finish_wait(&cancel_waitq, &cwait.wait);
34818603e1b3STejun Heo 		}
34821f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
34831f1f642eSOleg Nesterov 
3484bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
3485bbb68dfaSTejun Heo 	mark_work_canceling(work);
3486bbb68dfaSTejun Heo 	local_irq_restore(flags);
3487bbb68dfaSTejun Heo 
34883347fa09STejun Heo 	/*
34893347fa09STejun Heo 	 * This allows canceling during early boot.  We know that @work
34903347fa09STejun Heo 	 * isn't executing.
34913347fa09STejun Heo 	 */
34923347fa09STejun Heo 	if (wq_online)
3493d6e89786SJohannes Berg 		__flush_work(work, true);
34943347fa09STejun Heo 
34957a22ad75STejun Heo 	clear_work_data(work);
34968603e1b3STejun Heo 
34978603e1b3STejun Heo 	/*
34988603e1b3STejun Heo 	 * Paired with prepare_to_wait() above so that either
34998603e1b3STejun Heo 	 * waitqueue_active() is visible here or !work_is_canceling() is
35008603e1b3STejun Heo 	 * visible there.
35018603e1b3STejun Heo 	 */
35028603e1b3STejun Heo 	smp_mb();
35038603e1b3STejun Heo 	if (waitqueue_active(&cancel_waitq))
35048603e1b3STejun Heo 		__wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
35058603e1b3STejun Heo 
35061f1f642eSOleg Nesterov 	return ret;
35071f1f642eSOleg Nesterov }
35081f1f642eSOleg Nesterov 
35096e84d644SOleg Nesterov /**
3510401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
3511401a8d04STejun Heo  * @work: the work to cancel
35126e84d644SOleg Nesterov  *
3513401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
3514401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
3515401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
3516401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
35171f1f642eSOleg Nesterov  *
3518401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
3519401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
35206e84d644SOleg Nesterov  *
3521401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
35226e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
3523401a8d04STejun Heo  *
3524d185af30SYacine Belkadi  * Return:
3525401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
35266e84d644SOleg Nesterov  */
3527401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
35286e84d644SOleg Nesterov {
352936e227d2STejun Heo 	return __cancel_work_timer(work, false);
3530b89deed3SOleg Nesterov }
353128e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
3532b89deed3SOleg Nesterov 
35336e84d644SOleg Nesterov /**
3534401a8d04STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
3535401a8d04STejun Heo  * @dwork: the delayed work to flush
35366e84d644SOleg Nesterov  *
3537401a8d04STejun Heo  * Delayed timer is cancelled and the pending work is queued for
3538401a8d04STejun Heo  * immediate execution.  Like flush_work(), this function only
3539401a8d04STejun Heo  * considers the last queueing instance of @dwork.
35401f1f642eSOleg Nesterov  *
3541d185af30SYacine Belkadi  * Return:
3542401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
3543401a8d04STejun Heo  * %false if it was already idle.
35446e84d644SOleg Nesterov  */
3545401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
3546401a8d04STejun Heo {
35478930cabaSTejun Heo 	local_irq_disable();
3548401a8d04STejun Heo 	if (del_timer_sync(&dwork->timer))
354960c057bcSLai Jiangshan 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
35508930cabaSTejun Heo 	local_irq_enable();
3551401a8d04STejun Heo 	return flush_work(&dwork->work);
3552401a8d04STejun Heo }
3553401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work);
3554401a8d04STejun Heo 
355505f0fe6bSTejun Heo /**
355605f0fe6bSTejun Heo  * flush_rcu_work - wait for a rwork to finish executing the last queueing
355705f0fe6bSTejun Heo  * @rwork: the rcu work to flush
355805f0fe6bSTejun Heo  *
355905f0fe6bSTejun Heo  * Return:
356005f0fe6bSTejun Heo  * %true if flush_rcu_work() waited for the work to finish execution,
356105f0fe6bSTejun Heo  * %false if it was already idle.
356205f0fe6bSTejun Heo  */
356305f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork)
356405f0fe6bSTejun Heo {
356505f0fe6bSTejun Heo 	if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
356605f0fe6bSTejun Heo 		rcu_barrier();
356705f0fe6bSTejun Heo 		flush_work(&rwork->work);
356805f0fe6bSTejun Heo 		return true;
356905f0fe6bSTejun Heo 	} else {
357005f0fe6bSTejun Heo 		return flush_work(&rwork->work);
357105f0fe6bSTejun Heo 	}
357205f0fe6bSTejun Heo }
357305f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work);
357405f0fe6bSTejun Heo 
3575f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork)
3576f72b8792SJens Axboe {
3577f72b8792SJens Axboe 	unsigned long flags;
3578f72b8792SJens Axboe 	int ret;
3579f72b8792SJens Axboe 
3580f72b8792SJens Axboe 	do {
3581f72b8792SJens Axboe 		ret = try_to_grab_pending(work, is_dwork, &flags);
3582f72b8792SJens Axboe 	} while (unlikely(ret == -EAGAIN));
3583f72b8792SJens Axboe 
3584f72b8792SJens Axboe 	if (unlikely(ret < 0))
3585f72b8792SJens Axboe 		return false;
3586f72b8792SJens Axboe 
3587f72b8792SJens Axboe 	set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3588f72b8792SJens Axboe 	local_irq_restore(flags);
3589f72b8792SJens Axboe 	return ret;
3590f72b8792SJens Axboe }
3591f72b8792SJens Axboe 
359273b4b532SAndrey Grodzovsky /*
359373b4b532SAndrey Grodzovsky  * See cancel_delayed_work()
359473b4b532SAndrey Grodzovsky  */
359573b4b532SAndrey Grodzovsky bool cancel_work(struct work_struct *work)
359673b4b532SAndrey Grodzovsky {
359773b4b532SAndrey Grodzovsky 	return __cancel_work(work, false);
359873b4b532SAndrey Grodzovsky }
359973b4b532SAndrey Grodzovsky EXPORT_SYMBOL(cancel_work);
360073b4b532SAndrey Grodzovsky 
3601401a8d04STejun Heo /**
360257b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
360357b30ae7STejun Heo  * @dwork: delayed_work to cancel
360409383498STejun Heo  *
3605d185af30SYacine Belkadi  * Kill off a pending delayed_work.
3606d185af30SYacine Belkadi  *
3607d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
3608d185af30SYacine Belkadi  * pending.
3609d185af30SYacine Belkadi  *
3610d185af30SYacine Belkadi  * Note:
3611d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
3612d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
3613d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
361409383498STejun Heo  *
361557b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
361609383498STejun Heo  */
361757b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
361809383498STejun Heo {
3619f72b8792SJens Axboe 	return __cancel_work(&dwork->work, true);
362009383498STejun Heo }
362157b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
362209383498STejun Heo 
362309383498STejun Heo /**
3624401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3625401a8d04STejun Heo  * @dwork: the delayed work cancel
3626401a8d04STejun Heo  *
3627401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
3628401a8d04STejun Heo  *
3629d185af30SYacine Belkadi  * Return:
3630401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
3631401a8d04STejun Heo  */
3632401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
36336e84d644SOleg Nesterov {
363436e227d2STejun Heo 	return __cancel_work_timer(&dwork->work, true);
36356e84d644SOleg Nesterov }
3636f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
36371da177e4SLinus Torvalds 
36380fcb78c2SRolf Eike Beer /**
363931ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3640b6136773SAndrew Morton  * @func: the function to call
3641b6136773SAndrew Morton  *
364231ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
364331ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
3644b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
364531ddd871STejun Heo  *
3646d185af30SYacine Belkadi  * Return:
364731ddd871STejun Heo  * 0 on success, -errno on failure.
3648b6136773SAndrew Morton  */
364965f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
365015316ba8SChristoph Lameter {
365115316ba8SChristoph Lameter 	int cpu;
365238f51568SNamhyung Kim 	struct work_struct __percpu *works;
365315316ba8SChristoph Lameter 
3654b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
3655b6136773SAndrew Morton 	if (!works)
365615316ba8SChristoph Lameter 		return -ENOMEM;
3657b6136773SAndrew Morton 
3658ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
365993981800STejun Heo 
366015316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
36619bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
36629bfb1839SIngo Molnar 
36639bfb1839SIngo Molnar 		INIT_WORK(work, func);
36648de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
366515316ba8SChristoph Lameter 	}
366693981800STejun Heo 
366793981800STejun Heo 	for_each_online_cpu(cpu)
36688616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
366993981800STejun Heo 
3670ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
3671b6136773SAndrew Morton 	free_percpu(works);
367215316ba8SChristoph Lameter 	return 0;
367315316ba8SChristoph Lameter }
367415316ba8SChristoph Lameter 
3675eef6a7d5SAlan Stern /**
36761fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
36771fa44ecaSJames Bottomley  * @fn:		the function to execute
36781fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
36791fa44ecaSJames Bottomley  *		be available when the work executes)
36801fa44ecaSJames Bottomley  *
36811fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
36821fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
36831fa44ecaSJames Bottomley  *
3684d185af30SYacine Belkadi  * Return:	0 - function was executed
36851fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
36861fa44ecaSJames Bottomley  */
368765f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
36881fa44ecaSJames Bottomley {
36891fa44ecaSJames Bottomley 	if (!in_interrupt()) {
369065f27f38SDavid Howells 		fn(&ew->work);
36911fa44ecaSJames Bottomley 		return 0;
36921fa44ecaSJames Bottomley 	}
36931fa44ecaSJames Bottomley 
369465f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
36951fa44ecaSJames Bottomley 	schedule_work(&ew->work);
36961fa44ecaSJames Bottomley 
36971fa44ecaSJames Bottomley 	return 1;
36981fa44ecaSJames Bottomley }
36991fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
37001fa44ecaSJames Bottomley 
37017a4e344cSTejun Heo /**
37027a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
37037a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
37047a4e344cSTejun Heo  *
37057a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
37067a4e344cSTejun Heo  */
3707513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs)
37087a4e344cSTejun Heo {
37097a4e344cSTejun Heo 	if (attrs) {
37107a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
37119546b29eSTejun Heo 		free_cpumask_var(attrs->__pod_cpumask);
37127a4e344cSTejun Heo 		kfree(attrs);
37137a4e344cSTejun Heo 	}
37147a4e344cSTejun Heo }
37157a4e344cSTejun Heo 
37167a4e344cSTejun Heo /**
37177a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
37187a4e344cSTejun Heo  *
37197a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
3720d185af30SYacine Belkadi  * return it.
3721d185af30SYacine Belkadi  *
3722d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
37237a4e344cSTejun Heo  */
3724513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void)
37257a4e344cSTejun Heo {
37267a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
37277a4e344cSTejun Heo 
3728be69d00dSThomas Gleixner 	attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
37297a4e344cSTejun Heo 	if (!attrs)
37307a4e344cSTejun Heo 		goto fail;
3731be69d00dSThomas Gleixner 	if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
37327a4e344cSTejun Heo 		goto fail;
37339546b29eSTejun Heo 	if (!alloc_cpumask_var(&attrs->__pod_cpumask, GFP_KERNEL))
37349546b29eSTejun Heo 		goto fail;
37357a4e344cSTejun Heo 
373613e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
373763c5484eSTejun Heo 	attrs->affn_scope = wq_affn_dfl;
37387a4e344cSTejun Heo 	return attrs;
37397a4e344cSTejun Heo fail:
37407a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
37417a4e344cSTejun Heo 	return NULL;
37427a4e344cSTejun Heo }
37437a4e344cSTejun Heo 
374429c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
374529c91e99STejun Heo 				 const struct workqueue_attrs *from)
374629c91e99STejun Heo {
374729c91e99STejun Heo 	to->nice = from->nice;
374829c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
37499546b29eSTejun Heo 	cpumask_copy(to->__pod_cpumask, from->__pod_cpumask);
3750*8639ecebSTejun Heo 	to->affn_strict = from->affn_strict;
375184193c07STejun Heo 
37522865a8fbSShaohua Li 	/*
375384193c07STejun Heo 	 * Unlike hash and equality test, copying shouldn't ignore wq-only
375484193c07STejun Heo 	 * fields as copying is used for both pool and wq attrs. Instead,
375584193c07STejun Heo 	 * get_unbound_pool() explicitly clears the fields.
37562865a8fbSShaohua Li 	 */
375784193c07STejun Heo 	to->affn_scope = from->affn_scope;
3758af73f5c9STejun Heo 	to->ordered = from->ordered;
375929c91e99STejun Heo }
376029c91e99STejun Heo 
37615de7a03cSTejun Heo /*
37625de7a03cSTejun Heo  * Some attrs fields are workqueue-only. Clear them for worker_pool's. See the
37635de7a03cSTejun Heo  * comments in 'struct workqueue_attrs' definition.
37645de7a03cSTejun Heo  */
37655de7a03cSTejun Heo static void wqattrs_clear_for_pool(struct workqueue_attrs *attrs)
37665de7a03cSTejun Heo {
376784193c07STejun Heo 	attrs->affn_scope = WQ_AFFN_NR_TYPES;
37685de7a03cSTejun Heo 	attrs->ordered = false;
37695de7a03cSTejun Heo }
37705de7a03cSTejun Heo 
377129c91e99STejun Heo /* hash value of the content of @attr */
377229c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
377329c91e99STejun Heo {
377429c91e99STejun Heo 	u32 hash = 0;
377529c91e99STejun Heo 
377629c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
377713e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
377813e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
37799546b29eSTejun Heo 	hash = jhash(cpumask_bits(attrs->__pod_cpumask),
37809546b29eSTejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
3781*8639ecebSTejun Heo 	hash = jhash_1word(attrs->affn_strict, hash);
378229c91e99STejun Heo 	return hash;
378329c91e99STejun Heo }
378429c91e99STejun Heo 
378529c91e99STejun Heo /* content equality test */
378629c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
378729c91e99STejun Heo 			  const struct workqueue_attrs *b)
378829c91e99STejun Heo {
378929c91e99STejun Heo 	if (a->nice != b->nice)
379029c91e99STejun Heo 		return false;
379129c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
379229c91e99STejun Heo 		return false;
37939546b29eSTejun Heo 	if (!cpumask_equal(a->__pod_cpumask, b->__pod_cpumask))
37949546b29eSTejun Heo 		return false;
3795*8639ecebSTejun Heo 	if (a->affn_strict != b->affn_strict)
3796*8639ecebSTejun Heo 		return false;
379729c91e99STejun Heo 	return true;
379829c91e99STejun Heo }
379929c91e99STejun Heo 
38000f36ee24STejun Heo /* Update @attrs with actually available CPUs */
38010f36ee24STejun Heo static void wqattrs_actualize_cpumask(struct workqueue_attrs *attrs,
38020f36ee24STejun Heo 				      const cpumask_t *unbound_cpumask)
38030f36ee24STejun Heo {
38040f36ee24STejun Heo 	/*
38050f36ee24STejun Heo 	 * Calculate the effective CPU mask of @attrs given @unbound_cpumask. If
38060f36ee24STejun Heo 	 * @attrs->cpumask doesn't overlap with @unbound_cpumask, we fallback to
38070f36ee24STejun Heo 	 * @unbound_cpumask.
38080f36ee24STejun Heo 	 */
38090f36ee24STejun Heo 	cpumask_and(attrs->cpumask, attrs->cpumask, unbound_cpumask);
38100f36ee24STejun Heo 	if (unlikely(cpumask_empty(attrs->cpumask)))
38110f36ee24STejun Heo 		cpumask_copy(attrs->cpumask, unbound_cpumask);
38120f36ee24STejun Heo }
38130f36ee24STejun Heo 
381484193c07STejun Heo /* find wq_pod_type to use for @attrs */
381584193c07STejun Heo static const struct wq_pod_type *
381684193c07STejun Heo wqattrs_pod_type(const struct workqueue_attrs *attrs)
381784193c07STejun Heo {
381884193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[attrs->affn_scope];
381984193c07STejun Heo 
382084193c07STejun Heo 	if (!WARN_ON_ONCE(attrs->affn_scope == WQ_AFFN_NR_TYPES) &&
382184193c07STejun Heo 	    likely(pt->nr_pods))
382284193c07STejun Heo 		return pt;
382384193c07STejun Heo 
382484193c07STejun Heo 	/*
382584193c07STejun Heo 	 * Before workqueue_init_topology(), only SYSTEM is available which is
382684193c07STejun Heo 	 * initialized in workqueue_init_early().
382784193c07STejun Heo 	 */
382884193c07STejun Heo 	pt = &wq_pod_types[WQ_AFFN_SYSTEM];
382984193c07STejun Heo 	BUG_ON(!pt->nr_pods);
383084193c07STejun Heo 	return pt;
383184193c07STejun Heo }
383284193c07STejun Heo 
38337a4e344cSTejun Heo /**
38347a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
38357a4e344cSTejun Heo  * @pool: worker_pool to initialize
38367a4e344cSTejun Heo  *
3837402dd89dSShailendra Verma  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
3838d185af30SYacine Belkadi  *
3839d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
384029c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
384129c91e99STejun Heo  * on @pool safely to release it.
38427a4e344cSTejun Heo  */
38437a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
38444e1a1f9aSTejun Heo {
3845a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_init(&pool->lock);
384629c91e99STejun Heo 	pool->id = -1;
384729c91e99STejun Heo 	pool->cpu = -1;
3848f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
38494e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
385082607adcSTejun Heo 	pool->watchdog_ts = jiffies;
38514e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
38524e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
38534e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
38544e1a1f9aSTejun Heo 
385532a6c723SKees Cook 	timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
38563f959aa3SValentin Schneider 	INIT_WORK(&pool->idle_cull_work, idle_cull_fn);
38574e1a1f9aSTejun Heo 
385832a6c723SKees Cook 	timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
38594e1a1f9aSTejun Heo 
3860da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
3861e02b9312SValentin Schneider 	INIT_LIST_HEAD(&pool->dying_workers);
38627a4e344cSTejun Heo 
38637cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
386429c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
386529c91e99STejun Heo 	pool->refcnt = 1;
386629c91e99STejun Heo 
386729c91e99STejun Heo 	/* shouldn't fail above this point */
3868be69d00dSThomas Gleixner 	pool->attrs = alloc_workqueue_attrs();
38697a4e344cSTejun Heo 	if (!pool->attrs)
38707a4e344cSTejun Heo 		return -ENOMEM;
38715de7a03cSTejun Heo 
38725de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
38735de7a03cSTejun Heo 
38747a4e344cSTejun Heo 	return 0;
38754e1a1f9aSTejun Heo }
38764e1a1f9aSTejun Heo 
3877669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP
3878669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
3879669de8bdSBart Van Assche {
3880669de8bdSBart Van Assche 	char *lock_name;
3881669de8bdSBart Van Assche 
3882669de8bdSBart Van Assche 	lockdep_register_key(&wq->key);
3883669de8bdSBart Van Assche 	lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
3884669de8bdSBart Van Assche 	if (!lock_name)
3885669de8bdSBart Van Assche 		lock_name = wq->name;
388669a106c0SQian Cai 
388769a106c0SQian Cai 	wq->lock_name = lock_name;
3888669de8bdSBart Van Assche 	lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
3889669de8bdSBart Van Assche }
3890669de8bdSBart Van Assche 
3891669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
3892669de8bdSBart Van Assche {
3893669de8bdSBart Van Assche 	lockdep_unregister_key(&wq->key);
3894669de8bdSBart Van Assche }
3895669de8bdSBart Van Assche 
3896669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
3897669de8bdSBart Van Assche {
3898669de8bdSBart Van Assche 	if (wq->lock_name != wq->name)
3899669de8bdSBart Van Assche 		kfree(wq->lock_name);
3900669de8bdSBart Van Assche }
3901669de8bdSBart Van Assche #else
3902669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
3903669de8bdSBart Van Assche {
3904669de8bdSBart Van Assche }
3905669de8bdSBart Van Assche 
3906669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
3907669de8bdSBart Van Assche {
3908669de8bdSBart Van Assche }
3909669de8bdSBart Van Assche 
3910669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
3911669de8bdSBart Van Assche {
3912669de8bdSBart Van Assche }
3913669de8bdSBart Van Assche #endif
3914669de8bdSBart Van Assche 
3915e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu)
3916e2dca7adSTejun Heo {
3917e2dca7adSTejun Heo 	struct workqueue_struct *wq =
3918e2dca7adSTejun Heo 		container_of(rcu, struct workqueue_struct, rcu);
3919e2dca7adSTejun Heo 
3920669de8bdSBart Van Assche 	wq_free_lockdep(wq);
3921ee1ceef7STejun Heo 	free_percpu(wq->cpu_pwq);
3922e2dca7adSTejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
3923e2dca7adSTejun Heo 	kfree(wq);
3924e2dca7adSTejun Heo }
3925e2dca7adSTejun Heo 
392629c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
392729c91e99STejun Heo {
392829c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
392929c91e99STejun Heo 
39307cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
393129c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
393229c91e99STejun Heo 	kfree(pool);
393329c91e99STejun Heo }
393429c91e99STejun Heo 
393529c91e99STejun Heo /**
393629c91e99STejun Heo  * put_unbound_pool - put a worker_pool
393729c91e99STejun Heo  * @pool: worker_pool to put
393829c91e99STejun Heo  *
393924acfb71SThomas Gleixner  * Put @pool.  If its refcnt reaches zero, it gets destroyed in RCU
3940c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
3941c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
3942c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
3943a892caccSTejun Heo  *
3944a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
394529c91e99STejun Heo  */
394629c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
394729c91e99STejun Heo {
394860f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
394929c91e99STejun Heo 	struct worker *worker;
39509680540cSYang Yingliang 	LIST_HEAD(cull_list);
3951e02b9312SValentin Schneider 
3952a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
3953a892caccSTejun Heo 
3954a892caccSTejun Heo 	if (--pool->refcnt)
395529c91e99STejun Heo 		return;
395629c91e99STejun Heo 
395729c91e99STejun Heo 	/* sanity checks */
395861d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
3959a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
396029c91e99STejun Heo 		return;
396129c91e99STejun Heo 
396229c91e99STejun Heo 	/* release id and unhash */
396329c91e99STejun Heo 	if (pool->id >= 0)
396429c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
396529c91e99STejun Heo 	hash_del(&pool->hash_node);
396629c91e99STejun Heo 
3967c5aa87bbSTejun Heo 	/*
3968692b4825STejun Heo 	 * Become the manager and destroy all workers.  This prevents
3969692b4825STejun Heo 	 * @pool's workers from blocking on attach_mutex.  We're the last
3970692b4825STejun Heo 	 * manager and @pool gets freed with the flag set.
39719ab03be4SValentin Schneider 	 *
39729ab03be4SValentin Schneider 	 * Having a concurrent manager is quite unlikely to happen as we can
39739ab03be4SValentin Schneider 	 * only get here with
39749ab03be4SValentin Schneider 	 *   pwq->refcnt == pool->refcnt == 0
39759ab03be4SValentin Schneider 	 * which implies no work queued to the pool, which implies no worker can
39769ab03be4SValentin Schneider 	 * become the manager. However a worker could have taken the role of
39779ab03be4SValentin Schneider 	 * manager before the refcnts dropped to 0, since maybe_create_worker()
39789ab03be4SValentin Schneider 	 * drops pool->lock
3979c5aa87bbSTejun Heo 	 */
39809ab03be4SValentin Schneider 	while (true) {
39819ab03be4SValentin Schneider 		rcuwait_wait_event(&manager_wait,
39829ab03be4SValentin Schneider 				   !(pool->flags & POOL_MANAGER_ACTIVE),
3983d8bb65abSSebastian Andrzej Siewior 				   TASK_UNINTERRUPTIBLE);
3984e02b9312SValentin Schneider 
3985e02b9312SValentin Schneider 		mutex_lock(&wq_pool_attach_mutex);
39869ab03be4SValentin Schneider 		raw_spin_lock_irq(&pool->lock);
39879ab03be4SValentin Schneider 		if (!(pool->flags & POOL_MANAGER_ACTIVE)) {
3988692b4825STejun Heo 			pool->flags |= POOL_MANAGER_ACTIVE;
39899ab03be4SValentin Schneider 			break;
39909ab03be4SValentin Schneider 		}
39919ab03be4SValentin Schneider 		raw_spin_unlock_irq(&pool->lock);
3992e02b9312SValentin Schneider 		mutex_unlock(&wq_pool_attach_mutex);
39939ab03be4SValentin Schneider 	}
3994692b4825STejun Heo 
39951037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
3996e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
399729c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
3998a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
399960f5a4bcSLai Jiangshan 
4000e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
4001e02b9312SValentin Schneider 
4002e02b9312SValentin Schneider 	if (!list_empty(&pool->workers) || !list_empty(&pool->dying_workers))
400360f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
40041258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
400560f5a4bcSLai Jiangshan 
400660f5a4bcSLai Jiangshan 	if (pool->detach_completion)
400760f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
400860f5a4bcSLai Jiangshan 
400929c91e99STejun Heo 	/* shut down the timers */
401029c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
40113f959aa3SValentin Schneider 	cancel_work_sync(&pool->idle_cull_work);
401229c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
401329c91e99STejun Heo 
401424acfb71SThomas Gleixner 	/* RCU protected to allow dereferences from get_work_pool() */
401525b00775SPaul E. McKenney 	call_rcu(&pool->rcu, rcu_free_pool);
401629c91e99STejun Heo }
401729c91e99STejun Heo 
401829c91e99STejun Heo /**
401929c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
402029c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
402129c91e99STejun Heo  *
402229c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
402329c91e99STejun Heo  * reference count and return it.  If there already is a matching
402429c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
4025d185af30SYacine Belkadi  * create a new one.
4026a892caccSTejun Heo  *
4027a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
4028d185af30SYacine Belkadi  *
4029d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
4030d185af30SYacine Belkadi  * On failure, %NULL.
403129c91e99STejun Heo  */
403229c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
403329c91e99STejun Heo {
403484193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_NUMA];
403529c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
403629c91e99STejun Heo 	struct worker_pool *pool;
403784193c07STejun Heo 	int pod, node = NUMA_NO_NODE;
403829c91e99STejun Heo 
4039a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
404029c91e99STejun Heo 
404129c91e99STejun Heo 	/* do we already have a matching pool? */
404229c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
404329c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
404429c91e99STejun Heo 			pool->refcnt++;
40453fb1823cSLai Jiangshan 			return pool;
404629c91e99STejun Heo 		}
404729c91e99STejun Heo 	}
404829c91e99STejun Heo 
40499546b29eSTejun Heo 	/* If __pod_cpumask is contained inside a NUMA pod, that's our node */
405084193c07STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++) {
40519546b29eSTejun Heo 		if (cpumask_subset(attrs->__pod_cpumask, pt->pod_cpus[pod])) {
405284193c07STejun Heo 			node = pt->pod_node[pod];
4053e2273584SXunlei Pang 			break;
4054e2273584SXunlei Pang 		}
4055e2273584SXunlei Pang 	}
4056e2273584SXunlei Pang 
405729c91e99STejun Heo 	/* nope, create a new one */
405884193c07STejun Heo 	pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, node);
405929c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
406029c91e99STejun Heo 		goto fail;
406129c91e99STejun Heo 
406284193c07STejun Heo 	pool->node = node;
40635de7a03cSTejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
40645de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
40652865a8fbSShaohua Li 
406629c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
406729c91e99STejun Heo 		goto fail;
406829c91e99STejun Heo 
406929c91e99STejun Heo 	/* create and start the initial worker */
40703347fa09STejun Heo 	if (wq_online && !create_worker(pool))
407129c91e99STejun Heo 		goto fail;
407229c91e99STejun Heo 
407329c91e99STejun Heo 	/* install */
407429c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
40753fb1823cSLai Jiangshan 
407629c91e99STejun Heo 	return pool;
407729c91e99STejun Heo fail:
407829c91e99STejun Heo 	if (pool)
407929c91e99STejun Heo 		put_unbound_pool(pool);
408029c91e99STejun Heo 	return NULL;
408129c91e99STejun Heo }
408229c91e99STejun Heo 
40838864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
40848864b4e5STejun Heo {
40858864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
40868864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
40878864b4e5STejun Heo }
40888864b4e5STejun Heo 
40898864b4e5STejun Heo /*
4090967b494eSTejun Heo  * Scheduled on pwq_release_worker by put_pwq() when an unbound pwq hits zero
4091967b494eSTejun Heo  * refcnt and needs to be destroyed.
40928864b4e5STejun Heo  */
4093687a9aa5STejun Heo static void pwq_release_workfn(struct kthread_work *work)
40948864b4e5STejun Heo {
40958864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
4096687a9aa5STejun Heo 						  release_work);
40978864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
40988864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
4099b42b0bddSYang Yingliang 	bool is_last = false;
41008864b4e5STejun Heo 
4101b42b0bddSYang Yingliang 	/*
4102687a9aa5STejun Heo 	 * When @pwq is not linked, it doesn't hold any reference to the
4103b42b0bddSYang Yingliang 	 * @wq, and @wq is invalid to access.
4104b42b0bddSYang Yingliang 	 */
4105b42b0bddSYang Yingliang 	if (!list_empty(&pwq->pwqs_node)) {
41063c25a55dSLai Jiangshan 		mutex_lock(&wq->mutex);
41078864b4e5STejun Heo 		list_del_rcu(&pwq->pwqs_node);
4108bc0caf09STejun Heo 		is_last = list_empty(&wq->pwqs);
41093c25a55dSLai Jiangshan 		mutex_unlock(&wq->mutex);
4110b42b0bddSYang Yingliang 	}
41118864b4e5STejun Heo 
4112687a9aa5STejun Heo 	if (wq->flags & WQ_UNBOUND) {
4113a892caccSTejun Heo 		mutex_lock(&wq_pool_mutex);
41148864b4e5STejun Heo 		put_unbound_pool(pool);
4115a892caccSTejun Heo 		mutex_unlock(&wq_pool_mutex);
4116687a9aa5STejun Heo 	}
4117a892caccSTejun Heo 
411825b00775SPaul E. McKenney 	call_rcu(&pwq->rcu, rcu_free_pwq);
41198864b4e5STejun Heo 
41208864b4e5STejun Heo 	/*
41218864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
4122e2dca7adSTejun Heo 	 * is gonna access it anymore.  Schedule RCU free.
41238864b4e5STejun Heo 	 */
4124669de8bdSBart Van Assche 	if (is_last) {
4125669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
412625b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
41276029a918STejun Heo 	}
4128669de8bdSBart Van Assche }
41298864b4e5STejun Heo 
41300fbd95aaSTejun Heo /**
4131699ce097STejun Heo  * pwq_adjust_max_active - update a pwq's max_active to the current setting
41320fbd95aaSTejun Heo  * @pwq: target pool_workqueue
41330fbd95aaSTejun Heo  *
4134699ce097STejun Heo  * If @pwq isn't freezing, set @pwq->max_active to the associated
4135f97a4a1aSLai Jiangshan  * workqueue's saved_max_active and activate inactive work items
4136699ce097STejun Heo  * accordingly.  If @pwq is freezing, clear @pwq->max_active to zero.
41370fbd95aaSTejun Heo  */
4138699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq)
41390fbd95aaSTejun Heo {
4140699ce097STejun Heo 	struct workqueue_struct *wq = pwq->wq;
4141699ce097STejun Heo 	bool freezable = wq->flags & WQ_FREEZABLE;
41423347fa09STejun Heo 	unsigned long flags;
4143699ce097STejun Heo 
4144699ce097STejun Heo 	/* for @wq->saved_max_active */
4145a357fc03SLai Jiangshan 	lockdep_assert_held(&wq->mutex);
4146699ce097STejun Heo 
4147699ce097STejun Heo 	/* fast exit for non-freezable wqs */
4148699ce097STejun Heo 	if (!freezable && pwq->max_active == wq->saved_max_active)
4149699ce097STejun Heo 		return;
4150699ce097STejun Heo 
41513347fa09STejun Heo 	/* this function can be called during early boot w/ irq disabled */
4152a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irqsave(&pwq->pool->lock, flags);
4153699ce097STejun Heo 
415474b414eaSLai Jiangshan 	/*
415574b414eaSLai Jiangshan 	 * During [un]freezing, the caller is responsible for ensuring that
415674b414eaSLai Jiangshan 	 * this function is called at least once after @workqueue_freezing
415774b414eaSLai Jiangshan 	 * is updated and visible.
415874b414eaSLai Jiangshan 	 */
415974b414eaSLai Jiangshan 	if (!freezable || !workqueue_freezing) {
4160699ce097STejun Heo 		pwq->max_active = wq->saved_max_active;
41610fbd95aaSTejun Heo 
4162f97a4a1aSLai Jiangshan 		while (!list_empty(&pwq->inactive_works) &&
41630219a352STejun Heo 		       pwq->nr_active < pwq->max_active)
4164f97a4a1aSLai Jiangshan 			pwq_activate_first_inactive(pwq);
4165951a078aSLai Jiangshan 
41660219a352STejun Heo 		kick_pool(pwq->pool);
4167699ce097STejun Heo 	} else {
4168699ce097STejun Heo 		pwq->max_active = 0;
4169699ce097STejun Heo 	}
4170699ce097STejun Heo 
4171a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
41720fbd95aaSTejun Heo }
41730fbd95aaSTejun Heo 
417467dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */
4175f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
4176f147f29eSTejun Heo 		     struct worker_pool *pool)
4177d2c1d404STejun Heo {
4178d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
4179d2c1d404STejun Heo 
4180e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
4181e50aba9aSTejun Heo 
4182d2c1d404STejun Heo 	pwq->pool = pool;
4183d2c1d404STejun Heo 	pwq->wq = wq;
4184d2c1d404STejun Heo 	pwq->flush_color = -1;
41858864b4e5STejun Heo 	pwq->refcnt = 1;
4186f97a4a1aSLai Jiangshan 	INIT_LIST_HEAD(&pwq->inactive_works);
41871befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
4188d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
4189687a9aa5STejun Heo 	kthread_init_work(&pwq->release_work, pwq_release_workfn);
4190f147f29eSTejun Heo }
4191d2c1d404STejun Heo 
4192f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
41931befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
4194f147f29eSTejun Heo {
4195f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
4196f147f29eSTejun Heo 
4197f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
419875ccf595STejun Heo 
41991befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
42001befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
42011befcf30STejun Heo 		return;
42021befcf30STejun Heo 
420329b1cb41SLai Jiangshan 	/* set the matching work_color */
420475ccf595STejun Heo 	pwq->work_color = wq->work_color;
4205983ca25eSTejun Heo 
4206983ca25eSTejun Heo 	/* sync max_active to the current setting */
4207983ca25eSTejun Heo 	pwq_adjust_max_active(pwq);
4208983ca25eSTejun Heo 
4209983ca25eSTejun Heo 	/* link in @pwq */
42109e8cd2f5STejun Heo 	list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
4211df2d5ae4STejun Heo }
42126029a918STejun Heo 
4213f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
4214f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
4215f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
4216f147f29eSTejun Heo {
4217f147f29eSTejun Heo 	struct worker_pool *pool;
4218f147f29eSTejun Heo 	struct pool_workqueue *pwq;
4219f147f29eSTejun Heo 
4220f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4221f147f29eSTejun Heo 
4222f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
4223f147f29eSTejun Heo 	if (!pool)
4224f147f29eSTejun Heo 		return NULL;
4225f147f29eSTejun Heo 
4226e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
4227f147f29eSTejun Heo 	if (!pwq) {
4228f147f29eSTejun Heo 		put_unbound_pool(pool);
4229f147f29eSTejun Heo 		return NULL;
4230f147f29eSTejun Heo 	}
4231f147f29eSTejun Heo 
4232f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
4233f147f29eSTejun Heo 	return pwq;
4234d2c1d404STejun Heo }
4235d2c1d404STejun Heo 
42364c16bd32STejun Heo /**
4237fef59c9cSTejun Heo  * wq_calc_pod_cpumask - calculate a wq_attrs' cpumask for a pod
4238042f7df1SLai Jiangshan  * @attrs: the wq_attrs of the default pwq of the target workqueue
423984193c07STejun Heo  * @cpu: the target CPU
42404c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
42414c16bd32STejun Heo  *
4242fef59c9cSTejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @pod. If
4243fef59c9cSTejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during calculation.
42449546b29eSTejun Heo  * The result is stored in @attrs->__pod_cpumask.
42454c16bd32STejun Heo  *
4246fef59c9cSTejun Heo  * If pod affinity is not enabled, @attrs->cpumask is always used. If enabled
4247fef59c9cSTejun Heo  * and @pod has online CPUs requested by @attrs, the returned cpumask is the
4248fef59c9cSTejun Heo  * intersection of the possible CPUs of @pod and @attrs->cpumask.
42494c16bd32STejun Heo  *
4250fef59c9cSTejun Heo  * The caller is responsible for ensuring that the cpumask of @pod stays stable.
42514c16bd32STejun Heo  */
42529546b29eSTejun Heo static void wq_calc_pod_cpumask(struct workqueue_attrs *attrs, int cpu,
42539546b29eSTejun Heo 				int cpu_going_down)
42544c16bd32STejun Heo {
425584193c07STejun Heo 	const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
425684193c07STejun Heo 	int pod = pt->cpu_pod[cpu];
42574c16bd32STejun Heo 
4258fef59c9cSTejun Heo 	/* does @pod have any online CPUs @attrs wants? */
42599546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, pt->pod_cpus[pod], attrs->cpumask);
42609546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->__pod_cpumask, cpu_online_mask);
42614c16bd32STejun Heo 	if (cpu_going_down >= 0)
42629546b29eSTejun Heo 		cpumask_clear_cpu(cpu_going_down, attrs->__pod_cpumask);
42634c16bd32STejun Heo 
42649546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask)) {
42659546b29eSTejun Heo 		cpumask_copy(attrs->__pod_cpumask, attrs->cpumask);
426684193c07STejun Heo 		return;
426784193c07STejun Heo 	}
42684c16bd32STejun Heo 
4269fef59c9cSTejun Heo 	/* yeap, return possible CPUs in @pod that @attrs wants */
42709546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->cpumask, pt->pod_cpus[pod]);
42711ad0f0a7SMichael Bringmann 
42729546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask))
42731ad0f0a7SMichael Bringmann 		pr_warn_once("WARNING: workqueue cpumask: online intersect > "
42741ad0f0a7SMichael Bringmann 				"possible intersect\n");
42754c16bd32STejun Heo }
42764c16bd32STejun Heo 
4277636b927eSTejun Heo /* install @pwq into @wq's cpu_pwq and return the old pwq */
4278636b927eSTejun Heo static struct pool_workqueue *install_unbound_pwq(struct workqueue_struct *wq,
4279636b927eSTejun Heo 					int cpu, struct pool_workqueue *pwq)
42801befcf30STejun Heo {
42811befcf30STejun Heo 	struct pool_workqueue *old_pwq;
42821befcf30STejun Heo 
42835b95e1afSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
42841befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
42851befcf30STejun Heo 
42861befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
42871befcf30STejun Heo 	link_pwq(pwq);
42881befcf30STejun Heo 
4289636b927eSTejun Heo 	old_pwq = rcu_access_pointer(*per_cpu_ptr(wq->cpu_pwq, cpu));
4290636b927eSTejun Heo 	rcu_assign_pointer(*per_cpu_ptr(wq->cpu_pwq, cpu), pwq);
42911befcf30STejun Heo 	return old_pwq;
42921befcf30STejun Heo }
42931befcf30STejun Heo 
42942d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */
42952d5f0764SLai Jiangshan struct apply_wqattrs_ctx {
42962d5f0764SLai Jiangshan 	struct workqueue_struct	*wq;		/* target workqueue */
42972d5f0764SLai Jiangshan 	struct workqueue_attrs	*attrs;		/* attrs to apply */
4298042f7df1SLai Jiangshan 	struct list_head	list;		/* queued for batching commit */
42992d5f0764SLai Jiangshan 	struct pool_workqueue	*dfl_pwq;
43002d5f0764SLai Jiangshan 	struct pool_workqueue	*pwq_tbl[];
43012d5f0764SLai Jiangshan };
43022d5f0764SLai Jiangshan 
43032d5f0764SLai Jiangshan /* free the resources after success or abort */
43042d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
43052d5f0764SLai Jiangshan {
43062d5f0764SLai Jiangshan 	if (ctx) {
4307636b927eSTejun Heo 		int cpu;
43082d5f0764SLai Jiangshan 
4309636b927eSTejun Heo 		for_each_possible_cpu(cpu)
4310636b927eSTejun Heo 			put_pwq_unlocked(ctx->pwq_tbl[cpu]);
43112d5f0764SLai Jiangshan 		put_pwq_unlocked(ctx->dfl_pwq);
43122d5f0764SLai Jiangshan 
43132d5f0764SLai Jiangshan 		free_workqueue_attrs(ctx->attrs);
43142d5f0764SLai Jiangshan 
43152d5f0764SLai Jiangshan 		kfree(ctx);
43162d5f0764SLai Jiangshan 	}
43172d5f0764SLai Jiangshan }
43182d5f0764SLai Jiangshan 
43192d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */
43202d5f0764SLai Jiangshan static struct apply_wqattrs_ctx *
43212d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq,
432299c621efSLai Jiangshan 		      const struct workqueue_attrs *attrs,
432399c621efSLai Jiangshan 		      const cpumask_var_t unbound_cpumask)
43242d5f0764SLai Jiangshan {
43252d5f0764SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
43269546b29eSTejun Heo 	struct workqueue_attrs *new_attrs;
4327636b927eSTejun Heo 	int cpu;
43282d5f0764SLai Jiangshan 
43292d5f0764SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
43302d5f0764SLai Jiangshan 
433184193c07STejun Heo 	if (WARN_ON(attrs->affn_scope < 0 ||
433284193c07STejun Heo 		    attrs->affn_scope >= WQ_AFFN_NR_TYPES))
433384193c07STejun Heo 		return ERR_PTR(-EINVAL);
433484193c07STejun Heo 
4335636b927eSTejun Heo 	ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_cpu_ids), GFP_KERNEL);
43362d5f0764SLai Jiangshan 
4337be69d00dSThomas Gleixner 	new_attrs = alloc_workqueue_attrs();
43389546b29eSTejun Heo 	if (!ctx || !new_attrs)
43392d5f0764SLai Jiangshan 		goto out_free;
43402d5f0764SLai Jiangshan 
4341042f7df1SLai Jiangshan 	/*
43422d5f0764SLai Jiangshan 	 * If something goes wrong during CPU up/down, we'll fall back to
43432d5f0764SLai Jiangshan 	 * the default pwq covering whole @attrs->cpumask.  Always create
43442d5f0764SLai Jiangshan 	 * it even if we don't use it immediately.
43452d5f0764SLai Jiangshan 	 */
43460f36ee24STejun Heo 	copy_workqueue_attrs(new_attrs, attrs);
43470f36ee24STejun Heo 	wqattrs_actualize_cpumask(new_attrs, unbound_cpumask);
43489546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
43492d5f0764SLai Jiangshan 	ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
43502d5f0764SLai Jiangshan 	if (!ctx->dfl_pwq)
43512d5f0764SLai Jiangshan 		goto out_free;
43522d5f0764SLai Jiangshan 
4353636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
4354af73f5c9STejun Heo 		if (new_attrs->ordered) {
43552d5f0764SLai Jiangshan 			ctx->dfl_pwq->refcnt++;
4356636b927eSTejun Heo 			ctx->pwq_tbl[cpu] = ctx->dfl_pwq;
4357636b927eSTejun Heo 		} else {
43589546b29eSTejun Heo 			wq_calc_pod_cpumask(new_attrs, cpu, -1);
43599546b29eSTejun Heo 			ctx->pwq_tbl[cpu] = alloc_unbound_pwq(wq, new_attrs);
4360636b927eSTejun Heo 			if (!ctx->pwq_tbl[cpu])
4361636b927eSTejun Heo 				goto out_free;
43622d5f0764SLai Jiangshan 		}
43632d5f0764SLai Jiangshan 	}
43642d5f0764SLai Jiangshan 
4365042f7df1SLai Jiangshan 	/* save the user configured attrs and sanitize it. */
4366042f7df1SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
4367042f7df1SLai Jiangshan 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
43689546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
43692d5f0764SLai Jiangshan 	ctx->attrs = new_attrs;
4370042f7df1SLai Jiangshan 
43712d5f0764SLai Jiangshan 	ctx->wq = wq;
43722d5f0764SLai Jiangshan 	return ctx;
43732d5f0764SLai Jiangshan 
43742d5f0764SLai Jiangshan out_free:
43752d5f0764SLai Jiangshan 	free_workqueue_attrs(new_attrs);
43762d5f0764SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
437784193c07STejun Heo 	return ERR_PTR(-ENOMEM);
43782d5f0764SLai Jiangshan }
43792d5f0764SLai Jiangshan 
43802d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
43812d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
43822d5f0764SLai Jiangshan {
4383636b927eSTejun Heo 	int cpu;
43842d5f0764SLai Jiangshan 
43852d5f0764SLai Jiangshan 	/* all pwqs have been created successfully, let's install'em */
43862d5f0764SLai Jiangshan 	mutex_lock(&ctx->wq->mutex);
43872d5f0764SLai Jiangshan 
43882d5f0764SLai Jiangshan 	copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
43892d5f0764SLai Jiangshan 
43902d5f0764SLai Jiangshan 	/* save the previous pwq and install the new one */
4391636b927eSTejun Heo 	for_each_possible_cpu(cpu)
4392636b927eSTejun Heo 		ctx->pwq_tbl[cpu] = install_unbound_pwq(ctx->wq, cpu,
4393636b927eSTejun Heo 							ctx->pwq_tbl[cpu]);
43942d5f0764SLai Jiangshan 
43952d5f0764SLai Jiangshan 	/* @dfl_pwq might not have been used, ensure it's linked */
43962d5f0764SLai Jiangshan 	link_pwq(ctx->dfl_pwq);
43972d5f0764SLai Jiangshan 	swap(ctx->wq->dfl_pwq, ctx->dfl_pwq);
43982d5f0764SLai Jiangshan 
43992d5f0764SLai Jiangshan 	mutex_unlock(&ctx->wq->mutex);
44002d5f0764SLai Jiangshan }
44012d5f0764SLai Jiangshan 
4402a0111cf6SLai Jiangshan static void apply_wqattrs_lock(void)
4403a0111cf6SLai Jiangshan {
4404a0111cf6SLai Jiangshan 	/* CPUs should stay stable across pwq creations and installations */
4405ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
4406a0111cf6SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4407a0111cf6SLai Jiangshan }
4408a0111cf6SLai Jiangshan 
4409a0111cf6SLai Jiangshan static void apply_wqattrs_unlock(void)
4410a0111cf6SLai Jiangshan {
4411a0111cf6SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
4412ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
4413a0111cf6SLai Jiangshan }
4414a0111cf6SLai Jiangshan 
4415a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
4416a0111cf6SLai Jiangshan 					const struct workqueue_attrs *attrs)
4417a0111cf6SLai Jiangshan {
4418a0111cf6SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
4419a0111cf6SLai Jiangshan 
4420a0111cf6SLai Jiangshan 	/* only unbound workqueues can change attributes */
4421a0111cf6SLai Jiangshan 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
4422a0111cf6SLai Jiangshan 		return -EINVAL;
4423a0111cf6SLai Jiangshan 
4424a0111cf6SLai Jiangshan 	/* creating multiple pwqs breaks ordering guarantee */
44250a94efb5STejun Heo 	if (!list_empty(&wq->pwqs)) {
44260a94efb5STejun Heo 		if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
4427a0111cf6SLai Jiangshan 			return -EINVAL;
4428a0111cf6SLai Jiangshan 
44290a94efb5STejun Heo 		wq->flags &= ~__WQ_ORDERED;
44300a94efb5STejun Heo 	}
44310a94efb5STejun Heo 
443299c621efSLai Jiangshan 	ctx = apply_wqattrs_prepare(wq, attrs, wq_unbound_cpumask);
443384193c07STejun Heo 	if (IS_ERR(ctx))
443484193c07STejun Heo 		return PTR_ERR(ctx);
4435a0111cf6SLai Jiangshan 
4436a0111cf6SLai Jiangshan 	/* the ctx has been prepared successfully, let's commit it */
4437a0111cf6SLai Jiangshan 	apply_wqattrs_commit(ctx);
4438a0111cf6SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
4439a0111cf6SLai Jiangshan 
44406201171eSwanghaibin 	return 0;
4441a0111cf6SLai Jiangshan }
4442a0111cf6SLai Jiangshan 
44439e8cd2f5STejun Heo /**
44449e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
44459e8cd2f5STejun Heo  * @wq: the target workqueue
44469e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
44479e8cd2f5STejun Heo  *
4448fef59c9cSTejun Heo  * Apply @attrs to an unbound workqueue @wq. Unless disabled, this function maps
4449fef59c9cSTejun Heo  * a separate pwq to each CPU pod with possibles CPUs in @attrs->cpumask so that
4450fef59c9cSTejun Heo  * work items are affine to the pod it was issued on. Older pwqs are released as
4451fef59c9cSTejun Heo  * in-flight work items finish. Note that a work item which repeatedly requeues
4452fef59c9cSTejun Heo  * itself back-to-back will stay on its current pwq.
44539e8cd2f5STejun Heo  *
4454d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
4455d185af30SYacine Belkadi  *
4456ffd8bea8SSebastian Andrzej Siewior  * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock().
4457509b3204SDaniel Jordan  *
4458d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
44599e8cd2f5STejun Heo  */
4460513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq,
44619e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
44629e8cd2f5STejun Heo {
4463a0111cf6SLai Jiangshan 	int ret;
44649e8cd2f5STejun Heo 
4465509b3204SDaniel Jordan 	lockdep_assert_cpus_held();
4466509b3204SDaniel Jordan 
4467509b3204SDaniel Jordan 	mutex_lock(&wq_pool_mutex);
4468a0111cf6SLai Jiangshan 	ret = apply_workqueue_attrs_locked(wq, attrs);
4469509b3204SDaniel Jordan 	mutex_unlock(&wq_pool_mutex);
44702d5f0764SLai Jiangshan 
44712d5f0764SLai Jiangshan 	return ret;
44729e8cd2f5STejun Heo }
44739e8cd2f5STejun Heo 
44744c16bd32STejun Heo /**
4475fef59c9cSTejun Heo  * wq_update_pod - update pod affinity of a wq for CPU hot[un]plug
44764c16bd32STejun Heo  * @wq: the target workqueue
44774cbfd3deSTejun Heo  * @cpu: the CPU to update pool association for
44784cbfd3deSTejun Heo  * @hotplug_cpu: the CPU coming up or going down
44794c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
44804c16bd32STejun Heo  *
44814c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
4482fef59c9cSTejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update pod affinity of
44834c16bd32STejun Heo  * @wq accordingly.
44844c16bd32STejun Heo  *
44854c16bd32STejun Heo  *
4486fef59c9cSTejun Heo  * If pod affinity can't be adjusted due to memory allocation failure, it falls
4487fef59c9cSTejun Heo  * back to @wq->dfl_pwq which may not be optimal but is always correct.
4488fef59c9cSTejun Heo  *
4489fef59c9cSTejun Heo  * Note that when the last allowed CPU of a pod goes offline for a workqueue
4490fef59c9cSTejun Heo  * with a cpumask spanning multiple pods, the workers which were already
4491fef59c9cSTejun Heo  * executing the work items for the workqueue will lose their CPU affinity and
4492fef59c9cSTejun Heo  * may execute on any CPU. This is similar to how per-cpu workqueues behave on
4493fef59c9cSTejun Heo  * CPU_DOWN. If a workqueue user wants strict affinity, it's the user's
4494fef59c9cSTejun Heo  * responsibility to flush the work item from CPU_DOWN_PREPARE.
44954c16bd32STejun Heo  */
4496fef59c9cSTejun Heo static void wq_update_pod(struct workqueue_struct *wq, int cpu,
44974cbfd3deSTejun Heo 			  int hotplug_cpu, bool online)
44984c16bd32STejun Heo {
44994cbfd3deSTejun Heo 	int off_cpu = online ? -1 : hotplug_cpu;
45004c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
45014c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
45024c16bd32STejun Heo 
45034c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
45044c16bd32STejun Heo 
450584193c07STejun Heo 	if (!(wq->flags & WQ_UNBOUND) || wq->unbound_attrs->ordered)
45064c16bd32STejun Heo 		return;
45074c16bd32STejun Heo 
45084c16bd32STejun Heo 	/*
45094c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
45104c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
45114c16bd32STejun Heo 	 * CPU hotplug exclusion.
45124c16bd32STejun Heo 	 */
4513fef59c9cSTejun Heo 	target_attrs = wq_update_pod_attrs_buf;
45144c16bd32STejun Heo 
45154c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
45160f36ee24STejun Heo 	wqattrs_actualize_cpumask(target_attrs, wq_unbound_cpumask);
45174c16bd32STejun Heo 
4518636b927eSTejun Heo 	/* nothing to do if the target cpumask matches the current pwq */
45199546b29eSTejun Heo 	wq_calc_pod_cpumask(target_attrs, cpu, off_cpu);
4520636b927eSTejun Heo 	pwq = rcu_dereference_protected(*per_cpu_ptr(wq->cpu_pwq, cpu),
4521636b927eSTejun Heo 					lockdep_is_held(&wq_pool_mutex));
45229546b29eSTejun Heo 	if (wqattrs_equal(target_attrs, pwq->pool->attrs))
4523f7142ed4SLai Jiangshan 		return;
45244c16bd32STejun Heo 
45254c16bd32STejun Heo 	/* create a new pwq */
45264c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
45274c16bd32STejun Heo 	if (!pwq) {
4528fef59c9cSTejun Heo 		pr_warn("workqueue: allocation failed while updating CPU pod affinity of \"%s\"\n",
45294c16bd32STejun Heo 			wq->name);
453077f300b1SDaeseok Youn 		goto use_dfl_pwq;
45314c16bd32STejun Heo 	}
45324c16bd32STejun Heo 
4533f7142ed4SLai Jiangshan 	/* Install the new pwq. */
45344c16bd32STejun Heo 	mutex_lock(&wq->mutex);
4535636b927eSTejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, pwq);
45364c16bd32STejun Heo 	goto out_unlock;
45374c16bd32STejun Heo 
45384c16bd32STejun Heo use_dfl_pwq:
4539f7142ed4SLai Jiangshan 	mutex_lock(&wq->mutex);
4540a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&wq->dfl_pwq->pool->lock);
45414c16bd32STejun Heo 	get_pwq(wq->dfl_pwq);
4542a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock);
4543636b927eSTejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, wq->dfl_pwq);
45444c16bd32STejun Heo out_unlock:
45454c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
45464c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
45474c16bd32STejun Heo }
45484c16bd32STejun Heo 
454930cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
45501da177e4SLinus Torvalds {
455149e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
45528a2b7538STejun Heo 	int cpu, ret;
4553e1d8aa9fSFrederic Weisbecker 
4554687a9aa5STejun Heo 	wq->cpu_pwq = alloc_percpu(struct pool_workqueue *);
4555ee1ceef7STejun Heo 	if (!wq->cpu_pwq)
4556687a9aa5STejun Heo 		goto enomem;
455730cdf249STejun Heo 
4558636b927eSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
455930cdf249STejun Heo 		for_each_possible_cpu(cpu) {
4560687a9aa5STejun Heo 			struct pool_workqueue **pwq_p =
4561ee1ceef7STejun Heo 				per_cpu_ptr(wq->cpu_pwq, cpu);
4562687a9aa5STejun Heo 			struct worker_pool *pool =
4563687a9aa5STejun Heo 				&(per_cpu_ptr(cpu_worker_pools, cpu)[highpri]);
456430cdf249STejun Heo 
4565687a9aa5STejun Heo 			*pwq_p = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL,
4566687a9aa5STejun Heo 						       pool->node);
4567687a9aa5STejun Heo 			if (!*pwq_p)
4568687a9aa5STejun Heo 				goto enomem;
4569687a9aa5STejun Heo 
4570687a9aa5STejun Heo 			init_pwq(*pwq_p, wq, pool);
4571f147f29eSTejun Heo 
4572f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
4573687a9aa5STejun Heo 			link_pwq(*pwq_p);
4574f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
457530cdf249STejun Heo 		}
457630cdf249STejun Heo 		return 0;
4577509b3204SDaniel Jordan 	}
4578509b3204SDaniel Jordan 
4579ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
4580509b3204SDaniel Jordan 	if (wq->flags & __WQ_ORDERED) {
45818a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
45828a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
45838a2b7538STejun Heo 		WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
45848a2b7538STejun Heo 			      wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
45858a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
45869e8cd2f5STejun Heo 	} else {
4587509b3204SDaniel Jordan 		ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
45889e8cd2f5STejun Heo 	}
4589ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
4590509b3204SDaniel Jordan 
4591509b3204SDaniel Jordan 	return ret;
4592687a9aa5STejun Heo 
4593687a9aa5STejun Heo enomem:
4594687a9aa5STejun Heo 	if (wq->cpu_pwq) {
4595687a9aa5STejun Heo 		for_each_possible_cpu(cpu)
4596687a9aa5STejun Heo 			kfree(*per_cpu_ptr(wq->cpu_pwq, cpu));
4597687a9aa5STejun Heo 		free_percpu(wq->cpu_pwq);
4598687a9aa5STejun Heo 		wq->cpu_pwq = NULL;
4599687a9aa5STejun Heo 	}
4600687a9aa5STejun Heo 	return -ENOMEM;
46010f900049STejun Heo }
46020f900049STejun Heo 
4603f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
4604f3421797STejun Heo 			       const char *name)
4605b71ab8c2STejun Heo {
4606636b927eSTejun Heo 	if (max_active < 1 || max_active > WQ_MAX_ACTIVE)
4607044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4608636b927eSTejun Heo 			max_active, name, 1, WQ_MAX_ACTIVE);
4609b71ab8c2STejun Heo 
4610636b927eSTejun Heo 	return clamp_val(max_active, 1, WQ_MAX_ACTIVE);
4611b71ab8c2STejun Heo }
4612b71ab8c2STejun Heo 
4613983c7515STejun Heo /*
4614983c7515STejun Heo  * Workqueues which may be used during memory reclaim should have a rescuer
4615983c7515STejun Heo  * to guarantee forward progress.
4616983c7515STejun Heo  */
4617983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq)
4618983c7515STejun Heo {
4619983c7515STejun Heo 	struct worker *rescuer;
4620b92b36eaSDan Carpenter 	int ret;
4621983c7515STejun Heo 
4622983c7515STejun Heo 	if (!(wq->flags & WQ_MEM_RECLAIM))
4623983c7515STejun Heo 		return 0;
4624983c7515STejun Heo 
4625983c7515STejun Heo 	rescuer = alloc_worker(NUMA_NO_NODE);
46264c0736a7SPetr Mladek 	if (!rescuer) {
46274c0736a7SPetr Mladek 		pr_err("workqueue: Failed to allocate a rescuer for wq \"%s\"\n",
46284c0736a7SPetr Mladek 		       wq->name);
4629983c7515STejun Heo 		return -ENOMEM;
46304c0736a7SPetr Mladek 	}
4631983c7515STejun Heo 
4632983c7515STejun Heo 	rescuer->rescue_wq = wq;
4633983c7515STejun Heo 	rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name);
4634f187b697SSean Fu 	if (IS_ERR(rescuer->task)) {
4635b92b36eaSDan Carpenter 		ret = PTR_ERR(rescuer->task);
46364c0736a7SPetr Mladek 		pr_err("workqueue: Failed to create a rescuer kthread for wq \"%s\": %pe",
46374c0736a7SPetr Mladek 		       wq->name, ERR_PTR(ret));
4638983c7515STejun Heo 		kfree(rescuer);
4639b92b36eaSDan Carpenter 		return ret;
4640983c7515STejun Heo 	}
4641983c7515STejun Heo 
4642983c7515STejun Heo 	wq->rescuer = rescuer;
4643983c7515STejun Heo 	kthread_bind_mask(rescuer->task, cpu_possible_mask);
4644983c7515STejun Heo 	wake_up_process(rescuer->task);
4645983c7515STejun Heo 
4646983c7515STejun Heo 	return 0;
4647983c7515STejun Heo }
4648983c7515STejun Heo 
4649a2775bbcSMathieu Malaterre __printf(1, 4)
4650669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt,
465197e37d7bSTejun Heo 					 unsigned int flags,
4652669de8bdSBart Van Assche 					 int max_active, ...)
46533af24433SOleg Nesterov {
4654ecf6881fSTejun Heo 	va_list args;
46553af24433SOleg Nesterov 	struct workqueue_struct *wq;
465649e3cf44STejun Heo 	struct pool_workqueue *pwq;
4657b196be89STejun Heo 
46585c0338c6STejun Heo 	/*
4659fef59c9cSTejun Heo 	 * Unbound && max_active == 1 used to imply ordered, which is no longer
4660fef59c9cSTejun Heo 	 * the case on many machines due to per-pod pools. While
46615c0338c6STejun Heo 	 * alloc_ordered_workqueue() is the right way to create an ordered
4662fef59c9cSTejun Heo 	 * workqueue, keep the previous behavior to avoid subtle breakages.
46635c0338c6STejun Heo 	 */
46645c0338c6STejun Heo 	if ((flags & WQ_UNBOUND) && max_active == 1)
46655c0338c6STejun Heo 		flags |= __WQ_ORDERED;
46665c0338c6STejun Heo 
4667cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
4668cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4669cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
4670cee22a15SViresh Kumar 
4671ecf6881fSTejun Heo 	/* allocate wq and format name */
4672636b927eSTejun Heo 	wq = kzalloc(sizeof(*wq), GFP_KERNEL);
4673b196be89STejun Heo 	if (!wq)
4674d2c1d404STejun Heo 		return NULL;
4675b196be89STejun Heo 
46766029a918STejun Heo 	if (flags & WQ_UNBOUND) {
4677be69d00dSThomas Gleixner 		wq->unbound_attrs = alloc_workqueue_attrs();
46786029a918STejun Heo 		if (!wq->unbound_attrs)
46796029a918STejun Heo 			goto err_free_wq;
46806029a918STejun Heo 	}
46816029a918STejun Heo 
4682669de8bdSBart Van Assche 	va_start(args, max_active);
4683ecf6881fSTejun Heo 	vsnprintf(wq->name, sizeof(wq->name), fmt, args);
4684b196be89STejun Heo 	va_end(args);
46853af24433SOleg Nesterov 
4686d320c038STejun Heo 	max_active = max_active ?: WQ_DFL_ACTIVE;
4687b196be89STejun Heo 	max_active = wq_clamp_max_active(max_active, flags, wq->name);
46883af24433SOleg Nesterov 
4689b196be89STejun Heo 	/* init wq */
469097e37d7bSTejun Heo 	wq->flags = flags;
4691a0a1a5fdSTejun Heo 	wq->saved_max_active = max_active;
46923c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
4693112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
469430cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
469573f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
469673f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
4697493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
46983af24433SOleg Nesterov 
4699669de8bdSBart Van Assche 	wq_init_lockdep(wq);
4700cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
47013af24433SOleg Nesterov 
470230cdf249STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
470382efcab3SBart Van Assche 		goto err_unreg_lockdep;
47041537663fSTejun Heo 
470540c17f75STejun Heo 	if (wq_online && init_rescuer(wq) < 0)
4706d2c1d404STejun Heo 		goto err_destroy;
4707e22bee78STejun Heo 
4708226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4709226223abSTejun Heo 		goto err_destroy;
4710226223abSTejun Heo 
47116af8bf3dSOleg Nesterov 	/*
471268e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
471368e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
471468e13a67SLai Jiangshan 	 * list.
47156af8bf3dSOleg Nesterov 	 */
471668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
4717a0a1a5fdSTejun Heo 
4718a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
471949e3cf44STejun Heo 	for_each_pwq(pwq, wq)
4720699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4721a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4722a0a1a5fdSTejun Heo 
4723e2dca7adSTejun Heo 	list_add_tail_rcu(&wq->list, &workqueues);
4724a0a1a5fdSTejun Heo 
472568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
47263af24433SOleg Nesterov 
47273af24433SOleg Nesterov 	return wq;
4728d2c1d404STejun Heo 
472982efcab3SBart Van Assche err_unreg_lockdep:
4730009bb421SBart Van Assche 	wq_unregister_lockdep(wq);
4731009bb421SBart Van Assche 	wq_free_lockdep(wq);
473282efcab3SBart Van Assche err_free_wq:
47336029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
47344690c4abSTejun Heo 	kfree(wq);
4735d2c1d404STejun Heo 	return NULL;
4736d2c1d404STejun Heo err_destroy:
4737d2c1d404STejun Heo 	destroy_workqueue(wq);
47384690c4abSTejun Heo 	return NULL;
47391da177e4SLinus Torvalds }
4740669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue);
47411da177e4SLinus Torvalds 
4742c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq)
4743c29eb853STejun Heo {
4744c29eb853STejun Heo 	int i;
4745c29eb853STejun Heo 
4746c29eb853STejun Heo 	for (i = 0; i < WORK_NR_COLORS; i++)
4747c29eb853STejun Heo 		if (pwq->nr_in_flight[i])
4748c29eb853STejun Heo 			return true;
4749c29eb853STejun Heo 
4750c29eb853STejun Heo 	if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1))
4751c29eb853STejun Heo 		return true;
4752f97a4a1aSLai Jiangshan 	if (pwq->nr_active || !list_empty(&pwq->inactive_works))
4753c29eb853STejun Heo 		return true;
4754c29eb853STejun Heo 
4755c29eb853STejun Heo 	return false;
4756c29eb853STejun Heo }
4757c29eb853STejun Heo 
47583af24433SOleg Nesterov /**
47593af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
47603af24433SOleg Nesterov  * @wq: target workqueue
47613af24433SOleg Nesterov  *
47623af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
47633af24433SOleg Nesterov  */
47643af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
47653af24433SOleg Nesterov {
476649e3cf44STejun Heo 	struct pool_workqueue *pwq;
4767636b927eSTejun Heo 	int cpu;
47683af24433SOleg Nesterov 
4769def98c84STejun Heo 	/*
4770def98c84STejun Heo 	 * Remove it from sysfs first so that sanity check failure doesn't
4771def98c84STejun Heo 	 * lead to sysfs name conflicts.
4772def98c84STejun Heo 	 */
4773def98c84STejun Heo 	workqueue_sysfs_unregister(wq);
4774def98c84STejun Heo 
477533e3f0a3SRichard Clark 	/* mark the workqueue destruction is in progress */
477633e3f0a3SRichard Clark 	mutex_lock(&wq->mutex);
477733e3f0a3SRichard Clark 	wq->flags |= __WQ_DESTROYING;
477833e3f0a3SRichard Clark 	mutex_unlock(&wq->mutex);
477933e3f0a3SRichard Clark 
47809c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
47819c5a2ba7STejun Heo 	drain_workqueue(wq);
4782c8efcc25STejun Heo 
4783def98c84STejun Heo 	/* kill rescuer, if sanity checks fail, leave it w/o rescuer */
4784def98c84STejun Heo 	if (wq->rescuer) {
4785def98c84STejun Heo 		struct worker *rescuer = wq->rescuer;
4786def98c84STejun Heo 
4787def98c84STejun Heo 		/* this prevents new queueing */
4788a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
4789def98c84STejun Heo 		wq->rescuer = NULL;
4790a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
4791def98c84STejun Heo 
4792def98c84STejun Heo 		/* rescuer will empty maydays list before exiting */
4793def98c84STejun Heo 		kthread_stop(rescuer->task);
47948efe1223STejun Heo 		kfree(rescuer);
4795def98c84STejun Heo 	}
4796def98c84STejun Heo 
4797c29eb853STejun Heo 	/*
4798c29eb853STejun Heo 	 * Sanity checks - grab all the locks so that we wait for all
4799c29eb853STejun Heo 	 * in-flight operations which may do put_pwq().
4800c29eb853STejun Heo 	 */
4801c29eb853STejun Heo 	mutex_lock(&wq_pool_mutex);
4802b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
480349e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
4804a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
4805c29eb853STejun Heo 		if (WARN_ON(pwq_busy(pwq))) {
48061d9a6159SKefeng Wang 			pr_warn("%s: %s has the following busy pwq\n",
4807e66b39afSTejun Heo 				__func__, wq->name);
4808c29eb853STejun Heo 			show_pwq(pwq);
4809a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pwq->pool->lock);
4810b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
4811c29eb853STejun Heo 			mutex_unlock(&wq_pool_mutex);
481255df0933SImran Khan 			show_one_workqueue(wq);
48136183c009STejun Heo 			return;
481476af4d93STejun Heo 		}
4815a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
481676af4d93STejun Heo 	}
4817b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
48186183c009STejun Heo 
4819a0a1a5fdSTejun Heo 	/*
4820a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
4821a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
4822a0a1a5fdSTejun Heo 	 */
4823e2dca7adSTejun Heo 	list_del_rcu(&wq->list);
482468e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
48253af24433SOleg Nesterov 
48268864b4e5STejun Heo 	/*
4827636b927eSTejun Heo 	 * We're the sole accessor of @wq. Directly access cpu_pwq and dfl_pwq
4828636b927eSTejun Heo 	 * to put the base refs. @wq will be auto-destroyed from the last
4829636b927eSTejun Heo 	 * pwq_put. RCU read lock prevents @wq from going away from under us.
48308864b4e5STejun Heo 	 */
4831636b927eSTejun Heo 	rcu_read_lock();
4832636b927eSTejun Heo 
4833636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
4834636b927eSTejun Heo 		pwq = rcu_access_pointer(*per_cpu_ptr(wq->cpu_pwq, cpu));
4835636b927eSTejun Heo 		RCU_INIT_POINTER(*per_cpu_ptr(wq->cpu_pwq, cpu), NULL);
48364c16bd32STejun Heo 		put_pwq_unlocked(pwq);
48374c16bd32STejun Heo 	}
48384c16bd32STejun Heo 
4839636b927eSTejun Heo 	put_pwq_unlocked(wq->dfl_pwq);
48404c16bd32STejun Heo 	wq->dfl_pwq = NULL;
4841636b927eSTejun Heo 
4842636b927eSTejun Heo 	rcu_read_unlock();
48433af24433SOleg Nesterov }
48443af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
48453af24433SOleg Nesterov 
4846dcd989cbSTejun Heo /**
4847dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
4848dcd989cbSTejun Heo  * @wq: target workqueue
4849dcd989cbSTejun Heo  * @max_active: new max_active value.
4850dcd989cbSTejun Heo  *
4851dcd989cbSTejun Heo  * Set max_active of @wq to @max_active.
4852dcd989cbSTejun Heo  *
4853dcd989cbSTejun Heo  * CONTEXT:
4854dcd989cbSTejun Heo  * Don't call from IRQ context.
4855dcd989cbSTejun Heo  */
4856dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4857dcd989cbSTejun Heo {
485849e3cf44STejun Heo 	struct pool_workqueue *pwq;
4859dcd989cbSTejun Heo 
48608719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
48610a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
48628719dceaSTejun Heo 		return;
48638719dceaSTejun Heo 
4864f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
4865dcd989cbSTejun Heo 
4866a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
4867dcd989cbSTejun Heo 
48680a94efb5STejun Heo 	wq->flags &= ~__WQ_ORDERED;
4869dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
4870dcd989cbSTejun Heo 
4871699ce097STejun Heo 	for_each_pwq(pwq, wq)
4872699ce097STejun Heo 		pwq_adjust_max_active(pwq);
4873dcd989cbSTejun Heo 
4874a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
4875dcd989cbSTejun Heo }
4876dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4877dcd989cbSTejun Heo 
4878dcd989cbSTejun Heo /**
487927d4ee03SLukas Wunner  * current_work - retrieve %current task's work struct
488027d4ee03SLukas Wunner  *
488127d4ee03SLukas Wunner  * Determine if %current task is a workqueue worker and what it's working on.
488227d4ee03SLukas Wunner  * Useful to find out the context that the %current task is running in.
488327d4ee03SLukas Wunner  *
488427d4ee03SLukas Wunner  * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
488527d4ee03SLukas Wunner  */
488627d4ee03SLukas Wunner struct work_struct *current_work(void)
488727d4ee03SLukas Wunner {
488827d4ee03SLukas Wunner 	struct worker *worker = current_wq_worker();
488927d4ee03SLukas Wunner 
489027d4ee03SLukas Wunner 	return worker ? worker->current_work : NULL;
489127d4ee03SLukas Wunner }
489227d4ee03SLukas Wunner EXPORT_SYMBOL(current_work);
489327d4ee03SLukas Wunner 
489427d4ee03SLukas Wunner /**
4895e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
4896e6267616STejun Heo  *
4897e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
4898e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
4899d185af30SYacine Belkadi  *
4900d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
4901e6267616STejun Heo  */
4902e6267616STejun Heo bool current_is_workqueue_rescuer(void)
4903e6267616STejun Heo {
4904e6267616STejun Heo 	struct worker *worker = current_wq_worker();
4905e6267616STejun Heo 
49066a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
4907e6267616STejun Heo }
4908e6267616STejun Heo 
4909e6267616STejun Heo /**
4910dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
4911dcd989cbSTejun Heo  * @cpu: CPU in question
4912dcd989cbSTejun Heo  * @wq: target workqueue
4913dcd989cbSTejun Heo  *
4914dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
4915dcd989cbSTejun Heo  * no synchronization around this function and the test result is
4916dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4917dcd989cbSTejun Heo  *
4918d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4919636b927eSTejun Heo  *
4920636b927eSTejun Heo  * With the exception of ordered workqueues, all workqueues have per-cpu
4921636b927eSTejun Heo  * pool_workqueues, each with its own congested state. A workqueue being
4922636b927eSTejun Heo  * congested on one CPU doesn't mean that the workqueue is contested on any
4923636b927eSTejun Heo  * other CPUs.
4924d3251859STejun Heo  *
4925d185af30SYacine Belkadi  * Return:
4926dcd989cbSTejun Heo  * %true if congested, %false otherwise.
4927dcd989cbSTejun Heo  */
4928d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
4929dcd989cbSTejun Heo {
49307fb98ea7STejun Heo 	struct pool_workqueue *pwq;
493176af4d93STejun Heo 	bool ret;
493276af4d93STejun Heo 
493324acfb71SThomas Gleixner 	rcu_read_lock();
493424acfb71SThomas Gleixner 	preempt_disable();
49357fb98ea7STejun Heo 
4936d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
4937d3251859STejun Heo 		cpu = smp_processor_id();
4938d3251859STejun Heo 
4939687a9aa5STejun Heo 	pwq = *per_cpu_ptr(wq->cpu_pwq, cpu);
4940f97a4a1aSLai Jiangshan 	ret = !list_empty(&pwq->inactive_works);
4941636b927eSTejun Heo 
494224acfb71SThomas Gleixner 	preempt_enable();
494324acfb71SThomas Gleixner 	rcu_read_unlock();
494476af4d93STejun Heo 
494576af4d93STejun Heo 	return ret;
4946dcd989cbSTejun Heo }
4947dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
4948dcd989cbSTejun Heo 
4949dcd989cbSTejun Heo /**
4950dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
4951dcd989cbSTejun Heo  * @work: the work to be tested
4952dcd989cbSTejun Heo  *
4953dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
4954dcd989cbSTejun Heo  * synchronization around this function and the test result is
4955dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
4956dcd989cbSTejun Heo  *
4957d185af30SYacine Belkadi  * Return:
4958dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
4959dcd989cbSTejun Heo  */
4960dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
4961dcd989cbSTejun Heo {
4962fa1b54e6STejun Heo 	struct worker_pool *pool;
4963dcd989cbSTejun Heo 	unsigned long flags;
4964dcd989cbSTejun Heo 	unsigned int ret = 0;
4965dcd989cbSTejun Heo 
4966dcd989cbSTejun Heo 	if (work_pending(work))
4967dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
4968038366c5SLai Jiangshan 
496924acfb71SThomas Gleixner 	rcu_read_lock();
4970fa1b54e6STejun Heo 	pool = get_work_pool(work);
4971038366c5SLai Jiangshan 	if (pool) {
4972a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irqsave(&pool->lock, flags);
4973c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
4974dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
4975a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irqrestore(&pool->lock, flags);
4976038366c5SLai Jiangshan 	}
497724acfb71SThomas Gleixner 	rcu_read_unlock();
4978dcd989cbSTejun Heo 
4979dcd989cbSTejun Heo 	return ret;
4980dcd989cbSTejun Heo }
4981dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
4982dcd989cbSTejun Heo 
49833d1cb205STejun Heo /**
49843d1cb205STejun Heo  * set_worker_desc - set description for the current work item
49853d1cb205STejun Heo  * @fmt: printf-style format string
49863d1cb205STejun Heo  * @...: arguments for the format string
49873d1cb205STejun Heo  *
49883d1cb205STejun Heo  * This function can be called by a running work function to describe what
49893d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
49903d1cb205STejun Heo  * information will be printed out together to help debugging.  The
49913d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
49923d1cb205STejun Heo  */
49933d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
49943d1cb205STejun Heo {
49953d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
49963d1cb205STejun Heo 	va_list args;
49973d1cb205STejun Heo 
49983d1cb205STejun Heo 	if (worker) {
49993d1cb205STejun Heo 		va_start(args, fmt);
50003d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
50013d1cb205STejun Heo 		va_end(args);
50023d1cb205STejun Heo 	}
50033d1cb205STejun Heo }
50045c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc);
50053d1cb205STejun Heo 
50063d1cb205STejun Heo /**
50073d1cb205STejun Heo  * print_worker_info - print out worker information and description
50083d1cb205STejun Heo  * @log_lvl: the log level to use when printing
50093d1cb205STejun Heo  * @task: target task
50103d1cb205STejun Heo  *
50113d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
50123d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
50133d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
50143d1cb205STejun Heo  *
50153d1cb205STejun Heo  * This function can be safely called on any task as long as the
50163d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
50173d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
50183d1cb205STejun Heo  */
50193d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
50203d1cb205STejun Heo {
50213d1cb205STejun Heo 	work_func_t *fn = NULL;
50223d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
50233d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
50243d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
50253d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
50263d1cb205STejun Heo 	struct worker *worker;
50273d1cb205STejun Heo 
50283d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
50293d1cb205STejun Heo 		return;
50303d1cb205STejun Heo 
50313d1cb205STejun Heo 	/*
50323d1cb205STejun Heo 	 * This function is called without any synchronization and @task
50333d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
50343d1cb205STejun Heo 	 */
5035e700591aSPetr Mladek 	worker = kthread_probe_data(task);
50363d1cb205STejun Heo 
50373d1cb205STejun Heo 	/*
50388bf89593STejun Heo 	 * Carefully copy the associated workqueue's workfn, name and desc.
50398bf89593STejun Heo 	 * Keep the original last '\0' in case the original is garbage.
50403d1cb205STejun Heo 	 */
5041fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
5042fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
5043fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
5044fe557319SChristoph Hellwig 	copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
5045fe557319SChristoph Hellwig 	copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
50463d1cb205STejun Heo 
50473d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
5048d75f773cSSakari Ailus 		printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
50498bf89593STejun Heo 		if (strcmp(name, desc))
50503d1cb205STejun Heo 			pr_cont(" (%s)", desc);
50513d1cb205STejun Heo 		pr_cont("\n");
50523d1cb205STejun Heo 	}
50533d1cb205STejun Heo }
50543d1cb205STejun Heo 
50553494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool)
50563494fc30STejun Heo {
50573494fc30STejun Heo 	pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
50583494fc30STejun Heo 	if (pool->node != NUMA_NO_NODE)
50593494fc30STejun Heo 		pr_cont(" node=%d", pool->node);
50603494fc30STejun Heo 	pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice);
50613494fc30STejun Heo }
50623494fc30STejun Heo 
5063c76feb0dSPaul E. McKenney struct pr_cont_work_struct {
5064c76feb0dSPaul E. McKenney 	bool comma;
5065c76feb0dSPaul E. McKenney 	work_func_t func;
5066c76feb0dSPaul E. McKenney 	long ctr;
5067c76feb0dSPaul E. McKenney };
5068c76feb0dSPaul E. McKenney 
5069c76feb0dSPaul E. McKenney static void pr_cont_work_flush(bool comma, work_func_t func, struct pr_cont_work_struct *pcwsp)
5070c76feb0dSPaul E. McKenney {
5071c76feb0dSPaul E. McKenney 	if (!pcwsp->ctr)
5072c76feb0dSPaul E. McKenney 		goto out_record;
5073c76feb0dSPaul E. McKenney 	if (func == pcwsp->func) {
5074c76feb0dSPaul E. McKenney 		pcwsp->ctr++;
5075c76feb0dSPaul E. McKenney 		return;
5076c76feb0dSPaul E. McKenney 	}
5077c76feb0dSPaul E. McKenney 	if (pcwsp->ctr == 1)
5078c76feb0dSPaul E. McKenney 		pr_cont("%s %ps", pcwsp->comma ? "," : "", pcwsp->func);
5079c76feb0dSPaul E. McKenney 	else
5080c76feb0dSPaul E. McKenney 		pr_cont("%s %ld*%ps", pcwsp->comma ? "," : "", pcwsp->ctr, pcwsp->func);
5081c76feb0dSPaul E. McKenney 	pcwsp->ctr = 0;
5082c76feb0dSPaul E. McKenney out_record:
5083c76feb0dSPaul E. McKenney 	if ((long)func == -1L)
5084c76feb0dSPaul E. McKenney 		return;
5085c76feb0dSPaul E. McKenney 	pcwsp->comma = comma;
5086c76feb0dSPaul E. McKenney 	pcwsp->func = func;
5087c76feb0dSPaul E. McKenney 	pcwsp->ctr = 1;
5088c76feb0dSPaul E. McKenney }
5089c76feb0dSPaul E. McKenney 
5090c76feb0dSPaul E. McKenney static void pr_cont_work(bool comma, struct work_struct *work, struct pr_cont_work_struct *pcwsp)
50913494fc30STejun Heo {
50923494fc30STejun Heo 	if (work->func == wq_barrier_func) {
50933494fc30STejun Heo 		struct wq_barrier *barr;
50943494fc30STejun Heo 
50953494fc30STejun Heo 		barr = container_of(work, struct wq_barrier, work);
50963494fc30STejun Heo 
5097c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
50983494fc30STejun Heo 		pr_cont("%s BAR(%d)", comma ? "," : "",
50993494fc30STejun Heo 			task_pid_nr(barr->task));
51003494fc30STejun Heo 	} else {
5101c76feb0dSPaul E. McKenney 		if (!comma)
5102c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
5103c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, work->func, pcwsp);
51043494fc30STejun Heo 	}
51053494fc30STejun Heo }
51063494fc30STejun Heo 
51073494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq)
51083494fc30STejun Heo {
5109c76feb0dSPaul E. McKenney 	struct pr_cont_work_struct pcws = { .ctr = 0, };
51103494fc30STejun Heo 	struct worker_pool *pool = pwq->pool;
51113494fc30STejun Heo 	struct work_struct *work;
51123494fc30STejun Heo 	struct worker *worker;
51133494fc30STejun Heo 	bool has_in_flight = false, has_pending = false;
51143494fc30STejun Heo 	int bkt;
51153494fc30STejun Heo 
51163494fc30STejun Heo 	pr_info("  pwq %d:", pool->id);
51173494fc30STejun Heo 	pr_cont_pool_info(pool);
51183494fc30STejun Heo 
5119e66b39afSTejun Heo 	pr_cont(" active=%d/%d refcnt=%d%s\n",
5120e66b39afSTejun Heo 		pwq->nr_active, pwq->max_active, pwq->refcnt,
51213494fc30STejun Heo 		!list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
51223494fc30STejun Heo 
51233494fc30STejun Heo 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
51243494fc30STejun Heo 		if (worker->current_pwq == pwq) {
51253494fc30STejun Heo 			has_in_flight = true;
51263494fc30STejun Heo 			break;
51273494fc30STejun Heo 		}
51283494fc30STejun Heo 	}
51293494fc30STejun Heo 	if (has_in_flight) {
51303494fc30STejun Heo 		bool comma = false;
51313494fc30STejun Heo 
51323494fc30STejun Heo 		pr_info("    in-flight:");
51333494fc30STejun Heo 		hash_for_each(pool->busy_hash, bkt, worker, hentry) {
51343494fc30STejun Heo 			if (worker->current_pwq != pwq)
51353494fc30STejun Heo 				continue;
51363494fc30STejun Heo 
5137d75f773cSSakari Ailus 			pr_cont("%s %d%s:%ps", comma ? "," : "",
51383494fc30STejun Heo 				task_pid_nr(worker->task),
513930ae2fc0STejun Heo 				worker->rescue_wq ? "(RESCUER)" : "",
51403494fc30STejun Heo 				worker->current_func);
51413494fc30STejun Heo 			list_for_each_entry(work, &worker->scheduled, entry)
5142c76feb0dSPaul E. McKenney 				pr_cont_work(false, work, &pcws);
5143c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
51443494fc30STejun Heo 			comma = true;
51453494fc30STejun Heo 		}
51463494fc30STejun Heo 		pr_cont("\n");
51473494fc30STejun Heo 	}
51483494fc30STejun Heo 
51493494fc30STejun Heo 	list_for_each_entry(work, &pool->worklist, entry) {
51503494fc30STejun Heo 		if (get_work_pwq(work) == pwq) {
51513494fc30STejun Heo 			has_pending = true;
51523494fc30STejun Heo 			break;
51533494fc30STejun Heo 		}
51543494fc30STejun Heo 	}
51553494fc30STejun Heo 	if (has_pending) {
51563494fc30STejun Heo 		bool comma = false;
51573494fc30STejun Heo 
51583494fc30STejun Heo 		pr_info("    pending:");
51593494fc30STejun Heo 		list_for_each_entry(work, &pool->worklist, entry) {
51603494fc30STejun Heo 			if (get_work_pwq(work) != pwq)
51613494fc30STejun Heo 				continue;
51623494fc30STejun Heo 
5163c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
51643494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
51653494fc30STejun Heo 		}
5166c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
51673494fc30STejun Heo 		pr_cont("\n");
51683494fc30STejun Heo 	}
51693494fc30STejun Heo 
5170f97a4a1aSLai Jiangshan 	if (!list_empty(&pwq->inactive_works)) {
51713494fc30STejun Heo 		bool comma = false;
51723494fc30STejun Heo 
5173f97a4a1aSLai Jiangshan 		pr_info("    inactive:");
5174f97a4a1aSLai Jiangshan 		list_for_each_entry(work, &pwq->inactive_works, entry) {
5175c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
51763494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
51773494fc30STejun Heo 		}
5178c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
51793494fc30STejun Heo 		pr_cont("\n");
51803494fc30STejun Heo 	}
51813494fc30STejun Heo }
51823494fc30STejun Heo 
51833494fc30STejun Heo /**
518455df0933SImran Khan  * show_one_workqueue - dump state of specified workqueue
518555df0933SImran Khan  * @wq: workqueue whose state will be printed
51863494fc30STejun Heo  */
518755df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq)
51883494fc30STejun Heo {
51893494fc30STejun Heo 	struct pool_workqueue *pwq;
51903494fc30STejun Heo 	bool idle = true;
519155df0933SImran Khan 	unsigned long flags;
51923494fc30STejun Heo 
51933494fc30STejun Heo 	for_each_pwq(pwq, wq) {
5194f97a4a1aSLai Jiangshan 		if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
51953494fc30STejun Heo 			idle = false;
51963494fc30STejun Heo 			break;
51973494fc30STejun Heo 		}
51983494fc30STejun Heo 	}
519955df0933SImran Khan 	if (idle) /* Nothing to print for idle workqueue */
520055df0933SImran Khan 		return;
52013494fc30STejun Heo 
52023494fc30STejun Heo 	pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
52033494fc30STejun Heo 
52043494fc30STejun Heo 	for_each_pwq(pwq, wq) {
5205a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irqsave(&pwq->pool->lock, flags);
520657116ce1SJohan Hovold 		if (pwq->nr_active || !list_empty(&pwq->inactive_works)) {
520757116ce1SJohan Hovold 			/*
520857116ce1SJohan Hovold 			 * Defer printing to avoid deadlocks in console
520957116ce1SJohan Hovold 			 * drivers that queue work while holding locks
521057116ce1SJohan Hovold 			 * also taken in their write paths.
521157116ce1SJohan Hovold 			 */
521257116ce1SJohan Hovold 			printk_deferred_enter();
52133494fc30STejun Heo 			show_pwq(pwq);
521457116ce1SJohan Hovold 			printk_deferred_exit();
521557116ce1SJohan Hovold 		}
5216a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irqrestore(&pwq->pool->lock, flags);
521762635ea8SSergey Senozhatsky 		/*
521862635ea8SSergey Senozhatsky 		 * We could be printing a lot from atomic context, e.g.
521955df0933SImran Khan 		 * sysrq-t -> show_all_workqueues(). Avoid triggering
522062635ea8SSergey Senozhatsky 		 * hard lockup.
522162635ea8SSergey Senozhatsky 		 */
522262635ea8SSergey Senozhatsky 		touch_nmi_watchdog();
52233494fc30STejun Heo 	}
522455df0933SImran Khan 
52253494fc30STejun Heo }
52263494fc30STejun Heo 
522755df0933SImran Khan /**
522855df0933SImran Khan  * show_one_worker_pool - dump state of specified worker pool
522955df0933SImran Khan  * @pool: worker pool whose state will be printed
523055df0933SImran Khan  */
523155df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool)
523255df0933SImran Khan {
52333494fc30STejun Heo 	struct worker *worker;
52343494fc30STejun Heo 	bool first = true;
523555df0933SImran Khan 	unsigned long flags;
5236335a42ebSPetr Mladek 	unsigned long hung = 0;
52373494fc30STejun Heo 
5238a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irqsave(&pool->lock, flags);
52393494fc30STejun Heo 	if (pool->nr_workers == pool->nr_idle)
52403494fc30STejun Heo 		goto next_pool;
5241335a42ebSPetr Mladek 
5242335a42ebSPetr Mladek 	/* How long the first pending work is waiting for a worker. */
5243335a42ebSPetr Mladek 	if (!list_empty(&pool->worklist))
5244335a42ebSPetr Mladek 		hung = jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000;
5245335a42ebSPetr Mladek 
524657116ce1SJohan Hovold 	/*
524757116ce1SJohan Hovold 	 * Defer printing to avoid deadlocks in console drivers that
524857116ce1SJohan Hovold 	 * queue work while holding locks also taken in their write
524957116ce1SJohan Hovold 	 * paths.
525057116ce1SJohan Hovold 	 */
525157116ce1SJohan Hovold 	printk_deferred_enter();
52523494fc30STejun Heo 	pr_info("pool %d:", pool->id);
52533494fc30STejun Heo 	pr_cont_pool_info(pool);
5254335a42ebSPetr Mladek 	pr_cont(" hung=%lus workers=%d", hung, pool->nr_workers);
52553494fc30STejun Heo 	if (pool->manager)
52563494fc30STejun Heo 		pr_cont(" manager: %d",
52573494fc30STejun Heo 			task_pid_nr(pool->manager->task));
52583494fc30STejun Heo 	list_for_each_entry(worker, &pool->idle_list, entry) {
52593494fc30STejun Heo 		pr_cont(" %s%d", first ? "idle: " : "",
52603494fc30STejun Heo 			task_pid_nr(worker->task));
52613494fc30STejun Heo 		first = false;
52623494fc30STejun Heo 	}
52633494fc30STejun Heo 	pr_cont("\n");
526457116ce1SJohan Hovold 	printk_deferred_exit();
52653494fc30STejun Heo next_pool:
5266a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irqrestore(&pool->lock, flags);
526762635ea8SSergey Senozhatsky 	/*
526862635ea8SSergey Senozhatsky 	 * We could be printing a lot from atomic context, e.g.
526955df0933SImran Khan 	 * sysrq-t -> show_all_workqueues(). Avoid triggering
527062635ea8SSergey Senozhatsky 	 * hard lockup.
527162635ea8SSergey Senozhatsky 	 */
527262635ea8SSergey Senozhatsky 	touch_nmi_watchdog();
527355df0933SImran Khan 
52743494fc30STejun Heo }
52753494fc30STejun Heo 
527655df0933SImran Khan /**
527755df0933SImran Khan  * show_all_workqueues - dump workqueue state
527855df0933SImran Khan  *
5279704bc669SJungseung Lee  * Called from a sysrq handler and prints out all busy workqueues and pools.
528055df0933SImran Khan  */
528155df0933SImran Khan void show_all_workqueues(void)
528255df0933SImran Khan {
528355df0933SImran Khan 	struct workqueue_struct *wq;
528455df0933SImran Khan 	struct worker_pool *pool;
528555df0933SImran Khan 	int pi;
528655df0933SImran Khan 
528755df0933SImran Khan 	rcu_read_lock();
528855df0933SImran Khan 
528955df0933SImran Khan 	pr_info("Showing busy workqueues and worker pools:\n");
529055df0933SImran Khan 
529155df0933SImran Khan 	list_for_each_entry_rcu(wq, &workqueues, list)
529255df0933SImran Khan 		show_one_workqueue(wq);
529355df0933SImran Khan 
529455df0933SImran Khan 	for_each_pool(pool, pi)
529555df0933SImran Khan 		show_one_worker_pool(pool);
529655df0933SImran Khan 
529724acfb71SThomas Gleixner 	rcu_read_unlock();
52983494fc30STejun Heo }
52993494fc30STejun Heo 
5300704bc669SJungseung Lee /**
5301704bc669SJungseung Lee  * show_freezable_workqueues - dump freezable workqueue state
5302704bc669SJungseung Lee  *
5303704bc669SJungseung Lee  * Called from try_to_freeze_tasks() and prints out all freezable workqueues
5304704bc669SJungseung Lee  * still busy.
5305704bc669SJungseung Lee  */
5306704bc669SJungseung Lee void show_freezable_workqueues(void)
5307704bc669SJungseung Lee {
5308704bc669SJungseung Lee 	struct workqueue_struct *wq;
5309704bc669SJungseung Lee 
5310704bc669SJungseung Lee 	rcu_read_lock();
5311704bc669SJungseung Lee 
5312704bc669SJungseung Lee 	pr_info("Showing freezable workqueues that are still busy:\n");
5313704bc669SJungseung Lee 
5314704bc669SJungseung Lee 	list_for_each_entry_rcu(wq, &workqueues, list) {
5315704bc669SJungseung Lee 		if (!(wq->flags & WQ_FREEZABLE))
5316704bc669SJungseung Lee 			continue;
5317704bc669SJungseung Lee 		show_one_workqueue(wq);
5318704bc669SJungseung Lee 	}
5319704bc669SJungseung Lee 
5320704bc669SJungseung Lee 	rcu_read_unlock();
5321704bc669SJungseung Lee }
5322704bc669SJungseung Lee 
53236b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */
53246b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
53256b59808bSTejun Heo {
53266b59808bSTejun Heo 	int off;
53276b59808bSTejun Heo 
53286b59808bSTejun Heo 	/* always show the actual comm */
53296b59808bSTejun Heo 	off = strscpy(buf, task->comm, size);
53306b59808bSTejun Heo 	if (off < 0)
53316b59808bSTejun Heo 		return;
53326b59808bSTejun Heo 
5333197f6accSTejun Heo 	/* stabilize PF_WQ_WORKER and worker pool association */
53346b59808bSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
53356b59808bSTejun Heo 
5336197f6accSTejun Heo 	if (task->flags & PF_WQ_WORKER) {
5337197f6accSTejun Heo 		struct worker *worker = kthread_data(task);
5338197f6accSTejun Heo 		struct worker_pool *pool = worker->pool;
53396b59808bSTejun Heo 
53406b59808bSTejun Heo 		if (pool) {
5341a9b8a985SSebastian Andrzej Siewior 			raw_spin_lock_irq(&pool->lock);
53426b59808bSTejun Heo 			/*
5343197f6accSTejun Heo 			 * ->desc tracks information (wq name or
5344197f6accSTejun Heo 			 * set_worker_desc()) for the latest execution.  If
5345197f6accSTejun Heo 			 * current, prepend '+', otherwise '-'.
53466b59808bSTejun Heo 			 */
53476b59808bSTejun Heo 			if (worker->desc[0] != '\0') {
53486b59808bSTejun Heo 				if (worker->current_work)
53496b59808bSTejun Heo 					scnprintf(buf + off, size - off, "+%s",
53506b59808bSTejun Heo 						  worker->desc);
53516b59808bSTejun Heo 				else
53526b59808bSTejun Heo 					scnprintf(buf + off, size - off, "-%s",
53536b59808bSTejun Heo 						  worker->desc);
53546b59808bSTejun Heo 			}
5355a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pool->lock);
53566b59808bSTejun Heo 		}
5357197f6accSTejun Heo 	}
53586b59808bSTejun Heo 
53596b59808bSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
53606b59808bSTejun Heo }
53616b59808bSTejun Heo 
536266448bc2SMathieu Malaterre #ifdef CONFIG_SMP
536366448bc2SMathieu Malaterre 
5364db7bccf4STejun Heo /*
5365db7bccf4STejun Heo  * CPU hotplug.
5366db7bccf4STejun Heo  *
5367e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
5368112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
5369706026c2STejun Heo  * pool which make migrating pending and scheduled works very
5370e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
537194cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
5372e22bee78STejun Heo  * blocked draining impractical.
5373e22bee78STejun Heo  *
537424647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
5375628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
5376628c78e7STejun Heo  * cpu comes back online.
5377db7bccf4STejun Heo  */
5378db7bccf4STejun Heo 
5379e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu)
5380db7bccf4STejun Heo {
53814ce62e9eSTejun Heo 	struct worker_pool *pool;
5382db7bccf4STejun Heo 	struct worker *worker;
5383db7bccf4STejun Heo 
5384f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
53851258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
5386a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
5387e22bee78STejun Heo 
5388f2d5a0eeSTejun Heo 		/*
538992f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
539094cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
539111b45b0bSLai Jiangshan 		 * must be on the cpu.  After this, they may become diasporas.
5392b4ac9384SLai Jiangshan 		 * And the preemption disabled section in their sched callbacks
5393b4ac9384SLai Jiangshan 		 * are guaranteed to see WORKER_UNBOUND since the code here
5394b4ac9384SLai Jiangshan 		 * is on the same cpu.
5395f2d5a0eeSTejun Heo 		 */
5396da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
5397403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
5398db7bccf4STejun Heo 
539924647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
5400f2d5a0eeSTejun Heo 
5401e22bee78STejun Heo 		/*
5402989442d7SLai Jiangshan 		 * The handling of nr_running in sched callbacks are disabled
5403989442d7SLai Jiangshan 		 * now.  Zap nr_running.  After this, nr_running stays zero and
5404989442d7SLai Jiangshan 		 * need_more_worker() and keep_working() are always true as
5405989442d7SLai Jiangshan 		 * long as the worklist is not empty.  This pool now behaves as
5406989442d7SLai Jiangshan 		 * an unbound (in terms of concurrency management) pool which
5407eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
5408e22bee78STejun Heo 		 */
5409bc35f7efSLai Jiangshan 		pool->nr_running = 0;
5410eb283428SLai Jiangshan 
5411eb283428SLai Jiangshan 		/*
5412eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
5413eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
5414eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
5415eb283428SLai Jiangshan 		 */
54160219a352STejun Heo 		kick_pool(pool);
5417989442d7SLai Jiangshan 
5418a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
5419989442d7SLai Jiangshan 
5420793777bcSValentin Schneider 		for_each_pool_worker(worker, pool)
5421793777bcSValentin Schneider 			unbind_worker(worker);
5422989442d7SLai Jiangshan 
5423989442d7SLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
5424eb283428SLai Jiangshan 	}
5425db7bccf4STejun Heo }
5426db7bccf4STejun Heo 
5427bd7c089eSTejun Heo /**
5428bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
5429bd7c089eSTejun Heo  * @pool: pool of interest
5430bd7c089eSTejun Heo  *
5431a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
5432bd7c089eSTejun Heo  */
5433bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
5434bd7c089eSTejun Heo {
5435a9ab775bSTejun Heo 	struct worker *worker;
5436bd7c089eSTejun Heo 
54371258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
5438bd7c089eSTejun Heo 
5439bd7c089eSTejun Heo 	/*
5440a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
5441a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
5442402dd89dSShailendra Verma 	 * wake-ups for concurrency management happen, restore CPU affinity
5443a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
5444a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
5445bd7c089eSTejun Heo 	 */
5446c63a2e52SValentin Schneider 	for_each_pool_worker(worker, pool) {
5447c63a2e52SValentin Schneider 		kthread_set_per_cpu(worker->task, pool->cpu);
5448c63a2e52SValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
54499546b29eSTejun Heo 						  pool_allowed_cpus(pool)) < 0);
5450c63a2e52SValentin Schneider 	}
5451a9ab775bSTejun Heo 
5452a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
5453f7c17d26SWanpeng Li 
54543de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
5455a9ab775bSTejun Heo 
5456da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
5457a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
5458a9ab775bSTejun Heo 
5459a9ab775bSTejun Heo 		/*
5460a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
5461a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
5462a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
5463a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
5464a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
5465a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
5466a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
5467a9ab775bSTejun Heo 		 *
5468c95491edSMark Rutland 		 * WRITE_ONCE() is necessary because @worker->flags may be
5469a9ab775bSTejun Heo 		 * tested without holding any lock in
54706d25be57SThomas Gleixner 		 * wq_worker_running().  Without it, NOT_RUNNING test may
5471a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
5472a9ab775bSTejun Heo 		 * management operations.
5473bd7c089eSTejun Heo 		 */
5474a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
5475a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
5476a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
5477c95491edSMark Rutland 		WRITE_ONCE(worker->flags, worker_flags);
5478bd7c089eSTejun Heo 	}
5479a9ab775bSTejun Heo 
5480a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
5481bd7c089eSTejun Heo }
5482bd7c089eSTejun Heo 
54837dbc725eSTejun Heo /**
54847dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
54857dbc725eSTejun Heo  * @pool: unbound pool of interest
54867dbc725eSTejun Heo  * @cpu: the CPU which is coming up
54877dbc725eSTejun Heo  *
54887dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
54897dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
54907dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
54917dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
54927dbc725eSTejun Heo  */
54937dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
54947dbc725eSTejun Heo {
54957dbc725eSTejun Heo 	static cpumask_t cpumask;
54967dbc725eSTejun Heo 	struct worker *worker;
54977dbc725eSTejun Heo 
54981258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
54997dbc725eSTejun Heo 
55007dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
55017dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
55027dbc725eSTejun Heo 		return;
55037dbc725eSTejun Heo 
55047dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
55057dbc725eSTejun Heo 
55067dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
5507da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
5508d945b5e9SPeter Zijlstra 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
55097dbc725eSTejun Heo }
55107dbc725eSTejun Heo 
55117ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu)
55121da177e4SLinus Torvalds {
55134ce62e9eSTejun Heo 	struct worker_pool *pool;
55141da177e4SLinus Torvalds 
5515f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
55163ce63377STejun Heo 		if (pool->nr_workers)
55173ce63377STejun Heo 			continue;
5518051e1850SLai Jiangshan 		if (!create_worker(pool))
55197ee681b2SThomas Gleixner 			return -ENOMEM;
55203af24433SOleg Nesterov 	}
55217ee681b2SThomas Gleixner 	return 0;
55227ee681b2SThomas Gleixner }
55231da177e4SLinus Torvalds 
55247ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu)
55257ee681b2SThomas Gleixner {
55267ee681b2SThomas Gleixner 	struct worker_pool *pool;
55277ee681b2SThomas Gleixner 	struct workqueue_struct *wq;
55287ee681b2SThomas Gleixner 	int pi;
55297ee681b2SThomas Gleixner 
553068e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
55317dbc725eSTejun Heo 
55327dbc725eSTejun Heo 	for_each_pool(pool, pi) {
55331258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
553494cf58bbSTejun Heo 
5535f05b558dSLai Jiangshan 		if (pool->cpu == cpu)
553694cf58bbSTejun Heo 			rebind_workers(pool);
5537f05b558dSLai Jiangshan 		else if (pool->cpu < 0)
55387dbc725eSTejun Heo 			restore_unbound_workers_cpumask(pool, cpu);
553994cf58bbSTejun Heo 
55401258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
554194cf58bbSTejun Heo 	}
55427dbc725eSTejun Heo 
5543fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
55444cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
554584193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
554684193c07STejun Heo 
554784193c07STejun Heo 		if (attrs) {
554884193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
55494cbfd3deSTejun Heo 			int tcpu;
55504cbfd3deSTejun Heo 
555184193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
5552fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, true);
55534cbfd3deSTejun Heo 		}
55544cbfd3deSTejun Heo 	}
55554c16bd32STejun Heo 
555668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
55577ee681b2SThomas Gleixner 	return 0;
555865758202STejun Heo }
555965758202STejun Heo 
55607ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu)
556165758202STejun Heo {
55624c16bd32STejun Heo 	struct workqueue_struct *wq;
55638db25e78STejun Heo 
55644c16bd32STejun Heo 	/* unbinding per-cpu workers should happen on the local CPU */
5565e8b3f8dbSLai Jiangshan 	if (WARN_ON(cpu != smp_processor_id()))
5566e8b3f8dbSLai Jiangshan 		return -1;
5567e8b3f8dbSLai Jiangshan 
5568e8b3f8dbSLai Jiangshan 	unbind_workers(cpu);
55694c16bd32STejun Heo 
5570fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
55714c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
55724cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
557384193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
557484193c07STejun Heo 
557584193c07STejun Heo 		if (attrs) {
557684193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
55774cbfd3deSTejun Heo 			int tcpu;
55784cbfd3deSTejun Heo 
557984193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
5580fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, false);
55814cbfd3deSTejun Heo 		}
55824cbfd3deSTejun Heo 	}
55834c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
55844c16bd32STejun Heo 
55857ee681b2SThomas Gleixner 	return 0;
558665758202STejun Heo }
558765758202STejun Heo 
55882d3854a3SRusty Russell struct work_for_cpu {
5589ed48ece2STejun Heo 	struct work_struct work;
55902d3854a3SRusty Russell 	long (*fn)(void *);
55912d3854a3SRusty Russell 	void *arg;
55922d3854a3SRusty Russell 	long ret;
55932d3854a3SRusty Russell };
55942d3854a3SRusty Russell 
5595ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
55962d3854a3SRusty Russell {
5597ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
5598ed48ece2STejun Heo 
55992d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
56002d3854a3SRusty Russell }
56012d3854a3SRusty Russell 
56022d3854a3SRusty Russell /**
560322aceb31SAnna-Maria Gleixner  * work_on_cpu - run a function in thread context on a particular cpu
56042d3854a3SRusty Russell  * @cpu: the cpu to run on
56052d3854a3SRusty Russell  * @fn: the function to run
56062d3854a3SRusty Russell  * @arg: the function arg
56072d3854a3SRusty Russell  *
560831ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
56096b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
5610d185af30SYacine Belkadi  *
5611d185af30SYacine Belkadi  * Return: The value @fn returns.
56122d3854a3SRusty Russell  */
5613d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
56142d3854a3SRusty Russell {
5615ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
56162d3854a3SRusty Russell 
5617ed48ece2STejun Heo 	INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
5618ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
561912997d1aSBjorn Helgaas 	flush_work(&wfc.work);
5620440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
56212d3854a3SRusty Russell 	return wfc.ret;
56222d3854a3SRusty Russell }
56232d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu);
56240e8d6a93SThomas Gleixner 
56250e8d6a93SThomas Gleixner /**
56260e8d6a93SThomas Gleixner  * work_on_cpu_safe - run a function in thread context on a particular cpu
56270e8d6a93SThomas Gleixner  * @cpu: the cpu to run on
56280e8d6a93SThomas Gleixner  * @fn:  the function to run
56290e8d6a93SThomas Gleixner  * @arg: the function argument
56300e8d6a93SThomas Gleixner  *
56310e8d6a93SThomas Gleixner  * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
56320e8d6a93SThomas Gleixner  * any locks which would prevent @fn from completing.
56330e8d6a93SThomas Gleixner  *
56340e8d6a93SThomas Gleixner  * Return: The value @fn returns.
56350e8d6a93SThomas Gleixner  */
56360e8d6a93SThomas Gleixner long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
56370e8d6a93SThomas Gleixner {
56380e8d6a93SThomas Gleixner 	long ret = -ENODEV;
56390e8d6a93SThomas Gleixner 
5640ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
56410e8d6a93SThomas Gleixner 	if (cpu_online(cpu))
56420e8d6a93SThomas Gleixner 		ret = work_on_cpu(cpu, fn, arg);
5643ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
56440e8d6a93SThomas Gleixner 	return ret;
56450e8d6a93SThomas Gleixner }
56460e8d6a93SThomas Gleixner EXPORT_SYMBOL_GPL(work_on_cpu_safe);
56472d3854a3SRusty Russell #endif /* CONFIG_SMP */
56482d3854a3SRusty Russell 
5649a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
5650e7577c50SRusty Russell 
5651a0a1a5fdSTejun Heo /**
5652a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
5653a0a1a5fdSTejun Heo  *
565458a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
5655f97a4a1aSLai Jiangshan  * workqueues will queue new works to their inactive_works list instead of
5656706026c2STejun Heo  * pool->worklist.
5657a0a1a5fdSTejun Heo  *
5658a0a1a5fdSTejun Heo  * CONTEXT:
5659a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5660a0a1a5fdSTejun Heo  */
5661a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
5662a0a1a5fdSTejun Heo {
566324b8a847STejun Heo 	struct workqueue_struct *wq;
566424b8a847STejun Heo 	struct pool_workqueue *pwq;
5665a0a1a5fdSTejun Heo 
566668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5667a0a1a5fdSTejun Heo 
56686183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
5669a0a1a5fdSTejun Heo 	workqueue_freezing = true;
5670a0a1a5fdSTejun Heo 
567124b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
5672a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
5673699ce097STejun Heo 		for_each_pwq(pwq, wq)
5674699ce097STejun Heo 			pwq_adjust_max_active(pwq);
5675a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
5676a1056305STejun Heo 	}
56775bcab335STejun Heo 
567868e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5679a0a1a5fdSTejun Heo }
5680a0a1a5fdSTejun Heo 
5681a0a1a5fdSTejun Heo /**
568258a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
5683a0a1a5fdSTejun Heo  *
5684a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
5685a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
5686a0a1a5fdSTejun Heo  *
5687a0a1a5fdSTejun Heo  * CONTEXT:
568868e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
5689a0a1a5fdSTejun Heo  *
5690d185af30SYacine Belkadi  * Return:
569158a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
569258a69cb4STejun Heo  * is complete.
5693a0a1a5fdSTejun Heo  */
5694a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
5695a0a1a5fdSTejun Heo {
5696a0a1a5fdSTejun Heo 	bool busy = false;
569724b8a847STejun Heo 	struct workqueue_struct *wq;
569824b8a847STejun Heo 	struct pool_workqueue *pwq;
5699a0a1a5fdSTejun Heo 
570068e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5701a0a1a5fdSTejun Heo 
57026183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
5703a0a1a5fdSTejun Heo 
570424b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
570524b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
570624b8a847STejun Heo 			continue;
5707a0a1a5fdSTejun Heo 		/*
5708a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
5709a0a1a5fdSTejun Heo 		 * to peek without lock.
5710a0a1a5fdSTejun Heo 		 */
571124acfb71SThomas Gleixner 		rcu_read_lock();
571224b8a847STejun Heo 		for_each_pwq(pwq, wq) {
57136183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
5714112202d9STejun Heo 			if (pwq->nr_active) {
5715a0a1a5fdSTejun Heo 				busy = true;
571624acfb71SThomas Gleixner 				rcu_read_unlock();
5717a0a1a5fdSTejun Heo 				goto out_unlock;
5718a0a1a5fdSTejun Heo 			}
5719a0a1a5fdSTejun Heo 		}
572024acfb71SThomas Gleixner 		rcu_read_unlock();
5721a0a1a5fdSTejun Heo 	}
5722a0a1a5fdSTejun Heo out_unlock:
572368e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5724a0a1a5fdSTejun Heo 	return busy;
5725a0a1a5fdSTejun Heo }
5726a0a1a5fdSTejun Heo 
5727a0a1a5fdSTejun Heo /**
5728a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
5729a0a1a5fdSTejun Heo  *
5730a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
5731706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
5732a0a1a5fdSTejun Heo  *
5733a0a1a5fdSTejun Heo  * CONTEXT:
5734a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
5735a0a1a5fdSTejun Heo  */
5736a0a1a5fdSTejun Heo void thaw_workqueues(void)
5737a0a1a5fdSTejun Heo {
573824b8a847STejun Heo 	struct workqueue_struct *wq;
573924b8a847STejun Heo 	struct pool_workqueue *pwq;
5740a0a1a5fdSTejun Heo 
574168e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5742a0a1a5fdSTejun Heo 
5743a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
5744a0a1a5fdSTejun Heo 		goto out_unlock;
5745a0a1a5fdSTejun Heo 
574674b414eaSLai Jiangshan 	workqueue_freezing = false;
574724b8a847STejun Heo 
574824b8a847STejun Heo 	/* restore max_active and repopulate worklist */
574924b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
5750a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
5751699ce097STejun Heo 		for_each_pwq(pwq, wq)
5752699ce097STejun Heo 			pwq_adjust_max_active(pwq);
5753a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
575424b8a847STejun Heo 	}
575524b8a847STejun Heo 
5756a0a1a5fdSTejun Heo out_unlock:
575768e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
5758a0a1a5fdSTejun Heo }
5759a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
5760a0a1a5fdSTejun Heo 
576199c621efSLai Jiangshan static int workqueue_apply_unbound_cpumask(const cpumask_var_t unbound_cpumask)
5762042f7df1SLai Jiangshan {
5763042f7df1SLai Jiangshan 	LIST_HEAD(ctxs);
5764042f7df1SLai Jiangshan 	int ret = 0;
5765042f7df1SLai Jiangshan 	struct workqueue_struct *wq;
5766042f7df1SLai Jiangshan 	struct apply_wqattrs_ctx *ctx, *n;
5767042f7df1SLai Jiangshan 
5768042f7df1SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5769042f7df1SLai Jiangshan 
5770042f7df1SLai Jiangshan 	list_for_each_entry(wq, &workqueues, list) {
5771042f7df1SLai Jiangshan 		if (!(wq->flags & WQ_UNBOUND))
5772042f7df1SLai Jiangshan 			continue;
5773042f7df1SLai Jiangshan 		/* creating multiple pwqs breaks ordering guarantee */
5774042f7df1SLai Jiangshan 		if (wq->flags & __WQ_ORDERED)
5775042f7df1SLai Jiangshan 			continue;
5776042f7df1SLai Jiangshan 
577799c621efSLai Jiangshan 		ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs, unbound_cpumask);
577884193c07STejun Heo 		if (IS_ERR(ctx)) {
577984193c07STejun Heo 			ret = PTR_ERR(ctx);
5780042f7df1SLai Jiangshan 			break;
5781042f7df1SLai Jiangshan 		}
5782042f7df1SLai Jiangshan 
5783042f7df1SLai Jiangshan 		list_add_tail(&ctx->list, &ctxs);
5784042f7df1SLai Jiangshan 	}
5785042f7df1SLai Jiangshan 
5786042f7df1SLai Jiangshan 	list_for_each_entry_safe(ctx, n, &ctxs, list) {
5787042f7df1SLai Jiangshan 		if (!ret)
5788042f7df1SLai Jiangshan 			apply_wqattrs_commit(ctx);
5789042f7df1SLai Jiangshan 		apply_wqattrs_cleanup(ctx);
5790042f7df1SLai Jiangshan 	}
5791042f7df1SLai Jiangshan 
579299c621efSLai Jiangshan 	if (!ret) {
579399c621efSLai Jiangshan 		mutex_lock(&wq_pool_attach_mutex);
579499c621efSLai Jiangshan 		cpumask_copy(wq_unbound_cpumask, unbound_cpumask);
579599c621efSLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
579699c621efSLai Jiangshan 	}
5797042f7df1SLai Jiangshan 	return ret;
5798042f7df1SLai Jiangshan }
5799042f7df1SLai Jiangshan 
5800042f7df1SLai Jiangshan /**
5801042f7df1SLai Jiangshan  *  workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
5802042f7df1SLai Jiangshan  *  @cpumask: the cpumask to set
5803042f7df1SLai Jiangshan  *
5804042f7df1SLai Jiangshan  *  The low-level workqueues cpumask is a global cpumask that limits
5805042f7df1SLai Jiangshan  *  the affinity of all unbound workqueues.  This function check the @cpumask
5806042f7df1SLai Jiangshan  *  and apply it to all unbound workqueues and updates all pwqs of them.
5807042f7df1SLai Jiangshan  *
580867dc8325SCai Huoqing  *  Return:	0	- Success
5809042f7df1SLai Jiangshan  *  		-EINVAL	- Invalid @cpumask
5810042f7df1SLai Jiangshan  *  		-ENOMEM	- Failed to allocate memory for attrs or pwqs.
5811042f7df1SLai Jiangshan  */
5812042f7df1SLai Jiangshan int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
5813042f7df1SLai Jiangshan {
5814042f7df1SLai Jiangshan 	int ret = -EINVAL;
5815042f7df1SLai Jiangshan 
5816c98a9805STal Shorer 	/*
5817c98a9805STal Shorer 	 * Not excluding isolated cpus on purpose.
5818c98a9805STal Shorer 	 * If the user wishes to include them, we allow that.
5819c98a9805STal Shorer 	 */
5820042f7df1SLai Jiangshan 	cpumask_and(cpumask, cpumask, cpu_possible_mask);
5821042f7df1SLai Jiangshan 	if (!cpumask_empty(cpumask)) {
5822a0111cf6SLai Jiangshan 		apply_wqattrs_lock();
5823d25302e4SMenglong Dong 		if (cpumask_equal(cpumask, wq_unbound_cpumask)) {
5824d25302e4SMenglong Dong 			ret = 0;
5825d25302e4SMenglong Dong 			goto out_unlock;
5826d25302e4SMenglong Dong 		}
5827d25302e4SMenglong Dong 
582899c621efSLai Jiangshan 		ret = workqueue_apply_unbound_cpumask(cpumask);
5829042f7df1SLai Jiangshan 
5830d25302e4SMenglong Dong out_unlock:
5831a0111cf6SLai Jiangshan 		apply_wqattrs_unlock();
5832042f7df1SLai Jiangshan 	}
5833042f7df1SLai Jiangshan 
5834042f7df1SLai Jiangshan 	return ret;
5835042f7df1SLai Jiangshan }
5836042f7df1SLai Jiangshan 
583763c5484eSTejun Heo static int parse_affn_scope(const char *val)
583863c5484eSTejun Heo {
583963c5484eSTejun Heo 	int i;
584063c5484eSTejun Heo 
584163c5484eSTejun Heo 	for (i = 0; i < ARRAY_SIZE(wq_affn_names); i++) {
584263c5484eSTejun Heo 		if (!strncasecmp(val, wq_affn_names[i], strlen(wq_affn_names[i])))
584363c5484eSTejun Heo 			return i;
584463c5484eSTejun Heo 	}
584563c5484eSTejun Heo 	return -EINVAL;
584663c5484eSTejun Heo }
584763c5484eSTejun Heo 
584863c5484eSTejun Heo static int wq_affn_dfl_set(const char *val, const struct kernel_param *kp)
584963c5484eSTejun Heo {
585063c5484eSTejun Heo 	int affn;
585163c5484eSTejun Heo 
585263c5484eSTejun Heo 	affn = parse_affn_scope(val);
585363c5484eSTejun Heo 	if (affn < 0)
585463c5484eSTejun Heo 		return affn;
585563c5484eSTejun Heo 
585663c5484eSTejun Heo 	wq_affn_dfl = affn;
585763c5484eSTejun Heo 	return 0;
585863c5484eSTejun Heo }
585963c5484eSTejun Heo 
586063c5484eSTejun Heo static int wq_affn_dfl_get(char *buffer, const struct kernel_param *kp)
586163c5484eSTejun Heo {
586263c5484eSTejun Heo 	return scnprintf(buffer, PAGE_SIZE, "%s\n", wq_affn_names[wq_affn_dfl]);
586363c5484eSTejun Heo }
586463c5484eSTejun Heo 
586563c5484eSTejun Heo static const struct kernel_param_ops wq_affn_dfl_ops = {
586663c5484eSTejun Heo 	.set	= wq_affn_dfl_set,
586763c5484eSTejun Heo 	.get	= wq_affn_dfl_get,
586863c5484eSTejun Heo };
586963c5484eSTejun Heo 
587063c5484eSTejun Heo module_param_cb(default_affinity_scope, &wq_affn_dfl_ops, NULL, 0644);
587163c5484eSTejun Heo 
58726ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS
58736ba94429SFrederic Weisbecker /*
58746ba94429SFrederic Weisbecker  * Workqueues with WQ_SYSFS flag set is visible to userland via
58756ba94429SFrederic Weisbecker  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
58766ba94429SFrederic Weisbecker  * following attributes.
58776ba94429SFrederic Weisbecker  *
58786ba94429SFrederic Weisbecker  *  per_cpu		RO bool	: whether the workqueue is per-cpu or unbound
58796ba94429SFrederic Weisbecker  *  max_active		RW int	: maximum number of in-flight work items
58806ba94429SFrederic Weisbecker  *
58816ba94429SFrederic Weisbecker  * Unbound workqueues have the following extra attributes.
58826ba94429SFrederic Weisbecker  *
58836ba94429SFrederic Weisbecker  *  nice		RW int	: nice value of the workers
58846ba94429SFrederic Weisbecker  *  cpumask		RW mask	: bitmask of allowed CPUs for the workers
588563c5484eSTejun Heo  *  affinity_scope	RW str  : worker CPU affinity scope (cache, numa, none)
5886*8639ecebSTejun Heo  *  affinity_strict	RW bool : worker CPU affinity is strict
58876ba94429SFrederic Weisbecker  */
58886ba94429SFrederic Weisbecker struct wq_device {
58896ba94429SFrederic Weisbecker 	struct workqueue_struct		*wq;
58906ba94429SFrederic Weisbecker 	struct device			dev;
58916ba94429SFrederic Weisbecker };
58926ba94429SFrederic Weisbecker 
58936ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev)
58946ba94429SFrederic Weisbecker {
58956ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
58966ba94429SFrederic Weisbecker 
58976ba94429SFrederic Weisbecker 	return wq_dev->wq;
58986ba94429SFrederic Weisbecker }
58996ba94429SFrederic Weisbecker 
59006ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
59016ba94429SFrederic Weisbecker 			    char *buf)
59026ba94429SFrederic Weisbecker {
59036ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
59046ba94429SFrederic Weisbecker 
59056ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
59066ba94429SFrederic Weisbecker }
59076ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu);
59086ba94429SFrederic Weisbecker 
59096ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev,
59106ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
59116ba94429SFrederic Weisbecker {
59126ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
59136ba94429SFrederic Weisbecker 
59146ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
59156ba94429SFrederic Weisbecker }
59166ba94429SFrederic Weisbecker 
59176ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev,
59186ba94429SFrederic Weisbecker 				struct device_attribute *attr, const char *buf,
59196ba94429SFrederic Weisbecker 				size_t count)
59206ba94429SFrederic Weisbecker {
59216ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
59226ba94429SFrederic Weisbecker 	int val;
59236ba94429SFrederic Weisbecker 
59246ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
59256ba94429SFrederic Weisbecker 		return -EINVAL;
59266ba94429SFrederic Weisbecker 
59276ba94429SFrederic Weisbecker 	workqueue_set_max_active(wq, val);
59286ba94429SFrederic Weisbecker 	return count;
59296ba94429SFrederic Weisbecker }
59306ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active);
59316ba94429SFrederic Weisbecker 
59326ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = {
59336ba94429SFrederic Weisbecker 	&dev_attr_per_cpu.attr,
59346ba94429SFrederic Weisbecker 	&dev_attr_max_active.attr,
59356ba94429SFrederic Weisbecker 	NULL,
59366ba94429SFrederic Weisbecker };
59376ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs);
59386ba94429SFrederic Weisbecker 
59396ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
59406ba94429SFrederic Weisbecker 			    char *buf)
59416ba94429SFrederic Weisbecker {
59426ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
59436ba94429SFrederic Weisbecker 	int written;
59446ba94429SFrederic Weisbecker 
59456ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
59466ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
59476ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
59486ba94429SFrederic Weisbecker 
59496ba94429SFrederic Weisbecker 	return written;
59506ba94429SFrederic Weisbecker }
59516ba94429SFrederic Weisbecker 
59526ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */
59536ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
59546ba94429SFrederic Weisbecker {
59556ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
59566ba94429SFrederic Weisbecker 
5957899a94feSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
5958899a94feSLai Jiangshan 
5959be69d00dSThomas Gleixner 	attrs = alloc_workqueue_attrs();
59606ba94429SFrederic Weisbecker 	if (!attrs)
59616ba94429SFrederic Weisbecker 		return NULL;
59626ba94429SFrederic Weisbecker 
59636ba94429SFrederic Weisbecker 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
59646ba94429SFrederic Weisbecker 	return attrs;
59656ba94429SFrederic Weisbecker }
59666ba94429SFrederic Weisbecker 
59676ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
59686ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
59696ba94429SFrederic Weisbecker {
59706ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
59716ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
5972d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
5973d4d3e257SLai Jiangshan 
5974d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
59756ba94429SFrederic Weisbecker 
59766ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
59776ba94429SFrederic Weisbecker 	if (!attrs)
5978d4d3e257SLai Jiangshan 		goto out_unlock;
59796ba94429SFrederic Weisbecker 
59806ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
59816ba94429SFrederic Weisbecker 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
5982d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
59836ba94429SFrederic Weisbecker 	else
59846ba94429SFrederic Weisbecker 		ret = -EINVAL;
59856ba94429SFrederic Weisbecker 
5986d4d3e257SLai Jiangshan out_unlock:
5987d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
59886ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
59896ba94429SFrederic Weisbecker 	return ret ?: count;
59906ba94429SFrederic Weisbecker }
59916ba94429SFrederic Weisbecker 
59926ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev,
59936ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
59946ba94429SFrederic Weisbecker {
59956ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
59966ba94429SFrederic Weisbecker 	int written;
59976ba94429SFrederic Weisbecker 
59986ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
59996ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
60006ba94429SFrederic Weisbecker 			    cpumask_pr_args(wq->unbound_attrs->cpumask));
60016ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
60026ba94429SFrederic Weisbecker 	return written;
60036ba94429SFrederic Weisbecker }
60046ba94429SFrederic Weisbecker 
60056ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev,
60066ba94429SFrederic Weisbecker 				struct device_attribute *attr,
60076ba94429SFrederic Weisbecker 				const char *buf, size_t count)
60086ba94429SFrederic Weisbecker {
60096ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
60106ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
6011d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
6012d4d3e257SLai Jiangshan 
6013d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
60146ba94429SFrederic Weisbecker 
60156ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
60166ba94429SFrederic Weisbecker 	if (!attrs)
6017d4d3e257SLai Jiangshan 		goto out_unlock;
60186ba94429SFrederic Weisbecker 
60196ba94429SFrederic Weisbecker 	ret = cpumask_parse(buf, attrs->cpumask);
60206ba94429SFrederic Weisbecker 	if (!ret)
6021d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
60226ba94429SFrederic Weisbecker 
6023d4d3e257SLai Jiangshan out_unlock:
6024d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
60256ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
60266ba94429SFrederic Weisbecker 	return ret ?: count;
60276ba94429SFrederic Weisbecker }
60286ba94429SFrederic Weisbecker 
602963c5484eSTejun Heo static ssize_t wq_affn_scope_show(struct device *dev,
603063c5484eSTejun Heo 				  struct device_attribute *attr, char *buf)
603163c5484eSTejun Heo {
603263c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
603363c5484eSTejun Heo 	int written;
603463c5484eSTejun Heo 
603563c5484eSTejun Heo 	mutex_lock(&wq->mutex);
603663c5484eSTejun Heo 	written = scnprintf(buf, PAGE_SIZE, "%s\n",
603763c5484eSTejun Heo 			    wq_affn_names[wq->unbound_attrs->affn_scope]);
603863c5484eSTejun Heo 	mutex_unlock(&wq->mutex);
603963c5484eSTejun Heo 
604063c5484eSTejun Heo 	return written;
604163c5484eSTejun Heo }
604263c5484eSTejun Heo 
604363c5484eSTejun Heo static ssize_t wq_affn_scope_store(struct device *dev,
604463c5484eSTejun Heo 				   struct device_attribute *attr,
604563c5484eSTejun Heo 				   const char *buf, size_t count)
604663c5484eSTejun Heo {
604763c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
604863c5484eSTejun Heo 	struct workqueue_attrs *attrs;
604963c5484eSTejun Heo 	int affn, ret = -ENOMEM;
605063c5484eSTejun Heo 
605163c5484eSTejun Heo 	affn = parse_affn_scope(buf);
605263c5484eSTejun Heo 	if (affn < 0)
605363c5484eSTejun Heo 		return affn;
605463c5484eSTejun Heo 
605563c5484eSTejun Heo 	apply_wqattrs_lock();
605663c5484eSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
605763c5484eSTejun Heo 	if (attrs) {
605863c5484eSTejun Heo 		attrs->affn_scope = affn;
605963c5484eSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
606063c5484eSTejun Heo 	}
606163c5484eSTejun Heo 	apply_wqattrs_unlock();
606263c5484eSTejun Heo 	free_workqueue_attrs(attrs);
606363c5484eSTejun Heo 	return ret ?: count;
606463c5484eSTejun Heo }
606563c5484eSTejun Heo 
6066*8639ecebSTejun Heo static ssize_t wq_affinity_strict_show(struct device *dev,
6067*8639ecebSTejun Heo 				       struct device_attribute *attr, char *buf)
6068*8639ecebSTejun Heo {
6069*8639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
6070*8639ecebSTejun Heo 
6071*8639ecebSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n",
6072*8639ecebSTejun Heo 			 wq->unbound_attrs->affn_strict);
6073*8639ecebSTejun Heo }
6074*8639ecebSTejun Heo 
6075*8639ecebSTejun Heo static ssize_t wq_affinity_strict_store(struct device *dev,
6076*8639ecebSTejun Heo 					struct device_attribute *attr,
6077*8639ecebSTejun Heo 					const char *buf, size_t count)
6078*8639ecebSTejun Heo {
6079*8639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
6080*8639ecebSTejun Heo 	struct workqueue_attrs *attrs;
6081*8639ecebSTejun Heo 	int v, ret = -ENOMEM;
6082*8639ecebSTejun Heo 
6083*8639ecebSTejun Heo 	if (sscanf(buf, "%d", &v) != 1)
6084*8639ecebSTejun Heo 		return -EINVAL;
6085*8639ecebSTejun Heo 
6086*8639ecebSTejun Heo 	apply_wqattrs_lock();
6087*8639ecebSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
6088*8639ecebSTejun Heo 	if (attrs) {
6089*8639ecebSTejun Heo 		attrs->affn_strict = (bool)v;
6090*8639ecebSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
6091*8639ecebSTejun Heo 	}
6092*8639ecebSTejun Heo 	apply_wqattrs_unlock();
6093*8639ecebSTejun Heo 	free_workqueue_attrs(attrs);
6094*8639ecebSTejun Heo 	return ret ?: count;
6095*8639ecebSTejun Heo }
6096*8639ecebSTejun Heo 
60976ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = {
60986ba94429SFrederic Weisbecker 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
60996ba94429SFrederic Weisbecker 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
610063c5484eSTejun Heo 	__ATTR(affinity_scope, 0644, wq_affn_scope_show, wq_affn_scope_store),
6101*8639ecebSTejun Heo 	__ATTR(affinity_strict, 0644, wq_affinity_strict_show, wq_affinity_strict_store),
61026ba94429SFrederic Weisbecker 	__ATTR_NULL,
61036ba94429SFrederic Weisbecker };
61046ba94429SFrederic Weisbecker 
61056ba94429SFrederic Weisbecker static struct bus_type wq_subsys = {
61066ba94429SFrederic Weisbecker 	.name				= "workqueue",
61076ba94429SFrederic Weisbecker 	.dev_groups			= wq_sysfs_groups,
61086ba94429SFrederic Weisbecker };
61096ba94429SFrederic Weisbecker 
6110b05a7928SFrederic Weisbecker static ssize_t wq_unbound_cpumask_show(struct device *dev,
6111b05a7928SFrederic Weisbecker 		struct device_attribute *attr, char *buf)
6112b05a7928SFrederic Weisbecker {
6113b05a7928SFrederic Weisbecker 	int written;
6114b05a7928SFrederic Weisbecker 
6115042f7df1SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6116b05a7928SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
6117b05a7928SFrederic Weisbecker 			    cpumask_pr_args(wq_unbound_cpumask));
6118042f7df1SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6119b05a7928SFrederic Weisbecker 
6120b05a7928SFrederic Weisbecker 	return written;
6121b05a7928SFrederic Weisbecker }
6122b05a7928SFrederic Weisbecker 
6123042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev,
6124042f7df1SLai Jiangshan 		struct device_attribute *attr, const char *buf, size_t count)
6125042f7df1SLai Jiangshan {
6126042f7df1SLai Jiangshan 	cpumask_var_t cpumask;
6127042f7df1SLai Jiangshan 	int ret;
6128042f7df1SLai Jiangshan 
6129042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
6130042f7df1SLai Jiangshan 		return -ENOMEM;
6131042f7df1SLai Jiangshan 
6132042f7df1SLai Jiangshan 	ret = cpumask_parse(buf, cpumask);
6133042f7df1SLai Jiangshan 	if (!ret)
6134042f7df1SLai Jiangshan 		ret = workqueue_set_unbound_cpumask(cpumask);
6135042f7df1SLai Jiangshan 
6136042f7df1SLai Jiangshan 	free_cpumask_var(cpumask);
6137042f7df1SLai Jiangshan 	return ret ? ret : count;
6138042f7df1SLai Jiangshan }
6139042f7df1SLai Jiangshan 
6140b05a7928SFrederic Weisbecker static struct device_attribute wq_sysfs_cpumask_attr =
6141042f7df1SLai Jiangshan 	__ATTR(cpumask, 0644, wq_unbound_cpumask_show,
6142042f7df1SLai Jiangshan 	       wq_unbound_cpumask_store);
6143b05a7928SFrederic Weisbecker 
61446ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void)
61456ba94429SFrederic Weisbecker {
6146686f6697SGreg Kroah-Hartman 	struct device *dev_root;
6147b05a7928SFrederic Weisbecker 	int err;
6148b05a7928SFrederic Weisbecker 
6149b05a7928SFrederic Weisbecker 	err = subsys_virtual_register(&wq_subsys, NULL);
6150b05a7928SFrederic Weisbecker 	if (err)
6151b05a7928SFrederic Weisbecker 		return err;
6152b05a7928SFrederic Weisbecker 
6153686f6697SGreg Kroah-Hartman 	dev_root = bus_get_dev_root(&wq_subsys);
6154686f6697SGreg Kroah-Hartman 	if (dev_root) {
6155686f6697SGreg Kroah-Hartman 		err = device_create_file(dev_root, &wq_sysfs_cpumask_attr);
6156686f6697SGreg Kroah-Hartman 		put_device(dev_root);
6157686f6697SGreg Kroah-Hartman 	}
6158686f6697SGreg Kroah-Hartman 	return err;
61596ba94429SFrederic Weisbecker }
61606ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init);
61616ba94429SFrederic Weisbecker 
61626ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev)
61636ba94429SFrederic Weisbecker {
61646ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
61656ba94429SFrederic Weisbecker 
61666ba94429SFrederic Weisbecker 	kfree(wq_dev);
61676ba94429SFrederic Weisbecker }
61686ba94429SFrederic Weisbecker 
61696ba94429SFrederic Weisbecker /**
61706ba94429SFrederic Weisbecker  * workqueue_sysfs_register - make a workqueue visible in sysfs
61716ba94429SFrederic Weisbecker  * @wq: the workqueue to register
61726ba94429SFrederic Weisbecker  *
61736ba94429SFrederic Weisbecker  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
61746ba94429SFrederic Weisbecker  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
61756ba94429SFrederic Weisbecker  * which is the preferred method.
61766ba94429SFrederic Weisbecker  *
61776ba94429SFrederic Weisbecker  * Workqueue user should use this function directly iff it wants to apply
61786ba94429SFrederic Weisbecker  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
61796ba94429SFrederic Weisbecker  * apply_workqueue_attrs() may race against userland updating the
61806ba94429SFrederic Weisbecker  * attributes.
61816ba94429SFrederic Weisbecker  *
61826ba94429SFrederic Weisbecker  * Return: 0 on success, -errno on failure.
61836ba94429SFrederic Weisbecker  */
61846ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq)
61856ba94429SFrederic Weisbecker {
61866ba94429SFrederic Weisbecker 	struct wq_device *wq_dev;
61876ba94429SFrederic Weisbecker 	int ret;
61886ba94429SFrederic Weisbecker 
61896ba94429SFrederic Weisbecker 	/*
6190402dd89dSShailendra Verma 	 * Adjusting max_active or creating new pwqs by applying
61916ba94429SFrederic Weisbecker 	 * attributes breaks ordering guarantee.  Disallow exposing ordered
61926ba94429SFrederic Weisbecker 	 * workqueues.
61936ba94429SFrederic Weisbecker 	 */
61940a94efb5STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT))
61956ba94429SFrederic Weisbecker 		return -EINVAL;
61966ba94429SFrederic Weisbecker 
61976ba94429SFrederic Weisbecker 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
61986ba94429SFrederic Weisbecker 	if (!wq_dev)
61996ba94429SFrederic Weisbecker 		return -ENOMEM;
62006ba94429SFrederic Weisbecker 
62016ba94429SFrederic Weisbecker 	wq_dev->wq = wq;
62026ba94429SFrederic Weisbecker 	wq_dev->dev.bus = &wq_subsys;
62036ba94429SFrederic Weisbecker 	wq_dev->dev.release = wq_device_release;
620423217b44SLars-Peter Clausen 	dev_set_name(&wq_dev->dev, "%s", wq->name);
62056ba94429SFrederic Weisbecker 
62066ba94429SFrederic Weisbecker 	/*
62076ba94429SFrederic Weisbecker 	 * unbound_attrs are created separately.  Suppress uevent until
62086ba94429SFrederic Weisbecker 	 * everything is ready.
62096ba94429SFrederic Weisbecker 	 */
62106ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, true);
62116ba94429SFrederic Weisbecker 
62126ba94429SFrederic Weisbecker 	ret = device_register(&wq_dev->dev);
62136ba94429SFrederic Weisbecker 	if (ret) {
6214537f4146SArvind Yadav 		put_device(&wq_dev->dev);
62156ba94429SFrederic Weisbecker 		wq->wq_dev = NULL;
62166ba94429SFrederic Weisbecker 		return ret;
62176ba94429SFrederic Weisbecker 	}
62186ba94429SFrederic Weisbecker 
62196ba94429SFrederic Weisbecker 	if (wq->flags & WQ_UNBOUND) {
62206ba94429SFrederic Weisbecker 		struct device_attribute *attr;
62216ba94429SFrederic Weisbecker 
62226ba94429SFrederic Weisbecker 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
62236ba94429SFrederic Weisbecker 			ret = device_create_file(&wq_dev->dev, attr);
62246ba94429SFrederic Weisbecker 			if (ret) {
62256ba94429SFrederic Weisbecker 				device_unregister(&wq_dev->dev);
62266ba94429SFrederic Weisbecker 				wq->wq_dev = NULL;
62276ba94429SFrederic Weisbecker 				return ret;
62286ba94429SFrederic Weisbecker 			}
62296ba94429SFrederic Weisbecker 		}
62306ba94429SFrederic Weisbecker 	}
62316ba94429SFrederic Weisbecker 
62326ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, false);
62336ba94429SFrederic Weisbecker 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
62346ba94429SFrederic Weisbecker 	return 0;
62356ba94429SFrederic Weisbecker }
62366ba94429SFrederic Weisbecker 
62376ba94429SFrederic Weisbecker /**
62386ba94429SFrederic Weisbecker  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
62396ba94429SFrederic Weisbecker  * @wq: the workqueue to unregister
62406ba94429SFrederic Weisbecker  *
62416ba94429SFrederic Weisbecker  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
62426ba94429SFrederic Weisbecker  */
62436ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
62446ba94429SFrederic Weisbecker {
62456ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = wq->wq_dev;
62466ba94429SFrederic Weisbecker 
62476ba94429SFrederic Weisbecker 	if (!wq->wq_dev)
62486ba94429SFrederic Weisbecker 		return;
62496ba94429SFrederic Weisbecker 
62506ba94429SFrederic Weisbecker 	wq->wq_dev = NULL;
62516ba94429SFrederic Weisbecker 	device_unregister(&wq_dev->dev);
62526ba94429SFrederic Weisbecker }
62536ba94429SFrederic Weisbecker #else	/* CONFIG_SYSFS */
62546ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
62556ba94429SFrederic Weisbecker #endif	/* CONFIG_SYSFS */
62566ba94429SFrederic Weisbecker 
625782607adcSTejun Heo /*
625882607adcSTejun Heo  * Workqueue watchdog.
625982607adcSTejun Heo  *
626082607adcSTejun Heo  * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
626182607adcSTejun Heo  * flush dependency, a concurrency managed work item which stays RUNNING
626282607adcSTejun Heo  * indefinitely.  Workqueue stalls can be very difficult to debug as the
626382607adcSTejun Heo  * usual warning mechanisms don't trigger and internal workqueue state is
626482607adcSTejun Heo  * largely opaque.
626582607adcSTejun Heo  *
626682607adcSTejun Heo  * Workqueue watchdog monitors all worker pools periodically and dumps
626782607adcSTejun Heo  * state if some pools failed to make forward progress for a while where
626882607adcSTejun Heo  * forward progress is defined as the first item on ->worklist changing.
626982607adcSTejun Heo  *
627082607adcSTejun Heo  * This mechanism is controlled through the kernel parameter
627182607adcSTejun Heo  * "workqueue.watchdog_thresh" which can be updated at runtime through the
627282607adcSTejun Heo  * corresponding sysfs parameter file.
627382607adcSTejun Heo  */
627482607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG
627582607adcSTejun Heo 
627682607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30;
62775cd79d6aSKees Cook static struct timer_list wq_watchdog_timer;
627882607adcSTejun Heo 
627982607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
628082607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
628182607adcSTejun Heo 
6282cd2440d6SPetr Mladek /*
6283cd2440d6SPetr Mladek  * Show workers that might prevent the processing of pending work items.
6284cd2440d6SPetr Mladek  * The only candidates are CPU-bound workers in the running state.
6285cd2440d6SPetr Mladek  * Pending work items should be handled by another idle worker
6286cd2440d6SPetr Mladek  * in all other situations.
6287cd2440d6SPetr Mladek  */
6288cd2440d6SPetr Mladek static void show_cpu_pool_hog(struct worker_pool *pool)
6289cd2440d6SPetr Mladek {
6290cd2440d6SPetr Mladek 	struct worker *worker;
6291cd2440d6SPetr Mladek 	unsigned long flags;
6292cd2440d6SPetr Mladek 	int bkt;
6293cd2440d6SPetr Mladek 
6294cd2440d6SPetr Mladek 	raw_spin_lock_irqsave(&pool->lock, flags);
6295cd2440d6SPetr Mladek 
6296cd2440d6SPetr Mladek 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
6297cd2440d6SPetr Mladek 		if (task_is_running(worker->task)) {
6298cd2440d6SPetr Mladek 			/*
6299cd2440d6SPetr Mladek 			 * Defer printing to avoid deadlocks in console
6300cd2440d6SPetr Mladek 			 * drivers that queue work while holding locks
6301cd2440d6SPetr Mladek 			 * also taken in their write paths.
6302cd2440d6SPetr Mladek 			 */
6303cd2440d6SPetr Mladek 			printk_deferred_enter();
6304cd2440d6SPetr Mladek 
6305cd2440d6SPetr Mladek 			pr_info("pool %d:\n", pool->id);
6306cd2440d6SPetr Mladek 			sched_show_task(worker->task);
6307cd2440d6SPetr Mladek 
6308cd2440d6SPetr Mladek 			printk_deferred_exit();
6309cd2440d6SPetr Mladek 		}
6310cd2440d6SPetr Mladek 	}
6311cd2440d6SPetr Mladek 
6312cd2440d6SPetr Mladek 	raw_spin_unlock_irqrestore(&pool->lock, flags);
6313cd2440d6SPetr Mladek }
6314cd2440d6SPetr Mladek 
6315cd2440d6SPetr Mladek static void show_cpu_pools_hogs(void)
6316cd2440d6SPetr Mladek {
6317cd2440d6SPetr Mladek 	struct worker_pool *pool;
6318cd2440d6SPetr Mladek 	int pi;
6319cd2440d6SPetr Mladek 
6320cd2440d6SPetr Mladek 	pr_info("Showing backtraces of running workers in stalled CPU-bound worker pools:\n");
6321cd2440d6SPetr Mladek 
6322cd2440d6SPetr Mladek 	rcu_read_lock();
6323cd2440d6SPetr Mladek 
6324cd2440d6SPetr Mladek 	for_each_pool(pool, pi) {
6325cd2440d6SPetr Mladek 		if (pool->cpu_stall)
6326cd2440d6SPetr Mladek 			show_cpu_pool_hog(pool);
6327cd2440d6SPetr Mladek 
6328cd2440d6SPetr Mladek 	}
6329cd2440d6SPetr Mladek 
6330cd2440d6SPetr Mladek 	rcu_read_unlock();
6331cd2440d6SPetr Mladek }
6332cd2440d6SPetr Mladek 
633382607adcSTejun Heo static void wq_watchdog_reset_touched(void)
633482607adcSTejun Heo {
633582607adcSTejun Heo 	int cpu;
633682607adcSTejun Heo 
633782607adcSTejun Heo 	wq_watchdog_touched = jiffies;
633882607adcSTejun Heo 	for_each_possible_cpu(cpu)
633982607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
634082607adcSTejun Heo }
634182607adcSTejun Heo 
63425cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused)
634382607adcSTejun Heo {
634482607adcSTejun Heo 	unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
634582607adcSTejun Heo 	bool lockup_detected = false;
6346cd2440d6SPetr Mladek 	bool cpu_pool_stall = false;
6347940d71c6SSergey Senozhatsky 	unsigned long now = jiffies;
634882607adcSTejun Heo 	struct worker_pool *pool;
634982607adcSTejun Heo 	int pi;
635082607adcSTejun Heo 
635182607adcSTejun Heo 	if (!thresh)
635282607adcSTejun Heo 		return;
635382607adcSTejun Heo 
635482607adcSTejun Heo 	rcu_read_lock();
635582607adcSTejun Heo 
635682607adcSTejun Heo 	for_each_pool(pool, pi) {
635782607adcSTejun Heo 		unsigned long pool_ts, touched, ts;
635882607adcSTejun Heo 
6359cd2440d6SPetr Mladek 		pool->cpu_stall = false;
636082607adcSTejun Heo 		if (list_empty(&pool->worklist))
636182607adcSTejun Heo 			continue;
636282607adcSTejun Heo 
6363940d71c6SSergey Senozhatsky 		/*
6364940d71c6SSergey Senozhatsky 		 * If a virtual machine is stopped by the host it can look to
6365940d71c6SSergey Senozhatsky 		 * the watchdog like a stall.
6366940d71c6SSergey Senozhatsky 		 */
6367940d71c6SSergey Senozhatsky 		kvm_check_and_clear_guest_paused();
6368940d71c6SSergey Senozhatsky 
636982607adcSTejun Heo 		/* get the latest of pool and touched timestamps */
637089e28ce6SWang Qing 		if (pool->cpu >= 0)
637189e28ce6SWang Qing 			touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
637289e28ce6SWang Qing 		else
637382607adcSTejun Heo 			touched = READ_ONCE(wq_watchdog_touched);
637489e28ce6SWang Qing 		pool_ts = READ_ONCE(pool->watchdog_ts);
637582607adcSTejun Heo 
637682607adcSTejun Heo 		if (time_after(pool_ts, touched))
637782607adcSTejun Heo 			ts = pool_ts;
637882607adcSTejun Heo 		else
637982607adcSTejun Heo 			ts = touched;
638082607adcSTejun Heo 
638182607adcSTejun Heo 		/* did we stall? */
6382940d71c6SSergey Senozhatsky 		if (time_after(now, ts + thresh)) {
638382607adcSTejun Heo 			lockup_detected = true;
6384cd2440d6SPetr Mladek 			if (pool->cpu >= 0) {
6385cd2440d6SPetr Mladek 				pool->cpu_stall = true;
6386cd2440d6SPetr Mladek 				cpu_pool_stall = true;
6387cd2440d6SPetr Mladek 			}
638882607adcSTejun Heo 			pr_emerg("BUG: workqueue lockup - pool");
638982607adcSTejun Heo 			pr_cont_pool_info(pool);
639082607adcSTejun Heo 			pr_cont(" stuck for %us!\n",
6391940d71c6SSergey Senozhatsky 				jiffies_to_msecs(now - pool_ts) / 1000);
639282607adcSTejun Heo 		}
6393cd2440d6SPetr Mladek 
6394cd2440d6SPetr Mladek 
639582607adcSTejun Heo 	}
639682607adcSTejun Heo 
639782607adcSTejun Heo 	rcu_read_unlock();
639882607adcSTejun Heo 
639982607adcSTejun Heo 	if (lockup_detected)
640055df0933SImran Khan 		show_all_workqueues();
640182607adcSTejun Heo 
6402cd2440d6SPetr Mladek 	if (cpu_pool_stall)
6403cd2440d6SPetr Mladek 		show_cpu_pools_hogs();
6404cd2440d6SPetr Mladek 
640582607adcSTejun Heo 	wq_watchdog_reset_touched();
640682607adcSTejun Heo 	mod_timer(&wq_watchdog_timer, jiffies + thresh);
640782607adcSTejun Heo }
640882607adcSTejun Heo 
6409cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu)
641082607adcSTejun Heo {
641182607adcSTejun Heo 	if (cpu >= 0)
641282607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
641389e28ce6SWang Qing 
641482607adcSTejun Heo 	wq_watchdog_touched = jiffies;
641582607adcSTejun Heo }
641682607adcSTejun Heo 
641782607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh)
641882607adcSTejun Heo {
641982607adcSTejun Heo 	wq_watchdog_thresh = 0;
642082607adcSTejun Heo 	del_timer_sync(&wq_watchdog_timer);
642182607adcSTejun Heo 
642282607adcSTejun Heo 	if (thresh) {
642382607adcSTejun Heo 		wq_watchdog_thresh = thresh;
642482607adcSTejun Heo 		wq_watchdog_reset_touched();
642582607adcSTejun Heo 		mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
642682607adcSTejun Heo 	}
642782607adcSTejun Heo }
642882607adcSTejun Heo 
642982607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val,
643082607adcSTejun Heo 					const struct kernel_param *kp)
643182607adcSTejun Heo {
643282607adcSTejun Heo 	unsigned long thresh;
643382607adcSTejun Heo 	int ret;
643482607adcSTejun Heo 
643582607adcSTejun Heo 	ret = kstrtoul(val, 0, &thresh);
643682607adcSTejun Heo 	if (ret)
643782607adcSTejun Heo 		return ret;
643882607adcSTejun Heo 
643982607adcSTejun Heo 	if (system_wq)
644082607adcSTejun Heo 		wq_watchdog_set_thresh(thresh);
644182607adcSTejun Heo 	else
644282607adcSTejun Heo 		wq_watchdog_thresh = thresh;
644382607adcSTejun Heo 
644482607adcSTejun Heo 	return 0;
644582607adcSTejun Heo }
644682607adcSTejun Heo 
644782607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = {
644882607adcSTejun Heo 	.set	= wq_watchdog_param_set_thresh,
644982607adcSTejun Heo 	.get	= param_get_ulong,
645082607adcSTejun Heo };
645182607adcSTejun Heo 
645282607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
645382607adcSTejun Heo 		0644);
645482607adcSTejun Heo 
645582607adcSTejun Heo static void wq_watchdog_init(void)
645682607adcSTejun Heo {
64575cd79d6aSKees Cook 	timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
645882607adcSTejun Heo 	wq_watchdog_set_thresh(wq_watchdog_thresh);
645982607adcSTejun Heo }
646082607adcSTejun Heo 
646182607adcSTejun Heo #else	/* CONFIG_WQ_WATCHDOG */
646282607adcSTejun Heo 
646382607adcSTejun Heo static inline void wq_watchdog_init(void) { }
646482607adcSTejun Heo 
646582607adcSTejun Heo #endif	/* CONFIG_WQ_WATCHDOG */
646682607adcSTejun Heo 
64673347fa09STejun Heo /**
64683347fa09STejun Heo  * workqueue_init_early - early init for workqueue subsystem
64693347fa09STejun Heo  *
64702930155bSTejun Heo  * This is the first step of three-staged workqueue subsystem initialization and
64712930155bSTejun Heo  * invoked as soon as the bare basics - memory allocation, cpumasks and idr are
64722930155bSTejun Heo  * up. It sets up all the data structures and system workqueues and allows early
64732930155bSTejun Heo  * boot code to create workqueues and queue/cancel work items. Actual work item
64742930155bSTejun Heo  * execution starts only after kthreads can be created and scheduled right
64752930155bSTejun Heo  * before early initcalls.
64763347fa09STejun Heo  */
64772333e829SYu Chen void __init workqueue_init_early(void)
64781da177e4SLinus Torvalds {
647984193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_SYSTEM];
64807a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
64817a4e344cSTejun Heo 	int i, cpu;
6482c34056a3STejun Heo 
648310cdb157SLai Jiangshan 	BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
6484e904e6c2STejun Heo 
6485b05a7928SFrederic Weisbecker 	BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
648604d4e665SFrederic Weisbecker 	cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(HK_TYPE_WQ));
648704d4e665SFrederic Weisbecker 	cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, housekeeping_cpumask(HK_TYPE_DOMAIN));
6488b05a7928SFrederic Weisbecker 
6489ace3c549Stiozhang 	if (!cpumask_empty(&wq_cmdline_cpumask))
6490ace3c549Stiozhang 		cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, &wq_cmdline_cpumask);
6491ace3c549Stiozhang 
6492e904e6c2STejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
6493e904e6c2STejun Heo 
64942930155bSTejun Heo 	wq_update_pod_attrs_buf = alloc_workqueue_attrs();
64952930155bSTejun Heo 	BUG_ON(!wq_update_pod_attrs_buf);
64962930155bSTejun Heo 
649784193c07STejun Heo 	/* initialize WQ_AFFN_SYSTEM pods */
649884193c07STejun Heo 	pt->pod_cpus = kcalloc(1, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
649984193c07STejun Heo 	pt->pod_node = kcalloc(1, sizeof(pt->pod_node[0]), GFP_KERNEL);
650084193c07STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
650184193c07STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node || !pt->cpu_pod);
650284193c07STejun Heo 
650384193c07STejun Heo 	BUG_ON(!zalloc_cpumask_var_node(&pt->pod_cpus[0], GFP_KERNEL, NUMA_NO_NODE));
650484193c07STejun Heo 
650584193c07STejun Heo 	wq_update_pod_attrs_buf = alloc_workqueue_attrs();
650684193c07STejun Heo 	BUG_ON(!wq_update_pod_attrs_buf);
650784193c07STejun Heo 
650884193c07STejun Heo 	pt->nr_pods = 1;
650984193c07STejun Heo 	cpumask_copy(pt->pod_cpus[0], cpu_possible_mask);
651084193c07STejun Heo 	pt->pod_node[0] = NUMA_NO_NODE;
651184193c07STejun Heo 	pt->cpu_pod[0] = 0;
651284193c07STejun Heo 
6513706026c2STejun Heo 	/* initialize CPU pools */
651429c91e99STejun Heo 	for_each_possible_cpu(cpu) {
65154ce62e9eSTejun Heo 		struct worker_pool *pool;
65168b03ae3cSTejun Heo 
65177a4e344cSTejun Heo 		i = 0;
6518f02ae73aSTejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
65197a4e344cSTejun Heo 			BUG_ON(init_worker_pool(pool));
6520ec22ca5eSTejun Heo 			pool->cpu = cpu;
65217a4e344cSTejun Heo 			cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
65229546b29eSTejun Heo 			cpumask_copy(pool->attrs->__pod_cpumask, cpumask_of(cpu));
65237a4e344cSTejun Heo 			pool->attrs->nice = std_nice[i++];
6524*8639ecebSTejun Heo 			pool->attrs->affn_strict = true;
6525f3f90ad4STejun Heo 			pool->node = cpu_to_node(cpu);
65267a4e344cSTejun Heo 
65279daf9e67STejun Heo 			/* alloc pool ID */
652868e13a67SLai Jiangshan 			mutex_lock(&wq_pool_mutex);
65299daf9e67STejun Heo 			BUG_ON(worker_pool_assign_id(pool));
653068e13a67SLai Jiangshan 			mutex_unlock(&wq_pool_mutex);
65314ce62e9eSTejun Heo 		}
65328b03ae3cSTejun Heo 	}
65338b03ae3cSTejun Heo 
65348a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
653529c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
653629c91e99STejun Heo 		struct workqueue_attrs *attrs;
653729c91e99STejun Heo 
6538be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
653929c91e99STejun Heo 		attrs->nice = std_nice[i];
654029c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
65418a2b7538STejun Heo 
65428a2b7538STejun Heo 		/*
65438a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
65448a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
65458a2b7538STejun Heo 		 */
6546be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
65478a2b7538STejun Heo 		attrs->nice = std_nice[i];
6548af73f5c9STejun Heo 		attrs->ordered = true;
65498a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
655029c91e99STejun Heo 	}
655129c91e99STejun Heo 
6552d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
65531aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
6554d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
6555f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
6556636b927eSTejun Heo 					    WQ_MAX_ACTIVE);
655724d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
655824d51addSTejun Heo 					      WQ_FREEZABLE, 0);
65590668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
65600668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
65610668106cSViresh Kumar 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
65620668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
65630668106cSViresh Kumar 					      0);
65641aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
65650668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
65660668106cSViresh Kumar 	       !system_power_efficient_wq ||
65670668106cSViresh Kumar 	       !system_freezable_power_efficient_wq);
65683347fa09STejun Heo }
65693347fa09STejun Heo 
6570aa6fde93STejun Heo static void __init wq_cpu_intensive_thresh_init(void)
6571aa6fde93STejun Heo {
6572aa6fde93STejun Heo 	unsigned long thresh;
6573aa6fde93STejun Heo 	unsigned long bogo;
6574aa6fde93STejun Heo 
6575aa6fde93STejun Heo 	/* if the user set it to a specific value, keep it */
6576aa6fde93STejun Heo 	if (wq_cpu_intensive_thresh_us != ULONG_MAX)
6577aa6fde93STejun Heo 		return;
6578aa6fde93STejun Heo 
6579967b494eSTejun Heo 	pwq_release_worker = kthread_create_worker(0, "pool_workqueue_release");
6580967b494eSTejun Heo 	BUG_ON(IS_ERR(pwq_release_worker));
6581967b494eSTejun Heo 
6582aa6fde93STejun Heo 	/*
6583aa6fde93STejun Heo 	 * The default of 10ms is derived from the fact that most modern (as of
6584aa6fde93STejun Heo 	 * 2023) processors can do a lot in 10ms and that it's just below what
6585aa6fde93STejun Heo 	 * most consider human-perceivable. However, the kernel also runs on a
6586aa6fde93STejun Heo 	 * lot slower CPUs including microcontrollers where the threshold is way
6587aa6fde93STejun Heo 	 * too low.
6588aa6fde93STejun Heo 	 *
6589aa6fde93STejun Heo 	 * Let's scale up the threshold upto 1 second if BogoMips is below 4000.
6590aa6fde93STejun Heo 	 * This is by no means accurate but it doesn't have to be. The mechanism
6591aa6fde93STejun Heo 	 * is still useful even when the threshold is fully scaled up. Also, as
6592aa6fde93STejun Heo 	 * the reports would usually be applicable to everyone, some machines
6593aa6fde93STejun Heo 	 * operating on longer thresholds won't significantly diminish their
6594aa6fde93STejun Heo 	 * usefulness.
6595aa6fde93STejun Heo 	 */
6596aa6fde93STejun Heo 	thresh = 10 * USEC_PER_MSEC;
6597aa6fde93STejun Heo 
6598aa6fde93STejun Heo 	/* see init/calibrate.c for lpj -> BogoMIPS calculation */
6599aa6fde93STejun Heo 	bogo = max_t(unsigned long, loops_per_jiffy / 500000 * HZ, 1);
6600aa6fde93STejun Heo 	if (bogo < 4000)
6601aa6fde93STejun Heo 		thresh = min_t(unsigned long, thresh * 4000 / bogo, USEC_PER_SEC);
6602aa6fde93STejun Heo 
6603aa6fde93STejun Heo 	pr_debug("wq_cpu_intensive_thresh: lpj=%lu BogoMIPS=%lu thresh_us=%lu\n",
6604aa6fde93STejun Heo 		 loops_per_jiffy, bogo, thresh);
6605aa6fde93STejun Heo 
6606aa6fde93STejun Heo 	wq_cpu_intensive_thresh_us = thresh;
6607aa6fde93STejun Heo }
6608aa6fde93STejun Heo 
66093347fa09STejun Heo /**
66103347fa09STejun Heo  * workqueue_init - bring workqueue subsystem fully online
66113347fa09STejun Heo  *
66122930155bSTejun Heo  * This is the second step of three-staged workqueue subsystem initialization
66132930155bSTejun Heo  * and invoked as soon as kthreads can be created and scheduled. Workqueues have
66142930155bSTejun Heo  * been created and work items queued on them, but there are no kworkers
66152930155bSTejun Heo  * executing the work items yet. Populate the worker pools with the initial
66162930155bSTejun Heo  * workers and enable future kworker creations.
66173347fa09STejun Heo  */
66182333e829SYu Chen void __init workqueue_init(void)
66193347fa09STejun Heo {
66202186d9f9STejun Heo 	struct workqueue_struct *wq;
66213347fa09STejun Heo 	struct worker_pool *pool;
66223347fa09STejun Heo 	int cpu, bkt;
66233347fa09STejun Heo 
6624aa6fde93STejun Heo 	wq_cpu_intensive_thresh_init();
6625aa6fde93STejun Heo 
66262186d9f9STejun Heo 	mutex_lock(&wq_pool_mutex);
66272186d9f9STejun Heo 
66282930155bSTejun Heo 	/*
66292930155bSTejun Heo 	 * Per-cpu pools created earlier could be missing node hint. Fix them
66302930155bSTejun Heo 	 * up. Also, create a rescuer for workqueues that requested it.
66312930155bSTejun Heo 	 */
66322186d9f9STejun Heo 	for_each_possible_cpu(cpu) {
66332186d9f9STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
66342186d9f9STejun Heo 			pool->node = cpu_to_node(cpu);
66352186d9f9STejun Heo 		}
66362186d9f9STejun Heo 	}
66372186d9f9STejun Heo 
663840c17f75STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
663940c17f75STejun Heo 		WARN(init_rescuer(wq),
664040c17f75STejun Heo 		     "workqueue: failed to create early rescuer for %s",
664140c17f75STejun Heo 		     wq->name);
664240c17f75STejun Heo 	}
66432186d9f9STejun Heo 
66442186d9f9STejun Heo 	mutex_unlock(&wq_pool_mutex);
66452186d9f9STejun Heo 
66463347fa09STejun Heo 	/* create the initial workers */
66473347fa09STejun Heo 	for_each_online_cpu(cpu) {
66483347fa09STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
66493347fa09STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
66503347fa09STejun Heo 			BUG_ON(!create_worker(pool));
66513347fa09STejun Heo 		}
66523347fa09STejun Heo 	}
66533347fa09STejun Heo 
66543347fa09STejun Heo 	hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
66553347fa09STejun Heo 		BUG_ON(!create_worker(pool));
66563347fa09STejun Heo 
66573347fa09STejun Heo 	wq_online = true;
665882607adcSTejun Heo 	wq_watchdog_init();
66591da177e4SLinus Torvalds }
6660c4f135d6STetsuo Handa 
6661025e1684STejun Heo /*
6662025e1684STejun Heo  * Initialize @pt by first initializing @pt->cpu_pod[] with pod IDs according to
6663025e1684STejun Heo  * @cpu_shares_pod(). Each subset of CPUs that share a pod is assigned a unique
6664025e1684STejun Heo  * and consecutive pod ID. The rest of @pt is initialized accordingly.
6665025e1684STejun Heo  */
6666025e1684STejun Heo static void __init init_pod_type(struct wq_pod_type *pt,
6667025e1684STejun Heo 				 bool (*cpus_share_pod)(int, int))
6668025e1684STejun Heo {
6669025e1684STejun Heo 	int cur, pre, cpu, pod;
6670025e1684STejun Heo 
6671025e1684STejun Heo 	pt->nr_pods = 0;
6672025e1684STejun Heo 
6673025e1684STejun Heo 	/* init @pt->cpu_pod[] according to @cpus_share_pod() */
6674025e1684STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
6675025e1684STejun Heo 	BUG_ON(!pt->cpu_pod);
6676025e1684STejun Heo 
6677025e1684STejun Heo 	for_each_possible_cpu(cur) {
6678025e1684STejun Heo 		for_each_possible_cpu(pre) {
6679025e1684STejun Heo 			if (pre >= cur) {
6680025e1684STejun Heo 				pt->cpu_pod[cur] = pt->nr_pods++;
6681025e1684STejun Heo 				break;
6682025e1684STejun Heo 			}
6683025e1684STejun Heo 			if (cpus_share_pod(cur, pre)) {
6684025e1684STejun Heo 				pt->cpu_pod[cur] = pt->cpu_pod[pre];
6685025e1684STejun Heo 				break;
6686025e1684STejun Heo 			}
6687025e1684STejun Heo 		}
6688025e1684STejun Heo 	}
6689025e1684STejun Heo 
6690025e1684STejun Heo 	/* init the rest to match @pt->cpu_pod[] */
6691025e1684STejun Heo 	pt->pod_cpus = kcalloc(pt->nr_pods, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
6692025e1684STejun Heo 	pt->pod_node = kcalloc(pt->nr_pods, sizeof(pt->pod_node[0]), GFP_KERNEL);
6693025e1684STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node);
6694025e1684STejun Heo 
6695025e1684STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++)
6696025e1684STejun Heo 		BUG_ON(!zalloc_cpumask_var(&pt->pod_cpus[pod], GFP_KERNEL));
6697025e1684STejun Heo 
6698025e1684STejun Heo 	for_each_possible_cpu(cpu) {
6699025e1684STejun Heo 		cpumask_set_cpu(cpu, pt->pod_cpus[pt->cpu_pod[cpu]]);
6700025e1684STejun Heo 		pt->pod_node[pt->cpu_pod[cpu]] = cpu_to_node(cpu);
6701025e1684STejun Heo 	}
6702025e1684STejun Heo }
6703025e1684STejun Heo 
670463c5484eSTejun Heo static bool __init cpus_dont_share(int cpu0, int cpu1)
670563c5484eSTejun Heo {
670663c5484eSTejun Heo 	return false;
670763c5484eSTejun Heo }
670863c5484eSTejun Heo 
670963c5484eSTejun Heo static bool __init cpus_share_smt(int cpu0, int cpu1)
671063c5484eSTejun Heo {
671163c5484eSTejun Heo #ifdef CONFIG_SCHED_SMT
671263c5484eSTejun Heo 	return cpumask_test_cpu(cpu0, cpu_smt_mask(cpu1));
671363c5484eSTejun Heo #else
671463c5484eSTejun Heo 	return false;
671563c5484eSTejun Heo #endif
671663c5484eSTejun Heo }
671763c5484eSTejun Heo 
6718025e1684STejun Heo static bool __init cpus_share_numa(int cpu0, int cpu1)
6719025e1684STejun Heo {
6720025e1684STejun Heo 	return cpu_to_node(cpu0) == cpu_to_node(cpu1);
6721025e1684STejun Heo }
6722025e1684STejun Heo 
67232930155bSTejun Heo /**
67242930155bSTejun Heo  * workqueue_init_topology - initialize CPU pods for unbound workqueues
67252930155bSTejun Heo  *
67262930155bSTejun Heo  * This is the third step of there-staged workqueue subsystem initialization and
67272930155bSTejun Heo  * invoked after SMP and topology information are fully initialized. It
67282930155bSTejun Heo  * initializes the unbound CPU pods accordingly.
67292930155bSTejun Heo  */
67302930155bSTejun Heo void __init workqueue_init_topology(void)
6731a86feae6STejun Heo {
67322930155bSTejun Heo 	struct workqueue_struct *wq;
6733025e1684STejun Heo 	int cpu;
6734a86feae6STejun Heo 
673563c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CPU], cpus_dont_share);
673663c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_SMT], cpus_share_smt);
673763c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CACHE], cpus_share_cache);
6738025e1684STejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_NUMA], cpus_share_numa);
6739a86feae6STejun Heo 
67402930155bSTejun Heo 	mutex_lock(&wq_pool_mutex);
6741a86feae6STejun Heo 
6742a86feae6STejun Heo 	/*
67432930155bSTejun Heo 	 * Workqueues allocated earlier would have all CPUs sharing the default
67442930155bSTejun Heo 	 * worker pool. Explicitly call wq_update_pod() on all workqueue and CPU
67452930155bSTejun Heo 	 * combinations to apply per-pod sharing.
67462930155bSTejun Heo 	 */
67472930155bSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
67482930155bSTejun Heo 		for_each_online_cpu(cpu) {
67492930155bSTejun Heo 			wq_update_pod(wq, cpu, cpu, true);
67502930155bSTejun Heo 		}
67512930155bSTejun Heo 	}
67522930155bSTejun Heo 
67532930155bSTejun Heo 	mutex_unlock(&wq_pool_mutex);
6754a86feae6STejun Heo }
6755a86feae6STejun Heo 
675620bdedafSTetsuo Handa void __warn_flushing_systemwide_wq(void)
675720bdedafSTetsuo Handa {
675820bdedafSTetsuo Handa 	pr_warn("WARNING: Flushing system-wide workqueues will be prohibited in near future.\n");
675920bdedafSTetsuo Handa 	dump_stack();
676020bdedafSTetsuo Handa }
6761c4f135d6STetsuo Handa EXPORT_SYMBOL(__warn_flushing_systemwide_wq);
6762ace3c549Stiozhang 
6763ace3c549Stiozhang static int __init workqueue_unbound_cpus_setup(char *str)
6764ace3c549Stiozhang {
6765ace3c549Stiozhang 	if (cpulist_parse(str, &wq_cmdline_cpumask) < 0) {
6766ace3c549Stiozhang 		cpumask_clear(&wq_cmdline_cpumask);
6767ace3c549Stiozhang 		pr_warn("workqueue.unbound_cpus: incorrect CPU range, using default\n");
6768ace3c549Stiozhang 	}
6769ace3c549Stiozhang 
6770ace3c549Stiozhang 	return 1;
6771ace3c549Stiozhang }
6772ace3c549Stiozhang __setup("workqueue.unbound_cpus=", workqueue_unbound_cpus_setup);
6773