xref: /linux-6.15/kernel/workqueue.c (revision c26e2f2e)
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 */
84e563d0a7STejun Heo };
85db7bccf4STejun Heo 
86e563d0a7STejun Heo enum worker_flags {
87c8e55f36STejun Heo 	/* worker flags */
88c8e55f36STejun Heo 	WORKER_DIE		= 1 << 1,	/* die die die */
89c8e55f36STejun Heo 	WORKER_IDLE		= 1 << 2,	/* is idle */
90e22bee78STejun Heo 	WORKER_PREP		= 1 << 3,	/* preparing to run works */
91fb0e7bebSTejun Heo 	WORKER_CPU_INTENSIVE	= 1 << 6,	/* cpu intensive */
92f3421797STejun Heo 	WORKER_UNBOUND		= 1 << 7,	/* worker is unbound */
93a9ab775bSTejun Heo 	WORKER_REBOUND		= 1 << 8,	/* worker was rebound */
94e22bee78STejun Heo 
95a9ab775bSTejun Heo 	WORKER_NOT_RUNNING	= WORKER_PREP | WORKER_CPU_INTENSIVE |
96a9ab775bSTejun Heo 				  WORKER_UNBOUND | WORKER_REBOUND,
97e563d0a7STejun Heo };
98db7bccf4STejun Heo 
99e563d0a7STejun Heo enum wq_internal_consts {
100e34cdddbSTejun Heo 	NR_STD_WORKER_POOLS	= 2,		/* # standard pools per cpu */
1014ce62e9eSTejun Heo 
10229c91e99STejun Heo 	UNBOUND_POOL_HASH_ORDER	= 6,		/* hashed by pool->attrs */
103c8e55f36STejun Heo 	BUSY_WORKER_HASH_ORDER	= 6,		/* 64 pointers */
104db7bccf4STejun Heo 
105e22bee78STejun Heo 	MAX_IDLE_WORKERS_RATIO	= 4,		/* 1/4 of busy can be idle */
106e22bee78STejun Heo 	IDLE_WORKER_TIMEOUT	= 300 * HZ,	/* keep idle ones for 5 mins */
107e22bee78STejun Heo 
1083233cdbdSTejun Heo 	MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
1093233cdbdSTejun Heo 						/* call for help after 10ms
1103233cdbdSTejun Heo 						   (min two ticks) */
111e22bee78STejun Heo 	MAYDAY_INTERVAL		= HZ / 10,	/* and then every 100ms */
112e22bee78STejun Heo 	CREATE_COOLDOWN		= HZ,		/* time to breath after fail */
1131da177e4SLinus Torvalds 
1141da177e4SLinus Torvalds 	/*
115e22bee78STejun Heo 	 * Rescue workers are used only on emergencies and shared by
1168698a745SDongsheng Yang 	 * all cpus.  Give MIN_NICE.
117e22bee78STejun Heo 	 */
1188698a745SDongsheng Yang 	RESCUER_NICE_LEVEL	= MIN_NICE,
1198698a745SDongsheng Yang 	HIGHPRI_NICE_LEVEL	= MIN_NICE,
120ecf6881fSTejun Heo 
12131c89007SAudra Mitchell 	WQ_NAME_LEN		= 32,
122c8e55f36STejun Heo };
123c8e55f36STejun Heo 
1241da177e4SLinus Torvalds /*
1254cb1ef64STejun Heo  * We don't want to trap softirq for too long. See MAX_SOFTIRQ_TIME and
1264cb1ef64STejun Heo  * MAX_SOFTIRQ_RESTART in kernel/softirq.c. These are macros because
1274cb1ef64STejun Heo  * msecs_to_jiffies() can't be an initializer.
1284cb1ef64STejun Heo  */
1294cb1ef64STejun Heo #define BH_WORKER_JIFFIES	msecs_to_jiffies(2)
1304cb1ef64STejun Heo #define BH_WORKER_RESTARTS	10
1314cb1ef64STejun Heo 
1324cb1ef64STejun Heo /*
1334690c4abSTejun Heo  * Structure fields follow one of the following exclusion rules.
1344690c4abSTejun Heo  *
135e41e704bSTejun Heo  * I: Modifiable by initialization/destruction paths and read-only for
136e41e704bSTejun Heo  *    everyone else.
1374690c4abSTejun Heo  *
138e22bee78STejun Heo  * P: Preemption protected.  Disabling preemption is enough and should
139e22bee78STejun Heo  *    only be modified and accessed from the local cpu.
140e22bee78STejun Heo  *
141d565ed63STejun Heo  * L: pool->lock protected.  Access with pool->lock held.
1424690c4abSTejun Heo  *
1435797b1c1STejun Heo  * LN: pool->lock and wq_node_nr_active->lock protected for writes. Either for
1445797b1c1STejun Heo  *     reads.
1455797b1c1STejun Heo  *
146bdf8b9bfSTejun Heo  * K: Only modified by worker while holding pool->lock. Can be safely read by
147bdf8b9bfSTejun Heo  *    self, while holding pool->lock or from IRQ context if %current is the
148bdf8b9bfSTejun Heo  *    kworker.
149bdf8b9bfSTejun Heo  *
150bdf8b9bfSTejun Heo  * S: Only modified by worker self.
151bdf8b9bfSTejun Heo  *
1521258fae7STejun Heo  * A: wq_pool_attach_mutex protected.
153822d8405STejun Heo  *
15468e13a67SLai Jiangshan  * PL: wq_pool_mutex protected.
15576af4d93STejun Heo  *
15624acfb71SThomas Gleixner  * PR: wq_pool_mutex protected for writes.  RCU protected for reads.
1575bcab335STejun Heo  *
1585b95e1afSLai Jiangshan  * PW: wq_pool_mutex and wq->mutex protected for writes.  Either for reads.
1595b95e1afSLai Jiangshan  *
1605b95e1afSLai Jiangshan  * PWR: wq_pool_mutex and wq->mutex protected for writes.  Either or
16124acfb71SThomas Gleixner  *      RCU for reads.
1625b95e1afSLai Jiangshan  *
1633c25a55dSLai Jiangshan  * WQ: wq->mutex protected.
1643c25a55dSLai Jiangshan  *
16524acfb71SThomas Gleixner  * WR: wq->mutex protected for writes.  RCU protected for reads.
1662e109a28STejun Heo  *
167a045a272STejun Heo  * WO: wq->mutex protected for writes. Updated with WRITE_ONCE() and can be read
168a045a272STejun Heo  *     with READ_ONCE() without locking.
169a045a272STejun Heo  *
1702e109a28STejun Heo  * MD: wq_mayday_lock protected.
171cd2440d6SPetr Mladek  *
172cd2440d6SPetr Mladek  * WD: Used internally by the watchdog.
1734690c4abSTejun Heo  */
1744690c4abSTejun Heo 
1752eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */
176c34056a3STejun Heo 
177bd7bdd43STejun Heo struct worker_pool {
178a9b8a985SSebastian Andrzej Siewior 	raw_spinlock_t		lock;		/* the pool lock */
179d84ff051STejun Heo 	int			cpu;		/* I: the associated cpu */
180f3f90ad4STejun Heo 	int			node;		/* I: the associated node ID */
1819daf9e67STejun Heo 	int			id;		/* I: pool ID */
182bc8b50c2STejun Heo 	unsigned int		flags;		/* L: flags */
183bd7bdd43STejun Heo 
18482607adcSTejun Heo 	unsigned long		watchdog_ts;	/* L: watchdog timestamp */
185cd2440d6SPetr Mladek 	bool			cpu_stall;	/* WD: stalled cpu bound pool */
18682607adcSTejun Heo 
187bc35f7efSLai Jiangshan 	/*
188bc35f7efSLai Jiangshan 	 * The counter is incremented in a process context on the associated CPU
189bc35f7efSLai Jiangshan 	 * w/ preemption disabled, and decremented or reset in the same context
190bc35f7efSLai Jiangshan 	 * but w/ pool->lock held. The readers grab pool->lock and are
191bc35f7efSLai Jiangshan 	 * guaranteed to see if the counter reached zero.
192bc35f7efSLai Jiangshan 	 */
193bc35f7efSLai Jiangshan 	int			nr_running;
19484f91c62SLai Jiangshan 
195bd7bdd43STejun Heo 	struct list_head	worklist;	/* L: list of pending works */
196ea1abd61SLai Jiangshan 
1975826cc8fSLai Jiangshan 	int			nr_workers;	/* L: total number of workers */
1985826cc8fSLai Jiangshan 	int			nr_idle;	/* L: currently idle workers */
199bd7bdd43STejun Heo 
2002c1f1a91SLai Jiangshan 	struct list_head	idle_list;	/* L: list of idle workers */
201bd7bdd43STejun Heo 	struct timer_list	idle_timer;	/* L: worker idle timeout */
2023f959aa3SValentin Schneider 	struct work_struct      idle_cull_work; /* L: worker idle cleanup */
2033f959aa3SValentin Schneider 
204bd7bdd43STejun Heo 	struct timer_list	mayday_timer;	  /* L: SOS timer for workers */
205bd7bdd43STejun Heo 
206c5aa87bbSTejun Heo 	/* a workers is either on busy_hash or idle_list, or the manager */
207c9e7cf27STejun Heo 	DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
208c9e7cf27STejun Heo 						/* L: hash of busy workers */
209c9e7cf27STejun Heo 
2102607d7a6STejun Heo 	struct worker		*manager;	/* L: purely informational */
21192f9c5c4SLai Jiangshan 	struct list_head	workers;	/* A: attached workers */
212e02b9312SValentin Schneider 	struct list_head        dying_workers;  /* A: workers about to die */
21360f5a4bcSLai Jiangshan 	struct completion	*detach_completion; /* all workers detached */
214e19e397aSTejun Heo 
2157cda9aaeSLai Jiangshan 	struct ida		worker_ida;	/* worker IDs for task name */
216e19e397aSTejun Heo 
2177a4e344cSTejun Heo 	struct workqueue_attrs	*attrs;		/* I: worker attributes */
21868e13a67SLai Jiangshan 	struct hlist_node	hash_node;	/* PL: unbound_pool_hash node */
21968e13a67SLai Jiangshan 	int			refcnt;		/* PL: refcnt for unbound pools */
2207a4e344cSTejun Heo 
221e19e397aSTejun Heo 	/*
22224acfb71SThomas Gleixner 	 * Destruction of pool is RCU protected to allow dereferences
22329c91e99STejun Heo 	 * from get_work_pool().
22429c91e99STejun Heo 	 */
22529c91e99STejun Heo 	struct rcu_head		rcu;
22684f91c62SLai Jiangshan };
2278b03ae3cSTejun Heo 
2288b03ae3cSTejun Heo /*
229725e8ec5STejun Heo  * Per-pool_workqueue statistics. These can be monitored using
230725e8ec5STejun Heo  * tools/workqueue/wq_monitor.py.
231725e8ec5STejun Heo  */
232725e8ec5STejun Heo enum pool_workqueue_stats {
233725e8ec5STejun Heo 	PWQ_STAT_STARTED,	/* work items started execution */
234725e8ec5STejun Heo 	PWQ_STAT_COMPLETED,	/* work items completed execution */
2358a1dd1e5STejun Heo 	PWQ_STAT_CPU_TIME,	/* total CPU time consumed */
236616db877STejun Heo 	PWQ_STAT_CPU_INTENSIVE,	/* wq_cpu_intensive_thresh_us violations */
237725e8ec5STejun Heo 	PWQ_STAT_CM_WAKEUP,	/* concurrency-management worker wakeups */
2388639ecebSTejun Heo 	PWQ_STAT_REPATRIATED,	/* unbound workers brought back into scope */
239725e8ec5STejun Heo 	PWQ_STAT_MAYDAY,	/* maydays to rescuer */
240725e8ec5STejun Heo 	PWQ_STAT_RESCUED,	/* linked work items executed by rescuer */
241725e8ec5STejun Heo 
242725e8ec5STejun Heo 	PWQ_NR_STATS,
243725e8ec5STejun Heo };
244725e8ec5STejun Heo 
245725e8ec5STejun Heo /*
246112202d9STejun Heo  * The per-pool workqueue.  While queued, the lower WORK_STRUCT_FLAG_BITS
247112202d9STejun Heo  * of work_struct->data are used for flags and the remaining high bits
248112202d9STejun Heo  * point to the pwq; thus, pwqs need to be aligned at two's power of the
249112202d9STejun Heo  * number of flag bits.
2501da177e4SLinus Torvalds  */
251112202d9STejun Heo struct pool_workqueue {
252bd7bdd43STejun Heo 	struct worker_pool	*pool;		/* I: the associated pool */
2534690c4abSTejun Heo 	struct workqueue_struct *wq;		/* I: the owning workqueue */
25473f53c4aSTejun Heo 	int			work_color;	/* L: current color */
25573f53c4aSTejun Heo 	int			flush_color;	/* L: flushing color */
2568864b4e5STejun Heo 	int			refcnt;		/* L: reference count */
25773f53c4aSTejun Heo 	int			nr_in_flight[WORK_NR_COLORS];
25873f53c4aSTejun Heo 						/* L: nr of in_flight works */
2594c065dbcSWaiman Long 	bool			plugged;	/* L: execution suspended */
260018f3a13SLai Jiangshan 
261018f3a13SLai Jiangshan 	/*
262018f3a13SLai Jiangshan 	 * nr_active management and WORK_STRUCT_INACTIVE:
263018f3a13SLai Jiangshan 	 *
264018f3a13SLai Jiangshan 	 * When pwq->nr_active >= max_active, new work item is queued to
265018f3a13SLai Jiangshan 	 * pwq->inactive_works instead of pool->worklist and marked with
266018f3a13SLai Jiangshan 	 * WORK_STRUCT_INACTIVE.
267018f3a13SLai Jiangshan 	 *
2685797b1c1STejun Heo 	 * All work items marked with WORK_STRUCT_INACTIVE do not participate in
2695797b1c1STejun Heo 	 * nr_active and all work items in pwq->inactive_works are marked with
2705797b1c1STejun Heo 	 * WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE work items are
2715797b1c1STejun Heo 	 * in pwq->inactive_works. Some of them are ready to run in
2725797b1c1STejun Heo 	 * pool->worklist or worker->scheduled. Those work itmes are only struct
2735797b1c1STejun Heo 	 * wq_barrier which is used for flush_work() and should not participate
2745797b1c1STejun Heo 	 * in nr_active. For non-barrier work item, it is marked with
2755797b1c1STejun Heo 	 * WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works.
276018f3a13SLai Jiangshan 	 */
2771e19ffc6STejun Heo 	int			nr_active;	/* L: nr of active works */
278f97a4a1aSLai Jiangshan 	struct list_head	inactive_works;	/* L: inactive works */
2795797b1c1STejun Heo 	struct list_head	pending_node;	/* LN: node on wq_node_nr_active->pending_pwqs */
2803c25a55dSLai Jiangshan 	struct list_head	pwqs_node;	/* WR: node on wq->pwqs */
2812e109a28STejun Heo 	struct list_head	mayday_node;	/* MD: node on wq->maydays */
2828864b4e5STejun Heo 
283725e8ec5STejun Heo 	u64			stats[PWQ_NR_STATS];
284725e8ec5STejun Heo 
2858864b4e5STejun Heo 	/*
286967b494eSTejun Heo 	 * Release of unbound pwq is punted to a kthread_worker. See put_pwq()
287687a9aa5STejun Heo 	 * and pwq_release_workfn() for details. pool_workqueue itself is also
288687a9aa5STejun Heo 	 * RCU protected so that the first pwq can be determined without
289967b494eSTejun Heo 	 * grabbing wq->mutex.
2908864b4e5STejun Heo 	 */
291687a9aa5STejun Heo 	struct kthread_work	release_work;
2928864b4e5STejun Heo 	struct rcu_head		rcu;
293e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS);
2941da177e4SLinus Torvalds 
2951da177e4SLinus Torvalds /*
29673f53c4aSTejun Heo  * Structure used to wait for workqueue flush.
29773f53c4aSTejun Heo  */
29873f53c4aSTejun Heo struct wq_flusher {
2993c25a55dSLai Jiangshan 	struct list_head	list;		/* WQ: list of flushers */
3003c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: flush color waiting for */
30173f53c4aSTejun Heo 	struct completion	done;		/* flush completion */
30273f53c4aSTejun Heo };
3031da177e4SLinus Torvalds 
304226223abSTejun Heo struct wq_device;
305226223abSTejun Heo 
30673f53c4aSTejun Heo /*
30791ccc6e7STejun Heo  * Unlike in a per-cpu workqueue where max_active limits its concurrency level
30891ccc6e7STejun Heo  * on each CPU, in an unbound workqueue, max_active applies to the whole system.
30991ccc6e7STejun Heo  * As sharing a single nr_active across multiple sockets can be very expensive,
31091ccc6e7STejun Heo  * the counting and enforcement is per NUMA node.
3115797b1c1STejun Heo  *
3125797b1c1STejun Heo  * The following struct is used to enforce per-node max_active. When a pwq wants
3135797b1c1STejun Heo  * to start executing a work item, it should increment ->nr using
3145797b1c1STejun Heo  * tryinc_node_nr_active(). If acquisition fails due to ->nr already being over
3155797b1c1STejun Heo  * ->max, the pwq is queued on ->pending_pwqs. As in-flight work items finish
3165797b1c1STejun Heo  * and decrement ->nr, node_activate_pending_pwq() activates the pending pwqs in
3175797b1c1STejun Heo  * round-robin order.
31891ccc6e7STejun Heo  */
31991ccc6e7STejun Heo struct wq_node_nr_active {
3205797b1c1STejun Heo 	int			max;		/* per-node max_active */
3215797b1c1STejun Heo 	atomic_t		nr;		/* per-node nr_active */
3225797b1c1STejun Heo 	raw_spinlock_t		lock;		/* nests inside pool locks */
3235797b1c1STejun Heo 	struct list_head	pending_pwqs;	/* LN: pwqs with inactive works */
32491ccc6e7STejun Heo };
32591ccc6e7STejun Heo 
32691ccc6e7STejun Heo /*
327c5aa87bbSTejun Heo  * The externally visible workqueue.  It relays the issued work items to
328c5aa87bbSTejun Heo  * the appropriate worker_pool through its pool_workqueues.
3291da177e4SLinus Torvalds  */
3301da177e4SLinus Torvalds struct workqueue_struct {
3313c25a55dSLai Jiangshan 	struct list_head	pwqs;		/* WR: all pwqs of this wq */
332e2dca7adSTejun Heo 	struct list_head	list;		/* PR: list of all workqueues */
33373f53c4aSTejun Heo 
3343c25a55dSLai Jiangshan 	struct mutex		mutex;		/* protects this wq */
3353c25a55dSLai Jiangshan 	int			work_color;	/* WQ: current work color */
3363c25a55dSLai Jiangshan 	int			flush_color;	/* WQ: current flush color */
337112202d9STejun Heo 	atomic_t		nr_pwqs_to_flush; /* flush in progress */
3383c25a55dSLai Jiangshan 	struct wq_flusher	*first_flusher;	/* WQ: first flusher */
3393c25a55dSLai Jiangshan 	struct list_head	flusher_queue;	/* WQ: flush waiters */
3403c25a55dSLai Jiangshan 	struct list_head	flusher_overflow; /* WQ: flush overflow list */
34173f53c4aSTejun Heo 
3422e109a28STejun Heo 	struct list_head	maydays;	/* MD: pwqs requesting rescue */
34330ae2fc0STejun Heo 	struct worker		*rescuer;	/* MD: rescue worker */
344e22bee78STejun Heo 
34587fc741eSLai Jiangshan 	int			nr_drainers;	/* WQ: drain in progress */
3465797b1c1STejun Heo 
3475797b1c1STejun Heo 	/* See alloc_workqueue() function comment for info on min/max_active */
348a045a272STejun Heo 	int			max_active;	/* WO: max active works */
3495797b1c1STejun Heo 	int			min_active;	/* WO: min active works */
350a045a272STejun Heo 	int			saved_max_active; /* WQ: saved max_active */
3515797b1c1STejun Heo 	int			saved_min_active; /* WQ: saved min_active */
352226223abSTejun Heo 
3535b95e1afSLai Jiangshan 	struct workqueue_attrs	*unbound_attrs;	/* PW: only for unbound wqs */
3549f66cff2STejun Heo 	struct pool_workqueue __rcu *dfl_pwq;   /* PW: only for unbound wqs */
3556029a918STejun Heo 
356226223abSTejun Heo #ifdef CONFIG_SYSFS
357226223abSTejun Heo 	struct wq_device	*wq_dev;	/* I: for sysfs interface */
358226223abSTejun Heo #endif
3594e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
360669de8bdSBart Van Assche 	char			*lock_name;
361669de8bdSBart Van Assche 	struct lock_class_key	key;
3624e6045f1SJohannes Berg 	struct lockdep_map	lockdep_map;
3634e6045f1SJohannes Berg #endif
364ecf6881fSTejun Heo 	char			name[WQ_NAME_LEN]; /* I: workqueue name */
3652728fd2fSTejun Heo 
366e2dca7adSTejun Heo 	/*
36724acfb71SThomas Gleixner 	 * Destruction of workqueue_struct is RCU protected to allow walking
36824acfb71SThomas Gleixner 	 * the workqueues list without grabbing wq_pool_mutex.
369e2dca7adSTejun Heo 	 * This is used to dump all workqueues from sysrq.
370e2dca7adSTejun Heo 	 */
371e2dca7adSTejun Heo 	struct rcu_head		rcu;
372e2dca7adSTejun Heo 
3732728fd2fSTejun Heo 	/* hot fields used during command issue, aligned to cacheline */
3742728fd2fSTejun Heo 	unsigned int		flags ____cacheline_aligned; /* WQ: WQ_* flags */
375636b927eSTejun Heo 	struct pool_workqueue __percpu __rcu **cpu_pwq; /* I: per-cpu pwqs */
37691ccc6e7STejun Heo 	struct wq_node_nr_active *node_nr_active[]; /* I: per-node nr_active */
3771da177e4SLinus Torvalds };
3781da177e4SLinus Torvalds 
37984193c07STejun Heo /*
38084193c07STejun Heo  * Each pod type describes how CPUs should be grouped for unbound workqueues.
38184193c07STejun Heo  * See the comment above workqueue_attrs->affn_scope.
38284193c07STejun Heo  */
38384193c07STejun Heo struct wq_pod_type {
38484193c07STejun Heo 	int			nr_pods;	/* number of pods */
38584193c07STejun Heo 	cpumask_var_t		*pod_cpus;	/* pod -> cpus */
38684193c07STejun Heo 	int			*pod_node;	/* pod -> node */
38784193c07STejun Heo 	int			*cpu_pod;	/* cpu -> pod */
38884193c07STejun Heo };
38984193c07STejun Heo 
39063c5484eSTejun Heo static const char *wq_affn_names[WQ_AFFN_NR_TYPES] = {
391523a301eSTejun Heo 	[WQ_AFFN_DFL]		= "default",
39263c5484eSTejun Heo 	[WQ_AFFN_CPU]		= "cpu",
39363c5484eSTejun Heo 	[WQ_AFFN_SMT]		= "smt",
39463c5484eSTejun Heo 	[WQ_AFFN_CACHE]		= "cache",
39563c5484eSTejun Heo 	[WQ_AFFN_NUMA]		= "numa",
39663c5484eSTejun Heo 	[WQ_AFFN_SYSTEM]	= "system",
39763c5484eSTejun Heo };
398bce90380STejun Heo 
399616db877STejun Heo /*
400616db877STejun Heo  * Per-cpu work items which run for longer than the following threshold are
401616db877STejun Heo  * automatically considered CPU intensive and excluded from concurrency
402616db877STejun Heo  * management to prevent them from noticeably delaying other per-cpu work items.
403aa6fde93STejun Heo  * ULONG_MAX indicates that the user hasn't overridden it with a boot parameter.
404aa6fde93STejun Heo  * The actual value is initialized in wq_cpu_intensive_thresh_init().
405616db877STejun Heo  */
406aa6fde93STejun Heo static unsigned long wq_cpu_intensive_thresh_us = ULONG_MAX;
407616db877STejun Heo module_param_named(cpu_intensive_thresh_us, wq_cpu_intensive_thresh_us, ulong, 0644);
408616db877STejun Heo 
409cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */
410552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
411cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444);
412cee22a15SViresh Kumar 
413863b710bSTejun Heo static bool wq_online;			/* can kworkers be created yet? */
414c7a40c49STejun Heo static bool wq_topo_initialized __read_mostly = false;
415c7a40c49STejun Heo 
416c7a40c49STejun Heo static struct kmem_cache *pwq_cache;
417c7a40c49STejun Heo 
418c7a40c49STejun Heo static struct wq_pod_type wq_pod_types[WQ_AFFN_NR_TYPES];
419c7a40c49STejun Heo static enum wq_affn_scope wq_affn_dfl = WQ_AFFN_CACHE;
4203347fa09STejun Heo 
421fef59c9cSTejun Heo /* buf for wq_update_unbound_pod_attrs(), protected by CPU hotplug exclusion */
422fef59c9cSTejun Heo static struct workqueue_attrs *wq_update_pod_attrs_buf;
4234c16bd32STejun Heo 
42468e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex);	/* protects pools and workqueues list */
4251258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
426a9b8a985SSebastian Andrzej Siewior static DEFINE_RAW_SPINLOCK(wq_mayday_lock);	/* protects wq->maydays list */
427d8bb65abSSebastian Andrzej Siewior /* wait for manager to go away */
428d8bb65abSSebastian Andrzej Siewior static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait);
4295bcab335STejun Heo 
430e2dca7adSTejun Heo static LIST_HEAD(workqueues);		/* PR: list of all workqueues */
43168e13a67SLai Jiangshan static bool workqueue_freezing;		/* PL: have wqs started freezing? */
4327d19c5ceSTejun Heo 
43399c621efSLai Jiangshan /* PL&A: allowable cpus for unbound wqs and work items */
434ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask;
435ef557180SMike Galbraith 
436fe28f631SWaiman Long /* PL: user requested unbound cpumask via sysfs */
437fe28f631SWaiman Long static cpumask_var_t wq_requested_unbound_cpumask;
438fe28f631SWaiman Long 
439fe28f631SWaiman Long /* PL: isolated cpumask to be excluded from unbound cpumask */
440fe28f631SWaiman Long static cpumask_var_t wq_isolated_cpumask;
441fe28f631SWaiman Long 
442ace3c549Stiozhang /* for further constrain wq_unbound_cpumask by cmdline parameter*/
443ace3c549Stiozhang static struct cpumask wq_cmdline_cpumask __initdata;
444ace3c549Stiozhang 
445ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */
446ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last);
447b05a7928SFrederic Weisbecker 
448f303fccbSTejun Heo /*
449f303fccbSTejun Heo  * Local execution of unbound work items is no longer guaranteed.  The
450f303fccbSTejun Heo  * following always forces round-robin CPU selection on unbound work items
451f303fccbSTejun Heo  * to uncover usages which depend on it.
452f303fccbSTejun Heo  */
453f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
454f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true;
455f303fccbSTejun Heo #else
456f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false;
457f303fccbSTejun Heo #endif
458f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
459f303fccbSTejun Heo 
4602f34d733STejun Heo /* to raise softirq for the BH worker pools on other CPUs */
4612f34d733STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct irq_work [NR_STD_WORKER_POOLS],
4622f34d733STejun Heo 				     bh_pool_irq_works);
4632f34d733STejun Heo 
4644cb1ef64STejun Heo /* the BH worker pools */
4654cb1ef64STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
4664cb1ef64STejun Heo 				     bh_worker_pools);
4674cb1ef64STejun Heo 
4687d19c5ceSTejun Heo /* the per-cpu worker pools */
4694cb1ef64STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
4704cb1ef64STejun Heo 				     cpu_worker_pools);
4717d19c5ceSTejun Heo 
47268e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr);	/* PR: idr of all pools */
4737d19c5ceSTejun Heo 
47468e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */
47529c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
47629c91e99STejun Heo 
477c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */
47829c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
47929c91e99STejun Heo 
4808a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */
4818a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
4828a2b7538STejun Heo 
483967b494eSTejun Heo /*
484967b494eSTejun Heo  * I: kthread_worker to release pwq's. pwq release needs to be bounced to a
485967b494eSTejun Heo  * process context while holding a pool lock. Bounce to a dedicated kthread
486967b494eSTejun Heo  * worker to avoid A-A deadlocks.
487967b494eSTejun Heo  */
48868279f9cSAlexey Dobriyan static struct kthread_worker *pwq_release_worker __ro_after_init;
489967b494eSTejun Heo 
49068279f9cSAlexey Dobriyan struct workqueue_struct *system_wq __ro_after_init;
491ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq);
49268279f9cSAlexey Dobriyan struct workqueue_struct *system_highpri_wq __ro_after_init;
4931aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq);
49468279f9cSAlexey Dobriyan struct workqueue_struct *system_long_wq __ro_after_init;
495d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq);
49668279f9cSAlexey Dobriyan struct workqueue_struct *system_unbound_wq __ro_after_init;
497f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq);
49868279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_wq __ro_after_init;
49924d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq);
50068279f9cSAlexey Dobriyan struct workqueue_struct *system_power_efficient_wq __ro_after_init;
5010668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq);
50268279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_power_efficient_wq __ro_after_init;
5030668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
5044cb1ef64STejun Heo struct workqueue_struct *system_bh_wq;
5054cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_wq);
5064cb1ef64STejun Heo struct workqueue_struct *system_bh_highpri_wq;
5074cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_highpri_wq);
508d320c038STejun Heo 
5097d19c5ceSTejun Heo static int worker_thread(void *__worker);
5106ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
511c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq);
51255df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool);
5137d19c5ceSTejun Heo 
51497bd2347STejun Heo #define CREATE_TRACE_POINTS
51597bd2347STejun Heo #include <trace/events/workqueue.h>
51697bd2347STejun Heo 
51768e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex()					\
518d355001fSTejun Heo 	RCU_LOCKDEP_WARN(!rcu_read_lock_any_held() &&			\
519f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
52024acfb71SThomas Gleixner 			 "RCU or wq_pool_mutex should be held")
5215bcab335STejun Heo 
5225b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)			\
523d355001fSTejun Heo 	RCU_LOCKDEP_WARN(!rcu_read_lock_any_held() &&			\
524f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq->mutex) &&		\
525f78f5b90SPaul E. McKenney 			 !lockdep_is_held(&wq_pool_mutex),		\
52624acfb71SThomas Gleixner 			 "RCU, wq->mutex or wq_pool_mutex should be held")
5275b95e1afSLai Jiangshan 
5284cb1ef64STejun Heo #define for_each_bh_worker_pool(pool, cpu)				\
5294cb1ef64STejun Heo 	for ((pool) = &per_cpu(bh_worker_pools, cpu)[0];		\
5304cb1ef64STejun Heo 	     (pool) < &per_cpu(bh_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
5314cb1ef64STejun Heo 	     (pool)++)
5324cb1ef64STejun Heo 
533f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu)				\
534f02ae73aSTejun Heo 	for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];		\
535f02ae73aSTejun Heo 	     (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
5367a62c2c8STejun Heo 	     (pool)++)
5374ce62e9eSTejun Heo 
53849e3cf44STejun Heo /**
53917116969STejun Heo  * for_each_pool - iterate through all worker_pools in the system
54017116969STejun Heo  * @pool: iteration cursor
541611c92a0STejun Heo  * @pi: integer used for iteration
542fa1b54e6STejun Heo  *
54324acfb71SThomas Gleixner  * This must be called either with wq_pool_mutex held or RCU read
54468e13a67SLai Jiangshan  * locked.  If the pool needs to be used beyond the locking in effect, the
54568e13a67SLai Jiangshan  * caller is responsible for guaranteeing that the pool stays online.
546fa1b54e6STejun Heo  *
547fa1b54e6STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
548fa1b54e6STejun Heo  * ignored.
54917116969STejun Heo  */
550611c92a0STejun Heo #define for_each_pool(pool, pi)						\
551611c92a0STejun Heo 	idr_for_each_entry(&worker_pool_idr, pool, pi)			\
55268e13a67SLai Jiangshan 		if (({ assert_rcu_or_pool_mutex(); false; })) { }	\
553fa1b54e6STejun Heo 		else
55417116969STejun Heo 
55517116969STejun Heo /**
556822d8405STejun Heo  * for_each_pool_worker - iterate through all workers of a worker_pool
557822d8405STejun Heo  * @worker: iteration cursor
558822d8405STejun Heo  * @pool: worker_pool to iterate workers of
559822d8405STejun Heo  *
5601258fae7STejun Heo  * This must be called with wq_pool_attach_mutex.
561822d8405STejun Heo  *
562822d8405STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
563822d8405STejun Heo  * ignored.
564822d8405STejun Heo  */
565da028469SLai Jiangshan #define for_each_pool_worker(worker, pool)				\
566da028469SLai Jiangshan 	list_for_each_entry((worker), &(pool)->workers, node)		\
5671258fae7STejun Heo 		if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
568822d8405STejun Heo 		else
569822d8405STejun Heo 
570822d8405STejun Heo /**
57149e3cf44STejun Heo  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
57249e3cf44STejun Heo  * @pwq: iteration cursor
57349e3cf44STejun Heo  * @wq: the target workqueue
57476af4d93STejun Heo  *
57524acfb71SThomas Gleixner  * This must be called either with wq->mutex held or RCU read locked.
576794b18bcSTejun Heo  * If the pwq needs to be used beyond the locking in effect, the caller is
577794b18bcSTejun Heo  * responsible for guaranteeing that the pwq stays online.
57876af4d93STejun Heo  *
57976af4d93STejun Heo  * The if/else clause exists only for the lockdep assertion and can be
58076af4d93STejun Heo  * ignored.
58149e3cf44STejun Heo  */
58249e3cf44STejun Heo #define for_each_pwq(pwq, wq)						\
58349e9d1a9SSebastian Andrzej Siewior 	list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node,		\
5845a644662SJoel Fernandes (Google) 				 lockdep_is_held(&(wq->mutex)))
585f3421797STejun Heo 
586dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK
587dc186ad7SThomas Gleixner 
588f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr;
589dc186ad7SThomas Gleixner 
59099777288SStanislaw Gruszka static void *work_debug_hint(void *addr)
59199777288SStanislaw Gruszka {
59299777288SStanislaw Gruszka 	return ((struct work_struct *) addr)->func;
59399777288SStanislaw Gruszka }
59499777288SStanislaw Gruszka 
595b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr)
596b9fdac7fSDu, Changbin {
597b9fdac7fSDu, Changbin 	struct work_struct *work = addr;
598b9fdac7fSDu, Changbin 
599b9fdac7fSDu, Changbin 	return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
600b9fdac7fSDu, Changbin }
601b9fdac7fSDu, Changbin 
602dc186ad7SThomas Gleixner /*
603dc186ad7SThomas Gleixner  * fixup_init is called when:
604dc186ad7SThomas Gleixner  * - an active object is initialized
605dc186ad7SThomas Gleixner  */
60602a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state)
607dc186ad7SThomas Gleixner {
608dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
609dc186ad7SThomas Gleixner 
610dc186ad7SThomas Gleixner 	switch (state) {
611dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
612dc186ad7SThomas Gleixner 		cancel_work_sync(work);
613dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
61402a982a6SDu, Changbin 		return true;
615dc186ad7SThomas Gleixner 	default:
61602a982a6SDu, Changbin 		return false;
617dc186ad7SThomas Gleixner 	}
618dc186ad7SThomas Gleixner }
619dc186ad7SThomas Gleixner 
620dc186ad7SThomas Gleixner /*
621dc186ad7SThomas Gleixner  * fixup_free is called when:
622dc186ad7SThomas Gleixner  * - an active object is freed
623dc186ad7SThomas Gleixner  */
62402a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state)
625dc186ad7SThomas Gleixner {
626dc186ad7SThomas Gleixner 	struct work_struct *work = addr;
627dc186ad7SThomas Gleixner 
628dc186ad7SThomas Gleixner 	switch (state) {
629dc186ad7SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
630dc186ad7SThomas Gleixner 		cancel_work_sync(work);
631dc186ad7SThomas Gleixner 		debug_object_free(work, &work_debug_descr);
63202a982a6SDu, Changbin 		return true;
633dc186ad7SThomas Gleixner 	default:
63402a982a6SDu, Changbin 		return false;
635dc186ad7SThomas Gleixner 	}
636dc186ad7SThomas Gleixner }
637dc186ad7SThomas Gleixner 
638f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = {
639dc186ad7SThomas Gleixner 	.name		= "work_struct",
64099777288SStanislaw Gruszka 	.debug_hint	= work_debug_hint,
641b9fdac7fSDu, Changbin 	.is_static_object = work_is_static_object,
642dc186ad7SThomas Gleixner 	.fixup_init	= work_fixup_init,
643dc186ad7SThomas Gleixner 	.fixup_free	= work_fixup_free,
644dc186ad7SThomas Gleixner };
645dc186ad7SThomas Gleixner 
646dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work)
647dc186ad7SThomas Gleixner {
648dc186ad7SThomas Gleixner 	debug_object_activate(work, &work_debug_descr);
649dc186ad7SThomas Gleixner }
650dc186ad7SThomas Gleixner 
651dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work)
652dc186ad7SThomas Gleixner {
653dc186ad7SThomas Gleixner 	debug_object_deactivate(work, &work_debug_descr);
654dc186ad7SThomas Gleixner }
655dc186ad7SThomas Gleixner 
656dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack)
657dc186ad7SThomas Gleixner {
658dc186ad7SThomas Gleixner 	if (onstack)
659dc186ad7SThomas Gleixner 		debug_object_init_on_stack(work, &work_debug_descr);
660dc186ad7SThomas Gleixner 	else
661dc186ad7SThomas Gleixner 		debug_object_init(work, &work_debug_descr);
662dc186ad7SThomas Gleixner }
663dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work);
664dc186ad7SThomas Gleixner 
665dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work)
666dc186ad7SThomas Gleixner {
667dc186ad7SThomas Gleixner 	debug_object_free(work, &work_debug_descr);
668dc186ad7SThomas Gleixner }
669dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack);
670dc186ad7SThomas Gleixner 
671ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work)
672ea2e64f2SThomas Gleixner {
673ea2e64f2SThomas Gleixner 	destroy_timer_on_stack(&work->timer);
674ea2e64f2SThomas Gleixner 	debug_object_free(&work->work, &work_debug_descr);
675ea2e64f2SThomas Gleixner }
676ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
677ea2e64f2SThomas Gleixner 
678dc186ad7SThomas Gleixner #else
679dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { }
680dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { }
681dc186ad7SThomas Gleixner #endif
682dc186ad7SThomas Gleixner 
6834e8b22bdSLi Bin /**
68467dc8325SCai Huoqing  * worker_pool_assign_id - allocate ID and assign it to @pool
6854e8b22bdSLi Bin  * @pool: the pool pointer of interest
6864e8b22bdSLi Bin  *
6874e8b22bdSLi Bin  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
6884e8b22bdSLi Bin  * successfully, -errno on failure.
6894e8b22bdSLi Bin  */
6909daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool)
6919daf9e67STejun Heo {
6929daf9e67STejun Heo 	int ret;
6939daf9e67STejun Heo 
69468e13a67SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6955bcab335STejun Heo 
6964e8b22bdSLi Bin 	ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
6974e8b22bdSLi Bin 			GFP_KERNEL);
698229641a6STejun Heo 	if (ret >= 0) {
699e68035fbSTejun Heo 		pool->id = ret;
700229641a6STejun Heo 		return 0;
701229641a6STejun Heo 	}
7029daf9e67STejun Heo 	return ret;
7039daf9e67STejun Heo }
7049daf9e67STejun Heo 
7059f66cff2STejun Heo static struct pool_workqueue __rcu **
7069f66cff2STejun Heo unbound_pwq_slot(struct workqueue_struct *wq, int cpu)
7079f66cff2STejun Heo {
7089f66cff2STejun Heo        if (cpu >= 0)
7099f66cff2STejun Heo                return per_cpu_ptr(wq->cpu_pwq, cpu);
7109f66cff2STejun Heo        else
7119f66cff2STejun Heo                return &wq->dfl_pwq;
7129f66cff2STejun Heo }
7139f66cff2STejun Heo 
7149f66cff2STejun Heo /* @cpu < 0 for dfl_pwq */
7159f66cff2STejun Heo static struct pool_workqueue *unbound_pwq(struct workqueue_struct *wq, int cpu)
7169f66cff2STejun Heo {
7179f66cff2STejun Heo 	return rcu_dereference_check(*unbound_pwq_slot(wq, cpu),
7189f66cff2STejun Heo 				     lockdep_is_held(&wq_pool_mutex) ||
7199f66cff2STejun Heo 				     lockdep_is_held(&wq->mutex));
7209f66cff2STejun Heo }
7219f66cff2STejun Heo 
7225797b1c1STejun Heo /**
7235797b1c1STejun Heo  * unbound_effective_cpumask - effective cpumask of an unbound workqueue
7245797b1c1STejun Heo  * @wq: workqueue of interest
7255797b1c1STejun Heo  *
7265797b1c1STejun Heo  * @wq->unbound_attrs->cpumask contains the cpumask requested by the user which
7275797b1c1STejun Heo  * is masked with wq_unbound_cpumask to determine the effective cpumask. The
7285797b1c1STejun Heo  * default pwq is always mapped to the pool with the current effective cpumask.
7295797b1c1STejun Heo  */
7305797b1c1STejun Heo static struct cpumask *unbound_effective_cpumask(struct workqueue_struct *wq)
7315797b1c1STejun Heo {
7325797b1c1STejun Heo 	return unbound_pwq(wq, -1)->pool->attrs->__pod_cpumask;
7335797b1c1STejun Heo }
7345797b1c1STejun Heo 
73573f53c4aSTejun Heo static unsigned int work_color_to_flags(int color)
73673f53c4aSTejun Heo {
73773f53c4aSTejun Heo 	return color << WORK_STRUCT_COLOR_SHIFT;
73873f53c4aSTejun Heo }
73973f53c4aSTejun Heo 
740c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data)
74173f53c4aSTejun Heo {
742c4560c2cSLai Jiangshan 	return (work_data >> WORK_STRUCT_COLOR_SHIFT) &
74373f53c4aSTejun Heo 		((1 << WORK_STRUCT_COLOR_BITS) - 1);
74473f53c4aSTejun Heo }
74573f53c4aSTejun Heo 
74673f53c4aSTejun Heo static int work_next_color(int color)
74773f53c4aSTejun Heo {
74873f53c4aSTejun Heo 	return (color + 1) % WORK_NR_COLORS;
749a848e3b6SOleg Nesterov }
750a848e3b6SOleg Nesterov 
7514594bf15SDavid Howells /*
752112202d9STejun Heo  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
753112202d9STejun Heo  * contain the pointer to the queued pwq.  Once execution starts, the flag
7547c3eed5cSTejun Heo  * is cleared and the high bits contain OFFQ flags and pool ID.
7557a22ad75STejun Heo  *
756112202d9STejun Heo  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
757112202d9STejun Heo  * and clear_work_data() can be used to set the pwq, pool or clear
758bbb68dfaSTejun Heo  * work->data.  These functions should only be called while the work is
759bbb68dfaSTejun Heo  * owned - ie. while the PENDING bit is set.
7607a22ad75STejun Heo  *
761112202d9STejun Heo  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
7627c3eed5cSTejun Heo  * corresponding to a work.  Pool is available once the work has been
763112202d9STejun Heo  * queued anywhere after initialization until it is sync canceled.  pwq is
7647c3eed5cSTejun Heo  * available only while the work item is queued.
765bbb68dfaSTejun Heo  *
766bbb68dfaSTejun Heo  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
767bbb68dfaSTejun Heo  * canceled.  While being canceled, a work item may have its PENDING set
768bbb68dfaSTejun Heo  * but stay off timer and worklist for arbitrarily long and nobody should
769bbb68dfaSTejun Heo  * try to steal the PENDING bit.
7704594bf15SDavid Howells  */
7717a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data,
7727a22ad75STejun Heo 				 unsigned long flags)
7737a22ad75STejun Heo {
7746183c009STejun Heo 	WARN_ON_ONCE(!work_pending(work));
7757a22ad75STejun Heo 	atomic_long_set(&work->data, data | flags | work_static(work));
7767a22ad75STejun Heo }
7777a22ad75STejun Heo 
778112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
7794690c4abSTejun Heo 			 unsigned long extra_flags)
780365970a1SDavid Howells {
781112202d9STejun Heo 	set_work_data(work, (unsigned long)pwq,
782112202d9STejun Heo 		      WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
783365970a1SDavid Howells }
784365970a1SDavid Howells 
7854468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work,
7864468a00fSLai Jiangshan 					   int pool_id)
7874468a00fSLai Jiangshan {
7884468a00fSLai Jiangshan 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
7894468a00fSLai Jiangshan 		      WORK_STRUCT_PENDING);
7904468a00fSLai Jiangshan }
7914468a00fSLai Jiangshan 
7927c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work,
7937c3eed5cSTejun Heo 					    int pool_id)
7944d707b9fSOleg Nesterov {
79523657bb1STejun Heo 	/*
79623657bb1STejun Heo 	 * The following wmb is paired with the implied mb in
79723657bb1STejun Heo 	 * test_and_set_bit(PENDING) and ensures all updates to @work made
79823657bb1STejun Heo 	 * here are visible to and precede any updates by the next PENDING
79923657bb1STejun Heo 	 * owner.
80023657bb1STejun Heo 	 */
80123657bb1STejun Heo 	smp_wmb();
8027c3eed5cSTejun Heo 	set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
803346c09f8SRoman Pen 	/*
804346c09f8SRoman Pen 	 * The following mb guarantees that previous clear of a PENDING bit
805346c09f8SRoman Pen 	 * will not be reordered with any speculative LOADS or STORES from
806346c09f8SRoman Pen 	 * work->current_func, which is executed afterwards.  This possible
8078bdc6201SLiu Song 	 * reordering can lead to a missed execution on attempt to queue
808346c09f8SRoman Pen 	 * the same @work.  E.g. consider this case:
809346c09f8SRoman Pen 	 *
810346c09f8SRoman Pen 	 *   CPU#0                         CPU#1
811346c09f8SRoman Pen 	 *   ----------------------------  --------------------------------
812346c09f8SRoman Pen 	 *
813346c09f8SRoman Pen 	 * 1  STORE event_indicated
814346c09f8SRoman Pen 	 * 2  queue_work_on() {
815346c09f8SRoman Pen 	 * 3    test_and_set_bit(PENDING)
816346c09f8SRoman Pen 	 * 4 }                             set_..._and_clear_pending() {
817346c09f8SRoman Pen 	 * 5                                 set_work_data() # clear bit
818346c09f8SRoman Pen 	 * 6                                 smp_mb()
819346c09f8SRoman Pen 	 * 7                               work->current_func() {
820346c09f8SRoman Pen 	 * 8				      LOAD event_indicated
821346c09f8SRoman Pen 	 *				   }
822346c09f8SRoman Pen 	 *
823346c09f8SRoman Pen 	 * Without an explicit full barrier speculative LOAD on line 8 can
824346c09f8SRoman Pen 	 * be executed before CPU#0 does STORE on line 1.  If that happens,
825346c09f8SRoman Pen 	 * CPU#0 observes the PENDING bit is still set and new execution of
826346c09f8SRoman Pen 	 * a @work is not queued in a hope, that CPU#1 will eventually
827346c09f8SRoman Pen 	 * finish the queued @work.  Meanwhile CPU#1 does not see
828346c09f8SRoman Pen 	 * event_indicated is set, because speculative LOAD was executed
829346c09f8SRoman Pen 	 * before actual STORE.
830346c09f8SRoman Pen 	 */
831346c09f8SRoman Pen 	smp_mb();
8324d707b9fSOleg Nesterov }
8334d707b9fSOleg Nesterov 
8347a22ad75STejun Heo static void clear_work_data(struct work_struct *work)
835365970a1SDavid Howells {
8367c3eed5cSTejun Heo 	smp_wmb();	/* see set_work_pool_and_clear_pending() */
8377c3eed5cSTejun Heo 	set_work_data(work, WORK_STRUCT_NO_POOL, 0);
8387a22ad75STejun Heo }
8397a22ad75STejun Heo 
840afa4bb77SLinus Torvalds static inline struct pool_workqueue *work_struct_pwq(unsigned long data)
841afa4bb77SLinus Torvalds {
842afa4bb77SLinus Torvalds 	return (struct pool_workqueue *)(data & WORK_STRUCT_WQ_DATA_MASK);
843afa4bb77SLinus Torvalds }
844afa4bb77SLinus Torvalds 
845112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work)
8467a22ad75STejun Heo {
847e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
8487a22ad75STejun Heo 
849112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
850afa4bb77SLinus Torvalds 		return work_struct_pwq(data);
851e120153dSTejun Heo 	else
852e120153dSTejun Heo 		return NULL;
8537a22ad75STejun Heo }
8547a22ad75STejun Heo 
8557c3eed5cSTejun Heo /**
8567c3eed5cSTejun Heo  * get_work_pool - return the worker_pool a given work was associated with
8577c3eed5cSTejun Heo  * @work: the work item of interest
8587c3eed5cSTejun Heo  *
85968e13a67SLai Jiangshan  * Pools are created and destroyed under wq_pool_mutex, and allows read
86024acfb71SThomas Gleixner  * access under RCU read lock.  As such, this function should be
86124acfb71SThomas Gleixner  * called under wq_pool_mutex or inside of a rcu_read_lock() region.
862fa1b54e6STejun Heo  *
863fa1b54e6STejun Heo  * All fields of the returned pool are accessible as long as the above
864fa1b54e6STejun Heo  * mentioned locking is in effect.  If the returned pool needs to be used
865fa1b54e6STejun Heo  * beyond the critical section, the caller is responsible for ensuring the
866fa1b54e6STejun Heo  * returned pool is and stays online.
867d185af30SYacine Belkadi  *
868d185af30SYacine Belkadi  * Return: The worker_pool @work was last associated with.  %NULL if none.
8697c3eed5cSTejun Heo  */
8707c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work)
8717a22ad75STejun Heo {
872e120153dSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
8737c3eed5cSTejun Heo 	int pool_id;
8747a22ad75STejun Heo 
87568e13a67SLai Jiangshan 	assert_rcu_or_pool_mutex();
876fa1b54e6STejun Heo 
877112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
878afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool;
8797a22ad75STejun Heo 
8807c3eed5cSTejun Heo 	pool_id = data >> WORK_OFFQ_POOL_SHIFT;
8817c3eed5cSTejun Heo 	if (pool_id == WORK_OFFQ_POOL_NONE)
8827a22ad75STejun Heo 		return NULL;
8837a22ad75STejun Heo 
884fa1b54e6STejun Heo 	return idr_find(&worker_pool_idr, pool_id);
8857c3eed5cSTejun Heo }
8867c3eed5cSTejun Heo 
8877c3eed5cSTejun Heo /**
8887c3eed5cSTejun Heo  * get_work_pool_id - return the worker pool ID a given work is associated with
8897c3eed5cSTejun Heo  * @work: the work item of interest
8907c3eed5cSTejun Heo  *
891d185af30SYacine Belkadi  * Return: The worker_pool ID @work was last associated with.
8927c3eed5cSTejun Heo  * %WORK_OFFQ_POOL_NONE if none.
8937c3eed5cSTejun Heo  */
8947c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work)
8957c3eed5cSTejun Heo {
89654d5b7d0SLai Jiangshan 	unsigned long data = atomic_long_read(&work->data);
8977c3eed5cSTejun Heo 
898112202d9STejun Heo 	if (data & WORK_STRUCT_PWQ)
899afa4bb77SLinus Torvalds 		return work_struct_pwq(data)->pool->id;
90054d5b7d0SLai Jiangshan 
90154d5b7d0SLai Jiangshan 	return data >> WORK_OFFQ_POOL_SHIFT;
9027c3eed5cSTejun Heo }
9037c3eed5cSTejun Heo 
904bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work)
905bbb68dfaSTejun Heo {
9067c3eed5cSTejun Heo 	unsigned long pool_id = get_work_pool_id(work);
907bbb68dfaSTejun Heo 
9087c3eed5cSTejun Heo 	pool_id <<= WORK_OFFQ_POOL_SHIFT;
9097c3eed5cSTejun Heo 	set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
910bbb68dfaSTejun Heo }
911bbb68dfaSTejun Heo 
912bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work)
913bbb68dfaSTejun Heo {
914bbb68dfaSTejun Heo 	unsigned long data = atomic_long_read(&work->data);
915bbb68dfaSTejun Heo 
916112202d9STejun Heo 	return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
917bbb68dfaSTejun Heo }
918bbb68dfaSTejun Heo 
919e22bee78STejun Heo /*
9203270476aSTejun Heo  * Policy functions.  These define the policies on how the global worker
9213270476aSTejun Heo  * pools are managed.  Unless noted otherwise, these functions assume that
922d565ed63STejun Heo  * they're being called with pool->lock held.
923e22bee78STejun Heo  */
924e22bee78STejun Heo 
925e22bee78STejun Heo /*
926e22bee78STejun Heo  * Need to wake up a worker?  Called from anything but currently
927e22bee78STejun Heo  * running workers.
928974271c4STejun Heo  *
929974271c4STejun Heo  * Note that, because unbound workers never contribute to nr_running, this
930706026c2STejun Heo  * function will always return %true for unbound pools as long as the
931974271c4STejun Heo  * worklist isn't empty.
932e22bee78STejun Heo  */
93363d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool)
934e22bee78STejun Heo {
9350219a352STejun Heo 	return !list_empty(&pool->worklist) && !pool->nr_running;
936e22bee78STejun Heo }
937e22bee78STejun Heo 
938e22bee78STejun Heo /* Can I start working?  Called from busy but !running workers. */
93963d95a91STejun Heo static bool may_start_working(struct worker_pool *pool)
940e22bee78STejun Heo {
94163d95a91STejun Heo 	return pool->nr_idle;
942e22bee78STejun Heo }
943e22bee78STejun Heo 
944e22bee78STejun Heo /* Do I need to keep working?  Called from currently running workers. */
94563d95a91STejun Heo static bool keep_working(struct worker_pool *pool)
946e22bee78STejun Heo {
947bc35f7efSLai Jiangshan 	return !list_empty(&pool->worklist) && (pool->nr_running <= 1);
948e22bee78STejun Heo }
949e22bee78STejun Heo 
950e22bee78STejun Heo /* Do we need a new worker?  Called from manager. */
95163d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool)
952e22bee78STejun Heo {
95363d95a91STejun Heo 	return need_more_worker(pool) && !may_start_working(pool);
954e22bee78STejun Heo }
955e22bee78STejun Heo 
956e22bee78STejun Heo /* Do we have too many workers and should some go away? */
95763d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool)
958e22bee78STejun Heo {
959692b4825STejun Heo 	bool managing = pool->flags & POOL_MANAGER_ACTIVE;
96063d95a91STejun Heo 	int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
96163d95a91STejun Heo 	int nr_busy = pool->nr_workers - nr_idle;
962e22bee78STejun Heo 
963e22bee78STejun Heo 	return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
964e22bee78STejun Heo }
965e22bee78STejun Heo 
9664690c4abSTejun Heo /**
967e22bee78STejun Heo  * worker_set_flags - set worker flags and adjust nr_running accordingly
968cb444766STejun Heo  * @worker: self
969d302f017STejun Heo  * @flags: flags to set
970d302f017STejun Heo  *
971228f1d00SLai Jiangshan  * Set @flags in @worker->flags and adjust nr_running accordingly.
972d302f017STejun Heo  */
973228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags)
974d302f017STejun Heo {
975bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
976e22bee78STejun Heo 
977bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
978cb444766STejun Heo 
979228f1d00SLai Jiangshan 	/* If transitioning into NOT_RUNNING, adjust nr_running. */
980e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) &&
981e22bee78STejun Heo 	    !(worker->flags & WORKER_NOT_RUNNING)) {
982bc35f7efSLai Jiangshan 		pool->nr_running--;
983e22bee78STejun Heo 	}
984e22bee78STejun Heo 
985d302f017STejun Heo 	worker->flags |= flags;
986d302f017STejun Heo }
987d302f017STejun Heo 
988d302f017STejun Heo /**
989e22bee78STejun Heo  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
990cb444766STejun Heo  * @worker: self
991d302f017STejun Heo  * @flags: flags to clear
992d302f017STejun Heo  *
993e22bee78STejun Heo  * Clear @flags in @worker->flags and adjust nr_running accordingly.
994d302f017STejun Heo  */
995d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
996d302f017STejun Heo {
99763d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
998e22bee78STejun Heo 	unsigned int oflags = worker->flags;
999e22bee78STejun Heo 
1000bc8b50c2STejun Heo 	lockdep_assert_held(&pool->lock);
1001cb444766STejun Heo 
1002d302f017STejun Heo 	worker->flags &= ~flags;
1003e22bee78STejun Heo 
100442c025f3STejun Heo 	/*
100542c025f3STejun Heo 	 * If transitioning out of NOT_RUNNING, increment nr_running.  Note
100642c025f3STejun Heo 	 * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
100742c025f3STejun Heo 	 * of multiple flags, not a single flag.
100842c025f3STejun Heo 	 */
1009e22bee78STejun Heo 	if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
1010e22bee78STejun Heo 		if (!(worker->flags & WORKER_NOT_RUNNING))
1011bc35f7efSLai Jiangshan 			pool->nr_running++;
1012d302f017STejun Heo }
1013d302f017STejun Heo 
1014797e8345STejun Heo /* Return the first idle worker.  Called with pool->lock held. */
1015797e8345STejun Heo static struct worker *first_idle_worker(struct worker_pool *pool)
1016797e8345STejun Heo {
1017797e8345STejun Heo 	if (unlikely(list_empty(&pool->idle_list)))
1018797e8345STejun Heo 		return NULL;
1019797e8345STejun Heo 
1020797e8345STejun Heo 	return list_first_entry(&pool->idle_list, struct worker, entry);
1021797e8345STejun Heo }
1022797e8345STejun Heo 
1023797e8345STejun Heo /**
1024797e8345STejun Heo  * worker_enter_idle - enter idle state
1025797e8345STejun Heo  * @worker: worker which is entering idle state
1026797e8345STejun Heo  *
1027797e8345STejun Heo  * @worker is entering idle state.  Update stats and idle timer if
1028797e8345STejun Heo  * necessary.
1029797e8345STejun Heo  *
1030797e8345STejun Heo  * LOCKING:
1031797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1032797e8345STejun Heo  */
1033797e8345STejun Heo static void worker_enter_idle(struct worker *worker)
1034797e8345STejun Heo {
1035797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
1036797e8345STejun Heo 
1037797e8345STejun Heo 	if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1038797e8345STejun Heo 	    WARN_ON_ONCE(!list_empty(&worker->entry) &&
1039797e8345STejun Heo 			 (worker->hentry.next || worker->hentry.pprev)))
1040797e8345STejun Heo 		return;
1041797e8345STejun Heo 
1042797e8345STejun Heo 	/* can't use worker_set_flags(), also called from create_worker() */
1043797e8345STejun Heo 	worker->flags |= WORKER_IDLE;
1044797e8345STejun Heo 	pool->nr_idle++;
1045797e8345STejun Heo 	worker->last_active = jiffies;
1046797e8345STejun Heo 
1047797e8345STejun Heo 	/* idle_list is LIFO */
1048797e8345STejun Heo 	list_add(&worker->entry, &pool->idle_list);
1049797e8345STejun Heo 
1050797e8345STejun Heo 	if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1051797e8345STejun Heo 		mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1052797e8345STejun Heo 
1053797e8345STejun Heo 	/* Sanity check nr_running. */
1054797e8345STejun Heo 	WARN_ON_ONCE(pool->nr_workers == pool->nr_idle && pool->nr_running);
1055797e8345STejun Heo }
1056797e8345STejun Heo 
1057797e8345STejun Heo /**
1058797e8345STejun Heo  * worker_leave_idle - leave idle state
1059797e8345STejun Heo  * @worker: worker which is leaving idle state
1060797e8345STejun Heo  *
1061797e8345STejun Heo  * @worker is leaving idle state.  Update stats.
1062797e8345STejun Heo  *
1063797e8345STejun Heo  * LOCKING:
1064797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1065797e8345STejun Heo  */
1066797e8345STejun Heo static void worker_leave_idle(struct worker *worker)
1067797e8345STejun Heo {
1068797e8345STejun Heo 	struct worker_pool *pool = worker->pool;
1069797e8345STejun Heo 
1070797e8345STejun Heo 	if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1071797e8345STejun Heo 		return;
1072797e8345STejun Heo 	worker_clr_flags(worker, WORKER_IDLE);
1073797e8345STejun Heo 	pool->nr_idle--;
1074797e8345STejun Heo 	list_del_init(&worker->entry);
1075797e8345STejun Heo }
1076797e8345STejun Heo 
1077797e8345STejun Heo /**
1078797e8345STejun Heo  * find_worker_executing_work - find worker which is executing a work
1079797e8345STejun Heo  * @pool: pool of interest
1080797e8345STejun Heo  * @work: work to find worker for
1081797e8345STejun Heo  *
1082797e8345STejun Heo  * Find a worker which is executing @work on @pool by searching
1083797e8345STejun Heo  * @pool->busy_hash which is keyed by the address of @work.  For a worker
1084797e8345STejun Heo  * to match, its current execution should match the address of @work and
1085797e8345STejun Heo  * its work function.  This is to avoid unwanted dependency between
1086797e8345STejun Heo  * unrelated work executions through a work item being recycled while still
1087797e8345STejun Heo  * being executed.
1088797e8345STejun Heo  *
1089797e8345STejun Heo  * This is a bit tricky.  A work item may be freed once its execution
1090797e8345STejun Heo  * starts and nothing prevents the freed area from being recycled for
1091797e8345STejun Heo  * another work item.  If the same work item address ends up being reused
1092797e8345STejun Heo  * before the original execution finishes, workqueue will identify the
1093797e8345STejun Heo  * recycled work item as currently executing and make it wait until the
1094797e8345STejun Heo  * current execution finishes, introducing an unwanted dependency.
1095797e8345STejun Heo  *
1096797e8345STejun Heo  * This function checks the work item address and work function to avoid
1097797e8345STejun Heo  * false positives.  Note that this isn't complete as one may construct a
1098797e8345STejun Heo  * work function which can introduce dependency onto itself through a
1099797e8345STejun Heo  * recycled work item.  Well, if somebody wants to shoot oneself in the
1100797e8345STejun Heo  * foot that badly, there's only so much we can do, and if such deadlock
1101797e8345STejun Heo  * actually occurs, it should be easy to locate the culprit work function.
1102797e8345STejun Heo  *
1103797e8345STejun Heo  * CONTEXT:
1104797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1105797e8345STejun Heo  *
1106797e8345STejun Heo  * Return:
1107797e8345STejun Heo  * Pointer to worker which is executing @work if found, %NULL
1108797e8345STejun Heo  * otherwise.
1109797e8345STejun Heo  */
1110797e8345STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool,
1111797e8345STejun Heo 						 struct work_struct *work)
1112797e8345STejun Heo {
1113797e8345STejun Heo 	struct worker *worker;
1114797e8345STejun Heo 
1115797e8345STejun Heo 	hash_for_each_possible(pool->busy_hash, worker, hentry,
1116797e8345STejun Heo 			       (unsigned long)work)
1117797e8345STejun Heo 		if (worker->current_work == work &&
1118797e8345STejun Heo 		    worker->current_func == work->func)
1119797e8345STejun Heo 			return worker;
1120797e8345STejun Heo 
1121797e8345STejun Heo 	return NULL;
1122797e8345STejun Heo }
1123797e8345STejun Heo 
1124797e8345STejun Heo /**
1125797e8345STejun Heo  * move_linked_works - move linked works to a list
1126797e8345STejun Heo  * @work: start of series of works to be scheduled
1127797e8345STejun Heo  * @head: target list to append @work to
1128797e8345STejun Heo  * @nextp: out parameter for nested worklist walking
1129797e8345STejun Heo  *
1130873eaca6STejun Heo  * Schedule linked works starting from @work to @head. Work series to be
1131873eaca6STejun Heo  * scheduled starts at @work and includes any consecutive work with
1132873eaca6STejun Heo  * WORK_STRUCT_LINKED set in its predecessor. See assign_work() for details on
1133873eaca6STejun Heo  * @nextp.
1134797e8345STejun Heo  *
1135797e8345STejun Heo  * CONTEXT:
1136797e8345STejun Heo  * raw_spin_lock_irq(pool->lock).
1137797e8345STejun Heo  */
1138797e8345STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head,
1139797e8345STejun Heo 			      struct work_struct **nextp)
1140797e8345STejun Heo {
1141797e8345STejun Heo 	struct work_struct *n;
1142797e8345STejun Heo 
1143797e8345STejun Heo 	/*
1144797e8345STejun Heo 	 * Linked worklist will always end before the end of the list,
1145797e8345STejun Heo 	 * use NULL for list head.
1146797e8345STejun Heo 	 */
1147797e8345STejun Heo 	list_for_each_entry_safe_from(work, n, NULL, entry) {
1148797e8345STejun Heo 		list_move_tail(&work->entry, head);
1149797e8345STejun Heo 		if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1150797e8345STejun Heo 			break;
1151797e8345STejun Heo 	}
1152797e8345STejun Heo 
1153797e8345STejun Heo 	/*
1154797e8345STejun Heo 	 * If we're already inside safe list traversal and have moved
1155797e8345STejun Heo 	 * multiple works to the scheduled queue, the next position
1156797e8345STejun Heo 	 * needs to be updated.
1157797e8345STejun Heo 	 */
1158797e8345STejun Heo 	if (nextp)
1159797e8345STejun Heo 		*nextp = n;
1160797e8345STejun Heo }
1161797e8345STejun Heo 
1162797e8345STejun Heo /**
1163873eaca6STejun Heo  * assign_work - assign a work item and its linked work items to a worker
1164873eaca6STejun Heo  * @work: work to assign
1165873eaca6STejun Heo  * @worker: worker to assign to
1166873eaca6STejun Heo  * @nextp: out parameter for nested worklist walking
1167873eaca6STejun Heo  *
1168873eaca6STejun Heo  * Assign @work and its linked work items to @worker. If @work is already being
1169873eaca6STejun Heo  * executed by another worker in the same pool, it'll be punted there.
1170873eaca6STejun Heo  *
1171873eaca6STejun Heo  * If @nextp is not NULL, it's updated to point to the next work of the last
1172873eaca6STejun Heo  * scheduled work. This allows assign_work() to be nested inside
1173873eaca6STejun Heo  * list_for_each_entry_safe().
1174873eaca6STejun Heo  *
1175873eaca6STejun Heo  * Returns %true if @work was successfully assigned to @worker. %false if @work
1176873eaca6STejun Heo  * was punted to another worker already executing it.
1177873eaca6STejun Heo  */
1178873eaca6STejun Heo static bool assign_work(struct work_struct *work, struct worker *worker,
1179873eaca6STejun Heo 			struct work_struct **nextp)
1180873eaca6STejun Heo {
1181873eaca6STejun Heo 	struct worker_pool *pool = worker->pool;
1182873eaca6STejun Heo 	struct worker *collision;
1183873eaca6STejun Heo 
1184873eaca6STejun Heo 	lockdep_assert_held(&pool->lock);
1185873eaca6STejun Heo 
1186873eaca6STejun Heo 	/*
1187873eaca6STejun Heo 	 * A single work shouldn't be executed concurrently by multiple workers.
1188873eaca6STejun Heo 	 * __queue_work() ensures that @work doesn't jump to a different pool
1189873eaca6STejun Heo 	 * while still running in the previous pool. Here, we should ensure that
1190873eaca6STejun Heo 	 * @work is not executed concurrently by multiple workers from the same
1191873eaca6STejun Heo 	 * pool. Check whether anyone is already processing the work. If so,
1192873eaca6STejun Heo 	 * defer the work to the currently executing one.
1193873eaca6STejun Heo 	 */
1194873eaca6STejun Heo 	collision = find_worker_executing_work(pool, work);
1195873eaca6STejun Heo 	if (unlikely(collision)) {
1196873eaca6STejun Heo 		move_linked_works(work, &collision->scheduled, nextp);
1197873eaca6STejun Heo 		return false;
1198873eaca6STejun Heo 	}
1199873eaca6STejun Heo 
1200873eaca6STejun Heo 	move_linked_works(work, &worker->scheduled, nextp);
1201873eaca6STejun Heo 	return true;
1202873eaca6STejun Heo }
1203873eaca6STejun Heo 
12042f34d733STejun Heo static struct irq_work *bh_pool_irq_work(struct worker_pool *pool)
12052f34d733STejun Heo {
12062f34d733STejun Heo 	int high = pool->attrs->nice == HIGHPRI_NICE_LEVEL ? 1 : 0;
12072f34d733STejun Heo 
12082f34d733STejun Heo 	return &per_cpu(bh_pool_irq_works, pool->cpu)[high];
12092f34d733STejun Heo }
12102f34d733STejun Heo 
1211fd0a68a2STejun Heo static void kick_bh_pool(struct worker_pool *pool)
1212fd0a68a2STejun Heo {
1213fd0a68a2STejun Heo #ifdef CONFIG_SMP
1214fd0a68a2STejun Heo 	if (unlikely(pool->cpu != smp_processor_id())) {
1215fd0a68a2STejun Heo 		irq_work_queue_on(bh_pool_irq_work(pool), pool->cpu);
1216fd0a68a2STejun Heo 		return;
1217fd0a68a2STejun Heo 	}
1218fd0a68a2STejun Heo #endif
1219fd0a68a2STejun Heo 	if (pool->attrs->nice == HIGHPRI_NICE_LEVEL)
1220fd0a68a2STejun Heo 		raise_softirq_irqoff(HI_SOFTIRQ);
1221fd0a68a2STejun Heo 	else
1222fd0a68a2STejun Heo 		raise_softirq_irqoff(TASKLET_SOFTIRQ);
1223fd0a68a2STejun Heo }
1224fd0a68a2STejun Heo 
1225873eaca6STejun Heo /**
12260219a352STejun Heo  * kick_pool - wake up an idle worker if necessary
12270219a352STejun Heo  * @pool: pool to kick
1228797e8345STejun Heo  *
12290219a352STejun Heo  * @pool may have pending work items. Wake up worker if necessary. Returns
12300219a352STejun Heo  * whether a worker was woken up.
1231797e8345STejun Heo  */
12320219a352STejun Heo static bool kick_pool(struct worker_pool *pool)
1233797e8345STejun Heo {
1234797e8345STejun Heo 	struct worker *worker = first_idle_worker(pool);
12358639ecebSTejun Heo 	struct task_struct *p;
1236797e8345STejun Heo 
12370219a352STejun Heo 	lockdep_assert_held(&pool->lock);
12380219a352STejun Heo 
12390219a352STejun Heo 	if (!need_more_worker(pool) || !worker)
12400219a352STejun Heo 		return false;
12410219a352STejun Heo 
12424cb1ef64STejun Heo 	if (pool->flags & POOL_BH) {
1243fd0a68a2STejun Heo 		kick_bh_pool(pool);
12444cb1ef64STejun Heo 		return true;
12454cb1ef64STejun Heo 	}
12464cb1ef64STejun Heo 
12478639ecebSTejun Heo 	p = worker->task;
12488639ecebSTejun Heo 
12498639ecebSTejun Heo #ifdef CONFIG_SMP
12508639ecebSTejun Heo 	/*
12518639ecebSTejun Heo 	 * Idle @worker is about to execute @work and waking up provides an
12528639ecebSTejun Heo 	 * opportunity to migrate @worker at a lower cost by setting the task's
12538639ecebSTejun Heo 	 * wake_cpu field. Let's see if we want to move @worker to improve
12548639ecebSTejun Heo 	 * execution locality.
12558639ecebSTejun Heo 	 *
12568639ecebSTejun Heo 	 * We're waking the worker that went idle the latest and there's some
12578639ecebSTejun Heo 	 * chance that @worker is marked idle but hasn't gone off CPU yet. If
12588639ecebSTejun Heo 	 * so, setting the wake_cpu won't do anything. As this is a best-effort
12598639ecebSTejun Heo 	 * optimization and the race window is narrow, let's leave as-is for
12608639ecebSTejun Heo 	 * now. If this becomes pronounced, we can skip over workers which are
12618639ecebSTejun Heo 	 * still on cpu when picking an idle worker.
12628639ecebSTejun Heo 	 *
12638639ecebSTejun Heo 	 * If @pool has non-strict affinity, @worker might have ended up outside
12648639ecebSTejun Heo 	 * its affinity scope. Repatriate.
12658639ecebSTejun Heo 	 */
12668639ecebSTejun Heo 	if (!pool->attrs->affn_strict &&
12678639ecebSTejun Heo 	    !cpumask_test_cpu(p->wake_cpu, pool->attrs->__pod_cpumask)) {
12688639ecebSTejun Heo 		struct work_struct *work = list_first_entry(&pool->worklist,
12698639ecebSTejun Heo 						struct work_struct, entry);
12708639ecebSTejun Heo 		p->wake_cpu = cpumask_any_distribute(pool->attrs->__pod_cpumask);
12718639ecebSTejun Heo 		get_work_pwq(work)->stats[PWQ_STAT_REPATRIATED]++;
12728639ecebSTejun Heo 	}
12738639ecebSTejun Heo #endif
12748639ecebSTejun Heo 	wake_up_process(p);
12750219a352STejun Heo 	return true;
1276797e8345STejun Heo }
1277797e8345STejun Heo 
127863638450STejun Heo #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT
127963638450STejun Heo 
128063638450STejun Heo /*
128163638450STejun Heo  * Concurrency-managed per-cpu work items that hog CPU for longer than
128263638450STejun Heo  * wq_cpu_intensive_thresh_us trigger the automatic CPU_INTENSIVE mechanism,
128363638450STejun Heo  * which prevents them from stalling other concurrency-managed work items. If a
128463638450STejun Heo  * work function keeps triggering this mechanism, it's likely that the work item
128563638450STejun Heo  * should be using an unbound workqueue instead.
128663638450STejun Heo  *
128763638450STejun Heo  * wq_cpu_intensive_report() tracks work functions which trigger such conditions
128863638450STejun Heo  * and report them so that they can be examined and converted to use unbound
128963638450STejun Heo  * workqueues as appropriate. To avoid flooding the console, each violating work
129063638450STejun Heo  * function is tracked and reported with exponential backoff.
129163638450STejun Heo  */
129263638450STejun Heo #define WCI_MAX_ENTS 128
129363638450STejun Heo 
129463638450STejun Heo struct wci_ent {
129563638450STejun Heo 	work_func_t		func;
129663638450STejun Heo 	atomic64_t		cnt;
129763638450STejun Heo 	struct hlist_node	hash_node;
129863638450STejun Heo };
129963638450STejun Heo 
130063638450STejun Heo static struct wci_ent wci_ents[WCI_MAX_ENTS];
130163638450STejun Heo static int wci_nr_ents;
130263638450STejun Heo static DEFINE_RAW_SPINLOCK(wci_lock);
130363638450STejun Heo static DEFINE_HASHTABLE(wci_hash, ilog2(WCI_MAX_ENTS));
130463638450STejun Heo 
130563638450STejun Heo static struct wci_ent *wci_find_ent(work_func_t func)
130663638450STejun Heo {
130763638450STejun Heo 	struct wci_ent *ent;
130863638450STejun Heo 
130963638450STejun Heo 	hash_for_each_possible_rcu(wci_hash, ent, hash_node,
131063638450STejun Heo 				   (unsigned long)func) {
131163638450STejun Heo 		if (ent->func == func)
131263638450STejun Heo 			return ent;
131363638450STejun Heo 	}
131463638450STejun Heo 	return NULL;
131563638450STejun Heo }
131663638450STejun Heo 
131763638450STejun Heo static void wq_cpu_intensive_report(work_func_t func)
131863638450STejun Heo {
131963638450STejun Heo 	struct wci_ent *ent;
132063638450STejun Heo 
132163638450STejun Heo restart:
132263638450STejun Heo 	ent = wci_find_ent(func);
132363638450STejun Heo 	if (ent) {
132463638450STejun Heo 		u64 cnt;
132563638450STejun Heo 
132663638450STejun Heo 		/*
132763638450STejun Heo 		 * Start reporting from the fourth time and back off
132863638450STejun Heo 		 * exponentially.
132963638450STejun Heo 		 */
133063638450STejun Heo 		cnt = atomic64_inc_return_relaxed(&ent->cnt);
133163638450STejun Heo 		if (cnt >= 4 && is_power_of_2(cnt))
133263638450STejun Heo 			printk_deferred(KERN_WARNING "workqueue: %ps hogged CPU for >%luus %llu times, consider switching to WQ_UNBOUND\n",
133363638450STejun Heo 					ent->func, wq_cpu_intensive_thresh_us,
133463638450STejun Heo 					atomic64_read(&ent->cnt));
133563638450STejun Heo 		return;
133663638450STejun Heo 	}
133763638450STejun Heo 
133863638450STejun Heo 	/*
133963638450STejun Heo 	 * @func is a new violation. Allocate a new entry for it. If wcn_ents[]
134063638450STejun Heo 	 * is exhausted, something went really wrong and we probably made enough
134163638450STejun Heo 	 * noise already.
134263638450STejun Heo 	 */
134363638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS)
134463638450STejun Heo 		return;
134563638450STejun Heo 
134663638450STejun Heo 	raw_spin_lock(&wci_lock);
134763638450STejun Heo 
134863638450STejun Heo 	if (wci_nr_ents >= WCI_MAX_ENTS) {
134963638450STejun Heo 		raw_spin_unlock(&wci_lock);
135063638450STejun Heo 		return;
135163638450STejun Heo 	}
135263638450STejun Heo 
135363638450STejun Heo 	if (wci_find_ent(func)) {
135463638450STejun Heo 		raw_spin_unlock(&wci_lock);
135563638450STejun Heo 		goto restart;
135663638450STejun Heo 	}
135763638450STejun Heo 
135863638450STejun Heo 	ent = &wci_ents[wci_nr_ents++];
135963638450STejun Heo 	ent->func = func;
136063638450STejun Heo 	atomic64_set(&ent->cnt, 1);
136163638450STejun Heo 	hash_add_rcu(wci_hash, &ent->hash_node, (unsigned long)func);
136263638450STejun Heo 
136363638450STejun Heo 	raw_spin_unlock(&wci_lock);
136463638450STejun Heo }
136563638450STejun Heo 
136663638450STejun Heo #else	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
136763638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) {}
136863638450STejun Heo #endif	/* CONFIG_WQ_CPU_INTENSIVE_REPORT */
136963638450STejun Heo 
1370c54d5046STejun Heo /**
13711da177e4SLinus Torvalds  * wq_worker_running - a worker is running again
13721da177e4SLinus Torvalds  * @task: task waking up
13731da177e4SLinus Torvalds  *
13741da177e4SLinus Torvalds  * This function is called when a worker returns from schedule()
13751da177e4SLinus Torvalds  */
13761da177e4SLinus Torvalds void wq_worker_running(struct task_struct *task)
13771da177e4SLinus Torvalds {
13781da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
13791da177e4SLinus Torvalds 
1380c8f6219bSZqiang 	if (!READ_ONCE(worker->sleeping))
13811da177e4SLinus Torvalds 		return;
13821da177e4SLinus Torvalds 
13831da177e4SLinus Torvalds 	/*
13841da177e4SLinus Torvalds 	 * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check
13851da177e4SLinus Torvalds 	 * and the nr_running increment below, we may ruin the nr_running reset
13861da177e4SLinus Torvalds 	 * and leave with an unexpected pool->nr_running == 1 on the newly unbound
13871da177e4SLinus Torvalds 	 * pool. Protect against such race.
13881da177e4SLinus Torvalds 	 */
13891da177e4SLinus Torvalds 	preempt_disable();
13901da177e4SLinus Torvalds 	if (!(worker->flags & WORKER_NOT_RUNNING))
13911da177e4SLinus Torvalds 		worker->pool->nr_running++;
13921da177e4SLinus Torvalds 	preempt_enable();
1393616db877STejun Heo 
1394616db877STejun Heo 	/*
1395616db877STejun Heo 	 * CPU intensive auto-detection cares about how long a work item hogged
1396616db877STejun Heo 	 * CPU without sleeping. Reset the starting timestamp on wakeup.
1397616db877STejun Heo 	 */
1398616db877STejun Heo 	worker->current_at = worker->task->se.sum_exec_runtime;
1399616db877STejun Heo 
1400c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 0);
14011da177e4SLinus Torvalds }
14021da177e4SLinus Torvalds 
14031da177e4SLinus Torvalds /**
14041da177e4SLinus Torvalds  * wq_worker_sleeping - a worker is going to sleep
14051da177e4SLinus Torvalds  * @task: task going to sleep
14061da177e4SLinus Torvalds  *
14071da177e4SLinus Torvalds  * This function is called from schedule() when a busy worker is
14081da177e4SLinus Torvalds  * going to sleep.
14091da177e4SLinus Torvalds  */
14101da177e4SLinus Torvalds void wq_worker_sleeping(struct task_struct *task)
14111da177e4SLinus Torvalds {
14121da177e4SLinus Torvalds 	struct worker *worker = kthread_data(task);
14131da177e4SLinus Torvalds 	struct worker_pool *pool;
14141da177e4SLinus Torvalds 
14151da177e4SLinus Torvalds 	/*
14161da177e4SLinus Torvalds 	 * Rescuers, which may not have all the fields set up like normal
14171da177e4SLinus Torvalds 	 * workers, also reach here, let's not access anything before
14181da177e4SLinus Torvalds 	 * checking NOT_RUNNING.
14191da177e4SLinus Torvalds 	 */
14201da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING)
14211da177e4SLinus Torvalds 		return;
14221da177e4SLinus Torvalds 
14231da177e4SLinus Torvalds 	pool = worker->pool;
14241da177e4SLinus Torvalds 
14251da177e4SLinus Torvalds 	/* Return if preempted before wq_worker_running() was reached */
1426c8f6219bSZqiang 	if (READ_ONCE(worker->sleeping))
14271da177e4SLinus Torvalds 		return;
14281da177e4SLinus Torvalds 
1429c8f6219bSZqiang 	WRITE_ONCE(worker->sleeping, 1);
14301da177e4SLinus Torvalds 	raw_spin_lock_irq(&pool->lock);
14311da177e4SLinus Torvalds 
14321da177e4SLinus Torvalds 	/*
14331da177e4SLinus Torvalds 	 * Recheck in case unbind_workers() preempted us. We don't
14341da177e4SLinus Torvalds 	 * want to decrement nr_running after the worker is unbound
14351da177e4SLinus Torvalds 	 * and nr_running has been reset.
14361da177e4SLinus Torvalds 	 */
14371da177e4SLinus Torvalds 	if (worker->flags & WORKER_NOT_RUNNING) {
14381da177e4SLinus Torvalds 		raw_spin_unlock_irq(&pool->lock);
14391da177e4SLinus Torvalds 		return;
14401da177e4SLinus Torvalds 	}
14411da177e4SLinus Torvalds 
14421da177e4SLinus Torvalds 	pool->nr_running--;
14430219a352STejun Heo 	if (kick_pool(pool))
1444725e8ec5STejun Heo 		worker->current_pwq->stats[PWQ_STAT_CM_WAKEUP]++;
14450219a352STejun Heo 
14461da177e4SLinus Torvalds 	raw_spin_unlock_irq(&pool->lock);
14471da177e4SLinus Torvalds }
14481da177e4SLinus Torvalds 
14491da177e4SLinus Torvalds /**
1450616db877STejun Heo  * wq_worker_tick - a scheduler tick occurred while a kworker is running
1451616db877STejun Heo  * @task: task currently running
1452616db877STejun Heo  *
1453616db877STejun Heo  * Called from scheduler_tick(). We're in the IRQ context and the current
1454616db877STejun Heo  * worker's fields which follow the 'K' locking rule can be accessed safely.
1455616db877STejun Heo  */
1456616db877STejun Heo void wq_worker_tick(struct task_struct *task)
1457616db877STejun Heo {
1458616db877STejun Heo 	struct worker *worker = kthread_data(task);
1459616db877STejun Heo 	struct pool_workqueue *pwq = worker->current_pwq;
1460616db877STejun Heo 	struct worker_pool *pool = worker->pool;
1461616db877STejun Heo 
1462616db877STejun Heo 	if (!pwq)
1463616db877STejun Heo 		return;
1464616db877STejun Heo 
14658a1dd1e5STejun Heo 	pwq->stats[PWQ_STAT_CPU_TIME] += TICK_USEC;
14668a1dd1e5STejun Heo 
146718c8ae81SZqiang 	if (!wq_cpu_intensive_thresh_us)
146818c8ae81SZqiang 		return;
146918c8ae81SZqiang 
1470616db877STejun Heo 	/*
1471616db877STejun Heo 	 * If the current worker is concurrency managed and hogged the CPU for
1472616db877STejun Heo 	 * longer than wq_cpu_intensive_thresh_us, it's automatically marked
1473616db877STejun Heo 	 * CPU_INTENSIVE to avoid stalling other concurrency-managed work items.
1474c8f6219bSZqiang 	 *
1475c8f6219bSZqiang 	 * Set @worker->sleeping means that @worker is in the process of
1476c8f6219bSZqiang 	 * switching out voluntarily and won't be contributing to
1477c8f6219bSZqiang 	 * @pool->nr_running until it wakes up. As wq_worker_sleeping() also
1478c8f6219bSZqiang 	 * decrements ->nr_running, setting CPU_INTENSIVE here can lead to
1479c8f6219bSZqiang 	 * double decrements. The task is releasing the CPU anyway. Let's skip.
1480c8f6219bSZqiang 	 * We probably want to make this prettier in the future.
1481616db877STejun Heo 	 */
1482c8f6219bSZqiang 	if ((worker->flags & WORKER_NOT_RUNNING) || READ_ONCE(worker->sleeping) ||
1483616db877STejun Heo 	    worker->task->se.sum_exec_runtime - worker->current_at <
1484616db877STejun Heo 	    wq_cpu_intensive_thresh_us * NSEC_PER_USEC)
1485616db877STejun Heo 		return;
1486616db877STejun Heo 
1487616db877STejun Heo 	raw_spin_lock(&pool->lock);
1488616db877STejun Heo 
1489616db877STejun Heo 	worker_set_flags(worker, WORKER_CPU_INTENSIVE);
149063638450STejun Heo 	wq_cpu_intensive_report(worker->current_func);
1491616db877STejun Heo 	pwq->stats[PWQ_STAT_CPU_INTENSIVE]++;
1492616db877STejun Heo 
14930219a352STejun Heo 	if (kick_pool(pool))
1494616db877STejun Heo 		pwq->stats[PWQ_STAT_CM_WAKEUP]++;
1495616db877STejun Heo 
1496616db877STejun Heo 	raw_spin_unlock(&pool->lock);
1497616db877STejun Heo }
1498616db877STejun Heo 
1499616db877STejun Heo /**
15001da177e4SLinus Torvalds  * wq_worker_last_func - retrieve worker's last work function
15011da177e4SLinus Torvalds  * @task: Task to retrieve last work function of.
15021da177e4SLinus Torvalds  *
15031da177e4SLinus Torvalds  * Determine the last function a worker executed. This is called from
15041da177e4SLinus Torvalds  * the scheduler to get a worker's last known identity.
15051da177e4SLinus Torvalds  *
15061da177e4SLinus Torvalds  * CONTEXT:
15079b41ea72SAndrew Morton  * raw_spin_lock_irq(rq->lock)
15081da177e4SLinus Torvalds  *
15091da177e4SLinus Torvalds  * This function is called during schedule() when a kworker is going
1510f756d5e2SNathan Lynch  * to sleep. It's used by psi to identify aggregation workers during
1511f756d5e2SNathan Lynch  * dequeuing, to allow periodic aggregation to shut-off when that
15121da177e4SLinus Torvalds  * worker is the last task in the system or cgroup to go to sleep.
15131da177e4SLinus Torvalds  *
15141da177e4SLinus Torvalds  * As this function doesn't involve any workqueue-related locking, it
15151da177e4SLinus Torvalds  * only returns stable values when called from inside the scheduler's
15161da177e4SLinus Torvalds  * queuing and dequeuing paths, when @task, which must be a kworker,
15171da177e4SLinus Torvalds  * is guaranteed to not be processing any works.
1518365970a1SDavid Howells  *
1519365970a1SDavid Howells  * Return:
1520365970a1SDavid Howells  * The last work function %current executed as a worker, NULL if it
1521365970a1SDavid Howells  * hasn't executed any work yet.
1522365970a1SDavid Howells  */
1523365970a1SDavid Howells work_func_t wq_worker_last_func(struct task_struct *task)
1524365970a1SDavid Howells {
1525365970a1SDavid Howells 	struct worker *worker = kthread_data(task);
1526365970a1SDavid Howells 
1527365970a1SDavid Howells 	return worker->last_func;
1528365970a1SDavid Howells }
1529365970a1SDavid Howells 
1530d302f017STejun Heo /**
153191ccc6e7STejun Heo  * wq_node_nr_active - Determine wq_node_nr_active to use
153291ccc6e7STejun Heo  * @wq: workqueue of interest
153391ccc6e7STejun Heo  * @node: NUMA node, can be %NUMA_NO_NODE
153491ccc6e7STejun Heo  *
153591ccc6e7STejun Heo  * Determine wq_node_nr_active to use for @wq on @node. Returns:
153691ccc6e7STejun Heo  *
153791ccc6e7STejun Heo  * - %NULL for per-cpu workqueues as they don't need to use shared nr_active.
153891ccc6e7STejun Heo  *
153991ccc6e7STejun Heo  * - node_nr_active[nr_node_ids] if @node is %NUMA_NO_NODE.
154091ccc6e7STejun Heo  *
154191ccc6e7STejun Heo  * - Otherwise, node_nr_active[@node].
154291ccc6e7STejun Heo  */
154391ccc6e7STejun Heo static struct wq_node_nr_active *wq_node_nr_active(struct workqueue_struct *wq,
154491ccc6e7STejun Heo 						   int node)
154591ccc6e7STejun Heo {
154691ccc6e7STejun Heo 	if (!(wq->flags & WQ_UNBOUND))
154791ccc6e7STejun Heo 		return NULL;
154891ccc6e7STejun Heo 
154991ccc6e7STejun Heo 	if (node == NUMA_NO_NODE)
155091ccc6e7STejun Heo 		node = nr_node_ids;
155191ccc6e7STejun Heo 
155291ccc6e7STejun Heo 	return wq->node_nr_active[node];
155391ccc6e7STejun Heo }
155491ccc6e7STejun Heo 
155591ccc6e7STejun Heo /**
15565797b1c1STejun Heo  * wq_update_node_max_active - Update per-node max_actives to use
15575797b1c1STejun Heo  * @wq: workqueue to update
15585797b1c1STejun Heo  * @off_cpu: CPU that's going down, -1 if a CPU is not going down
15595797b1c1STejun Heo  *
15605797b1c1STejun Heo  * Update @wq->node_nr_active[]->max. @wq must be unbound. max_active is
15615797b1c1STejun Heo  * distributed among nodes according to the proportions of numbers of online
15625797b1c1STejun Heo  * cpus. The result is always between @wq->min_active and max_active.
15635797b1c1STejun Heo  */
15645797b1c1STejun Heo static void wq_update_node_max_active(struct workqueue_struct *wq, int off_cpu)
15655797b1c1STejun Heo {
15665797b1c1STejun Heo 	struct cpumask *effective = unbound_effective_cpumask(wq);
15675797b1c1STejun Heo 	int min_active = READ_ONCE(wq->min_active);
15685797b1c1STejun Heo 	int max_active = READ_ONCE(wq->max_active);
15695797b1c1STejun Heo 	int total_cpus, node;
15705797b1c1STejun Heo 
15715797b1c1STejun Heo 	lockdep_assert_held(&wq->mutex);
15725797b1c1STejun Heo 
1573c5f8cd6cSTejun Heo 	if (!wq_topo_initialized)
1574c5f8cd6cSTejun Heo 		return;
1575c5f8cd6cSTejun Heo 
157615930da4STejun Heo 	if (off_cpu >= 0 && !cpumask_test_cpu(off_cpu, effective))
15775797b1c1STejun Heo 		off_cpu = -1;
15785797b1c1STejun Heo 
15795797b1c1STejun Heo 	total_cpus = cpumask_weight_and(effective, cpu_online_mask);
15805797b1c1STejun Heo 	if (off_cpu >= 0)
15815797b1c1STejun Heo 		total_cpus--;
15825797b1c1STejun Heo 
15835797b1c1STejun Heo 	for_each_node(node) {
15845797b1c1STejun Heo 		int node_cpus;
15855797b1c1STejun Heo 
15865797b1c1STejun Heo 		node_cpus = cpumask_weight_and(effective, cpumask_of_node(node));
15875797b1c1STejun Heo 		if (off_cpu >= 0 && cpu_to_node(off_cpu) == node)
15885797b1c1STejun Heo 			node_cpus--;
15895797b1c1STejun Heo 
15905797b1c1STejun Heo 		wq_node_nr_active(wq, node)->max =
15915797b1c1STejun Heo 			clamp(DIV_ROUND_UP(max_active * node_cpus, total_cpus),
15925797b1c1STejun Heo 			      min_active, max_active);
15935797b1c1STejun Heo 	}
15945797b1c1STejun Heo 
15955797b1c1STejun Heo 	wq_node_nr_active(wq, NUMA_NO_NODE)->max = min_active;
15965797b1c1STejun Heo }
15975797b1c1STejun Heo 
15985797b1c1STejun Heo /**
15998864b4e5STejun Heo  * get_pwq - get an extra reference on the specified pool_workqueue
16008864b4e5STejun Heo  * @pwq: pool_workqueue to get
16018864b4e5STejun Heo  *
16028864b4e5STejun Heo  * Obtain an extra reference on @pwq.  The caller should guarantee that
16038864b4e5STejun Heo  * @pwq has positive refcnt and be holding the matching pool->lock.
16048864b4e5STejun Heo  */
16058864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq)
16068864b4e5STejun Heo {
16078864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
16088864b4e5STejun Heo 	WARN_ON_ONCE(pwq->refcnt <= 0);
16098864b4e5STejun Heo 	pwq->refcnt++;
16108864b4e5STejun Heo }
16118864b4e5STejun Heo 
16128864b4e5STejun Heo /**
16138864b4e5STejun Heo  * put_pwq - put a pool_workqueue reference
16148864b4e5STejun Heo  * @pwq: pool_workqueue to put
16158864b4e5STejun Heo  *
16168864b4e5STejun Heo  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
16178864b4e5STejun Heo  * destruction.  The caller should be holding the matching pool->lock.
16188864b4e5STejun Heo  */
16198864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq)
16208864b4e5STejun Heo {
16218864b4e5STejun Heo 	lockdep_assert_held(&pwq->pool->lock);
16228864b4e5STejun Heo 	if (likely(--pwq->refcnt))
16238864b4e5STejun Heo 		return;
16248864b4e5STejun Heo 	/*
1625967b494eSTejun Heo 	 * @pwq can't be released under pool->lock, bounce to a dedicated
1626967b494eSTejun Heo 	 * kthread_worker to avoid A-A deadlocks.
16278864b4e5STejun Heo 	 */
1628687a9aa5STejun Heo 	kthread_queue_work(pwq_release_worker, &pwq->release_work);
16298864b4e5STejun Heo }
16308864b4e5STejun Heo 
1631dce90d47STejun Heo /**
1632dce90d47STejun Heo  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1633dce90d47STejun Heo  * @pwq: pool_workqueue to put (can be %NULL)
1634dce90d47STejun Heo  *
1635dce90d47STejun Heo  * put_pwq() with locking.  This function also allows %NULL @pwq.
1636dce90d47STejun Heo  */
1637dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq)
1638dce90d47STejun Heo {
1639dce90d47STejun Heo 	if (pwq) {
1640dce90d47STejun Heo 		/*
164124acfb71SThomas Gleixner 		 * As both pwqs and pools are RCU protected, the
1642dce90d47STejun Heo 		 * following lock operations are safe.
1643dce90d47STejun Heo 		 */
1644a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
1645dce90d47STejun Heo 		put_pwq(pwq);
1646a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
1647dce90d47STejun Heo 	}
1648dce90d47STejun Heo }
1649dce90d47STejun Heo 
1650afa87ce8STejun Heo static bool pwq_is_empty(struct pool_workqueue *pwq)
1651afa87ce8STejun Heo {
1652afa87ce8STejun Heo 	return !pwq->nr_active && list_empty(&pwq->inactive_works);
1653afa87ce8STejun Heo }
1654afa87ce8STejun Heo 
16554c638030STejun Heo static void __pwq_activate_work(struct pool_workqueue *pwq,
16564c638030STejun Heo 				struct work_struct *work)
1657bf4ede01STejun Heo {
16581c270b79STejun Heo 	unsigned long *wdb = work_data_bits(work);
16591c270b79STejun Heo 
16601c270b79STejun Heo 	WARN_ON_ONCE(!(*wdb & WORK_STRUCT_INACTIVE));
1661bf4ede01STejun Heo 	trace_workqueue_activate_work(work);
166282607adcSTejun Heo 	if (list_empty(&pwq->pool->worklist))
166382607adcSTejun Heo 		pwq->pool->watchdog_ts = jiffies;
1664112202d9STejun Heo 	move_linked_works(work, &pwq->pool->worklist, NULL);
16651c270b79STejun Heo 	__clear_bit(WORK_STRUCT_INACTIVE_BIT, wdb);
16664c638030STejun Heo }
16674c638030STejun Heo 
16684c638030STejun Heo /**
16694c638030STejun Heo  * pwq_activate_work - Activate a work item if inactive
16704c638030STejun Heo  * @pwq: pool_workqueue @work belongs to
16714c638030STejun Heo  * @work: work item to activate
16724c638030STejun Heo  *
16734c638030STejun Heo  * Returns %true if activated. %false if already active.
16744c638030STejun Heo  */
16754c638030STejun Heo static bool pwq_activate_work(struct pool_workqueue *pwq,
16764c638030STejun Heo 			      struct work_struct *work)
16774c638030STejun Heo {
16784c638030STejun Heo 	struct worker_pool *pool = pwq->pool;
167991ccc6e7STejun Heo 	struct wq_node_nr_active *nna;
16804c638030STejun Heo 
16814c638030STejun Heo 	lockdep_assert_held(&pool->lock);
16824c638030STejun Heo 
16834c638030STejun Heo 	if (!(*work_data_bits(work) & WORK_STRUCT_INACTIVE))
16844c638030STejun Heo 		return false;
16854c638030STejun Heo 
168691ccc6e7STejun Heo 	nna = wq_node_nr_active(pwq->wq, pool->node);
168791ccc6e7STejun Heo 	if (nna)
168891ccc6e7STejun Heo 		atomic_inc(&nna->nr);
168991ccc6e7STejun Heo 
1690112202d9STejun Heo 	pwq->nr_active++;
16914c638030STejun Heo 	__pwq_activate_work(pwq, work);
16924c638030STejun Heo 	return true;
1693bf4ede01STejun Heo }
1694bf4ede01STejun Heo 
16955797b1c1STejun Heo static bool tryinc_node_nr_active(struct wq_node_nr_active *nna)
16965797b1c1STejun Heo {
16975797b1c1STejun Heo 	int max = READ_ONCE(nna->max);
16985797b1c1STejun Heo 
16995797b1c1STejun Heo 	while (true) {
17005797b1c1STejun Heo 		int old, tmp;
17015797b1c1STejun Heo 
17025797b1c1STejun Heo 		old = atomic_read(&nna->nr);
17035797b1c1STejun Heo 		if (old >= max)
17045797b1c1STejun Heo 			return false;
17055797b1c1STejun Heo 		tmp = atomic_cmpxchg_relaxed(&nna->nr, old, old + 1);
17065797b1c1STejun Heo 		if (tmp == old)
17075797b1c1STejun Heo 			return true;
17085797b1c1STejun Heo 	}
17095797b1c1STejun Heo }
17105797b1c1STejun Heo 
17111c270b79STejun Heo /**
17121c270b79STejun Heo  * pwq_tryinc_nr_active - Try to increment nr_active for a pwq
17131c270b79STejun Heo  * @pwq: pool_workqueue of interest
17145797b1c1STejun Heo  * @fill: max_active may have increased, try to increase concurrency level
17151c270b79STejun Heo  *
17161c270b79STejun Heo  * Try to increment nr_active for @pwq. Returns %true if an nr_active count is
17171c270b79STejun Heo  * successfully obtained. %false otherwise.
17181c270b79STejun Heo  */
17195797b1c1STejun Heo static bool pwq_tryinc_nr_active(struct pool_workqueue *pwq, bool fill)
17203aa62497SLai Jiangshan {
17211c270b79STejun Heo 	struct workqueue_struct *wq = pwq->wq;
17221c270b79STejun Heo 	struct worker_pool *pool = pwq->pool;
172391ccc6e7STejun Heo 	struct wq_node_nr_active *nna = wq_node_nr_active(wq, pool->node);
17245797b1c1STejun Heo 	bool obtained = false;
17251c270b79STejun Heo 
17261c270b79STejun Heo 	lockdep_assert_held(&pool->lock);
17271c270b79STejun Heo 
17285797b1c1STejun Heo 	if (!nna) {
17294cb1ef64STejun Heo 		/* BH or per-cpu workqueue, pwq->nr_active is sufficient */
17301c270b79STejun Heo 		obtained = pwq->nr_active < READ_ONCE(wq->max_active);
17315797b1c1STejun Heo 		goto out;
173291ccc6e7STejun Heo 	}
17335797b1c1STejun Heo 
17344c065dbcSWaiman Long 	if (unlikely(pwq->plugged))
17354c065dbcSWaiman Long 		return false;
17364c065dbcSWaiman Long 
17375797b1c1STejun Heo 	/*
17385797b1c1STejun Heo 	 * Unbound workqueue uses per-node shared nr_active $nna. If @pwq is
17395797b1c1STejun Heo 	 * already waiting on $nna, pwq_dec_nr_active() will maintain the
17405797b1c1STejun Heo 	 * concurrency level. Don't jump the line.
17415797b1c1STejun Heo 	 *
17425797b1c1STejun Heo 	 * We need to ignore the pending test after max_active has increased as
17435797b1c1STejun Heo 	 * pwq_dec_nr_active() can only maintain the concurrency level but not
17445797b1c1STejun Heo 	 * increase it. This is indicated by @fill.
17455797b1c1STejun Heo 	 */
17465797b1c1STejun Heo 	if (!list_empty(&pwq->pending_node) && likely(!fill))
17475797b1c1STejun Heo 		goto out;
17485797b1c1STejun Heo 
17495797b1c1STejun Heo 	obtained = tryinc_node_nr_active(nna);
17505797b1c1STejun Heo 	if (obtained)
17515797b1c1STejun Heo 		goto out;
17525797b1c1STejun Heo 
17535797b1c1STejun Heo 	/*
17545797b1c1STejun Heo 	 * Lockless acquisition failed. Lock, add ourself to $nna->pending_pwqs
17555797b1c1STejun Heo 	 * and try again. The smp_mb() is paired with the implied memory barrier
17565797b1c1STejun Heo 	 * of atomic_dec_return() in pwq_dec_nr_active() to ensure that either
17575797b1c1STejun Heo 	 * we see the decremented $nna->nr or they see non-empty
17585797b1c1STejun Heo 	 * $nna->pending_pwqs.
17595797b1c1STejun Heo 	 */
17605797b1c1STejun Heo 	raw_spin_lock(&nna->lock);
17615797b1c1STejun Heo 
17625797b1c1STejun Heo 	if (list_empty(&pwq->pending_node))
17635797b1c1STejun Heo 		list_add_tail(&pwq->pending_node, &nna->pending_pwqs);
17645797b1c1STejun Heo 	else if (likely(!fill))
17655797b1c1STejun Heo 		goto out_unlock;
17665797b1c1STejun Heo 
17675797b1c1STejun Heo 	smp_mb();
17685797b1c1STejun Heo 
17695797b1c1STejun Heo 	obtained = tryinc_node_nr_active(nna);
17705797b1c1STejun Heo 
17715797b1c1STejun Heo 	/*
17725797b1c1STejun Heo 	 * If @fill, @pwq might have already been pending. Being spuriously
17735797b1c1STejun Heo 	 * pending in cold paths doesn't affect anything. Let's leave it be.
17745797b1c1STejun Heo 	 */
17755797b1c1STejun Heo 	if (obtained && likely(!fill))
17765797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
17775797b1c1STejun Heo 
17785797b1c1STejun Heo out_unlock:
17795797b1c1STejun Heo 	raw_spin_unlock(&nna->lock);
17805797b1c1STejun Heo out:
17815797b1c1STejun Heo 	if (obtained)
17825797b1c1STejun Heo 		pwq->nr_active++;
17831c270b79STejun Heo 	return obtained;
17841c270b79STejun Heo }
17851c270b79STejun Heo 
17861c270b79STejun Heo /**
17871c270b79STejun Heo  * pwq_activate_first_inactive - Activate the first inactive work item on a pwq
17881c270b79STejun Heo  * @pwq: pool_workqueue of interest
17895797b1c1STejun Heo  * @fill: max_active may have increased, try to increase concurrency level
17901c270b79STejun Heo  *
17911c270b79STejun Heo  * Activate the first inactive work item of @pwq if available and allowed by
17921c270b79STejun Heo  * max_active limit.
17931c270b79STejun Heo  *
17941c270b79STejun Heo  * Returns %true if an inactive work item has been activated. %false if no
17951c270b79STejun Heo  * inactive work item is found or max_active limit is reached.
17961c270b79STejun Heo  */
17975797b1c1STejun Heo static bool pwq_activate_first_inactive(struct pool_workqueue *pwq, bool fill)
17981c270b79STejun Heo {
17991c270b79STejun Heo 	struct work_struct *work =
18001c270b79STejun Heo 		list_first_entry_or_null(&pwq->inactive_works,
18013aa62497SLai Jiangshan 					 struct work_struct, entry);
18023aa62497SLai Jiangshan 
18035797b1c1STejun Heo 	if (work && pwq_tryinc_nr_active(pwq, fill)) {
18041c270b79STejun Heo 		__pwq_activate_work(pwq, work);
18051c270b79STejun Heo 		return true;
18061c270b79STejun Heo 	} else {
18071c270b79STejun Heo 		return false;
18081c270b79STejun Heo 	}
18091c270b79STejun Heo }
18101c270b79STejun Heo 
18111c270b79STejun Heo /**
1812516d3dc9SWaiman Long  * unplug_oldest_pwq - unplug the oldest pool_workqueue
1813516d3dc9SWaiman Long  * @wq: workqueue_struct where its oldest pwq is to be unplugged
18144c065dbcSWaiman Long  *
1815516d3dc9SWaiman Long  * This function should only be called for ordered workqueues where only the
1816516d3dc9SWaiman Long  * oldest pwq is unplugged, the others are plugged to suspend execution to
1817516d3dc9SWaiman Long  * ensure proper work item ordering::
18184c065dbcSWaiman Long  *
18194c065dbcSWaiman Long  *    dfl_pwq --------------+     [P] - plugged
18204c065dbcSWaiman Long  *                          |
18214c065dbcSWaiman Long  *                          v
18224c065dbcSWaiman Long  *    pwqs -> A -> B [P] -> C [P] (newest)
18234c065dbcSWaiman Long  *            |    |        |
18244c065dbcSWaiman Long  *            1    3        5
18254c065dbcSWaiman Long  *            |    |        |
18264c065dbcSWaiman Long  *            2    4        6
1827516d3dc9SWaiman Long  *
1828516d3dc9SWaiman Long  * When the oldest pwq is drained and removed, this function should be called
1829516d3dc9SWaiman Long  * to unplug the next oldest one to start its work item execution. Note that
1830516d3dc9SWaiman Long  * pwq's are linked into wq->pwqs with the oldest first, so the first one in
1831516d3dc9SWaiman Long  * the list is the oldest.
18324c065dbcSWaiman Long  */
18334c065dbcSWaiman Long static void unplug_oldest_pwq(struct workqueue_struct *wq)
18344c065dbcSWaiman Long {
18354c065dbcSWaiman Long 	struct pool_workqueue *pwq;
18364c065dbcSWaiman Long 
18374c065dbcSWaiman Long 	lockdep_assert_held(&wq->mutex);
18384c065dbcSWaiman Long 
18394c065dbcSWaiman Long 	/* Caller should make sure that pwqs isn't empty before calling */
18404c065dbcSWaiman Long 	pwq = list_first_entry_or_null(&wq->pwqs, struct pool_workqueue,
18414c065dbcSWaiman Long 				       pwqs_node);
18424c065dbcSWaiman Long 	raw_spin_lock_irq(&pwq->pool->lock);
18434c065dbcSWaiman Long 	if (pwq->plugged) {
18444c065dbcSWaiman Long 		pwq->plugged = false;
18454c065dbcSWaiman Long 		if (pwq_activate_first_inactive(pwq, true))
18464c065dbcSWaiman Long 			kick_pool(pwq->pool);
18474c065dbcSWaiman Long 	}
18484c065dbcSWaiman Long 	raw_spin_unlock_irq(&pwq->pool->lock);
18494c065dbcSWaiman Long }
18504c065dbcSWaiman Long 
18514c065dbcSWaiman Long /**
18525797b1c1STejun Heo  * node_activate_pending_pwq - Activate a pending pwq on a wq_node_nr_active
18535797b1c1STejun Heo  * @nna: wq_node_nr_active to activate a pending pwq for
18545797b1c1STejun Heo  * @caller_pool: worker_pool the caller is locking
18555797b1c1STejun Heo  *
18565797b1c1STejun Heo  * Activate a pwq in @nna->pending_pwqs. Called with @caller_pool locked.
18575797b1c1STejun Heo  * @caller_pool may be unlocked and relocked to lock other worker_pools.
18585797b1c1STejun Heo  */
18595797b1c1STejun Heo static void node_activate_pending_pwq(struct wq_node_nr_active *nna,
18605797b1c1STejun Heo 				      struct worker_pool *caller_pool)
18615797b1c1STejun Heo {
18625797b1c1STejun Heo 	struct worker_pool *locked_pool = caller_pool;
18635797b1c1STejun Heo 	struct pool_workqueue *pwq;
18645797b1c1STejun Heo 	struct work_struct *work;
18655797b1c1STejun Heo 
18665797b1c1STejun Heo 	lockdep_assert_held(&caller_pool->lock);
18675797b1c1STejun Heo 
18685797b1c1STejun Heo 	raw_spin_lock(&nna->lock);
18695797b1c1STejun Heo retry:
18705797b1c1STejun Heo 	pwq = list_first_entry_or_null(&nna->pending_pwqs,
18715797b1c1STejun Heo 				       struct pool_workqueue, pending_node);
18725797b1c1STejun Heo 	if (!pwq)
18735797b1c1STejun Heo 		goto out_unlock;
18745797b1c1STejun Heo 
18755797b1c1STejun Heo 	/*
18765797b1c1STejun Heo 	 * If @pwq is for a different pool than @locked_pool, we need to lock
18775797b1c1STejun Heo 	 * @pwq->pool->lock. Let's trylock first. If unsuccessful, do the unlock
18785797b1c1STejun Heo 	 * / lock dance. For that, we also need to release @nna->lock as it's
18795797b1c1STejun Heo 	 * nested inside pool locks.
18805797b1c1STejun Heo 	 */
18815797b1c1STejun Heo 	if (pwq->pool != locked_pool) {
18825797b1c1STejun Heo 		raw_spin_unlock(&locked_pool->lock);
18835797b1c1STejun Heo 		locked_pool = pwq->pool;
18845797b1c1STejun Heo 		if (!raw_spin_trylock(&locked_pool->lock)) {
18855797b1c1STejun Heo 			raw_spin_unlock(&nna->lock);
18865797b1c1STejun Heo 			raw_spin_lock(&locked_pool->lock);
18875797b1c1STejun Heo 			raw_spin_lock(&nna->lock);
18885797b1c1STejun Heo 			goto retry;
18895797b1c1STejun Heo 		}
18905797b1c1STejun Heo 	}
18915797b1c1STejun Heo 
18925797b1c1STejun Heo 	/*
18935797b1c1STejun Heo 	 * $pwq may not have any inactive work items due to e.g. cancellations.
18945797b1c1STejun Heo 	 * Drop it from pending_pwqs and see if there's another one.
18955797b1c1STejun Heo 	 */
18965797b1c1STejun Heo 	work = list_first_entry_or_null(&pwq->inactive_works,
18975797b1c1STejun Heo 					struct work_struct, entry);
18985797b1c1STejun Heo 	if (!work) {
18995797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
19005797b1c1STejun Heo 		goto retry;
19015797b1c1STejun Heo 	}
19025797b1c1STejun Heo 
19035797b1c1STejun Heo 	/*
19045797b1c1STejun Heo 	 * Acquire an nr_active count and activate the inactive work item. If
19055797b1c1STejun Heo 	 * $pwq still has inactive work items, rotate it to the end of the
19065797b1c1STejun Heo 	 * pending_pwqs so that we round-robin through them. This means that
19075797b1c1STejun Heo 	 * inactive work items are not activated in queueing order which is fine
19085797b1c1STejun Heo 	 * given that there has never been any ordering across different pwqs.
19095797b1c1STejun Heo 	 */
19105797b1c1STejun Heo 	if (likely(tryinc_node_nr_active(nna))) {
19115797b1c1STejun Heo 		pwq->nr_active++;
19125797b1c1STejun Heo 		__pwq_activate_work(pwq, work);
19135797b1c1STejun Heo 
19145797b1c1STejun Heo 		if (list_empty(&pwq->inactive_works))
19155797b1c1STejun Heo 			list_del_init(&pwq->pending_node);
19165797b1c1STejun Heo 		else
19175797b1c1STejun Heo 			list_move_tail(&pwq->pending_node, &nna->pending_pwqs);
19185797b1c1STejun Heo 
19195797b1c1STejun Heo 		/* if activating a foreign pool, make sure it's running */
19205797b1c1STejun Heo 		if (pwq->pool != caller_pool)
19215797b1c1STejun Heo 			kick_pool(pwq->pool);
19225797b1c1STejun Heo 	}
19235797b1c1STejun Heo 
19245797b1c1STejun Heo out_unlock:
19255797b1c1STejun Heo 	raw_spin_unlock(&nna->lock);
19265797b1c1STejun Heo 	if (locked_pool != caller_pool) {
19275797b1c1STejun Heo 		raw_spin_unlock(&locked_pool->lock);
19285797b1c1STejun Heo 		raw_spin_lock(&caller_pool->lock);
19295797b1c1STejun Heo 	}
19305797b1c1STejun Heo }
19315797b1c1STejun Heo 
19325797b1c1STejun Heo /**
19331c270b79STejun Heo  * pwq_dec_nr_active - Retire an active count
19341c270b79STejun Heo  * @pwq: pool_workqueue of interest
19351c270b79STejun Heo  *
19361c270b79STejun Heo  * Decrement @pwq's nr_active and try to activate the first inactive work item.
19375797b1c1STejun Heo  * For unbound workqueues, this function may temporarily drop @pwq->pool->lock.
19381c270b79STejun Heo  */
19391c270b79STejun Heo static void pwq_dec_nr_active(struct pool_workqueue *pwq)
19401c270b79STejun Heo {
19411c270b79STejun Heo 	struct worker_pool *pool = pwq->pool;
194291ccc6e7STejun Heo 	struct wq_node_nr_active *nna = wq_node_nr_active(pwq->wq, pool->node);
19431c270b79STejun Heo 
19441c270b79STejun Heo 	lockdep_assert_held(&pool->lock);
19451c270b79STejun Heo 
194691ccc6e7STejun Heo 	/*
194791ccc6e7STejun Heo 	 * @pwq->nr_active should be decremented for both percpu and unbound
194891ccc6e7STejun Heo 	 * workqueues.
194991ccc6e7STejun Heo 	 */
19501c270b79STejun Heo 	pwq->nr_active--;
195191ccc6e7STejun Heo 
195291ccc6e7STejun Heo 	/*
195391ccc6e7STejun Heo 	 * For a percpu workqueue, it's simple. Just need to kick the first
195491ccc6e7STejun Heo 	 * inactive work item on @pwq itself.
195591ccc6e7STejun Heo 	 */
195691ccc6e7STejun Heo 	if (!nna) {
19575797b1c1STejun Heo 		pwq_activate_first_inactive(pwq, false);
195891ccc6e7STejun Heo 		return;
195991ccc6e7STejun Heo 	}
196091ccc6e7STejun Heo 
19615797b1c1STejun Heo 	/*
19625797b1c1STejun Heo 	 * If @pwq is for an unbound workqueue, it's more complicated because
19635797b1c1STejun Heo 	 * multiple pwqs and pools may be sharing the nr_active count. When a
19645797b1c1STejun Heo 	 * pwq needs to wait for an nr_active count, it puts itself on
19655797b1c1STejun Heo 	 * $nna->pending_pwqs. The following atomic_dec_return()'s implied
19665797b1c1STejun Heo 	 * memory barrier is paired with smp_mb() in pwq_tryinc_nr_active() to
19675797b1c1STejun Heo 	 * guarantee that either we see non-empty pending_pwqs or they see
19685797b1c1STejun Heo 	 * decremented $nna->nr.
19695797b1c1STejun Heo 	 *
19705797b1c1STejun Heo 	 * $nna->max may change as CPUs come online/offline and @pwq->wq's
19715797b1c1STejun Heo 	 * max_active gets updated. However, it is guaranteed to be equal to or
19725797b1c1STejun Heo 	 * larger than @pwq->wq->min_active which is above zero unless freezing.
19735797b1c1STejun Heo 	 * This maintains the forward progress guarantee.
19745797b1c1STejun Heo 	 */
19755797b1c1STejun Heo 	if (atomic_dec_return(&nna->nr) >= READ_ONCE(nna->max))
19765797b1c1STejun Heo 		return;
19775797b1c1STejun Heo 
19785797b1c1STejun Heo 	if (!list_empty(&nna->pending_pwqs))
19795797b1c1STejun Heo 		node_activate_pending_pwq(nna, pool);
19803aa62497SLai Jiangshan }
19813aa62497SLai Jiangshan 
1982bf4ede01STejun Heo /**
1983112202d9STejun Heo  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1984112202d9STejun Heo  * @pwq: pwq of interest
1985c4560c2cSLai Jiangshan  * @work_data: work_data of work which left the queue
1986bf4ede01STejun Heo  *
1987bf4ede01STejun Heo  * A work either has completed or is removed from pending queue,
1988112202d9STejun Heo  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1989bf4ede01STejun Heo  *
1990dd6c3c54STejun Heo  * NOTE:
1991dd6c3c54STejun Heo  * For unbound workqueues, this function may temporarily drop @pwq->pool->lock
1992dd6c3c54STejun Heo  * and thus should be called after all other state updates for the in-flight
1993dd6c3c54STejun Heo  * work item is complete.
1994dd6c3c54STejun Heo  *
1995bf4ede01STejun Heo  * CONTEXT:
1996a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
1997bf4ede01STejun Heo  */
1998c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data)
1999bf4ede01STejun Heo {
2000c4560c2cSLai Jiangshan 	int color = get_work_color(work_data);
2001c4560c2cSLai Jiangshan 
20021c270b79STejun Heo 	if (!(work_data & WORK_STRUCT_INACTIVE))
20031c270b79STejun Heo 		pwq_dec_nr_active(pwq);
2004018f3a13SLai Jiangshan 
2005018f3a13SLai Jiangshan 	pwq->nr_in_flight[color]--;
2006bf4ede01STejun Heo 
2007bf4ede01STejun Heo 	/* is flush in progress and are we at the flushing tip? */
2008112202d9STejun Heo 	if (likely(pwq->flush_color != color))
20098864b4e5STejun Heo 		goto out_put;
2010bf4ede01STejun Heo 
2011bf4ede01STejun Heo 	/* are there still in-flight works? */
2012112202d9STejun Heo 	if (pwq->nr_in_flight[color])
20138864b4e5STejun Heo 		goto out_put;
2014bf4ede01STejun Heo 
2015112202d9STejun Heo 	/* this pwq is done, clear flush_color */
2016112202d9STejun Heo 	pwq->flush_color = -1;
2017bf4ede01STejun Heo 
2018bf4ede01STejun Heo 	/*
2019112202d9STejun Heo 	 * If this was the last pwq, wake up the first flusher.  It
2020bf4ede01STejun Heo 	 * will handle the rest.
2021bf4ede01STejun Heo 	 */
2022112202d9STejun Heo 	if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
2023112202d9STejun Heo 		complete(&pwq->wq->first_flusher->done);
20248864b4e5STejun Heo out_put:
20258864b4e5STejun Heo 	put_pwq(pwq);
2026bf4ede01STejun Heo }
2027bf4ede01STejun Heo 
202836e227d2STejun Heo /**
2029bbb68dfaSTejun Heo  * try_to_grab_pending - steal work item from worklist and disable irq
203036e227d2STejun Heo  * @work: work item to steal
203136e227d2STejun Heo  * @is_dwork: @work is a delayed_work
2032*c26e2f2eSTejun Heo  * @irq_flags: place to store irq state
203336e227d2STejun Heo  *
203436e227d2STejun Heo  * Try to grab PENDING bit of @work.  This function can handle @work in any
2035d185af30SYacine Belkadi  * stable state - idle, on timer or on worklist.
203636e227d2STejun Heo  *
2037d185af30SYacine Belkadi  * Return:
20383eb6b31bSMauro Carvalho Chehab  *
20393eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
204036e227d2STejun Heo  *  1		if @work was pending and we successfully stole PENDING
204136e227d2STejun Heo  *  0		if @work was idle and we claimed PENDING
204236e227d2STejun Heo  *  -EAGAIN	if PENDING couldn't be grabbed at the moment, safe to busy-retry
2043bbb68dfaSTejun Heo  *  -ENOENT	if someone else is canceling @work, this state may persist
2044bbb68dfaSTejun Heo  *		for arbitrarily long
20453eb6b31bSMauro Carvalho Chehab  *  ========	================================================================
204636e227d2STejun Heo  *
2047d185af30SYacine Belkadi  * Note:
2048bbb68dfaSTejun Heo  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
2049e0aecdd8STejun Heo  * interrupted while holding PENDING and @work off queue, irq must be
2050e0aecdd8STejun Heo  * disabled on entry.  This, combined with delayed_work->timer being
2051e0aecdd8STejun Heo  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
2052bbb68dfaSTejun Heo  *
2053bbb68dfaSTejun Heo  * On successful return, >= 0, irq is disabled and the caller is
2054*c26e2f2eSTejun Heo  * responsible for releasing it using local_irq_restore(*@irq_flags).
2055bbb68dfaSTejun Heo  *
2056e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
2057bf4ede01STejun Heo  */
2058bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
2059*c26e2f2eSTejun Heo 			       unsigned long *irq_flags)
2060bf4ede01STejun Heo {
2061d565ed63STejun Heo 	struct worker_pool *pool;
2062112202d9STejun Heo 	struct pool_workqueue *pwq;
2063bf4ede01STejun Heo 
2064*c26e2f2eSTejun Heo 	local_irq_save(*irq_flags);
2065bbb68dfaSTejun Heo 
206636e227d2STejun Heo 	/* try to steal the timer if it exists */
206736e227d2STejun Heo 	if (is_dwork) {
206836e227d2STejun Heo 		struct delayed_work *dwork = to_delayed_work(work);
206936e227d2STejun Heo 
2070e0aecdd8STejun Heo 		/*
2071e0aecdd8STejun Heo 		 * dwork->timer is irqsafe.  If del_timer() fails, it's
2072e0aecdd8STejun Heo 		 * guaranteed that the timer is not queued anywhere and not
2073e0aecdd8STejun Heo 		 * running on the local CPU.
2074e0aecdd8STejun Heo 		 */
207536e227d2STejun Heo 		if (likely(del_timer(&dwork->timer)))
207636e227d2STejun Heo 			return 1;
207736e227d2STejun Heo 	}
207836e227d2STejun Heo 
207936e227d2STejun Heo 	/* try to claim PENDING the normal way */
2080bf4ede01STejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
2081bf4ede01STejun Heo 		return 0;
2082bf4ede01STejun Heo 
208324acfb71SThomas Gleixner 	rcu_read_lock();
2084bf4ede01STejun Heo 	/*
2085bf4ede01STejun Heo 	 * The queueing is in progress, or it is already queued. Try to
2086bf4ede01STejun Heo 	 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2087bf4ede01STejun Heo 	 */
2088d565ed63STejun Heo 	pool = get_work_pool(work);
2089d565ed63STejun Heo 	if (!pool)
2090bbb68dfaSTejun Heo 		goto fail;
2091bf4ede01STejun Heo 
2092a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&pool->lock);
2093bf4ede01STejun Heo 	/*
2094112202d9STejun Heo 	 * work->data is guaranteed to point to pwq only while the work
2095112202d9STejun Heo 	 * item is queued on pwq->wq, and both updating work->data to point
2096112202d9STejun Heo 	 * to pwq on queueing and to pool on dequeueing are done under
2097112202d9STejun Heo 	 * pwq->pool->lock.  This in turn guarantees that, if work->data
2098112202d9STejun Heo 	 * points to pwq which is associated with a locked pool, the work
20990b3dae68SLai Jiangshan 	 * item is currently queued on that pool.
2100bf4ede01STejun Heo 	 */
2101112202d9STejun Heo 	pwq = get_work_pwq(work);
2102112202d9STejun Heo 	if (pwq && pwq->pool == pool) {
2103c70e1779STejun Heo 		unsigned long work_data;
2104c70e1779STejun Heo 
2105bf4ede01STejun Heo 		debug_work_deactivate(work);
21063aa62497SLai Jiangshan 
21073aa62497SLai Jiangshan 		/*
2108018f3a13SLai Jiangshan 		 * A cancelable inactive work item must be in the
2109018f3a13SLai Jiangshan 		 * pwq->inactive_works since a queued barrier can't be
2110018f3a13SLai Jiangshan 		 * canceled (see the comments in insert_wq_barrier()).
2111018f3a13SLai Jiangshan 		 *
2112f97a4a1aSLai Jiangshan 		 * An inactive work item cannot be grabbed directly because
2113d812796eSLai Jiangshan 		 * it might have linked barrier work items which, if left
2114f97a4a1aSLai Jiangshan 		 * on the inactive_works list, will confuse pwq->nr_active
211516062836STejun Heo 		 * management later on and cause stall.  Make sure the work
211616062836STejun Heo 		 * item is activated before grabbing.
21173aa62497SLai Jiangshan 		 */
21184c638030STejun Heo 		pwq_activate_work(pwq, work);
21193aa62497SLai Jiangshan 
2120bf4ede01STejun Heo 		list_del_init(&work->entry);
212136e227d2STejun Heo 
2122c70e1779STejun Heo 		/*
2123c70e1779STejun Heo 		 * work->data points to pwq iff queued. Let's point to pool. As
2124c70e1779STejun Heo 		 * this destroys work->data needed by the next step, stash it.
2125c70e1779STejun Heo 		 */
2126c70e1779STejun Heo 		work_data = *work_data_bits(work);
21274468a00fSLai Jiangshan 		set_work_pool_and_keep_pending(work, pool->id);
21284468a00fSLai Jiangshan 
2129dd6c3c54STejun Heo 		/* must be the last step, see the function comment */
2130c70e1779STejun Heo 		pwq_dec_nr_in_flight(pwq, work_data);
2131dd6c3c54STejun Heo 
2132a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock(&pool->lock);
213324acfb71SThomas Gleixner 		rcu_read_unlock();
213436e227d2STejun Heo 		return 1;
2135bf4ede01STejun Heo 	}
2136a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&pool->lock);
2137bbb68dfaSTejun Heo fail:
213824acfb71SThomas Gleixner 	rcu_read_unlock();
2139*c26e2f2eSTejun Heo 	local_irq_restore(*irq_flags);
2140bbb68dfaSTejun Heo 	if (work_is_canceling(work))
2141bbb68dfaSTejun Heo 		return -ENOENT;
2142bbb68dfaSTejun Heo 	cpu_relax();
214336e227d2STejun Heo 	return -EAGAIN;
2144bf4ede01STejun Heo }
2145bf4ede01STejun Heo 
2146bf4ede01STejun Heo /**
2147706026c2STejun Heo  * insert_work - insert a work into a pool
2148112202d9STejun Heo  * @pwq: pwq @work belongs to
21494690c4abSTejun Heo  * @work: work to insert
21504690c4abSTejun Heo  * @head: insertion point
21514690c4abSTejun Heo  * @extra_flags: extra WORK_STRUCT_* flags to set
21524690c4abSTejun Heo  *
2153112202d9STejun Heo  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
2154706026c2STejun Heo  * work_struct flags.
21554690c4abSTejun Heo  *
21564690c4abSTejun Heo  * CONTEXT:
2157a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2158365970a1SDavid Howells  */
2159112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
2160112202d9STejun Heo 			struct list_head *head, unsigned int extra_flags)
2161b89deed3SOleg Nesterov {
2162fe089f87STejun Heo 	debug_work_activate(work);
2163e1d8aa9fSFrederic Weisbecker 
2164e89a85d6SWalter Wu 	/* record the work call stack in order to print it in KASAN reports */
2165f70da745SMarco Elver 	kasan_record_aux_stack_noalloc(work);
2166e89a85d6SWalter Wu 
21674690c4abSTejun Heo 	/* we own @work, set data and link */
2168112202d9STejun Heo 	set_work_pwq(work, pwq, extra_flags);
21691a4d9b0aSOleg Nesterov 	list_add_tail(&work->entry, head);
21708864b4e5STejun Heo 	get_pwq(pwq);
2171b89deed3SOleg Nesterov }
2172b89deed3SOleg Nesterov 
2173c8efcc25STejun Heo /*
2174c8efcc25STejun Heo  * Test whether @work is being queued from another work executing on the
21758d03ecfeSTejun Heo  * same workqueue.
2176c8efcc25STejun Heo  */
2177c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq)
2178c8efcc25STejun Heo {
2179c8efcc25STejun Heo 	struct worker *worker;
2180c8efcc25STejun Heo 
21818d03ecfeSTejun Heo 	worker = current_wq_worker();
2182c8efcc25STejun Heo 	/*
2183bf393fd4SBart Van Assche 	 * Return %true iff I'm a worker executing a work item on @wq.  If
21848d03ecfeSTejun Heo 	 * I'm @worker, it's safe to dereference it without locking.
2185c8efcc25STejun Heo 	 */
2186112202d9STejun Heo 	return worker && worker->current_pwq->wq == wq;
2187c8efcc25STejun Heo }
2188c8efcc25STejun Heo 
2189ef557180SMike Galbraith /*
2190ef557180SMike Galbraith  * When queueing an unbound work item to a wq, prefer local CPU if allowed
2191ef557180SMike Galbraith  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
2192ef557180SMike Galbraith  * avoid perturbing sensitive tasks.
2193ef557180SMike Galbraith  */
2194ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu)
2195ef557180SMike Galbraith {
2196ef557180SMike Galbraith 	int new_cpu;
2197ef557180SMike Galbraith 
2198f303fccbSTejun Heo 	if (likely(!wq_debug_force_rr_cpu)) {
2199ef557180SMike Galbraith 		if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
2200ef557180SMike Galbraith 			return cpu;
2201a8ec5880SAmmar Faizi 	} else {
2202a8ec5880SAmmar Faizi 		pr_warn_once("workqueue: round-robin CPU selection forced, expect performance impact\n");
2203f303fccbSTejun Heo 	}
2204f303fccbSTejun Heo 
2205ef557180SMike Galbraith 	new_cpu = __this_cpu_read(wq_rr_cpu_last);
2206ef557180SMike Galbraith 	new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
2207ef557180SMike Galbraith 	if (unlikely(new_cpu >= nr_cpu_ids)) {
2208ef557180SMike Galbraith 		new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
2209ef557180SMike Galbraith 		if (unlikely(new_cpu >= nr_cpu_ids))
2210ef557180SMike Galbraith 			return cpu;
2211ef557180SMike Galbraith 	}
2212ef557180SMike Galbraith 	__this_cpu_write(wq_rr_cpu_last, new_cpu);
2213ef557180SMike Galbraith 
2214ef557180SMike Galbraith 	return new_cpu;
2215ef557180SMike Galbraith }
2216ef557180SMike Galbraith 
2217d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq,
22181da177e4SLinus Torvalds 			 struct work_struct *work)
22191da177e4SLinus Torvalds {
2220112202d9STejun Heo 	struct pool_workqueue *pwq;
2221fe089f87STejun Heo 	struct worker_pool *last_pool, *pool;
22228a2e8e5dSTejun Heo 	unsigned int work_flags;
2223b75cac93SJoonsoo Kim 	unsigned int req_cpu = cpu;
22248930cabaSTejun Heo 
22258930cabaSTejun Heo 	/*
22268930cabaSTejun Heo 	 * While a work item is PENDING && off queue, a task trying to
22278930cabaSTejun Heo 	 * steal the PENDING will busy-loop waiting for it to either get
22288930cabaSTejun Heo 	 * queued or lose PENDING.  Grabbing PENDING and queueing should
22298930cabaSTejun Heo 	 * happen with IRQ disabled.
22308930cabaSTejun Heo 	 */
22318e8eb730SFrederic Weisbecker 	lockdep_assert_irqs_disabled();
22321da177e4SLinus Torvalds 
223333e3f0a3SRichard Clark 	/*
223433e3f0a3SRichard Clark 	 * For a draining wq, only works from the same workqueue are
223533e3f0a3SRichard Clark 	 * allowed. The __WQ_DESTROYING helps to spot the issue that
223633e3f0a3SRichard Clark 	 * queues a new work item to a wq after destroy_workqueue(wq).
223733e3f0a3SRichard Clark 	 */
223833e3f0a3SRichard Clark 	if (unlikely(wq->flags & (__WQ_DESTROYING | __WQ_DRAINING) &&
223933e3f0a3SRichard Clark 		     WARN_ON_ONCE(!is_chained_work(wq))))
2240e41e704bSTejun Heo 		return;
224124acfb71SThomas Gleixner 	rcu_read_lock();
22429e8cd2f5STejun Heo retry:
2243aa202f1fSHillf Danton 	/* pwq which will be used unless @work is executing elsewhere */
2244636b927eSTejun Heo 	if (req_cpu == WORK_CPU_UNBOUND) {
2245636b927eSTejun Heo 		if (wq->flags & WQ_UNBOUND)
2246ef557180SMike Galbraith 			cpu = wq_select_unbound_cpu(raw_smp_processor_id());
2247636b927eSTejun Heo 		else
2248aa202f1fSHillf Danton 			cpu = raw_smp_processor_id();
2249aa202f1fSHillf Danton 	}
2250f3421797STejun Heo 
2251636b927eSTejun Heo 	pwq = rcu_dereference(*per_cpu_ptr(wq->cpu_pwq, cpu));
2252fe089f87STejun Heo 	pool = pwq->pool;
2253fe089f87STejun Heo 
225418aa9effSTejun Heo 	/*
2255c9178087STejun Heo 	 * If @work was previously on a different pool, it might still be
2256c9178087STejun Heo 	 * running there, in which case the work needs to be queued on that
2257c9178087STejun Heo 	 * pool to guarantee non-reentrancy.
225818aa9effSTejun Heo 	 */
2259c9e7cf27STejun Heo 	last_pool = get_work_pool(work);
2260fe089f87STejun Heo 	if (last_pool && last_pool != pool) {
226118aa9effSTejun Heo 		struct worker *worker;
226218aa9effSTejun Heo 
2263a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock(&last_pool->lock);
226418aa9effSTejun Heo 
2265c9e7cf27STejun Heo 		worker = find_worker_executing_work(last_pool, work);
226618aa9effSTejun Heo 
2267112202d9STejun Heo 		if (worker && worker->current_pwq->wq == wq) {
2268c9178087STejun Heo 			pwq = worker->current_pwq;
2269fe089f87STejun Heo 			pool = pwq->pool;
2270fe089f87STejun Heo 			WARN_ON_ONCE(pool != last_pool);
22718594fadeSLai Jiangshan 		} else {
227218aa9effSTejun Heo 			/* meh... not running there, queue here */
2273a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock(&last_pool->lock);
2274fe089f87STejun Heo 			raw_spin_lock(&pool->lock);
227518aa9effSTejun Heo 		}
22768930cabaSTejun Heo 	} else {
2277fe089f87STejun Heo 		raw_spin_lock(&pool->lock);
22788930cabaSTejun Heo 	}
2279502ca9d8STejun Heo 
22809e8cd2f5STejun Heo 	/*
2281636b927eSTejun Heo 	 * pwq is determined and locked. For unbound pools, we could have raced
2282636b927eSTejun Heo 	 * with pwq release and it could already be dead. If its refcnt is zero,
2283636b927eSTejun Heo 	 * repeat pwq selection. Note that unbound pwqs never die without
2284636b927eSTejun Heo 	 * another pwq replacing it in cpu_pwq or while work items are executing
2285636b927eSTejun Heo 	 * on it, so the retrying is guaranteed to make forward-progress.
22869e8cd2f5STejun Heo 	 */
22879e8cd2f5STejun Heo 	if (unlikely(!pwq->refcnt)) {
22889e8cd2f5STejun Heo 		if (wq->flags & WQ_UNBOUND) {
2289fe089f87STejun Heo 			raw_spin_unlock(&pool->lock);
22909e8cd2f5STejun Heo 			cpu_relax();
22919e8cd2f5STejun Heo 			goto retry;
22929e8cd2f5STejun Heo 		}
22939e8cd2f5STejun Heo 		/* oops */
22949e8cd2f5STejun Heo 		WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
22959e8cd2f5STejun Heo 			  wq->name, cpu);
22969e8cd2f5STejun Heo 	}
22979e8cd2f5STejun Heo 
2298112202d9STejun Heo 	/* pwq determined, queue */
2299112202d9STejun Heo 	trace_workqueue_queue_work(req_cpu, pwq, work);
2300502ca9d8STejun Heo 
230124acfb71SThomas Gleixner 	if (WARN_ON(!list_empty(&work->entry)))
230224acfb71SThomas Gleixner 		goto out;
23031e19ffc6STejun Heo 
2304112202d9STejun Heo 	pwq->nr_in_flight[pwq->work_color]++;
2305112202d9STejun Heo 	work_flags = work_color_to_flags(pwq->work_color);
23061e19ffc6STejun Heo 
2307a045a272STejun Heo 	/*
2308a045a272STejun Heo 	 * Limit the number of concurrently active work items to max_active.
2309a045a272STejun Heo 	 * @work must also queue behind existing inactive work items to maintain
2310a045a272STejun Heo 	 * ordering when max_active changes. See wq_adjust_max_active().
2311a045a272STejun Heo 	 */
23125797b1c1STejun Heo 	if (list_empty(&pwq->inactive_works) && pwq_tryinc_nr_active(pwq, false)) {
2313fe089f87STejun Heo 		if (list_empty(&pool->worklist))
2314fe089f87STejun Heo 			pool->watchdog_ts = jiffies;
2315fe089f87STejun Heo 
2316cdadf009STejun Heo 		trace_workqueue_activate_work(work);
2317fe089f87STejun Heo 		insert_work(pwq, work, &pool->worklist, work_flags);
23180219a352STejun Heo 		kick_pool(pool);
23198a2e8e5dSTejun Heo 	} else {
2320f97a4a1aSLai Jiangshan 		work_flags |= WORK_STRUCT_INACTIVE;
2321fe089f87STejun Heo 		insert_work(pwq, work, &pwq->inactive_works, work_flags);
23228a2e8e5dSTejun Heo 	}
23231e19ffc6STejun Heo 
232424acfb71SThomas Gleixner out:
2325fe089f87STejun Heo 	raw_spin_unlock(&pool->lock);
232624acfb71SThomas Gleixner 	rcu_read_unlock();
23271da177e4SLinus Torvalds }
23281da177e4SLinus Torvalds 
23290fcb78c2SRolf Eike Beer /**
2330c1a220e7SZhang Rui  * queue_work_on - queue work on specific cpu
2331c1a220e7SZhang Rui  * @cpu: CPU number to execute work on
2332c1a220e7SZhang Rui  * @wq: workqueue to use
2333c1a220e7SZhang Rui  * @work: work to queue
2334c1a220e7SZhang Rui  *
2335c1a220e7SZhang Rui  * We queue the work to a specific CPU, the caller must ensure it
2336443378f0SPaul E. McKenney  * can't go away.  Callers that fail to ensure that the specified
2337443378f0SPaul E. McKenney  * CPU cannot go away will execute on a randomly chosen CPU.
2338854f5cc5SPaul E. McKenney  * But note well that callers specifying a CPU that never has been
2339854f5cc5SPaul E. McKenney  * online will get a splat.
2340d185af30SYacine Belkadi  *
2341d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.
2342c1a220e7SZhang Rui  */
2343d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq,
2344d4283e93STejun Heo 		   struct work_struct *work)
2345c1a220e7SZhang Rui {
2346d4283e93STejun Heo 	bool ret = false;
2347*c26e2f2eSTejun Heo 	unsigned long irq_flags;
23488930cabaSTejun Heo 
2349*c26e2f2eSTejun Heo 	local_irq_save(irq_flags);
2350c1a220e7SZhang Rui 
235122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
23524690c4abSTejun Heo 		__queue_work(cpu, wq, work);
2353d4283e93STejun Heo 		ret = true;
2354c1a220e7SZhang Rui 	}
23558930cabaSTejun Heo 
2356*c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
2357c1a220e7SZhang Rui 	return ret;
2358c1a220e7SZhang Rui }
2359ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on);
2360c1a220e7SZhang Rui 
23618204e0c1SAlexander Duyck /**
2362fef59c9cSTejun Heo  * select_numa_node_cpu - Select a CPU based on NUMA node
23638204e0c1SAlexander Duyck  * @node: NUMA node ID that we want to select a CPU from
23648204e0c1SAlexander Duyck  *
23658204e0c1SAlexander Duyck  * This function will attempt to find a "random" cpu available on a given
23668204e0c1SAlexander Duyck  * node. If there are no CPUs available on the given node it will return
23678204e0c1SAlexander Duyck  * WORK_CPU_UNBOUND indicating that we should just schedule to any
23688204e0c1SAlexander Duyck  * available CPU if we need to schedule this work.
23698204e0c1SAlexander Duyck  */
2370fef59c9cSTejun Heo static int select_numa_node_cpu(int node)
23718204e0c1SAlexander Duyck {
23728204e0c1SAlexander Duyck 	int cpu;
23738204e0c1SAlexander Duyck 
23748204e0c1SAlexander Duyck 	/* Delay binding to CPU if node is not valid or online */
23758204e0c1SAlexander Duyck 	if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
23768204e0c1SAlexander Duyck 		return WORK_CPU_UNBOUND;
23778204e0c1SAlexander Duyck 
23788204e0c1SAlexander Duyck 	/* Use local node/cpu if we are already there */
23798204e0c1SAlexander Duyck 	cpu = raw_smp_processor_id();
23808204e0c1SAlexander Duyck 	if (node == cpu_to_node(cpu))
23818204e0c1SAlexander Duyck 		return cpu;
23828204e0c1SAlexander Duyck 
23838204e0c1SAlexander Duyck 	/* Use "random" otherwise know as "first" online CPU of node */
23848204e0c1SAlexander Duyck 	cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
23858204e0c1SAlexander Duyck 
23868204e0c1SAlexander Duyck 	/* If CPU is valid return that, otherwise just defer */
23878204e0c1SAlexander Duyck 	return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
23888204e0c1SAlexander Duyck }
23898204e0c1SAlexander Duyck 
23908204e0c1SAlexander Duyck /**
23918204e0c1SAlexander Duyck  * queue_work_node - queue work on a "random" cpu for a given NUMA node
23928204e0c1SAlexander Duyck  * @node: NUMA node that we are targeting the work for
23938204e0c1SAlexander Duyck  * @wq: workqueue to use
23948204e0c1SAlexander Duyck  * @work: work to queue
23958204e0c1SAlexander Duyck  *
23968204e0c1SAlexander Duyck  * We queue the work to a "random" CPU within a given NUMA node. The basic
23978204e0c1SAlexander Duyck  * idea here is to provide a way to somehow associate work with a given
23988204e0c1SAlexander Duyck  * NUMA node.
23998204e0c1SAlexander Duyck  *
24008204e0c1SAlexander Duyck  * This function will only make a best effort attempt at getting this onto
24018204e0c1SAlexander Duyck  * the right NUMA node. If no node is requested or the requested node is
24028204e0c1SAlexander Duyck  * offline then we just fall back to standard queue_work behavior.
24038204e0c1SAlexander Duyck  *
24048204e0c1SAlexander Duyck  * Currently the "random" CPU ends up being the first available CPU in the
24058204e0c1SAlexander Duyck  * intersection of cpu_online_mask and the cpumask of the node, unless we
24068204e0c1SAlexander Duyck  * are running on the node. In that case we just use the current CPU.
24078204e0c1SAlexander Duyck  *
24088204e0c1SAlexander Duyck  * Return: %false if @work was already on a queue, %true otherwise.
24098204e0c1SAlexander Duyck  */
24108204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq,
24118204e0c1SAlexander Duyck 		     struct work_struct *work)
24128204e0c1SAlexander Duyck {
2413*c26e2f2eSTejun Heo 	unsigned long irq_flags;
24148204e0c1SAlexander Duyck 	bool ret = false;
24158204e0c1SAlexander Duyck 
24168204e0c1SAlexander Duyck 	/*
24178204e0c1SAlexander Duyck 	 * This current implementation is specific to unbound workqueues.
24188204e0c1SAlexander Duyck 	 * Specifically we only return the first available CPU for a given
24198204e0c1SAlexander Duyck 	 * node instead of cycling through individual CPUs within the node.
24208204e0c1SAlexander Duyck 	 *
24218204e0c1SAlexander Duyck 	 * If this is used with a per-cpu workqueue then the logic in
24228204e0c1SAlexander Duyck 	 * workqueue_select_cpu_near would need to be updated to allow for
24238204e0c1SAlexander Duyck 	 * some round robin type logic.
24248204e0c1SAlexander Duyck 	 */
24258204e0c1SAlexander Duyck 	WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
24268204e0c1SAlexander Duyck 
2427*c26e2f2eSTejun Heo 	local_irq_save(irq_flags);
24288204e0c1SAlexander Duyck 
24298204e0c1SAlexander Duyck 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
2430fef59c9cSTejun Heo 		int cpu = select_numa_node_cpu(node);
24318204e0c1SAlexander Duyck 
24328204e0c1SAlexander Duyck 		__queue_work(cpu, wq, work);
24338204e0c1SAlexander Duyck 		ret = true;
24348204e0c1SAlexander Duyck 	}
24358204e0c1SAlexander Duyck 
2436*c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
24378204e0c1SAlexander Duyck 	return ret;
24388204e0c1SAlexander Duyck }
24398204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node);
24408204e0c1SAlexander Duyck 
24418c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t)
24421da177e4SLinus Torvalds {
24438c20feb6SKees Cook 	struct delayed_work *dwork = from_timer(dwork, t, timer);
24441da177e4SLinus Torvalds 
2445e0aecdd8STejun Heo 	/* should have been called from irqsafe timer with irq already off */
244660c057bcSLai Jiangshan 	__queue_work(dwork->cpu, dwork->wq, &dwork->work);
24471da177e4SLinus Torvalds }
24481438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn);
24491da177e4SLinus Torvalds 
24507beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
245152bad64dSDavid Howells 				struct delayed_work *dwork, unsigned long delay)
24521da177e4SLinus Torvalds {
24537beb2edfSTejun Heo 	struct timer_list *timer = &dwork->timer;
24547beb2edfSTejun Heo 	struct work_struct *work = &dwork->work;
24551da177e4SLinus Torvalds 
2456637fdbaeSTejun Heo 	WARN_ON_ONCE(!wq);
24574b243563SSami Tolvanen 	WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
2458fc4b514fSTejun Heo 	WARN_ON_ONCE(timer_pending(timer));
2459fc4b514fSTejun Heo 	WARN_ON_ONCE(!list_empty(&work->entry));
24607beb2edfSTejun Heo 
24618852aac2STejun Heo 	/*
24628852aac2STejun Heo 	 * If @delay is 0, queue @dwork->work immediately.  This is for
24638852aac2STejun Heo 	 * both optimization and correctness.  The earliest @timer can
24648852aac2STejun Heo 	 * expire is on the closest next tick and delayed_work users depend
24658852aac2STejun Heo 	 * on that there's no such delay when @delay is 0.
24668852aac2STejun Heo 	 */
24678852aac2STejun Heo 	if (!delay) {
24688852aac2STejun Heo 		__queue_work(cpu, wq, &dwork->work);
24698852aac2STejun Heo 		return;
24708852aac2STejun Heo 	}
24718852aac2STejun Heo 
247260c057bcSLai Jiangshan 	dwork->wq = wq;
24731265057fSTejun Heo 	dwork->cpu = cpu;
24747beb2edfSTejun Heo 	timer->expires = jiffies + delay;
24757beb2edfSTejun Heo 
2476aae17ebbSLeonardo Bras 	if (housekeeping_enabled(HK_TYPE_TIMER)) {
2477aae17ebbSLeonardo Bras 		/* If the current cpu is a housekeeping cpu, use it. */
2478aae17ebbSLeonardo Bras 		cpu = smp_processor_id();
2479aae17ebbSLeonardo Bras 		if (!housekeeping_test_cpu(cpu, HK_TYPE_TIMER))
2480aae17ebbSLeonardo Bras 			cpu = housekeeping_any_cpu(HK_TYPE_TIMER);
24817beb2edfSTejun Heo 		add_timer_on(timer, cpu);
2482aae17ebbSLeonardo Bras 	} else {
2483aae17ebbSLeonardo Bras 		if (likely(cpu == WORK_CPU_UNBOUND))
2484041bd12eSTejun Heo 			add_timer(timer);
2485aae17ebbSLeonardo Bras 		else
2486aae17ebbSLeonardo Bras 			add_timer_on(timer, cpu);
2487aae17ebbSLeonardo Bras 	}
24887beb2edfSTejun Heo }
24891da177e4SLinus Torvalds 
24900fcb78c2SRolf Eike Beer /**
24910fcb78c2SRolf Eike Beer  * queue_delayed_work_on - queue work on specific CPU after delay
24920fcb78c2SRolf Eike Beer  * @cpu: CPU number to execute work on
24930fcb78c2SRolf Eike Beer  * @wq: workqueue to use
2494af9997e4SRandy Dunlap  * @dwork: work to queue
24950fcb78c2SRolf Eike Beer  * @delay: number of jiffies to wait before queueing
24960fcb78c2SRolf Eike Beer  *
2497d185af30SYacine Belkadi  * Return: %false if @work was already on a queue, %true otherwise.  If
2498715f1300STejun Heo  * @delay is zero and @dwork is idle, it will be scheduled for immediate
2499715f1300STejun Heo  * execution.
25000fcb78c2SRolf Eike Beer  */
2501d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
250252bad64dSDavid Howells 			   struct delayed_work *dwork, unsigned long delay)
25037a6bc1cdSVenkatesh Pallipadi {
250452bad64dSDavid Howells 	struct work_struct *work = &dwork->work;
2505d4283e93STejun Heo 	bool ret = false;
2506*c26e2f2eSTejun Heo 	unsigned long irq_flags;
25078930cabaSTejun Heo 
25088930cabaSTejun Heo 	/* read the comment in __queue_work() */
2509*c26e2f2eSTejun Heo 	local_irq_save(irq_flags);
25107a6bc1cdSVenkatesh Pallipadi 
251122df02bbSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
25127beb2edfSTejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
2513d4283e93STejun Heo 		ret = true;
25147a6bc1cdSVenkatesh Pallipadi 	}
25158930cabaSTejun Heo 
2516*c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
25177a6bc1cdSVenkatesh Pallipadi 	return ret;
25187a6bc1cdSVenkatesh Pallipadi }
2519ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on);
25201da177e4SLinus Torvalds 
2521c8e55f36STejun Heo /**
25228376fe22STejun Heo  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
25238376fe22STejun Heo  * @cpu: CPU number to execute work on
25248376fe22STejun Heo  * @wq: workqueue to use
25258376fe22STejun Heo  * @dwork: work to queue
25268376fe22STejun Heo  * @delay: number of jiffies to wait before queueing
25278376fe22STejun Heo  *
25288376fe22STejun Heo  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
25298376fe22STejun Heo  * modify @dwork's timer so that it expires after @delay.  If @delay is
25308376fe22STejun Heo  * zero, @work is guaranteed to be scheduled immediately regardless of its
25318376fe22STejun Heo  * current state.
25328376fe22STejun Heo  *
2533d185af30SYacine Belkadi  * Return: %false if @dwork was idle and queued, %true if @dwork was
25348376fe22STejun Heo  * pending and its timer was modified.
25358376fe22STejun Heo  *
2536e0aecdd8STejun Heo  * This function is safe to call from any context including IRQ handler.
25378376fe22STejun Heo  * See try_to_grab_pending() for details.
25388376fe22STejun Heo  */
25398376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
25408376fe22STejun Heo 			 struct delayed_work *dwork, unsigned long delay)
25418376fe22STejun Heo {
2542*c26e2f2eSTejun Heo 	unsigned long irq_flags;
25438376fe22STejun Heo 	int ret;
25448376fe22STejun Heo 
25458376fe22STejun Heo 	do {
2546*c26e2f2eSTejun Heo 		ret = try_to_grab_pending(&dwork->work, true, &irq_flags);
25478376fe22STejun Heo 	} while (unlikely(ret == -EAGAIN));
25488376fe22STejun Heo 
25498376fe22STejun Heo 	if (likely(ret >= 0)) {
25508376fe22STejun Heo 		__queue_delayed_work(cpu, wq, dwork, delay);
2551*c26e2f2eSTejun Heo 		local_irq_restore(irq_flags);
25528376fe22STejun Heo 	}
25538376fe22STejun Heo 
25548376fe22STejun Heo 	/* -ENOENT from try_to_grab_pending() becomes %true */
25558376fe22STejun Heo 	return ret;
25568376fe22STejun Heo }
25578376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on);
25588376fe22STejun Heo 
255905f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu)
256005f0fe6bSTejun Heo {
256105f0fe6bSTejun Heo 	struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
256205f0fe6bSTejun Heo 
256305f0fe6bSTejun Heo 	/* read the comment in __queue_work() */
256405f0fe6bSTejun Heo 	local_irq_disable();
256505f0fe6bSTejun Heo 	__queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
256605f0fe6bSTejun Heo 	local_irq_enable();
256705f0fe6bSTejun Heo }
256805f0fe6bSTejun Heo 
256905f0fe6bSTejun Heo /**
257005f0fe6bSTejun Heo  * queue_rcu_work - queue work after a RCU grace period
257105f0fe6bSTejun Heo  * @wq: workqueue to use
257205f0fe6bSTejun Heo  * @rwork: work to queue
257305f0fe6bSTejun Heo  *
257405f0fe6bSTejun Heo  * Return: %false if @rwork was already pending, %true otherwise.  Note
257505f0fe6bSTejun Heo  * that a full RCU grace period is guaranteed only after a %true return.
2576bf393fd4SBart Van Assche  * While @rwork is guaranteed to be executed after a %false return, the
257705f0fe6bSTejun Heo  * execution may happen before a full RCU grace period has passed.
257805f0fe6bSTejun Heo  */
257905f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
258005f0fe6bSTejun Heo {
258105f0fe6bSTejun Heo 	struct work_struct *work = &rwork->work;
258205f0fe6bSTejun Heo 
258305f0fe6bSTejun Heo 	if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
258405f0fe6bSTejun Heo 		rwork->wq = wq;
2585a7e30c0eSUladzislau Rezki 		call_rcu_hurry(&rwork->rcu, rcu_work_rcufn);
258605f0fe6bSTejun Heo 		return true;
258705f0fe6bSTejun Heo 	}
258805f0fe6bSTejun Heo 
258905f0fe6bSTejun Heo 	return false;
259005f0fe6bSTejun Heo }
259105f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work);
259205f0fe6bSTejun Heo 
2593f7537df5SLai Jiangshan static struct worker *alloc_worker(int node)
2594c34056a3STejun Heo {
2595c34056a3STejun Heo 	struct worker *worker;
2596c34056a3STejun Heo 
2597f7537df5SLai Jiangshan 	worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
2598c8e55f36STejun Heo 	if (worker) {
2599c8e55f36STejun Heo 		INIT_LIST_HEAD(&worker->entry);
2600affee4b2STejun Heo 		INIT_LIST_HEAD(&worker->scheduled);
2601da028469SLai Jiangshan 		INIT_LIST_HEAD(&worker->node);
2602e22bee78STejun Heo 		/* on creation a worker is in !idle && prep state */
2603e22bee78STejun Heo 		worker->flags = WORKER_PREP;
2604c8e55f36STejun Heo 	}
2605c34056a3STejun Heo 	return worker;
2606c34056a3STejun Heo }
2607c34056a3STejun Heo 
26089546b29eSTejun Heo static cpumask_t *pool_allowed_cpus(struct worker_pool *pool)
26099546b29eSTejun Heo {
26108639ecebSTejun Heo 	if (pool->cpu < 0 && pool->attrs->affn_strict)
26119546b29eSTejun Heo 		return pool->attrs->__pod_cpumask;
26128639ecebSTejun Heo 	else
26138639ecebSTejun Heo 		return pool->attrs->cpumask;
26149546b29eSTejun Heo }
26159546b29eSTejun Heo 
2616c34056a3STejun Heo /**
26174736cbf7SLai Jiangshan  * worker_attach_to_pool() - attach a worker to a pool
26184736cbf7SLai Jiangshan  * @worker: worker to be attached
26194736cbf7SLai Jiangshan  * @pool: the target pool
26204736cbf7SLai Jiangshan  *
26214736cbf7SLai Jiangshan  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
26224736cbf7SLai Jiangshan  * cpu-binding of @worker are kept coordinated with the pool across
26234736cbf7SLai Jiangshan  * cpu-[un]hotplugs.
26244736cbf7SLai Jiangshan  */
26254736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker,
26264736cbf7SLai Jiangshan 				  struct worker_pool *pool)
26274736cbf7SLai Jiangshan {
26281258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
26294736cbf7SLai Jiangshan 
26304736cbf7SLai Jiangshan 	/*
26314cb1ef64STejun Heo 	 * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains stable
26324cb1ef64STejun Heo 	 * across this function. See the comments above the flag definition for
26334cb1ef64STejun Heo 	 * details. BH workers are, while per-CPU, always DISASSOCIATED.
26344736cbf7SLai Jiangshan 	 */
26354cb1ef64STejun Heo 	if (pool->flags & POOL_DISASSOCIATED) {
26364736cbf7SLai Jiangshan 		worker->flags |= WORKER_UNBOUND;
26374cb1ef64STejun Heo 	} else {
26384cb1ef64STejun Heo 		WARN_ON_ONCE(pool->flags & POOL_BH);
26395c25b5ffSPeter Zijlstra 		kthread_set_per_cpu(worker->task, pool->cpu);
26404cb1ef64STejun Heo 	}
26414736cbf7SLai Jiangshan 
2642640f17c8SPeter Zijlstra 	if (worker->rescue_wq)
26439546b29eSTejun Heo 		set_cpus_allowed_ptr(worker->task, pool_allowed_cpus(pool));
2644640f17c8SPeter Zijlstra 
26454736cbf7SLai Jiangshan 	list_add_tail(&worker->node, &pool->workers);
2646a2d812a2STejun Heo 	worker->pool = pool;
26474736cbf7SLai Jiangshan 
26481258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
26494736cbf7SLai Jiangshan }
26504736cbf7SLai Jiangshan 
26514736cbf7SLai Jiangshan /**
265260f5a4bcSLai Jiangshan  * worker_detach_from_pool() - detach a worker from its pool
265360f5a4bcSLai Jiangshan  * @worker: worker which is attached to its pool
265460f5a4bcSLai Jiangshan  *
26554736cbf7SLai Jiangshan  * Undo the attaching which had been done in worker_attach_to_pool().  The
26564736cbf7SLai Jiangshan  * caller worker shouldn't access to the pool after detached except it has
26574736cbf7SLai Jiangshan  * other reference to the pool.
265860f5a4bcSLai Jiangshan  */
2659a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker)
266060f5a4bcSLai Jiangshan {
2661a2d812a2STejun Heo 	struct worker_pool *pool = worker->pool;
266260f5a4bcSLai Jiangshan 	struct completion *detach_completion = NULL;
266360f5a4bcSLai Jiangshan 
26644cb1ef64STejun Heo 	/* there is one permanent BH worker per CPU which should never detach */
26654cb1ef64STejun Heo 	WARN_ON_ONCE(pool->flags & POOL_BH);
26664cb1ef64STejun Heo 
26671258fae7STejun Heo 	mutex_lock(&wq_pool_attach_mutex);
2668a2d812a2STejun Heo 
26695c25b5ffSPeter Zijlstra 	kthread_set_per_cpu(worker->task, -1);
2670da028469SLai Jiangshan 	list_del(&worker->node);
2671a2d812a2STejun Heo 	worker->pool = NULL;
2672a2d812a2STejun Heo 
2673e02b9312SValentin Schneider 	if (list_empty(&pool->workers) && list_empty(&pool->dying_workers))
267460f5a4bcSLai Jiangshan 		detach_completion = pool->detach_completion;
26751258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
267660f5a4bcSLai Jiangshan 
2677b62c0751SLai Jiangshan 	/* clear leftover flags without pool->lock after it is detached */
2678b62c0751SLai Jiangshan 	worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
2679b62c0751SLai Jiangshan 
268060f5a4bcSLai Jiangshan 	if (detach_completion)
268160f5a4bcSLai Jiangshan 		complete(detach_completion);
268260f5a4bcSLai Jiangshan }
268360f5a4bcSLai Jiangshan 
268460f5a4bcSLai Jiangshan /**
2685c34056a3STejun Heo  * create_worker - create a new workqueue worker
268663d95a91STejun Heo  * @pool: pool the new worker will belong to
2687c34056a3STejun Heo  *
2688051e1850SLai Jiangshan  * Create and start a new worker which is attached to @pool.
2689c34056a3STejun Heo  *
2690c34056a3STejun Heo  * CONTEXT:
2691c34056a3STejun Heo  * Might sleep.  Does GFP_KERNEL allocations.
2692c34056a3STejun Heo  *
2693d185af30SYacine Belkadi  * Return:
2694c34056a3STejun Heo  * Pointer to the newly created worker.
2695c34056a3STejun Heo  */
2696bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool)
2697c34056a3STejun Heo {
2698e441b56fSZhen Lei 	struct worker *worker;
2699e441b56fSZhen Lei 	int id;
27005d9c7a1eSLucy Mielke 	char id_buf[23];
2701c34056a3STejun Heo 
27027cda9aaeSLai Jiangshan 	/* ID is needed to determine kthread name */
2703e441b56fSZhen Lei 	id = ida_alloc(&pool->worker_ida, GFP_KERNEL);
27043f0ea0b8SPetr Mladek 	if (id < 0) {
27053f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker ID: %pe\n",
27063f0ea0b8SPetr Mladek 			    ERR_PTR(id));
2707e441b56fSZhen Lei 		return NULL;
27083f0ea0b8SPetr Mladek 	}
2709c34056a3STejun Heo 
2710f7537df5SLai Jiangshan 	worker = alloc_worker(pool->node);
27113f0ea0b8SPetr Mladek 	if (!worker) {
27123f0ea0b8SPetr Mladek 		pr_err_once("workqueue: Failed to allocate a worker\n");
2713c34056a3STejun Heo 		goto fail;
27143f0ea0b8SPetr Mladek 	}
2715c34056a3STejun Heo 
2716c34056a3STejun Heo 	worker->id = id;
2717c34056a3STejun Heo 
27184cb1ef64STejun Heo 	if (!(pool->flags & POOL_BH)) {
271929c91e99STejun Heo 		if (pool->cpu >= 0)
2720e3c916a4STejun Heo 			snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
2721e3c916a4STejun Heo 				 pool->attrs->nice < 0  ? "H" : "");
2722f3421797STejun Heo 		else
2723e3c916a4STejun Heo 			snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
2724e3c916a4STejun Heo 
27254cb1ef64STejun Heo 		worker->task = kthread_create_on_node(worker_thread, worker,
27264cb1ef64STejun Heo 					pool->node, "kworker/%s", id_buf);
27273f0ea0b8SPetr Mladek 		if (IS_ERR(worker->task)) {
272860f54038SPetr Mladek 			if (PTR_ERR(worker->task) == -EINTR) {
272960f54038SPetr Mladek 				pr_err("workqueue: Interrupted when creating a worker thread \"kworker/%s\"\n",
273060f54038SPetr Mladek 				       id_buf);
273160f54038SPetr Mladek 			} else {
27323f0ea0b8SPetr Mladek 				pr_err_once("workqueue: Failed to create a worker thread: %pe",
27333f0ea0b8SPetr Mladek 					    worker->task);
273460f54038SPetr Mladek 			}
2735c34056a3STejun Heo 			goto fail;
27363f0ea0b8SPetr Mladek 		}
2737c34056a3STejun Heo 
273891151228SOleg Nesterov 		set_user_nice(worker->task, pool->attrs->nice);
27399546b29eSTejun Heo 		kthread_bind_mask(worker->task, pool_allowed_cpus(pool));
27404cb1ef64STejun Heo 	}
274191151228SOleg Nesterov 
2742da028469SLai Jiangshan 	/* successful, attach the worker to the pool */
27434736cbf7SLai Jiangshan 	worker_attach_to_pool(worker, pool);
2744822d8405STejun Heo 
2745051e1850SLai Jiangshan 	/* start the newly created worker */
2746a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
27470219a352STejun Heo 
2748051e1850SLai Jiangshan 	worker->pool->nr_workers++;
2749051e1850SLai Jiangshan 	worker_enter_idle(worker);
27500219a352STejun Heo 
27510219a352STejun Heo 	/*
27520219a352STejun Heo 	 * @worker is waiting on a completion in kthread() and will trigger hung
27536a229b0eSTejun Heo 	 * check if not woken up soon. As kick_pool() is noop if @pool is empty,
27546a229b0eSTejun Heo 	 * wake it up explicitly.
27550219a352STejun Heo 	 */
27564cb1ef64STejun Heo 	if (worker->task)
2757051e1850SLai Jiangshan 		wake_up_process(worker->task);
27580219a352STejun Heo 
2759a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2760051e1850SLai Jiangshan 
2761c34056a3STejun Heo 	return worker;
2762822d8405STejun Heo 
2763c34056a3STejun Heo fail:
2764e441b56fSZhen Lei 	ida_free(&pool->worker_ida, id);
2765c34056a3STejun Heo 	kfree(worker);
2766c34056a3STejun Heo 	return NULL;
2767c34056a3STejun Heo }
2768c34056a3STejun Heo 
2769793777bcSValentin Schneider static void unbind_worker(struct worker *worker)
2770793777bcSValentin Schneider {
2771793777bcSValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2772793777bcSValentin Schneider 
2773793777bcSValentin Schneider 	kthread_set_per_cpu(worker->task, -1);
2774793777bcSValentin Schneider 	if (cpumask_intersects(wq_unbound_cpumask, cpu_active_mask))
2775793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, wq_unbound_cpumask) < 0);
2776793777bcSValentin Schneider 	else
2777793777bcSValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0);
2778793777bcSValentin Schneider }
2779793777bcSValentin Schneider 
2780e02b9312SValentin Schneider static void wake_dying_workers(struct list_head *cull_list)
2781e02b9312SValentin Schneider {
2782e02b9312SValentin Schneider 	struct worker *worker, *tmp;
2783e02b9312SValentin Schneider 
2784e02b9312SValentin Schneider 	list_for_each_entry_safe(worker, tmp, cull_list, entry) {
2785e02b9312SValentin Schneider 		list_del_init(&worker->entry);
2786e02b9312SValentin Schneider 		unbind_worker(worker);
2787e02b9312SValentin Schneider 		/*
2788e02b9312SValentin Schneider 		 * If the worker was somehow already running, then it had to be
2789e02b9312SValentin Schneider 		 * in pool->idle_list when set_worker_dying() happened or we
2790e02b9312SValentin Schneider 		 * wouldn't have gotten here.
2791c34056a3STejun Heo 		 *
2792e02b9312SValentin Schneider 		 * Thus, the worker must either have observed the WORKER_DIE
2793e02b9312SValentin Schneider 		 * flag, or have set its state to TASK_IDLE. Either way, the
2794e02b9312SValentin Schneider 		 * below will be observed by the worker and is safe to do
2795e02b9312SValentin Schneider 		 * outside of pool->lock.
2796e02b9312SValentin Schneider 		 */
2797e02b9312SValentin Schneider 		wake_up_process(worker->task);
2798e02b9312SValentin Schneider 	}
2799e02b9312SValentin Schneider }
2800e02b9312SValentin Schneider 
2801e02b9312SValentin Schneider /**
2802e02b9312SValentin Schneider  * set_worker_dying - Tag a worker for destruction
2803e02b9312SValentin Schneider  * @worker: worker to be destroyed
2804e02b9312SValentin Schneider  * @list: transfer worker away from its pool->idle_list and into list
2805e02b9312SValentin Schneider  *
2806e02b9312SValentin Schneider  * Tag @worker for destruction and adjust @pool stats accordingly.  The worker
2807e02b9312SValentin Schneider  * should be idle.
2808c8e55f36STejun Heo  *
2809c8e55f36STejun Heo  * CONTEXT:
2810a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
2811c34056a3STejun Heo  */
2812e02b9312SValentin Schneider static void set_worker_dying(struct worker *worker, struct list_head *list)
2813c34056a3STejun Heo {
2814bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
2815c34056a3STejun Heo 
2816cd549687STejun Heo 	lockdep_assert_held(&pool->lock);
2817e02b9312SValentin Schneider 	lockdep_assert_held(&wq_pool_attach_mutex);
2818cd549687STejun Heo 
2819c34056a3STejun Heo 	/* sanity check frenzy */
28206183c009STejun Heo 	if (WARN_ON(worker->current_work) ||
282173eb7fe7SLai Jiangshan 	    WARN_ON(!list_empty(&worker->scheduled)) ||
282273eb7fe7SLai Jiangshan 	    WARN_ON(!(worker->flags & WORKER_IDLE)))
28236183c009STejun Heo 		return;
2824c34056a3STejun Heo 
2825bd7bdd43STejun Heo 	pool->nr_workers--;
2826bd7bdd43STejun Heo 	pool->nr_idle--;
2827c8e55f36STejun Heo 
2828cb444766STejun Heo 	worker->flags |= WORKER_DIE;
2829e02b9312SValentin Schneider 
2830e02b9312SValentin Schneider 	list_move(&worker->entry, list);
2831e02b9312SValentin Schneider 	list_move(&worker->node, &pool->dying_workers);
2832c34056a3STejun Heo }
2833c34056a3STejun Heo 
28343f959aa3SValentin Schneider /**
28353f959aa3SValentin Schneider  * idle_worker_timeout - check if some idle workers can now be deleted.
28363f959aa3SValentin Schneider  * @t: The pool's idle_timer that just expired
28373f959aa3SValentin Schneider  *
28383f959aa3SValentin Schneider  * The timer is armed in worker_enter_idle(). Note that it isn't disarmed in
28393f959aa3SValentin Schneider  * worker_leave_idle(), as a worker flicking between idle and active while its
28403f959aa3SValentin Schneider  * pool is at the too_many_workers() tipping point would cause too much timer
28413f959aa3SValentin Schneider  * housekeeping overhead. Since IDLE_WORKER_TIMEOUT is long enough, we just let
28423f959aa3SValentin Schneider  * it expire and re-evaluate things from there.
28433f959aa3SValentin Schneider  */
284432a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t)
2845e22bee78STejun Heo {
284632a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, idle_timer);
28473f959aa3SValentin Schneider 	bool do_cull = false;
28483f959aa3SValentin Schneider 
28493f959aa3SValentin Schneider 	if (work_pending(&pool->idle_cull_work))
28503f959aa3SValentin Schneider 		return;
28513f959aa3SValentin Schneider 
28523f959aa3SValentin Schneider 	raw_spin_lock_irq(&pool->lock);
28533f959aa3SValentin Schneider 
28543f959aa3SValentin Schneider 	if (too_many_workers(pool)) {
28553f959aa3SValentin Schneider 		struct worker *worker;
28563f959aa3SValentin Schneider 		unsigned long expires;
28573f959aa3SValentin Schneider 
28583f959aa3SValentin Schneider 		/* idle_list is kept in LIFO order, check the last one */
28593f959aa3SValentin Schneider 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
28603f959aa3SValentin Schneider 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
28613f959aa3SValentin Schneider 		do_cull = !time_before(jiffies, expires);
28623f959aa3SValentin Schneider 
28633f959aa3SValentin Schneider 		if (!do_cull)
28643f959aa3SValentin Schneider 			mod_timer(&pool->idle_timer, expires);
28653f959aa3SValentin Schneider 	}
28663f959aa3SValentin Schneider 	raw_spin_unlock_irq(&pool->lock);
28673f959aa3SValentin Schneider 
28683f959aa3SValentin Schneider 	if (do_cull)
28693f959aa3SValentin Schneider 		queue_work(system_unbound_wq, &pool->idle_cull_work);
28703f959aa3SValentin Schneider }
28713f959aa3SValentin Schneider 
28723f959aa3SValentin Schneider /**
28733f959aa3SValentin Schneider  * idle_cull_fn - cull workers that have been idle for too long.
28743f959aa3SValentin Schneider  * @work: the pool's work for handling these idle workers
28753f959aa3SValentin Schneider  *
28763f959aa3SValentin Schneider  * This goes through a pool's idle workers and gets rid of those that have been
28773f959aa3SValentin Schneider  * idle for at least IDLE_WORKER_TIMEOUT seconds.
2878e02b9312SValentin Schneider  *
2879e02b9312SValentin Schneider  * We don't want to disturb isolated CPUs because of a pcpu kworker being
2880e02b9312SValentin Schneider  * culled, so this also resets worker affinity. This requires a sleepable
2881e02b9312SValentin Schneider  * context, hence the split between timer callback and work item.
28823f959aa3SValentin Schneider  */
28833f959aa3SValentin Schneider static void idle_cull_fn(struct work_struct *work)
28843f959aa3SValentin Schneider {
28853f959aa3SValentin Schneider 	struct worker_pool *pool = container_of(work, struct worker_pool, idle_cull_work);
28869680540cSYang Yingliang 	LIST_HEAD(cull_list);
2887e22bee78STejun Heo 
2888e02b9312SValentin Schneider 	/*
2889e02b9312SValentin Schneider 	 * Grabbing wq_pool_attach_mutex here ensures an already-running worker
2890e02b9312SValentin Schneider 	 * cannot proceed beyong worker_detach_from_pool() in its self-destruct
2891e02b9312SValentin Schneider 	 * path. This is required as a previously-preempted worker could run after
2892e02b9312SValentin Schneider 	 * set_worker_dying() has happened but before wake_dying_workers() did.
2893e02b9312SValentin Schneider 	 */
2894e02b9312SValentin Schneider 	mutex_lock(&wq_pool_attach_mutex);
2895a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2896e22bee78STejun Heo 
28973347fc9fSLai Jiangshan 	while (too_many_workers(pool)) {
2898e22bee78STejun Heo 		struct worker *worker;
2899e22bee78STejun Heo 		unsigned long expires;
2900e22bee78STejun Heo 
290163d95a91STejun Heo 		worker = list_entry(pool->idle_list.prev, struct worker, entry);
2902e22bee78STejun Heo 		expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2903e22bee78STejun Heo 
29043347fc9fSLai Jiangshan 		if (time_before(jiffies, expires)) {
290563d95a91STejun Heo 			mod_timer(&pool->idle_timer, expires);
29063347fc9fSLai Jiangshan 			break;
2907e22bee78STejun Heo 		}
29083347fc9fSLai Jiangshan 
2909e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
2910e22bee78STejun Heo 	}
2911e22bee78STejun Heo 
2912a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2913e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
2914e02b9312SValentin Schneider 	mutex_unlock(&wq_pool_attach_mutex);
2915e22bee78STejun Heo }
2916e22bee78STejun Heo 
2917493a1724STejun Heo static void send_mayday(struct work_struct *work)
2918e22bee78STejun Heo {
2919112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
2920112202d9STejun Heo 	struct workqueue_struct *wq = pwq->wq;
2921493a1724STejun Heo 
29222e109a28STejun Heo 	lockdep_assert_held(&wq_mayday_lock);
2923e22bee78STejun Heo 
2924493008a8STejun Heo 	if (!wq->rescuer)
2925493a1724STejun Heo 		return;
2926e22bee78STejun Heo 
2927e22bee78STejun Heo 	/* mayday mayday mayday */
2928493a1724STejun Heo 	if (list_empty(&pwq->mayday_node)) {
292977668c8bSLai Jiangshan 		/*
293077668c8bSLai Jiangshan 		 * If @pwq is for an unbound wq, its base ref may be put at
293177668c8bSLai Jiangshan 		 * any time due to an attribute change.  Pin @pwq until the
293277668c8bSLai Jiangshan 		 * rescuer is done with it.
293377668c8bSLai Jiangshan 		 */
293477668c8bSLai Jiangshan 		get_pwq(pwq);
2935493a1724STejun Heo 		list_add_tail(&pwq->mayday_node, &wq->maydays);
2936e22bee78STejun Heo 		wake_up_process(wq->rescuer->task);
2937725e8ec5STejun Heo 		pwq->stats[PWQ_STAT_MAYDAY]++;
2938493a1724STejun Heo 	}
2939e22bee78STejun Heo }
2940e22bee78STejun Heo 
294132a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t)
2942e22bee78STejun Heo {
294332a6c723SKees Cook 	struct worker_pool *pool = from_timer(pool, t, mayday_timer);
2944e22bee78STejun Heo 	struct work_struct *work;
2945e22bee78STejun Heo 
2946a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
2947a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock(&wq_mayday_lock);		/* for wq->maydays */
2948e22bee78STejun Heo 
294963d95a91STejun Heo 	if (need_to_create_worker(pool)) {
2950e22bee78STejun Heo 		/*
2951e22bee78STejun Heo 		 * We've been trying to create a new worker but
2952e22bee78STejun Heo 		 * haven't been successful.  We might be hitting an
2953e22bee78STejun Heo 		 * allocation deadlock.  Send distress signals to
2954e22bee78STejun Heo 		 * rescuers.
2955e22bee78STejun Heo 		 */
295663d95a91STejun Heo 		list_for_each_entry(work, &pool->worklist, entry)
2957e22bee78STejun Heo 			send_mayday(work);
2958e22bee78STejun Heo 	}
2959e22bee78STejun Heo 
2960a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock(&wq_mayday_lock);
2961a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
2962e22bee78STejun Heo 
296363d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
2964e22bee78STejun Heo }
2965e22bee78STejun Heo 
2966e22bee78STejun Heo /**
2967e22bee78STejun Heo  * maybe_create_worker - create a new worker if necessary
296863d95a91STejun Heo  * @pool: pool to create a new worker for
2969e22bee78STejun Heo  *
297063d95a91STejun Heo  * Create a new worker for @pool if necessary.  @pool is guaranteed to
2971e22bee78STejun Heo  * have at least one idle worker on return from this function.  If
2972e22bee78STejun Heo  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
297363d95a91STejun Heo  * sent to all rescuers with works scheduled on @pool to resolve
2974e22bee78STejun Heo  * possible allocation deadlock.
2975e22bee78STejun Heo  *
2976c5aa87bbSTejun Heo  * On return, need_to_create_worker() is guaranteed to be %false and
2977c5aa87bbSTejun Heo  * may_start_working() %true.
2978e22bee78STejun Heo  *
2979e22bee78STejun Heo  * LOCKING:
2980a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
2981e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.  Called only from
2982e22bee78STejun Heo  * manager.
2983e22bee78STejun Heo  */
298429187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool)
2985d565ed63STejun Heo __releases(&pool->lock)
2986d565ed63STejun Heo __acquires(&pool->lock)
2987e22bee78STejun Heo {
2988e22bee78STejun Heo restart:
2989a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
29909f9c2364STejun Heo 
2991e22bee78STejun Heo 	/* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
299263d95a91STejun Heo 	mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2993e22bee78STejun Heo 
2994e22bee78STejun Heo 	while (true) {
2995051e1850SLai Jiangshan 		if (create_worker(pool) || !need_to_create_worker(pool))
2996e22bee78STejun Heo 			break;
2997e22bee78STejun Heo 
2998e212f361SLai Jiangshan 		schedule_timeout_interruptible(CREATE_COOLDOWN);
29999f9c2364STejun Heo 
300063d95a91STejun Heo 		if (!need_to_create_worker(pool))
3001e22bee78STejun Heo 			break;
3002e22bee78STejun Heo 	}
3003e22bee78STejun Heo 
300463d95a91STejun Heo 	del_timer_sync(&pool->mayday_timer);
3005a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3006051e1850SLai Jiangshan 	/*
3007051e1850SLai Jiangshan 	 * This is necessary even after a new worker was just successfully
3008051e1850SLai Jiangshan 	 * created as @pool->lock was dropped and the new worker might have
3009051e1850SLai Jiangshan 	 * already become busy.
3010051e1850SLai Jiangshan 	 */
301163d95a91STejun Heo 	if (need_to_create_worker(pool))
3012e22bee78STejun Heo 		goto restart;
3013e22bee78STejun Heo }
3014e22bee78STejun Heo 
3015e22bee78STejun Heo /**
3016e22bee78STejun Heo  * manage_workers - manage worker pool
3017e22bee78STejun Heo  * @worker: self
3018e22bee78STejun Heo  *
3019706026c2STejun Heo  * Assume the manager role and manage the worker pool @worker belongs
3020e22bee78STejun Heo  * to.  At any given time, there can be only zero or one manager per
3021706026c2STejun Heo  * pool.  The exclusion is handled automatically by this function.
3022e22bee78STejun Heo  *
3023e22bee78STejun Heo  * The caller can safely start processing works on false return.  On
3024e22bee78STejun Heo  * true return, it's guaranteed that need_to_create_worker() is false
3025e22bee78STejun Heo  * and may_start_working() is true.
3026e22bee78STejun Heo  *
3027e22bee78STejun Heo  * CONTEXT:
3028a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
3029e22bee78STejun Heo  * multiple times.  Does GFP_KERNEL allocations.
3030e22bee78STejun Heo  *
3031d185af30SYacine Belkadi  * Return:
303229187a9eSTejun Heo  * %false if the pool doesn't need management and the caller can safely
303329187a9eSTejun Heo  * start processing works, %true if management function was performed and
303429187a9eSTejun Heo  * the conditions that the caller verified before calling the function may
303529187a9eSTejun Heo  * no longer be true.
3036e22bee78STejun Heo  */
3037e22bee78STejun Heo static bool manage_workers(struct worker *worker)
3038e22bee78STejun Heo {
303963d95a91STejun Heo 	struct worker_pool *pool = worker->pool;
3040e22bee78STejun Heo 
3041692b4825STejun Heo 	if (pool->flags & POOL_MANAGER_ACTIVE)
304229187a9eSTejun Heo 		return false;
3043692b4825STejun Heo 
3044692b4825STejun Heo 	pool->flags |= POOL_MANAGER_ACTIVE;
30452607d7a6STejun Heo 	pool->manager = worker;
3046e22bee78STejun Heo 
304729187a9eSTejun Heo 	maybe_create_worker(pool);
3048e22bee78STejun Heo 
30492607d7a6STejun Heo 	pool->manager = NULL;
3050692b4825STejun Heo 	pool->flags &= ~POOL_MANAGER_ACTIVE;
3051d8bb65abSSebastian Andrzej Siewior 	rcuwait_wake_up(&manager_wait);
305229187a9eSTejun Heo 	return true;
3053e22bee78STejun Heo }
3054e22bee78STejun Heo 
3055a62428c0STejun Heo /**
3056a62428c0STejun Heo  * process_one_work - process single work
3057c34056a3STejun Heo  * @worker: self
3058a62428c0STejun Heo  * @work: work to process
3059a62428c0STejun Heo  *
3060a62428c0STejun Heo  * Process @work.  This function contains all the logics necessary to
3061a62428c0STejun Heo  * process a single work including synchronization against and
3062a62428c0STejun Heo  * interaction with other workers on the same cpu, queueing and
3063a62428c0STejun Heo  * flushing.  As long as context requirement is met, any worker can
3064a62428c0STejun Heo  * call this function to process a work.
3065a62428c0STejun Heo  *
3066a62428c0STejun Heo  * CONTEXT:
3067a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which is released and regrabbed.
3068a62428c0STejun Heo  */
3069c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work)
3070d565ed63STejun Heo __releases(&pool->lock)
3071d565ed63STejun Heo __acquires(&pool->lock)
30721da177e4SLinus Torvalds {
3073112202d9STejun Heo 	struct pool_workqueue *pwq = get_work_pwq(work);
3074bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
3075c4560c2cSLai Jiangshan 	unsigned long work_data;
3076c35aea39STejun Heo 	int lockdep_start_depth, rcu_start_depth;
30774e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP
30784e6045f1SJohannes Berg 	/*
3079a62428c0STejun Heo 	 * It is permissible to free the struct work_struct from
3080a62428c0STejun Heo 	 * inside the function that is called from it, this we need to
3081a62428c0STejun Heo 	 * take into account for lockdep too.  To avoid bogus "held
3082a62428c0STejun Heo 	 * lock freed" warnings as well as problems when looking into
3083a62428c0STejun Heo 	 * work->lockdep_map, make a copy and use that here.
30844e6045f1SJohannes Berg 	 */
30854d82a1deSPeter Zijlstra 	struct lockdep_map lockdep_map;
30864d82a1deSPeter Zijlstra 
30874d82a1deSPeter Zijlstra 	lockdep_copy_map(&lockdep_map, &work->lockdep_map);
30884e6045f1SJohannes Berg #endif
3089807407c0SLai Jiangshan 	/* ensure we're on the correct CPU */
309085327af6SLai Jiangshan 	WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
3091ec22ca5eSTejun Heo 		     raw_smp_processor_id() != pool->cpu);
309225511a47STejun Heo 
30938930cabaSTejun Heo 	/* claim and dequeue */
3094dc186ad7SThomas Gleixner 	debug_work_deactivate(work);
3095c9e7cf27STejun Heo 	hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
3096c34056a3STejun Heo 	worker->current_work = work;
3097a2c1c57bSTejun Heo 	worker->current_func = work->func;
3098112202d9STejun Heo 	worker->current_pwq = pwq;
30994cb1ef64STejun Heo 	if (worker->task)
3100616db877STejun Heo 		worker->current_at = worker->task->se.sum_exec_runtime;
3101c4560c2cSLai Jiangshan 	work_data = *work_data_bits(work);
3102d812796eSLai Jiangshan 	worker->current_color = get_work_color(work_data);
31037a22ad75STejun Heo 
31048bf89593STejun Heo 	/*
31058bf89593STejun Heo 	 * Record wq name for cmdline and debug reporting, may get
31068bf89593STejun Heo 	 * overridden through set_worker_desc().
31078bf89593STejun Heo 	 */
31088bf89593STejun Heo 	strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
31098bf89593STejun Heo 
3110a62428c0STejun Heo 	list_del_init(&work->entry);
3111a62428c0STejun Heo 
3112649027d7STejun Heo 	/*
3113228f1d00SLai Jiangshan 	 * CPU intensive works don't participate in concurrency management.
3114228f1d00SLai Jiangshan 	 * They're the scheduler's responsibility.  This takes @worker out
3115228f1d00SLai Jiangshan 	 * of concurrency management and the next code block will chain
3116228f1d00SLai Jiangshan 	 * execution of the pending work items.
3117fb0e7bebSTejun Heo 	 */
3118616db877STejun Heo 	if (unlikely(pwq->wq->flags & WQ_CPU_INTENSIVE))
3119228f1d00SLai Jiangshan 		worker_set_flags(worker, WORKER_CPU_INTENSIVE);
3120fb0e7bebSTejun Heo 
3121974271c4STejun Heo 	/*
31220219a352STejun Heo 	 * Kick @pool if necessary. It's always noop for per-cpu worker pools
31230219a352STejun Heo 	 * since nr_running would always be >= 1 at this point. This is used to
31240219a352STejun Heo 	 * chain execution of the pending work items for WORKER_NOT_RUNNING
31250219a352STejun Heo 	 * workers such as the UNBOUND and CPU_INTENSIVE ones.
3126974271c4STejun Heo 	 */
31270219a352STejun Heo 	kick_pool(pool);
3128974271c4STejun Heo 
31298930cabaSTejun Heo 	/*
31307c3eed5cSTejun Heo 	 * Record the last pool and clear PENDING which should be the last
3131d565ed63STejun Heo 	 * update to @work.  Also, do this inside @pool->lock so that
313223657bb1STejun Heo 	 * PENDING and queued state changes happen together while IRQ is
313323657bb1STejun Heo 	 * disabled.
31348930cabaSTejun Heo 	 */
31357c3eed5cSTejun Heo 	set_work_pool_and_clear_pending(work, pool->id);
31361da177e4SLinus Torvalds 
3137fe48ba7dSMirsad Goran Todorovac 	pwq->stats[PWQ_STAT_STARTED]++;
3138a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
3139365970a1SDavid Howells 
3140c35aea39STejun Heo 	rcu_start_depth = rcu_preempt_depth();
3141c35aea39STejun Heo 	lockdep_start_depth = lockdep_depth(current);
3142a1d14934SPeter Zijlstra 	lock_map_acquire(&pwq->wq->lockdep_map);
31433295f0efSIngo Molnar 	lock_map_acquire(&lockdep_map);
3144e6f3faa7SPeter Zijlstra 	/*
3145f52be570SPeter Zijlstra 	 * Strictly speaking we should mark the invariant state without holding
3146f52be570SPeter Zijlstra 	 * any locks, that is, before these two lock_map_acquire()'s.
3147e6f3faa7SPeter Zijlstra 	 *
3148e6f3faa7SPeter Zijlstra 	 * However, that would result in:
3149e6f3faa7SPeter Zijlstra 	 *
3150e6f3faa7SPeter Zijlstra 	 *   A(W1)
3151e6f3faa7SPeter Zijlstra 	 *   WFC(C)
3152e6f3faa7SPeter Zijlstra 	 *		A(W1)
3153e6f3faa7SPeter Zijlstra 	 *		C(C)
3154e6f3faa7SPeter Zijlstra 	 *
3155e6f3faa7SPeter Zijlstra 	 * Which would create W1->C->W1 dependencies, even though there is no
3156e6f3faa7SPeter Zijlstra 	 * actual deadlock possible. There are two solutions, using a
3157e6f3faa7SPeter Zijlstra 	 * read-recursive acquire on the work(queue) 'locks', but this will then
3158f52be570SPeter Zijlstra 	 * hit the lockdep limitation on recursive locks, or simply discard
3159e6f3faa7SPeter Zijlstra 	 * these locks.
3160e6f3faa7SPeter Zijlstra 	 *
3161e6f3faa7SPeter Zijlstra 	 * AFAICT there is no possible deadlock scenario between the
3162e6f3faa7SPeter Zijlstra 	 * flush_work() and complete() primitives (except for single-threaded
3163e6f3faa7SPeter Zijlstra 	 * workqueues), so hiding them isn't a problem.
3164e6f3faa7SPeter Zijlstra 	 */
3165f52be570SPeter Zijlstra 	lockdep_invariant_state(true);
3166e36c886aSArjan van de Ven 	trace_workqueue_execute_start(work);
3167a2c1c57bSTejun Heo 	worker->current_func(work);
3168e36c886aSArjan van de Ven 	/*
3169e36c886aSArjan van de Ven 	 * While we must be careful to not use "work" after this, the trace
3170e36c886aSArjan van de Ven 	 * point will only record its address.
3171e36c886aSArjan van de Ven 	 */
31721c5da0ecSDaniel Jordan 	trace_workqueue_execute_end(work, worker->current_func);
3173725e8ec5STejun Heo 	pwq->stats[PWQ_STAT_COMPLETED]++;
31743295f0efSIngo Molnar 	lock_map_release(&lockdep_map);
3175112202d9STejun Heo 	lock_map_release(&pwq->wq->lockdep_map);
31761da177e4SLinus Torvalds 
3177c35aea39STejun Heo 	if (unlikely((worker->task && in_atomic()) ||
3178c35aea39STejun Heo 		     lockdep_depth(current) != lockdep_start_depth ||
3179c35aea39STejun Heo 		     rcu_preempt_depth() != rcu_start_depth)) {
3180c35aea39STejun Heo 		pr_err("BUG: workqueue leaked atomic, lock or RCU: %s[%d]\n"
3181c35aea39STejun Heo 		       "     preempt=0x%08x lock=%d->%d RCU=%d->%d workfn=%ps\n",
3182c35aea39STejun Heo 		       current->comm, task_pid_nr(current), preempt_count(),
3183c35aea39STejun Heo 		       lockdep_start_depth, lockdep_depth(current),
3184c35aea39STejun Heo 		       rcu_start_depth, rcu_preempt_depth(),
3185c35aea39STejun Heo 		       worker->current_func);
3186d5abe669SPeter Zijlstra 		debug_show_held_locks(current);
3187d5abe669SPeter Zijlstra 		dump_stack();
3188d5abe669SPeter Zijlstra 	}
3189d5abe669SPeter Zijlstra 
3190b22ce278STejun Heo 	/*
3191025f50f3SSebastian Andrzej Siewior 	 * The following prevents a kworker from hogging CPU on !PREEMPTION
3192b22ce278STejun Heo 	 * kernels, where a requeueing work item waiting for something to
3193b22ce278STejun Heo 	 * happen could deadlock with stop_machine as such work item could
3194b22ce278STejun Heo 	 * indefinitely requeue itself while all other CPUs are trapped in
3195789cbbecSJoe Lawrence 	 * stop_machine. At the same time, report a quiescent RCU state so
3196789cbbecSJoe Lawrence 	 * the same condition doesn't freeze RCU.
3197b22ce278STejun Heo 	 */
31984cb1ef64STejun Heo 	if (worker->task)
3199a7e6425eSPaul E. McKenney 		cond_resched();
3200b22ce278STejun Heo 
3201a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3202a62428c0STejun Heo 
3203616db877STejun Heo 	/*
3204616db877STejun Heo 	 * In addition to %WQ_CPU_INTENSIVE, @worker may also have been marked
3205616db877STejun Heo 	 * CPU intensive by wq_worker_tick() if @work hogged CPU longer than
3206616db877STejun Heo 	 * wq_cpu_intensive_thresh_us. Clear it.
3207616db877STejun Heo 	 */
3208fb0e7bebSTejun Heo 	worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
3209fb0e7bebSTejun Heo 
32101b69ac6bSJohannes Weiner 	/* tag the worker for identification in schedule() */
32111b69ac6bSJohannes Weiner 	worker->last_func = worker->current_func;
32121b69ac6bSJohannes Weiner 
3213a62428c0STejun Heo 	/* we're done with it, release */
321442f8570fSSasha Levin 	hash_del(&worker->hentry);
3215c34056a3STejun Heo 	worker->current_work = NULL;
3216a2c1c57bSTejun Heo 	worker->current_func = NULL;
3217112202d9STejun Heo 	worker->current_pwq = NULL;
3218d812796eSLai Jiangshan 	worker->current_color = INT_MAX;
3219dd6c3c54STejun Heo 
3220dd6c3c54STejun Heo 	/* must be the last step, see the function comment */
3221c4560c2cSLai Jiangshan 	pwq_dec_nr_in_flight(pwq, work_data);
32221da177e4SLinus Torvalds }
32231da177e4SLinus Torvalds 
3224affee4b2STejun Heo /**
3225affee4b2STejun Heo  * process_scheduled_works - process scheduled works
3226affee4b2STejun Heo  * @worker: self
3227affee4b2STejun Heo  *
3228affee4b2STejun Heo  * Process all scheduled works.  Please note that the scheduled list
3229affee4b2STejun Heo  * may change while processing a work, so this function repeatedly
3230affee4b2STejun Heo  * fetches a work from the top and executes it.
3231affee4b2STejun Heo  *
3232affee4b2STejun Heo  * CONTEXT:
3233a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock) which may be released and regrabbed
3234affee4b2STejun Heo  * multiple times.
3235affee4b2STejun Heo  */
3236affee4b2STejun Heo static void process_scheduled_works(struct worker *worker)
32371da177e4SLinus Torvalds {
3238c0ab017dSTejun Heo 	struct work_struct *work;
3239c0ab017dSTejun Heo 	bool first = true;
3240c0ab017dSTejun Heo 
3241c0ab017dSTejun Heo 	while ((work = list_first_entry_or_null(&worker->scheduled,
3242c0ab017dSTejun Heo 						struct work_struct, entry))) {
3243c0ab017dSTejun Heo 		if (first) {
3244c0ab017dSTejun Heo 			worker->pool->watchdog_ts = jiffies;
3245c0ab017dSTejun Heo 			first = false;
3246c0ab017dSTejun Heo 		}
3247c34056a3STejun Heo 		process_one_work(worker, work);
3248a62428c0STejun Heo 	}
32491da177e4SLinus Torvalds }
32501da177e4SLinus Torvalds 
3251197f6accSTejun Heo static void set_pf_worker(bool val)
3252197f6accSTejun Heo {
3253197f6accSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
3254197f6accSTejun Heo 	if (val)
3255197f6accSTejun Heo 		current->flags |= PF_WQ_WORKER;
3256197f6accSTejun Heo 	else
3257197f6accSTejun Heo 		current->flags &= ~PF_WQ_WORKER;
3258197f6accSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
3259197f6accSTejun Heo }
3260197f6accSTejun Heo 
32614690c4abSTejun Heo /**
32624690c4abSTejun Heo  * worker_thread - the worker thread function
3263c34056a3STejun Heo  * @__worker: self
32644690c4abSTejun Heo  *
3265c5aa87bbSTejun Heo  * The worker thread function.  All workers belong to a worker_pool -
3266c5aa87bbSTejun Heo  * either a per-cpu one or dynamic unbound one.  These workers process all
3267c5aa87bbSTejun Heo  * work items regardless of their specific target workqueue.  The only
3268c5aa87bbSTejun Heo  * exception is work items which belong to workqueues with a rescuer which
3269c5aa87bbSTejun Heo  * will be explained in rescuer_thread().
3270d185af30SYacine Belkadi  *
3271d185af30SYacine Belkadi  * Return: 0
32724690c4abSTejun Heo  */
3273c34056a3STejun Heo static int worker_thread(void *__worker)
32741da177e4SLinus Torvalds {
3275c34056a3STejun Heo 	struct worker *worker = __worker;
3276bd7bdd43STejun Heo 	struct worker_pool *pool = worker->pool;
32771da177e4SLinus Torvalds 
3278e22bee78STejun Heo 	/* tell the scheduler that this is a workqueue worker */
3279197f6accSTejun Heo 	set_pf_worker(true);
3280c8e55f36STejun Heo woke_up:
3281a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
3282affee4b2STejun Heo 
3283a9ab775bSTejun Heo 	/* am I supposed to die? */
3284a9ab775bSTejun Heo 	if (unlikely(worker->flags & WORKER_DIE)) {
3285a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
3286197f6accSTejun Heo 		set_pf_worker(false);
328760f5a4bcSLai Jiangshan 
328860f5a4bcSLai Jiangshan 		set_task_comm(worker->task, "kworker/dying");
3289e441b56fSZhen Lei 		ida_free(&pool->worker_ida, worker->id);
3290a2d812a2STejun Heo 		worker_detach_from_pool(worker);
3291e02b9312SValentin Schneider 		WARN_ON_ONCE(!list_empty(&worker->entry));
329260f5a4bcSLai Jiangshan 		kfree(worker);
3293c8e55f36STejun Heo 		return 0;
3294c8e55f36STejun Heo 	}
3295c8e55f36STejun Heo 
3296c8e55f36STejun Heo 	worker_leave_idle(worker);
3297db7bccf4STejun Heo recheck:
3298e22bee78STejun Heo 	/* no more worker necessary? */
329963d95a91STejun Heo 	if (!need_more_worker(pool))
3300e22bee78STejun Heo 		goto sleep;
3301e22bee78STejun Heo 
3302e22bee78STejun Heo 	/* do we need to manage? */
330363d95a91STejun Heo 	if (unlikely(!may_start_working(pool)) && manage_workers(worker))
3304e22bee78STejun Heo 		goto recheck;
3305e22bee78STejun Heo 
3306c8e55f36STejun Heo 	/*
3307c8e55f36STejun Heo 	 * ->scheduled list can only be filled while a worker is
3308c8e55f36STejun Heo 	 * preparing to process a work or actually processing it.
3309c8e55f36STejun Heo 	 * Make sure nobody diddled with it while I was sleeping.
3310c8e55f36STejun Heo 	 */
33116183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
3312c8e55f36STejun Heo 
3313e22bee78STejun Heo 	/*
3314a9ab775bSTejun Heo 	 * Finish PREP stage.  We're guaranteed to have at least one idle
3315a9ab775bSTejun Heo 	 * worker or that someone else has already assumed the manager
3316a9ab775bSTejun Heo 	 * role.  This is where @worker starts participating in concurrency
3317a9ab775bSTejun Heo 	 * management if applicable and concurrency management is restored
3318a9ab775bSTejun Heo 	 * after being rebound.  See rebind_workers() for details.
3319e22bee78STejun Heo 	 */
3320a9ab775bSTejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
3321e22bee78STejun Heo 
3322e22bee78STejun Heo 	do {
3323affee4b2STejun Heo 		struct work_struct *work =
3324bd7bdd43STejun Heo 			list_first_entry(&pool->worklist,
3325affee4b2STejun Heo 					 struct work_struct, entry);
3326affee4b2STejun Heo 
3327873eaca6STejun Heo 		if (assign_work(work, worker, NULL))
3328affee4b2STejun Heo 			process_scheduled_works(worker);
332963d95a91STejun Heo 	} while (keep_working(pool));
3330affee4b2STejun Heo 
3331228f1d00SLai Jiangshan 	worker_set_flags(worker, WORKER_PREP);
3332d313dd85STejun Heo sleep:
3333c8e55f36STejun Heo 	/*
3334d565ed63STejun Heo 	 * pool->lock is held and there's no work to process and no need to
3335d565ed63STejun Heo 	 * manage, sleep.  Workers are woken up only while holding
3336d565ed63STejun Heo 	 * pool->lock or from local cpu, so setting the current state
3337d565ed63STejun Heo 	 * before releasing pool->lock is enough to prevent losing any
3338d565ed63STejun Heo 	 * event.
3339c8e55f36STejun Heo 	 */
3340c8e55f36STejun Heo 	worker_enter_idle(worker);
3341c5a94a61SPeter Zijlstra 	__set_current_state(TASK_IDLE);
3342a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
33431da177e4SLinus Torvalds 	schedule();
3344c8e55f36STejun Heo 	goto woke_up;
33451da177e4SLinus Torvalds }
33461da177e4SLinus Torvalds 
3347e22bee78STejun Heo /**
3348e22bee78STejun Heo  * rescuer_thread - the rescuer thread function
3349111c225aSTejun Heo  * @__rescuer: self
3350e22bee78STejun Heo  *
3351e22bee78STejun Heo  * Workqueue rescuer thread function.  There's one rescuer for each
3352493008a8STejun Heo  * workqueue which has WQ_MEM_RECLAIM set.
3353e22bee78STejun Heo  *
3354706026c2STejun Heo  * Regular work processing on a pool may block trying to create a new
3355e22bee78STejun Heo  * worker which uses GFP_KERNEL allocation which has slight chance of
3356e22bee78STejun Heo  * developing into deadlock if some works currently on the same queue
3357e22bee78STejun Heo  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
3358e22bee78STejun Heo  * the problem rescuer solves.
3359e22bee78STejun Heo  *
3360706026c2STejun Heo  * When such condition is possible, the pool summons rescuers of all
3361706026c2STejun Heo  * workqueues which have works queued on the pool and let them process
3362e22bee78STejun Heo  * those works so that forward progress can be guaranteed.
3363e22bee78STejun Heo  *
3364e22bee78STejun Heo  * This should happen rarely.
3365d185af30SYacine Belkadi  *
3366d185af30SYacine Belkadi  * Return: 0
3367e22bee78STejun Heo  */
3368111c225aSTejun Heo static int rescuer_thread(void *__rescuer)
3369e22bee78STejun Heo {
3370111c225aSTejun Heo 	struct worker *rescuer = __rescuer;
3371111c225aSTejun Heo 	struct workqueue_struct *wq = rescuer->rescue_wq;
33724d595b86SLai Jiangshan 	bool should_stop;
3373e22bee78STejun Heo 
3374e22bee78STejun Heo 	set_user_nice(current, RESCUER_NICE_LEVEL);
3375111c225aSTejun Heo 
3376111c225aSTejun Heo 	/*
3377111c225aSTejun Heo 	 * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
3378111c225aSTejun Heo 	 * doesn't participate in concurrency management.
3379111c225aSTejun Heo 	 */
3380197f6accSTejun Heo 	set_pf_worker(true);
3381e22bee78STejun Heo repeat:
3382c5a94a61SPeter Zijlstra 	set_current_state(TASK_IDLE);
33831da177e4SLinus Torvalds 
33844d595b86SLai Jiangshan 	/*
33854d595b86SLai Jiangshan 	 * By the time the rescuer is requested to stop, the workqueue
33864d595b86SLai Jiangshan 	 * shouldn't have any work pending, but @wq->maydays may still have
33874d595b86SLai Jiangshan 	 * pwq(s) queued.  This can happen by non-rescuer workers consuming
33884d595b86SLai Jiangshan 	 * all the work items before the rescuer got to them.  Go through
33894d595b86SLai Jiangshan 	 * @wq->maydays processing before acting on should_stop so that the
33904d595b86SLai Jiangshan 	 * list is always empty on exit.
33914d595b86SLai Jiangshan 	 */
33924d595b86SLai Jiangshan 	should_stop = kthread_should_stop();
33931da177e4SLinus Torvalds 
3394493a1724STejun Heo 	/* see whether any pwq is asking for help */
3395a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&wq_mayday_lock);
3396493a1724STejun Heo 
3397493a1724STejun Heo 	while (!list_empty(&wq->maydays)) {
3398493a1724STejun Heo 		struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
3399493a1724STejun Heo 					struct pool_workqueue, mayday_node);
3400112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
3401e22bee78STejun Heo 		struct work_struct *work, *n;
3402e22bee78STejun Heo 
3403e22bee78STejun Heo 		__set_current_state(TASK_RUNNING);
3404493a1724STejun Heo 		list_del_init(&pwq->mayday_node);
3405493a1724STejun Heo 
3406a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
3407e22bee78STejun Heo 
340851697d39SLai Jiangshan 		worker_attach_to_pool(rescuer, pool);
340951697d39SLai Jiangshan 
3410a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
3411e22bee78STejun Heo 
3412e22bee78STejun Heo 		/*
3413e22bee78STejun Heo 		 * Slurp in all works issued via this workqueue and
3414e22bee78STejun Heo 		 * process'em.
3415e22bee78STejun Heo 		 */
3416873eaca6STejun Heo 		WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
341782607adcSTejun Heo 		list_for_each_entry_safe(work, n, &pool->worklist, entry) {
3418873eaca6STejun Heo 			if (get_work_pwq(work) == pwq &&
3419873eaca6STejun Heo 			    assign_work(work, rescuer, &n))
3420725e8ec5STejun Heo 				pwq->stats[PWQ_STAT_RESCUED]++;
342182607adcSTejun Heo 		}
3422e22bee78STejun Heo 
3423873eaca6STejun Heo 		if (!list_empty(&rescuer->scheduled)) {
3424e22bee78STejun Heo 			process_scheduled_works(rescuer);
34257576958aSTejun Heo 
34267576958aSTejun Heo 			/*
3427008847f6SNeilBrown 			 * The above execution of rescued work items could
3428008847f6SNeilBrown 			 * have created more to rescue through
3429f97a4a1aSLai Jiangshan 			 * pwq_activate_first_inactive() or chained
3430008847f6SNeilBrown 			 * queueing.  Let's put @pwq back on mayday list so
3431008847f6SNeilBrown 			 * that such back-to-back work items, which may be
3432008847f6SNeilBrown 			 * being used to relieve memory pressure, don't
3433008847f6SNeilBrown 			 * incur MAYDAY_INTERVAL delay inbetween.
3434008847f6SNeilBrown 			 */
34354f3f4cf3SLai Jiangshan 			if (pwq->nr_active && need_to_create_worker(pool)) {
3436a9b8a985SSebastian Andrzej Siewior 				raw_spin_lock(&wq_mayday_lock);
3437e66b39afSTejun Heo 				/*
3438e66b39afSTejun Heo 				 * Queue iff we aren't racing destruction
3439e66b39afSTejun Heo 				 * and somebody else hasn't queued it already.
3440e66b39afSTejun Heo 				 */
3441e66b39afSTejun Heo 				if (wq->rescuer && list_empty(&pwq->mayday_node)) {
3442008847f6SNeilBrown 					get_pwq(pwq);
3443e66b39afSTejun Heo 					list_add_tail(&pwq->mayday_node, &wq->maydays);
3444e66b39afSTejun Heo 				}
3445a9b8a985SSebastian Andrzej Siewior 				raw_spin_unlock(&wq_mayday_lock);
3446008847f6SNeilBrown 			}
3447008847f6SNeilBrown 		}
3448008847f6SNeilBrown 
3449008847f6SNeilBrown 		/*
345077668c8bSLai Jiangshan 		 * Put the reference grabbed by send_mayday().  @pool won't
345113b1d625SLai Jiangshan 		 * go away while we're still attached to it.
345277668c8bSLai Jiangshan 		 */
345377668c8bSLai Jiangshan 		put_pwq(pwq);
345477668c8bSLai Jiangshan 
345577668c8bSLai Jiangshan 		/*
34560219a352STejun Heo 		 * Leave this pool. Notify regular workers; otherwise, we end up
34570219a352STejun Heo 		 * with 0 concurrency and stalling the execution.
34587576958aSTejun Heo 		 */
34590219a352STejun Heo 		kick_pool(pool);
34607576958aSTejun Heo 
3461a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
346213b1d625SLai Jiangshan 
3463a2d812a2STejun Heo 		worker_detach_from_pool(rescuer);
346413b1d625SLai Jiangshan 
3465a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
34661da177e4SLinus Torvalds 	}
34671da177e4SLinus Torvalds 
3468a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&wq_mayday_lock);
3469493a1724STejun Heo 
34704d595b86SLai Jiangshan 	if (should_stop) {
34714d595b86SLai Jiangshan 		__set_current_state(TASK_RUNNING);
3472197f6accSTejun Heo 		set_pf_worker(false);
34734d595b86SLai Jiangshan 		return 0;
34744d595b86SLai Jiangshan 	}
34754d595b86SLai Jiangshan 
3476111c225aSTejun Heo 	/* rescuers should never participate in concurrency management */
3477111c225aSTejun Heo 	WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
3478e22bee78STejun Heo 	schedule();
3479e22bee78STejun Heo 	goto repeat;
34801da177e4SLinus Torvalds }
34811da177e4SLinus Torvalds 
34824cb1ef64STejun Heo static void bh_worker(struct worker *worker)
34834cb1ef64STejun Heo {
34844cb1ef64STejun Heo 	struct worker_pool *pool = worker->pool;
34854cb1ef64STejun Heo 	int nr_restarts = BH_WORKER_RESTARTS;
34864cb1ef64STejun Heo 	unsigned long end = jiffies + BH_WORKER_JIFFIES;
34874cb1ef64STejun Heo 
34884cb1ef64STejun Heo 	raw_spin_lock_irq(&pool->lock);
34894cb1ef64STejun Heo 	worker_leave_idle(worker);
34904cb1ef64STejun Heo 
34914cb1ef64STejun Heo 	/*
34924cb1ef64STejun Heo 	 * This function follows the structure of worker_thread(). See there for
34934cb1ef64STejun Heo 	 * explanations on each step.
34944cb1ef64STejun Heo 	 */
34954cb1ef64STejun Heo 	if (!need_more_worker(pool))
34964cb1ef64STejun Heo 		goto done;
34974cb1ef64STejun Heo 
34984cb1ef64STejun Heo 	WARN_ON_ONCE(!list_empty(&worker->scheduled));
34994cb1ef64STejun Heo 	worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
35004cb1ef64STejun Heo 
35014cb1ef64STejun Heo 	do {
35024cb1ef64STejun Heo 		struct work_struct *work =
35034cb1ef64STejun Heo 			list_first_entry(&pool->worklist,
35044cb1ef64STejun Heo 					 struct work_struct, entry);
35054cb1ef64STejun Heo 
35064cb1ef64STejun Heo 		if (assign_work(work, worker, NULL))
35074cb1ef64STejun Heo 			process_scheduled_works(worker);
35084cb1ef64STejun Heo 	} while (keep_working(pool) &&
35094cb1ef64STejun Heo 		 --nr_restarts && time_before(jiffies, end));
35104cb1ef64STejun Heo 
35114cb1ef64STejun Heo 	worker_set_flags(worker, WORKER_PREP);
35124cb1ef64STejun Heo done:
35134cb1ef64STejun Heo 	worker_enter_idle(worker);
35144cb1ef64STejun Heo 	kick_pool(pool);
35154cb1ef64STejun Heo 	raw_spin_unlock_irq(&pool->lock);
35164cb1ef64STejun Heo }
35174cb1ef64STejun Heo 
35184cb1ef64STejun Heo /*
35194cb1ef64STejun Heo  * TODO: Convert all tasklet users to workqueue and use softirq directly.
35204cb1ef64STejun Heo  *
35214cb1ef64STejun Heo  * This is currently called from tasklet[_hi]action() and thus is also called
35224cb1ef64STejun Heo  * whenever there are tasklets to run. Let's do an early exit if there's nothing
35234cb1ef64STejun Heo  * queued. Once conversion from tasklet is complete, the need_more_worker() test
35244cb1ef64STejun Heo  * can be dropped.
35254cb1ef64STejun Heo  *
35264cb1ef64STejun Heo  * After full conversion, we'll add worker->softirq_action, directly use the
35274cb1ef64STejun Heo  * softirq action and obtain the worker pointer from the softirq_action pointer.
35284cb1ef64STejun Heo  */
35294cb1ef64STejun Heo void workqueue_softirq_action(bool highpri)
35304cb1ef64STejun Heo {
35314cb1ef64STejun Heo 	struct worker_pool *pool =
35324cb1ef64STejun Heo 		&per_cpu(bh_worker_pools, smp_processor_id())[highpri];
35334cb1ef64STejun Heo 	if (need_more_worker(pool))
35344cb1ef64STejun Heo 		bh_worker(list_first_entry(&pool->workers, struct worker, node));
35354cb1ef64STejun Heo }
35364cb1ef64STejun Heo 
3537fca839c0STejun Heo /**
3538fca839c0STejun Heo  * check_flush_dependency - check for flush dependency sanity
3539fca839c0STejun Heo  * @target_wq: workqueue being flushed
3540fca839c0STejun Heo  * @target_work: work item being flushed (NULL for workqueue flushes)
3541fca839c0STejun Heo  *
3542fca839c0STejun Heo  * %current is trying to flush the whole @target_wq or @target_work on it.
3543fca839c0STejun Heo  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
3544fca839c0STejun Heo  * reclaiming memory or running on a workqueue which doesn't have
3545fca839c0STejun Heo  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
3546fca839c0STejun Heo  * a deadlock.
3547fca839c0STejun Heo  */
3548fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq,
3549fca839c0STejun Heo 				   struct work_struct *target_work)
3550fca839c0STejun Heo {
3551fca839c0STejun Heo 	work_func_t target_func = target_work ? target_work->func : NULL;
3552fca839c0STejun Heo 	struct worker *worker;
3553fca839c0STejun Heo 
3554fca839c0STejun Heo 	if (target_wq->flags & WQ_MEM_RECLAIM)
3555fca839c0STejun Heo 		return;
3556fca839c0STejun Heo 
3557fca839c0STejun Heo 	worker = current_wq_worker();
3558fca839c0STejun Heo 
3559fca839c0STejun Heo 	WARN_ONCE(current->flags & PF_MEMALLOC,
3560d75f773cSSakari Ailus 		  "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps",
3561fca839c0STejun Heo 		  current->pid, current->comm, target_wq->name, target_func);
356223d11a58STejun Heo 	WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
356323d11a58STejun Heo 			      (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
3564d75f773cSSakari Ailus 		  "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps",
3565fca839c0STejun Heo 		  worker->current_pwq->wq->name, worker->current_func,
3566fca839c0STejun Heo 		  target_wq->name, target_func);
3567fca839c0STejun Heo }
3568fca839c0STejun Heo 
3569fc2e4d70SOleg Nesterov struct wq_barrier {
3570fc2e4d70SOleg Nesterov 	struct work_struct	work;
3571fc2e4d70SOleg Nesterov 	struct completion	done;
35722607d7a6STejun Heo 	struct task_struct	*task;	/* purely informational */
3573fc2e4d70SOleg Nesterov };
3574fc2e4d70SOleg Nesterov 
3575fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work)
3576fc2e4d70SOleg Nesterov {
3577fc2e4d70SOleg Nesterov 	struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
3578fc2e4d70SOleg Nesterov 	complete(&barr->done);
3579fc2e4d70SOleg Nesterov }
3580fc2e4d70SOleg Nesterov 
35814690c4abSTejun Heo /**
35824690c4abSTejun Heo  * insert_wq_barrier - insert a barrier work
3583112202d9STejun Heo  * @pwq: pwq to insert barrier into
35844690c4abSTejun Heo  * @barr: wq_barrier to insert
3585affee4b2STejun Heo  * @target: target work to attach @barr to
3586affee4b2STejun Heo  * @worker: worker currently executing @target, NULL if @target is not executing
35874690c4abSTejun Heo  *
3588affee4b2STejun Heo  * @barr is linked to @target such that @barr is completed only after
3589affee4b2STejun Heo  * @target finishes execution.  Please note that the ordering
3590affee4b2STejun Heo  * guarantee is observed only with respect to @target and on the local
3591affee4b2STejun Heo  * cpu.
3592affee4b2STejun Heo  *
3593affee4b2STejun Heo  * Currently, a queued barrier can't be canceled.  This is because
3594affee4b2STejun Heo  * try_to_grab_pending() can't determine whether the work to be
3595affee4b2STejun Heo  * grabbed is at the head of the queue and thus can't clear LINKED
3596affee4b2STejun Heo  * flag of the previous work while there must be a valid next work
3597affee4b2STejun Heo  * after a work with LINKED flag set.
3598affee4b2STejun Heo  *
3599affee4b2STejun Heo  * Note that when @worker is non-NULL, @target may be modified
3600112202d9STejun Heo  * underneath us, so we can't reliably determine pwq from @target.
36014690c4abSTejun Heo  *
36024690c4abSTejun Heo  * CONTEXT:
3603a9b8a985SSebastian Andrzej Siewior  * raw_spin_lock_irq(pool->lock).
36044690c4abSTejun Heo  */
3605112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq,
3606affee4b2STejun Heo 			      struct wq_barrier *barr,
3607affee4b2STejun Heo 			      struct work_struct *target, struct worker *worker)
3608fc2e4d70SOleg Nesterov {
36094cb1ef64STejun Heo 	static __maybe_unused struct lock_class_key bh_key, thr_key;
3610d812796eSLai Jiangshan 	unsigned int work_flags = 0;
3611d812796eSLai Jiangshan 	unsigned int work_color;
3612affee4b2STejun Heo 	struct list_head *head;
3613affee4b2STejun Heo 
3614dc186ad7SThomas Gleixner 	/*
3615d565ed63STejun Heo 	 * debugobject calls are safe here even with pool->lock locked
3616dc186ad7SThomas Gleixner 	 * as we know for sure that this will not trigger any of the
3617dc186ad7SThomas Gleixner 	 * checks and call back into the fixup functions where we
3618dc186ad7SThomas Gleixner 	 * might deadlock.
36194cb1ef64STejun Heo 	 *
36204cb1ef64STejun Heo 	 * BH and threaded workqueues need separate lockdep keys to avoid
36214cb1ef64STejun Heo 	 * spuriously triggering "inconsistent {SOFTIRQ-ON-W} -> {IN-SOFTIRQ-W}
36224cb1ef64STejun Heo 	 * usage".
3623dc186ad7SThomas Gleixner 	 */
36244cb1ef64STejun Heo 	INIT_WORK_ONSTACK_KEY(&barr->work, wq_barrier_func,
36254cb1ef64STejun Heo 			      (pwq->wq->flags & WQ_BH) ? &bh_key : &thr_key);
362622df02bbSTejun Heo 	__set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
362752fa5bc5SBoqun Feng 
3628fd1a5b04SByungchul Park 	init_completion_map(&barr->done, &target->lockdep_map);
3629fd1a5b04SByungchul Park 
36302607d7a6STejun Heo 	barr->task = current;
363183c22520SOleg Nesterov 
36325797b1c1STejun Heo 	/* The barrier work item does not participate in nr_active. */
3633018f3a13SLai Jiangshan 	work_flags |= WORK_STRUCT_INACTIVE;
3634018f3a13SLai Jiangshan 
3635affee4b2STejun Heo 	/*
3636affee4b2STejun Heo 	 * If @target is currently being executed, schedule the
3637affee4b2STejun Heo 	 * barrier to the worker; otherwise, put it after @target.
3638affee4b2STejun Heo 	 */
3639d812796eSLai Jiangshan 	if (worker) {
3640affee4b2STejun Heo 		head = worker->scheduled.next;
3641d812796eSLai Jiangshan 		work_color = worker->current_color;
3642d812796eSLai Jiangshan 	} else {
3643affee4b2STejun Heo 		unsigned long *bits = work_data_bits(target);
3644affee4b2STejun Heo 
3645affee4b2STejun Heo 		head = target->entry.next;
3646affee4b2STejun Heo 		/* there can already be other linked works, inherit and set */
3647d21cece0SLai Jiangshan 		work_flags |= *bits & WORK_STRUCT_LINKED;
3648d812796eSLai Jiangshan 		work_color = get_work_color(*bits);
3649affee4b2STejun Heo 		__set_bit(WORK_STRUCT_LINKED_BIT, bits);
3650affee4b2STejun Heo 	}
3651affee4b2STejun Heo 
3652d812796eSLai Jiangshan 	pwq->nr_in_flight[work_color]++;
3653d812796eSLai Jiangshan 	work_flags |= work_color_to_flags(work_color);
3654d812796eSLai Jiangshan 
3655d21cece0SLai Jiangshan 	insert_work(pwq, &barr->work, head, work_flags);
3656fc2e4d70SOleg Nesterov }
3657fc2e4d70SOleg Nesterov 
365873f53c4aSTejun Heo /**
3659112202d9STejun Heo  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
366073f53c4aSTejun Heo  * @wq: workqueue being flushed
366173f53c4aSTejun Heo  * @flush_color: new flush color, < 0 for no-op
366273f53c4aSTejun Heo  * @work_color: new work color, < 0 for no-op
366373f53c4aSTejun Heo  *
3664112202d9STejun Heo  * Prepare pwqs for workqueue flushing.
366573f53c4aSTejun Heo  *
3666112202d9STejun Heo  * If @flush_color is non-negative, flush_color on all pwqs should be
3667112202d9STejun Heo  * -1.  If no pwq has in-flight commands at the specified color, all
3668112202d9STejun Heo  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
3669112202d9STejun Heo  * has in flight commands, its pwq->flush_color is set to
3670112202d9STejun Heo  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
367173f53c4aSTejun Heo  * wakeup logic is armed and %true is returned.
367273f53c4aSTejun Heo  *
367373f53c4aSTejun Heo  * The caller should have initialized @wq->first_flusher prior to
367473f53c4aSTejun Heo  * calling this function with non-negative @flush_color.  If
367573f53c4aSTejun Heo  * @flush_color is negative, no flush color update is done and %false
367673f53c4aSTejun Heo  * is returned.
367773f53c4aSTejun Heo  *
3678112202d9STejun Heo  * If @work_color is non-negative, all pwqs should have the same
367973f53c4aSTejun Heo  * work_color which is previous to @work_color and all will be
368073f53c4aSTejun Heo  * advanced to @work_color.
368173f53c4aSTejun Heo  *
368273f53c4aSTejun Heo  * CONTEXT:
36833c25a55dSLai Jiangshan  * mutex_lock(wq->mutex).
368473f53c4aSTejun Heo  *
3685d185af30SYacine Belkadi  * Return:
368673f53c4aSTejun Heo  * %true if @flush_color >= 0 and there's something to flush.  %false
368773f53c4aSTejun Heo  * otherwise.
368873f53c4aSTejun Heo  */
3689112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
369073f53c4aSTejun Heo 				      int flush_color, int work_color)
36911da177e4SLinus Torvalds {
369273f53c4aSTejun Heo 	bool wait = false;
369349e3cf44STejun Heo 	struct pool_workqueue *pwq;
36941da177e4SLinus Torvalds 
369573f53c4aSTejun Heo 	if (flush_color >= 0) {
36966183c009STejun Heo 		WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
3697112202d9STejun Heo 		atomic_set(&wq->nr_pwqs_to_flush, 1);
3698dc186ad7SThomas Gleixner 	}
369914441960SOleg Nesterov 
370049e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3701112202d9STejun Heo 		struct worker_pool *pool = pwq->pool;
37021da177e4SLinus Torvalds 
3703a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
370473f53c4aSTejun Heo 
370573f53c4aSTejun Heo 		if (flush_color >= 0) {
37066183c009STejun Heo 			WARN_ON_ONCE(pwq->flush_color != -1);
370773f53c4aSTejun Heo 
3708112202d9STejun Heo 			if (pwq->nr_in_flight[flush_color]) {
3709112202d9STejun Heo 				pwq->flush_color = flush_color;
3710112202d9STejun Heo 				atomic_inc(&wq->nr_pwqs_to_flush);
371173f53c4aSTejun Heo 				wait = true;
37121da177e4SLinus Torvalds 			}
371373f53c4aSTejun Heo 		}
371473f53c4aSTejun Heo 
371573f53c4aSTejun Heo 		if (work_color >= 0) {
37166183c009STejun Heo 			WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
3717112202d9STejun Heo 			pwq->work_color = work_color;
371873f53c4aSTejun Heo 		}
371973f53c4aSTejun Heo 
3720a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
37211da177e4SLinus Torvalds 	}
37221da177e4SLinus Torvalds 
3723112202d9STejun Heo 	if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
372473f53c4aSTejun Heo 		complete(&wq->first_flusher->done);
372573f53c4aSTejun Heo 
372673f53c4aSTejun Heo 	return wait;
372783c22520SOleg Nesterov }
37281da177e4SLinus Torvalds 
3729c35aea39STejun Heo static void touch_wq_lockdep_map(struct workqueue_struct *wq)
3730c35aea39STejun Heo {
37314cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP
37324cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
37334cb1ef64STejun Heo 		local_bh_disable();
37344cb1ef64STejun Heo 
3735c35aea39STejun Heo 	lock_map_acquire(&wq->lockdep_map);
3736c35aea39STejun Heo 	lock_map_release(&wq->lockdep_map);
37374cb1ef64STejun Heo 
37384cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
37394cb1ef64STejun Heo 		local_bh_enable();
37404cb1ef64STejun Heo #endif
3741c35aea39STejun Heo }
3742c35aea39STejun Heo 
3743c35aea39STejun Heo static void touch_work_lockdep_map(struct work_struct *work,
3744c35aea39STejun Heo 				   struct workqueue_struct *wq)
3745c35aea39STejun Heo {
37464cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP
37474cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
37484cb1ef64STejun Heo 		local_bh_disable();
37494cb1ef64STejun Heo 
3750c35aea39STejun Heo 	lock_map_acquire(&work->lockdep_map);
3751c35aea39STejun Heo 	lock_map_release(&work->lockdep_map);
37524cb1ef64STejun Heo 
37534cb1ef64STejun Heo 	if (wq->flags & WQ_BH)
37544cb1ef64STejun Heo 		local_bh_enable();
37554cb1ef64STejun Heo #endif
3756c35aea39STejun Heo }
3757c35aea39STejun Heo 
37580fcb78c2SRolf Eike Beer /**
3759c4f135d6STetsuo Handa  * __flush_workqueue - ensure that any scheduled work has run to completion.
37600fcb78c2SRolf Eike Beer  * @wq: workqueue to flush
37611da177e4SLinus Torvalds  *
3762c5aa87bbSTejun Heo  * This function sleeps until all work items which were queued on entry
3763c5aa87bbSTejun Heo  * have finished execution, but it is not livelocked by new incoming ones.
37641da177e4SLinus Torvalds  */
3765c4f135d6STetsuo Handa void __flush_workqueue(struct workqueue_struct *wq)
37661da177e4SLinus Torvalds {
376773f53c4aSTejun Heo 	struct wq_flusher this_flusher = {
376873f53c4aSTejun Heo 		.list = LIST_HEAD_INIT(this_flusher.list),
376973f53c4aSTejun Heo 		.flush_color = -1,
3770fd1a5b04SByungchul Park 		.done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
377173f53c4aSTejun Heo 	};
377273f53c4aSTejun Heo 	int next_color;
3773b1f4ec17SOleg Nesterov 
37743347fa09STejun Heo 	if (WARN_ON(!wq_online))
37753347fa09STejun Heo 		return;
37763347fa09STejun Heo 
3777c35aea39STejun Heo 	touch_wq_lockdep_map(wq);
377887915adcSJohannes Berg 
37793c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
378073f53c4aSTejun Heo 
378173f53c4aSTejun Heo 	/*
378273f53c4aSTejun Heo 	 * Start-to-wait phase
378373f53c4aSTejun Heo 	 */
378473f53c4aSTejun Heo 	next_color = work_next_color(wq->work_color);
378573f53c4aSTejun Heo 
378673f53c4aSTejun Heo 	if (next_color != wq->flush_color) {
378773f53c4aSTejun Heo 		/*
378873f53c4aSTejun Heo 		 * Color space is not full.  The current work_color
378973f53c4aSTejun Heo 		 * becomes our flush_color and work_color is advanced
379073f53c4aSTejun Heo 		 * by one.
379173f53c4aSTejun Heo 		 */
37926183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
379373f53c4aSTejun Heo 		this_flusher.flush_color = wq->work_color;
379473f53c4aSTejun Heo 		wq->work_color = next_color;
379573f53c4aSTejun Heo 
379673f53c4aSTejun Heo 		if (!wq->first_flusher) {
379773f53c4aSTejun Heo 			/* no flush in progress, become the first flusher */
37986183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
379973f53c4aSTejun Heo 
380073f53c4aSTejun Heo 			wq->first_flusher = &this_flusher;
380173f53c4aSTejun Heo 
3802112202d9STejun Heo 			if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
380373f53c4aSTejun Heo 						       wq->work_color)) {
380473f53c4aSTejun Heo 				/* nothing to flush, done */
380573f53c4aSTejun Heo 				wq->flush_color = next_color;
380673f53c4aSTejun Heo 				wq->first_flusher = NULL;
380773f53c4aSTejun Heo 				goto out_unlock;
380873f53c4aSTejun Heo 			}
380973f53c4aSTejun Heo 		} else {
381073f53c4aSTejun Heo 			/* wait in queue */
38116183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
381273f53c4aSTejun Heo 			list_add_tail(&this_flusher.list, &wq->flusher_queue);
3813112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
381473f53c4aSTejun Heo 		}
381573f53c4aSTejun Heo 	} else {
381673f53c4aSTejun Heo 		/*
381773f53c4aSTejun Heo 		 * Oops, color space is full, wait on overflow queue.
381873f53c4aSTejun Heo 		 * The next flush completion will assign us
381973f53c4aSTejun Heo 		 * flush_color and transfer to flusher_queue.
382073f53c4aSTejun Heo 		 */
382173f53c4aSTejun Heo 		list_add_tail(&this_flusher.list, &wq->flusher_overflow);
382273f53c4aSTejun Heo 	}
382373f53c4aSTejun Heo 
3824fca839c0STejun Heo 	check_flush_dependency(wq, NULL);
3825fca839c0STejun Heo 
38263c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
382773f53c4aSTejun Heo 
382873f53c4aSTejun Heo 	wait_for_completion(&this_flusher.done);
382973f53c4aSTejun Heo 
383073f53c4aSTejun Heo 	/*
383173f53c4aSTejun Heo 	 * Wake-up-and-cascade phase
383273f53c4aSTejun Heo 	 *
383373f53c4aSTejun Heo 	 * First flushers are responsible for cascading flushes and
383473f53c4aSTejun Heo 	 * handling overflow.  Non-first flushers can simply return.
383573f53c4aSTejun Heo 	 */
383600d5d15bSChris Wilson 	if (READ_ONCE(wq->first_flusher) != &this_flusher)
383773f53c4aSTejun Heo 		return;
383873f53c4aSTejun Heo 
38393c25a55dSLai Jiangshan 	mutex_lock(&wq->mutex);
384073f53c4aSTejun Heo 
38414ce48b37STejun Heo 	/* we might have raced, check again with mutex held */
38424ce48b37STejun Heo 	if (wq->first_flusher != &this_flusher)
38434ce48b37STejun Heo 		goto out_unlock;
38444ce48b37STejun Heo 
384500d5d15bSChris Wilson 	WRITE_ONCE(wq->first_flusher, NULL);
384673f53c4aSTejun Heo 
38476183c009STejun Heo 	WARN_ON_ONCE(!list_empty(&this_flusher.list));
38486183c009STejun Heo 	WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
384973f53c4aSTejun Heo 
385073f53c4aSTejun Heo 	while (true) {
385173f53c4aSTejun Heo 		struct wq_flusher *next, *tmp;
385273f53c4aSTejun Heo 
385373f53c4aSTejun Heo 		/* complete all the flushers sharing the current flush color */
385473f53c4aSTejun Heo 		list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
385573f53c4aSTejun Heo 			if (next->flush_color != wq->flush_color)
385673f53c4aSTejun Heo 				break;
385773f53c4aSTejun Heo 			list_del_init(&next->list);
385873f53c4aSTejun Heo 			complete(&next->done);
385973f53c4aSTejun Heo 		}
386073f53c4aSTejun Heo 
38616183c009STejun Heo 		WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
386273f53c4aSTejun Heo 			     wq->flush_color != work_next_color(wq->work_color));
386373f53c4aSTejun Heo 
386473f53c4aSTejun Heo 		/* this flush_color is finished, advance by one */
386573f53c4aSTejun Heo 		wq->flush_color = work_next_color(wq->flush_color);
386673f53c4aSTejun Heo 
386773f53c4aSTejun Heo 		/* one color has been freed, handle overflow queue */
386873f53c4aSTejun Heo 		if (!list_empty(&wq->flusher_overflow)) {
386973f53c4aSTejun Heo 			/*
387073f53c4aSTejun Heo 			 * Assign the same color to all overflowed
387173f53c4aSTejun Heo 			 * flushers, advance work_color and append to
387273f53c4aSTejun Heo 			 * flusher_queue.  This is the start-to-wait
387373f53c4aSTejun Heo 			 * phase for these overflowed flushers.
387473f53c4aSTejun Heo 			 */
387573f53c4aSTejun Heo 			list_for_each_entry(tmp, &wq->flusher_overflow, list)
387673f53c4aSTejun Heo 				tmp->flush_color = wq->work_color;
387773f53c4aSTejun Heo 
387873f53c4aSTejun Heo 			wq->work_color = work_next_color(wq->work_color);
387973f53c4aSTejun Heo 
388073f53c4aSTejun Heo 			list_splice_tail_init(&wq->flusher_overflow,
388173f53c4aSTejun Heo 					      &wq->flusher_queue);
3882112202d9STejun Heo 			flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
388373f53c4aSTejun Heo 		}
388473f53c4aSTejun Heo 
388573f53c4aSTejun Heo 		if (list_empty(&wq->flusher_queue)) {
38866183c009STejun Heo 			WARN_ON_ONCE(wq->flush_color != wq->work_color);
388773f53c4aSTejun Heo 			break;
388873f53c4aSTejun Heo 		}
388973f53c4aSTejun Heo 
389073f53c4aSTejun Heo 		/*
389173f53c4aSTejun Heo 		 * Need to flush more colors.  Make the next flusher
3892112202d9STejun Heo 		 * the new first flusher and arm pwqs.
389373f53c4aSTejun Heo 		 */
38946183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color == wq->work_color);
38956183c009STejun Heo 		WARN_ON_ONCE(wq->flush_color != next->flush_color);
389673f53c4aSTejun Heo 
389773f53c4aSTejun Heo 		list_del_init(&next->list);
389873f53c4aSTejun Heo 		wq->first_flusher = next;
389973f53c4aSTejun Heo 
3900112202d9STejun Heo 		if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
390173f53c4aSTejun Heo 			break;
390273f53c4aSTejun Heo 
390373f53c4aSTejun Heo 		/*
390473f53c4aSTejun Heo 		 * Meh... this color is already done, clear first
390573f53c4aSTejun Heo 		 * flusher and repeat cascading.
390673f53c4aSTejun Heo 		 */
390773f53c4aSTejun Heo 		wq->first_flusher = NULL;
390873f53c4aSTejun Heo 	}
390973f53c4aSTejun Heo 
391073f53c4aSTejun Heo out_unlock:
39113c25a55dSLai Jiangshan 	mutex_unlock(&wq->mutex);
39121da177e4SLinus Torvalds }
3913c4f135d6STetsuo Handa EXPORT_SYMBOL(__flush_workqueue);
39141da177e4SLinus Torvalds 
39159c5a2ba7STejun Heo /**
39169c5a2ba7STejun Heo  * drain_workqueue - drain a workqueue
39179c5a2ba7STejun Heo  * @wq: workqueue to drain
39189c5a2ba7STejun Heo  *
39199c5a2ba7STejun Heo  * Wait until the workqueue becomes empty.  While draining is in progress,
39209c5a2ba7STejun Heo  * only chain queueing is allowed.  IOW, only currently pending or running
39219c5a2ba7STejun Heo  * work items on @wq can queue further work items on it.  @wq is flushed
3922b749b1b6SChen Hanxiao  * repeatedly until it becomes empty.  The number of flushing is determined
39239c5a2ba7STejun Heo  * by the depth of chaining and should be relatively short.  Whine if it
39249c5a2ba7STejun Heo  * takes too long.
39259c5a2ba7STejun Heo  */
39269c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq)
39279c5a2ba7STejun Heo {
39289c5a2ba7STejun Heo 	unsigned int flush_cnt = 0;
392949e3cf44STejun Heo 	struct pool_workqueue *pwq;
39309c5a2ba7STejun Heo 
39319c5a2ba7STejun Heo 	/*
39329c5a2ba7STejun Heo 	 * __queue_work() needs to test whether there are drainers, is much
39339c5a2ba7STejun Heo 	 * hotter than drain_workqueue() and already looks at @wq->flags.
3934618b01ebSTejun Heo 	 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
39359c5a2ba7STejun Heo 	 */
393687fc741eSLai Jiangshan 	mutex_lock(&wq->mutex);
39379c5a2ba7STejun Heo 	if (!wq->nr_drainers++)
3938618b01ebSTejun Heo 		wq->flags |= __WQ_DRAINING;
393987fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
39409c5a2ba7STejun Heo reflush:
3941c4f135d6STetsuo Handa 	__flush_workqueue(wq);
39429c5a2ba7STejun Heo 
3943b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
394476af4d93STejun Heo 
394549e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
3946fa2563e4SThomas Tuttle 		bool drained;
39479c5a2ba7STejun Heo 
3948a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
3949afa87ce8STejun Heo 		drained = pwq_is_empty(pwq);
3950a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
3951fa2563e4SThomas Tuttle 
3952fa2563e4SThomas Tuttle 		if (drained)
39539c5a2ba7STejun Heo 			continue;
39549c5a2ba7STejun Heo 
39559c5a2ba7STejun Heo 		if (++flush_cnt == 10 ||
39569c5a2ba7STejun Heo 		    (flush_cnt % 100 == 0 && flush_cnt <= 1000))
3957e9ad2eb3SStephen Zhang 			pr_warn("workqueue %s: %s() isn't complete after %u tries\n",
3958e9ad2eb3SStephen Zhang 				wq->name, __func__, flush_cnt);
395976af4d93STejun Heo 
3960b09f4fd3SLai Jiangshan 		mutex_unlock(&wq->mutex);
39619c5a2ba7STejun Heo 		goto reflush;
39629c5a2ba7STejun Heo 	}
39639c5a2ba7STejun Heo 
39649c5a2ba7STejun Heo 	if (!--wq->nr_drainers)
3965618b01ebSTejun Heo 		wq->flags &= ~__WQ_DRAINING;
396687fc741eSLai Jiangshan 	mutex_unlock(&wq->mutex);
39679c5a2ba7STejun Heo }
39689c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue);
39699c5a2ba7STejun Heo 
3970d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
3971d6e89786SJohannes Berg 			     bool from_cancel)
3972baf59022STejun Heo {
3973baf59022STejun Heo 	struct worker *worker = NULL;
3974c9e7cf27STejun Heo 	struct worker_pool *pool;
3975112202d9STejun Heo 	struct pool_workqueue *pwq;
3976c35aea39STejun Heo 	struct workqueue_struct *wq;
3977baf59022STejun Heo 
3978baf59022STejun Heo 	might_sleep();
3979baf59022STejun Heo 
398024acfb71SThomas Gleixner 	rcu_read_lock();
3981fa1b54e6STejun Heo 	pool = get_work_pool(work);
3982fa1b54e6STejun Heo 	if (!pool) {
398324acfb71SThomas Gleixner 		rcu_read_unlock();
3984fa1b54e6STejun Heo 		return false;
3985fa1b54e6STejun Heo 	}
3986fa1b54e6STejun Heo 
3987a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
39880b3dae68SLai Jiangshan 	/* see the comment in try_to_grab_pending() with the same code */
3989112202d9STejun Heo 	pwq = get_work_pwq(work);
3990112202d9STejun Heo 	if (pwq) {
3991112202d9STejun Heo 		if (unlikely(pwq->pool != pool))
3992baf59022STejun Heo 			goto already_gone;
3993606a5020STejun Heo 	} else {
3994c9e7cf27STejun Heo 		worker = find_worker_executing_work(pool, work);
3995baf59022STejun Heo 		if (!worker)
3996baf59022STejun Heo 			goto already_gone;
3997112202d9STejun Heo 		pwq = worker->current_pwq;
3998606a5020STejun Heo 	}
3999baf59022STejun Heo 
4000c35aea39STejun Heo 	wq = pwq->wq;
4001c35aea39STejun Heo 	check_flush_dependency(wq, work);
4002fca839c0STejun Heo 
4003112202d9STejun Heo 	insert_wq_barrier(pwq, barr, work, worker);
4004a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
4005baf59022STejun Heo 
4006c35aea39STejun Heo 	touch_work_lockdep_map(work, wq);
4007c35aea39STejun Heo 
4008e159489bSTejun Heo 	/*
4009a1d14934SPeter Zijlstra 	 * Force a lock recursion deadlock when using flush_work() inside a
4010a1d14934SPeter Zijlstra 	 * single-threaded or rescuer equipped workqueue.
4011a1d14934SPeter Zijlstra 	 *
4012a1d14934SPeter Zijlstra 	 * For single threaded workqueues the deadlock happens when the work
4013a1d14934SPeter Zijlstra 	 * is after the work issuing the flush_work(). For rescuer equipped
4014a1d14934SPeter Zijlstra 	 * workqueues the deadlock happens when the rescuer stalls, blocking
4015a1d14934SPeter Zijlstra 	 * forward progress.
4016e159489bSTejun Heo 	 */
4017c35aea39STejun Heo 	if (!from_cancel && (wq->saved_max_active == 1 || wq->rescuer))
4018c35aea39STejun Heo 		touch_wq_lockdep_map(wq);
4019c35aea39STejun Heo 
402024acfb71SThomas Gleixner 	rcu_read_unlock();
4021baf59022STejun Heo 	return true;
4022baf59022STejun Heo already_gone:
4023a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
402424acfb71SThomas Gleixner 	rcu_read_unlock();
4025baf59022STejun Heo 	return false;
4026baf59022STejun Heo }
4027baf59022STejun Heo 
4028d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel)
4029d6e89786SJohannes Berg {
4030d6e89786SJohannes Berg 	struct wq_barrier barr;
4031d6e89786SJohannes Berg 
4032d6e89786SJohannes Berg 	if (WARN_ON(!wq_online))
4033d6e89786SJohannes Berg 		return false;
4034d6e89786SJohannes Berg 
40354d43d395STetsuo Handa 	if (WARN_ON(!work->func))
40364d43d395STetsuo Handa 		return false;
40374d43d395STetsuo Handa 
4038d6e89786SJohannes Berg 	if (start_flush_work(work, &barr, from_cancel)) {
4039d6e89786SJohannes Berg 		wait_for_completion(&barr.done);
4040d6e89786SJohannes Berg 		destroy_work_on_stack(&barr.work);
4041d6e89786SJohannes Berg 		return true;
4042d6e89786SJohannes Berg 	} else {
4043d6e89786SJohannes Berg 		return false;
4044d6e89786SJohannes Berg 	}
4045d6e89786SJohannes Berg }
4046d6e89786SJohannes Berg 
4047db700897SOleg Nesterov /**
4048401a8d04STejun Heo  * flush_work - wait for a work to finish executing the last queueing instance
4049401a8d04STejun Heo  * @work: the work to flush
4050db700897SOleg Nesterov  *
4051606a5020STejun Heo  * Wait until @work has finished execution.  @work is guaranteed to be idle
4052606a5020STejun Heo  * on return if it hasn't been requeued since flush started.
4053401a8d04STejun Heo  *
4054d185af30SYacine Belkadi  * Return:
4055401a8d04STejun Heo  * %true if flush_work() waited for the work to finish execution,
4056401a8d04STejun Heo  * %false if it was already idle.
4057db700897SOleg Nesterov  */
4058401a8d04STejun Heo bool flush_work(struct work_struct *work)
4059db700897SOleg Nesterov {
4060d6e89786SJohannes Berg 	return __flush_work(work, false);
4061606a5020STejun Heo }
4062db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work);
4063db700897SOleg Nesterov 
4064cdc6e4b3STejun Heo /**
4065cdc6e4b3STejun Heo  * flush_delayed_work - wait for a dwork to finish executing the last queueing
4066cdc6e4b3STejun Heo  * @dwork: the delayed work to flush
4067cdc6e4b3STejun Heo  *
4068cdc6e4b3STejun Heo  * Delayed timer is cancelled and the pending work is queued for
4069cdc6e4b3STejun Heo  * immediate execution.  Like flush_work(), this function only
4070cdc6e4b3STejun Heo  * considers the last queueing instance of @dwork.
4071cdc6e4b3STejun Heo  *
4072cdc6e4b3STejun Heo  * Return:
4073cdc6e4b3STejun Heo  * %true if flush_work() waited for the work to finish execution,
4074cdc6e4b3STejun Heo  * %false if it was already idle.
4075cdc6e4b3STejun Heo  */
4076cdc6e4b3STejun Heo bool flush_delayed_work(struct delayed_work *dwork)
4077cdc6e4b3STejun Heo {
4078cdc6e4b3STejun Heo 	local_irq_disable();
4079cdc6e4b3STejun Heo 	if (del_timer_sync(&dwork->timer))
4080cdc6e4b3STejun Heo 		__queue_work(dwork->cpu, dwork->wq, &dwork->work);
4081cdc6e4b3STejun Heo 	local_irq_enable();
4082cdc6e4b3STejun Heo 	return flush_work(&dwork->work);
4083cdc6e4b3STejun Heo }
4084cdc6e4b3STejun Heo EXPORT_SYMBOL(flush_delayed_work);
4085cdc6e4b3STejun Heo 
4086cdc6e4b3STejun Heo /**
4087cdc6e4b3STejun Heo  * flush_rcu_work - wait for a rwork to finish executing the last queueing
4088cdc6e4b3STejun Heo  * @rwork: the rcu work to flush
4089cdc6e4b3STejun Heo  *
4090cdc6e4b3STejun Heo  * Return:
4091cdc6e4b3STejun Heo  * %true if flush_rcu_work() waited for the work to finish execution,
4092cdc6e4b3STejun Heo  * %false if it was already idle.
4093cdc6e4b3STejun Heo  */
4094cdc6e4b3STejun Heo bool flush_rcu_work(struct rcu_work *rwork)
4095cdc6e4b3STejun Heo {
4096cdc6e4b3STejun Heo 	if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
4097cdc6e4b3STejun Heo 		rcu_barrier();
4098cdc6e4b3STejun Heo 		flush_work(&rwork->work);
4099cdc6e4b3STejun Heo 		return true;
4100cdc6e4b3STejun Heo 	} else {
4101cdc6e4b3STejun Heo 		return flush_work(&rwork->work);
4102cdc6e4b3STejun Heo 	}
4103cdc6e4b3STejun Heo }
4104cdc6e4b3STejun Heo EXPORT_SYMBOL(flush_rcu_work);
4105cdc6e4b3STejun Heo 
4106cdc6e4b3STejun Heo static bool __cancel_work(struct work_struct *work, bool is_dwork)
4107cdc6e4b3STejun Heo {
4108*c26e2f2eSTejun Heo 	unsigned long irq_flags;
4109cdc6e4b3STejun Heo 	int ret;
4110cdc6e4b3STejun Heo 
4111cdc6e4b3STejun Heo 	do {
4112*c26e2f2eSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &irq_flags);
4113cdc6e4b3STejun Heo 	} while (unlikely(ret == -EAGAIN));
4114cdc6e4b3STejun Heo 
4115cdc6e4b3STejun Heo 	if (unlikely(ret < 0))
4116cdc6e4b3STejun Heo 		return false;
4117cdc6e4b3STejun Heo 
4118cdc6e4b3STejun Heo 	set_work_pool_and_clear_pending(work, get_work_pool_id(work));
4119*c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
4120cdc6e4b3STejun Heo 	return ret;
4121cdc6e4b3STejun Heo }
4122cdc6e4b3STejun Heo 
41238603e1b3STejun Heo struct cwt_wait {
4124ac6424b9SIngo Molnar 	wait_queue_entry_t		wait;
41258603e1b3STejun Heo 	struct work_struct	*work;
41268603e1b3STejun Heo };
41278603e1b3STejun Heo 
4128ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
41298603e1b3STejun Heo {
41308603e1b3STejun Heo 	struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
41318603e1b3STejun Heo 
41328603e1b3STejun Heo 	if (cwait->work != key)
41338603e1b3STejun Heo 		return 0;
41348603e1b3STejun Heo 	return autoremove_wake_function(wait, mode, sync, key);
41358603e1b3STejun Heo }
41368603e1b3STejun Heo 
4137c5140688STejun Heo static bool __cancel_work_sync(struct work_struct *work, bool is_dwork)
4138401a8d04STejun Heo {
41398603e1b3STejun Heo 	static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
4140*c26e2f2eSTejun Heo 	unsigned long irq_flags;
41411f1f642eSOleg Nesterov 	int ret;
41421f1f642eSOleg Nesterov 
41431f1f642eSOleg Nesterov 	do {
4144*c26e2f2eSTejun Heo 		ret = try_to_grab_pending(work, is_dwork, &irq_flags);
4145bbb68dfaSTejun Heo 		/*
41468603e1b3STejun Heo 		 * If someone else is already canceling, wait for it to
41478603e1b3STejun Heo 		 * finish.  flush_work() doesn't work for PREEMPT_NONE
41488603e1b3STejun Heo 		 * because we may get scheduled between @work's completion
41498603e1b3STejun Heo 		 * and the other canceling task resuming and clearing
41508603e1b3STejun Heo 		 * CANCELING - flush_work() will return false immediately
41518603e1b3STejun Heo 		 * as @work is no longer busy, try_to_grab_pending() will
41528603e1b3STejun Heo 		 * return -ENOENT as @work is still being canceled and the
41538603e1b3STejun Heo 		 * other canceling task won't be able to clear CANCELING as
41548603e1b3STejun Heo 		 * we're hogging the CPU.
41558603e1b3STejun Heo 		 *
41568603e1b3STejun Heo 		 * Let's wait for completion using a waitqueue.  As this
41578603e1b3STejun Heo 		 * may lead to the thundering herd problem, use a custom
41588603e1b3STejun Heo 		 * wake function which matches @work along with exclusive
41598603e1b3STejun Heo 		 * wait and wakeup.
4160bbb68dfaSTejun Heo 		 */
41618603e1b3STejun Heo 		if (unlikely(ret == -ENOENT)) {
41628603e1b3STejun Heo 			struct cwt_wait cwait;
41638603e1b3STejun Heo 
41648603e1b3STejun Heo 			init_wait(&cwait.wait);
41658603e1b3STejun Heo 			cwait.wait.func = cwt_wakefn;
41668603e1b3STejun Heo 			cwait.work = work;
41678603e1b3STejun Heo 
41688603e1b3STejun Heo 			prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
41698603e1b3STejun Heo 						  TASK_UNINTERRUPTIBLE);
41708603e1b3STejun Heo 			if (work_is_canceling(work))
41718603e1b3STejun Heo 				schedule();
41728603e1b3STejun Heo 			finish_wait(&cancel_waitq, &cwait.wait);
41738603e1b3STejun Heo 		}
41741f1f642eSOleg Nesterov 	} while (unlikely(ret < 0));
41751f1f642eSOleg Nesterov 
4176bbb68dfaSTejun Heo 	/* tell other tasks trying to grab @work to back off */
4177bbb68dfaSTejun Heo 	mark_work_canceling(work);
4178*c26e2f2eSTejun Heo 	local_irq_restore(irq_flags);
4179bbb68dfaSTejun Heo 
41803347fa09STejun Heo 	/*
4181c7a40c49STejun Heo 	 * Skip __flush_work() during early boot when we know that @work isn't
4182c7a40c49STejun Heo 	 * executing. This allows canceling during early boot.
41833347fa09STejun Heo 	 */
41843347fa09STejun Heo 	if (wq_online)
4185d6e89786SJohannes Berg 		__flush_work(work, true);
41863347fa09STejun Heo 
41877a22ad75STejun Heo 	clear_work_data(work);
41888603e1b3STejun Heo 
41898603e1b3STejun Heo 	/*
41908603e1b3STejun Heo 	 * Paired with prepare_to_wait() above so that either
41918603e1b3STejun Heo 	 * waitqueue_active() is visible here or !work_is_canceling() is
41928603e1b3STejun Heo 	 * visible there.
41938603e1b3STejun Heo 	 */
41948603e1b3STejun Heo 	smp_mb();
41958603e1b3STejun Heo 	if (waitqueue_active(&cancel_waitq))
41968603e1b3STejun Heo 		__wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
41978603e1b3STejun Heo 
41981f1f642eSOleg Nesterov 	return ret;
41991f1f642eSOleg Nesterov }
42001f1f642eSOleg Nesterov 
4201cdc6e4b3STejun Heo /*
4202cdc6e4b3STejun Heo  * See cancel_delayed_work()
4203cdc6e4b3STejun Heo  */
4204cdc6e4b3STejun Heo bool cancel_work(struct work_struct *work)
4205cdc6e4b3STejun Heo {
4206cdc6e4b3STejun Heo 	return __cancel_work(work, false);
4207cdc6e4b3STejun Heo }
4208cdc6e4b3STejun Heo EXPORT_SYMBOL(cancel_work);
4209cdc6e4b3STejun Heo 
42106e84d644SOleg Nesterov /**
4211401a8d04STejun Heo  * cancel_work_sync - cancel a work and wait for it to finish
4212401a8d04STejun Heo  * @work: the work to cancel
42136e84d644SOleg Nesterov  *
4214401a8d04STejun Heo  * Cancel @work and wait for its execution to finish.  This function
4215401a8d04STejun Heo  * can be used even if the work re-queues itself or migrates to
4216401a8d04STejun Heo  * another workqueue.  On return from this function, @work is
4217401a8d04STejun Heo  * guaranteed to be not pending or executing on any CPU.
42181f1f642eSOleg Nesterov  *
4219401a8d04STejun Heo  * cancel_work_sync(&delayed_work->work) must not be used for
4220401a8d04STejun Heo  * delayed_work's.  Use cancel_delayed_work_sync() instead.
42216e84d644SOleg Nesterov  *
4222401a8d04STejun Heo  * The caller must ensure that the workqueue on which @work was last
42236e84d644SOleg Nesterov  * queued can't be destroyed before this function returns.
4224401a8d04STejun Heo  *
4225d185af30SYacine Belkadi  * Return:
4226401a8d04STejun Heo  * %true if @work was pending, %false otherwise.
42276e84d644SOleg Nesterov  */
4228401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work)
42296e84d644SOleg Nesterov {
4230c5140688STejun Heo 	return __cancel_work_sync(work, false);
4231b89deed3SOleg Nesterov }
423228e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync);
4233b89deed3SOleg Nesterov 
42346e84d644SOleg Nesterov /**
423557b30ae7STejun Heo  * cancel_delayed_work - cancel a delayed work
423657b30ae7STejun Heo  * @dwork: delayed_work to cancel
423709383498STejun Heo  *
4238d185af30SYacine Belkadi  * Kill off a pending delayed_work.
4239d185af30SYacine Belkadi  *
4240d185af30SYacine Belkadi  * Return: %true if @dwork was pending and canceled; %false if it wasn't
4241d185af30SYacine Belkadi  * pending.
4242d185af30SYacine Belkadi  *
4243d185af30SYacine Belkadi  * Note:
4244d185af30SYacine Belkadi  * The work callback function may still be running on return, unless
4245d185af30SYacine Belkadi  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
4246d185af30SYacine Belkadi  * use cancel_delayed_work_sync() to wait on it.
424709383498STejun Heo  *
424857b30ae7STejun Heo  * This function is safe to call from any context including IRQ handler.
424909383498STejun Heo  */
425057b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork)
425109383498STejun Heo {
4252f72b8792SJens Axboe 	return __cancel_work(&dwork->work, true);
425309383498STejun Heo }
425457b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work);
425509383498STejun Heo 
425609383498STejun Heo /**
4257401a8d04STejun Heo  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
4258401a8d04STejun Heo  * @dwork: the delayed work cancel
4259401a8d04STejun Heo  *
4260401a8d04STejun Heo  * This is cancel_work_sync() for delayed works.
4261401a8d04STejun Heo  *
4262d185af30SYacine Belkadi  * Return:
4263401a8d04STejun Heo  * %true if @dwork was pending, %false otherwise.
4264401a8d04STejun Heo  */
4265401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork)
42666e84d644SOleg Nesterov {
4267c5140688STejun Heo 	return __cancel_work_sync(&dwork->work, true);
42686e84d644SOleg Nesterov }
4269f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync);
42701da177e4SLinus Torvalds 
42710fcb78c2SRolf Eike Beer /**
427231ddd871STejun Heo  * schedule_on_each_cpu - execute a function synchronously on each online CPU
4273b6136773SAndrew Morton  * @func: the function to call
4274b6136773SAndrew Morton  *
427531ddd871STejun Heo  * schedule_on_each_cpu() executes @func on each online CPU using the
427631ddd871STejun Heo  * system workqueue and blocks until all CPUs have completed.
4277b6136773SAndrew Morton  * schedule_on_each_cpu() is very slow.
427831ddd871STejun Heo  *
4279d185af30SYacine Belkadi  * Return:
428031ddd871STejun Heo  * 0 on success, -errno on failure.
4281b6136773SAndrew Morton  */
428265f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func)
428315316ba8SChristoph Lameter {
428415316ba8SChristoph Lameter 	int cpu;
428538f51568SNamhyung Kim 	struct work_struct __percpu *works;
428615316ba8SChristoph Lameter 
4287b6136773SAndrew Morton 	works = alloc_percpu(struct work_struct);
4288b6136773SAndrew Morton 	if (!works)
428915316ba8SChristoph Lameter 		return -ENOMEM;
4290b6136773SAndrew Morton 
4291ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
429293981800STejun Heo 
429315316ba8SChristoph Lameter 	for_each_online_cpu(cpu) {
42949bfb1839SIngo Molnar 		struct work_struct *work = per_cpu_ptr(works, cpu);
42959bfb1839SIngo Molnar 
42969bfb1839SIngo Molnar 		INIT_WORK(work, func);
42978de6d308SOleg Nesterov 		schedule_work_on(cpu, work);
429815316ba8SChristoph Lameter 	}
429993981800STejun Heo 
430093981800STejun Heo 	for_each_online_cpu(cpu)
43018616a89aSOleg Nesterov 		flush_work(per_cpu_ptr(works, cpu));
430293981800STejun Heo 
4303ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
4304b6136773SAndrew Morton 	free_percpu(works);
430515316ba8SChristoph Lameter 	return 0;
430615316ba8SChristoph Lameter }
430715316ba8SChristoph Lameter 
4308eef6a7d5SAlan Stern /**
43091fa44ecaSJames Bottomley  * execute_in_process_context - reliably execute the routine with user context
43101fa44ecaSJames Bottomley  * @fn:		the function to execute
43111fa44ecaSJames Bottomley  * @ew:		guaranteed storage for the execute work structure (must
43121fa44ecaSJames Bottomley  *		be available when the work executes)
43131fa44ecaSJames Bottomley  *
43141fa44ecaSJames Bottomley  * Executes the function immediately if process context is available,
43151fa44ecaSJames Bottomley  * otherwise schedules the function for delayed execution.
43161fa44ecaSJames Bottomley  *
4317d185af30SYacine Belkadi  * Return:	0 - function was executed
43181fa44ecaSJames Bottomley  *		1 - function was scheduled for execution
43191fa44ecaSJames Bottomley  */
432065f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew)
43211fa44ecaSJames Bottomley {
43221fa44ecaSJames Bottomley 	if (!in_interrupt()) {
432365f27f38SDavid Howells 		fn(&ew->work);
43241fa44ecaSJames Bottomley 		return 0;
43251fa44ecaSJames Bottomley 	}
43261fa44ecaSJames Bottomley 
432765f27f38SDavid Howells 	INIT_WORK(&ew->work, fn);
43281fa44ecaSJames Bottomley 	schedule_work(&ew->work);
43291fa44ecaSJames Bottomley 
43301fa44ecaSJames Bottomley 	return 1;
43311fa44ecaSJames Bottomley }
43321fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context);
43331fa44ecaSJames Bottomley 
43347a4e344cSTejun Heo /**
43357a4e344cSTejun Heo  * free_workqueue_attrs - free a workqueue_attrs
43367a4e344cSTejun Heo  * @attrs: workqueue_attrs to free
43377a4e344cSTejun Heo  *
43387a4e344cSTejun Heo  * Undo alloc_workqueue_attrs().
43397a4e344cSTejun Heo  */
4340513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs)
43417a4e344cSTejun Heo {
43427a4e344cSTejun Heo 	if (attrs) {
43437a4e344cSTejun Heo 		free_cpumask_var(attrs->cpumask);
43449546b29eSTejun Heo 		free_cpumask_var(attrs->__pod_cpumask);
43457a4e344cSTejun Heo 		kfree(attrs);
43467a4e344cSTejun Heo 	}
43477a4e344cSTejun Heo }
43487a4e344cSTejun Heo 
43497a4e344cSTejun Heo /**
43507a4e344cSTejun Heo  * alloc_workqueue_attrs - allocate a workqueue_attrs
43517a4e344cSTejun Heo  *
43527a4e344cSTejun Heo  * Allocate a new workqueue_attrs, initialize with default settings and
4353d185af30SYacine Belkadi  * return it.
4354d185af30SYacine Belkadi  *
4355d185af30SYacine Belkadi  * Return: The allocated new workqueue_attr on success. %NULL on failure.
43567a4e344cSTejun Heo  */
4357513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void)
43587a4e344cSTejun Heo {
43597a4e344cSTejun Heo 	struct workqueue_attrs *attrs;
43607a4e344cSTejun Heo 
4361be69d00dSThomas Gleixner 	attrs = kzalloc(sizeof(*attrs), GFP_KERNEL);
43627a4e344cSTejun Heo 	if (!attrs)
43637a4e344cSTejun Heo 		goto fail;
4364be69d00dSThomas Gleixner 	if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL))
43657a4e344cSTejun Heo 		goto fail;
43669546b29eSTejun Heo 	if (!alloc_cpumask_var(&attrs->__pod_cpumask, GFP_KERNEL))
43679546b29eSTejun Heo 		goto fail;
43687a4e344cSTejun Heo 
436913e2e556STejun Heo 	cpumask_copy(attrs->cpumask, cpu_possible_mask);
4370523a301eSTejun Heo 	attrs->affn_scope = WQ_AFFN_DFL;
43717a4e344cSTejun Heo 	return attrs;
43727a4e344cSTejun Heo fail:
43737a4e344cSTejun Heo 	free_workqueue_attrs(attrs);
43747a4e344cSTejun Heo 	return NULL;
43757a4e344cSTejun Heo }
43767a4e344cSTejun Heo 
437729c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to,
437829c91e99STejun Heo 				 const struct workqueue_attrs *from)
437929c91e99STejun Heo {
438029c91e99STejun Heo 	to->nice = from->nice;
438129c91e99STejun Heo 	cpumask_copy(to->cpumask, from->cpumask);
43829546b29eSTejun Heo 	cpumask_copy(to->__pod_cpumask, from->__pod_cpumask);
43838639ecebSTejun Heo 	to->affn_strict = from->affn_strict;
438484193c07STejun Heo 
43852865a8fbSShaohua Li 	/*
438684193c07STejun Heo 	 * Unlike hash and equality test, copying shouldn't ignore wq-only
438784193c07STejun Heo 	 * fields as copying is used for both pool and wq attrs. Instead,
438884193c07STejun Heo 	 * get_unbound_pool() explicitly clears the fields.
43892865a8fbSShaohua Li 	 */
439084193c07STejun Heo 	to->affn_scope = from->affn_scope;
4391af73f5c9STejun Heo 	to->ordered = from->ordered;
439229c91e99STejun Heo }
439329c91e99STejun Heo 
43945de7a03cSTejun Heo /*
43955de7a03cSTejun Heo  * Some attrs fields are workqueue-only. Clear them for worker_pool's. See the
43965de7a03cSTejun Heo  * comments in 'struct workqueue_attrs' definition.
43975de7a03cSTejun Heo  */
43985de7a03cSTejun Heo static void wqattrs_clear_for_pool(struct workqueue_attrs *attrs)
43995de7a03cSTejun Heo {
440084193c07STejun Heo 	attrs->affn_scope = WQ_AFFN_NR_TYPES;
44015de7a03cSTejun Heo 	attrs->ordered = false;
44025de7a03cSTejun Heo }
44035de7a03cSTejun Heo 
440429c91e99STejun Heo /* hash value of the content of @attr */
440529c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
440629c91e99STejun Heo {
440729c91e99STejun Heo 	u32 hash = 0;
440829c91e99STejun Heo 
440929c91e99STejun Heo 	hash = jhash_1word(attrs->nice, hash);
441013e2e556STejun Heo 	hash = jhash(cpumask_bits(attrs->cpumask),
441113e2e556STejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
44129546b29eSTejun Heo 	hash = jhash(cpumask_bits(attrs->__pod_cpumask),
44139546b29eSTejun Heo 		     BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
44148639ecebSTejun Heo 	hash = jhash_1word(attrs->affn_strict, hash);
441529c91e99STejun Heo 	return hash;
441629c91e99STejun Heo }
441729c91e99STejun Heo 
441829c91e99STejun Heo /* content equality test */
441929c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a,
442029c91e99STejun Heo 			  const struct workqueue_attrs *b)
442129c91e99STejun Heo {
442229c91e99STejun Heo 	if (a->nice != b->nice)
442329c91e99STejun Heo 		return false;
442429c91e99STejun Heo 	if (!cpumask_equal(a->cpumask, b->cpumask))
442529c91e99STejun Heo 		return false;
44269546b29eSTejun Heo 	if (!cpumask_equal(a->__pod_cpumask, b->__pod_cpumask))
44279546b29eSTejun Heo 		return false;
44288639ecebSTejun Heo 	if (a->affn_strict != b->affn_strict)
44298639ecebSTejun Heo 		return false;
443029c91e99STejun Heo 	return true;
443129c91e99STejun Heo }
443229c91e99STejun Heo 
44330f36ee24STejun Heo /* Update @attrs with actually available CPUs */
44340f36ee24STejun Heo static void wqattrs_actualize_cpumask(struct workqueue_attrs *attrs,
44350f36ee24STejun Heo 				      const cpumask_t *unbound_cpumask)
44360f36ee24STejun Heo {
44370f36ee24STejun Heo 	/*
44380f36ee24STejun Heo 	 * Calculate the effective CPU mask of @attrs given @unbound_cpumask. If
44390f36ee24STejun Heo 	 * @attrs->cpumask doesn't overlap with @unbound_cpumask, we fallback to
44400f36ee24STejun Heo 	 * @unbound_cpumask.
44410f36ee24STejun Heo 	 */
44420f36ee24STejun Heo 	cpumask_and(attrs->cpumask, attrs->cpumask, unbound_cpumask);
44430f36ee24STejun Heo 	if (unlikely(cpumask_empty(attrs->cpumask)))
44440f36ee24STejun Heo 		cpumask_copy(attrs->cpumask, unbound_cpumask);
44450f36ee24STejun Heo }
44460f36ee24STejun Heo 
444784193c07STejun Heo /* find wq_pod_type to use for @attrs */
444884193c07STejun Heo static const struct wq_pod_type *
444984193c07STejun Heo wqattrs_pod_type(const struct workqueue_attrs *attrs)
445084193c07STejun Heo {
4451523a301eSTejun Heo 	enum wq_affn_scope scope;
4452523a301eSTejun Heo 	struct wq_pod_type *pt;
4453523a301eSTejun Heo 
4454523a301eSTejun Heo 	/* to synchronize access to wq_affn_dfl */
4455523a301eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4456523a301eSTejun Heo 
4457523a301eSTejun Heo 	if (attrs->affn_scope == WQ_AFFN_DFL)
4458523a301eSTejun Heo 		scope = wq_affn_dfl;
4459523a301eSTejun Heo 	else
4460523a301eSTejun Heo 		scope = attrs->affn_scope;
4461523a301eSTejun Heo 
4462523a301eSTejun Heo 	pt = &wq_pod_types[scope];
446384193c07STejun Heo 
446484193c07STejun Heo 	if (!WARN_ON_ONCE(attrs->affn_scope == WQ_AFFN_NR_TYPES) &&
446584193c07STejun Heo 	    likely(pt->nr_pods))
446684193c07STejun Heo 		return pt;
446784193c07STejun Heo 
446884193c07STejun Heo 	/*
446984193c07STejun Heo 	 * Before workqueue_init_topology(), only SYSTEM is available which is
447084193c07STejun Heo 	 * initialized in workqueue_init_early().
447184193c07STejun Heo 	 */
447284193c07STejun Heo 	pt = &wq_pod_types[WQ_AFFN_SYSTEM];
447384193c07STejun Heo 	BUG_ON(!pt->nr_pods);
447484193c07STejun Heo 	return pt;
447584193c07STejun Heo }
447684193c07STejun Heo 
44777a4e344cSTejun Heo /**
44787a4e344cSTejun Heo  * init_worker_pool - initialize a newly zalloc'd worker_pool
44797a4e344cSTejun Heo  * @pool: worker_pool to initialize
44807a4e344cSTejun Heo  *
4481402dd89dSShailendra Verma  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
4482d185af30SYacine Belkadi  *
4483d185af30SYacine Belkadi  * Return: 0 on success, -errno on failure.  Even on failure, all fields
448429c91e99STejun Heo  * inside @pool proper are initialized and put_unbound_pool() can be called
448529c91e99STejun Heo  * on @pool safely to release it.
44867a4e344cSTejun Heo  */
44877a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool)
44884e1a1f9aSTejun Heo {
4489a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_init(&pool->lock);
449029c91e99STejun Heo 	pool->id = -1;
449129c91e99STejun Heo 	pool->cpu = -1;
4492f3f90ad4STejun Heo 	pool->node = NUMA_NO_NODE;
44934e1a1f9aSTejun Heo 	pool->flags |= POOL_DISASSOCIATED;
449482607adcSTejun Heo 	pool->watchdog_ts = jiffies;
44954e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->worklist);
44964e1a1f9aSTejun Heo 	INIT_LIST_HEAD(&pool->idle_list);
44974e1a1f9aSTejun Heo 	hash_init(pool->busy_hash);
44984e1a1f9aSTejun Heo 
449932a6c723SKees Cook 	timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE);
45003f959aa3SValentin Schneider 	INIT_WORK(&pool->idle_cull_work, idle_cull_fn);
45014e1a1f9aSTejun Heo 
450232a6c723SKees Cook 	timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0);
45034e1a1f9aSTejun Heo 
4504da028469SLai Jiangshan 	INIT_LIST_HEAD(&pool->workers);
4505e02b9312SValentin Schneider 	INIT_LIST_HEAD(&pool->dying_workers);
45067a4e344cSTejun Heo 
45077cda9aaeSLai Jiangshan 	ida_init(&pool->worker_ida);
450829c91e99STejun Heo 	INIT_HLIST_NODE(&pool->hash_node);
450929c91e99STejun Heo 	pool->refcnt = 1;
451029c91e99STejun Heo 
451129c91e99STejun Heo 	/* shouldn't fail above this point */
4512be69d00dSThomas Gleixner 	pool->attrs = alloc_workqueue_attrs();
45137a4e344cSTejun Heo 	if (!pool->attrs)
45147a4e344cSTejun Heo 		return -ENOMEM;
45155de7a03cSTejun Heo 
45165de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
45175de7a03cSTejun Heo 
45187a4e344cSTejun Heo 	return 0;
45194e1a1f9aSTejun Heo }
45204e1a1f9aSTejun Heo 
4521669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP
4522669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
4523669de8bdSBart Van Assche {
4524669de8bdSBart Van Assche 	char *lock_name;
4525669de8bdSBart Van Assche 
4526669de8bdSBart Van Assche 	lockdep_register_key(&wq->key);
4527669de8bdSBart Van Assche 	lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name);
4528669de8bdSBart Van Assche 	if (!lock_name)
4529669de8bdSBart Van Assche 		lock_name = wq->name;
453069a106c0SQian Cai 
453169a106c0SQian Cai 	wq->lock_name = lock_name;
4532669de8bdSBart Van Assche 	lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0);
4533669de8bdSBart Van Assche }
4534669de8bdSBart Van Assche 
4535669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
4536669de8bdSBart Van Assche {
4537669de8bdSBart Van Assche 	lockdep_unregister_key(&wq->key);
4538669de8bdSBart Van Assche }
4539669de8bdSBart Van Assche 
4540669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
4541669de8bdSBart Van Assche {
4542669de8bdSBart Van Assche 	if (wq->lock_name != wq->name)
4543669de8bdSBart Van Assche 		kfree(wq->lock_name);
4544669de8bdSBart Van Assche }
4545669de8bdSBart Van Assche #else
4546669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq)
4547669de8bdSBart Van Assche {
4548669de8bdSBart Van Assche }
4549669de8bdSBart Van Assche 
4550669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq)
4551669de8bdSBart Van Assche {
4552669de8bdSBart Van Assche }
4553669de8bdSBart Van Assche 
4554669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq)
4555669de8bdSBart Van Assche {
4556669de8bdSBart Van Assche }
4557669de8bdSBart Van Assche #endif
4558669de8bdSBart Van Assche 
455991ccc6e7STejun Heo static void free_node_nr_active(struct wq_node_nr_active **nna_ar)
456091ccc6e7STejun Heo {
456191ccc6e7STejun Heo 	int node;
456291ccc6e7STejun Heo 
456391ccc6e7STejun Heo 	for_each_node(node) {
456491ccc6e7STejun Heo 		kfree(nna_ar[node]);
456591ccc6e7STejun Heo 		nna_ar[node] = NULL;
456691ccc6e7STejun Heo 	}
456791ccc6e7STejun Heo 
456891ccc6e7STejun Heo 	kfree(nna_ar[nr_node_ids]);
456991ccc6e7STejun Heo 	nna_ar[nr_node_ids] = NULL;
457091ccc6e7STejun Heo }
457191ccc6e7STejun Heo 
457291ccc6e7STejun Heo static void init_node_nr_active(struct wq_node_nr_active *nna)
457391ccc6e7STejun Heo {
4574c5f8cd6cSTejun Heo 	nna->max = WQ_DFL_MIN_ACTIVE;
457591ccc6e7STejun Heo 	atomic_set(&nna->nr, 0);
45765797b1c1STejun Heo 	raw_spin_lock_init(&nna->lock);
45775797b1c1STejun Heo 	INIT_LIST_HEAD(&nna->pending_pwqs);
457891ccc6e7STejun Heo }
457991ccc6e7STejun Heo 
458091ccc6e7STejun Heo /*
458191ccc6e7STejun Heo  * Each node's nr_active counter will be accessed mostly from its own node and
458291ccc6e7STejun Heo  * should be allocated in the node.
458391ccc6e7STejun Heo  */
458491ccc6e7STejun Heo static int alloc_node_nr_active(struct wq_node_nr_active **nna_ar)
458591ccc6e7STejun Heo {
458691ccc6e7STejun Heo 	struct wq_node_nr_active *nna;
458791ccc6e7STejun Heo 	int node;
458891ccc6e7STejun Heo 
458991ccc6e7STejun Heo 	for_each_node(node) {
459091ccc6e7STejun Heo 		nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, node);
459191ccc6e7STejun Heo 		if (!nna)
459291ccc6e7STejun Heo 			goto err_free;
459391ccc6e7STejun Heo 		init_node_nr_active(nna);
459491ccc6e7STejun Heo 		nna_ar[node] = nna;
459591ccc6e7STejun Heo 	}
459691ccc6e7STejun Heo 
459791ccc6e7STejun Heo 	/* [nr_node_ids] is used as the fallback */
459891ccc6e7STejun Heo 	nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, NUMA_NO_NODE);
459991ccc6e7STejun Heo 	if (!nna)
460091ccc6e7STejun Heo 		goto err_free;
460191ccc6e7STejun Heo 	init_node_nr_active(nna);
460291ccc6e7STejun Heo 	nna_ar[nr_node_ids] = nna;
460391ccc6e7STejun Heo 
460491ccc6e7STejun Heo 	return 0;
460591ccc6e7STejun Heo 
460691ccc6e7STejun Heo err_free:
460791ccc6e7STejun Heo 	free_node_nr_active(nna_ar);
460891ccc6e7STejun Heo 	return -ENOMEM;
460991ccc6e7STejun Heo }
461091ccc6e7STejun Heo 
4611e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu)
4612e2dca7adSTejun Heo {
4613e2dca7adSTejun Heo 	struct workqueue_struct *wq =
4614e2dca7adSTejun Heo 		container_of(rcu, struct workqueue_struct, rcu);
4615e2dca7adSTejun Heo 
461691ccc6e7STejun Heo 	if (wq->flags & WQ_UNBOUND)
461791ccc6e7STejun Heo 		free_node_nr_active(wq->node_nr_active);
461891ccc6e7STejun Heo 
4619669de8bdSBart Van Assche 	wq_free_lockdep(wq);
4620ee1ceef7STejun Heo 	free_percpu(wq->cpu_pwq);
4621e2dca7adSTejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
4622e2dca7adSTejun Heo 	kfree(wq);
4623e2dca7adSTejun Heo }
4624e2dca7adSTejun Heo 
462529c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu)
462629c91e99STejun Heo {
462729c91e99STejun Heo 	struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
462829c91e99STejun Heo 
46297cda9aaeSLai Jiangshan 	ida_destroy(&pool->worker_ida);
463029c91e99STejun Heo 	free_workqueue_attrs(pool->attrs);
463129c91e99STejun Heo 	kfree(pool);
463229c91e99STejun Heo }
463329c91e99STejun Heo 
463429c91e99STejun Heo /**
463529c91e99STejun Heo  * put_unbound_pool - put a worker_pool
463629c91e99STejun Heo  * @pool: worker_pool to put
463729c91e99STejun Heo  *
463824acfb71SThomas Gleixner  * Put @pool.  If its refcnt reaches zero, it gets destroyed in RCU
4639c5aa87bbSTejun Heo  * safe manner.  get_unbound_pool() calls this function on its failure path
4640c5aa87bbSTejun Heo  * and this function should be able to release pools which went through,
4641c5aa87bbSTejun Heo  * successfully or not, init_worker_pool().
4642a892caccSTejun Heo  *
4643a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
464429c91e99STejun Heo  */
464529c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool)
464629c91e99STejun Heo {
464760f5a4bcSLai Jiangshan 	DECLARE_COMPLETION_ONSTACK(detach_completion);
464829c91e99STejun Heo 	struct worker *worker;
46499680540cSYang Yingliang 	LIST_HEAD(cull_list);
4650e02b9312SValentin Schneider 
4651a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4652a892caccSTejun Heo 
4653a892caccSTejun Heo 	if (--pool->refcnt)
465429c91e99STejun Heo 		return;
465529c91e99STejun Heo 
465629c91e99STejun Heo 	/* sanity checks */
465761d0fbb4SLai Jiangshan 	if (WARN_ON(!(pool->cpu < 0)) ||
4658a892caccSTejun Heo 	    WARN_ON(!list_empty(&pool->worklist)))
465929c91e99STejun Heo 		return;
466029c91e99STejun Heo 
466129c91e99STejun Heo 	/* release id and unhash */
466229c91e99STejun Heo 	if (pool->id >= 0)
466329c91e99STejun Heo 		idr_remove(&worker_pool_idr, pool->id);
466429c91e99STejun Heo 	hash_del(&pool->hash_node);
466529c91e99STejun Heo 
4666c5aa87bbSTejun Heo 	/*
4667692b4825STejun Heo 	 * Become the manager and destroy all workers.  This prevents
4668692b4825STejun Heo 	 * @pool's workers from blocking on attach_mutex.  We're the last
4669692b4825STejun Heo 	 * manager and @pool gets freed with the flag set.
46709ab03be4SValentin Schneider 	 *
46719ab03be4SValentin Schneider 	 * Having a concurrent manager is quite unlikely to happen as we can
46729ab03be4SValentin Schneider 	 * only get here with
46739ab03be4SValentin Schneider 	 *   pwq->refcnt == pool->refcnt == 0
46749ab03be4SValentin Schneider 	 * which implies no work queued to the pool, which implies no worker can
46759ab03be4SValentin Schneider 	 * become the manager. However a worker could have taken the role of
46769ab03be4SValentin Schneider 	 * manager before the refcnts dropped to 0, since maybe_create_worker()
46779ab03be4SValentin Schneider 	 * drops pool->lock
4678c5aa87bbSTejun Heo 	 */
46799ab03be4SValentin Schneider 	while (true) {
46809ab03be4SValentin Schneider 		rcuwait_wait_event(&manager_wait,
46819ab03be4SValentin Schneider 				   !(pool->flags & POOL_MANAGER_ACTIVE),
4682d8bb65abSSebastian Andrzej Siewior 				   TASK_UNINTERRUPTIBLE);
4683e02b9312SValentin Schneider 
4684e02b9312SValentin Schneider 		mutex_lock(&wq_pool_attach_mutex);
46859ab03be4SValentin Schneider 		raw_spin_lock_irq(&pool->lock);
46869ab03be4SValentin Schneider 		if (!(pool->flags & POOL_MANAGER_ACTIVE)) {
4687692b4825STejun Heo 			pool->flags |= POOL_MANAGER_ACTIVE;
46889ab03be4SValentin Schneider 			break;
46899ab03be4SValentin Schneider 		}
46909ab03be4SValentin Schneider 		raw_spin_unlock_irq(&pool->lock);
4691e02b9312SValentin Schneider 		mutex_unlock(&wq_pool_attach_mutex);
46929ab03be4SValentin Schneider 	}
4693692b4825STejun Heo 
46941037de36SLai Jiangshan 	while ((worker = first_idle_worker(pool)))
4695e02b9312SValentin Schneider 		set_worker_dying(worker, &cull_list);
469629c91e99STejun Heo 	WARN_ON(pool->nr_workers || pool->nr_idle);
4697a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
469860f5a4bcSLai Jiangshan 
4699e02b9312SValentin Schneider 	wake_dying_workers(&cull_list);
4700e02b9312SValentin Schneider 
4701e02b9312SValentin Schneider 	if (!list_empty(&pool->workers) || !list_empty(&pool->dying_workers))
470260f5a4bcSLai Jiangshan 		pool->detach_completion = &detach_completion;
47031258fae7STejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
470460f5a4bcSLai Jiangshan 
470560f5a4bcSLai Jiangshan 	if (pool->detach_completion)
470660f5a4bcSLai Jiangshan 		wait_for_completion(pool->detach_completion);
470760f5a4bcSLai Jiangshan 
470829c91e99STejun Heo 	/* shut down the timers */
470929c91e99STejun Heo 	del_timer_sync(&pool->idle_timer);
47103f959aa3SValentin Schneider 	cancel_work_sync(&pool->idle_cull_work);
471129c91e99STejun Heo 	del_timer_sync(&pool->mayday_timer);
471229c91e99STejun Heo 
471324acfb71SThomas Gleixner 	/* RCU protected to allow dereferences from get_work_pool() */
471425b00775SPaul E. McKenney 	call_rcu(&pool->rcu, rcu_free_pool);
471529c91e99STejun Heo }
471629c91e99STejun Heo 
471729c91e99STejun Heo /**
471829c91e99STejun Heo  * get_unbound_pool - get a worker_pool with the specified attributes
471929c91e99STejun Heo  * @attrs: the attributes of the worker_pool to get
472029c91e99STejun Heo  *
472129c91e99STejun Heo  * Obtain a worker_pool which has the same attributes as @attrs, bump the
472229c91e99STejun Heo  * reference count and return it.  If there already is a matching
472329c91e99STejun Heo  * worker_pool, it will be used; otherwise, this function attempts to
4724d185af30SYacine Belkadi  * create a new one.
4725a892caccSTejun Heo  *
4726a892caccSTejun Heo  * Should be called with wq_pool_mutex held.
4727d185af30SYacine Belkadi  *
4728d185af30SYacine Belkadi  * Return: On success, a worker_pool with the same attributes as @attrs.
4729d185af30SYacine Belkadi  * On failure, %NULL.
473029c91e99STejun Heo  */
473129c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
473229c91e99STejun Heo {
473384193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_NUMA];
473429c91e99STejun Heo 	u32 hash = wqattrs_hash(attrs);
473529c91e99STejun Heo 	struct worker_pool *pool;
473684193c07STejun Heo 	int pod, node = NUMA_NO_NODE;
473729c91e99STejun Heo 
4738a892caccSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
473929c91e99STejun Heo 
474029c91e99STejun Heo 	/* do we already have a matching pool? */
474129c91e99STejun Heo 	hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
474229c91e99STejun Heo 		if (wqattrs_equal(pool->attrs, attrs)) {
474329c91e99STejun Heo 			pool->refcnt++;
47443fb1823cSLai Jiangshan 			return pool;
474529c91e99STejun Heo 		}
474629c91e99STejun Heo 	}
474729c91e99STejun Heo 
47489546b29eSTejun Heo 	/* If __pod_cpumask is contained inside a NUMA pod, that's our node */
474984193c07STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++) {
47509546b29eSTejun Heo 		if (cpumask_subset(attrs->__pod_cpumask, pt->pod_cpus[pod])) {
475184193c07STejun Heo 			node = pt->pod_node[pod];
4752e2273584SXunlei Pang 			break;
4753e2273584SXunlei Pang 		}
4754e2273584SXunlei Pang 	}
4755e2273584SXunlei Pang 
475629c91e99STejun Heo 	/* nope, create a new one */
475784193c07STejun Heo 	pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, node);
475829c91e99STejun Heo 	if (!pool || init_worker_pool(pool) < 0)
475929c91e99STejun Heo 		goto fail;
476029c91e99STejun Heo 
476184193c07STejun Heo 	pool->node = node;
47625de7a03cSTejun Heo 	copy_workqueue_attrs(pool->attrs, attrs);
47635de7a03cSTejun Heo 	wqattrs_clear_for_pool(pool->attrs);
47642865a8fbSShaohua Li 
476529c91e99STejun Heo 	if (worker_pool_assign_id(pool) < 0)
476629c91e99STejun Heo 		goto fail;
476729c91e99STejun Heo 
476829c91e99STejun Heo 	/* create and start the initial worker */
47693347fa09STejun Heo 	if (wq_online && !create_worker(pool))
477029c91e99STejun Heo 		goto fail;
477129c91e99STejun Heo 
477229c91e99STejun Heo 	/* install */
477329c91e99STejun Heo 	hash_add(unbound_pool_hash, &pool->hash_node, hash);
47743fb1823cSLai Jiangshan 
477529c91e99STejun Heo 	return pool;
477629c91e99STejun Heo fail:
477729c91e99STejun Heo 	if (pool)
477829c91e99STejun Heo 		put_unbound_pool(pool);
477929c91e99STejun Heo 	return NULL;
478029c91e99STejun Heo }
478129c91e99STejun Heo 
47828864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu)
47838864b4e5STejun Heo {
47848864b4e5STejun Heo 	kmem_cache_free(pwq_cache,
47858864b4e5STejun Heo 			container_of(rcu, struct pool_workqueue, rcu));
47868864b4e5STejun Heo }
47878864b4e5STejun Heo 
47888864b4e5STejun Heo /*
4789967b494eSTejun Heo  * Scheduled on pwq_release_worker by put_pwq() when an unbound pwq hits zero
4790967b494eSTejun Heo  * refcnt and needs to be destroyed.
47918864b4e5STejun Heo  */
4792687a9aa5STejun Heo static void pwq_release_workfn(struct kthread_work *work)
47938864b4e5STejun Heo {
47948864b4e5STejun Heo 	struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
4795687a9aa5STejun Heo 						  release_work);
47968864b4e5STejun Heo 	struct workqueue_struct *wq = pwq->wq;
47978864b4e5STejun Heo 	struct worker_pool *pool = pwq->pool;
4798b42b0bddSYang Yingliang 	bool is_last = false;
47998864b4e5STejun Heo 
4800b42b0bddSYang Yingliang 	/*
4801687a9aa5STejun Heo 	 * When @pwq is not linked, it doesn't hold any reference to the
4802b42b0bddSYang Yingliang 	 * @wq, and @wq is invalid to access.
4803b42b0bddSYang Yingliang 	 */
4804b42b0bddSYang Yingliang 	if (!list_empty(&pwq->pwqs_node)) {
48053c25a55dSLai Jiangshan 		mutex_lock(&wq->mutex);
48068864b4e5STejun Heo 		list_del_rcu(&pwq->pwqs_node);
4807bc0caf09STejun Heo 		is_last = list_empty(&wq->pwqs);
48084c065dbcSWaiman Long 
48094c065dbcSWaiman Long 		/*
48104c065dbcSWaiman Long 		 * For ordered workqueue with a plugged dfl_pwq, restart it now.
48114c065dbcSWaiman Long 		 */
48124c065dbcSWaiman Long 		if (!is_last && (wq->flags & __WQ_ORDERED))
48134c065dbcSWaiman Long 			unplug_oldest_pwq(wq);
48144c065dbcSWaiman Long 
48153c25a55dSLai Jiangshan 		mutex_unlock(&wq->mutex);
4816b42b0bddSYang Yingliang 	}
48178864b4e5STejun Heo 
4818687a9aa5STejun Heo 	if (wq->flags & WQ_UNBOUND) {
4819a892caccSTejun Heo 		mutex_lock(&wq_pool_mutex);
48208864b4e5STejun Heo 		put_unbound_pool(pool);
4821a892caccSTejun Heo 		mutex_unlock(&wq_pool_mutex);
4822687a9aa5STejun Heo 	}
4823a892caccSTejun Heo 
48245797b1c1STejun Heo 	if (!list_empty(&pwq->pending_node)) {
48255797b1c1STejun Heo 		struct wq_node_nr_active *nna =
48265797b1c1STejun Heo 			wq_node_nr_active(pwq->wq, pwq->pool->node);
48275797b1c1STejun Heo 
48285797b1c1STejun Heo 		raw_spin_lock_irq(&nna->lock);
48295797b1c1STejun Heo 		list_del_init(&pwq->pending_node);
48305797b1c1STejun Heo 		raw_spin_unlock_irq(&nna->lock);
48315797b1c1STejun Heo 	}
48325797b1c1STejun Heo 
483325b00775SPaul E. McKenney 	call_rcu(&pwq->rcu, rcu_free_pwq);
48348864b4e5STejun Heo 
48358864b4e5STejun Heo 	/*
48368864b4e5STejun Heo 	 * If we're the last pwq going away, @wq is already dead and no one
4837e2dca7adSTejun Heo 	 * is gonna access it anymore.  Schedule RCU free.
48388864b4e5STejun Heo 	 */
4839669de8bdSBart Van Assche 	if (is_last) {
4840669de8bdSBart Van Assche 		wq_unregister_lockdep(wq);
484125b00775SPaul E. McKenney 		call_rcu(&wq->rcu, rcu_free_wq);
48426029a918STejun Heo 	}
4843669de8bdSBart Van Assche }
48448864b4e5STejun Heo 
484567dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */
4846f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
4847f147f29eSTejun Heo 		     struct worker_pool *pool)
4848d2c1d404STejun Heo {
4849d2c1d404STejun Heo 	BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
4850d2c1d404STejun Heo 
4851e50aba9aSTejun Heo 	memset(pwq, 0, sizeof(*pwq));
4852e50aba9aSTejun Heo 
4853d2c1d404STejun Heo 	pwq->pool = pool;
4854d2c1d404STejun Heo 	pwq->wq = wq;
4855d2c1d404STejun Heo 	pwq->flush_color = -1;
48568864b4e5STejun Heo 	pwq->refcnt = 1;
4857f97a4a1aSLai Jiangshan 	INIT_LIST_HEAD(&pwq->inactive_works);
48585797b1c1STejun Heo 	INIT_LIST_HEAD(&pwq->pending_node);
48591befcf30STejun Heo 	INIT_LIST_HEAD(&pwq->pwqs_node);
4860d2c1d404STejun Heo 	INIT_LIST_HEAD(&pwq->mayday_node);
4861687a9aa5STejun Heo 	kthread_init_work(&pwq->release_work, pwq_release_workfn);
4862f147f29eSTejun Heo }
4863d2c1d404STejun Heo 
4864f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */
48651befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq)
4866f147f29eSTejun Heo {
4867f147f29eSTejun Heo 	struct workqueue_struct *wq = pwq->wq;
4868f147f29eSTejun Heo 
4869f147f29eSTejun Heo 	lockdep_assert_held(&wq->mutex);
487075ccf595STejun Heo 
48711befcf30STejun Heo 	/* may be called multiple times, ignore if already linked */
48721befcf30STejun Heo 	if (!list_empty(&pwq->pwqs_node))
48731befcf30STejun Heo 		return;
48741befcf30STejun Heo 
487529b1cb41SLai Jiangshan 	/* set the matching work_color */
487675ccf595STejun Heo 	pwq->work_color = wq->work_color;
4877983ca25eSTejun Heo 
4878983ca25eSTejun Heo 	/* link in @pwq */
487926fb7e3dSWaiman Long 	list_add_tail_rcu(&pwq->pwqs_node, &wq->pwqs);
4880df2d5ae4STejun Heo }
48816029a918STejun Heo 
4882f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */
4883f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
4884f147f29eSTejun Heo 					const struct workqueue_attrs *attrs)
4885f147f29eSTejun Heo {
4886f147f29eSTejun Heo 	struct worker_pool *pool;
4887f147f29eSTejun Heo 	struct pool_workqueue *pwq;
4888f147f29eSTejun Heo 
4889f147f29eSTejun Heo 	lockdep_assert_held(&wq_pool_mutex);
4890f147f29eSTejun Heo 
4891f147f29eSTejun Heo 	pool = get_unbound_pool(attrs);
4892f147f29eSTejun Heo 	if (!pool)
4893f147f29eSTejun Heo 		return NULL;
4894f147f29eSTejun Heo 
4895e50aba9aSTejun Heo 	pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
4896f147f29eSTejun Heo 	if (!pwq) {
4897f147f29eSTejun Heo 		put_unbound_pool(pool);
4898f147f29eSTejun Heo 		return NULL;
4899f147f29eSTejun Heo 	}
4900f147f29eSTejun Heo 
4901f147f29eSTejun Heo 	init_pwq(pwq, wq, pool);
4902f147f29eSTejun Heo 	return pwq;
4903d2c1d404STejun Heo }
4904d2c1d404STejun Heo 
49054c16bd32STejun Heo /**
4906fef59c9cSTejun Heo  * wq_calc_pod_cpumask - calculate a wq_attrs' cpumask for a pod
4907042f7df1SLai Jiangshan  * @attrs: the wq_attrs of the default pwq of the target workqueue
490884193c07STejun Heo  * @cpu: the target CPU
49094c16bd32STejun Heo  * @cpu_going_down: if >= 0, the CPU to consider as offline
49104c16bd32STejun Heo  *
4911fef59c9cSTejun Heo  * Calculate the cpumask a workqueue with @attrs should use on @pod. If
4912fef59c9cSTejun Heo  * @cpu_going_down is >= 0, that cpu is considered offline during calculation.
49139546b29eSTejun Heo  * The result is stored in @attrs->__pod_cpumask.
49144c16bd32STejun Heo  *
4915fef59c9cSTejun Heo  * If pod affinity is not enabled, @attrs->cpumask is always used. If enabled
4916fef59c9cSTejun Heo  * and @pod has online CPUs requested by @attrs, the returned cpumask is the
4917fef59c9cSTejun Heo  * intersection of the possible CPUs of @pod and @attrs->cpumask.
49184c16bd32STejun Heo  *
4919fef59c9cSTejun Heo  * The caller is responsible for ensuring that the cpumask of @pod stays stable.
49204c16bd32STejun Heo  */
49219546b29eSTejun Heo static void wq_calc_pod_cpumask(struct workqueue_attrs *attrs, int cpu,
49229546b29eSTejun Heo 				int cpu_going_down)
49234c16bd32STejun Heo {
492484193c07STejun Heo 	const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
492584193c07STejun Heo 	int pod = pt->cpu_pod[cpu];
49264c16bd32STejun Heo 
4927fef59c9cSTejun Heo 	/* does @pod have any online CPUs @attrs wants? */
49289546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, pt->pod_cpus[pod], attrs->cpumask);
49299546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->__pod_cpumask, cpu_online_mask);
49304c16bd32STejun Heo 	if (cpu_going_down >= 0)
49319546b29eSTejun Heo 		cpumask_clear_cpu(cpu_going_down, attrs->__pod_cpumask);
49324c16bd32STejun Heo 
49339546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask)) {
49349546b29eSTejun Heo 		cpumask_copy(attrs->__pod_cpumask, attrs->cpumask);
493584193c07STejun Heo 		return;
493684193c07STejun Heo 	}
49374c16bd32STejun Heo 
4938fef59c9cSTejun Heo 	/* yeap, return possible CPUs in @pod that @attrs wants */
49399546b29eSTejun Heo 	cpumask_and(attrs->__pod_cpumask, attrs->cpumask, pt->pod_cpus[pod]);
49401ad0f0a7SMichael Bringmann 
49419546b29eSTejun Heo 	if (cpumask_empty(attrs->__pod_cpumask))
49421ad0f0a7SMichael Bringmann 		pr_warn_once("WARNING: workqueue cpumask: online intersect > "
49431ad0f0a7SMichael Bringmann 				"possible intersect\n");
49444c16bd32STejun Heo }
49454c16bd32STejun Heo 
49469f66cff2STejun Heo /* install @pwq into @wq and return the old pwq, @cpu < 0 for dfl_pwq */
4947636b927eSTejun Heo static struct pool_workqueue *install_unbound_pwq(struct workqueue_struct *wq,
4948636b927eSTejun Heo 					int cpu, struct pool_workqueue *pwq)
49491befcf30STejun Heo {
49509f66cff2STejun Heo 	struct pool_workqueue __rcu **slot = unbound_pwq_slot(wq, cpu);
49511befcf30STejun Heo 	struct pool_workqueue *old_pwq;
49521befcf30STejun Heo 
49535b95e1afSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
49541befcf30STejun Heo 	lockdep_assert_held(&wq->mutex);
49551befcf30STejun Heo 
49561befcf30STejun Heo 	/* link_pwq() can handle duplicate calls */
49571befcf30STejun Heo 	link_pwq(pwq);
49581befcf30STejun Heo 
49599f66cff2STejun Heo 	old_pwq = rcu_access_pointer(*slot);
49609f66cff2STejun Heo 	rcu_assign_pointer(*slot, pwq);
49611befcf30STejun Heo 	return old_pwq;
49621befcf30STejun Heo }
49631befcf30STejun Heo 
49642d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */
49652d5f0764SLai Jiangshan struct apply_wqattrs_ctx {
49662d5f0764SLai Jiangshan 	struct workqueue_struct	*wq;		/* target workqueue */
49672d5f0764SLai Jiangshan 	struct workqueue_attrs	*attrs;		/* attrs to apply */
4968042f7df1SLai Jiangshan 	struct list_head	list;		/* queued for batching commit */
49692d5f0764SLai Jiangshan 	struct pool_workqueue	*dfl_pwq;
49702d5f0764SLai Jiangshan 	struct pool_workqueue	*pwq_tbl[];
49712d5f0764SLai Jiangshan };
49722d5f0764SLai Jiangshan 
49732d5f0764SLai Jiangshan /* free the resources after success or abort */
49742d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx)
49752d5f0764SLai Jiangshan {
49762d5f0764SLai Jiangshan 	if (ctx) {
4977636b927eSTejun Heo 		int cpu;
49782d5f0764SLai Jiangshan 
4979636b927eSTejun Heo 		for_each_possible_cpu(cpu)
4980636b927eSTejun Heo 			put_pwq_unlocked(ctx->pwq_tbl[cpu]);
49812d5f0764SLai Jiangshan 		put_pwq_unlocked(ctx->dfl_pwq);
49822d5f0764SLai Jiangshan 
49832d5f0764SLai Jiangshan 		free_workqueue_attrs(ctx->attrs);
49842d5f0764SLai Jiangshan 
49852d5f0764SLai Jiangshan 		kfree(ctx);
49862d5f0764SLai Jiangshan 	}
49872d5f0764SLai Jiangshan }
49882d5f0764SLai Jiangshan 
49892d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */
49902d5f0764SLai Jiangshan static struct apply_wqattrs_ctx *
49912d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq,
499299c621efSLai Jiangshan 		      const struct workqueue_attrs *attrs,
499399c621efSLai Jiangshan 		      const cpumask_var_t unbound_cpumask)
49942d5f0764SLai Jiangshan {
49952d5f0764SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
49969546b29eSTejun Heo 	struct workqueue_attrs *new_attrs;
4997636b927eSTejun Heo 	int cpu;
49982d5f0764SLai Jiangshan 
49992d5f0764SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
50002d5f0764SLai Jiangshan 
500184193c07STejun Heo 	if (WARN_ON(attrs->affn_scope < 0 ||
500284193c07STejun Heo 		    attrs->affn_scope >= WQ_AFFN_NR_TYPES))
500384193c07STejun Heo 		return ERR_PTR(-EINVAL);
500484193c07STejun Heo 
5005636b927eSTejun Heo 	ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_cpu_ids), GFP_KERNEL);
50062d5f0764SLai Jiangshan 
5007be69d00dSThomas Gleixner 	new_attrs = alloc_workqueue_attrs();
50089546b29eSTejun Heo 	if (!ctx || !new_attrs)
50092d5f0764SLai Jiangshan 		goto out_free;
50102d5f0764SLai Jiangshan 
5011042f7df1SLai Jiangshan 	/*
50122d5f0764SLai Jiangshan 	 * If something goes wrong during CPU up/down, we'll fall back to
50132d5f0764SLai Jiangshan 	 * the default pwq covering whole @attrs->cpumask.  Always create
50142d5f0764SLai Jiangshan 	 * it even if we don't use it immediately.
50152d5f0764SLai Jiangshan 	 */
50160f36ee24STejun Heo 	copy_workqueue_attrs(new_attrs, attrs);
50170f36ee24STejun Heo 	wqattrs_actualize_cpumask(new_attrs, unbound_cpumask);
50189546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
50192d5f0764SLai Jiangshan 	ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
50202d5f0764SLai Jiangshan 	if (!ctx->dfl_pwq)
50212d5f0764SLai Jiangshan 		goto out_free;
50222d5f0764SLai Jiangshan 
5023636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
5024af73f5c9STejun Heo 		if (new_attrs->ordered) {
50252d5f0764SLai Jiangshan 			ctx->dfl_pwq->refcnt++;
5026636b927eSTejun Heo 			ctx->pwq_tbl[cpu] = ctx->dfl_pwq;
5027636b927eSTejun Heo 		} else {
50289546b29eSTejun Heo 			wq_calc_pod_cpumask(new_attrs, cpu, -1);
50299546b29eSTejun Heo 			ctx->pwq_tbl[cpu] = alloc_unbound_pwq(wq, new_attrs);
5030636b927eSTejun Heo 			if (!ctx->pwq_tbl[cpu])
5031636b927eSTejun Heo 				goto out_free;
50322d5f0764SLai Jiangshan 		}
50332d5f0764SLai Jiangshan 	}
50342d5f0764SLai Jiangshan 
5035042f7df1SLai Jiangshan 	/* save the user configured attrs and sanitize it. */
5036042f7df1SLai Jiangshan 	copy_workqueue_attrs(new_attrs, attrs);
5037042f7df1SLai Jiangshan 	cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
50389546b29eSTejun Heo 	cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask);
50392d5f0764SLai Jiangshan 	ctx->attrs = new_attrs;
5040042f7df1SLai Jiangshan 
50414c065dbcSWaiman Long 	/*
50424c065dbcSWaiman Long 	 * For initialized ordered workqueues, there should only be one pwq
50434c065dbcSWaiman Long 	 * (dfl_pwq). Set the plugged flag of ctx->dfl_pwq to suspend execution
50444c065dbcSWaiman Long 	 * of newly queued work items until execution of older work items in
50454c065dbcSWaiman Long 	 * the old pwq's have completed.
50464c065dbcSWaiman Long 	 */
50474c065dbcSWaiman Long 	if ((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs))
50484c065dbcSWaiman Long 		ctx->dfl_pwq->plugged = true;
50494c065dbcSWaiman Long 
50502d5f0764SLai Jiangshan 	ctx->wq = wq;
50512d5f0764SLai Jiangshan 	return ctx;
50522d5f0764SLai Jiangshan 
50532d5f0764SLai Jiangshan out_free:
50542d5f0764SLai Jiangshan 	free_workqueue_attrs(new_attrs);
50552d5f0764SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
505684193c07STejun Heo 	return ERR_PTR(-ENOMEM);
50572d5f0764SLai Jiangshan }
50582d5f0764SLai Jiangshan 
50592d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */
50602d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx)
50612d5f0764SLai Jiangshan {
5062636b927eSTejun Heo 	int cpu;
50632d5f0764SLai Jiangshan 
50642d5f0764SLai Jiangshan 	/* all pwqs have been created successfully, let's install'em */
50652d5f0764SLai Jiangshan 	mutex_lock(&ctx->wq->mutex);
50662d5f0764SLai Jiangshan 
50672d5f0764SLai Jiangshan 	copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs);
50682d5f0764SLai Jiangshan 
50699f66cff2STejun Heo 	/* save the previous pwqs and install the new ones */
5070636b927eSTejun Heo 	for_each_possible_cpu(cpu)
5071636b927eSTejun Heo 		ctx->pwq_tbl[cpu] = install_unbound_pwq(ctx->wq, cpu,
5072636b927eSTejun Heo 							ctx->pwq_tbl[cpu]);
50739f66cff2STejun Heo 	ctx->dfl_pwq = install_unbound_pwq(ctx->wq, -1, ctx->dfl_pwq);
50742d5f0764SLai Jiangshan 
50755797b1c1STejun Heo 	/* update node_nr_active->max */
50765797b1c1STejun Heo 	wq_update_node_max_active(ctx->wq, -1);
50775797b1c1STejun Heo 
5078d64f2fa0SJuri Lelli 	/* rescuer needs to respect wq cpumask changes */
5079d64f2fa0SJuri Lelli 	if (ctx->wq->rescuer)
5080d64f2fa0SJuri Lelli 		set_cpus_allowed_ptr(ctx->wq->rescuer->task,
5081d64f2fa0SJuri Lelli 				     unbound_effective_cpumask(ctx->wq));
5082d64f2fa0SJuri Lelli 
50832d5f0764SLai Jiangshan 	mutex_unlock(&ctx->wq->mutex);
50842d5f0764SLai Jiangshan }
50852d5f0764SLai Jiangshan 
5086a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq,
5087a0111cf6SLai Jiangshan 					const struct workqueue_attrs *attrs)
5088a0111cf6SLai Jiangshan {
5089a0111cf6SLai Jiangshan 	struct apply_wqattrs_ctx *ctx;
5090a0111cf6SLai Jiangshan 
5091a0111cf6SLai Jiangshan 	/* only unbound workqueues can change attributes */
5092a0111cf6SLai Jiangshan 	if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
5093a0111cf6SLai Jiangshan 		return -EINVAL;
5094a0111cf6SLai Jiangshan 
509599c621efSLai Jiangshan 	ctx = apply_wqattrs_prepare(wq, attrs, wq_unbound_cpumask);
509684193c07STejun Heo 	if (IS_ERR(ctx))
509784193c07STejun Heo 		return PTR_ERR(ctx);
5098a0111cf6SLai Jiangshan 
5099a0111cf6SLai Jiangshan 	/* the ctx has been prepared successfully, let's commit it */
5100a0111cf6SLai Jiangshan 	apply_wqattrs_commit(ctx);
5101a0111cf6SLai Jiangshan 	apply_wqattrs_cleanup(ctx);
5102a0111cf6SLai Jiangshan 
51036201171eSwanghaibin 	return 0;
5104a0111cf6SLai Jiangshan }
5105a0111cf6SLai Jiangshan 
51069e8cd2f5STejun Heo /**
51079e8cd2f5STejun Heo  * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
51089e8cd2f5STejun Heo  * @wq: the target workqueue
51099e8cd2f5STejun Heo  * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
51109e8cd2f5STejun Heo  *
5111fef59c9cSTejun Heo  * Apply @attrs to an unbound workqueue @wq. Unless disabled, this function maps
5112fef59c9cSTejun Heo  * a separate pwq to each CPU pod with possibles CPUs in @attrs->cpumask so that
5113fef59c9cSTejun Heo  * work items are affine to the pod it was issued on. Older pwqs are released as
5114fef59c9cSTejun Heo  * in-flight work items finish. Note that a work item which repeatedly requeues
5115fef59c9cSTejun Heo  * itself back-to-back will stay on its current pwq.
51169e8cd2f5STejun Heo  *
5117d185af30SYacine Belkadi  * Performs GFP_KERNEL allocations.
5118d185af30SYacine Belkadi  *
5119ffd8bea8SSebastian Andrzej Siewior  * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock().
5120509b3204SDaniel Jordan  *
5121d185af30SYacine Belkadi  * Return: 0 on success and -errno on failure.
51229e8cd2f5STejun Heo  */
5123513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq,
51249e8cd2f5STejun Heo 			  const struct workqueue_attrs *attrs)
51259e8cd2f5STejun Heo {
5126a0111cf6SLai Jiangshan 	int ret;
51279e8cd2f5STejun Heo 
5128509b3204SDaniel Jordan 	lockdep_assert_cpus_held();
5129509b3204SDaniel Jordan 
5130509b3204SDaniel Jordan 	mutex_lock(&wq_pool_mutex);
5131a0111cf6SLai Jiangshan 	ret = apply_workqueue_attrs_locked(wq, attrs);
5132509b3204SDaniel Jordan 	mutex_unlock(&wq_pool_mutex);
51332d5f0764SLai Jiangshan 
51342d5f0764SLai Jiangshan 	return ret;
51359e8cd2f5STejun Heo }
51369e8cd2f5STejun Heo 
51374c16bd32STejun Heo /**
5138fef59c9cSTejun Heo  * wq_update_pod - update pod affinity of a wq for CPU hot[un]plug
51394c16bd32STejun Heo  * @wq: the target workqueue
51404cbfd3deSTejun Heo  * @cpu: the CPU to update pool association for
51414cbfd3deSTejun Heo  * @hotplug_cpu: the CPU coming up or going down
51424c16bd32STejun Heo  * @online: whether @cpu is coming up or going down
51434c16bd32STejun Heo  *
51444c16bd32STejun Heo  * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
5145fef59c9cSTejun Heo  * %CPU_DOWN_FAILED.  @cpu is being hot[un]plugged, update pod affinity of
51464c16bd32STejun Heo  * @wq accordingly.
51474c16bd32STejun Heo  *
51484c16bd32STejun Heo  *
5149fef59c9cSTejun Heo  * If pod affinity can't be adjusted due to memory allocation failure, it falls
5150fef59c9cSTejun Heo  * back to @wq->dfl_pwq which may not be optimal but is always correct.
5151fef59c9cSTejun Heo  *
5152fef59c9cSTejun Heo  * Note that when the last allowed CPU of a pod goes offline for a workqueue
5153fef59c9cSTejun Heo  * with a cpumask spanning multiple pods, the workers which were already
5154fef59c9cSTejun Heo  * executing the work items for the workqueue will lose their CPU affinity and
5155fef59c9cSTejun Heo  * may execute on any CPU. This is similar to how per-cpu workqueues behave on
5156fef59c9cSTejun Heo  * CPU_DOWN. If a workqueue user wants strict affinity, it's the user's
5157fef59c9cSTejun Heo  * responsibility to flush the work item from CPU_DOWN_PREPARE.
51584c16bd32STejun Heo  */
5159fef59c9cSTejun Heo static void wq_update_pod(struct workqueue_struct *wq, int cpu,
51604cbfd3deSTejun Heo 			  int hotplug_cpu, bool online)
51614c16bd32STejun Heo {
51624cbfd3deSTejun Heo 	int off_cpu = online ? -1 : hotplug_cpu;
51634c16bd32STejun Heo 	struct pool_workqueue *old_pwq = NULL, *pwq;
51644c16bd32STejun Heo 	struct workqueue_attrs *target_attrs;
51654c16bd32STejun Heo 
51664c16bd32STejun Heo 	lockdep_assert_held(&wq_pool_mutex);
51674c16bd32STejun Heo 
516884193c07STejun Heo 	if (!(wq->flags & WQ_UNBOUND) || wq->unbound_attrs->ordered)
51694c16bd32STejun Heo 		return;
51704c16bd32STejun Heo 
51714c16bd32STejun Heo 	/*
51724c16bd32STejun Heo 	 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
51734c16bd32STejun Heo 	 * Let's use a preallocated one.  The following buf is protected by
51744c16bd32STejun Heo 	 * CPU hotplug exclusion.
51754c16bd32STejun Heo 	 */
5176fef59c9cSTejun Heo 	target_attrs = wq_update_pod_attrs_buf;
51774c16bd32STejun Heo 
51784c16bd32STejun Heo 	copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
51790f36ee24STejun Heo 	wqattrs_actualize_cpumask(target_attrs, wq_unbound_cpumask);
51804c16bd32STejun Heo 
5181636b927eSTejun Heo 	/* nothing to do if the target cpumask matches the current pwq */
51829546b29eSTejun Heo 	wq_calc_pod_cpumask(target_attrs, cpu, off_cpu);
51839f66cff2STejun Heo 	if (wqattrs_equal(target_attrs, unbound_pwq(wq, cpu)->pool->attrs))
5184f7142ed4SLai Jiangshan 		return;
51854c16bd32STejun Heo 
51864c16bd32STejun Heo 	/* create a new pwq */
51874c16bd32STejun Heo 	pwq = alloc_unbound_pwq(wq, target_attrs);
51884c16bd32STejun Heo 	if (!pwq) {
5189fef59c9cSTejun Heo 		pr_warn("workqueue: allocation failed while updating CPU pod affinity of \"%s\"\n",
51904c16bd32STejun Heo 			wq->name);
519177f300b1SDaeseok Youn 		goto use_dfl_pwq;
51924c16bd32STejun Heo 	}
51934c16bd32STejun Heo 
5194f7142ed4SLai Jiangshan 	/* Install the new pwq. */
51954c16bd32STejun Heo 	mutex_lock(&wq->mutex);
5196636b927eSTejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, pwq);
51974c16bd32STejun Heo 	goto out_unlock;
51984c16bd32STejun Heo 
51994c16bd32STejun Heo use_dfl_pwq:
5200f7142ed4SLai Jiangshan 	mutex_lock(&wq->mutex);
52019f66cff2STejun Heo 	pwq = unbound_pwq(wq, -1);
52029f66cff2STejun Heo 	raw_spin_lock_irq(&pwq->pool->lock);
52039f66cff2STejun Heo 	get_pwq(pwq);
52049f66cff2STejun Heo 	raw_spin_unlock_irq(&pwq->pool->lock);
52059f66cff2STejun Heo 	old_pwq = install_unbound_pwq(wq, cpu, pwq);
52064c16bd32STejun Heo out_unlock:
52074c16bd32STejun Heo 	mutex_unlock(&wq->mutex);
52084c16bd32STejun Heo 	put_pwq_unlocked(old_pwq);
52094c16bd32STejun Heo }
52104c16bd32STejun Heo 
521130cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq)
52121da177e4SLinus Torvalds {
521349e3cf44STejun Heo 	bool highpri = wq->flags & WQ_HIGHPRI;
52148a2b7538STejun Heo 	int cpu, ret;
5215e1d8aa9fSFrederic Weisbecker 
5216687a9aa5STejun Heo 	wq->cpu_pwq = alloc_percpu(struct pool_workqueue *);
5217ee1ceef7STejun Heo 	if (!wq->cpu_pwq)
5218687a9aa5STejun Heo 		goto enomem;
521930cdf249STejun Heo 
5220636b927eSTejun Heo 	if (!(wq->flags & WQ_UNBOUND)) {
522130cdf249STejun Heo 		for_each_possible_cpu(cpu) {
52224cb1ef64STejun Heo 			struct pool_workqueue **pwq_p;
52234cb1ef64STejun Heo 			struct worker_pool __percpu *pools;
52244cb1ef64STejun Heo 			struct worker_pool *pool;
52254cb1ef64STejun Heo 
52264cb1ef64STejun Heo 			if (wq->flags & WQ_BH)
52274cb1ef64STejun Heo 				pools = bh_worker_pools;
52284cb1ef64STejun Heo 			else
52294cb1ef64STejun Heo 				pools = cpu_worker_pools;
52304cb1ef64STejun Heo 
52314cb1ef64STejun Heo 			pool = &(per_cpu_ptr(pools, cpu)[highpri]);
52324cb1ef64STejun Heo 			pwq_p = per_cpu_ptr(wq->cpu_pwq, cpu);
523330cdf249STejun Heo 
5234687a9aa5STejun Heo 			*pwq_p = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL,
5235687a9aa5STejun Heo 						       pool->node);
5236687a9aa5STejun Heo 			if (!*pwq_p)
5237687a9aa5STejun Heo 				goto enomem;
5238687a9aa5STejun Heo 
5239687a9aa5STejun Heo 			init_pwq(*pwq_p, wq, pool);
5240f147f29eSTejun Heo 
5241f147f29eSTejun Heo 			mutex_lock(&wq->mutex);
5242687a9aa5STejun Heo 			link_pwq(*pwq_p);
5243f147f29eSTejun Heo 			mutex_unlock(&wq->mutex);
524430cdf249STejun Heo 		}
524530cdf249STejun Heo 		return 0;
5246509b3204SDaniel Jordan 	}
5247509b3204SDaniel Jordan 
5248ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
5249509b3204SDaniel Jordan 	if (wq->flags & __WQ_ORDERED) {
52509f66cff2STejun Heo 		struct pool_workqueue *dfl_pwq;
52519f66cff2STejun Heo 
52528a2b7538STejun Heo 		ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
52538a2b7538STejun Heo 		/* there should only be single pwq for ordering guarantee */
52549f66cff2STejun Heo 		dfl_pwq = rcu_access_pointer(wq->dfl_pwq);
52559f66cff2STejun Heo 		WARN(!ret && (wq->pwqs.next != &dfl_pwq->pwqs_node ||
52569f66cff2STejun Heo 			      wq->pwqs.prev != &dfl_pwq->pwqs_node),
52578a2b7538STejun Heo 		     "ordering guarantee broken for workqueue %s\n", wq->name);
52589e8cd2f5STejun Heo 	} else {
5259509b3204SDaniel Jordan 		ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
52609e8cd2f5STejun Heo 	}
5261ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
5262509b3204SDaniel Jordan 
526364344553SZqiang 	/* for unbound pwq, flush the pwq_release_worker ensures that the
526464344553SZqiang 	 * pwq_release_workfn() completes before calling kfree(wq).
526564344553SZqiang 	 */
526664344553SZqiang 	if (ret)
526764344553SZqiang 		kthread_flush_worker(pwq_release_worker);
526864344553SZqiang 
5269509b3204SDaniel Jordan 	return ret;
5270687a9aa5STejun Heo 
5271687a9aa5STejun Heo enomem:
5272687a9aa5STejun Heo 	if (wq->cpu_pwq) {
52737b42f401SZqiang 		for_each_possible_cpu(cpu) {
52747b42f401SZqiang 			struct pool_workqueue *pwq = *per_cpu_ptr(wq->cpu_pwq, cpu);
52757b42f401SZqiang 
52767b42f401SZqiang 			if (pwq)
52777b42f401SZqiang 				kmem_cache_free(pwq_cache, pwq);
52787b42f401SZqiang 		}
5279687a9aa5STejun Heo 		free_percpu(wq->cpu_pwq);
5280687a9aa5STejun Heo 		wq->cpu_pwq = NULL;
5281687a9aa5STejun Heo 	}
5282687a9aa5STejun Heo 	return -ENOMEM;
52830f900049STejun Heo }
52840f900049STejun Heo 
5285f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags,
5286f3421797STejun Heo 			       const char *name)
5287b71ab8c2STejun Heo {
5288636b927eSTejun Heo 	if (max_active < 1 || max_active > WQ_MAX_ACTIVE)
5289044c782cSValentin Ilie 		pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
5290636b927eSTejun Heo 			max_active, name, 1, WQ_MAX_ACTIVE);
5291b71ab8c2STejun Heo 
5292636b927eSTejun Heo 	return clamp_val(max_active, 1, WQ_MAX_ACTIVE);
5293b71ab8c2STejun Heo }
5294b71ab8c2STejun Heo 
5295983c7515STejun Heo /*
5296983c7515STejun Heo  * Workqueues which may be used during memory reclaim should have a rescuer
5297983c7515STejun Heo  * to guarantee forward progress.
5298983c7515STejun Heo  */
5299983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq)
5300983c7515STejun Heo {
5301983c7515STejun Heo 	struct worker *rescuer;
5302b92b36eaSDan Carpenter 	int ret;
5303983c7515STejun Heo 
5304983c7515STejun Heo 	if (!(wq->flags & WQ_MEM_RECLAIM))
5305983c7515STejun Heo 		return 0;
5306983c7515STejun Heo 
5307983c7515STejun Heo 	rescuer = alloc_worker(NUMA_NO_NODE);
53084c0736a7SPetr Mladek 	if (!rescuer) {
53094c0736a7SPetr Mladek 		pr_err("workqueue: Failed to allocate a rescuer for wq \"%s\"\n",
53104c0736a7SPetr Mladek 		       wq->name);
5311983c7515STejun Heo 		return -ENOMEM;
53124c0736a7SPetr Mladek 	}
5313983c7515STejun Heo 
5314983c7515STejun Heo 	rescuer->rescue_wq = wq;
5315b6a46f72SAaron Tomlin 	rescuer->task = kthread_create(rescuer_thread, rescuer, "kworker/R-%s", wq->name);
5316f187b697SSean Fu 	if (IS_ERR(rescuer->task)) {
5317b92b36eaSDan Carpenter 		ret = PTR_ERR(rescuer->task);
53184c0736a7SPetr Mladek 		pr_err("workqueue: Failed to create a rescuer kthread for wq \"%s\": %pe",
53194c0736a7SPetr Mladek 		       wq->name, ERR_PTR(ret));
5320983c7515STejun Heo 		kfree(rescuer);
5321b92b36eaSDan Carpenter 		return ret;
5322983c7515STejun Heo 	}
5323983c7515STejun Heo 
5324983c7515STejun Heo 	wq->rescuer = rescuer;
532585f0ab43SJuri Lelli 	if (wq->flags & WQ_UNBOUND)
532649584bb8SWaiman Long 		kthread_bind_mask(rescuer->task, wq_unbound_cpumask);
532785f0ab43SJuri Lelli 	else
5328983c7515STejun Heo 		kthread_bind_mask(rescuer->task, cpu_possible_mask);
5329983c7515STejun Heo 	wake_up_process(rescuer->task);
5330983c7515STejun Heo 
5331983c7515STejun Heo 	return 0;
5332983c7515STejun Heo }
5333983c7515STejun Heo 
5334a045a272STejun Heo /**
5335a045a272STejun Heo  * wq_adjust_max_active - update a wq's max_active to the current setting
5336a045a272STejun Heo  * @wq: target workqueue
5337a045a272STejun Heo  *
5338a045a272STejun Heo  * If @wq isn't freezing, set @wq->max_active to the saved_max_active and
5339a045a272STejun Heo  * activate inactive work items accordingly. If @wq is freezing, clear
5340a045a272STejun Heo  * @wq->max_active to zero.
5341a045a272STejun Heo  */
5342a045a272STejun Heo static void wq_adjust_max_active(struct workqueue_struct *wq)
5343a045a272STejun Heo {
5344c5404d4eSTejun Heo 	bool activated;
53455797b1c1STejun Heo 	int new_max, new_min;
5346a045a272STejun Heo 
5347a045a272STejun Heo 	lockdep_assert_held(&wq->mutex);
5348a045a272STejun Heo 
5349a045a272STejun Heo 	if ((wq->flags & WQ_FREEZABLE) && workqueue_freezing) {
53505797b1c1STejun Heo 		new_max = 0;
53515797b1c1STejun Heo 		new_min = 0;
53525797b1c1STejun Heo 	} else {
53535797b1c1STejun Heo 		new_max = wq->saved_max_active;
53545797b1c1STejun Heo 		new_min = wq->saved_min_active;
5355a045a272STejun Heo 	}
5356a045a272STejun Heo 
53575797b1c1STejun Heo 	if (wq->max_active == new_max && wq->min_active == new_min)
5358a045a272STejun Heo 		return;
5359a045a272STejun Heo 
5360a045a272STejun Heo 	/*
53615797b1c1STejun Heo 	 * Update @wq->max/min_active and then kick inactive work items if more
5362a045a272STejun Heo 	 * active work items are allowed. This doesn't break work item ordering
5363a045a272STejun Heo 	 * because new work items are always queued behind existing inactive
5364a045a272STejun Heo 	 * work items if there are any.
5365a045a272STejun Heo 	 */
53665797b1c1STejun Heo 	WRITE_ONCE(wq->max_active, new_max);
53675797b1c1STejun Heo 	WRITE_ONCE(wq->min_active, new_min);
53685797b1c1STejun Heo 
53695797b1c1STejun Heo 	if (wq->flags & WQ_UNBOUND)
53705797b1c1STejun Heo 		wq_update_node_max_active(wq, -1);
53715797b1c1STejun Heo 
53725797b1c1STejun Heo 	if (new_max == 0)
53735797b1c1STejun Heo 		return;
5374a045a272STejun Heo 
5375c5404d4eSTejun Heo 	/*
5376c5404d4eSTejun Heo 	 * Round-robin through pwq's activating the first inactive work item
5377c5404d4eSTejun Heo 	 * until max_active is filled.
5378c5404d4eSTejun Heo 	 */
5379c5404d4eSTejun Heo 	do {
5380c5404d4eSTejun Heo 		struct pool_workqueue *pwq;
5381c5404d4eSTejun Heo 
5382c5404d4eSTejun Heo 		activated = false;
5383a045a272STejun Heo 		for_each_pwq(pwq, wq) {
5384*c26e2f2eSTejun Heo 			unsigned long irq_flags;
5385a045a272STejun Heo 
5386c5404d4eSTejun Heo 			/* can be called during early boot w/ irq disabled */
5387*c26e2f2eSTejun Heo 			raw_spin_lock_irqsave(&pwq->pool->lock, irq_flags);
53885797b1c1STejun Heo 			if (pwq_activate_first_inactive(pwq, true)) {
5389c5404d4eSTejun Heo 				activated = true;
5390a045a272STejun Heo 				kick_pool(pwq->pool);
5391c5404d4eSTejun Heo 			}
5392*c26e2f2eSTejun Heo 			raw_spin_unlock_irqrestore(&pwq->pool->lock, irq_flags);
5393a045a272STejun Heo 		}
5394c5404d4eSTejun Heo 	} while (activated);
5395a045a272STejun Heo }
5396a045a272STejun Heo 
5397a2775bbcSMathieu Malaterre __printf(1, 4)
5398669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt,
539997e37d7bSTejun Heo 					 unsigned int flags,
5400669de8bdSBart Van Assche 					 int max_active, ...)
54013af24433SOleg Nesterov {
5402ecf6881fSTejun Heo 	va_list args;
54033af24433SOleg Nesterov 	struct workqueue_struct *wq;
540491ccc6e7STejun Heo 	size_t wq_size;
540591ccc6e7STejun Heo 	int name_len;
5406b196be89STejun Heo 
54074cb1ef64STejun Heo 	if (flags & WQ_BH) {
54084cb1ef64STejun Heo 		if (WARN_ON_ONCE(flags & ~__WQ_BH_ALLOWS))
54094cb1ef64STejun Heo 			return NULL;
54104cb1ef64STejun Heo 		if (WARN_ON_ONCE(max_active))
54114cb1ef64STejun Heo 			return NULL;
54124cb1ef64STejun Heo 	}
54134cb1ef64STejun Heo 
5414cee22a15SViresh Kumar 	/* see the comment above the definition of WQ_POWER_EFFICIENT */
5415cee22a15SViresh Kumar 	if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
5416cee22a15SViresh Kumar 		flags |= WQ_UNBOUND;
5417cee22a15SViresh Kumar 
5418ecf6881fSTejun Heo 	/* allocate wq and format name */
541991ccc6e7STejun Heo 	if (flags & WQ_UNBOUND)
542091ccc6e7STejun Heo 		wq_size = struct_size(wq, node_nr_active, nr_node_ids + 1);
542191ccc6e7STejun Heo 	else
542291ccc6e7STejun Heo 		wq_size = sizeof(*wq);
542391ccc6e7STejun Heo 
542491ccc6e7STejun Heo 	wq = kzalloc(wq_size, GFP_KERNEL);
5425b196be89STejun Heo 	if (!wq)
5426d2c1d404STejun Heo 		return NULL;
5427b196be89STejun Heo 
54286029a918STejun Heo 	if (flags & WQ_UNBOUND) {
5429be69d00dSThomas Gleixner 		wq->unbound_attrs = alloc_workqueue_attrs();
54306029a918STejun Heo 		if (!wq->unbound_attrs)
54316029a918STejun Heo 			goto err_free_wq;
54326029a918STejun Heo 	}
54336029a918STejun Heo 
5434669de8bdSBart Van Assche 	va_start(args, max_active);
543591ccc6e7STejun Heo 	name_len = vsnprintf(wq->name, sizeof(wq->name), fmt, args);
5436b196be89STejun Heo 	va_end(args);
54373af24433SOleg Nesterov 
543891ccc6e7STejun Heo 	if (name_len >= WQ_NAME_LEN)
543991ccc6e7STejun Heo 		pr_warn_once("workqueue: name exceeds WQ_NAME_LEN. Truncating to: %s\n",
544091ccc6e7STejun Heo 			     wq->name);
544131c89007SAudra Mitchell 
54424cb1ef64STejun Heo 	if (flags & WQ_BH) {
54434cb1ef64STejun Heo 		/*
54444cb1ef64STejun Heo 		 * BH workqueues always share a single execution context per CPU
54454cb1ef64STejun Heo 		 * and don't impose any max_active limit.
54464cb1ef64STejun Heo 		 */
54474cb1ef64STejun Heo 		max_active = INT_MAX;
54484cb1ef64STejun Heo 	} else {
5449d320c038STejun Heo 		max_active = max_active ?: WQ_DFL_ACTIVE;
5450b196be89STejun Heo 		max_active = wq_clamp_max_active(max_active, flags, wq->name);
54514cb1ef64STejun Heo 	}
54523af24433SOleg Nesterov 
5453b196be89STejun Heo 	/* init wq */
545497e37d7bSTejun Heo 	wq->flags = flags;
5455a045a272STejun Heo 	wq->max_active = max_active;
54565797b1c1STejun Heo 	wq->min_active = min(max_active, WQ_DFL_MIN_ACTIVE);
54575797b1c1STejun Heo 	wq->saved_max_active = wq->max_active;
54585797b1c1STejun Heo 	wq->saved_min_active = wq->min_active;
54593c25a55dSLai Jiangshan 	mutex_init(&wq->mutex);
5460112202d9STejun Heo 	atomic_set(&wq->nr_pwqs_to_flush, 0);
546130cdf249STejun Heo 	INIT_LIST_HEAD(&wq->pwqs);
546273f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_queue);
546373f53c4aSTejun Heo 	INIT_LIST_HEAD(&wq->flusher_overflow);
5464493a1724STejun Heo 	INIT_LIST_HEAD(&wq->maydays);
54653af24433SOleg Nesterov 
5466669de8bdSBart Van Assche 	wq_init_lockdep(wq);
5467cce1a165SOleg Nesterov 	INIT_LIST_HEAD(&wq->list);
54683af24433SOleg Nesterov 
546991ccc6e7STejun Heo 	if (flags & WQ_UNBOUND) {
547091ccc6e7STejun Heo 		if (alloc_node_nr_active(wq->node_nr_active) < 0)
547182efcab3SBart Van Assche 			goto err_unreg_lockdep;
547291ccc6e7STejun Heo 	}
547391ccc6e7STejun Heo 
547491ccc6e7STejun Heo 	if (alloc_and_link_pwqs(wq) < 0)
547591ccc6e7STejun Heo 		goto err_free_node_nr_active;
54761537663fSTejun Heo 
547740c17f75STejun Heo 	if (wq_online && init_rescuer(wq) < 0)
5478d2c1d404STejun Heo 		goto err_destroy;
5479e22bee78STejun Heo 
5480226223abSTejun Heo 	if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
5481226223abSTejun Heo 		goto err_destroy;
5482226223abSTejun Heo 
54836af8bf3dSOleg Nesterov 	/*
548468e13a67SLai Jiangshan 	 * wq_pool_mutex protects global freeze state and workqueues list.
548568e13a67SLai Jiangshan 	 * Grab it, adjust max_active and add the new @wq to workqueues
548668e13a67SLai Jiangshan 	 * list.
54876af8bf3dSOleg Nesterov 	 */
548868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
5489a0a1a5fdSTejun Heo 
5490a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
5491a045a272STejun Heo 	wq_adjust_max_active(wq);
5492a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
5493a0a1a5fdSTejun Heo 
5494e2dca7adSTejun Heo 	list_add_tail_rcu(&wq->list, &workqueues);
5495a0a1a5fdSTejun Heo 
549668e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
54973af24433SOleg Nesterov 
54983af24433SOleg Nesterov 	return wq;
5499d2c1d404STejun Heo 
550091ccc6e7STejun Heo err_free_node_nr_active:
550191ccc6e7STejun Heo 	if (wq->flags & WQ_UNBOUND)
550291ccc6e7STejun Heo 		free_node_nr_active(wq->node_nr_active);
550382efcab3SBart Van Assche err_unreg_lockdep:
5504009bb421SBart Van Assche 	wq_unregister_lockdep(wq);
5505009bb421SBart Van Assche 	wq_free_lockdep(wq);
550682efcab3SBart Van Assche err_free_wq:
55076029a918STejun Heo 	free_workqueue_attrs(wq->unbound_attrs);
55084690c4abSTejun Heo 	kfree(wq);
5509d2c1d404STejun Heo 	return NULL;
5510d2c1d404STejun Heo err_destroy:
5511d2c1d404STejun Heo 	destroy_workqueue(wq);
55124690c4abSTejun Heo 	return NULL;
55131da177e4SLinus Torvalds }
5514669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue);
55151da177e4SLinus Torvalds 
5516c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq)
5517c29eb853STejun Heo {
5518c29eb853STejun Heo 	int i;
5519c29eb853STejun Heo 
5520c29eb853STejun Heo 	for (i = 0; i < WORK_NR_COLORS; i++)
5521c29eb853STejun Heo 		if (pwq->nr_in_flight[i])
5522c29eb853STejun Heo 			return true;
5523c29eb853STejun Heo 
55249f66cff2STejun Heo 	if ((pwq != rcu_access_pointer(pwq->wq->dfl_pwq)) && (pwq->refcnt > 1))
5525c29eb853STejun Heo 		return true;
5526afa87ce8STejun Heo 	if (!pwq_is_empty(pwq))
5527c29eb853STejun Heo 		return true;
5528c29eb853STejun Heo 
5529c29eb853STejun Heo 	return false;
5530c29eb853STejun Heo }
5531c29eb853STejun Heo 
55323af24433SOleg Nesterov /**
55333af24433SOleg Nesterov  * destroy_workqueue - safely terminate a workqueue
55343af24433SOleg Nesterov  * @wq: target workqueue
55353af24433SOleg Nesterov  *
55363af24433SOleg Nesterov  * Safely destroy a workqueue. All work currently pending will be done first.
55373af24433SOleg Nesterov  */
55383af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq)
55393af24433SOleg Nesterov {
554049e3cf44STejun Heo 	struct pool_workqueue *pwq;
5541636b927eSTejun Heo 	int cpu;
55423af24433SOleg Nesterov 
5543def98c84STejun Heo 	/*
5544def98c84STejun Heo 	 * Remove it from sysfs first so that sanity check failure doesn't
5545def98c84STejun Heo 	 * lead to sysfs name conflicts.
5546def98c84STejun Heo 	 */
5547def98c84STejun Heo 	workqueue_sysfs_unregister(wq);
5548def98c84STejun Heo 
554933e3f0a3SRichard Clark 	/* mark the workqueue destruction is in progress */
555033e3f0a3SRichard Clark 	mutex_lock(&wq->mutex);
555133e3f0a3SRichard Clark 	wq->flags |= __WQ_DESTROYING;
555233e3f0a3SRichard Clark 	mutex_unlock(&wq->mutex);
555333e3f0a3SRichard Clark 
55549c5a2ba7STejun Heo 	/* drain it before proceeding with destruction */
55559c5a2ba7STejun Heo 	drain_workqueue(wq);
5556c8efcc25STejun Heo 
5557def98c84STejun Heo 	/* kill rescuer, if sanity checks fail, leave it w/o rescuer */
5558def98c84STejun Heo 	if (wq->rescuer) {
5559def98c84STejun Heo 		struct worker *rescuer = wq->rescuer;
5560def98c84STejun Heo 
5561def98c84STejun Heo 		/* this prevents new queueing */
5562a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&wq_mayday_lock);
5563def98c84STejun Heo 		wq->rescuer = NULL;
5564a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&wq_mayday_lock);
5565def98c84STejun Heo 
5566def98c84STejun Heo 		/* rescuer will empty maydays list before exiting */
5567def98c84STejun Heo 		kthread_stop(rescuer->task);
55688efe1223STejun Heo 		kfree(rescuer);
5569def98c84STejun Heo 	}
5570def98c84STejun Heo 
5571c29eb853STejun Heo 	/*
5572c29eb853STejun Heo 	 * Sanity checks - grab all the locks so that we wait for all
5573c29eb853STejun Heo 	 * in-flight operations which may do put_pwq().
5574c29eb853STejun Heo 	 */
5575c29eb853STejun Heo 	mutex_lock(&wq_pool_mutex);
5576b09f4fd3SLai Jiangshan 	mutex_lock(&wq->mutex);
557749e3cf44STejun Heo 	for_each_pwq(pwq, wq) {
5578a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pwq->pool->lock);
5579c29eb853STejun Heo 		if (WARN_ON(pwq_busy(pwq))) {
55801d9a6159SKefeng Wang 			pr_warn("%s: %s has the following busy pwq\n",
5581e66b39afSTejun Heo 				__func__, wq->name);
5582c29eb853STejun Heo 			show_pwq(pwq);
5583a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pwq->pool->lock);
5584b09f4fd3SLai Jiangshan 			mutex_unlock(&wq->mutex);
5585c29eb853STejun Heo 			mutex_unlock(&wq_pool_mutex);
558655df0933SImran Khan 			show_one_workqueue(wq);
55876183c009STejun Heo 			return;
558876af4d93STejun Heo 		}
5589a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pwq->pool->lock);
559076af4d93STejun Heo 	}
5591b09f4fd3SLai Jiangshan 	mutex_unlock(&wq->mutex);
55926183c009STejun Heo 
5593a0a1a5fdSTejun Heo 	/*
5594a0a1a5fdSTejun Heo 	 * wq list is used to freeze wq, remove from list after
5595a0a1a5fdSTejun Heo 	 * flushing is complete in case freeze races us.
5596a0a1a5fdSTejun Heo 	 */
5597e2dca7adSTejun Heo 	list_del_rcu(&wq->list);
559868e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
55993af24433SOleg Nesterov 
56008864b4e5STejun Heo 	/*
5601636b927eSTejun Heo 	 * We're the sole accessor of @wq. Directly access cpu_pwq and dfl_pwq
5602636b927eSTejun Heo 	 * to put the base refs. @wq will be auto-destroyed from the last
5603636b927eSTejun Heo 	 * pwq_put. RCU read lock prevents @wq from going away from under us.
56048864b4e5STejun Heo 	 */
5605636b927eSTejun Heo 	rcu_read_lock();
5606636b927eSTejun Heo 
5607636b927eSTejun Heo 	for_each_possible_cpu(cpu) {
56089f66cff2STejun Heo 		put_pwq_unlocked(unbound_pwq(wq, cpu));
56099f66cff2STejun Heo 		RCU_INIT_POINTER(*unbound_pwq_slot(wq, cpu), NULL);
56104c16bd32STejun Heo 	}
56114c16bd32STejun Heo 
56129f66cff2STejun Heo 	put_pwq_unlocked(unbound_pwq(wq, -1));
56139f66cff2STejun Heo 	RCU_INIT_POINTER(*unbound_pwq_slot(wq, -1), NULL);
5614636b927eSTejun Heo 
5615636b927eSTejun Heo 	rcu_read_unlock();
56163af24433SOleg Nesterov }
56173af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue);
56183af24433SOleg Nesterov 
5619dcd989cbSTejun Heo /**
5620dcd989cbSTejun Heo  * workqueue_set_max_active - adjust max_active of a workqueue
5621dcd989cbSTejun Heo  * @wq: target workqueue
5622dcd989cbSTejun Heo  * @max_active: new max_active value.
5623dcd989cbSTejun Heo  *
56245797b1c1STejun Heo  * Set max_active of @wq to @max_active. See the alloc_workqueue() function
56255797b1c1STejun Heo  * comment.
5626dcd989cbSTejun Heo  *
5627dcd989cbSTejun Heo  * CONTEXT:
5628dcd989cbSTejun Heo  * Don't call from IRQ context.
5629dcd989cbSTejun Heo  */
5630dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
5631dcd989cbSTejun Heo {
56324cb1ef64STejun Heo 	/* max_active doesn't mean anything for BH workqueues */
56334cb1ef64STejun Heo 	if (WARN_ON(wq->flags & WQ_BH))
56344cb1ef64STejun Heo 		return;
56358719dceaSTejun Heo 	/* disallow meddling with max_active for ordered workqueues */
56363bc1e711STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
56378719dceaSTejun Heo 		return;
56388719dceaSTejun Heo 
5639f3421797STejun Heo 	max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
5640dcd989cbSTejun Heo 
5641a357fc03SLai Jiangshan 	mutex_lock(&wq->mutex);
5642dcd989cbSTejun Heo 
5643dcd989cbSTejun Heo 	wq->saved_max_active = max_active;
56445797b1c1STejun Heo 	if (wq->flags & WQ_UNBOUND)
56455797b1c1STejun Heo 		wq->saved_min_active = min(wq->saved_min_active, max_active);
56465797b1c1STejun Heo 
5647a045a272STejun Heo 	wq_adjust_max_active(wq);
5648dcd989cbSTejun Heo 
5649a357fc03SLai Jiangshan 	mutex_unlock(&wq->mutex);
5650dcd989cbSTejun Heo }
5651dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active);
5652dcd989cbSTejun Heo 
5653dcd989cbSTejun Heo /**
56548f172181STejun Heo  * workqueue_set_min_active - adjust min_active of an unbound workqueue
56558f172181STejun Heo  * @wq: target unbound workqueue
56568f172181STejun Heo  * @min_active: new min_active value
56578f172181STejun Heo  *
56588f172181STejun Heo  * Set min_active of an unbound workqueue. Unlike other types of workqueues, an
56598f172181STejun Heo  * unbound workqueue is not guaranteed to be able to process max_active
56608f172181STejun Heo  * interdependent work items. Instead, an unbound workqueue is guaranteed to be
56618f172181STejun Heo  * able to process min_active number of interdependent work items which is
56628f172181STejun Heo  * %WQ_DFL_MIN_ACTIVE by default.
56638f172181STejun Heo  *
56648f172181STejun Heo  * Use this function to adjust the min_active value between 0 and the current
56658f172181STejun Heo  * max_active.
56668f172181STejun Heo  */
56678f172181STejun Heo void workqueue_set_min_active(struct workqueue_struct *wq, int min_active)
56688f172181STejun Heo {
56698f172181STejun Heo 	/* min_active is only meaningful for non-ordered unbound workqueues */
56708f172181STejun Heo 	if (WARN_ON((wq->flags & (WQ_BH | WQ_UNBOUND | __WQ_ORDERED)) !=
56718f172181STejun Heo 		    WQ_UNBOUND))
56728f172181STejun Heo 		return;
56738f172181STejun Heo 
56748f172181STejun Heo 	mutex_lock(&wq->mutex);
56758f172181STejun Heo 	wq->saved_min_active = clamp(min_active, 0, wq->saved_max_active);
56768f172181STejun Heo 	wq_adjust_max_active(wq);
56778f172181STejun Heo 	mutex_unlock(&wq->mutex);
56788f172181STejun Heo }
56798f172181STejun Heo 
56808f172181STejun Heo /**
568127d4ee03SLukas Wunner  * current_work - retrieve %current task's work struct
568227d4ee03SLukas Wunner  *
568327d4ee03SLukas Wunner  * Determine if %current task is a workqueue worker and what it's working on.
568427d4ee03SLukas Wunner  * Useful to find out the context that the %current task is running in.
568527d4ee03SLukas Wunner  *
568627d4ee03SLukas Wunner  * Return: work struct if %current task is a workqueue worker, %NULL otherwise.
568727d4ee03SLukas Wunner  */
568827d4ee03SLukas Wunner struct work_struct *current_work(void)
568927d4ee03SLukas Wunner {
569027d4ee03SLukas Wunner 	struct worker *worker = current_wq_worker();
569127d4ee03SLukas Wunner 
569227d4ee03SLukas Wunner 	return worker ? worker->current_work : NULL;
569327d4ee03SLukas Wunner }
569427d4ee03SLukas Wunner EXPORT_SYMBOL(current_work);
569527d4ee03SLukas Wunner 
569627d4ee03SLukas Wunner /**
5697e6267616STejun Heo  * current_is_workqueue_rescuer - is %current workqueue rescuer?
5698e6267616STejun Heo  *
5699e6267616STejun Heo  * Determine whether %current is a workqueue rescuer.  Can be used from
5700e6267616STejun Heo  * work functions to determine whether it's being run off the rescuer task.
5701d185af30SYacine Belkadi  *
5702d185af30SYacine Belkadi  * Return: %true if %current is a workqueue rescuer. %false otherwise.
5703e6267616STejun Heo  */
5704e6267616STejun Heo bool current_is_workqueue_rescuer(void)
5705e6267616STejun Heo {
5706e6267616STejun Heo 	struct worker *worker = current_wq_worker();
5707e6267616STejun Heo 
57086a092dfdSLai Jiangshan 	return worker && worker->rescue_wq;
5709e6267616STejun Heo }
5710e6267616STejun Heo 
5711e6267616STejun Heo /**
5712dcd989cbSTejun Heo  * workqueue_congested - test whether a workqueue is congested
5713dcd989cbSTejun Heo  * @cpu: CPU in question
5714dcd989cbSTejun Heo  * @wq: target workqueue
5715dcd989cbSTejun Heo  *
5716dcd989cbSTejun Heo  * Test whether @wq's cpu workqueue for @cpu is congested.  There is
5717dcd989cbSTejun Heo  * no synchronization around this function and the test result is
5718dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
5719dcd989cbSTejun Heo  *
5720d3251859STejun Heo  * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
5721636b927eSTejun Heo  *
5722636b927eSTejun Heo  * With the exception of ordered workqueues, all workqueues have per-cpu
5723636b927eSTejun Heo  * pool_workqueues, each with its own congested state. A workqueue being
5724636b927eSTejun Heo  * congested on one CPU doesn't mean that the workqueue is contested on any
5725636b927eSTejun Heo  * other CPUs.
5726d3251859STejun Heo  *
5727d185af30SYacine Belkadi  * Return:
5728dcd989cbSTejun Heo  * %true if congested, %false otherwise.
5729dcd989cbSTejun Heo  */
5730d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq)
5731dcd989cbSTejun Heo {
57327fb98ea7STejun Heo 	struct pool_workqueue *pwq;
573376af4d93STejun Heo 	bool ret;
573476af4d93STejun Heo 
573524acfb71SThomas Gleixner 	rcu_read_lock();
573624acfb71SThomas Gleixner 	preempt_disable();
57377fb98ea7STejun Heo 
5738d3251859STejun Heo 	if (cpu == WORK_CPU_UNBOUND)
5739d3251859STejun Heo 		cpu = smp_processor_id();
5740d3251859STejun Heo 
5741687a9aa5STejun Heo 	pwq = *per_cpu_ptr(wq->cpu_pwq, cpu);
5742f97a4a1aSLai Jiangshan 	ret = !list_empty(&pwq->inactive_works);
5743636b927eSTejun Heo 
574424acfb71SThomas Gleixner 	preempt_enable();
574524acfb71SThomas Gleixner 	rcu_read_unlock();
574676af4d93STejun Heo 
574776af4d93STejun Heo 	return ret;
5748dcd989cbSTejun Heo }
5749dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested);
5750dcd989cbSTejun Heo 
5751dcd989cbSTejun Heo /**
5752dcd989cbSTejun Heo  * work_busy - test whether a work is currently pending or running
5753dcd989cbSTejun Heo  * @work: the work to be tested
5754dcd989cbSTejun Heo  *
5755dcd989cbSTejun Heo  * Test whether @work is currently pending or running.  There is no
5756dcd989cbSTejun Heo  * synchronization around this function and the test result is
5757dcd989cbSTejun Heo  * unreliable and only useful as advisory hints or for debugging.
5758dcd989cbSTejun Heo  *
5759d185af30SYacine Belkadi  * Return:
5760dcd989cbSTejun Heo  * OR'd bitmask of WORK_BUSY_* bits.
5761dcd989cbSTejun Heo  */
5762dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work)
5763dcd989cbSTejun Heo {
5764fa1b54e6STejun Heo 	struct worker_pool *pool;
5765*c26e2f2eSTejun Heo 	unsigned long irq_flags;
5766dcd989cbSTejun Heo 	unsigned int ret = 0;
5767dcd989cbSTejun Heo 
5768dcd989cbSTejun Heo 	if (work_pending(work))
5769dcd989cbSTejun Heo 		ret |= WORK_BUSY_PENDING;
5770038366c5SLai Jiangshan 
577124acfb71SThomas Gleixner 	rcu_read_lock();
5772fa1b54e6STejun Heo 	pool = get_work_pool(work);
5773038366c5SLai Jiangshan 	if (pool) {
5774*c26e2f2eSTejun Heo 		raw_spin_lock_irqsave(&pool->lock, irq_flags);
5775c9e7cf27STejun Heo 		if (find_worker_executing_work(pool, work))
5776dcd989cbSTejun Heo 			ret |= WORK_BUSY_RUNNING;
5777*c26e2f2eSTejun Heo 		raw_spin_unlock_irqrestore(&pool->lock, irq_flags);
5778038366c5SLai Jiangshan 	}
577924acfb71SThomas Gleixner 	rcu_read_unlock();
5780dcd989cbSTejun Heo 
5781dcd989cbSTejun Heo 	return ret;
5782dcd989cbSTejun Heo }
5783dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy);
5784dcd989cbSTejun Heo 
57853d1cb205STejun Heo /**
57863d1cb205STejun Heo  * set_worker_desc - set description for the current work item
57873d1cb205STejun Heo  * @fmt: printf-style format string
57883d1cb205STejun Heo  * @...: arguments for the format string
57893d1cb205STejun Heo  *
57903d1cb205STejun Heo  * This function can be called by a running work function to describe what
57913d1cb205STejun Heo  * the work item is about.  If the worker task gets dumped, this
57923d1cb205STejun Heo  * information will be printed out together to help debugging.  The
57933d1cb205STejun Heo  * description can be at most WORKER_DESC_LEN including the trailing '\0'.
57943d1cb205STejun Heo  */
57953d1cb205STejun Heo void set_worker_desc(const char *fmt, ...)
57963d1cb205STejun Heo {
57973d1cb205STejun Heo 	struct worker *worker = current_wq_worker();
57983d1cb205STejun Heo 	va_list args;
57993d1cb205STejun Heo 
58003d1cb205STejun Heo 	if (worker) {
58013d1cb205STejun Heo 		va_start(args, fmt);
58023d1cb205STejun Heo 		vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
58033d1cb205STejun Heo 		va_end(args);
58043d1cb205STejun Heo 	}
58053d1cb205STejun Heo }
58065c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc);
58073d1cb205STejun Heo 
58083d1cb205STejun Heo /**
58093d1cb205STejun Heo  * print_worker_info - print out worker information and description
58103d1cb205STejun Heo  * @log_lvl: the log level to use when printing
58113d1cb205STejun Heo  * @task: target task
58123d1cb205STejun Heo  *
58133d1cb205STejun Heo  * If @task is a worker and currently executing a work item, print out the
58143d1cb205STejun Heo  * name of the workqueue being serviced and worker description set with
58153d1cb205STejun Heo  * set_worker_desc() by the currently executing work item.
58163d1cb205STejun Heo  *
58173d1cb205STejun Heo  * This function can be safely called on any task as long as the
58183d1cb205STejun Heo  * task_struct itself is accessible.  While safe, this function isn't
58193d1cb205STejun Heo  * synchronized and may print out mixups or garbages of limited length.
58203d1cb205STejun Heo  */
58213d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task)
58223d1cb205STejun Heo {
58233d1cb205STejun Heo 	work_func_t *fn = NULL;
58243d1cb205STejun Heo 	char name[WQ_NAME_LEN] = { };
58253d1cb205STejun Heo 	char desc[WORKER_DESC_LEN] = { };
58263d1cb205STejun Heo 	struct pool_workqueue *pwq = NULL;
58273d1cb205STejun Heo 	struct workqueue_struct *wq = NULL;
58283d1cb205STejun Heo 	struct worker *worker;
58293d1cb205STejun Heo 
58303d1cb205STejun Heo 	if (!(task->flags & PF_WQ_WORKER))
58313d1cb205STejun Heo 		return;
58323d1cb205STejun Heo 
58333d1cb205STejun Heo 	/*
58343d1cb205STejun Heo 	 * This function is called without any synchronization and @task
58353d1cb205STejun Heo 	 * could be in any state.  Be careful with dereferences.
58363d1cb205STejun Heo 	 */
5837e700591aSPetr Mladek 	worker = kthread_probe_data(task);
58383d1cb205STejun Heo 
58393d1cb205STejun Heo 	/*
58408bf89593STejun Heo 	 * Carefully copy the associated workqueue's workfn, name and desc.
58418bf89593STejun Heo 	 * Keep the original last '\0' in case the original is garbage.
58423d1cb205STejun Heo 	 */
5843fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn));
5844fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq));
5845fe557319SChristoph Hellwig 	copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq));
5846fe557319SChristoph Hellwig 	copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1);
5847fe557319SChristoph Hellwig 	copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1);
58483d1cb205STejun Heo 
58493d1cb205STejun Heo 	if (fn || name[0] || desc[0]) {
5850d75f773cSSakari Ailus 		printk("%sWorkqueue: %s %ps", log_lvl, name, fn);
58518bf89593STejun Heo 		if (strcmp(name, desc))
58523d1cb205STejun Heo 			pr_cont(" (%s)", desc);
58533d1cb205STejun Heo 		pr_cont("\n");
58543d1cb205STejun Heo 	}
58553d1cb205STejun Heo }
58563d1cb205STejun Heo 
58573494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool)
58583494fc30STejun Heo {
58593494fc30STejun Heo 	pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask);
58603494fc30STejun Heo 	if (pool->node != NUMA_NO_NODE)
58613494fc30STejun Heo 		pr_cont(" node=%d", pool->node);
58624cb1ef64STejun Heo 	pr_cont(" flags=0x%x", pool->flags);
58634cb1ef64STejun Heo 	if (pool->flags & POOL_BH)
58644cb1ef64STejun Heo 		pr_cont(" bh%s",
58654cb1ef64STejun Heo 			pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : "");
58664cb1ef64STejun Heo 	else
58674cb1ef64STejun Heo 		pr_cont(" nice=%d", pool->attrs->nice);
58684cb1ef64STejun Heo }
58694cb1ef64STejun Heo 
58704cb1ef64STejun Heo static void pr_cont_worker_id(struct worker *worker)
58714cb1ef64STejun Heo {
58724cb1ef64STejun Heo 	struct worker_pool *pool = worker->pool;
58734cb1ef64STejun Heo 
58744cb1ef64STejun Heo 	if (pool->flags & WQ_BH)
58754cb1ef64STejun Heo 		pr_cont("bh%s",
58764cb1ef64STejun Heo 			pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : "");
58774cb1ef64STejun Heo 	else
58784cb1ef64STejun Heo 		pr_cont("%d%s", task_pid_nr(worker->task),
58794cb1ef64STejun Heo 			worker->rescue_wq ? "(RESCUER)" : "");
58803494fc30STejun Heo }
58813494fc30STejun Heo 
5882c76feb0dSPaul E. McKenney struct pr_cont_work_struct {
5883c76feb0dSPaul E. McKenney 	bool comma;
5884c76feb0dSPaul E. McKenney 	work_func_t func;
5885c76feb0dSPaul E. McKenney 	long ctr;
5886c76feb0dSPaul E. McKenney };
5887c76feb0dSPaul E. McKenney 
5888c76feb0dSPaul E. McKenney static void pr_cont_work_flush(bool comma, work_func_t func, struct pr_cont_work_struct *pcwsp)
5889c76feb0dSPaul E. McKenney {
5890c76feb0dSPaul E. McKenney 	if (!pcwsp->ctr)
5891c76feb0dSPaul E. McKenney 		goto out_record;
5892c76feb0dSPaul E. McKenney 	if (func == pcwsp->func) {
5893c76feb0dSPaul E. McKenney 		pcwsp->ctr++;
5894c76feb0dSPaul E. McKenney 		return;
5895c76feb0dSPaul E. McKenney 	}
5896c76feb0dSPaul E. McKenney 	if (pcwsp->ctr == 1)
5897c76feb0dSPaul E. McKenney 		pr_cont("%s %ps", pcwsp->comma ? "," : "", pcwsp->func);
5898c76feb0dSPaul E. McKenney 	else
5899c76feb0dSPaul E. McKenney 		pr_cont("%s %ld*%ps", pcwsp->comma ? "," : "", pcwsp->ctr, pcwsp->func);
5900c76feb0dSPaul E. McKenney 	pcwsp->ctr = 0;
5901c76feb0dSPaul E. McKenney out_record:
5902c76feb0dSPaul E. McKenney 	if ((long)func == -1L)
5903c76feb0dSPaul E. McKenney 		return;
5904c76feb0dSPaul E. McKenney 	pcwsp->comma = comma;
5905c76feb0dSPaul E. McKenney 	pcwsp->func = func;
5906c76feb0dSPaul E. McKenney 	pcwsp->ctr = 1;
5907c76feb0dSPaul E. McKenney }
5908c76feb0dSPaul E. McKenney 
5909c76feb0dSPaul E. McKenney static void pr_cont_work(bool comma, struct work_struct *work, struct pr_cont_work_struct *pcwsp)
59103494fc30STejun Heo {
59113494fc30STejun Heo 	if (work->func == wq_barrier_func) {
59123494fc30STejun Heo 		struct wq_barrier *barr;
59133494fc30STejun Heo 
59143494fc30STejun Heo 		barr = container_of(work, struct wq_barrier, work);
59153494fc30STejun Heo 
5916c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
59173494fc30STejun Heo 		pr_cont("%s BAR(%d)", comma ? "," : "",
59183494fc30STejun Heo 			task_pid_nr(barr->task));
59193494fc30STejun Heo 	} else {
5920c76feb0dSPaul E. McKenney 		if (!comma)
5921c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1, pcwsp);
5922c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, work->func, pcwsp);
59233494fc30STejun Heo 	}
59243494fc30STejun Heo }
59253494fc30STejun Heo 
59263494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq)
59273494fc30STejun Heo {
5928c76feb0dSPaul E. McKenney 	struct pr_cont_work_struct pcws = { .ctr = 0, };
59293494fc30STejun Heo 	struct worker_pool *pool = pwq->pool;
59303494fc30STejun Heo 	struct work_struct *work;
59313494fc30STejun Heo 	struct worker *worker;
59323494fc30STejun Heo 	bool has_in_flight = false, has_pending = false;
59333494fc30STejun Heo 	int bkt;
59343494fc30STejun Heo 
59353494fc30STejun Heo 	pr_info("  pwq %d:", pool->id);
59363494fc30STejun Heo 	pr_cont_pool_info(pool);
59373494fc30STejun Heo 
5938a045a272STejun Heo 	pr_cont(" active=%d refcnt=%d%s\n",
5939a045a272STejun Heo 		pwq->nr_active, pwq->refcnt,
59403494fc30STejun Heo 		!list_empty(&pwq->mayday_node) ? " MAYDAY" : "");
59413494fc30STejun Heo 
59423494fc30STejun Heo 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
59433494fc30STejun Heo 		if (worker->current_pwq == pwq) {
59443494fc30STejun Heo 			has_in_flight = true;
59453494fc30STejun Heo 			break;
59463494fc30STejun Heo 		}
59473494fc30STejun Heo 	}
59483494fc30STejun Heo 	if (has_in_flight) {
59493494fc30STejun Heo 		bool comma = false;
59503494fc30STejun Heo 
59513494fc30STejun Heo 		pr_info("    in-flight:");
59523494fc30STejun Heo 		hash_for_each(pool->busy_hash, bkt, worker, hentry) {
59533494fc30STejun Heo 			if (worker->current_pwq != pwq)
59543494fc30STejun Heo 				continue;
59553494fc30STejun Heo 
59564cb1ef64STejun Heo 			pr_cont(" %s", comma ? "," : "");
59574cb1ef64STejun Heo 			pr_cont_worker_id(worker);
59584cb1ef64STejun Heo 			pr_cont(":%ps", worker->current_func);
59593494fc30STejun Heo 			list_for_each_entry(work, &worker->scheduled, entry)
5960c76feb0dSPaul E. McKenney 				pr_cont_work(false, work, &pcws);
5961c76feb0dSPaul E. McKenney 			pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
59623494fc30STejun Heo 			comma = true;
59633494fc30STejun Heo 		}
59643494fc30STejun Heo 		pr_cont("\n");
59653494fc30STejun Heo 	}
59663494fc30STejun Heo 
59673494fc30STejun Heo 	list_for_each_entry(work, &pool->worklist, entry) {
59683494fc30STejun Heo 		if (get_work_pwq(work) == pwq) {
59693494fc30STejun Heo 			has_pending = true;
59703494fc30STejun Heo 			break;
59713494fc30STejun Heo 		}
59723494fc30STejun Heo 	}
59733494fc30STejun Heo 	if (has_pending) {
59743494fc30STejun Heo 		bool comma = false;
59753494fc30STejun Heo 
59763494fc30STejun Heo 		pr_info("    pending:");
59773494fc30STejun Heo 		list_for_each_entry(work, &pool->worklist, entry) {
59783494fc30STejun Heo 			if (get_work_pwq(work) != pwq)
59793494fc30STejun Heo 				continue;
59803494fc30STejun Heo 
5981c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
59823494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
59833494fc30STejun Heo 		}
5984c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
59853494fc30STejun Heo 		pr_cont("\n");
59863494fc30STejun Heo 	}
59873494fc30STejun Heo 
5988f97a4a1aSLai Jiangshan 	if (!list_empty(&pwq->inactive_works)) {
59893494fc30STejun Heo 		bool comma = false;
59903494fc30STejun Heo 
5991f97a4a1aSLai Jiangshan 		pr_info("    inactive:");
5992f97a4a1aSLai Jiangshan 		list_for_each_entry(work, &pwq->inactive_works, entry) {
5993c76feb0dSPaul E. McKenney 			pr_cont_work(comma, work, &pcws);
59943494fc30STejun Heo 			comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED);
59953494fc30STejun Heo 		}
5996c76feb0dSPaul E. McKenney 		pr_cont_work_flush(comma, (work_func_t)-1L, &pcws);
59973494fc30STejun Heo 		pr_cont("\n");
59983494fc30STejun Heo 	}
59993494fc30STejun Heo }
60003494fc30STejun Heo 
60013494fc30STejun Heo /**
600255df0933SImran Khan  * show_one_workqueue - dump state of specified workqueue
600355df0933SImran Khan  * @wq: workqueue whose state will be printed
60043494fc30STejun Heo  */
600555df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq)
60063494fc30STejun Heo {
60073494fc30STejun Heo 	struct pool_workqueue *pwq;
60083494fc30STejun Heo 	bool idle = true;
6009*c26e2f2eSTejun Heo 	unsigned long irq_flags;
60103494fc30STejun Heo 
60113494fc30STejun Heo 	for_each_pwq(pwq, wq) {
6012afa87ce8STejun Heo 		if (!pwq_is_empty(pwq)) {
60133494fc30STejun Heo 			idle = false;
60143494fc30STejun Heo 			break;
60153494fc30STejun Heo 		}
60163494fc30STejun Heo 	}
601755df0933SImran Khan 	if (idle) /* Nothing to print for idle workqueue */
601855df0933SImran Khan 		return;
60193494fc30STejun Heo 
60203494fc30STejun Heo 	pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags);
60213494fc30STejun Heo 
60223494fc30STejun Heo 	for_each_pwq(pwq, wq) {
6023*c26e2f2eSTejun Heo 		raw_spin_lock_irqsave(&pwq->pool->lock, irq_flags);
6024afa87ce8STejun Heo 		if (!pwq_is_empty(pwq)) {
602557116ce1SJohan Hovold 			/*
602657116ce1SJohan Hovold 			 * Defer printing to avoid deadlocks in console
602757116ce1SJohan Hovold 			 * drivers that queue work while holding locks
602857116ce1SJohan Hovold 			 * also taken in their write paths.
602957116ce1SJohan Hovold 			 */
603057116ce1SJohan Hovold 			printk_deferred_enter();
60313494fc30STejun Heo 			show_pwq(pwq);
603257116ce1SJohan Hovold 			printk_deferred_exit();
603357116ce1SJohan Hovold 		}
6034*c26e2f2eSTejun Heo 		raw_spin_unlock_irqrestore(&pwq->pool->lock, irq_flags);
603562635ea8SSergey Senozhatsky 		/*
603662635ea8SSergey Senozhatsky 		 * We could be printing a lot from atomic context, e.g.
603755df0933SImran Khan 		 * sysrq-t -> show_all_workqueues(). Avoid triggering
603862635ea8SSergey Senozhatsky 		 * hard lockup.
603962635ea8SSergey Senozhatsky 		 */
604062635ea8SSergey Senozhatsky 		touch_nmi_watchdog();
60413494fc30STejun Heo 	}
604255df0933SImran Khan 
60433494fc30STejun Heo }
60443494fc30STejun Heo 
604555df0933SImran Khan /**
604655df0933SImran Khan  * show_one_worker_pool - dump state of specified worker pool
604755df0933SImran Khan  * @pool: worker pool whose state will be printed
604855df0933SImran Khan  */
604955df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool)
605055df0933SImran Khan {
60513494fc30STejun Heo 	struct worker *worker;
60523494fc30STejun Heo 	bool first = true;
6053*c26e2f2eSTejun Heo 	unsigned long irq_flags;
6054335a42ebSPetr Mladek 	unsigned long hung = 0;
60553494fc30STejun Heo 
6056*c26e2f2eSTejun Heo 	raw_spin_lock_irqsave(&pool->lock, irq_flags);
60573494fc30STejun Heo 	if (pool->nr_workers == pool->nr_idle)
60583494fc30STejun Heo 		goto next_pool;
6059335a42ebSPetr Mladek 
6060335a42ebSPetr Mladek 	/* How long the first pending work is waiting for a worker. */
6061335a42ebSPetr Mladek 	if (!list_empty(&pool->worklist))
6062335a42ebSPetr Mladek 		hung = jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000;
6063335a42ebSPetr Mladek 
606457116ce1SJohan Hovold 	/*
606557116ce1SJohan Hovold 	 * Defer printing to avoid deadlocks in console drivers that
606657116ce1SJohan Hovold 	 * queue work while holding locks also taken in their write
606757116ce1SJohan Hovold 	 * paths.
606857116ce1SJohan Hovold 	 */
606957116ce1SJohan Hovold 	printk_deferred_enter();
60703494fc30STejun Heo 	pr_info("pool %d:", pool->id);
60713494fc30STejun Heo 	pr_cont_pool_info(pool);
6072335a42ebSPetr Mladek 	pr_cont(" hung=%lus workers=%d", hung, pool->nr_workers);
60733494fc30STejun Heo 	if (pool->manager)
60743494fc30STejun Heo 		pr_cont(" manager: %d",
60753494fc30STejun Heo 			task_pid_nr(pool->manager->task));
60763494fc30STejun Heo 	list_for_each_entry(worker, &pool->idle_list, entry) {
60774cb1ef64STejun Heo 		pr_cont(" %s", first ? "idle: " : "");
60784cb1ef64STejun Heo 		pr_cont_worker_id(worker);
60793494fc30STejun Heo 		first = false;
60803494fc30STejun Heo 	}
60813494fc30STejun Heo 	pr_cont("\n");
608257116ce1SJohan Hovold 	printk_deferred_exit();
60833494fc30STejun Heo next_pool:
6084*c26e2f2eSTejun Heo 	raw_spin_unlock_irqrestore(&pool->lock, irq_flags);
608562635ea8SSergey Senozhatsky 	/*
608662635ea8SSergey Senozhatsky 	 * We could be printing a lot from atomic context, e.g.
608755df0933SImran Khan 	 * sysrq-t -> show_all_workqueues(). Avoid triggering
608862635ea8SSergey Senozhatsky 	 * hard lockup.
608962635ea8SSergey Senozhatsky 	 */
609062635ea8SSergey Senozhatsky 	touch_nmi_watchdog();
609155df0933SImran Khan 
60923494fc30STejun Heo }
60933494fc30STejun Heo 
609455df0933SImran Khan /**
609555df0933SImran Khan  * show_all_workqueues - dump workqueue state
609655df0933SImran Khan  *
6097704bc669SJungseung Lee  * Called from a sysrq handler and prints out all busy workqueues and pools.
609855df0933SImran Khan  */
609955df0933SImran Khan void show_all_workqueues(void)
610055df0933SImran Khan {
610155df0933SImran Khan 	struct workqueue_struct *wq;
610255df0933SImran Khan 	struct worker_pool *pool;
610355df0933SImran Khan 	int pi;
610455df0933SImran Khan 
610555df0933SImran Khan 	rcu_read_lock();
610655df0933SImran Khan 
610755df0933SImran Khan 	pr_info("Showing busy workqueues and worker pools:\n");
610855df0933SImran Khan 
610955df0933SImran Khan 	list_for_each_entry_rcu(wq, &workqueues, list)
611055df0933SImran Khan 		show_one_workqueue(wq);
611155df0933SImran Khan 
611255df0933SImran Khan 	for_each_pool(pool, pi)
611355df0933SImran Khan 		show_one_worker_pool(pool);
611455df0933SImran Khan 
611524acfb71SThomas Gleixner 	rcu_read_unlock();
61163494fc30STejun Heo }
61173494fc30STejun Heo 
6118704bc669SJungseung Lee /**
6119704bc669SJungseung Lee  * show_freezable_workqueues - dump freezable workqueue state
6120704bc669SJungseung Lee  *
6121704bc669SJungseung Lee  * Called from try_to_freeze_tasks() and prints out all freezable workqueues
6122704bc669SJungseung Lee  * still busy.
6123704bc669SJungseung Lee  */
6124704bc669SJungseung Lee void show_freezable_workqueues(void)
6125704bc669SJungseung Lee {
6126704bc669SJungseung Lee 	struct workqueue_struct *wq;
6127704bc669SJungseung Lee 
6128704bc669SJungseung Lee 	rcu_read_lock();
6129704bc669SJungseung Lee 
6130704bc669SJungseung Lee 	pr_info("Showing freezable workqueues that are still busy:\n");
6131704bc669SJungseung Lee 
6132704bc669SJungseung Lee 	list_for_each_entry_rcu(wq, &workqueues, list) {
6133704bc669SJungseung Lee 		if (!(wq->flags & WQ_FREEZABLE))
6134704bc669SJungseung Lee 			continue;
6135704bc669SJungseung Lee 		show_one_workqueue(wq);
6136704bc669SJungseung Lee 	}
6137704bc669SJungseung Lee 
6138704bc669SJungseung Lee 	rcu_read_unlock();
6139704bc669SJungseung Lee }
6140704bc669SJungseung Lee 
61416b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */
61426b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task)
61436b59808bSTejun Heo {
61446b59808bSTejun Heo 	int off;
61456b59808bSTejun Heo 
61466b59808bSTejun Heo 	/* always show the actual comm */
61476b59808bSTejun Heo 	off = strscpy(buf, task->comm, size);
61486b59808bSTejun Heo 	if (off < 0)
61496b59808bSTejun Heo 		return;
61506b59808bSTejun Heo 
6151197f6accSTejun Heo 	/* stabilize PF_WQ_WORKER and worker pool association */
61526b59808bSTejun Heo 	mutex_lock(&wq_pool_attach_mutex);
61536b59808bSTejun Heo 
6154197f6accSTejun Heo 	if (task->flags & PF_WQ_WORKER) {
6155197f6accSTejun Heo 		struct worker *worker = kthread_data(task);
6156197f6accSTejun Heo 		struct worker_pool *pool = worker->pool;
61576b59808bSTejun Heo 
61586b59808bSTejun Heo 		if (pool) {
6159a9b8a985SSebastian Andrzej Siewior 			raw_spin_lock_irq(&pool->lock);
61606b59808bSTejun Heo 			/*
6161197f6accSTejun Heo 			 * ->desc tracks information (wq name or
6162197f6accSTejun Heo 			 * set_worker_desc()) for the latest execution.  If
6163197f6accSTejun Heo 			 * current, prepend '+', otherwise '-'.
61646b59808bSTejun Heo 			 */
61656b59808bSTejun Heo 			if (worker->desc[0] != '\0') {
61666b59808bSTejun Heo 				if (worker->current_work)
61676b59808bSTejun Heo 					scnprintf(buf + off, size - off, "+%s",
61686b59808bSTejun Heo 						  worker->desc);
61696b59808bSTejun Heo 				else
61706b59808bSTejun Heo 					scnprintf(buf + off, size - off, "-%s",
61716b59808bSTejun Heo 						  worker->desc);
61726b59808bSTejun Heo 			}
6173a9b8a985SSebastian Andrzej Siewior 			raw_spin_unlock_irq(&pool->lock);
61746b59808bSTejun Heo 		}
6175197f6accSTejun Heo 	}
61766b59808bSTejun Heo 
61776b59808bSTejun Heo 	mutex_unlock(&wq_pool_attach_mutex);
61786b59808bSTejun Heo }
61796b59808bSTejun Heo 
618066448bc2SMathieu Malaterre #ifdef CONFIG_SMP
618166448bc2SMathieu Malaterre 
6182db7bccf4STejun Heo /*
6183db7bccf4STejun Heo  * CPU hotplug.
6184db7bccf4STejun Heo  *
6185e22bee78STejun Heo  * There are two challenges in supporting CPU hotplug.  Firstly, there
6186112202d9STejun Heo  * are a lot of assumptions on strong associations among work, pwq and
6187706026c2STejun Heo  * pool which make migrating pending and scheduled works very
6188e22bee78STejun Heo  * difficult to implement without impacting hot paths.  Secondly,
618994cf58bbSTejun Heo  * worker pools serve mix of short, long and very long running works making
6190e22bee78STejun Heo  * blocked draining impractical.
6191e22bee78STejun Heo  *
619224647570STejun Heo  * This is solved by allowing the pools to be disassociated from the CPU
6193628c78e7STejun Heo  * running as an unbound one and allowing it to be reattached later if the
6194628c78e7STejun Heo  * cpu comes back online.
6195db7bccf4STejun Heo  */
6196db7bccf4STejun Heo 
6197e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu)
6198db7bccf4STejun Heo {
61994ce62e9eSTejun Heo 	struct worker_pool *pool;
6200db7bccf4STejun Heo 	struct worker *worker;
6201db7bccf4STejun Heo 
6202f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
62031258fae7STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
6204a9b8a985SSebastian Andrzej Siewior 		raw_spin_lock_irq(&pool->lock);
6205e22bee78STejun Heo 
6206f2d5a0eeSTejun Heo 		/*
620792f9c5c4SLai Jiangshan 		 * We've blocked all attach/detach operations. Make all workers
620894cf58bbSTejun Heo 		 * unbound and set DISASSOCIATED.  Before this, all workers
620911b45b0bSLai Jiangshan 		 * must be on the cpu.  After this, they may become diasporas.
6210b4ac9384SLai Jiangshan 		 * And the preemption disabled section in their sched callbacks
6211b4ac9384SLai Jiangshan 		 * are guaranteed to see WORKER_UNBOUND since the code here
6212b4ac9384SLai Jiangshan 		 * is on the same cpu.
6213f2d5a0eeSTejun Heo 		 */
6214da028469SLai Jiangshan 		for_each_pool_worker(worker, pool)
6215403c821dSTejun Heo 			worker->flags |= WORKER_UNBOUND;
6216db7bccf4STejun Heo 
621724647570STejun Heo 		pool->flags |= POOL_DISASSOCIATED;
6218f2d5a0eeSTejun Heo 
6219e22bee78STejun Heo 		/*
6220989442d7SLai Jiangshan 		 * The handling of nr_running in sched callbacks are disabled
6221989442d7SLai Jiangshan 		 * now.  Zap nr_running.  After this, nr_running stays zero and
6222989442d7SLai Jiangshan 		 * need_more_worker() and keep_working() are always true as
6223989442d7SLai Jiangshan 		 * long as the worklist is not empty.  This pool now behaves as
6224989442d7SLai Jiangshan 		 * an unbound (in terms of concurrency management) pool which
6225eb283428SLai Jiangshan 		 * are served by workers tied to the pool.
6226e22bee78STejun Heo 		 */
6227bc35f7efSLai Jiangshan 		pool->nr_running = 0;
6228eb283428SLai Jiangshan 
6229eb283428SLai Jiangshan 		/*
6230eb283428SLai Jiangshan 		 * With concurrency management just turned off, a busy
6231eb283428SLai Jiangshan 		 * worker blocking could lead to lengthy stalls.  Kick off
6232eb283428SLai Jiangshan 		 * unbound chain execution of currently pending work items.
6233eb283428SLai Jiangshan 		 */
62340219a352STejun Heo 		kick_pool(pool);
6235989442d7SLai Jiangshan 
6236a9b8a985SSebastian Andrzej Siewior 		raw_spin_unlock_irq(&pool->lock);
6237989442d7SLai Jiangshan 
6238793777bcSValentin Schneider 		for_each_pool_worker(worker, pool)
6239793777bcSValentin Schneider 			unbind_worker(worker);
6240989442d7SLai Jiangshan 
6241989442d7SLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
6242eb283428SLai Jiangshan 	}
6243db7bccf4STejun Heo }
6244db7bccf4STejun Heo 
6245bd7c089eSTejun Heo /**
6246bd7c089eSTejun Heo  * rebind_workers - rebind all workers of a pool to the associated CPU
6247bd7c089eSTejun Heo  * @pool: pool of interest
6248bd7c089eSTejun Heo  *
6249a9ab775bSTejun Heo  * @pool->cpu is coming online.  Rebind all workers to the CPU.
6250bd7c089eSTejun Heo  */
6251bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool)
6252bd7c089eSTejun Heo {
6253a9ab775bSTejun Heo 	struct worker *worker;
6254bd7c089eSTejun Heo 
62551258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
6256bd7c089eSTejun Heo 
6257bd7c089eSTejun Heo 	/*
6258a9ab775bSTejun Heo 	 * Restore CPU affinity of all workers.  As all idle workers should
6259a9ab775bSTejun Heo 	 * be on the run-queue of the associated CPU before any local
6260402dd89dSShailendra Verma 	 * wake-ups for concurrency management happen, restore CPU affinity
6261a9ab775bSTejun Heo 	 * of all workers first and then clear UNBOUND.  As we're called
6262a9ab775bSTejun Heo 	 * from CPU_ONLINE, the following shouldn't fail.
6263bd7c089eSTejun Heo 	 */
6264c63a2e52SValentin Schneider 	for_each_pool_worker(worker, pool) {
6265c63a2e52SValentin Schneider 		kthread_set_per_cpu(worker->task, pool->cpu);
6266c63a2e52SValentin Schneider 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
62679546b29eSTejun Heo 						  pool_allowed_cpus(pool)) < 0);
6268c63a2e52SValentin Schneider 	}
6269a9ab775bSTejun Heo 
6270a9b8a985SSebastian Andrzej Siewior 	raw_spin_lock_irq(&pool->lock);
6271f7c17d26SWanpeng Li 
62723de5e884SLai Jiangshan 	pool->flags &= ~POOL_DISASSOCIATED;
6273a9ab775bSTejun Heo 
6274da028469SLai Jiangshan 	for_each_pool_worker(worker, pool) {
6275a9ab775bSTejun Heo 		unsigned int worker_flags = worker->flags;
6276a9ab775bSTejun Heo 
6277a9ab775bSTejun Heo 		/*
6278a9ab775bSTejun Heo 		 * We want to clear UNBOUND but can't directly call
6279a9ab775bSTejun Heo 		 * worker_clr_flags() or adjust nr_running.  Atomically
6280a9ab775bSTejun Heo 		 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
6281a9ab775bSTejun Heo 		 * @worker will clear REBOUND using worker_clr_flags() when
6282a9ab775bSTejun Heo 		 * it initiates the next execution cycle thus restoring
6283a9ab775bSTejun Heo 		 * concurrency management.  Note that when or whether
6284a9ab775bSTejun Heo 		 * @worker clears REBOUND doesn't affect correctness.
6285a9ab775bSTejun Heo 		 *
6286c95491edSMark Rutland 		 * WRITE_ONCE() is necessary because @worker->flags may be
6287a9ab775bSTejun Heo 		 * tested without holding any lock in
62886d25be57SThomas Gleixner 		 * wq_worker_running().  Without it, NOT_RUNNING test may
6289a9ab775bSTejun Heo 		 * fail incorrectly leading to premature concurrency
6290a9ab775bSTejun Heo 		 * management operations.
6291bd7c089eSTejun Heo 		 */
6292a9ab775bSTejun Heo 		WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
6293a9ab775bSTejun Heo 		worker_flags |= WORKER_REBOUND;
6294a9ab775bSTejun Heo 		worker_flags &= ~WORKER_UNBOUND;
6295c95491edSMark Rutland 		WRITE_ONCE(worker->flags, worker_flags);
6296bd7c089eSTejun Heo 	}
6297a9ab775bSTejun Heo 
6298a9b8a985SSebastian Andrzej Siewior 	raw_spin_unlock_irq(&pool->lock);
6299bd7c089eSTejun Heo }
6300bd7c089eSTejun Heo 
63017dbc725eSTejun Heo /**
63027dbc725eSTejun Heo  * restore_unbound_workers_cpumask - restore cpumask of unbound workers
63037dbc725eSTejun Heo  * @pool: unbound pool of interest
63047dbc725eSTejun Heo  * @cpu: the CPU which is coming up
63057dbc725eSTejun Heo  *
63067dbc725eSTejun Heo  * An unbound pool may end up with a cpumask which doesn't have any online
63077dbc725eSTejun Heo  * CPUs.  When a worker of such pool get scheduled, the scheduler resets
63087dbc725eSTejun Heo  * its cpus_allowed.  If @cpu is in @pool's cpumask which didn't have any
63097dbc725eSTejun Heo  * online CPU before, cpus_allowed of all its workers should be restored.
63107dbc725eSTejun Heo  */
63117dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
63127dbc725eSTejun Heo {
63137dbc725eSTejun Heo 	static cpumask_t cpumask;
63147dbc725eSTejun Heo 	struct worker *worker;
63157dbc725eSTejun Heo 
63161258fae7STejun Heo 	lockdep_assert_held(&wq_pool_attach_mutex);
63177dbc725eSTejun Heo 
63187dbc725eSTejun Heo 	/* is @cpu allowed for @pool? */
63197dbc725eSTejun Heo 	if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
63207dbc725eSTejun Heo 		return;
63217dbc725eSTejun Heo 
63227dbc725eSTejun Heo 	cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
63237dbc725eSTejun Heo 
63247dbc725eSTejun Heo 	/* as we're called from CPU_ONLINE, the following shouldn't fail */
6325da028469SLai Jiangshan 	for_each_pool_worker(worker, pool)
6326d945b5e9SPeter Zijlstra 		WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0);
63277dbc725eSTejun Heo }
63287dbc725eSTejun Heo 
63297ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu)
63301da177e4SLinus Torvalds {
63314ce62e9eSTejun Heo 	struct worker_pool *pool;
63321da177e4SLinus Torvalds 
6333f02ae73aSTejun Heo 	for_each_cpu_worker_pool(pool, cpu) {
63343ce63377STejun Heo 		if (pool->nr_workers)
63353ce63377STejun Heo 			continue;
6336051e1850SLai Jiangshan 		if (!create_worker(pool))
63377ee681b2SThomas Gleixner 			return -ENOMEM;
63383af24433SOleg Nesterov 	}
63397ee681b2SThomas Gleixner 	return 0;
63407ee681b2SThomas Gleixner }
63411da177e4SLinus Torvalds 
63427ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu)
63437ee681b2SThomas Gleixner {
63447ee681b2SThomas Gleixner 	struct worker_pool *pool;
63457ee681b2SThomas Gleixner 	struct workqueue_struct *wq;
63467ee681b2SThomas Gleixner 	int pi;
63477ee681b2SThomas Gleixner 
634868e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
63497dbc725eSTejun Heo 
63507dbc725eSTejun Heo 	for_each_pool(pool, pi) {
63514cb1ef64STejun Heo 		/* BH pools aren't affected by hotplug */
63524cb1ef64STejun Heo 		if (pool->flags & POOL_BH)
63534cb1ef64STejun Heo 			continue;
635494cf58bbSTejun Heo 
63554cb1ef64STejun Heo 		mutex_lock(&wq_pool_attach_mutex);
6356f05b558dSLai Jiangshan 		if (pool->cpu == cpu)
635794cf58bbSTejun Heo 			rebind_workers(pool);
6358f05b558dSLai Jiangshan 		else if (pool->cpu < 0)
63597dbc725eSTejun Heo 			restore_unbound_workers_cpumask(pool, cpu);
63601258fae7STejun Heo 		mutex_unlock(&wq_pool_attach_mutex);
636194cf58bbSTejun Heo 	}
63627dbc725eSTejun Heo 
6363fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
63644cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
636584193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
636684193c07STejun Heo 
636784193c07STejun Heo 		if (attrs) {
636884193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
63694cbfd3deSTejun Heo 			int tcpu;
63704cbfd3deSTejun Heo 
637184193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
6372fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, true);
63735797b1c1STejun Heo 
63745797b1c1STejun Heo 			mutex_lock(&wq->mutex);
63755797b1c1STejun Heo 			wq_update_node_max_active(wq, -1);
63765797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
63774cbfd3deSTejun Heo 		}
63784cbfd3deSTejun Heo 	}
63794c16bd32STejun Heo 
638068e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
63817ee681b2SThomas Gleixner 	return 0;
638265758202STejun Heo }
638365758202STejun Heo 
63847ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu)
638565758202STejun Heo {
63864c16bd32STejun Heo 	struct workqueue_struct *wq;
63878db25e78STejun Heo 
63884c16bd32STejun Heo 	/* unbinding per-cpu workers should happen on the local CPU */
6389e8b3f8dbSLai Jiangshan 	if (WARN_ON(cpu != smp_processor_id()))
6390e8b3f8dbSLai Jiangshan 		return -1;
6391e8b3f8dbSLai Jiangshan 
6392e8b3f8dbSLai Jiangshan 	unbind_workers(cpu);
63934c16bd32STejun Heo 
6394fef59c9cSTejun Heo 	/* update pod affinity of unbound workqueues */
63954c16bd32STejun Heo 	mutex_lock(&wq_pool_mutex);
63964cbfd3deSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
639784193c07STejun Heo 		struct workqueue_attrs *attrs = wq->unbound_attrs;
639884193c07STejun Heo 
639984193c07STejun Heo 		if (attrs) {
640084193c07STejun Heo 			const struct wq_pod_type *pt = wqattrs_pod_type(attrs);
64014cbfd3deSTejun Heo 			int tcpu;
64024cbfd3deSTejun Heo 
640384193c07STejun Heo 			for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]])
6404fef59c9cSTejun Heo 				wq_update_pod(wq, tcpu, cpu, false);
64055797b1c1STejun Heo 
64065797b1c1STejun Heo 			mutex_lock(&wq->mutex);
64075797b1c1STejun Heo 			wq_update_node_max_active(wq, cpu);
64085797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
64094cbfd3deSTejun Heo 		}
64104cbfd3deSTejun Heo 	}
64114c16bd32STejun Heo 	mutex_unlock(&wq_pool_mutex);
64124c16bd32STejun Heo 
64137ee681b2SThomas Gleixner 	return 0;
641465758202STejun Heo }
641565758202STejun Heo 
64162d3854a3SRusty Russell struct work_for_cpu {
6417ed48ece2STejun Heo 	struct work_struct work;
64182d3854a3SRusty Russell 	long (*fn)(void *);
64192d3854a3SRusty Russell 	void *arg;
64202d3854a3SRusty Russell 	long ret;
64212d3854a3SRusty Russell };
64222d3854a3SRusty Russell 
6423ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work)
64242d3854a3SRusty Russell {
6425ed48ece2STejun Heo 	struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
6426ed48ece2STejun Heo 
64272d3854a3SRusty Russell 	wfc->ret = wfc->fn(wfc->arg);
64282d3854a3SRusty Russell }
64292d3854a3SRusty Russell 
64302d3854a3SRusty Russell /**
6431265f3ed0SFrederic Weisbecker  * work_on_cpu_key - run a function in thread context on a particular cpu
64322d3854a3SRusty Russell  * @cpu: the cpu to run on
64332d3854a3SRusty Russell  * @fn: the function to run
64342d3854a3SRusty Russell  * @arg: the function arg
6435265f3ed0SFrederic Weisbecker  * @key: The lock class key for lock debugging purposes
64362d3854a3SRusty Russell  *
643731ad9081SRusty Russell  * It is up to the caller to ensure that the cpu doesn't go offline.
64386b44003eSAndrew Morton  * The caller must not hold any locks which would prevent @fn from completing.
6439d185af30SYacine Belkadi  *
6440d185af30SYacine Belkadi  * Return: The value @fn returns.
64412d3854a3SRusty Russell  */
6442265f3ed0SFrederic Weisbecker long work_on_cpu_key(int cpu, long (*fn)(void *),
6443265f3ed0SFrederic Weisbecker 		     void *arg, struct lock_class_key *key)
64442d3854a3SRusty Russell {
6445ed48ece2STejun Heo 	struct work_for_cpu wfc = { .fn = fn, .arg = arg };
64462d3854a3SRusty Russell 
6447265f3ed0SFrederic Weisbecker 	INIT_WORK_ONSTACK_KEY(&wfc.work, work_for_cpu_fn, key);
6448ed48ece2STejun Heo 	schedule_work_on(cpu, &wfc.work);
644912997d1aSBjorn Helgaas 	flush_work(&wfc.work);
6450440a1136SChuansheng Liu 	destroy_work_on_stack(&wfc.work);
64512d3854a3SRusty Russell 	return wfc.ret;
64522d3854a3SRusty Russell }
6453265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_key);
64540e8d6a93SThomas Gleixner 
64550e8d6a93SThomas Gleixner /**
6456265f3ed0SFrederic Weisbecker  * work_on_cpu_safe_key - run a function in thread context on a particular cpu
64570e8d6a93SThomas Gleixner  * @cpu: the cpu to run on
64580e8d6a93SThomas Gleixner  * @fn:  the function to run
64590e8d6a93SThomas Gleixner  * @arg: the function argument
6460265f3ed0SFrederic Weisbecker  * @key: The lock class key for lock debugging purposes
64610e8d6a93SThomas Gleixner  *
64620e8d6a93SThomas Gleixner  * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold
64630e8d6a93SThomas Gleixner  * any locks which would prevent @fn from completing.
64640e8d6a93SThomas Gleixner  *
64650e8d6a93SThomas Gleixner  * Return: The value @fn returns.
64660e8d6a93SThomas Gleixner  */
6467265f3ed0SFrederic Weisbecker long work_on_cpu_safe_key(int cpu, long (*fn)(void *),
6468265f3ed0SFrederic Weisbecker 			  void *arg, struct lock_class_key *key)
64690e8d6a93SThomas Gleixner {
64700e8d6a93SThomas Gleixner 	long ret = -ENODEV;
64710e8d6a93SThomas Gleixner 
6472ffd8bea8SSebastian Andrzej Siewior 	cpus_read_lock();
64730e8d6a93SThomas Gleixner 	if (cpu_online(cpu))
6474265f3ed0SFrederic Weisbecker 		ret = work_on_cpu_key(cpu, fn, arg, key);
6475ffd8bea8SSebastian Andrzej Siewior 	cpus_read_unlock();
64760e8d6a93SThomas Gleixner 	return ret;
64770e8d6a93SThomas Gleixner }
6478265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_safe_key);
64792d3854a3SRusty Russell #endif /* CONFIG_SMP */
64802d3854a3SRusty Russell 
6481a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER
6482e7577c50SRusty Russell 
6483a0a1a5fdSTejun Heo /**
6484a0a1a5fdSTejun Heo  * freeze_workqueues_begin - begin freezing workqueues
6485a0a1a5fdSTejun Heo  *
648658a69cb4STejun Heo  * Start freezing workqueues.  After this function returns, all freezable
6487f97a4a1aSLai Jiangshan  * workqueues will queue new works to their inactive_works list instead of
6488706026c2STejun Heo  * pool->worklist.
6489a0a1a5fdSTejun Heo  *
6490a0a1a5fdSTejun Heo  * CONTEXT:
6491a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
6492a0a1a5fdSTejun Heo  */
6493a0a1a5fdSTejun Heo void freeze_workqueues_begin(void)
6494a0a1a5fdSTejun Heo {
649524b8a847STejun Heo 	struct workqueue_struct *wq;
6496a0a1a5fdSTejun Heo 
649768e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6498a0a1a5fdSTejun Heo 
64996183c009STejun Heo 	WARN_ON_ONCE(workqueue_freezing);
6500a0a1a5fdSTejun Heo 	workqueue_freezing = true;
6501a0a1a5fdSTejun Heo 
650224b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6503a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
6504a045a272STejun Heo 		wq_adjust_max_active(wq);
6505a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
6506a1056305STejun Heo 	}
65075bcab335STejun Heo 
650868e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6509a0a1a5fdSTejun Heo }
6510a0a1a5fdSTejun Heo 
6511a0a1a5fdSTejun Heo /**
651258a69cb4STejun Heo  * freeze_workqueues_busy - are freezable workqueues still busy?
6513a0a1a5fdSTejun Heo  *
6514a0a1a5fdSTejun Heo  * Check whether freezing is complete.  This function must be called
6515a0a1a5fdSTejun Heo  * between freeze_workqueues_begin() and thaw_workqueues().
6516a0a1a5fdSTejun Heo  *
6517a0a1a5fdSTejun Heo  * CONTEXT:
651868e13a67SLai Jiangshan  * Grabs and releases wq_pool_mutex.
6519a0a1a5fdSTejun Heo  *
6520d185af30SYacine Belkadi  * Return:
652158a69cb4STejun Heo  * %true if some freezable workqueues are still busy.  %false if freezing
652258a69cb4STejun Heo  * is complete.
6523a0a1a5fdSTejun Heo  */
6524a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void)
6525a0a1a5fdSTejun Heo {
6526a0a1a5fdSTejun Heo 	bool busy = false;
652724b8a847STejun Heo 	struct workqueue_struct *wq;
652824b8a847STejun Heo 	struct pool_workqueue *pwq;
6529a0a1a5fdSTejun Heo 
653068e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6531a0a1a5fdSTejun Heo 
65326183c009STejun Heo 	WARN_ON_ONCE(!workqueue_freezing);
6533a0a1a5fdSTejun Heo 
653424b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
653524b8a847STejun Heo 		if (!(wq->flags & WQ_FREEZABLE))
653624b8a847STejun Heo 			continue;
6537a0a1a5fdSTejun Heo 		/*
6538a0a1a5fdSTejun Heo 		 * nr_active is monotonically decreasing.  It's safe
6539a0a1a5fdSTejun Heo 		 * to peek without lock.
6540a0a1a5fdSTejun Heo 		 */
654124acfb71SThomas Gleixner 		rcu_read_lock();
654224b8a847STejun Heo 		for_each_pwq(pwq, wq) {
65436183c009STejun Heo 			WARN_ON_ONCE(pwq->nr_active < 0);
6544112202d9STejun Heo 			if (pwq->nr_active) {
6545a0a1a5fdSTejun Heo 				busy = true;
654624acfb71SThomas Gleixner 				rcu_read_unlock();
6547a0a1a5fdSTejun Heo 				goto out_unlock;
6548a0a1a5fdSTejun Heo 			}
6549a0a1a5fdSTejun Heo 		}
655024acfb71SThomas Gleixner 		rcu_read_unlock();
6551a0a1a5fdSTejun Heo 	}
6552a0a1a5fdSTejun Heo out_unlock:
655368e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6554a0a1a5fdSTejun Heo 	return busy;
6555a0a1a5fdSTejun Heo }
6556a0a1a5fdSTejun Heo 
6557a0a1a5fdSTejun Heo /**
6558a0a1a5fdSTejun Heo  * thaw_workqueues - thaw workqueues
6559a0a1a5fdSTejun Heo  *
6560a0a1a5fdSTejun Heo  * Thaw workqueues.  Normal queueing is restored and all collected
6561706026c2STejun Heo  * frozen works are transferred to their respective pool worklists.
6562a0a1a5fdSTejun Heo  *
6563a0a1a5fdSTejun Heo  * CONTEXT:
6564a357fc03SLai Jiangshan  * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
6565a0a1a5fdSTejun Heo  */
6566a0a1a5fdSTejun Heo void thaw_workqueues(void)
6567a0a1a5fdSTejun Heo {
656824b8a847STejun Heo 	struct workqueue_struct *wq;
6569a0a1a5fdSTejun Heo 
657068e13a67SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
6571a0a1a5fdSTejun Heo 
6572a0a1a5fdSTejun Heo 	if (!workqueue_freezing)
6573a0a1a5fdSTejun Heo 		goto out_unlock;
6574a0a1a5fdSTejun Heo 
657574b414eaSLai Jiangshan 	workqueue_freezing = false;
657624b8a847STejun Heo 
657724b8a847STejun Heo 	/* restore max_active and repopulate worklist */
657824b8a847STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6579a357fc03SLai Jiangshan 		mutex_lock(&wq->mutex);
6580a045a272STejun Heo 		wq_adjust_max_active(wq);
6581a357fc03SLai Jiangshan 		mutex_unlock(&wq->mutex);
658224b8a847STejun Heo 	}
658324b8a847STejun Heo 
6584a0a1a5fdSTejun Heo out_unlock:
658568e13a67SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
6586a0a1a5fdSTejun Heo }
6587a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */
6588a0a1a5fdSTejun Heo 
658999c621efSLai Jiangshan static int workqueue_apply_unbound_cpumask(const cpumask_var_t unbound_cpumask)
6590042f7df1SLai Jiangshan {
6591042f7df1SLai Jiangshan 	LIST_HEAD(ctxs);
6592042f7df1SLai Jiangshan 	int ret = 0;
6593042f7df1SLai Jiangshan 	struct workqueue_struct *wq;
6594042f7df1SLai Jiangshan 	struct apply_wqattrs_ctx *ctx, *n;
6595042f7df1SLai Jiangshan 
6596042f7df1SLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6597042f7df1SLai Jiangshan 
6598042f7df1SLai Jiangshan 	list_for_each_entry(wq, &workqueues, list) {
65998eb17dc1SWaiman Long 		if (!(wq->flags & WQ_UNBOUND) || (wq->flags & __WQ_DESTROYING))
6600042f7df1SLai Jiangshan 			continue;
6601042f7df1SLai Jiangshan 
660299c621efSLai Jiangshan 		ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs, unbound_cpumask);
660384193c07STejun Heo 		if (IS_ERR(ctx)) {
660484193c07STejun Heo 			ret = PTR_ERR(ctx);
6605042f7df1SLai Jiangshan 			break;
6606042f7df1SLai Jiangshan 		}
6607042f7df1SLai Jiangshan 
6608042f7df1SLai Jiangshan 		list_add_tail(&ctx->list, &ctxs);
6609042f7df1SLai Jiangshan 	}
6610042f7df1SLai Jiangshan 
6611042f7df1SLai Jiangshan 	list_for_each_entry_safe(ctx, n, &ctxs, list) {
6612042f7df1SLai Jiangshan 		if (!ret)
6613042f7df1SLai Jiangshan 			apply_wqattrs_commit(ctx);
6614042f7df1SLai Jiangshan 		apply_wqattrs_cleanup(ctx);
6615042f7df1SLai Jiangshan 	}
6616042f7df1SLai Jiangshan 
661799c621efSLai Jiangshan 	if (!ret) {
661899c621efSLai Jiangshan 		mutex_lock(&wq_pool_attach_mutex);
661999c621efSLai Jiangshan 		cpumask_copy(wq_unbound_cpumask, unbound_cpumask);
662099c621efSLai Jiangshan 		mutex_unlock(&wq_pool_attach_mutex);
662199c621efSLai Jiangshan 	}
6622042f7df1SLai Jiangshan 	return ret;
6623042f7df1SLai Jiangshan }
6624042f7df1SLai Jiangshan 
6625042f7df1SLai Jiangshan /**
6626fe28f631SWaiman Long  * workqueue_unbound_exclude_cpumask - Exclude given CPUs from unbound cpumask
6627fe28f631SWaiman Long  * @exclude_cpumask: the cpumask to be excluded from wq_unbound_cpumask
6628fe28f631SWaiman Long  *
6629fe28f631SWaiman Long  * This function can be called from cpuset code to provide a set of isolated
6630fe28f631SWaiman Long  * CPUs that should be excluded from wq_unbound_cpumask. The caller must hold
6631fe28f631SWaiman Long  * either cpus_read_lock or cpus_write_lock.
6632fe28f631SWaiman Long  */
6633fe28f631SWaiman Long int workqueue_unbound_exclude_cpumask(cpumask_var_t exclude_cpumask)
6634fe28f631SWaiman Long {
6635fe28f631SWaiman Long 	cpumask_var_t cpumask;
6636fe28f631SWaiman Long 	int ret = 0;
6637fe28f631SWaiman Long 
6638fe28f631SWaiman Long 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
6639fe28f631SWaiman Long 		return -ENOMEM;
6640fe28f631SWaiman Long 
6641fe28f631SWaiman Long 	lockdep_assert_cpus_held();
6642fe28f631SWaiman Long 	mutex_lock(&wq_pool_mutex);
6643fe28f631SWaiman Long 
6644fe28f631SWaiman Long 	/* Save the current isolated cpumask & export it via sysfs */
6645fe28f631SWaiman Long 	cpumask_copy(wq_isolated_cpumask, exclude_cpumask);
6646fe28f631SWaiman Long 
6647fe28f631SWaiman Long 	/*
6648fe28f631SWaiman Long 	 * If the operation fails, it will fall back to
6649fe28f631SWaiman Long 	 * wq_requested_unbound_cpumask which is initially set to
6650fe28f631SWaiman Long 	 * (HK_TYPE_WQ ∩ HK_TYPE_DOMAIN) house keeping mask and rewritten
6651fe28f631SWaiman Long 	 * by any subsequent write to workqueue/cpumask sysfs file.
6652fe28f631SWaiman Long 	 */
6653fe28f631SWaiman Long 	if (!cpumask_andnot(cpumask, wq_requested_unbound_cpumask, exclude_cpumask))
6654fe28f631SWaiman Long 		cpumask_copy(cpumask, wq_requested_unbound_cpumask);
6655fe28f631SWaiman Long 	if (!cpumask_equal(cpumask, wq_unbound_cpumask))
6656fe28f631SWaiman Long 		ret = workqueue_apply_unbound_cpumask(cpumask);
6657fe28f631SWaiman Long 
6658fe28f631SWaiman Long 	mutex_unlock(&wq_pool_mutex);
6659fe28f631SWaiman Long 	free_cpumask_var(cpumask);
6660fe28f631SWaiman Long 	return ret;
6661fe28f631SWaiman Long }
6662fe28f631SWaiman Long 
666363c5484eSTejun Heo static int parse_affn_scope(const char *val)
666463c5484eSTejun Heo {
666563c5484eSTejun Heo 	int i;
666663c5484eSTejun Heo 
666763c5484eSTejun Heo 	for (i = 0; i < ARRAY_SIZE(wq_affn_names); i++) {
666863c5484eSTejun Heo 		if (!strncasecmp(val, wq_affn_names[i], strlen(wq_affn_names[i])))
666963c5484eSTejun Heo 			return i;
667063c5484eSTejun Heo 	}
667163c5484eSTejun Heo 	return -EINVAL;
667263c5484eSTejun Heo }
667363c5484eSTejun Heo 
667463c5484eSTejun Heo static int wq_affn_dfl_set(const char *val, const struct kernel_param *kp)
667563c5484eSTejun Heo {
6676523a301eSTejun Heo 	struct workqueue_struct *wq;
6677523a301eSTejun Heo 	int affn, cpu;
667863c5484eSTejun Heo 
667963c5484eSTejun Heo 	affn = parse_affn_scope(val);
668063c5484eSTejun Heo 	if (affn < 0)
668163c5484eSTejun Heo 		return affn;
6682523a301eSTejun Heo 	if (affn == WQ_AFFN_DFL)
6683523a301eSTejun Heo 		return -EINVAL;
6684523a301eSTejun Heo 
6685523a301eSTejun Heo 	cpus_read_lock();
6686523a301eSTejun Heo 	mutex_lock(&wq_pool_mutex);
668763c5484eSTejun Heo 
668863c5484eSTejun Heo 	wq_affn_dfl = affn;
6689523a301eSTejun Heo 
6690523a301eSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
6691523a301eSTejun Heo 		for_each_online_cpu(cpu) {
6692523a301eSTejun Heo 			wq_update_pod(wq, cpu, cpu, true);
6693523a301eSTejun Heo 		}
6694523a301eSTejun Heo 	}
6695523a301eSTejun Heo 
6696523a301eSTejun Heo 	mutex_unlock(&wq_pool_mutex);
6697523a301eSTejun Heo 	cpus_read_unlock();
6698523a301eSTejun Heo 
669963c5484eSTejun Heo 	return 0;
670063c5484eSTejun Heo }
670163c5484eSTejun Heo 
670263c5484eSTejun Heo static int wq_affn_dfl_get(char *buffer, const struct kernel_param *kp)
670363c5484eSTejun Heo {
670463c5484eSTejun Heo 	return scnprintf(buffer, PAGE_SIZE, "%s\n", wq_affn_names[wq_affn_dfl]);
670563c5484eSTejun Heo }
670663c5484eSTejun Heo 
670763c5484eSTejun Heo static const struct kernel_param_ops wq_affn_dfl_ops = {
670863c5484eSTejun Heo 	.set	= wq_affn_dfl_set,
670963c5484eSTejun Heo 	.get	= wq_affn_dfl_get,
671063c5484eSTejun Heo };
671163c5484eSTejun Heo 
671263c5484eSTejun Heo module_param_cb(default_affinity_scope, &wq_affn_dfl_ops, NULL, 0644);
671363c5484eSTejun Heo 
67146ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS
67156ba94429SFrederic Weisbecker /*
67166ba94429SFrederic Weisbecker  * Workqueues with WQ_SYSFS flag set is visible to userland via
67176ba94429SFrederic Weisbecker  * /sys/bus/workqueue/devices/WQ_NAME.  All visible workqueues have the
67186ba94429SFrederic Weisbecker  * following attributes.
67196ba94429SFrederic Weisbecker  *
67206ba94429SFrederic Weisbecker  *  per_cpu		RO bool	: whether the workqueue is per-cpu or unbound
67216ba94429SFrederic Weisbecker  *  max_active		RW int	: maximum number of in-flight work items
67226ba94429SFrederic Weisbecker  *
67236ba94429SFrederic Weisbecker  * Unbound workqueues have the following extra attributes.
67246ba94429SFrederic Weisbecker  *
67256ba94429SFrederic Weisbecker  *  nice		RW int	: nice value of the workers
67266ba94429SFrederic Weisbecker  *  cpumask		RW mask	: bitmask of allowed CPUs for the workers
672763c5484eSTejun Heo  *  affinity_scope	RW str  : worker CPU affinity scope (cache, numa, none)
67288639ecebSTejun Heo  *  affinity_strict	RW bool : worker CPU affinity is strict
67296ba94429SFrederic Weisbecker  */
67306ba94429SFrederic Weisbecker struct wq_device {
67316ba94429SFrederic Weisbecker 	struct workqueue_struct		*wq;
67326ba94429SFrederic Weisbecker 	struct device			dev;
67336ba94429SFrederic Weisbecker };
67346ba94429SFrederic Weisbecker 
67356ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev)
67366ba94429SFrederic Weisbecker {
67376ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
67386ba94429SFrederic Weisbecker 
67396ba94429SFrederic Weisbecker 	return wq_dev->wq;
67406ba94429SFrederic Weisbecker }
67416ba94429SFrederic Weisbecker 
67426ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
67436ba94429SFrederic Weisbecker 			    char *buf)
67446ba94429SFrederic Weisbecker {
67456ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
67466ba94429SFrederic Weisbecker 
67476ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
67486ba94429SFrederic Weisbecker }
67496ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu);
67506ba94429SFrederic Weisbecker 
67516ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev,
67526ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
67536ba94429SFrederic Weisbecker {
67546ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
67556ba94429SFrederic Weisbecker 
67566ba94429SFrederic Weisbecker 	return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
67576ba94429SFrederic Weisbecker }
67586ba94429SFrederic Weisbecker 
67596ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev,
67606ba94429SFrederic Weisbecker 				struct device_attribute *attr, const char *buf,
67616ba94429SFrederic Weisbecker 				size_t count)
67626ba94429SFrederic Weisbecker {
67636ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
67646ba94429SFrederic Weisbecker 	int val;
67656ba94429SFrederic Weisbecker 
67666ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &val) != 1 || val <= 0)
67676ba94429SFrederic Weisbecker 		return -EINVAL;
67686ba94429SFrederic Weisbecker 
67696ba94429SFrederic Weisbecker 	workqueue_set_max_active(wq, val);
67706ba94429SFrederic Weisbecker 	return count;
67716ba94429SFrederic Weisbecker }
67726ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active);
67736ba94429SFrederic Weisbecker 
67746ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = {
67756ba94429SFrederic Weisbecker 	&dev_attr_per_cpu.attr,
67766ba94429SFrederic Weisbecker 	&dev_attr_max_active.attr,
67776ba94429SFrederic Weisbecker 	NULL,
67786ba94429SFrederic Weisbecker };
67796ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs);
67806ba94429SFrederic Weisbecker 
678149277a5bSWaiman Long static void apply_wqattrs_lock(void)
678249277a5bSWaiman Long {
678349277a5bSWaiman Long 	/* CPUs should stay stable across pwq creations and installations */
678449277a5bSWaiman Long 	cpus_read_lock();
678549277a5bSWaiman Long 	mutex_lock(&wq_pool_mutex);
678649277a5bSWaiman Long }
678749277a5bSWaiman Long 
678849277a5bSWaiman Long static void apply_wqattrs_unlock(void)
678949277a5bSWaiman Long {
679049277a5bSWaiman Long 	mutex_unlock(&wq_pool_mutex);
679149277a5bSWaiman Long 	cpus_read_unlock();
679249277a5bSWaiman Long }
679349277a5bSWaiman Long 
67946ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
67956ba94429SFrederic Weisbecker 			    char *buf)
67966ba94429SFrederic Weisbecker {
67976ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
67986ba94429SFrederic Weisbecker 	int written;
67996ba94429SFrederic Weisbecker 
68006ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
68016ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
68026ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
68036ba94429SFrederic Weisbecker 
68046ba94429SFrederic Weisbecker 	return written;
68056ba94429SFrederic Weisbecker }
68066ba94429SFrederic Weisbecker 
68076ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */
68086ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
68096ba94429SFrederic Weisbecker {
68106ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
68116ba94429SFrederic Weisbecker 
6812899a94feSLai Jiangshan 	lockdep_assert_held(&wq_pool_mutex);
6813899a94feSLai Jiangshan 
6814be69d00dSThomas Gleixner 	attrs = alloc_workqueue_attrs();
68156ba94429SFrederic Weisbecker 	if (!attrs)
68166ba94429SFrederic Weisbecker 		return NULL;
68176ba94429SFrederic Weisbecker 
68186ba94429SFrederic Weisbecker 	copy_workqueue_attrs(attrs, wq->unbound_attrs);
68196ba94429SFrederic Weisbecker 	return attrs;
68206ba94429SFrederic Weisbecker }
68216ba94429SFrederic Weisbecker 
68226ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
68236ba94429SFrederic Weisbecker 			     const char *buf, size_t count)
68246ba94429SFrederic Weisbecker {
68256ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
68266ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
6827d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
6828d4d3e257SLai Jiangshan 
6829d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
68306ba94429SFrederic Weisbecker 
68316ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
68326ba94429SFrederic Weisbecker 	if (!attrs)
6833d4d3e257SLai Jiangshan 		goto out_unlock;
68346ba94429SFrederic Weisbecker 
68356ba94429SFrederic Weisbecker 	if (sscanf(buf, "%d", &attrs->nice) == 1 &&
68366ba94429SFrederic Weisbecker 	    attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
6837d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
68386ba94429SFrederic Weisbecker 	else
68396ba94429SFrederic Weisbecker 		ret = -EINVAL;
68406ba94429SFrederic Weisbecker 
6841d4d3e257SLai Jiangshan out_unlock:
6842d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
68436ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
68446ba94429SFrederic Weisbecker 	return ret ?: count;
68456ba94429SFrederic Weisbecker }
68466ba94429SFrederic Weisbecker 
68476ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev,
68486ba94429SFrederic Weisbecker 			       struct device_attribute *attr, char *buf)
68496ba94429SFrederic Weisbecker {
68506ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
68516ba94429SFrederic Weisbecker 	int written;
68526ba94429SFrederic Weisbecker 
68536ba94429SFrederic Weisbecker 	mutex_lock(&wq->mutex);
68546ba94429SFrederic Weisbecker 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n",
68556ba94429SFrederic Weisbecker 			    cpumask_pr_args(wq->unbound_attrs->cpumask));
68566ba94429SFrederic Weisbecker 	mutex_unlock(&wq->mutex);
68576ba94429SFrederic Weisbecker 	return written;
68586ba94429SFrederic Weisbecker }
68596ba94429SFrederic Weisbecker 
68606ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev,
68616ba94429SFrederic Weisbecker 				struct device_attribute *attr,
68626ba94429SFrederic Weisbecker 				const char *buf, size_t count)
68636ba94429SFrederic Weisbecker {
68646ba94429SFrederic Weisbecker 	struct workqueue_struct *wq = dev_to_wq(dev);
68656ba94429SFrederic Weisbecker 	struct workqueue_attrs *attrs;
6866d4d3e257SLai Jiangshan 	int ret = -ENOMEM;
6867d4d3e257SLai Jiangshan 
6868d4d3e257SLai Jiangshan 	apply_wqattrs_lock();
68696ba94429SFrederic Weisbecker 
68706ba94429SFrederic Weisbecker 	attrs = wq_sysfs_prep_attrs(wq);
68716ba94429SFrederic Weisbecker 	if (!attrs)
6872d4d3e257SLai Jiangshan 		goto out_unlock;
68736ba94429SFrederic Weisbecker 
68746ba94429SFrederic Weisbecker 	ret = cpumask_parse(buf, attrs->cpumask);
68756ba94429SFrederic Weisbecker 	if (!ret)
6876d4d3e257SLai Jiangshan 		ret = apply_workqueue_attrs_locked(wq, attrs);
68776ba94429SFrederic Weisbecker 
6878d4d3e257SLai Jiangshan out_unlock:
6879d4d3e257SLai Jiangshan 	apply_wqattrs_unlock();
68806ba94429SFrederic Weisbecker 	free_workqueue_attrs(attrs);
68816ba94429SFrederic Weisbecker 	return ret ?: count;
68826ba94429SFrederic Weisbecker }
68836ba94429SFrederic Weisbecker 
688463c5484eSTejun Heo static ssize_t wq_affn_scope_show(struct device *dev,
688563c5484eSTejun Heo 				  struct device_attribute *attr, char *buf)
688663c5484eSTejun Heo {
688763c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
688863c5484eSTejun Heo 	int written;
688963c5484eSTejun Heo 
689063c5484eSTejun Heo 	mutex_lock(&wq->mutex);
6891523a301eSTejun Heo 	if (wq->unbound_attrs->affn_scope == WQ_AFFN_DFL)
6892523a301eSTejun Heo 		written = scnprintf(buf, PAGE_SIZE, "%s (%s)\n",
6893523a301eSTejun Heo 				    wq_affn_names[WQ_AFFN_DFL],
6894523a301eSTejun Heo 				    wq_affn_names[wq_affn_dfl]);
6895523a301eSTejun Heo 	else
689663c5484eSTejun Heo 		written = scnprintf(buf, PAGE_SIZE, "%s\n",
689763c5484eSTejun Heo 				    wq_affn_names[wq->unbound_attrs->affn_scope]);
689863c5484eSTejun Heo 	mutex_unlock(&wq->mutex);
689963c5484eSTejun Heo 
690063c5484eSTejun Heo 	return written;
690163c5484eSTejun Heo }
690263c5484eSTejun Heo 
690363c5484eSTejun Heo static ssize_t wq_affn_scope_store(struct device *dev,
690463c5484eSTejun Heo 				   struct device_attribute *attr,
690563c5484eSTejun Heo 				   const char *buf, size_t count)
690663c5484eSTejun Heo {
690763c5484eSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
690863c5484eSTejun Heo 	struct workqueue_attrs *attrs;
690963c5484eSTejun Heo 	int affn, ret = -ENOMEM;
691063c5484eSTejun Heo 
691163c5484eSTejun Heo 	affn = parse_affn_scope(buf);
691263c5484eSTejun Heo 	if (affn < 0)
691363c5484eSTejun Heo 		return affn;
691463c5484eSTejun Heo 
691563c5484eSTejun Heo 	apply_wqattrs_lock();
691663c5484eSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
691763c5484eSTejun Heo 	if (attrs) {
691863c5484eSTejun Heo 		attrs->affn_scope = affn;
691963c5484eSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
692063c5484eSTejun Heo 	}
692163c5484eSTejun Heo 	apply_wqattrs_unlock();
692263c5484eSTejun Heo 	free_workqueue_attrs(attrs);
692363c5484eSTejun Heo 	return ret ?: count;
692463c5484eSTejun Heo }
692563c5484eSTejun Heo 
69268639ecebSTejun Heo static ssize_t wq_affinity_strict_show(struct device *dev,
69278639ecebSTejun Heo 				       struct device_attribute *attr, char *buf)
69288639ecebSTejun Heo {
69298639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
69308639ecebSTejun Heo 
69318639ecebSTejun Heo 	return scnprintf(buf, PAGE_SIZE, "%d\n",
69328639ecebSTejun Heo 			 wq->unbound_attrs->affn_strict);
69338639ecebSTejun Heo }
69348639ecebSTejun Heo 
69358639ecebSTejun Heo static ssize_t wq_affinity_strict_store(struct device *dev,
69368639ecebSTejun Heo 					struct device_attribute *attr,
69378639ecebSTejun Heo 					const char *buf, size_t count)
69388639ecebSTejun Heo {
69398639ecebSTejun Heo 	struct workqueue_struct *wq = dev_to_wq(dev);
69408639ecebSTejun Heo 	struct workqueue_attrs *attrs;
69418639ecebSTejun Heo 	int v, ret = -ENOMEM;
69428639ecebSTejun Heo 
69438639ecebSTejun Heo 	if (sscanf(buf, "%d", &v) != 1)
69448639ecebSTejun Heo 		return -EINVAL;
69458639ecebSTejun Heo 
69468639ecebSTejun Heo 	apply_wqattrs_lock();
69478639ecebSTejun Heo 	attrs = wq_sysfs_prep_attrs(wq);
69488639ecebSTejun Heo 	if (attrs) {
69498639ecebSTejun Heo 		attrs->affn_strict = (bool)v;
69508639ecebSTejun Heo 		ret = apply_workqueue_attrs_locked(wq, attrs);
69518639ecebSTejun Heo 	}
69528639ecebSTejun Heo 	apply_wqattrs_unlock();
69538639ecebSTejun Heo 	free_workqueue_attrs(attrs);
69548639ecebSTejun Heo 	return ret ?: count;
69558639ecebSTejun Heo }
69568639ecebSTejun Heo 
69576ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = {
69586ba94429SFrederic Weisbecker 	__ATTR(nice, 0644, wq_nice_show, wq_nice_store),
69596ba94429SFrederic Weisbecker 	__ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
696063c5484eSTejun Heo 	__ATTR(affinity_scope, 0644, wq_affn_scope_show, wq_affn_scope_store),
69618639ecebSTejun Heo 	__ATTR(affinity_strict, 0644, wq_affinity_strict_show, wq_affinity_strict_store),
69626ba94429SFrederic Weisbecker 	__ATTR_NULL,
69636ba94429SFrederic Weisbecker };
69646ba94429SFrederic Weisbecker 
69654f19b8e0STejun Heo static struct bus_type wq_subsys = {
69666ba94429SFrederic Weisbecker 	.name				= "workqueue",
69676ba94429SFrederic Weisbecker 	.dev_groups			= wq_sysfs_groups,
69686ba94429SFrederic Weisbecker };
69696ba94429SFrederic Weisbecker 
697049277a5bSWaiman Long /**
697149277a5bSWaiman Long  *  workqueue_set_unbound_cpumask - Set the low-level unbound cpumask
697249277a5bSWaiman Long  *  @cpumask: the cpumask to set
697349277a5bSWaiman Long  *
697449277a5bSWaiman Long  *  The low-level workqueues cpumask is a global cpumask that limits
697549277a5bSWaiman Long  *  the affinity of all unbound workqueues.  This function check the @cpumask
697649277a5bSWaiman Long  *  and apply it to all unbound workqueues and updates all pwqs of them.
697749277a5bSWaiman Long  *
697849277a5bSWaiman Long  *  Return:	0	- Success
697949277a5bSWaiman Long  *		-EINVAL	- Invalid @cpumask
698049277a5bSWaiman Long  *		-ENOMEM	- Failed to allocate memory for attrs or pwqs.
698149277a5bSWaiman Long  */
698249277a5bSWaiman Long static int workqueue_set_unbound_cpumask(cpumask_var_t cpumask)
698349277a5bSWaiman Long {
698449277a5bSWaiman Long 	int ret = -EINVAL;
698549277a5bSWaiman Long 
698649277a5bSWaiman Long 	/*
698749277a5bSWaiman Long 	 * Not excluding isolated cpus on purpose.
698849277a5bSWaiman Long 	 * If the user wishes to include them, we allow that.
698949277a5bSWaiman Long 	 */
699049277a5bSWaiman Long 	cpumask_and(cpumask, cpumask, cpu_possible_mask);
699149277a5bSWaiman Long 	if (!cpumask_empty(cpumask)) {
699249277a5bSWaiman Long 		apply_wqattrs_lock();
699349277a5bSWaiman Long 		cpumask_copy(wq_requested_unbound_cpumask, cpumask);
699449277a5bSWaiman Long 		if (cpumask_equal(cpumask, wq_unbound_cpumask)) {
699549277a5bSWaiman Long 			ret = 0;
699649277a5bSWaiman Long 			goto out_unlock;
699749277a5bSWaiman Long 		}
699849277a5bSWaiman Long 
699949277a5bSWaiman Long 		ret = workqueue_apply_unbound_cpumask(cpumask);
700049277a5bSWaiman Long 
700149277a5bSWaiman Long out_unlock:
700249277a5bSWaiman Long 		apply_wqattrs_unlock();
700349277a5bSWaiman Long 	}
700449277a5bSWaiman Long 
700549277a5bSWaiman Long 	return ret;
700649277a5bSWaiman Long }
700749277a5bSWaiman Long 
7008fe28f631SWaiman Long static ssize_t __wq_cpumask_show(struct device *dev,
7009fe28f631SWaiman Long 		struct device_attribute *attr, char *buf, cpumask_var_t mask)
7010b05a7928SFrederic Weisbecker {
7011b05a7928SFrederic Weisbecker 	int written;
7012b05a7928SFrederic Weisbecker 
7013042f7df1SLai Jiangshan 	mutex_lock(&wq_pool_mutex);
7014fe28f631SWaiman Long 	written = scnprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask));
7015042f7df1SLai Jiangshan 	mutex_unlock(&wq_pool_mutex);
7016b05a7928SFrederic Weisbecker 
7017b05a7928SFrederic Weisbecker 	return written;
7018b05a7928SFrederic Weisbecker }
7019b05a7928SFrederic Weisbecker 
7020fe28f631SWaiman Long static ssize_t wq_unbound_cpumask_show(struct device *dev,
7021fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
7022fe28f631SWaiman Long {
7023fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_unbound_cpumask);
7024fe28f631SWaiman Long }
7025fe28f631SWaiman Long 
7026fe28f631SWaiman Long static ssize_t wq_requested_cpumask_show(struct device *dev,
7027fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
7028fe28f631SWaiman Long {
7029fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_requested_unbound_cpumask);
7030fe28f631SWaiman Long }
7031fe28f631SWaiman Long 
7032fe28f631SWaiman Long static ssize_t wq_isolated_cpumask_show(struct device *dev,
7033fe28f631SWaiman Long 		struct device_attribute *attr, char *buf)
7034fe28f631SWaiman Long {
7035fe28f631SWaiman Long 	return __wq_cpumask_show(dev, attr, buf, wq_isolated_cpumask);
7036fe28f631SWaiman Long }
7037fe28f631SWaiman Long 
7038042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev,
7039042f7df1SLai Jiangshan 		struct device_attribute *attr, const char *buf, size_t count)
7040042f7df1SLai Jiangshan {
7041042f7df1SLai Jiangshan 	cpumask_var_t cpumask;
7042042f7df1SLai Jiangshan 	int ret;
7043042f7df1SLai Jiangshan 
7044042f7df1SLai Jiangshan 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
7045042f7df1SLai Jiangshan 		return -ENOMEM;
7046042f7df1SLai Jiangshan 
7047042f7df1SLai Jiangshan 	ret = cpumask_parse(buf, cpumask);
7048042f7df1SLai Jiangshan 	if (!ret)
7049042f7df1SLai Jiangshan 		ret = workqueue_set_unbound_cpumask(cpumask);
7050042f7df1SLai Jiangshan 
7051042f7df1SLai Jiangshan 	free_cpumask_var(cpumask);
7052042f7df1SLai Jiangshan 	return ret ? ret : count;
7053042f7df1SLai Jiangshan }
7054042f7df1SLai Jiangshan 
7055fe28f631SWaiman Long static struct device_attribute wq_sysfs_cpumask_attrs[] = {
7056042f7df1SLai Jiangshan 	__ATTR(cpumask, 0644, wq_unbound_cpumask_show,
7057fe28f631SWaiman Long 	       wq_unbound_cpumask_store),
7058fe28f631SWaiman Long 	__ATTR(cpumask_requested, 0444, wq_requested_cpumask_show, NULL),
7059fe28f631SWaiman Long 	__ATTR(cpumask_isolated, 0444, wq_isolated_cpumask_show, NULL),
7060fe28f631SWaiman Long 	__ATTR_NULL,
7061fe28f631SWaiman Long };
7062b05a7928SFrederic Weisbecker 
70636ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void)
70646ba94429SFrederic Weisbecker {
7065686f6697SGreg Kroah-Hartman 	struct device *dev_root;
7066b05a7928SFrederic Weisbecker 	int err;
7067b05a7928SFrederic Weisbecker 
7068b05a7928SFrederic Weisbecker 	err = subsys_virtual_register(&wq_subsys, NULL);
7069b05a7928SFrederic Weisbecker 	if (err)
7070b05a7928SFrederic Weisbecker 		return err;
7071b05a7928SFrederic Weisbecker 
7072686f6697SGreg Kroah-Hartman 	dev_root = bus_get_dev_root(&wq_subsys);
7073686f6697SGreg Kroah-Hartman 	if (dev_root) {
7074fe28f631SWaiman Long 		struct device_attribute *attr;
7075fe28f631SWaiman Long 
7076fe28f631SWaiman Long 		for (attr = wq_sysfs_cpumask_attrs; attr->attr.name; attr++) {
7077fe28f631SWaiman Long 			err = device_create_file(dev_root, attr);
7078fe28f631SWaiman Long 			if (err)
7079fe28f631SWaiman Long 				break;
7080fe28f631SWaiman Long 		}
7081686f6697SGreg Kroah-Hartman 		put_device(dev_root);
7082686f6697SGreg Kroah-Hartman 	}
7083686f6697SGreg Kroah-Hartman 	return err;
70846ba94429SFrederic Weisbecker }
70856ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init);
70866ba94429SFrederic Weisbecker 
70876ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev)
70886ba94429SFrederic Weisbecker {
70896ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
70906ba94429SFrederic Weisbecker 
70916ba94429SFrederic Weisbecker 	kfree(wq_dev);
70926ba94429SFrederic Weisbecker }
70936ba94429SFrederic Weisbecker 
70946ba94429SFrederic Weisbecker /**
70956ba94429SFrederic Weisbecker  * workqueue_sysfs_register - make a workqueue visible in sysfs
70966ba94429SFrederic Weisbecker  * @wq: the workqueue to register
70976ba94429SFrederic Weisbecker  *
70986ba94429SFrederic Weisbecker  * Expose @wq in sysfs under /sys/bus/workqueue/devices.
70996ba94429SFrederic Weisbecker  * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
71006ba94429SFrederic Weisbecker  * which is the preferred method.
71016ba94429SFrederic Weisbecker  *
71026ba94429SFrederic Weisbecker  * Workqueue user should use this function directly iff it wants to apply
71036ba94429SFrederic Weisbecker  * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
71046ba94429SFrederic Weisbecker  * apply_workqueue_attrs() may race against userland updating the
71056ba94429SFrederic Weisbecker  * attributes.
71066ba94429SFrederic Weisbecker  *
71076ba94429SFrederic Weisbecker  * Return: 0 on success, -errno on failure.
71086ba94429SFrederic Weisbecker  */
71096ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq)
71106ba94429SFrederic Weisbecker {
71116ba94429SFrederic Weisbecker 	struct wq_device *wq_dev;
71126ba94429SFrederic Weisbecker 	int ret;
71136ba94429SFrederic Weisbecker 
71146ba94429SFrederic Weisbecker 	/*
71154c065dbcSWaiman Long 	 * Adjusting max_active breaks ordering guarantee.  Disallow exposing
71164c065dbcSWaiman Long 	 * ordered workqueues.
71176ba94429SFrederic Weisbecker 	 */
71183bc1e711STejun Heo 	if (WARN_ON(wq->flags & __WQ_ORDERED))
71196ba94429SFrederic Weisbecker 		return -EINVAL;
71206ba94429SFrederic Weisbecker 
71216ba94429SFrederic Weisbecker 	wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
71226ba94429SFrederic Weisbecker 	if (!wq_dev)
71236ba94429SFrederic Weisbecker 		return -ENOMEM;
71246ba94429SFrederic Weisbecker 
71256ba94429SFrederic Weisbecker 	wq_dev->wq = wq;
71266ba94429SFrederic Weisbecker 	wq_dev->dev.bus = &wq_subsys;
71276ba94429SFrederic Weisbecker 	wq_dev->dev.release = wq_device_release;
712823217b44SLars-Peter Clausen 	dev_set_name(&wq_dev->dev, "%s", wq->name);
71296ba94429SFrederic Weisbecker 
71306ba94429SFrederic Weisbecker 	/*
71316ba94429SFrederic Weisbecker 	 * unbound_attrs are created separately.  Suppress uevent until
71326ba94429SFrederic Weisbecker 	 * everything is ready.
71336ba94429SFrederic Weisbecker 	 */
71346ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, true);
71356ba94429SFrederic Weisbecker 
71366ba94429SFrederic Weisbecker 	ret = device_register(&wq_dev->dev);
71376ba94429SFrederic Weisbecker 	if (ret) {
7138537f4146SArvind Yadav 		put_device(&wq_dev->dev);
71396ba94429SFrederic Weisbecker 		wq->wq_dev = NULL;
71406ba94429SFrederic Weisbecker 		return ret;
71416ba94429SFrederic Weisbecker 	}
71426ba94429SFrederic Weisbecker 
71436ba94429SFrederic Weisbecker 	if (wq->flags & WQ_UNBOUND) {
71446ba94429SFrederic Weisbecker 		struct device_attribute *attr;
71456ba94429SFrederic Weisbecker 
71466ba94429SFrederic Weisbecker 		for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
71476ba94429SFrederic Weisbecker 			ret = device_create_file(&wq_dev->dev, attr);
71486ba94429SFrederic Weisbecker 			if (ret) {
71496ba94429SFrederic Weisbecker 				device_unregister(&wq_dev->dev);
71506ba94429SFrederic Weisbecker 				wq->wq_dev = NULL;
71516ba94429SFrederic Weisbecker 				return ret;
71526ba94429SFrederic Weisbecker 			}
71536ba94429SFrederic Weisbecker 		}
71546ba94429SFrederic Weisbecker 	}
71556ba94429SFrederic Weisbecker 
71566ba94429SFrederic Weisbecker 	dev_set_uevent_suppress(&wq_dev->dev, false);
71576ba94429SFrederic Weisbecker 	kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
71586ba94429SFrederic Weisbecker 	return 0;
71596ba94429SFrederic Weisbecker }
71606ba94429SFrederic Weisbecker 
71616ba94429SFrederic Weisbecker /**
71626ba94429SFrederic Weisbecker  * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
71636ba94429SFrederic Weisbecker  * @wq: the workqueue to unregister
71646ba94429SFrederic Weisbecker  *
71656ba94429SFrederic Weisbecker  * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
71666ba94429SFrederic Weisbecker  */
71676ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
71686ba94429SFrederic Weisbecker {
71696ba94429SFrederic Weisbecker 	struct wq_device *wq_dev = wq->wq_dev;
71706ba94429SFrederic Weisbecker 
71716ba94429SFrederic Weisbecker 	if (!wq->wq_dev)
71726ba94429SFrederic Weisbecker 		return;
71736ba94429SFrederic Weisbecker 
71746ba94429SFrederic Weisbecker 	wq->wq_dev = NULL;
71756ba94429SFrederic Weisbecker 	device_unregister(&wq_dev->dev);
71766ba94429SFrederic Weisbecker }
71776ba94429SFrederic Weisbecker #else	/* CONFIG_SYSFS */
71786ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq)	{ }
71796ba94429SFrederic Weisbecker #endif	/* CONFIG_SYSFS */
71806ba94429SFrederic Weisbecker 
718182607adcSTejun Heo /*
718282607adcSTejun Heo  * Workqueue watchdog.
718382607adcSTejun Heo  *
718482607adcSTejun Heo  * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal
718582607adcSTejun Heo  * flush dependency, a concurrency managed work item which stays RUNNING
718682607adcSTejun Heo  * indefinitely.  Workqueue stalls can be very difficult to debug as the
718782607adcSTejun Heo  * usual warning mechanisms don't trigger and internal workqueue state is
718882607adcSTejun Heo  * largely opaque.
718982607adcSTejun Heo  *
719082607adcSTejun Heo  * Workqueue watchdog monitors all worker pools periodically and dumps
719182607adcSTejun Heo  * state if some pools failed to make forward progress for a while where
719282607adcSTejun Heo  * forward progress is defined as the first item on ->worklist changing.
719382607adcSTejun Heo  *
719482607adcSTejun Heo  * This mechanism is controlled through the kernel parameter
719582607adcSTejun Heo  * "workqueue.watchdog_thresh" which can be updated at runtime through the
719682607adcSTejun Heo  * corresponding sysfs parameter file.
719782607adcSTejun Heo  */
719882607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG
719982607adcSTejun Heo 
720082607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30;
72015cd79d6aSKees Cook static struct timer_list wq_watchdog_timer;
720282607adcSTejun Heo 
720382607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES;
720482607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES;
720582607adcSTejun Heo 
7206cd2440d6SPetr Mladek /*
7207cd2440d6SPetr Mladek  * Show workers that might prevent the processing of pending work items.
7208cd2440d6SPetr Mladek  * The only candidates are CPU-bound workers in the running state.
7209cd2440d6SPetr Mladek  * Pending work items should be handled by another idle worker
7210cd2440d6SPetr Mladek  * in all other situations.
7211cd2440d6SPetr Mladek  */
7212cd2440d6SPetr Mladek static void show_cpu_pool_hog(struct worker_pool *pool)
7213cd2440d6SPetr Mladek {
7214cd2440d6SPetr Mladek 	struct worker *worker;
7215*c26e2f2eSTejun Heo 	unsigned long irq_flags;
7216cd2440d6SPetr Mladek 	int bkt;
7217cd2440d6SPetr Mladek 
7218*c26e2f2eSTejun Heo 	raw_spin_lock_irqsave(&pool->lock, irq_flags);
7219cd2440d6SPetr Mladek 
7220cd2440d6SPetr Mladek 	hash_for_each(pool->busy_hash, bkt, worker, hentry) {
7221cd2440d6SPetr Mladek 		if (task_is_running(worker->task)) {
7222cd2440d6SPetr Mladek 			/*
7223cd2440d6SPetr Mladek 			 * Defer printing to avoid deadlocks in console
7224cd2440d6SPetr Mladek 			 * drivers that queue work while holding locks
7225cd2440d6SPetr Mladek 			 * also taken in their write paths.
7226cd2440d6SPetr Mladek 			 */
7227cd2440d6SPetr Mladek 			printk_deferred_enter();
7228cd2440d6SPetr Mladek 
7229cd2440d6SPetr Mladek 			pr_info("pool %d:\n", pool->id);
7230cd2440d6SPetr Mladek 			sched_show_task(worker->task);
7231cd2440d6SPetr Mladek 
7232cd2440d6SPetr Mladek 			printk_deferred_exit();
7233cd2440d6SPetr Mladek 		}
7234cd2440d6SPetr Mladek 	}
7235cd2440d6SPetr Mladek 
7236*c26e2f2eSTejun Heo 	raw_spin_unlock_irqrestore(&pool->lock, irq_flags);
7237cd2440d6SPetr Mladek }
7238cd2440d6SPetr Mladek 
7239cd2440d6SPetr Mladek static void show_cpu_pools_hogs(void)
7240cd2440d6SPetr Mladek {
7241cd2440d6SPetr Mladek 	struct worker_pool *pool;
7242cd2440d6SPetr Mladek 	int pi;
7243cd2440d6SPetr Mladek 
7244cd2440d6SPetr Mladek 	pr_info("Showing backtraces of running workers in stalled CPU-bound worker pools:\n");
7245cd2440d6SPetr Mladek 
7246cd2440d6SPetr Mladek 	rcu_read_lock();
7247cd2440d6SPetr Mladek 
7248cd2440d6SPetr Mladek 	for_each_pool(pool, pi) {
7249cd2440d6SPetr Mladek 		if (pool->cpu_stall)
7250cd2440d6SPetr Mladek 			show_cpu_pool_hog(pool);
7251cd2440d6SPetr Mladek 
7252cd2440d6SPetr Mladek 	}
7253cd2440d6SPetr Mladek 
7254cd2440d6SPetr Mladek 	rcu_read_unlock();
7255cd2440d6SPetr Mladek }
7256cd2440d6SPetr Mladek 
725782607adcSTejun Heo static void wq_watchdog_reset_touched(void)
725882607adcSTejun Heo {
725982607adcSTejun Heo 	int cpu;
726082607adcSTejun Heo 
726182607adcSTejun Heo 	wq_watchdog_touched = jiffies;
726282607adcSTejun Heo 	for_each_possible_cpu(cpu)
726382607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
726482607adcSTejun Heo }
726582607adcSTejun Heo 
72665cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused)
726782607adcSTejun Heo {
726882607adcSTejun Heo 	unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ;
726982607adcSTejun Heo 	bool lockup_detected = false;
7270cd2440d6SPetr Mladek 	bool cpu_pool_stall = false;
7271940d71c6SSergey Senozhatsky 	unsigned long now = jiffies;
727282607adcSTejun Heo 	struct worker_pool *pool;
727382607adcSTejun Heo 	int pi;
727482607adcSTejun Heo 
727582607adcSTejun Heo 	if (!thresh)
727682607adcSTejun Heo 		return;
727782607adcSTejun Heo 
727882607adcSTejun Heo 	rcu_read_lock();
727982607adcSTejun Heo 
728082607adcSTejun Heo 	for_each_pool(pool, pi) {
728182607adcSTejun Heo 		unsigned long pool_ts, touched, ts;
728282607adcSTejun Heo 
7283cd2440d6SPetr Mladek 		pool->cpu_stall = false;
728482607adcSTejun Heo 		if (list_empty(&pool->worklist))
728582607adcSTejun Heo 			continue;
728682607adcSTejun Heo 
7287940d71c6SSergey Senozhatsky 		/*
7288940d71c6SSergey Senozhatsky 		 * If a virtual machine is stopped by the host it can look to
7289940d71c6SSergey Senozhatsky 		 * the watchdog like a stall.
7290940d71c6SSergey Senozhatsky 		 */
7291940d71c6SSergey Senozhatsky 		kvm_check_and_clear_guest_paused();
7292940d71c6SSergey Senozhatsky 
729382607adcSTejun Heo 		/* get the latest of pool and touched timestamps */
729489e28ce6SWang Qing 		if (pool->cpu >= 0)
729589e28ce6SWang Qing 			touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu));
729689e28ce6SWang Qing 		else
729782607adcSTejun Heo 			touched = READ_ONCE(wq_watchdog_touched);
729889e28ce6SWang Qing 		pool_ts = READ_ONCE(pool->watchdog_ts);
729982607adcSTejun Heo 
730082607adcSTejun Heo 		if (time_after(pool_ts, touched))
730182607adcSTejun Heo 			ts = pool_ts;
730282607adcSTejun Heo 		else
730382607adcSTejun Heo 			ts = touched;
730482607adcSTejun Heo 
730582607adcSTejun Heo 		/* did we stall? */
7306940d71c6SSergey Senozhatsky 		if (time_after(now, ts + thresh)) {
730782607adcSTejun Heo 			lockup_detected = true;
73084cb1ef64STejun Heo 			if (pool->cpu >= 0 && !(pool->flags & POOL_BH)) {
7309cd2440d6SPetr Mladek 				pool->cpu_stall = true;
7310cd2440d6SPetr Mladek 				cpu_pool_stall = true;
7311cd2440d6SPetr Mladek 			}
731282607adcSTejun Heo 			pr_emerg("BUG: workqueue lockup - pool");
731382607adcSTejun Heo 			pr_cont_pool_info(pool);
731482607adcSTejun Heo 			pr_cont(" stuck for %us!\n",
7315940d71c6SSergey Senozhatsky 				jiffies_to_msecs(now - pool_ts) / 1000);
731682607adcSTejun Heo 		}
7317cd2440d6SPetr Mladek 
7318cd2440d6SPetr Mladek 
731982607adcSTejun Heo 	}
732082607adcSTejun Heo 
732182607adcSTejun Heo 	rcu_read_unlock();
732282607adcSTejun Heo 
732382607adcSTejun Heo 	if (lockup_detected)
732455df0933SImran Khan 		show_all_workqueues();
732582607adcSTejun Heo 
7326cd2440d6SPetr Mladek 	if (cpu_pool_stall)
7327cd2440d6SPetr Mladek 		show_cpu_pools_hogs();
7328cd2440d6SPetr Mladek 
732982607adcSTejun Heo 	wq_watchdog_reset_touched();
733082607adcSTejun Heo 	mod_timer(&wq_watchdog_timer, jiffies + thresh);
733182607adcSTejun Heo }
733282607adcSTejun Heo 
7333cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu)
733482607adcSTejun Heo {
733582607adcSTejun Heo 	if (cpu >= 0)
733682607adcSTejun Heo 		per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies;
733789e28ce6SWang Qing 
733882607adcSTejun Heo 	wq_watchdog_touched = jiffies;
733982607adcSTejun Heo }
734082607adcSTejun Heo 
734182607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh)
734282607adcSTejun Heo {
734382607adcSTejun Heo 	wq_watchdog_thresh = 0;
734482607adcSTejun Heo 	del_timer_sync(&wq_watchdog_timer);
734582607adcSTejun Heo 
734682607adcSTejun Heo 	if (thresh) {
734782607adcSTejun Heo 		wq_watchdog_thresh = thresh;
734882607adcSTejun Heo 		wq_watchdog_reset_touched();
734982607adcSTejun Heo 		mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ);
735082607adcSTejun Heo 	}
735182607adcSTejun Heo }
735282607adcSTejun Heo 
735382607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val,
735482607adcSTejun Heo 					const struct kernel_param *kp)
735582607adcSTejun Heo {
735682607adcSTejun Heo 	unsigned long thresh;
735782607adcSTejun Heo 	int ret;
735882607adcSTejun Heo 
735982607adcSTejun Heo 	ret = kstrtoul(val, 0, &thresh);
736082607adcSTejun Heo 	if (ret)
736182607adcSTejun Heo 		return ret;
736282607adcSTejun Heo 
736382607adcSTejun Heo 	if (system_wq)
736482607adcSTejun Heo 		wq_watchdog_set_thresh(thresh);
736582607adcSTejun Heo 	else
736682607adcSTejun Heo 		wq_watchdog_thresh = thresh;
736782607adcSTejun Heo 
736882607adcSTejun Heo 	return 0;
736982607adcSTejun Heo }
737082607adcSTejun Heo 
737182607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = {
737282607adcSTejun Heo 	.set	= wq_watchdog_param_set_thresh,
737382607adcSTejun Heo 	.get	= param_get_ulong,
737482607adcSTejun Heo };
737582607adcSTejun Heo 
737682607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh,
737782607adcSTejun Heo 		0644);
737882607adcSTejun Heo 
737982607adcSTejun Heo static void wq_watchdog_init(void)
738082607adcSTejun Heo {
73815cd79d6aSKees Cook 	timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE);
738282607adcSTejun Heo 	wq_watchdog_set_thresh(wq_watchdog_thresh);
738382607adcSTejun Heo }
738482607adcSTejun Heo 
738582607adcSTejun Heo #else	/* CONFIG_WQ_WATCHDOG */
738682607adcSTejun Heo 
738782607adcSTejun Heo static inline void wq_watchdog_init(void) { }
738882607adcSTejun Heo 
738982607adcSTejun Heo #endif	/* CONFIG_WQ_WATCHDOG */
739082607adcSTejun Heo 
73912f34d733STejun Heo static void bh_pool_kick_normal(struct irq_work *irq_work)
73922f34d733STejun Heo {
73932f34d733STejun Heo 	raise_softirq_irqoff(TASKLET_SOFTIRQ);
73942f34d733STejun Heo }
73952f34d733STejun Heo 
73962f34d733STejun Heo static void bh_pool_kick_highpri(struct irq_work *irq_work)
73972f34d733STejun Heo {
73982f34d733STejun Heo 	raise_softirq_irqoff(HI_SOFTIRQ);
73992f34d733STejun Heo }
74002f34d733STejun Heo 
74014a6c5607STejun Heo static void __init restrict_unbound_cpumask(const char *name, const struct cpumask *mask)
74024a6c5607STejun Heo {
74034a6c5607STejun Heo 	if (!cpumask_intersects(wq_unbound_cpumask, mask)) {
74044a6c5607STejun Heo 		pr_warn("workqueue: Restricting unbound_cpumask (%*pb) with %s (%*pb) leaves no CPU, ignoring\n",
74054a6c5607STejun Heo 			cpumask_pr_args(wq_unbound_cpumask), name, cpumask_pr_args(mask));
74064a6c5607STejun Heo 		return;
74074a6c5607STejun Heo 	}
74084a6c5607STejun Heo 
74094a6c5607STejun Heo 	cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, mask);
74104a6c5607STejun Heo }
74114a6c5607STejun Heo 
74122fcdb1b4STejun Heo static void __init init_cpu_worker_pool(struct worker_pool *pool, int cpu, int nice)
74132fcdb1b4STejun Heo {
74142fcdb1b4STejun Heo 	BUG_ON(init_worker_pool(pool));
74152fcdb1b4STejun Heo 	pool->cpu = cpu;
74162fcdb1b4STejun Heo 	cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
74172fcdb1b4STejun Heo 	cpumask_copy(pool->attrs->__pod_cpumask, cpumask_of(cpu));
74182fcdb1b4STejun Heo 	pool->attrs->nice = nice;
74192fcdb1b4STejun Heo 	pool->attrs->affn_strict = true;
74202fcdb1b4STejun Heo 	pool->node = cpu_to_node(cpu);
74212fcdb1b4STejun Heo 
74222fcdb1b4STejun Heo 	/* alloc pool ID */
74232fcdb1b4STejun Heo 	mutex_lock(&wq_pool_mutex);
74242fcdb1b4STejun Heo 	BUG_ON(worker_pool_assign_id(pool));
74252fcdb1b4STejun Heo 	mutex_unlock(&wq_pool_mutex);
74262fcdb1b4STejun Heo }
74272fcdb1b4STejun Heo 
74283347fa09STejun Heo /**
74293347fa09STejun Heo  * workqueue_init_early - early init for workqueue subsystem
74303347fa09STejun Heo  *
74312930155bSTejun Heo  * This is the first step of three-staged workqueue subsystem initialization and
74322930155bSTejun Heo  * invoked as soon as the bare basics - memory allocation, cpumasks and idr are
74332930155bSTejun Heo  * up. It sets up all the data structures and system workqueues and allows early
74342930155bSTejun Heo  * boot code to create workqueues and queue/cancel work items. Actual work item
74352930155bSTejun Heo  * execution starts only after kthreads can be created and scheduled right
74362930155bSTejun Heo  * before early initcalls.
74373347fa09STejun Heo  */
74382333e829SYu Chen void __init workqueue_init_early(void)
74391da177e4SLinus Torvalds {
744084193c07STejun Heo 	struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_SYSTEM];
74417a4e344cSTejun Heo 	int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
74422f34d733STejun Heo 	void (*irq_work_fns[2])(struct irq_work *) = { bh_pool_kick_normal,
74432f34d733STejun Heo 						       bh_pool_kick_highpri };
74447a4e344cSTejun Heo 	int i, cpu;
7445c34056a3STejun Heo 
744610cdb157SLai Jiangshan 	BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
7447e904e6c2STejun Heo 
7448b05a7928SFrederic Weisbecker 	BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL));
7449fe28f631SWaiman Long 	BUG_ON(!alloc_cpumask_var(&wq_requested_unbound_cpumask, GFP_KERNEL));
7450fe28f631SWaiman Long 	BUG_ON(!zalloc_cpumask_var(&wq_isolated_cpumask, GFP_KERNEL));
7451b05a7928SFrederic Weisbecker 
74524a6c5607STejun Heo 	cpumask_copy(wq_unbound_cpumask, cpu_possible_mask);
74534a6c5607STejun Heo 	restrict_unbound_cpumask("HK_TYPE_WQ", housekeeping_cpumask(HK_TYPE_WQ));
74544a6c5607STejun Heo 	restrict_unbound_cpumask("HK_TYPE_DOMAIN", housekeeping_cpumask(HK_TYPE_DOMAIN));
7455ace3c549Stiozhang 	if (!cpumask_empty(&wq_cmdline_cpumask))
74564a6c5607STejun Heo 		restrict_unbound_cpumask("workqueue.unbound_cpus", &wq_cmdline_cpumask);
7457ace3c549Stiozhang 
7458fe28f631SWaiman Long 	cpumask_copy(wq_requested_unbound_cpumask, wq_unbound_cpumask);
74598b03ae3cSTejun Heo 
74608b03ae3cSTejun Heo 	pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
7461e22bee78STejun Heo 
74622930155bSTejun Heo 	wq_update_pod_attrs_buf = alloc_workqueue_attrs();
74632930155bSTejun Heo 	BUG_ON(!wq_update_pod_attrs_buf);
74642930155bSTejun Heo 
74657bd20b6bSMarcelo Tosatti 	/*
74667bd20b6bSMarcelo Tosatti 	 * If nohz_full is enabled, set power efficient workqueue as unbound.
74677bd20b6bSMarcelo Tosatti 	 * This allows workqueue items to be moved to HK CPUs.
74687bd20b6bSMarcelo Tosatti 	 */
74697bd20b6bSMarcelo Tosatti 	if (housekeeping_enabled(HK_TYPE_TICK))
74707bd20b6bSMarcelo Tosatti 		wq_power_efficient = true;
74717bd20b6bSMarcelo Tosatti 
747284193c07STejun Heo 	/* initialize WQ_AFFN_SYSTEM pods */
747384193c07STejun Heo 	pt->pod_cpus = kcalloc(1, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
747484193c07STejun Heo 	pt->pod_node = kcalloc(1, sizeof(pt->pod_node[0]), GFP_KERNEL);
747584193c07STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
747684193c07STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node || !pt->cpu_pod);
747784193c07STejun Heo 
747884193c07STejun Heo 	BUG_ON(!zalloc_cpumask_var_node(&pt->pod_cpus[0], GFP_KERNEL, NUMA_NO_NODE));
747984193c07STejun Heo 
748084193c07STejun Heo 	pt->nr_pods = 1;
748184193c07STejun Heo 	cpumask_copy(pt->pod_cpus[0], cpu_possible_mask);
748284193c07STejun Heo 	pt->pod_node[0] = NUMA_NO_NODE;
748384193c07STejun Heo 	pt->cpu_pod[0] = 0;
748484193c07STejun Heo 
74854cb1ef64STejun Heo 	/* initialize BH and CPU pools */
74861da177e4SLinus Torvalds 	for_each_possible_cpu(cpu) {
74871da177e4SLinus Torvalds 		struct worker_pool *pool;
74881da177e4SLinus Torvalds 
74891da177e4SLinus Torvalds 		i = 0;
74904cb1ef64STejun Heo 		for_each_bh_worker_pool(pool, cpu) {
74912f34d733STejun Heo 			init_cpu_worker_pool(pool, cpu, std_nice[i]);
74924cb1ef64STejun Heo 			pool->flags |= POOL_BH;
74932f34d733STejun Heo 			init_irq_work(bh_pool_irq_work(pool), irq_work_fns[i]);
74942f34d733STejun Heo 			i++;
74954cb1ef64STejun Heo 		}
74964cb1ef64STejun Heo 
74974cb1ef64STejun Heo 		i = 0;
74982fcdb1b4STejun Heo 		for_each_cpu_worker_pool(pool, cpu)
74992fcdb1b4STejun Heo 			init_cpu_worker_pool(pool, cpu, std_nice[i++]);
75001da177e4SLinus Torvalds 	}
75011da177e4SLinus Torvalds 
75028a2b7538STejun Heo 	/* create default unbound and ordered wq attrs */
750329c91e99STejun Heo 	for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
750429c91e99STejun Heo 		struct workqueue_attrs *attrs;
750529c91e99STejun Heo 
7506be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
750729c91e99STejun Heo 		attrs->nice = std_nice[i];
750829c91e99STejun Heo 		unbound_std_wq_attrs[i] = attrs;
75098a2b7538STejun Heo 
75108a2b7538STejun Heo 		/*
75118a2b7538STejun Heo 		 * An ordered wq should have only one pwq as ordering is
75128a2b7538STejun Heo 		 * guaranteed by max_active which is enforced by pwqs.
75138a2b7538STejun Heo 		 */
7514be69d00dSThomas Gleixner 		BUG_ON(!(attrs = alloc_workqueue_attrs()));
75158a2b7538STejun Heo 		attrs->nice = std_nice[i];
7516af73f5c9STejun Heo 		attrs->ordered = true;
75178a2b7538STejun Heo 		ordered_wq_attrs[i] = attrs;
751829c91e99STejun Heo 	}
751929c91e99STejun Heo 
7520d320c038STejun Heo 	system_wq = alloc_workqueue("events", 0, 0);
75211aabe902SJoonsoo Kim 	system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
7522d320c038STejun Heo 	system_long_wq = alloc_workqueue("events_long", 0, 0);
7523f3421797STejun Heo 	system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
7524636b927eSTejun Heo 					    WQ_MAX_ACTIVE);
752524d51addSTejun Heo 	system_freezable_wq = alloc_workqueue("events_freezable",
752624d51addSTejun Heo 					      WQ_FREEZABLE, 0);
75270668106cSViresh Kumar 	system_power_efficient_wq = alloc_workqueue("events_power_efficient",
75280668106cSViresh Kumar 					      WQ_POWER_EFFICIENT, 0);
75298318d6a6SAudra Mitchell 	system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_pwr_efficient",
75300668106cSViresh Kumar 					      WQ_FREEZABLE | WQ_POWER_EFFICIENT,
75310668106cSViresh Kumar 					      0);
75324cb1ef64STejun Heo 	system_bh_wq = alloc_workqueue("events_bh", WQ_BH, 0);
75334cb1ef64STejun Heo 	system_bh_highpri_wq = alloc_workqueue("events_bh_highpri",
75344cb1ef64STejun Heo 					       WQ_BH | WQ_HIGHPRI, 0);
75351aabe902SJoonsoo Kim 	BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
75360668106cSViresh Kumar 	       !system_unbound_wq || !system_freezable_wq ||
75370668106cSViresh Kumar 	       !system_power_efficient_wq ||
75384cb1ef64STejun Heo 	       !system_freezable_power_efficient_wq ||
75394cb1ef64STejun Heo 	       !system_bh_wq || !system_bh_highpri_wq);
75403347fa09STejun Heo }
75413347fa09STejun Heo 
7542aa6fde93STejun Heo static void __init wq_cpu_intensive_thresh_init(void)
7543aa6fde93STejun Heo {
7544aa6fde93STejun Heo 	unsigned long thresh;
7545aa6fde93STejun Heo 	unsigned long bogo;
7546aa6fde93STejun Heo 
7547dd64c873SZqiang 	pwq_release_worker = kthread_create_worker(0, "pool_workqueue_release");
7548dd64c873SZqiang 	BUG_ON(IS_ERR(pwq_release_worker));
7549dd64c873SZqiang 
7550aa6fde93STejun Heo 	/* if the user set it to a specific value, keep it */
7551aa6fde93STejun Heo 	if (wq_cpu_intensive_thresh_us != ULONG_MAX)
7552aa6fde93STejun Heo 		return;
7553aa6fde93STejun Heo 
7554aa6fde93STejun Heo 	/*
7555aa6fde93STejun Heo 	 * The default of 10ms is derived from the fact that most modern (as of
7556aa6fde93STejun Heo 	 * 2023) processors can do a lot in 10ms and that it's just below what
7557aa6fde93STejun Heo 	 * most consider human-perceivable. However, the kernel also runs on a
7558aa6fde93STejun Heo 	 * lot slower CPUs including microcontrollers where the threshold is way
7559aa6fde93STejun Heo 	 * too low.
7560aa6fde93STejun Heo 	 *
7561aa6fde93STejun Heo 	 * Let's scale up the threshold upto 1 second if BogoMips is below 4000.
7562aa6fde93STejun Heo 	 * This is by no means accurate but it doesn't have to be. The mechanism
7563aa6fde93STejun Heo 	 * is still useful even when the threshold is fully scaled up. Also, as
7564aa6fde93STejun Heo 	 * the reports would usually be applicable to everyone, some machines
7565aa6fde93STejun Heo 	 * operating on longer thresholds won't significantly diminish their
7566aa6fde93STejun Heo 	 * usefulness.
7567aa6fde93STejun Heo 	 */
7568aa6fde93STejun Heo 	thresh = 10 * USEC_PER_MSEC;
7569aa6fde93STejun Heo 
7570aa6fde93STejun Heo 	/* see init/calibrate.c for lpj -> BogoMIPS calculation */
7571aa6fde93STejun Heo 	bogo = max_t(unsigned long, loops_per_jiffy / 500000 * HZ, 1);
7572aa6fde93STejun Heo 	if (bogo < 4000)
7573aa6fde93STejun Heo 		thresh = min_t(unsigned long, thresh * 4000 / bogo, USEC_PER_SEC);
7574aa6fde93STejun Heo 
7575aa6fde93STejun Heo 	pr_debug("wq_cpu_intensive_thresh: lpj=%lu BogoMIPS=%lu thresh_us=%lu\n",
7576aa6fde93STejun Heo 		 loops_per_jiffy, bogo, thresh);
7577aa6fde93STejun Heo 
7578aa6fde93STejun Heo 	wq_cpu_intensive_thresh_us = thresh;
7579aa6fde93STejun Heo }
7580aa6fde93STejun Heo 
75813347fa09STejun Heo /**
75823347fa09STejun Heo  * workqueue_init - bring workqueue subsystem fully online
75833347fa09STejun Heo  *
75842930155bSTejun Heo  * This is the second step of three-staged workqueue subsystem initialization
75852930155bSTejun Heo  * and invoked as soon as kthreads can be created and scheduled. Workqueues have
75862930155bSTejun Heo  * been created and work items queued on them, but there are no kworkers
75872930155bSTejun Heo  * executing the work items yet. Populate the worker pools with the initial
75882930155bSTejun Heo  * workers and enable future kworker creations.
75893347fa09STejun Heo  */
75902333e829SYu Chen void __init workqueue_init(void)
75913347fa09STejun Heo {
75922186d9f9STejun Heo 	struct workqueue_struct *wq;
75933347fa09STejun Heo 	struct worker_pool *pool;
75943347fa09STejun Heo 	int cpu, bkt;
75953347fa09STejun Heo 
7596aa6fde93STejun Heo 	wq_cpu_intensive_thresh_init();
7597aa6fde93STejun Heo 
75982186d9f9STejun Heo 	mutex_lock(&wq_pool_mutex);
75992186d9f9STejun Heo 
76002930155bSTejun Heo 	/*
76012930155bSTejun Heo 	 * Per-cpu pools created earlier could be missing node hint. Fix them
76022930155bSTejun Heo 	 * up. Also, create a rescuer for workqueues that requested it.
76032930155bSTejun Heo 	 */
76042186d9f9STejun Heo 	for_each_possible_cpu(cpu) {
76054cb1ef64STejun Heo 		for_each_bh_worker_pool(pool, cpu)
76062186d9f9STejun Heo 			pool->node = cpu_to_node(cpu);
76074cb1ef64STejun Heo 		for_each_cpu_worker_pool(pool, cpu)
76084cb1ef64STejun Heo 			pool->node = cpu_to_node(cpu);
76092186d9f9STejun Heo 	}
76102186d9f9STejun Heo 
761140c17f75STejun Heo 	list_for_each_entry(wq, &workqueues, list) {
761240c17f75STejun Heo 		WARN(init_rescuer(wq),
761340c17f75STejun Heo 		     "workqueue: failed to create early rescuer for %s",
761440c17f75STejun Heo 		     wq->name);
761540c17f75STejun Heo 	}
76162186d9f9STejun Heo 
76172186d9f9STejun Heo 	mutex_unlock(&wq_pool_mutex);
76182186d9f9STejun Heo 
76194cb1ef64STejun Heo 	/*
76204cb1ef64STejun Heo 	 * Create the initial workers. A BH pool has one pseudo worker that
76214cb1ef64STejun Heo 	 * represents the shared BH execution context and thus doesn't get
76224cb1ef64STejun Heo 	 * affected by hotplug events. Create the BH pseudo workers for all
76234cb1ef64STejun Heo 	 * possible CPUs here.
76244cb1ef64STejun Heo 	 */
76254cb1ef64STejun Heo 	for_each_possible_cpu(cpu)
76264cb1ef64STejun Heo 		for_each_bh_worker_pool(pool, cpu)
76274cb1ef64STejun Heo 			BUG_ON(!create_worker(pool));
76284cb1ef64STejun Heo 
76293347fa09STejun Heo 	for_each_online_cpu(cpu) {
76303347fa09STejun Heo 		for_each_cpu_worker_pool(pool, cpu) {
76313347fa09STejun Heo 			pool->flags &= ~POOL_DISASSOCIATED;
76323347fa09STejun Heo 			BUG_ON(!create_worker(pool));
76333347fa09STejun Heo 		}
76343347fa09STejun Heo 	}
76353347fa09STejun Heo 
76363347fa09STejun Heo 	hash_for_each(unbound_pool_hash, bkt, pool, hash_node)
76373347fa09STejun Heo 		BUG_ON(!create_worker(pool));
76383347fa09STejun Heo 
76393347fa09STejun Heo 	wq_online = true;
764082607adcSTejun Heo 	wq_watchdog_init();
76411da177e4SLinus Torvalds }
7642c4f135d6STetsuo Handa 
7643025e1684STejun Heo /*
7644025e1684STejun Heo  * Initialize @pt by first initializing @pt->cpu_pod[] with pod IDs according to
7645025e1684STejun Heo  * @cpu_shares_pod(). Each subset of CPUs that share a pod is assigned a unique
7646025e1684STejun Heo  * and consecutive pod ID. The rest of @pt is initialized accordingly.
7647025e1684STejun Heo  */
7648025e1684STejun Heo static void __init init_pod_type(struct wq_pod_type *pt,
7649025e1684STejun Heo 				 bool (*cpus_share_pod)(int, int))
7650025e1684STejun Heo {
7651025e1684STejun Heo 	int cur, pre, cpu, pod;
7652025e1684STejun Heo 
7653025e1684STejun Heo 	pt->nr_pods = 0;
7654025e1684STejun Heo 
7655025e1684STejun Heo 	/* init @pt->cpu_pod[] according to @cpus_share_pod() */
7656025e1684STejun Heo 	pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL);
7657025e1684STejun Heo 	BUG_ON(!pt->cpu_pod);
7658025e1684STejun Heo 
7659025e1684STejun Heo 	for_each_possible_cpu(cur) {
7660025e1684STejun Heo 		for_each_possible_cpu(pre) {
7661025e1684STejun Heo 			if (pre >= cur) {
7662025e1684STejun Heo 				pt->cpu_pod[cur] = pt->nr_pods++;
7663025e1684STejun Heo 				break;
7664025e1684STejun Heo 			}
7665025e1684STejun Heo 			if (cpus_share_pod(cur, pre)) {
7666025e1684STejun Heo 				pt->cpu_pod[cur] = pt->cpu_pod[pre];
7667025e1684STejun Heo 				break;
7668025e1684STejun Heo 			}
7669025e1684STejun Heo 		}
7670025e1684STejun Heo 	}
7671025e1684STejun Heo 
7672025e1684STejun Heo 	/* init the rest to match @pt->cpu_pod[] */
7673025e1684STejun Heo 	pt->pod_cpus = kcalloc(pt->nr_pods, sizeof(pt->pod_cpus[0]), GFP_KERNEL);
7674025e1684STejun Heo 	pt->pod_node = kcalloc(pt->nr_pods, sizeof(pt->pod_node[0]), GFP_KERNEL);
7675025e1684STejun Heo 	BUG_ON(!pt->pod_cpus || !pt->pod_node);
7676025e1684STejun Heo 
7677025e1684STejun Heo 	for (pod = 0; pod < pt->nr_pods; pod++)
7678025e1684STejun Heo 		BUG_ON(!zalloc_cpumask_var(&pt->pod_cpus[pod], GFP_KERNEL));
7679025e1684STejun Heo 
7680025e1684STejun Heo 	for_each_possible_cpu(cpu) {
7681025e1684STejun Heo 		cpumask_set_cpu(cpu, pt->pod_cpus[pt->cpu_pod[cpu]]);
7682025e1684STejun Heo 		pt->pod_node[pt->cpu_pod[cpu]] = cpu_to_node(cpu);
7683025e1684STejun Heo 	}
7684025e1684STejun Heo }
7685025e1684STejun Heo 
768663c5484eSTejun Heo static bool __init cpus_dont_share(int cpu0, int cpu1)
768763c5484eSTejun Heo {
768863c5484eSTejun Heo 	return false;
768963c5484eSTejun Heo }
769063c5484eSTejun Heo 
769163c5484eSTejun Heo static bool __init cpus_share_smt(int cpu0, int cpu1)
769263c5484eSTejun Heo {
769363c5484eSTejun Heo #ifdef CONFIG_SCHED_SMT
769463c5484eSTejun Heo 	return cpumask_test_cpu(cpu0, cpu_smt_mask(cpu1));
769563c5484eSTejun Heo #else
769663c5484eSTejun Heo 	return false;
769763c5484eSTejun Heo #endif
769863c5484eSTejun Heo }
769963c5484eSTejun Heo 
7700025e1684STejun Heo static bool __init cpus_share_numa(int cpu0, int cpu1)
7701025e1684STejun Heo {
7702025e1684STejun Heo 	return cpu_to_node(cpu0) == cpu_to_node(cpu1);
7703025e1684STejun Heo }
7704025e1684STejun Heo 
77052930155bSTejun Heo /**
77062930155bSTejun Heo  * workqueue_init_topology - initialize CPU pods for unbound workqueues
77072930155bSTejun Heo  *
770896068b60SWang Jinchao  * This is the third step of three-staged workqueue subsystem initialization and
77092930155bSTejun Heo  * invoked after SMP and topology information are fully initialized. It
77102930155bSTejun Heo  * initializes the unbound CPU pods accordingly.
77112930155bSTejun Heo  */
77122930155bSTejun Heo void __init workqueue_init_topology(void)
7713a86feae6STejun Heo {
77142930155bSTejun Heo 	struct workqueue_struct *wq;
7715025e1684STejun Heo 	int cpu;
7716a86feae6STejun Heo 
771763c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CPU], cpus_dont_share);
771863c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_SMT], cpus_share_smt);
771963c5484eSTejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_CACHE], cpus_share_cache);
7720025e1684STejun Heo 	init_pod_type(&wq_pod_types[WQ_AFFN_NUMA], cpus_share_numa);
7721a86feae6STejun Heo 
7722c5f8cd6cSTejun Heo 	wq_topo_initialized = true;
7723c5f8cd6cSTejun Heo 
77242930155bSTejun Heo 	mutex_lock(&wq_pool_mutex);
7725a86feae6STejun Heo 
7726a86feae6STejun Heo 	/*
77272930155bSTejun Heo 	 * Workqueues allocated earlier would have all CPUs sharing the default
77282930155bSTejun Heo 	 * worker pool. Explicitly call wq_update_pod() on all workqueue and CPU
77292930155bSTejun Heo 	 * combinations to apply per-pod sharing.
77302930155bSTejun Heo 	 */
77312930155bSTejun Heo 	list_for_each_entry(wq, &workqueues, list) {
77325797b1c1STejun Heo 		for_each_online_cpu(cpu)
77332930155bSTejun Heo 			wq_update_pod(wq, cpu, cpu, true);
77345797b1c1STejun Heo 		if (wq->flags & WQ_UNBOUND) {
77355797b1c1STejun Heo 			mutex_lock(&wq->mutex);
77365797b1c1STejun Heo 			wq_update_node_max_active(wq, -1);
77375797b1c1STejun Heo 			mutex_unlock(&wq->mutex);
77382930155bSTejun Heo 		}
77392930155bSTejun Heo 	}
77402930155bSTejun Heo 
77412930155bSTejun Heo 	mutex_unlock(&wq_pool_mutex);
7742a86feae6STejun Heo }
7743a86feae6STejun Heo 
774420bdedafSTetsuo Handa void __warn_flushing_systemwide_wq(void)
774520bdedafSTetsuo Handa {
774620bdedafSTetsuo Handa 	pr_warn("WARNING: Flushing system-wide workqueues will be prohibited in near future.\n");
774720bdedafSTetsuo Handa 	dump_stack();
774820bdedafSTetsuo Handa }
7749c4f135d6STetsuo Handa EXPORT_SYMBOL(__warn_flushing_systemwide_wq);
7750ace3c549Stiozhang 
7751ace3c549Stiozhang static int __init workqueue_unbound_cpus_setup(char *str)
7752ace3c549Stiozhang {
7753ace3c549Stiozhang 	if (cpulist_parse(str, &wq_cmdline_cpumask) < 0) {
7754ace3c549Stiozhang 		cpumask_clear(&wq_cmdline_cpumask);
7755ace3c549Stiozhang 		pr_warn("workqueue.unbound_cpus: incorrect CPU range, using default\n");
7756ace3c549Stiozhang 	}
7757ace3c549Stiozhang 
7758ace3c549Stiozhang 	return 1;
7759ace3c549Stiozhang }
7760ace3c549Stiozhang __setup("workqueue.unbound_cpus=", workqueue_unbound_cpus_setup);
7761