xref: /linux-6.15/kernel/workqueue.c (revision 1acd92d9)
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>
324cb1ef64STejun Heo #include <linux/interrupt.h>
331da177e4SLinus Torvalds #include <linux/signal.h>
341da177e4SLinus Torvalds #include <linux/completion.h>
351da177e4SLinus Torvalds #include <linux/workqueue.h>
361da177e4SLinus Torvalds #include <linux/slab.h>
371da177e4SLinus Torvalds #include <linux/cpu.h>
381da177e4SLinus Torvalds #include <linux/notifier.h>
391da177e4SLinus Torvalds #include <linux/kthread.h>
401fa44ecaSJames Bottomley #include <linux/hardirq.h>
4146934023SChristoph Lameter #include <linux/mempolicy.h>
42341a5958SRafael J. Wysocki #include <linux/freezer.h>
43d5abe669SPeter Zijlstra #include <linux/debug_locks.h>
444e6045f1SJohannes Berg #include <linux/lockdep.h>
45c34056a3STejun Heo #include <linux/idr.h>
4629c91e99STejun Heo #include <linux/jhash.h>
4742f8570fSSasha Levin #include <linux/hashtable.h>
4876af4d93STejun Heo #include <linux/rculist.h>
49bce90380STejun Heo #include <linux/nodemask.h>
504c16bd32STejun Heo #include <linux/moduleparam.h>
513d1cb205STejun Heo #include <linux/uaccess.h>
52c98a9805STal Shorer #include <linux/sched/isolation.h>
53cd2440d6SPetr Mladek #include <linux/sched/debug.h>
5462635ea8SSergey Senozhatsky #include <linux/nmi.h>
55940d71c6SSergey Senozhatsky #include <linux/kvm_para.h>
56aa6fde93STejun Heo #include <linux/delay.h>
572f34d733STejun Heo #include <linux/irq_work.h>
58e22bee78STejun Heo 
59ea138446STejun Heo #include "workqueue_internal.h"
601da177e4SLinus Torvalds 
61e563d0a7STejun Heo enum worker_pool_flags {
62bc2ae0f5STejun Heo 	/*
6324647570STejun Heo 	 * worker_pool flags
64bc2ae0f5STejun Heo 	 *
6524647570STejun Heo 	 * A bound pool is either associated or disassociated with its CPU.
66bc2ae0f5STejun Heo 	 * While associated (!DISASSOCIATED), all workers are bound to the
67bc2ae0f5STejun Heo 	 * CPU and none has %WORKER_UNBOUND set and concurrency management
68bc2ae0f5STejun Heo 	 * is in effect.
69bc2ae0f5STejun Heo 	 *
70bc2ae0f5STejun Heo 	 * While DISASSOCIATED, the cpu may be offline and all workers have
71bc2ae0f5STejun Heo 	 * %WORKER_UNBOUND set and concurrency management disabled, and may
7224647570STejun Heo 	 * be executing on any CPU.  The pool behaves as an unbound one.
73bc2ae0f5STejun Heo 	 *
74bc3a1afcSTejun Heo 	 * Note that DISASSOCIATED should be flipped only while holding
751258fae7STejun Heo 	 * wq_pool_attach_mutex to avoid changing binding state while
764736cbf7SLai Jiangshan 	 * worker_attach_to_pool() is in progress.
774cb1ef64STejun Heo 	 *
784cb1ef64STejun Heo 	 * As there can only be one concurrent BH execution context per CPU, a
794cb1ef64STejun Heo 	 * BH pool is per-CPU and always DISASSOCIATED.
80bc2ae0f5STejun Heo 	 */
814cb1ef64STejun Heo 	POOL_BH			= 1 << 0,	/* is a BH pool */
824cb1ef64STejun Heo 	POOL_MANAGER_ACTIVE	= 1 << 1,	/* being managed */
8324647570STejun Heo 	POOL_DISASSOCIATED	= 1 << 2,	/* cpu can't serve workers */
84*1acd92d9STejun Heo 	POOL_BH_DRAINING	= 1 << 3,	/* draining after CPU offline */
85e563d0a7STejun Heo };
86db7bccf4STejun Heo 
87e563d0a7STejun Heo enum worker_flags {
88c8e55f36STejun Heo 	/* worker flags */
89c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
90c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
91e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
92fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
93f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
94a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
95e22bee78STejun Heo 
96a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
97a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
98e563d0a7STejun Heo };
99db7bccf4STejun Heo 
100c5f5b942STejun Heo enum work_cancel_flags {
101c5f5b942STejun Heo 	WORK_CANCEL_DELAYED	= 1 << 0,	/* canceling a delayed_work */
102c5f5b942STejun Heo };
103c5f5b942STejun Heo 
104e563d0a7STejun Heo enum wq_internal_consts {
105e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
1064ce62e9eSTejun Heo 
10729c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
108c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
109db7bccf4STejun Heo 
110e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
111e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
112e22bee78STejun Heo 
1133233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
1143233cdbdSTejun Heo 						/* call for help after 10ms
1153233cdbdSTejun Heo 						   (min two ticks) */
116e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
117e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
1181da177e4SLinus Torvalds 
1191da177e4SLinus Torvalds 	/*
120e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
1218698a745SDongsheng Yang 	 * all cpus.  Give MIN_NICE.
122e22bee78STejun Heo 	 */
1238698a745SDongsheng Yang 	RESCUER_NICE_LEVEL	= MIN_NICE,
1248698a745SDongsheng Yang 	HIGHPRI_NICE_LEVEL	= MIN_NICE,
125ecf6881fSTejun Heo 
12631c89007SAudra Mitchell 	WQ_NAME_LEN		= 32,
127c8e55f36STejun Heo };
128c8e55f36STejun Heo 
1291da177e4SLinus Torvalds /*
1304cb1ef64STejun Heo  * We don't want to trap softirq for too long. See MAX_SOFTIRQ_TIME and
1314cb1ef64STejun Heo  * MAX_SOFTIRQ_RESTART in kernel/softirq.c. These are macros because
1324cb1ef64STejun Heo  * msecs_to_jiffies() can't be an initializer.
1334cb1ef64STejun Heo  */
1344cb1ef64STejun Heo #define BH_WORKER_JIFFIES	msecs_to_jiffies(2)
1354cb1ef64STejun Heo #define BH_WORKER_RESTARTS	10
1364cb1ef64STejun Heo 
1374cb1ef64STejun Heo /*
1384690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1394690c4abSTejun Heo  *
140e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
141e41e704bSTejun Heo  *    everyone else.
1424690c4abSTejun Heo  *
143e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
144e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
145e22bee78STejun Heo  *
146d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1474690c4abSTejun Heo  *
1485797b1c1STejun Heo  * LN: pool->lock and wq_node_nr_active->lock protected for writes. Either for
1495797b1c1STejun Heo  *     reads.
1505797b1c1STejun Heo  *
151bdf8b9bfSTejun Heo  * K: Only modified by worker while holding pool->lock. Can be safely read by
152bdf8b9bfSTejun Heo  *    self, while holding pool->lock or from IRQ context if %current is the
153bdf8b9bfSTejun Heo  *    kworker.
154bdf8b9bfSTejun Heo  *
155bdf8b9bfSTejun Heo  * S: Only modified by worker self.
156bdf8b9bfSTejun Heo  *
1571258fae7STejun Heo  * A: wq_pool_attach_mutex protected.
158822d8405STejun Heo  *
15968e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
16076af4d93STejun Heo  *
16124acfb71SThomas Gleixner  * PR: wq_pool_mutex protected for writes.  RCU protected for reads.
1625bcab335STejun Heo  *
1635b95e1afSLai Jiangshan  * PW: wq_pool_mutex and wq->mutex protected for writes.  Either for reads.
1645b95e1afSLai Jiangshan  *
1655b95e1afSLai Jiangshan  * PWR: wq_pool_mutex and wq->mutex protected for writes.  Either or
16624acfb71SThomas Gleixner  *      RCU for reads.
1675b95e1afSLai Jiangshan  *
1683c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1693c25a55dSLai Jiangshan  *
17024acfb71SThomas Gleixner  * WR: wq->mutex protected for writes.  RCU protected for reads.
1712e109a28STejun Heo  *
172a045a272STejun Heo  * WO: wq->mutex protected for writes. Updated with WRITE_ONCE() and can be read
173a045a272STejun Heo  *     with READ_ONCE() without locking.
174a045a272STejun Heo  *
1752e109a28STejun Heo  * MD: wq_mayday_lock protected.
176cd2440d6SPetr Mladek  *
177cd2440d6SPetr Mladek  * WD: Used internally by the watchdog.
1784690c4abSTejun Heo  */
1794690c4abSTejun Heo 
1802eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
181c34056a3STejun Heo 
182bd7bdd43STejun Heo struct worker_pool {
183a9b8a985SSebastian Andrzej Siewior 	raw_spinlock_t		lock;		/* the pool lock */
184d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
185f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1869daf9e67STejun Heo 	int			id;		/* I: pool ID */
187bc8b50c2STejun Heo 	unsigned int		flags;		/* L: flags */
188bd7bdd43STejun Heo 
18982607adcSTejun Heo 	unsigned long		watchdog_ts;	/* L: watchdog timestamp */
190cd2440d6SPetr Mladek 	bool			cpu_stall;	/* WD: stalled cpu bound pool */
19182607adcSTejun Heo 
192bc35f7efSLai Jiangshan 	/*
193bc35f7efSLai Jiangshan 	 * The counter is incremented in a process context on the associated CPU
194bc35f7efSLai Jiangshan 	 * w/ preemption disabled, and decremented or reset in the same context
195bc35f7efSLai Jiangshan 	 * but w/ pool->lock held. The readers grab pool->lock and are
196bc35f7efSLai Jiangshan 	 * guaranteed to see if the counter reached zero.
197bc35f7efSLai Jiangshan 	 */
198bc35f7efSLai Jiangshan 	int			nr_running;
19984f91c62SLai Jiangshan 
200bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
201ea1abd61SLai Jiangshan 
2025826cc8fSLai Jiangshan 	int			nr_workers;	/* L: total number of workers */
2035826cc8fSLai Jiangshan 	int			nr_idle;	/* L: currently idle workers */
204bd7bdd43STejun Heo 
2052c1f1a91SLai Jiangshan 	struct list_head	idle_list;	/* L: list of idle workers */
206bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
2073f959aa3SValentin Schneider 	struct work_struct      idle_cull_work; /* L: worker idle cleanup */
2083f959aa3SValentin Schneider 
209bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	  /* L: SOS timer for workers */
210bd7bdd43STejun Heo 
211c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
212c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
213c9e7cf27STejun Heo 						/* L: hash of busy workers */
214c9e7cf27STejun Heo 
2152607d7a6STejun Heo 	struct worker		*manager;	/* L: purely informational */
21692f9c5c4SLai Jiangshan 	struct list_head	workers;	/* A: attached workers */
217e02b9312SValentin Schneider 	struct list_head        dying_workers;  /* A: workers about to die */
21860f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
219e19e397aSTejun Heo 
2207cda9aaeSLai Jiangshan 	struct ida		worker_ida;	/* worker IDs for task name */
221e19e397aSTejun Heo 
2227a4e344cSTejun Heo 	struct workqueue_attrs	*attrs;		/* I: worker attributes */
22368e13a67SLai Jiangshan 	struct hlist_node	hash_node;	/* PL: unbound_pool_hash node */
22468e13a67SLai Jiangshan 	int			refcnt;		/* PL: refcnt for unbound pools */
2257a4e344cSTejun Heo 
226e19e397aSTejun Heo 	/*
22724acfb71SThomas Gleixner 	 * Destruction of pool is RCU protected to allow dereferences
22829c91e99STejun Heo 	 * from get_work_pool().
22929c91e99STejun Heo 	 */
23029c91e99STejun Heo 	struct rcu_head		rcu;
23184f91c62SLai Jiangshan };
2328b03ae3cSTejun Heo 
2338b03ae3cSTejun Heo /*
234725e8ec5STejun Heo  * Per-pool_workqueue statistics. These can be monitored using
235725e8ec5STejun Heo  * tools/workqueue/wq_monitor.py.
236725e8ec5STejun Heo  */
237725e8ec5STejun Heo enum pool_workqueue_stats {
238725e8ec5STejun Heo 	PWQ_STAT_STARTED,	/* work items started execution */
239725e8ec5STejun Heo 	PWQ_STAT_COMPLETED,	/* work items completed execution */
2408a1dd1e5STejun Heo 	PWQ_STAT_CPU_TIME,	/* total CPU time consumed */
241616db877STejun Heo 	PWQ_STAT_CPU_INTENSIVE,	/* wq_cpu_intensive_thresh_us violations */
242725e8ec5STejun Heo 	PWQ_STAT_CM_WAKEUP,	/* concurrency-management worker wakeups */
2438639ecebSTejun Heo 	PWQ_STAT_REPATRIATED,	/* unbound workers brought back into scope */
244725e8ec5STejun Heo 	PWQ_STAT_MAYDAY,	/* maydays to rescuer */
245725e8ec5STejun Heo 	PWQ_STAT_RESCUED,	/* linked work items executed by rescuer */
246725e8ec5STejun Heo 
247725e8ec5STejun Heo 	PWQ_NR_STATS,
248725e8ec5STejun Heo };
249725e8ec5STejun Heo 
250725e8ec5STejun Heo /*
251e9a8e01fSTejun Heo  * The per-pool workqueue.  While queued, bits below WORK_PWQ_SHIFT
252112202d9STejun Heo  * of work_struct->data are used for flags and the remaining high bits
253112202d9STejun Heo  * point to the pwq; thus, pwqs need to be aligned at two's power of the
254112202d9STejun Heo  * number of flag bits.
2551da177e4SLinus Torvalds  */
256112202d9STejun Heo struct pool_workqueue {
257bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
2584690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
25973f53c4aSTejun Heo 	int			work_color;	/* L: current color */
26073f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
2618864b4e5STejun Heo 	int			refcnt;		/* L: reference count */
26273f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
26373f53c4aSTejun Heo 						/* L: nr of in_flight works */
2644c065dbcSWaiman Long 	bool			plugged;	/* L: execution suspended */
265018f3a13SLai Jiangshan 
266018f3a13SLai Jiangshan 	/*
267018f3a13SLai Jiangshan 	 * nr_active management and WORK_STRUCT_INACTIVE:
268018f3a13SLai Jiangshan 	 *
269018f3a13SLai Jiangshan 	 * When pwq->nr_active >= max_active, new work item is queued to
270018f3a13SLai Jiangshan 	 * pwq->inactive_works instead of pool->worklist and marked with
271018f3a13SLai Jiangshan 	 * WORK_STRUCT_INACTIVE.
272018f3a13SLai Jiangshan 	 *
2735797b1c1STejun Heo 	 * All work items marked with WORK_STRUCT_INACTIVE do not participate in
2745797b1c1STejun Heo 	 * nr_active and all work items in pwq->inactive_works are marked with
2755797b1c1STejun Heo 	 * WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE work items are
2765797b1c1STejun Heo 	 * in pwq->inactive_works. Some of them are ready to run in
2775797b1c1STejun Heo 	 * pool->worklist or worker->scheduled. Those work itmes are only struct
2785797b1c1STejun Heo 	 * wq_barrier which is used for flush_work() and should not participate
2795797b1c1STejun Heo 	 * in nr_active. For non-barrier work item, it is marked with
2805797b1c1STejun Heo 	 * WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works.
281018f3a13SLai Jiangshan 	 */
2821e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
283f97a4a1aSLai Jiangshan 	struct list_head	inactive_works;	/* L: inactive works */
2845797b1c1STejun Heo 	struct list_head	pending_node;	/* LN: node on wq_node_nr_active->pending_pwqs */
2853c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2862e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2878864b4e5STejun Heo 
288725e8ec5STejun Heo 	u64			stats[PWQ_NR_STATS];
289725e8ec5STejun Heo 
2908864b4e5STejun Heo 	/*
291967b494eSTejun Heo 	 * Release of unbound pwq is punted to a kthread_worker. See put_pwq()
292687a9aa5STejun Heo 	 * and pwq_release_workfn() for details. pool_workqueue itself is also
293687a9aa5STejun Heo 	 * RCU protected so that the first pwq can be determined without
294967b494eSTejun Heo 	 * grabbing wq->mutex.
2958864b4e5STejun Heo 	 */
296687a9aa5STejun Heo 	struct kthread_work	release_work;
2978864b4e5STejun Heo 	struct rcu_head		rcu;
298e9a8e01fSTejun Heo } __aligned(1 << WORK_STRUCT_PWQ_SHIFT);
2991da177e4SLinus Torvalds 
3001da177e4SLinus Torvalds /*
30173f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
30273f53c4aSTejun Heo  */
30373f53c4aSTejun Heo struct wq_flusher {
3043c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
3053c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
30673f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
30773f53c4aSTejun Heo };
3081da177e4SLinus Torvalds 
309226223abSTejun Heo struct wq_device;
310226223abSTejun Heo 
31173f53c4aSTejun Heo /*
31291ccc6e7STejun Heo  * Unlike in a per-cpu workqueue where max_active limits its concurrency level
31391ccc6e7STejun Heo  * on each CPU, in an unbound workqueue, max_active applies to the whole system.
31491ccc6e7STejun Heo  * As sharing a single nr_active across multiple sockets can be very expensive,
31591ccc6e7STejun Heo  * the counting and enforcement is per NUMA node.
3165797b1c1STejun Heo  *
3175797b1c1STejun Heo  * The following struct is used to enforce per-node max_active. When a pwq wants
3185797b1c1STejun Heo  * to start executing a work item, it should increment ->nr using
3195797b1c1STejun Heo  * tryinc_node_nr_active(). If acquisition fails due to ->nr already being over
3205797b1c1STejun Heo  * ->max, the pwq is queued on ->pending_pwqs. As in-flight work items finish
3215797b1c1STejun Heo  * and decrement ->nr, node_activate_pending_pwq() activates the pending pwqs in
3225797b1c1STejun Heo  * round-robin order.
32391ccc6e7STejun Heo  */
32491ccc6e7STejun Heo struct wq_node_nr_active {
3255797b1c1STejun Heo 	int			max;		/* per-node max_active */
3265797b1c1STejun Heo 	atomic_t		nr;		/* per-node nr_active */
3275797b1c1STejun Heo 	raw_spinlock_t		lock;		/* nests inside pool locks */
3285797b1c1STejun Heo 	struct list_head	pending_pwqs;	/* LN: pwqs with inactive works */
32991ccc6e7STejun Heo };
33091ccc6e7STejun Heo 
33191ccc6e7STejun Heo /*
332c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
333c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
3341da177e4SLinus Torvalds  */
3351da177e4SLinus Torvalds struct workqueue_struct {
3363c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
337e2dca7adSTejun Heo 	struct list_head	list;		/* PR: list of all workqueues */
33873f53c4aSTejun Heo 
3393c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
3403c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
3413c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
342112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
3433c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
3443c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
3453c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
34673f53c4aSTejun Heo 
3472e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
34830ae2fc0STejun Heo 	struct worker		*rescuer;	/* MD: rescue worker */
349e22bee78STejun Heo 
35087fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
3515797b1c1STejun Heo 
3525797b1c1STejun Heo 	/* See alloc_workqueue() function comment for info on min/max_active */
353a045a272STejun Heo 	int			max_active;	/* WO: max active works */
3545797b1c1STejun Heo 	int			min_active;	/* WO: min active works */
355a045a272STejun Heo 	int			saved_max_active; /* WQ: saved max_active */
3565797b1c1STejun Heo 	int			saved_min_active; /* WQ: saved min_active */
357226223abSTejun Heo 
3585b95e1afSLai Jiangshan 	struct workqueue_attrs	*unbound_attrs;	/* PW: only for unbound wqs */
3599f66cff2STejun Heo 	struct pool_workqueue __rcu *dfl_pwq;   /* PW: only for unbound wqs */
3606029a918STejun Heo 
361226223abSTejun Heo #ifdef CONFIG_SYSFS
362226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
363226223abSTejun Heo #endif
3644e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
365669de8bdSBart Van Assche 	char			*lock_name;
366669de8bdSBart Van Assche 	struct lock_class_key	key;
3674e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
3684e6045f1SJohannes Berg #endif
369ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
3702728fd2fSTejun Heo 
371e2dca7adSTejun Heo 	/*
37224acfb71SThomas Gleixner 	 * Destruction of workqueue_struct is RCU protected to allow walking
37324acfb71SThomas Gleixner 	 * the workqueues list without grabbing wq_pool_mutex.
374e2dca7adSTejun Heo 	 * This is used to dump all workqueues from sysrq.
375e2dca7adSTejun Heo 	 */
376e2dca7adSTejun Heo 	struct rcu_head		rcu;
377e2dca7adSTejun Heo 
3782728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
3792728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
380636b927eSTejun Heo 	struct pool_workqueue __percpu __rcu **cpu_pwq; /* I: per-cpu pwqs */
38191ccc6e7STejun Heo 	struct wq_node_nr_active *node_nr_active[]; /* I: per-node nr_active */
3821da177e4SLinus Torvalds };
3831da177e4SLinus Torvalds 
38484193c07STejun Heo /*
38584193c07STejun Heo  * Each pod type describes how CPUs should be grouped for unbound workqueues.
38684193c07STejun Heo  * See the comment above workqueue_attrs->affn_scope.
38784193c07STejun Heo  */
38884193c07STejun Heo struct wq_pod_type {
38984193c07STejun Heo 	int			nr_pods;	/* number of pods */
39084193c07STejun Heo 	cpumask_var_t		*pod_cpus;	/* pod -> cpus */
39184193c07STejun Heo 	int			*pod_node;	/* pod -> node */
39284193c07STejun Heo 	int			*cpu_pod;	/* cpu -> pod */
39384193c07STejun Heo };
39484193c07STejun Heo 
39563c5484eSTejun Heo static const char *wq_affn_names[WQ_AFFN_NR_TYPES] = {
396523a301eSTejun Heo 	[WQ_AFFN_DFL]		= "default",
39763c5484eSTejun Heo 	[WQ_AFFN_CPU]		= "cpu",
39863c5484eSTejun Heo 	[WQ_AFFN_SMT]		= "smt",
39963c5484eSTejun Heo 	[WQ_AFFN_CACHE]		= "cache",
40063c5484eSTejun Heo 	[WQ_AFFN_NUMA]		= "numa",
40163c5484eSTejun Heo 	[WQ_AFFN_SYSTEM]	= "system",
40263c5484eSTejun Heo };
403bce90380STejun Heo 
404616db877STejun Heo /*
405616db877STejun Heo  * Per-cpu work items which run for longer than the following threshold are
406616db877STejun Heo  * automatically considered CPU intensive and excluded from concurrency
407616db877STejun Heo  * management to prevent them from noticeably delaying other per-cpu work items.
408aa6fde93STejun Heo  * ULONG_MAX indicates that the user hasn't overridden it with a boot parameter.
409aa6fde93STejun Heo  * The actual value is initialized in wq_cpu_intensive_thresh_init().
410616db877STejun Heo  */
411aa6fde93STejun Heo static unsigned long wq_cpu_intensive_thresh_us = ULONG_MAX;
412616db877STejun Heo module_param_named(cpu_intensive_thresh_us, wq_cpu_intensive_thresh_us, ulong, 0644);
413ccdec921SXuewen Yan #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT
414ccdec921SXuewen Yan static unsigned int wq_cpu_intensive_warning_thresh = 4;
415ccdec921SXuewen Yan module_param_named(cpu_intensive_warning_thresh, wq_cpu_intensive_warning_thresh, uint, 0644);
416ccdec921SXuewen Yan #endif
417616db877STejun Heo 
418cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
419552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
420cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
421cee22a15SViresh Kumar 
422863b710bSTejun Heo static bool wq_online;			/* can kworkers be created yet? */
423c7a40c49STejun Heo static bool wq_topo_initialized __read_mostly = false;
424c7a40c49STejun Heo 
425c7a40c49STejun Heo static struct kmem_cache *pwq_cache;
426c7a40c49STejun Heo 
427c7a40c49STejun Heo static struct wq_pod_type wq_pod_types[WQ_AFFN_NR_TYPES];
428c7a40c49STejun Heo static enum wq_affn_scope wq_affn_dfl = WQ_AFFN_CACHE;
4293347fa09STejun Heo 
430fef59c9cSTejun Heo /* buf for wq_update_unbound_pod_attrs(), protected by CPU hotplug exclusion */
431fef59c9cSTejun Heo static struct workqueue_attrs *wq_update_pod_attrs_buf;
4324c16bd32STejun Heo 
43368e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
4341258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
435a9b8a985SSebastian Andrzej Siewior static DEFINE_RAW_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
436d8bb65abSSebastian Andrzej Siewior /* wait for manager to go away */
437d8bb65abSSebastian Andrzej Siewior static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
4385bcab335STejun Heo 
439e2dca7adSTejun Heo static LIST_HEAD(workqueues);		/* PR: list of all workqueues */
44068e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
4417d19c5ceSTejun Heo 
44299c621efSLai Jiangshan /* PL&A: allowable cpus for unbound wqs and work items */
443ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask;
444ef557180SMike Galbraith 
445fe28f631SWaiman Long /* PL: user requested unbound cpumask via sysfs */
446fe28f631SWaiman Long static cpumask_var_t wq_requested_unbound_cpumask;
447fe28f631SWaiman Long 
448fe28f631SWaiman Long /* PL: isolated cpumask to be excluded from unbound cpumask */
449fe28f631SWaiman Long static cpumask_var_t wq_isolated_cpumask;
450fe28f631SWaiman Long 
451ace3c549Stiozhang /* for further constrain wq_unbound_cpumask by cmdline parameter*/
452ace3c549Stiozhang static struct cpumask wq_cmdline_cpumask __initdata;
453ace3c549Stiozhang 
454ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */
455ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last);
456b05a7928SFrederic Weisbecker 
457f303fccbSTejun Heo /*
458f303fccbSTejun Heo  * Local execution of unbound work items is no longer guaranteed.  The
459f303fccbSTejun Heo  * following always forces round-robin CPU selection on unbound work items
460f303fccbSTejun Heo  * to uncover usages which depend on it.
461f303fccbSTejun Heo  */
462f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
463f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true;
464f303fccbSTejun Heo #else
465f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false;
466f303fccbSTejun Heo #endif
467f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
468f303fccbSTejun Heo 
4692f34d733STejun Heo /* to raise softirq for the BH worker pools on other CPUs */
4702f34d733STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct irq_work [NR_STD_WORKER_POOLS],
4712f34d733STejun Heo 				     bh_pool_irq_works);
4722f34d733STejun Heo 
4734cb1ef64STejun Heo /* the BH worker pools */
4744cb1ef64STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
4754cb1ef64STejun Heo 				     bh_worker_pools);
4764cb1ef64STejun Heo 
4777d19c5ceSTejun Heo /* the per-cpu worker pools */
4784cb1ef64STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
4794cb1ef64STejun Heo 				     cpu_worker_pools);
4807d19c5ceSTejun Heo 
48168e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
4827d19c5ceSTejun Heo 
48368e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
48429c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
48529c91e99STejun Heo 
486c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
48729c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
48829c91e99STejun Heo 
4898a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
4908a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
4918a2b7538STejun Heo 
492967b494eSTejun Heo /*
493978b8409STejun Heo  * Used to synchronize multiple cancel_sync attempts on the same work item. See
494978b8409STejun Heo  * work_grab_pending() and __cancel_work_sync().
495978b8409STejun Heo  */
496978b8409STejun Heo static DECLARE_WAIT_QUEUE_HEAD(wq_cancel_waitq);
497978b8409STejun Heo 
498978b8409STejun Heo /*
499967b494eSTejun Heo  * I: kthread_worker to release pwq's. pwq release needs to be bounced to a
500967b494eSTejun Heo  * process context while holding a pool lock. Bounce to a dedicated kthread
501967b494eSTejun Heo  * worker to avoid A-A deadlocks.
502967b494eSTejun Heo  */
50368279f9cSAlexey Dobriyan static struct kthread_worker *pwq_release_worker __ro_after_init;
504967b494eSTejun Heo 
50568279f9cSAlexey Dobriyan struct workqueue_struct *system_wq __ro_after_init;
506ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
50768279f9cSAlexey Dobriyan struct workqueue_struct *system_highpri_wq __ro_after_init;
5081aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
50968279f9cSAlexey Dobriyan struct workqueue_struct *system_long_wq __ro_after_init;
510d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
51168279f9cSAlexey Dobriyan struct workqueue_struct *system_unbound_wq __ro_after_init;
512f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
51368279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_wq __ro_after_init;
51424d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
51568279f9cSAlexey Dobriyan struct workqueue_struct *system_power_efficient_wq __ro_after_init;
5160668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
51768279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_power_efficient_wq __ro_after_init;
5180668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
5194cb1ef64STejun Heo struct workqueue_struct *system_bh_wq;
5204cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_wq);
5214cb1ef64STejun Heo struct workqueue_struct *system_bh_highpri_wq;
5224cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_highpri_wq);
523d320c038STejun Heo 
5247d19c5ceSTejun Heo static int worker_thread(void *__worker);
5256ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
526c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq);
52755df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool);
5287d19c5ceSTejun Heo 
52997bd2347STejun Heo #define CREATE_TRACE_POINTS
53097bd2347STejun Heo #include <trace/events/workqueue.h>
53197bd2347STejun Heo 
53268e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
533d355001fSTejun Heo 	RCU_LOCKDEP_WARN(!rcu_read_lock_any_held() &&			\
534f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
53524acfb71SThomas Gleixner 			 "RCU or wq_pool_mutex should be held")
5365bcab335STejun Heo 
5375b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)			\
538d355001fSTejun Heo 	RCU_LOCKDEP_WARN(!rcu_read_lock_any_held() &&			\
539f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex) &&		\
540f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
54124acfb71SThomas Gleixner 			 "RCU, wq->mutex or wq_pool_mutex should be held")
5425b95e1afSLai Jiangshan 
5434cb1ef64STejun Heo #define for_each_bh_worker_pool(pool, cpu)				\
5444cb1ef64STejun Heo 	for ((pool) = &per_cpu(bh_worker_pools, cpu)[0];		\
5454cb1ef64STejun Heo 	     (pool) < &per_cpu(bh_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
5464cb1ef64STejun Heo 	     (pool)++)
5474cb1ef64STejun Heo 
548f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
549f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
550f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
5517a62c2c8STejun Heo 	     (pool)++)
5524ce62e9eSTejun Heo 
55349e3cf44STejun Heo /**
55417116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
55517116969STejun Heo  * @pool: iteration cursor
556611c92a0STejun Heo  * @pi: integer used for iteration
557fa1b54e6STejun Heo  *
55824acfb71SThomas Gleixner  * This must be called either with wq_pool_mutex held or RCU read
55968e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
56068e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
561fa1b54e6STejun Heo  *
562fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
563fa1b54e6STejun Heo  * ignored.
56417116969STejun Heo  */
565611c92a0STejun Heo #define for_each_pool(pool, pi)						\
566611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
56768e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
568fa1b54e6STejun Heo 		else
56917116969STejun Heo 
57017116969STejun Heo /**
571822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
572822d8405STejun Heo  * @worker: iteration cursor
573822d8405STejun Heo  * @pool: worker_pool to iterate workers of
574822d8405STejun Heo  *
5751258fae7STejun Heo  * This must be called with wq_pool_attach_mutex.
576822d8405STejun Heo  *
577822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
578822d8405STejun Heo  * ignored.
579822d8405STejun Heo  */
580da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
581da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
5821258fae7STejun Heo 		if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
583822d8405STejun Heo 		else
584822d8405STejun Heo 
585822d8405STejun Heo /**
58649e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
58749e3cf44STejun Heo  * @pwq: iteration cursor
58849e3cf44STejun Heo  * @wq: the target workqueue
58976af4d93STejun Heo  *
59024acfb71SThomas Gleixner  * This must be called either with wq->mutex held or RCU read locked.
591794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
592794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
59376af4d93STejun Heo  *
59476af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
59576af4d93STejun Heo  * ignored.
59649e3cf44STejun Heo  */
59749e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
59849e9d1a9SSebastian Andrzej Siewior 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node,		\
5995a644662SJoel Fernandes (Google) 				 lockdep_is_held(&(wq->mutex)))
600f3421797STejun Heo 
601dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
602dc186ad7SThomas Gleixner 
603f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr;
604dc186ad7SThomas Gleixner 
60599777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
60699777288SStanislaw Gruszka {
60799777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
60899777288SStanislaw Gruszka }
60999777288SStanislaw Gruszka 
610b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr)
611b9fdac7fSDu, Changbin {
612b9fdac7fSDu, Changbin 	struct work_struct *work = addr;
613b9fdac7fSDu, Changbin 
614b9fdac7fSDu, Changbin 	return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
615b9fdac7fSDu, Changbin }
616b9fdac7fSDu, Changbin 
617dc186ad7SThomas Gleixner /*
618dc186ad7SThomas Gleixner  * fixup_init is called when:
619dc186ad7SThomas Gleixner  * - an active object is initialized
620dc186ad7SThomas Gleixner  */
62102a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state)
622dc186ad7SThomas Gleixner {
623dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
624dc186ad7SThomas Gleixner 
625dc186ad7SThomas Gleixner 	switch (state) {
626dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
627dc186ad7SThomas Gleixner 		cancel_work_sync(work);
628dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
62902a982a6SDu, Changbin 		return true;
630dc186ad7SThomas Gleixner 	default:
63102a982a6SDu, Changbin 		return false;
632dc186ad7SThomas Gleixner 	}
633dc186ad7SThomas Gleixner }
634dc186ad7SThomas Gleixner 
635dc186ad7SThomas Gleixner /*
636dc186ad7SThomas Gleixner  * fixup_free is called when:
637dc186ad7SThomas Gleixner  * - an active object is freed
638dc186ad7SThomas Gleixner  */
63902a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state)
640dc186ad7SThomas Gleixner {
641dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
642dc186ad7SThomas Gleixner 
643dc186ad7SThomas Gleixner 	switch (state) {
644dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
645dc186ad7SThomas Gleixner 		cancel_work_sync(work);
646dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
64702a982a6SDu, Changbin 		return true;
648dc186ad7SThomas Gleixner 	default:
64902a982a6SDu, Changbin 		return false;
650dc186ad7SThomas Gleixner 	}
651dc186ad7SThomas Gleixner }
652dc186ad7SThomas Gleixner 
653f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = {
654dc186ad7SThomas Gleixner 	.name		= "work_struct",
65599777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
656b9fdac7fSDu, Changbin 	.is_static_object = work_is_static_object,
657dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
658dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
659dc186ad7SThomas Gleixner };
660dc186ad7SThomas Gleixner 
661dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
662dc186ad7SThomas Gleixner {
663dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
664dc186ad7SThomas Gleixner }
665dc186ad7SThomas Gleixner 
666dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
667dc186ad7SThomas Gleixner {
668dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
669dc186ad7SThomas Gleixner }
670dc186ad7SThomas Gleixner 
671dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
672dc186ad7SThomas Gleixner {
673dc186ad7SThomas Gleixner 	if (onstack)
674dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
675dc186ad7SThomas Gleixner 	else
676dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
677dc186ad7SThomas Gleixner }
678dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
679dc186ad7SThomas Gleixner 
680dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
681dc186ad7SThomas Gleixner {
682dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
683dc186ad7SThomas Gleixner }
684dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
685dc186ad7SThomas Gleixner 
686ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
687ea2e64f2SThomas Gleixner {
688ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
689ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
690ea2e64f2SThomas Gleixner }
691ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
692ea2e64f2SThomas Gleixner 
693dc186ad7SThomas Gleixner #else
694dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
695dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
696dc186ad7SThomas Gleixner #endif
697dc186ad7SThomas Gleixner 
6984e8b22bdSLi Bin /**
69967dc8325SCai Huoqing  * worker_pool_assign_id - allocate ID and assign it to @pool
7004e8b22bdSLi Bin  * @pool: the pool pointer of interest
7014e8b22bdSLi Bin  *
7024e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
7034e8b22bdSLi Bin  * successfully, -errno on failure.
7044e8b22bdSLi Bin  */
7059daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
7069daf9e67STejun Heo {
7079daf9e67STejun Heo 	int ret;
7089daf9e67STejun Heo 
70968e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
7105bcab335STejun Heo 
7114e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
7124e8b22bdSLi Bin 			GFP_KERNEL);
713229641a6STejun Heo 	if (ret >= 0) {
714e68035fbSTejun Heo 		pool->id = ret;
715229641a6STejun Heo 		return 0;
716229641a6STejun Heo 	}
7179daf9e67STejun Heo 	return ret;
7189daf9e67STejun Heo }
7199daf9e67STejun Heo 
7209f66cff2STejun Heo static struct pool_workqueue __rcu **
7219f66cff2STejun Heo unbound_pwq_slot(struct workqueue_struct *wq, int cpu)
7229f66cff2STejun Heo {
7239f66cff2STejun Heo        if (cpu >= 0)
7249f66cff2STejun Heo                return per_cpu_ptr(wq->cpu_pwq, cpu);
7259f66cff2STejun Heo        else
7269f66cff2STejun Heo                return &wq->dfl_pwq;
7279f66cff2STejun Heo }
7289f66cff2STejun Heo 
7299f66cff2STejun Heo /* @cpu < 0 for dfl_pwq */
7309f66cff2STejun Heo static struct pool_workqueue *unbound_pwq(struct workqueue_struct *wq, int cpu)
7319f66cff2STejun Heo {
7329f66cff2STejun Heo 	return rcu_dereference_check(*unbound_pwq_slot(wq, cpu),
7339f66cff2STejun Heo 				     lockdep_is_held(&wq_pool_mutex) ||
7349f66cff2STejun Heo 				     lockdep_is_held(&wq->mutex));
7359f66cff2STejun Heo }
7369f66cff2STejun Heo 
7375797b1c1STejun Heo /**
7385797b1c1STejun Heo  * unbound_effective_cpumask - effective cpumask of an unbound workqueue
7395797b1c1STejun Heo  * @wq: workqueue of interest
7405797b1c1STejun Heo  *
7415797b1c1STejun Heo  * @wq->unbound_attrs->cpumask contains the cpumask requested by the user which
7425797b1c1STejun Heo  * is masked with wq_unbound_cpumask to determine the effective cpumask. The
7435797b1c1STejun Heo  * default pwq is always mapped to the pool with the current effective cpumask.
7445797b1c1STejun Heo  */
7455797b1c1STejun Heo static struct cpumask *unbound_effective_cpumask(struct workqueue_struct *wq)
7465797b1c1STejun Heo {
7475797b1c1STejun Heo 	return unbound_pwq(wq, -1)->pool->attrs->__pod_cpumask;
7485797b1c1STejun Heo }
7495797b1c1STejun Heo 
75073f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
75173f53c4aSTejun Heo {
75273f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
75373f53c4aSTejun Heo }
75473f53c4aSTejun Heo 
755c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data)
75673f53c4aSTejun Heo {
757c4560c2cSLai Jiangshan 	return (work_data >> WORK_STRUCT_COLOR_SHIFT) &
75873f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
75973f53c4aSTejun Heo }
76073f53c4aSTejun Heo 
76173f53c4aSTejun Heo static int work_next_color(int color)
76273f53c4aSTejun Heo {
76373f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
764a848e3b6SOleg Nesterov }
765a848e3b6SOleg Nesterov 
7664594bf15SDavid Howells /*
767112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
768112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
7697c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
7707a22ad75STejun Heo  *
771afe928c1STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending() and mark_work_canceling()
772afe928c1STejun Heo  * can be used to set the pwq, pool or clear work->data. These functions should
773afe928c1STejun Heo  * only be called while the work is owned - ie. while the PENDING bit is set.
7747a22ad75STejun Heo  *
775112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
7767c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
777112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
7787c3eed5cSTejun Heo  * available only while the work item is queued.
779bbb68dfaSTejun Heo  *
780bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
781bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
782bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
783bbb68dfaSTejun Heo  * try to steal the PENDING bit.
7844594bf15SDavid Howells  */
785bccdc1faSTejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data)
7867a22ad75STejun Heo {
7876183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
788bccdc1faSTejun Heo 	atomic_long_set(&work->data, data | work_static(work));
7897a22ad75STejun Heo }
7907a22ad75STejun Heo 
791112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
792bccdc1faSTejun Heo 			 unsigned long flags)
793365970a1SDavid Howells {
794bccdc1faSTejun Heo 	set_work_data(work, (unsigned long)pwq | WORK_STRUCT_PENDING |
795bccdc1faSTejun Heo 		      WORK_STRUCT_PWQ | flags);
796365970a1SDavid Howells }
797365970a1SDavid Howells 
7984468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
799bccdc1faSTejun Heo 					   int pool_id, unsigned long flags)
8004468a00fSLai Jiangshan {
801bccdc1faSTejun Heo 	set_work_data(work, ((unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT) |
802bccdc1faSTejun Heo 		      WORK_STRUCT_PENDING | flags);
8034468a00fSLai Jiangshan }
8044468a00fSLai Jiangshan 
8057c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
806bccdc1faSTejun Heo 					    int pool_id, unsigned long flags)
8074d707b9fSOleg Nesterov {
80823657bb1STejun Heo 	/*
80923657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
81023657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
81123657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
81223657bb1STejun Heo 	 * owner.
81323657bb1STejun Heo 	 */
81423657bb1STejun Heo 	smp_wmb();
815bccdc1faSTejun Heo 	set_work_data(work, ((unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT) |
816bccdc1faSTejun Heo 		      flags);
817346c09f8SRoman Pen 	/*
818346c09f8SRoman Pen 	 * The following mb guarantees that previous clear of a PENDING bit
819346c09f8SRoman Pen 	 * will not be reordered with any speculative LOADS or STORES from
820346c09f8SRoman Pen 	 * work->current_func, which is executed afterwards.  This possible
8218bdc6201SLiu Song 	 * reordering can lead to a missed execution on attempt to queue
822346c09f8SRoman Pen 	 * the same @work.  E.g. consider this case:
823346c09f8SRoman Pen 	 *
824346c09f8SRoman Pen 	 *   CPU#0                         CPU#1
825346c09f8SRoman Pen 	 *   ----------------------------  --------------------------------
826346c09f8SRoman Pen 	 *
827346c09f8SRoman Pen 	 * 1  STORE event_indicated
828346c09f8SRoman Pen 	 * 2  queue_work_on() {
829346c09f8SRoman Pen 	 * 3    test_and_set_bit(PENDING)
830346c09f8SRoman Pen 	 * 4 }                             set_..._and_clear_pending() {
831346c09f8SRoman Pen 	 * 5                                 set_work_data() # clear bit
832346c09f8SRoman Pen 	 * 6                                 smp_mb()
833346c09f8SRoman Pen 	 * 7                               work->current_func() {
834346c09f8SRoman Pen 	 * 8				      LOAD event_indicated
835346c09f8SRoman Pen 	 *				   }
836346c09f8SRoman Pen 	 *
837346c09f8SRoman Pen 	 * Without an explicit full barrier speculative LOAD on line 8 can
838346c09f8SRoman Pen 	 * be executed before CPU#0 does STORE on line 1.  If that happens,
839346c09f8SRoman Pen 	 * CPU#0 observes the PENDING bit is still set and new execution of
840346c09f8SRoman Pen 	 * a @work is not queued in a hope, that CPU#1 will eventually
841346c09f8SRoman Pen 	 * finish the queued @work.  Meanwhile CPU#1 does not see
842346c09f8SRoman Pen 	 * event_indicated is set, because speculative LOAD was executed
843346c09f8SRoman Pen 	 * before actual STORE.
844346c09f8SRoman Pen 	 */
845346c09f8SRoman Pen 	smp_mb();
8464d707b9fSOleg Nesterov }
8474d707b9fSOleg Nesterov 
848afa4bb77SLinus Torvalds static inline struct pool_workqueue *work_struct_pwq(unsigned long data)
849afa4bb77SLinus Torvalds {
850e9a8e01fSTejun Heo 	return (struct pool_workqueue *)(data & WORK_STRUCT_PWQ_MASK);
851afa4bb77SLinus Torvalds }
852afa4bb77SLinus Torvalds 
853112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
8547a22ad75STejun Heo {
855e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
8567a22ad75STejun Heo 
857112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
858afa4bb77SLinus Torvalds 		return work_struct_pwq(data);
859e120153dSTejun Heo 	else
860e120153dSTejun Heo 		return NULL;
8617a22ad75STejun Heo }
8627a22ad75STejun Heo 
8637c3eed5cSTejun Heo /**
8647c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
8657c3eed5cSTejun Heo  * @work: the work item of interest
8667c3eed5cSTejun Heo  *
86768e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
86824acfb71SThomas Gleixner  * access under RCU read lock.  As such, this function should be
86924acfb71SThomas Gleixner  * called under wq_pool_mutex or inside of a rcu_read_lock() region.
870fa1b54e6STejun Heo  *
871fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
872fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
873fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
874fa1b54e6STejun Heo  * returned pool is and stays online.
875d185af30SYacine Belkadi  *
876d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
8777c3eed5cSTejun Heo  */
8787c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
8797a22ad75STejun Heo {
880e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
8817c3eed5cSTejun Heo 	int pool_id;
8827a22ad75STejun Heo 
88368e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
884fa1b54e6STejun Heo 
885112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
886afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool;
8877a22ad75STejun Heo 
8887c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
8897c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
8907a22ad75STejun Heo 		return NULL;
8917a22ad75STejun Heo 
892fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
8937c3eed5cSTejun Heo }
8947c3eed5cSTejun Heo 
8957c3eed5cSTejun Heo /**
8967c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
8977c3eed5cSTejun Heo  * @work: the work item of interest
8987c3eed5cSTejun Heo  *
899d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
9007c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
9017c3eed5cSTejun Heo  */
9027c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
9037c3eed5cSTejun Heo {
90454d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
9057c3eed5cSTejun Heo 
906112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
907afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool->id;
90854d5b7d0SLai Jiangshan 
90954d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
9107c3eed5cSTejun Heo }
9117c3eed5cSTejun Heo 
912bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
913bbb68dfaSTejun Heo {
9147c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
915bbb68dfaSTejun Heo 
9167c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
917bccdc1faSTejun Heo 	set_work_data(work, pool_id | WORK_STRUCT_PENDING | WORK_OFFQ_CANCELING);
918bbb68dfaSTejun Heo }
919bbb68dfaSTejun Heo 
920bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
921bbb68dfaSTejun Heo {
922bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
923bbb68dfaSTejun Heo 
924112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
925bbb68dfaSTejun Heo }
926bbb68dfaSTejun Heo 
927e22bee78STejun Heo /*
9283270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
9293270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
930d565ed63STejun Heo  * they're being called with pool->lock held.
931e22bee78STejun Heo  */
932e22bee78STejun Heo 
933e22bee78STejun Heo /*
934e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
935e22bee78STejun Heo  * running workers.
936974271c4STejun Heo  *
937974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
938706026c2STejun Heo  * function will always return %true for unbound pools as long as the
939974271c4STejun Heo  * worklist isn't empty.
940e22bee78STejun Heo  */
94163d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
942e22bee78STejun Heo {
9430219a352STejun Heo 	return !list_empty(&pool->worklist) && !pool->nr_running;
944e22bee78STejun Heo }
945e22bee78STejun Heo 
946e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
94763d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
948e22bee78STejun Heo {
94963d95a91STejun Heo 	return pool->nr_idle;
950e22bee78STejun Heo }
951e22bee78STejun Heo 
952e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
95363d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
954e22bee78STejun Heo {
955bc35f7efSLai Jiangshan 	return !list_empty(&pool->worklist) && (pool->nr_running <= 1);
956e22bee78STejun Heo }
957e22bee78STejun Heo 
958e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
95963d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
960e22bee78STejun Heo {
96163d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
962e22bee78STejun Heo }
963e22bee78STejun Heo 
964e22bee78STejun Heo /* Do we have too many workers and should some go away? */
96563d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
966e22bee78STejun Heo {
967692b4825STejun Heo 	bool managing = pool->flags & POOL_MANAGER_ACTIVE;
96863d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
96963d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
970e22bee78STejun Heo 
971e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
972e22bee78STejun Heo }
973e22bee78STejun Heo 
9744690c4abSTejun Heo /**
975e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
976cb444766STejun Heo  * @worker: self
977d302f017STejun Heo  * @flags: flags to set
978d302f017STejun Heo  *
979228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
980d302f017STejun Heo  */
981228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
982d302f017STejun Heo {
983bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
984e22bee78STejun Heo 
985bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
986cb444766STejun Heo 
987228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
988e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
989e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
990bc35f7efSLai Jiangshan 		pool->nr_running--;
991e22bee78STejun Heo 	}
992e22bee78STejun Heo 
993d302f017STejun Heo 	worker->flags |= flags;
994d302f017STejun Heo }
995d302f017STejun Heo 
996d302f017STejun Heo /**
997e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
998cb444766STejun Heo  * @worker: self
999d302f017STejun Heo  * @flags: flags to clear
1000d302f017STejun Heo  *
1001e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
1002d302f017STejun Heo  */
1003d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
1004d302f017STejun Heo {
100563d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
1006e22bee78STejun Heo 	unsigned int oflags = worker->flags;
1007e22bee78STejun Heo 
1008bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
1009cb444766STejun Heo 
1010d302f017STejun Heo 	worker->flags &= ~flags;
1011e22bee78STejun Heo 
101242c025f3STejun Heo 	/*
101342c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
101442c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
101542c025f3STejun Heo 	 * of multiple flags, not a single flag.
101642c025f3STejun Heo 	 */
1017e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
1018e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
1019bc35f7efSLai Jiangshan 			pool->nr_running++;
1020d302f017STejun Heo }
1021d302f017STejun Heo 
1022797e8345STejun Heo /* Return the first idle worker.  Called with pool->lock held. */
1023797e8345STejun Heo static struct worker *first_idle_worker(struct worker_pool *pool)
1024797e8345STejun Heo {
1025797e8345STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
1026797e8345STejun Heo 		return NULL;
1027797e8345STejun Heo 
1028797e8345STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
1029797e8345STejun Heo }
1030797e8345STejun Heo 
1031797e8345STejun Heo /**
1032797e8345STejun Heo  * worker_enter_idle - enter idle state
1033797e8345STejun Heo  * @worker: worker which is entering idle state
1034797e8345STejun Heo  *
1035797e8345STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1036797e8345STejun Heo  * necessary.
1037797e8345STejun Heo  *
1038797e8345STejun Heo  * LOCKING:
1039797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1040797e8345STejun Heo  */
1041797e8345STejun Heo static void worker_enter_idle(struct worker *worker)
1042797e8345STejun Heo {
1043797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
1044797e8345STejun Heo 
1045797e8345STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1046797e8345STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
1047797e8345STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
1048797e8345STejun Heo 		return;
1049797e8345STejun Heo 
1050797e8345STejun Heo 	/* can't use worker_set_flags(), also called from create_worker() */
1051797e8345STejun Heo 	worker->flags |= WORKER_IDLE;
1052797e8345STejun Heo 	pool->nr_idle++;
1053797e8345STejun Heo 	worker->last_active = jiffies;
1054797e8345STejun Heo 
1055797e8345STejun Heo 	/* idle_list is LIFO */
1056797e8345STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1057797e8345STejun Heo 
1058797e8345STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1059797e8345STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1060797e8345STejun Heo 
1061797e8345STejun Heo 	/* Sanity check nr_running. */
1062797e8345STejun Heo 	WARN_ON_ONCE(pool->nr_workers == pool->nr_idle && pool->nr_running);
1063797e8345STejun Heo }
1064797e8345STejun Heo 
1065797e8345STejun Heo /**
1066797e8345STejun Heo  * worker_leave_idle - leave idle state
1067797e8345STejun Heo  * @worker: worker which is leaving idle state
1068797e8345STejun Heo  *
1069797e8345STejun Heo  * @worker is leaving idle state.  Update stats.
1070797e8345STejun Heo  *
1071797e8345STejun Heo  * LOCKING:
1072797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1073797e8345STejun Heo  */
1074797e8345STejun Heo static void worker_leave_idle(struct worker *worker)
1075797e8345STejun Heo {
1076797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
1077797e8345STejun Heo 
1078797e8345STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1079797e8345STejun Heo 		return;
1080797e8345STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1081797e8345STejun Heo 	pool->nr_idle--;
1082797e8345STejun Heo 	list_del_init(&worker->entry);
1083797e8345STejun Heo }
1084797e8345STejun Heo 
1085797e8345STejun Heo /**
1086797e8345STejun Heo  * find_worker_executing_work - find worker which is executing a work
1087797e8345STejun Heo  * @pool: pool of interest
1088797e8345STejun Heo  * @work: work to find worker for
1089797e8345STejun Heo  *
1090797e8345STejun Heo  * Find a worker which is executing @work on @pool by searching
1091797e8345STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
1092797e8345STejun Heo  * to match, its current execution should match the address of @work and
1093797e8345STejun Heo  * its work function.  This is to avoid unwanted dependency between
1094797e8345STejun Heo  * unrelated work executions through a work item being recycled while still
1095797e8345STejun Heo  * being executed.
1096797e8345STejun Heo  *
1097797e8345STejun Heo  * This is a bit tricky.  A work item may be freed once its execution
1098797e8345STejun Heo  * starts and nothing prevents the freed area from being recycled for
1099797e8345STejun Heo  * another work item.  If the same work item address ends up being reused
1100797e8345STejun Heo  * before the original execution finishes, workqueue will identify the
1101797e8345STejun Heo  * recycled work item as currently executing and make it wait until the
1102797e8345STejun Heo  * current execution finishes, introducing an unwanted dependency.
1103797e8345STejun Heo  *
1104797e8345STejun Heo  * This function checks the work item address and work function to avoid
1105797e8345STejun Heo  * false positives.  Note that this isn't complete as one may construct a
1106797e8345STejun Heo  * work function which can introduce dependency onto itself through a
1107797e8345STejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
1108797e8345STejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
1109797e8345STejun Heo  * actually occurs, it should be easy to locate the culprit work function.
1110797e8345STejun Heo  *
1111797e8345STejun Heo  * CONTEXT:
1112797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1113797e8345STejun Heo  *
1114797e8345STejun Heo  * Return:
1115797e8345STejun Heo  * Pointer to worker which is executing @work if found, %NULL
1116797e8345STejun Heo  * otherwise.
1117797e8345STejun Heo  */
1118797e8345STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
1119797e8345STejun Heo 						 struct work_struct *work)
1120797e8345STejun Heo {
1121797e8345STejun Heo 	struct worker *worker;
1122797e8345STejun Heo 
1123797e8345STejun Heo 	hash_for_each_possible(pool->busy_hash, worker, hentry,
1124797e8345STejun Heo 			       (unsigned long)work)
1125797e8345STejun Heo 		if (worker->current_work == work &&
1126797e8345STejun Heo 		    worker->current_func == work->func)
1127797e8345STejun Heo 			return worker;
1128797e8345STejun Heo 
1129797e8345STejun Heo 	return NULL;
1130797e8345STejun Heo }
1131797e8345STejun Heo 
1132797e8345STejun Heo /**
1133797e8345STejun Heo  * move_linked_works - move linked works to a list
1134797e8345STejun Heo  * @work: start of series of works to be scheduled
1135797e8345STejun Heo  * @head: target list to append @work to
1136797e8345STejun Heo  * @nextp: out parameter for nested worklist walking
1137797e8345STejun Heo  *
1138873eaca6STejun Heo  * Schedule linked works starting from @work to @head. Work series to be
1139873eaca6STejun Heo  * scheduled starts at @work and includes any consecutive work with
1140873eaca6STejun Heo  * WORK_STRUCT_LINKED set in its predecessor. See assign_work() for details on
1141873eaca6STejun Heo  * @nextp.
1142797e8345STejun Heo  *
1143797e8345STejun Heo  * CONTEXT:
1144797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1145797e8345STejun Heo  */
1146797e8345STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1147797e8345STejun Heo 			      struct work_struct **nextp)
1148797e8345STejun Heo {
1149797e8345STejun Heo 	struct work_struct *n;
1150797e8345STejun Heo 
1151797e8345STejun Heo 	/*
1152797e8345STejun Heo 	 * Linked worklist will always end before the end of the list,
1153797e8345STejun Heo 	 * use NULL for list head.
1154797e8345STejun Heo 	 */
1155797e8345STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1156797e8345STejun Heo 		list_move_tail(&work->entry, head);
1157797e8345STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1158797e8345STejun Heo 			break;
1159797e8345STejun Heo 	}
1160797e8345STejun Heo 
1161797e8345STejun Heo 	/*
1162797e8345STejun Heo 	 * If we're already inside safe list traversal and have moved
1163797e8345STejun Heo 	 * multiple works to the scheduled queue, the next position
1164797e8345STejun Heo 	 * needs to be updated.
1165797e8345STejun Heo 	 */
1166797e8345STejun Heo 	if (nextp)
1167797e8345STejun Heo 		*nextp = n;
1168797e8345STejun Heo }
1169797e8345STejun Heo 
1170797e8345STejun Heo /**
1171873eaca6STejun Heo  * assign_work - assign a work item and its linked work items to a worker
1172873eaca6STejun Heo  * @work: work to assign
1173873eaca6STejun Heo  * @worker: worker to assign to
1174873eaca6STejun Heo  * @nextp: out parameter for nested worklist walking
1175873eaca6STejun Heo  *
1176873eaca6STejun Heo  * Assign @work and its linked work items to @worker. If @work is already being
1177873eaca6STejun Heo  * executed by another worker in the same pool, it'll be punted there.
1178873eaca6STejun Heo  *
1179873eaca6STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of the last
1180873eaca6STejun Heo  * scheduled work. This allows assign_work() to be nested inside
1181873eaca6STejun Heo  * list_for_each_entry_safe().
1182873eaca6STejun Heo  *
1183873eaca6STejun Heo  * Returns %true if @work was successfully assigned to @worker. %false if @work
1184873eaca6STejun Heo  * was punted to another worker already executing it.
1185873eaca6STejun Heo  */
1186873eaca6STejun Heo static bool assign_work(struct work_struct *work, struct worker *worker,
1187873eaca6STejun Heo 			struct work_struct **nextp)
1188873eaca6STejun Heo {
1189873eaca6STejun Heo 	struct worker_pool *pool = worker->pool;
1190873eaca6STejun Heo 	struct worker *collision;
1191873eaca6STejun Heo 
1192873eaca6STejun Heo 	lockdep_assert_held(&pool->lock);
1193873eaca6STejun Heo 
1194873eaca6STejun Heo 	/*
1195873eaca6STejun Heo 	 * A single work shouldn't be executed concurrently by multiple workers.
1196873eaca6STejun Heo 	 * __queue_work() ensures that @work doesn't jump to a different pool
1197873eaca6STejun Heo 	 * while still running in the previous pool. Here, we should ensure that
1198873eaca6STejun Heo 	 * @work is not executed concurrently by multiple workers from the same
1199873eaca6STejun Heo 	 * pool. Check whether anyone is already processing the work. If so,
1200873eaca6STejun Heo 	 * defer the work to the currently executing one.
1201873eaca6STejun Heo 	 */
1202873eaca6STejun Heo 	collision = find_worker_executing_work(pool, work);
1203873eaca6STejun Heo 	if (unlikely(collision)) {
1204873eaca6STejun Heo 		move_linked_works(work, &collision->scheduled, nextp);
1205873eaca6STejun Heo 		return false;
1206873eaca6STejun Heo 	}
1207873eaca6STejun Heo 
1208873eaca6STejun Heo 	move_linked_works(work, &worker->scheduled, nextp);
1209873eaca6STejun Heo 	return true;
1210873eaca6STejun Heo }
1211873eaca6STejun Heo 
12122f34d733STejun Heo static struct irq_work *bh_pool_irq_work(struct worker_pool *pool)
12132f34d733STejun Heo {
12142f34d733STejun Heo 	int high = pool->attrs->nice == HIGHPRI_NICE_LEVEL ? 1 : 0;
12152f34d733STejun Heo 
12162f34d733STejun Heo 	return &per_cpu(bh_pool_irq_works, pool->cpu)[high];
12172f34d733STejun Heo }
12182f34d733STejun Heo 
1219fd0a68a2STejun Heo static void kick_bh_pool(struct worker_pool *pool)
1220fd0a68a2STejun Heo {
1221fd0a68a2STejun Heo #ifdef CONFIG_SMP
1222*1acd92d9STejun Heo 	/* see drain_dead_softirq_workfn() for BH_DRAINING */
1223*1acd92d9STejun Heo 	if (unlikely(pool->cpu != smp_processor_id() &&
1224*1acd92d9STejun Heo 		     !(pool->flags & POOL_BH_DRAINING))) {
1225fd0a68a2STejun Heo 		irq_work_queue_on(bh_pool_irq_work(pool), pool->cpu);
1226fd0a68a2STejun Heo 		return;
1227fd0a68a2STejun Heo 	}
1228fd0a68a2STejun Heo #endif
1229fd0a68a2STejun Heo 	if (pool->attrs->nice == HIGHPRI_NICE_LEVEL)
1230fd0a68a2STejun Heo 		raise_softirq_irqoff(HI_SOFTIRQ);
1231fd0a68a2STejun Heo 	else
1232fd0a68a2STejun Heo 		raise_softirq_irqoff(TASKLET_SOFTIRQ);
1233fd0a68a2STejun Heo }
1234fd0a68a2STejun Heo 
1235873eaca6STejun Heo /**
12360219a352STejun Heo  * kick_pool - wake up an idle worker if necessary
12370219a352STejun Heo  * @pool: pool to kick
1238797e8345STejun Heo  *
12390219a352STejun Heo  * @pool may have pending work items. Wake up worker if necessary. Returns
12400219a352STejun Heo  * whether a worker was woken up.
1241797e8345STejun Heo  */
12420219a352STejun Heo static bool kick_pool(struct worker_pool *pool)
1243797e8345STejun Heo {
1244797e8345STejun Heo 	struct worker *worker = first_idle_worker(pool);
12458639ecebSTejun Heo 	struct task_struct *p;
1246797e8345STejun Heo 
12470219a352STejun Heo 	lockdep_assert_held(&pool->lock);
12480219a352STejun Heo 
12490219a352STejun Heo 	if (!need_more_worker(pool) || !worker)
12500219a352STejun Heo 		return false;
12510219a352STejun Heo 
12524cb1ef64STejun Heo 	if (pool->flags & POOL_BH) {
1253fd0a68a2STejun Heo 		kick_bh_pool(pool);
12544cb1ef64STejun Heo 		return true;
12554cb1ef64STejun Heo 	}
12564cb1ef64STejun Heo 
12578639ecebSTejun Heo 	p = worker->task;
12588639ecebSTejun Heo 
12598639ecebSTejun Heo #ifdef CONFIG_SMP
12608639ecebSTejun Heo 	/*
12618639ecebSTejun Heo 	 * Idle @worker is about to execute @work and waking up provides an
12628639ecebSTejun Heo 	 * opportunity to migrate @worker at a lower cost by setting the task's
12638639ecebSTejun Heo 	 * wake_cpu field. Let's see if we want to move @worker to improve
12648639ecebSTejun Heo 	 * execution locality.
12658639ecebSTejun Heo 	 *
12668639ecebSTejun Heo 	 * We're waking the worker that went idle the latest and there's some
12678639ecebSTejun Heo 	 * chance that @worker is marked idle but hasn't gone off CPU yet. If
12688639ecebSTejun Heo 	 * so, setting the wake_cpu won't do anything. As this is a best-effort
12698639ecebSTejun Heo 	 * optimization and the race window is narrow, let's leave as-is for
12708639ecebSTejun Heo 	 * now. If this becomes pronounced, we can skip over workers which are
12718639ecebSTejun Heo 	 * still on cpu when picking an idle worker.
12728639ecebSTejun Heo 	 *
12738639ecebSTejun Heo 	 * If @pool has non-strict affinity, @worker might have ended up outside
12748639ecebSTejun Heo 	 * its affinity scope. Repatriate.
12758639ecebSTejun Heo 	 */
12768639ecebSTejun Heo 	if (!pool->attrs->affn_strict &&
12778639ecebSTejun Heo 	    !cpumask_test_cpu(p->wake_cpu, pool->attrs->__pod_cpumask)) {
12788639ecebSTejun Heo 		struct work_struct *work = list_first_entry(&pool->worklist,
12798639ecebSTejun Heo 						struct work_struct, entry);
12808639ecebSTejun Heo 		p->wake_cpu = cpumask_any_distribute(pool->attrs->__pod_cpumask);
12818639ecebSTejun Heo 		get_work_pwq(work)->stats[PWQ_STAT_REPATRIATED]++;
12828639ecebSTejun Heo 	}
12838639ecebSTejun Heo #endif
12848639ecebSTejun Heo 	wake_up_process(p);
12850219a352STejun Heo 	return true;
1286797e8345STejun Heo }
1287797e8345STejun Heo 
128863638450STejun Heo #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT
128963638450STejun Heo 
129063638450STejun Heo /*
129163638450STejun Heo  * Concurrency-managed per-cpu work items that hog CPU for longer than
129263638450STejun Heo  * wq_cpu_intensive_thresh_us trigger the automatic CPU_INTENSIVE mechanism,
129363638450STejun Heo  * which prevents them from stalling other concurrency-managed work items. If a
129463638450STejun Heo  * work function keeps triggering this mechanism, it's likely that the work item
129563638450STejun Heo  * should be using an unbound workqueue instead.
129663638450STejun Heo  *
129763638450STejun Heo  * wq_cpu_intensive_report() tracks work functions which trigger such conditions
129863638450STejun Heo  * and report them so that they can be examined and converted to use unbound
129963638450STejun Heo  * workqueues as appropriate. To avoid flooding the console, each violating work
130063638450STejun Heo  * function is tracked and reported with exponential backoff.
130163638450STejun Heo  */
130263638450STejun Heo #define WCI_MAX_ENTS 128
130363638450STejun Heo 
130463638450STejun Heo struct wci_ent {
130563638450STejun Heo 	work_func_t		func;
130663638450STejun Heo 	atomic64_t		cnt;
130763638450STejun Heo 	struct hlist_node	hash_node;
130863638450STejun Heo };
130963638450STejun Heo 
131063638450STejun Heo static struct wci_ent wci_ents[WCI_MAX_ENTS];
131163638450STejun Heo static int wci_nr_ents;
131263638450STejun Heo static DEFINE_RAW_SPINLOCK(wci_lock);
131363638450STejun Heo static DEFINE_HASHTABLE(wci_hash, ilog2(WCI_MAX_ENTS));
131463638450STejun Heo 
131563638450STejun Heo static struct wci_ent *wci_find_ent(work_func_t func)
131663638450STejun Heo {
131763638450STejun Heo 	struct wci_ent *ent;
131863638450STejun Heo 
131963638450STejun Heo 	hash_for_each_possible_rcu(wci_hash, ent, hash_node,
132063638450STejun Heo 				   (unsigned long)func) {
132163638450STejun Heo 		if (ent->func == func)
132263638450STejun Heo 			return ent;
132363638450STejun Heo 	}
132463638450STejun Heo 	return NULL;
132563638450STejun Heo }
132663638450STejun Heo 
132763638450STejun Heo static void wq_cpu_intensive_report(work_func_t func)
132863638450STejun Heo {
132963638450STejun Heo 	struct wci_ent *ent;
133063638450STejun Heo 
133163638450STejun Heo restart:
133263638450STejun Heo 	ent = wci_find_ent(func);
133363638450STejun Heo 	if (ent) {
133463638450STejun Heo 		u64 cnt;
133563638450STejun Heo 
133663638450STejun Heo 		/*
1337ccdec921SXuewen Yan 		 * Start reporting from the warning_thresh and back off
133863638450STejun Heo 		 * exponentially.
133963638450STejun Heo 		 */
134063638450STejun Heo 		cnt = atomic64_inc_return_relaxed(&ent->cnt);
1341ccdec921SXuewen Yan 		if (wq_cpu_intensive_warning_thresh &&
1342ccdec921SXuewen Yan 		    cnt >= wq_cpu_intensive_warning_thresh &&
1343ccdec921SXuewen Yan 		    is_power_of_2(cnt + 1 - wq_cpu_intensive_warning_thresh))
134463638450STejun Heo 			printk_deferred(KERN_WARNING "workqueue: %ps hogged CPU for >%luus %llu times, consider switching to WQ_UNBOUND\n",
134563638450STejun Heo 					ent->func, wq_cpu_intensive_thresh_us,
134663638450STejun Heo 					atomic64_read(&ent->cnt));
134763638450STejun Heo 		return;
134863638450STejun Heo 	}
134963638450STejun Heo 
135063638450STejun Heo 	/*
135163638450STejun Heo 	 * @func is a new violation. Allocate a new entry for it. If wcn_ents[]
135263638450STejun Heo 	 * is exhausted, something went really wrong and we probably made enough
135363638450STejun Heo 	 * noise already.
135463638450STejun Heo 	 */
135563638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS)
135663638450STejun Heo 		return;
135763638450STejun Heo 
135863638450STejun Heo 	raw_spin_lock(&wci_lock);
135963638450STejun Heo 
136063638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS) {
136163638450STejun Heo 		raw_spin_unlock(&wci_lock);
136263638450STejun Heo 		return;
136363638450STejun Heo 	}
136463638450STejun Heo 
136563638450STejun Heo 	if (wci_find_ent(func)) {
136663638450STejun Heo 		raw_spin_unlock(&wci_lock);
136763638450STejun Heo 		goto restart;
136863638450STejun Heo 	}
136963638450STejun Heo 
137063638450STejun Heo 	ent = &wci_ents[wci_nr_ents++];
137163638450STejun Heo 	ent->func = func;
1372ccdec921SXuewen Yan 	atomic64_set(&ent->cnt, 0);
137363638450STejun Heo 	hash_add_rcu(wci_hash, &ent->hash_node, (unsigned long)func);
137463638450STejun Heo 
137563638450STejun Heo 	raw_spin_unlock(&wci_lock);
1376ccdec921SXuewen Yan 
1377ccdec921SXuewen Yan 	goto restart;
137863638450STejun Heo }
137963638450STejun Heo 
138063638450STejun Heo #else	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
138163638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) {}
138263638450STejun Heo #endif	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
138363638450STejun Heo 
1384c54d5046STejun Heo /**
13851da177e4SLinus Torvalds  * wq_worker_running - a worker is running again
13861da177e4SLinus Torvalds  * @task: task waking up
13871da177e4SLinus Torvalds  *
13881da177e4SLinus Torvalds  * This function is called when a worker returns from schedule()
13891da177e4SLinus Torvalds  */
13901da177e4SLinus Torvalds void wq_worker_running(struct task_struct *task)
13911da177e4SLinus Torvalds {
13921da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
13931da177e4SLinus Torvalds 
1394c8f6219bSZqiang 	if (!READ_ONCE(worker->sleeping))
13951da177e4SLinus Torvalds 		return;
13961da177e4SLinus Torvalds 
13971da177e4SLinus Torvalds 	/*
13981da177e4SLinus Torvalds 	 * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check
13991da177e4SLinus Torvalds 	 * and the nr_running increment below, we may ruin the nr_running reset
14001da177e4SLinus Torvalds 	 * and leave with an unexpected pool->nr_running == 1 on the newly unbound
14011da177e4SLinus Torvalds 	 * pool. Protect against such race.
14021da177e4SLinus Torvalds 	 */
14031da177e4SLinus Torvalds 	preempt_disable();
14041da177e4SLinus Torvalds 	if (!(worker->flags & WORKER_NOT_RUNNING))
14051da177e4SLinus Torvalds 		worker->pool->nr_running++;
14061da177e4SLinus Torvalds 	preempt_enable();
1407616db877STejun Heo 
1408616db877STejun Heo 	/*
1409616db877STejun Heo 	 * CPU intensive auto-detection cares about how long a work item hogged
1410616db877STejun Heo 	 * CPU without sleeping. Reset the starting timestamp on wakeup.
1411616db877STejun Heo 	 */
1412616db877STejun Heo 	worker->current_at = worker->task->se.sum_exec_runtime;
1413616db877STejun Heo 
1414c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 0);
14151da177e4SLinus Torvalds }
14161da177e4SLinus Torvalds 
14171da177e4SLinus Torvalds /**
14181da177e4SLinus Torvalds  * wq_worker_sleeping - a worker is going to sleep
14191da177e4SLinus Torvalds  * @task: task going to sleep
14201da177e4SLinus Torvalds  *
14211da177e4SLinus Torvalds  * This function is called from schedule() when a busy worker is
14221da177e4SLinus Torvalds  * going to sleep.
14231da177e4SLinus Torvalds  */
14241da177e4SLinus Torvalds void wq_worker_sleeping(struct task_struct *task)
14251da177e4SLinus Torvalds {
14261da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
14271da177e4SLinus Torvalds 	struct worker_pool *pool;
14281da177e4SLinus Torvalds 
14291da177e4SLinus Torvalds 	/*
14301da177e4SLinus Torvalds 	 * Rescuers, which may not have all the fields set up like normal
14311da177e4SLinus Torvalds 	 * workers, also reach here, let's not access anything before
14321da177e4SLinus Torvalds 	 * checking NOT_RUNNING.
14331da177e4SLinus Torvalds 	 */
14341da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING)
14351da177e4SLinus Torvalds 		return;
14361da177e4SLinus Torvalds 
14371da177e4SLinus Torvalds 	pool = worker->pool;
14381da177e4SLinus Torvalds 
14391da177e4SLinus Torvalds 	/* Return if preempted before wq_worker_running() was reached */
1440c8f6219bSZqiang 	if (READ_ONCE(worker->sleeping))
14411da177e4SLinus Torvalds 		return;
14421da177e4SLinus Torvalds 
1443c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 1);
14441da177e4SLinus Torvalds 	raw_spin_lock_irq(&pool->lock);
14451da177e4SLinus Torvalds 
14461da177e4SLinus Torvalds 	/*
14471da177e4SLinus Torvalds 	 * Recheck in case unbind_workers() preempted us. We don't
14481da177e4SLinus Torvalds 	 * want to decrement nr_running after the worker is unbound
14491da177e4SLinus Torvalds 	 * and nr_running has been reset.
14501da177e4SLinus Torvalds 	 */
14511da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING) {
14521da177e4SLinus Torvalds 		raw_spin_unlock_irq(&pool->lock);
14531da177e4SLinus Torvalds 		return;
14541da177e4SLinus Torvalds 	}
14551da177e4SLinus Torvalds 
14561da177e4SLinus Torvalds 	pool->nr_running--;
14570219a352STejun Heo 	if (kick_pool(pool))
1458725e8ec5STejun Heo 		worker->current_pwq->stats[PWQ_STAT_CM_WAKEUP]++;
14590219a352STejun Heo 
14601da177e4SLinus Torvalds 	raw_spin_unlock_irq(&pool->lock);
14611da177e4SLinus Torvalds }
14621da177e4SLinus Torvalds 
14631da177e4SLinus Torvalds /**
1464616db877STejun Heo  * wq_worker_tick - a scheduler tick occurred while a kworker is running
1465616db877STejun Heo  * @task: task currently running
1466616db877STejun Heo  *
1467616db877STejun Heo  * Called from scheduler_tick(). We're in the IRQ context and the current
1468616db877STejun Heo  * worker's fields which follow the 'K' locking rule can be accessed safely.
1469616db877STejun Heo  */
1470616db877STejun Heo void wq_worker_tick(struct task_struct *task)
1471616db877STejun Heo {
1472616db877STejun Heo 	struct worker *worker = kthread_data(task);
1473616db877STejun Heo 	struct pool_workqueue *pwq = worker->current_pwq;
1474616db877STejun Heo 	struct worker_pool *pool = worker->pool;
1475616db877STejun Heo 
1476616db877STejun Heo 	if (!pwq)
1477616db877STejun Heo 		return;
1478616db877STejun Heo 
14798a1dd1e5STejun Heo 	pwq->stats[PWQ_STAT_CPU_TIME] += TICK_USEC;
14808a1dd1e5STejun Heo 
148118c8ae81SZqiang 	if (!wq_cpu_intensive_thresh_us)
148218c8ae81SZqiang 		return;
148318c8ae81SZqiang 
1484616db877STejun Heo 	/*
1485616db877STejun Heo 	 * If the current worker is concurrency managed and hogged the CPU for
1486616db877STejun Heo 	 * longer than wq_cpu_intensive_thresh_us, it's automatically marked
1487616db877STejun Heo 	 * CPU_INTENSIVE to avoid stalling other concurrency-managed work items.
1488c8f6219bSZqiang 	 *
1489c8f6219bSZqiang 	 * Set @worker->sleeping means that @worker is in the process of
1490c8f6219bSZqiang 	 * switching out voluntarily and won't be contributing to
1491c8f6219bSZqiang 	 * @pool->nr_running until it wakes up. As wq_worker_sleeping() also
1492c8f6219bSZqiang 	 * decrements ->nr_running, setting CPU_INTENSIVE here can lead to
1493c8f6219bSZqiang 	 * double decrements. The task is releasing the CPU anyway. Let's skip.
1494c8f6219bSZqiang 	 * We probably want to make this prettier in the future.
1495616db877STejun Heo 	 */
1496c8f6219bSZqiang 	if ((worker->flags & WORKER_NOT_RUNNING) || READ_ONCE(worker->sleeping) ||
1497616db877STejun Heo 	    worker->task->se.sum_exec_runtime - worker->current_at <
1498616db877STejun Heo 	    wq_cpu_intensive_thresh_us * NSEC_PER_USEC)
1499616db877STejun Heo 		return;
1500616db877STejun Heo 
1501616db877STejun Heo 	raw_spin_lock(&pool->lock);
1502616db877STejun Heo 
1503616db877STejun Heo 	worker_set_flags(worker, WORKER_CPU_INTENSIVE);
150463638450STejun Heo 	wq_cpu_intensive_report(worker->current_func);
1505616db877STejun Heo 	pwq->stats[PWQ_STAT_CPU_INTENSIVE]++;
1506616db877STejun Heo 
15070219a352STejun Heo 	if (kick_pool(pool))
1508616db877STejun Heo 		pwq->stats[PWQ_STAT_CM_WAKEUP]++;
1509616db877STejun Heo 
1510616db877STejun Heo 	raw_spin_unlock(&pool->lock);
1511616db877STejun Heo }
1512616db877STejun Heo 
1513616db877STejun Heo /**
15141da177e4SLinus Torvalds  * wq_worker_last_func - retrieve worker's last work function
15151da177e4SLinus Torvalds  * @task: Task to retrieve last work function of.
15161da177e4SLinus Torvalds  *
15171da177e4SLinus Torvalds  * Determine the last function a worker executed. This is called from
15181da177e4SLinus Torvalds  * the scheduler to get a worker's last known identity.
15191da177e4SLinus Torvalds  *
15209b41ea72SAndrew Morton  * CONTEXT:
15211da177e4SLinus Torvalds  * raw_spin_lock_irq(rq->lock)
15221da177e4SLinus Torvalds  *
1523f756d5e2SNathan Lynch  * This function is called during schedule() when a kworker is going
1524f756d5e2SNathan Lynch  * to sleep. It's used by psi to identify aggregation workers during
15251da177e4SLinus Torvalds  * dequeuing, to allow periodic aggregation to shut-off when that
15261da177e4SLinus Torvalds  * worker is the last task in the system or cgroup to go to sleep.
15271da177e4SLinus Torvalds  *
15281da177e4SLinus Torvalds  * As this function doesn't involve any workqueue-related locking, it
15291da177e4SLinus Torvalds  * only returns stable values when called from inside the scheduler's
15301da177e4SLinus Torvalds  * queuing and dequeuing paths, when @task, which must be a kworker,
1531365970a1SDavid Howells  * is guaranteed to not be processing any works.
1532365970a1SDavid Howells  *
1533365970a1SDavid Howells  * Return:
1534365970a1SDavid Howells  * The last work function %current executed as a worker, NULL if it
1535365970a1SDavid Howells  * hasn't executed any work yet.
1536365970a1SDavid Howells  */
1537365970a1SDavid Howells work_func_t wq_worker_last_func(struct task_struct *task)
1538365970a1SDavid Howells {
1539365970a1SDavid Howells 	struct worker *worker = kthread_data(task);
1540365970a1SDavid Howells 
1541365970a1SDavid Howells 	return worker->last_func;
1542365970a1SDavid Howells }
1543365970a1SDavid Howells 
1544d302f017STejun Heo /**
154591ccc6e7STejun Heo  * wq_node_nr_active - Determine wq_node_nr_active to use
154691ccc6e7STejun Heo  * @wq: workqueue of interest
154791ccc6e7STejun Heo  * @node: NUMA node, can be %NUMA_NO_NODE
154891ccc6e7STejun Heo  *
154991ccc6e7STejun Heo  * Determine wq_node_nr_active to use for @wq on @node. Returns:
155091ccc6e7STejun Heo  *
155191ccc6e7STejun Heo  * - %NULL for per-cpu workqueues as they don't need to use shared nr_active.
155291ccc6e7STejun Heo  *
155391ccc6e7STejun Heo  * - node_nr_active[nr_node_ids] if @node is %NUMA_NO_NODE.
155491ccc6e7STejun Heo  *
155591ccc6e7STejun Heo  * - Otherwise, node_nr_active[@node].
155691ccc6e7STejun Heo  */
155791ccc6e7STejun Heo static struct wq_node_nr_active *wq_node_nr_active(struct workqueue_struct *wq,
155891ccc6e7STejun Heo 						   int node)
155991ccc6e7STejun Heo {
156091ccc6e7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
156191ccc6e7STejun Heo 		return NULL;
156291ccc6e7STejun Heo 
156391ccc6e7STejun Heo 	if (node == NUMA_NO_NODE)
156491ccc6e7STejun Heo 		node = nr_node_ids;
156591ccc6e7STejun Heo 
156691ccc6e7STejun Heo 	return wq->node_nr_active[node];
156791ccc6e7STejun Heo }
156891ccc6e7STejun Heo 
156991ccc6e7STejun Heo /**
15705797b1c1STejun Heo  * wq_update_node_max_active - Update per-node max_actives to use
15715797b1c1STejun Heo  * @wq: workqueue to update
15725797b1c1STejun Heo  * @off_cpu: CPU that's going down, -1 if a CPU is not going down
15735797b1c1STejun Heo  *
15745797b1c1STejun Heo  * Update @wq->node_nr_active[]->max. @wq must be unbound. max_active is
15755797b1c1STejun Heo  * distributed among nodes according to the proportions of numbers of online
15765797b1c1STejun Heo  * cpus. The result is always between @wq->min_active and max_active.
15775797b1c1STejun Heo  */
15785797b1c1STejun Heo static void wq_update_node_max_active(struct workqueue_struct *wq, int off_cpu)
15795797b1c1STejun Heo {
15805797b1c1STejun Heo 	struct cpumask *effective = unbound_effective_cpumask(wq);
15815797b1c1STejun Heo 	int min_active = READ_ONCE(wq->min_active);
15825797b1c1STejun Heo 	int max_active = READ_ONCE(wq->max_active);
15835797b1c1STejun Heo 	int total_cpus, node;
15845797b1c1STejun Heo 
15855797b1c1STejun Heo 	lockdep_assert_held(&wq->mutex);
15865797b1c1STejun Heo 
1587c5f8cd6cSTejun Heo 	if (!wq_topo_initialized)
1588c5f8cd6cSTejun Heo 		return;
1589c5f8cd6cSTejun Heo 
159015930da4STejun Heo 	if (off_cpu >= 0 && !cpumask_test_cpu(off_cpu, effective))
15915797b1c1STejun Heo 		off_cpu = -1;
15925797b1c1STejun Heo 
15935797b1c1STejun Heo 	total_cpus = cpumask_weight_and(effective, cpu_online_mask);
15945797b1c1STejun Heo 	if (off_cpu >= 0)
15955797b1c1STejun Heo 		total_cpus--;
15965797b1c1STejun Heo 
15975797b1c1STejun Heo 	for_each_node(node) {
15985797b1c1STejun Heo 		int node_cpus;
15995797b1c1STejun Heo 
16005797b1c1STejun Heo 		node_cpus = cpumask_weight_and(effective, cpumask_of_node(node));
16015797b1c1STejun Heo 		if (off_cpu >= 0 && cpu_to_node(off_cpu) == node)
16025797b1c1STejun Heo 			node_cpus--;
16035797b1c1STejun Heo 
16045797b1c1STejun Heo 		wq_node_nr_active(wq, node)->max =
16055797b1c1STejun Heo 			clamp(DIV_ROUND_UP(max_active * node_cpus, total_cpus),
16065797b1c1STejun Heo 			      min_active, max_active);
16075797b1c1STejun Heo 	}
16085797b1c1STejun Heo 
16095797b1c1STejun Heo 	wq_node_nr_active(wq, NUMA_NO_NODE)->max = min_active;
16105797b1c1STejun Heo }
16115797b1c1STejun Heo 
16125797b1c1STejun Heo /**
16138864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
16148864b4e5STejun Heo  * @pwq: pool_workqueue to get
16158864b4e5STejun Heo  *
16168864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
16178864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
16188864b4e5STejun Heo  */
16198864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
16208864b4e5STejun Heo {
16218864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
16228864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
16238864b4e5STejun Heo 	pwq->refcnt++;
16248864b4e5STejun Heo }
16258864b4e5STejun Heo 
16268864b4e5STejun Heo /**
16278864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
16288864b4e5STejun Heo  * @pwq: pool_workqueue to put
16298864b4e5STejun Heo  *
16308864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
16318864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
16328864b4e5STejun Heo  */
16338864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
16348864b4e5STejun Heo {
16358864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
16368864b4e5STejun Heo 	if (likely(--pwq->refcnt))
16378864b4e5STejun Heo 		return;
16388864b4e5STejun Heo 	/*
1639967b494eSTejun Heo 	 * @pwq can't be released under pool->lock, bounce to a dedicated
1640967b494eSTejun Heo 	 * kthread_worker to avoid A-A deadlocks.
16418864b4e5STejun Heo 	 */
1642687a9aa5STejun Heo 	kthread_queue_work(pwq_release_worker, &pwq->release_work);
16438864b4e5STejun Heo }
16448864b4e5STejun Heo 
1645dce90d47STejun Heo /**
1646dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1647dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1648dce90d47STejun Heo  *
1649dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1650dce90d47STejun Heo  */
1651dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1652dce90d47STejun Heo {
1653dce90d47STejun Heo 	if (pwq) {
1654dce90d47STejun Heo 		/*
165524acfb71SThomas Gleixner 		 * As both pwqs and pools are RCU protected, the
1656dce90d47STejun Heo 		 * following lock operations are safe.
1657dce90d47STejun Heo 		 */
1658a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
1659dce90d47STejun Heo 		put_pwq(pwq);
1660a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
1661dce90d47STejun Heo 	}
1662dce90d47STejun Heo }
1663dce90d47STejun Heo 
1664afa87ce8STejun Heo static bool pwq_is_empty(struct pool_workqueue *pwq)
1665afa87ce8STejun Heo {
1666afa87ce8STejun Heo 	return !pwq->nr_active && list_empty(&pwq->inactive_works);
1667afa87ce8STejun Heo }
1668afa87ce8STejun Heo 
16694c638030STejun Heo static void __pwq_activate_work(struct pool_workqueue *pwq,
16704c638030STejun Heo 				struct work_struct *work)
1671bf4ede01STejun Heo {
16721c270b79STejun Heo 	unsigned long *wdb = work_data_bits(work);
16731c270b79STejun Heo 
16741c270b79STejun Heo 	WARN_ON_ONCE(!(*wdb & WORK_STRUCT_INACTIVE));
1675bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
167682607adcSTejun Heo 	if (list_empty(&pwq->pool->worklist))
167782607adcSTejun Heo 		pwq->pool->watchdog_ts = jiffies;
1678112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
16791c270b79STejun Heo 	__clear_bit(WORK_STRUCT_INACTIVE_BIT, wdb);
16804c638030STejun Heo }
16814c638030STejun Heo 
16824c638030STejun Heo /**
16834c638030STejun Heo  * pwq_activate_work - Activate a work item if inactive
16844c638030STejun Heo  * @pwq: pool_workqueue @work belongs to
16854c638030STejun Heo  * @work: work item to activate
16864c638030STejun Heo  *
16874c638030STejun Heo  * Returns %true if activated. %false if already active.
16884c638030STejun Heo  */
16894c638030STejun Heo static bool pwq_activate_work(struct pool_workqueue *pwq,
16904c638030STejun Heo 			      struct work_struct *work)
16914c638030STejun Heo {
16924c638030STejun Heo 	struct worker_pool *pool = pwq->pool;
169391ccc6e7STejun Heo 	struct wq_node_nr_active *nna;
16944c638030STejun Heo 
16954c638030STejun Heo 	lockdep_assert_held(&pool->lock);
16964c638030STejun Heo 
16974c638030STejun Heo 	if (!(*work_data_bits(work) & WORK_STRUCT_INACTIVE))
16984c638030STejun Heo 		return false;
16994c638030STejun Heo 
170091ccc6e7STejun Heo 	nna = wq_node_nr_active(pwq->wq, pool->node);
170191ccc6e7STejun Heo 	if (nna)
170291ccc6e7STejun Heo 		atomic_inc(&nna->nr);
170391ccc6e7STejun Heo 
1704112202d9STejun Heo 	pwq->nr_active++;
17054c638030STejun Heo 	__pwq_activate_work(pwq, work);
17064c638030STejun Heo 	return true;
1707bf4ede01STejun Heo }
1708bf4ede01STejun Heo 
17095797b1c1STejun Heo static bool tryinc_node_nr_active(struct wq_node_nr_active *nna)
17105797b1c1STejun Heo {
17115797b1c1STejun Heo 	int max = READ_ONCE(nna->max);
17125797b1c1STejun Heo 
17135797b1c1STejun Heo 	while (true) {
17145797b1c1STejun Heo 		int old, tmp;
17155797b1c1STejun Heo 
17165797b1c1STejun Heo 		old = atomic_read(&nna->nr);
17175797b1c1STejun Heo 		if (old >= max)
17185797b1c1STejun Heo 			return false;
17195797b1c1STejun Heo 		tmp = atomic_cmpxchg_relaxed(&nna->nr, old, old + 1);
17205797b1c1STejun Heo 		if (tmp == old)
17215797b1c1STejun Heo 			return true;
17225797b1c1STejun Heo 	}
17235797b1c1STejun Heo }
17245797b1c1STejun Heo 
17251c270b79STejun Heo /**
17261c270b79STejun Heo  * pwq_tryinc_nr_active - Try to increment nr_active for a pwq
17271c270b79STejun Heo  * @pwq: pool_workqueue of interest
17285797b1c1STejun Heo  * @fill: max_active may have increased, try to increase concurrency level
17291c270b79STejun Heo  *
17301c270b79STejun Heo  * Try to increment nr_active for @pwq. Returns %true if an nr_active count is
17311c270b79STejun Heo  * successfully obtained. %false otherwise.
17321c270b79STejun Heo  */
17335797b1c1STejun Heo static bool pwq_tryinc_nr_active(struct pool_workqueue *pwq, bool fill)
17343aa62497SLai Jiangshan {
17351c270b79STejun Heo 	struct workqueue_struct *wq = pwq->wq;
17361c270b79STejun Heo 	struct worker_pool *pool = pwq->pool;
173791ccc6e7STejun Heo 	struct wq_node_nr_active *nna = wq_node_nr_active(wq, pool->node);
17385797b1c1STejun Heo 	bool obtained = false;
17391c270b79STejun Heo 
17401c270b79STejun Heo 	lockdep_assert_held(&pool->lock);
17411c270b79STejun Heo 
17425797b1c1STejun Heo 	if (!nna) {
17434cb1ef64STejun Heo 		/* BH or per-cpu workqueue, pwq->nr_active is sufficient */
17441c270b79STejun Heo 		obtained = pwq->nr_active < READ_ONCE(wq->max_active);
17455797b1c1STejun Heo 		goto out;
174691ccc6e7STejun Heo 	}
17475797b1c1STejun Heo 
17484c065dbcSWaiman Long 	if (unlikely(pwq->plugged))
17494c065dbcSWaiman Long 		return false;
17504c065dbcSWaiman Long 
17515797b1c1STejun Heo 	/*
17525797b1c1STejun Heo 	 * Unbound workqueue uses per-node shared nr_active $nna. If @pwq is
17535797b1c1STejun Heo 	 * already waiting on $nna, pwq_dec_nr_active() will maintain the
17545797b1c1STejun Heo 	 * concurrency level. Don't jump the line.
17555797b1c1STejun Heo 	 *
17565797b1c1STejun Heo 	 * We need to ignore the pending test after max_active has increased as
17575797b1c1STejun Heo 	 * pwq_dec_nr_active() can only maintain the concurrency level but not
17585797b1c1STejun Heo 	 * increase it. This is indicated by @fill.
17595797b1c1STejun Heo 	 */
17605797b1c1STejun Heo 	if (!list_empty(&pwq->pending_node) && likely(!fill))
17615797b1c1STejun Heo 		goto out;
17625797b1c1STejun Heo 
17635797b1c1STejun Heo 	obtained = tryinc_node_nr_active(nna);
17645797b1c1STejun Heo 	if (obtained)
17655797b1c1STejun Heo 		goto out;
17665797b1c1STejun Heo 
17675797b1c1STejun Heo 	/*
17685797b1c1STejun Heo 	 * Lockless acquisition failed. Lock, add ourself to $nna->pending_pwqs
17695797b1c1STejun Heo 	 * and try again. The smp_mb() is paired with the implied memory barrier
17705797b1c1STejun Heo 	 * of atomic_dec_return() in pwq_dec_nr_active() to ensure that either
17715797b1c1STejun Heo 	 * we see the decremented $nna->nr or they see non-empty
17725797b1c1STejun Heo 	 * $nna->pending_pwqs.
17735797b1c1STejun Heo 	 */
17745797b1c1STejun Heo 	raw_spin_lock(&nna->lock);
17755797b1c1STejun Heo 
17765797b1c1STejun Heo 	if (list_empty(&pwq->pending_node))
17775797b1c1STejun Heo 		list_add_tail(&pwq->pending_node, &nna->pending_pwqs);
17785797b1c1STejun Heo 	else if (likely(!fill))
17795797b1c1STejun Heo 		goto out_unlock;
17805797b1c1STejun Heo 
17815797b1c1STejun Heo 	smp_mb();
17825797b1c1STejun Heo 
17835797b1c1STejun Heo 	obtained = tryinc_node_nr_active(nna);
17845797b1c1STejun Heo 
17855797b1c1STejun Heo 	/*
17865797b1c1STejun Heo 	 * If @fill, @pwq might have already been pending. Being spuriously
17875797b1c1STejun Heo 	 * pending in cold paths doesn't affect anything. Let's leave it be.
17885797b1c1STejun Heo 	 */
17895797b1c1STejun Heo 	if (obtained && likely(!fill))
17905797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
17915797b1c1STejun Heo 
17925797b1c1STejun Heo out_unlock:
17935797b1c1STejun Heo 	raw_spin_unlock(&nna->lock);
17945797b1c1STejun Heo out:
17955797b1c1STejun Heo 	if (obtained)
17965797b1c1STejun Heo 		pwq->nr_active++;
17971c270b79STejun Heo 	return obtained;
17981c270b79STejun Heo }
17991c270b79STejun Heo 
18001c270b79STejun Heo /**
18011c270b79STejun Heo  * pwq_activate_first_inactive - Activate the first inactive work item on a pwq
18021c270b79STejun Heo  * @pwq: pool_workqueue of interest
18035797b1c1STejun Heo  * @fill: max_active may have increased, try to increase concurrency level
18041c270b79STejun Heo  *
18051c270b79STejun Heo  * Activate the first inactive work item of @pwq if available and allowed by
18061c270b79STejun Heo  * max_active limit.
18071c270b79STejun Heo  *
18081c270b79STejun Heo  * Returns %true if an inactive work item has been activated. %false if no
18091c270b79STejun Heo  * inactive work item is found or max_active limit is reached.
18101c270b79STejun Heo  */
18115797b1c1STejun Heo static bool pwq_activate_first_inactive(struct pool_workqueue *pwq, bool fill)
18121c270b79STejun Heo {
18131c270b79STejun Heo 	struct work_struct *work =
18141c270b79STejun Heo 		list_first_entry_or_null(&pwq->inactive_works,
18153aa62497SLai Jiangshan 					 struct work_struct, entry);
18163aa62497SLai Jiangshan 
18175797b1c1STejun Heo 	if (work && pwq_tryinc_nr_active(pwq, fill)) {
18181c270b79STejun Heo 		__pwq_activate_work(pwq, work);
18191c270b79STejun Heo 		return true;
18201c270b79STejun Heo 	} else {
18211c270b79STejun Heo 		return false;
18221c270b79STejun Heo 	}
18231c270b79STejun Heo }
18241c270b79STejun Heo 
18251c270b79STejun Heo /**
1826516d3dc9SWaiman Long  * unplug_oldest_pwq - unplug the oldest pool_workqueue
1827516d3dc9SWaiman Long  * @wq: workqueue_struct where its oldest pwq is to be unplugged
18284c065dbcSWaiman Long  *
1829516d3dc9SWaiman Long  * This function should only be called for ordered workqueues where only the
1830516d3dc9SWaiman Long  * oldest pwq is unplugged, the others are plugged to suspend execution to
1831516d3dc9SWaiman Long  * ensure proper work item ordering::
18324c065dbcSWaiman Long  *
18334c065dbcSWaiman Long  *    dfl_pwq --------------+     [P] - plugged
18344c065dbcSWaiman Long  *                          |
18354c065dbcSWaiman Long  *                          v
18364c065dbcSWaiman Long  *    pwqs -> A -> B [P] -> C [P] (newest)
18374c065dbcSWaiman Long  *            |    |        |
18384c065dbcSWaiman Long  *            1    3        5
18394c065dbcSWaiman Long  *            |    |        |
18404c065dbcSWaiman Long  *            2    4        6
1841516d3dc9SWaiman Long  *
1842516d3dc9SWaiman Long  * When the oldest pwq is drained and removed, this function should be called
1843516d3dc9SWaiman Long  * to unplug the next oldest one to start its work item execution. Note that
1844516d3dc9SWaiman Long  * pwq's are linked into wq->pwqs with the oldest first, so the first one in
1845516d3dc9SWaiman Long  * the list is the oldest.
18464c065dbcSWaiman Long  */
18474c065dbcSWaiman Long static void unplug_oldest_pwq(struct workqueue_struct *wq)
18484c065dbcSWaiman Long {
18494c065dbcSWaiman Long 	struct pool_workqueue *pwq;
18504c065dbcSWaiman Long 
18514c065dbcSWaiman Long 	lockdep_assert_held(&wq->mutex);
18524c065dbcSWaiman Long 
18534c065dbcSWaiman Long 	/* Caller should make sure that pwqs isn't empty before calling */
18544c065dbcSWaiman Long 	pwq = list_first_entry_or_null(&wq->pwqs, struct pool_workqueue,
18554c065dbcSWaiman Long 				       pwqs_node);
18564c065dbcSWaiman Long 	raw_spin_lock_irq(&pwq->pool->lock);
18574c065dbcSWaiman Long 	if (pwq->plugged) {
18584c065dbcSWaiman Long 		pwq->plugged = false;
18594c065dbcSWaiman Long 		if (pwq_activate_first_inactive(pwq, true))
18604c065dbcSWaiman Long 			kick_pool(pwq->pool);
18614c065dbcSWaiman Long 	}
18624c065dbcSWaiman Long 	raw_spin_unlock_irq(&pwq->pool->lock);
18634c065dbcSWaiman Long }
18644c065dbcSWaiman Long 
18654c065dbcSWaiman Long /**
18665797b1c1STejun Heo  * node_activate_pending_pwq - Activate a pending pwq on a wq_node_nr_active
18675797b1c1STejun Heo  * @nna: wq_node_nr_active to activate a pending pwq for
18685797b1c1STejun Heo  * @caller_pool: worker_pool the caller is locking
18695797b1c1STejun Heo  *
18705797b1c1STejun Heo  * Activate a pwq in @nna->pending_pwqs. Called with @caller_pool locked.
18715797b1c1STejun Heo  * @caller_pool may be unlocked and relocked to lock other worker_pools.
18725797b1c1STejun Heo  */
18735797b1c1STejun Heo static void node_activate_pending_pwq(struct wq_node_nr_active *nna,
18745797b1c1STejun Heo 				      struct worker_pool *caller_pool)
18755797b1c1STejun Heo {
18765797b1c1STejun Heo 	struct worker_pool *locked_pool = caller_pool;
18775797b1c1STejun Heo 	struct pool_workqueue *pwq;
18785797b1c1STejun Heo 	struct work_struct *work;
18795797b1c1STejun Heo 
18805797b1c1STejun Heo 	lockdep_assert_held(&caller_pool->lock);
18815797b1c1STejun Heo 
18825797b1c1STejun Heo 	raw_spin_lock(&nna->lock);
18835797b1c1STejun Heo retry:
18845797b1c1STejun Heo 	pwq = list_first_entry_or_null(&nna->pending_pwqs,
18855797b1c1STejun Heo 				       struct pool_workqueue, pending_node);
18865797b1c1STejun Heo 	if (!pwq)
18875797b1c1STejun Heo 		goto out_unlock;
18885797b1c1STejun Heo 
18895797b1c1STejun Heo 	/*
18905797b1c1STejun Heo 	 * If @pwq is for a different pool than @locked_pool, we need to lock
18915797b1c1STejun Heo 	 * @pwq->pool->lock. Let's trylock first. If unsuccessful, do the unlock
18925797b1c1STejun Heo 	 * / lock dance. For that, we also need to release @nna->lock as it's
18935797b1c1STejun Heo 	 * nested inside pool locks.
18945797b1c1STejun Heo 	 */
18955797b1c1STejun Heo 	if (pwq->pool != locked_pool) {
18965797b1c1STejun Heo 		raw_spin_unlock(&locked_pool->lock);
18975797b1c1STejun Heo 		locked_pool = pwq->pool;
18985797b1c1STejun Heo 		if (!raw_spin_trylock(&locked_pool->lock)) {
18995797b1c1STejun Heo 			raw_spin_unlock(&nna->lock);
19005797b1c1STejun Heo 			raw_spin_lock(&locked_pool->lock);
19015797b1c1STejun Heo 			raw_spin_lock(&nna->lock);
19025797b1c1STejun Heo 			goto retry;
19035797b1c1STejun Heo 		}
19045797b1c1STejun Heo 	}
19055797b1c1STejun Heo 
19065797b1c1STejun Heo 	/*
19075797b1c1STejun Heo 	 * $pwq may not have any inactive work items due to e.g. cancellations.
19085797b1c1STejun Heo 	 * Drop it from pending_pwqs and see if there's another one.
19095797b1c1STejun Heo 	 */
19105797b1c1STejun Heo 	work = list_first_entry_or_null(&pwq->inactive_works,
19115797b1c1STejun Heo 					struct work_struct, entry);
19125797b1c1STejun Heo 	if (!work) {
19135797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
19145797b1c1STejun Heo 		goto retry;
19155797b1c1STejun Heo 	}
19165797b1c1STejun Heo 
19175797b1c1STejun Heo 	/*
19185797b1c1STejun Heo 	 * Acquire an nr_active count and activate the inactive work item. If
19195797b1c1STejun Heo 	 * $pwq still has inactive work items, rotate it to the end of the
19205797b1c1STejun Heo 	 * pending_pwqs so that we round-robin through them. This means that
19215797b1c1STejun Heo 	 * inactive work items are not activated in queueing order which is fine
19225797b1c1STejun Heo 	 * given that there has never been any ordering across different pwqs.
19235797b1c1STejun Heo 	 */
19245797b1c1STejun Heo 	if (likely(tryinc_node_nr_active(nna))) {
19255797b1c1STejun Heo 		pwq->nr_active++;
19265797b1c1STejun Heo 		__pwq_activate_work(pwq, work);
19275797b1c1STejun Heo 
19285797b1c1STejun Heo 		if (list_empty(&pwq->inactive_works))
19295797b1c1STejun Heo 			list_del_init(&pwq->pending_node);
19305797b1c1STejun Heo 		else
19315797b1c1STejun Heo 			list_move_tail(&pwq->pending_node, &nna->pending_pwqs);
19325797b1c1STejun Heo 
19335797b1c1STejun Heo 		/* if activating a foreign pool, make sure it's running */
19345797b1c1STejun Heo 		if (pwq->pool != caller_pool)
19355797b1c1STejun Heo 			kick_pool(pwq->pool);
19365797b1c1STejun Heo 	}
19375797b1c1STejun Heo 
19385797b1c1STejun Heo out_unlock:
19395797b1c1STejun Heo 	raw_spin_unlock(&nna->lock);
19405797b1c1STejun Heo 	if (locked_pool != caller_pool) {
19415797b1c1STejun Heo 		raw_spin_unlock(&locked_pool->lock);
19425797b1c1STejun Heo 		raw_spin_lock(&caller_pool->lock);
19435797b1c1STejun Heo 	}
19445797b1c1STejun Heo }
19455797b1c1STejun Heo 
19465797b1c1STejun Heo /**
19471c270b79STejun Heo  * pwq_dec_nr_active - Retire an active count
19481c270b79STejun Heo  * @pwq: pool_workqueue of interest
19491c270b79STejun Heo  *
19501c270b79STejun Heo  * Decrement @pwq's nr_active and try to activate the first inactive work item.
19515797b1c1STejun Heo  * For unbound workqueues, this function may temporarily drop @pwq->pool->lock.
19521c270b79STejun Heo  */
19531c270b79STejun Heo static void pwq_dec_nr_active(struct pool_workqueue *pwq)
19541c270b79STejun Heo {
19551c270b79STejun Heo 	struct worker_pool *pool = pwq->pool;
195691ccc6e7STejun Heo 	struct wq_node_nr_active *nna = wq_node_nr_active(pwq->wq, pool->node);
19571c270b79STejun Heo 
19581c270b79STejun Heo 	lockdep_assert_held(&pool->lock);
19591c270b79STejun Heo 
196091ccc6e7STejun Heo 	/*
196191ccc6e7STejun Heo 	 * @pwq->nr_active should be decremented for both percpu and unbound
196291ccc6e7STejun Heo 	 * workqueues.
196391ccc6e7STejun Heo 	 */
19641c270b79STejun Heo 	pwq->nr_active--;
196591ccc6e7STejun Heo 
196691ccc6e7STejun Heo 	/*
196791ccc6e7STejun Heo 	 * For a percpu workqueue, it's simple. Just need to kick the first
196891ccc6e7STejun Heo 	 * inactive work item on @pwq itself.
196991ccc6e7STejun Heo 	 */
197091ccc6e7STejun Heo 	if (!nna) {
19715797b1c1STejun Heo 		pwq_activate_first_inactive(pwq, false);
197291ccc6e7STejun Heo 		return;
197391ccc6e7STejun Heo 	}
197491ccc6e7STejun Heo 
19755797b1c1STejun Heo 	/*
19765797b1c1STejun Heo 	 * If @pwq is for an unbound workqueue, it's more complicated because
19775797b1c1STejun Heo 	 * multiple pwqs and pools may be sharing the nr_active count. When a
19785797b1c1STejun Heo 	 * pwq needs to wait for an nr_active count, it puts itself on
19795797b1c1STejun Heo 	 * $nna->pending_pwqs. The following atomic_dec_return()'s implied
19805797b1c1STejun Heo 	 * memory barrier is paired with smp_mb() in pwq_tryinc_nr_active() to
19815797b1c1STejun Heo 	 * guarantee that either we see non-empty pending_pwqs or they see
19825797b1c1STejun Heo 	 * decremented $nna->nr.
19835797b1c1STejun Heo 	 *
19845797b1c1STejun Heo 	 * $nna->max may change as CPUs come online/offline and @pwq->wq's
19855797b1c1STejun Heo 	 * max_active gets updated. However, it is guaranteed to be equal to or
19865797b1c1STejun Heo 	 * larger than @pwq->wq->min_active which is above zero unless freezing.
19875797b1c1STejun Heo 	 * This maintains the forward progress guarantee.
19885797b1c1STejun Heo 	 */
19895797b1c1STejun Heo 	if (atomic_dec_return(&nna->nr) >= READ_ONCE(nna->max))
19905797b1c1STejun Heo 		return;
19915797b1c1STejun Heo 
19925797b1c1STejun Heo 	if (!list_empty(&nna->pending_pwqs))
19935797b1c1STejun Heo 		node_activate_pending_pwq(nna, pool);
19943aa62497SLai Jiangshan }
19953aa62497SLai Jiangshan 
1996bf4ede01STejun Heo /**
1997112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1998112202d9STejun Heo  * @pwq: pwq of interest
1999c4560c2cSLai Jiangshan  * @work_data: work_data of work which left the queue
2000bf4ede01STejun Heo  *
2001bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
2002112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
2003bf4ede01STejun Heo  *
2004dd6c3c54STejun Heo  * NOTE:
2005dd6c3c54STejun Heo  * For unbound workqueues, this function may temporarily drop @pwq->pool->lock
2006dd6c3c54STejun Heo  * and thus should be called after all other state updates for the in-flight
2007dd6c3c54STejun Heo  * work item is complete.
2008dd6c3c54STejun Heo  *
2009bf4ede01STejun Heo  * CONTEXT:
2010a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2011bf4ede01STejun Heo  */
2012c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data)
2013bf4ede01STejun Heo {
2014c4560c2cSLai Jiangshan 	int color = get_work_color(work_data);
2015c4560c2cSLai Jiangshan 
20161c270b79STejun Heo 	if (!(work_data & WORK_STRUCT_INACTIVE))
20171c270b79STejun Heo 		pwq_dec_nr_active(pwq);
2018018f3a13SLai Jiangshan 
2019018f3a13SLai Jiangshan 	pwq->nr_in_flight[color]--;
2020bf4ede01STejun Heo 
2021bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
2022112202d9STejun Heo 	if (likely(pwq->flush_color != color))
20238864b4e5STejun Heo 		goto out_put;
2024bf4ede01STejun Heo 
2025bf4ede01STejun Heo 	/* are there still in-flight works? */
2026112202d9STejun Heo 	if (pwq->nr_in_flight[color])
20278864b4e5STejun Heo 		goto out_put;
2028bf4ede01STejun Heo 
2029112202d9STejun Heo 	/* this pwq is done, clear flush_color */
2030112202d9STejun Heo 	pwq->flush_color = -1;
2031bf4ede01STejun Heo 
2032bf4ede01STejun Heo 	/*
2033112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
2034bf4ede01STejun Heo 	 * will handle the rest.
2035bf4ede01STejun Heo 	 */
2036112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
2037112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
20388864b4e5STejun Heo out_put:
20398864b4e5STejun Heo 	put_pwq(pwq);
2040bf4ede01STejun Heo }
2041bf4ede01STejun Heo 
204236e227d2STejun Heo /**
2043bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
204436e227d2STejun Heo  * @work: work item to steal
2045c5f5b942STejun Heo  * @cflags: %WORK_CANCEL_ flags
2046c26e2f2eSTejun Heo  * @irq_flags: place to store irq state
204736e227d2STejun Heo  *
204836e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
2049d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
205036e227d2STejun Heo  *
2051d185af30SYacine Belkadi  * Return:
20523eb6b31bSMauro Carvalho Chehab  *
20533eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
205436e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
205536e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
205636e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
2057bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
2058bbb68dfaSTejun Heo  *		for arbitrarily long
20593eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
206036e227d2STejun Heo  *
2061d185af30SYacine Belkadi  * Note:
2062bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
2063e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
2064e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
2065e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
2066bbb68dfaSTejun Heo  *
2067bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
2068c26e2f2eSTejun Heo  * responsible for releasing it using local_irq_restore(*@irq_flags).
2069bbb68dfaSTejun Heo  *
2070e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
2071bf4ede01STejun Heo  */
2072c5f5b942STejun Heo static int try_to_grab_pending(struct work_struct *work, u32 cflags,
2073c26e2f2eSTejun Heo 			       unsigned long *irq_flags)
2074bf4ede01STejun Heo {
2075d565ed63STejun Heo 	struct worker_pool *pool;
2076112202d9STejun Heo 	struct pool_workqueue *pwq;
2077bf4ede01STejun Heo 
2078c26e2f2eSTejun Heo 	local_irq_save(*irq_flags);
2079bbb68dfaSTejun Heo 
208036e227d2STejun Heo 	/* try to steal the timer if it exists */
2081c5f5b942STejun Heo 	if (cflags & WORK_CANCEL_DELAYED) {
208236e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
208336e227d2STejun Heo 
2084e0aecdd8STejun Heo 		/*
2085e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
2086e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
2087e0aecdd8STejun Heo 		 * running on the local CPU.
2088e0aecdd8STejun Heo 		 */
208936e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
209036e227d2STejun Heo 			return 1;
209136e227d2STejun Heo 	}
209236e227d2STejun Heo 
209336e227d2STejun Heo 	/* try to claim PENDING the normal way */
2094bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
2095bf4ede01STejun Heo 		return 0;
2096bf4ede01STejun Heo 
209724acfb71SThomas Gleixner 	rcu_read_lock();
2098bf4ede01STejun Heo 	/*
2099bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
2100bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2101bf4ede01STejun Heo 	 */
2102d565ed63STejun Heo 	pool = get_work_pool(work);
2103d565ed63STejun Heo 	if (!pool)
2104bbb68dfaSTejun Heo 		goto fail;
2105bf4ede01STejun Heo 
2106a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&pool->lock);
2107bf4ede01STejun Heo 	/*
2108112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
2109112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
2110112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
2111112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
2112112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
21130b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
2114bf4ede01STejun Heo 	 */
2115112202d9STejun Heo 	pwq = get_work_pwq(work);
2116112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
2117c70e1779STejun Heo 		unsigned long work_data;
2118c70e1779STejun Heo 
2119bf4ede01STejun Heo 		debug_work_deactivate(work);
21203aa62497SLai Jiangshan 
21213aa62497SLai Jiangshan 		/*
2122018f3a13SLai Jiangshan 		 * A cancelable inactive work item must be in the
2123018f3a13SLai Jiangshan 		 * pwq->inactive_works since a queued barrier can't be
2124018f3a13SLai Jiangshan 		 * canceled (see the comments in insert_wq_barrier()).
2125018f3a13SLai Jiangshan 		 *
2126f97a4a1aSLai Jiangshan 		 * An inactive work item cannot be grabbed directly because
2127d812796eSLai Jiangshan 		 * it might have linked barrier work items which, if left
2128f97a4a1aSLai Jiangshan 		 * on the inactive_works list, will confuse pwq->nr_active
212916062836STejun Heo 		 * management later on and cause stall.  Make sure the work
213016062836STejun Heo 		 * item is activated before grabbing.
21313aa62497SLai Jiangshan 		 */
21324c638030STejun Heo 		pwq_activate_work(pwq, work);
21333aa62497SLai Jiangshan 
2134bf4ede01STejun Heo 		list_del_init(&work->entry);
213536e227d2STejun Heo 
2136c70e1779STejun Heo 		/*
2137c70e1779STejun Heo 		 * work->data points to pwq iff queued. Let's point to pool. As
2138c70e1779STejun Heo 		 * this destroys work->data needed by the next step, stash it.
2139c70e1779STejun Heo 		 */
2140c70e1779STejun Heo 		work_data = *work_data_bits(work);
2141bccdc1faSTejun Heo 		set_work_pool_and_keep_pending(work, pool->id, 0);
21424468a00fSLai Jiangshan 
2143dd6c3c54STejun Heo 		/* must be the last step, see the function comment */
2144c70e1779STejun Heo 		pwq_dec_nr_in_flight(pwq, work_data);
2145dd6c3c54STejun Heo 
2146a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock(&pool->lock);
214724acfb71SThomas Gleixner 		rcu_read_unlock();
214836e227d2STejun Heo 		return 1;
2149bf4ede01STejun Heo 	}
2150a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&pool->lock);
2151bbb68dfaSTejun Heo fail:
215224acfb71SThomas Gleixner 	rcu_read_unlock();
2153c26e2f2eSTejun Heo 	local_irq_restore(*irq_flags);
2154bbb68dfaSTejun Heo 	if (work_is_canceling(work))
2155bbb68dfaSTejun Heo 		return -ENOENT;
2156bbb68dfaSTejun Heo 	cpu_relax();
215736e227d2STejun Heo 	return -EAGAIN;
2158bf4ede01STejun Heo }
2159bf4ede01STejun Heo 
2160978b8409STejun Heo struct cwt_wait {
2161978b8409STejun Heo 	wait_queue_entry_t	wait;
2162978b8409STejun Heo 	struct work_struct	*work;
2163978b8409STejun Heo };
2164978b8409STejun Heo 
2165978b8409STejun Heo static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
2166978b8409STejun Heo {
2167978b8409STejun Heo 	struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
2168978b8409STejun Heo 
2169978b8409STejun Heo 	if (cwait->work != key)
2170978b8409STejun Heo 		return 0;
2171978b8409STejun Heo 	return autoremove_wake_function(wait, mode, sync, key);
2172978b8409STejun Heo }
2173978b8409STejun Heo 
2174978b8409STejun Heo /**
2175978b8409STejun Heo  * work_grab_pending - steal work item from worklist and disable irq
2176978b8409STejun Heo  * @work: work item to steal
2177978b8409STejun Heo  * @cflags: %WORK_CANCEL_ flags
2178978b8409STejun Heo  * @irq_flags: place to store IRQ state
2179978b8409STejun Heo  *
2180978b8409STejun Heo  * Grab PENDING bit of @work. @work can be in any stable state - idle, on timer
2181978b8409STejun Heo  * or on worklist.
2182978b8409STejun Heo  *
2183978b8409STejun Heo  * Must be called in process context. IRQ is disabled on return with IRQ state
2184978b8409STejun Heo  * stored in *@irq_flags. The caller is responsible for re-enabling it using
2185978b8409STejun Heo  * local_irq_restore().
2186978b8409STejun Heo  *
2187978b8409STejun Heo  * Returns %true if @work was pending. %false if idle.
2188978b8409STejun Heo  */
2189978b8409STejun Heo static bool work_grab_pending(struct work_struct *work, u32 cflags,
2190978b8409STejun Heo 			      unsigned long *irq_flags)
2191978b8409STejun Heo {
2192978b8409STejun Heo 	struct cwt_wait cwait;
2193978b8409STejun Heo 	int ret;
2194978b8409STejun Heo 
2195978b8409STejun Heo 	might_sleep();
2196978b8409STejun Heo repeat:
2197978b8409STejun Heo 	ret = try_to_grab_pending(work, cflags, irq_flags);
2198978b8409STejun Heo 	if (likely(ret >= 0))
2199978b8409STejun Heo 		return ret;
2200978b8409STejun Heo 	if (ret != -ENOENT)
2201978b8409STejun Heo 		goto repeat;
2202978b8409STejun Heo 
2203978b8409STejun Heo 	/*
2204978b8409STejun Heo 	 * Someone is already canceling. Wait for it to finish. flush_work()
2205978b8409STejun Heo 	 * doesn't work for PREEMPT_NONE because we may get woken up between
2206978b8409STejun Heo 	 * @work's completion and the other canceling task resuming and clearing
2207978b8409STejun Heo 	 * CANCELING - flush_work() will return false immediately as @work is no
2208978b8409STejun Heo 	 * longer busy, try_to_grab_pending() will return -ENOENT as @work is
2209978b8409STejun Heo 	 * still being canceled and the other canceling task won't be able to
2210978b8409STejun Heo 	 * clear CANCELING as we're hogging the CPU.
2211978b8409STejun Heo 	 *
2212978b8409STejun Heo 	 * Let's wait for completion using a waitqueue. As this may lead to the
2213978b8409STejun Heo 	 * thundering herd problem, use a custom wake function which matches
2214978b8409STejun Heo 	 * @work along with exclusive wait and wakeup.
2215978b8409STejun Heo 	 */
2216978b8409STejun Heo 	init_wait(&cwait.wait);
2217978b8409STejun Heo 	cwait.wait.func = cwt_wakefn;
2218978b8409STejun Heo 	cwait.work = work;
2219978b8409STejun Heo 
2220978b8409STejun Heo 	prepare_to_wait_exclusive(&wq_cancel_waitq, &cwait.wait,
2221978b8409STejun Heo 				  TASK_UNINTERRUPTIBLE);
2222978b8409STejun Heo 	if (work_is_canceling(work))
2223978b8409STejun Heo 		schedule();
2224978b8409STejun Heo 	finish_wait(&wq_cancel_waitq, &cwait.wait);
2225978b8409STejun Heo 
2226978b8409STejun Heo 	goto repeat;
2227978b8409STejun Heo }
2228978b8409STejun Heo 
2229bf4ede01STejun Heo /**
2230706026c2STejun Heo  * insert_work - insert a work into a pool
2231112202d9STejun Heo  * @pwq: pwq @work belongs to
22324690c4abSTejun Heo  * @work: work to insert
22334690c4abSTejun Heo  * @head: insertion point
22344690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
22354690c4abSTejun Heo  *
2236112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
2237706026c2STejun Heo  * work_struct flags.
22384690c4abSTejun Heo  *
22394690c4abSTejun Heo  * CONTEXT:
2240a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2241365970a1SDavid Howells  */
2242112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
2243112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
2244b89deed3SOleg Nesterov {
2245fe089f87STejun Heo 	debug_work_activate(work);
2246e1d8aa9fSFrederic Weisbecker 
2247e89a85d6SWalter Wu 	/* record the work call stack in order to print it in KASAN reports */
2248f70da745SMarco Elver 	kasan_record_aux_stack_noalloc(work);
2249e89a85d6SWalter Wu 
22504690c4abSTejun Heo 	/* we own @work, set data and link */
2251112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
22521a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
22538864b4e5STejun Heo 	get_pwq(pwq);
2254b89deed3SOleg Nesterov }
2255b89deed3SOleg Nesterov 
2256c8efcc25STejun Heo /*
2257c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
22588d03ecfeSTejun Heo  * same workqueue.
2259c8efcc25STejun Heo  */
2260c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
2261c8efcc25STejun Heo {
2262c8efcc25STejun Heo 	struct worker *worker;
2263c8efcc25STejun Heo 
22648d03ecfeSTejun Heo 	worker = current_wq_worker();
2265c8efcc25STejun Heo 	/*
2266bf393fd4SBart Van Assche 	 * Return %true iff I'm a worker executing a work item on @wq.  If
22678d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
2268c8efcc25STejun Heo 	 */
2269112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
2270c8efcc25STejun Heo }
2271c8efcc25STejun Heo 
2272ef557180SMike Galbraith /*
2273ef557180SMike Galbraith  * When queueing an unbound work item to a wq, prefer local CPU if allowed
2274ef557180SMike Galbraith  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
2275ef557180SMike Galbraith  * avoid perturbing sensitive tasks.
2276ef557180SMike Galbraith  */
2277ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu)
2278ef557180SMike Galbraith {
2279ef557180SMike Galbraith 	int new_cpu;
2280ef557180SMike Galbraith 
2281f303fccbSTejun Heo 	if (likely(!wq_debug_force_rr_cpu)) {
2282ef557180SMike Galbraith 		if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
2283ef557180SMike Galbraith 			return cpu;
2284a8ec5880SAmmar Faizi 	} else {
2285a8ec5880SAmmar Faizi 		pr_warn_once("workqueue: round-robin CPU selection forced, expect performance impact\n");
2286f303fccbSTejun Heo 	}
2287f303fccbSTejun Heo 
2288ef557180SMike Galbraith 	new_cpu = __this_cpu_read(wq_rr_cpu_last);
2289ef557180SMike Galbraith 	new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
2290ef557180SMike Galbraith 	if (unlikely(new_cpu >= nr_cpu_ids)) {
2291ef557180SMike Galbraith 		new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
2292ef557180SMike Galbraith 		if (unlikely(new_cpu >= nr_cpu_ids))
2293ef557180SMike Galbraith 			return cpu;
2294ef557180SMike Galbraith 	}
2295ef557180SMike Galbraith 	__this_cpu_write(wq_rr_cpu_last, new_cpu);
2296ef557180SMike Galbraith 
2297ef557180SMike Galbraith 	return new_cpu;
2298ef557180SMike Galbraith }
2299ef557180SMike Galbraith 
2300d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
23011da177e4SLinus Torvalds 			 struct work_struct *work)
23021da177e4SLinus Torvalds {
2303112202d9STejun Heo 	struct pool_workqueue *pwq;
2304fe089f87STejun Heo 	struct worker_pool *last_pool, *pool;
23058a2e8e5dSTejun Heo 	unsigned int work_flags;
2306b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
23078930cabaSTejun Heo 
23088930cabaSTejun Heo 	/*
23098930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
23108930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
23118930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
23128930cabaSTejun Heo 	 * happen with IRQ disabled.
23138930cabaSTejun Heo 	 */
23148e8eb730SFrederic Weisbecker 	lockdep_assert_irqs_disabled();
23151da177e4SLinus Torvalds 
231633e3f0a3SRichard Clark 	/*
231733e3f0a3SRichard Clark 	 * For a draining wq, only works from the same workqueue are
231833e3f0a3SRichard Clark 	 * allowed. The __WQ_DESTROYING helps to spot the issue that
231933e3f0a3SRichard Clark 	 * queues a new work item to a wq after destroy_workqueue(wq).
232033e3f0a3SRichard Clark 	 */
232133e3f0a3SRichard Clark 	if (unlikely(wq->flags & (__WQ_DESTROYING | __WQ_DRAINING) &&
232233e3f0a3SRichard Clark 		     WARN_ON_ONCE(!is_chained_work(wq))))
2323e41e704bSTejun Heo 		return;
232424acfb71SThomas Gleixner 	rcu_read_lock();
23259e8cd2f5STejun Heo retry:
2326aa202f1fSHillf Danton 	/* pwq which will be used unless @work is executing elsewhere */
2327636b927eSTejun Heo 	if (req_cpu == WORK_CPU_UNBOUND) {
2328636b927eSTejun Heo 		if (wq->flags & WQ_UNBOUND)
2329ef557180SMike Galbraith 			cpu = wq_select_unbound_cpu(raw_smp_processor_id());
2330636b927eSTejun Heo 		else
2331aa202f1fSHillf Danton 			cpu = raw_smp_processor_id();
2332aa202f1fSHillf Danton 	}
2333f3421797STejun Heo 
2334636b927eSTejun Heo 	pwq = rcu_dereference(*per_cpu_ptr(wq->cpu_pwq, cpu));
2335fe089f87STejun Heo 	pool = pwq->pool;
2336fe089f87STejun Heo 
233718aa9effSTejun Heo 	/*
2338c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
2339c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
2340c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
234118aa9effSTejun Heo 	 */
2342c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
2343fe089f87STejun Heo 	if (last_pool && last_pool != pool) {
234418aa9effSTejun Heo 		struct worker *worker;
234518aa9effSTejun Heo 
2346a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock(&last_pool->lock);
234718aa9effSTejun Heo 
2348c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
234918aa9effSTejun Heo 
2350112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
2351c9178087STejun Heo 			pwq = worker->current_pwq;
2352fe089f87STejun Heo 			pool = pwq->pool;
2353fe089f87STejun Heo 			WARN_ON_ONCE(pool != last_pool);
23548594fadeSLai Jiangshan 		} else {
235518aa9effSTejun Heo 			/* meh... not running there, queue here */
2356a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock(&last_pool->lock);
2357fe089f87STejun Heo 			raw_spin_lock(&pool->lock);
235818aa9effSTejun Heo 		}
23598930cabaSTejun Heo 	} else {
2360fe089f87STejun Heo 		raw_spin_lock(&pool->lock);
23618930cabaSTejun Heo 	}
2362502ca9d8STejun Heo 
23639e8cd2f5STejun Heo 	/*
2364636b927eSTejun Heo 	 * pwq is determined and locked. For unbound pools, we could have raced
2365636b927eSTejun Heo 	 * with pwq release and it could already be dead. If its refcnt is zero,
2366636b927eSTejun Heo 	 * repeat pwq selection. Note that unbound pwqs never die without
2367636b927eSTejun Heo 	 * another pwq replacing it in cpu_pwq or while work items are executing
2368636b927eSTejun Heo 	 * on it, so the retrying is guaranteed to make forward-progress.
23699e8cd2f5STejun Heo 	 */
23709e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
23719e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
2372fe089f87STejun Heo 			raw_spin_unlock(&pool->lock);
23739e8cd2f5STejun Heo 			cpu_relax();
23749e8cd2f5STejun Heo 			goto retry;
23759e8cd2f5STejun Heo 		}
23769e8cd2f5STejun Heo 		/* oops */
23779e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
23789e8cd2f5STejun Heo 			  wq->name, cpu);
23799e8cd2f5STejun Heo 	}
23809e8cd2f5STejun Heo 
2381112202d9STejun Heo 	/* pwq determined, queue */
2382112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
2383502ca9d8STejun Heo 
238424acfb71SThomas Gleixner 	if (WARN_ON(!list_empty(&work->entry)))
238524acfb71SThomas Gleixner 		goto out;
23861e19ffc6STejun Heo 
2387112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
2388112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
23891e19ffc6STejun Heo 
2390a045a272STejun Heo 	/*
2391a045a272STejun Heo 	 * Limit the number of concurrently active work items to max_active.
2392a045a272STejun Heo 	 * @work must also queue behind existing inactive work items to maintain
2393a045a272STejun Heo 	 * ordering when max_active changes. See wq_adjust_max_active().
2394a045a272STejun Heo 	 */
23955797b1c1STejun Heo 	if (list_empty(&pwq->inactive_works) && pwq_tryinc_nr_active(pwq, false)) {
2396fe089f87STejun Heo 		if (list_empty(&pool->worklist))
2397fe089f87STejun Heo 			pool->watchdog_ts = jiffies;
2398fe089f87STejun Heo 
2399cdadf009STejun Heo 		trace_workqueue_activate_work(work);
2400fe089f87STejun Heo 		insert_work(pwq, work, &pool->worklist, work_flags);
24010219a352STejun Heo 		kick_pool(pool);
24028a2e8e5dSTejun Heo 	} else {
2403f97a4a1aSLai Jiangshan 		work_flags |= WORK_STRUCT_INACTIVE;
2404fe089f87STejun Heo 		insert_work(pwq, work, &pwq->inactive_works, work_flags);
24058a2e8e5dSTejun Heo 	}
24061e19ffc6STejun Heo 
240724acfb71SThomas Gleixner out:
2408fe089f87STejun Heo 	raw_spin_unlock(&pool->lock);
240924acfb71SThomas Gleixner 	rcu_read_unlock();
24101da177e4SLinus Torvalds }
24111da177e4SLinus Torvalds 
24120fcb78c2SRolf Eike Beer /**
2413c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
2414c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
2415c1a220e7SZhang Rui  * @wq: workqueue to use
2416c1a220e7SZhang Rui  * @work: work to queue
2417c1a220e7SZhang Rui  *
2418c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
2419443378f0SPaul E. McKenney  * can't go away.  Callers that fail to ensure that the specified
2420443378f0SPaul E. McKenney  * CPU cannot go away will execute on a randomly chosen CPU.
2421854f5cc5SPaul E. McKenney  * But note well that callers specifying a CPU that never has been
2422854f5cc5SPaul E. McKenney  * online will get a splat.
2423d185af30SYacine Belkadi  *
2424d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
2425c1a220e7SZhang Rui  */
2426d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
2427d4283e93STejun Heo 		   struct work_struct *work)
2428c1a220e7SZhang Rui {
2429d4283e93STejun Heo 	bool ret = false;
2430c26e2f2eSTejun Heo 	unsigned long irq_flags;
24318930cabaSTejun Heo 
2432c26e2f2eSTejun Heo 	local_irq_save(irq_flags);
2433c1a220e7SZhang Rui 
243422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
24354690c4abSTejun Heo 		__queue_work(cpu, wq, work);
2436d4283e93STejun Heo 		ret = true;
2437c1a220e7SZhang Rui 	}
24388930cabaSTejun Heo 
2439c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
2440c1a220e7SZhang Rui 	return ret;
2441c1a220e7SZhang Rui }
2442ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
2443c1a220e7SZhang Rui 
24448204e0c1SAlexander Duyck /**
2445fef59c9cSTejun Heo  * select_numa_node_cpu - Select a CPU based on NUMA node
24468204e0c1SAlexander Duyck  * @node: NUMA node ID that we want to select a CPU from
24478204e0c1SAlexander Duyck  *
24488204e0c1SAlexander Duyck  * This function will attempt to find a "random" cpu available on a given
24498204e0c1SAlexander Duyck  * node. If there are no CPUs available on the given node it will return
24508204e0c1SAlexander Duyck  * WORK_CPU_UNBOUND indicating that we should just schedule to any
24518204e0c1SAlexander Duyck  * available CPU if we need to schedule this work.
24528204e0c1SAlexander Duyck  */
2453fef59c9cSTejun Heo static int select_numa_node_cpu(int node)
24548204e0c1SAlexander Duyck {
24558204e0c1SAlexander Duyck 	int cpu;
24568204e0c1SAlexander Duyck 
24578204e0c1SAlexander Duyck 	/* Delay binding to CPU if node is not valid or online */
24588204e0c1SAlexander Duyck 	if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
24598204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
24608204e0c1SAlexander Duyck 
24618204e0c1SAlexander Duyck 	/* Use local node/cpu if we are already there */
24628204e0c1SAlexander Duyck 	cpu = raw_smp_processor_id();
24638204e0c1SAlexander Duyck 	if (node == cpu_to_node(cpu))
24648204e0c1SAlexander Duyck 		return cpu;
24658204e0c1SAlexander Duyck 
24668204e0c1SAlexander Duyck 	/* Use "random" otherwise know as "first" online CPU of node */
24678204e0c1SAlexander Duyck 	cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
24688204e0c1SAlexander Duyck 
24698204e0c1SAlexander Duyck 	/* If CPU is valid return that, otherwise just defer */
24708204e0c1SAlexander Duyck 	return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
24718204e0c1SAlexander Duyck }
24728204e0c1SAlexander Duyck 
24738204e0c1SAlexander Duyck /**
24748204e0c1SAlexander Duyck  * queue_work_node - queue work on a "random" cpu for a given NUMA node
24758204e0c1SAlexander Duyck  * @node: NUMA node that we are targeting the work for
24768204e0c1SAlexander Duyck  * @wq: workqueue to use
24778204e0c1SAlexander Duyck  * @work: work to queue
24788204e0c1SAlexander Duyck  *
24798204e0c1SAlexander Duyck  * We queue the work to a "random" CPU within a given NUMA node. The basic
24808204e0c1SAlexander Duyck  * idea here is to provide a way to somehow associate work with a given
24818204e0c1SAlexander Duyck  * NUMA node.
24828204e0c1SAlexander Duyck  *
24838204e0c1SAlexander Duyck  * This function will only make a best effort attempt at getting this onto
24848204e0c1SAlexander Duyck  * the right NUMA node. If no node is requested or the requested node is
24858204e0c1SAlexander Duyck  * offline then we just fall back to standard queue_work behavior.
24868204e0c1SAlexander Duyck  *
24878204e0c1SAlexander Duyck  * Currently the "random" CPU ends up being the first available CPU in the
24888204e0c1SAlexander Duyck  * intersection of cpu_online_mask and the cpumask of the node, unless we
24898204e0c1SAlexander Duyck  * are running on the node. In that case we just use the current CPU.
24908204e0c1SAlexander Duyck  *
24918204e0c1SAlexander Duyck  * Return: %false if @work was already on a queue, %true otherwise.
24928204e0c1SAlexander Duyck  */
24938204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq,
24948204e0c1SAlexander Duyck 		     struct work_struct *work)
24958204e0c1SAlexander Duyck {
2496c26e2f2eSTejun Heo 	unsigned long irq_flags;
24978204e0c1SAlexander Duyck 	bool ret = false;
24988204e0c1SAlexander Duyck 
24998204e0c1SAlexander Duyck 	/*
25008204e0c1SAlexander Duyck 	 * This current implementation is specific to unbound workqueues.
25018204e0c1SAlexander Duyck 	 * Specifically we only return the first available CPU for a given
25028204e0c1SAlexander Duyck 	 * node instead of cycling through individual CPUs within the node.
25038204e0c1SAlexander Duyck 	 *
25048204e0c1SAlexander Duyck 	 * If this is used with a per-cpu workqueue then the logic in
25058204e0c1SAlexander Duyck 	 * workqueue_select_cpu_near would need to be updated to allow for
25068204e0c1SAlexander Duyck 	 * some round robin type logic.
25078204e0c1SAlexander Duyck 	 */
25088204e0c1SAlexander Duyck 	WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
25098204e0c1SAlexander Duyck 
2510c26e2f2eSTejun Heo 	local_irq_save(irq_flags);
25118204e0c1SAlexander Duyck 
25128204e0c1SAlexander Duyck 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
2513fef59c9cSTejun Heo 		int cpu = select_numa_node_cpu(node);
25148204e0c1SAlexander Duyck 
25158204e0c1SAlexander Duyck 		__queue_work(cpu, wq, work);
25168204e0c1SAlexander Duyck 		ret = true;
25178204e0c1SAlexander Duyck 	}
25188204e0c1SAlexander Duyck 
2519c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
25208204e0c1SAlexander Duyck 	return ret;
25218204e0c1SAlexander Duyck }
25228204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node);
25238204e0c1SAlexander Duyck 
25248c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t)
25251da177e4SLinus Torvalds {
25268c20feb6SKees Cook 	struct delayed_work *dwork = from_timer(dwork, t, timer);
25271da177e4SLinus Torvalds 
2528e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
252960c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
25301da177e4SLinus Torvalds }
25311438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
25321da177e4SLinus Torvalds 
25337beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
253452bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
25351da177e4SLinus Torvalds {
25367beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
25377beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
25381da177e4SLinus Torvalds 
2539637fdbaeSTejun Heo 	WARN_ON_ONCE(!wq);
25404b243563SSami Tolvanen 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
2541fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
2542fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
25437beb2edfSTejun Heo 
25448852aac2STejun Heo 	/*
25458852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
25468852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
25478852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
25488852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
25498852aac2STejun Heo 	 */
25508852aac2STejun Heo 	if (!delay) {
25518852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
25528852aac2STejun Heo 		return;
25538852aac2STejun Heo 	}
25548852aac2STejun Heo 
255560c057bcSLai Jiangshan 	dwork->wq = wq;
25561265057fSTejun Heo 	dwork->cpu = cpu;
25577beb2edfSTejun Heo 	timer->expires = jiffies + delay;
25587beb2edfSTejun Heo 
2559aae17ebbSLeonardo Bras 	if (housekeeping_enabled(HK_TYPE_TIMER)) {
2560aae17ebbSLeonardo Bras 		/* If the current cpu is a housekeeping cpu, use it. */
2561aae17ebbSLeonardo Bras 		cpu = smp_processor_id();
2562aae17ebbSLeonardo Bras 		if (!housekeeping_test_cpu(cpu, HK_TYPE_TIMER))
2563aae17ebbSLeonardo Bras 			cpu = housekeeping_any_cpu(HK_TYPE_TIMER);
25647beb2edfSTejun Heo 		add_timer_on(timer, cpu);
2565aae17ebbSLeonardo Bras 	} else {
2566aae17ebbSLeonardo Bras 		if (likely(cpu == WORK_CPU_UNBOUND))
2567041bd12eSTejun Heo 			add_timer(timer);
2568aae17ebbSLeonardo Bras 		else
2569aae17ebbSLeonardo Bras 			add_timer_on(timer, cpu);
2570aae17ebbSLeonardo Bras 	}
25717beb2edfSTejun Heo }
25721da177e4SLinus Torvalds 
25730fcb78c2SRolf Eike Beer /**
25740fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
25750fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
25760fcb78c2SRolf Eike Beer  * @wq: workqueue to use
2577af9997e4SRandy Dunlap  * @dwork: work to queue
25780fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
25790fcb78c2SRolf Eike Beer  *
2580d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
2581715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
2582715f1300STejun Heo  * execution.
25830fcb78c2SRolf Eike Beer  */
2584d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
258552bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
25867a6bc1cdSVenkatesh Pallipadi {
258752bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
2588d4283e93STejun Heo 	bool ret = false;
2589c26e2f2eSTejun Heo 	unsigned long irq_flags;
25908930cabaSTejun Heo 
25918930cabaSTejun Heo 	/* read the comment in __queue_work() */
2592c26e2f2eSTejun Heo 	local_irq_save(irq_flags);
25937a6bc1cdSVenkatesh Pallipadi 
259422df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
25957beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
2596d4283e93STejun Heo 		ret = true;
25977a6bc1cdSVenkatesh Pallipadi 	}
25988930cabaSTejun Heo 
2599c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
26007a6bc1cdSVenkatesh Pallipadi 	return ret;
26017a6bc1cdSVenkatesh Pallipadi }
2602ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
26031da177e4SLinus Torvalds 
2604c8e55f36STejun Heo /**
26058376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
26068376fe22STejun Heo  * @cpu: CPU number to execute work on
26078376fe22STejun Heo  * @wq: workqueue to use
26088376fe22STejun Heo  * @dwork: work to queue
26098376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
26108376fe22STejun Heo  *
26118376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
26128376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
26138376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
26148376fe22STejun Heo  * current state.
26158376fe22STejun Heo  *
2616d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
26178376fe22STejun Heo  * pending and its timer was modified.
26188376fe22STejun Heo  *
2619e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
26208376fe22STejun Heo  * See try_to_grab_pending() for details.
26218376fe22STejun Heo  */
26228376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
26238376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
26248376fe22STejun Heo {
2625c26e2f2eSTejun Heo 	unsigned long irq_flags;
26268376fe22STejun Heo 	int ret;
26278376fe22STejun Heo 
26288376fe22STejun Heo 	do {
2629c5f5b942STejun Heo 		ret = try_to_grab_pending(&dwork->work, WORK_CANCEL_DELAYED,
2630c5f5b942STejun Heo 					  &irq_flags);
26318376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
26328376fe22STejun Heo 
26338376fe22STejun Heo 	if (likely(ret >= 0)) {
26348376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
2635c26e2f2eSTejun Heo 		local_irq_restore(irq_flags);
26368376fe22STejun Heo 	}
26378376fe22STejun Heo 
26388376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
26398376fe22STejun Heo 	return ret;
26408376fe22STejun Heo }
26418376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
26428376fe22STejun Heo 
264305f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu)
264405f0fe6bSTejun Heo {
264505f0fe6bSTejun Heo 	struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
264605f0fe6bSTejun Heo 
264705f0fe6bSTejun Heo 	/* read the comment in __queue_work() */
264805f0fe6bSTejun Heo 	local_irq_disable();
264905f0fe6bSTejun Heo 	__queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
265005f0fe6bSTejun Heo 	local_irq_enable();
265105f0fe6bSTejun Heo }
265205f0fe6bSTejun Heo 
265305f0fe6bSTejun Heo /**
265405f0fe6bSTejun Heo  * queue_rcu_work - queue work after a RCU grace period
265505f0fe6bSTejun Heo  * @wq: workqueue to use
265605f0fe6bSTejun Heo  * @rwork: work to queue
265705f0fe6bSTejun Heo  *
265805f0fe6bSTejun Heo  * Return: %false if @rwork was already pending, %true otherwise.  Note
265905f0fe6bSTejun Heo  * that a full RCU grace period is guaranteed only after a %true return.
2660bf393fd4SBart Van Assche  * While @rwork is guaranteed to be executed after a %false return, the
266105f0fe6bSTejun Heo  * execution may happen before a full RCU grace period has passed.
266205f0fe6bSTejun Heo  */
266305f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
266405f0fe6bSTejun Heo {
266505f0fe6bSTejun Heo 	struct work_struct *work = &rwork->work;
266605f0fe6bSTejun Heo 
266705f0fe6bSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
266805f0fe6bSTejun Heo 		rwork->wq = wq;
2669a7e30c0eSUladzislau Rezki 		call_rcu_hurry(&rwork->rcu, rcu_work_rcufn);
267005f0fe6bSTejun Heo 		return true;
267105f0fe6bSTejun Heo 	}
267205f0fe6bSTejun Heo 
267305f0fe6bSTejun Heo 	return false;
267405f0fe6bSTejun Heo }
267505f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work);
267605f0fe6bSTejun Heo 
2677f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
2678c34056a3STejun Heo {
2679c34056a3STejun Heo 	struct worker *worker;
2680c34056a3STejun Heo 
2681f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
2682c8e55f36STejun Heo 	if (worker) {
2683c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
2684affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
2685da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
2686e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
2687e22bee78STejun Heo 		worker->flags = WORKER_PREP;
2688c8e55f36STejun Heo 	}
2689c34056a3STejun Heo 	return worker;
2690c34056a3STejun Heo }
2691c34056a3STejun Heo 
26929546b29eSTejun Heo static cpumask_t *pool_allowed_cpus(struct worker_pool *pool)
26939546b29eSTejun Heo {
26948639ecebSTejun Heo 	if (pool->cpu < 0 && pool->attrs->affn_strict)
26959546b29eSTejun Heo 		return pool->attrs->__pod_cpumask;
26968639ecebSTejun Heo 	else
26978639ecebSTejun Heo 		return pool->attrs->cpumask;
26989546b29eSTejun Heo }
26999546b29eSTejun Heo 
2700c34056a3STejun Heo /**
27014736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
27024736cbf7SLai Jiangshan  * @worker: worker to be attached
27034736cbf7SLai Jiangshan  * @pool: the target pool
27044736cbf7SLai Jiangshan  *
27054736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
27064736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
27074736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
27084736cbf7SLai Jiangshan  */
27094736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
27104736cbf7SLai Jiangshan 				  struct worker_pool *pool)
27114736cbf7SLai Jiangshan {
27121258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
27134736cbf7SLai Jiangshan 
27144736cbf7SLai Jiangshan 	/*
27154cb1ef64STejun Heo 	 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains stable
27164cb1ef64STejun Heo 	 * across this function. See the comments above the flag definition for
27174cb1ef64STejun Heo 	 * details. BH workers are, while per-CPU, always DISASSOCIATED.
27184736cbf7SLai Jiangshan 	 */
27194cb1ef64STejun Heo 	if (pool->flags & POOL_DISASSOCIATED) {
27204736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
27214cb1ef64STejun Heo 	} else {
27224cb1ef64STejun Heo 		WARN_ON_ONCE(pool->flags & POOL_BH);
27235c25b5ffSPeter Zijlstra 		kthread_set_per_cpu(worker->task, pool->cpu);
27244cb1ef64STejun Heo 	}
27254736cbf7SLai Jiangshan 
2726640f17c8SPeter Zijlstra 	if (worker->rescue_wq)
27279546b29eSTejun Heo 		set_cpus_allowed_ptr(worker->task, pool_allowed_cpus(pool));
2728640f17c8SPeter Zijlstra 
27294736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
2730a2d812a2STejun Heo 	worker->pool = pool;
27314736cbf7SLai Jiangshan 
27321258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
27334736cbf7SLai Jiangshan }
27344736cbf7SLai Jiangshan 
27354736cbf7SLai Jiangshan /**
273660f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
273760f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
273860f5a4bcSLai Jiangshan  *
27394736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
27404736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
27414736cbf7SLai Jiangshan  * other reference to the pool.
274260f5a4bcSLai Jiangshan  */
2743a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker)
274460f5a4bcSLai Jiangshan {
2745a2d812a2STejun Heo 	struct worker_pool *pool = worker->pool;
274660f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
274760f5a4bcSLai Jiangshan 
27484cb1ef64STejun Heo 	/* there is one permanent BH worker per CPU which should never detach */
27494cb1ef64STejun Heo 	WARN_ON_ONCE(pool->flags & POOL_BH);
27504cb1ef64STejun Heo 
27511258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
2752a2d812a2STejun Heo 
27535c25b5ffSPeter Zijlstra 	kthread_set_per_cpu(worker->task, -1);
2754da028469SLai Jiangshan 	list_del(&worker->node);
2755a2d812a2STejun Heo 	worker->pool = NULL;
2756a2d812a2STejun Heo 
2757e02b9312SValentin Schneider 	if (list_empty(&pool->workers) && list_empty(&pool->dying_workers))
275860f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
27591258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
276060f5a4bcSLai Jiangshan 
2761b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
2762b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
2763b62c0751SLai Jiangshan 
276460f5a4bcSLai Jiangshan 	if (detach_completion)
276560f5a4bcSLai Jiangshan 		complete(detach_completion);
276660f5a4bcSLai Jiangshan }
276760f5a4bcSLai Jiangshan 
276860f5a4bcSLai Jiangshan /**
2769c34056a3STejun Heo  * create_worker - create a new workqueue worker
277063d95a91STejun Heo  * @pool: pool the new worker will belong to
2771c34056a3STejun Heo  *
2772051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
2773c34056a3STejun Heo  *
2774c34056a3STejun Heo  * CONTEXT:
2775c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
2776c34056a3STejun Heo  *
2777d185af30SYacine Belkadi  * Return:
2778c34056a3STejun Heo  * Pointer to the newly created worker.
2779c34056a3STejun Heo  */
2780bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
2781c34056a3STejun Heo {
2782e441b56fSZhen Lei 	struct worker *worker;
2783e441b56fSZhen Lei 	int id;
27845d9c7a1eSLucy Mielke 	char id_buf[23];
2785c34056a3STejun Heo 
27867cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
2787e441b56fSZhen Lei 	id = ida_alloc(&pool->worker_ida, GFP_KERNEL);
27883f0ea0b8SPetr Mladek 	if (id < 0) {
27893f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker ID: %pe\n",
27903f0ea0b8SPetr Mladek 			    ERR_PTR(id));
2791e441b56fSZhen Lei 		return NULL;
27923f0ea0b8SPetr Mladek 	}
2793c34056a3STejun Heo 
2794f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
27953f0ea0b8SPetr Mladek 	if (!worker) {
27963f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker\n");
2797c34056a3STejun Heo 		goto fail;
27983f0ea0b8SPetr Mladek 	}
2799c34056a3STejun Heo 
2800c34056a3STejun Heo 	worker->id = id;
2801c34056a3STejun Heo 
28024cb1ef64STejun Heo 	if (!(pool->flags & POOL_BH)) {
280329c91e99STejun Heo 		if (pool->cpu >= 0)
2804e3c916a4STejun Heo 			snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
2805e3c916a4STejun Heo 				 pool->attrs->nice < 0  ? "H" : "");
2806f3421797STejun Heo 		else
2807e3c916a4STejun Heo 			snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
2808e3c916a4STejun Heo 
28094cb1ef64STejun Heo 		worker->task = kthread_create_on_node(worker_thread, worker,
28104cb1ef64STejun Heo 					pool->node, "kworker/%s", id_buf);
28113f0ea0b8SPetr Mladek 		if (IS_ERR(worker->task)) {
281260f54038SPetr Mladek 			if (PTR_ERR(worker->task) == -EINTR) {
281360f54038SPetr Mladek 				pr_err("workqueue: Interrupted when creating a worker thread \"kworker/%s\"\n",
281460f54038SPetr Mladek 				       id_buf);
281560f54038SPetr Mladek 			} else {
28163f0ea0b8SPetr Mladek 				pr_err_once("workqueue: Failed to create a worker thread: %pe",
28173f0ea0b8SPetr Mladek 					    worker->task);
281860f54038SPetr Mladek 			}
2819c34056a3STejun Heo 			goto fail;
28203f0ea0b8SPetr Mladek 		}
2821c34056a3STejun Heo 
282291151228SOleg Nesterov 		set_user_nice(worker->task, pool->attrs->nice);
28239546b29eSTejun Heo 		kthread_bind_mask(worker->task, pool_allowed_cpus(pool));
28244cb1ef64STejun Heo 	}
282591151228SOleg Nesterov 
2826da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
28274736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
2828822d8405STejun Heo 
2829051e1850SLai Jiangshan 	/* start the newly created worker */
2830a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
28310219a352STejun Heo 
2832051e1850SLai Jiangshan 	worker->pool->nr_workers++;
2833051e1850SLai Jiangshan 	worker_enter_idle(worker);
28340219a352STejun Heo 
28350219a352STejun Heo 	/*
28360219a352STejun Heo 	 * @worker is waiting on a completion in kthread() and will trigger hung
28376a229b0eSTejun Heo 	 * check if not woken up soon. As kick_pool() is noop if @pool is empty,
28386a229b0eSTejun Heo 	 * wake it up explicitly.
28390219a352STejun Heo 	 */
28404cb1ef64STejun Heo 	if (worker->task)
2841051e1850SLai Jiangshan 		wake_up_process(worker->task);
28420219a352STejun Heo 
2843a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2844051e1850SLai Jiangshan 
2845c34056a3STejun Heo 	return worker;
2846822d8405STejun Heo 
2847c34056a3STejun Heo fail:
2848e441b56fSZhen Lei 	ida_free(&pool->worker_ida, id);
2849c34056a3STejun Heo 	kfree(worker);
2850c34056a3STejun Heo 	return NULL;
2851c34056a3STejun Heo }
2852c34056a3STejun Heo 
2853793777bcSValentin Schneider static void unbind_worker(struct worker *worker)
2854793777bcSValentin Schneider {
2855793777bcSValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2856793777bcSValentin Schneider 
2857793777bcSValentin Schneider 	kthread_set_per_cpu(worker->task, -1);
2858793777bcSValentin Schneider 	if (cpumask_intersects(wq_unbound_cpumask, cpu_active_mask))
2859793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, wq_unbound_cpumask) < 0);
2860793777bcSValentin Schneider 	else
2861793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
2862793777bcSValentin Schneider }
2863793777bcSValentin Schneider 
2864e02b9312SValentin Schneider static void wake_dying_workers(struct list_head *cull_list)
2865e02b9312SValentin Schneider {
2866e02b9312SValentin Schneider 	struct worker *worker, *tmp;
2867e02b9312SValentin Schneider 
2868e02b9312SValentin Schneider 	list_for_each_entry_safe(worker, tmp, cull_list, entry) {
2869e02b9312SValentin Schneider 		list_del_init(&worker->entry);
2870e02b9312SValentin Schneider 		unbind_worker(worker);
2871e02b9312SValentin Schneider 		/*
2872e02b9312SValentin Schneider 		 * If the worker was somehow already running, then it had to be
2873e02b9312SValentin Schneider 		 * in pool->idle_list when set_worker_dying() happened or we
2874e02b9312SValentin Schneider 		 * wouldn't have gotten here.
2875c34056a3STejun Heo 		 *
2876e02b9312SValentin Schneider 		 * Thus, the worker must either have observed the WORKER_DIE
2877e02b9312SValentin Schneider 		 * flag, or have set its state to TASK_IDLE. Either way, the
2878e02b9312SValentin Schneider 		 * below will be observed by the worker and is safe to do
2879e02b9312SValentin Schneider 		 * outside of pool->lock.
2880e02b9312SValentin Schneider 		 */
2881e02b9312SValentin Schneider 		wake_up_process(worker->task);
2882e02b9312SValentin Schneider 	}
2883e02b9312SValentin Schneider }
2884e02b9312SValentin Schneider 
2885e02b9312SValentin Schneider /**
2886e02b9312SValentin Schneider  * set_worker_dying - Tag a worker for destruction
2887e02b9312SValentin Schneider  * @worker: worker to be destroyed
2888e02b9312SValentin Schneider  * @list: transfer worker away from its pool->idle_list and into list
2889e02b9312SValentin Schneider  *
2890e02b9312SValentin Schneider  * Tag @worker for destruction and adjust @pool stats accordingly.  The worker
2891e02b9312SValentin Schneider  * should be idle.
2892c8e55f36STejun Heo  *
2893c8e55f36STejun Heo  * CONTEXT:
2894a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2895c34056a3STejun Heo  */
2896e02b9312SValentin Schneider static void set_worker_dying(struct worker *worker, struct list_head *list)
2897c34056a3STejun Heo {
2898bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2899c34056a3STejun Heo 
2900cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
2901e02b9312SValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2902cd549687STejun Heo 
2903c34056a3STejun Heo 	/* sanity check frenzy */
29046183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
290573eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
290673eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
29076183c009STejun Heo 		return;
2908c34056a3STejun Heo 
2909bd7bdd43STejun Heo 	pool->nr_workers--;
2910bd7bdd43STejun Heo 	pool->nr_idle--;
2911c8e55f36STejun Heo 
2912cb444766STejun Heo 	worker->flags |= WORKER_DIE;
2913e02b9312SValentin Schneider 
2914e02b9312SValentin Schneider 	list_move(&worker->entry, list);
2915e02b9312SValentin Schneider 	list_move(&worker->node, &pool->dying_workers);
2916c34056a3STejun Heo }
2917c34056a3STejun Heo 
29183f959aa3SValentin Schneider /**
29193f959aa3SValentin Schneider  * idle_worker_timeout - check if some idle workers can now be deleted.
29203f959aa3SValentin Schneider  * @t: The pool's idle_timer that just expired
29213f959aa3SValentin Schneider  *
29223f959aa3SValentin Schneider  * The timer is armed in worker_enter_idle(). Note that it isn't disarmed in
29233f959aa3SValentin Schneider  * worker_leave_idle(), as a worker flicking between idle and active while its
29243f959aa3SValentin Schneider  * pool is at the too_many_workers() tipping point would cause too much timer
29253f959aa3SValentin Schneider  * housekeeping overhead. Since IDLE_WORKER_TIMEOUT is long enough, we just let
29263f959aa3SValentin Schneider  * it expire and re-evaluate things from there.
29273f959aa3SValentin Schneider  */
292832a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t)
2929e22bee78STejun Heo {
293032a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, idle_timer);
29313f959aa3SValentin Schneider 	bool do_cull = false;
29323f959aa3SValentin Schneider 
29333f959aa3SValentin Schneider 	if (work_pending(&pool->idle_cull_work))
29343f959aa3SValentin Schneider 		return;
29353f959aa3SValentin Schneider 
29363f959aa3SValentin Schneider 	raw_spin_lock_irq(&pool->lock);
29373f959aa3SValentin Schneider 
29383f959aa3SValentin Schneider 	if (too_many_workers(pool)) {
29393f959aa3SValentin Schneider 		struct worker *worker;
29403f959aa3SValentin Schneider 		unsigned long expires;
29413f959aa3SValentin Schneider 
29423f959aa3SValentin Schneider 		/* idle_list is kept in LIFO order, check the last one */
29433f959aa3SValentin Schneider 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
29443f959aa3SValentin Schneider 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
29453f959aa3SValentin Schneider 		do_cull = !time_before(jiffies, expires);
29463f959aa3SValentin Schneider 
29473f959aa3SValentin Schneider 		if (!do_cull)
29483f959aa3SValentin Schneider 			mod_timer(&pool->idle_timer, expires);
29493f959aa3SValentin Schneider 	}
29503f959aa3SValentin Schneider 	raw_spin_unlock_irq(&pool->lock);
29513f959aa3SValentin Schneider 
29523f959aa3SValentin Schneider 	if (do_cull)
29533f959aa3SValentin Schneider 		queue_work(system_unbound_wq, &pool->idle_cull_work);
29543f959aa3SValentin Schneider }
29553f959aa3SValentin Schneider 
29563f959aa3SValentin Schneider /**
29573f959aa3SValentin Schneider  * idle_cull_fn - cull workers that have been idle for too long.
29583f959aa3SValentin Schneider  * @work: the pool's work for handling these idle workers
29593f959aa3SValentin Schneider  *
29603f959aa3SValentin Schneider  * This goes through a pool's idle workers and gets rid of those that have been
29613f959aa3SValentin Schneider  * idle for at least IDLE_WORKER_TIMEOUT seconds.
2962e02b9312SValentin Schneider  *
2963e02b9312SValentin Schneider  * We don't want to disturb isolated CPUs because of a pcpu kworker being
2964e02b9312SValentin Schneider  * culled, so this also resets worker affinity. This requires a sleepable
2965e02b9312SValentin Schneider  * context, hence the split between timer callback and work item.
29663f959aa3SValentin Schneider  */
29673f959aa3SValentin Schneider static void idle_cull_fn(struct work_struct *work)
29683f959aa3SValentin Schneider {
29693f959aa3SValentin Schneider 	struct worker_pool *pool = container_of(work, struct worker_pool, idle_cull_work);
29709680540cSYang Yingliang 	LIST_HEAD(cull_list);
2971e22bee78STejun Heo 
2972e02b9312SValentin Schneider 	/*
2973e02b9312SValentin Schneider 	 * Grabbing wq_pool_attach_mutex here ensures an already-running worker
2974e02b9312SValentin Schneider 	 * cannot proceed beyong worker_detach_from_pool() in its self-destruct
2975e02b9312SValentin Schneider 	 * path. This is required as a previously-preempted worker could run after
2976e02b9312SValentin Schneider 	 * set_worker_dying() has happened but before wake_dying_workers() did.
2977e02b9312SValentin Schneider 	 */
2978e02b9312SValentin Schneider 	mutex_lock(&wq_pool_attach_mutex);
2979a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2980e22bee78STejun Heo 
29813347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
2982e22bee78STejun Heo 		struct worker *worker;
2983e22bee78STejun Heo 		unsigned long expires;
2984e22bee78STejun Heo 
298563d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2986e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2987e22bee78STejun Heo 
29883347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
298963d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
29903347fc9fSLai Jiangshan 			break;
2991e22bee78STejun Heo 		}
29923347fc9fSLai Jiangshan 
2993e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
2994e22bee78STejun Heo 	}
2995e22bee78STejun Heo 
2996a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2997e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
2998e02b9312SValentin Schneider 	mutex_unlock(&wq_pool_attach_mutex);
2999e22bee78STejun Heo }
3000e22bee78STejun Heo 
3001493a1724STejun Heo static void send_mayday(struct work_struct *work)
3002e22bee78STejun Heo {
3003112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
3004112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
3005493a1724STejun Heo 
30062e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
3007e22bee78STejun Heo 
3008493008a8STejun Heo 	if (!wq->rescuer)
3009493a1724STejun Heo 		return;
3010e22bee78STejun Heo 
3011e22bee78STejun Heo 	/* mayday mayday mayday */
3012493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
301377668c8bSLai Jiangshan 		/*
301477668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
301577668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
301677668c8bSLai Jiangshan 		 * rescuer is done with it.
301777668c8bSLai Jiangshan 		 */
301877668c8bSLai Jiangshan 		get_pwq(pwq);
3019493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
3020e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
3021725e8ec5STejun Heo 		pwq->stats[PWQ_STAT_MAYDAY]++;
3022493a1724STejun Heo 	}
3023e22bee78STejun Heo }
3024e22bee78STejun Heo 
302532a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t)
3026e22bee78STejun Heo {
302732a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, mayday_timer);
3028e22bee78STejun Heo 	struct work_struct *work;
3029e22bee78STejun Heo 
3030a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3031a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&wq_mayday_lock);		/* for wq->maydays */
3032e22bee78STejun Heo 
303363d95a91STejun Heo 	if (need_to_create_worker(pool)) {
3034e22bee78STejun Heo 		/*
3035e22bee78STejun Heo 		 * We've been trying to create a new worker but
3036e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
3037e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
3038e22bee78STejun Heo 		 * rescuers.
3039e22bee78STejun Heo 		 */
304063d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
3041e22bee78STejun Heo 			send_mayday(work);
3042e22bee78STejun Heo 	}
3043e22bee78STejun Heo 
3044a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&wq_mayday_lock);
3045a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
3046e22bee78STejun Heo 
304763d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
3048e22bee78STejun Heo }
3049e22bee78STejun Heo 
3050e22bee78STejun Heo /**
3051e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
305263d95a91STejun Heo  * @pool: pool to create a new worker for
3053e22bee78STejun Heo  *
305463d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
3055e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
3056e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
305763d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
3058e22bee78STejun Heo  * possible allocation deadlock.
3059e22bee78STejun Heo  *
3060c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
3061c5aa87bbSTejun Heo  * may_start_working() %true.
3062e22bee78STejun Heo  *
3063e22bee78STejun Heo  * LOCKING:
3064a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
3065e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
3066e22bee78STejun Heo  * manager.
3067e22bee78STejun Heo  */
306829187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool)
3069d565ed63STejun Heo __releases(&pool->lock)
3070d565ed63STejun Heo __acquires(&pool->lock)
3071e22bee78STejun Heo {
3072e22bee78STejun Heo restart:
3073a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
30749f9c2364STejun Heo 
3075e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
307663d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
3077e22bee78STejun Heo 
3078e22bee78STejun Heo 	while (true) {
3079051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
3080e22bee78STejun Heo 			break;
3081e22bee78STejun Heo 
3082e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
30839f9c2364STejun Heo 
308463d95a91STejun Heo 		if (!need_to_create_worker(pool))
3085e22bee78STejun Heo 			break;
3086e22bee78STejun Heo 	}
3087e22bee78STejun Heo 
308863d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
3089a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3090051e1850SLai Jiangshan 	/*
3091051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
3092051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
3093051e1850SLai Jiangshan 	 * already become busy.
3094051e1850SLai Jiangshan 	 */
309563d95a91STejun Heo 	if (need_to_create_worker(pool))
3096e22bee78STejun Heo 		goto restart;
3097e22bee78STejun Heo }
3098e22bee78STejun Heo 
3099e22bee78STejun Heo /**
3100e22bee78STejun Heo  * manage_workers - manage worker pool
3101e22bee78STejun Heo  * @worker: self
3102e22bee78STejun Heo  *
3103706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
3104e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
3105706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
3106e22bee78STejun Heo  *
3107e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
3108e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
3109e22bee78STejun Heo  * and may_start_working() is true.
3110e22bee78STejun Heo  *
3111e22bee78STejun Heo  * CONTEXT:
3112a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
3113e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
3114e22bee78STejun Heo  *
3115d185af30SYacine Belkadi  * Return:
311629187a9eSTejun Heo  * %false if the pool doesn't need management and the caller can safely
311729187a9eSTejun Heo  * start processing works, %true if management function was performed and
311829187a9eSTejun Heo  * the conditions that the caller verified before calling the function may
311929187a9eSTejun Heo  * no longer be true.
3120e22bee78STejun Heo  */
3121e22bee78STejun Heo static bool manage_workers(struct worker *worker)
3122e22bee78STejun Heo {
312363d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
3124e22bee78STejun Heo 
3125692b4825STejun Heo 	if (pool->flags & POOL_MANAGER_ACTIVE)
312629187a9eSTejun Heo 		return false;
3127692b4825STejun Heo 
3128692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
31292607d7a6STejun Heo 	pool->manager = worker;
3130e22bee78STejun Heo 
313129187a9eSTejun Heo 	maybe_create_worker(pool);
3132e22bee78STejun Heo 
31332607d7a6STejun Heo 	pool->manager = NULL;
3134692b4825STejun Heo 	pool->flags &= ~POOL_MANAGER_ACTIVE;
3135d8bb65abSSebastian Andrzej Siewior 	rcuwait_wake_up(&manager_wait);
313629187a9eSTejun Heo 	return true;
3137e22bee78STejun Heo }
3138e22bee78STejun Heo 
3139a62428c0STejun Heo /**
3140a62428c0STejun Heo  * process_one_work - process single work
3141c34056a3STejun Heo  * @worker: self
3142a62428c0STejun Heo  * @work: work to process
3143a62428c0STejun Heo  *
3144a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
3145a62428c0STejun Heo  * process a single work including synchronization against and
3146a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
3147a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
3148a62428c0STejun Heo  * call this function to process a work.
3149a62428c0STejun Heo  *
3150a62428c0STejun Heo  * CONTEXT:
3151a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
3152a62428c0STejun Heo  */
3153c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
3154d565ed63STejun Heo __releases(&pool->lock)
3155d565ed63STejun Heo __acquires(&pool->lock)
31561da177e4SLinus Torvalds {
3157112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
3158bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
3159c4560c2cSLai Jiangshan 	unsigned long work_data;
3160c35aea39STejun Heo 	int lockdep_start_depth, rcu_start_depth;
3161*1acd92d9STejun Heo 	bool bh_draining = pool->flags & POOL_BH_DRAINING;
31624e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
31634e6045f1SJohannes Berg 	/*
3164a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
3165a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
3166a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
3167a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
3168a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
31694e6045f1SJohannes Berg 	 */
31704d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
31714d82a1deSPeter Zijlstra 
31724d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
31734e6045f1SJohannes Berg #endif
3174807407c0SLai Jiangshan 	/* ensure we're on the correct CPU */
317585327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
3176ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
317725511a47STejun Heo 
31788930cabaSTejun Heo 	/* claim and dequeue */
3179dc186ad7SThomas Gleixner 	debug_work_deactivate(work);
3180c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
3181c34056a3STejun Heo 	worker->current_work = work;
3182a2c1c57bSTejun Heo 	worker->current_func = work->func;
3183112202d9STejun Heo 	worker->current_pwq = pwq;
31844cb1ef64STejun Heo 	if (worker->task)
3185616db877STejun Heo 		worker->current_at = worker->task->se.sum_exec_runtime;
3186c4560c2cSLai Jiangshan 	work_data = *work_data_bits(work);
3187d812796eSLai Jiangshan 	worker->current_color = get_work_color(work_data);
31887a22ad75STejun Heo 
31898bf89593STejun Heo 	/*
31908bf89593STejun Heo 	 * Record wq name for cmdline and debug reporting, may get
31918bf89593STejun Heo 	 * overridden through set_worker_desc().
31928bf89593STejun Heo 	 */
31938bf89593STejun Heo 	strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
31948bf89593STejun Heo 
3195a62428c0STejun Heo 	list_del_init(&work->entry);
3196a62428c0STejun Heo 
3197649027d7STejun Heo 	/*
3198228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
3199228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
3200228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
3201228f1d00SLai Jiangshan 	 * execution of the pending work items.
3202fb0e7bebSTejun Heo 	 */
3203616db877STejun Heo 	if (unlikely(pwq->wq->flags & WQ_CPU_INTENSIVE))
3204228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
3205fb0e7bebSTejun Heo 
3206974271c4STejun Heo 	/*
32070219a352STejun Heo 	 * Kick @pool if necessary. It's always noop for per-cpu worker pools
32080219a352STejun Heo 	 * since nr_running would always be >= 1 at this point. This is used to
32090219a352STejun Heo 	 * chain execution of the pending work items for WORKER_NOT_RUNNING
32100219a352STejun Heo 	 * workers such as the UNBOUND and CPU_INTENSIVE ones.
3211974271c4STejun Heo 	 */
32120219a352STejun Heo 	kick_pool(pool);
3213974271c4STejun Heo 
32148930cabaSTejun Heo 	/*
32157c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
3216d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
321723657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
321823657bb1STejun Heo 	 * disabled.
32198930cabaSTejun Heo 	 */
3220bccdc1faSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id, 0);
32211da177e4SLinus Torvalds 
3222fe48ba7dSMirsad Goran Todorovac 	pwq->stats[PWQ_STAT_STARTED]++;
3223a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
3224365970a1SDavid Howells 
3225c35aea39STejun Heo 	rcu_start_depth = rcu_preempt_depth();
3226c35aea39STejun Heo 	lockdep_start_depth = lockdep_depth(current);
3227*1acd92d9STejun Heo 	/* see drain_dead_softirq_workfn() */
3228*1acd92d9STejun Heo 	if (!bh_draining)
3229a1d14934SPeter Zijlstra 		lock_map_acquire(&pwq->wq->lockdep_map);
32303295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
3231e6f3faa7SPeter Zijlstra 	/*
3232f52be570SPeter Zijlstra 	 * Strictly speaking we should mark the invariant state without holding
3233f52be570SPeter Zijlstra 	 * any locks, that is, before these two lock_map_acquire()'s.
3234e6f3faa7SPeter Zijlstra 	 *
3235e6f3faa7SPeter Zijlstra 	 * However, that would result in:
3236e6f3faa7SPeter Zijlstra 	 *
3237e6f3faa7SPeter Zijlstra 	 *   A(W1)
3238e6f3faa7SPeter Zijlstra 	 *   WFC(C)
3239e6f3faa7SPeter Zijlstra 	 *		A(W1)
3240e6f3faa7SPeter Zijlstra 	 *		C(C)
3241e6f3faa7SPeter Zijlstra 	 *
3242e6f3faa7SPeter Zijlstra 	 * Which would create W1->C->W1 dependencies, even though there is no
3243e6f3faa7SPeter Zijlstra 	 * actual deadlock possible. There are two solutions, using a
3244e6f3faa7SPeter Zijlstra 	 * read-recursive acquire on the work(queue) 'locks', but this will then
3245f52be570SPeter Zijlstra 	 * hit the lockdep limitation on recursive locks, or simply discard
3246e6f3faa7SPeter Zijlstra 	 * these locks.
3247e6f3faa7SPeter Zijlstra 	 *
3248e6f3faa7SPeter Zijlstra 	 * AFAICT there is no possible deadlock scenario between the
3249e6f3faa7SPeter Zijlstra 	 * flush_work() and complete() primitives (except for single-threaded
3250e6f3faa7SPeter Zijlstra 	 * workqueues), so hiding them isn't a problem.
3251e6f3faa7SPeter Zijlstra 	 */
3252f52be570SPeter Zijlstra 	lockdep_invariant_state(true);
3253e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
3254a2c1c57bSTejun Heo 	worker->current_func(work);
3255e36c886aSArjan van de Ven 	/*
3256e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
3257e36c886aSArjan van de Ven 	 * point will only record its address.
3258e36c886aSArjan van de Ven 	 */
32591c5da0ecSDaniel Jordan 	trace_workqueue_execute_end(work, worker->current_func);
3260725e8ec5STejun Heo 	pwq->stats[PWQ_STAT_COMPLETED]++;
32613295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
3262*1acd92d9STejun Heo 	if (!bh_draining)
3263112202d9STejun Heo 		lock_map_release(&pwq->wq->lockdep_map);
32641da177e4SLinus Torvalds 
3265c35aea39STejun Heo 	if (unlikely((worker->task && in_atomic()) ||
3266c35aea39STejun Heo 		     lockdep_depth(current) != lockdep_start_depth ||
3267c35aea39STejun Heo 		     rcu_preempt_depth() != rcu_start_depth)) {
3268c35aea39STejun Heo 		pr_err("BUG: workqueue leaked atomic, lock or RCU: %s[%d]\n"
3269c35aea39STejun Heo 		       "     preempt=0x%08x lock=%d->%d RCU=%d->%d workfn=%ps\n",
3270c35aea39STejun Heo 		       current->comm, task_pid_nr(current), preempt_count(),
3271c35aea39STejun Heo 		       lockdep_start_depth, lockdep_depth(current),
3272c35aea39STejun Heo 		       rcu_start_depth, rcu_preempt_depth(),
3273c35aea39STejun Heo 		       worker->current_func);
3274d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
3275d5abe669SPeter Zijlstra 		dump_stack();
3276d5abe669SPeter Zijlstra 	}
3277d5abe669SPeter Zijlstra 
3278b22ce278STejun Heo 	/*
3279025f50f3SSebastian Andrzej Siewior 	 * The following prevents a kworker from hogging CPU on !PREEMPTION
3280b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
3281b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
3282b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
3283789cbbecSJoe Lawrence 	 * stop_machine. At the same time, report a quiescent RCU state so
3284789cbbecSJoe Lawrence 	 * the same condition doesn't freeze RCU.
3285b22ce278STejun Heo 	 */
32864cb1ef64STejun Heo 	if (worker->task)
3287a7e6425eSPaul E. McKenney 		cond_resched();
3288b22ce278STejun Heo 
3289a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3290a62428c0STejun Heo 
3291616db877STejun Heo 	/*
3292616db877STejun Heo 	 * In addition to %WQ_CPU_INTENSIVE, @worker may also have been marked
3293616db877STejun Heo 	 * CPU intensive by wq_worker_tick() if @work hogged CPU longer than
3294616db877STejun Heo 	 * wq_cpu_intensive_thresh_us. Clear it.
3295616db877STejun Heo 	 */
3296fb0e7bebSTejun Heo 	worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
3297fb0e7bebSTejun Heo 
32981b69ac6bSJohannes Weiner 	/* tag the worker for identification in schedule() */
32991b69ac6bSJohannes Weiner 	worker->last_func = worker->current_func;
33001b69ac6bSJohannes Weiner 
3301a62428c0STejun Heo 	/* we're done with it, release */
330242f8570fSSasha Levin 	hash_del(&worker->hentry);
3303c34056a3STejun Heo 	worker->current_work = NULL;
3304a2c1c57bSTejun Heo 	worker->current_func = NULL;
3305112202d9STejun Heo 	worker->current_pwq = NULL;
3306d812796eSLai Jiangshan 	worker->current_color = INT_MAX;
3307dd6c3c54STejun Heo 
3308dd6c3c54STejun Heo 	/* must be the last step, see the function comment */
3309c4560c2cSLai Jiangshan 	pwq_dec_nr_in_flight(pwq, work_data);
33101da177e4SLinus Torvalds }
33111da177e4SLinus Torvalds 
3312affee4b2STejun Heo /**
3313affee4b2STejun Heo  * process_scheduled_works - process scheduled works
3314affee4b2STejun Heo  * @worker: self
3315affee4b2STejun Heo  *
3316affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
3317affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
3318affee4b2STejun Heo  * fetches a work from the top and executes it.
3319affee4b2STejun Heo  *
3320affee4b2STejun Heo  * CONTEXT:
3321a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
3322affee4b2STejun Heo  * multiple times.
3323affee4b2STejun Heo  */
3324affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
33251da177e4SLinus Torvalds {
3326c0ab017dSTejun Heo 	struct work_struct *work;
3327c0ab017dSTejun Heo 	bool first = true;
3328c0ab017dSTejun Heo 
3329c0ab017dSTejun Heo 	while ((work = list_first_entry_or_null(&worker->scheduled,
3330c0ab017dSTejun Heo 						struct work_struct, entry))) {
3331c0ab017dSTejun Heo 		if (first) {
3332c0ab017dSTejun Heo 			worker->pool->watchdog_ts = jiffies;
3333c0ab017dSTejun Heo 			first = false;
3334c0ab017dSTejun Heo 		}
3335c34056a3STejun Heo 		process_one_work(worker, work);
3336a62428c0STejun Heo 	}
33371da177e4SLinus Torvalds }
33381da177e4SLinus Torvalds 
3339197f6accSTejun Heo static void set_pf_worker(bool val)
3340197f6accSTejun Heo {
3341197f6accSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
3342197f6accSTejun Heo 	if (val)
3343197f6accSTejun Heo 		current->flags |= PF_WQ_WORKER;
3344197f6accSTejun Heo 	else
3345197f6accSTejun Heo 		current->flags &= ~PF_WQ_WORKER;
3346197f6accSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
3347197f6accSTejun Heo }
3348197f6accSTejun Heo 
33494690c4abSTejun Heo /**
33504690c4abSTejun Heo  * worker_thread - the worker thread function
3351c34056a3STejun Heo  * @__worker: self
33524690c4abSTejun Heo  *
3353c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
3354c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
3355c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
3356c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
3357c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
3358d185af30SYacine Belkadi  *
3359d185af30SYacine Belkadi  * Return: 0
33604690c4abSTejun Heo  */
3361c34056a3STejun Heo static int worker_thread(void *__worker)
33621da177e4SLinus Torvalds {
3363c34056a3STejun Heo 	struct worker *worker = __worker;
3364bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
33651da177e4SLinus Torvalds 
3366e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
3367197f6accSTejun Heo 	set_pf_worker(true);
3368c8e55f36STejun Heo woke_up:
3369a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3370affee4b2STejun Heo 
3371a9ab775bSTejun Heo 	/* am I supposed to die? */
3372a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
3373a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
3374197f6accSTejun Heo 		set_pf_worker(false);
337560f5a4bcSLai Jiangshan 
337660f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
3377e441b56fSZhen Lei 		ida_free(&pool->worker_ida, worker->id);
3378a2d812a2STejun Heo 		worker_detach_from_pool(worker);
3379e02b9312SValentin Schneider 		WARN_ON_ONCE(!list_empty(&worker->entry));
338060f5a4bcSLai Jiangshan 		kfree(worker);
3381c8e55f36STejun Heo 		return 0;
3382c8e55f36STejun Heo 	}
3383c8e55f36STejun Heo 
3384c8e55f36STejun Heo 	worker_leave_idle(worker);
3385db7bccf4STejun Heo recheck:
3386e22bee78STejun Heo 	/* no more worker necessary? */
338763d95a91STejun Heo 	if (!need_more_worker(pool))
3388e22bee78STejun Heo 		goto sleep;
3389e22bee78STejun Heo 
3390e22bee78STejun Heo 	/* do we need to manage? */
339163d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
3392e22bee78STejun Heo 		goto recheck;
3393e22bee78STejun Heo 
3394c8e55f36STejun Heo 	/*
3395c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
3396c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
3397c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
3398c8e55f36STejun Heo 	 */
33996183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
3400c8e55f36STejun Heo 
3401e22bee78STejun Heo 	/*
3402a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
3403a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
3404a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
3405a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
3406a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
3407e22bee78STejun Heo 	 */
3408a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
3409e22bee78STejun Heo 
3410e22bee78STejun Heo 	do {
3411affee4b2STejun Heo 		struct work_struct *work =
3412bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
3413affee4b2STejun Heo 					 struct work_struct, entry);
3414affee4b2STejun Heo 
3415873eaca6STejun Heo 		if (assign_work(work, worker, NULL))
3416affee4b2STejun Heo 			process_scheduled_works(worker);
341763d95a91STejun Heo 	} while (keep_working(pool));
3418affee4b2STejun Heo 
3419228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
3420d313dd85STejun Heo sleep:
3421c8e55f36STejun Heo 	/*
3422d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
3423d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
3424d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
3425d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
3426d565ed63STejun Heo 	 * event.
3427c8e55f36STejun Heo 	 */
3428c8e55f36STejun Heo 	worker_enter_idle(worker);
3429c5a94a61SPeter Zijlstra 	__set_current_state(TASK_IDLE);
3430a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
34311da177e4SLinus Torvalds 	schedule();
3432c8e55f36STejun Heo 	goto woke_up;
34331da177e4SLinus Torvalds }
34341da177e4SLinus Torvalds 
3435e22bee78STejun Heo /**
3436e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
3437111c225aSTejun Heo  * @__rescuer: self
3438e22bee78STejun Heo  *
3439e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
3440493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
3441e22bee78STejun Heo  *
3442706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
3443e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
3444e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
3445e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
3446e22bee78STejun Heo  * the problem rescuer solves.
3447e22bee78STejun Heo  *
3448706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
3449706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
3450e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
3451e22bee78STejun Heo  *
3452e22bee78STejun Heo  * This should happen rarely.
3453d185af30SYacine Belkadi  *
3454d185af30SYacine Belkadi  * Return: 0
3455e22bee78STejun Heo  */
3456111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
3457e22bee78STejun Heo {
3458111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
3459111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
34604d595b86SLai Jiangshan 	bool should_stop;
3461e22bee78STejun Heo 
3462e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
3463111c225aSTejun Heo 
3464111c225aSTejun Heo 	/*
3465111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
3466111c225aSTejun Heo 	 * doesn't participate in concurrency management.
3467111c225aSTejun Heo 	 */
3468197f6accSTejun Heo 	set_pf_worker(true);
3469e22bee78STejun Heo repeat:
3470c5a94a61SPeter Zijlstra 	set_current_state(TASK_IDLE);
34711da177e4SLinus Torvalds 
34724d595b86SLai Jiangshan 	/*
34734d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
34744d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
34754d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
34764d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
34774d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
34784d595b86SLai Jiangshan 	 * list is always empty on exit.
34794d595b86SLai Jiangshan 	 */
34804d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
34811da177e4SLinus Torvalds 
3482493a1724STejun Heo 	/* see whether any pwq is asking for help */
3483a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&wq_mayday_lock);
3484493a1724STejun Heo 
3485493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
3486493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
3487493a1724STejun Heo 					struct pool_workqueue, mayday_node);
3488112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
3489e22bee78STejun Heo 		struct work_struct *work, *n;
3490e22bee78STejun Heo 
3491e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
3492493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
3493493a1724STejun Heo 
3494a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
3495e22bee78STejun Heo 
349651697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
349751697d39SLai Jiangshan 
3498a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
3499e22bee78STejun Heo 
3500e22bee78STejun Heo 		/*
3501e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
3502e22bee78STejun Heo 		 * process'em.
3503e22bee78STejun Heo 		 */
3504873eaca6STejun Heo 		WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
350582607adcSTejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry) {
3506873eaca6STejun Heo 			if (get_work_pwq(work) == pwq &&
3507873eaca6STejun Heo 			    assign_work(work, rescuer, &n))
3508725e8ec5STejun Heo 				pwq->stats[PWQ_STAT_RESCUED]++;
350982607adcSTejun Heo 		}
3510e22bee78STejun Heo 
3511873eaca6STejun Heo 		if (!list_empty(&rescuer->scheduled)) {
3512e22bee78STejun Heo 			process_scheduled_works(rescuer);
35137576958aSTejun Heo 
35147576958aSTejun Heo 			/*
3515008847f6SNeilBrown 			 * The above execution of rescued work items could
3516008847f6SNeilBrown 			 * have created more to rescue through
3517f97a4a1aSLai Jiangshan 			 * pwq_activate_first_inactive() or chained
3518008847f6SNeilBrown 			 * queueing.  Let's put @pwq back on mayday list so
3519008847f6SNeilBrown 			 * that such back-to-back work items, which may be
3520008847f6SNeilBrown 			 * being used to relieve memory pressure, don't
3521008847f6SNeilBrown 			 * incur MAYDAY_INTERVAL delay inbetween.
3522008847f6SNeilBrown 			 */
35234f3f4cf3SLai Jiangshan 			if (pwq->nr_active && need_to_create_worker(pool)) {
3524a9b8a985SSebastian Andrzej Siewior 				raw_spin_lock(&wq_mayday_lock);
3525e66b39afSTejun Heo 				/*
3526e66b39afSTejun Heo 				 * Queue iff we aren't racing destruction
3527e66b39afSTejun Heo 				 * and somebody else hasn't queued it already.
3528e66b39afSTejun Heo 				 */
3529e66b39afSTejun Heo 				if (wq->rescuer && list_empty(&pwq->mayday_node)) {
3530008847f6SNeilBrown 					get_pwq(pwq);
3531e66b39afSTejun Heo 					list_add_tail(&pwq->mayday_node, &wq->maydays);
3532e66b39afSTejun Heo 				}
3533a9b8a985SSebastian Andrzej Siewior 				raw_spin_unlock(&wq_mayday_lock);
3534008847f6SNeilBrown 			}
3535008847f6SNeilBrown 		}
3536008847f6SNeilBrown 
3537008847f6SNeilBrown 		/*
353877668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
353913b1d625SLai Jiangshan 		 * go away while we're still attached to it.
354077668c8bSLai Jiangshan 		 */
354177668c8bSLai Jiangshan 		put_pwq(pwq);
354277668c8bSLai Jiangshan 
354377668c8bSLai Jiangshan 		/*
35440219a352STejun Heo 		 * Leave this pool. Notify regular workers; otherwise, we end up
35450219a352STejun Heo 		 * with 0 concurrency and stalling the execution.
35467576958aSTejun Heo 		 */
35470219a352STejun Heo 		kick_pool(pool);
35487576958aSTejun Heo 
3549a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
355013b1d625SLai Jiangshan 
3551a2d812a2STejun Heo 		worker_detach_from_pool(rescuer);
355213b1d625SLai Jiangshan 
3553a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
35541da177e4SLinus Torvalds 	}
35551da177e4SLinus Torvalds 
3556a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&wq_mayday_lock);
3557493a1724STejun Heo 
35584d595b86SLai Jiangshan 	if (should_stop) {
35594d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
3560197f6accSTejun Heo 		set_pf_worker(false);
35614d595b86SLai Jiangshan 		return 0;
35624d595b86SLai Jiangshan 	}
35634d595b86SLai Jiangshan 
3564111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
3565111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
3566e22bee78STejun Heo 	schedule();
3567e22bee78STejun Heo 	goto repeat;
35681da177e4SLinus Torvalds }
35691da177e4SLinus Torvalds 
35704cb1ef64STejun Heo static void bh_worker(struct worker *worker)
35714cb1ef64STejun Heo {
35724cb1ef64STejun Heo 	struct worker_pool *pool = worker->pool;
35734cb1ef64STejun Heo 	int nr_restarts = BH_WORKER_RESTARTS;
35744cb1ef64STejun Heo 	unsigned long end = jiffies + BH_WORKER_JIFFIES;
35754cb1ef64STejun Heo 
35764cb1ef64STejun Heo 	raw_spin_lock_irq(&pool->lock);
35774cb1ef64STejun Heo 	worker_leave_idle(worker);
35784cb1ef64STejun Heo 
35794cb1ef64STejun Heo 	/*
35804cb1ef64STejun Heo 	 * This function follows the structure of worker_thread(). See there for
35814cb1ef64STejun Heo 	 * explanations on each step.
35824cb1ef64STejun Heo 	 */
35834cb1ef64STejun Heo 	if (!need_more_worker(pool))
35844cb1ef64STejun Heo 		goto done;
35854cb1ef64STejun Heo 
35864cb1ef64STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
35874cb1ef64STejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
35884cb1ef64STejun Heo 
35894cb1ef64STejun Heo 	do {
35904cb1ef64STejun Heo 		struct work_struct *work =
35914cb1ef64STejun Heo 			list_first_entry(&pool->worklist,
35924cb1ef64STejun Heo 					 struct work_struct, entry);
35934cb1ef64STejun Heo 
35944cb1ef64STejun Heo 		if (assign_work(work, worker, NULL))
35954cb1ef64STejun Heo 			process_scheduled_works(worker);
35964cb1ef64STejun Heo 	} while (keep_working(pool) &&
35974cb1ef64STejun Heo 		 --nr_restarts && time_before(jiffies, end));
35984cb1ef64STejun Heo 
35994cb1ef64STejun Heo 	worker_set_flags(worker, WORKER_PREP);
36004cb1ef64STejun Heo done:
36014cb1ef64STejun Heo 	worker_enter_idle(worker);
36024cb1ef64STejun Heo 	kick_pool(pool);
36034cb1ef64STejun Heo 	raw_spin_unlock_irq(&pool->lock);
36044cb1ef64STejun Heo }
36054cb1ef64STejun Heo 
36064cb1ef64STejun Heo /*
36074cb1ef64STejun Heo  * TODO: Convert all tasklet users to workqueue and use softirq directly.
36084cb1ef64STejun Heo  *
36094cb1ef64STejun Heo  * This is currently called from tasklet[_hi]action() and thus is also called
36104cb1ef64STejun Heo  * whenever there are tasklets to run. Let's do an early exit if there's nothing
36114cb1ef64STejun Heo  * queued. Once conversion from tasklet is complete, the need_more_worker() test
36124cb1ef64STejun Heo  * can be dropped.
36134cb1ef64STejun Heo  *
36144cb1ef64STejun Heo  * After full conversion, we'll add worker->softirq_action, directly use the
36154cb1ef64STejun Heo  * softirq action and obtain the worker pointer from the softirq_action pointer.
36164cb1ef64STejun Heo  */
36174cb1ef64STejun Heo void workqueue_softirq_action(bool highpri)
36184cb1ef64STejun Heo {
36194cb1ef64STejun Heo 	struct worker_pool *pool =
36204cb1ef64STejun Heo 		&per_cpu(bh_worker_pools, smp_processor_id())[highpri];
36214cb1ef64STejun Heo 	if (need_more_worker(pool))
36224cb1ef64STejun Heo 		bh_worker(list_first_entry(&pool->workers, struct worker, node));
36234cb1ef64STejun Heo }
36244cb1ef64STejun Heo 
3625*1acd92d9STejun Heo struct wq_drain_dead_softirq_work {
3626*1acd92d9STejun Heo 	struct work_struct	work;
3627*1acd92d9STejun Heo 	struct worker_pool	*pool;
3628*1acd92d9STejun Heo 	struct completion	done;
3629*1acd92d9STejun Heo };
3630*1acd92d9STejun Heo 
3631*1acd92d9STejun Heo static void drain_dead_softirq_workfn(struct work_struct *work)
3632*1acd92d9STejun Heo {
3633*1acd92d9STejun Heo 	struct wq_drain_dead_softirq_work *dead_work =
3634*1acd92d9STejun Heo 		container_of(work, struct wq_drain_dead_softirq_work, work);
3635*1acd92d9STejun Heo 	struct worker_pool *pool = dead_work->pool;
3636*1acd92d9STejun Heo 	bool repeat;
3637*1acd92d9STejun Heo 
3638*1acd92d9STejun Heo 	/*
3639*1acd92d9STejun Heo 	 * @pool's CPU is dead and we want to execute its still pending work
3640*1acd92d9STejun Heo 	 * items from this BH work item which is running on a different CPU. As
3641*1acd92d9STejun Heo 	 * its CPU is dead, @pool can't be kicked and, as work execution path
3642*1acd92d9STejun Heo 	 * will be nested, a lockdep annotation needs to be suppressed. Mark
3643*1acd92d9STejun Heo 	 * @pool with %POOL_BH_DRAINING for the special treatments.
3644*1acd92d9STejun Heo 	 */
3645*1acd92d9STejun Heo 	raw_spin_lock_irq(&pool->lock);
3646*1acd92d9STejun Heo 	pool->flags |= POOL_BH_DRAINING;
3647*1acd92d9STejun Heo 	raw_spin_unlock_irq(&pool->lock);
3648*1acd92d9STejun Heo 
3649*1acd92d9STejun Heo 	bh_worker(list_first_entry(&pool->workers, struct worker, node));
3650*1acd92d9STejun Heo 
3651*1acd92d9STejun Heo 	raw_spin_lock_irq(&pool->lock);
3652*1acd92d9STejun Heo 	pool->flags &= ~POOL_BH_DRAINING;
3653*1acd92d9STejun Heo 	repeat = need_more_worker(pool);
3654*1acd92d9STejun Heo 	raw_spin_unlock_irq(&pool->lock);
3655*1acd92d9STejun Heo 
3656*1acd92d9STejun Heo 	/*
3657*1acd92d9STejun Heo 	 * bh_worker() might hit consecutive execution limit and bail. If there
3658*1acd92d9STejun Heo 	 * still are pending work items, reschedule self and return so that we
3659*1acd92d9STejun Heo 	 * don't hog this CPU's BH.
3660*1acd92d9STejun Heo 	 */
3661*1acd92d9STejun Heo 	if (repeat) {
3662*1acd92d9STejun Heo 		if (pool->attrs->nice == HIGHPRI_NICE_LEVEL)
3663*1acd92d9STejun Heo 			queue_work(system_bh_highpri_wq, work);
3664*1acd92d9STejun Heo 		else
3665*1acd92d9STejun Heo 			queue_work(system_bh_wq, work);
3666*1acd92d9STejun Heo 	} else {
3667*1acd92d9STejun Heo 		complete(&dead_work->done);
3668*1acd92d9STejun Heo 	}
3669*1acd92d9STejun Heo }
3670*1acd92d9STejun Heo 
3671*1acd92d9STejun Heo /*
3672*1acd92d9STejun Heo  * @cpu is dead. Drain the remaining BH work items on the current CPU. It's
3673*1acd92d9STejun Heo  * possible to allocate dead_work per CPU and avoid flushing. However, then we
3674*1acd92d9STejun Heo  * have to worry about draining overlapping with CPU coming back online or
3675*1acd92d9STejun Heo  * nesting (one CPU's dead_work queued on another CPU which is also dead and so
3676*1acd92d9STejun Heo  * on). Let's keep it simple and drain them synchronously. These are BH work
3677*1acd92d9STejun Heo  * items which shouldn't be requeued on the same pool. Shouldn't take long.
3678*1acd92d9STejun Heo  */
3679*1acd92d9STejun Heo void workqueue_softirq_dead(unsigned int cpu)
3680*1acd92d9STejun Heo {
3681*1acd92d9STejun Heo 	int i;
3682*1acd92d9STejun Heo 
3683*1acd92d9STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
3684*1acd92d9STejun Heo 		struct worker_pool *pool = &per_cpu(bh_worker_pools, cpu)[i];
3685*1acd92d9STejun Heo 		struct wq_drain_dead_softirq_work dead_work;
3686*1acd92d9STejun Heo 
3687*1acd92d9STejun Heo 		if (!need_more_worker(pool))
3688*1acd92d9STejun Heo 			continue;
3689*1acd92d9STejun Heo 
3690*1acd92d9STejun Heo 		INIT_WORK(&dead_work.work, drain_dead_softirq_workfn);
3691*1acd92d9STejun Heo 		dead_work.pool = pool;
3692*1acd92d9STejun Heo 		init_completion(&dead_work.done);
3693*1acd92d9STejun Heo 
3694*1acd92d9STejun Heo 		if (pool->attrs->nice == HIGHPRI_NICE_LEVEL)
3695*1acd92d9STejun Heo 			queue_work(system_bh_highpri_wq, &dead_work.work);
3696*1acd92d9STejun Heo 		else
3697*1acd92d9STejun Heo 			queue_work(system_bh_wq, &dead_work.work);
3698*1acd92d9STejun Heo 
3699*1acd92d9STejun Heo 		wait_for_completion(&dead_work.done);
3700*1acd92d9STejun Heo 	}
3701*1acd92d9STejun Heo }
3702*1acd92d9STejun Heo 
3703fca839c0STejun Heo /**
3704fca839c0STejun Heo  * check_flush_dependency - check for flush dependency sanity
3705fca839c0STejun Heo  * @target_wq: workqueue being flushed
3706fca839c0STejun Heo  * @target_work: work item being flushed (NULL for workqueue flushes)
3707fca839c0STejun Heo  *
3708fca839c0STejun Heo  * %current is trying to flush the whole @target_wq or @target_work on it.
3709fca839c0STejun Heo  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
3710fca839c0STejun Heo  * reclaiming memory or running on a workqueue which doesn't have
3711fca839c0STejun Heo  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
3712fca839c0STejun Heo  * a deadlock.
3713fca839c0STejun Heo  */
3714fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq,
3715fca839c0STejun Heo 				   struct work_struct *target_work)
3716fca839c0STejun Heo {
3717fca839c0STejun Heo 	work_func_t target_func = target_work ? target_work->func : NULL;
3718fca839c0STejun Heo 	struct worker *worker;
3719fca839c0STejun Heo 
3720fca839c0STejun Heo 	if (target_wq->flags & WQ_MEM_RECLAIM)
3721fca839c0STejun Heo 		return;
3722fca839c0STejun Heo 
3723fca839c0STejun Heo 	worker = current_wq_worker();
3724fca839c0STejun Heo 
3725fca839c0STejun Heo 	WARN_ONCE(current->flags & PF_MEMALLOC,
3726d75f773cSSakari Ailus 		  "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
3727fca839c0STejun Heo 		  current->pid, current->comm, target_wq->name, target_func);
372823d11a58STejun Heo 	WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
372923d11a58STejun Heo 			      (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
3730d75f773cSSakari Ailus 		  "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
3731fca839c0STejun Heo 		  worker->current_pwq->wq->name, worker->current_func,
3732fca839c0STejun Heo 		  target_wq->name, target_func);
3733fca839c0STejun Heo }
3734fca839c0STejun Heo 
3735fc2e4d70SOleg Nesterov struct wq_barrier {
3736fc2e4d70SOleg Nesterov 	struct work_struct	work;
3737fc2e4d70SOleg Nesterov 	struct completion	done;
37382607d7a6STejun Heo 	struct task_struct	*task;	/* purely informational */
3739fc2e4d70SOleg Nesterov };
3740fc2e4d70SOleg Nesterov 
3741fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
3742fc2e4d70SOleg Nesterov {
3743fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
3744fc2e4d70SOleg Nesterov 	complete(&barr->done);
3745fc2e4d70SOleg Nesterov }
3746fc2e4d70SOleg Nesterov 
37474690c4abSTejun Heo /**
37484690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
3749112202d9STejun Heo  * @pwq: pwq to insert barrier into
37504690c4abSTejun Heo  * @barr: wq_barrier to insert
3751affee4b2STejun Heo  * @target: target work to attach @barr to
3752affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
37534690c4abSTejun Heo  *
3754affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
3755affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
3756affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
3757affee4b2STejun Heo  * cpu.
3758affee4b2STejun Heo  *
3759affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
3760affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
3761affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
3762affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
3763affee4b2STejun Heo  * after a work with LINKED flag set.
3764affee4b2STejun Heo  *
3765affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
3766112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
37674690c4abSTejun Heo  *
37684690c4abSTejun Heo  * CONTEXT:
3769a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
37704690c4abSTejun Heo  */
3771112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
3772affee4b2STejun Heo 			      struct wq_barrier *barr,
3773affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
3774fc2e4d70SOleg Nesterov {
37754cb1ef64STejun Heo 	static __maybe_unused struct lock_class_key bh_key, thr_key;
3776d812796eSLai Jiangshan 	unsigned int work_flags = 0;
3777d812796eSLai Jiangshan 	unsigned int work_color;
3778affee4b2STejun Heo 	struct list_head *head;
3779affee4b2STejun Heo 
3780dc186ad7SThomas Gleixner 	/*
3781d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
3782dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
3783dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
3784dc186ad7SThomas Gleixner 	 * might deadlock.
37854cb1ef64STejun Heo 	 *
37864cb1ef64STejun Heo 	 * BH and threaded workqueues need separate lockdep keys to avoid
37874cb1ef64STejun Heo 	 * spuriously triggering "inconsistent {SOFTIRQ-ON-W} -> {IN-SOFTIRQ-W}
37884cb1ef64STejun Heo 	 * usage".
3789dc186ad7SThomas Gleixner 	 */
37904cb1ef64STejun Heo 	INIT_WORK_ONSTACK_KEY(&barr->work, wq_barrier_func,
37914cb1ef64STejun Heo 			      (pwq->wq->flags & WQ_BH) ? &bh_key : &thr_key);
379222df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
379352fa5bc5SBoqun Feng 
3794fd1a5b04SByungchul Park 	init_completion_map(&barr->done, &target->lockdep_map);
3795fd1a5b04SByungchul Park 
37962607d7a6STejun Heo 	barr->task = current;
379783c22520SOleg Nesterov 
37985797b1c1STejun Heo 	/* The barrier work item does not participate in nr_active. */
3799018f3a13SLai Jiangshan 	work_flags |= WORK_STRUCT_INACTIVE;
3800018f3a13SLai Jiangshan 
3801affee4b2STejun Heo 	/*
3802affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
3803affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
3804affee4b2STejun Heo 	 */
3805d812796eSLai Jiangshan 	if (worker) {
3806affee4b2STejun Heo 		head = worker->scheduled.next;
3807d812796eSLai Jiangshan 		work_color = worker->current_color;
3808d812796eSLai Jiangshan 	} else {
3809affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
3810affee4b2STejun Heo 
3811affee4b2STejun Heo 		head = target->entry.next;
3812affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
3813d21cece0SLai Jiangshan 		work_flags |= *bits & WORK_STRUCT_LINKED;
3814d812796eSLai Jiangshan 		work_color = get_work_color(*bits);
3815affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
3816affee4b2STejun Heo 	}
3817affee4b2STejun Heo 
3818d812796eSLai Jiangshan 	pwq->nr_in_flight[work_color]++;
3819d812796eSLai Jiangshan 	work_flags |= work_color_to_flags(work_color);
3820d812796eSLai Jiangshan 
3821d21cece0SLai Jiangshan 	insert_work(pwq, &barr->work, head, work_flags);
3822fc2e4d70SOleg Nesterov }
3823fc2e4d70SOleg Nesterov 
382473f53c4aSTejun Heo /**
3825112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
382673f53c4aSTejun Heo  * @wq: workqueue being flushed
382773f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
382873f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
382973f53c4aSTejun Heo  *
3830112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
383173f53c4aSTejun Heo  *
3832112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
3833112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
3834112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
3835112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
3836112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
383773f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
383873f53c4aSTejun Heo  *
383973f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
384073f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
384173f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
384273f53c4aSTejun Heo  * is returned.
384373f53c4aSTejun Heo  *
3844112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
384573f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
384673f53c4aSTejun Heo  * advanced to @work_color.
384773f53c4aSTejun Heo  *
384873f53c4aSTejun Heo  * CONTEXT:
38493c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
385073f53c4aSTejun Heo  *
3851d185af30SYacine Belkadi  * Return:
385273f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
385373f53c4aSTejun Heo  * otherwise.
385473f53c4aSTejun Heo  */
3855112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
385673f53c4aSTejun Heo 				      int flush_color, int work_color)
38571da177e4SLinus Torvalds {
385873f53c4aSTejun Heo 	bool wait = false;
385949e3cf44STejun Heo 	struct pool_workqueue *pwq;
38601da177e4SLinus Torvalds 
386173f53c4aSTejun Heo 	if (flush_color >= 0) {
38626183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
3863112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
3864dc186ad7SThomas Gleixner 	}
386514441960SOleg Nesterov 
386649e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3867112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
38681da177e4SLinus Torvalds 
3869a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
387073f53c4aSTejun Heo 
387173f53c4aSTejun Heo 		if (flush_color >= 0) {
38726183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
387373f53c4aSTejun Heo 
3874112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
3875112202d9STejun Heo 				pwq->flush_color = flush_color;
3876112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
387773f53c4aSTejun Heo 				wait = true;
38781da177e4SLinus Torvalds 			}
387973f53c4aSTejun Heo 		}
388073f53c4aSTejun Heo 
388173f53c4aSTejun Heo 		if (work_color >= 0) {
38826183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
3883112202d9STejun Heo 			pwq->work_color = work_color;
388473f53c4aSTejun Heo 		}
388573f53c4aSTejun Heo 
3886a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
38871da177e4SLinus Torvalds 	}
38881da177e4SLinus Torvalds 
3889112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
389073f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
389173f53c4aSTejun Heo 
389273f53c4aSTejun Heo 	return wait;
389383c22520SOleg Nesterov }
38941da177e4SLinus Torvalds 
3895c35aea39STejun Heo static void touch_wq_lockdep_map(struct workqueue_struct *wq)
3896c35aea39STejun Heo {
38974cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP
38984cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
38994cb1ef64STejun Heo 		local_bh_disable();
39004cb1ef64STejun Heo 
3901c35aea39STejun Heo 	lock_map_acquire(&wq->lockdep_map);
3902c35aea39STejun Heo 	lock_map_release(&wq->lockdep_map);
39034cb1ef64STejun Heo 
39044cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
39054cb1ef64STejun Heo 		local_bh_enable();
39064cb1ef64STejun Heo #endif
3907c35aea39STejun Heo }
3908c35aea39STejun Heo 
3909c35aea39STejun Heo static void touch_work_lockdep_map(struct work_struct *work,
3910c35aea39STejun Heo 				   struct workqueue_struct *wq)
3911c35aea39STejun Heo {
39124cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP
39134cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
39144cb1ef64STejun Heo 		local_bh_disable();
39154cb1ef64STejun Heo 
3916c35aea39STejun Heo 	lock_map_acquire(&work->lockdep_map);
3917c35aea39STejun Heo 	lock_map_release(&work->lockdep_map);
39184cb1ef64STejun Heo 
39194cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
39204cb1ef64STejun Heo 		local_bh_enable();
39214cb1ef64STejun Heo #endif
3922c35aea39STejun Heo }
3923c35aea39STejun Heo 
39240fcb78c2SRolf Eike Beer /**
3925c4f135d6STetsuo Handa  * __flush_workqueue - ensure that any scheduled work has run to completion.
39260fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
39271da177e4SLinus Torvalds  *
3928c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
3929c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
39301da177e4SLinus Torvalds  */
3931c4f135d6STetsuo Handa void __flush_workqueue(struct workqueue_struct *wq)
39321da177e4SLinus Torvalds {
393373f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
393473f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
393573f53c4aSTejun Heo 		.flush_color = -1,
3936fd1a5b04SByungchul Park 		.done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
393773f53c4aSTejun Heo 	};
393873f53c4aSTejun Heo 	int next_color;
3939b1f4ec17SOleg Nesterov 
39403347fa09STejun Heo 	if (WARN_ON(!wq_online))
39413347fa09STejun Heo 		return;
39423347fa09STejun Heo 
3943c35aea39STejun Heo 	touch_wq_lockdep_map(wq);
394487915adcSJohannes Berg 
39453c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
394673f53c4aSTejun Heo 
394773f53c4aSTejun Heo 	/*
394873f53c4aSTejun Heo 	 * Start-to-wait phase
394973f53c4aSTejun Heo 	 */
395073f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
395173f53c4aSTejun Heo 
395273f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
395373f53c4aSTejun Heo 		/*
395473f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
395573f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
395673f53c4aSTejun Heo 		 * by one.
395773f53c4aSTejun Heo 		 */
39586183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
395973f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
396073f53c4aSTejun Heo 		wq->work_color = next_color;
396173f53c4aSTejun Heo 
396273f53c4aSTejun Heo 		if (!wq->first_flusher) {
396373f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
39646183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
396573f53c4aSTejun Heo 
396673f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
396773f53c4aSTejun Heo 
3968112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
396973f53c4aSTejun Heo 						       wq->work_color)) {
397073f53c4aSTejun Heo 				/* nothing to flush, done */
397173f53c4aSTejun Heo 				wq->flush_color = next_color;
397273f53c4aSTejun Heo 				wq->first_flusher = NULL;
397373f53c4aSTejun Heo 				goto out_unlock;
397473f53c4aSTejun Heo 			}
397573f53c4aSTejun Heo 		} else {
397673f53c4aSTejun Heo 			/* wait in queue */
39776183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
397873f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
3979112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
398073f53c4aSTejun Heo 		}
398173f53c4aSTejun Heo 	} else {
398273f53c4aSTejun Heo 		/*
398373f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
398473f53c4aSTejun Heo 		 * The next flush completion will assign us
398573f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
398673f53c4aSTejun Heo 		 */
398773f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
398873f53c4aSTejun Heo 	}
398973f53c4aSTejun Heo 
3990fca839c0STejun Heo 	check_flush_dependency(wq, NULL);
3991fca839c0STejun Heo 
39923c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
399373f53c4aSTejun Heo 
399473f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
399573f53c4aSTejun Heo 
399673f53c4aSTejun Heo 	/*
399773f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
399873f53c4aSTejun Heo 	 *
399973f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
400073f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
400173f53c4aSTejun Heo 	 */
400200d5d15bSChris Wilson 	if (READ_ONCE(wq->first_flusher) != &this_flusher)
400373f53c4aSTejun Heo 		return;
400473f53c4aSTejun Heo 
40053c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
400673f53c4aSTejun Heo 
40074ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
40084ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
40094ce48b37STejun Heo 		goto out_unlock;
40104ce48b37STejun Heo 
401100d5d15bSChris Wilson 	WRITE_ONCE(wq->first_flusher, NULL);
401273f53c4aSTejun Heo 
40136183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
40146183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
401573f53c4aSTejun Heo 
401673f53c4aSTejun Heo 	while (true) {
401773f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
401873f53c4aSTejun Heo 
401973f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
402073f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
402173f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
402273f53c4aSTejun Heo 				break;
402373f53c4aSTejun Heo 			list_del_init(&next->list);
402473f53c4aSTejun Heo 			complete(&next->done);
402573f53c4aSTejun Heo 		}
402673f53c4aSTejun Heo 
40276183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
402873f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
402973f53c4aSTejun Heo 
403073f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
403173f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
403273f53c4aSTejun Heo 
403373f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
403473f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
403573f53c4aSTejun Heo 			/*
403673f53c4aSTejun Heo 			 * Assign the same color to all overflowed
403773f53c4aSTejun Heo 			 * flushers, advance work_color and append to
403873f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
403973f53c4aSTejun Heo 			 * phase for these overflowed flushers.
404073f53c4aSTejun Heo 			 */
404173f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
404273f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
404373f53c4aSTejun Heo 
404473f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
404573f53c4aSTejun Heo 
404673f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
404773f53c4aSTejun Heo 					      &wq->flusher_queue);
4048112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
404973f53c4aSTejun Heo 		}
405073f53c4aSTejun Heo 
405173f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
40526183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
405373f53c4aSTejun Heo 			break;
405473f53c4aSTejun Heo 		}
405573f53c4aSTejun Heo 
405673f53c4aSTejun Heo 		/*
405773f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
4058112202d9STejun Heo 		 * the new first flusher and arm pwqs.
405973f53c4aSTejun Heo 		 */
40606183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
40616183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
406273f53c4aSTejun Heo 
406373f53c4aSTejun Heo 		list_del_init(&next->list);
406473f53c4aSTejun Heo 		wq->first_flusher = next;
406573f53c4aSTejun Heo 
4066112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
406773f53c4aSTejun Heo 			break;
406873f53c4aSTejun Heo 
406973f53c4aSTejun Heo 		/*
407073f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
407173f53c4aSTejun Heo 		 * flusher and repeat cascading.
407273f53c4aSTejun Heo 		 */
407373f53c4aSTejun Heo 		wq->first_flusher = NULL;
407473f53c4aSTejun Heo 	}
407573f53c4aSTejun Heo 
407673f53c4aSTejun Heo out_unlock:
40773c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
40781da177e4SLinus Torvalds }
4079c4f135d6STetsuo Handa EXPORT_SYMBOL(__flush_workqueue);
40801da177e4SLinus Torvalds 
40819c5a2ba7STejun Heo /**
40829c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
40839c5a2ba7STejun Heo  * @wq: workqueue to drain
40849c5a2ba7STejun Heo  *
40859c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
40869c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
40879c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
4088b749b1b6SChen Hanxiao  * repeatedly until it becomes empty.  The number of flushing is determined
40899c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
40909c5a2ba7STejun Heo  * takes too long.
40919c5a2ba7STejun Heo  */
40929c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
40939c5a2ba7STejun Heo {
40949c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
409549e3cf44STejun Heo 	struct pool_workqueue *pwq;
40969c5a2ba7STejun Heo 
40979c5a2ba7STejun Heo 	/*
40989c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
40999c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
4100618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
41019c5a2ba7STejun Heo 	 */
410287fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
41039c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
4104618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
410587fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
41069c5a2ba7STejun Heo reflush:
4107c4f135d6STetsuo Handa 	__flush_workqueue(wq);
41089c5a2ba7STejun Heo 
4109b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
411076af4d93STejun Heo 
411149e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
4112fa2563e4SThomas Tuttle 		bool drained;
41139c5a2ba7STejun Heo 
4114a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
4115afa87ce8STejun Heo 		drained = pwq_is_empty(pwq);
4116a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
4117fa2563e4SThomas Tuttle 
4118fa2563e4SThomas Tuttle 		if (drained)
41199c5a2ba7STejun Heo 			continue;
41209c5a2ba7STejun Heo 
41219c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
41229c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
4123e9ad2eb3SStephen Zhang 			pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
4124e9ad2eb3SStephen Zhang 				wq->name, __func__, flush_cnt);
412576af4d93STejun Heo 
4126b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
41279c5a2ba7STejun Heo 		goto reflush;
41289c5a2ba7STejun Heo 	}
41299c5a2ba7STejun Heo 
41309c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
4131618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
413287fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
41339c5a2ba7STejun Heo }
41349c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
41359c5a2ba7STejun Heo 
4136d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
4137d6e89786SJohannes Berg 			     bool from_cancel)
4138baf59022STejun Heo {
4139baf59022STejun Heo 	struct worker *worker = NULL;
4140c9e7cf27STejun Heo 	struct worker_pool *pool;
4141112202d9STejun Heo 	struct pool_workqueue *pwq;
4142c35aea39STejun Heo 	struct workqueue_struct *wq;
4143baf59022STejun Heo 
4144baf59022STejun Heo 	might_sleep();
4145baf59022STejun Heo 
414624acfb71SThomas Gleixner 	rcu_read_lock();
4147fa1b54e6STejun Heo 	pool = get_work_pool(work);
4148fa1b54e6STejun Heo 	if (!pool) {
414924acfb71SThomas Gleixner 		rcu_read_unlock();
4150fa1b54e6STejun Heo 		return false;
4151fa1b54e6STejun Heo 	}
4152fa1b54e6STejun Heo 
4153a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
41540b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
4155112202d9STejun Heo 	pwq = get_work_pwq(work);
4156112202d9STejun Heo 	if (pwq) {
4157112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
4158baf59022STejun Heo 			goto already_gone;
4159606a5020STejun Heo 	} else {
4160c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
4161baf59022STejun Heo 		if (!worker)
4162baf59022STejun Heo 			goto already_gone;
4163112202d9STejun Heo 		pwq = worker->current_pwq;
4164606a5020STejun Heo 	}
4165baf59022STejun Heo 
4166c35aea39STejun Heo 	wq = pwq->wq;
4167c35aea39STejun Heo 	check_flush_dependency(wq, work);
4168fca839c0STejun Heo 
4169112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
4170a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
4171baf59022STejun Heo 
4172c35aea39STejun Heo 	touch_work_lockdep_map(work, wq);
4173c35aea39STejun Heo 
4174e159489bSTejun Heo 	/*
4175a1d14934SPeter Zijlstra 	 * Force a lock recursion deadlock when using flush_work() inside a
4176a1d14934SPeter Zijlstra 	 * single-threaded or rescuer equipped workqueue.
4177a1d14934SPeter Zijlstra 	 *
4178a1d14934SPeter Zijlstra 	 * For single threaded workqueues the deadlock happens when the work
4179a1d14934SPeter Zijlstra 	 * is after the work issuing the flush_work(). For rescuer equipped
4180a1d14934SPeter Zijlstra 	 * workqueues the deadlock happens when the rescuer stalls, blocking
4181a1d14934SPeter Zijlstra 	 * forward progress.
4182e159489bSTejun Heo 	 */
4183c35aea39STejun Heo 	if (!from_cancel && (wq->saved_max_active == 1 || wq->rescuer))
4184c35aea39STejun Heo 		touch_wq_lockdep_map(wq);
4185c35aea39STejun Heo 
418624acfb71SThomas Gleixner 	rcu_read_unlock();
4187baf59022STejun Heo 	return true;
4188baf59022STejun Heo already_gone:
4189a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
419024acfb71SThomas Gleixner 	rcu_read_unlock();
4191baf59022STejun Heo 	return false;
4192baf59022STejun Heo }
4193baf59022STejun Heo 
4194d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel)
4195d6e89786SJohannes Berg {
4196d6e89786SJohannes Berg 	struct wq_barrier barr;
4197d6e89786SJohannes Berg 
4198d6e89786SJohannes Berg 	if (WARN_ON(!wq_online))
4199d6e89786SJohannes Berg 		return false;
4200d6e89786SJohannes Berg 
42014d43d395STetsuo Handa 	if (WARN_ON(!work->func))
42024d43d395STetsuo Handa 		return false;
42034d43d395STetsuo Handa 
4204d6e89786SJohannes Berg 	if (start_flush_work(work, &barr, from_cancel)) {
4205d6e89786SJohannes Berg 		wait_for_completion(&barr.done);
4206d6e89786SJohannes Berg 		destroy_work_on_stack(&barr.work);
4207d6e89786SJohannes Berg 		return true;
4208d6e89786SJohannes Berg 	} else {
4209d6e89786SJohannes Berg 		return false;
4210d6e89786SJohannes Berg 	}
4211d6e89786SJohannes Berg }
4212d6e89786SJohannes Berg 
4213db700897SOleg Nesterov /**
4214401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
4215401a8d04STejun Heo  * @work: the work to flush
4216db700897SOleg Nesterov  *
4217606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
4218606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
4219401a8d04STejun Heo  *
4220d185af30SYacine Belkadi  * Return:
4221401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
4222401a8d04STejun Heo  * %false if it was already idle.
4223db700897SOleg Nesterov  */
4224401a8d04STejun Heo bool flush_work(struct work_struct *work)
4225db700897SOleg Nesterov {
4226d6e89786SJohannes Berg 	return __flush_work(work, false);
4227606a5020STejun Heo }
4228db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
4229db700897SOleg Nesterov 
4230cdc6e4b3STejun Heo /**
4231cdc6e4b3STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
4232cdc6e4b3STejun Heo  * @dwork: the delayed work to flush
4233cdc6e4b3STejun Heo  *
4234cdc6e4b3STejun Heo  * Delayed timer is cancelled and the pending work is queued for
4235cdc6e4b3STejun Heo  * immediate execution.  Like flush_work(), this function only
4236cdc6e4b3STejun Heo  * considers the last queueing instance of @dwork.
4237cdc6e4b3STejun Heo  *
4238cdc6e4b3STejun Heo  * Return:
4239cdc6e4b3STejun Heo  * %true if flush_work() waited for the work to finish execution,
4240cdc6e4b3STejun Heo  * %false if it was already idle.
4241cdc6e4b3STejun Heo  */
4242cdc6e4b3STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
4243cdc6e4b3STejun Heo {
4244cdc6e4b3STejun Heo 	local_irq_disable();
4245cdc6e4b3STejun Heo 	if (del_timer_sync(&dwork->timer))
4246cdc6e4b3STejun Heo 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
4247cdc6e4b3STejun Heo 	local_irq_enable();
4248cdc6e4b3STejun Heo 	return flush_work(&dwork->work);
4249cdc6e4b3STejun Heo }
4250cdc6e4b3STejun Heo EXPORT_SYMBOL(flush_delayed_work);
4251cdc6e4b3STejun Heo 
4252cdc6e4b3STejun Heo /**
4253cdc6e4b3STejun Heo  * flush_rcu_work - wait for a rwork to finish executing the last queueing
4254cdc6e4b3STejun Heo  * @rwork: the rcu work to flush
4255cdc6e4b3STejun Heo  *
4256cdc6e4b3STejun Heo  * Return:
4257cdc6e4b3STejun Heo  * %true if flush_rcu_work() waited for the work to finish execution,
4258cdc6e4b3STejun Heo  * %false if it was already idle.
4259cdc6e4b3STejun Heo  */
4260cdc6e4b3STejun Heo bool flush_rcu_work(struct rcu_work *rwork)
4261cdc6e4b3STejun Heo {
4262cdc6e4b3STejun Heo 	if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
4263cdc6e4b3STejun Heo 		rcu_barrier();
4264cdc6e4b3STejun Heo 		flush_work(&rwork->work);
4265cdc6e4b3STejun Heo 		return true;
4266cdc6e4b3STejun Heo 	} else {
4267cdc6e4b3STejun Heo 		return flush_work(&rwork->work);
4268cdc6e4b3STejun Heo 	}
4269cdc6e4b3STejun Heo }
4270cdc6e4b3STejun Heo EXPORT_SYMBOL(flush_rcu_work);
4271cdc6e4b3STejun Heo 
4272c5f5b942STejun Heo static bool __cancel_work(struct work_struct *work, u32 cflags)
4273cdc6e4b3STejun Heo {
4274c26e2f2eSTejun Heo 	unsigned long irq_flags;
4275cdc6e4b3STejun Heo 	int ret;
4276cdc6e4b3STejun Heo 
4277cdc6e4b3STejun Heo 	do {
4278c5f5b942STejun Heo 		ret = try_to_grab_pending(work, cflags, &irq_flags);
4279cdc6e4b3STejun Heo 	} while (unlikely(ret == -EAGAIN));
4280cdc6e4b3STejun Heo 
4281cdc6e4b3STejun Heo 	if (unlikely(ret < 0))
4282cdc6e4b3STejun Heo 		return false;
4283cdc6e4b3STejun Heo 
4284bccdc1faSTejun Heo 	set_work_pool_and_clear_pending(work, get_work_pool_id(work), 0);
4285c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
4286cdc6e4b3STejun Heo 	return ret;
4287cdc6e4b3STejun Heo }
4288cdc6e4b3STejun Heo 
4289c5f5b942STejun Heo static bool __cancel_work_sync(struct work_struct *work, u32 cflags)
4290401a8d04STejun Heo {
4291c26e2f2eSTejun Heo 	unsigned long irq_flags;
4292978b8409STejun Heo 	bool ret;
42931f1f642eSOleg Nesterov 
4294978b8409STejun Heo 	/* claim @work and tell other tasks trying to grab @work to back off */
4295978b8409STejun Heo 	ret = work_grab_pending(work, cflags, &irq_flags);
4296bbb68dfaSTejun Heo 	mark_work_canceling(work);
4297c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
4298bbb68dfaSTejun Heo 
42993347fa09STejun Heo 	/*
4300c7a40c49STejun Heo 	 * Skip __flush_work() during early boot when we know that @work isn't
4301c7a40c49STejun Heo 	 * executing. This allows canceling during early boot.
43023347fa09STejun Heo 	 */
43033347fa09STejun Heo 	if (wq_online)
4304d6e89786SJohannes Berg 		__flush_work(work, true);
43053347fa09STejun Heo 
43068603e1b3STejun Heo 	/*
4307afe928c1STejun Heo 	 * smp_mb() at the end of set_work_pool_and_clear_pending() is paired
4308afe928c1STejun Heo 	 * with prepare_to_wait() above so that either waitqueue_active() is
4309afe928c1STejun Heo 	 * visible here or !work_is_canceling() is visible there.
43108603e1b3STejun Heo 	 */
4311bccdc1faSTejun Heo 	set_work_pool_and_clear_pending(work, WORK_OFFQ_POOL_NONE, 0);
4312afe928c1STejun Heo 
4313978b8409STejun Heo 	if (waitqueue_active(&wq_cancel_waitq))
4314978b8409STejun Heo 		__wake_up(&wq_cancel_waitq, TASK_NORMAL, 1, work);
43158603e1b3STejun Heo 
43161f1f642eSOleg Nesterov 	return ret;
43171f1f642eSOleg Nesterov }
43181f1f642eSOleg Nesterov 
4319cdc6e4b3STejun Heo /*
4320cdc6e4b3STejun Heo  * See cancel_delayed_work()
4321cdc6e4b3STejun Heo  */
4322cdc6e4b3STejun Heo bool cancel_work(struct work_struct *work)
4323cdc6e4b3STejun Heo {
4324c5f5b942STejun Heo 	return __cancel_work(work, 0);
4325cdc6e4b3STejun Heo }
4326cdc6e4b3STejun Heo EXPORT_SYMBOL(cancel_work);
4327cdc6e4b3STejun Heo 
43286e84d644SOleg Nesterov /**
4329401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
4330401a8d04STejun Heo  * @work: the work to cancel
43316e84d644SOleg Nesterov  *
4332401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
4333401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
4334401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
4335401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
43361f1f642eSOleg Nesterov  *
4337401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
4338401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
43396e84d644SOleg Nesterov  *
4340401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
43416e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
4342401a8d04STejun Heo  *
4343d185af30SYacine Belkadi  * Return:
4344401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
43456e84d644SOleg Nesterov  */
4346401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
43476e84d644SOleg Nesterov {
4348c5f5b942STejun Heo 	return __cancel_work_sync(work, 0);
4349b89deed3SOleg Nesterov }
435028e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
4351b89deed3SOleg Nesterov 
43526e84d644SOleg Nesterov /**
435357b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
435457b30ae7STejun Heo  * @dwork: delayed_work to cancel
435509383498STejun Heo  *
4356d185af30SYacine Belkadi  * Kill off a pending delayed_work.
4357d185af30SYacine Belkadi  *
4358d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
4359d185af30SYacine Belkadi  * pending.
4360d185af30SYacine Belkadi  *
4361d185af30SYacine Belkadi  * Note:
4362d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
4363d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
4364d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
436509383498STejun Heo  *
436657b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
436709383498STejun Heo  */
436857b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
436909383498STejun Heo {
4370c5f5b942STejun Heo 	return __cancel_work(&dwork->work, WORK_CANCEL_DELAYED);
437109383498STejun Heo }
437257b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
437309383498STejun Heo 
437409383498STejun Heo /**
4375401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
4376401a8d04STejun Heo  * @dwork: the delayed work cancel
4377401a8d04STejun Heo  *
4378401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
4379401a8d04STejun Heo  *
4380d185af30SYacine Belkadi  * Return:
4381401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
4382401a8d04STejun Heo  */
4383401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
43846e84d644SOleg Nesterov {
4385c5f5b942STejun Heo 	return __cancel_work_sync(&dwork->work, WORK_CANCEL_DELAYED);
43866e84d644SOleg Nesterov }
4387f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
43881da177e4SLinus Torvalds 
43890fcb78c2SRolf Eike Beer /**
439031ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
4391b6136773SAndrew Morton  * @func: the function to call
4392b6136773SAndrew Morton  *
439331ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
439431ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
4395b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
439631ddd871STejun Heo  *
4397d185af30SYacine Belkadi  * Return:
439831ddd871STejun Heo  * 0 on success, -errno on failure.
4399b6136773SAndrew Morton  */
440065f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
440115316ba8SChristoph Lameter {
440215316ba8SChristoph Lameter 	int cpu;
440338f51568SNamhyung Kim 	struct work_struct __percpu *works;
440415316ba8SChristoph Lameter 
4405b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
4406b6136773SAndrew Morton 	if (!works)
440715316ba8SChristoph Lameter 		return -ENOMEM;
4408b6136773SAndrew Morton 
4409ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
441093981800STejun Heo 
441115316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
44129bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
44139bfb1839SIngo Molnar 
44149bfb1839SIngo Molnar 		INIT_WORK(work, func);
44158de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
441615316ba8SChristoph Lameter 	}
441793981800STejun Heo 
441893981800STejun Heo 	for_each_online_cpu(cpu)
44198616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
442093981800STejun Heo 
4421ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
4422b6136773SAndrew Morton 	free_percpu(works);
442315316ba8SChristoph Lameter 	return 0;
442415316ba8SChristoph Lameter }
442515316ba8SChristoph Lameter 
4426eef6a7d5SAlan Stern /**
44271fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
44281fa44ecaSJames Bottomley  * @fn:		the function to execute
44291fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
44301fa44ecaSJames Bottomley  *		be available when the work executes)
44311fa44ecaSJames Bottomley  *
44321fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
44331fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
44341fa44ecaSJames Bottomley  *
4435d185af30SYacine Belkadi  * Return:	0 - function was executed
44361fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
44371fa44ecaSJames Bottomley  */
443865f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
44391fa44ecaSJames Bottomley {
44401fa44ecaSJames Bottomley 	if (!in_interrupt()) {
444165f27f38SDavid Howells 		fn(&ew->work);
44421fa44ecaSJames Bottomley 		return 0;
44431fa44ecaSJames Bottomley 	}
44441fa44ecaSJames Bottomley 
444565f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
44461fa44ecaSJames Bottomley 	schedule_work(&ew->work);
44471fa44ecaSJames Bottomley 
44481fa44ecaSJames Bottomley 	return 1;
44491fa44ecaSJames Bottomley }
44501fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
44511fa44ecaSJames Bottomley 
44527a4e344cSTejun Heo /**
44537a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
44547a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
44557a4e344cSTejun Heo  *
44567a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
44577a4e344cSTejun Heo  */
4458513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs)
44597a4e344cSTejun Heo {
44607a4e344cSTejun Heo 	if (attrs) {
44617a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
44629546b29eSTejun Heo 		free_cpumask_var(attrs->__pod_cpumask);
44637a4e344cSTejun Heo 		kfree(attrs);
44647a4e344cSTejun Heo 	}
44657a4e344cSTejun Heo }
44667a4e344cSTejun Heo 
44677a4e344cSTejun Heo /**
44687a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
44697a4e344cSTejun Heo  *
44707a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
4471d185af30SYacine Belkadi  * return it.
4472d185af30SYacine Belkadi  *
4473d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
44747a4e344cSTejun Heo  */
4475513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void)
44767a4e344cSTejun Heo {
44777a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
44787a4e344cSTejun Heo 
4479be69d00dSThomas Gleixner 	attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
44807a4e344cSTejun Heo 	if (!attrs)
44817a4e344cSTejun Heo 		goto fail;
4482be69d00dSThomas Gleixner 	if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
44837a4e344cSTejun Heo 		goto fail;
44849546b29eSTejun Heo 	if (!alloc_cpumask_var(&attrs->__pod_cpumask, GFP_KERNEL))
44859546b29eSTejun Heo 		goto fail;
44867a4e344cSTejun Heo 
448713e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
4488523a301eSTejun Heo 	attrs->affn_scope = WQ_AFFN_DFL;
44897a4e344cSTejun Heo 	return attrs;
44907a4e344cSTejun Heo fail:
44917a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
44927a4e344cSTejun Heo 	return NULL;
44937a4e344cSTejun Heo }
44947a4e344cSTejun Heo 
449529c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
449629c91e99STejun Heo 				 const struct workqueue_attrs *from)
449729c91e99STejun Heo {
449829c91e99STejun Heo 	to->nice = from->nice;
449929c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
45009546b29eSTejun Heo 	cpumask_copy(to->__pod_cpumask, from->__pod_cpumask);
45018639ecebSTejun Heo 	to->affn_strict = from->affn_strict;
450284193c07STejun Heo 
45032865a8fbSShaohua Li 	/*
450484193c07STejun Heo 	 * Unlike hash and equality test, copying shouldn't ignore wq-only
450584193c07STejun Heo 	 * fields as copying is used for both pool and wq attrs. Instead,
450684193c07STejun Heo 	 * get_unbound_pool() explicitly clears the fields.
45072865a8fbSShaohua Li 	 */
450884193c07STejun Heo 	to->affn_scope = from->affn_scope;
4509af73f5c9STejun Heo 	to->ordered = from->ordered;
451029c91e99STejun Heo }
451129c91e99STejun Heo 
45125de7a03cSTejun Heo /*
45135de7a03cSTejun Heo  * Some attrs fields are workqueue-only. Clear them for worker_pool's. See the
45145de7a03cSTejun Heo  * comments in 'struct workqueue_attrs' definition.
45155de7a03cSTejun Heo  */
45165de7a03cSTejun Heo static void wqattrs_clear_for_pool(struct workqueue_attrs *attrs)
45175de7a03cSTejun Heo {
451884193c07STejun Heo 	attrs->affn_scope = WQ_AFFN_NR_TYPES;
45195de7a03cSTejun Heo 	attrs->ordered = false;
45205de7a03cSTejun Heo }
45215de7a03cSTejun Heo 
452229c91e99STejun Heo /* hash value of the content of @attr */
452329c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
452429c91e99STejun Heo {
452529c91e99STejun Heo 	u32 hash = 0;
452629c91e99STejun Heo 
452729c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
452813e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
452913e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
45309546b29eSTejun Heo 	hash = jhash(cpumask_bits(attrs->__pod_cpumask),
45319546b29eSTejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
45328639ecebSTejun Heo 	hash = jhash_1word(attrs->affn_strict, hash);
453329c91e99STejun Heo 	return hash;
453429c91e99STejun Heo }
453529c91e99STejun Heo 
453629c91e99STejun Heo /* content equality test */
453729c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
453829c91e99STejun Heo 			  const struct workqueue_attrs *b)
453929c91e99STejun Heo {
454029c91e99STejun Heo 	if (a->nice != b->nice)
454129c91e99STejun Heo 		return false;
454229c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
454329c91e99STejun Heo 		return false;
45449546b29eSTejun Heo 	if (!cpumask_equal(a->__pod_cpumask, b->__pod_cpumask))
45459546b29eSTejun Heo 		return false;
45468639ecebSTejun Heo 	if (a->affn_strict != b->affn_strict)
45478639ecebSTejun Heo 		return false;
454829c91e99STejun Heo 	return true;
454929c91e99STejun Heo }
455029c91e99STejun Heo 
45510f36ee24STejun Heo /* Update @attrs with actually available CPUs */
45520f36ee24STejun Heo static void wqattrs_actualize_cpumask(struct workqueue_attrs *attrs,
45530f36ee24STejun Heo 				      const cpumask_t *unbound_cpumask)
45540f36ee24STejun Heo {
45550f36ee24STejun Heo 	/*
45560f36ee24STejun Heo 	 * Calculate the effective CPU mask of @attrs given @unbound_cpumask. If
45570f36ee24STejun Heo 	 * @attrs->cpumask doesn't overlap with @unbound_cpumask, we fallback to
45580f36ee24STejun Heo 	 * @unbound_cpumask.
45590f36ee24STejun Heo 	 */
45600f36ee24STejun Heo 	cpumask_and(attrs->cpumask, attrs->cpumask, unbound_cpumask);
45610f36ee24STejun Heo 	if (unlikely(cpumask_empty(attrs->cpumask)))
45620f36ee24STejun Heo 		cpumask_copy(attrs->cpumask, unbound_cpumask);
45630f36ee24STejun Heo }
45640f36ee24STejun Heo 
456584193c07STejun Heo /* find wq_pod_type to use for @attrs */
456684193c07STejun Heo static const struct wq_pod_type *
456784193c07STejun Heo wqattrs_pod_type(const struct workqueue_attrs *attrs)
456884193c07STejun Heo {
4569523a301eSTejun Heo 	enum wq_affn_scope scope;
4570523a301eSTejun Heo 	struct wq_pod_type *pt;
4571523a301eSTejun Heo 
4572523a301eSTejun Heo 	/* to synchronize access to wq_affn_dfl */
4573523a301eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4574523a301eSTejun Heo 
4575523a301eSTejun Heo 	if (attrs->affn_scope == WQ_AFFN_DFL)
4576523a301eSTejun Heo 		scope = wq_affn_dfl;
4577523a301eSTejun Heo 	else
4578523a301eSTejun Heo 		scope = attrs->affn_scope;
4579523a301eSTejun Heo 
4580523a301eSTejun Heo 	pt = &wq_pod_types[scope];
458184193c07STejun Heo 
458284193c07STejun Heo 	if (!WARN_ON_ONCE(attrs->affn_scope == WQ_AFFN_NR_TYPES) &&
458384193c07STejun Heo 	    likely(pt->nr_pods))
458484193c07STejun Heo 		return pt;
458584193c07STejun Heo 
458684193c07STejun Heo 	/*
458784193c07STejun Heo 	 * Before workqueue_init_topology(), only SYSTEM is available which is
458884193c07STejun Heo 	 * initialized in workqueue_init_early().
458984193c07STejun Heo 	 */
459084193c07STejun Heo 	pt = &wq_pod_types[WQ_AFFN_SYSTEM];
459184193c07STejun Heo 	BUG_ON(!pt->nr_pods);
459284193c07STejun Heo 	return pt;
459384193c07STejun Heo }
459484193c07STejun Heo 
45957a4e344cSTejun Heo /**
45967a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
45977a4e344cSTejun Heo  * @pool: worker_pool to initialize
45987a4e344cSTejun Heo  *
4599402dd89dSShailendra Verma  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
4600d185af30SYacine Belkadi  *
4601d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
460229c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
460329c91e99STejun Heo  * on @pool safely to release it.
46047a4e344cSTejun Heo  */
46057a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
46064e1a1f9aSTejun Heo {
4607a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_init(&pool->lock);
460829c91e99STejun Heo 	pool->id = -1;
460929c91e99STejun Heo 	pool->cpu = -1;
4610f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
46114e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
461282607adcSTejun Heo 	pool->watchdog_ts = jiffies;
46134e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
46144e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
46154e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
46164e1a1f9aSTejun Heo 
461732a6c723SKees Cook 	timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
46183f959aa3SValentin Schneider 	INIT_WORK(&pool->idle_cull_work, idle_cull_fn);
46194e1a1f9aSTejun Heo 
462032a6c723SKees Cook 	timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
46214e1a1f9aSTejun Heo 
4622da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
4623e02b9312SValentin Schneider 	INIT_LIST_HEAD(&pool->dying_workers);
46247a4e344cSTejun Heo 
46257cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
462629c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
462729c91e99STejun Heo 	pool->refcnt = 1;
462829c91e99STejun Heo 
462929c91e99STejun Heo 	/* shouldn't fail above this point */
4630be69d00dSThomas Gleixner 	pool->attrs = alloc_workqueue_attrs();
46317a4e344cSTejun Heo 	if (!pool->attrs)
46327a4e344cSTejun Heo 		return -ENOMEM;
46335de7a03cSTejun Heo 
46345de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
46355de7a03cSTejun Heo 
46367a4e344cSTejun Heo 	return 0;
46374e1a1f9aSTejun Heo }
46384e1a1f9aSTejun Heo 
4639669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP
4640669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
4641669de8bdSBart Van Assche {
4642669de8bdSBart Van Assche 	char *lock_name;
4643669de8bdSBart Van Assche 
4644669de8bdSBart Van Assche 	lockdep_register_key(&wq->key);
4645669de8bdSBart Van Assche 	lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
4646669de8bdSBart Van Assche 	if (!lock_name)
4647669de8bdSBart Van Assche 		lock_name = wq->name;
464869a106c0SQian Cai 
464969a106c0SQian Cai 	wq->lock_name = lock_name;
4650669de8bdSBart Van Assche 	lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
4651669de8bdSBart Van Assche }
4652669de8bdSBart Van Assche 
4653669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
4654669de8bdSBart Van Assche {
4655669de8bdSBart Van Assche 	lockdep_unregister_key(&wq->key);
4656669de8bdSBart Van Assche }
4657669de8bdSBart Van Assche 
4658669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
4659669de8bdSBart Van Assche {
4660669de8bdSBart Van Assche 	if (wq->lock_name != wq->name)
4661669de8bdSBart Van Assche 		kfree(wq->lock_name);
4662669de8bdSBart Van Assche }
4663669de8bdSBart Van Assche #else
4664669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
4665669de8bdSBart Van Assche {
4666669de8bdSBart Van Assche }
4667669de8bdSBart Van Assche 
4668669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
4669669de8bdSBart Van Assche {
4670669de8bdSBart Van Assche }
4671669de8bdSBart Van Assche 
4672669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
4673669de8bdSBart Van Assche {
4674669de8bdSBart Van Assche }
4675669de8bdSBart Van Assche #endif
4676669de8bdSBart Van Assche 
467791ccc6e7STejun Heo static void free_node_nr_active(struct wq_node_nr_active **nna_ar)
467891ccc6e7STejun Heo {
467991ccc6e7STejun Heo 	int node;
468091ccc6e7STejun Heo 
468191ccc6e7STejun Heo 	for_each_node(node) {
468291ccc6e7STejun Heo 		kfree(nna_ar[node]);
468391ccc6e7STejun Heo 		nna_ar[node] = NULL;
468491ccc6e7STejun Heo 	}
468591ccc6e7STejun Heo 
468691ccc6e7STejun Heo 	kfree(nna_ar[nr_node_ids]);
468791ccc6e7STejun Heo 	nna_ar[nr_node_ids] = NULL;
468891ccc6e7STejun Heo }
468991ccc6e7STejun Heo 
469091ccc6e7STejun Heo static void init_node_nr_active(struct wq_node_nr_active *nna)
469191ccc6e7STejun Heo {
4692c5f8cd6cSTejun Heo 	nna->max = WQ_DFL_MIN_ACTIVE;
469391ccc6e7STejun Heo 	atomic_set(&nna->nr, 0);
46945797b1c1STejun Heo 	raw_spin_lock_init(&nna->lock);
46955797b1c1STejun Heo 	INIT_LIST_HEAD(&nna->pending_pwqs);
469691ccc6e7STejun Heo }
469791ccc6e7STejun Heo 
469891ccc6e7STejun Heo /*
469991ccc6e7STejun Heo  * Each node's nr_active counter will be accessed mostly from its own node and
470091ccc6e7STejun Heo  * should be allocated in the node.
470191ccc6e7STejun Heo  */
470291ccc6e7STejun Heo static int alloc_node_nr_active(struct wq_node_nr_active **nna_ar)
470391ccc6e7STejun Heo {
470491ccc6e7STejun Heo 	struct wq_node_nr_active *nna;
470591ccc6e7STejun Heo 	int node;
470691ccc6e7STejun Heo 
470791ccc6e7STejun Heo 	for_each_node(node) {
470891ccc6e7STejun Heo 		nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, node);
470991ccc6e7STejun Heo 		if (!nna)
471091ccc6e7STejun Heo 			goto err_free;
471191ccc6e7STejun Heo 		init_node_nr_active(nna);
471291ccc6e7STejun Heo 		nna_ar[node] = nna;
471391ccc6e7STejun Heo 	}
471491ccc6e7STejun Heo 
471591ccc6e7STejun Heo 	/* [nr_node_ids] is used as the fallback */
471691ccc6e7STejun Heo 	nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, NUMA_NO_NODE);
471791ccc6e7STejun Heo 	if (!nna)
471891ccc6e7STejun Heo 		goto err_free;
471991ccc6e7STejun Heo 	init_node_nr_active(nna);
472091ccc6e7STejun Heo 	nna_ar[nr_node_ids] = nna;
472191ccc6e7STejun Heo 
472291ccc6e7STejun Heo 	return 0;
472391ccc6e7STejun Heo 
472491ccc6e7STejun Heo err_free:
472591ccc6e7STejun Heo 	free_node_nr_active(nna_ar);
472691ccc6e7STejun Heo 	return -ENOMEM;
472791ccc6e7STejun Heo }
472891ccc6e7STejun Heo 
4729e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu)
4730e2dca7adSTejun Heo {
4731e2dca7adSTejun Heo 	struct workqueue_struct *wq =
4732e2dca7adSTejun Heo 		container_of(rcu, struct workqueue_struct, rcu);
4733e2dca7adSTejun Heo 
473491ccc6e7STejun Heo 	if (wq->flags & WQ_UNBOUND)
473591ccc6e7STejun Heo 		free_node_nr_active(wq->node_nr_active);
473691ccc6e7STejun Heo 
4737669de8bdSBart Van Assche 	wq_free_lockdep(wq);
4738ee1ceef7STejun Heo 	free_percpu(wq->cpu_pwq);
4739e2dca7adSTejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
4740e2dca7adSTejun Heo 	kfree(wq);
4741e2dca7adSTejun Heo }
4742e2dca7adSTejun Heo 
474329c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
474429c91e99STejun Heo {
474529c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
474629c91e99STejun Heo 
47477cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
474829c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
474929c91e99STejun Heo 	kfree(pool);
475029c91e99STejun Heo }
475129c91e99STejun Heo 
475229c91e99STejun Heo /**
475329c91e99STejun Heo  * put_unbound_pool - put a worker_pool
475429c91e99STejun Heo  * @pool: worker_pool to put
475529c91e99STejun Heo  *
475624acfb71SThomas Gleixner  * Put @pool.  If its refcnt reaches zero, it gets destroyed in RCU
4757c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
4758c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
4759c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
4760a892caccSTejun Heo  *
4761a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
476229c91e99STejun Heo  */
476329c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
476429c91e99STejun Heo {
476560f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
476629c91e99STejun Heo 	struct worker *worker;
47679680540cSYang Yingliang 	LIST_HEAD(cull_list);
4768e02b9312SValentin Schneider 
4769a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4770a892caccSTejun Heo 
4771a892caccSTejun Heo 	if (--pool->refcnt)
477229c91e99STejun Heo 		return;
477329c91e99STejun Heo 
477429c91e99STejun Heo 	/* sanity checks */
477561d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
4776a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
477729c91e99STejun Heo 		return;
477829c91e99STejun Heo 
477929c91e99STejun Heo 	/* release id and unhash */
478029c91e99STejun Heo 	if (pool->id >= 0)
478129c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
478229c91e99STejun Heo 	hash_del(&pool->hash_node);
478329c91e99STejun Heo 
4784c5aa87bbSTejun Heo 	/*
4785692b4825STejun Heo 	 * Become the manager and destroy all workers.  This prevents
4786692b4825STejun Heo 	 * @pool's workers from blocking on attach_mutex.  We're the last
4787692b4825STejun Heo 	 * manager and @pool gets freed with the flag set.
47889ab03be4SValentin Schneider 	 *
47899ab03be4SValentin Schneider 	 * Having a concurrent manager is quite unlikely to happen as we can
47909ab03be4SValentin Schneider 	 * only get here with
47919ab03be4SValentin Schneider 	 *   pwq->refcnt == pool->refcnt == 0
47929ab03be4SValentin Schneider 	 * which implies no work queued to the pool, which implies no worker can
47939ab03be4SValentin Schneider 	 * become the manager. However a worker could have taken the role of
47949ab03be4SValentin Schneider 	 * manager before the refcnts dropped to 0, since maybe_create_worker()
47959ab03be4SValentin Schneider 	 * drops pool->lock
4796c5aa87bbSTejun Heo 	 */
47979ab03be4SValentin Schneider 	while (true) {
47989ab03be4SValentin Schneider 		rcuwait_wait_event(&manager_wait,
47999ab03be4SValentin Schneider 				   !(pool->flags & POOL_MANAGER_ACTIVE),
4800d8bb65abSSebastian Andrzej Siewior 				   TASK_UNINTERRUPTIBLE);
4801e02b9312SValentin Schneider 
4802e02b9312SValentin Schneider 		mutex_lock(&wq_pool_attach_mutex);
48039ab03be4SValentin Schneider 		raw_spin_lock_irq(&pool->lock);
48049ab03be4SValentin Schneider 		if (!(pool->flags & POOL_MANAGER_ACTIVE)) {
4805692b4825STejun Heo 			pool->flags |= POOL_MANAGER_ACTIVE;
48069ab03be4SValentin Schneider 			break;
48079ab03be4SValentin Schneider 		}
48089ab03be4SValentin Schneider 		raw_spin_unlock_irq(&pool->lock);
4809e02b9312SValentin Schneider 		mutex_unlock(&wq_pool_attach_mutex);
48109ab03be4SValentin Schneider 	}
4811692b4825STejun Heo 
48121037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
4813e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
481429c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
4815a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
481660f5a4bcSLai Jiangshan 
4817e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
4818e02b9312SValentin Schneider 
4819e02b9312SValentin Schneider 	if (!list_empty(&pool->workers) || !list_empty(&pool->dying_workers))
482060f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
48211258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
482260f5a4bcSLai Jiangshan 
482360f5a4bcSLai Jiangshan 	if (pool->detach_completion)
482460f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
482560f5a4bcSLai Jiangshan 
482629c91e99STejun Heo 	/* shut down the timers */
482729c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
48283f959aa3SValentin Schneider 	cancel_work_sync(&pool->idle_cull_work);
482929c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
483029c91e99STejun Heo 
483124acfb71SThomas Gleixner 	/* RCU protected to allow dereferences from get_work_pool() */
483225b00775SPaul E. McKenney 	call_rcu(&pool->rcu, rcu_free_pool);
483329c91e99STejun Heo }
483429c91e99STejun Heo 
483529c91e99STejun Heo /**
483629c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
483729c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
483829c91e99STejun Heo  *
483929c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
484029c91e99STejun Heo  * reference count and return it.  If there already is a matching
484129c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
4842d185af30SYacine Belkadi  * create a new one.
4843a892caccSTejun Heo  *
4844a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
4845d185af30SYacine Belkadi  *
4846d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
4847d185af30SYacine Belkadi  * On failure, %NULL.
484829c91e99STejun Heo  */
484929c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
485029c91e99STejun Heo {
485184193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_NUMA];
485229c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
485329c91e99STejun Heo 	struct worker_pool *pool;
485484193c07STejun Heo 	int pod, node = NUMA_NO_NODE;
485529c91e99STejun Heo 
4856a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
485729c91e99STejun Heo 
485829c91e99STejun Heo 	/* do we already have a matching pool? */
485929c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
486029c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
486129c91e99STejun Heo 			pool->refcnt++;
48623fb1823cSLai Jiangshan 			return pool;
486329c91e99STejun Heo 		}
486429c91e99STejun Heo 	}
486529c91e99STejun Heo 
48669546b29eSTejun Heo 	/* If __pod_cpumask is contained inside a NUMA pod, that's our node */
486784193c07STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++) {
48689546b29eSTejun Heo 		if (cpumask_subset(attrs->__pod_cpumask, pt->pod_cpus[pod])) {
486984193c07STejun Heo 			node = pt->pod_node[pod];
4870e2273584SXunlei Pang 			break;
4871e2273584SXunlei Pang 		}
4872e2273584SXunlei Pang 	}
4873e2273584SXunlei Pang 
487429c91e99STejun Heo 	/* nope, create a new one */
487584193c07STejun Heo 	pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, node);
487629c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
487729c91e99STejun Heo 		goto fail;
487829c91e99STejun Heo 
487984193c07STejun Heo 	pool->node = node;
48805de7a03cSTejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
48815de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
48822865a8fbSShaohua Li 
488329c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
488429c91e99STejun Heo 		goto fail;
488529c91e99STejun Heo 
488629c91e99STejun Heo 	/* create and start the initial worker */
48873347fa09STejun Heo 	if (wq_online && !create_worker(pool))
488829c91e99STejun Heo 		goto fail;
488929c91e99STejun Heo 
489029c91e99STejun Heo 	/* install */
489129c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
48923fb1823cSLai Jiangshan 
489329c91e99STejun Heo 	return pool;
489429c91e99STejun Heo fail:
489529c91e99STejun Heo 	if (pool)
489629c91e99STejun Heo 		put_unbound_pool(pool);
489729c91e99STejun Heo 	return NULL;
489829c91e99STejun Heo }
489929c91e99STejun Heo 
49008864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
49018864b4e5STejun Heo {
49028864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
49038864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
49048864b4e5STejun Heo }
49058864b4e5STejun Heo 
49068864b4e5STejun Heo /*
4907967b494eSTejun Heo  * Scheduled on pwq_release_worker by put_pwq() when an unbound pwq hits zero
4908967b494eSTejun Heo  * refcnt and needs to be destroyed.
49098864b4e5STejun Heo  */
4910687a9aa5STejun Heo static void pwq_release_workfn(struct kthread_work *work)
49118864b4e5STejun Heo {
49128864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
4913687a9aa5STejun Heo 						  release_work);
49148864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
49158864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
4916b42b0bddSYang Yingliang 	bool is_last = false;
49178864b4e5STejun Heo 
4918b42b0bddSYang Yingliang 	/*
4919687a9aa5STejun Heo 	 * When @pwq is not linked, it doesn't hold any reference to the
4920b42b0bddSYang Yingliang 	 * @wq, and @wq is invalid to access.
4921b42b0bddSYang Yingliang 	 */
4922b42b0bddSYang Yingliang 	if (!list_empty(&pwq->pwqs_node)) {
49233c25a55dSLai Jiangshan 		mutex_lock(&wq->mutex);
49248864b4e5STejun Heo 		list_del_rcu(&pwq->pwqs_node);
4925bc0caf09STejun Heo 		is_last = list_empty(&wq->pwqs);
49264c065dbcSWaiman Long 
49274c065dbcSWaiman Long 		/*
49284c065dbcSWaiman Long 		 * For ordered workqueue with a plugged dfl_pwq, restart it now.
49294c065dbcSWaiman Long 		 */
49304c065dbcSWaiman Long 		if (!is_last && (wq->flags & __WQ_ORDERED))
49314c065dbcSWaiman Long 			unplug_oldest_pwq(wq);
49324c065dbcSWaiman Long 
49333c25a55dSLai Jiangshan 		mutex_unlock(&wq->mutex);
4934b42b0bddSYang Yingliang 	}
49358864b4e5STejun Heo 
4936687a9aa5STejun Heo 	if (wq->flags & WQ_UNBOUND) {
4937a892caccSTejun Heo 		mutex_lock(&wq_pool_mutex);
49388864b4e5STejun Heo 		put_unbound_pool(pool);
4939a892caccSTejun Heo 		mutex_unlock(&wq_pool_mutex);
4940687a9aa5STejun Heo 	}
4941a892caccSTejun Heo 
49425797b1c1STejun Heo 	if (!list_empty(&pwq->pending_node)) {
49435797b1c1STejun Heo 		struct wq_node_nr_active *nna =
49445797b1c1STejun Heo 			wq_node_nr_active(pwq->wq, pwq->pool->node);
49455797b1c1STejun Heo 
49465797b1c1STejun Heo 		raw_spin_lock_irq(&nna->lock);
49475797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
49485797b1c1STejun Heo 		raw_spin_unlock_irq(&nna->lock);
49495797b1c1STejun Heo 	}
49505797b1c1STejun Heo 
495125b00775SPaul E. McKenney 	call_rcu(&pwq->rcu, rcu_free_pwq);
49528864b4e5STejun Heo 
49538864b4e5STejun Heo 	/*
49548864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
4955e2dca7adSTejun Heo 	 * is gonna access it anymore.  Schedule RCU free.
49568864b4e5STejun Heo 	 */
4957669de8bdSBart Van Assche 	if (is_last) {
4958669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
495925b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
49606029a918STejun Heo 	}
4961669de8bdSBart Van Assche }
49628864b4e5STejun Heo 
496367dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */
4964f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
4965f147f29eSTejun Heo 		     struct worker_pool *pool)
4966d2c1d404STejun Heo {
4967e9a8e01fSTejun Heo 	BUG_ON((unsigned long)pwq & ~WORK_STRUCT_PWQ_MASK);
4968d2c1d404STejun Heo 
4969e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
4970e50aba9aSTejun Heo 
4971d2c1d404STejun Heo 	pwq->pool = pool;
4972d2c1d404STejun Heo 	pwq->wq = wq;
4973d2c1d404STejun Heo 	pwq->flush_color = -1;
49748864b4e5STejun Heo 	pwq->refcnt = 1;
4975f97a4a1aSLai Jiangshan 	INIT_LIST_HEAD(&pwq->inactive_works);
49765797b1c1STejun Heo 	INIT_LIST_HEAD(&pwq->pending_node);
49771befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
4978d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
4979687a9aa5STejun Heo 	kthread_init_work(&pwq->release_work, pwq_release_workfn);
4980f147f29eSTejun Heo }
4981d2c1d404STejun Heo 
4982f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
49831befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
4984f147f29eSTejun Heo {
4985f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
4986f147f29eSTejun Heo 
4987f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
498875ccf595STejun Heo 
49891befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
49901befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
49911befcf30STejun Heo 		return;
49921befcf30STejun Heo 
499329b1cb41SLai Jiangshan 	/* set the matching work_color */
499475ccf595STejun Heo 	pwq->work_color = wq->work_color;
4995983ca25eSTejun Heo 
4996983ca25eSTejun Heo 	/* link in @pwq */
499726fb7e3dSWaiman Long 	list_add_tail_rcu(&pwq->pwqs_node, &wq->pwqs);
4998df2d5ae4STejun Heo }
49996029a918STejun Heo 
5000f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
5001f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
5002f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
5003f147f29eSTejun Heo {
5004f147f29eSTejun Heo 	struct worker_pool *pool;
5005f147f29eSTejun Heo 	struct pool_workqueue *pwq;
5006f147f29eSTejun Heo 
5007f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
5008f147f29eSTejun Heo 
5009f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
5010f147f29eSTejun Heo 	if (!pool)
5011f147f29eSTejun Heo 		return NULL;
5012f147f29eSTejun Heo 
5013e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
5014f147f29eSTejun Heo 	if (!pwq) {
5015f147f29eSTejun Heo 		put_unbound_pool(pool);
5016f147f29eSTejun Heo 		return NULL;
5017f147f29eSTejun Heo 	}
5018f147f29eSTejun Heo 
5019f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
5020f147f29eSTejun Heo 	return pwq;
5021d2c1d404STejun Heo }
5022d2c1d404STejun Heo 
50234c16bd32STejun Heo /**
5024fef59c9cSTejun Heo  * wq_calc_pod_cpumask - calculate a wq_attrs' cpumask for a pod
5025042f7df1SLai Jiangshan  * @attrs: the wq_attrs of the default pwq of the target workqueue
502684193c07STejun Heo  * @cpu: the target CPU
50274c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
50284c16bd32STejun Heo  *
5029fef59c9cSTejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @pod. If
5030fef59c9cSTejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during calculation.
50319546b29eSTejun Heo  * The result is stored in @attrs->__pod_cpumask.
50324c16bd32STejun Heo  *
5033fef59c9cSTejun Heo  * If pod affinity is not enabled, @attrs->cpumask is always used. If enabled
5034fef59c9cSTejun Heo  * and @pod has online CPUs requested by @attrs, the returned cpumask is the
5035fef59c9cSTejun Heo  * intersection of the possible CPUs of @pod and @attrs->cpumask.
50364c16bd32STejun Heo  *
5037fef59c9cSTejun Heo  * The caller is responsible for ensuring that the cpumask of @pod stays stable.
50384c16bd32STejun Heo  */
50399546b29eSTejun Heo static void wq_calc_pod_cpumask(struct workqueue_attrs *attrs, int cpu,
50409546b29eSTejun Heo 				int cpu_going_down)
50414c16bd32STejun Heo {
504284193c07STejun Heo 	const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
504384193c07STejun Heo 	int pod = pt->cpu_pod[cpu];
50444c16bd32STejun Heo 
5045fef59c9cSTejun Heo 	/* does @pod have any online CPUs @attrs wants? */
50469546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, pt->pod_cpus[pod], attrs->cpumask);
50479546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->__pod_cpumask, cpu_online_mask);
50484c16bd32STejun Heo 	if (cpu_going_down >= 0)
50499546b29eSTejun Heo 		cpumask_clear_cpu(cpu_going_down, attrs->__pod_cpumask);
50504c16bd32STejun Heo 
50519546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask)) {
50529546b29eSTejun Heo 		cpumask_copy(attrs->__pod_cpumask, attrs->cpumask);
505384193c07STejun Heo 		return;
505484193c07STejun Heo 	}
50554c16bd32STejun Heo 
5056fef59c9cSTejun Heo 	/* yeap, return possible CPUs in @pod that @attrs wants */
50579546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->cpumask, pt->pod_cpus[pod]);
50581ad0f0a7SMichael Bringmann 
50599546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask))
50601ad0f0a7SMichael Bringmann 		pr_warn_once("WARNING: workqueue cpumask: online intersect > "
50611ad0f0a7SMichael Bringmann 				"possible intersect\n");
50624c16bd32STejun Heo }
50634c16bd32STejun Heo 
50649f66cff2STejun Heo /* install @pwq into @wq and return the old pwq, @cpu < 0 for dfl_pwq */
5065636b927eSTejun Heo static struct pool_workqueue *install_unbound_pwq(struct workqueue_struct *wq,
5066636b927eSTejun Heo 					int cpu, struct pool_workqueue *pwq)
50671befcf30STejun Heo {
50689f66cff2STejun Heo 	struct pool_workqueue __rcu **slot = unbound_pwq_slot(wq, cpu);
50691befcf30STejun Heo 	struct pool_workqueue *old_pwq;
50701befcf30STejun Heo 
50715b95e1afSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
50721befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
50731befcf30STejun Heo 
50741befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
50751befcf30STejun Heo 	link_pwq(pwq);
50761befcf30STejun Heo 
50779f66cff2STejun Heo 	old_pwq = rcu_access_pointer(*slot);
50789f66cff2STejun Heo 	rcu_assign_pointer(*slot, pwq);
50791befcf30STejun Heo 	return old_pwq;
50801befcf30STejun Heo }
50811befcf30STejun Heo 
50822d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */
50832d5f0764SLai Jiangshan struct apply_wqattrs_ctx {
50842d5f0764SLai Jiangshan 	struct workqueue_struct	*wq;		/* target workqueue */
50852d5f0764SLai Jiangshan 	struct workqueue_attrs	*attrs;		/* attrs to apply */
5086042f7df1SLai Jiangshan 	struct list_head	list;		/* queued for batching commit */
50872d5f0764SLai Jiangshan 	struct pool_workqueue	*dfl_pwq;
50882d5f0764SLai Jiangshan 	struct pool_workqueue	*pwq_tbl[];
50892d5f0764SLai Jiangshan };
50902d5f0764SLai Jiangshan 
50912d5f0764SLai Jiangshan /* free the resources after success or abort */
50922d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
50932d5f0764SLai Jiangshan {
50942d5f0764SLai Jiangshan 	if (ctx) {
5095636b927eSTejun Heo 		int cpu;
50962d5f0764SLai Jiangshan 
5097636b927eSTejun Heo 		for_each_possible_cpu(cpu)
5098636b927eSTejun Heo 			put_pwq_unlocked(ctx->pwq_tbl[cpu]);
50992d5f0764SLai Jiangshan 		put_pwq_unlocked(ctx->dfl_pwq);
51002d5f0764SLai Jiangshan 
51012d5f0764SLai Jiangshan 		free_workqueue_attrs(ctx->attrs);
51022d5f0764SLai Jiangshan 
51032d5f0764SLai Jiangshan 		kfree(ctx);
51042d5f0764SLai Jiangshan 	}
51052d5f0764SLai Jiangshan }
51062d5f0764SLai Jiangshan 
51072d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */
51082d5f0764SLai Jiangshan static struct apply_wqattrs_ctx *
51092d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq,
511099c621efSLai Jiangshan 		      const struct workqueue_attrs *attrs,
511199c621efSLai Jiangshan 		      const cpumask_var_t unbound_cpumask)
51122d5f0764SLai Jiangshan {
51132d5f0764SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
51149546b29eSTejun Heo 	struct workqueue_attrs *new_attrs;
5115636b927eSTejun Heo 	int cpu;
51162d5f0764SLai Jiangshan 
51172d5f0764SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
51182d5f0764SLai Jiangshan 
511984193c07STejun Heo 	if (WARN_ON(attrs->affn_scope < 0 ||
512084193c07STejun Heo 		    attrs->affn_scope >= WQ_AFFN_NR_TYPES))
512184193c07STejun Heo 		return ERR_PTR(-EINVAL);
512284193c07STejun Heo 
5123636b927eSTejun Heo 	ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_cpu_ids), GFP_KERNEL);
51242d5f0764SLai Jiangshan 
5125be69d00dSThomas Gleixner 	new_attrs = alloc_workqueue_attrs();
51269546b29eSTejun Heo 	if (!ctx || !new_attrs)
51272d5f0764SLai Jiangshan 		goto out_free;
51282d5f0764SLai Jiangshan 
5129042f7df1SLai Jiangshan 	/*
51302d5f0764SLai Jiangshan 	 * If something goes wrong during CPU up/down, we'll fall back to
51312d5f0764SLai Jiangshan 	 * the default pwq covering whole @attrs->cpumask.  Always create
51322d5f0764SLai Jiangshan 	 * it even if we don't use it immediately.
51332d5f0764SLai Jiangshan 	 */
51340f36ee24STejun Heo 	copy_workqueue_attrs(new_attrs, attrs);
51350f36ee24STejun Heo 	wqattrs_actualize_cpumask(new_attrs, unbound_cpumask);
51369546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
51372d5f0764SLai Jiangshan 	ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
51382d5f0764SLai Jiangshan 	if (!ctx->dfl_pwq)
51392d5f0764SLai Jiangshan 		goto out_free;
51402d5f0764SLai Jiangshan 
5141636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
5142af73f5c9STejun Heo 		if (new_attrs->ordered) {
51432d5f0764SLai Jiangshan 			ctx->dfl_pwq->refcnt++;
5144636b927eSTejun Heo 			ctx->pwq_tbl[cpu] = ctx->dfl_pwq;
5145636b927eSTejun Heo 		} else {
51469546b29eSTejun Heo 			wq_calc_pod_cpumask(new_attrs, cpu, -1);
51479546b29eSTejun Heo 			ctx->pwq_tbl[cpu] = alloc_unbound_pwq(wq, new_attrs);
5148636b927eSTejun Heo 			if (!ctx->pwq_tbl[cpu])
5149636b927eSTejun Heo 				goto out_free;
51502d5f0764SLai Jiangshan 		}
51512d5f0764SLai Jiangshan 	}
51522d5f0764SLai Jiangshan 
5153042f7df1SLai Jiangshan 	/* save the user configured attrs and sanitize it. */
5154042f7df1SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
5155042f7df1SLai Jiangshan 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
51569546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
51572d5f0764SLai Jiangshan 	ctx->attrs = new_attrs;
5158042f7df1SLai Jiangshan 
51594c065dbcSWaiman Long 	/*
51604c065dbcSWaiman Long 	 * For initialized ordered workqueues, there should only be one pwq
51614c065dbcSWaiman Long 	 * (dfl_pwq). Set the plugged flag of ctx->dfl_pwq to suspend execution
51624c065dbcSWaiman Long 	 * of newly queued work items until execution of older work items in
51634c065dbcSWaiman Long 	 * the old pwq's have completed.
51644c065dbcSWaiman Long 	 */
51654c065dbcSWaiman Long 	if ((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs))
51664c065dbcSWaiman Long 		ctx->dfl_pwq->plugged = true;
51674c065dbcSWaiman Long 
51682d5f0764SLai Jiangshan 	ctx->wq = wq;
51692d5f0764SLai Jiangshan 	return ctx;
51702d5f0764SLai Jiangshan 
51712d5f0764SLai Jiangshan out_free:
51722d5f0764SLai Jiangshan 	free_workqueue_attrs(new_attrs);
51732d5f0764SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
517484193c07STejun Heo 	return ERR_PTR(-ENOMEM);
51752d5f0764SLai Jiangshan }
51762d5f0764SLai Jiangshan 
51772d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
51782d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
51792d5f0764SLai Jiangshan {
5180636b927eSTejun Heo 	int cpu;
51812d5f0764SLai Jiangshan 
51822d5f0764SLai Jiangshan 	/* all pwqs have been created successfully, let's install'em */
51832d5f0764SLai Jiangshan 	mutex_lock(&ctx->wq->mutex);
51842d5f0764SLai Jiangshan 
51852d5f0764SLai Jiangshan 	copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
51862d5f0764SLai Jiangshan 
51879f66cff2STejun Heo 	/* save the previous pwqs and install the new ones */
5188636b927eSTejun Heo 	for_each_possible_cpu(cpu)
5189636b927eSTejun Heo 		ctx->pwq_tbl[cpu] = install_unbound_pwq(ctx->wq, cpu,
5190636b927eSTejun Heo 							ctx->pwq_tbl[cpu]);
51919f66cff2STejun Heo 	ctx->dfl_pwq = install_unbound_pwq(ctx->wq, -1, ctx->dfl_pwq);
51922d5f0764SLai Jiangshan 
51935797b1c1STejun Heo 	/* update node_nr_active->max */
51945797b1c1STejun Heo 	wq_update_node_max_active(ctx->wq, -1);
51955797b1c1STejun Heo 
5196d64f2fa0SJuri Lelli 	/* rescuer needs to respect wq cpumask changes */
5197d64f2fa0SJuri Lelli 	if (ctx->wq->rescuer)
5198d64f2fa0SJuri Lelli 		set_cpus_allowed_ptr(ctx->wq->rescuer->task,
5199d64f2fa0SJuri Lelli 				     unbound_effective_cpumask(ctx->wq));
5200d64f2fa0SJuri Lelli 
52012d5f0764SLai Jiangshan 	mutex_unlock(&ctx->wq->mutex);
52022d5f0764SLai Jiangshan }
52032d5f0764SLai Jiangshan 
5204a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
5205a0111cf6SLai Jiangshan 					const struct workqueue_attrs *attrs)
5206a0111cf6SLai Jiangshan {
5207a0111cf6SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
5208a0111cf6SLai Jiangshan 
5209a0111cf6SLai Jiangshan 	/* only unbound workqueues can change attributes */
5210a0111cf6SLai Jiangshan 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
5211a0111cf6SLai Jiangshan 		return -EINVAL;
5212a0111cf6SLai Jiangshan 
521399c621efSLai Jiangshan 	ctx = apply_wqattrs_prepare(wq, attrs, wq_unbound_cpumask);
521484193c07STejun Heo 	if (IS_ERR(ctx))
521584193c07STejun Heo 		return PTR_ERR(ctx);
5216a0111cf6SLai Jiangshan 
5217a0111cf6SLai Jiangshan 	/* the ctx has been prepared successfully, let's commit it */
5218a0111cf6SLai Jiangshan 	apply_wqattrs_commit(ctx);
5219a0111cf6SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
5220a0111cf6SLai Jiangshan 
52216201171eSwanghaibin 	return 0;
5222a0111cf6SLai Jiangshan }
5223a0111cf6SLai Jiangshan 
52249e8cd2f5STejun Heo /**
52259e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
52269e8cd2f5STejun Heo  * @wq: the target workqueue
52279e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
52289e8cd2f5STejun Heo  *
5229fef59c9cSTejun Heo  * Apply @attrs to an unbound workqueue @wq. Unless disabled, this function maps
5230fef59c9cSTejun Heo  * a separate pwq to each CPU pod with possibles CPUs in @attrs->cpumask so that
5231fef59c9cSTejun Heo  * work items are affine to the pod it was issued on. Older pwqs are released as
5232fef59c9cSTejun Heo  * in-flight work items finish. Note that a work item which repeatedly requeues
5233fef59c9cSTejun Heo  * itself back-to-back will stay on its current pwq.
52349e8cd2f5STejun Heo  *
5235d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
5236d185af30SYacine Belkadi  *
5237ffd8bea8SSebastian Andrzej Siewior  * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock().
5238509b3204SDaniel Jordan  *
5239d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
52409e8cd2f5STejun Heo  */
5241513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq,
52429e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
52439e8cd2f5STejun Heo {
5244a0111cf6SLai Jiangshan 	int ret;
52459e8cd2f5STejun Heo 
5246509b3204SDaniel Jordan 	lockdep_assert_cpus_held();
5247509b3204SDaniel Jordan 
5248509b3204SDaniel Jordan 	mutex_lock(&wq_pool_mutex);
5249a0111cf6SLai Jiangshan 	ret = apply_workqueue_attrs_locked(wq, attrs);
5250509b3204SDaniel Jordan 	mutex_unlock(&wq_pool_mutex);
52512d5f0764SLai Jiangshan 
52522d5f0764SLai Jiangshan 	return ret;
52539e8cd2f5STejun Heo }
52549e8cd2f5STejun Heo 
52554c16bd32STejun Heo /**
5256fef59c9cSTejun Heo  * wq_update_pod - update pod affinity of a wq for CPU hot[un]plug
52574c16bd32STejun Heo  * @wq: the target workqueue
52584cbfd3deSTejun Heo  * @cpu: the CPU to update pool association for
52594cbfd3deSTejun Heo  * @hotplug_cpu: the CPU coming up or going down
52604c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
52614c16bd32STejun Heo  *
52624c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
5263fef59c9cSTejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update pod affinity of
52644c16bd32STejun Heo  * @wq accordingly.
52654c16bd32STejun Heo  *
52664c16bd32STejun Heo  *
5267fef59c9cSTejun Heo  * If pod affinity can't be adjusted due to memory allocation failure, it falls
5268fef59c9cSTejun Heo  * back to @wq->dfl_pwq which may not be optimal but is always correct.
5269fef59c9cSTejun Heo  *
5270fef59c9cSTejun Heo  * Note that when the last allowed CPU of a pod goes offline for a workqueue
5271fef59c9cSTejun Heo  * with a cpumask spanning multiple pods, the workers which were already
5272fef59c9cSTejun Heo  * executing the work items for the workqueue will lose their CPU affinity and
5273fef59c9cSTejun Heo  * may execute on any CPU. This is similar to how per-cpu workqueues behave on
5274fef59c9cSTejun Heo  * CPU_DOWN. If a workqueue user wants strict affinity, it's the user's
5275fef59c9cSTejun Heo  * responsibility to flush the work item from CPU_DOWN_PREPARE.
52764c16bd32STejun Heo  */
5277fef59c9cSTejun Heo static void wq_update_pod(struct workqueue_struct *wq, int cpu,
52784cbfd3deSTejun Heo 			  int hotplug_cpu, bool online)
52794c16bd32STejun Heo {
52804cbfd3deSTejun Heo 	int off_cpu = online ? -1 : hotplug_cpu;
52814c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
52824c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
52834c16bd32STejun Heo 
52844c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
52854c16bd32STejun Heo 
528684193c07STejun Heo 	if (!(wq->flags & WQ_UNBOUND) || wq->unbound_attrs->ordered)
52874c16bd32STejun Heo 		return;
52884c16bd32STejun Heo 
52894c16bd32STejun Heo 	/*
52904c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
52914c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
52924c16bd32STejun Heo 	 * CPU hotplug exclusion.
52934c16bd32STejun Heo 	 */
5294fef59c9cSTejun Heo 	target_attrs = wq_update_pod_attrs_buf;
52954c16bd32STejun Heo 
52964c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
52970f36ee24STejun Heo 	wqattrs_actualize_cpumask(target_attrs, wq_unbound_cpumask);
52984c16bd32STejun Heo 
5299636b927eSTejun Heo 	/* nothing to do if the target cpumask matches the current pwq */
53009546b29eSTejun Heo 	wq_calc_pod_cpumask(target_attrs, cpu, off_cpu);
53019f66cff2STejun Heo 	if (wqattrs_equal(target_attrs, unbound_pwq(wq, cpu)->pool->attrs))
5302f7142ed4SLai Jiangshan 		return;
53034c16bd32STejun Heo 
53044c16bd32STejun Heo 	/* create a new pwq */
53054c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
53064c16bd32STejun Heo 	if (!pwq) {
5307fef59c9cSTejun Heo 		pr_warn("workqueue: allocation failed while updating CPU pod affinity of \"%s\"\n",
53084c16bd32STejun Heo 			wq->name);
530977f300b1SDaeseok Youn 		goto use_dfl_pwq;
53104c16bd32STejun Heo 	}
53114c16bd32STejun Heo 
5312f7142ed4SLai Jiangshan 	/* Install the new pwq. */
53134c16bd32STejun Heo 	mutex_lock(&wq->mutex);
5314636b927eSTejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, pwq);
53154c16bd32STejun Heo 	goto out_unlock;
53164c16bd32STejun Heo 
53174c16bd32STejun Heo use_dfl_pwq:
5318f7142ed4SLai Jiangshan 	mutex_lock(&wq->mutex);
53199f66cff2STejun Heo 	pwq = unbound_pwq(wq, -1);
53209f66cff2STejun Heo 	raw_spin_lock_irq(&pwq->pool->lock);
53219f66cff2STejun Heo 	get_pwq(pwq);
53229f66cff2STejun Heo 	raw_spin_unlock_irq(&pwq->pool->lock);
53239f66cff2STejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, pwq);
53244c16bd32STejun Heo out_unlock:
53254c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
53264c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
53274c16bd32STejun Heo }
53284c16bd32STejun Heo 
532930cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
53301da177e4SLinus Torvalds {
533149e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
53328a2b7538STejun Heo 	int cpu, ret;
5333e1d8aa9fSFrederic Weisbecker 
5334687a9aa5STejun Heo 	wq->cpu_pwq = alloc_percpu(struct pool_workqueue *);
5335ee1ceef7STejun Heo 	if (!wq->cpu_pwq)
5336687a9aa5STejun Heo 		goto enomem;
533730cdf249STejun Heo 
5338636b927eSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
533930cdf249STejun Heo 		for_each_possible_cpu(cpu) {
53404cb1ef64STejun Heo 			struct pool_workqueue **pwq_p;
53414cb1ef64STejun Heo 			struct worker_pool __percpu *pools;
53424cb1ef64STejun Heo 			struct worker_pool *pool;
53434cb1ef64STejun Heo 
53444cb1ef64STejun Heo 			if (wq->flags & WQ_BH)
53454cb1ef64STejun Heo 				pools = bh_worker_pools;
53464cb1ef64STejun Heo 			else
53474cb1ef64STejun Heo 				pools = cpu_worker_pools;
53484cb1ef64STejun Heo 
53494cb1ef64STejun Heo 			pool = &(per_cpu_ptr(pools, cpu)[highpri]);
53504cb1ef64STejun Heo 			pwq_p = per_cpu_ptr(wq->cpu_pwq, cpu);
535130cdf249STejun Heo 
5352687a9aa5STejun Heo 			*pwq_p = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL,
5353687a9aa5STejun Heo 						       pool->node);
5354687a9aa5STejun Heo 			if (!*pwq_p)
5355687a9aa5STejun Heo 				goto enomem;
5356687a9aa5STejun Heo 
5357687a9aa5STejun Heo 			init_pwq(*pwq_p, wq, pool);
5358f147f29eSTejun Heo 
5359f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
5360687a9aa5STejun Heo 			link_pwq(*pwq_p);
5361f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
536230cdf249STejun Heo 		}
536330cdf249STejun Heo 		return 0;
5364509b3204SDaniel Jordan 	}
5365509b3204SDaniel Jordan 
5366ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
5367509b3204SDaniel Jordan 	if (wq->flags & __WQ_ORDERED) {
53689f66cff2STejun Heo 		struct pool_workqueue *dfl_pwq;
53699f66cff2STejun Heo 
53708a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
53718a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
53729f66cff2STejun Heo 		dfl_pwq = rcu_access_pointer(wq->dfl_pwq);
53739f66cff2STejun Heo 		WARN(!ret && (wq->pwqs.next != &dfl_pwq->pwqs_node ||
53749f66cff2STejun Heo 			      wq->pwqs.prev != &dfl_pwq->pwqs_node),
53758a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
53769e8cd2f5STejun Heo 	} else {
5377509b3204SDaniel Jordan 		ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
53789e8cd2f5STejun Heo 	}
5379ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
5380509b3204SDaniel Jordan 
538164344553SZqiang 	/* for unbound pwq, flush the pwq_release_worker ensures that the
538264344553SZqiang 	 * pwq_release_workfn() completes before calling kfree(wq).
538364344553SZqiang 	 */
538464344553SZqiang 	if (ret)
538564344553SZqiang 		kthread_flush_worker(pwq_release_worker);
538664344553SZqiang 
5387509b3204SDaniel Jordan 	return ret;
5388687a9aa5STejun Heo 
5389687a9aa5STejun Heo enomem:
5390687a9aa5STejun Heo 	if (wq->cpu_pwq) {
53917b42f401SZqiang 		for_each_possible_cpu(cpu) {
53927b42f401SZqiang 			struct pool_workqueue *pwq = *per_cpu_ptr(wq->cpu_pwq, cpu);
53937b42f401SZqiang 
53947b42f401SZqiang 			if (pwq)
53957b42f401SZqiang 				kmem_cache_free(pwq_cache, pwq);
53967b42f401SZqiang 		}
5397687a9aa5STejun Heo 		free_percpu(wq->cpu_pwq);
5398687a9aa5STejun Heo 		wq->cpu_pwq = NULL;
5399687a9aa5STejun Heo 	}
5400687a9aa5STejun Heo 	return -ENOMEM;
54010f900049STejun Heo }
54020f900049STejun Heo 
5403f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
5404f3421797STejun Heo 			       const char *name)
5405b71ab8c2STejun Heo {
5406636b927eSTejun Heo 	if (max_active < 1 || max_active > WQ_MAX_ACTIVE)
5407044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
5408636b927eSTejun Heo 			max_active, name, 1, WQ_MAX_ACTIVE);
5409b71ab8c2STejun Heo 
5410636b927eSTejun Heo 	return clamp_val(max_active, 1, WQ_MAX_ACTIVE);
5411b71ab8c2STejun Heo }
5412b71ab8c2STejun Heo 
5413983c7515STejun Heo /*
5414983c7515STejun Heo  * Workqueues which may be used during memory reclaim should have a rescuer
5415983c7515STejun Heo  * to guarantee forward progress.
5416983c7515STejun Heo  */
5417983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq)
5418983c7515STejun Heo {
5419983c7515STejun Heo 	struct worker *rescuer;
5420b92b36eaSDan Carpenter 	int ret;
5421983c7515STejun Heo 
5422983c7515STejun Heo 	if (!(wq->flags & WQ_MEM_RECLAIM))
5423983c7515STejun Heo 		return 0;
5424983c7515STejun Heo 
5425983c7515STejun Heo 	rescuer = alloc_worker(NUMA_NO_NODE);
54264c0736a7SPetr Mladek 	if (!rescuer) {
54274c0736a7SPetr Mladek 		pr_err("workqueue: Failed to allocate a rescuer for wq \"%s\"\n",
54284c0736a7SPetr Mladek 		       wq->name);
5429983c7515STejun Heo 		return -ENOMEM;
54304c0736a7SPetr Mladek 	}
5431983c7515STejun Heo 
5432983c7515STejun Heo 	rescuer->rescue_wq = wq;
5433b6a46f72SAaron Tomlin 	rescuer->task = kthread_create(rescuer_thread, rescuer, "kworker/R-%s", wq->name);
5434f187b697SSean Fu 	if (IS_ERR(rescuer->task)) {
5435b92b36eaSDan Carpenter 		ret = PTR_ERR(rescuer->task);
54364c0736a7SPetr Mladek 		pr_err("workqueue: Failed to create a rescuer kthread for wq \"%s\": %pe",
54374c0736a7SPetr Mladek 		       wq->name, ERR_PTR(ret));
5438983c7515STejun Heo 		kfree(rescuer);
5439b92b36eaSDan Carpenter 		return ret;
5440983c7515STejun Heo 	}
5441983c7515STejun Heo 
5442983c7515STejun Heo 	wq->rescuer = rescuer;
544385f0ab43SJuri Lelli 	if (wq->flags & WQ_UNBOUND)
544449584bb8SWaiman Long 		kthread_bind_mask(rescuer->task, wq_unbound_cpumask);
544585f0ab43SJuri Lelli 	else
5446983c7515STejun Heo 		kthread_bind_mask(rescuer->task, cpu_possible_mask);
5447983c7515STejun Heo 	wake_up_process(rescuer->task);
5448983c7515STejun Heo 
5449983c7515STejun Heo 	return 0;
5450983c7515STejun Heo }
5451983c7515STejun Heo 
5452a045a272STejun Heo /**
5453a045a272STejun Heo  * wq_adjust_max_active - update a wq's max_active to the current setting
5454a045a272STejun Heo  * @wq: target workqueue
5455a045a272STejun Heo  *
5456a045a272STejun Heo  * If @wq isn't freezing, set @wq->max_active to the saved_max_active and
5457a045a272STejun Heo  * activate inactive work items accordingly. If @wq is freezing, clear
5458a045a272STejun Heo  * @wq->max_active to zero.
5459a045a272STejun Heo  */
5460a045a272STejun Heo static void wq_adjust_max_active(struct workqueue_struct *wq)
5461a045a272STejun Heo {
5462c5404d4eSTejun Heo 	bool activated;
54635797b1c1STejun Heo 	int new_max, new_min;
5464a045a272STejun Heo 
5465a045a272STejun Heo 	lockdep_assert_held(&wq->mutex);
5466a045a272STejun Heo 
5467a045a272STejun Heo 	if ((wq->flags & WQ_FREEZABLE) && workqueue_freezing) {
54685797b1c1STejun Heo 		new_max = 0;
54695797b1c1STejun Heo 		new_min = 0;
54705797b1c1STejun Heo 	} else {
54715797b1c1STejun Heo 		new_max = wq->saved_max_active;
54725797b1c1STejun Heo 		new_min = wq->saved_min_active;
5473a045a272STejun Heo 	}
5474a045a272STejun Heo 
54755797b1c1STejun Heo 	if (wq->max_active == new_max && wq->min_active == new_min)
5476a045a272STejun Heo 		return;
5477a045a272STejun Heo 
5478a045a272STejun Heo 	/*
54795797b1c1STejun Heo 	 * Update @wq->max/min_active and then kick inactive work items if more
5480a045a272STejun Heo 	 * active work items are allowed. This doesn't break work item ordering
5481a045a272STejun Heo 	 * because new work items are always queued behind existing inactive
5482a045a272STejun Heo 	 * work items if there are any.
5483a045a272STejun Heo 	 */
54845797b1c1STejun Heo 	WRITE_ONCE(wq->max_active, new_max);
54855797b1c1STejun Heo 	WRITE_ONCE(wq->min_active, new_min);
54865797b1c1STejun Heo 
54875797b1c1STejun Heo 	if (wq->flags & WQ_UNBOUND)
54885797b1c1STejun Heo 		wq_update_node_max_active(wq, -1);
54895797b1c1STejun Heo 
54905797b1c1STejun Heo 	if (new_max == 0)
54915797b1c1STejun Heo 		return;
5492a045a272STejun Heo 
5493c5404d4eSTejun Heo 	/*
5494c5404d4eSTejun Heo 	 * Round-robin through pwq's activating the first inactive work item
5495c5404d4eSTejun Heo 	 * until max_active is filled.
5496c5404d4eSTejun Heo 	 */
5497c5404d4eSTejun Heo 	do {
5498c5404d4eSTejun Heo 		struct pool_workqueue *pwq;
5499c5404d4eSTejun Heo 
5500c5404d4eSTejun Heo 		activated = false;
5501a045a272STejun Heo 		for_each_pwq(pwq, wq) {
5502c26e2f2eSTejun Heo 			unsigned long irq_flags;
5503a045a272STejun Heo 
5504c5404d4eSTejun Heo 			/* can be called during early boot w/ irq disabled */
5505c26e2f2eSTejun Heo 			raw_spin_lock_irqsave(&pwq->pool->lock, irq_flags);
55065797b1c1STejun Heo 			if (pwq_activate_first_inactive(pwq, true)) {
5507c5404d4eSTejun Heo 				activated = true;
5508a045a272STejun Heo 				kick_pool(pwq->pool);
5509c5404d4eSTejun Heo 			}
5510c26e2f2eSTejun Heo 			raw_spin_unlock_irqrestore(&pwq->pool->lock, irq_flags);
5511a045a272STejun Heo 		}
5512c5404d4eSTejun Heo 	} while (activated);
5513a045a272STejun Heo }
5514a045a272STejun Heo 
5515a2775bbcSMathieu Malaterre __printf(1, 4)
5516669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt,
551797e37d7bSTejun Heo 					 unsigned int flags,
5518669de8bdSBart Van Assche 					 int max_active, ...)
55193af24433SOleg Nesterov {
5520ecf6881fSTejun Heo 	va_list args;
55213af24433SOleg Nesterov 	struct workqueue_struct *wq;
552291ccc6e7STejun Heo 	size_t wq_size;
552391ccc6e7STejun Heo 	int name_len;
5524b196be89STejun Heo 
55254cb1ef64STejun Heo 	if (flags & WQ_BH) {
55264cb1ef64STejun Heo 		if (WARN_ON_ONCE(flags & ~__WQ_BH_ALLOWS))
55274cb1ef64STejun Heo 			return NULL;
55284cb1ef64STejun Heo 		if (WARN_ON_ONCE(max_active))
55294cb1ef64STejun Heo 			return NULL;
55304cb1ef64STejun Heo 	}
55314cb1ef64STejun Heo 
5532cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
5533cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
5534cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
5535cee22a15SViresh Kumar 
5536ecf6881fSTejun Heo 	/* allocate wq and format name */
553791ccc6e7STejun Heo 	if (flags & WQ_UNBOUND)
553891ccc6e7STejun Heo 		wq_size = struct_size(wq, node_nr_active, nr_node_ids + 1);
553991ccc6e7STejun Heo 	else
554091ccc6e7STejun Heo 		wq_size = sizeof(*wq);
554191ccc6e7STejun Heo 
554291ccc6e7STejun Heo 	wq = kzalloc(wq_size, GFP_KERNEL);
5543b196be89STejun Heo 	if (!wq)
5544d2c1d404STejun Heo 		return NULL;
5545b196be89STejun Heo 
55466029a918STejun Heo 	if (flags & WQ_UNBOUND) {
5547be69d00dSThomas Gleixner 		wq->unbound_attrs = alloc_workqueue_attrs();
55486029a918STejun Heo 		if (!wq->unbound_attrs)
55496029a918STejun Heo 			goto err_free_wq;
55506029a918STejun Heo 	}
55516029a918STejun Heo 
5552669de8bdSBart Van Assche 	va_start(args, max_active);
555391ccc6e7STejun Heo 	name_len = vsnprintf(wq->name, sizeof(wq->name), fmt, args);
5554b196be89STejun Heo 	va_end(args);
55553af24433SOleg Nesterov 
555691ccc6e7STejun Heo 	if (name_len >= WQ_NAME_LEN)
555791ccc6e7STejun Heo 		pr_warn_once("workqueue: name exceeds WQ_NAME_LEN. Truncating to: %s\n",
555891ccc6e7STejun Heo 			     wq->name);
555931c89007SAudra Mitchell 
55604cb1ef64STejun Heo 	if (flags & WQ_BH) {
55614cb1ef64STejun Heo 		/*
55624cb1ef64STejun Heo 		 * BH workqueues always share a single execution context per CPU
55634cb1ef64STejun Heo 		 * and don't impose any max_active limit.
55644cb1ef64STejun Heo 		 */
55654cb1ef64STejun Heo 		max_active = INT_MAX;
55664cb1ef64STejun Heo 	} else {
5567d320c038STejun Heo 		max_active = max_active ?: WQ_DFL_ACTIVE;
5568b196be89STejun Heo 		max_active = wq_clamp_max_active(max_active, flags, wq->name);
55694cb1ef64STejun Heo 	}
55703af24433SOleg Nesterov 
5571b196be89STejun Heo 	/* init wq */
557297e37d7bSTejun Heo 	wq->flags = flags;
5573a045a272STejun Heo 	wq->max_active = max_active;
55745797b1c1STejun Heo 	wq->min_active = min(max_active, WQ_DFL_MIN_ACTIVE);
55755797b1c1STejun Heo 	wq->saved_max_active = wq->max_active;
55765797b1c1STejun Heo 	wq->saved_min_active = wq->min_active;
55773c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
5578112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
557930cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
558073f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
558173f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
5582493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
55833af24433SOleg Nesterov 
5584669de8bdSBart Van Assche 	wq_init_lockdep(wq);
5585cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
55863af24433SOleg Nesterov 
558791ccc6e7STejun Heo 	if (flags & WQ_UNBOUND) {
558891ccc6e7STejun Heo 		if (alloc_node_nr_active(wq->node_nr_active) < 0)
558982efcab3SBart Van Assche 			goto err_unreg_lockdep;
559091ccc6e7STejun Heo 	}
559191ccc6e7STejun Heo 
559291ccc6e7STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
559391ccc6e7STejun Heo 		goto err_free_node_nr_active;
55941537663fSTejun Heo 
559540c17f75STejun Heo 	if (wq_online && init_rescuer(wq) < 0)
5596d2c1d404STejun Heo 		goto err_destroy;
5597e22bee78STejun Heo 
5598226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
5599226223abSTejun Heo 		goto err_destroy;
5600226223abSTejun Heo 
56016af8bf3dSOleg Nesterov 	/*
560268e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
560368e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
560468e13a67SLai Jiangshan 	 * list.
56056af8bf3dSOleg Nesterov 	 */
560668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5607a0a1a5fdSTejun Heo 
5608a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
5609a045a272STejun Heo 	wq_adjust_max_active(wq);
5610a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
5611a0a1a5fdSTejun Heo 
5612e2dca7adSTejun Heo 	list_add_tail_rcu(&wq->list, &workqueues);
5613a0a1a5fdSTejun Heo 
561468e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
56153af24433SOleg Nesterov 
56163af24433SOleg Nesterov 	return wq;
5617d2c1d404STejun Heo 
561891ccc6e7STejun Heo err_free_node_nr_active:
561991ccc6e7STejun Heo 	if (wq->flags & WQ_UNBOUND)
562091ccc6e7STejun Heo 		free_node_nr_active(wq->node_nr_active);
562182efcab3SBart Van Assche err_unreg_lockdep:
5622009bb421SBart Van Assche 	wq_unregister_lockdep(wq);
5623009bb421SBart Van Assche 	wq_free_lockdep(wq);
562482efcab3SBart Van Assche err_free_wq:
56256029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
56264690c4abSTejun Heo 	kfree(wq);
5627d2c1d404STejun Heo 	return NULL;
5628d2c1d404STejun Heo err_destroy:
5629d2c1d404STejun Heo 	destroy_workqueue(wq);
56304690c4abSTejun Heo 	return NULL;
56311da177e4SLinus Torvalds }
5632669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue);
56331da177e4SLinus Torvalds 
5634c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq)
5635c29eb853STejun Heo {
5636c29eb853STejun Heo 	int i;
5637c29eb853STejun Heo 
5638c29eb853STejun Heo 	for (i = 0; i < WORK_NR_COLORS; i++)
5639c29eb853STejun Heo 		if (pwq->nr_in_flight[i])
5640c29eb853STejun Heo 			return true;
5641c29eb853STejun Heo 
56429f66cff2STejun Heo 	if ((pwq != rcu_access_pointer(pwq->wq->dfl_pwq)) && (pwq->refcnt > 1))
5643c29eb853STejun Heo 		return true;
5644afa87ce8STejun Heo 	if (!pwq_is_empty(pwq))
5645c29eb853STejun Heo 		return true;
5646c29eb853STejun Heo 
5647c29eb853STejun Heo 	return false;
5648c29eb853STejun Heo }
5649c29eb853STejun Heo 
56503af24433SOleg Nesterov /**
56513af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
56523af24433SOleg Nesterov  * @wq: target workqueue
56533af24433SOleg Nesterov  *
56543af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
56553af24433SOleg Nesterov  */
56563af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
56573af24433SOleg Nesterov {
565849e3cf44STejun Heo 	struct pool_workqueue *pwq;
5659636b927eSTejun Heo 	int cpu;
56603af24433SOleg Nesterov 
5661def98c84STejun Heo 	/*
5662def98c84STejun Heo 	 * Remove it from sysfs first so that sanity check failure doesn't
5663def98c84STejun Heo 	 * lead to sysfs name conflicts.
5664def98c84STejun Heo 	 */
5665def98c84STejun Heo 	workqueue_sysfs_unregister(wq);
5666def98c84STejun Heo 
566733e3f0a3SRichard Clark 	/* mark the workqueue destruction is in progress */
566833e3f0a3SRichard Clark 	mutex_lock(&wq->mutex);
566933e3f0a3SRichard Clark 	wq->flags |= __WQ_DESTROYING;
567033e3f0a3SRichard Clark 	mutex_unlock(&wq->mutex);
567133e3f0a3SRichard Clark 
56729c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
56739c5a2ba7STejun Heo 	drain_workqueue(wq);
5674c8efcc25STejun Heo 
5675def98c84STejun Heo 	/* kill rescuer, if sanity checks fail, leave it w/o rescuer */
5676def98c84STejun Heo 	if (wq->rescuer) {
5677def98c84STejun Heo 		struct worker *rescuer = wq->rescuer;
5678def98c84STejun Heo 
5679def98c84STejun Heo 		/* this prevents new queueing */
5680a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
5681def98c84STejun Heo 		wq->rescuer = NULL;
5682a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
5683def98c84STejun Heo 
5684def98c84STejun Heo 		/* rescuer will empty maydays list before exiting */
5685def98c84STejun Heo 		kthread_stop(rescuer->task);
56868efe1223STejun Heo 		kfree(rescuer);
5687def98c84STejun Heo 	}
5688def98c84STejun Heo 
5689c29eb853STejun Heo 	/*
5690c29eb853STejun Heo 	 * Sanity checks - grab all the locks so that we wait for all
5691c29eb853STejun Heo 	 * in-flight operations which may do put_pwq().
5692c29eb853STejun Heo 	 */
5693c29eb853STejun Heo 	mutex_lock(&wq_pool_mutex);
5694b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
569549e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
5696a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
5697c29eb853STejun Heo 		if (WARN_ON(pwq_busy(pwq))) {
56981d9a6159SKefeng Wang 			pr_warn("%s: %s has the following busy pwq\n",
5699e66b39afSTejun Heo 				__func__, wq->name);
5700c29eb853STejun Heo 			show_pwq(pwq);
5701a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pwq->pool->lock);
5702b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
5703c29eb853STejun Heo 			mutex_unlock(&wq_pool_mutex);
570455df0933SImran Khan 			show_one_workqueue(wq);
57056183c009STejun Heo 			return;
570676af4d93STejun Heo 		}
5707a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
570876af4d93STejun Heo 	}
5709b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
57106183c009STejun Heo 
5711a0a1a5fdSTejun Heo 	/*
5712a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
5713a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
5714a0a1a5fdSTejun Heo 	 */
5715e2dca7adSTejun Heo 	list_del_rcu(&wq->list);
571668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
57173af24433SOleg Nesterov 
57188864b4e5STejun Heo 	/*
5719636b927eSTejun Heo 	 * We're the sole accessor of @wq. Directly access cpu_pwq and dfl_pwq
5720636b927eSTejun Heo 	 * to put the base refs. @wq will be auto-destroyed from the last
5721636b927eSTejun Heo 	 * pwq_put. RCU read lock prevents @wq from going away from under us.
57228864b4e5STejun Heo 	 */
5723636b927eSTejun Heo 	rcu_read_lock();
5724636b927eSTejun Heo 
5725636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
57269f66cff2STejun Heo 		put_pwq_unlocked(unbound_pwq(wq, cpu));
57279f66cff2STejun Heo 		RCU_INIT_POINTER(*unbound_pwq_slot(wq, cpu), NULL);
57284c16bd32STejun Heo 	}
57294c16bd32STejun Heo 
57309f66cff2STejun Heo 	put_pwq_unlocked(unbound_pwq(wq, -1));
57319f66cff2STejun Heo 	RCU_INIT_POINTER(*unbound_pwq_slot(wq, -1), NULL);
5732636b927eSTejun Heo 
5733636b927eSTejun Heo 	rcu_read_unlock();
57343af24433SOleg Nesterov }
57353af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
57363af24433SOleg Nesterov 
5737dcd989cbSTejun Heo /**
5738dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
5739dcd989cbSTejun Heo  * @wq: target workqueue
5740dcd989cbSTejun Heo  * @max_active: new max_active value.
5741dcd989cbSTejun Heo  *
57425797b1c1STejun Heo  * Set max_active of @wq to @max_active. See the alloc_workqueue() function
57435797b1c1STejun Heo  * comment.
5744dcd989cbSTejun Heo  *
5745dcd989cbSTejun Heo  * CONTEXT:
5746dcd989cbSTejun Heo  * Don't call from IRQ context.
5747dcd989cbSTejun Heo  */
5748dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
5749dcd989cbSTejun Heo {
57504cb1ef64STejun Heo 	/* max_active doesn't mean anything for BH workqueues */
57514cb1ef64STejun Heo 	if (WARN_ON(wq->flags & WQ_BH))
57524cb1ef64STejun Heo 		return;
57538719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
57543bc1e711STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
57558719dceaSTejun Heo 		return;
57568719dceaSTejun Heo 
5757f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
5758dcd989cbSTejun Heo 
5759a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
5760dcd989cbSTejun Heo 
5761dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
57625797b1c1STejun Heo 	if (wq->flags & WQ_UNBOUND)
57635797b1c1STejun Heo 		wq->saved_min_active = min(wq->saved_min_active, max_active);
57645797b1c1STejun Heo 
5765a045a272STejun Heo 	wq_adjust_max_active(wq);
5766dcd989cbSTejun Heo 
5767a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
5768dcd989cbSTejun Heo }
5769dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
5770dcd989cbSTejun Heo 
5771dcd989cbSTejun Heo /**
57728f172181STejun Heo  * workqueue_set_min_active - adjust min_active of an unbound workqueue
57738f172181STejun Heo  * @wq: target unbound workqueue
57748f172181STejun Heo  * @min_active: new min_active value
57758f172181STejun Heo  *
57768f172181STejun Heo  * Set min_active of an unbound workqueue. Unlike other types of workqueues, an
57778f172181STejun Heo  * unbound workqueue is not guaranteed to be able to process max_active
57788f172181STejun Heo  * interdependent work items. Instead, an unbound workqueue is guaranteed to be
57798f172181STejun Heo  * able to process min_active number of interdependent work items which is
57808f172181STejun Heo  * %WQ_DFL_MIN_ACTIVE by default.
57818f172181STejun Heo  *
57828f172181STejun Heo  * Use this function to adjust the min_active value between 0 and the current
57838f172181STejun Heo  * max_active.
57848f172181STejun Heo  */
57858f172181STejun Heo void workqueue_set_min_active(struct workqueue_struct *wq, int min_active)
57868f172181STejun Heo {
57878f172181STejun Heo 	/* min_active is only meaningful for non-ordered unbound workqueues */
57888f172181STejun Heo 	if (WARN_ON((wq->flags & (WQ_BH | WQ_UNBOUND | __WQ_ORDERED)) !=
57898f172181STejun Heo 		    WQ_UNBOUND))
57908f172181STejun Heo 		return;
57918f172181STejun Heo 
57928f172181STejun Heo 	mutex_lock(&wq->mutex);
57938f172181STejun Heo 	wq->saved_min_active = clamp(min_active, 0, wq->saved_max_active);
57948f172181STejun Heo 	wq_adjust_max_active(wq);
57958f172181STejun Heo 	mutex_unlock(&wq->mutex);
57968f172181STejun Heo }
57978f172181STejun Heo 
57988f172181STejun Heo /**
579927d4ee03SLukas Wunner  * current_work - retrieve %current task's work struct
580027d4ee03SLukas Wunner  *
580127d4ee03SLukas Wunner  * Determine if %current task is a workqueue worker and what it's working on.
580227d4ee03SLukas Wunner  * Useful to find out the context that the %current task is running in.
580327d4ee03SLukas Wunner  *
580427d4ee03SLukas Wunner  * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
580527d4ee03SLukas Wunner  */
580627d4ee03SLukas Wunner struct work_struct *current_work(void)
580727d4ee03SLukas Wunner {
580827d4ee03SLukas Wunner 	struct worker *worker = current_wq_worker();
580927d4ee03SLukas Wunner 
581027d4ee03SLukas Wunner 	return worker ? worker->current_work : NULL;
581127d4ee03SLukas Wunner }
581227d4ee03SLukas Wunner EXPORT_SYMBOL(current_work);
581327d4ee03SLukas Wunner 
581427d4ee03SLukas Wunner /**
5815e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
5816e6267616STejun Heo  *
5817e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
5818e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
5819d185af30SYacine Belkadi  *
5820d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
5821e6267616STejun Heo  */
5822e6267616STejun Heo bool current_is_workqueue_rescuer(void)
5823e6267616STejun Heo {
5824e6267616STejun Heo 	struct worker *worker = current_wq_worker();
5825e6267616STejun Heo 
58266a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
5827e6267616STejun Heo }
5828e6267616STejun Heo 
5829e6267616STejun Heo /**
5830dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
5831dcd989cbSTejun Heo  * @cpu: CPU in question
5832dcd989cbSTejun Heo  * @wq: target workqueue
5833dcd989cbSTejun Heo  *
5834dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
5835dcd989cbSTejun Heo  * no synchronization around this function and the test result is
5836dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
5837dcd989cbSTejun Heo  *
5838d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
5839636b927eSTejun Heo  *
5840636b927eSTejun Heo  * With the exception of ordered workqueues, all workqueues have per-cpu
5841636b927eSTejun Heo  * pool_workqueues, each with its own congested state. A workqueue being
5842636b927eSTejun Heo  * congested on one CPU doesn't mean that the workqueue is contested on any
5843636b927eSTejun Heo  * other CPUs.
5844d3251859STejun Heo  *
5845d185af30SYacine Belkadi  * Return:
5846dcd989cbSTejun Heo  * %true if congested, %false otherwise.
5847dcd989cbSTejun Heo  */
5848d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
5849dcd989cbSTejun Heo {
58507fb98ea7STejun Heo 	struct pool_workqueue *pwq;
585176af4d93STejun Heo 	bool ret;
585276af4d93STejun Heo 
585324acfb71SThomas Gleixner 	rcu_read_lock();
585424acfb71SThomas Gleixner 	preempt_disable();
58557fb98ea7STejun Heo 
5856d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
5857d3251859STejun Heo 		cpu = smp_processor_id();
5858d3251859STejun Heo 
5859687a9aa5STejun Heo 	pwq = *per_cpu_ptr(wq->cpu_pwq, cpu);
5860f97a4a1aSLai Jiangshan 	ret = !list_empty(&pwq->inactive_works);
5861636b927eSTejun Heo 
586224acfb71SThomas Gleixner 	preempt_enable();
586324acfb71SThomas Gleixner 	rcu_read_unlock();
586476af4d93STejun Heo 
586576af4d93STejun Heo 	return ret;
5866dcd989cbSTejun Heo }
5867dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
5868dcd989cbSTejun Heo 
5869dcd989cbSTejun Heo /**
5870dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
5871dcd989cbSTejun Heo  * @work: the work to be tested
5872dcd989cbSTejun Heo  *
5873dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
5874dcd989cbSTejun Heo  * synchronization around this function and the test result is
5875dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
5876dcd989cbSTejun Heo  *
5877d185af30SYacine Belkadi  * Return:
5878dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
5879dcd989cbSTejun Heo  */
5880dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
5881dcd989cbSTejun Heo {
5882fa1b54e6STejun Heo 	struct worker_pool *pool;
5883c26e2f2eSTejun Heo 	unsigned long irq_flags;
5884dcd989cbSTejun Heo 	unsigned int ret = 0;
5885dcd989cbSTejun Heo 
5886dcd989cbSTejun Heo 	if (work_pending(work))
5887dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
5888038366c5SLai Jiangshan 
588924acfb71SThomas Gleixner 	rcu_read_lock();
5890fa1b54e6STejun Heo 	pool = get_work_pool(work);
5891038366c5SLai Jiangshan 	if (pool) {
5892c26e2f2eSTejun Heo 		raw_spin_lock_irqsave(&pool->lock, irq_flags);
5893c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
5894dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
5895c26e2f2eSTejun Heo 		raw_spin_unlock_irqrestore(&pool->lock, irq_flags);
5896038366c5SLai Jiangshan 	}
589724acfb71SThomas Gleixner 	rcu_read_unlock();
5898dcd989cbSTejun Heo 
5899dcd989cbSTejun Heo 	return ret;
5900dcd989cbSTejun Heo }
5901dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
5902dcd989cbSTejun Heo 
59033d1cb205STejun Heo /**
59043d1cb205STejun Heo  * set_worker_desc - set description for the current work item
59053d1cb205STejun Heo  * @fmt: printf-style format string
59063d1cb205STejun Heo  * @...: arguments for the format string
59073d1cb205STejun Heo  *
59083d1cb205STejun Heo  * This function can be called by a running work function to describe what
59093d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
59103d1cb205STejun Heo  * information will be printed out together to help debugging.  The
59113d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
59123d1cb205STejun Heo  */
59133d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
59143d1cb205STejun Heo {
59153d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
59163d1cb205STejun Heo 	va_list args;
59173d1cb205STejun Heo 
59183d1cb205STejun Heo 	if (worker) {
59193d1cb205STejun Heo 		va_start(args, fmt);
59203d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
59213d1cb205STejun Heo 		va_end(args);
59223d1cb205STejun Heo 	}
59233d1cb205STejun Heo }
59245c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc);
59253d1cb205STejun Heo 
59263d1cb205STejun Heo /**
59273d1cb205STejun Heo  * print_worker_info - print out worker information and description
59283d1cb205STejun Heo  * @log_lvl: the log level to use when printing
59293d1cb205STejun Heo  * @task: target task
59303d1cb205STejun Heo  *
59313d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
59323d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
59333d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
59343d1cb205STejun Heo  *
59353d1cb205STejun Heo  * This function can be safely called on any task as long as the
59363d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
59373d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
59383d1cb205STejun Heo  */
59393d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
59403d1cb205STejun Heo {
59413d1cb205STejun Heo 	work_func_t *fn = NULL;
59423d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
59433d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
59443d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
59453d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
59463d1cb205STejun Heo 	struct worker *worker;
59473d1cb205STejun Heo 
59483d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
59493d1cb205STejun Heo 		return;
59503d1cb205STejun Heo 
59513d1cb205STejun Heo 	/*
59523d1cb205STejun Heo 	 * This function is called without any synchronization and @task
59533d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
59543d1cb205STejun Heo 	 */
5955e700591aSPetr Mladek 	worker = kthread_probe_data(task);
59563d1cb205STejun Heo 
59573d1cb205STejun Heo 	/*
59588bf89593STejun Heo 	 * Carefully copy the associated workqueue's workfn, name and desc.
59598bf89593STejun Heo 	 * Keep the original last '\0' in case the original is garbage.
59603d1cb205STejun Heo 	 */
5961fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
5962fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
5963fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
5964fe557319SChristoph Hellwig 	copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
5965fe557319SChristoph Hellwig 	copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
59663d1cb205STejun Heo 
59673d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
5968d75f773cSSakari Ailus 		printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
59698bf89593STejun Heo 		if (strcmp(name, desc))
59703d1cb205STejun Heo 			pr_cont(" (%s)", desc);
59713d1cb205STejun Heo 		pr_cont("\n");
59723d1cb205STejun Heo 	}
59733d1cb205STejun Heo }
59743d1cb205STejun Heo 
59753494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool)
59763494fc30STejun Heo {
59773494fc30STejun Heo 	pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
59783494fc30STejun Heo 	if (pool->node != NUMA_NO_NODE)
59793494fc30STejun Heo 		pr_cont(" node=%d", pool->node);
59804cb1ef64STejun Heo 	pr_cont(" flags=0x%x", pool->flags);
59814cb1ef64STejun Heo 	if (pool->flags & POOL_BH)
59824cb1ef64STejun Heo 		pr_cont(" bh%s",
59834cb1ef64STejun Heo 			pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : "");
59844cb1ef64STejun Heo 	else
59854cb1ef64STejun Heo 		pr_cont(" nice=%d", pool->attrs->nice);
59864cb1ef64STejun Heo }
59874cb1ef64STejun Heo 
59884cb1ef64STejun Heo static void pr_cont_worker_id(struct worker *worker)
59894cb1ef64STejun Heo {
59904cb1ef64STejun Heo 	struct worker_pool *pool = worker->pool;
59914cb1ef64STejun Heo 
59924cb1ef64STejun Heo 	if (pool->flags & WQ_BH)
59934cb1ef64STejun Heo 		pr_cont("bh%s",
59944cb1ef64STejun Heo 			pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : "");
59954cb1ef64STejun Heo 	else
59964cb1ef64STejun Heo 		pr_cont("%d%s", task_pid_nr(worker->task),
59974cb1ef64STejun Heo 			worker->rescue_wq ? "(RESCUER)" : "");
59983494fc30STejun Heo }
59993494fc30STejun Heo 
6000c76feb0dSPaul E. McKenney struct pr_cont_work_struct {
6001c76feb0dSPaul E. McKenney 	bool comma;
6002c76feb0dSPaul E. McKenney 	work_func_t func;
6003c76feb0dSPaul E. McKenney 	long ctr;
6004c76feb0dSPaul E. McKenney };
6005c76feb0dSPaul E. McKenney 
6006c76feb0dSPaul E. McKenney static void pr_cont_work_flush(bool comma, work_func_t func, struct pr_cont_work_struct *pcwsp)
6007c76feb0dSPaul E. McKenney {
6008c76feb0dSPaul E. McKenney 	if (!pcwsp->ctr)
6009c76feb0dSPaul E. McKenney 		goto out_record;
6010c76feb0dSPaul E. McKenney 	if (func == pcwsp->func) {
6011c76feb0dSPaul E. McKenney 		pcwsp->ctr++;
6012c76feb0dSPaul E. McKenney 		return;
6013c76feb0dSPaul E. McKenney 	}
6014c76feb0dSPaul E. McKenney 	if (pcwsp->ctr == 1)
6015c76feb0dSPaul E. McKenney 		pr_cont("%s %ps", pcwsp->comma ? "," : "", pcwsp->func);
6016c76feb0dSPaul E. McKenney 	else
6017c76feb0dSPaul E. McKenney 		pr_cont("%s %ld*%ps", pcwsp->comma ? "," : "", pcwsp->ctr, pcwsp->func);
6018c76feb0dSPaul E. McKenney 	pcwsp->ctr = 0;
6019c76feb0dSPaul E. McKenney out_record:
6020c76feb0dSPaul E. McKenney 	if ((long)func == -1L)
6021c76feb0dSPaul E. McKenney 		return;
6022c76feb0dSPaul E. McKenney 	pcwsp->comma = comma;
6023c76feb0dSPaul E. McKenney 	pcwsp->func = func;
6024c76feb0dSPaul E. McKenney 	pcwsp->ctr = 1;
6025c76feb0dSPaul E. McKenney }
6026c76feb0dSPaul E. McKenney 
6027c76feb0dSPaul E. McKenney static void pr_cont_work(bool comma, struct work_struct *work, struct pr_cont_work_struct *pcwsp)
60283494fc30STejun Heo {
60293494fc30STejun Heo 	if (work->func == wq_barrier_func) {
60303494fc30STejun Heo 		struct wq_barrier *barr;
60313494fc30STejun Heo 
60323494fc30STejun Heo 		barr = container_of(work, struct wq_barrier, work);
60333494fc30STejun Heo 
6034c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
60353494fc30STejun Heo 		pr_cont("%s BAR(%d)", comma ? "," : "",
60363494fc30STejun Heo 			task_pid_nr(barr->task));
60373494fc30STejun Heo 	} else {
6038c76feb0dSPaul E. McKenney 		if (!comma)
6039c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
6040c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, work->func, pcwsp);
60413494fc30STejun Heo 	}
60423494fc30STejun Heo }
60433494fc30STejun Heo 
60443494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq)
60453494fc30STejun Heo {
6046c76feb0dSPaul E. McKenney 	struct pr_cont_work_struct pcws = { .ctr = 0, };
60473494fc30STejun Heo 	struct worker_pool *pool = pwq->pool;
60483494fc30STejun Heo 	struct work_struct *work;
60493494fc30STejun Heo 	struct worker *worker;
60503494fc30STejun Heo 	bool has_in_flight = false, has_pending = false;
60513494fc30STejun Heo 	int bkt;
60523494fc30STejun Heo 
60533494fc30STejun Heo 	pr_info("  pwq %d:", pool->id);
60543494fc30STejun Heo 	pr_cont_pool_info(pool);
60553494fc30STejun Heo 
6056a045a272STejun Heo 	pr_cont(" active=%d refcnt=%d%s\n",
6057a045a272STejun Heo 		pwq->nr_active, pwq->refcnt,
60583494fc30STejun Heo 		!list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
60593494fc30STejun Heo 
60603494fc30STejun Heo 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
60613494fc30STejun Heo 		if (worker->current_pwq == pwq) {
60623494fc30STejun Heo 			has_in_flight = true;
60633494fc30STejun Heo 			break;
60643494fc30STejun Heo 		}
60653494fc30STejun Heo 	}
60663494fc30STejun Heo 	if (has_in_flight) {
60673494fc30STejun Heo 		bool comma = false;
60683494fc30STejun Heo 
60693494fc30STejun Heo 		pr_info("    in-flight:");
60703494fc30STejun Heo 		hash_for_each(pool->busy_hash, bkt, worker, hentry) {
60713494fc30STejun Heo 			if (worker->current_pwq != pwq)
60723494fc30STejun Heo 				continue;
60733494fc30STejun Heo 
60744cb1ef64STejun Heo 			pr_cont(" %s", comma ? "," : "");
60754cb1ef64STejun Heo 			pr_cont_worker_id(worker);
60764cb1ef64STejun Heo 			pr_cont(":%ps", worker->current_func);
60773494fc30STejun Heo 			list_for_each_entry(work, &worker->scheduled, entry)
6078c76feb0dSPaul E. McKenney 				pr_cont_work(false, work, &pcws);
6079c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
60803494fc30STejun Heo 			comma = true;
60813494fc30STejun Heo 		}
60823494fc30STejun Heo 		pr_cont("\n");
60833494fc30STejun Heo 	}
60843494fc30STejun Heo 
60853494fc30STejun Heo 	list_for_each_entry(work, &pool->worklist, entry) {
60863494fc30STejun Heo 		if (get_work_pwq(work) == pwq) {
60873494fc30STejun Heo 			has_pending = true;
60883494fc30STejun Heo 			break;
60893494fc30STejun Heo 		}
60903494fc30STejun Heo 	}
60913494fc30STejun Heo 	if (has_pending) {
60923494fc30STejun Heo 		bool comma = false;
60933494fc30STejun Heo 
60943494fc30STejun Heo 		pr_info("    pending:");
60953494fc30STejun Heo 		list_for_each_entry(work, &pool->worklist, entry) {
60963494fc30STejun Heo 			if (get_work_pwq(work) != pwq)
60973494fc30STejun Heo 				continue;
60983494fc30STejun Heo 
6099c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
61003494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
61013494fc30STejun Heo 		}
6102c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
61033494fc30STejun Heo 		pr_cont("\n");
61043494fc30STejun Heo 	}
61053494fc30STejun Heo 
6106f97a4a1aSLai Jiangshan 	if (!list_empty(&pwq->inactive_works)) {
61073494fc30STejun Heo 		bool comma = false;
61083494fc30STejun Heo 
6109f97a4a1aSLai Jiangshan 		pr_info("    inactive:");
6110f97a4a1aSLai Jiangshan 		list_for_each_entry(work, &pwq->inactive_works, entry) {
6111c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
61123494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
61133494fc30STejun Heo 		}
6114c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
61153494fc30STejun Heo 		pr_cont("\n");
61163494fc30STejun Heo 	}
61173494fc30STejun Heo }
61183494fc30STejun Heo 
61193494fc30STejun Heo /**
612055df0933SImran Khan  * show_one_workqueue - dump state of specified workqueue
612155df0933SImran Khan  * @wq: workqueue whose state will be printed
61223494fc30STejun Heo  */
612355df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq)
61243494fc30STejun Heo {
61253494fc30STejun Heo 	struct pool_workqueue *pwq;
61263494fc30STejun Heo 	bool idle = true;
6127c26e2f2eSTejun Heo 	unsigned long irq_flags;
61283494fc30STejun Heo 
61293494fc30STejun Heo 	for_each_pwq(pwq, wq) {
6130afa87ce8STejun Heo 		if (!pwq_is_empty(pwq)) {
61313494fc30STejun Heo 			idle = false;
61323494fc30STejun Heo 			break;
61333494fc30STejun Heo 		}
61343494fc30STejun Heo 	}
613555df0933SImran Khan 	if (idle) /* Nothing to print for idle workqueue */
613655df0933SImran Khan 		return;
61373494fc30STejun Heo 
61383494fc30STejun Heo 	pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
61393494fc30STejun Heo 
61403494fc30STejun Heo 	for_each_pwq(pwq, wq) {
6141c26e2f2eSTejun Heo 		raw_spin_lock_irqsave(&pwq->pool->lock, irq_flags);
6142afa87ce8STejun Heo 		if (!pwq_is_empty(pwq)) {
614357116ce1SJohan Hovold 			/*
614457116ce1SJohan Hovold 			 * Defer printing to avoid deadlocks in console
614557116ce1SJohan Hovold 			 * drivers that queue work while holding locks
614657116ce1SJohan Hovold 			 * also taken in their write paths.
614757116ce1SJohan Hovold 			 */
614857116ce1SJohan Hovold 			printk_deferred_enter();
61493494fc30STejun Heo 			show_pwq(pwq);
615057116ce1SJohan Hovold 			printk_deferred_exit();
615157116ce1SJohan Hovold 		}
6152c26e2f2eSTejun Heo 		raw_spin_unlock_irqrestore(&pwq->pool->lock, irq_flags);
615362635ea8SSergey Senozhatsky 		/*
615462635ea8SSergey Senozhatsky 		 * We could be printing a lot from atomic context, e.g.
615555df0933SImran Khan 		 * sysrq-t -> show_all_workqueues(). Avoid triggering
615662635ea8SSergey Senozhatsky 		 * hard lockup.
615762635ea8SSergey Senozhatsky 		 */
615862635ea8SSergey Senozhatsky 		touch_nmi_watchdog();
61593494fc30STejun Heo 	}
616055df0933SImran Khan 
61613494fc30STejun Heo }
61623494fc30STejun Heo 
616355df0933SImran Khan /**
616455df0933SImran Khan  * show_one_worker_pool - dump state of specified worker pool
616555df0933SImran Khan  * @pool: worker pool whose state will be printed
616655df0933SImran Khan  */
616755df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool)
616855df0933SImran Khan {
61693494fc30STejun Heo 	struct worker *worker;
61703494fc30STejun Heo 	bool first = true;
6171c26e2f2eSTejun Heo 	unsigned long irq_flags;
6172335a42ebSPetr Mladek 	unsigned long hung = 0;
61733494fc30STejun Heo 
6174c26e2f2eSTejun Heo 	raw_spin_lock_irqsave(&pool->lock, irq_flags);
61753494fc30STejun Heo 	if (pool->nr_workers == pool->nr_idle)
61763494fc30STejun Heo 		goto next_pool;
6177335a42ebSPetr Mladek 
6178335a42ebSPetr Mladek 	/* How long the first pending work is waiting for a worker. */
6179335a42ebSPetr Mladek 	if (!list_empty(&pool->worklist))
6180335a42ebSPetr Mladek 		hung = jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000;
6181335a42ebSPetr Mladek 
618257116ce1SJohan Hovold 	/*
618357116ce1SJohan Hovold 	 * Defer printing to avoid deadlocks in console drivers that
618457116ce1SJohan Hovold 	 * queue work while holding locks also taken in their write
618557116ce1SJohan Hovold 	 * paths.
618657116ce1SJohan Hovold 	 */
618757116ce1SJohan Hovold 	printk_deferred_enter();
61883494fc30STejun Heo 	pr_info("pool %d:", pool->id);
61893494fc30STejun Heo 	pr_cont_pool_info(pool);
6190335a42ebSPetr Mladek 	pr_cont(" hung=%lus workers=%d", hung, pool->nr_workers);
61913494fc30STejun Heo 	if (pool->manager)
61923494fc30STejun Heo 		pr_cont(" manager: %d",
61933494fc30STejun Heo 			task_pid_nr(pool->manager->task));
61943494fc30STejun Heo 	list_for_each_entry(worker, &pool->idle_list, entry) {
61954cb1ef64STejun Heo 		pr_cont(" %s", first ? "idle: " : "");
61964cb1ef64STejun Heo 		pr_cont_worker_id(worker);
61973494fc30STejun Heo 		first = false;
61983494fc30STejun Heo 	}
61993494fc30STejun Heo 	pr_cont("\n");
620057116ce1SJohan Hovold 	printk_deferred_exit();
62013494fc30STejun Heo next_pool:
6202c26e2f2eSTejun Heo 	raw_spin_unlock_irqrestore(&pool->lock, irq_flags);
620362635ea8SSergey Senozhatsky 	/*
620462635ea8SSergey Senozhatsky 	 * We could be printing a lot from atomic context, e.g.
620555df0933SImran Khan 	 * sysrq-t -> show_all_workqueues(). Avoid triggering
620662635ea8SSergey Senozhatsky 	 * hard lockup.
620762635ea8SSergey Senozhatsky 	 */
620862635ea8SSergey Senozhatsky 	touch_nmi_watchdog();
620955df0933SImran Khan 
62103494fc30STejun Heo }
62113494fc30STejun Heo 
621255df0933SImran Khan /**
621355df0933SImran Khan  * show_all_workqueues - dump workqueue state
621455df0933SImran Khan  *
6215704bc669SJungseung Lee  * Called from a sysrq handler and prints out all busy workqueues and pools.
621655df0933SImran Khan  */
621755df0933SImran Khan void show_all_workqueues(void)
621855df0933SImran Khan {
621955df0933SImran Khan 	struct workqueue_struct *wq;
622055df0933SImran Khan 	struct worker_pool *pool;
622155df0933SImran Khan 	int pi;
622255df0933SImran Khan 
622355df0933SImran Khan 	rcu_read_lock();
622455df0933SImran Khan 
622555df0933SImran Khan 	pr_info("Showing busy workqueues and worker pools:\n");
622655df0933SImran Khan 
622755df0933SImran Khan 	list_for_each_entry_rcu(wq, &workqueues, list)
622855df0933SImran Khan 		show_one_workqueue(wq);
622955df0933SImran Khan 
623055df0933SImran Khan 	for_each_pool(pool, pi)
623155df0933SImran Khan 		show_one_worker_pool(pool);
623255df0933SImran Khan 
623324acfb71SThomas Gleixner 	rcu_read_unlock();
62343494fc30STejun Heo }
62353494fc30STejun Heo 
6236704bc669SJungseung Lee /**
6237704bc669SJungseung Lee  * show_freezable_workqueues - dump freezable workqueue state
6238704bc669SJungseung Lee  *
6239704bc669SJungseung Lee  * Called from try_to_freeze_tasks() and prints out all freezable workqueues
6240704bc669SJungseung Lee  * still busy.
6241704bc669SJungseung Lee  */
6242704bc669SJungseung Lee void show_freezable_workqueues(void)
6243704bc669SJungseung Lee {
6244704bc669SJungseung Lee 	struct workqueue_struct *wq;
6245704bc669SJungseung Lee 
6246704bc669SJungseung Lee 	rcu_read_lock();
6247704bc669SJungseung Lee 
6248704bc669SJungseung Lee 	pr_info("Showing freezable workqueues that are still busy:\n");
6249704bc669SJungseung Lee 
6250704bc669SJungseung Lee 	list_for_each_entry_rcu(wq, &workqueues, list) {
6251704bc669SJungseung Lee 		if (!(wq->flags & WQ_FREEZABLE))
6252704bc669SJungseung Lee 			continue;
6253704bc669SJungseung Lee 		show_one_workqueue(wq);
6254704bc669SJungseung Lee 	}
6255704bc669SJungseung Lee 
6256704bc669SJungseung Lee 	rcu_read_unlock();
6257704bc669SJungseung Lee }
6258704bc669SJungseung Lee 
62596b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */
62606b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
62616b59808bSTejun Heo {
62626b59808bSTejun Heo 	int off;
62636b59808bSTejun Heo 
62646b59808bSTejun Heo 	/* always show the actual comm */
62656b59808bSTejun Heo 	off = strscpy(buf, task->comm, size);
62666b59808bSTejun Heo 	if (off < 0)
62676b59808bSTejun Heo 		return;
62686b59808bSTejun Heo 
6269197f6accSTejun Heo 	/* stabilize PF_WQ_WORKER and worker pool association */
62706b59808bSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
62716b59808bSTejun Heo 
6272197f6accSTejun Heo 	if (task->flags & PF_WQ_WORKER) {
6273197f6accSTejun Heo 		struct worker *worker = kthread_data(task);
6274197f6accSTejun Heo 		struct worker_pool *pool = worker->pool;
62756b59808bSTejun Heo 
62766b59808bSTejun Heo 		if (pool) {
6277a9b8a985SSebastian Andrzej Siewior 			raw_spin_lock_irq(&pool->lock);
62786b59808bSTejun Heo 			/*
6279197f6accSTejun Heo 			 * ->desc tracks information (wq name or
6280197f6accSTejun Heo 			 * set_worker_desc()) for the latest execution.  If
6281197f6accSTejun Heo 			 * current, prepend '+', otherwise '-'.
62826b59808bSTejun Heo 			 */
62836b59808bSTejun Heo 			if (worker->desc[0] != '\0') {
62846b59808bSTejun Heo 				if (worker->current_work)
62856b59808bSTejun Heo 					scnprintf(buf + off, size - off, "+%s",
62866b59808bSTejun Heo 						  worker->desc);
62876b59808bSTejun Heo 				else
62886b59808bSTejun Heo 					scnprintf(buf + off, size - off, "-%s",
62896b59808bSTejun Heo 						  worker->desc);
62906b59808bSTejun Heo 			}
6291a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pool->lock);
62926b59808bSTejun Heo 		}
6293197f6accSTejun Heo 	}
62946b59808bSTejun Heo 
62956b59808bSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
62966b59808bSTejun Heo }
62976b59808bSTejun Heo 
629866448bc2SMathieu Malaterre #ifdef CONFIG_SMP
629966448bc2SMathieu Malaterre 
6300db7bccf4STejun Heo /*
6301db7bccf4STejun Heo  * CPU hotplug.
6302db7bccf4STejun Heo  *
6303e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
6304112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
6305706026c2STejun Heo  * pool which make migrating pending and scheduled works very
6306e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
630794cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
6308e22bee78STejun Heo  * blocked draining impractical.
6309e22bee78STejun Heo  *
631024647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
6311628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
6312628c78e7STejun Heo  * cpu comes back online.
6313db7bccf4STejun Heo  */
6314db7bccf4STejun Heo 
6315e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu)
6316db7bccf4STejun Heo {
63174ce62e9eSTejun Heo 	struct worker_pool *pool;
6318db7bccf4STejun Heo 	struct worker *worker;
6319db7bccf4STejun Heo 
6320f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
63211258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
6322a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
6323e22bee78STejun Heo 
6324f2d5a0eeSTejun Heo 		/*
632592f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
632694cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
632711b45b0bSLai Jiangshan 		 * must be on the cpu.  After this, they may become diasporas.
6328b4ac9384SLai Jiangshan 		 * And the preemption disabled section in their sched callbacks
6329b4ac9384SLai Jiangshan 		 * are guaranteed to see WORKER_UNBOUND since the code here
6330b4ac9384SLai Jiangshan 		 * is on the same cpu.
6331f2d5a0eeSTejun Heo 		 */
6332da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
6333403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
6334db7bccf4STejun Heo 
633524647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
6336f2d5a0eeSTejun Heo 
6337e22bee78STejun Heo 		/*
6338989442d7SLai Jiangshan 		 * The handling of nr_running in sched callbacks are disabled
6339989442d7SLai Jiangshan 		 * now.  Zap nr_running.  After this, nr_running stays zero and
6340989442d7SLai Jiangshan 		 * need_more_worker() and keep_working() are always true as
6341989442d7SLai Jiangshan 		 * long as the worklist is not empty.  This pool now behaves as
6342989442d7SLai Jiangshan 		 * an unbound (in terms of concurrency management) pool which
6343eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
6344e22bee78STejun Heo 		 */
6345bc35f7efSLai Jiangshan 		pool->nr_running = 0;
6346eb283428SLai Jiangshan 
6347eb283428SLai Jiangshan 		/*
6348eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
6349eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
6350eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
6351eb283428SLai Jiangshan 		 */
63520219a352STejun Heo 		kick_pool(pool);
6353989442d7SLai Jiangshan 
6354a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
6355989442d7SLai Jiangshan 
6356793777bcSValentin Schneider 		for_each_pool_worker(worker, pool)
6357793777bcSValentin Schneider 			unbind_worker(worker);
6358989442d7SLai Jiangshan 
6359989442d7SLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
6360eb283428SLai Jiangshan 	}
6361db7bccf4STejun Heo }
6362db7bccf4STejun Heo 
6363bd7c089eSTejun Heo /**
6364bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
6365bd7c089eSTejun Heo  * @pool: pool of interest
6366bd7c089eSTejun Heo  *
6367a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
6368bd7c089eSTejun Heo  */
6369bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
6370bd7c089eSTejun Heo {
6371a9ab775bSTejun Heo 	struct worker *worker;
6372bd7c089eSTejun Heo 
63731258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
6374bd7c089eSTejun Heo 
6375bd7c089eSTejun Heo 	/*
6376a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
6377a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
6378402dd89dSShailendra Verma 	 * wake-ups for concurrency management happen, restore CPU affinity
6379a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
6380a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
6381bd7c089eSTejun Heo 	 */
6382c63a2e52SValentin Schneider 	for_each_pool_worker(worker, pool) {
6383c63a2e52SValentin Schneider 		kthread_set_per_cpu(worker->task, pool->cpu);
6384c63a2e52SValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
63859546b29eSTejun Heo 						  pool_allowed_cpus(pool)) < 0);
6386c63a2e52SValentin Schneider 	}
6387a9ab775bSTejun Heo 
6388a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
6389f7c17d26SWanpeng Li 
63903de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
6391a9ab775bSTejun Heo 
6392da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
6393a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
6394a9ab775bSTejun Heo 
6395a9ab775bSTejun Heo 		/*
6396a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
6397a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
6398a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
6399a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
6400a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
6401a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
6402a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
6403a9ab775bSTejun Heo 		 *
6404c95491edSMark Rutland 		 * WRITE_ONCE() is necessary because @worker->flags may be
6405a9ab775bSTejun Heo 		 * tested without holding any lock in
64066d25be57SThomas Gleixner 		 * wq_worker_running().  Without it, NOT_RUNNING test may
6407a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
6408a9ab775bSTejun Heo 		 * management operations.
6409bd7c089eSTejun Heo 		 */
6410a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
6411a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
6412a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
6413c95491edSMark Rutland 		WRITE_ONCE(worker->flags, worker_flags);
6414bd7c089eSTejun Heo 	}
6415a9ab775bSTejun Heo 
6416a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
6417bd7c089eSTejun Heo }
6418bd7c089eSTejun Heo 
64197dbc725eSTejun Heo /**
64207dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
64217dbc725eSTejun Heo  * @pool: unbound pool of interest
64227dbc725eSTejun Heo  * @cpu: the CPU which is coming up
64237dbc725eSTejun Heo  *
64247dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
64257dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
64267dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
64277dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
64287dbc725eSTejun Heo  */
64297dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
64307dbc725eSTejun Heo {
64317dbc725eSTejun Heo 	static cpumask_t cpumask;
64327dbc725eSTejun Heo 	struct worker *worker;
64337dbc725eSTejun Heo 
64341258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
64357dbc725eSTejun Heo 
64367dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
64377dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
64387dbc725eSTejun Heo 		return;
64397dbc725eSTejun Heo 
64407dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
64417dbc725eSTejun Heo 
64427dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
6443da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
6444d945b5e9SPeter Zijlstra 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
64457dbc725eSTejun Heo }
64467dbc725eSTejun Heo 
64477ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu)
64481da177e4SLinus Torvalds {
64494ce62e9eSTejun Heo 	struct worker_pool *pool;
64501da177e4SLinus Torvalds 
6451f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
64523ce63377STejun Heo 		if (pool->nr_workers)
64533ce63377STejun Heo 			continue;
6454051e1850SLai Jiangshan 		if (!create_worker(pool))
64557ee681b2SThomas Gleixner 			return -ENOMEM;
64563af24433SOleg Nesterov 	}
64577ee681b2SThomas Gleixner 	return 0;
64587ee681b2SThomas Gleixner }
64591da177e4SLinus Torvalds 
64607ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu)
64617ee681b2SThomas Gleixner {
64627ee681b2SThomas Gleixner 	struct worker_pool *pool;
64637ee681b2SThomas Gleixner 	struct workqueue_struct *wq;
64647ee681b2SThomas Gleixner 	int pi;
64657ee681b2SThomas Gleixner 
646668e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
64677dbc725eSTejun Heo 
64687dbc725eSTejun Heo 	for_each_pool(pool, pi) {
64694cb1ef64STejun Heo 		/* BH pools aren't affected by hotplug */
64704cb1ef64STejun Heo 		if (pool->flags & POOL_BH)
64714cb1ef64STejun Heo 			continue;
647294cf58bbSTejun Heo 
64734cb1ef64STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
6474f05b558dSLai Jiangshan 		if (pool->cpu == cpu)
647594cf58bbSTejun Heo 			rebind_workers(pool);
6476f05b558dSLai Jiangshan 		else if (pool->cpu < 0)
64777dbc725eSTejun Heo 			restore_unbound_workers_cpumask(pool, cpu);
64781258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
647994cf58bbSTejun Heo 	}
64807dbc725eSTejun Heo 
6481fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
64824cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
648384193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
648484193c07STejun Heo 
648584193c07STejun Heo 		if (attrs) {
648684193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
64874cbfd3deSTejun Heo 			int tcpu;
64884cbfd3deSTejun Heo 
648984193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
6490fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, true);
64915797b1c1STejun Heo 
64925797b1c1STejun Heo 			mutex_lock(&wq->mutex);
64935797b1c1STejun Heo 			wq_update_node_max_active(wq, -1);
64945797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
64954cbfd3deSTejun Heo 		}
64964cbfd3deSTejun Heo 	}
64974c16bd32STejun Heo 
649868e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
64997ee681b2SThomas Gleixner 	return 0;
650065758202STejun Heo }
650165758202STejun Heo 
65027ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu)
650365758202STejun Heo {
65044c16bd32STejun Heo 	struct workqueue_struct *wq;
65058db25e78STejun Heo 
65064c16bd32STejun Heo 	/* unbinding per-cpu workers should happen on the local CPU */
6507e8b3f8dbSLai Jiangshan 	if (WARN_ON(cpu != smp_processor_id()))
6508e8b3f8dbSLai Jiangshan 		return -1;
6509e8b3f8dbSLai Jiangshan 
6510e8b3f8dbSLai Jiangshan 	unbind_workers(cpu);
65114c16bd32STejun Heo 
6512fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
65134c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
65144cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
651584193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
651684193c07STejun Heo 
651784193c07STejun Heo 		if (attrs) {
651884193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
65194cbfd3deSTejun Heo 			int tcpu;
65204cbfd3deSTejun Heo 
652184193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
6522fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, false);
65235797b1c1STejun Heo 
65245797b1c1STejun Heo 			mutex_lock(&wq->mutex);
65255797b1c1STejun Heo 			wq_update_node_max_active(wq, cpu);
65265797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
65274cbfd3deSTejun Heo 		}
65284cbfd3deSTejun Heo 	}
65294c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
65304c16bd32STejun Heo 
65317ee681b2SThomas Gleixner 	return 0;
653265758202STejun Heo }
653365758202STejun Heo 
65342d3854a3SRusty Russell struct work_for_cpu {
6535ed48ece2STejun Heo 	struct work_struct work;
65362d3854a3SRusty Russell 	long (*fn)(void *);
65372d3854a3SRusty Russell 	void *arg;
65382d3854a3SRusty Russell 	long ret;
65392d3854a3SRusty Russell };
65402d3854a3SRusty Russell 
6541ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
65422d3854a3SRusty Russell {
6543ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
6544ed48ece2STejun Heo 
65452d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
65462d3854a3SRusty Russell }
65472d3854a3SRusty Russell 
65482d3854a3SRusty Russell /**
6549265f3ed0SFrederic Weisbecker  * work_on_cpu_key - run a function in thread context on a particular cpu
65502d3854a3SRusty Russell  * @cpu: the cpu to run on
65512d3854a3SRusty Russell  * @fn: the function to run
65522d3854a3SRusty Russell  * @arg: the function arg
6553265f3ed0SFrederic Weisbecker  * @key: The lock class key for lock debugging purposes
65542d3854a3SRusty Russell  *
655531ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
65566b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
6557d185af30SYacine Belkadi  *
6558d185af30SYacine Belkadi  * Return: The value @fn returns.
65592d3854a3SRusty Russell  */
6560265f3ed0SFrederic Weisbecker long work_on_cpu_key(int cpu, long (*fn)(void *),
6561265f3ed0SFrederic Weisbecker 		     void *arg, struct lock_class_key *key)
65622d3854a3SRusty Russell {
6563ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
65642d3854a3SRusty Russell 
6565265f3ed0SFrederic Weisbecker 	INIT_WORK_ONSTACK_KEY(&wfc.work, work_for_cpu_fn, key);
6566ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
656712997d1aSBjorn Helgaas 	flush_work(&wfc.work);
6568440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
65692d3854a3SRusty Russell 	return wfc.ret;
65702d3854a3SRusty Russell }
6571265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_key);
65720e8d6a93SThomas Gleixner 
65730e8d6a93SThomas Gleixner /**
6574265f3ed0SFrederic Weisbecker  * work_on_cpu_safe_key - run a function in thread context on a particular cpu
65750e8d6a93SThomas Gleixner  * @cpu: the cpu to run on
65760e8d6a93SThomas Gleixner  * @fn:  the function to run
65770e8d6a93SThomas Gleixner  * @arg: the function argument
6578265f3ed0SFrederic Weisbecker  * @key: The lock class key for lock debugging purposes
65790e8d6a93SThomas Gleixner  *
65800e8d6a93SThomas Gleixner  * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
65810e8d6a93SThomas Gleixner  * any locks which would prevent @fn from completing.
65820e8d6a93SThomas Gleixner  *
65830e8d6a93SThomas Gleixner  * Return: The value @fn returns.
65840e8d6a93SThomas Gleixner  */
6585265f3ed0SFrederic Weisbecker long work_on_cpu_safe_key(int cpu, long (*fn)(void *),
6586265f3ed0SFrederic Weisbecker 			  void *arg, struct lock_class_key *key)
65870e8d6a93SThomas Gleixner {
65880e8d6a93SThomas Gleixner 	long ret = -ENODEV;
65890e8d6a93SThomas Gleixner 
6590ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
65910e8d6a93SThomas Gleixner 	if (cpu_online(cpu))
6592265f3ed0SFrederic Weisbecker 		ret = work_on_cpu_key(cpu, fn, arg, key);
6593ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
65940e8d6a93SThomas Gleixner 	return ret;
65950e8d6a93SThomas Gleixner }
6596265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_safe_key);
65972d3854a3SRusty Russell #endif /* CONFIG_SMP */
65982d3854a3SRusty Russell 
6599a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
6600e7577c50SRusty Russell 
6601a0a1a5fdSTejun Heo /**
6602a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
6603a0a1a5fdSTejun Heo  *
660458a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
6605f97a4a1aSLai Jiangshan  * workqueues will queue new works to their inactive_works list instead of
6606706026c2STejun Heo  * pool->worklist.
6607a0a1a5fdSTejun Heo  *
6608a0a1a5fdSTejun Heo  * CONTEXT:
6609a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
6610a0a1a5fdSTejun Heo  */
6611a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
6612a0a1a5fdSTejun Heo {
661324b8a847STejun Heo 	struct workqueue_struct *wq;
6614a0a1a5fdSTejun Heo 
661568e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6616a0a1a5fdSTejun Heo 
66176183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
6618a0a1a5fdSTejun Heo 	workqueue_freezing = true;
6619a0a1a5fdSTejun Heo 
662024b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6621a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
6622a045a272STejun Heo 		wq_adjust_max_active(wq);
6623a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
6624a1056305STejun Heo 	}
66255bcab335STejun Heo 
662668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6627a0a1a5fdSTejun Heo }
6628a0a1a5fdSTejun Heo 
6629a0a1a5fdSTejun Heo /**
663058a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
6631a0a1a5fdSTejun Heo  *
6632a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
6633a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
6634a0a1a5fdSTejun Heo  *
6635a0a1a5fdSTejun Heo  * CONTEXT:
663668e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
6637a0a1a5fdSTejun Heo  *
6638d185af30SYacine Belkadi  * Return:
663958a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
664058a69cb4STejun Heo  * is complete.
6641a0a1a5fdSTejun Heo  */
6642a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
6643a0a1a5fdSTejun Heo {
6644a0a1a5fdSTejun Heo 	bool busy = false;
664524b8a847STejun Heo 	struct workqueue_struct *wq;
664624b8a847STejun Heo 	struct pool_workqueue *pwq;
6647a0a1a5fdSTejun Heo 
664868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6649a0a1a5fdSTejun Heo 
66506183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
6651a0a1a5fdSTejun Heo 
665224b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
665324b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
665424b8a847STejun Heo 			continue;
6655a0a1a5fdSTejun Heo 		/*
6656a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
6657a0a1a5fdSTejun Heo 		 * to peek without lock.
6658a0a1a5fdSTejun Heo 		 */
665924acfb71SThomas Gleixner 		rcu_read_lock();
666024b8a847STejun Heo 		for_each_pwq(pwq, wq) {
66616183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
6662112202d9STejun Heo 			if (pwq->nr_active) {
6663a0a1a5fdSTejun Heo 				busy = true;
666424acfb71SThomas Gleixner 				rcu_read_unlock();
6665a0a1a5fdSTejun Heo 				goto out_unlock;
6666a0a1a5fdSTejun Heo 			}
6667a0a1a5fdSTejun Heo 		}
666824acfb71SThomas Gleixner 		rcu_read_unlock();
6669a0a1a5fdSTejun Heo 	}
6670a0a1a5fdSTejun Heo out_unlock:
667168e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6672a0a1a5fdSTejun Heo 	return busy;
6673a0a1a5fdSTejun Heo }
6674a0a1a5fdSTejun Heo 
6675a0a1a5fdSTejun Heo /**
6676a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
6677a0a1a5fdSTejun Heo  *
6678a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
6679706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
6680a0a1a5fdSTejun Heo  *
6681a0a1a5fdSTejun Heo  * CONTEXT:
6682a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
6683a0a1a5fdSTejun Heo  */
6684a0a1a5fdSTejun Heo void thaw_workqueues(void)
6685a0a1a5fdSTejun Heo {
668624b8a847STejun Heo 	struct workqueue_struct *wq;
6687a0a1a5fdSTejun Heo 
668868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6689a0a1a5fdSTejun Heo 
6690a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
6691a0a1a5fdSTejun Heo 		goto out_unlock;
6692a0a1a5fdSTejun Heo 
669374b414eaSLai Jiangshan 	workqueue_freezing = false;
669424b8a847STejun Heo 
669524b8a847STejun Heo 	/* restore max_active and repopulate worklist */
669624b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6697a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
6698a045a272STejun Heo 		wq_adjust_max_active(wq);
6699a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
670024b8a847STejun Heo 	}
670124b8a847STejun Heo 
6702a0a1a5fdSTejun Heo out_unlock:
670368e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6704a0a1a5fdSTejun Heo }
6705a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
6706a0a1a5fdSTejun Heo 
670799c621efSLai Jiangshan static int workqueue_apply_unbound_cpumask(const cpumask_var_t unbound_cpumask)
6708042f7df1SLai Jiangshan {
6709042f7df1SLai Jiangshan 	LIST_HEAD(ctxs);
6710042f7df1SLai Jiangshan 	int ret = 0;
6711042f7df1SLai Jiangshan 	struct workqueue_struct *wq;
6712042f7df1SLai Jiangshan 	struct apply_wqattrs_ctx *ctx, *n;
6713042f7df1SLai Jiangshan 
6714042f7df1SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6715042f7df1SLai Jiangshan 
6716042f7df1SLai Jiangshan 	list_for_each_entry(wq, &workqueues, list) {
67178eb17dc1SWaiman Long 		if (!(wq->flags & WQ_UNBOUND) || (wq->flags & __WQ_DESTROYING))
6718042f7df1SLai Jiangshan 			continue;
6719042f7df1SLai Jiangshan 
672099c621efSLai Jiangshan 		ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs, unbound_cpumask);
672184193c07STejun Heo 		if (IS_ERR(ctx)) {
672284193c07STejun Heo 			ret = PTR_ERR(ctx);
6723042f7df1SLai Jiangshan 			break;
6724042f7df1SLai Jiangshan 		}
6725042f7df1SLai Jiangshan 
6726042f7df1SLai Jiangshan 		list_add_tail(&ctx->list, &ctxs);
6727042f7df1SLai Jiangshan 	}
6728042f7df1SLai Jiangshan 
6729042f7df1SLai Jiangshan 	list_for_each_entry_safe(ctx, n, &ctxs, list) {
6730042f7df1SLai Jiangshan 		if (!ret)
6731042f7df1SLai Jiangshan 			apply_wqattrs_commit(ctx);
6732042f7df1SLai Jiangshan 		apply_wqattrs_cleanup(ctx);
6733042f7df1SLai Jiangshan 	}
6734042f7df1SLai Jiangshan 
673599c621efSLai Jiangshan 	if (!ret) {
673699c621efSLai Jiangshan 		mutex_lock(&wq_pool_attach_mutex);
673799c621efSLai Jiangshan 		cpumask_copy(wq_unbound_cpumask, unbound_cpumask);
673899c621efSLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
673999c621efSLai Jiangshan 	}
6740042f7df1SLai Jiangshan 	return ret;
6741042f7df1SLai Jiangshan }
6742042f7df1SLai Jiangshan 
6743042f7df1SLai Jiangshan /**
6744fe28f631SWaiman Long  * workqueue_unbound_exclude_cpumask - Exclude given CPUs from unbound cpumask
6745fe28f631SWaiman Long  * @exclude_cpumask: the cpumask to be excluded from wq_unbound_cpumask
6746fe28f631SWaiman Long  *
6747fe28f631SWaiman Long  * This function can be called from cpuset code to provide a set of isolated
6748fe28f631SWaiman Long  * CPUs that should be excluded from wq_unbound_cpumask. The caller must hold
6749fe28f631SWaiman Long  * either cpus_read_lock or cpus_write_lock.
6750fe28f631SWaiman Long  */
6751fe28f631SWaiman Long int workqueue_unbound_exclude_cpumask(cpumask_var_t exclude_cpumask)
6752fe28f631SWaiman Long {
6753fe28f631SWaiman Long 	cpumask_var_t cpumask;
6754fe28f631SWaiman Long 	int ret = 0;
6755fe28f631SWaiman Long 
6756fe28f631SWaiman Long 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
6757fe28f631SWaiman Long 		return -ENOMEM;
6758fe28f631SWaiman Long 
6759fe28f631SWaiman Long 	lockdep_assert_cpus_held();
6760fe28f631SWaiman Long 	mutex_lock(&wq_pool_mutex);
6761fe28f631SWaiman Long 
6762fe28f631SWaiman Long 	/* Save the current isolated cpumask & export it via sysfs */
6763fe28f631SWaiman Long 	cpumask_copy(wq_isolated_cpumask, exclude_cpumask);
6764fe28f631SWaiman Long 
6765fe28f631SWaiman Long 	/*
6766fe28f631SWaiman Long 	 * If the operation fails, it will fall back to
6767fe28f631SWaiman Long 	 * wq_requested_unbound_cpumask which is initially set to
6768fe28f631SWaiman Long 	 * (HK_TYPE_WQ ∩ HK_TYPE_DOMAIN) house keeping mask and rewritten
6769fe28f631SWaiman Long 	 * by any subsequent write to workqueue/cpumask sysfs file.
6770fe28f631SWaiman Long 	 */
6771fe28f631SWaiman Long 	if (!cpumask_andnot(cpumask, wq_requested_unbound_cpumask, exclude_cpumask))
6772fe28f631SWaiman Long 		cpumask_copy(cpumask, wq_requested_unbound_cpumask);
6773fe28f631SWaiman Long 	if (!cpumask_equal(cpumask, wq_unbound_cpumask))
6774fe28f631SWaiman Long 		ret = workqueue_apply_unbound_cpumask(cpumask);
6775fe28f631SWaiman Long 
6776fe28f631SWaiman Long 	mutex_unlock(&wq_pool_mutex);
6777fe28f631SWaiman Long 	free_cpumask_var(cpumask);
6778fe28f631SWaiman Long 	return ret;
6779fe28f631SWaiman Long }
6780fe28f631SWaiman Long 
678163c5484eSTejun Heo static int parse_affn_scope(const char *val)
678263c5484eSTejun Heo {
678363c5484eSTejun Heo 	int i;
678463c5484eSTejun Heo 
678563c5484eSTejun Heo 	for (i = 0; i < ARRAY_SIZE(wq_affn_names); i++) {
678663c5484eSTejun Heo 		if (!strncasecmp(val, wq_affn_names[i], strlen(wq_affn_names[i])))
678763c5484eSTejun Heo 			return i;
678863c5484eSTejun Heo 	}
678963c5484eSTejun Heo 	return -EINVAL;
679063c5484eSTejun Heo }
679163c5484eSTejun Heo 
679263c5484eSTejun Heo static int wq_affn_dfl_set(const char *val, const struct kernel_param *kp)
679363c5484eSTejun Heo {
6794523a301eSTejun Heo 	struct workqueue_struct *wq;
6795523a301eSTejun Heo 	int affn, cpu;
679663c5484eSTejun Heo 
679763c5484eSTejun Heo 	affn = parse_affn_scope(val);
679863c5484eSTejun Heo 	if (affn < 0)
679963c5484eSTejun Heo 		return affn;
6800523a301eSTejun Heo 	if (affn == WQ_AFFN_DFL)
6801523a301eSTejun Heo 		return -EINVAL;
6802523a301eSTejun Heo 
6803523a301eSTejun Heo 	cpus_read_lock();
6804523a301eSTejun Heo 	mutex_lock(&wq_pool_mutex);
680563c5484eSTejun Heo 
680663c5484eSTejun Heo 	wq_affn_dfl = affn;
6807523a301eSTejun Heo 
6808523a301eSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6809523a301eSTejun Heo 		for_each_online_cpu(cpu) {
6810523a301eSTejun Heo 			wq_update_pod(wq, cpu, cpu, true);
6811523a301eSTejun Heo 		}
6812523a301eSTejun Heo 	}
6813523a301eSTejun Heo 
6814523a301eSTejun Heo 	mutex_unlock(&wq_pool_mutex);
6815523a301eSTejun Heo 	cpus_read_unlock();
6816523a301eSTejun Heo 
681763c5484eSTejun Heo 	return 0;
681863c5484eSTejun Heo }
681963c5484eSTejun Heo 
682063c5484eSTejun Heo static int wq_affn_dfl_get(char *buffer, const struct kernel_param *kp)
682163c5484eSTejun Heo {
682263c5484eSTejun Heo 	return scnprintf(buffer, PAGE_SIZE, "%s\n", wq_affn_names[wq_affn_dfl]);
682363c5484eSTejun Heo }
682463c5484eSTejun Heo 
682563c5484eSTejun Heo static const struct kernel_param_ops wq_affn_dfl_ops = {
682663c5484eSTejun Heo 	.set	= wq_affn_dfl_set,
682763c5484eSTejun Heo 	.get	= wq_affn_dfl_get,
682863c5484eSTejun Heo };
682963c5484eSTejun Heo 
683063c5484eSTejun Heo module_param_cb(default_affinity_scope, &wq_affn_dfl_ops, NULL, 0644);
683163c5484eSTejun Heo 
68326ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS
68336ba94429SFrederic Weisbecker /*
68346ba94429SFrederic Weisbecker  * Workqueues with WQ_SYSFS flag set is visible to userland via
68356ba94429SFrederic Weisbecker  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
68366ba94429SFrederic Weisbecker  * following attributes.
68376ba94429SFrederic Weisbecker  *
68386ba94429SFrederic Weisbecker  *  per_cpu		RO bool	: whether the workqueue is per-cpu or unbound
68396ba94429SFrederic Weisbecker  *  max_active		RW int	: maximum number of in-flight work items
68406ba94429SFrederic Weisbecker  *
68416ba94429SFrederic Weisbecker  * Unbound workqueues have the following extra attributes.
68426ba94429SFrederic Weisbecker  *
68436ba94429SFrederic Weisbecker  *  nice		RW int	: nice value of the workers
68446ba94429SFrederic Weisbecker  *  cpumask		RW mask	: bitmask of allowed CPUs for the workers
684563c5484eSTejun Heo  *  affinity_scope	RW str  : worker CPU affinity scope (cache, numa, none)
68468639ecebSTejun Heo  *  affinity_strict	RW bool : worker CPU affinity is strict
68476ba94429SFrederic Weisbecker  */
68486ba94429SFrederic Weisbecker struct wq_device {
68496ba94429SFrederic Weisbecker 	struct workqueue_struct		*wq;
68506ba94429SFrederic Weisbecker 	struct device			dev;
68516ba94429SFrederic Weisbecker };
68526ba94429SFrederic Weisbecker 
68536ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev)
68546ba94429SFrederic Weisbecker {
68556ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
68566ba94429SFrederic Weisbecker 
68576ba94429SFrederic Weisbecker 	return wq_dev->wq;
68586ba94429SFrederic Weisbecker }
68596ba94429SFrederic Weisbecker 
68606ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
68616ba94429SFrederic Weisbecker 			    char *buf)
68626ba94429SFrederic Weisbecker {
68636ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
68646ba94429SFrederic Weisbecker 
68656ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
68666ba94429SFrederic Weisbecker }
68676ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu);
68686ba94429SFrederic Weisbecker 
68696ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev,
68706ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
68716ba94429SFrederic Weisbecker {
68726ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
68736ba94429SFrederic Weisbecker 
68746ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
68756ba94429SFrederic Weisbecker }
68766ba94429SFrederic Weisbecker 
68776ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev,
68786ba94429SFrederic Weisbecker 				struct device_attribute *attr, const char *buf,
68796ba94429SFrederic Weisbecker 				size_t count)
68806ba94429SFrederic Weisbecker {
68816ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
68826ba94429SFrederic Weisbecker 	int val;
68836ba94429SFrederic Weisbecker 
68846ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
68856ba94429SFrederic Weisbecker 		return -EINVAL;
68866ba94429SFrederic Weisbecker 
68876ba94429SFrederic Weisbecker 	workqueue_set_max_active(wq, val);
68886ba94429SFrederic Weisbecker 	return count;
68896ba94429SFrederic Weisbecker }
68906ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active);
68916ba94429SFrederic Weisbecker 
68926ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = {
68936ba94429SFrederic Weisbecker 	&dev_attr_per_cpu.attr,
68946ba94429SFrederic Weisbecker 	&dev_attr_max_active.attr,
68956ba94429SFrederic Weisbecker 	NULL,
68966ba94429SFrederic Weisbecker };
68976ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs);
68986ba94429SFrederic Weisbecker 
689949277a5bSWaiman Long static void apply_wqattrs_lock(void)
690049277a5bSWaiman Long {
690149277a5bSWaiman Long 	/* CPUs should stay stable across pwq creations and installations */
690249277a5bSWaiman Long 	cpus_read_lock();
690349277a5bSWaiman Long 	mutex_lock(&wq_pool_mutex);
690449277a5bSWaiman Long }
690549277a5bSWaiman Long 
690649277a5bSWaiman Long static void apply_wqattrs_unlock(void)
690749277a5bSWaiman Long {
690849277a5bSWaiman Long 	mutex_unlock(&wq_pool_mutex);
690949277a5bSWaiman Long 	cpus_read_unlock();
691049277a5bSWaiman Long }
691149277a5bSWaiman Long 
69126ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
69136ba94429SFrederic Weisbecker 			    char *buf)
69146ba94429SFrederic Weisbecker {
69156ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
69166ba94429SFrederic Weisbecker 	int written;
69176ba94429SFrederic Weisbecker 
69186ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
69196ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
69206ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
69216ba94429SFrederic Weisbecker 
69226ba94429SFrederic Weisbecker 	return written;
69236ba94429SFrederic Weisbecker }
69246ba94429SFrederic Weisbecker 
69256ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */
69266ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
69276ba94429SFrederic Weisbecker {
69286ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
69296ba94429SFrederic Weisbecker 
6930899a94feSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6931899a94feSLai Jiangshan 
6932be69d00dSThomas Gleixner 	attrs = alloc_workqueue_attrs();
69336ba94429SFrederic Weisbecker 	if (!attrs)
69346ba94429SFrederic Weisbecker 		return NULL;
69356ba94429SFrederic Weisbecker 
69366ba94429SFrederic Weisbecker 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
69376ba94429SFrederic Weisbecker 	return attrs;
69386ba94429SFrederic Weisbecker }
69396ba94429SFrederic Weisbecker 
69406ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
69416ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
69426ba94429SFrederic Weisbecker {
69436ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
69446ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
6945d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
6946d4d3e257SLai Jiangshan 
6947d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
69486ba94429SFrederic Weisbecker 
69496ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
69506ba94429SFrederic Weisbecker 	if (!attrs)
6951d4d3e257SLai Jiangshan 		goto out_unlock;
69526ba94429SFrederic Weisbecker 
69536ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
69546ba94429SFrederic Weisbecker 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
6955d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
69566ba94429SFrederic Weisbecker 	else
69576ba94429SFrederic Weisbecker 		ret = -EINVAL;
69586ba94429SFrederic Weisbecker 
6959d4d3e257SLai Jiangshan out_unlock:
6960d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
69616ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
69626ba94429SFrederic Weisbecker 	return ret ?: count;
69636ba94429SFrederic Weisbecker }
69646ba94429SFrederic Weisbecker 
69656ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev,
69666ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
69676ba94429SFrederic Weisbecker {
69686ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
69696ba94429SFrederic Weisbecker 	int written;
69706ba94429SFrederic Weisbecker 
69716ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
69726ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
69736ba94429SFrederic Weisbecker 			    cpumask_pr_args(wq->unbound_attrs->cpumask));
69746ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
69756ba94429SFrederic Weisbecker 	return written;
69766ba94429SFrederic Weisbecker }
69776ba94429SFrederic Weisbecker 
69786ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev,
69796ba94429SFrederic Weisbecker 				struct device_attribute *attr,
69806ba94429SFrederic Weisbecker 				const char *buf, size_t count)
69816ba94429SFrederic Weisbecker {
69826ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
69836ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
6984d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
6985d4d3e257SLai Jiangshan 
6986d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
69876ba94429SFrederic Weisbecker 
69886ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
69896ba94429SFrederic Weisbecker 	if (!attrs)
6990d4d3e257SLai Jiangshan 		goto out_unlock;
69916ba94429SFrederic Weisbecker 
69926ba94429SFrederic Weisbecker 	ret = cpumask_parse(buf, attrs->cpumask);
69936ba94429SFrederic Weisbecker 	if (!ret)
6994d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
69956ba94429SFrederic Weisbecker 
6996d4d3e257SLai Jiangshan out_unlock:
6997d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
69986ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
69996ba94429SFrederic Weisbecker 	return ret ?: count;
70006ba94429SFrederic Weisbecker }
70016ba94429SFrederic Weisbecker 
700263c5484eSTejun Heo static ssize_t wq_affn_scope_show(struct device *dev,
700363c5484eSTejun Heo 				  struct device_attribute *attr, char *buf)
700463c5484eSTejun Heo {
700563c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
700663c5484eSTejun Heo 	int written;
700763c5484eSTejun Heo 
700863c5484eSTejun Heo 	mutex_lock(&wq->mutex);
7009523a301eSTejun Heo 	if (wq->unbound_attrs->affn_scope == WQ_AFFN_DFL)
7010523a301eSTejun Heo 		written = scnprintf(buf, PAGE_SIZE, "%s (%s)\n",
7011523a301eSTejun Heo 				    wq_affn_names[WQ_AFFN_DFL],
7012523a301eSTejun Heo 				    wq_affn_names[wq_affn_dfl]);
7013523a301eSTejun Heo 	else
701463c5484eSTejun Heo 		written = scnprintf(buf, PAGE_SIZE, "%s\n",
701563c5484eSTejun Heo 				    wq_affn_names[wq->unbound_attrs->affn_scope]);
701663c5484eSTejun Heo 	mutex_unlock(&wq->mutex);
701763c5484eSTejun Heo 
701863c5484eSTejun Heo 	return written;
701963c5484eSTejun Heo }
702063c5484eSTejun Heo 
702163c5484eSTejun Heo static ssize_t wq_affn_scope_store(struct device *dev,
702263c5484eSTejun Heo 				   struct device_attribute *attr,
702363c5484eSTejun Heo 				   const char *buf, size_t count)
702463c5484eSTejun Heo {
702563c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
702663c5484eSTejun Heo 	struct workqueue_attrs *attrs;
702763c5484eSTejun Heo 	int affn, ret = -ENOMEM;
702863c5484eSTejun Heo 
702963c5484eSTejun Heo 	affn = parse_affn_scope(buf);
703063c5484eSTejun Heo 	if (affn < 0)
703163c5484eSTejun Heo 		return affn;
703263c5484eSTejun Heo 
703363c5484eSTejun Heo 	apply_wqattrs_lock();
703463c5484eSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
703563c5484eSTejun Heo 	if (attrs) {
703663c5484eSTejun Heo 		attrs->affn_scope = affn;
703763c5484eSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
703863c5484eSTejun Heo 	}
703963c5484eSTejun Heo 	apply_wqattrs_unlock();
704063c5484eSTejun Heo 	free_workqueue_attrs(attrs);
704163c5484eSTejun Heo 	return ret ?: count;
704263c5484eSTejun Heo }
704363c5484eSTejun Heo 
70448639ecebSTejun Heo static ssize_t wq_affinity_strict_show(struct device *dev,
70458639ecebSTejun Heo 				       struct device_attribute *attr, char *buf)
70468639ecebSTejun Heo {
70478639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
70488639ecebSTejun Heo 
70498639ecebSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n",
70508639ecebSTejun Heo 			 wq->unbound_attrs->affn_strict);
70518639ecebSTejun Heo }
70528639ecebSTejun Heo 
70538639ecebSTejun Heo static ssize_t wq_affinity_strict_store(struct device *dev,
70548639ecebSTejun Heo 					struct device_attribute *attr,
70558639ecebSTejun Heo 					const char *buf, size_t count)
70568639ecebSTejun Heo {
70578639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
70588639ecebSTejun Heo 	struct workqueue_attrs *attrs;
70598639ecebSTejun Heo 	int v, ret = -ENOMEM;
70608639ecebSTejun Heo 
70618639ecebSTejun Heo 	if (sscanf(buf, "%d", &v) != 1)
70628639ecebSTejun Heo 		return -EINVAL;
70638639ecebSTejun Heo 
70648639ecebSTejun Heo 	apply_wqattrs_lock();
70658639ecebSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
70668639ecebSTejun Heo 	if (attrs) {
70678639ecebSTejun Heo 		attrs->affn_strict = (bool)v;
70688639ecebSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
70698639ecebSTejun Heo 	}
70708639ecebSTejun Heo 	apply_wqattrs_unlock();
70718639ecebSTejun Heo 	free_workqueue_attrs(attrs);
70728639ecebSTejun Heo 	return ret ?: count;
70738639ecebSTejun Heo }
70748639ecebSTejun Heo 
70756ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = {
70766ba94429SFrederic Weisbecker 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
70776ba94429SFrederic Weisbecker 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
707863c5484eSTejun Heo 	__ATTR(affinity_scope, 0644, wq_affn_scope_show, wq_affn_scope_store),
70798639ecebSTejun Heo 	__ATTR(affinity_strict, 0644, wq_affinity_strict_show, wq_affinity_strict_store),
70806ba94429SFrederic Weisbecker 	__ATTR_NULL,
70816ba94429SFrederic Weisbecker };
70826ba94429SFrederic Weisbecker 
70834f19b8e0STejun Heo static struct bus_type wq_subsys = {
70846ba94429SFrederic Weisbecker 	.name				= "workqueue",
70856ba94429SFrederic Weisbecker 	.dev_groups			= wq_sysfs_groups,
70866ba94429SFrederic Weisbecker };
70876ba94429SFrederic Weisbecker 
708849277a5bSWaiman Long /**
708949277a5bSWaiman Long  *  workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
709049277a5bSWaiman Long  *  @cpumask: the cpumask to set
709149277a5bSWaiman Long  *
709249277a5bSWaiman Long  *  The low-level workqueues cpumask is a global cpumask that limits
709349277a5bSWaiman Long  *  the affinity of all unbound workqueues.  This function check the @cpumask
709449277a5bSWaiman Long  *  and apply it to all unbound workqueues and updates all pwqs of them.
709549277a5bSWaiman Long  *
709649277a5bSWaiman Long  *  Return:	0	- Success
709749277a5bSWaiman Long  *		-EINVAL	- Invalid @cpumask
709849277a5bSWaiman Long  *		-ENOMEM	- Failed to allocate memory for attrs or pwqs.
709949277a5bSWaiman Long  */
710049277a5bSWaiman Long static int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
710149277a5bSWaiman Long {
710249277a5bSWaiman Long 	int ret = -EINVAL;
710349277a5bSWaiman Long 
710449277a5bSWaiman Long 	/*
710549277a5bSWaiman Long 	 * Not excluding isolated cpus on purpose.
710649277a5bSWaiman Long 	 * If the user wishes to include them, we allow that.
710749277a5bSWaiman Long 	 */
710849277a5bSWaiman Long 	cpumask_and(cpumask, cpumask, cpu_possible_mask);
710949277a5bSWaiman Long 	if (!cpumask_empty(cpumask)) {
711049277a5bSWaiman Long 		apply_wqattrs_lock();
711149277a5bSWaiman Long 		cpumask_copy(wq_requested_unbound_cpumask, cpumask);
711249277a5bSWaiman Long 		if (cpumask_equal(cpumask, wq_unbound_cpumask)) {
711349277a5bSWaiman Long 			ret = 0;
711449277a5bSWaiman Long 			goto out_unlock;
711549277a5bSWaiman Long 		}
711649277a5bSWaiman Long 
711749277a5bSWaiman Long 		ret = workqueue_apply_unbound_cpumask(cpumask);
711849277a5bSWaiman Long 
711949277a5bSWaiman Long out_unlock:
712049277a5bSWaiman Long 		apply_wqattrs_unlock();
712149277a5bSWaiman Long 	}
712249277a5bSWaiman Long 
712349277a5bSWaiman Long 	return ret;
712449277a5bSWaiman Long }
712549277a5bSWaiman Long 
7126fe28f631SWaiman Long static ssize_t __wq_cpumask_show(struct device *dev,
7127fe28f631SWaiman Long 		struct device_attribute *attr, char *buf, cpumask_var_t mask)
7128b05a7928SFrederic Weisbecker {
7129b05a7928SFrederic Weisbecker 	int written;
7130b05a7928SFrederic Weisbecker 
7131042f7df1SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
7132fe28f631SWaiman Long 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask));
7133042f7df1SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
7134b05a7928SFrederic Weisbecker 
7135b05a7928SFrederic Weisbecker 	return written;
7136b05a7928SFrederic Weisbecker }
7137b05a7928SFrederic Weisbecker 
7138fe28f631SWaiman Long static ssize_t wq_unbound_cpumask_show(struct device *dev,
7139fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
7140fe28f631SWaiman Long {
7141fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_unbound_cpumask);
7142fe28f631SWaiman Long }
7143fe28f631SWaiman Long 
7144fe28f631SWaiman Long static ssize_t wq_requested_cpumask_show(struct device *dev,
7145fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
7146fe28f631SWaiman Long {
7147fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_requested_unbound_cpumask);
7148fe28f631SWaiman Long }
7149fe28f631SWaiman Long 
7150fe28f631SWaiman Long static ssize_t wq_isolated_cpumask_show(struct device *dev,
7151fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
7152fe28f631SWaiman Long {
7153fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_isolated_cpumask);
7154fe28f631SWaiman Long }
7155fe28f631SWaiman Long 
7156042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev,
7157042f7df1SLai Jiangshan 		struct device_attribute *attr, const char *buf, size_t count)
7158042f7df1SLai Jiangshan {
7159042f7df1SLai Jiangshan 	cpumask_var_t cpumask;
7160042f7df1SLai Jiangshan 	int ret;
7161042f7df1SLai Jiangshan 
7162042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
7163042f7df1SLai Jiangshan 		return -ENOMEM;
7164042f7df1SLai Jiangshan 
7165042f7df1SLai Jiangshan 	ret = cpumask_parse(buf, cpumask);
7166042f7df1SLai Jiangshan 	if (!ret)
7167042f7df1SLai Jiangshan 		ret = workqueue_set_unbound_cpumask(cpumask);
7168042f7df1SLai Jiangshan 
7169042f7df1SLai Jiangshan 	free_cpumask_var(cpumask);
7170042f7df1SLai Jiangshan 	return ret ? ret : count;
7171042f7df1SLai Jiangshan }
7172042f7df1SLai Jiangshan 
7173fe28f631SWaiman Long static struct device_attribute wq_sysfs_cpumask_attrs[] = {
7174042f7df1SLai Jiangshan 	__ATTR(cpumask, 0644, wq_unbound_cpumask_show,
7175fe28f631SWaiman Long 	       wq_unbound_cpumask_store),
7176fe28f631SWaiman Long 	__ATTR(cpumask_requested, 0444, wq_requested_cpumask_show, NULL),
7177fe28f631SWaiman Long 	__ATTR(cpumask_isolated, 0444, wq_isolated_cpumask_show, NULL),
7178fe28f631SWaiman Long 	__ATTR_NULL,
7179fe28f631SWaiman Long };
7180b05a7928SFrederic Weisbecker 
71816ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void)
71826ba94429SFrederic Weisbecker {
7183686f6697SGreg Kroah-Hartman 	struct device *dev_root;
7184b05a7928SFrederic Weisbecker 	int err;
7185b05a7928SFrederic Weisbecker 
7186b05a7928SFrederic Weisbecker 	err = subsys_virtual_register(&wq_subsys, NULL);
7187b05a7928SFrederic Weisbecker 	if (err)
7188b05a7928SFrederic Weisbecker 		return err;
7189b05a7928SFrederic Weisbecker 
7190686f6697SGreg Kroah-Hartman 	dev_root = bus_get_dev_root(&wq_subsys);
7191686f6697SGreg Kroah-Hartman 	if (dev_root) {
7192fe28f631SWaiman Long 		struct device_attribute *attr;
7193fe28f631SWaiman Long 
7194fe28f631SWaiman Long 		for (attr = wq_sysfs_cpumask_attrs; attr->attr.name; attr++) {
7195fe28f631SWaiman Long 			err = device_create_file(dev_root, attr);
7196fe28f631SWaiman Long 			if (err)
7197fe28f631SWaiman Long 				break;
7198fe28f631SWaiman Long 		}
7199686f6697SGreg Kroah-Hartman 		put_device(dev_root);
7200686f6697SGreg Kroah-Hartman 	}
7201686f6697SGreg Kroah-Hartman 	return err;
72026ba94429SFrederic Weisbecker }
72036ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init);
72046ba94429SFrederic Weisbecker 
72056ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev)
72066ba94429SFrederic Weisbecker {
72076ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
72086ba94429SFrederic Weisbecker 
72096ba94429SFrederic Weisbecker 	kfree(wq_dev);
72106ba94429SFrederic Weisbecker }
72116ba94429SFrederic Weisbecker 
72126ba94429SFrederic Weisbecker /**
72136ba94429SFrederic Weisbecker  * workqueue_sysfs_register - make a workqueue visible in sysfs
72146ba94429SFrederic Weisbecker  * @wq: the workqueue to register
72156ba94429SFrederic Weisbecker  *
72166ba94429SFrederic Weisbecker  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
72176ba94429SFrederic Weisbecker  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
72186ba94429SFrederic Weisbecker  * which is the preferred method.
72196ba94429SFrederic Weisbecker  *
72206ba94429SFrederic Weisbecker  * Workqueue user should use this function directly iff it wants to apply
72216ba94429SFrederic Weisbecker  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
72226ba94429SFrederic Weisbecker  * apply_workqueue_attrs() may race against userland updating the
72236ba94429SFrederic Weisbecker  * attributes.
72246ba94429SFrederic Weisbecker  *
72256ba94429SFrederic Weisbecker  * Return: 0 on success, -errno on failure.
72266ba94429SFrederic Weisbecker  */
72276ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq)
72286ba94429SFrederic Weisbecker {
72296ba94429SFrederic Weisbecker 	struct wq_device *wq_dev;
72306ba94429SFrederic Weisbecker 	int ret;
72316ba94429SFrederic Weisbecker 
72326ba94429SFrederic Weisbecker 	/*
72334c065dbcSWaiman Long 	 * Adjusting max_active breaks ordering guarantee.  Disallow exposing
72344c065dbcSWaiman Long 	 * ordered workqueues.
72356ba94429SFrederic Weisbecker 	 */
72363bc1e711STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
72376ba94429SFrederic Weisbecker 		return -EINVAL;
72386ba94429SFrederic Weisbecker 
72396ba94429SFrederic Weisbecker 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
72406ba94429SFrederic Weisbecker 	if (!wq_dev)
72416ba94429SFrederic Weisbecker 		return -ENOMEM;
72426ba94429SFrederic Weisbecker 
72436ba94429SFrederic Weisbecker 	wq_dev->wq = wq;
72446ba94429SFrederic Weisbecker 	wq_dev->dev.bus = &wq_subsys;
72456ba94429SFrederic Weisbecker 	wq_dev->dev.release = wq_device_release;
724623217b44SLars-Peter Clausen 	dev_set_name(&wq_dev->dev, "%s", wq->name);
72476ba94429SFrederic Weisbecker 
72486ba94429SFrederic Weisbecker 	/*
72496ba94429SFrederic Weisbecker 	 * unbound_attrs are created separately.  Suppress uevent until
72506ba94429SFrederic Weisbecker 	 * everything is ready.
72516ba94429SFrederic Weisbecker 	 */
72526ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, true);
72536ba94429SFrederic Weisbecker 
72546ba94429SFrederic Weisbecker 	ret = device_register(&wq_dev->dev);
72556ba94429SFrederic Weisbecker 	if (ret) {
7256537f4146SArvind Yadav 		put_device(&wq_dev->dev);
72576ba94429SFrederic Weisbecker 		wq->wq_dev = NULL;
72586ba94429SFrederic Weisbecker 		return ret;
72596ba94429SFrederic Weisbecker 	}
72606ba94429SFrederic Weisbecker 
72616ba94429SFrederic Weisbecker 	if (wq->flags & WQ_UNBOUND) {
72626ba94429SFrederic Weisbecker 		struct device_attribute *attr;
72636ba94429SFrederic Weisbecker 
72646ba94429SFrederic Weisbecker 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
72656ba94429SFrederic Weisbecker 			ret = device_create_file(&wq_dev->dev, attr);
72666ba94429SFrederic Weisbecker 			if (ret) {
72676ba94429SFrederic Weisbecker 				device_unregister(&wq_dev->dev);
72686ba94429SFrederic Weisbecker 				wq->wq_dev = NULL;
72696ba94429SFrederic Weisbecker 				return ret;
72706ba94429SFrederic Weisbecker 			}
72716ba94429SFrederic Weisbecker 		}
72726ba94429SFrederic Weisbecker 	}
72736ba94429SFrederic Weisbecker 
72746ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, false);
72756ba94429SFrederic Weisbecker 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
72766ba94429SFrederic Weisbecker 	return 0;
72776ba94429SFrederic Weisbecker }
72786ba94429SFrederic Weisbecker 
72796ba94429SFrederic Weisbecker /**
72806ba94429SFrederic Weisbecker  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
72816ba94429SFrederic Weisbecker  * @wq: the workqueue to unregister
72826ba94429SFrederic Weisbecker  *
72836ba94429SFrederic Weisbecker  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
72846ba94429SFrederic Weisbecker  */
72856ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
72866ba94429SFrederic Weisbecker {
72876ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = wq->wq_dev;
72886ba94429SFrederic Weisbecker 
72896ba94429SFrederic Weisbecker 	if (!wq->wq_dev)
72906ba94429SFrederic Weisbecker 		return;
72916ba94429SFrederic Weisbecker 
72926ba94429SFrederic Weisbecker 	wq->wq_dev = NULL;
72936ba94429SFrederic Weisbecker 	device_unregister(&wq_dev->dev);
72946ba94429SFrederic Weisbecker }
72956ba94429SFrederic Weisbecker #else	/* CONFIG_SYSFS */
72966ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
72976ba94429SFrederic Weisbecker #endif	/* CONFIG_SYSFS */
72986ba94429SFrederic Weisbecker 
729982607adcSTejun Heo /*
730082607adcSTejun Heo  * Workqueue watchdog.
730182607adcSTejun Heo  *
730282607adcSTejun Heo  * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
730382607adcSTejun Heo  * flush dependency, a concurrency managed work item which stays RUNNING
730482607adcSTejun Heo  * indefinitely.  Workqueue stalls can be very difficult to debug as the
730582607adcSTejun Heo  * usual warning mechanisms don't trigger and internal workqueue state is
730682607adcSTejun Heo  * largely opaque.
730782607adcSTejun Heo  *
730882607adcSTejun Heo  * Workqueue watchdog monitors all worker pools periodically and dumps
730982607adcSTejun Heo  * state if some pools failed to make forward progress for a while where
731082607adcSTejun Heo  * forward progress is defined as the first item on ->worklist changing.
731182607adcSTejun Heo  *
731282607adcSTejun Heo  * This mechanism is controlled through the kernel parameter
731382607adcSTejun Heo  * "workqueue.watchdog_thresh" which can be updated at runtime through the
731482607adcSTejun Heo  * corresponding sysfs parameter file.
731582607adcSTejun Heo  */
731682607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG
731782607adcSTejun Heo 
731882607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30;
73195cd79d6aSKees Cook static struct timer_list wq_watchdog_timer;
732082607adcSTejun Heo 
732182607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
732282607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
732382607adcSTejun Heo 
7324cd2440d6SPetr Mladek /*
7325cd2440d6SPetr Mladek  * Show workers that might prevent the processing of pending work items.
7326cd2440d6SPetr Mladek  * The only candidates are CPU-bound workers in the running state.
7327cd2440d6SPetr Mladek  * Pending work items should be handled by another idle worker
7328cd2440d6SPetr Mladek  * in all other situations.
7329cd2440d6SPetr Mladek  */
7330cd2440d6SPetr Mladek static void show_cpu_pool_hog(struct worker_pool *pool)
7331cd2440d6SPetr Mladek {
7332cd2440d6SPetr Mladek 	struct worker *worker;
7333c26e2f2eSTejun Heo 	unsigned long irq_flags;
7334cd2440d6SPetr Mladek 	int bkt;
7335cd2440d6SPetr Mladek 
7336c26e2f2eSTejun Heo 	raw_spin_lock_irqsave(&pool->lock, irq_flags);
7337cd2440d6SPetr Mladek 
7338cd2440d6SPetr Mladek 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
7339cd2440d6SPetr Mladek 		if (task_is_running(worker->task)) {
7340cd2440d6SPetr Mladek 			/*
7341cd2440d6SPetr Mladek 			 * Defer printing to avoid deadlocks in console
7342cd2440d6SPetr Mladek 			 * drivers that queue work while holding locks
7343cd2440d6SPetr Mladek 			 * also taken in their write paths.
7344cd2440d6SPetr Mladek 			 */
7345cd2440d6SPetr Mladek 			printk_deferred_enter();
7346cd2440d6SPetr Mladek 
7347cd2440d6SPetr Mladek 			pr_info("pool %d:\n", pool->id);
7348cd2440d6SPetr Mladek 			sched_show_task(worker->task);
7349cd2440d6SPetr Mladek 
7350cd2440d6SPetr Mladek 			printk_deferred_exit();
7351cd2440d6SPetr Mladek 		}
7352cd2440d6SPetr Mladek 	}
7353cd2440d6SPetr Mladek 
7354c26e2f2eSTejun Heo 	raw_spin_unlock_irqrestore(&pool->lock, irq_flags);
7355cd2440d6SPetr Mladek }
7356cd2440d6SPetr Mladek 
7357cd2440d6SPetr Mladek static void show_cpu_pools_hogs(void)
7358cd2440d6SPetr Mladek {
7359cd2440d6SPetr Mladek 	struct worker_pool *pool;
7360cd2440d6SPetr Mladek 	int pi;
7361cd2440d6SPetr Mladek 
7362cd2440d6SPetr Mladek 	pr_info("Showing backtraces of running workers in stalled CPU-bound worker pools:\n");
7363cd2440d6SPetr Mladek 
7364cd2440d6SPetr Mladek 	rcu_read_lock();
7365cd2440d6SPetr Mladek 
7366cd2440d6SPetr Mladek 	for_each_pool(pool, pi) {
7367cd2440d6SPetr Mladek 		if (pool->cpu_stall)
7368cd2440d6SPetr Mladek 			show_cpu_pool_hog(pool);
7369cd2440d6SPetr Mladek 
7370cd2440d6SPetr Mladek 	}
7371cd2440d6SPetr Mladek 
7372cd2440d6SPetr Mladek 	rcu_read_unlock();
7373cd2440d6SPetr Mladek }
7374cd2440d6SPetr Mladek 
737582607adcSTejun Heo static void wq_watchdog_reset_touched(void)
737682607adcSTejun Heo {
737782607adcSTejun Heo 	int cpu;
737882607adcSTejun Heo 
737982607adcSTejun Heo 	wq_watchdog_touched = jiffies;
738082607adcSTejun Heo 	for_each_possible_cpu(cpu)
738182607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
738282607adcSTejun Heo }
738382607adcSTejun Heo 
73845cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused)
738582607adcSTejun Heo {
738682607adcSTejun Heo 	unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
738782607adcSTejun Heo 	bool lockup_detected = false;
7388cd2440d6SPetr Mladek 	bool cpu_pool_stall = false;
7389940d71c6SSergey Senozhatsky 	unsigned long now = jiffies;
739082607adcSTejun Heo 	struct worker_pool *pool;
739182607adcSTejun Heo 	int pi;
739282607adcSTejun Heo 
739382607adcSTejun Heo 	if (!thresh)
739482607adcSTejun Heo 		return;
739582607adcSTejun Heo 
739682607adcSTejun Heo 	rcu_read_lock();
739782607adcSTejun Heo 
739882607adcSTejun Heo 	for_each_pool(pool, pi) {
739982607adcSTejun Heo 		unsigned long pool_ts, touched, ts;
740082607adcSTejun Heo 
7401cd2440d6SPetr Mladek 		pool->cpu_stall = false;
740282607adcSTejun Heo 		if (list_empty(&pool->worklist))
740382607adcSTejun Heo 			continue;
740482607adcSTejun Heo 
7405940d71c6SSergey Senozhatsky 		/*
7406940d71c6SSergey Senozhatsky 		 * If a virtual machine is stopped by the host it can look to
7407940d71c6SSergey Senozhatsky 		 * the watchdog like a stall.
7408940d71c6SSergey Senozhatsky 		 */
7409940d71c6SSergey Senozhatsky 		kvm_check_and_clear_guest_paused();
7410940d71c6SSergey Senozhatsky 
741182607adcSTejun Heo 		/* get the latest of pool and touched timestamps */
741289e28ce6SWang Qing 		if (pool->cpu >= 0)
741389e28ce6SWang Qing 			touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
741489e28ce6SWang Qing 		else
741582607adcSTejun Heo 			touched = READ_ONCE(wq_watchdog_touched);
741689e28ce6SWang Qing 		pool_ts = READ_ONCE(pool->watchdog_ts);
741782607adcSTejun Heo 
741882607adcSTejun Heo 		if (time_after(pool_ts, touched))
741982607adcSTejun Heo 			ts = pool_ts;
742082607adcSTejun Heo 		else
742182607adcSTejun Heo 			ts = touched;
742282607adcSTejun Heo 
742382607adcSTejun Heo 		/* did we stall? */
7424940d71c6SSergey Senozhatsky 		if (time_after(now, ts + thresh)) {
742582607adcSTejun Heo 			lockup_detected = true;
74264cb1ef64STejun Heo 			if (pool->cpu >= 0 && !(pool->flags & POOL_BH)) {
7427cd2440d6SPetr Mladek 				pool->cpu_stall = true;
7428cd2440d6SPetr Mladek 				cpu_pool_stall = true;
7429cd2440d6SPetr Mladek 			}
743082607adcSTejun Heo 			pr_emerg("BUG: workqueue lockup - pool");
743182607adcSTejun Heo 			pr_cont_pool_info(pool);
743282607adcSTejun Heo 			pr_cont(" stuck for %us!\n",
7433940d71c6SSergey Senozhatsky 				jiffies_to_msecs(now - pool_ts) / 1000);
743482607adcSTejun Heo 		}
7435cd2440d6SPetr Mladek 
7436cd2440d6SPetr Mladek 
743782607adcSTejun Heo 	}
743882607adcSTejun Heo 
743982607adcSTejun Heo 	rcu_read_unlock();
744082607adcSTejun Heo 
744182607adcSTejun Heo 	if (lockup_detected)
744255df0933SImran Khan 		show_all_workqueues();
744382607adcSTejun Heo 
7444cd2440d6SPetr Mladek 	if (cpu_pool_stall)
7445cd2440d6SPetr Mladek 		show_cpu_pools_hogs();
7446cd2440d6SPetr Mladek 
744782607adcSTejun Heo 	wq_watchdog_reset_touched();
744882607adcSTejun Heo 	mod_timer(&wq_watchdog_timer, jiffies + thresh);
744982607adcSTejun Heo }
745082607adcSTejun Heo 
7451cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu)
745282607adcSTejun Heo {
745382607adcSTejun Heo 	if (cpu >= 0)
745482607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
745589e28ce6SWang Qing 
745682607adcSTejun Heo 	wq_watchdog_touched = jiffies;
745782607adcSTejun Heo }
745882607adcSTejun Heo 
745982607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh)
746082607adcSTejun Heo {
746182607adcSTejun Heo 	wq_watchdog_thresh = 0;
746282607adcSTejun Heo 	del_timer_sync(&wq_watchdog_timer);
746382607adcSTejun Heo 
746482607adcSTejun Heo 	if (thresh) {
746582607adcSTejun Heo 		wq_watchdog_thresh = thresh;
746682607adcSTejun Heo 		wq_watchdog_reset_touched();
746782607adcSTejun Heo 		mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
746882607adcSTejun Heo 	}
746982607adcSTejun Heo }
747082607adcSTejun Heo 
747182607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val,
747282607adcSTejun Heo 					const struct kernel_param *kp)
747382607adcSTejun Heo {
747482607adcSTejun Heo 	unsigned long thresh;
747582607adcSTejun Heo 	int ret;
747682607adcSTejun Heo 
747782607adcSTejun Heo 	ret = kstrtoul(val, 0, &thresh);
747882607adcSTejun Heo 	if (ret)
747982607adcSTejun Heo 		return ret;
748082607adcSTejun Heo 
748182607adcSTejun Heo 	if (system_wq)
748282607adcSTejun Heo 		wq_watchdog_set_thresh(thresh);
748382607adcSTejun Heo 	else
748482607adcSTejun Heo 		wq_watchdog_thresh = thresh;
748582607adcSTejun Heo 
748682607adcSTejun Heo 	return 0;
748782607adcSTejun Heo }
748882607adcSTejun Heo 
748982607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = {
749082607adcSTejun Heo 	.set	= wq_watchdog_param_set_thresh,
749182607adcSTejun Heo 	.get	= param_get_ulong,
749282607adcSTejun Heo };
749382607adcSTejun Heo 
749482607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
749582607adcSTejun Heo 		0644);
749682607adcSTejun Heo 
749782607adcSTejun Heo static void wq_watchdog_init(void)
749882607adcSTejun Heo {
74995cd79d6aSKees Cook 	timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
750082607adcSTejun Heo 	wq_watchdog_set_thresh(wq_watchdog_thresh);
750182607adcSTejun Heo }
750282607adcSTejun Heo 
750382607adcSTejun Heo #else	/* CONFIG_WQ_WATCHDOG */
750482607adcSTejun Heo 
750582607adcSTejun Heo static inline void wq_watchdog_init(void) { }
750682607adcSTejun Heo 
750782607adcSTejun Heo #endif	/* CONFIG_WQ_WATCHDOG */
750882607adcSTejun Heo 
75092f34d733STejun Heo static void bh_pool_kick_normal(struct irq_work *irq_work)
75102f34d733STejun Heo {
75112f34d733STejun Heo 	raise_softirq_irqoff(TASKLET_SOFTIRQ);
75122f34d733STejun Heo }
75132f34d733STejun Heo 
75142f34d733STejun Heo static void bh_pool_kick_highpri(struct irq_work *irq_work)
75152f34d733STejun Heo {
75162f34d733STejun Heo 	raise_softirq_irqoff(HI_SOFTIRQ);
75172f34d733STejun Heo }
75182f34d733STejun Heo 
75194a6c5607STejun Heo static void __init restrict_unbound_cpumask(const char *name, const struct cpumask *mask)
75204a6c5607STejun Heo {
75214a6c5607STejun Heo 	if (!cpumask_intersects(wq_unbound_cpumask, mask)) {
75224a6c5607STejun Heo 		pr_warn("workqueue: Restricting unbound_cpumask (%*pb) with %s (%*pb) leaves no CPU, ignoring\n",
75234a6c5607STejun Heo 			cpumask_pr_args(wq_unbound_cpumask), name, cpumask_pr_args(mask));
75244a6c5607STejun Heo 		return;
75254a6c5607STejun Heo 	}
75264a6c5607STejun Heo 
75274a6c5607STejun Heo 	cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, mask);
75284a6c5607STejun Heo }
75294a6c5607STejun Heo 
75302fcdb1b4STejun Heo static void __init init_cpu_worker_pool(struct worker_pool *pool, int cpu, int nice)
75312fcdb1b4STejun Heo {
75322fcdb1b4STejun Heo 	BUG_ON(init_worker_pool(pool));
75332fcdb1b4STejun Heo 	pool->cpu = cpu;
75342fcdb1b4STejun Heo 	cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
75352fcdb1b4STejun Heo 	cpumask_copy(pool->attrs->__pod_cpumask, cpumask_of(cpu));
75362fcdb1b4STejun Heo 	pool->attrs->nice = nice;
75372fcdb1b4STejun Heo 	pool->attrs->affn_strict = true;
75382fcdb1b4STejun Heo 	pool->node = cpu_to_node(cpu);
75392fcdb1b4STejun Heo 
75402fcdb1b4STejun Heo 	/* alloc pool ID */
75412fcdb1b4STejun Heo 	mutex_lock(&wq_pool_mutex);
75422fcdb1b4STejun Heo 	BUG_ON(worker_pool_assign_id(pool));
75432fcdb1b4STejun Heo 	mutex_unlock(&wq_pool_mutex);
75442fcdb1b4STejun Heo }
75452fcdb1b4STejun Heo 
75463347fa09STejun Heo /**
75473347fa09STejun Heo  * workqueue_init_early - early init for workqueue subsystem
75483347fa09STejun Heo  *
75492930155bSTejun Heo  * This is the first step of three-staged workqueue subsystem initialization and
75502930155bSTejun Heo  * invoked as soon as the bare basics - memory allocation, cpumasks and idr are
75512930155bSTejun Heo  * up. It sets up all the data structures and system workqueues and allows early
75522930155bSTejun Heo  * boot code to create workqueues and queue/cancel work items. Actual work item
75532930155bSTejun Heo  * execution starts only after kthreads can be created and scheduled right
75542930155bSTejun Heo  * before early initcalls.
75553347fa09STejun Heo  */
75562333e829SYu Chen void __init workqueue_init_early(void)
75571da177e4SLinus Torvalds {
755884193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_SYSTEM];
75597a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
75602f34d733STejun Heo 	void (*irq_work_fns[2])(struct irq_work *) = { bh_pool_kick_normal,
75612f34d733STejun Heo 						       bh_pool_kick_highpri };
75627a4e344cSTejun Heo 	int i, cpu;
7563c34056a3STejun Heo 
756410cdb157SLai Jiangshan 	BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
7565e904e6c2STejun Heo 
7566b05a7928SFrederic Weisbecker 	BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
7567fe28f631SWaiman Long 	BUG_ON(!alloc_cpumask_var(&wq_requested_unbound_cpumask, GFP_KERNEL));
7568fe28f631SWaiman Long 	BUG_ON(!zalloc_cpumask_var(&wq_isolated_cpumask, GFP_KERNEL));
7569b05a7928SFrederic Weisbecker 
75704a6c5607STejun Heo 	cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
75714a6c5607STejun Heo 	restrict_unbound_cpumask("HK_TYPE_WQ", housekeeping_cpumask(HK_TYPE_WQ));
75724a6c5607STejun Heo 	restrict_unbound_cpumask("HK_TYPE_DOMAIN", housekeeping_cpumask(HK_TYPE_DOMAIN));
7573ace3c549Stiozhang 	if (!cpumask_empty(&wq_cmdline_cpumask))
75744a6c5607STejun Heo 		restrict_unbound_cpumask("workqueue.unbound_cpus", &wq_cmdline_cpumask);
7575ace3c549Stiozhang 
7576fe28f631SWaiman Long 	cpumask_copy(wq_requested_unbound_cpumask, wq_unbound_cpumask);
75778b03ae3cSTejun Heo 
75788b03ae3cSTejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
7579e22bee78STejun Heo 
75802930155bSTejun Heo 	wq_update_pod_attrs_buf = alloc_workqueue_attrs();
75812930155bSTejun Heo 	BUG_ON(!wq_update_pod_attrs_buf);
75822930155bSTejun Heo 
75837bd20b6bSMarcelo Tosatti 	/*
75847bd20b6bSMarcelo Tosatti 	 * If nohz_full is enabled, set power efficient workqueue as unbound.
75857bd20b6bSMarcelo Tosatti 	 * This allows workqueue items to be moved to HK CPUs.
75867bd20b6bSMarcelo Tosatti 	 */
75877bd20b6bSMarcelo Tosatti 	if (housekeeping_enabled(HK_TYPE_TICK))
75887bd20b6bSMarcelo Tosatti 		wq_power_efficient = true;
75897bd20b6bSMarcelo Tosatti 
759084193c07STejun Heo 	/* initialize WQ_AFFN_SYSTEM pods */
759184193c07STejun Heo 	pt->pod_cpus = kcalloc(1, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
759284193c07STejun Heo 	pt->pod_node = kcalloc(1, sizeof(pt->pod_node[0]), GFP_KERNEL);
759384193c07STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
759484193c07STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node || !pt->cpu_pod);
759584193c07STejun Heo 
759684193c07STejun Heo 	BUG_ON(!zalloc_cpumask_var_node(&pt->pod_cpus[0], GFP_KERNEL, NUMA_NO_NODE));
759784193c07STejun Heo 
759884193c07STejun Heo 	pt->nr_pods = 1;
759984193c07STejun Heo 	cpumask_copy(pt->pod_cpus[0], cpu_possible_mask);
760084193c07STejun Heo 	pt->pod_node[0] = NUMA_NO_NODE;
760184193c07STejun Heo 	pt->cpu_pod[0] = 0;
760284193c07STejun Heo 
76034cb1ef64STejun Heo 	/* initialize BH and CPU pools */
76041da177e4SLinus Torvalds 	for_each_possible_cpu(cpu) {
76051da177e4SLinus Torvalds 		struct worker_pool *pool;
76061da177e4SLinus Torvalds 
76071da177e4SLinus Torvalds 		i = 0;
76084cb1ef64STejun Heo 		for_each_bh_worker_pool(pool, cpu) {
76092f34d733STejun Heo 			init_cpu_worker_pool(pool, cpu, std_nice[i]);
76104cb1ef64STejun Heo 			pool->flags |= POOL_BH;
76112f34d733STejun Heo 			init_irq_work(bh_pool_irq_work(pool), irq_work_fns[i]);
76122f34d733STejun Heo 			i++;
76134cb1ef64STejun Heo 		}
76144cb1ef64STejun Heo 
76154cb1ef64STejun Heo 		i = 0;
76162fcdb1b4STejun Heo 		for_each_cpu_worker_pool(pool, cpu)
76172fcdb1b4STejun Heo 			init_cpu_worker_pool(pool, cpu, std_nice[i++]);
76181da177e4SLinus Torvalds 	}
76191da177e4SLinus Torvalds 
76208a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
762129c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
762229c91e99STejun Heo 		struct workqueue_attrs *attrs;
762329c91e99STejun Heo 
7624be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
762529c91e99STejun Heo 		attrs->nice = std_nice[i];
762629c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
76278a2b7538STejun Heo 
76288a2b7538STejun Heo 		/*
76298a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
76308a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
76318a2b7538STejun Heo 		 */
7632be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
76338a2b7538STejun Heo 		attrs->nice = std_nice[i];
7634af73f5c9STejun Heo 		attrs->ordered = true;
76358a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
763629c91e99STejun Heo 	}
763729c91e99STejun Heo 
7638d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
76391aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
7640d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
7641f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
7642636b927eSTejun Heo 					    WQ_MAX_ACTIVE);
764324d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
764424d51addSTejun Heo 					      WQ_FREEZABLE, 0);
76450668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
76460668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
76478318d6a6SAudra Mitchell 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_pwr_efficient",
76480668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
76490668106cSViresh Kumar 					      0);
76504cb1ef64STejun Heo 	system_bh_wq = alloc_workqueue("events_bh", WQ_BH, 0);
76514cb1ef64STejun Heo 	system_bh_highpri_wq = alloc_workqueue("events_bh_highpri",
76524cb1ef64STejun Heo 					       WQ_BH | WQ_HIGHPRI, 0);
76531aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
76540668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
76550668106cSViresh Kumar 	       !system_power_efficient_wq ||
76564cb1ef64STejun Heo 	       !system_freezable_power_efficient_wq ||
76574cb1ef64STejun Heo 	       !system_bh_wq || !system_bh_highpri_wq);
76583347fa09STejun Heo }
76593347fa09STejun Heo 
7660aa6fde93STejun Heo static void __init wq_cpu_intensive_thresh_init(void)
7661aa6fde93STejun Heo {
7662aa6fde93STejun Heo 	unsigned long thresh;
7663aa6fde93STejun Heo 	unsigned long bogo;
7664aa6fde93STejun Heo 
7665dd64c873SZqiang 	pwq_release_worker = kthread_create_worker(0, "pool_workqueue_release");
7666dd64c873SZqiang 	BUG_ON(IS_ERR(pwq_release_worker));
7667dd64c873SZqiang 
7668aa6fde93STejun Heo 	/* if the user set it to a specific value, keep it */
7669aa6fde93STejun Heo 	if (wq_cpu_intensive_thresh_us != ULONG_MAX)
7670aa6fde93STejun Heo 		return;
7671aa6fde93STejun Heo 
7672aa6fde93STejun Heo 	/*
7673aa6fde93STejun Heo 	 * The default of 10ms is derived from the fact that most modern (as of
7674aa6fde93STejun Heo 	 * 2023) processors can do a lot in 10ms and that it's just below what
7675aa6fde93STejun Heo 	 * most consider human-perceivable. However, the kernel also runs on a
7676aa6fde93STejun Heo 	 * lot slower CPUs including microcontrollers where the threshold is way
7677aa6fde93STejun Heo 	 * too low.
7678aa6fde93STejun Heo 	 *
7679aa6fde93STejun Heo 	 * Let's scale up the threshold upto 1 second if BogoMips is below 4000.
7680aa6fde93STejun Heo 	 * This is by no means accurate but it doesn't have to be. The mechanism
7681aa6fde93STejun Heo 	 * is still useful even when the threshold is fully scaled up. Also, as
7682aa6fde93STejun Heo 	 * the reports would usually be applicable to everyone, some machines
7683aa6fde93STejun Heo 	 * operating on longer thresholds won't significantly diminish their
7684aa6fde93STejun Heo 	 * usefulness.
7685aa6fde93STejun Heo 	 */
7686aa6fde93STejun Heo 	thresh = 10 * USEC_PER_MSEC;
7687aa6fde93STejun Heo 
7688aa6fde93STejun Heo 	/* see init/calibrate.c for lpj -> BogoMIPS calculation */
7689aa6fde93STejun Heo 	bogo = max_t(unsigned long, loops_per_jiffy / 500000 * HZ, 1);
7690aa6fde93STejun Heo 	if (bogo < 4000)
7691aa6fde93STejun Heo 		thresh = min_t(unsigned long, thresh * 4000 / bogo, USEC_PER_SEC);
7692aa6fde93STejun Heo 
7693aa6fde93STejun Heo 	pr_debug("wq_cpu_intensive_thresh: lpj=%lu BogoMIPS=%lu thresh_us=%lu\n",
7694aa6fde93STejun Heo 		 loops_per_jiffy, bogo, thresh);
7695aa6fde93STejun Heo 
7696aa6fde93STejun Heo 	wq_cpu_intensive_thresh_us = thresh;
7697aa6fde93STejun Heo }
7698aa6fde93STejun Heo 
76993347fa09STejun Heo /**
77003347fa09STejun Heo  * workqueue_init - bring workqueue subsystem fully online
77013347fa09STejun Heo  *
77022930155bSTejun Heo  * This is the second step of three-staged workqueue subsystem initialization
77032930155bSTejun Heo  * and invoked as soon as kthreads can be created and scheduled. Workqueues have
77042930155bSTejun Heo  * been created and work items queued on them, but there are no kworkers
77052930155bSTejun Heo  * executing the work items yet. Populate the worker pools with the initial
77062930155bSTejun Heo  * workers and enable future kworker creations.
77073347fa09STejun Heo  */
77082333e829SYu Chen void __init workqueue_init(void)
77093347fa09STejun Heo {
77102186d9f9STejun Heo 	struct workqueue_struct *wq;
77113347fa09STejun Heo 	struct worker_pool *pool;
77123347fa09STejun Heo 	int cpu, bkt;
77133347fa09STejun Heo 
7714aa6fde93STejun Heo 	wq_cpu_intensive_thresh_init();
7715aa6fde93STejun Heo 
77162186d9f9STejun Heo 	mutex_lock(&wq_pool_mutex);
77172186d9f9STejun Heo 
77182930155bSTejun Heo 	/*
77192930155bSTejun Heo 	 * Per-cpu pools created earlier could be missing node hint. Fix them
77202930155bSTejun Heo 	 * up. Also, create a rescuer for workqueues that requested it.
77212930155bSTejun Heo 	 */
77222186d9f9STejun Heo 	for_each_possible_cpu(cpu) {
77234cb1ef64STejun Heo 		for_each_bh_worker_pool(pool, cpu)
77242186d9f9STejun Heo 			pool->node = cpu_to_node(cpu);
77254cb1ef64STejun Heo 		for_each_cpu_worker_pool(pool, cpu)
77264cb1ef64STejun Heo 			pool->node = cpu_to_node(cpu);
77272186d9f9STejun Heo 	}
77282186d9f9STejun Heo 
772940c17f75STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
773040c17f75STejun Heo 		WARN(init_rescuer(wq),
773140c17f75STejun Heo 		     "workqueue: failed to create early rescuer for %s",
773240c17f75STejun Heo 		     wq->name);
773340c17f75STejun Heo 	}
77342186d9f9STejun Heo 
77352186d9f9STejun Heo 	mutex_unlock(&wq_pool_mutex);
77362186d9f9STejun Heo 
77374cb1ef64STejun Heo 	/*
77384cb1ef64STejun Heo 	 * Create the initial workers. A BH pool has one pseudo worker that
77394cb1ef64STejun Heo 	 * represents the shared BH execution context and thus doesn't get
77404cb1ef64STejun Heo 	 * affected by hotplug events. Create the BH pseudo workers for all
77414cb1ef64STejun Heo 	 * possible CPUs here.
77424cb1ef64STejun Heo 	 */
77434cb1ef64STejun Heo 	for_each_possible_cpu(cpu)
77444cb1ef64STejun Heo 		for_each_bh_worker_pool(pool, cpu)
77454cb1ef64STejun Heo 			BUG_ON(!create_worker(pool));
77464cb1ef64STejun Heo 
77473347fa09STejun Heo 	for_each_online_cpu(cpu) {
77483347fa09STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
77493347fa09STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
77503347fa09STejun Heo 			BUG_ON(!create_worker(pool));
77513347fa09STejun Heo 		}
77523347fa09STejun Heo 	}
77533347fa09STejun Heo 
77543347fa09STejun Heo 	hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
77553347fa09STejun Heo 		BUG_ON(!create_worker(pool));
77563347fa09STejun Heo 
77573347fa09STejun Heo 	wq_online = true;
775882607adcSTejun Heo 	wq_watchdog_init();
77591da177e4SLinus Torvalds }
7760c4f135d6STetsuo Handa 
7761025e1684STejun Heo /*
7762025e1684STejun Heo  * Initialize @pt by first initializing @pt->cpu_pod[] with pod IDs according to
7763025e1684STejun Heo  * @cpu_shares_pod(). Each subset of CPUs that share a pod is assigned a unique
7764025e1684STejun Heo  * and consecutive pod ID. The rest of @pt is initialized accordingly.
7765025e1684STejun Heo  */
7766025e1684STejun Heo static void __init init_pod_type(struct wq_pod_type *pt,
7767025e1684STejun Heo 				 bool (*cpus_share_pod)(int, int))
7768025e1684STejun Heo {
7769025e1684STejun Heo 	int cur, pre, cpu, pod;
7770025e1684STejun Heo 
7771025e1684STejun Heo 	pt->nr_pods = 0;
7772025e1684STejun Heo 
7773025e1684STejun Heo 	/* init @pt->cpu_pod[] according to @cpus_share_pod() */
7774025e1684STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
7775025e1684STejun Heo 	BUG_ON(!pt->cpu_pod);
7776025e1684STejun Heo 
7777025e1684STejun Heo 	for_each_possible_cpu(cur) {
7778025e1684STejun Heo 		for_each_possible_cpu(pre) {
7779025e1684STejun Heo 			if (pre >= cur) {
7780025e1684STejun Heo 				pt->cpu_pod[cur] = pt->nr_pods++;
7781025e1684STejun Heo 				break;
7782025e1684STejun Heo 			}
7783025e1684STejun Heo 			if (cpus_share_pod(cur, pre)) {
7784025e1684STejun Heo 				pt->cpu_pod[cur] = pt->cpu_pod[pre];
7785025e1684STejun Heo 				break;
7786025e1684STejun Heo 			}
7787025e1684STejun Heo 		}
7788025e1684STejun Heo 	}
7789025e1684STejun Heo 
7790025e1684STejun Heo 	/* init the rest to match @pt->cpu_pod[] */
7791025e1684STejun Heo 	pt->pod_cpus = kcalloc(pt->nr_pods, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
7792025e1684STejun Heo 	pt->pod_node = kcalloc(pt->nr_pods, sizeof(pt->pod_node[0]), GFP_KERNEL);
7793025e1684STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node);
7794025e1684STejun Heo 
7795025e1684STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++)
7796025e1684STejun Heo 		BUG_ON(!zalloc_cpumask_var(&pt->pod_cpus[pod], GFP_KERNEL));
7797025e1684STejun Heo 
7798025e1684STejun Heo 	for_each_possible_cpu(cpu) {
7799025e1684STejun Heo 		cpumask_set_cpu(cpu, pt->pod_cpus[pt->cpu_pod[cpu]]);
7800025e1684STejun Heo 		pt->pod_node[pt->cpu_pod[cpu]] = cpu_to_node(cpu);
7801025e1684STejun Heo 	}
7802025e1684STejun Heo }
7803025e1684STejun Heo 
780463c5484eSTejun Heo static bool __init cpus_dont_share(int cpu0, int cpu1)
780563c5484eSTejun Heo {
780663c5484eSTejun Heo 	return false;
780763c5484eSTejun Heo }
780863c5484eSTejun Heo 
780963c5484eSTejun Heo static bool __init cpus_share_smt(int cpu0, int cpu1)
781063c5484eSTejun Heo {
781163c5484eSTejun Heo #ifdef CONFIG_SCHED_SMT
781263c5484eSTejun Heo 	return cpumask_test_cpu(cpu0, cpu_smt_mask(cpu1));
781363c5484eSTejun Heo #else
781463c5484eSTejun Heo 	return false;
781563c5484eSTejun Heo #endif
781663c5484eSTejun Heo }
781763c5484eSTejun Heo 
7818025e1684STejun Heo static bool __init cpus_share_numa(int cpu0, int cpu1)
7819025e1684STejun Heo {
7820025e1684STejun Heo 	return cpu_to_node(cpu0) == cpu_to_node(cpu1);
7821025e1684STejun Heo }
7822025e1684STejun Heo 
78232930155bSTejun Heo /**
78242930155bSTejun Heo  * workqueue_init_topology - initialize CPU pods for unbound workqueues
78252930155bSTejun Heo  *
782696068b60SWang Jinchao  * This is the third step of three-staged workqueue subsystem initialization and
78272930155bSTejun Heo  * invoked after SMP and topology information are fully initialized. It
78282930155bSTejun Heo  * initializes the unbound CPU pods accordingly.
78292930155bSTejun Heo  */
78302930155bSTejun Heo void __init workqueue_init_topology(void)
7831a86feae6STejun Heo {
78322930155bSTejun Heo 	struct workqueue_struct *wq;
7833025e1684STejun Heo 	int cpu;
7834a86feae6STejun Heo 
783563c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CPU], cpus_dont_share);
783663c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_SMT], cpus_share_smt);
783763c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CACHE], cpus_share_cache);
7838025e1684STejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_NUMA], cpus_share_numa);
7839a86feae6STejun Heo 
7840c5f8cd6cSTejun Heo 	wq_topo_initialized = true;
7841c5f8cd6cSTejun Heo 
78422930155bSTejun Heo 	mutex_lock(&wq_pool_mutex);
7843a86feae6STejun Heo 
7844a86feae6STejun Heo 	/*
78452930155bSTejun Heo 	 * Workqueues allocated earlier would have all CPUs sharing the default
78462930155bSTejun Heo 	 * worker pool. Explicitly call wq_update_pod() on all workqueue and CPU
78472930155bSTejun Heo 	 * combinations to apply per-pod sharing.
78482930155bSTejun Heo 	 */
78492930155bSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
78505797b1c1STejun Heo 		for_each_online_cpu(cpu)
78512930155bSTejun Heo 			wq_update_pod(wq, cpu, cpu, true);
78525797b1c1STejun Heo 		if (wq->flags & WQ_UNBOUND) {
78535797b1c1STejun Heo 			mutex_lock(&wq->mutex);
78545797b1c1STejun Heo 			wq_update_node_max_active(wq, -1);
78555797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
78562930155bSTejun Heo 		}
78572930155bSTejun Heo 	}
78582930155bSTejun Heo 
78592930155bSTejun Heo 	mutex_unlock(&wq_pool_mutex);
7860a86feae6STejun Heo }
7861a86feae6STejun Heo 
786220bdedafSTetsuo Handa void __warn_flushing_systemwide_wq(void)
786320bdedafSTetsuo Handa {
786420bdedafSTetsuo Handa 	pr_warn("WARNING: Flushing system-wide workqueues will be prohibited in near future.\n");
786520bdedafSTetsuo Handa 	dump_stack();
786620bdedafSTetsuo Handa }
7867c4f135d6STetsuo Handa EXPORT_SYMBOL(__warn_flushing_systemwide_wq);
7868ace3c549Stiozhang 
7869ace3c549Stiozhang static int __init workqueue_unbound_cpus_setup(char *str)
7870ace3c549Stiozhang {
7871ace3c549Stiozhang 	if (cpulist_parse(str, &wq_cmdline_cpumask) < 0) {
7872ace3c549Stiozhang 		cpumask_clear(&wq_cmdline_cpumask);
7873ace3c549Stiozhang 		pr_warn("workqueue.unbound_cpus: incorrect CPU range, using default\n");
7874ace3c549Stiozhang 	}
7875ace3c549Stiozhang 
7876ace3c549Stiozhang 	return 1;
7877ace3c549Stiozhang }
7878ace3c549Stiozhang __setup("workqueue.unbound_cpus=", workqueue_unbound_cpus_setup);
7879